diff options
Diffstat (limited to 'doc/src/qml/qmlruntime.qdoc')
-rw-r--r-- | doc/src/qml/qmlruntime.qdoc | 143 |
1 files changed, 0 insertions, 143 deletions
diff --git a/doc/src/qml/qmlruntime.qdoc b/doc/src/qml/qmlruntime.qdoc deleted file mode 100644 index 831323474f..0000000000 --- a/doc/src/qml/qmlruntime.qdoc +++ /dev/null @@ -1,143 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** GNU Free Documentation License -** 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. -** -** Other Usage -** Alternatively, this file may be used in accordance with the terms -** and conditions contained in a signed written agreement between you -** and Nokia. -** -** -** -** -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! -\page qmlruntime.html -\title Qt Declarative UI Runtime -\brief launching QML based applications through Qt - -QML documents are loaded and executed by the QML runtime. This includes the -Declarative UI engine along with the built-in QML elements and plugin modules, -and it also provides access to third-party QML elements and modules. - -Applications that use QML need to invoke the QML runtime in order to -execute QML documents. This can be done by creating a QQuickView -or a QQmlEngine, as described below. In addition, the Declarative UI -package includes the qmlscene tool, which loads \c .qml files. This tool is -useful for developing and testing QML code without the need to write -a C++ application to load the QML runtime. - - - -\section1 Deploying QML-based applications - -To deploy an application that uses QML, the QML runtime must be invoked by -the application. This is done by writing a Qt C++ application that loads the -QQmlEngine by either: - -\list -\li Loading the QML file through a QQuickView instance, or -\li Creating a QQmlEngine instance and loading QML files with QQmlComponent -\endlist - - -\section2 Deploying with QQuickView - -QQuickView is a QWidget-based class that is able to load QML files. -For example, if there is a QML file, \c application.qml, like this: - -\qml - import QtQuick 2.0 - - Rectangle { width: 100; height: 100; color: "red" } -\endqml - -It can be loaded in a Qt application's \c main.cpp file like this: - -\code - #include <QApplication> - #include <QQuickView> - - int main(int argc, char *argv[]) - { - QApplication app(argc, argv); - - QQuickView view; - view.setSource(QUrl::fromLocalFile("application.qml")); - view.show(); - - return app.exec(); - } -\endcode - -This creates a QWidget-based view that displays the contents of -\c application.qml. - -The application's \c .pro \l{qmake Project Files}{project file} must specify -the \c declarative module for the \c QT variable. For example: - -\code - TEMPLATE += app - QT += gui declarative - SOURCES += main.cpp -\endcode - - -\section2 Creating a QQmlEngine directly - -If \c application.qml does not have any graphical components, or if it is -preferred to avoid QQuickView for other reasons, the QQmlEngine -can be constructed directly instead. In this case, \c application.qml is -loaded as a QQmlComponent instance rather than placed into a view: - -\code - #include <QApplication> - #include <QQmlEngine> - #include <QQmlContext> - #include <QQmlComponent> - - int main(int argc, char *argv[]) - { - QApplication app(argc, argv); - - QQmlEngine engine; - QQmlContext *objectContext = new QQmlContext(engine.rootContext()); - - QQmlComponent component(&engine, "application.qml"); - QObject *object = component.create(objectContext); - - // ... delete object and objectContext when necessary - - return app.exec(); - } -\endcode - -See \l {Using QML Bindings in C++ Applications} for more information about using -QQmlEngine, QQmlContext and QQmlComponent, as well -as details on including QML files through \l{The Qt Resource System}{Qt's Resource system}. - - - -\section1 Developing and Prototyping with QML Viewer - -The Declarative UI package includes a QML runtime tool, qmlscene, which loads -and displays QML documents. This is useful during the application development -phase for prototyping QML-based applications without writing your own C++ -applications to invoke the QML runtime. - -*/ - |