List of all members | Public Member Functions | Protected Member Functions | Friends
QtProperty Class Reference

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

Definition at line 71 of file qtpropertybrowser.h.

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()

Definition at line 162 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:

◆ 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()

Definition at line 147 of file qtpropertybrowser.cpp.

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()

Definition at line 448 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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()

Definition at line 330 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasValue()

bool hasValue ( ) const

Returns whether the property has a value.

See also
QtAbstractPropertyManager::hasValue()

Definition at line 288 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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.

See also
addSubProperty(), removeSubProperty()

Definition at line 474 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isEnabled()

bool isEnabled ( ) const

Returns whether the property is enabled.

See also
setEnabled()

Definition at line 266 of file qtpropertybrowser.cpp.

◆ isModified()

bool isModified ( ) const

Returns whether the property is modified.

See also
setModified()

Definition at line 277 of file qtpropertybrowser.cpp.

◆ propertyChanged()

void propertyChanged ( )
protected

Definition at line 576 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ propertyManager()

QtAbstractPropertyManager * propertyManager ( ) const

Returns a pointer to the manager that owns this property.

Definition at line 211 of file qtpropertybrowser.cpp.

+ Here is the caller graph for this function:

◆ propertyName()

QString propertyName ( ) const

Returns the property's name.

See also
setPropertyName()

Definition at line 255 of file qtpropertybrowser.cpp.

+ Here is the caller graph for this function:

◆ removeSubProperty()

void removeSubProperty ( QtProperty *  property)

Removes the given property from the list of subproperties without deleting it.

See also
addSubProperty(), insertSubProperty()

Definition at line 546 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:

◆ setEnabled()

void setEnabled ( bool  enable)

Enables or disables the property according to the passed enable value.

See also
isEnabled()

Definition at line 411 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setModified()

void setModified ( bool  modified)

Sets the property's modified state according to the passed modified value.

See also
isModified()

Definition at line 428 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:

◆ setPropertyName()

void setPropertyName ( const QString &  name)

Sets the property's name to the given name.

See also
propertyName()

Definition at line 394 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setStatusTip()

void setStatusTip ( const QString &  text)

Sets the property's status tip to the given text.

See also
statusTip()

Definition at line 358 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setToolTip()

void setToolTip ( const QString &  text)

Sets the property's tool tip to the given text.

See also
toolTip()

Definition at line 341 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setWhatsThis()

void setWhatsThis ( const QString &  text)

Sets the property's "What's This" help text to the given text.

See also
whatsThis()

Definition at line 375 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ statusTip()

QString statusTip ( ) const

Returns the property's status tip.

See also
setStatusTip()

Definition at line 233 of file qtpropertybrowser.cpp.

◆ subProperties()

QList< QtProperty * > subProperties ( ) const

Returns the set of subproperties.

Note that subproperties are not owned by this property, but by the manager that created them.

See also
insertSubProperty(), removeSubProperty()

Definition at line 202 of file qtpropertybrowser.cpp.

+ Here is the caller graph for this function:

◆ toolTip()

QString toolTip ( ) const

Returns the property's tool tip.

See also
setToolTip()

Definition at line 222 of file qtpropertybrowser.cpp.

◆ valueIcon()

QIcon valueIcon ( ) const

Returns an icon representing the current state of this property.

If the given property type can not generate such an icon, this function returns an invalid icon.

See also
QtAbstractPropertyManager::valueIcon()

Definition at line 302 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ valueText()

QString valueText ( ) const

Returns a string representing the current state of this property.

If the given property type can not generate such a string, this function returns an empty string.

See also
QtAbstractPropertyManager::valueText()

Definition at line 316 of file qtpropertybrowser.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ whatsThis()

QString whatsThis ( ) const

Returns the property's "What's This" help text.

See also
setWhatsThis()

Definition at line 244 of file qtpropertybrowser.cpp.

Friends And Related Function Documentation

◆ QtAbstractPropertyManager

friend class QtAbstractPropertyManager
friend

Definition at line 108 of file qtpropertybrowser.h.

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