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

#include <qtpropertymanager.h>

Public Slots
void	setEnumIcons (QtProperty *property, const QMap< int, QIcon > &icons)

void	setEnumNames (QtProperty *property, const QStringList &names)

void	setValue (QtProperty *property, int val)

Signals
void	enumIconsChanged (QtProperty *property, const QMap< int, QIcon > &icons)

void	enumNamesChanged (QtProperty *property, const QStringList &names)

void	valueChanged (QtProperty *property, int 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
QMap< int, QIcon >	enumIcons (const QtProperty *property) const

QStringList	enumNames (const QtProperty *property) const

	QtEnumPropertyManager (QObject *parent=nullptr)

int	value (const QtProperty *property) const

	~QtEnumPropertyManager () override

Public Member Functions inherited from QtAbstractPropertyManager
QtProperty *	addProperty (const QString &name=QString())

void	clear () const

QSet< QtProperty * >	properties () const

	QtAbstractPropertyManager (QObject *parent=nullptr)

	~QtAbstractPropertyManager () override

Protected Member Functions
void	initializeProperty (QtProperty *property) override

void	uninitializeProperty (QtProperty *property) override

QIcon	valueIcon (const QtProperty *property) const override

QString	valueText (const QtProperty *property) const override

Protected Member Functions inherited from QtAbstractPropertyManager
virtual QtProperty *	createProperty ()

virtual QString	displayText (const QtProperty *property) const

virtual EchoMode	echoMode (const QtProperty *) const

virtual bool	hasValue (const QtProperty *property) const

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 = nullptr )

Creates a manager with the given parent.

References d_ptr, and QtEnumPropertyManagerPrivate::q_ptr.

◆ ~QtEnumPropertyManager()

QtEnumPropertyManager::~QtEnumPropertyManager ( )

override

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

References QtAbstractPropertyManager::clear(), and d_ptr.

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

References d_ptr, QtEnumPropertyManagerPrivate::Data::enumIcons, and QtEnumPropertyManagerPrivate::m_values.

Referenced by QtEnumEditorFactory::createEditor(), setEnumIcons(), and QtEnumEditorFactoryPrivate::slotEnumNamesChanged().

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

Referenced by setEnumIcons().

◆ enumNames()

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

Returns the given property's list of enum names.

See also: value(), setEnumNames()

References d_ptr, QtEnumPropertyManagerPrivate::Data::enumNames, and QtEnumPropertyManagerPrivate::m_values.

Referenced by QtEnumEditorFactory::createEditor(), setEnumNames(), and QtEnumEditorFactoryPrivate::slotEnumIconsChanged().

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

Referenced by setEnumNames().

◆ initializeProperty()

void QtEnumPropertyManager::initializeProperty ( QtProperty * property )

overrideprotectedvirtual

Implements QtAbstractPropertyManager.

References d_ptr, and QtEnumPropertyManagerPrivate::m_values.

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

References d_ptr, enumIcons(), enumIconsChanged(), QtEnumPropertyManagerPrivate::m_values, and QtAbstractPropertyManager::propertyChanged().

Referenced by QtCursorEditorFactory::createEditor(), and main().

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

References d_ptr, enumNames(), QtEnumPropertyManagerPrivate::Data::enumNames, enumNamesChanged(), QtEnumPropertyManagerPrivate::m_values, QtAbstractPropertyManager::propertyChanged(), QtEnumPropertyManagerPrivate::Data::val, and valueChanged().

Referenced by QtCursorEditorFactory::createEditor(), QtLocalePropertyManager::initializeProperty(), QtSizePolicyPropertyManager::initializeProperty(), QtFontPropertyManager::initializeProperty(), main(), and QtLocalePropertyManager::setValue().

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

References d_ptr, QtEnumPropertyManagerPrivate::Data::enumNames, QtEnumPropertyManagerPrivate::m_values, QtAbstractPropertyManager::propertyChanged(), QtEnumPropertyManagerPrivate::Data::val, and valueChanged().

Referenced by QtCursorEditorFactory::createEditor(), QtLocalePropertyManager::initializeProperty(), QtSizePolicyPropertyManager::initializeProperty(), QtFontPropertyManager::initializeProperty(), QtLocalePropertyManager::setValue(), QtSizePolicyPropertyManager::setValue(), QtFontPropertyManager::setValue(), QtCursorEditorFactoryPrivate::slotPropertyChanged(), and QtEnumEditorFactoryPrivate::slotSetValue().

◆ uninitializeProperty()

void QtEnumPropertyManager::uninitializeProperty ( QtProperty * property )

overrideprotectedvirtual

Reimplemented from QtAbstractPropertyManager.

References d_ptr, and QtEnumPropertyManagerPrivate::m_values.

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

References d_ptr, and QtEnumPropertyManagerPrivate::m_values.

Referenced by QtEnumEditorFactory::createEditor(), QtEnumEditorFactoryPrivate::slotEnumIconsChanged(), and QtEnumEditorFactoryPrivate::slotEnumNamesChanged().

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