QVirtualKeyboardSelectionListModel Class

List model for selection lists. More...

Header: #include <QVirtualKeyboardSelectionListModel>
CMake: find_package(Qt6 REQUIRED COMPONENTS VirtualKeyboard)
target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard)
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 }

Public Functions

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

Signals

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

Detailed Description

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

Member Type Documentation

enum class QVirtualKeyboardSelectionListModel::DictionaryType

This enum specifies the dictionary type of a word.

ConstantValueDescription
QVirtualKeyboardSelectionListModel::DictionaryType::Default0The word candidate is from the default dictionary.
QVirtualKeyboardSelectionListModel::DictionaryType::User1The word candidate is from the user dictionary.

enum class QVirtualKeyboardSelectionListModel::Role

This enum specifies a role of the data requested.

ConstantValueDescription
QVirtualKeyboardSelectionListModel::Role::DisplayQt::DisplayRoleThe data to be rendered in form of text.
QVirtualKeyboardSelectionListModel::Role::DisplayRoleDisplayobsolete Use Role::Display.
QVirtualKeyboardSelectionListModel::Role::WordCompletionLengthQt::UserRole + 1An 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::WordCompletionLengthRoleWordCompletionLengthobsolete Use Role::WordCompletionLength.
QVirtualKeyboardSelectionListModel::Role::Dictionary258An integer specifying l {QVirtualKeyboardSelectionListModel::DictionaryType}{dictionary type}.
QVirtualKeyboardSelectionListModel::Role::CanRemoveSuggestion259A boolean value indicating if the word candidate can be removed from the dictionary.

enum class QVirtualKeyboardSelectionListModel::Type

This enum specifies the type of selection list.

ConstantValueDescription
QVirtualKeyboardSelectionListModel::Type::WordCandidateList0Shows list of word candidates.

Member Function Documentation

[signal] void QVirtualKeyboardSelectionListModel::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.

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

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

[invokable] void QVirtualKeyboardSelectionListModel::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.

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

[invokable] void QVirtualKeyboardSelectionListModel::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.

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

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.