QVirtualKeyboardSelectionListModel Class

List model for selection lists. More...

Header:	#include <QVirtualKeyboardSelectionListModel>
qmake:	QT += virtualkeyboard
Instantiated By:	SelectionListModel
Inherits:	QAbstractListModel

Public Types

enum class	DictionaryType { Default, User }
enum class	Role { Display, DisplayRole, WordCompletionLength, WordCompletionLengthRole, Dictionary, CanRemoveSuggestion }
enum class	Type { WordCandidateList }

This class acts as a bridge between the UI and the input method that provides the data for selection lists.

This enum specifies the dictionary type of a word.

Constant	Value	Description
`QVirtualKeyboardSelectionListModel::DictionaryType::Default`	`0`	The word candidate is from the default dictionary.
`QVirtualKeyboardSelectionListModel::DictionaryType::User`	`1`	The word candidate is from the user dictionary.

This enum specifies a role of the data requested.

Constant	Value	Description
`QVirtualKeyboardSelectionListModel::Role::Display`	`Qt::DisplayRole`	The data to be rendered in form of text.
`QVirtualKeyboardSelectionListModel::Role::DisplayRole`	`Display`	`obsolete` Use Role::Display.
`QVirtualKeyboardSelectionListModel::Role::WordCompletionLength`	`Qt::UserRole + 1`	An integer specifying the length of the word the completion part expressed as the number of characters counted from the end of the string.
`QVirtualKeyboardSelectionListModel::Role::WordCompletionLengthRole`	`WordCompletionLength`	`obsolete` Use Role::WordCompletionLength.
`QVirtualKeyboardSelectionListModel::Role::Dictionary`	`258`	An integer specifying l {QVirtualKeyboardSelectionListModel::DictionaryType}{dictionary type}.
`QVirtualKeyboardSelectionListModel::Role::CanRemoveSuggestion`	`259`	A boolean value indicating if the word candidate can be removed from the dictionary.

This enum specifies the type of selection list.

Constant	Value	Description
`QVirtualKeyboardSelectionListModel::Type::WordCandidateList`	`0`	Shows list of word candidates.