QML MultiSelectionDialog Element

Selection dialog to pick multiple items at once. More...

Inherits Item

This element was introduced in qt-components 4.7.

• List of all members, including inherited members

Properties

• acceptButtonText : string
• delegate : Component
• model : ListModel
• platformStyle : Style
• rejectButtonText : string
• selectedIndexes : variant

Detailed Description

The MultiSelectionDialog is a dialog that allows the user to pick multiple items from available options.

 // Create a multi-selection dialog with a title and list elements to choose from.
 MultiSelectionDialog {
     id: multiSelectionDialog
     titleText: "Dialog Header #1"
     selectedIndexes: [1, 3, 5]
     model: ListModel {
         ListElement { name: "ListTitle #1" }
         ListElement { name: "ListTitle #2" }
         ListElement { name: "ListTitle #3" }
         ListElement { name: "ListTitle #4" }
         ListElement { name: "ListTitle #5" }
     }
     acceptButtonText: "OK"
 }

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: "MultiSelection"
     onClicked: {
         multiSelectionDialog.open();
     }
 }

In order to accept and close the dialog the user needs to press the accept button. The name of the selected ListElements from the model is queried via the selectedIndexes property:

 Text {
     anchors.centerIn: parent
     text: multiSelectionDialog.model.get(multiSelectionDialog.selectedIndexes[index]).name
 }

In order to allow the user to select a single item from a list a SelectionDialog is used.

Common API

 property ListModel model
 property variant selectedIndexes
 property alias acceptButtonText
 property alias rejectButtonText

 property Component delegate
 // Style API
 property Style platformStyle

See also Dialog and SelectionDialog.

Property Documentation