blob: 037acf44610f79ec19beabeb717d01bbea52822e (
plain)
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\title Qt Virtual Keyboard
\page qtvirtualkeyboard-index.html
The Qt Virtual Keyboard project provides an input framework and reference
keyboard frontend for Qt 6 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 Using the Module
\include {module-use.qdocinc} {using the c++ api}
\section2 Building with CMake
\include {module-use.qdocinc} {building with cmake} {VirtualKeyboard}
\section2 Building with qmake
\include {module-use.qdocinc} {building_with_qmake} {virtualkeyboard}
\section1 Articles and Guides
\list
\li \l {Building Qt Virtual Keyboard}
\li \l {Deployment Guide}
\li \l {Qt Virtual Keyboard Overview}
\li \l {User Guide}
\endlist
\section1 Examples
\list
\li \l{Qt Virtual Keyboard Examples}
\endlist
\section1 Reference
\list
\li \l{Qt Virtual Keyboard API for Applications}
\li \l{Qt Virtual Keyboard API for Advanced Use Cases}
\li \l{Qt Virtual Keyboard QML Types}
\li \l{Qt Virtual Keyboard C++ Classes}
\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 the following permissive licenses:
\generatelist{groupsbymodule attributions-qtvirtualkeyboard}
*/
/*!
\page qtquick-virtualkeyboard-for-application.html
\title Qt Virtual Keyboard API for Applications
\brief Provides API for integrating the virtual keyboard into an application.
The QML types can be imported into your application using the following
import statements in your .qml file:
\qml
import QtQuick.VirtualKeyboard
import QtQuick.VirtualKeyboard.Settings
\endqml
In addition to importing the types, the \c QT_IM_MODULE environment
variable must be set to \c qtvirtualkeyboard. For more information, see
\l {Loading the Plugin}.
\section1 \l {Qt Virtual Keyboard Module QML Types} {Virtual Keyboard}
QML types
\generatelist groupsbymodule qtvirtualkeyboard-qml
C++ types
\generatelist groupsbymodule qtvirtualkeyboard-cpp-for-apps
\section1 \l {Qt Quick Virtual Keyboard Settings QML Types} {Virtual Keyboard Settings}
QML types
\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Settings
*/
/*!
\page qtquick-virtualkeyboard-for-advanced-use-cases.html
\title Qt Virtual Keyboard API for Advanced Use Cases
\brief Provides API for extending or modifying virtual keyboard functionality.
These QML types fall under the categories of virtual keyboard plugin vendors,
style providers, and keyboard layouts. They should not be used by application
or middleware.
\section1 \l {Qt Quick Virtual Keyboard Styles QML Types} {Styles}
QML types
\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Styles
\section1 \l {Qt Quick Virtual Keyboard Components QML Types} {Components}
QML types
\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Components
C++ types
\generatelist groupsbymodule qtvirtualkeyboard-cpp-for-devs
*/
/*!
\qmlmodule QtQuick.VirtualKeyboard
\title Qt Virtual Keyboard Module QML Types
\brief Provides QML types for the virtual keyboard.
*/
/*!
\page qtvirtualkeyboard-qmltypes.html
\title Qt Virtual Keyboard QML Types
\brief QML types for the virtual keyboard.
\generatelist groupsbymodule qmlclass
*/
|
