 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Abstract interface for instance editor widgets. More...
Public Member Functions | |
| virtual | ~DtInstanceEditorInterface () |
| Virtual DTOR. | |
| virtual std::string | selectedInstance () const =0 |
| Returns the selected instance. | |
| virtual std::string | selectedInstanceCategory () const =0 |
| Returns category selected instance is in. | |
| virtual int | selectedInstanceCategoryIndex () const =0 |
| Returns category selected instance is in (integer) | |
| virtual void | addFilterItem (const std::string &, int)=0 |
| Adds an item into the filter list. | |
| virtual void | setInstanceTypeName (const std::string &name)=0 |
| Called by the logic to set the type of instances. | |
| virtual void | setFilterToolTip (const std::string &)=0 |
| Sets the tool tip of the filter button. | |
| virtual void | addInstance (const std::string &name)=0 |
| Called by the logic to add an instance to the gui. | |
| virtual void | deleteInstance (const std::string &name)=0 |
| Called by the logic to remove an instance from the gui. | |
| virtual void | renameInstance (const std::string &oldName, const std::string &newName, int selectedInstanceIndex)=0 |
| Renames the instance from the old to new name if the selected instance is the one given. | |
| virtual void | clearFilters ()=0 |
| Clears out filters. | |
| virtual void | clearInstances ()=0 |
| Called by the logic to remove all instances from the gui. | |
| virtual void | sortInstances ()=0 |
| Sorts the instances by name. | |
| virtual void | selectInstance (const std::string &name)=0 |
| Called by the logic to select an instance in the gui. | |
| virtual void | selectFilter (const std::string &name)=0 |
| Selects a filter item and then emits signal that filter has changed. | |
| virtual void | setInstanceFlags (const std::string &name, bool isSaved=true, bool isOk=true, bool isEnabled=true)=0 |
| Called by the logic to set additional parameters about an instance. | |
| virtual void | setInstancesCopyable (bool copyable)=0 |
| Called by the logic to enable/disable copying instances. | |
| virtual void | setInstancesEditable (bool editable)=0 |
| Called by the logic to enable/disable editing instances. | |
| virtual void | setInstancesRenamable (bool renamable)=0 |
| Called by the logic to enable/disable renaming instances. | |
| virtual void | setInstancesRemovable (bool removable)=0 |
| Called by the logic to enable/disable removing of instances. | |
| virtual void | setEnableFilterEditor (bool filters)=0 |
| Called by the logic to enable/disable the filter editing control The filter editor typically selects the desired filter, the logic is still responsible for executing the actual filtering. | |
| virtual void | setFilters (const std::vector< std::pair< std::string, bool > > &filters)=0 |
| Set a list of filter strings the interface may display. | |
| virtual void | setupInvalidInstances ()=0 |
| Cycles through dialog to look at items that have "red" background. | |
| virtual void | setDeleteButtonEnabled (bool)=0 |
| Sets whether or not the delete button is enabled. | |
| virtual void | setDeleteButtonToolTip (const QString &)=0 |
| Sets too tip on delete button. | |
Public Attributes | |
| boost::signal< void(const std::string &name, const std::string &schema)> | signal_createInstance |
| Signal emitted when the user clicks the "New". | |
| boost::signal< void(const std::string &, const std::string &)> | signal_deleteInstance |
| Signal emitted when the user clicks the "Delete". | |
| boost::signal< void(const std::string &, const std::string &, const std::string &)> | signal_copyInstance |
| Signal emitted when the user clicks the "Copy", containing the old name, and the new name. | |
| boost::signal< void(const std::string &, const std::string &)> | signal_editInstance |
| Signal emitted when the user clicks the "Edit". | |
| boost::signal< void(const std::string &oldName, const std::string &newName, int)> | signal_renameInstance |
| Signal emitted when the user clicks the "Edit". | |
| boost::signal< void(const std::string &, const std::string &, int)> | signal_selectionChanged |
| Signal emitted when the user selects an instance. | |
| boost::signal< void(const std::string &)> | signal_filterChanged |
| Signal emitted when the user changes the filter. | |
Abstract interface for instance editor widgets.
| virtual makVrv::DtInstanceEditorInterface::~DtInstanceEditorInterface | ( | ) | [virtual] |
Virtual DTOR.
| virtual std::string makVrv::DtInstanceEditorInterface::selectedInstance | ( | ) | const [pure virtual] |
Returns the selected instance.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual std::string makVrv::DtInstanceEditorInterface::selectedInstanceCategory | ( | ) | const [pure virtual] |
Returns category selected instance is in.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual int makVrv::DtInstanceEditorInterface::selectedInstanceCategoryIndex | ( | ) | const [pure virtual] |
Returns category selected instance is in (integer)
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::addFilterItem | ( | const std::string & | , |
| int | |||
| ) | [pure virtual] |
Adds an item into the filter list.
id is an identifier for the item being placed into th combo box. Thit value will be returned in the call selectedInstanceCategoryIndex
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setInstanceTypeName | ( | const std::string & | name | ) | [pure virtual] |
Called by the logic to set the type of instances.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setFilterToolTip | ( | const std::string & | ) | [pure virtual] |
Sets the tool tip of the filter button.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::addInstance | ( | const std::string & | name | ) | [pure virtual] |
Called by the logic to add an instance to the gui.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::deleteInstance | ( | const std::string & | name | ) | [pure virtual] |
Called by the logic to remove an instance from the gui.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::renameInstance | ( | const std::string & | oldName, |
| const std::string & | newName, | ||
| int | selectedInstanceIndex | ||
| ) | [pure virtual] |
Renames the instance from the old to new name if the selected instance is the one given.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::clearFilters | ( | ) | [pure virtual] |
Clears out filters.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::clearInstances | ( | ) | [pure virtual] |
Called by the logic to remove all instances from the gui.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::sortInstances | ( | ) | [pure virtual] |
Sorts the instances by name.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::selectInstance | ( | const std::string & | name | ) | [pure virtual] |
Called by the logic to select an instance in the gui.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::selectFilter | ( | const std::string & | name | ) | [pure virtual] |
Selects a filter item and then emits signal that filter has changed.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setInstanceFlags | ( | const std::string & | name, |
| bool | isSaved = true, |
||
| bool | isOk = true, |
||
| bool | isEnabled = true |
||
| ) | [pure virtual] |
Called by the logic to set additional parameters about an instance.
By default all of these parameters are true.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setInstancesCopyable | ( | bool | copyable | ) | [pure virtual] |
Called by the logic to enable/disable copying instances.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setInstancesEditable | ( | bool | editable | ) | [pure virtual] |
Called by the logic to enable/disable editing instances.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setInstancesRenamable | ( | bool | renamable | ) | [pure virtual] |
Called by the logic to enable/disable renaming instances.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setInstancesRemovable | ( | bool | removable | ) | [pure virtual] |
Called by the logic to enable/disable removing of instances.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setEnableFilterEditor | ( | bool | filters | ) | [pure virtual] |
Called by the logic to enable/disable the filter editing control The filter editor typically selects the desired filter, the logic is still responsible for executing the actual filtering.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setFilters | ( | const std::vector< std::pair< std::string, bool > > & | filters | ) | [pure virtual] |
Set a list of filter strings the interface may display.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setupInvalidInstances | ( | ) | [pure virtual] |
Cycles through dialog to look at items that have "red" background.
Any item that does is considered invalid and is added to the error message box
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setDeleteButtonEnabled | ( | bool | ) | [pure virtual] |
Sets whether or not the delete button is enabled.
Implemented in makVrv::DtInstanceEditorWidget.
| virtual void makVrv::DtInstanceEditorInterface::setDeleteButtonToolTip | ( | const QString & | ) | [pure virtual] |
Sets too tip on delete button.
Implemented in makVrv::DtInstanceEditorWidget.
| boost::signal<void (const std::string& name, const std::string& schema)> makVrv::DtInstanceEditorInterface::signal_createInstance |
Signal emitted when the user clicks the "New".
Connected to a slot in the logic.
| boost::signal<void (const std::string&, const std::string&)> makVrv::DtInstanceEditorInterface::signal_deleteInstance |
Signal emitted when the user clicks the "Delete".
Connected to a slot in the logic.
| boost::signal<void (const std::string&,const std::string&, const std::string&)> makVrv::DtInstanceEditorInterface::signal_copyInstance |
Signal emitted when the user clicks the "Copy", containing the old name, and the new name.
Connected to a slot in the logic.
| boost::signal<void (const std::string&, const std::string&)> makVrv::DtInstanceEditorInterface::signal_editInstance |
Signal emitted when the user clicks the "Edit".
Connected to a slot in the logic.
| boost::signal<void (const std::string& oldName, const std::string& newName, int)> makVrv::DtInstanceEditorInterface::signal_renameInstance |
Signal emitted when the user clicks the "Edit".
Connected to a slot in the logic.
| boost::signal<void (const std::string&, const std::string&, int)> makVrv::DtInstanceEditorInterface::signal_selectionChanged |
Signal emitted when the user selects an instance.
Connected to a slot in the logic.
| boost::signal<void (const std::string&)> makVrv::DtInstanceEditorInterface::signal_filterChanged |
Signal emitted when the user changes the filter.
Connected to a slot in the logic.