Класс QQmlListProperty

Класс QQmlListProperty позволяет приложениям предоставлять свойства, подобные спискам, для классов, производных от QObject, в QML. Подробнее...

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

Типы публичного интерфейса

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

Макросы

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

В QML существует много свойств списков, где можно назначить несколько значений объекта. Использование свойства списка из QML выглядит так:

FruitBasket {
    fruit: [
        Apple {},
        Orange{},
        Banana{}
    ]
}

Класс QQmlListProperty инкапсулирует набор указателей на функции, представляющие набор действий, которые QML может выполнить со списком: добавление элементов, извлечение элементов и очистка списка. В будущем могут быть добавлены дополнительные операции. Все свойства списка должны реализовывать операцию добавления, но остальные являются необязательными.

Для предоставления свойства списка класс C++ должен реализовать обратные вызовы операций, а затем вернуть соответствующее значение QQmlListProperty из получателя свойства. У свойств списков не должно быть установщика.

В приведенном выше примере декларативная конструкция Q_PROPERTY() будет выглядеть следующим образом:

Q_PROPERTY(QQmlListProperty<Fruit> fruit READ fruit)

Свойства списков QML являются типобезопасными — в данном случае Fruit является типом QObject, от которого Apple, Orange и Banana наследуются.

См. также Пример расширения QML — типы свойств объекта и списка.

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

[alias] QQmlListProperty::AppendFunction

Синоним для void (*)(QQmlListProperty<T> *property, T *value).

Добавить value в список property.

[alias] QQmlListProperty::AtFunction

Синоним для T *(*)(QQmlListProperty<T> *property, qsizetype index).

Возвращает элемент с индексом index в списке property.

[alias] QQmlListProperty::ClearFunction

Синоним для void (*)(QQmlListProperty<T> *property).

Очистить список property.

[alias] QQmlListProperty::CountFunction

Синоним для qsizetype (*)(QQmlListProperty<T> *property).

Возвращает количество элементов в списке property.

[alias] QQmlListProperty::RemoveLastFunction

Синоним для void (*)(QQmlListProperty<T> *property).

Удалить последний элемент из списка property.

[alias] QQmlListProperty::ReplaceFunction

Синоним для void (*)(QQmlListProperty<T> *property, qsizetype index, T *value).

Заменить элемент с индексом index в списке property на value.

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

QQmlListProperty::QQmlListProperty(QObject *object, void *data, QQmlListProperty::CountFunction count, QQmlListProperty::AtFunction at)

Создает только для чтения QQmlListProperty из набора функций операций count и at. Может быть передан неявный дескриптор data, к которому можно получить доступ внутри функций операций. Свойство списка остается валидным, пока существует object.

QQmlListProperty::QQmlListProperty(QObject *object, void *data, QQmlListProperty::AppendFunction append, QQmlListProperty::CountFunction count, QQmlListProperty::AtFunction at, QQmlListProperty::ClearFunction clear, QQmlListProperty::ReplaceFunction replace, QQmlListProperty::RemoveLastFunction removeLast)

Создает QQmlListProperty из набора функций операций append, count, at, clear, replace и removeLast. Может быть передан неявный дескриптор data, к которому можно получить доступ внутри функций операций. Свойство списка остается валидным, пока существует object.

Для любой функции могут быть переданы нулевые указатели, что приведет к синтезу соответствующей функции с использованием других функций, если это возможно. QQmlListProperty может синтезировать

• clear с использованием count и removeLast
• replace с использованием count, at, clear и append
• replace с использованием count, at, removeLast и append
• removeLast с использованием count, at, clear и append

если они заданы. Это медленно, но если ваш список не предоставляет более быстрые варианты для этих примитивов, вы можете использовать синтезированные.

Кроме того, если ни один из count, at, append и clear не задан явно и не синтезирован, список нельзя будет ни задавать, ни изменять в отладчике. Рекомендуется передавать достаточное количество допустимых указателей, чтобы избежать такой ситуации.

QQmlListProperty::QQmlListProperty(QObject *object, void *data, QQmlListProperty::AppendFunction append, QQmlListProperty::CountFunction count, QQmlListProperty::AtFunction at, QQmlListProperty::ClearFunction clear)

Создает QQmlListProperty из набора функций операций append, count, at и clear. Может быть передан неявный дескриптор data, к которому можно получить доступ внутри функций операций. Свойство списка остается валидным, пока существует object.

Для любой функции могут быть переданы нулевые указатели. Если переданы любые нулевые указатели, список нельзя будет ни задавать, ни изменять в отладчике. Рекомендуется передавать действительные указатели для всех функций.

[since 5.15] QQmlListProperty::QQmlListProperty(QObject *object, QList<T *> *list)

Удобный конструктор для создания значения QQmlListProperty из существующего списка QList list. Ссылка на list должна оставаться действительной до тех пор, пока существует object. object должен быть предоставлен.

Эта функция была добавлена в Qt 5.15.

bool QQmlListProperty::operator==(const QQmlListProperty<T> &other) const

Возвращает true, если этот QQmlListProperty равен other, иначе false.

class FruitBasket : QObject {
    Q_OBJECT
    QML_LIST_PROPERTY_ASSIGN_BEHAVIOR_APPEND
    Q_PROPERTY(QQmlListProperty<Fruit> fruit READ fruit)

    public:
    // ...
    QQmlListProperty<Fruit> fruit();
    // ...
};

class FruitBasket : QObject {
    Q_OBJECT
    QML_LIST_PROPERTY_ASSIGN_BEHAVIOR_REPLACE
    Q_PROPERTY(QQmlListProperty<Fruit> fruit READ fruit)

    public:
    // ...
    QQmlListProperty<Fruit> fruit();
    // ...
};

class FruitBasket : QObject {
    Q_OBJECT
    QML_LIST_PROPERTY_ASSIGN_BEHAVIOR_REPLACE_IF_NOT_DEFAULT
    Q_PROPERTY(QQmlListProperty<Fruit> fruit READ fruit)

    public:
    // ...
    QQmlListProperty<Fruit> fruit();
    // ...
};