makVrv::DtKeyMappingEditorLogic Class Reference

The logic for the makVrv::DtKeyMappingEditor. More...

Public Member Functions
	DtKeyMappingEditorLogic (DtDe &de, DtPersistenceControlsInterface &toolbar, DtKeyMappingEditorWidgetInterface &iFace, DtSelectInstanceWidget &selectedInstance)
	CTOR.
virtual	~DtKeyMappingEditorLogic ()
	virtual DTOR
void	editKeyMapping ()
	Function called when the user clicks the "Edit".
void	addKeyMapping ()
	Function called when the user clicks the "Add".
void	removeKeyMapping ()
	Function called when the user clicks the "Remove".
void	filterChanged (int functionCategory)
	Called when the user changes the filter.
void	selectFunction (const std::string &functionName)
	Called when the user changes function selection.
void	selectKeyMapping (const DtKeyMapping &keyMapping)
	Called when the user changes key mapping selection.
void	selectKeyMap (const std::string &keyMapping)
	Sets the current key map.
void	deselectFunctions ()
	Called to clear function and mapping selections.
void	requestInputCanceled ()
	Sent by the interface to indicate that Cancel was selected on a request for input.
void	requestInputAccepted (const DtKeyMapping &keyMapping, bool isEdit)
	Sent by the interface when a request for input is completed.
void	requestKeyValidationAccepted (const DtKeyMapping &keyMapping, const DtKeyFunctionNameList &fnList, bool isEdit, bool replace)
	Sent by the interface to return the result of a requestKeyValidation This is initiated when a function is mapped to a key that already has one or more functions mapped to it.

Protected Member Functions
virtual void	setupGui ()
void	setupFilters ()
void	setupAllKeyFunctions ()
void	setupKeyFunctions ()
void	setupBinaryKeyFunctions ()
void	updateAfterMappingChange ()
std::string	keyMappingsToString (const DtKeyMap::MappedKeyList &keyList, bool suppressDirection=false)
std::string	mapNameFromFileName (const std::string &filename)
virtual void	slot_currentInstanceChanged (int index, const std::string &keyMap)
	Send when the current key map has changed due to the selected instance. Reset current key map.
virtual void	slot_keyMapRestored (DtKeyMapManager *, const std::string &map)
	Sent when a key map is restored, if currently selected keymap, restore settings.
virtual void	onExport ()
	Called when user wants to export contents of selected key mapping to a file.
virtual void	onExportFilenameChosen (const std::string &)
	Called when the export filename has been chosen.
virtual void	onImport ()
	Called when a user wants to import (replace) selected key mapping with contents of selected file.
virtual void	onImportFilenameChosen (const std::string &)
	Called when the import filename has been chose.
virtual void	slot_renameInstanceRequested ()
	Called to rename the currently selected key map.
virtual void	slot_newInstanceRequested ()
	Called to create a new instance.
virtual void	slot_deleteInstanceRequested ()
	Called to delete the currently selected instance.
virtual QString	askForKeyMapName (QString initial, const QString &title) const
	Asks for a name for the given key map.

Protected Attributes
DtDe &	myDe
DtPersistenceControlsInterface &	myToolbar
DtKeyMappingEditorWidgetInterface &	myInterface
DtSelectInstanceWidget &	mySelectedInstance
int	myFilter
	current function filter in use
std::string	myCurrentFunctionSelection
	The currently selected function in the function list.
bool	myCurrentFunctionIsBinary
	Indicates if the current function selection is a binary function.
DtKeyMapping	myCurrentKeyMapping
	The currently selected key mapping in the key mapping list.
DtKeyMap *	myKeyMap
	pointer to the temporary, workspace key map
std::string	myKeyMapName
	This is the name of the map we're editing. If "", this is a new map.

Detailed Description

The logic for the makVrv::DtKeyMappingEditor.

Constructor & Destructor Documentation

makVrv::DtKeyMappingEditorLogic::DtKeyMappingEditorLogic	(	DtDe &	de,
		DtPersistenceControlsInterface &	toolbar,
		DtKeyMappingEditorWidgetInterface &	iFace,
		DtSelectInstanceWidget &	selectedInstance
	)

CTOR.

virtual makVrv::DtKeyMappingEditorLogic::~DtKeyMappingEditorLogic ( )

virtual

virtual DTOR

Member Function Documentation

void makVrv::DtKeyMappingEditorLogic::editKeyMapping

(

)

Function called when the user clicks the "Edit".

void makVrv::DtKeyMappingEditorLogic::addKeyMapping

(

)

Function called when the user clicks the "Add".

void makVrv::DtKeyMappingEditorLogic::removeKeyMapping

(

)

Function called when the user clicks the "Remove".

void makVrv::DtKeyMappingEditorLogic::filterChanged

(

int

functionCategory

)

Called when the user changes the filter.

void makVrv::DtKeyMappingEditorLogic::selectFunction

(

const std::string &

functionName

)

Called when the user changes function selection.

void makVrv::DtKeyMappingEditorLogic::selectKeyMapping

(

const DtKeyMapping &

keyMapping

)

Called when the user changes key mapping selection.

void makVrv::DtKeyMappingEditorLogic::selectKeyMap

(

const std::string &

keyMapping

)

Sets the current key map.

void makVrv::DtKeyMappingEditorLogic::deselectFunctions

(

)

Called to clear function and mapping selections.

void makVrv::DtKeyMappingEditorLogic::requestInputCanceled

(

)

Sent by the interface to indicate that Cancel was selected on a request for input.

void makVrv::DtKeyMappingEditorLogic::requestInputAccepted	(	const DtKeyMapping &	keyMapping,
		bool	isEdit
	)

Sent by the interface when a request for input is completed.

isEdit indicates if the request was for a new mapping or to change an existing one

void makVrv::DtKeyMappingEditorLogic::requestKeyValidationAccepted	(	const DtKeyMapping &	keyMapping,
		const DtKeyFunctionNameList &	fnList,
		bool	isEdit,
		bool	replace
	)

Sent by the interface to return the result of a requestKeyValidation This is initiated when a function is mapped to a key that already has one or more functions mapped to it.

virtual void makVrv::DtKeyMappingEditorLogic::setupGui ( )

protectedvirtual

void makVrv::DtKeyMappingEditorLogic::setupFilters ( )

protected

void makVrv::DtKeyMappingEditorLogic::setupAllKeyFunctions ( )

protected

void makVrv::DtKeyMappingEditorLogic::setupKeyFunctions ( )

protected

void makVrv::DtKeyMappingEditorLogic::setupBinaryKeyFunctions ( )

protected

void makVrv::DtKeyMappingEditorLogic::updateAfterMappingChange ( )

protected

std::string makVrv::DtKeyMappingEditorLogic::keyMappingsToString ( const DtKeyMap::MappedKeyList &  keyList, bool  suppressDirection = false  )

protected

std::string makVrv::DtKeyMappingEditorLogic::mapNameFromFileName ( const std::string &  filename )

protected

virtual void makVrv::DtKeyMappingEditorLogic::slot_currentInstanceChanged ( int  index, const std::string &  keyMap  )

protectedvirtual

Send when the current key map has changed due to the selected instance. Reset current key map.

virtual void makVrv::DtKeyMappingEditorLogic::slot_keyMapRestored ( DtKeyMapManager *  , const std::string &  map  )

protectedvirtual

Sent when a key map is restored, if currently selected keymap, restore settings.

virtual void makVrv::DtKeyMappingEditorLogic::onExport ( )

protectedvirtual

Called when user wants to export contents of selected key mapping to a file.

virtual void makVrv::DtKeyMappingEditorLogic::onExportFilenameChosen ( const std::string &  )

protectedvirtual

Called when the export filename has been chosen.

Will export contents of key mapping to given file

virtual void makVrv::DtKeyMappingEditorLogic::onImport ( )

protectedvirtual

Called when a user wants to import (replace) selected key mapping with contents of selected file.

virtual void makVrv::DtKeyMappingEditorLogic::onImportFilenameChosen ( const std::string &  )

protectedvirtual

Called when the import filename has been chose.

Will import contents of file to selected key mapping

virtual void makVrv::DtKeyMappingEditorLogic::slot_renameInstanceRequested ( )

protectedvirtual

Called to rename the currently selected key map.

virtual void makVrv::DtKeyMappingEditorLogic::slot_newInstanceRequested ( )

protectedvirtual

Called to create a new instance.

virtual void makVrv::DtKeyMappingEditorLogic::slot_deleteInstanceRequested ( )

protectedvirtual

Called to delete the currently selected instance.

virtual QString makVrv::DtKeyMappingEditorLogic::askForKeyMapName ( QString  initial, const QString &  title  ) const

protectedvirtual

Asks for a name for the given key map.

Member Data Documentation

DtDe& makVrv::DtKeyMappingEditorLogic::myDe

protected

DtPersistenceControlsInterface& makVrv::DtKeyMappingEditorLogic::myToolbar

protected

DtKeyMappingEditorWidgetInterface& makVrv::DtKeyMappingEditorLogic::myInterface

protected

DtSelectInstanceWidget& makVrv::DtKeyMappingEditorLogic::mySelectedInstance

protected

int makVrv::DtKeyMappingEditorLogic::myFilter

protected

current function filter in use

std::string makVrv::DtKeyMappingEditorLogic::myCurrentFunctionSelection

protected

The currently selected function in the function list.

bool makVrv::DtKeyMappingEditorLogic::myCurrentFunctionIsBinary

protected

Indicates if the current function selection is a binary function.

DtKeyMapping makVrv::DtKeyMappingEditorLogic::myCurrentKeyMapping

protected

The currently selected key mapping in the key mapping list.

DtKeyMap* makVrv::DtKeyMappingEditorLogic::myKeyMap

protected

pointer to the temporary, workspace key map

std::string makVrv::DtKeyMappingEditorLogic::myKeyMapName

protected

This is the name of the map we're editing. If "", this is a new map.

---

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

• include/vrvCoreQt/DtKeyMappingEditorLogic.h