QQmlPropertyMap Class

Documentation des fonctions membres

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

Construit une carte liante avec l'objet parent parent. Utilisez ce constructeur dans les classes dérivées de QQmlPropertyMap.

Le type de derived est utilisé pour enregistrer la table des propriétés auprès du Meta-Object System, ce qui est nécessaire pour garantir l'accessibilité des propriétés de la classe dérivée. Ce type doit être dérivé de QQmlPropertyMap.

Dans le fichier 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();

Ensuite, dans 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()

Détruit la carte liante.

void QQmlPropertyMap::clear(const QString &key)

Efface la valeur (le cas échéant) associée à key.

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

Retourne vrai si la carte contient key.

Voir aussi size().

int QQmlPropertyMap::count() const

Identique à size().

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

Crée une carte liante avec l'objet parent parent.

[since 6.1] void QQmlPropertyMap::freeze()

Interdit l'ajout de nouvelles propriétés à cette carte des propriétés. Les propriétés existantes peuvent être modifiées ou effacées.

Par ailleurs, un cache interne est activé pour les propriétés existantes, ce qui peut permettre un accès plus rapide à partir de QML.

Cette fonction a été introduite dans Qt 6.1.

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

Insère le values dans le QQmlPropertyMap.

Les clés qui n'existent pas sont automatiquement créées.

Cette méthode est nettement plus rapide que d'appeler insert(key, value) plusieurs fois de suite.

Cette fonction a été introduite dans Qt 6.1.

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

Définit la valeur associée à key en value.

Si la clé n'existe pas, elle est automatiquement créée.

bool QQmlPropertyMap::isEmpty() const

Retourne true si la carte ne contient pas de clés, sinon retourne false.

Voir aussi size().

[invokable] QStringList QQmlPropertyMap::keys() const

Renvoie la liste des clés.

Les clés qui ont été effacées apparaîtront toujours dans cette liste, même si leurs valeurs associées sont des QVariants invalides.

int QQmlPropertyMap::size() const

Renvoie le nombre de clés dans la carte.

Voir aussi isEmpty() et count().

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

Renvoie la nouvelle valeur à stocker pour la clé key. Cette fonction est fournie pour intercepter les mises à jour d'une propriété à partir de QML, lorsque la valeur fournie par QML est input.

Surchargez cette fonction pour manipuler la valeur de la propriété au fur et à mesure qu'elle est mise à jour. Notez que cette fonction n'est invoquée que lorsque la valeur est mise à jour à partir de QML.

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

Renvoie la valeur associée à key.

Si aucune valeur n'a été définie pour cette clé (ou si la valeur a été effacée), une adresse QVariant invalide est renvoyée.

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

Ce signal est émis chaque fois qu'une des valeurs de la carte est modifiée. key est la clé correspondant à la valeur value qui a été modifiée.

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

Renvoie la valeur associée à la clé key sous la forme d'une référence modifiable.

Si la carte ne contient aucun élément avec la clé key, la fonction insère un QVariant invalide dans la carte avec la clé key, et renvoie une référence à cet élément.

Voir aussi insert() et value().

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

Identique à value().