aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/texthandling.qdoc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2012-05-28 19:40:02 +0200
committerQt by Nokia <qt-info@nokia.com>2012-06-06 06:27:41 +0200
commitca6d49e6b4096f5a9737c6aee04e9b22a781aba2 (patch)
tree5fabb7125253062e4f36490e151a6fad064f82b5 /src/quick/doc/src/texthandling.qdoc
parent2896a434715d70c73409042d78ecc2e92b8b093b (diff)
Doc: Grouped Qt Quick types into several groups
-created new groups and converted some overviews into group pages -edited type documentation and added \ingroup -articles still need title fixes and link fixes Groups: qtquick-visual-types qtquick-item-graphics qtquick-shaders qtquick-canvas qtquick-text qtquick-text-validator qtquick-interaction qtquick-positioners qtquick-transformations qtquick-states qtquick-animation-define qtquick-animation-properties qtquick-animation-control qtquick-animation-modifiers qtquick-images-sprites qtquick-images qtquick-models qtquick-containers qtquick-views qtquick-paths qtquick-utility Task: QTBUG-25685 Change-Id: I81d4df3320bf5daad5cabb5e42408013fb24f464 Reviewed-by: Bea Lam <bea.lam@nokia.com> Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
Diffstat (limited to 'src/quick/doc/src/texthandling.qdoc')
-rw-r--r--src/quick/doc/src/texthandling.qdoc71
1 files changed, 71 insertions, 0 deletions
diff --git a/src/quick/doc/src/texthandling.qdoc b/src/quick/doc/src/texthandling.qdoc
new file mode 100644
index 0000000000..2628776ca3
--- /dev/null
+++ b/src/quick/doc/src/texthandling.qdoc
@@ -0,0 +1,71 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-text
+\title Qt Quick Text Handling and Validators
+\brief Text display, 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.
+
+\generatelist{related}
+
+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 doc/snippets/qml/texthandling.qml int validator
+The validator types bind to \c {TextInput}'s \c validator property.
+
+\snippet doc/snippets/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.
+
+*/
+
+/*!
+\group qtquick-text-validator
+\title Qt Quick Text Validators
+\brief Types that validate text input
+
+The \l{Qt Quick Text Handling and Validators} page has information about
+validating user text input.
+*/