Home

QtEnumPropertyManager Class Reference

The QtEnumPropertyManager provides and manages enum properties. More...

 #include <QtEnumPropertyManager>

Inherits QtAbstractPropertyManager.

• List of all members, including inherited members

Public Functions

• QtEnumPropertyManager ( QObject * parent = 0 )
• ~QtEnumPropertyManager ()
• QMap<int, QIcon> enumIcons ( const QtProperty * property ) const
• QStringList enumNames ( const QtProperty * property ) const
• int value ( const QtProperty * property ) const

• 3 public functions inherited from QtAbstractPropertyManager
• 29 public functions inherited from QObject

Public Slots

• void setEnumIcons ( QtProperty * property, const QMap<int, QIcon> & enumIcons )
• void setEnumNames ( QtProperty * property, const QStringList & enumNames )
• void setValue ( QtProperty * property, int value )

• 1 public slot inherited from QObject

Signals

• void enumIconsChanged ( QtProperty * property, const QMap<int, QIcon> & icons )
• void enumNamesChanged ( QtProperty * property, const QStringList & names )
• void valueChanged ( QtProperty * property, int value )

• 4 signals inherited from QtAbstractPropertyManager
• 1 signal inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 6 protected functions inherited from QtAbstractPropertyManager
• 7 protected functions inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QtEnumPropertyManager provides and manages enum properties.

Each enum property has an associated list of enum names which can be retrieved using the enumNames() function, and set using the corresponding setEnumNames() function. An enum property's value is represented by an index in this list, and can be retrieved and set using the value() and setValue() slots respectively.

Each enum value can also have an associated icon. The mapping from values to icons can be set using the setEnumIcons() function and queried with the enumIcons() function.

In addition, QtEnumPropertyManager provides the valueChanged() signal which is emitted whenever a property created by this manager changes. The enumNamesChanged() or enumIconsChanged() signal is emitted whenever the list of enum names or icons is altered.

See also QtAbstractPropertyManager and QtEnumEditorFactory.

Member Function Documentation

QtEnumPropertyManager::QtEnumPropertyManager ( QObject * parent = 0 )

Creates a manager with the given parent.

QtEnumPropertyManager::~QtEnumPropertyManager ()

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

QMap<int, QIcon> QtEnumPropertyManager::enumIcons ( const QtProperty * property ) const

Returns the given property's map of enum values to their icons.

See also value() and setEnumIcons().

void QtEnumPropertyManager::enumIconsChanged ( QtProperty * property, const QMap<int, QIcon> & icons )   [signal]

This signal is emitted whenever a property created by this manager changes its enum icons, passing a pointer to the property and the new mapping of values to icons as parameters.

See also setEnumIcons().

QStringList QtEnumPropertyManager::enumNames ( const QtProperty * property ) const

Returns the given property's list of enum names.

See also value() and setEnumNames().

void QtEnumPropertyManager::enumNamesChanged ( QtProperty * property, const QStringList & names )   [signal]

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

See also setEnumNames().

void QtEnumPropertyManager::setEnumIcons ( QtProperty * property, const QMap<int, QIcon> & enumIcons )   [slot]

Sets the given property's map of enum values to their icons to enumIcons.

Each enum value can have associated icon. This association is represented with passed enumIcons map.

See also enumIcons(), enumNames(), and enumNamesChanged().

void QtEnumPropertyManager::setEnumNames ( QtProperty * property, const QStringList & enumNames )   [slot]

Sets the given property's list of enum names to enumNames. The property's current value is reset to 0 indicating the first item of the list.

If the specified enumNames list is empty, the property's current value is set to -1.

See also enumNames() and enumNamesChanged().

void QtEnumPropertyManager::setValue ( QtProperty * property, int value )   [slot]

Sets the value of the given property to value.

The specified value must be less than the size of the given property's enumNames() list, and larger than (or equal to) 0.

See also value() and valueChanged().

int QtEnumPropertyManager::value ( const QtProperty * property ) const

Returns the given property's value which is an index in the list returned by enumNames()

If the given property is not managed by this manager, this function returns -1.

See also enumNames() and setValue().

void QtEnumPropertyManager::valueChanged ( QtProperty * property, int 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().