summaryrefslogtreecommitdiff
path: root/src/doc/src/declarative/qmltexthandling.qdoc
blob: 6aee1af023daccdb8e99d27db4734adaf550a0be (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
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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 texthandling.html
\title QML Text Handling and Validators
\ingroup QML Features
\previouspage {QML Mouse Events}{Mouse Events}
\nextpage {Keyboard Focus in Qt Quick 1}{Keyboard Focus}
\contentspage QML Features

\tableofcontents

\section1 Text Elements

\list
\li \l{Text}
\li \l{TextInput}
\li \l{TextEdit}
\endlist

\section1 Validators
\list
\li \l{IntValidator}
\li \l{DoubleValidator}
\li \l{RegExpValidator}
\endlist

\section1 Displaying Text in QML
QML provides several elements to display text onto the screen. The \l Text
element will display formatted text onto the screen, the \l TextEdit element
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 element documentation.

\section1 Validating Input Text
The \l {Validators}{validator} elements enforce the type and format of
\l TextInput objects.

\snippet doc/src/snippets/declarative/texthandling.qml int validator
The validator elements bind to \c {TextInput}'s \c validator property.

\snippet doc/src/snippets/declarative/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.

*/