List of all members | Public Slots | Signals | Public Member Functions | Protected Member Functions
QtFlagPropertyManager Class Reference

The QtFlagPropertyManager provides and manages flag properties. More...

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

+ Inheritance diagram for QtFlagPropertyManager:

Public Slots

void setFlagNames (QtProperty *property, const QStringList &names)
 
void setValue (QtProperty *property, int val)
 

Signals

void flagNamesChanged (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

QStringList flagNames (const QtProperty *property) const
 
 QtFlagPropertyManager (QObject *parent=0)
 
QtBoolPropertyManager * subBoolPropertyManager () const
 
int value (const QtProperty *property) const
 
 ~QtFlagPropertyManager () override
 
- Public Member Functions inherited from QtAbstractPropertyManager
QtProperty * addProperty (const QString &name=QString())
 
void clear () const
 
QSet< QtProperty * > properties () const
 
 QtAbstractPropertyManager (QObject *parent=0)
 
 ~QtAbstractPropertyManager () override
 

Protected Member Functions

void initializeProperty (QtProperty *property) override
 
void uninitializeProperty (QtProperty *property) 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
 
virtual QIcon valueIcon (const QtProperty *property) const
 

Detailed Description

The QtFlagPropertyManager provides and manages flag properties.

Each flag property has an associated list of flag names which can be retrieved using the flagNames() function, and set using the corresponding setFlagNames() function.

The flag manager provides properties with nested boolean subproperties representing each flag, i.e. a flag property's value is the binary combination of the subproperties' values. A property's value can be retrieved and set using the value() and setValue() slots respectively. The combination of flags is represented by single int value - that's why it's possible to store up to 32 independent flags in one flag property.

The subproperties are created by a QtBoolPropertyManager object. This manager can be retrieved using the subBoolPropertyManager() function. In order to provide editing widgets for the subproperties in a property browser widget, this manager must be associated with an editor factory.

In addition, QtFlagPropertyManager provides the valueChanged() signal which is emitted whenever a property created by this manager changes, and the flagNamesChanged() signal which is emitted whenever the list of flag names is altered.

See also
QtAbstractPropertyManager, QtBoolPropertyManager

Definition at line 607 of file qtpropertymanager.h.

Constructor & Destructor Documentation

◆ QtFlagPropertyManager()

QtFlagPropertyManager ( QObject *  parent = 0)

Creates a manager with the given parent.

Definition at line 5798 of file qtpropertymanager.cpp.

◆ ~QtFlagPropertyManager()

~QtFlagPropertyManager ( )
override

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

Definition at line 5814 of file qtpropertymanager.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ flagNames()

QStringList flagNames ( const QtProperty *  property) const

Returns the given property's list of flag names.

See also
value(), setFlagNames()

Definition at line 5853 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ flagNamesChanged

void flagNamesChanged ( QtProperty *  property,
const QStringList &  names 
)
signal

This signal is emitted whenever a property created by this manager changes its flag names, passing a pointer to the property and the new names as parameters.

See also
setFlagNames()
+ Here is the caller graph for this function:

◆ initializeProperty()

void initializeProperty ( QtProperty *  property)
overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyManager.

Definition at line 6021 of file qtpropertymanager.cpp.

◆ setFlagNames

void setFlagNames ( QtProperty *  property,
const QStringList &  flagNames 
)
slot

Sets the given property's list of flag names to flagNames. The property's current value is reset to 0 indicating the first item of the list.

See also
flagNames(), flagNamesChanged()

Definition at line 5964 of file qtpropertymanager.cpp.

+ Here is the call graph for this function:

◆ setValue

void setValue ( QtProperty *  property,
int  value 
)
slot

Sets the value of the given property to value. Nested properties are updated automatically.

The specified value must be less than the binary combination of the property's flagNames() list size (i.e. less than 2\sup n, where n is the size of the list) and larger than (or equal to) 0.

See also
value(), valueChanged()

Definition at line 5908 of file qtpropertymanager.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ subBoolPropertyManager()

QtBoolPropertyManager * subBoolPropertyManager ( ) const

Returns the manager that produces the nested boolean subproperties representing each flag.

In order to provide editing widgets for the subproperties in a property browser widget, this manager must be associated with an editor factory.

See also
QtAbstractPropertyBrowser::setFactoryForManager()

Definition at line 5830 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ uninitializeProperty()

void uninitializeProperty ( QtProperty *  property)
overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 6031 of file qtpropertymanager.cpp.

◆ value()

int value ( const QtProperty *  property) const

Returns the given property's value.

If the given property is not managed by this manager, this function returns 0.

See also
flagNames(), setValue()

Definition at line 5843 of file qtpropertymanager.cpp.

◆ valueChanged

void 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()
+ Here is the caller graph for this function:

◆ valueText()

QString valueText ( const QtProperty *  property) const
overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 5861 of file qtpropertymanager.cpp.

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: