The QtProperty class encapsulates an instance of a property. More...

#include <ArmarXGui/libraries/qtpropertybrowser/src/qtpropertybrowser.h>

Inheritance diagram for QtProperty:

Public Member Functions
void	addSubProperty (QtProperty *property)

QString	displayText () const

bool	hasValue () const

void	insertSubProperty (QtProperty property, QtProperty afterProperty)

bool	isEnabled () const

bool	isModified () const

QtAbstractPropertyManager *	propertyManager () const

QString	propertyName () const

void	removeSubProperty (QtProperty *property)

void	setEnabled (bool enable)

void	setModified (bool modified)

void	setPropertyName (const QString &text)

void	setStatusTip (const QString &text)

void	setToolTip (const QString &text)

void	setWhatsThis (const QString &text)

QString	statusTip () const

QList< QtProperty * >	subProperties () const

QString	toolTip () const

QIcon	valueIcon () const

QString	valueText () const

QString	whatsThis () const

virtual	~QtProperty ()

Protected Member Functions
void	propertyChanged ()

	QtProperty (QtAbstractPropertyManager *manager)

Friends
class	QtAbstractPropertyManager

Detailed Description

The QtProperty class encapsulates an instance of a property.

Properties are created by objects of QtAbstractPropertyManager subclasses; a manager can create properties of a given type, and is used in conjunction with the QtAbstractPropertyBrowser class. A property is always owned by the manager that created it, which can be retrieved using the propertyManager() function.

QtProperty contains the most common property attributes, and provides functions for retrieving as well as setting their values:

\table \header \o Getter \o Setter \row \o propertyName() \o setPropertyName() \row \o statusTip() \o setStatusTip() \row \o toolTip() \o setToolTip() \row \o whatsThis() \o setWhatsThis() \row \o isEnabled() \o setEnabled() \row \o isModified() \o setModified() \row \o valueText() \o Nop \row \o valueIcon() \o Nop \endtable

It is also possible to nest properties: QtProperty provides the addSubProperty(), insertSubProperty() and removeSubProperty() functions to manipulate the set of subproperties. Use the subProperties() function to retrieve a property's current set of subproperties. Note that nested properties are not owned by the parent property, i.e. each subproperty is owned by the manager that created it.

See also: QtAbstractPropertyManager, QtBrowserItem

Constructor & Destructor Documentation

◆ ~QtProperty()

~QtProperty ( )

virtual

Destroys this property.

Note that subproperties are detached but not destroyed, i.e. they can still be used in another context.

See also: QtAbstractPropertyManager::clear()

◆ QtProperty()

QtProperty ( QtAbstractPropertyManager * manager )

explicitprotected

Creates a property with the given manager.

This constructor is only useful when creating a custom QtProperty subclass (e.g. QtVariantProperty). To create a regular QtProperty object, use the QtAbstractPropertyManager::addProperty() function instead.

See also: QtAbstractPropertyManager::addProperty()

Member Function Documentation

◆ addSubProperty()

void addSubProperty ( QtProperty * property )

Appends the given property to this property's subproperties.

If the given property already is added, this function does nothing.

See also: insertSubProperty(), removeSubProperty()

◆ displayText()

QString displayText ( ) const

Returns the display text according to the echo-mode set on the editor.

When the editor is a QLineEdit, this will return a string equal to what is displayed.

See also: QtAbstractPropertyManager::valueText()

◆ hasValue()

bool hasValue ( ) const

Returns whether the property has a value.

See also: QtAbstractPropertyManager::hasValue()

◆ insertSubProperty()

void insertSubProperty	(	QtProperty *	property,
		QtProperty *	precedingProperty )

Inserts the given property after the specified precedingProperty into this property's list of subproperties. If precedingProperty is 0, the specified property is inserted at the beginning of the list.

If the given property already is inserted, this function does nothing.