Класс QMetaProperty

Класс QMetaProperty предоставляет метаданные о свойстве. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Открытые функции

Подробное описание

Класс QMetaProperty предоставляет метаданные о свойстве.

Метаданные свойства получаются из метаобъекта объекта. Подробности см. в QMetaObject::property() и QMetaObject::propertyCount().

Метаданные свойства

Свойство имеет имя name() и тип type(), а также различные атрибуты, определяющие его поведение: isReadable(), isWritable(), isDesignable(), isScriptable(), revision() и isStored().

Если свойство является перечислением, isEnumType() возвращает true; если свойство является перечислением, которое также является флагом (т. е. его значения могут быть объединены с помощью оператора ИЛИ), isEnumType() и isFlagType() оба возвращают true. Перечисление для этих типов доступно из enumerator().

Значения свойства устанавливаются и извлекаются с помощью read(), write() и reset(); они также могут быть изменены через функции установки и получения QObject. Подробности см. в QObject::setProperty() и QObject::property().

Копирование и присваивание

Объекты QMetaProperty можно копировать по значению. Однако каждый экземпляр копии будет ссылаться на те же самые метаданные базового свойства.

См. также QMetaObject, QMetaEnum, QMetaMethod и Систему свойств Qt.

Документация по функциям-членам

QMetaEnum QMetaProperty::enumerator() const

Возвращает перечисление, если тип этого свойства — тип перечисления; в противном случае возвращаемое значение неопределено.

См. также isEnumType() и isFlagType().

bool QMetaProperty::hasNotifySignal() const

Возвращает true если для этого свойства существует соответствующий сигнал уведомления о изменении; в противном случае возвращает false.

См. также notifySignal().

bool QMetaProperty::isConstant() const

Возвращает true если свойство является константой; в противном случае возвращает false.

Свойство является константой, если атрибут Q_PROPERTY() свойства имеет установленное значение CONSTANT.

Эта функция была введена в Qt 4.6.

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

Возвращает true если это свойство применимо для данного объекта object; в противном случае возвращает false.

Если object не задан, функция возвращает false если атрибут Q_PROPERTY() свойства имеет значение false; в противном случае возвращает true (если атрибут true или это функция или выражение).

См. также isScriptable() и isStored().

bool QMetaProperty::isEnumType() const

Возвращает true если тип свойства является типом перечисления; в противном случае возвращает false.

См. также enumerator() и isFlagType().

bool QMetaProperty::isFinal() const

Возвращает true если свойство является финальным; в противном случае возвращает false.

Свойство является финальным, если атрибут Q_PROPERTY() свойства имеет установленное значение FINAL.

Эта функция была введена в Qt 4.6.

bool QMetaProperty::isFlagType() const

Возвращает true если тип свойства — это тип перечисления, используемый в качестве флага; в противном случае возвращает false.

Флаги можно объединять с помощью оператора ИЛИ. Тип флага подразумевает также тип перечисления.

См. также isEnumType(), enumerator() и QMetaEnum::isFlag().

bool QMetaProperty::isReadable() const

Возвращает true если это свойство читабельно; в противном случае возвращает false.

См. также isWritable(), read() и isValid().

bool QMetaProperty::isResettable() const

Возвращает true, если данное свойство может быть сброшено до значения по умолчанию; в противном случае возвращает false.

См. также reset().

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

Возвращает true, если свойство доступно для скриптинга для данного object; в противном случае возвращает false.

Если object не указан, функция возвращает false, если у Q_PROPERTY() свойство SCRIPTABLE имеет значение false; в противном случае возвращает true (если свойство имеет значение true или является функцией или выражением).

См. также isDesignable() и isStored().

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

Возвращает true, если свойство сохраняется для object; в противном случае возвращает false.

Если object не указан, функция возвращает false, если у Q_PROPERTY() свойство STORED имеет значение false; в противном случае возвращает true (если свойство имеет значение true или является функцией или выражением).

См. также isDesignable() и isScriptable().

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

Возвращает true, если это свойство обозначено как свойство, доступное для редактирования пользователем для object или каким-либо другим способом значимое. В противном случае возвращает false. Например, свойство text является свойством, редактируемым пользователем, для QLineEdit.

Если object равен null, функция возвращает false, если у Q_PROPERTY() свойство USER имеет значение false. В противном случае возвращает true.

См. также QMetaObject::userProperty(), isDesignable() и isScriptable().

bool QMetaProperty::isValid() const

Возвращает true, если данное свойство валидно (читабельно); в противном случае возвращает false.

См. также isReadable().

bool QMetaProperty::isWritable() const

Возвращает true, если данное свойство доступно для записи; в противном случае возвращает false.

См. также isReadable() и write().

const char *QMetaProperty::name() const

Возвращает имя данного свойства.

См. также type() и typeName().

QMetaMethod QMetaProperty::notifySignal() const

Возвращает экземпляр QMetaMethod сигнала уведомления о изменении свойства, если он был указан; в противном случае возвращает недопустимый QMetaMethod.

Данная функция была добавлена в Qt 4.5.

См. также hasNotifySignal().

int QMetaProperty::notifySignalIndex() const

Возвращает индекс сигнала уведомления о изменении свойства, если он был указан; в противном случае возвращает -1.

Данная функция была добавлена в Qt 4.6.

См. также hasNotifySignal().

int QMetaProperty::propertyIndex() const

Возвращает индекс данного свойства.

Данная функция была добавлена в Qt 4.6.

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

Читает значение свойства из заданного object. Возвращает значение, если чтение выполнено успешно; в противном случае возвращает невалидный объект.

См. также write(), reset() и isReadable().

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

Читает значение свойства из заданного gadget. Возвращает значение, если чтение выполнено успешно; в противном случае возвращает невалидный объект.

Данная функция должна использоваться только если это свойство объекта Q_GADGET

Данная функция была добавлена в Qt 5.5.

bool QMetaProperty::reset(QObject *object) const

Сбрасывает свойство для заданного object с помощью метода сброса. Возвращает true, если сброс выполнен успешно; в противном случае возвращает false.

Методы сброса необязательны; их поддерживают только некоторые свойства.

См. также read() и write().

bool QMetaProperty::resetOnGadget(void *gadget) const

Сбрасывает свойство для заданного gadget с помощью метода сброса. Возвращает true, если сброс выполнен успешно; в противном случае возвращает false.

Методы сброса необязательны; их поддерживают только некоторые свойства.

Данная функция должна использоваться только если это свойство объекта Q_GADGET

Данная функция была добавлена в Qt 5.5.

int QMetaProperty::revision() const

Возвращает ревизию свойства, если она была задана, в противном случае возвращает 0.

Данная функция была добавлена в Qt 5.1.

QVariant::Type QMetaProperty::type() const

Возвращает тип данного свойства. Возвращаемое значение — одно из значений перечисления QVariant::Type.

См. также userType(), typeName() и name().

const char *QMetaProperty::typeName() const

Возвращает имя типа данного свойства.

См. также type() и name().

int QMetaProperty::userType() const

Возвращает пользовательский тип данного свойства. Возвращаемое значение — одно из значений, зарегистрированных в QMetaType, или QMetaType::UnknownType, если тип не зарегистрирован.

Данная функция была добавлена в Qt 4.2.

См. также type(), QMetaType и typeName().

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

Записывает value как значение свойства для заданного object. Возвращает true, если запись выполнена успешно; в противном случае возвращает false.

Если value не имеет того же типа, что и свойство, выполняется попытка преобразования. Пустой QVariant() эквивалентен вызову reset(), если это свойство доступно для сброса, или установлению значения по умолчанию в противном случае.

См. также read(), reset() и isWritable().

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

Записывает value как значение свойства для заданного gadget. Возвращает true, если запись выполнена успешно; в противном случае возвращает false.

Данная функция должна использоваться только если это свойство объекта Q_GADGET

Данная функция была добавлена в Qt 5.5.