QSapecNG
Signals | Public Member Functions | Protected Member Functions | Friends
QtAbstractPropertyManager Class Reference

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

Inheritance diagram for QtAbstractPropertyManager:
QtBoolPropertyManager QtCharPropertyManager QtColorPropertyManager QtCursorPropertyManager QtDatePropertyManager QtDateTimePropertyManager QtDoublePropertyManager QtEnumPropertyManager QtFlagPropertyManager QtFontPropertyManager QtGroupPropertyManager QtIntPropertyManager QtKeySequencePropertyManager QtLocalePropertyManager QtPointFPropertyManager QtPointPropertyManager QtRectFPropertyManager QtRectPropertyManager QtSizeFPropertyManager QtSizePolicyPropertyManager QtSizePropertyManager QtStringPropertyManager QtTimePropertyManager QtVariantPropertyManager

List of all members.

Signals

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

 QtAbstractPropertyManager (QObject *parent=0)
 ~QtAbstractPropertyManager ()
QSet< QtProperty * > properties () const
void clear () const
QtPropertyaddProperty (const QString &name=QString())

Protected Member Functions

virtual bool hasValue (const QtProperty *property) const
virtual QIcon valueIcon (const QtProperty *property) const
virtual QString valueText (const QtProperty *property) const
virtual void initializeProperty (QtProperty *property)=0
virtual void uninitializeProperty (QtProperty *property)
virtual QtPropertycreateProperty ()

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:

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

See also:
QtAbstractEditorFactoryBase, QtAbstractPropertyBrowser, QtProperty

Constructor & Destructor Documentation

QtAbstractPropertyManager::QtAbstractPropertyManager ( QObject *  parent = 0) [explicit]

Creates an abstract property manager with the given parent.

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


Member Function Documentation

QtProperty * QtAbstractPropertyManager::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()

Destroys all the properties that this manager has created.

See also:
propertyDestroyed(), uninitializeProperty()

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.

bool QtAbstractPropertyManager::hasValue ( const QtProperty property) const [protected, virtual]

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.

void QtAbstractPropertyManager::initializeProperty ( QtProperty property) [protected, pure 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 {QtIntPropertyManager::value()}{value}, {QtIntPropertyManager::minimum()}{minimum} and {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, and QtGroupPropertyManager.

Returns the set of properties created by this manager.

See also:
addProperty()

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

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()
void QtAbstractPropertyManager::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()
void QtAbstractPropertyManager::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()
void QtAbstractPropertyManager::uninitializeProperty ( QtProperty property) [protected, virtual]
QIcon QtAbstractPropertyManager::valueIcon ( const QtProperty property) const [protected, virtual]

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, and QtVariantPropertyManager.

QString QtAbstractPropertyManager::valueText ( const QtProperty property) const [protected, virtual]

The documentation for this class was generated from the following files:
 All Classes Functions Enumerations Properties