Тип QML Menu

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

Заявление об импорте:	import QtQuick.Controls 2.4
С момента:	Qt 5.7
Наследует:	Popup

Свойства

cascade : bool
contentData : список<Объект>
contentModel : модель
count : int
currentIndex : int
delegate : Компонент
overlap : вещественное
title : строка

Методы

Действие actionAt(int index)
void addAction(Действие action)
void addItem(Элемент item)
void addMenu(Меню menu)
void dismiss()
void insertAction(int index, Действие action)
void insertItem(int index, Элемент item)
void insertMenu(int index, Меню menu)
Элемент itemAt(int index)
Меню menuAt(int index)
void moveItem(int from, int to)
void popup(Элемент parent, вещественное x, вещественное y, MenuItem item = null)
void popup(вещественное x, вещественное y, MenuItem item = null)
void popup(Элемент parent, точка pos, MenuItem item = null)
void popup(точка pos, MenuItem item = null)
void popup(Элемент parent, MenuItem item = null)
void popup(MenuItem item = null)
void removeAction(Действие action)
void removeItem(Элемент item)
void removeMenu(Меню menu)
Действие takeAction(int index)
MenuItem takeItem(int index)
Меню takeMenu(int index)

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

Меню имеет два основных варианта использования:

Контекстные меню; например, меню, которое отображается после нажатия правой кнопки мыши
Всплывающие меню; например, меню, которое отображается после нажатия на кнопку

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

MouseArea {
    anchors.fill: parent
    acceptedButtons: Qt.LeftButton | Qt.RightButton
    onClicked: {
        if (mouse.button === Qt.RightButton)
            contextMenu.popup()
    }
    onPressAndHold: {
        if (mouse.source === Qt.MouseEventNotSynthesized)
            contextMenu.popup()
    }

    Menu {
        id: contextMenu
        MenuItem { text: "Cut" }
        MenuItem { text: "Copy" }
        MenuItem { text: "Paste" }
    }
}

При использовании в качестве всплывающего меню проще всего указать позицию, указав желаемые координаты x и y с помощью соответствующих свойств и вызвав open(), чтобы открыть меню.

Button {
    id: fileButton
    text: "File"
    onClicked: menu.open()

    Menu {
        id: menu
        y: fileButton.height

        MenuItem {
            text: "New..."
        }
        MenuItem {
            text: "Open..."
        }
        MenuItem {
            text: "Save"
        }
    }
}

С QtQuick.Controls 2.3 (Qt 5.10), также возможно создавать подменю и объявлять объекты Action внутри Menu:

Menu {
    Action { text: "Cut" }
    Action { text: "Copy" }
    Action { text: "Paste" }

    MenuSeparator { }

    Menu {
        title: "Find/Replace"
        Action { text: "Find Next" }
        Action { text: "Find Previous" }
        Action { text: "Replace" }
    }
}

Подменю по умолчанию имеют каскадное расположение на платформах с поддержкой курсора мыши. Меню без каскадирования отображаются по одному, и центрированы над родительским меню.

Обычно элементы меню статически объявляются как дочерние элементы меню, но Menu также предоставляет API для добавления, вставки, перемещения и удаления элементов динамически. К элементам меню можно получить доступ с помощью itemAt() или contentChildren.

Хотя MenuItem чаще всего используются с Menu, оно может содержать любой тип элемента.

См. также Настройка меню, MenuItem, Элементы управления меню и Элементы управления всплывающими окнами.

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

cascade : bool

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

Значение по умолчанию зависит от платформы. Меню по умолчанию каскадируются на платформах с поддержкой курсора мыши. Меню без каскадирования отображаются по одному, и центрированы над родительским меню.

Примечание: Изменение значения свойства не влияет на открытое меню.

Это свойство было введено в QtQuick.Controls 2.3 (Qt 5.10).

См. также overlap.

[default] contentData : list<Объект>

Это свойство содержит список данных содержимого.

Список содержит все объекты, объявленные в QML как дочерние элементы меню, а также элементы, динамически добавленные или вставленные с помощью методов addItem() и insertItem() соответственно.

Примечание: В отличие от contentChildren, contentData включает невидимые объекты QML. Он не переупорядочивается при вставке или перемещении элементов.

См. также Item::data и contentChildren.

[только для чтения] contentModel : модель

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

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

Menu {
    id: menu
    contentItem: ListView {
        model: menu.contentModel
    }
}

Модель позволяет статически объявлять элементы меню в качестве дочерних элементов меню.

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

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

Это свойство было введено в QtQuick.Controls 2.3 (Qt 5.10).

currentIndex : int

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

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

Это свойство было введено в QtQuick.Controls 2.3 (Qt 5.10).

См. также MenuItem::highlighted.

delegate : Компонент

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

Menu {
    Action { text: "Cut" }
    Action { text: "Copy" }
    Action { text: "Paste" }
}

Это свойство было введено в QtQuick.Controls 2.3 (Qt 5.10).

См. также Действие.

overlap : вещественное

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

Свойство действует только когда меню используется как каскадное подменю.

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

Примечание: Изменение значения свойства не влияет на открытое меню.

Это свойство было введено в QtQuick.Controls 2.3 (Qt 5.10).

См. также cascade.

title : строка

Это свойство содержит заголовок меню.

Заголовок меню часто отображается в тексте элемента меню, когда меню является подменю, и в тексте кнопки инструмента, когда оно находится в строке меню.

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

Действие actionAt(int index)

Возвращает действие по индексу index или null, если индекс недействителен или действия по указанному индексу нет.