Spec-Zone.ru › Qt 5.12

Тип PieMenu QML

Поп-меню, отображающее несколько пунктов меню по дуге. Подробнее...

Заявление об импорте: import QtQuick.Extras 1.4
С момента: Qt 5.5
  • Список всех членов, включая унаследованные
  • Устаревшие члены

Свойства

  • boundingItem : Item
  • currentIndex : int
  • currentItem : int
  • menuItems : список<MenuItem>
  • selectionAngle : real
  • title : строка
  • triggerMode : int

Методы

  • void addItem(строка text)
  • void insertItem(int before, строка text)
  • void popup(real x, real y)
  • void removeItem(item)

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

A PieMenu

Тип PieMenu предоставляет радиальное контекстное меню в качестве альтернативы традиционному меню. Все элементы PieMenu находятся на одинаковом расстоянии от центра элемента управления.

Заполнение меню

Для создания меню определите как минимум один элемент MenuItem как дочерний элемент:

PieMenu {
    id: pieMenu

    MenuItem {
        text: "Action 1"
        onTriggered: print("Action 1")
    }
    MenuItem {
        text: "Action 2"
        onTriggered: print("Action 2")
    }
    MenuItem {
        text: "Action 3"
        onTriggered: print("Action 3")
    }
}

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

Отображение меню

Типовой случай использования меню — открытие в точке курсора мыши после щелчка правой кнопкой. Для этого определите MouseArea, покрывающую область, по которой следует открывать меню. При нажатии правой кнопкой мыши на MouseArea вызовите функцию popup():

MouseArea {
    anchors.fill: parent
    acceptedButtons: Qt.RightButton

    onClicked: pieMenu.popup(mouseX, mouseY)
}

Если меню открывается в позиции, где некоторые его элементы будут за пределами boundingItem, оно автоматически перемещается в позицию, где они не будут скрыты. По умолчанию boundingItem установлен на родительский элемент меню. Его также можно установить на null для предотвращения этого поведения.

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

Чтобы создать PieMenu, который открывается после длительного нажатия и выбирает элементы при отпускании, вы можете объединить ActivationMode.ActivateOnRelease с MouseArea с использованием таймера:

MouseArea {
    id: touchArea
    anchors.fill: parent

    Timer {
        id: pressAndHoldTimer
        interval: 300
        onTriggered: pieMenu.popup(touchArea.mouseX, touchArea.mouseY);
    }

    onPressed: pressAndHoldTimer.start()
    onReleased: pressAndHoldTimer.stop();
}

PieMenu {
    id: pieMenu

    triggerMode: TriggerMode.TriggerOnRelease

    MenuItem {
        text: "Action 1"
        onTriggered: print("Action 1")
    }
    MenuItem {
        text: "Action 2"
        onTriggered: print("Action 2")
    }
    MenuItem {
        text: "Action 3"
        onTriggered: print("Action 3")
    }
}

Вы можете скрыть отдельные элементы меню, установив их свойство visible в false. Скрытие элементов не влияет на startAngle или endAngle; оставшиеся элементы будут расширяться, чтобы занять доступное пространство.

Вы можете создать пользовательский вид для PieMenu, назначив PieMenuStyle

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

boundingItem : Item

Элемент, внутри которого должно оставаться меню.

Типичный случай использования PieMenu включает:

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

Несмотря на то, что они звучат похоже, они имеют разные цели. Рассмотрим пример ниже:

Canvas boundingItem example

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

Если по какой-либо причине нам не нужна эта ограничение, мы можем установить boundingItem на null:

Canvas null boundingItem example

По умолчанию родительский элемент меню является boundingItem.

[только для чтения] currentIndex : int

Индекс элемента меню, который в данный момент находится под курсором, или -1 если такого элемента нет.

[только для чтения] currentItem : int

Элемент меню, который в данный момент находится под курсором, или null если такого элемента нет.

[значение по умолчанию] menuItems : список<MenuItem>

Список элементов меню, отображаемых в этом меню.

Вы можете назначать элементы меню, объявляя их как дочерние элементы PieMenu:

PieMenu {
    MenuItem {
        text: "Action 1"
        onTriggered: function() { print("Action 1"); }
    }
    MenuItem {
        text: "Action 2"
        onTriggered: function() { print("Action 2"); }
    }
    MenuItem {
        text: "Action 3"
        onTriggered: function() { print("Action 3"); }
    }
}

[только для чтения] selectionAngle : real

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

Его значение не определено, когда меню не отображается.

title : строка

Это свойство определяет текст, отображаемый над меню, когда нет текущего элемента меню (currentIndex равно -1).

Значение по умолчанию — "" (пустая строка).

triggerMode : int

Это свойство определяет метод выбора элементов в меню.

  • triggerMode со значением TriggerMode.TriggerOnPress означает, что элементы меню будут выбираться только при нажатии кнопки мыши на них.
  • triggerMode со значением TriggerMode.TriggerOnRelease означает, что элементы меню будут выбираться только при отпускании кнопки мыши над ними. Это означает, что пользователь должен удерживать кнопку мыши после открытия меню и отпустить ее над элементом, который он хочет выбрать.
  • triggerMode со значением TriggerMode.TriggerOnClick означает, что элементы меню будут выбираться только при нажатии пользователем один раз над ними.

Предупреждение: Изменение triggerMode во время видимости меню приведет к неопределенному поведению.

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

void addItem(строка text)

Добавляет элемент в конец элементов меню.

Эквивалентно вызову insertItem(menuItems.length, text).

Возвращает вновь добавленный элемент.

void insertItem(int before, строка text)

Вставляет MenuItem с text перед индексом before.

Чтобы вставить элемент в конец, передайте menuItems.length.

Возвращает вставленный элемент или null если before некорректный.

void popup(real x, real y)

Открывает меню в координатах x, y.

void removeItem(item)

Удаляет item из меню.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.12/qml-qtquick-extras-piemenu.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API