Abstract interface for instance editor widgets. More...

Inheritance diagram for makVrv::DtKeyMappingEditorWidgetInterface:

Public Member Functions
virtual	~DtKeyMappingEditorWidgetInterface ()
	Virtual DTOR.
virtual void	addKeyFunction (const std::string &name, const std::string &keyString)=0
	Called by the logic to add a key function to the gui.
virtual void	updateKeyFunction (const std::string &name, const std::string &keyString)=0
	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)=0
	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)=0
	Called by the logic to remove a key function from the gui.
virtual void	clearKeyFunctions ()=0
	Called by the logic to remove all key functions from the gui.
virtual void	sortKeyFunctions ()=0
	Sorts the key functions by name.
virtual void	selectKeyFunction (const std::string &name)=0
	Called by the logic to select a key function in the gui.
virtual void	selectKeyMapping (const DtKeyMapping &keyMapping, bool isBinary)=0
	Select a specific key mapping.
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< int, bool > > &filters)=0
	Set a list of filter strings the interface may display.
virtual void	addKeyMapping (const DtKeyMapping &keyMapping, bool isBinary=false)=0
	Add a key mapping to the edit list.
virtual void	removeKeyMapping (const DtKeyMapping &keyMapping)=0
	Remove a key mapping from the edit list.
virtual void	clearKeyMappings ()=0
	clear all the key mappings from the edit list
virtual void	setEnableAddMappingButton (bool enabled)=0
	enable or disable the add key mapping button
virtual void	setEnableRemoveMappingButton (bool enabled)=0
	enable or disable the remove key mapping button
virtual void	setEnableEditMappingButton (bool enabled)=0
	enable or disable the remove key mapping button
virtual void	requestInput (const std::string functionName, const DtKeyMapping &keyMapping, bool isBinary)=0
	Bring up dialog to request key to edit.
virtual void	requestInput (const std::string functionName, bool isBinary)=0
	Bring up dialog to request key to add.
virtual void	closeEditor ()=0
	close the editor
virtual void	requestKeyValidation (const DtKeyMapping &keyMapping, const std::string functionName, const DtKeyFunctionNameList &fnList, bool isEdit)=0
	An attempt to map an already bound key has occurred.
virtual void	disableEditor ()=0
	Disable all editor widgets.
virtual void	enableEditor ()=0
	Enable all editor widgets.
virtual std::string	unmappedString ()=0
	Returns the translated equivalent of <unmapped> which the logic needs to be able to return.
virtual QWidget *	widget ()=0
	Returns this as a widget.

Public Attributes
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

Abstract interface for instance editor widgets.

Constructor & Destructor Documentation

virtual makVrv::DtKeyMappingEditorWidgetInterface::~DtKeyMappingEditorWidgetInterface ( )

virtual

Virtual DTOR.

Member Function Documentation

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

pure virtual

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

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

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

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

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

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

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

Implemented in makVrv::DtKeyMappingEditorWidget.

virtual void makVrv::DtKeyMappingEditorWidgetInterface::clearKeyFunctions ( )

pure virtual

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

Implemented in makVrv::DtKeyMappingEditorWidget.

virtual void makVrv::DtKeyMappingEditorWidgetInterface::sortKeyFunctions ( )

pure virtual

Sorts the key functions by name.

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

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

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

Select a specific key mapping.

Implemented in makVrv::DtKeyMappingEditorWidget.

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

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

pure virtual

Set a list of filter strings the interface may display.

Implemented in makVrv::DtKeyMappingEditorWidget.

virtual void makVrv::DtKeyMappingEditorWidgetInterface::addKeyMapping	(	const DtKeyMapping &	keyMapping,
		bool	isBinary = `false`
	)

pure virtual

Add a key mapping to the edit list.

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

Remove a key mapping from the edit list.

Implemented in makVrv::DtKeyMappingEditorWidget.

virtual void makVrv::DtKeyMappingEditorWidgetInterface::clearKeyMappings ( )

pure virtual

clear all the key mappings from the edit list

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

enable or disable the add key mapping button

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

enable or disable the remove key mapping button

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

enable or disable the remove key mapping button

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

Bring up dialog to request key to edit.

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

Bring up dialog to request key to add.

Implemented in makVrv::DtKeyMappingEditorWidget.

virtual void makVrv::DtKeyMappingEditorWidgetInterface::closeEditor ( )

pure virtual

close the editor

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

An attempt to map an already bound key has occurred.

Ask the user what to do

Implemented in makVrv::DtKeyMappingEditorWidget.

virtual void makVrv::DtKeyMappingEditorWidgetInterface::disableEditor ( )

pure virtual

Disable all editor widgets.

Implemented in makVrv::DtKeyMappingEditorWidget.

virtual void makVrv::DtKeyMappingEditorWidgetInterface::enableEditor ( )

pure virtual

Enable all editor widgets.

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

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

Implemented in makVrv::DtKeyMappingEditorWidget.

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

pure virtual

Returns this as a widget.

Implemented in makVrv::DtKeyMappingEditorWidget.

Member Data Documentation

boost::signal<void (int)> makVrv::DtKeyMappingEditorWidgetInterface::signal_filterChanged

boost::signal<void ()> makVrv::DtKeyMappingEditorWidgetInterface::signal_deselectKeyMappings

boost::signal<void (const DtKeyMapping&)> makVrv::DtKeyMappingEditorWidgetInterface::signal_selectKeyMapping

boost::signal<void ()> makVrv::DtKeyMappingEditorWidgetInterface::signal_deselectFunctions

boost::signal<void (const std::string&)> makVrv::DtKeyMappingEditorWidgetInterface::signal_selectFunction

boost::signal<void ()> makVrv::DtKeyMappingEditorWidgetInterface::signal_addKeyMapping

boost::signal<void ()> makVrv::DtKeyMappingEditorWidgetInterface::signal_removeKeyMapping

boost::signal<void ()> makVrv::DtKeyMappingEditorWidgetInterface::signal_editKeyMapping

boost::signal<void ()> makVrv::DtKeyMappingEditorWidgetInterface::signal_requestInputCanceled

boost::signal<void (const DtKeyMapping&, bool)> makVrv::DtKeyMappingEditorWidgetInterface::signal_requestInputAccepted

boost::signal<void (const DtKeyMapping&, const DtKeyFunctionNameList&, bool, bool)> makVrv::DtKeyMappingEditorWidgetInterface::signal_requestKeyValidationAccepted

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

include/vrvCoreQt/DtKeyMappingEditorWidgetInterface.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation