Menu QML Type

A native menu. More...

• List of all members, including inherited members

Properties

• data : list<QtObject>
• enabled : bool
• font : font
• icon (since Qt.labs.platform 1.1 (Qt 5.12))
  • icon.mask : bool (since Qt.labs.platform 1.1 (Qt 5.12))
  • icon.name : string (since Qt.labs.platform 1.1 (Qt 5.12))
  • icon.source : url (since Qt.labs.platform 1.1 (Qt 5.12))
• items : list<MenuItem>
• menuBar : MenuBar
• menuItem : MenuItem
• minimumWidth : int
• parentMenu : Menu
• systemTrayIcon : SystemTrayIcon
• title : string
• type : enumeration
• visible : bool

Signals

• aboutToHide()
• aboutToShow()

Methods

• void addItem(MenuItem item)
• void addMenu(Menu submenu)
• void clear()
• void close()
• void insertItem(int index, MenuItem item)
• void insertMenu(int index, Menu submenu)
• void open(MenuItem item)
• void open(Item target, MenuItem item)
• void removeItem(MenuItem item)
• void removeMenu(Menu submenu)

Detailed Description

The Menu type provides a QML API for native platform menu popups.

Menu can be used in a MenuBar, or as a stand-alone context menu. The following example shows how to open a context menu on right mouse click:

 MouseArea {
     anchors.fill: parent
     acceptedButtons: Qt.RightButton
     onClicked: zoomMenu.open()
 }

 Menu {
     id: zoomMenu

     MenuItem {
         text: qsTr("Zoom In")
         shortcut: StandardKey.ZoomIn
         onTriggered: zoomIn()
     }

     MenuItem {
         text: qsTr("Zoom Out")
         shortcut: StandardKey.ZoomOut
         onTriggered: zoomOut()
     }
 }

Submenus

To create submenus, declare a Menu as a child of another Menu:

 Menu {
     title: qsTr("Edit")

     Menu {
         title: qsTr("Advanced")

         MenuItem {
             text: qsTr("Auto-indent Selection")
             onTriggered: autoIndentSelection()
         }

         MenuItem {
             text: qsTr("Rewrap Paragraph")
             onTriggered: rewrapParagraph()
         }
     }
 }

Dynamically generating menu items

You can dynamically generate menu items with Instantiator. The following code shows how you can implement a "Recent Files" submenu, where the items come from a list of files stored in settings:

 Menu {
     title: qsTr("File")

     Menu {
         id: recentFilesMenu
         title: qsTr("Recent Files")
         enabled: recentFilesInstantiator.count > 0

         Instantiator {
             id: recentFilesInstantiator
             model: settings.recentFiles
             delegate: MenuItem {
                 text: settings.displayableFilePath(modelData)
                 onTriggered: loadFile(modelData)
             }

             onObjectAdded: (index, object) => recentFilesMenu.insertItem(index, object)
             onObjectRemoved: (index, object) => recentFilesMenu.removeItem(object)
         }

         MenuSeparator {}

         MenuItem {
             text: qsTr("Clear Recent Files")
             onTriggered: settings.clearRecentFiles()
         }
     }
 }

Availability

A native platform menu is currently available on the following platforms:

• macOS
• iOS
• Android
• Linux (only available as a stand-alone context menu when running with the GTK+ platform theme)

The Qt Labs Platform module uses Qt Widgets as a fallback on platforms that do not have a native implementation available. Therefore, applications that use types from the Qt Labs Platform module should link to QtWidgets and use QApplication instead of QGuiApplication.

To link against the QtWidgets library, add the following to your qmake project file:

 QT += widgets

Create an instance of QApplication in main():

 #include <QApplication>
 #include <QQmlApplicationEngine>

 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
     QQmlApplicationEngine engine;
     engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
     return app.exec();
 }

See also MenuItem, MenuSeparator, and MenuBar.

Property Documentation

Signal Documentation

Method Documentation