QtVariantProperty Class Reference

The QtVariantProperty class is a convenience class handling QVariant based properties. More...

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

Inheritance diagram for QtVariantProperty:

Public Member Functions
QVariant	attributeValue (const QString &attribute) const
int	propertyType () const
void	setAttribute (const QString &attribute, const QVariant &value)
void	setValue (const QVariant &value)
QVariant	value () const
int	valueType () const
	~QtVariantProperty () override
Public Member Functions inherited from QtProperty
void	addSubProperty (QtProperty *property)
QString	displayText () const
bool	hasValue () const
void	insertSubProperty (QtProperty *property, QtProperty *afterProperty)
bool	isEnabled () const
bool	isModified () const
QtAbstractPropertyManager *	propertyManager () const
QString	propertyName () const
void	removeSubProperty (QtProperty *property)
void	setEnabled (bool enable)
void	setModified (bool modified)
void	setPropertyName (const QString &text)
void	setStatusTip (const QString &text)
void	setToolTip (const QString &text)
void	setWhatsThis (const QString &text)
QString	statusTip () const
QList< QtProperty * >	subProperties () const
QString	toolTip () const
QIcon	valueIcon () const
QString	valueText () const
QString	whatsThis () const
virtual	~QtProperty ()

Protected Member Functions
	QtVariantProperty (QtVariantPropertyManager *manager)
Protected Member Functions inherited from QtProperty
void	propertyChanged ()
	QtProperty (QtAbstractPropertyManager *manager)

Friends
class	QtVariantPropertyManager

Detailed Description

The QtVariantProperty class is a convenience class handling QVariant based properties.

QtVariantProperty provides additional API: A property's type, value type, attribute values and current value can easily be retrieved using the propertyType(), valueType(), attributeValue() and value() functions respectively. In addition, the attribute values and the current value can be set using the corresponding setValue() and setAttribute() functions.

For example, instead of writing:

QtVariantPropertyManager *variantPropertyManager;
QtProperty *property;
 
variantPropertyManager->setValue(property, 10);

you can write:

QtVariantPropertyManager *variantPropertyManager;
QtVariantProperty *property;
 
property->setValue(10);

QtVariantProperty instances can only be created by the QtVariantPropertyManager class.

See also

QtProperty, QtVariantPropertyManager, QtVariantEditorFactory

Definition at line 55 of file qtvariantproperty.h.

Constructor & Destructor Documentation

~QtVariantProperty()

~QtVariantProperty ( )

override

Destroys this property.

See also

QtProperty::~QtProperty()

Definition at line 208 of file qtvariantproperty.cpp.

QtVariantProperty()

QtVariantProperty ( QtVariantPropertyManager *  manager )

protected

Creates a variant property using the given manager.

Do not use this constructor to create variant property instances; use the QtVariantPropertyManager::addProperty() function instead. This constructor is used internally by the QtVariantPropertyManager::createProperty() function.

See also

QtVariantPropertyManager

Definition at line 197 of file qtvariantproperty.cpp.

Member Function Documentation

attributeValue()

QVariant attributeValue

(

const QString &

attribute

)

const

Returns this property's value for the specified attribute.

QtVariantPropertyManager provides a couple of related functions: \l{QtVariantPropertyManager::attributes()}{attributes()} and \l{QtVariantPropertyManager::attributeType()}{attributeType()}.

See also

setAttribute()

Definition at line 232 of file qtvariantproperty.cpp.

Here is the call graph for this function:

propertyType()

int propertyType

(

)

const

Returns this property's type.

QtVariantPropertyManager provides several related functions: \l{QtVariantPropertyManager::enumTypeId()}{enumTypeId()}, \l{QtVariantPropertyManager::flagTypeId()}{flagTypeId()} and \l{QtVariantPropertyManager::groupTypeId()}{groupTypeId()}.

See also

valueType()

Definition at line 257 of file qtvariantproperty.cpp.

Here is the call graph for this function:

setAttribute()

void setAttribute	(	const QString &	attribute,
		const QVariant &	value
	)

Sets the attribute of property to value.

QtVariantPropertyManager provides the related \l{QtVariantPropertyManager::setAttribute()}{setAttribute()} function.

See also

attributeValue()

Definition at line 286 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setValue()

void setValue

(

const QVariant &

value

)

Sets the value of this property to value.

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

See also

value()

Definition at line 272 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

value()

QVariant value

(

)

const

Returns the property's current value.

See also

valueType(), setValue()

Definition at line 218 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

valueType()

int valueType

(

)

const

Returns the type of this property's value.

See also

propertyType()

Definition at line 242 of file qtvariantproperty.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

QtVariantPropertyManager

friend class QtVariantPropertyManager

friend

Definition at line 69 of file qtvariantproperty.h.

---

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

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