 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
This is the interface for the element definition editor widget. More...
Public Types | |
| enum | ButtonFlags { ElementDefinitionAdd = 0x00000001, ElementDefinitionRemove = 0x00000002, ElementDefinitionMoveUp = 0x00000004, ElementDefinitionMoveDown = 0x00000008, ElementDefinitionMoveLeft = 0x00000010, ElementDefinitionMoveRight = 0x00000020, ElementDefinitionCopy = 0x00000040, ElementDefinitionPaste = 0x00000080, ElementDefinitionRename = 0x00000100, AllElementDefinitionButtons, VisualDefinitionAdd = 0x00000100, VisualDefinitionRemove = 0x00000200, VisualDefinitionAddAttribute = 0x00000400, VisualDefinitionRemoveAttribute = 0x00000800, VisualDefinitionRevert = 0x00001000, AllVisualDefinitionButtons } |
| Flags to use when enabling/disabling buttons. More... | |
Public Member Functions | |
| virtual | ~DtElementDefinitionEditorInterface () |
| DTOR. | |
| virtual void | clearModelSets ()=0 |
| Clears model sets combo box. | |
| virtual void | addModelSet (const std::string &, int id)=0 |
| Adds a new item to the model sets combo box. Name and index that represents the model set. | |
| virtual int | modelSet () const =0 |
| Returns the id of the selected model set. | |
| virtual void | clearElementDefinitions ()=0 |
| Clears out the element definition pane. | |
| virtual void | addPath (const std::string &path)=0 |
| Adds the path into the element definition hierarchy. | |
| virtual void | selectPath (const std::string &path)=0 |
| Selects the path and makes sure all parents are opened and item is in view. | |
| virtual std::string | selectedPath () const =0 |
| Returns the path selected. | |
| virtual void | setEnabled (ButtonFlags, bool)=0 |
| Enables/disables buttons based on flags. | |
| virtual QTreeWidgetItem * | selectedElementDefinitionTreeWidgetItem () const =0 |
| Returns the selected element definition tree widget item. | |
| virtual QTreeWidgetItem * | selectedVisualDefinitionTreeWidgetItem () const =0 |
| Returns the selected visual definition tree widget item. | |
| virtual QTreeWidgetItem * | elementDefinitionTreeWidgetRootItem () const =0 |
| Returns the root item of the element definition tree (Qt invisibleRootItem) | |
| virtual void | removePath (const std::string &path)=0 |
| Removes the path from the interface. | |
| virtual void | clearElementDefinitionSelection ()=0 |
| Clears selection. | |
| virtual void | movePathTo (const std::string &oldPath, const std::string &newPath)=0 |
| Moves the tree widget item from the specified path to the specified path. | |
| virtual void | reposition (const std::string &from, const std::string &after)=0 |
| Repositions the item to just after the supplied item. | |
| virtual std::string | title () const =0 |
| Returns window title. | |
| virtual void | clearVisualDefinitions ()=0 |
| Clears out visual definitions. | |
| virtual void | addVisualDefinition (const std::string &vis, const DtVisualDefinition &, const std::string &screenName, bool isInherited)=0 |
| Adds in the visual definition to the visual definitions display. If parent is true, should mark as a different color. | |
| virtual void | addVisualAttribute (const std::string &visualDefinition, const std::string &attribute, const DtVisualAttributeInterface *attr, bool isInherited)=0 |
| Adds the visual attribute to the visual definition. | |
| virtual void | removeVisualDefinition (const std::string &path, const std::string &vis)=0 |
| If the selected path is the one supplied, remove the visual definition from the visual definition pane. | |
| virtual void | removeVisualAttribute (const std::string &path, const std::string &vis, const std::string &attr)=0 |
| If the selected path is the one supplied, remove the visual attribute from the visual definition pane. | |
| virtual QWidget * | widget ()=0 |
| Returns this widget. | |
| virtual void | selectVisualDefinition (const std::string &vis)=0 |
| Select the visual definition. | |
| virtual void | selectVisualAttribute (const std::string &vis, const std::string &attr)=0 |
| Select the visual attribute for the visual definition definition. | |
| virtual void | registerItemCreator (int createByType, const std::string &type, DtVisualDefinitionItemCreator *)=0 |
| Adds a new kind of rule for creating visual definition items for this tree. | |
| virtual int | buttonFlags () const =0 |
| Returns the buttons that are currently enabled as flags. | |
| virtual void | editSelectedItem (int col=0)=0 |
| Edits the currently selected item at the specified column. | |
| virtual void | setPathModified (const std::string &path, bool modified)=0 |
| Sets whether or not the path is modified. | |
| virtual void | pathsCleaned ()=0 |
| Cleans out all modified flags. | |
| virtual void | setModifiedPaths (const std::map< std::string, bool > &)=0 |
| Sets the paths that have been modified. | |
| virtual void | setHelpText (const std::string &)=0 |
| Sets text into the help box. | |
| virtual void | setElementDefinitionEditorLabel (const QString &t)=0 |
| Sets text for the element definition editor label. | |
| virtual void | setDeleteButtonToolTip (const QString &s)=0 |
| Sets the tool tip for the delete button. If the string is empty, sets default. | |
| virtual void | sort ()=0 |
| Sorts the item in ascending order. | |
| virtual void | setPathValid (const std::string &path, bool)=0 |
| Sets path valid/invalid. | |
| virtual void | setVisualDefinitionValid (const std::string &visDef, bool)=0 |
| Sets visual definition valid/invalid. | |
| virtual void | setVisualDefinitionErrors (const std::string &)=0 |
| Sets visual definitions errors. Empty string hides errors. | |
| virtual void | appendVisualDefinitionError (const std::string &visDef, const std::string &, bool reset=false)=0 |
| Appends text to the visual definition errors. Shows if hidden. | |
| virtual void | clearVisualDefinitionErrorsFor (const std::string &visDef)=0 |
| Clears out errors for the specified visual definition. | |
| virtual void | setupVisualDefinitionErrors ()=0 |
| Given the visual definitions errors, set up from the internal list. | |
| virtual void | setElementDefinitionErrors (const std::string &)=0 |
| Sets element definitions errors. Empty string hides errors. | |
| virtual void | appendElementDefinitionError (const std::string &visDef, const std::string &, bool reset=false)=0 |
| Appends text to the element definition errors. Shows if hidden. | |
| virtual void | clearElementDefinitionErrorsFor (const std::string &visDef)=0 |
| Clears out errors for the specified element definition. | |
| virtual void | setupElementDefinitionErrors ()=0 |
| Given the element definitions errors, set up from the internal list. | |
| virtual void | setCanRemove (bool)=0 |
| Sets whether or not the remove button is visible. | |
Public Attributes | |
| boost::signal< void()> | signal_elementDefinitionSelectionChanged |
| boost::signal< void()> | signal_visualDefinitionSelectionChanged |
| boost::signal< void()> | signal_addElementDefinition |
| boost::signal< void(const std::string &path)> | signal_removeElementDefinition |
| boost::signal< void(const std::string &path)> | signal_addVisualDefinition |
| boost::signal< void(const std::string &path, const std::string &def)> | signal_removeVisualDefinition |
| boost::signal< void(const std::string &path, const std::string &def, const std::string &attr)> | signal_removeVisualAttribute |
| boost::signal< void(const std::string &path, const std::string &def)> | signal_addVisualAttribute |
| boost::signal< void()> | signal_moveUp |
| boost::signal< void(QTreeWidgetItem *, int)> | signal_visualAttributeSelected |
| boost::signal< void()> | signal_moveDown |
| boost::signal< void()> | signal_moveLeft |
| boost::signal< void()> | signal_moveRight |
| boost::signal< void()> | signal_copyElement |
| boost::signal< void()> | signal_pasteElement |
| boost::signal< void()> | signal_backupClipboard |
| boost::signal< void()> | signal_restoreClipboard |
| boost::signal< void(const std::string &path)> | signal_copyElementDefinition |
| boost::signal< void(const std::string &from, const std::string &to)> | signal_copyElementDefinitionPath |
| boost::signal< void(const std::string &path)> | signal_pasteElementDefinition |
| boost::signal< void(const std::string &oldPath, const std::string &newPath)> | signal_elementDefinitionNameChanged |
| boost::signal< void(const std::string &oldPath, const std::string &newPath)> | signal_movePathTo |
| boost::signal< void(const std::string &from, const std::string &top)> | signal_reparent |
| boost::signal< void(int)> | signal_displayModelSet |
| boost::signal< void(const std::string &attribute)> | signal_createNew |
This is the interface for the element definition editor widget.
Flags to use when enabling/disabling buttons.
| virtual makVrv::DtElementDefinitionEditorInterface::~DtElementDefinitionEditorInterface | ( | ) | [virtual] |
DTOR.
| virtual void makVrv::DtElementDefinitionEditorInterface::clearModelSets | ( | ) | [pure virtual] |
Clears model sets combo box.
| virtual void makVrv::DtElementDefinitionEditorInterface::addModelSet | ( | const std::string & | , |
| int | id | ||
| ) | [pure virtual] |
Adds a new item to the model sets combo box. Name and index that represents the model set.
| virtual int makVrv::DtElementDefinitionEditorInterface::modelSet | ( | ) | const [pure virtual] |
Returns the id of the selected model set.
| virtual void makVrv::DtElementDefinitionEditorInterface::clearElementDefinitions | ( | ) | [pure virtual] |
Clears out the element definition pane.
| virtual void makVrv::DtElementDefinitionEditorInterface::addPath | ( | const std::string & | path | ) | [pure virtual] |
Adds the path into the element definition hierarchy.
| virtual void makVrv::DtElementDefinitionEditorInterface::selectPath | ( | const std::string & | path | ) | [pure virtual] |
Selects the path and makes sure all parents are opened and item is in view.
| virtual std::string makVrv::DtElementDefinitionEditorInterface::selectedPath | ( | ) | const [pure virtual] |
Returns the path selected.
| virtual void makVrv::DtElementDefinitionEditorInterface::setEnabled | ( | ButtonFlags | , |
| bool | |||
| ) | [pure virtual] |
Enables/disables buttons based on flags.
| virtual QTreeWidgetItem* makVrv::DtElementDefinitionEditorInterface::selectedElementDefinitionTreeWidgetItem | ( | ) | const [pure virtual] |
Returns the selected element definition tree widget item.
| virtual QTreeWidgetItem* makVrv::DtElementDefinitionEditorInterface::selectedVisualDefinitionTreeWidgetItem | ( | ) | const [pure virtual] |
Returns the selected visual definition tree widget item.
| virtual QTreeWidgetItem* makVrv::DtElementDefinitionEditorInterface::elementDefinitionTreeWidgetRootItem | ( | ) | const [pure virtual] |
Returns the root item of the element definition tree (Qt invisibleRootItem)
| virtual void makVrv::DtElementDefinitionEditorInterface::removePath | ( | const std::string & | path | ) | [pure virtual] |
Removes the path from the interface.
| virtual void makVrv::DtElementDefinitionEditorInterface::clearElementDefinitionSelection | ( | ) | [pure virtual] |
Clears selection.
| virtual void makVrv::DtElementDefinitionEditorInterface::movePathTo | ( | const std::string & | oldPath, |
| const std::string & | newPath | ||
| ) | [pure virtual] |
Moves the tree widget item from the specified path to the specified path.
| virtual void makVrv::DtElementDefinitionEditorInterface::reposition | ( | const std::string & | from, |
| const std::string & | after | ||
| ) | [pure virtual] |
Repositions the item to just after the supplied item.
| virtual std::string makVrv::DtElementDefinitionEditorInterface::title | ( | ) | const [pure virtual] |
Returns window title.
| virtual void makVrv::DtElementDefinitionEditorInterface::clearVisualDefinitions | ( | ) | [pure virtual] |
Clears out visual definitions.
| virtual void makVrv::DtElementDefinitionEditorInterface::addVisualDefinition | ( | const std::string & | vis, |
| const DtVisualDefinition & | , | ||
| const std::string & | screenName, | ||
| bool | isInherited | ||
| ) | [pure virtual] |
Adds in the visual definition to the visual definitions display. If parent is true, should mark as a different color.
| virtual void makVrv::DtElementDefinitionEditorInterface::addVisualAttribute | ( | const std::string & | visualDefinition, |
| const std::string & | attribute, | ||
| const DtVisualAttributeInterface * | attr, | ||
| bool | isInherited | ||
| ) | [pure virtual] |
Adds the visual attribute to the visual definition.
If the visual attribute already exists, then it has been modified from a parent, and will be marked as such
| virtual void makVrv::DtElementDefinitionEditorInterface::removeVisualDefinition | ( | const std::string & | path, |
| const std::string & | vis | ||
| ) | [pure virtual] |
If the selected path is the one supplied, remove the visual definition from the visual definition pane.
| virtual void makVrv::DtElementDefinitionEditorInterface::removeVisualAttribute | ( | const std::string & | path, |
| const std::string & | vis, | ||
| const std::string & | attr | ||
| ) | [pure virtual] |
If the selected path is the one supplied, remove the visual attribute from the visual definition pane.
| virtual QWidget* makVrv::DtElementDefinitionEditorInterface::widget | ( | ) | [pure virtual] |
Returns this widget.
| virtual void makVrv::DtElementDefinitionEditorInterface::selectVisualDefinition | ( | const std::string & | vis | ) | [pure virtual] |
Select the visual definition.
| virtual void makVrv::DtElementDefinitionEditorInterface::selectVisualAttribute | ( | const std::string & | vis, |
| const std::string & | attr | ||
| ) | [pure virtual] |
Select the visual attribute for the visual definition definition.
| virtual void makVrv::DtElementDefinitionEditorInterface::registerItemCreator | ( | int | createByType, |
| const std::string & | type, | ||
| DtVisualDefinitionItemCreator * | |||
| ) | [pure virtual] |
Adds a new kind of rule for creating visual definition items for this tree.
| virtual int makVrv::DtElementDefinitionEditorInterface::buttonFlags | ( | ) | const [pure virtual] |
Returns the buttons that are currently enabled as flags.
| virtual void makVrv::DtElementDefinitionEditorInterface::editSelectedItem | ( | int | col = 0 | ) | [pure virtual] |
Edits the currently selected item at the specified column.
| virtual void makVrv::DtElementDefinitionEditorInterface::setPathModified | ( | const std::string & | path, |
| bool | modified | ||
| ) | [pure virtual] |
Sets whether or not the path is modified.
| virtual void makVrv::DtElementDefinitionEditorInterface::pathsCleaned | ( | ) | [pure virtual] |
Cleans out all modified flags.
| virtual void makVrv::DtElementDefinitionEditorInterface::setModifiedPaths | ( | const std::map< std::string, bool > & | ) | [pure virtual] |
Sets the paths that have been modified.
| virtual void makVrv::DtElementDefinitionEditorInterface::setHelpText | ( | const std::string & | ) | [pure virtual] |
Sets text into the help box.
| virtual void makVrv::DtElementDefinitionEditorInterface::setElementDefinitionEditorLabel | ( | const QString & | t | ) | [pure virtual] |
Sets text for the element definition editor label.
| virtual void makVrv::DtElementDefinitionEditorInterface::setDeleteButtonToolTip | ( | const QString & | s | ) | [pure virtual] |
Sets the tool tip for the delete button. If the string is empty, sets default.
| virtual void makVrv::DtElementDefinitionEditorInterface::sort | ( | ) | [pure virtual] |
Sorts the item in ascending order.
| virtual void makVrv::DtElementDefinitionEditorInterface::setPathValid | ( | const std::string & | path, |
| bool | |||
| ) | [pure virtual] |
Sets path valid/invalid.
| virtual void makVrv::DtElementDefinitionEditorInterface::setVisualDefinitionValid | ( | const std::string & | visDef, |
| bool | |||
| ) | [pure virtual] |
Sets visual definition valid/invalid.
| virtual void makVrv::DtElementDefinitionEditorInterface::setVisualDefinitionErrors | ( | const std::string & | ) | [pure virtual] |
Sets visual definitions errors. Empty string hides errors.
| virtual void makVrv::DtElementDefinitionEditorInterface::appendVisualDefinitionError | ( | const std::string & | visDef, |
| const std::string & | , | ||
| bool | reset = false |
||
| ) | [pure virtual] |
Appends text to the visual definition errors. Shows if hidden.
| virtual void makVrv::DtElementDefinitionEditorInterface::clearVisualDefinitionErrorsFor | ( | const std::string & | visDef | ) | [pure virtual] |
Clears out errors for the specified visual definition.
Will hide if none left or rework error window if there are some left
| virtual void makVrv::DtElementDefinitionEditorInterface::setupVisualDefinitionErrors | ( | ) | [pure virtual] |
Given the visual definitions errors, set up from the internal list.
| virtual void makVrv::DtElementDefinitionEditorInterface::setElementDefinitionErrors | ( | const std::string & | ) | [pure virtual] |
Sets element definitions errors. Empty string hides errors.
| virtual void makVrv::DtElementDefinitionEditorInterface::appendElementDefinitionError | ( | const std::string & | visDef, |
| const std::string & | , | ||
| bool | reset = false |
||
| ) | [pure virtual] |
Appends text to the element definition errors. Shows if hidden.
| virtual void makVrv::DtElementDefinitionEditorInterface::clearElementDefinitionErrorsFor | ( | const std::string & | visDef | ) | [pure virtual] |
Clears out errors for the specified element definition.
Will hide if none left or rework error window if there are some left
| virtual void makVrv::DtElementDefinitionEditorInterface::setupElementDefinitionErrors | ( | ) | [pure virtual] |
Given the element definitions errors, set up from the internal list.
| virtual void makVrv::DtElementDefinitionEditorInterface::setCanRemove | ( | bool | ) | [pure virtual] |
Sets whether or not the remove button is visible.
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_elementDefinitionSelectionChanged |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_visualDefinitionSelectionChanged |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_addElementDefinition |
| boost::signal<void (const std::string& path)> makVrv::DtElementDefinitionEditorInterface::signal_removeElementDefinition |
| boost::signal<void (const std::string& path)> makVrv::DtElementDefinitionEditorInterface::signal_addVisualDefinition |
| boost::signal<void (const std::string& path, const std::string& def)> makVrv::DtElementDefinitionEditorInterface::signal_removeVisualDefinition |
| boost::signal<void (const std::string& path, const std::string& def, const std::string& attr)> makVrv::DtElementDefinitionEditorInterface::signal_removeVisualAttribute |
| boost::signal<void (const std::string& path, const std::string& def)> makVrv::DtElementDefinitionEditorInterface::signal_addVisualAttribute |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_moveUp |
| boost::signal<void (QTreeWidgetItem*, int)> makVrv::DtElementDefinitionEditorInterface::signal_visualAttributeSelected |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_moveDown |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_moveLeft |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_moveRight |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_copyElement |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_pasteElement |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_backupClipboard |
| boost::signal<void ()> makVrv::DtElementDefinitionEditorInterface::signal_restoreClipboard |
| boost::signal<void (const std::string& path)> makVrv::DtElementDefinitionEditorInterface::signal_copyElementDefinition |
| boost::signal<void (const std::string& from, const std::string& to)> makVrv::DtElementDefinitionEditorInterface::signal_copyElementDefinitionPath |
| boost::signal<void (const std::string& path)> makVrv::DtElementDefinitionEditorInterface::signal_pasteElementDefinition |
| boost::signal<void (const std::string& oldPath, const std::string& newPath)> makVrv::DtElementDefinitionEditorInterface::signal_elementDefinitionNameChanged |
| boost::signal<void (const std::string& oldPath, const std::string& newPath)> makVrv::DtElementDefinitionEditorInterface::signal_movePathTo |
| boost::signal<void (const std::string& from, const std::string& top)> makVrv::DtElementDefinitionEditorInterface::signal_reparent |
| boost::signal<void (int)> makVrv::DtElementDefinitionEditorInterface::signal_displayModelSet |
| boost::signal<void (const std::string& attribute)> makVrv::DtElementDefinitionEditorInterface::signal_createNew |