blob: ed7066953a45d62de7857e761cf69b544a962ef5 (
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
|
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\example SimpleKeyboard
\ingroup studioexamples
\brief Illustrates how to use a virtual keyboard in an application.
\title Simple Keyboard
\e {Simple Keyboard} provides a virtual keyboard for entering
text into several text fields. It uses functionality from the
\l{Qt Virtual Keyboard} module.
\image simplekeyboard.png "Virtual keyboard opening from a text input field"
The virtual keyboard is automatically displayed when users start entering
text into \l{Text Edit} or \l{Text Input} components. For more information
about using it, see \l{User Guide}{Virtual Keyboard: User Guide}.
To test the virtual keyboard, you need to select the \inlineimage icons/run_small.png
(\uicontrol Run) button to run the example on the desktop or a device.
The keyboard is not available during preview.
\section1 Using a Virtual Keyboard
First, we create an empty project, as described in \l {Creating Projects}.
For the purposes of this example, we call the project \e SimpleKeyboard.
We can use the default settings for other options, but we need to select
the \uicontrol {Use Qt Virtual Keyboard} check box on the
\uicontrol {Define Project Details} page.
\image simplekeyboard-project-details.png "SimpleKeyboard project details"
The project wizard template adds the Qt Quick Virtual Keyboard module
to the project and creates a component based on \l InputPanel in
\e SimpleKeyboard.qml.
\image simplekeyboard-component.png "SimpleKeyboard component"
We then create a tabbed UI that contains fields for entering text, among
other things. The virtual keyboard is automatically enabled for the text
edit and text input controls.
*/
|
