itom
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
QtEnumPropertyManager Class Reference

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

Inheritance diagram for QtEnumPropertyManager:
QtAbstractPropertyManager

Public Slots

void setValue (QtProperty *property, int val)
 
void setEnumNames (QtProperty *property, const QStringList &names)
 
void setEnumIcons (QtProperty *property, const QMap< int, QIcon > &icons)
 

Signals

void valueChanged (QtProperty *property, int val)
 
void enumNamesChanged (QtProperty *property, const QStringList &names)
 
void enumIconsChanged (QtProperty *property, const QMap< int, QIcon > &icons)
 
- Signals inherited from QtAbstractPropertyManager
void propertyInserted (QtProperty *property, QtProperty *parent, QtProperty *after)
 
void propertyChanged (QtProperty *property)
 
void propertyRemoved (QtProperty *property, QtProperty *parent)
 
void propertyDestroyed (QtProperty *property)
 

Public Member Functions

 QtEnumPropertyManager (QObject *parent=0)
 
 ~QtEnumPropertyManager ()
 
int value (const QtProperty *property) const
 
QStringList enumNames (const QtProperty *property) const
 
QMap< int, QIcon > enumIcons (const QtProperty *property) const
 
- Public Member Functions inherited from QtAbstractPropertyManager
 QtAbstractPropertyManager (QObject *parent=0)
 
 ~QtAbstractPropertyManager ()
 
QSet< QtProperty * > properties () const
 
void clear () const
 
QtProperty * addProperty (const QString &name=QString())
 

Protected Member Functions

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

Private Attributes

QtEnumPropertyManagerPrivate * d_ptr
 

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, QtEnumEditorFactory

Constructor & Destructor Documentation

◆ QtEnumPropertyManager()

QtEnumPropertyManager::QtEnumPropertyManager ( QObject * parent = 0)

Creates a manager with the given parent.

◆ ~QtEnumPropertyManager()

QtEnumPropertyManager::~QtEnumPropertyManager ( )

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

Member Function Documentation

◆ enumIcons()

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

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

See also
value(), setEnumIcons()

◆ enumIconsChanged

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

◆ enumNames()

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

Returns the given property's list of enum names.

See also
value(), setEnumNames()

◆ enumNamesChanged

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

◆ initializeProperty()

void QtEnumPropertyManager::initializeProperty ( QtProperty * property)
protectedvirtual

\reimp

Implements QtAbstractPropertyManager.

◆ setEnumIcons

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
enumNames(), enumNamesChanged()

◆ setEnumNames

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

◆ setValue

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

◆ uninitializeProperty()

void QtEnumPropertyManager::uninitializeProperty ( QtProperty * property)
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

◆ value()

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

◆ valueChanged

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

◆ valueIcon()

QIcon QtEnumPropertyManager::valueIcon ( const QtProperty * property) const
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

◆ valueText()

QString QtEnumPropertyManager::valueText ( const QtProperty * property) const
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

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