Skip to content

PythonQt.QtCore.QMetaProperty · declarations 001

Back to PythonQt.QtCore.QMetaProperty

enumerator

enumerator() -> Any

X.enumerator() -> PythonQt.QtCore.QMetaEnum

Supplemental documentation: Qt 5 reference:

QMetaEnum QMetaProperty::enumerator() const

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

See also isEnumType() and isFlagType().

Upstream PySide2 reference signatures (binding differences may apply):

enumerator(self) -> PySide2.QtCore.QMetaEnum

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#enumerator

hasNotifySignal

hasNotifySignal() -> bool

X.hasNotifySignal() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::hasNotifySignal() const

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

See also notifySignal().

Upstream PySide2 reference signatures (binding differences may apply):

hasNotifySignal(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#hasNotifySignal

hasStdCppSet

hasStdCppSet() -> bool

X.hasStdCppSet() -> bool

Upstream PySide2 reference signatures (binding differences may apply):

hasStdCppSet(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#hasStdCppSet

isConstant

isConstant() -> bool

X.isConstant() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isConstant() const

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.

Upstream PySide2 reference signatures (binding differences may apply):

isConstant(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isConstant

isDesignable

isDesignable(obj: Any) -> bool

X.isDesignable(obj) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isDesignable(const QObject *object \= nullptr) const

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().

Upstream PySide2 reference signatures (binding differences may apply):

isDesignable(self, obj: typing.Optional[PySide2.QtCore.QObject]=...) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isDesignable

isEditable

isEditable(obj: Any) -> bool

X.isEditable(obj) -> bool

Upstream PySide2 reference signatures (binding differences may apply):

isEditable(self, obj: typing.Optional[PySide2.QtCore.QObject]=...) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isEditable

isEnumType

isEnumType() -> bool

X.isEnumType() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isEnumType() const

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

See also enumerator() and isFlagType().

Upstream PySide2 reference signatures (binding differences may apply):

isEnumType(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isEnumType

isFinal

isFinal() -> bool

X.isFinal() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isFinal() const

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.

Upstream PySide2 reference signatures (binding differences may apply):

isFinal(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isFinal

isFlagType

isFlagType() -> bool

X.isFlagType() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isFlagType() const

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().

Upstream PySide2 reference signatures (binding differences may apply):

isFlagType(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isFlagType

isReadable

isReadable() -> bool

X.isReadable() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isReadable() const

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

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

Upstream PySide2 reference signatures (binding differences may apply):

isReadable(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isReadable

isResettable

isResettable() -> bool

X.isResettable() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isResettable() const

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

See also reset().

Upstream PySide2 reference signatures (binding differences may apply):

isResettable(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isResettable

isScriptable

isScriptable(obj: Any) -> bool

X.isScriptable(obj) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isScriptable(const QObject *object \= nullptr) const

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().

Upstream PySide2 reference signatures (binding differences may apply):

isScriptable(self, obj: typing.Optional[PySide2.QtCore.QObject]=...) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isScriptable

isStored

isStored(obj: Any) -> bool

X.isStored(obj) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isStored(const QObject *object \= nullptr) const

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().

Upstream PySide2 reference signatures (binding differences may apply):

isStored(self, obj: typing.Optional[PySide2.QtCore.QObject]=...) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isStored

isUser

isUser(obj: Any) -> bool

X.isUser(obj) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isUser(const QObject *object \= nullptr) const

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 nullptr, the function returns false if the Q_PROPERTY()'s USER attribute is false. Otherwise it returns true.

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

Upstream PySide2 reference signatures (binding differences may apply):

isUser(self, obj: typing.Optional[PySide2.QtCore.QObject]=...) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isUser

isValid

isValid() -> bool

X.isValid() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isValid() const

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

See also isReadable().

Upstream PySide2 reference signatures (binding differences may apply):

isValid(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isValid

isWritable

isWritable() -> bool

X.isWritable() -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::isWritable() const

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

See also isReadable() and write().

Upstream PySide2 reference signatures (binding differences may apply):

isWritable(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#isWritable

name

name() -> str

X.name() -> int

Supplemental documentation: Qt 5 reference:

const char *QMetaProperty::name() const

Returns this property's name.

See also type() and typeName().

Upstream PySide2 reference signatures (binding differences may apply):

name(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#name

notifySignal

notifySignal() -> Any

X.notifySignal() -> PythonQt.QtCore.QMetaMethod

Supplemental documentation: Qt 5 reference:

QMetaMethod QMetaProperty::notifySignal() const

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().

Upstream PySide2 reference signatures (binding differences may apply):

notifySignal(self) -> PySide2.QtCore.QMetaMethod

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#notifySignal

notifySignalIndex

notifySignalIndex() -> int

X.notifySignalIndex() -> int

Supplemental documentation: Qt 5 reference:

int QMetaProperty::notifySignalIndex() const

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().

Upstream PySide2 reference signatures (binding differences may apply):

notifySignalIndex(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#notifySignalIndex

propertyIndex

propertyIndex() -> int

X.propertyIndex() -> int

Supplemental documentation: Qt 5 reference:

int QMetaProperty::propertyIndex() const

Returns this property's index.

This function was introduced in Qt 4.6.

Upstream PySide2 reference signatures (binding differences may apply):

propertyIndex(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#propertyIndex

read

read(obj: Any) -> Any

X.read(obj) -> object

Supplemental documentation: Qt 5 reference:

QVariant QMetaProperty::read(const QObject *object) const

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().

Upstream PySide2 reference signatures (binding differences may apply):

read(self, obj: PySide2.QtCore.QObject) -> typing.Any

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#read

readOnGadget

readOnGadget(gadget: int) -> Any

X.readOnGadget(gadget) -> object

Supplemental documentation: Qt 5 reference:

QVariant QMetaProperty::readOnGadget(const void *gadget) const

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

This function should only be used if this is a property of a Q_GADGET

This function was introduced in Qt 5.5.

Upstream PySide2 reference signatures (binding differences may apply):

readOnGadget(self, gadget: int) -> typing.Any

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#readOnGadget

reset

reset(obj: Any) -> bool

X.reset(obj) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::reset(QObject *object) const

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().

Upstream PySide2 reference signatures (binding differences may apply):

reset(self, obj: PySide2.QtCore.QObject) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#reset

resetOnGadget

resetOnGadget(gadget: int) -> bool

X.resetOnGadget(gadget) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::resetOnGadget(void *gadget) const

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

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

This function should only be used if this is a property of a Q_GADGET

This function was introduced in Qt 5.5.

Upstream PySide2 reference signatures (binding differences may apply):

resetOnGadget(self, gadget: int) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#resetOnGadget

revision

revision() -> int

X.revision() -> int

Supplemental documentation: Qt 5 reference:

int QMetaProperty::revision() const

Returns the property revision if one was specified by REVISION, otherwise returns 0.

This function was introduced in Qt 5.1.

Upstream PySide2 reference signatures (binding differences may apply):

revision(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#revision

type

type() -> Any

X.type()

Supplemental documentation: Qt 5 reference:

QVariant::Type QMetaProperty::type() const

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

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

Upstream PySide2 reference signatures (binding differences may apply):

type(self) -> type

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#type

typeName

typeName() -> str

X.typeName() -> int

Supplemental documentation: Qt 5 reference:

const char *QMetaProperty::typeName() const

Returns the name of this property's type.

See also type() and name().

Upstream PySide2 reference signatures (binding differences may apply):

typeName(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#typeName

userType

userType() -> int

X.userType() -> int

Supplemental documentation: Qt 5 reference:

int QMetaProperty::userType() const

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

This function was introduced in Qt 4.2.

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

Upstream PySide2 reference signatures (binding differences may apply):

userType(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#userType

write

write(obj: Any, value: Any) -> bool

X.write(obj, value) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::write(QObject *object, const QVariant \&value) const

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

If value is not of the same type type as the property, a conversion is attempted. An empty QVariant() is equivalent to a call to reset() if this property is resettable, or setting a default-constructed object otherwise.

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

Upstream PySide2 reference signatures (binding differences may apply):

write(self, obj: PySide2.QtCore.QObject, value: typing.Any) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#write

writeOnGadget

writeOnGadget(gadget: int, value: Any) -> bool

X.writeOnGadget(gadget, value) -> bool

Supplemental documentation: Qt 5 reference:

bool QMetaProperty::writeOnGadget(void *gadget, const QVariant \&value) const

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

This function should only be used if this is a property of a Q_GADGET

This function was introduced in Qt 5.5.

Upstream PySide2 reference signatures (binding differences may apply):

writeOnGadget(self, gadget: int, value: typing.Any) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qmetaproperty.html#writeOnGadget