summaryrefslogtreecommitdiff
path: root/src/controls/doc/src/qtquickcontrols-index.qdoc
blob: 011de527d23861873f8030a48036248520b7b673 (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
/****************************************************************************
**
** Copyright (C) 2012 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 qtquickcontrols-index.html
    \title Qt Quick Controls

    \brief The Qt Quick Controls module provides a set of reusable Qt Quick UI components.

    The Qt Quick Controls module provides a set of reusable UI components to create
    classic desktop-style user interfaces using Qt Quick.

    The module is new in Qt 5.1 and requires \l{Qt Quick} 2.1.

    \note \l{Qt Quick Layouts} can be used to arrange Qt Quick Controls in a user interface.

    \note The current focus is on desktop, but in the long term Qt Quick Controls
    are expected to be supported on mobile platforms too.

    \section1 Getting started

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

    \code
     import QtQuick.Controls 1.0
    \endcode

    \section1 Application Window
    Components used to describe the basic window properties of an application.
    \annotatedlist applicationwindow

    \section1 Navigation and Views
    Views typically let the user manage or present other components in a layout.
    \annotatedlist views

    \section1 Controls
    Controls are typically items that are used to present or receive input from the user.
    \annotatedlist controls

    \section1 Menus
    Types that can be used to build menus.
    \annotatedlist menus

    \section1 Related information

    \section2 Guides
     \list
      \li \l{Qt Quick Controls Overview}
     \endlist

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

    \section2 Examples
     \list
      \li \l{Qt Quick Controls Examples}
     \endlist

    \l {Qt Quick Controls Styles QML Types}

*/