Тип QML PathView

Выкладывает элементы, предоставляемые моделью, на траектории. Подробнее...

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

Свойства

• cacheItemCount : int
• count : int
• currentIndex : int
• currentItem : Item
• delegate : Component
• dragMargin : real
• dragging : bool
• flickDeceleration : real
• flicking : bool
• highlight : Component
• highlightItem : Item
• highlightMoveDuration : int
• highlightRangeMode : перечисление
• interactive : bool
• maximumFlickVelocity : real
• model : модель
• movementDirection : перечисление
• moving : bool
• offset : real
• path : Path
• pathItemCount : int
• preferredHighlightBegin : real
• preferredHighlightEnd : real
• snapMode : перечисление

Присоединённые свойства

• isCurrentItem : bool
• onPath : bool
• view : PathView

Сигналы

• dragEnded()
• dragStarted()
• flickEnded()
• flickStarted()
• movementEnded()
• movementStarted()

Методы

• decrementCurrentIndex()
• incrementCurrentIndex()
• int indexAt(real x, real y)
• Item itemAt(real x, real y)
• positionViewAtIndex(int index, PositionMode mode)

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

PathView отображает данные из моделей, созданных из встроенных типов QML, таких как ListModel и XmlListModel, или пользовательских классов модели, определённых в C++, которые наследуются от QAbstractListModel.

Представление имеет модель, которая определяет отображаемые данные, и делегат, который определяет, как должны отображаться данные. Делегат создаётся для каждого элемента на траектории. Элементы могут перемещаться по траектории с помощью нажатия.

Например, если в файле ContactModel.qml определена простая модель списка:

import QtQuick 2.0

ListModel {
    ListElement {
        name: "Bill Jones"
        icon: "pics/qtlogo.png"
    }
    ListElement {
        name: "Jane Doe"
        icon: "pics/qtlogo.png"
    }
    ListElement {
        name: "John Smith"
        icon: "pics/qtlogo.png"
    }
}

Эти данные можно представить в виде PathView, например так:

import QtQuick 2.0

Rectangle {
    width: 240; height: 200

    Component {
        id: delegate
        Column {
            id: wrapper
            opacity: PathView.isCurrentItem ? 1 : 0.5
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: icon
            }
            Text {
                id: nameText
                text: name
                font.pointSize: 16
            }
        }
    }

    PathView {
        anchors.fill: parent
        model: ContactModel {}
        delegate: delegate
        path: Path {
            startX: 120; startY: 100
            PathQuad { x: 120; y: 25; controlX: 260; controlY: 75 }
            PathQuad { x: 120; y: 100; controlX: -20; controlY: 75 }
        }
    }
}

(В приведённом выше примере используется PathAttribute для масштабирования и изменения непрозрачности элементов по мере их вращения. Этот дополнительный код можно увидеть в документации PathAttribute.)

PathView не обрабатывает навигацию по клавиатуре автоматически. Это связано с тем, что используемые клавиши будут зависеть от формы траектории. Навигацию можно довольно просто добавить, установив focus на true и вызвав decrementCurrentIndex() или incrementCurrentIndex(), например, для навигации с помощью клавиш влево и вправо:

PathView {
    // ...
    focus: true
    Keys.onLeftPressed: decrementCurrentIndex()
    Keys.onRightPressed: incrementCurrentIndex()
}

Само представление траектории является областью фокуса (подробнее см. Фокус клавиатуры в Qt Quick).

Делегаты создаются по мере необходимости и могут быть уничтожены в любое время. Состояние никогда не должно храниться в делегате.

PathView присоединяет ряд свойств к корневому элементу делегата, например, PathView.isCurrentItem. В следующем примере корневой элемент делегата может получить доступ к этому присоединённому свойству непосредственно как PathView.isCurrentItem, в то время как объект дочернего элемента nameText должен обращаться к этому свойству как wrapper.PathView.isCurrentItem.

    Component {
        id: delegate
        Column {
            id: wrapper
            opacity: PathView.isCurrentItem ? 1 : 0.5
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: icon
            }
            Text {
                id: nameText
                text: name
                font.pointSize: 16
            }
        }
    }

Примечание. Представления не включают обрезку автоматически. Если представление не обрезается другим элементом или экраном, необходимо установить clip: true, чтобы корректно обрезать элементы, находящиеся вне поля видимости.

См. также Path, QML Модели данных, ListView, GridView и Примеры Qt Quick — Представления.

Документация по свойствам

Эти свойства задают предпочтительный диапазон выделения (текущий элемент) в представлении. Предпочтительные значения должны находиться в диапазоне от 0 до 1.

Допустимые значения для highlightRangeMode:

• PathView.NoHighlightRange — диапазон не применяется, и выделение будет свободно перемещаться в пределах представления.
• PathView.ApplyRange — представление попытается сохранить выделение в диапазоне, но выделение может выйти за пределы диапазона в конце траектории или из-за взаимодействия с мышкой.
• PathView.StrictlyEnforceRange — выделение никогда не выйдет за пределы диапазона. Это означает, что текущий элемент изменится, если действие с клавиатуры или мыши вызовет перемещение выделения за пределы диапазона.

Значение по умолчанию — PathView.StrictlyEnforceRange.

Определение диапазона выделения — правильный способ повлиять на то, где оказывается текущий элемент при перемещении представления. Например, если вы хотите, чтобы текущий выбранный элемент находился посередине траектории, установите диапазон выделения в 0,5; 0,5 и highlightRangeMode в PathView.StrictlyEnforceRange. Тогда при прокрутке траектории текущим выбранным элементом будет элемент в этой позиции. Это также относится к случаям изменения текущего выбранного элемента — он будет прокручиваться до предпочтительного диапазона выделения. Кроме того, поведение текущего индекса элемента произойдёт независимо от наличия выделения.

Примечание: Действительный диапазон требует, чтобы preferredHighlightEnd было больше или равно preferredHighlightBegin.

cacheItemCount : int

Это свойство содержит максимальное количество элементов для кэширования вне траектории.

Например, PathView с моделью, содержащей 20 элементов, pathItemCount 10 и cacheItemCount 4 создаст до 14 элементов, из которых 10 будут видны на траектории, а 4 — невидимые кэшированные элементы.

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

Примечание. Установка этого свойства не заменяет создание эффективных делегатов. Это может улучшить плавность поведения при прокрутке за счёт дополнительного использования памяти. Чем меньше объектов и связей в делегате, тем быстрее можно прокручивать представление. Важно понимать, что установка cacheItemCount лишь отложит проблемы, вызванные медленным загрузкой делегатов, это не решение для такой ситуации.

См. также pathItemCount.

count : int

Это свойство содержит количество элементов в модели.

currentIndex : int

Это свойство содержит индекс текущего элемента.

currentItem : Item

Это свойство содержит текущий элемент в представлении.

delegate : Component

Делегат предоставляет шаблон, определяющий каждый элемент, создаваемый представлением. Индекс представлен как доступное index свойство. Свойства модели также доступны в зависимости от типа модели данных.

Количество объектов и связей в делегате оказывает непосредственное влияние на производительность прокрутки представления, когда указано pathItemCount. Если это возможно, поместите функциональность, которая не требуется для нормального отображения делегата, в Loader, который может загружать дополнительные компоненты по мере необходимости.

Обратите внимание, что PathView будет размещать элементы на основе размера корневого элемента в делегате.

Вот пример делегата:

    Component {
        id: delegate
        Column {
            id: wrapper
            opacity: PathView.isCurrentItem ? 1 : 0.5
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: icon
            }
            Text {
                id: nameText
                text: name
                font.pointSize: 16
            }
        }
    }

dragMargin : real

Это свойство содержит максимальное расстояние от пути, который инициирует перетаскивание мышью.

По умолчанию путь можно перетащить только щелкнув по элементу. Если dragMargin больше нуля, перетаскивание можно начать, щелкнув в пределах dragMargin пикселей от пути.

dragging : bool

Это свойство содержит значение, указывающее, перемещается ли представление в данный момент из-за перетаскивания пользователем.

flickDeceleration : real

Это свойство содержит скорость, с которой затухает прокрутка.

Значение по умолчанию равно 100.

flicking : bool

Это свойство содержит значение, указывающее, перемещается ли представление в данный момент из-за прокрутки пользователем.

highlight : Component

Это свойство содержит компонент, используемый в качестве выделения.

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

Ниже приведен пример того, как создать простое выделение. Обратите внимание на использование присоединённого свойства PathView.onPath, чтобы убедиться, что выделение скрыто, когда прокрутка отходит от пути.

Component {
    Rectangle {
        visible: PathView.onPath
        // ...
    }
}

См. также highlightItem и highlightRangeMode.

highlightItem : Item

highlightItem содержит элемент выделения, который был создан из компонента highlight.

См. также highlight.

highlightMoveDuration : int

Это свойство содержит длительность анимации перемещения выделенного делегата.

Если highlightRangeMode — StrictlyEnforceRange, то это свойство определяет скорость перемещения элементов по пути.

Значение по умолчанию для длительности — 300 мс.

interactive : bool

Пользователь не может перетащить или прокрутить PathView, который не интерактивен.

Это свойство полезно для временного отключения прокрутки. Это позволяет использовать специальное взаимодействие с элементами PathView.

maximumFlickVelocity : real

Это свойство содержит приблизительную максимальную скорость, с которой пользователь может прокрутить представление в пикселях/секунду.

Значение по умолчанию зависит от платформы.

model : model

Это свойство содержит модель, предоставляющую данные для представления.

Модель предоставляет набор данных, используемый для создания элементов для представления. Для больших или динамических наборов данных модель обычно предоставляется объектом модели C++. Модели также могут быть созданы непосредственно в QML, используя тип ListModel.

Примечание: изменение модели сбросит смещение и currentIndex до 0.

См. также Модели данных.

[since 5.7] movementDirection : enumeration

Это свойство определяет направление, в котором элементы перемещаются при установке текущего индекса. Возможные значения:

• PathView.Shortest (по умолчанию) - элементы перемещаются в направлении, требующем наименьшего перемещения, что может быть как Negative , так и Positive.
• PathView.Negative - элементы перемещаются назад к своему пункту назначения.
• PathView.Positive - элементы перемещаются вперед к своему пункту назначения.

Например, предположим, что в модели есть 5 элементов, и currentIndex равно 0. Если currentIndex установлено в 2,

• направление перемещения Positive приведет к следующему порядку: 0, 1, 2
• направление перемещения Negative приведет к следующему порядку: 0, 5, 4, 3, 2
• направление перемещения Shortest приведет к тому же порядку, что и Positive.

Примечание: это свойство не влияет на перемещение incrementCurrentIndex() и decrementCurrentIndex().

Это свойство было введено в Qt 5.7.

moving : bool

Это свойство содержит значение, указывающее, перемещается ли представление в данный момент из-за перетаскивания или прокрутки пользователем.

offset : real

Смещение указывает, насколько далеко вдоль пути находятся элементы от их начальных позиций. Это вещественное число, которое варьируется от 0 до количества элементов в модели.

path : Path

Это свойство содержит путь, используемый для размещения элементов. Более подробную информацию см. в документации Path.

pathItemCount : int

Это свойство содержит количество элементов, видимых на пути одновременно.

Установка pathItemCount в неопределённое значение покажет все элементы на пути.

snapMode : enumeration

Это свойство определяет, как элементы будут устанавливаться после перетаскивания или прокрутки. Возможные значения:

• PathView.NoSnap (по умолчанию) - элементы останавливаются где угодно на пути.
• PathView.SnapToItem - элементы устанавливаются с элементом, выровненным с preferredHighlightBegin.
• PathView.SnapOneItem - элементы устанавливаются не более чем на один элемент от элемента, ближайшего к preferredHighlightBegin в момент отпускания нажатия. Этот режим особенно полезен для перемещения по одной странице за раз.

snapMode не влияет на currentIndex. Чтобы обновить currentIndex по мере перемещения представления, установите highlightRangeMode в PathView.StrictlyEnforceRange (значение по умолчанию для PathView).

См. также highlightRangeMode.

Документация по присоединённым свойствам

PathView.isCurrentItem : bool

Это присоединённое свойство имеет значение true, если этот делегат является текущим элементом, и false в противном случае.

Оно присоединяется к каждому экземпляру делегата.

Это свойство может использоваться для изменения внешнего вида текущего элемента.

    Component {
        id: delegate
        Column {
            id: wrapper
            opacity: PathView.isCurrentItem ? 1 : 0.5
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: icon
            }
            Text {
                id: nameText
                text: name
                font.pointSize: 16
            }
        }
    }

PathView.onPath : bool

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

Если было установлено pathItemCount, возможно, некоторые элементы были созданы, но не считаются находящимися в данный момент на пути. Обычно эти элементы скрываются, например:

Component {
    Rectangle {
        visible: PathView.onPath
        // ...
    }
}

Оно присоединяется к каждому экземпляру делегата.

PathView.view : PathView

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

Оно присоединяется к каждому экземпляру делегата.

Документация по сигналам

dragEnded()

Этот сигнал испускается, когда пользователь прекращает перетаскивание представления.

Если скорость перетаскивания достаточно высока в момент отпускания сенсорного или мышиного клика, начнется прокрутка.

Примечание: Соответствующий обработчик — onDragEnded.

dragStarted()

Этот сигнал испускается, когда представление начинает перетаскиваться из-за взаимодействия пользователя.

Примечание: Соответствующий обработчик — onDragStarted.

flickEnded()

Этот сигнал испускается, когда представление перестаёт двигаться из-за прокрутки.

Примечание: Соответствующий обработчик — onFlickEnded.

flickStarted()

Этот сигнал излучается, когда представление прокручивается. Прокрутка начинается с точки, в которой мышь или сенсорный экран отпускаются, при этом движение продолжается.

Примечание: Соответствующий обработчик — onFlickStarted.

movementEnded()

Этот сигнал излучается, когда движение представления прекращается из-за взаимодействия пользователя. Если была инициирована прокрутка, этот сигнал будет излучен, как только прокрутка остановится. Если прокрутка не была инициирована, этот сигнал будет излучен, когда пользователь перестанет перемещать представление — т. е. при отпускании мыши или сенсорного экрана.

Примечание: Соответствующий обработчик — onMovementEnded.

movementStarted()

Этот сигнал излучается, когда движение представления начинается из-за взаимодействия пользователя.

Примечание: Соответствующий обработчик — onMovementStarted.

Документация методов

decrementCurrentIndex()

Уменьшает текущий индекс.

Примечание: методы следует вызывать только после завершения компонента.

incrementCurrentIndex()

Увеличивает текущий индекс.

Примечание: методы следует вызывать только после завершения компонента.

int indexAt(real x, real y)

Возвращает индекс элемента, содержащего точку x, y в координатах содержимого. Если в указанной точке нет элемента, возвращается -1.

Примечание: методы следует вызывать только после завершения компонента.

Item itemAt(real x, real y)

Возвращает элемент, содержащий точку x, y в координатах содержимого. Если в указанной точке нет элемента, возвращается null.

Примечание: методы следует вызывать только после завершения компонента.

positionViewAtIndex(int index, PositionMode mode)

Позиционирует представление так, чтобы элемент с индексом index находился в позиции, заданной mode:

• PathView.Начало — позиционирует элемент в начале пути.
• PathView.Центр — позиционирует элемент в центре пути.
• PathView.Конец — позиционирует элемент в конце пути.
• PathView.Содержит — гарантирует позиционирование элемента на пути.
• PathView.ТочкаПривязки — позиционирует элемент в точке preferredHighlightBegin. Этот режим допустим только если highlightRangeMode равен StrictlyEnforceRange или привязка включена через snapMode.

Примечание: методы следует вызывать только после завершения компонента. Для позиционирования представления при запуске следует вызвать этот метод в Component.onCompleted. Например, для позиционирования представления в конце:

Component.onCompleted: positionViewAtIndex(count - 1, PathView.End)