Тип PathView QML

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

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

Свойства

• 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 : model
• 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.

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

Например, если простая модель списка определена в файле 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
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: icon
            }
            Text {
                id: nameText
                text: name
                font.pointSize: 16
                color: wrapper.PathView.isCurrentItem ? "red" : "black"
            }
        }
    }

    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()
}

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

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

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

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

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

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

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

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
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: icon
            }
            Text {
                id: nameText
                text: name
                font.pointSize: 16
                color: wrapper.PathView.isCurrentItem ? "red" : "black"
            }
        }
    }

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 мс.

highlightRangeMode : enumeration

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

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

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

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

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

Примечание: Для валидного диапазона preferredHighlightEnd должно быть больше или равно preferredHighlightBegin.

interactive : bool

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

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

maximumFlickVelocity : real

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

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

model : model

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

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

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

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

moving : bool

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

offset : real

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

path : Path

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

pathItemCount : int

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

Установка pathItemCount в undefined отобразит все элементы на пути.

preferredHighlightBegin : real

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

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

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

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

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

Примечание: Для валидного диапазона preferredHighlightEnd должно быть больше или равно preferredHighlightBegin.

preferredHighlightEnd : real

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

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

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

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

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

Примечание: Для валидного диапазона preferredHighlightEnd должно быть больше или равно preferredHighlightBegin.

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
            Image {
                anchors.horizontalCenter: nameText.horizontalCenter
                width: 64; height: 64
                source: icon
            }
            Text {
                id: nameText
                text: name
                font.pointSize: 16
                color: wrapper.PathView.isCurrentItem ? "red" : "black"
            }
        }
    }

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)