VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Slots | Protected Member Functions | Protected Attributes
makVrv::DtInstanceEditorWidget Class Reference

A widget class for editing instances. More...

Inheritance diagram for makVrv::DtInstanceEditorWidget:
Inheritance graph
[legend]

Public Member Functions

 DtInstanceEditorWidget (DtDe &de, const QString &widgetEditorType, QWidget *parent=0, Qt::WindowFlags flags=0)
 
virtual ~DtInstanceEditorWidget ()
 
virtual void setInstanceTypeName (const std::string &name)
 Called by the logic to set the type of instances. More...
 
virtual void addInstance (const std::string &name)
 Called by the logic to add an instance to the GUI. More...
 
virtual void setDuplicate (const std::string &name, bool b)
 Balled by the logic to mark duplicate instances. More...
 
virtual void deleteInstance (const std::string &name)
 Called by the logic to remove an instance from the GUI. More...
 
virtual void setInstanceFlags (const std::string &name, bool isSaved, bool isOk, bool isEnabled)
 Called by the logic to set additional parameters about an instance. More...
 
virtual void clearInstances ()
 Called by the logic to remove all instances from the gui. More...
 
virtual void selectInstance (const std::string &name)
 Called by the logic to select an instance in the GUI. More...
 
virtual void clearFilters ()
 Clears out filters. More...
 
virtual void selectFilter (const std::string &name)
 Selects a filter item and then emits signal that filter has changed. More...
 
virtual void addFilterItem (const std::string &, int)
 Adds an item into the filter list. More...
 
virtual void setEnableFilterEditor (bool filters)
 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. More...
 
virtual void setInstancesCopyable (bool copyable)
 Called by the logic to enable/disable the copy button. More...
 
virtual void setInstancesEditable (bool editable)
 Called by the logic to enable/disable the edit button. More...
 
virtual void setInstancesRenamable (bool renamable)
 Called by the logic to enable/disable the rename button. More...
 
virtual void setInstancesRemovable (bool removable)
 Called by the logic to enable/disable removing of instances. More...
 
virtual void setFilters (const std::vector< std::pair< std::string, bool > > &filters)
 Set a list of filter strings the interface may display. More...
 
virtual void setFilterToolTip (const std::string &text)
 Set the filter tool tip text. More...
 
virtual QPushButtonaddButton ()
 Set the 'add' button text. More...
 
virtual void setDeleteButtonText (QString text)
 Set the 'delete' button text. More...
 
virtual void setCopyButtonText (QString text)
 Set the 'copy' button text. More...
 
virtual void setEditButtonText (QString text)
 Set the 'edit' button text. More...
 
virtual void setRenameButtonText (QString text)
 Set the 'rename' button text. More...
 
virtual void sortInstances ()
 Sorts the instances by name. More...
 
virtual void setupInvalidInstances ()
 Cycles through dialog to look at items that have "red" background. More...
 
virtual void renameInstance (const std::string &oldName, const std::string &newName, int selectedInstanceIndex)
 Renames the instance from the old to new name if the selected instance is the one given. More...
 
virtual void setDeleteButtonEnabled (bool)
 Sets whether or not the delete button is enabled. More...
 
virtual void setDeleteButtonToolTip (const QString &)
 Sets too tip on delete button. If empty string, sets default. More...
 
virtual void setSelectionMode (SelectionMode mode)
 Sets the selection mode default is single selection. More...
 
virtual void resetFilters ()
 clean the filters More...
 
- Public Member Functions inherited from makVrv::DtInstanceEditorInterface
virtual ~DtInstanceEditorInterface ()
 Virtual DTOR. More...
 
virtual std::string selectedInstance () const =0
 Returns the selected instance. More...
 
virtual std::vector< std::string > selectedInstances () const =0
 Returns the selected instances. More...
 
virtual std::string selectedInstanceCategory () const =0
 Returns category selected instance is in. More...
 
virtual int selectedInstanceCategoryIndex () const =0
 Returns category selected instance is in (integer) More...
 

Protected Types

typedef boost::unordered_map
< std::string, QTreeWidgetItem * >
::iterator 
ItemItr
 

Protected Slots

virtual void on_myTreeWidget_itemSelectionChanged ()
 
virtual void on_myAddButton_clicked ()
 
virtual void on_myDeleteButton_clicked ()
 
virtual void on_myCopyButton_clicked ()
 
virtual void on_myEditButton_clicked ()
 
virtual void on_myRenameButton_clicked ()
 
virtual void on_myFilterGroup_triggered (const QString &)
 
virtual void on_myFilterActionGroup_triggered (QAction *)
 
virtual void on_mySearchLineEdit_textChanged (const QString &)
 
virtual void on_mySearchCleanButton_released ()
 
void on_myTreeWidget_itemClicked (QTreeWidgetItem *item, int column)
 
void on_myTreeWidget_itemActivated (QTreeWidgetItem *item, int column)
 
void on_myTreeWidget_itemDoubleClicked (QTreeWidgetItem *item, int column)
 
virtual std::string selectedInstance () const
 
virtual std::vector< std::string > selectedInstances () const
 
virtual std::string selectedInstanceCategory () const
 
virtual int selectedInstanceCategoryIndex () const
 

Protected Member Functions

QString askForNewInstanceName (QString initial, const QString &title)
 
void setupGui ()
 
QTreeWidgetItemfindItem (const std::string &name)
 
virtual void updateErrorMessage (QTreeWidgetItem *item)
 brief update the error messages when you delete item More...
 

Protected Attributes

DtDemyDe
 
bool myInstancesCopyable
 
bool myInstancesEditable
 
bool myInstancesRenamable
 
bool myInstancesRemovable
 
boost::unordered_map
< std::string, QTreeWidgetItem * > 
myNameToItemMap
 
std::set< QTreeWidgetItem * > myInvalidItems
 
QLabelmyTitle
 
QHBoxLayout * myButtonLayout
 
QPushButtonmyAddButton
 
QPushButtonmyDeleteButton
 
QPushButtonmyCopyButton
 
QPushButtonmyEditButton
 
QPushButtonmyRenameButton
 
QLabelmySearchLabel
 
QLineEditmySearchLineEdit
 
QPushButtonmySearchCleanButton
 
QPushButtonmyFilterButton
 
QActionGroup * myFilterActionGroup
 
QTextEdit * myErrorMessages
 
DtContextTreeWidgetmyTreeWidget
 
QString myInstanceTypeLabel
 
QString myWidgetEditorType
 
bool myShowDeleteDialog
 

Additional Inherited Members

- Public Types inherited from makVrv::DtInstanceEditorInterface
enum  SelectionMode {
  NoSelection, SingleSelection, MultiSelection, ExtendedSelection,
  ContiguousSelection
}
 
- Public Attributes inherited from makVrv::DtInstanceEditorInterface
boost::signal< void(const
std::string &name, const
std::string &schema)> 
signal_createInstance
 Signal emitted when the user clicks the "New". More...
 
boost::signal< void(const
std::string &, const
std::string &)> 
signal_deleteInstance
 Signal emitted when the user clicks the "Delete". More...
 
boost::signal< void(std::vector
< std::string >)> 
signal_deleteInstances
 Signal emitted when the user clicks the "Delete" with multiple instances selected Connected to a slot in the logic. More...
 
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. More...
 
boost::signal< void(const
std::string &, const
std::string &)> 
signal_editInstance
 Signal emitted when the user clicks the "Edit". More...
 
boost::signal< void(const
std::string &oldName, const
std::string &newName, int)> 
signal_renameInstance
 Signal emitted when the user clicks the "Edit". More...
 
boost::signal< void()> signal_changeFileName
 
boost::signal< void(const
std::string &, const
std::string &, int)> 
signal_selectionChanged
 Signal emitted when the user selects an instance. More...
 
boost::signal< void(const
std::string &)> 
signal_filterChanged
 Signal emitted when the user changes the filter. More...
 

Detailed Description

A widget class for editing instances.

Member Typedef Documentation

typedef boost::unordered_map<std::string, QTreeWidgetItem*>::iterator makVrv::DtInstanceEditorWidget::ItemItr
protected

Constructor & Destructor Documentation

makVrv::DtInstanceEditorWidget::DtInstanceEditorWidget ( DtDe de,
const QString &  widgetEditorType,
QWidget *  parent = 0,
Qt::WindowFlags  flags = 0 
)
virtual makVrv::DtInstanceEditorWidget::~DtInstanceEditorWidget ( )
virtual

Member Function Documentation

virtual void makVrv::DtInstanceEditorWidget::setInstanceTypeName ( const std::string &  name)
virtual

Called by the logic to set the type of instances.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::addInstance ( const std::string &  name)
virtual

Called by the logic to add an instance to the GUI.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setDuplicate ( const std::string &  name,
bool  b 
)
virtual

Balled by the logic to mark duplicate instances.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::deleteInstance ( const std::string &  name)
virtual

Called by the logic to remove an instance from the GUI.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setInstanceFlags ( const std::string &  name,
bool  isSaved,
bool  isOk,
bool  isEnabled 
)
virtual

Called by the logic to set additional parameters about an instance.

By default all of these parameters are true.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::clearInstances ( )
virtual

Called by the logic to remove all instances from the gui.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::selectInstance ( const std::string &  name)
virtual

Called by the logic to select an instance in the GUI.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::clearFilters ( )
virtual

Clears out filters.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::selectFilter ( const std::string &  name)
virtual

Selects a filter item and then emits signal that filter has changed.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::addFilterItem ( const std::string &  ,
int   
)
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

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setEnableFilterEditor ( bool  filters)
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.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setInstancesCopyable ( bool  copyable)
virtual

Called by the logic to enable/disable the copy button.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setInstancesEditable ( bool  editable)
virtual

Called by the logic to enable/disable the edit button.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setInstancesRenamable ( bool  renamable)
virtual

Called by the logic to enable/disable the rename button.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setInstancesRemovable ( bool  removable)
virtual

Called by the logic to enable/disable removing of instances.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setFilters ( const std::vector< std::pair< std::string, bool > > &  filters)
virtual

Set a list of filter strings the interface may display.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setFilterToolTip ( const std::string &  text)
virtual

Set the filter tool tip text.

Implements makVrv::DtInstanceEditorInterface.

virtual QPushButton* makVrv::DtInstanceEditorWidget::addButton ( )
virtual

Set the 'add' button text.

virtual void makVrv::DtInstanceEditorWidget::setDeleteButtonText ( QString  text)
virtual

Set the 'delete' button text.

virtual void makVrv::DtInstanceEditorWidget::setCopyButtonText ( QString  text)
virtual

Set the 'copy' button text.

virtual void makVrv::DtInstanceEditorWidget::setEditButtonText ( QString  text)
virtual

Set the 'edit' button text.

virtual void makVrv::DtInstanceEditorWidget::setRenameButtonText ( QString  text)
virtual

Set the 'rename' button text.

virtual void makVrv::DtInstanceEditorWidget::sortInstances ( )
virtual

Sorts the instances by name.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setupInvalidInstances ( )
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

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::renameInstance ( const std::string &  oldName,
const std::string &  newName,
int  selectedInstanceIndex 
)
virtual

Renames the instance from the old to new name if the selected instance is the one given.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setDeleteButtonEnabled ( bool  )
virtual

Sets whether or not the delete button is enabled.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setDeleteButtonToolTip ( const QString &  )
virtual

Sets too tip on delete button. If empty string, sets default.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::setSelectionMode ( SelectionMode  mode)
virtual

Sets the selection mode default is single selection.

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::resetFilters ( )
virtual

clean the filters

Implements makVrv::DtInstanceEditorInterface.

virtual void makVrv::DtInstanceEditorWidget::on_myTreeWidget_itemSelectionChanged ( )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_myAddButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_myDeleteButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_myCopyButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_myEditButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_myRenameButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_myFilterGroup_triggered ( const QString &  )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_myFilterActionGroup_triggered ( QAction )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_mySearchLineEdit_textChanged ( const QString &  )
protectedvirtualslot
virtual void makVrv::DtInstanceEditorWidget::on_mySearchCleanButton_released ( )
protectedvirtualslot
void makVrv::DtInstanceEditorWidget::on_myTreeWidget_itemClicked ( QTreeWidgetItem item,
int  column 
)
protectedslot
void makVrv::DtInstanceEditorWidget::on_myTreeWidget_itemActivated ( QTreeWidgetItem item,
int  column 
)
protectedslot
void makVrv::DtInstanceEditorWidget::on_myTreeWidget_itemDoubleClicked ( QTreeWidgetItem item,
int  column 
)
protectedslot
virtual std::string makVrv::DtInstanceEditorWidget::selectedInstance ( ) const
protectedvirtualslot
virtual std::vector<std::string> makVrv::DtInstanceEditorWidget::selectedInstances ( ) const
protectedvirtualslot
virtual std::string makVrv::DtInstanceEditorWidget::selectedInstanceCategory ( ) const
protectedvirtualslot
virtual int makVrv::DtInstanceEditorWidget::selectedInstanceCategoryIndex ( ) const
protectedvirtualslot
QString makVrv::DtInstanceEditorWidget::askForNewInstanceName ( QString  initial,
const QString &  title 
)
protected
void makVrv::DtInstanceEditorWidget::setupGui ( )
protected
QTreeWidgetItem* makVrv::DtInstanceEditorWidget::findItem ( const std::string &  name)
protected
virtual void makVrv::DtInstanceEditorWidget::updateErrorMessage ( QTreeWidgetItem item)
protectedvirtual

brief update the error messages when you delete item

Member Data Documentation

DtDe& makVrv::DtInstanceEditorWidget::myDe
protected
bool makVrv::DtInstanceEditorWidget::myInstancesCopyable
protected
bool makVrv::DtInstanceEditorWidget::myInstancesEditable
protected
bool makVrv::DtInstanceEditorWidget::myInstancesRenamable
protected
bool makVrv::DtInstanceEditorWidget::myInstancesRemovable
protected
boost::unordered_map<std::string, QTreeWidgetItem*> makVrv::DtInstanceEditorWidget::myNameToItemMap
protected
std::set<QTreeWidgetItem*> makVrv::DtInstanceEditorWidget::myInvalidItems
protected
QLabel* makVrv::DtInstanceEditorWidget::myTitle
protected
QHBoxLayout* makVrv::DtInstanceEditorWidget::myButtonLayout
protected
QPushButton* makVrv::DtInstanceEditorWidget::myAddButton
protected
QPushButton* makVrv::DtInstanceEditorWidget::myDeleteButton
protected
QPushButton* makVrv::DtInstanceEditorWidget::myCopyButton
protected
QPushButton* makVrv::DtInstanceEditorWidget::myEditButton
protected
QPushButton* makVrv::DtInstanceEditorWidget::myRenameButton
protected
QLabel* makVrv::DtInstanceEditorWidget::mySearchLabel
protected
QLineEdit* makVrv::DtInstanceEditorWidget::mySearchLineEdit
protected
QPushButton* makVrv::DtInstanceEditorWidget::mySearchCleanButton
protected
QPushButton* makVrv::DtInstanceEditorWidget::myFilterButton
protected
QActionGroup* makVrv::DtInstanceEditorWidget::myFilterActionGroup
protected
QTextEdit* makVrv::DtInstanceEditorWidget::myErrorMessages
protected
DtContextTreeWidget* makVrv::DtInstanceEditorWidget::myTreeWidget
protected
QString makVrv::DtInstanceEditorWidget::myInstanceTypeLabel
protected
QString makVrv::DtInstanceEditorWidget::myWidgetEditorType
protected
bool makVrv::DtInstanceEditorWidget::myShowDeleteDialog
protected

The documentation for this class was generated from the following file:

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)