Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qtquickcontrols-input.qdoc
Go to the documentation of this file.
1// Copyright (C) 2017 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
3
4/*!
5 \page qtquickcontrols-input.html
6 \title Input Controls
7 \ingroup qtquickcontrols-guidelines
8 \brief Guidelines for input controls
9
10 Qt Quick Controls offers a variety of input controls for both numeric
11 and textual input.
12
13 \annotatedlist qtquickcontrols-input
14
15 Each type of input control has its own specific target use case. The
16 following sections offer guidelines for choosing the appropriate type
17 of input control, depending on the use case.
18
19 \section1 ComboBox Control
20
21 \image qtquickcontrols-combobox.gif
22
23 \l ComboBox is used to select a value from a static multiple-line drop-down list.
24 It is not possible to add new values, and only one option can be selected.
25
26 Recommendations:
27 \list
28 \li If the number of values is very large, consider applying a filter.
29 \li If the list is very limited, consider using RadioButton. This has the
30 advantage that the user can see all options at the same time.
31 \li Select a default value, the value that will be chosen most often.
32 \endlist
33
34 \b {See also} \l {CheckBox Control}, \l {Tumbler Control}.
35
36 \section1 Dial Control
37
38 \image qtquickcontrols-dial.png
39
40 \l Dial is similar to a traditional dial knob that is found on devices such
41 as stereos or industrial equipment.
42
43 The dial is rotated by clicking and dragging, with the handle indicating the
44 value of the dial.
45
46 For applications where fast input is important, the circular
47 \l {Dial::inputMode}{input mode} is useful, as clicking on the dial will
48 move it directly to that position.
49
50 For applications where precise input is important, the horizontal and
51 vertical input modes are recommended, as these allow small adjustments to
52 be made relative to where the dial is clicked. These modes are also better
53 for dials where large jumps in values could be unsafe, such as a dial that
54 controls audio volume.
55
56 \b {See also} \l {Tumbler Control}.
57
58 \section1 TextArea Control
59
60 \image qtquickcontrols-textarea.png
61
62 \l TextArea is a multi-line text editor.
63
64 \section1 TextField Control
65
66 \image qtquickcontrols-textfield.png
67
68 \l TextField is a single line text editor.
69
70 \b {See also} \l {Tumbler Control}.
71
72 \section1 Slider Control
73
74 \image qtquickcontrols-slider.gif
75
76 \l Slider is used to select a value by sliding a handle along a track.
77
78 \section1 RangeSlider Control
79
80 \image qtquickcontrols-rangeslider.gif
81
82 \l RangeSlider is used to select a range specified by two values,
83 by sliding each handle along a track.
84
85 \b {See also} \l {Slider Control}.
86
87 \section1 Tumbler Control
88
89 \image qtquickcontrols-tumbler.png
90
91 \l Tumbler is a spinnable wheel of items that can be selected.
92
93 \b {See also} \l {ComboBox Control}.
94
95 \section1 Related Information
96 \list
97 \li \l {Qt Quick Controls Guidelines}
98 \endlist
99*/