QVirtualKeyboardSelectionListModel Class

List model for selection lists. More...

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

Public Types

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

Properties

  • 1 property inherited from QObject

Public Functions

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

Signals

void activeItemChanged(int index)
void countChanged()
void itemSelected(int index)

Static Public Members

const QMetaObject staticMetaObject
  • 9 static public members inherited from QObject

Additional Inherited Members

Detailed Description

List model for selection lists.

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

Member Type Documentation

enum QVirtualKeyboardSelectionListModel::DictionaryType

This enum specifies the dictionary type of a word.

ConstantValueDescription
QVirtualKeyboardSelectionListModel::DictionaryType::Default?The word candidate is from the default dictionary.
QVirtualKeyboardSelectionListModel::DictionaryType::User?The word candidate is from the user dictionary.

enum QVirtualKeyboardSelectionListModel::Role

This enum specifies a role of the data requested.

ConstantValueDescription
QVirtualKeyboardSelectionListModel::Role::Display?The data to be rendered in form of text.
QVirtualKeyboardSelectionListModel::Role::DisplayRole?obsolete Use Role::Display.
QVirtualKeyboardSelectionListModel::Role::WordCompletionLength?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?obsolete Use Role::WordCompletionLength.
QVirtualKeyboardSelectionListModel::Role::Dictionary?An integer specifying l {QVirtualKeyboardSelectionListModel::DictionaryType}{dictionary type}.
QVirtualKeyboardSelectionListModel::Role::CanRemoveSuggestion?A boolean value indicating if the word candidate can be removed from the dictionary.

enum QVirtualKeyboardSelectionListModel::Type

This enum specifies the type of selection list.

ConstantValueDescription
QVirtualKeyboardSelectionListModel::Type::WordCandidateList?Shows list of word candidates

Property Documentation

count : const int

Notifier signal:

void countChanged()

Member Function Documentation

[signal] void QVirtualKeyboardSelectionListModel::activeItemChanged(int index)

[signal] void QVirtualKeyboardSelectionListModel::itemSelected(int index)

void QVirtualKeyboardSelectionListModel::removeItem(int index)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

void QVirtualKeyboardSelectionListModel::selectItem(int index)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Member Variable Documentation

Related Non-Members

Macro Documentation