makVrv::DtKeyMappingEditorWidget Class Reference

A widget class for editing key functions. More...

Inheritance diagram for makVrv::DtKeyMappingEditorWidget:

Public Member Functions
	DtKeyMappingEditorWidget (DtDe &de, QWidget *parent=0, Qt::WindowFlags flags=0)
	CTOR.
virtual	~DtKeyMappingEditorWidget ()
	Virtual DTOR.
virtual void	addKeyFunction (const std::string &name, const std::string &keyString)
	Called by the logic to add a key function to the GUI.
virtual void	updateKeyFunction (const std::string &name, const std::string &keyString)
	Called by the logic to update a key function to the gui.
virtual void	addChildKeyFunction (const std::string &name, const std::string &parentName, const std::string &keyString)
	Called by the logic to add a key function parented by a binary key funciton to the gui.
virtual void	deleteKeyFunction (const std::string &name)
	Called by the logic to remove a key function from the GUI.
virtual void	clearKeyFunctions ()
	Called by the logic to remove all key functions from the gui.
virtual void	selectKeyFunction (const std::string &name)
	Called by the logic to select a key function in the GUI.
virtual void	selectKeyMapping (const DtKeyMapping &keyMapping, bool isBinary)
	Select a specific key mapping.
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.
virtual void	setFilters (const std::vector< std::pair< int, bool > > &filters)
	Set a list of filter strings the interface may display.
virtual void	sortKeyFunctions ()
	Sorts the key functions by name.
virtual void	addKeyMapping (const DtKeyMapping &keyMapping, bool suppressUpDown)
	Add a key mapping to the edit list.
virtual void	removeKeyMapping (const DtKeyMapping &keyMapping)
	Remove a key mapping from the edit list.
virtual void	clearKeyMappings ()
	clear all the key mappings from the edit list
virtual void	setEnableAddMappingButton (bool enabled)
	enable or disable the add key mapping button
virtual void	setEnableRemoveMappingButton (bool enabled)
	enable or disable the remove key mapping button
virtual void	setEnableEditMappingButton (bool enabled)
	enable or disable the edit key mapping button
virtual void	requestInput (const std::string functionName, const DtKeyMapping &keyMapping, bool isBinary)
	Bring up dialog to request key to edit.
virtual void	requestInput (const std::string functionName, bool isBinary)
	Bring up dialog to request key to add.
virtual void	closeEditor ()
	close the editor
virtual std::string	unmappedString ()
	Returns the translated equivalent of <unmapped> which the logic needs to be able to return.
virtual void	requestKeyValidation (const DtKeyMapping &keyMapping, const std::string functionName, const DtKeyFunctionNameList &fnList, bool isEdit)
	When an input request is filled and the key mapping has already been assigned to one or more other functions, we ask if the new mapping should replace the old mappings, be added to them, or cancel the whole thing,.
virtual void	disableEditor ()
	Disable all editor widgets.
virtual void	enableEditor ()
	Enable all editor widgets.
virtual QWidget *	widget ()
	Returns this as a widget.
Public Member Functions inherited from makVrv::DtKeyMappingEditorWidgetInterface
virtual	~DtKeyMappingEditorWidgetInterface ()
	Virtual DTOR.

Protected Slots
virtual void	onFunctionItemSelectionChanged ()
	handle change of function selection
virtual void	onEditItemSelectionChanged ()
	handle change of mapping selection
virtual void	onFilterGroupTriggered (QAction *action)
	handle click on filter group pulldown
virtual void	onAddMappingClicked ()
	handle click on Add Mapping button
virtual void	onRemoveMappingClicked ()
	handle click on Remove Mapping button
virtual void	onEditMappingClicked ()
	handle click on Edit Mapping button

Protected Member Functions
void	slot_requestInputAccepted (const DtKeyMapping &, bool)
	Resend signal.
void	slot_requestInputCanceled ()
void	slot_requestKeyValidationAccepted (const DtKeyMapping &keyMapping, const DtKeyFunctionNameList &fnList, bool isEdit, bool replace)
	Resend signal.
QString	selectedKeyFunctionName () const
void	functionCategoryToCategoryName (int category, QString &categoryName)
void	setupGui ()
QTreeWidgetItem *	findItem (const std::string &key)
QTreeWidgetItem *	findKeyMapping (const DtKeyMapping &mapping, bool isBinary)

Protected Attributes
DtDe &	myDe
std::string	myKeyMapName
QPushButton *	myFilterButton
QLabel *	myFilterLabel
QActionGroup *	myFilterGroup
QMenu *	myFilterMenu
QWidget *	myFunctionWidget
QWidget *	myEditWidget
QTreeWidget *	myFunctionTreeWidget
QTreeWidget *	myEditTreeWidget
QSplitter *	myTreeWidgetSplitter
QVBoxLayout *	myFunctionLayout
QVBoxLayout *	myMappingEditorLayout
QHBoxLayout *	myMappingEditorButtonLayout
QHBoxLayout *	myButtonLayout
QPushButton *	myEditMappingButton
QPushButton *	myAddMappingButton
QPushButton *	myRemoveMappingButton
DtRequestKeyMapKeyDialog *	myRequestDialog
DtRequestKeyValidationDialog *	myRequestKeyValidationDialog
bool	mySaveFilterEnabledState
bool	mySaveFunctionListEnabledState
bool	mySaveMappingListEnabledState
bool	mySaveEditMappingButtonEnabledState
bool	mySaveAddMappingButtonEnabledState
bool	mySaveRemoveMappingButtonEnabledState
bool	myEditorDisabled
bool	myIsClosing

Additional Inherited Members
Public Attributes inherited from makVrv::DtKeyMappingEditorWidgetInterface
boost::signal< void(int)>	signal_filterChanged
boost::signal< void()>	signal_deselectKeyMappings
boost::signal< void(const DtKeyMapping &)>	signal_selectKeyMapping
boost::signal< void()>	signal_deselectFunctions
boost::signal< void(const std::string &)>	signal_selectFunction
boost::signal< void()>	signal_addKeyMapping
boost::signal< void()>	signal_removeKeyMapping
boost::signal< void()>	signal_editKeyMapping
boost::signal< void()>	signal_requestInputCanceled
boost::signal< void(const DtKeyMapping &, bool)>	signal_requestInputAccepted
boost::signal< void(const DtKeyMapping &, const DtKeyFunctionNameList &, bool, bool)>	signal_requestKeyValidationAccepted

Detailed Description

A widget class for editing key functions.

Constructor & Destructor Documentation

makVrv::DtKeyMappingEditorWidget::DtKeyMappingEditorWidget	(	DtDe &	de,
		QWidget *	parent = 0,
		Qt::WindowFlags	flags = 0
	)

CTOR.

virtual makVrv::DtKeyMappingEditorWidget::~DtKeyMappingEditorWidget ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtKeyMappingEditorWidget::addKeyFunction ( const std::string &  name, const std::string &  keyString  )

virtual

Called by the logic to add a key function to the GUI.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::updateKeyFunction ( const std::string &  name, const std::string &  keyString  )

virtual

Called by the logic to update a key function to the gui.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::addChildKeyFunction ( const std::string &  name, const std::string &  parentName, const std::string &  keyString  )

virtual

Called by the logic to add a key function parented by a binary key funciton to the gui.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::deleteKeyFunction ( const std::string &  name )

virtual

Called by the logic to remove a key function from the GUI.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::clearKeyFunctions ( )

virtual

Called by the logic to remove all key functions from the gui.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::selectKeyFunction ( const std::string &  name )

virtual

Called by the logic to select a key function in the GUI.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::selectKeyMapping ( const DtKeyMapping &  keyMapping, bool  isBinary  )

virtual

Select a specific key mapping.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::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::DtKeyMappingEditorWidgetInterface.

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

virtual

Set a list of filter strings the interface may display.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::sortKeyFunctions ( )

virtual

Sorts the key functions by name.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::addKeyMapping ( const DtKeyMapping &  keyMapping, bool  suppressUpDown  )

virtual

Add a key mapping to the edit list.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::removeKeyMapping ( const DtKeyMapping &  keyMapping )

virtual

Remove a key mapping from the edit list.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::clearKeyMappings ( )

virtual

clear all the key mappings from the edit list

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::setEnableAddMappingButton ( bool  enabled )

virtual

enable or disable the add key mapping button

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::setEnableRemoveMappingButton ( bool  enabled )

virtual

enable or disable the remove key mapping button

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::setEnableEditMappingButton ( bool  enabled )

virtual

enable or disable the edit key mapping button

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::requestInput ( const std::string  functionName, const DtKeyMapping &  keyMapping, bool  isBinary  )

virtual

Bring up dialog to request key to edit.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::requestInput ( const std::string  functionName, bool  isBinary  )

virtual

Bring up dialog to request key to add.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::closeEditor ( )

virtual

close the editor

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual std::string makVrv::DtKeyMappingEditorWidget::unmappedString ( )

virtual

Returns the translated equivalent of <unmapped> which the logic needs to be able to return.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::requestKeyValidation ( const DtKeyMapping &  keyMapping, const std::string  functionName, const DtKeyFunctionNameList &  fnList, bool  isEdit  )

virtual

When an input request is filled and the key mapping has already been assigned to one or more other functions, we ask if the new mapping should replace the old mappings, be added to them, or cancel the whole thing,.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::disableEditor ( )

virtual

Disable all editor widgets.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::enableEditor ( )

virtual

Enable all editor widgets.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual QWidget* makVrv::DtKeyMappingEditorWidget::widget ( )

virtual

Returns this as a widget.

Implements makVrv::DtKeyMappingEditorWidgetInterface.

virtual void makVrv::DtKeyMappingEditorWidget::onFunctionItemSelectionChanged ( )

protectedvirtualslot

handle change of function selection

virtual void makVrv::DtKeyMappingEditorWidget::onEditItemSelectionChanged ( )

protectedvirtualslot

handle change of mapping selection

virtual void makVrv::DtKeyMappingEditorWidget::onFilterGroupTriggered ( QAction *  action )

protectedvirtualslot

handle click on filter group pulldown

virtual void makVrv::DtKeyMappingEditorWidget::onAddMappingClicked ( )

protectedvirtualslot

handle click on Add Mapping button

virtual void makVrv::DtKeyMappingEditorWidget::onRemoveMappingClicked ( )

protectedvirtualslot

handle click on Remove Mapping button

virtual void makVrv::DtKeyMappingEditorWidget::onEditMappingClicked ( )

protectedvirtualslot

handle click on Edit Mapping button

void makVrv::DtKeyMappingEditorWidget::slot_requestInputAccepted ( const DtKeyMapping &  , bool    )

protected

Resend signal.

void makVrv::DtKeyMappingEditorWidget::slot_requestInputCanceled ( )

protected

void makVrv::DtKeyMappingEditorWidget::slot_requestKeyValidationAccepted ( const DtKeyMapping &  keyMapping, const DtKeyFunctionNameList &  fnList, bool  isEdit, bool  replace  )

protected

Resend signal.

QString makVrv::DtKeyMappingEditorWidget::selectedKeyFunctionName ( ) const

protected

void makVrv::DtKeyMappingEditorWidget::functionCategoryToCategoryName ( int  category, QString &  categoryName  )

protected

void makVrv::DtKeyMappingEditorWidget::setupGui ( )

protected

QTreeWidgetItem* makVrv::DtKeyMappingEditorWidget::findItem ( const std::string &  key )

protected

QTreeWidgetItem* makVrv::DtKeyMappingEditorWidget::findKeyMapping ( const DtKeyMapping &  mapping, bool  isBinary  )

protected

Member Data Documentation

DtDe& makVrv::DtKeyMappingEditorWidget::myDe

protected

std::string makVrv::DtKeyMappingEditorWidget::myKeyMapName

protected

QPushButton* makVrv::DtKeyMappingEditorWidget::myFilterButton

protected

QLabel* makVrv::DtKeyMappingEditorWidget::myFilterLabel

protected

QActionGroup* makVrv::DtKeyMappingEditorWidget::myFilterGroup

protected

QMenu* makVrv::DtKeyMappingEditorWidget::myFilterMenu

protected

QWidget* makVrv::DtKeyMappingEditorWidget::myFunctionWidget

protected

QWidget* makVrv::DtKeyMappingEditorWidget::myEditWidget

protected

QTreeWidget* makVrv::DtKeyMappingEditorWidget::myFunctionTreeWidget

protected

QTreeWidget* makVrv::DtKeyMappingEditorWidget::myEditTreeWidget

protected

QSplitter* makVrv::DtKeyMappingEditorWidget::myTreeWidgetSplitter

protected

QVBoxLayout* makVrv::DtKeyMappingEditorWidget::myFunctionLayout

protected

QVBoxLayout* makVrv::DtKeyMappingEditorWidget::myMappingEditorLayout

protected

QHBoxLayout* makVrv::DtKeyMappingEditorWidget::myMappingEditorButtonLayout

protected

QHBoxLayout* makVrv::DtKeyMappingEditorWidget::myButtonLayout

protected

QPushButton* makVrv::DtKeyMappingEditorWidget::myEditMappingButton

protected

QPushButton* makVrv::DtKeyMappingEditorWidget::myAddMappingButton

protected

QPushButton* makVrv::DtKeyMappingEditorWidget::myRemoveMappingButton

protected

DtRequestKeyMapKeyDialog* makVrv::DtKeyMappingEditorWidget::myRequestDialog

protected

DtRequestKeyValidationDialog* makVrv::DtKeyMappingEditorWidget::myRequestKeyValidationDialog

protected

bool makVrv::DtKeyMappingEditorWidget::mySaveFilterEnabledState

protected

bool makVrv::DtKeyMappingEditorWidget::mySaveFunctionListEnabledState

protected

bool makVrv::DtKeyMappingEditorWidget::mySaveMappingListEnabledState

protected

bool makVrv::DtKeyMappingEditorWidget::mySaveEditMappingButtonEnabledState

protected

bool makVrv::DtKeyMappingEditorWidget::mySaveAddMappingButtonEnabledState

protected

bool makVrv::DtKeyMappingEditorWidget::mySaveRemoveMappingButtonEnabledState

protected

bool makVrv::DtKeyMappingEditorWidget::myEditorDisabled

protected

bool makVrv::DtKeyMappingEditorWidget::myIsClosing

protected

---

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

• include/vrvCoreQt/DtKeyMappingEditorWidget.h