QML ContextMenu Element

A Context Menu component for selecting a menu item from a list of menu items. More...

Inherits Popup

This element was introduced in qt-components 4.7.

• List of all members, including inherited members

Properties

• content : Item
• platformStyle : Style
• status : int
• title : list<Item>
• visualParent : QDeclarativeItem*

Methods

• close
• open

Detailed Description

A Context Menu componentis for selecting a menu item from a list of menu items. Each menu item displays some text and can be associated with a custom action that is performed on the clicked signal.

The menu items are arranged in a layout via the MenuLayout element. Note that this layout and its implementation can vary depending on the UI guidelines of the platform.

 PageStackWindow {
   id: rootWindow
   initialPage: Page {

     // long press rectangle to open the ContextMenu
     Rectangle {
         id: contextColorRect
         anchors.centerIn: parent
         width: 100; height: 100
         color: "black"
         MouseArea {
             id: longPressArea
             anchors.fill: parent
             onPressAndHold: myContextMenu.open()
         }
     }

     // Create a menu with different menu items.
     ContextMenu {
         id: myContextMenu
         MenuLayout {
             MenuItem {text: "Red"; onClicked: { contextColorRect.color = "darkred" } }
             MenuItem {text: "Green"; onClicked: { contextColorRect.color = "darkgreen" }}
             MenuItem {text: "Blue"; onClicked: { contextColorRect.color = "darkblue" }}
             MenuItem {text: "Black is an extremely beautiful and stylish color"; onClicked: { contextColorRect.color = "black" }}
         }
       }
    }
  }

The visual parent property is used to specify which area of the screen is grayed out while the menu is opened. If no visual parent is set then it is determined automatically and falls back to the root item.

The ContextMenu shares most of its API with the ContextMenu component.

Common API

     default property alias content: contentField.children

     // Common API inherited from Popup:
     function open()
     function close()

     property QDeclarativeItem* visualParent
     property int status

     property list<Item> title: titleBar.children

     // platformStyle API
     property Style platformStyle
     property string platformTitleText
     property Item platformIcon

     property Style style // Deprecated

See also MenuItem.

Property Documentation

Method Documentation