QVirtualKeyboardInputEngine Class
The InputEngine class provides an input engine that supports C++ and QML integration. More...
| Header: | #include <QVirtualKeyboardInputEngine> |
| qmake: | QT += virtualkeyboard |
| Instantiated By: | InputEngine |
| Inherits: | QObject |
Public Types
| enum class | InputMode { Latin, Numeric, Dialable, Pinyin, Cangjie, …, Thai } |
| enum class | PatternRecognitionMode { None, PatternRecognitionDisabled, Handwriting, HandwritingRecoginition } |
| enum class | ReselectFlag { WordBeforeCursor, WordAfterCursor, WordAtCursor } |
| enum class | TextCase { Lower, Upper } |
Properties
|
|
Public Functions
| Qt::Key | activeKey() const |
| QVirtualKeyboardAbstractInputMethod * | inputMethod() const |
| QVirtualKeyboardInputEngine::InputMode | inputMode() const |
| QList<int> | inputModes() const |
| QList<int> | patternRecognitionModes() const |
| Qt::Key | previousKey() const |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
| void | setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode) |
| QVirtualKeyboardSelectionListModel * | wordCandidateListModel() const |
| bool | wordCandidateListVisibleHint() const |
Signals
| void | activeKeyChanged(Qt::Key key) |
| void | inputMethodChanged() |
| void | inputModeChanged() |
| void | inputModesChanged() |
| void | patternRecognitionModesChanged() |
| void | previousKeyChanged(Qt::Key key) |
| void | wordCandidateListModelChanged() |
| void | wordCandidateListVisibleHintChanged() |
Detailed Description
The input engine is responsible for routing input events to input methods. The actual input logic is implemented by the input methods.
The input engine also includes the default input method, which takes care of default processing if the active input method does not handle the event.
Member Type Documentation
enum class QVirtualKeyboardInputEngine::InputMode
This enum specifies the input mode for the input method.
| Constant | Value | Description |
|---|---|---|
QVirtualKeyboardInputEngine::InputMode::Latin | 0 | The default input mode for latin text. |
QVirtualKeyboardInputEngine::InputMode::Numeric | 1 | Only numeric input is allowed. |
QVirtualKeyboardInputEngine::InputMode::Dialable | 2 | Only dialable input is allowed. |
QVirtualKeyboardInputEngine::InputMode::Pinyin | 3 | Pinyin input mode for Chinese. |
QVirtualKeyboardInputEngine::InputMode::Cangjie | 4 | Cangjie input mode for Chinese. |
QVirtualKeyboardInputEngine::InputMode::Zhuyin | 5 | Zhuyin input mode for Chinese. |
QVirtualKeyboardInputEngine::InputMode::Hangul | 6 | Hangul input mode for Korean. |
QVirtualKeyboardInputEngine::InputMode::Hiragana | 7 | Hiragana input mode for Japanese. |
QVirtualKeyboardInputEngine::InputMode::Katakana | 8 | Katakana input mode for Japanese. |
QVirtualKeyboardInputEngine::InputMode::FullwidthLatin | 9 | Fullwidth latin input mode for East Asian languages. |
QVirtualKeyboardInputEngine::InputMode::Greek | 10 | Greek input mode. |
QVirtualKeyboardInputEngine::InputMode::Cyrillic | 11 | Cyrillic input mode. |
QVirtualKeyboardInputEngine::InputMode::Arabic | 12 | Arabic input mode. |
QVirtualKeyboardInputEngine::InputMode::Hebrew | 13 | Hebrew input mode. |
QVirtualKeyboardInputEngine::InputMode::ChineseHandwriting | 14 | Chinese handwriting input mode. |
QVirtualKeyboardInputEngine::InputMode::JapaneseHandwriting | 15 | Japanese handwriting input mode. |
QVirtualKeyboardInputEngine::InputMode::KoreanHandwriting | 16 | Korean handwriting input mode. |
QVirtualKeyboardInputEngine::InputMode::Thai | 17 | Thai input mode. |
enum class QVirtualKeyboardInputEngine::PatternRecognitionMode
This enum specifies the input mode for the input method.
| Constant | Value | Description |
|---|---|---|
QVirtualKeyboardInputEngine::PatternRecognitionMode::None | 0 | Pattern recognition is not available. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::PatternRecognitionDisabled | None | obsolete Use PatternRecognitionMode::None |
QVirtualKeyboardInputEngine::PatternRecognitionMode::Handwriting | 1 | Pattern recognition mode for handwriting recognition. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::HandwritingRecoginition | Handwriting | obsolete Use PatternRecognitionMode::Handwriting |
enum class QVirtualKeyboardInputEngine::ReselectFlag
This enum specifies the rules for word reselection.
| Constant | Value | Description |
|---|---|---|
QVirtualKeyboardInputEngine::ReselectFlag::WordBeforeCursor | 0x1 | Activate the word before the cursor. When this flag is used exclusively, the word must end exactly at the cursor. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAfterCursor | 0x2 | Activate the word after the cursor. When this flag is used exclusively, the word must start exactly at the cursor. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAtCursor | WordBeforeCursor | WordAfterCursor | Activate the word at the cursor. This flag is a combination of the above flags with the exception that the word cannot start or stop at the cursor. |
enum class QVirtualKeyboardInputEngine::TextCase
This enum specifies the text case for the input method.
| Constant | Value | Description |
|---|---|---|
QVirtualKeyboardInputEngine::TextCase::Lower | 0 | Lower case text. |
QVirtualKeyboardInputEngine::TextCase::Upper | 1 | Upper case text. |
Property Documentation
activeKey : const Qt::Key
This property holds the active key.
Currently pressed key.
Access functions:
| Qt::Key | activeKey() const |
Notifier signal:
| void | activeKeyChanged(Qt::Key key) |
inputMethod : QVirtualKeyboardAbstractInputMethod*
This property holds the active input method.
Use this property to set active the input method, or to monitor when the active input method changes.
Access functions:
| QVirtualKeyboardAbstractInputMethod * | inputMethod() const |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
Notifier signal:
| void | inputMethodChanged() |
inputMode : InputMode
This property holds the current input mode.
Use this property to get or set the current input mode. The InputEngine::inputModes provides list of valid input modes for current input method and locale.
Access functions:
| QVirtualKeyboardInputEngine::InputMode | inputMode() const |
| void | setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode) |
Notifier signal:
| void | inputModeChanged() |
inputModes : const QList<int>
This property holds the available input modes for active input method.
The list of available input modes is dependent on the input method and locale. This property is updated when either of the dependencies changes.
Access functions:
| QList<int> | inputModes() const |
Notifier signal:
| void | inputModesChanged() |
patternRecognitionModes : const QList<int>
This property holds the list of available pattern recognition modes.
The list of available pattern recognition modes.
This property was introduced in QtQuick.VirtualKeyboard 2.0.
Access functions:
| QList<int> | patternRecognitionModes() const |
Notifier signal:
| void | patternRecognitionModesChanged() |
previousKey : const Qt::Key
This property holds the previous active key.
Previously pressed key.
Access functions:
| Qt::Key | previousKey() const |
Notifier signal:
| void | previousKeyChanged(Qt::Key key) |
wordCandidateListModel : QVirtualKeyboardSelectionListModel* const
list model for the word candidate list.
Use this property to access the list model for the word candidate list.
Access functions:
| QVirtualKeyboardSelectionListModel * | wordCandidateListModel() const |
Notifier signal:
| void | wordCandidateListModelChanged() |
wordCandidateListVisibleHint : const bool
visible hint for the word candidate list.
Use this property to check if the word candidate list should be visible in the UI.
Access functions:
| bool | wordCandidateListVisibleHint() const |
Notifier signal:
| void | wordCandidateListVisibleHintChanged() |