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

#include <qtpropertymanager_p.h>

Inheritance diagram for QtEnumPropertyManager:

Collaboration diagram for QtEnumPropertyManager:

Public Slots
void	setValue (QtProperty *property, int val)
	Sets the value of the given property to value.

void	setEnumNames (QtProperty *property, const QStringList &names)
	Sets the given property's list of enum names to enumNames.

void	setEnumIcons (QtProperty *property, const QMap< int, QIcon > &icons)
	Sets the given property's map of enum values to their icons to enumIcons.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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

void	enumNamesChanged (QtProperty *property, const QStringList &names)
	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.

void	enumIconsChanged (QtProperty *property, const QMap< int, QIcon > &icons)
	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.

Signals inherited from QtAbstractPropertyManager
void	propertyInserted (QtProperty property, QtProperty parent, QtProperty *after)
	This signal is emitted when a new subproperty is inserted into an existing property, passing pointers to the newProperty, parentProperty and precedingProperty as parameters.

void	propertyChanged (QtProperty *property)
	This signal is emitted whenever a property's data changes, passing a pointer to the property as parameter.

void	propertyRemoved (QtProperty property, QtProperty parent)
	This signal is emitted when a subproperty is removed, passing pointers to the removed property and the parent property as parameters.

void	propertyDestroyed (QtProperty *property)
	This signal is emitted when the specified property is about to be destroyed.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QtEnumPropertyManager (QObject *parent=nullptr)
	Creates a manager with the given parent.

	~QtEnumPropertyManager () override
	Destroys this manager, and all the properties it has created.

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

QStringList	enumNames (const QtProperty *property) const
	Returns the given property's list of enum names.

QMap< int, QIcon >	enumIcons (const QtProperty *property) const
	Returns the given property's map of enum values to their icons.

Public Member Functions inherited from QtAbstractPropertyManager
	QtAbstractPropertyManager (QObject *parent=nullptr)
	Creates an abstract property manager with the given parent.

	~QtAbstractPropertyManager () override
	Destroys the manager.

QSet< QtProperty * >	properties () const
	Returns the set of properties created by this manager.

void	clear () const
	Destroys all the properties that this manager has created.

QtProperty *	addProperty (const QString &name=QString())
	Creates a property with the given name which then is owned by this manager.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Member Functions
QString	valueText (const QtProperty *property) const override
	\reimp

QIcon	valueIcon (const QtProperty *property) const override
	\reimp

void	initializeProperty (QtProperty *property) override
	\reimp

void	uninitializeProperty (QtProperty *property) override
	\reimp

Protected Member Functions inherited from QtAbstractPropertyManager
virtual bool	hasValue (const QtProperty *property) const
	Returns whether the given property has a value.

virtual QtProperty *	createProperty ()
	Creates a property.

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QtEnumPropertyManager provides and manages enum properties.

\inmodule QtDesigner

Since: 4.4

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

Definition at line 517 of file qtpropertymanager_p.h.

Constructor & Destructor Documentation

◆ QtEnumPropertyManager()

QtEnumPropertyManager::QtEnumPropertyManager ( QObject * parent = nullptr )

Creates a manager with the given parent.

Definition at line 4626 of file qtpropertymanager.cpp.

◆ ~QtEnumPropertyManager()

QtEnumPropertyManager::~QtEnumPropertyManager ( )

override

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

Definition at line 4635 of file qtpropertymanager.cpp.

References QtAbstractPropertyManager::clear().

Here is the call graph for this function:

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

Definition at line 4669 of file qtpropertymanager.cpp.

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

Definition at line 4659 of file qtpropertymanager.cpp.

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

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyManager.

Definition at line 4804 of file qtpropertymanager.cpp.

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

Definition at line 4788 of file qtpropertymanager.cpp.

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

Definition at line 4754 of file qtpropertymanager.cpp.

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

Definition at line 4716 of file qtpropertymanager.cpp.

◆ uninitializeProperty()

void QtEnumPropertyManager::uninitializeProperty ( QtProperty * property )

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 4812 of file qtpropertymanager.cpp.

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

Definition at line 4649 of file qtpropertymanager.cpp.

Referenced by QtEnumEditorFactory::createEditor().

Here is the caller graph for this function:

◆ 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

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 4694 of file qtpropertymanager.cpp.

◆ valueText()

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

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 4677 of file qtpropertymanager.cpp.

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

qttools/src/shared/qtpropertybrowser/qtpropertymanager_p.h (b6a14f6c08c898f618a34f29c6ffa01fa7f7ccc0)
qttools/src/shared/qtpropertybrowser/qtpropertymanager.cpp (0526daae8186ccf594b764d1d4784e2ec7848b3b)

Public Slots

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QtEnumPropertyManager()

◆ ~QtEnumPropertyManager()

Member Function Documentation

◆ enumIcons()

◆ enumIconsChanged

◆ enumNames()

◆ enumNamesChanged

◆ initializeProperty()

◆ setEnumIcons

◆ setEnumNames

◆ setValue

◆ uninitializeProperty()

◆ value()

◆ valueChanged

◆ valueIcon()

◆ valueText()