The QtVariantPropertyManager class provides and manages QVariant based properties. More...

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

Inheritance diagram for QtVariantPropertyManager:

Public Slots
virtual void	setAttribute (QtProperty *property, const QString &attribute, const QVariant &value)

virtual void	setValue (QtProperty *property, const QVariant &val)

Signals
void	attributeChanged (QtProperty *property, const QString &attribute, const QVariant &val)

void	valueChanged (QtProperty *property, const QVariant &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
virtual QtVariantProperty *	addProperty (int propertyType, const QString &name=QString())

virtual QStringList	attributes (int propertyType) const

virtual int	attributeType (int propertyType, const QString &attribute) const

virtual QVariant	attributeValue (const QtProperty *property, const QString &attribute) const

virtual bool	isPropertyTypeSupported (int propertyType) const

int	propertyType (const QtProperty *property) const

	QtVariantPropertyManager (QObject *parent=0)

virtual QVariant	value (const QtProperty *property) const

int	valueType (const QtProperty *property) const

virtual int	valueType (int propertyType) const

QtVariantProperty *	variantProperty (const QtProperty *property) const

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

Static Public Member Functions
static int	enumTypeId ()

static int	flagTypeId ()

static int	groupTypeId ()

static int	iconMapTypeId ()

Protected Member Functions
QtProperty *	createProperty () override

bool	hasValue (const QtProperty *property) const override

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 QString	displayText (const QtProperty *property) const

virtual EchoMode	echoMode (const QtProperty *) const

Detailed Description

The QtVariantPropertyManager class provides and manages QVariant based properties.

QtVariantPropertyManager provides the addProperty() function which creates QtVariantProperty objects. The QtVariantProperty class is a convenience class handling QVariant based properties inheriting QtProperty. A QtProperty object created by a QtVariantPropertyManager instance can be converted into a QtVariantProperty object using the variantProperty() function.

The property's value can be retrieved using the value(), and set using the setValue() slot. In addition the property's type, and the type of its value, can be retrieved using the propertyType() and valueType() functions respectively.

A property's type is a QVariant::Type enumerator value, and usually a property's type is the same as its value type. But for some properties the types differ, for example for enums, flags and group types in which case QtVariantPropertyManager provides the enumTypeId(), flagTypeId() and groupTypeId() functions, respectively, to identify their property type (the value types are QVariant::Int for the enum and flag types, and QVariant::Invalid for the group type).

Use the isPropertyTypeSupported() function to check if a particular property type is supported. The currently supported property types are:

\table \header \o Property Type \o Property Type Id \row \o int \o QVariant::Int \row \o double \o QVariant::Double \row \o bool \o QVariant::Bool \row \o QString \o QVariant::String \row \o QDate \o QVariant::Date \row \o QTime \o QVariant::Time \row \o QDateTime \o QVariant::DateTime \row \o QKeySequence \o QVariant::KeySequence \row \o QChar \o QVariant::Char \row \o QLocale \o QVariant::Locale \row \o QPoint \o QVariant::Point \row \o QPointF \o QVariant::PointF \row \o QSize \o QVariant::Size \row \o QSizeF \o QVariant::SizeF \row \o QRect \o QVariant::Rect \row \o QRectF \o QVariant::RectF \row \o QColor \o QVariant::Color \row \o QSizePolicy \o QVariant::SizePolicy \row \o QFont \o QVariant::Font \row \o QCursor \o QVariant::Cursor \row \o enum \o enumTypeId() \row \o flag \o flagTypeId() \row \o group \o groupTypeId() \endtable

Each property type can provide additional attributes, e.g. QVariant::Int and QVariant::Double provides minimum and maximum values. The currently supported attributes are:

\table \header \o Property Type \o Attribute Name \o Attribute Type \row \o int \o minimum \o QVariant::Int \row \o \o maximum \o QVariant::Int \row \o \o singleStep \o QVariant::Int \row \o double \o minimum \o QVariant::Double \row \o \o maximum \o QVariant::Double \row \o \o singleStep \o QVariant::Double \row \o \o decimals \o QVariant::Int \row \o bool \o textVisible \o QVariant::Bool \row \o QString \o regExp \o QVariant::RegExp \row \o \o echoMode \o QVariant::Int \row \o QDate \o minimum \o QVariant::Date \row \o \o maximum \o QVariant::Date \row \o QPointF \o decimals \o QVariant::Int \row \o QSize \o minimum \o QVariant::Size \row \o \o maximum \o QVariant::Size \row \o QSizeF \o minimum \o QVariant::SizeF \row \o \o maximum \o QVariant::SizeF \row \o \o decimals \o QVariant::Int \row \o QRect \o constraint \o QVariant::Rect \row \o QRectF \o constraint \o QVariant::RectF \row \o \o decimals \o QVariant::Int \row \o enum \o enumNames \o QVariant::StringList \row \o \o enumIcons \o iconMapTypeId() \row \o flag \o flagNames \o QVariant::StringList \endtable

The attributes for a given property type can be retrieved using the attributes() function. Each attribute has a value type which can be retrieved using the attributeType() function, and a value accessible through the attributeValue() function. In addition, the value can be set using the setAttribute() slot.

QtVariantManager also provides the valueChanged() signal which is emitted whenever a property created by this manager change, and the attributeChanged() signal which is emitted whenever an attribute of such a property changes.

See also: QtVariantProperty, QtVariantEditorFactory

Definition at line 78 of file qtvariantproperty.h.

Constructor & Destructor Documentation

◆ QtVariantPropertyManager()

QtVariantPropertyManager ( QObject * parent = 0 )

Creates a manager with the given parent.

Definition at line 1080 of file qtvariantproperty.cpp.

Here is the call graph for this function:

◆ ~QtVariantPropertyManager()

~QtVariantPropertyManager ( )

override

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

Definition at line 1591 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ addProperty()

QtVariantProperty * addProperty	(	int	propertyType,
		const QString &	name = `QString()`
	)

virtual

Creates and returns a variant property of the given propertyType with the given name.

If the specified propertyType is not supported by this variant manager, this function returns 0.

Do not use the inherited QtAbstractPropertyManager::addProperty() function to create a variant property (that function will always return 0 since it will not be clear what type the property should have).

See also: isPropertyTypeSupported()

Definition at line 1651 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ attributeChanged

void attributeChanged	(	QtProperty *	property,
		const QString &	attribute,
		const QVariant &	value
	)

signal

This signal is emitted whenever an attribute of a property created by this manager changes its value, passing a pointer to the property, the attribute and the new value as parameters.

See also: setAttribute()

Here is the caller graph for this function:

◆ attributes()

QStringList attributes ( int propertyType ) const

virtual

Returns a list of the given propertyType 's attributes.

See also: attributeValue(), attributeType()

Reimplemented in OptionalVariantManager.

Definition at line 2085 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ attributeType()

int attributeType	(	int	propertyType,
		const QString &	attribute
	)		const

virtual

Returns the type of the specified attribute of the given propertyType.

If the given propertyType is not supported by this manager, or if the given propertyType does not possess the specified attribute, this function returns QVariant::Invalid.

See also: attributes(), valueType()

Reimplemented in OptionalVariantManager.

Definition at line 2109 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ attributeValue()

QVariant attributeValue	(	const QtProperty *	property,
		const QString &	attribute
	)		const

virtual

Returns the given property's value for the specified attribute

If the given property was not created by this manager, or if the specified attribute does not exist, this function returns an invalid variant.

See also: attributes(), attributeType(), setAttribute()

Reimplemented in OptionalVariantManager.

Definition at line 1853 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createProperty()

QtProperty * createProperty ( )

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 2642 of file qtvariantproperty.cpp.

◆ enumTypeId()

QT_END_NAMESPACE QT_BEGIN_NAMESPACE int enumTypeId ( )

static

Returns the type id for an enum property.

Note that the property's value type can be retrieved using the valueType() function (which is QVariant::Int for the enum property type).

See also: propertyType(), valueType()

Definition at line 88 of file qtvariantproperty.cpp.

Here is the caller graph for this function:

◆ flagTypeId()

int flagTypeId ( )

static

Returns the type id for a flag property.

Note that the property's value type can be retrieved using the valueType() function (which is QVariant::Int for the flag property type).

See also: propertyType(), valueType()

Definition at line 103 of file qtvariantproperty.cpp.

Here is the caller graph for this function:

◆ groupTypeId()

int groupTypeId ( )

static

Returns the type id for a group property.

Note that the property's value type can be retrieved using the valueType() function (which is QVariant::Invalid for the group property type, since it doesn't provide any value).

See also: propertyType(), valueType()

Definition at line 118 of file qtvariantproperty.cpp.

Here is the caller graph for this function:

◆ hasValue()

bool hasValue ( const QtProperty * property ) const

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 2525 of file qtvariantproperty.cpp.

Here is the call graph for this function:

◆ iconMapTypeId()

int iconMapTypeId ( )

static

Returns the type id for a icon map attribute.

Note that the property's attribute type can be retrieved using the attributeType() function.

See also: attributeType(), QtEnumPropertyManager::enumIcons()

Definition at line 132 of file qtvariantproperty.cpp.

Here is the caller graph for this function:

◆ initializeProperty()

void initializeProperty ( QtProperty * property )

overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyManager.

Definition at line 2561 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPropertyTypeSupported()

bool isPropertyTypeSupported ( int propertyType ) const

virtual

Returns true if the given propertyType is supported by this variant manager; otherwise false.

See also: propertyType()

Reimplemented in OptionalVariantManager, and VariantManager.

Definition at line 1626 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ propertyType()

int propertyType ( const QtProperty * property ) const

Returns the given property's type.

See also: valueType()

Definition at line 1829 of file qtvariantproperty.cpp.

Here is the caller graph for this function:

◆ setAttribute

void setAttribute	(	QtProperty *	property,
		const QString &	attribute,
		const QVariant &	value
	)

virtualslot

Sets the value of the specified attribute of the given property, to value.

The new value's type must be of the type returned by attributeType(), or of a type that can be converted to attributeType() using the QVariant::canConvert() function, otherwise this function does nothing.

See also: attributeValue(), QtVariantProperty::setAttribute(), attributeChanged()

Definition at line 2303 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue

void setValue	(	QtProperty *	property,
		const QVariant &	value
	)

virtualslot

Sets the value of the given property to value.

The specified value must be of a type returned by valueType(), or of type that can be converted to valueType() using the QVariant::canConvert() function, otherwise this function does nothing.

See also: value(), QtVariantProperty::setValue(), valueChanged()

Definition at line 2143 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uninitializeProperty()

void uninitializeProperty ( QtProperty * property )

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 2606 of file qtvariantproperty.cpp.

Here is the caller graph for this function:

◆ value()

QVariant value ( const QtProperty * property ) const

virtual

Returns the given property's value.

If the given property is not managed by this manager, this function returns an invalid variant.

See also: setValue()

Reimplemented in OptionalVariantManager, and VariantManager.

Definition at line 1682 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueChanged

void valueChanged	(	QtProperty *	property,
		const QVariant &	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:

◆ valueIcon()

QIcon valueIcon ( const QtProperty * property ) const

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 2551 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueText()

QString valueText ( const QtProperty * property ) const

overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 2539 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueType() [1/2]

int valueType ( const QtProperty * property ) const

Returns the given property's value type.

See also: propertyType()

Definition at line 1801 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueType() [2/2]

int valueType ( int propertyType ) const

virtual

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

Returns the value type associated with the given propertyType.

Reimplemented in OptionalVariantManager, and VariantManager.

Definition at line 1813 of file qtvariantproperty.cpp.

Here is the call graph for this function:

◆ variantProperty()

QtVariantProperty * variantProperty ( const QtProperty * property ) const

Returns the given property converted into a QtVariantProperty.

If the property was not created by this variant manager, the function returns 0.

See also: createProperty()

Definition at line 1606 of file qtvariantproperty.cpp.

Here is the caller graph for this function:

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

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

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QtVariantPropertyManager()

◆ ~QtVariantPropertyManager()

Member Function Documentation

◆ addProperty()

◆ attributeChanged

◆ attributes()

◆ attributeType()

◆ attributeValue()

◆ createProperty()

◆ enumTypeId()

◆ flagTypeId()

◆ groupTypeId()

◆ hasValue()

◆ iconMapTypeId()

◆ initializeProperty()

◆ isPropertyTypeSupported()

◆ propertyType()

◆ setAttribute

◆ setValue

◆ uninitializeProperty()

◆ value()

◆ valueChanged

◆ valueIcon()

◆ valueText()

◆ valueType() [1/2]

◆ valueType() [2/2]

◆ variantProperty()