SelectionListModel QML Type (Uncreatable) | Qt Virtual Keyboard | Qt 6.12.0
Description: Provides a data model for the selection lists.
Keywords: qmltype

- Qt 6.12
- Qt Virtual Keyboard
- QML Types
- QtQuick.VirtualKeyboard
- SelectionListModel
- Qt Virtual Keyboard | Commercial or GPLv3

# SelectionListModel QML Type (Uncreatable)

Provides a data model for the selection lists. More...

Import Statement: | `import QtQuick.VirtualKeyboard`
In C++: | QVirtualKeyboardSelectionListModel

Note: This is an uncreatable type. It cannot be instantiated in QML.

- List of all members, including inherited members

## Signals

- void activeItemChanged(int index)
- void itemSelected(int index)

## Methods

- void removeItem(int index)
- void selectItem(int index)

## Detailed Description

The SelectionListModel is a data model for word candidates provided by the input method.

An instance of a SelectionListModel cannot be created directly. Instead, the InputEngine manages the instances and provides access to the model by InputEngine::wordCandidateListModel property.

The model exposes the following data roles for the list delegate:

- `display` Display text for item.
- `wordCompletionLength` Word completion length for item.
- `dictionaryType` Dictionary type of the word, see QVirtualKeyboardSelectionListModel::DictionaryType.
- `canRemoveSuggestion` A boolean indicating if the word can be removed from the dictionary.

The activeItemChanged signal indicates which item is currently highlighted by the input method. The view should respond to this signal by highlighting the corresponding item in the list.

The user selection is handled by the selectItem() method. The view should be invoke this method when the user selects an item from the list.

## Signal Documentation

### void activeItemChanged(int index)

This signal is emitted when the active item in the list changes. The UI should react to this signal by highlighting the item at index in the list.

Note: The corresponding handler is `onActiveItemChanged`.

### void itemSelected(int index)

This signal is emitted when an item at index is selected by the user.

Note: The corresponding handler is `onItemSelected`.

## Method Documentation

### void removeItem(int index)

This method should be called when the user removes an item at position index from the list. The removal is forwarded to the input method for further processing.

### void selectItem(int index)

This method should be called when the user selects an item at position index from the list. The selection is forwarded to the input method for further processing.