Workspace 6.21.5
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QtColorPropertyManager Class Reference

The QtColorPropertyManager provides and manages QColor properties. More...

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

Inheritance diagram for QtColorPropertyManager:
[legend]

Public Slots

void setValue (QtProperty *property, const QColor &val)
 

Signals

void valueChanged (QtProperty *property, const QColor &val)
 
- Signals inherited from QtAbstractPropertyManager
void propertyChanged (QtProperty *property)
 
void propertyDestroyed (QtProperty *property)
 
void propertyInserted (QtProperty *property, QtProperty *parent, QtProperty *after)
 
void propertyRemoved (QtProperty *property, QtProperty *parent)
 

Public Member Functions

 QtColorPropertyManager (QObject *parent=nullptr)
 
 ~QtColorPropertyManager ()
 
QtIntPropertyManagersubIntPropertyManager () const
 
QColor value (const QtProperty *property) const
 
- Public Member Functions inherited from QtAbstractPropertyManager
 QtAbstractPropertyManager (QObject *parent=nullptr)
 
 ~QtAbstractPropertyManager ()
 
QtPropertyaddProperty (const QString &name=QString())
 
void clear () const
 
bool getModifiedOnValueChanged () const
 
QSet< QtProperty * > properties () const
 
void setModifiedOnValueChanged (bool modified)
 

Protected Member Functions

virtual void initializeProperty (QtProperty *property)
 
virtual void uninitializeProperty (QtProperty *property)
 
QIcon valueIcon (const QtProperty *property) const
 
QString valueText (const QtProperty *property) const
 
- Protected Member Functions inherited from QtAbstractPropertyManager
virtual QtPropertycreateProperty ()
 
virtual QString displayText (const QtProperty *property) const
 
virtual EchoMode echoMode (const QtProperty *) const
 
virtual bool hasValue (const QtProperty *property) const
 
virtual void initializeProperty (QtProperty *property)=0
 
virtual void uninitializeProperty (QtProperty *property)
 
virtual QIcon valueIcon (const QtProperty *property) const
 
virtual QString valueText (const QtProperty *property) const
 

Detailed Description

A color property has nested red, green and blue subproperties. The top-level property's value can be retrieved using the value() function, and set using the setValue() slot.

The subproperties are created by a QtIntPropertyManager object. This manager can be retrieved using the subIntPropertyManager() function. In order to provide editing widgets for the subproperties in a property browser widget, this manager must be associated with an editor factory.

In addition, QtColorPropertyManager provides the valueChanged() signal which is emitted whenever a property created by this manager changes.

See also
QtAbstractPropertyManager, QtAbstractPropertyBrowser, QtIntPropertyManager

Constructor & Destructor Documentation

◆ QtColorPropertyManager()

QtColorPropertyManager ( QObject *  parent = nullptr)

Creates a manager with the given parent.

◆ ~QtColorPropertyManager()

Destroys this manager, and all the properties it has created.

Member Function Documentation

◆ initializeProperty()

void initializeProperty ( QtProperty property)
protectedvirtual

This function is called whenever a new valid property pointer has been created, passing the pointer as parameter.

The purpose is to let the manager know that the property has been created so that it can provide additional attributes for the new property, e.g. QtIntPropertyManager adds {QtIntPropertyManager::value()}{value}, {QtIntPropertyManager::minimum()}{minimum} and {QtIntPropertyManager::maximum()}{maximum} attributes. Since each manager subclass adds type specific attributes, this function is pure virtual and must be reimplemented when deriving from the QtAbstractPropertyManager class.

See also
addProperty(), createProperty()

Implements QtAbstractPropertyManager.

◆ setValue

void setValue ( QtProperty property,
const QColor &  value 
)
slot

Sets the value of the given property to value. Nested properties are updated automatically.

See also
value(), valueChanged()

◆ subIntPropertyManager()

QtIntPropertyManager * subIntPropertyManager ( ) const

Returns the manager that produces the nested red, green and blue subproperties.

In order to provide editing widgets for the subproperties in a property browser widget, this manager must be associated with an editor factory.

See also
QtAbstractPropertyBrowser::setFactoryForManager()

◆ uninitializeProperty()

void uninitializeProperty ( QtProperty property)
protectedvirtual

This function is called just before the specified property is destroyed.

The purpose is to let the property manager know that the property is being destroyed so that it can remove the property's additional attributes.

See also
clear(), propertyDestroyed()

Reimplemented from QtAbstractPropertyManager.

◆ value()

QColor value ( const QtProperty property) const

Returns the given property's value.

If the given property is not managed by this manager, this function returns an invalid color.

See also
setValue()

◆ valueChanged

void valueChanged ( QtProperty property,
const QColor &  value 
)
signal

This signal is emitted whenever a property created by this manager changes its value, passing a pointer to the property and the new value as parameters.

See also
setValue()

◆ valueIcon()

QIcon valueIcon ( const QtProperty property) const
protectedvirtual

Returns an icon representing the current state of the given property.

The default implementation of this function returns an invalid icon.

See also
QtProperty::valueIcon()

Reimplemented from QtAbstractPropertyManager.

◆ valueText()

QString valueText ( const QtProperty property) const
protectedvirtual

Returns a string representing the current state of the given property.

The default implementation of this function returns an empty string.

See also
QtProperty::valueText()

Reimplemented from QtAbstractPropertyManager.