blob: 5c22276e49b46bbcd24a7801319995ae04d20bce (
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/****************************************************************************
**
** 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 UI controls for Qt Quick.
The Qt Quick Controls module provides a set of controls that can be used to
build complete interfaces in Qt Quick.
The module is new in Qt 5.1 and requires \l{Qt Quick} 2.1.
\image qtquickcontrols-example-gallery.png
\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
A basic example of a QML file that makes use of controls is shown here:
\code
import QtQuick.Controls 1.0
ApplicationWindow {
title: "My Application"
Button {
text: "Push Me"
anchors.centerIn: parent
}
}
\endcode
\section2 Setting Up Controls from C++
While we traditionally have used a QQuickView window to display QML files
in a C++ application, doing this means you can only set window properties from C++.
With Qt Quick Controls, declare an ApplicationWindow as the root item of your application and launch it by using the
QQmlApplicationEngine instead. This ensures that you can control top level window properties from QML.
A basic example of a source file that makes use of controls is shown here:
\code
#include <QApplication>
#include <QQmlApplicationEngine>
int main(int argc, char *argv[])
{
QApplication app(argc, argv);
QQmlApplicationEngine engine("main.qml");
return app.exec();
}
\endcode
\note We are using QApplication and not QGuiApplication in this example.
Though you can use QGuiApplication instead, doing this will eliminate platform-dependent styling.
This is because it is relying on the widget module to provide the native look and feel.
\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
\section2 Styles
\list
\li \l {Qt Quick Controls Styles}
\endlist
\section2 Layouts
\list
\li \l {Qt Quick Layouts}
\endlist
*/
|
