aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/concepts/input/textinput.qdoc
blob: 41508caad673baade394ea573fab72cbd3f377f7 (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page qtquick-input-textinput.html
\title Qt Quick Text Input Handling and Validators
\brief Text input and validation

\section1 Text Visual Types

Qt Quick provides several types to display text onto the screen. The \l Text
type will display formatted text onto the screen, the \l TextEdit type
will place a multiline line edit onto the screen, and the \l TextInput will
place a single editable line field onto the screen.

To learn more about their specific features and properties, visit their
respective documentation.

\section1 Validating Input Text

The \e validator types enforce the type and format of
\l TextInput objects.

\annotatedlist qtquick-text-validator

\snippet qml/texthandling.qml int validator
The validator types bind to \c {TextInput}'s \c validator property.

\snippet qml/texthandling.qml regexp validator
The regular expression in the snippet will only allow the inputted text to be
\c {fruit basket}.

Note that QML parses JavaScript regular expressions, while Qt's
\l {QRegExp} class' regular expressions are based on Perl regular expressions.

*/

/*!
\page qtquick-text-validator.html
\ingroup qtquick-text-validator
\title Qt Quick Text Validators
\brief Types that validate text input

The \l {Qt Quick Text Input Handling and Validators} page has information about
validating user text input.
*/