1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQml module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qqmlextensionplugin.h"
41#include "qqmlextensionplugin_p.h"
42
43QT_BEGIN_NAMESPACE
44
45/*!
46 \since 5.0
47 \inmodule QtQml
48 \class QQmlExtensionPlugin
49 \brief The QQmlExtensionPlugin class provides an abstract base for custom QML extension plugins.
50
51 \ingroup plugins
52
53 \include qqmlextensionplugin.qdocinc
54
55 The \l {Writing QML Extensions with C++} tutorial also contains a chapter
56 on creating QML plugins.
57
58 \sa QQmlEngine::importPlugin(), {How to Create Qt Plugins}
59*/
60
61/*!
62 \fn void QQmlExtensionPlugin::registerTypes(const char *uri)
63
64 Registers the QML types in the given \a uri. Subclasses should implement
65 this to call qmlRegisterType() for all types which are provided by the extension
66 plugin.
67
68 The \a uri is an identifier for the plugin generated by the QML engine
69 based on the name and path of the extension's plugin library.
70*/
71
72/*!
73 Constructs a QML extension plugin with the given \a parent.
74
75 Note that this constructor is invoked automatically by the
76 Q_PLUGIN_METADATA() macro, so there is no need for calling it
77 explicitly.
78*/
79QQmlExtensionPlugin::QQmlExtensionPlugin(QObject *parent)
80 : QObject(*(new QQmlExtensionPluginPrivate), parent)
81{
82}
83
84/*!
85 \internal
86 */
87QQmlExtensionPlugin::~QQmlExtensionPlugin()
88{
89}
90
91/*!
92 \since 5.1
93 \brief Returns the URL of the directory from which the extension is loaded.
94
95 This is useful when the plugin also needs to load QML files or other
96 assets from the same directory.
97*/
98QUrl QQmlExtensionPlugin::baseUrl() const
99{
100 Q_D(const QQmlExtensionPlugin);
101 return d->baseUrl;
102}
103
104/*!
105 \fn void QQmlExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
106
107 Initializes the extension from the \a uri using the \a engine. Here an application
108 plugin might, for example, expose some data or objects to QML,
109 as context properties on the engine's root context.
110*/
111
112void QQmlExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
113{
114 Q_UNUSED(engine);
115 Q_UNUSED(uri);
116}
117
118/*!
119 \class QQmlExtensionInterface
120 \internal
121 \inmodule QtQml
122*/
123
124/*!
125 \class QQmlTypesExtensionInterface
126 \internal
127 \inmodule QtQml
128*/
129
130QT_END_NAMESPACE
131
132#include "moc_qqmlextensionplugin.cpp"
133