PropertyEditor Class Reference

#include <widgets/PropertyEditor.h>

Inheritance diagram for PropertyEditor:

Classes
class	Delegate
	Provides display and editing facilities for property items in the editor. More...

Public Types
typedef boost::shared_ptr< Delegate >	DelegatePtr

Public Slots
void	clear ()
	Removes all property nodes that were set and therefore clears the whole editor content (without deleting the nodes). More...
void	addProperty (PropertyNode *property, QVariant user=QVariant())
	Adds the specified property node as top level node to the editor. More...
void	removeProperty (PropertyNode *property)
	Remove the specified property node from the editor. More...
void	moveUpProperty (PropertyNode *property)
	Moves the property node up in the editor's property node list. More...
void	moveDownProperty (PropertyNode *property)
	Moves the property node down in the editor's property node list. More...
QVariant	getUser (PropertyNode *property)
void	setAutoHideFilterBar (bool hide=true)
void	showFilter ()
void	hideFilter ()

Public Member Functions
	PropertyEditor (QWidget *parent=0)
virtual	~PropertyEditor ()
PropertyNode *	currentProperty ()
	Returns the current selected property node, or NULL if nothing is selected. More...
void	setHideSingleRootNode (bool hide=true)
	If hiding of the single root node is enabled, a single top level node will not be shown explicitly. More...
bool	getHideSingleRootNode () const
	Returns the set mode, whether a single root node should be hidden or not. More...
void	installFilterShortCut (QWidget *widget, const QString &shortcut="Ctrl+F")
bool	getAutoHideFilterBar () const
void	setColor (const PropertyNode *property, const QColor &color)
	Sets the background color for the specified property. More...
QColor	getColor (const PropertyNode *property) const
std::string	getText (const PropertyNode *property) const
QIcon	getIcon (const PropertyNode *property) const
QColor	getBackgroundColor (const PropertyNode *property) const
QWidget *	createEditor (PropertyNode *property, QWidget *parent)
std::string	getName (const PropertyNode *property)
const PropertyNode *	getCurrentEditedProperty () const
PropertyListener interface
virtual void	beginAddChildren (const PropertyNode *node, int index, int count)
virtual void	endAddChildren ()
virtual void	beginRemoveChildren (const PropertyNode *node, int index, int count)
virtual void	endRemoveChildren ()
virtual void	beginMoveChildren (const PropertyNode *node, int index, int count, int destination)
virtual void	endMoveChildren ()

Static Public Attributes
static const QColor	lightBlue
static const QColor	lightRed
static const QColor	lightGreen
static const QColor	lightYellow
static const QColor	lightPurple

Protected Member Functions
void	timerEvent (QTimerEvent *)
void	customEvent (QEvent *)

Friends
class	Model
class	TreeView
class	ItemDelegate
class	PropertyItemEditor

Member Typedef Documentation

DelegatePtr

typedef boost::shared_ptr<Delegate> DelegatePtr

Constructor & Destructor Documentation

PropertyEditor()

PropertyEditor

(

QWidget *

parent = 0

)

~PropertyEditor()

virtual ~PropertyEditor ( )

virtual

Member Function Documentation

currentProperty()

PropertyNode* currentProperty

(

)

Returns the current selected property node, or NULL if nothing is selected.

clear

void clear ( )

slot

Removes all property nodes that were set and therefore clears the whole editor content (without deleting the nodes).

addProperty

void addProperty ( PropertyNode *  property, QVariant  user = QVariant()  )

slot

Adds the specified property node as top level node to the editor.

removeProperty

void removeProperty ( PropertyNode *  property )

slot

Remove the specified property node from the editor.

moveUpProperty

void moveUpProperty ( PropertyNode *  property )

slot

Moves the property node up in the editor's property node list.

moveDownProperty

void moveDownProperty ( PropertyNode *  property )

slot

Moves the property node down in the editor's property node list.

getUser

QVariant getUser ( PropertyNode *  property )

slot

setHideSingleRootNode()

void setHideSingleRootNode

(

bool

hide = true

)

If hiding of the single root node is enabled, a single top level node will not be shown explicitly.

Its children will be shown only.

getHideSingleRootNode()

bool getHideSingleRootNode

(

)

const

Returns the set mode, whether a single root node should be hidden or not.

installFilterShortCut()

void installFilterShortCut	(	QWidget *	widget,
		const QString &	shortcut = "Ctrl+F"
	)

getAutoHideFilterBar()

bool getAutoHideFilterBar

(

)

const

setAutoHideFilterBar

void setAutoHideFilterBar ( bool  hide = true )

slot

showFilter

void showFilter ( )

slot

hideFilter

void hideFilter ( )

slot

setColor()

void setColor	(	const PropertyNode *	property,
		const QColor &	color
	)

Sets the background color for the specified property.

getColor()

QColor getColor

(

const PropertyNode *

property

)

const

getText()

std::string getText

(

const PropertyNode *

property

)

const

getIcon()

QIcon getIcon

(

const PropertyNode *

property

)

const

getBackgroundColor()

QColor getBackgroundColor

(

const PropertyNode *

property

)

const

createEditor()

QWidget* createEditor	(	PropertyNode *	property,
		QWidget *	parent
	)

getName()

std::string getName

(

const PropertyNode *

property

)

timerEvent()

void timerEvent ( QTimerEvent *  )

protected

customEvent()

void customEvent ( QEvent *  )

protected

getCurrentEditedProperty()

const PropertyNode* getCurrentEditedProperty ( ) const

inline

beginAddChildren()

virtual void beginAddChildren ( const PropertyNode *  node, int  index, int  count  )

virtual

Implements PropertyNodeListener.

endAddChildren()

virtual void endAddChildren ( )

virtual

Implements PropertyNodeListener.

beginRemoveChildren()

virtual void beginRemoveChildren ( const PropertyNode *  node, int  index, int  count  )

virtual

Implements PropertyNodeListener.

endRemoveChildren()

virtual void endRemoveChildren ( )

virtual

Implements PropertyNodeListener.

beginMoveChildren()

virtual void beginMoveChildren ( const PropertyNode *  node, int  index, int  count, int  destination  )

virtual

Implements PropertyNodeListener.

endMoveChildren()

virtual void endMoveChildren ( )

virtual

Implements PropertyNodeListener.

Friends And Related Function Documentation

Model

friend class Model

friend

TreeView

friend class TreeView

friend

ItemDelegate

friend class ItemDelegate

friend

PropertyItemEditor

friend class PropertyItemEditor

friend

Member Data Documentation

lightBlue

const QColor lightBlue

static

lightRed

const QColor lightRed

static

lightGreen

const QColor lightGreen

static

lightYellow

const QColor lightYellow

static

lightPurple

const QColor lightPurple

static

---

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

• gui/include/widgets/PropertyEditor.h