1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QVIRTUALKEYBOARDINPUTENGINE_H
#define QVIRTUALKEYBOARDINPUTENGINE_H
#include <QObject>
#include <QPointer>
#include <QtVirtualKeyboard/qvirtualkeyboard_global.h>
QT_BEGIN_NAMESPACE
class QVirtualKeyboardInputContext;
class QVirtualKeyboardSelectionListModel;
class QVirtualKeyboardAbstractInputMethod;
class QVirtualKeyboardInputEnginePrivate;
class QVirtualKeyboardTrace;
class QVIRTUALKEYBOARD_EXPORT QVirtualKeyboardInputEngine : public QObject
{
Q_OBJECT
Q_DISABLE_COPY(QVirtualKeyboardInputEngine)
Q_DECLARE_PRIVATE(QVirtualKeyboardInputEngine)
Q_PROPERTY(Qt::Key activeKey READ activeKey NOTIFY activeKeyChanged)
Q_PROPERTY(Qt::Key previousKey READ previousKey NOTIFY previousKeyChanged)
Q_PROPERTY(QVirtualKeyboardAbstractInputMethod *inputMethod READ inputMethod WRITE setInputMethod NOTIFY inputMethodChanged)
Q_PROPERTY(QList<int> inputModes READ inputModes NOTIFY inputModesChanged)
Q_PROPERTY(InputMode inputMode READ inputMode WRITE setInputMode NOTIFY inputModeChanged)
Q_PROPERTY(QList<int> patternRecognitionModes READ patternRecognitionModes NOTIFY patternRecognitionModesChanged)
Q_PROPERTY(QVirtualKeyboardSelectionListModel *wordCandidateListModel READ wordCandidateListModel NOTIFY wordCandidateListModelChanged)
Q_PROPERTY(bool wordCandidateListVisibleHint READ wordCandidateListVisibleHint NOTIFY wordCandidateListVisibleHintChanged)
explicit QVirtualKeyboardInputEngine(QVirtualKeyboardInputContext *parent = nullptr);
void init();
public:
enum class TextCase {
Lower,
Upper
};
Q_ENUM(TextCase)
enum class InputMode {
Latin,
Numeric,
Dialable,
Pinyin,
Cangjie,
Zhuyin,
Hangul,
Hiragana,
Katakana,
FullwidthLatin,
Greek,
Cyrillic,
Arabic,
Hebrew,
ChineseHandwriting,
JapaneseHandwriting,
KoreanHandwriting,
Thai
};
Q_ENUM(InputMode)
enum class PatternRecognitionMode {
None,
PatternRecognitionDisabled = None,
Handwriting,
HandwritingRecoginition = Handwriting
};
Q_ENUM(PatternRecognitionMode)
enum class ReselectFlag {
WordBeforeCursor = 0x1,
WordAfterCursor = 0x2,
WordAtCursor = WordBeforeCursor | WordAfterCursor
};
Q_FLAG(ReselectFlag)
Q_DECLARE_FLAGS(ReselectFlags, QVirtualKeyboardInputEngine::ReselectFlag)
public:
~QVirtualKeyboardInputEngine();
Q_INVOKABLE bool virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat);
Q_INVOKABLE void virtualKeyCancel();
Q_INVOKABLE bool virtualKeyRelease(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers);
Q_INVOKABLE bool virtualKeyClick(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers);
QVirtualKeyboardInputContext *inputContext() const;
Qt::Key activeKey() const;
Qt::Key previousKey() const;
QVirtualKeyboardAbstractInputMethod *inputMethod() const;
void setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod);
QList<int> inputModes() const;
InputMode inputMode() const;
void setInputMode(InputMode inputMode);
QVirtualKeyboardSelectionListModel *wordCandidateListModel() const;
bool wordCandidateListVisibleHint() const;
QList<int> patternRecognitionModes() const;
Q_INVOKABLE QVirtualKeyboardTrace *traceBegin(
int traceId, PatternRecognitionMode patternRecognitionMode,
const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo);
Q_INVOKABLE bool traceEnd(QVirtualKeyboardTrace *trace);
Q_INVOKABLE bool reselect(int cursorPosition, const ReselectFlags &reselectFlags);
bool clickPreeditText(int cursorPosition);
Q_SIGNALS:
void virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat);
void activeKeyChanged(Qt::Key key);
void previousKeyChanged(Qt::Key key);
void inputMethodChanged();
void inputMethodReset();
void inputMethodUpdate();
void inputModesChanged();
void inputModeChanged();
void patternRecognitionModesChanged();
void wordCandidateListModelChanged();
void wordCandidateListVisibleHintChanged();
private Q_SLOTS:
void reset();
void update();
void shiftChanged();
void updateSelectionListModels();
void updateInputModes();
protected:
void timerEvent(QTimerEvent *timerEvent);
private:
friend class QVirtualKeyboardInputContext;
friend class QVirtualKeyboardInputContextPrivate;
};
Q_DECL_CONST_FUNCTION Q_DECL_CONSTEXPR inline uint qHash(QVirtualKeyboardInputEngine::InputMode key, uint seed = 0) Q_DECL_NOTHROW { return uint(key) ^ seed; }
Q_DECLARE_OPERATORS_FOR_FLAGS(QVirtualKeyboardInputEngine::ReselectFlags)
QT_END_NAMESPACE
Q_DECLARE_METATYPE(QVirtualKeyboardInputEngine::TextCase)
Q_DECLARE_METATYPE(QVirtualKeyboardInputEngine::InputMode)
Q_DECLARE_METATYPE(QVirtualKeyboardInputEngine::PatternRecognitionMode)
Q_DECLARE_METATYPE(QVirtualKeyboardInputEngine::ReselectFlag)
#endif
|
