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
178
179
180
181
182
|
/****************************************************************************
**
** 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 INPUTCONTEXT_H
#define INPUTCONTEXT_H
#include <QObject>
#include <QRectF>
#include <QLocale>
#include <QInputMethodEvent>
#include <QInputMethod>
#include <QtVirtualKeyboard/qvirtualkeyboard_global.h>
QT_BEGIN_NAMESPACE
namespace QtVirtualKeyboard {
class PlatformInputContext;
class ShadowInputContext;
class InputEngine;
class ShiftHandler;
class InputContextPrivate;
class QVIRTUALKEYBOARD_EXPORT InputContext : public QObject
{
Q_OBJECT
Q_DISABLE_COPY(InputContext)
Q_DECLARE_PRIVATE(InputContext)
Q_PROPERTY(bool focus READ focus NOTIFY focusChanged)
Q_PROPERTY(bool shift READ shift WRITE setShift NOTIFY shiftChanged)
Q_PROPERTY(bool capsLock READ capsLock WRITE setCapsLock NOTIFY capsLockChanged)
Q_PROPERTY(bool uppercase READ uppercase NOTIFY uppercaseChanged)
Q_PROPERTY(int anchorPosition READ anchorPosition NOTIFY anchorPositionChanged)
Q_PROPERTY(int cursorPosition READ cursorPosition NOTIFY cursorPositionChanged)
Q_PROPERTY(Qt::InputMethodHints inputMethodHints READ inputMethodHints NOTIFY inputMethodHintsChanged)
Q_PROPERTY(QString preeditText READ preeditText WRITE setPreeditText NOTIFY preeditTextChanged)
Q_PROPERTY(QString surroundingText READ surroundingText NOTIFY surroundingTextChanged)
Q_PROPERTY(QString selectedText READ selectedText NOTIFY selectedTextChanged)
Q_PROPERTY(QRectF anchorRectangle READ anchorRectangle NOTIFY anchorRectangleChanged)
Q_PROPERTY(QRectF cursorRectangle READ cursorRectangle NOTIFY cursorRectangleChanged)
Q_PROPERTY(QRectF keyboardRectangle READ keyboardRectangle WRITE setKeyboardRectangle NOTIFY keyboardRectangleChanged)
Q_PROPERTY(QRectF previewRectangle READ previewRectangle WRITE setPreviewRectangle NOTIFY previewRectangleChanged)
Q_PROPERTY(bool previewVisible READ previewVisible WRITE setPreviewVisible NOTIFY previewVisibleChanged)
Q_PROPERTY(bool animating READ animating WRITE setAnimating NOTIFY animatingChanged)
Q_PROPERTY(QString locale READ locale WRITE setLocale NOTIFY localeChanged)
Q_PROPERTY(QObject *inputItem READ inputItem NOTIFY inputItemChanged)
Q_PROPERTY(ShiftHandler *shiftHandler READ shiftHandler CONSTANT)
Q_PROPERTY(InputEngine *inputEngine READ inputEngine CONSTANT)
Q_PROPERTY(bool selectionControlVisible READ selectionControlVisible NOTIFY selectionControlVisibleChanged)
Q_PROPERTY(bool anchorRectIntersectsClipRect READ anchorRectIntersectsClipRect NOTIFY anchorRectIntersectsClipRectChanged)
Q_PROPERTY(bool cursorRectIntersectsClipRect READ cursorRectIntersectsClipRect NOTIFY cursorRectIntersectsClipRectChanged)
Q_PROPERTY(ShadowInputContext *shadow READ shadow CONSTANT)
public:
explicit InputContext(PlatformInputContext *parent = nullptr);
~InputContext();
bool focus() const;
bool shift() const;
void setShift(bool enable);
bool capsLock() const;
void setCapsLock(bool enable);
bool uppercase() const;
int anchorPosition() const;
int cursorPosition() const;
Qt::InputMethodHints inputMethodHints() const;
QString preeditText() const;
void setPreeditText(const QString &text, QList<QInputMethodEvent::Attribute> attributes = QList<QInputMethodEvent::Attribute>(), int replaceFrom = 0, int replaceLength = 0);
QList<QInputMethodEvent::Attribute> preeditTextAttributes() const;
QString surroundingText() const;
QString selectedText() const;
QRectF anchorRectangle() const;
QRectF cursorRectangle() const;
QRectF keyboardRectangle() const;
void setKeyboardRectangle(QRectF rectangle);
QRectF previewRectangle() const;
void setPreviewRectangle(QRectF rectangle);
bool previewVisible() const;
void setPreviewVisible(bool visible);
bool animating() const;
void setAnimating(bool animating);
QString locale() const;
void setLocale(const QString &locale);
Q_INVOKABLE void updateAvailableLocales(const QStringList &availableLocales);
QObject *inputItem() const;
ShiftHandler *shiftHandler() const;
InputEngine *inputEngine() const;
bool selectionControlVisible() const;
bool anchorRectIntersectsClipRect() const;
bool cursorRectIntersectsClipRect() const;
ShadowInputContext *shadow() const;
Q_INVOKABLE void hideInputPanel();
Q_INVOKABLE void sendKeyClick(int key, const QString &text, int modifiers = 0);
Q_INVOKABLE void commit();
Q_INVOKABLE void commit(const QString &text, int replaceFrom = 0, int replaceLength = 0);
Q_INVOKABLE void clear();
// Helper functions
Q_INVOKABLE bool fileExists(const QUrl &fileUrl);
Q_INVOKABLE bool hasEnterKeyAction(QObject *item) const;
// For selection handles
Q_INVOKABLE void setSelectionOnFocusObject(const QPointF &anchorPos, const QPointF &cursorPos);
// For shadow input
Q_INVOKABLE void forceCursorPosition(int anchorPosition, int cursorPosition);
Q_SIGNALS:
void focusChanged();
void focusEditorChanged();
void preeditTextChanged();
void inputMethodHintsChanged();
void surroundingTextChanged();
void selectedTextChanged();
void anchorPositionChanged();
void cursorPositionChanged();
void anchorRectangleChanged();
void cursorRectangleChanged();
void shiftChanged();
void capsLockChanged();
void uppercaseChanged();
void keyboardRectangleChanged();
void previewRectangleChanged();
void previewVisibleChanged();
void animatingChanged();
void localeChanged();
void inputItemChanged();
void selectionControlVisibleChanged();
void navigationKeyPressed(int key, bool isAutoRepeat);
void navigationKeyReleased(int key, bool isAutoRepeat);
void anchorRectIntersectsClipRectChanged();
void cursorRectIntersectsClipRectChanged();
private Q_SLOTS:
void onInputItemChanged();
private:
void setFocus(bool enable);
void sendPreedit(const QString &text, const QList<QInputMethodEvent::Attribute> &attributes, int replaceFrom, int replaceLength);
void reset();
void externalCommit();
void update(Qt::InputMethodQueries queries);
void invokeAction(QInputMethod::Action action, int cursorPosition);
bool filterEvent(const QEvent *event);
void addSelectionAttribute(QList<QInputMethodEvent::Attribute> &attributes);
bool testAttribute(const QList<QInputMethodEvent::Attribute> &attributes, QInputMethodEvent::AttributeType attributeType) const;
int findAttribute(const QList<QInputMethodEvent::Attribute> &attributes, QInputMethodEvent::AttributeType attributeType) const;
private:
friend class PlatformInputContext;
};
} // namespace QtVirtualKeyboard
QT_END_NAMESPACE
#endif
|
