QQmlPropertyMap Class

成员函数文档

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

构建一个以父对象parent 为基准的可绑定映射。请在从QQmlPropertyMap派生的类中使用此构造函数。

derived 的类型用于将属性映射注册到元对象系统中，这是确保能够访问派生类属性的必要条件。该类型必须继承自 QQmlPropertyMap。

在 C++ 文件中：

class MyQmlPropertyMap : public QQmlPropertyMap
{
    Q_OBJECT
    QML_NAMED_ELEMENT(MyQmlPropertyMap)
public:
    explicit MyQmlPropertyMap(QObject *parent = nullptr)
        : QQmlPropertyMap(this, parent)
    {
        insert("name", "John Smith");
        insert("phone", "555-5555");
        insert("email", "john.smith@example.com");
    }

public slots:
    void updateEmail(const QString &newEmail)
    {
        insert("email", newEmail);
    }
};
    QQuickView view;
    view.setSource(QUrl("qrc:/main.qml"));
    view.show();

然后，在main.qml 中：

MyQmlPropertyMap
{
    id : owner
    Component.onCompleted: { owner.updateEmail("new.email@example.com") }
}
Text { text : owner.name + " " + owner.phone + " " + owner.email }

[override virtual noexcept] QQmlPropertyMap::~QQmlPropertyMap()

销毁可绑定映射。

void QQmlPropertyMap::clear(const QString &key)

清除与key 关联的值（如有）。

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

如果该映射包含key ，则返回true。

另请参阅 size()。

int QQmlPropertyMap::count() const

与size() 相同。

[static] QQmlPropertyMap *QQmlPropertyMap::create(QObject *parent = nullptr)

创建一个可绑定的映射，其父对象为parent 。

[since 6.1] void QQmlPropertyMap::freeze()

禁止向此属性映射中添加任何其他属性。现有属性可以进行修改或清除。

相应地，系统会为现有属性启用内部缓存，这可能会加快 QML 的访问速度。

此功能自 Qt 6.1 起引入。

[since 6.1] void QQmlPropertyMap::insert(const QVariantHash &values)

将values 插入到QQmlPropertyMap 中。

不存在的键将自动创建。

此方法比连续多次调用 `insert(key, value) ` 要快得多。

该函数在 Qt 6.1 中引入。

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

将key 关联的值设置为value 。

如果该键不存在，则会自动创建。

bool QQmlPropertyMap::isEmpty() const

如果映射中不包含任何键，则返回 true；否则返回 false。

另请参阅 ` size()`。

[invokable] QStringList QQmlPropertyMap::keys() const

返回键的列表。

即使已清空的键，其关联的值已变为无效的 QVariant，这些键仍会出现在此列表中。

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 。

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

每当地图中的某个值发生变化时，都会触发此信号。key 是与发生变化的value 对应的键。

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

返回与键key 关联的值，该值以可修改引用形式返回。

如果映射中不存在键为key 的项，则该函数会向映射中插入一个键为key 的无效QVariant ，并返回对其的引用。

另请参阅 insert() 和value()。

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

与value()相同。