Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
QtCore.QMetaProperty Class Reference

The QMetaProperty class provides meta-data about a property. More...

Inheritance diagram for QtCore.QMetaProperty:
Collaboration diagram for QtCore.QMetaProperty:

Public Member Functions

 QMetaProperty ()
 
 QMetaProperty (QMetaProperty copy)
 
virtual void CreateProxy ()
 
new bool IsDesignable (QObject obj=null)
  More...
 
new bool IsEditable (QObject obj=null)
  More...
 
new bool IsScriptable (QObject obj=null)
  More...
 
new bool IsStored (QObject obj=null)
  More...
 
new bool IsUser (QObject obj=null)
  More...
 
new QMetaMethod NotifySignal ()
  More...
 
new int NotifySignalIndex ()
  More...
 
new object Read (QObject obj)
  More...
 
new bool Reset (QObject obj)
  More...
 
new bool Write (QObject obj, object value)
  More...
 
new void Dispose ()
 

Protected Member Functions

 QMetaProperty (System.Type dummy)
 

Protected Attributes

SmokeInvocation interceptor
 

Properties

QMetaObject EnclosingMetaObject [get]
 
QMetaEnum Enumerator [get]
  More...
 
bool HasNotifySignal [get]
  More...
 
bool HasStdCppSet [get]
 
bool IsConstant [get]
  More...
 
bool IsEnumType [get]
  More...
 
bool IsFinal [get]
  More...
 
bool IsFlagType [get]
  More...
 
bool IsReadable [get]
  More...
 
bool IsResettable [get, set]
  More...
 
bool IsValid [get]
  More...
 
bool IsWritable [get]
  More...
 
string Name [get]
  More...
 
int PropertyIndex [get]
  More...
 
int Revision [get]
 
QVariant.Type Type [get]
  More...
 
string TypeName [get]
  More...
 
int UserType [get]
  More...
 
virtual System.IntPtr SmokeObject [get, set]
 

Detailed Description

The QMetaProperty class provides meta-data about a property.

Property meta-data is obtained from an object's meta-object. See QMetaObject::property() and QMetaObject::propertyCount() for details.

Property Meta-Data

A property has a name() and a type(), as well as various attributes that specify its behavior: isReadable(), isWritable(), isDesignable(), isScriptable(), and isStored().

If the property is an enumeration, isEnumType() returns true; if the property is an enumeration that is also a flag (i.e. its values can be combined using the OR operator), isEnumType() and isFlagType() both return true. The enumerator for these types is available from enumerator().

The property's values are set and retrieved with read(), write(), and reset(); they can also be changed through QObject's set and get functions. See QObject::setProperty() and QObject::property() for details.

Copying and Assignment

QMetaProperty objects can be copied by value. However, each copy will refer to the same underlying property meta-data.

See also QMetaObject, QMetaEnum, QMetaMethod, and Qt's Property System.

Constructor & Destructor Documentation

QtCore.QMetaProperty.QMetaProperty ( System.Type  dummy)
protected
QtCore.QMetaProperty.QMetaProperty ( )

Here is the call graph for this function:

QtCore.QMetaProperty.QMetaProperty ( QMetaProperty  copy)

Here is the call graph for this function:

Member Function Documentation

virtual void QtCore.QMetaProperty.CreateProxy ( )
virtual

Here is the caller graph for this function:

new void QtCore.QMetaProperty.Dispose ( )
new bool QtCore.QMetaProperty.IsDesignable ( QObject  obj = null)

Returns true if this property is designable for the given object; otherwise returns false.

If no object is given, the function returns false if the Q_PROPERTY()'s DESIGNABLE attribute is false; otherwise returns true (if the attribute is true or is a function or expression).

See also isScriptable() and isStored().

new bool QtCore.QMetaProperty.IsEditable ( QObject  obj = null)

Returns true if the property is editable for the given object; otherwise returns false.

If no object is given, the function returns false if the Q_PROPERTY()'s EDITABLE attribute is false; otherwise returns true (if the attribute is true or is a function or expression).

See also isDesignable(), isScriptable(), and isStored().

new bool QtCore.QMetaProperty.IsScriptable ( QObject  obj = null)

Returns true if the property is scriptable for the given object; otherwise returns false.

If no object is given, the function returns false if the Q_PROPERTY()'s SCRIPTABLE attribute is false; otherwise returns true (if the attribute is true or is a function or expression).

See also isDesignable() and isStored().

new bool QtCore.QMetaProperty.IsStored ( QObject  obj = null)

Returns true if the property is stored for object; otherwise returns false.

If no object is given, the function returns false if the Q_PROPERTY()'s STORED attribute is false; otherwise returns true (if the attribute is true or is a function or expression).

See also isDesignable() and isScriptable().

new bool QtCore.QMetaProperty.IsUser ( QObject  obj = null)

Returns true if this property is designated as the USER property, i.e., the one that the user can edit for object or that is significant in some other way. Otherwise it returns false. e.g., the text property is the USER editable property of a QLineEdit.

If object is null, the function returns false if the Q_PROPERTY()'s USER attribute is false. Otherwise it returns true.

See also QMetaObject::userProperty(), isDesignable(), and isScriptable().

new QMetaMethod QtCore.QMetaProperty.NotifySignal ( )

Returns the QMetaMethod instance of the property change notifying signal if one was specified, otherwise returns an invalid QMetaMethod.

This function was introduced in Qt 4.5.

See also hasNotifySignal().

new int QtCore.QMetaProperty.NotifySignalIndex ( )

Returns the index of the property change notifying signal if one was specified, otherwise returns -1.

This function was introduced in Qt 4.6.

See also hasNotifySignal().

new object QtCore.QMetaProperty.Read ( QObject  obj)

Reads the property's value from the given object. Returns the value if it was able to read it; otherwise returns an invalid variant.

See also write(), reset(), and isReadable().

new bool QtCore.QMetaProperty.Reset ( QObject  obj)

Resets the property for the given object with a reset method. Returns true if the reset worked; otherwise returns false.

Reset methods are optional; only a few properties support them.

See also read() and write().

new bool QtCore.QMetaProperty.Write ( QObject  obj,
object  value 
)

Writes value as the property's value to the given object. Returns true if the write succeeded; otherwise returns false.

See also read(), reset(), and isWritable().

Member Data Documentation

SmokeInvocation QtCore.QMetaProperty.interceptor
protected

Property Documentation

QMetaObject QtCore.QMetaProperty.EnclosingMetaObject
get
QMetaEnum QtCore.QMetaProperty.Enumerator
get

Returns the enumerator if this property's type is an enumerator type; otherwise the returned value is undefined.

See also isEnumType() and isFlagType().

bool QtCore.QMetaProperty.HasNotifySignal
get

Returns true if this property has a corresponding change notify signal; otherwise returns false.

See also notifySignal().

bool QtCore.QMetaProperty.HasStdCppSet
get
bool QtCore.QMetaProperty.IsConstant
get

Returns true if the property is constant; otherwise returns false.

A property is constant if the Q_PROPERTY()'s CONSTANT attribute is set.

This function was introduced in Qt 4.6.

bool QtCore.QMetaProperty.IsEnumType
get

Returns true if the property's type is an enumeration value; otherwise returns false.

See also enumerator() and isFlagType().

bool QtCore.QMetaProperty.IsFinal
get

Returns true if the property is final; otherwise returns false.

A property is final if the Q_PROPERTY()'s FINAL attribute is set.

This function was introduced in Qt 4.6.

bool QtCore.QMetaProperty.IsFlagType
get

Returns true if the property's type is an enumeration value that is used as a flag; otherwise returns false.

Flags can be combined using the OR operator. A flag type is implicitly also an enum type.

See also isEnumType(), enumerator(), and QMetaEnum::isFlag().

bool QtCore.QMetaProperty.IsReadable
get

Returns true if this property is readable; otherwise returns false.

See also isWritable(), read(), and isValid().

bool QtCore.QMetaProperty.IsResettable
getset

Returns true if this property can be reset to a default value; otherwise returns false.

See also reset().

bool QtCore.QMetaProperty.IsValid
get

Returns true if this property is valid (readable); otherwise returns false.

See also isReadable().

bool QtCore.QMetaProperty.IsWritable
get

Returns true if this property is writable; otherwise returns false.

See also isReadable() and write().

string QtCore.QMetaProperty.Name
get

Returns this property's name.

See also type() and typeName().

int QtCore.QMetaProperty.PropertyIndex
get

Returns this property's index.

This function was introduced in Qt 4.6.

int QtCore.QMetaProperty.Revision
get
virtual System.IntPtr QtCore.QMetaProperty.SmokeObject
getset
QVariant.Type QtCore.QMetaProperty.Type
get

Returns this property's type. The return value is one of the values of the QVariant::Type enumeration.

See also userType(), typeName(), and name().

string QtCore.QMetaProperty.TypeName
get

Returns the name of this property's type.

See also type() and name().

int QtCore.QMetaProperty.UserType
get

Returns this property's user type. The return value is one of the values that are registered with QMetaType, or 0 if the type is not registered.

This function was introduced in Qt 4.2.

See also type(), QMetaType, and typeName().