summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShawn Rutledge <shawn.rutledge@digia.com>2013-06-26 16:37:23 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-06-28 16:43:06 +0200
commit87a4a3d095f4fbabb91dade7e7313cb844256b9b (patch)
tree76071bb86e731ef5e77decce68172073ee5d4fcb
parent74438ef7c14f19cecda0910a122eb8887dab649d (diff)
QtQml: document QQmlExtensionPlugin::baseUrl
It was added here https://codereview.qt-project.org/#change,47532 without documentation. Also updated \since because for now qdoc seems to interpret \since 5.0 as QtQml 5.0. Task-number: QTBUG-31928 Change-Id: I652e9471f1ad8e83b355bffc8498a6565dc9aa2b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
-rw-r--r--dist/changes-5.1.02
-rw-r--r--src/qml/doc/src/whatsnew.qdoc2
-rw-r--r--src/qml/qml/qqmlextensionplugin.cpp9
3 files changed, 12 insertions, 1 deletions
diff --git a/dist/changes-5.1.0 b/dist/changes-5.1.0
index 528260e760..141c9a90e1 100644
--- a/dist/changes-5.1.0
+++ b/dist/changes-5.1.0
@@ -85,6 +85,8 @@ QtQml
static data generated by previous qmlRegisterType calls.
- New qmlRegisteredType function in qqml.h, allowing the registration of
composite types from C++.
+ - New baseUrl() accessor in QQmlExtensionPlugin, in case a plugin
+ needs to load QML or other assets from the same directory.
QtQuick
------
diff --git a/src/qml/doc/src/whatsnew.qdoc b/src/qml/doc/src/whatsnew.qdoc
index f1c69160b6..9ad8c23a42 100644
--- a/src/qml/doc/src/whatsnew.qdoc
+++ b/src/qml/doc/src/whatsnew.qdoc
@@ -115,6 +115,8 @@ has now been replaced by the new \l {Qt QML} and \l {Qt Quick} modules. See the
\list
\li Arbitrary functionality may be provided in a namespace through a singleton type. See qmlRegisterSingletonType() for more information.
\li JavaScript (.js) files may now import QML modules and other JavaScript files using the ".import" syntax.
+\li Plugins may now use QQmlExtensionPlugin::baseUrl to get the directory from which the plugin is loaded.
+ This will be useful if the plugin needs to load QML or other assets from the same directory.
\endlist
\section2 Other
diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp
index f77b176404..30eca7b112 100644
--- a/src/qml/qml/qqmlextensionplugin.cpp
+++ b/src/qml/qml/qqmlextensionplugin.cpp
@@ -45,7 +45,7 @@
QT_BEGIN_NAMESPACE
/*!
- \since 5.0
+ \since Qt 5.0
\inmodule QtQml
\class QQmlExtensionPlugin
\brief The QQmlExtensionPlugin class provides an abstract base for custom QML extension plugins.
@@ -156,6 +156,13 @@ QQmlExtensionPlugin::~QQmlExtensionPlugin()
{
}
+/*!
+ \since Qt 5.1
+ \brief Returns the URL of the directory from which the extension is loaded.
+
+ This is useful when the plugin also needs to load QML files or other
+ assets from the same directory.
+*/
QUrl QQmlExtensionPlugin::baseUrl() const
{
Q_D(const QQmlExtensionPlugin);