diff options
author | Alan Alpert <aalpert@rim.com> | 2012-12-21 13:37:30 -0800 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-03-20 06:48:30 +0100 |
commit | 471645f6dba6a21b85cb6788f0a0a07b6d5a804a (patch) | |
tree | f5244e1c76e5ef8ca9563837737ef7e71ce64298 /src/qml/qml/qqmlapplicationengine.cpp | |
parent | 9582ca0ce1758572d1ad59548fe221ca2e51598b (diff) |
Add QQmlApplicationEngine
This helper class exposes QML application functionality that QML-only
applications want to have, but QML-using applications may not.
Change-Id: If91c3f55ffa2a4aecdd9d6cc62f6ad09fd35b0dd
Reviewed-by: Alan Alpert (Personal) <416365416c@gmail.com>
Diffstat (limited to 'src/qml/qml/qqmlapplicationengine.cpp')
-rw-r--r-- | src/qml/qml/qqmlapplicationengine.cpp | 285 |
1 files changed, 285 insertions, 0 deletions
diff --git a/src/qml/qml/qqmlapplicationengine.cpp b/src/qml/qml/qqmlapplicationengine.cpp new file mode 100644 index 0000000000..7dc2c77922 --- /dev/null +++ b/src/qml/qml/qqmlapplicationengine.cpp @@ -0,0 +1,285 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Research In Motion. +** Contact: http://www.qt-project.org/legal +** +** This file is part of the QtQml module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** 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 Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <QtCore/QCoreApplication> +#include <QtCore/QTranslator> +#include <QQmlComponent> +#include "qqmlapplicationengine.h" +#include "qqmlapplicationengine_p.h" + +QT_BEGIN_NAMESPACE + +QQmlApplicationEnginePrivate::QQmlApplicationEnginePrivate(QQmlEngine *e) + : QQmlEnginePrivate(e) +{ +} + +QQmlApplicationEnginePrivate::~QQmlApplicationEnginePrivate() +{ + qDeleteAll(objects); +#ifndef QT_NO_TRANSLATIONS + qDeleteAll(translators); +#endif +} + +void QQmlApplicationEnginePrivate::init() +{ + Q_Q(QQmlApplicationEngine); + q->connect(&statusMapper, SIGNAL(mapped(QObject*)), + q, SLOT(_q_finishLoad(QObject*))); + q->connect(q, SIGNAL(quit()), QCoreApplication::instance(), SLOT(quit())); +#ifndef QT_NO_TRANSLATIONS + QTranslator* qtTranslator = new QTranslator; + if (qtTranslator->load(QLatin1String("qt_") + QLocale::system().name(), QLibraryInfo::location(QLibraryInfo::TranslationsPath))) + QCoreApplication::installTranslator(qtTranslator); + translators << qtTranslator; +#endif +} + +void QQmlApplicationEnginePrivate::loadTranslations(const QUrl &rootFile) +{ +#ifndef QT_NO_TRANSLATIONS + if (rootFile.scheme() != QLatin1String("file") && rootFile.scheme() != QLatin1String("qrc")) + return; + + QFileInfo fi(rootFile.toLocalFile()); + + QTranslator *translator = new QTranslator; + if (translator->load(QLatin1String("qml_") + QLocale::system().name(), fi.path() + QLatin1String("/i18n"))) { + QCoreApplication::installTranslator(translator); + translators << translator; + } else { + delete translator; + } +#endif +} + +void QQmlApplicationEnginePrivate::startLoad(const QUrl &url, const QByteArray &data, bool dataFlag) +{ + Q_Q(QQmlApplicationEngine); + + loadTranslations(url); //Translations must be loaded before the QML file is + QQmlComponent *c = new QQmlComponent(q, q); + + if (dataFlag) + c->setData(data,url); + else + c->loadUrl(url); + + if (!c->isLoading()) { + _q_finishLoad(c); + return; + } + statusMapper.setMapping(c, c); + q->connect(c, SIGNAL(statusChanged(QQmlComponent::Status)), + &statusMapper, SLOT(map())); +} + +void QQmlApplicationEnginePrivate::_q_finishLoad(QObject *o) +{ + Q_Q(QQmlApplicationEngine); + QQmlComponent *c = qobject_cast<QQmlComponent *>(o); + if (!c) + return; + switch (c->status()) { + case QQmlComponent::Error: + qWarning() << "QQmlApplicationEngine failed to load component"; + qWarning() << qPrintable(c->errorString()); + q->objectCreated(0, c->url()); + break; + case QQmlComponent::Ready: + objects << c->create(); + q->objectCreated(objects.last(), c->url()); + break; + case QQmlComponent::Loading: + case QQmlComponent::Null: + return; //These cases just wait for the next status update + } + delete c; +} + +/*! + \class QQmlApplicationEngine + \since 5.1 + \inmodule QtQml + \brief QQmlApplicationEngine provides a convenient way to load an application from a single QML file. + + This class combines a QQmlEngine and QQmlComponent to provide a convenient way to load a single QML file. It also exposes some central application functionality to QML, which a C++/QML hybrid application would normally control from C++. + + It can be used like so: + + \code + #include <QGuiApplication> + #include <QQmlApplicationEngine> + + int main(int argc, char *argv[]) + { + QGuiApplication app(argc, argv); + QQmlApplicationEngine engine("main.qml"); + return app.exec(); + } + \endcode + + You can also use QCoreApplication with QQmlApplicationEngine, if you are not using any QML modules which require a QGuiApplication (such as QtQuick). + + List of configuration changes from a default QQmlEngine: + + \list + \li Connecting Qt.quit() to QCoreApplication::quit() + \li Automatically loads translation files from an i18n directory adjacent to the main QML file. + \endlist + + The engine behavior can be further tweaked by using the inherited methods from QQmlEngine. +*/ + +/*! + \fn QQmlApplicationEngine::objectCreated(QObject *object, const QUrl &url) + + This signal is emitted when an object finishes loading. If loading was successful, \a object contains a pointer to the loaded object. + Otherwise the pointer is NULL. The \a url loaded is also provided, note that if a QString file path was initially passed to the + QQmlApplicationEngine, this url will be the equivalent of QUrl::fromLocalFile(filePath). +*/ + +/*! + Create a new QQmlApplicationEngine with the given \a parent. You will have to call load() later in + order to load a QML file. +*/ +QQmlApplicationEngine::QQmlApplicationEngine(QObject *parent) +: QQmlEngine(*(new QQmlApplicationEnginePrivate(this)), parent) +{ + Q_D(QQmlApplicationEngine); + d->init(); +} + +/*! + Create a new QQmlApplicationEngine and loads the QML file at the given \a url. + This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards. +*/ +QQmlApplicationEngine::QQmlApplicationEngine(const QUrl &url, QObject *parent) + : QQmlEngine(*(new QQmlApplicationEnginePrivate(this)), parent) +{ + Q_D(QQmlApplicationEngine); + d->init(); + load(url); +} + +/*! + Create a new QQmlApplicationEngine and loads the QML file at the given + \a filePath, which must be a local file path. If a relative path is + given then it will be interpreted as relative to the working directory of the + application. + + This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards. +*/ +QQmlApplicationEngine::QQmlApplicationEngine(const QString &filePath, QObject *parent) + : QQmlEngine(*(new QQmlApplicationEnginePrivate(this)), parent) +{ + Q_D(QQmlApplicationEngine); + d->init(); + load(QUrl::fromLocalFile(filePath)); +} + +/*! + Destroys the QQmlApplicationEngine and all QML objects it loaded. +*/ +QQmlApplicationEngine::~QQmlApplicationEngine() +{ + //Instantiated root objects cleaned up in private class +} + +/*! + Loads the root QML file located at \a url. The object tree defined by the file + is created immediately for local file urls. Remote urls are loaded asynchronously, + listen to the objectCreated signal to determine when the object + tree is ready. + + If an error occurs, error messages are printed with qWarning. +*/ +void QQmlApplicationEngine::load(const QUrl &url) +{ + Q_D(QQmlApplicationEngine); + d->startLoad(url); +} + +/*! + Loads the root QML file located at \a filePath. \a filePath must be a path to + a local file. If \a filePath is a relative path, it is taken as relative to + the application's working directory. The object tree defined by the file is + instantiated immediately. + + If an error occurs, error messages are printed with qWarning. +*/ +void QQmlApplicationEngine::load(const QString &filePath) +{ + Q_D(QQmlApplicationEngine); + d->startLoad(QUrl::fromLocalFile(filePath)); +} + +/*! + Loads the QML given in \a data. The object tree defined by \a data is + instantiated immediately. + + If a \a url is specified it is used as the base url of the component. This affects + relative paths within the data and error messages. + + If an error occurs, error messages are printed with qWarning. +*/ +void QQmlApplicationEngine::loadData(const QByteArray &data, const QUrl &url) +{ + Q_D(QQmlApplicationEngine); + d->startLoad(url, data, true); +} + +/*! + Returns a list of all the root objects instantiated by the + QQmlApplicationEngine. This will only contain objects loaded via load() or a + convenience constructor. +*/ + +QList<QObject *> QQmlApplicationEngine::rootObjects() +{ + Q_D(QQmlApplicationEngine); + return d->objects; +} + +QT_END_NAMESPACE + +#include "moc_qqmlapplicationengine.cpp" |