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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtvirtualkeyboard-deployment-guide.html
\contentspage {Deployment Guide} {Contents}
\title Deployment Guide
\section1 Overview
This document describes how to deploy and use the Qt Virtual Keyboard plugin
with Qt 5 applications.
\section1 Deployment
The various Qt Virtual Keyboard plugins and files are deployed in the following
locations:
\table
\header
\li Item
\li Desktop install path
\li Boot2Qt install path
\row
\li qtvirtualkeyboardplugin
\li \c $$[QT_INSTALL_PLUGINS]/platforminputcontexts
\li \c /system/plugins/platforminputcontexts
\row
\li qtvirtualkeyboardextensionplugin
\li \c $$[QT_INSTALL_PLUGINS]/virtualkeyboard
\li \c /system/plugins/virtualkeyboard
\row
\li qtvirtualkeyboardplugin QML files
\li \c $$[QT_INSTALL_QML]/QtQuick/VirtualKeyboard
\li \c /system/qml/QtQuick/VirtualKeyboard
\row
\li qtvirtualkeyboardstylesplugin
\li \c $$[QT_INSTALL_QML]/QtQuick/VirtualKeyboard/Styles
\li \c /system/qml/QtQuick/VirtualKeyboard/Styles
\endtable
\section1 Integration Method
Qt Virtual Keyboard currently supports two alternative integration methods
for using the plugin:
\list
\li \c Desktop: requires no changes to existing applications.
The virtual keyboard is available to all of the Qt 5 applications
in the system.
In this integration method, the keyboard is shown in a dedicated
top-level window.
\li \c Application: the virtual keyboard is embedded within the Qt
application itself by instantiating an \l InputPanel item in QML.
This method is mandatory in environments where there is no support
for multiple top-level windows (such as embedded devices), but can
be used in desktop applications too.
This method can also be used by Qt Wayland compositors in order to
provide a server-side virtual keyboard. See the section below for details.
\endlist
The integration method is automatically selected by the project files.
However, in desktop environments, it is possible to override the desktop
integration method and use the application integration method instead,
by adding \c CONFIG+=disable-desktop to the \c qmake command line.
\section2 Using Qt Virtual Keyboard with Qt Wayland
This section explains how to use Qt Virtual Keyboard to interact with the
\l {Line Edits Example}{Qt Widgets Line Edits example} using the
\l {Qt Wayland Compositor Examples - Pure QML}{Pure QML example}
as a compositor.
We will be using Ubuntu 18.04 to run the example, using the X11 as the
windowing system. The example compositor (\c pure-qml) will open
as a window within an X11 session.
\list 1
\li Start the compositor:
\badcode
QT_XCB_GL_INTEGRATION=xcb_egl QT_WAYLAND_CLIENT_BUFFER_INTEGRATION=xcomposite-egl QT_IM_MODULE=qtvirtualkeyboard ./pure-qml -platform xcb
\endcode
\li Before running the client application, ensure that QT_IM_MODULE is unset:
\badcode
unset QT_IM_MODULE
\endcode
\li Start the Line Edits example as the client:
\badcode
./lineedits -platform wayland
\endcode
\li Click on a line edit and Qt Virtual Keyboard's input panel will open.
\endlist
If issues are encountered, the following environment variables can be set
when running the compositor to get debug output that can help diagnose the issue:
\badcode
WAYLAND_DEBUG=1
QT_LOGGING_RULES="qt.virtualkeyboard=true;qt.qpa.wayland*=true"
\endcode
\section1 Loading the Plugin
In both integration methods, the application must use the \c QT_IM_MODULE
environment variable to load the plugin. For example:
\code
$ QT_IM_MODULE=qtvirtualkeyboard myapp
\endcode
or in the main() function:
\code
qputenv("QT_IM_MODULE", QByteArray("qtvirtualkeyboard"));
\endcode
In the desktop integration method, this step is all that is required to
use Qt Virtual Keyboard. In the application integration method, the application
is required to create an instance of InputPanel as explained in the
following chapter.
\section1 Creating InputPanel
The following example shows how to create an InputPanel and how to
divide the screen area with the application container.
\code
import QtQuick 2.0
import QtQuick.VirtualKeyboard 2.1
Item {
id: root
Item {
id: appContainer
anchors.left: parent.left
anchors.top: parent.top
anchors.right: parent.right
anchors.bottom: inputPanel.top
...
}
InputPanel {
id: inputPanel
y: Qt.inputMethod.visible ? parent.height - inputPanel.height : parent.height
anchors.left: parent.left
anchors.right: parent.right
}
}
\endcode
The input panel must be a sibling element next to the application container.
It is important not to put the input panel within the application container,
as it would then overlap with the contents of the application. Also, the
input panel height will be automatically updated according to the available
width; the aspect ratio of the input panel is constant.
\section1 Environment Variables
There are several environment variables defined by the module that are listed below:
\table
\header
\li Variable
\li Purpose
\row
\li QT_VIRTUALKEYBOARD_HUNSPELL_DATA_PATH
\li Overrides the location of the Hunspell data files.
The default location depends on the value of
\c {QLibraryInfo::location(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/hunspell}.
See \l {Hunspell Integration} for more information.
\row
\li QT_VIRTUALKEYBOARD_PINYIN_DICTIONARY
\li Overrides the location of the Pinyin dictionary.
By default, the dictionary is bundled into the plugin's resources.
To disable resource bundling, add \c CONFIG+=no-bundle-pinyin in the
plugin's qmake command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::location(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/pinyin/dict_pinyin.dat}.
\row
\li QT_VIRTUALKEYBOARD_CANGJIE_DICTIONARY
\li Overrides the location of the Cangjie dictionary.
By default, the dictionary is bundled into the plugin's resources.
To disable resource bundling, add \c CONFIG+=no-bundle-tcime in the
plugin's qmake command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::location(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/tcime/dict_cangjie.dat}.
\row
\li QT_VIRTUALKEYBOARD_ZHUYIN_DICTIONARY
\li Overrides the location of the Zhuyin dictionary.
By default, the dictionary is bundled into the plugin's resources.
To disable resource bundling, add \c CONFIG+=no-bundle-tcime in the
plugin's qmake command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::location(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/tcime/dict_zhuyin.dat}.
\row
\li QT_VIRTUALKEYBOARD_PHRASE_DICTIONARY
\li Overrides the location of the phrase dictionary.
By default, the dictionary is bundled into the plugin's resources.
To disable resource bundling, add \c CONFIG+=no-bundle-tcime in the
plugin's qmake command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::location(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/tcime/dict_phrases.dat}.
\row
\li QT_VIRTUALKEYBOARD_STYLE
\li Specifies the location of the style to use with the virtual keyboard.
This can also be specified in QML by setting \l {VirtualKeyboardSettings::styleName},
or at build time by using the \l {Advanced Configuration Options}{qmake configuration options}.
\row
\li QT_VIRTUALKEYBOARD_LAYOUT_PATH
\li Specifies the location of the layouts to be used with the virtual keyboard.
\row
\li LIPI_ROOT
\li Specifies the location of lipi-toolkit.
The default location depends on the value of
\c {QLibraryInfo::location(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/lipi_toolkit}.
\row
\li LIPI_LIB
\li Specifies the location of lipi-toolkit plugins.
The default location depends on \c LIPI_ROOT:
\list
\li \c {LIPI_ROOT + "/lib"} if \c LIPI_ROOT is set.
\li \c {QLibraryInfo::location(QLibraryInfo::PluginsPath) + "/lipi_toolkit"} if \c LIPI_ROOT is not set.
\endlist
\endtable
*/
|
