aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/templates/doc/src/qtquicktemplates2-qmltypes.qdoc
blob: 33ee08d36527fd7c506b9aee08d128c6dde19123 (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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \qmlmodule QtQuick.Templates 2.5
    \title Qt Quick Templates 2 QML Types
    \ingroup qmlmodules
    \brief Provides QML types for templates (Qt Quick Templates).

    The \l {Qt Quick Templates 2} 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 QtQuick.Templates 2.12 as T
    \endcode

    For the sake of clarity, there is a one-to-one mapping between the types
    provided by the \c QtQuick.Templates and \c QtQuick.Controls imports. For
    every type available in the \c QtQuick.Controls import, a non-visual template
    type by the same name exists in the \c QtQuick.Templates import.

    \note It is recommended to use a namespace for the templates import to avoid
    overlap with the types provided by the \c QtQuick.Controls import.

    \section1 QML Types

    \generatelist {qmltypesbymodule QtQuick.Controls}

    \section1 Related Information

    \list
        \li \l {Qt Quick Controls 2 QML Types}
    \endlist

    \noautolist
*/