itom
Loading...
Searching...
No Matches
QtVariantPropertyManager Class Reference

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

Inheritance diagram for QtVariantPropertyManager:
QtAbstractPropertyManager

Public Slots

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

Signals

void valueChanged (QtProperty *property, const QVariant &val)
 
void attributeChanged (QtProperty *property, const QString &attribute, const QVariant &val)
 
- Signals inherited from QtAbstractPropertyManager
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

 QtVariantPropertyManager (QObject *parent=0)
 
 ~QtVariantPropertyManager ()
 
virtual QtVariantPropertyaddProperty (int propertyType, const QString &name=QString())
 
int propertyType (const QtProperty *property) const
 
int valueType (const QtProperty *property) const
 
QtVariantPropertyvariantProperty (const QtProperty *property) const
 
virtual bool isPropertyTypeSupported (int propertyType) const
 
virtual int valueType (int propertyType) const
 
virtual QStringList attributes (int propertyType) const
 
virtual int attributeType (int propertyType, const QString &attribute) const
 
virtual QVariant value (const QtProperty *property) const
 
virtual QVariant attributeValue (const QtProperty *property, const QString &attribute) const
 
- Public Member Functions inherited from QtAbstractPropertyManager
 QtAbstractPropertyManager (QObject *parent=0)
 
 ~QtAbstractPropertyManager ()
 
QSet< QtProperty * > properties () const
 
void clear () const
 
QtPropertyaddProperty (const QString &name=QString())
 

Static Public Member Functions

static int enumTypeId ()
 
static int flagTypeId ()
 
static int groupTypeId ()
 
static int iconMapTypeId ()
 

Protected Member Functions

virtual bool hasValue (const QtProperty *property) const
 
QString valueText (const QtProperty *property) const
 
QIcon valueIcon (const QtProperty *property) const
 
virtual void initializeProperty (QtProperty *property)
 
virtual void uninitializeProperty (QtProperty *property)
 
virtual QtPropertycreateProperty ()
 
- Protected Member Functions inherited from QtAbstractPropertyManager
virtual QString displayText (const QtProperty *property) const
 
virtual EchoMode echoMode (const QtProperty *) const
 

Private Member Functions

 Q_PRIVATE_SLOT (d_func(), void slotValueChanged(QtProperty *, int)) Q_PRIVATE_SLOT(d_func()
 
void slotRangeChanged (QtProperty *, int, int)) Q_PRIVATE_SLOT(d_func()
 
void void slotSingleStepChanged (QtProperty *, int)) Q_PRIVATE_SLOT(d_func()
 
void void void slotValueChanged (QtProperty *, double)) Q_PRIVATE_SLOT(d_func()
 
void void void void slotRangeChanged (QtProperty *, double, double)) Q_PRIVATE_SLOT(d_func()
 
void void void void void slotSingleStepChanged (QtProperty *, double)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void slotDecimalsChanged (QtProperty *, int)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void slotValueChanged (QtProperty *, bool)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void slotValueChanged (QtProperty *, const QString &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void slotRegExpChanged (QtProperty *, const QRegularExpression &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void slotEchoModeChanged (QtProperty *, int)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void slotValueChanged (QtProperty *, const QDate &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void slotRangeChanged (QtProperty *, const QDate &, const QDate &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QTime &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QDateTime &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QKeySequence &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QChar &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QLocale &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QPoint &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QPointF &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QSize &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void slotRangeChanged (QtProperty *, const QSize &, const QSize &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QSizeF &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void slotRangeChanged (QtProperty *, const QSizeF &, const QSizeF &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QRect &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void slotConstraintChanged (QtProperty *, const QRect &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QMargins &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void slotConstraintChanged (QtProperty *, const QMargins &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QRectF &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotConstraintChanged (QtProperty *, const QRectF &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QColor &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotEnumNamesChanged (QtProperty *, const QStringList &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotEnumIconsChanged (QtProperty *, const QMap< int, QIcon > &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QSizePolicy &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QFont &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotValueChanged (QtProperty *, const QCursor &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotFlagNamesChanged (QtProperty *, const QStringList &)) Q_PRIVATE_SLOT(d_func()
 
void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void void slotPropertyInserted (QtProperty *, QtProperty *, QtProperty *)) Q_PRIVATE_SLOT(d_func()
 

Private Attributes

QtVariantPropertyManagerPrivated_ptr
 

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 QString \o regular expression \o QVariant::RegularExpression \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

Constructor & Destructor Documentation

◆ QtVariantPropertyManager()

QtVariantPropertyManager::QtVariantPropertyManager ( QObject * parent = 0)

Creates a manager with the given parent.

◆ ~QtVariantPropertyManager()

QtVariantPropertyManager::~QtVariantPropertyManager ( )

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

Member Function Documentation

◆ addProperty()

QtVariantProperty * QtVariantPropertyManager::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()

◆ attributeChanged

void QtVariantPropertyManager::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()

◆ attributes()

QStringList QtVariantPropertyManager::attributes ( int propertyType) const
virtual

Returns a list of the given propertyType 's attributes.

See also
attributeValue(), attributeType()

◆ attributeType()

int QtVariantPropertyManager::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()

◆ attributeValue()

QVariant QtVariantPropertyManager::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()

◆ createProperty()

QtProperty * QtVariantPropertyManager::createProperty ( )
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

◆ enumTypeId()

int QtVariantPropertyManager::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()

◆ flagTypeId()

int QtVariantPropertyManager::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()

◆ groupTypeId()

int QtVariantPropertyManager::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()

◆ hasValue()

bool QtVariantPropertyManager::hasValue ( const QtProperty * property) const
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

◆ iconMapTypeId()

int QtVariantPropertyManager::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()

◆ initializeProperty()

void QtVariantPropertyManager::initializeProperty ( QtProperty * property)
protectedvirtual

\reimp

Implements QtAbstractPropertyManager.

◆ isPropertyTypeSupported()

bool QtVariantPropertyManager::isPropertyTypeSupported ( int propertyType) const
virtual

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

See also
propertyType()

◆ propertyType()

int QtVariantPropertyManager::propertyType ( const QtProperty * property) const

Returns the given property's type.

See also
valueType()

◆ setAttribute

void QtVariantPropertyManager::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()

◆ setValue

void QtVariantPropertyManager::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()

◆ uninitializeProperty()

void QtVariantPropertyManager::uninitializeProperty ( QtProperty * property)
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

◆ value()

QVariant QtVariantPropertyManager::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()

◆ valueChanged

void QtVariantPropertyManager::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()

◆ valueIcon()

QIcon QtVariantPropertyManager::valueIcon ( const QtProperty * property) const
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

◆ valueText()

QString QtVariantPropertyManager::valueText ( const QtProperty * property) const
protectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

◆ valueType() [1/2]

int QtVariantPropertyManager::valueType ( const QtProperty * property) const

Returns the given property's value type.

See also
propertyType()

◆ valueType() [2/2]

int QtVariantPropertyManager::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.

◆ variantProperty()

QtVariantProperty * QtVariantPropertyManager::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()

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