Класс 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 Meta-Object System.

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

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

[protected] QQmlPropertyMap::QQmlPropertyMap(DerivedType *derived, QObject *parent)

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

Тип derived используется для регистрации карты свойств в системе Meta-Object System, что необходимо для обеспечения доступа к свойствам производного класса. Этот тип должен быть производным от 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().