Класс QMetaProperty

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

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

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

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

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

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

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

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

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

Значения свойства устанавливаются и извлекаются с помощью read(), write() и reset(); их также можно изменить с помощью функций set и get объекта 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 = Q_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 = Q_NULLPTR) const

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

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

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

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

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

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

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

bool QMetaProperty::isUser(const QObject *object = Q_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

Возвращает версию свойства, если она была задана REVISION, в противном случае возвращает 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.