Interface for a key/value pair editor GUI. More...

Inheritance diagram for makVrv::DtMapEditorInterface:

Public Member Functions
virtual	~DtMapEditorInterface ()
virtual void	setPossibleValues (QStringList values, int column=1)=0
	Set the list of possible values for value.
virtual void	setValue (const std::string &key, const std::string &value, int index=1, DtCustomTreeWidgetEditor::EditorType defaultEditor=DtCustomTreeWidgetEditor::DefaultEditor)=0
	Called by the logic to add a key/value to the widget.
virtual void	deleteValue (const std::string &key)=0
	Called by the logic to delete a key/value to the widget.
virtual void	clearValues ()=0
	Called by the logic to clear all values on widget.
virtual void	unableToRenameParameter (const std::string &oldName)=0
	Called by the logic when a renameValue fails.
virtual void	selectValue (const std::string &key)=0
	Called by the logic to select a value in the widget.
virtual void	renameKey (const std::string &oldkey, const std::string &newkey)=0
	Called by the logic to rename a key Warning: This only does so visually and is primarily only used when using the map editor to display an ordered list with an invisible key.
virtual void	setLabelText (const std::string &)=0
	Sets label text for label next to buttons.
virtual void	setUseSpacer (bool)=0
	Sets whether or not to show a spacer underneath the label.
virtual void	sortValues ()=0
	Sorts all items in ascending order.

Public Attributes
boost::signal< void(const std::string &oldName, const std::string &newName)>	signal_renameValue
	Signal emitted when the user wants to rename a key.
boost::signal< void(const std::string &key, const std::string &value, int index)>	signal_addValue
	Signal emitted when the user wants to add a new key/value.
boost::signal< void(const std::string &key)>	signal_deleteValue
	Signal emitted when the user wants to delete a key value.
boost::signal< void(const std::string &key)>	signal_itemSelected
	Signal emitted when a value is selected.

Detailed Description

Interface for a key/value pair editor GUI.

Constructor & Destructor Documentation

virtual makVrv::DtMapEditorInterface::~DtMapEditorInterface ( )

virtual

Member Function Documentation

virtual void makVrv::DtMapEditorInterface::setPossibleValues	(	QStringList	values,
		int	column = `1`
	)

pure virtual

Set the list of possible values for value.

Optionally there may be multiple sets of values, specified by the index.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::setValue	(	const std::string &	key,
		const std::string &	value,
		int	index = `1`,
		DtCustomTreeWidgetEditor::EditorType	defaultEditor = `DtCustomTreeWidgetEditor::DefaultEditor`
	)

pure virtual

Called by the logic to add a key/value to the widget.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::deleteValue ( const std::string & key )

pure virtual

Called by the logic to delete a key/value to the widget.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::clearValues ( )

pure virtual

Called by the logic to clear all values on widget.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::unableToRenameParameter ( const std::string & oldName )

pure virtual

Called by the logic when a renameValue fails.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::selectValue ( const std::string & key )

pure virtual

Called by the logic to select a value in the widget.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::renameKey	(	const std::string &	oldkey,
		const std::string &	newkey
	)

pure virtual

Called by the logic to rename a key Warning: This only does so visually and is primarily only used when using the map editor to display an ordered list with an invisible key.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::setLabelText ( const std::string & )

pure virtual

Sets label text for label next to buttons.

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::setUseSpacer ( bool )

pure virtual

Sets whether or not to show a spacer underneath the label.

Default is true (used for layout with other widgets on screen)

Implemented in makVrv::DtMapEditorWidget.

virtual void makVrv::DtMapEditorInterface::sortValues ( )

pure virtual

Sorts all items in ascending order.

Implemented in makVrv::DtMapEditorWidget.

Member Data Documentation

boost::signal<void (const std::string& oldName,const std::string& newName)> makVrv::DtMapEditorInterface::signal_renameValue

Signal emitted when the user wants to rename a key.

boost::signal<void (const std::string& key,const std::string& value, int index)> makVrv::DtMapEditorInterface::signal_addValue

Signal emitted when the user wants to add a new key/value.

Optionally there is an index provided for multiple values.

boost::signal<void (const std::string& key)> makVrv::DtMapEditorInterface::signal_deleteValue

Signal emitted when the user wants to delete a key value.

boost::signal<void (const std::string& key)> makVrv::DtMapEditorInterface::signal_itemSelected

Signal emitted when a value is selected.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCoreQt/DtMapEditorInterface.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation