The QtAbstractPropertyManager provides an interface for property managers. More...

#include <ArmarXGui/libraries/qtpropertybrowser/src/qtpropertybrowser.h>

Inheritance diagram for QtAbstractPropertyManager:

Signals
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
QtProperty *	addProperty (const QString &name=QString())

void	clear () const

QSet< QtProperty * >	properties () const

	QtAbstractPropertyManager (QObject *parent=0)

	~QtAbstractPropertyManager () override

Protected Member Functions
virtual QtProperty *	createProperty ()

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

Friends
class	QtProperty

Detailed Description

The QtAbstractPropertyManager provides an interface for property managers.

A manager can create and manage properties of a given type, and is used in conjunction with the QtAbstractPropertyBrowser class.

When using a property browser widget, the properties are created and managed by implementations of the QtAbstractPropertyManager class. To ensure that the properties' values will be displayed using suitable editing widgets, the managers are associated with objects of QtAbstractEditorFactory subclasses. The property browser will use these associations to determine which factories it should use to create the preferred editing widgets.

The QtAbstractPropertyManager class provides common functionality like creating a property using the addProperty() function, and retrieving the properties created by the manager using the properties() function. The class also provides signals that are emitted when the manager's properties change: propertyInserted(), propertyRemoved(), propertyChanged() and propertyDestroyed().

QtAbstractPropertyManager subclasses are supposed to provide their own type specific API. Note that several ready-made implementations are available:

\list \o QtBoolPropertyManager \o QtColorPropertyManager \o QtDatePropertyManager \o QtDateTimePropertyManager \o QtDoublePropertyManager \o QtEnumPropertyManager \o QtFlagPropertyManager \o QtFontPropertyManager \o QtGroupPropertyManager \o QtIntPropertyManager \o QtPointPropertyManager \o QtRectPropertyManager \o QtSizePropertyManager \o QtSizePolicyPropertyManager \o QtStringPropertyManager \o QtTimePropertyManager \o QtVariantPropertyManager \endlist

See also: QtAbstractEditorFactoryBase, QtAbstractPropertyBrowser, QtProperty

Definition at line 112 of file qtpropertybrowser.h.

Constructor & Destructor Documentation

◆ QtAbstractPropertyManager()

QtAbstractPropertyManager ( QObject * parent = 0 )

explicit

Creates an abstract property manager with the given parent.

Definition at line 703 of file qtpropertybrowser.cpp.

◆ ~QtAbstractPropertyManager()

~QtAbstractPropertyManager ( )

override

Destroys the manager. All properties created by the manager are destroyed.

Definition at line 715 of file qtpropertybrowser.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ addProperty()

QtProperty * addProperty ( const QString & name = QString() )

Creates a property with the given name which then is owned by this manager.

Internally, this function calls the createProperty() and initializeProperty() functions.

See also: initializeProperty(), properties()

Definition at line 826 of file qtpropertybrowser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void clear ( ) const

Destroys all the properties that this manager has created.

See also: propertyDestroyed(), uninitializeProperty()

Definition at line 726 of file qtpropertybrowser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createProperty()

QtProperty * createProperty ( )

protectedvirtual

Creates a property.

The base implementation produce QtProperty instances; Reimplement this function to make this manager produce objects of a QtProperty subclass.

See also: addProperty(), initializeProperty()

Reimplemented in QtVariantPropertyManager.

Definition at line 849 of file qtpropertybrowser.cpp.

Here is the caller graph for this function:

◆ displayText()

QString displayText ( 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 in QtStringPropertyManager.

Definition at line 798 of file qtpropertybrowser.cpp.

Here is the caller graph for this function:

◆ echoMode()

EchoMode echoMode ( const QtProperty * property ) const

protectedvirtual

Returns the echo mode representing the current state of the given property.

The default implementation of this function returns QLineEdit::Normal.

See also: QtProperty::valueText()

Reimplemented in QtStringPropertyManager.

Definition at line 812 of file qtpropertybrowser.cpp.

◆ hasValue()

bool hasValue ( const QtProperty * property ) const

protectedvirtual

Returns whether the given property has a value.

The default implementation of this function returns true.

See also: QtProperty::hasValue()

Reimplemented in QtVariantPropertyManager, and QtGroupPropertyManager.

Definition at line 753 of file qtpropertybrowser.cpp.

Here is the caller graph for this function:

◆ initializeProperty()

void initializeProperty ( QtProperty * property )

protectedpure virtual

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 \l {QtIntPropertyManager::value()}{value}, \l {QtIntPropertyManager::minimum()}{minimum} and \l {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()

Implemented in QtCursorPropertyManager, QtColorPropertyManager, QtFontPropertyManager, QtSizePolicyPropertyManager, QtFlagPropertyManager, QtEnumPropertyManager, QtRectFPropertyManager, QtRectPropertyManager, QtSizeFPropertyManager, QtSizePropertyManager, QtPointFPropertyManager, QtPointPropertyManager, QtLocalePropertyManager, QtCharPropertyManager, QtKeySequencePropertyManager, QtDateTimePropertyManager, QtTimePropertyManager, QtDatePropertyManager, QtStringPropertyManager, QtDoublePropertyManager, QtBoolPropertyManager, QtVariantPropertyManager, QtIntPropertyManager, QtGroupPropertyManager, OptionalVariantManager, DecoratedDoublePropertyManager, and VariantManager.

Here is the caller graph for this function:

◆ properties()

QSet< QtProperty * > properties ( ) const

Returns the set of properties created by this manager.

See also: addProperty()

Definition at line 741 of file qtpropertybrowser.cpp.

Here is the caller graph for this function:

◆ propertyChanged

void propertyChanged ( QtProperty * property )

signal

This signal is emitted whenever a property's data changes, passing a pointer to the property as parameter.

Note that signal is only emitted for properties that are created by this manager.

See also: QtAbstractPropertyBrowser::itemChanged()

◆ propertyDestroyed

void propertyDestroyed ( QtProperty * property )

signal

This signal is emitted when the specified property is about to be destroyed.

Note that signal is only emitted for properties that are created by this manager.

See also: clear(), uninitializeProperty()

Here is the caller graph for this function:

◆ propertyInserted

void propertyInserted	(	QtProperty *	newProperty,
		QtProperty *	parentProperty,
		QtProperty *	precedingProperty
	)

signal

This signal is emitted when a new subproperty is inserted into an existing property, passing pointers to the newProperty, parentProperty and precedingProperty as parameters.

If precedingProperty is 0, the newProperty was inserted at the beginning of the parentProperty's subproperties list.

Note that signal is emitted only if the parentProperty is created by this manager.

See also: QtAbstractPropertyBrowser::itemInserted()

Here is the caller graph for this function:

◆ propertyRemoved

void propertyRemoved	(	QtProperty *	property,
		QtProperty *	parent
	)

signal

This signal is emitted when a subproperty is removed, passing pointers to the removed property and the parent property as parameters.

Note that signal is emitted only when the parent property is created by this manager.

See also: QtAbstractPropertyBrowser::itemRemoved()

Here is the caller graph for this function:

◆ 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 in QtCursorPropertyManager, QtColorPropertyManager, QtFontPropertyManager, QtSizePolicyPropertyManager, QtFlagPropertyManager, QtEnumPropertyManager, QtRectFPropertyManager, QtRectPropertyManager, QtSizeFPropertyManager, QtSizePropertyManager, QtPointFPropertyManager, QtPointPropertyManager, QtLocalePropertyManager, QtCharPropertyManager, QtKeySequencePropertyManager, QtDateTimePropertyManager, QtTimePropertyManager, QtDatePropertyManager, QtStringPropertyManager, QtDoublePropertyManager, QtBoolPropertyManager, QtVariantPropertyManager, QtIntPropertyManager, QtGroupPropertyManager, OptionalVariantManager, DecoratedDoublePropertyManager, and VariantManager.

Definition at line 882 of file qtpropertybrowser.cpp.

Here is the caller graph for this function:

◆ 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 in QtCursorPropertyManager, QtColorPropertyManager, QtFontPropertyManager, QtEnumPropertyManager, QtBoolPropertyManager, QtVariantPropertyManager, and OptionalVariantManager.

Definition at line 768 of file qtpropertybrowser.cpp.

Here is the caller graph for this function:

◆ 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 in QtCursorPropertyManager, QtColorPropertyManager, QtFontPropertyManager, QtSizePolicyPropertyManager, QtFlagPropertyManager, QtEnumPropertyManager, QtRectFPropertyManager, QtRectPropertyManager, QtSizeFPropertyManager, QtSizePropertyManager, QtPointFPropertyManager, QtPointPropertyManager, QtLocalePropertyManager, QtCharPropertyManager, QtKeySequencePropertyManager, QtDateTimePropertyManager, QtTimePropertyManager, QtDatePropertyManager, QtStringPropertyManager, QtDoublePropertyManager, QtBoolPropertyManager, QtVariantPropertyManager, QtIntPropertyManager, OptionalVariantManager, DecoratedDoublePropertyManager, and VariantManager.

Definition at line 783 of file qtpropertybrowser.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QtProperty

friend class QtProperty

friend

Definition at line 141 of file qtpropertybrowser.h.

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

ArmarXGui/libraries/qtpropertybrowser/src/qtpropertybrowser.h
ArmarXGui/libraries/qtpropertybrowser/src/qtpropertybrowser.cpp

Signals

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QtAbstractPropertyManager()

◆ ~QtAbstractPropertyManager()

Member Function Documentation

◆ addProperty()

◆ clear()

◆ createProperty()

◆ displayText()

◆ echoMode()

◆ hasValue()

◆ initializeProperty()

◆ properties()

◆ propertyChanged

◆ propertyDestroyed

◆ propertyInserted

◆ propertyRemoved

◆ uninitializeProperty()

◆ valueIcon()

◆ valueText()

Friends And Related Function Documentation

◆ QtProperty