aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@theqtcompany.com>2015-12-29 13:57:57 +0100
committerJ-P Nurmi <jpnurmi@theqtcompany.com>2016-01-05 07:19:27 +0000
commit4d7a53aceaa1684651df086f017d700963fe5c4c (patch)
tree13643338d1b629fc9c49f6bdeed3d962a24ad3f5 /src
parentcf58057988464f68e23c4d52598fd9de791f4af7 (diff)
Docs: templates
Change-Id: I4b28b2c847869a3768e40ba835cda04191ca18d6 Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com> Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r--src/imports/controls/doc/src/qtlabscontrols-index.qdoc1
-rw-r--r--src/imports/controls/doc/src/templates/qtlabstemplates-index.qdoc54
-rw-r--r--src/imports/controls/doc/src/templates/qtlabstemplates.qdoc63
3 files changed, 118 insertions, 0 deletions
diff --git a/src/imports/controls/doc/src/qtlabscontrols-index.qdoc b/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
index 93615499..dc198135 100644
--- a/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
+++ b/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
@@ -97,6 +97,7 @@
\li \l{Qt Quick}
\li \l{Qt Quick Layouts}
\li \l{Qt Labs Calendar}
+ \li \l{Qt Labs Templates}
\li \l{Qt Labs Controls QML Types}{Qt Labs Controls QML Types}
\endlist
*/
diff --git a/src/imports/controls/doc/src/templates/qtlabstemplates-index.qdoc b/src/imports/controls/doc/src/templates/qtlabstemplates-index.qdoc
new file mode 100644
index 00000000..fded42cd
--- /dev/null
+++ b/src/imports/controls/doc/src/templates/qtlabstemplates-index.qdoc
@@ -0,0 +1,54 @@
+/****************************************************************************
+**
+** 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 qtlabstemplates-index.html
+ \title Qt Labs Templates
+ \brief A set of templates to create user interface controls in Qt Quick
+
+ Qt Labs Templates are the foundations of \l {Qt Labs Controls}. Templates
+ are non-visual implementations of controls' logic and behavior. They offer
+ an interface to visualize the controls in QML using \l {Qt Quick}.
+
+ Even though the templates aim to be as style-agnostic as possible, in some
+ cases they have to make certain assumptions about the visual structure of
+ a control. For example, a spinbox has buttons that increment and decrement
+ the value of the spinbox. In order to implement the behavior of a spinbox,
+ the spinbox template needs to know if the user is interacting with the up
+ or down button. A visual implementation of the spinbox template merely needs
+ to position the up and down buttons and visualize them in normal, pressed,
+ and disabled states. Any input event handling and state processing is taken
+ care of by the underlying template.
+
+ \section1 Related Information
+
+ \list
+ \li \l{Qt Quick}
+ \li \l{Qt Labs Controls}
+ \li \l{Qt Labs Templates QML Types}
+ \endlist
+*/
diff --git a/src/imports/controls/doc/src/templates/qtlabstemplates.qdoc b/src/imports/controls/doc/src/templates/qtlabstemplates.qdoc
new file mode 100644
index 00000000..84eabe44
--- /dev/null
+++ b/src/imports/controls/doc/src/templates/qtlabstemplates.qdoc
@@ -0,0 +1,63 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \qmlmodule Qt.labs.templates 1.0
+ \title Qt Labs Templates QML Types
+ \ingroup qmlmodules
+ \brief Provides QML types for templates (Qt Labs Templates).
+
+ The \l {Qt Labs Templates} module provides a set of non-visual templates
+ that can be used to build user interface controls in QML using \l {Qt Quick}.
+
+ The QML types can be imported using the following import statement in your
+ \c .qml file:
+
+ \badcode
+ import Qt.labs.templates 1.0 as T
+ \endcode
+
+ For the sake of clarity, there is a one-to-one mapping between the types
+ provided by the \c Qt.labs.templates and \c Qt.labs.controls imports. For
+ every type available in the \c Qt.labs.controls import, a non-visual template
+ type by the same name exists in the \c Qt.labs.templates import.
+
+ \note It is recommended to use a namespace for the templates import to avoid
+ overlap with the types provided by the \c Qt.labs.controls import.
+
+ \section1 QML Types
+
+ \generatelist {qmltypesbymodule Qt.labs.controls}
+
+ \section1 Related Information
+
+ \list
+ \li \l {Qt Labs Controls QML Types}
+ \endlist
+
+ \noautolist
+*/