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
|
/****************************************************************************
**
** 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$
**
****************************************************************************/
/*!
\title Qt Virtual Keyboard
\page qtvirtualkeyboard-index.html
The Qt Virtual Keyboard project provides an input framework and reference
keyboard frontend for Qt 5 on Linux Desktop/X11, Windows Desktop, and
Boot2Qt targets.
The input framework makes it easy to write custom input methods or to
integrate 3rd party input engines. The input methods can be implemented
in C++ or QML.
\section1 Features
Key features of the Qt Virtual Keyboard include:
\list
\li Customizable keyboard layouts and styles with dynamic switching.
\li Predictive text input with word selection.
\li Character preview and alternative character view.
\li Automatic capitalization and space insertion.
\li Scalability to different resolutions.
\li Support for different character sets (Latin, Simplified/Traditional Chinese,
Hindi, Japanese, Arabic, Korean, and others).
\li Support for most common input \l {Supported Languages}{languages},
with possibility to easily extend the language support.
\li Left-to-right and right-to-left input.
\li Hardware key support for 2-way and 5-way navigation.
\li Handwriting support, with gestures for fullscreen input.
\li Audio feedback.
\li Cross-platform functionality.
\endlist
\section1 Supported Languages
The Virtual Keyboard supports the following languages:
\list
\li Arabic
\li Danish
\li English
\li Finnish
\li French
\li German
\li Hindi
\li Italian
\li Japanese
\li Korean
\li Norwegian
\li Persian/Farsi
\li Polish
\li Portugese
\li Romanian
\li Russian
\li Simplified Chinese
\li Traditional Chinese
\li Spanish
\li Swedish
\endlist
To add support for an additional language, see
\l {Adding New Keyboard Layouts}.
\section1 Guides
\list
\li \l {Building Qt Virtual Keyboard}
\li \l {Deployment Guide}
\li \l {Technical Guide}
\li \l {User Guide}
\endlist
\section1 QML Types
\annotatedlist qtvirtualkeyboard-qml
Styling components:
\annotatedlist qtvirtualkeyboard-styles-qml
Settings components:
\annotatedlist qtvirtualkeyboard-settings-qml
\section1 Examples
\list
\li \l{Qt Virtual Keyboard Examples}
\endlist
\section1 Licenses and Attributions
Qt Virtual Keyboard is available under commercial licenses from \l{The Qt Company}.
In addition, it is available under the \l{GNU General Public License, version 3}.
See \l{Qt Licensing} for further details.
Furthermore Qt Virtual Keyboard potentially contains third party
modules under following permissive licenses:
\generatelist{groupsbymodule attributions-qtvirtualkeyboard}
*/
/*!
\page qt-virtual-keyboard-qmltypes.html
\title Qt Virtual Keyboard QML Types
\inmodule qtvirtualkeyboard
\annotatedlist qtvirtualkeyboard-qml
Styling components:
\annotatedlist qtvirtualkeyboard-styles-qml
Settings components:
\annotatedlist qtvirtualkeyboard-settings-qml
*/
|
