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

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

#include <Workspace/Widgets/PropertyBrowser/qtpropertybrowser.h>

Inheritance diagram for QtProperty:
[legend]

Public Member Functions

virtual ~QtProperty ()
 
void addSubProperty (QtProperty *property)
 
QString displayText () const
 
QString getGlobalName () const
 
bool hasValue () const
 
void insertSubProperty (QtProperty *property, QtProperty *afterProperty)
 
bool isEnabled () const
 
bool isModified () const
 
QtAbstractPropertyManagerpropertyManager () const
 
QString propertyName () const
 
void removeSubProperty (QtProperty *property)
 
void setEnabled (bool enable)
 
void setGlobalName (const QString &globalName)
 
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
 

Protected Member Functions

 QtProperty (QtAbstractPropertyManager *manager)
 
void propertyChanged ()
 

Detailed Description

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:

Getter Setter
propertyName() setPropertyName()
statusTip() setStatusTip()
toolTip() setToolTip()
whatsThis() setWhatsThis()
isEnabled() setEnabled()
isModified() setModified()
valueText() Nop
valueIcon() Nop

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

◆ getGlobalName()

QString getGlobalName ( ) const

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

See also
addSubProperty(), removeSubProperty()

◆ isEnabled()

bool isEnabled ( ) const

Returns whether the property is enabled.

See also
setEnabled()

◆ isModified()

bool isModified ( ) const

Returns whether the property is modified.

See also
setModified()

◆ propertyChanged()

void propertyChanged ( )
protected

◆ propertyManager()

QtAbstractPropertyManager * propertyManager ( ) const

Returns a pointer to the manager that owns this property.

◆ propertyName()

QString propertyName ( ) const

Returns the property's name.

See also
setPropertyName()

◆ removeSubProperty()

void removeSubProperty ( QtProperty property)

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

See also
addSubProperty(), insertSubProperty()

◆ setEnabled()

void setEnabled ( bool  enable)

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

See also
isEnabled()

◆ setGlobalName()

void setGlobalName ( const QString &  globalName)

◆ setModified()

void setModified ( bool  modified)

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

See also
isModified()

◆ setPropertyName()

void setPropertyName ( const QString &  name)

Sets the property's name to the given name.

See also
propertyName()

◆ setStatusTip()

void setStatusTip ( const QString &  text)

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

See also
statusTip()

◆ setToolTip()

void setToolTip ( const QString &  text)

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

See also
toolTip()

◆ setWhatsThis()

void setWhatsThis ( const QString &  text)

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

See also
whatsThis()

◆ statusTip()

QString statusTip ( ) const

Returns the property's status tip.

See also
setStatusTip()

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

◆ toolTip()

QString toolTip ( ) const

Returns the property's tool tip.

See also
setToolTip()

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

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

◆ whatsThis()

QString whatsThis ( ) const

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

See also
setWhatsThis()