summaryrefslogtreecommitdiff
path: root/src/extras/doc/src/qtquickextras-overview.qdoc
blob: 5d5edf7c1cb118981e02b2c27ef908a188678126 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/****************************************************************************
**
** 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 qtquickextras-overview.html
    \title Qt Quick Extras Overview
    \brief A set of UI controls to create user interfaces in Qt Quick

    Qt Quick Extras provide a set of UI controls to create user
    interfaces in Qt Quick.

    \section1 Getting Started

    \section2 Building

    If you are building Qt Quick Extras from source, you can follow
    the steps used for most Qt modules:

    \code
    qmake
    make
    make install
    \endcode

    \section2 Documentation

    To build this documentation, you should use an in-source build of Qt or
    install Qt from a binary package.

    The steps to build the documentation are:

    \code
    qmake
    make docs
    \endcode

    \section2 Using the Controls

    The QML types can be imported into your application using the following
    import statement in your \c {.qml} file.

    \code
    import QtQuick.Extras 1.4
    \endcode

    \section1 Interactive controls

    \annotatedlist extras-interactive

    \section1 Non-interactive controls

    \annotatedlist extras-non-interactive

    \section1 Creating a basic example

    A basic example of a QML file that makes use of controls is shown here:

    \code
    import QtQuick 2.2
    import QtQuick.Extras 1.4

    Rectangle {
        DelayButton {
            anchors.centerIn: parent
        }
    }
    \endcode

    For an interactive showcase of the controls provided by
    \l{Qt Quick Extras}, you can look at
    the \l{Qt Quick Extras - Gallery}{Gallery} example.

    \image qtquickextras-example-gallery.png

    \section1 Related information

     \list
      \li \l{Qt Quick}
      \li \l{Qt Quick Extras}
      \li \l{Qt Quick Extras Examples}
    \endlist
*/