Класс QQmlPropertyMap

Класс QQmlPropertyMap позволяет задавать пары «ключ-значение», которые могут быть использованы в привязках QML. Подробнее...

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

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

Сигналы

Защищенные функции

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

QQmlPropertyMap предоставляет удобный способ экспонирования данных домена в слой пользовательского интерфейса. Следующий пример показывает, как вы можете объявить данные в C++ и затем получить доступ к ним в QML.

В файле C++:

// create our data
QQmlPropertyMap ownerData;
ownerData.insert("name", QVariant(QString("John Smith")));
ownerData.insert("phone", QVariant(QString("555-5555")));

// expose it to the UI layer
QQuickView view;
QQmlContext *ctxt = view.rootContext();
ctxt->setContextProperty("owner", &ownerData);

view.setSource(QUrl::fromLocalFile("main.qml"));
view.show();

Затем, в main.qml:

Text { text: owner.name + " " + owner.phone }

Привязка динамическая — всякий раз, когда значение ключа обновляется, всё, что привязано к этому ключу, будет обновлено также.

Для обнаружения изменений значений, внесенных в слой пользовательского интерфейса, вы можете подключиться к сигналу valueChanged(). Однако обратите внимание, что valueChanged() НЕ излучается при внесении изменений путём вызова insert() или clear() — он излучается только при обновлении значения из QML.

Примечание: Удалить ключи из карты нельзя; после добавления ключа можно только изменить или очистить связанное с ним значение.

Примечание: При наследовании класса от QQmlPropertyMap используйте защищенный конструктор с двумя аргументами, который гарантирует, что класс правильно зарегистрирован в системе метаобъектов Qt метаобъектов.

Примечание: QMetaObject QQmlPropertyMap генерируется и модифицируется динамически. Операции с этим метаобъектом не потокобезопасны, поэтому приложениям нужно позаботиться об явном синхронизации доступа к метаобъекту.

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

[protected] template <typename DerivedType> QQmlPropertyMap::QQmlPropertyMap(DerivedType *derived, QObject *parent)

Создаёт привязываемую карту с родительским объектом parent. Используйте этот конструктор в классах, наследуемых от QQmlPropertyMap.

Тип derived используется для регистрации карты свойств в Системе метаобъектов, что необходимо для обеспечения доступа к свойствам производного класса. Этот тип должен быть производным от QQmlPropertyMap.

QQmlPropertyMap::QQmlPropertyMap(QObject *parent = nullptr)

Создаёт привязываемую карту с родительским объектом parent.

[signal] void QQmlPropertyMap::valueChanged(const QString &key, const QVariant &value)

Этот сигнал излучается всякий раз, когда одно из значений в карте изменяется. key — ключ, соответствующий изменённому value.

Примечание: valueChanged() НЕ излучается при внесении изменений путём вызова insert() или clear() — он излучается только при обновлении значения из QML.

[override virtual] QQmlPropertyMap::~QQmlPropertyMap()

Уничтожает привязываемую карту.

void QQmlPropertyMap::clear(const QString &key)

Очищает значение (если оно есть), связанное с key.

bool QQmlPropertyMap::contains(const QString &key) const

Возвращает true, если карта содержит key.

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

int QQmlPropertyMap::count() const

Это перегруженная функция.

То же, что и size().

void QQmlPropertyMap::insert(const QString &key, const QVariant &value)

Устанавливает значение, связанное с key, в value.

Если ключ не существует, он автоматически создаётся.

bool QQmlPropertyMap::isEmpty() const

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

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

QStringList QQmlPropertyMap::keys() const

Возвращает список ключей.

Ключи, которые были очищены, всё ещё будут отображаться в этом списке, даже если их связанные значения являются недопустимыми QVariant.

Примечание: К этой функции можно обратиться через систему метаобъектов и из QML. См. Q_INVOKABLE.

int QQmlPropertyMap::size() const

Возвращает количество ключей в карте.

См. также isEmpty() и count().

[virtual protected] QVariant QQmlPropertyMap::updateValue(const QString &key, const QVariant &input)

Возвращает новое значение, которое должно быть сохранено для ключа key. Эта функция предназначена для перехвата обновлений свойства из QML, где значение, предоставленное из QML, равно input.

Переопределите эту функцию, чтобы изменить значение свойства при его обновлении. Обратите внимание, что эта функция вызывается только при обновлении значения из QML.

QVariant QQmlPropertyMap::value(const QString &key) const

Возвращает значение, связанное с key.

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

QVariant &QQmlPropertyMap::operator[](const QString &key)

Возвращает значение, связанное с ключом key, как ссылку, которую можно изменить.

Если карта не содержит элемента с ключом key, функция вставляет недопустимый QVariant в карту с ключом key и возвращает ссылку на него.

См. также insert() и value().

QVariant QQmlPropertyMap::operator[](const QString &key) const

Это перегруженная функция.

То же, что и value().