Класс QMetaProperty

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

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

Публичные функции

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

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

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

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

Свойство имеет имя (name()), тип (type()), а также различные атрибуты, определяющие его поведение: 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() атрибут DESIGNABLE равен 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, если данное свойство обозначено как свойство USER, т.е. такое, которое пользователь может редактировать для object или которое важно по каким-либо другим причинам. В противном случае возвращает false. Например, свойство text является свойством USER для редактирования объекта 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.