QMetaProperty(3qt)

NAME
QMetaProperty - Stores meta data about a property

SYNOPSIS
#include <qmetaobject.h>

  Public Members
<li class=fn>const char * type () const <li class=fn>const char * name () const <li class=fn>bool writable () const <li class=fn>bool isSetType () const <li class=fn>bool isEnumType () const <li class=fn>QStrList enumKeys () const <li class=fn>int keyToValue ( const char * key ) const <li class=fn>const char * valueToKey ( int value ) const <li class=fn>int keysToValue ( const QStrList & keys ) const <li class=fn>QStrList valueToKeys ( int value ) const <li class=fn>bool designable ( QObject * o = 0 ) const <li class=fn>bool scriptable ( QObject * o = 0 ) const <li class=fn>bool stored ( QObject * o = 0 ) const <li class=fn>bool reset ( QObject * o ) const

DESCRIPTION
The QMetaProperty class stores meta data about a property.

Property meta data includes type(), name(), and whether a property is writable(), designable() and stored().

The functions isSetType(), isEnumType() and enumKeys() provide further information about a property's type. The conversion functions keyToValue(), valueToKey(), keysToValue() and valueToKeys() allow conversion between the integer representation of an enumeration or set value and its literal representation.

Actual property values are set and received through QObject's set and get functions. See QObject::setProperty() and QObject::property() for details.

You receive meta property data through an object's meta object. See QMetaObject::property() and QMetaObject::propertyNames() for details.

See also Object Model.

MEMBER FUNCTION DOCUMENTATION

bool QMetaProperty::designable ( QObject * o = 0 ) const
Returns TRUE if the property is designable for object o; otherwise returns FALSE.

If no object o is given, the function returns a static approximation.

QStrList QMetaProperty::enumKeys () const
Returns the possible enumeration keys if this property is an enumeration type (or a set type).

See also isEnumType().

bool QMetaProperty::isEnumType () const
Returns TRUE if the property's type is an enumeration value; otherwise returns FALSE.

See also isSetType() and enumKeys().

bool QMetaProperty::isSetType () const
Returns TRUE if the property's type is an enumeration value that is used as set, i.e. if the enumeration values can be OR-ed together; otherwise returns FALSE. A set type is implicitly also an enum type.

See also isEnumType() and enumKeys().

int QMetaProperty::keyToValue ( const char * key ) const
Converts the enumeration key key to its integer value.

For set types, use keysToValue().

See also valueToKey(), isSetType(), and keysToValue().

int QMetaProperty::keysToValue ( const QStrList & keys ) const
Converts the list of keys keys to their combined (OR-ed) integer value.

See also isSetType() and valueToKey().

const char * QMetaProperty::name () const
Returns the name of the property.

bool QMetaProperty::reset ( QObject * o ) const
Tries to reset the property for object o with a reset method. On success, returns TRUE; otherwise returns FALSE.

Reset methods are optional, usually only a few properties support them.

bool QMetaProperty::scriptable ( QObject * o = 0 ) const
Returns TRUE if the property is scriptable for object o; otherwise returns FALSE.

If no object o is given, the function returns a static approximation.

bool QMetaProperty::stored ( QObject * o = 0 ) const
Returns TRUE if the property shall be stored for object o; otherwise returns FALSE.

If no object o is given, the function returns a static approximation.

const char * QMetaProperty::type () const
Returns the type of the property.

const char * QMetaProperty::valueToKey ( int value ) const
Converts the enumeration value value to its literal key.

For set types, use valueToKeys().

See also isSetType() and valueToKeys().

QStrList QMetaProperty::valueToKeys ( int value ) const
Converts the set value value to a list of keys.

See also isSetType() and valueToKey().

bool QMetaProperty::writable () const
Returns TRUE if the property is writable; otherwise returns FALSE.

SEE ALSO
http://doc.trolltech.com/qmetaproperty.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.

BUGS
If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qmetaproperty.3qt) and the Qt version (3.3.3).