summaryrefslogtreecommitdiff
path: root/src/controls/doc/src/qtquickcontrols-overview.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/controls/doc/src/qtquickcontrols-overview.qdoc')
-rw-r--r--src/controls/doc/src/qtquickcontrols-overview.qdoc79
1 files changed, 78 insertions, 1 deletions
diff --git a/src/controls/doc/src/qtquickcontrols-overview.qdoc b/src/controls/doc/src/qtquickcontrols-overview.qdoc
index 82da0b22..4eb6892f 100644
--- a/src/controls/doc/src/qtquickcontrols-overview.qdoc
+++ b/src/controls/doc/src/qtquickcontrols-overview.qdoc
@@ -28,5 +28,82 @@
/*!
\page qtquickcontrols-overview.html
\title Qt Quick Controls Overview
- \brief A set of APIs for working with ...
+ \brief A set of UI controls to create user interfaces in Qt Quick
+
+ The Qt Quick Controls provide a set of UI controls to create user interfaces
+ in Qt Quick.
+
+ \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 Creating a basic example
+
+ 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
+
+ For an overview of the controls provided by \l{Qt Quick Controls}, you can look at
+ the \l{Qt Quick Controls - Gallery}{Gallery} example.
+
+ \image qtquickcontrols-example-gallery.png
+
+ \section1 Setting Up Controls from C++
+
+ Although we have traditionally 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.
+
+ \section2 Using C++ Data From QML
+
+ If you need to register a C++ class to use from QML, you can call, for example,
+ qmlRegisterType() before declaring your QQmlApplicationEngine. You can find the list
+ of all registering functions \l{QQmlEngine}{here}.
+
+ If you need to expose data to QML components, you need to set them
+ to the context of the current QML engine. See QQmlContext for more
+ information.
+
+ \section1 Related information
+
+ \list
+ \li \l{Qt Quick}
+ \li \l{Qt Quick Controls}
+ \li \l{Qt Quick Controls Examples}
+ \endlist
*/