QML SelectionDialog Element

Single selection dialog. More...

Inherits Item

This element was introduced in qt-components 4.7.

• List of all members, including inherited members

Properties

• delegate : Component
• model : ListModel
• platformStyle : Style
• selectedIndex : int

Detailed Description

The SelectionDialog is a dialog that allows the user to select a single item from several list elements.

 // Create a selection dialog with a title and list elements to choose from.
 SelectionDialog {
     id: singleSelectionDialog
     titleText: "Dialog Header #1"
     selectedIndex: 1

     model: ListModel {
         ListElement { name: "ListTitle #1" }
         ListElement { name: "ListTitle #2" }
         ListElement { name: "ListTitle #3" }
     }
 }

As with all dialogs 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 dialog is opened via the open() call:

 Button {
     text: "SingleSelection"
     onClicked: {
         singleSelectionDialog.open();
     }
 }

The dialog is automatically accepted and closed once an item got selected by the user. The name of the selected ListElement from the model is queried through the selectedIndex property:

 Text {
     anchors.centerIn: parent
     text: singleSelectionDialog.model.get(singleSelectionDialog.selectedIndex).name
 }

In order to allow the user to pick several items from a list a MultiSelectionDialog is used.

Common API

 property ListModel model
 property int selectedIndex

 property Component delegate
 // Style API
 property Style platformStyle

See also Dialog and MultiSelectionDialog.

Property Documentation