The QtProperty class encapsulates an instance of a property. More...
#include <qtpropertybrowser.h>
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) | |
Private Attributes | |
QtPropertyPrivate * | d_ptr |
Friends | |
class | QtAbstractPropertyManager |
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.
|
virtual |
Destroys this property.
Note that subproperties are detached but not destroyed, i.e. they can still be used in another context.
References d_ptr, QtAbstractPropertyManager::d_ptr, QtPropertyPrivate::m_manager, QtPropertyPrivate::m_parentItems, QtPropertyPrivate::m_subItems, QtAbstractPropertyManagerPrivate::propertyDestroyed(), and QtAbstractPropertyManagerPrivate::propertyRemoved().
|
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.
References d_ptr, and QtPropertyPrivate::q_ptr.
void QtProperty::addSubProperty | ( | QtProperty * | property | ) |
Appends the given property to this property's subproperties.
If the given property already is added, this function does nothing.
References d_ptr, insertSubProperty(), and QtPropertyPrivate::m_subItems.
Referenced by ObjectControllerPrivate::addClassProperties(), QtLocalePropertyManager::initializeProperty(), QtPointPropertyManager::initializeProperty(), QtPointFPropertyManager::initializeProperty(), QtSizePropertyManager::initializeProperty(), QtSizeFPropertyManager::initializeProperty(), QtRectPropertyManager::initializeProperty(), QtRectFPropertyManager::initializeProperty(), QtVector3DPropertyManager::initializeProperty(), QtSizePolicyPropertyManager::initializeProperty(), QtFontPropertyManager::initializeProperty(), QtColorPropertyManager::initializeProperty(), and main().
QString QtProperty::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.
References d_ptr, QtAbstractPropertyManager::displayText(), and QtPropertyPrivate::m_manager.
Referenced by QtVariantPropertyManager::valueText().
bool QtProperty::hasValue | ( | ) | const |
Returns whether the property has a value.
References d_ptr, QtAbstractPropertyManager::hasValue(), and QtPropertyPrivate::m_manager.
Referenced by QtPropertyEditorView::drawRow(), QtTreePropertyBrowserPrivate::hasValue(), QtPropertyEditorDelegate::paint(), and QtButtonPropertyBrowserPrivate::propertyInserted().
void QtProperty::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.
References d_ptr, QtAbstractPropertyManager::d_ptr, QtPropertyPrivate::m_manager, QtPropertyPrivate::m_subItems, QtAbstractPropertyManagerPrivate::propertyInserted(), and subProperties().
Referenced by addSubProperty(), and QtVariantPropertyManagerPrivate::createSubProperty().
bool QtProperty::isEnabled | ( | ) | const |
Returns whether the property is enabled.
References d_ptr, and QtPropertyPrivate::m_enabled.
bool QtProperty::isModified | ( | ) | const |
Returns whether the property is modified.
References d_ptr, and QtPropertyPrivate::m_modified.
|
protected |
References d_ptr, QtAbstractPropertyManager::d_ptr, QtPropertyPrivate::m_manager, and QtAbstractPropertyManagerPrivate::propertyChanged().
Referenced by setEnabled(), setModified(), setPropertyName(), setStatusTip(), setToolTip(), and setWhatsThis().
QtAbstractPropertyManager * QtProperty::propertyManager | ( | ) | const |
Returns a pointer to the manager that owns this property.
References d_ptr, and QtPropertyPrivate::m_manager.
Referenced by QtVariantPropertyManager::attributeValue(), QtAbstractEditorFactory< QtStringPropertyManager >::createEditor(), QtVariantPropertyManager::setAttribute(), QtVariantPropertyManager::setValue(), and QtVariantPropertyManager::value().
QString QtProperty::propertyName | ( | ) | const |
Returns the property's name.
References d_ptr, and QtPropertyPrivate::m_name.
Referenced by QtCursorEditorFactory::createEditor().
void QtProperty::removeSubProperty | ( | QtProperty * | property | ) |
Removes the given property from the list of subproperties without deleting it.
References d_ptr, QtAbstractPropertyManager::d_ptr, QtPropertyPrivate::m_manager, QtPropertyPrivate::m_subItems, QtAbstractPropertyManagerPrivate::propertyRemoved(), and subProperties().
void QtProperty::setEnabled | ( | bool | enable | ) |
Enables or disables the property according to the passed enable value.
References d_ptr, QtPropertyPrivate::m_enabled, and propertyChanged().
Referenced by ObjectControllerPrivate::addClassProperties().
void QtProperty::setModified | ( | bool | modified | ) |
Sets the property's modified state according to the passed modified value.
References d_ptr, QtPropertyPrivate::m_modified, and propertyChanged().
void QtProperty::setPropertyName | ( | const QString & | name | ) |
Sets the property's name to the given name.
References d_ptr, QtPropertyPrivate::m_name, and propertyChanged().
Referenced by QtVariantPropertyManagerPrivate::createSubProperty(), VariantManager::initializeProperty(), QtLocalePropertyManager::initializeProperty(), QtPointPropertyManager::initializeProperty(), QtPointFPropertyManager::initializeProperty(), QtSizePropertyManager::initializeProperty(), QtSizeFPropertyManager::initializeProperty(), QtRectPropertyManager::initializeProperty(), QtRectFPropertyManager::initializeProperty(), QtVector3DPropertyManager::initializeProperty(), QtSizePolicyPropertyManager::initializeProperty(), QtFontPropertyManager::initializeProperty(), QtColorPropertyManager::initializeProperty(), and QtFlagPropertyManager::setFlagNames().
void QtProperty::setStatusTip | ( | const QString & | text | ) |
Sets the property's status tip to the given text.
References d_ptr, QtPropertyPrivate::m_statusTip, and propertyChanged().
Referenced by QtVariantPropertyManagerPrivate::createSubProperty().
void QtProperty::setToolTip | ( | const QString & | text | ) |
Sets the property's tool tip to the given text.
References d_ptr, QtPropertyPrivate::m_toolTip, and propertyChanged().
Referenced by QtVariantPropertyManagerPrivate::createSubProperty().
void QtProperty::setWhatsThis | ( | const QString & | text | ) |
Sets the property's "What's This" help text to the given text.
References d_ptr, QtPropertyPrivate::m_whatsThis, and propertyChanged().
Referenced by QtVariantPropertyManagerPrivate::createSubProperty().
QString QtProperty::statusTip | ( | ) | const |
Returns the property's status tip.
References d_ptr, and QtPropertyPrivate::m_statusTip.
QList< QtProperty * > QtProperty::subProperties | ( | ) | const |
Returns the set of subproperties.
Note that subproperties are not owned by this property, but by the manager that created them.
References d_ptr, and QtPropertyPrivate::m_subItems.
Referenced by QtVariantPropertyManager::initializeProperty(), insertSubProperty(), and removeSubProperty().
QString QtProperty::toolTip | ( | ) | const |
Returns the property's tool tip.
References d_ptr, and QtPropertyPrivate::m_toolTip.
QIcon QtProperty::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.
References d_ptr, QtPropertyPrivate::m_manager, and QtAbstractPropertyManager::valueIcon().
Referenced by QtVariantPropertyManager::valueIcon().
QString QtProperty::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.
References d_ptr, QtPropertyPrivate::m_manager, and QtAbstractPropertyManager::valueText().
Referenced by QtVariantPropertyManager::valueText().
QString QtProperty::whatsThis | ( | ) | const |
Returns the property's "What's This" help text.
References d_ptr, and QtPropertyPrivate::m_whatsThis.
|
friend |
|
private |
Referenced by addSubProperty(), displayText(), hasValue(), insertSubProperty(), isEnabled(), isModified(), propertyChanged(), propertyManager(), propertyName(), QtProperty(), removeSubProperty(), setEnabled(), setModified(), setPropertyName(), setStatusTip(), setToolTip(), setWhatsThis(), statusTip(), subProperties(), toolTip(), valueIcon(), valueText(), whatsThis(), and ~QtProperty().