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 | |
43 | QT_BEGIN_NAMESPACE |
44 | |
45 | /*! |
46 | \since 5.14 |
47 | \inmodule QtQml |
48 | \class QQmlEngineExtensionPlugin |
49 | \brief The QQmlEngineExtensionPlugin class provides an abstract base for custom QML extension |
50 | plugins. |
51 | |
52 | \ingroup plugins |
53 | |
54 | \include qqmlextensionplugin.qdocinc |
55 | |
56 | The \l {Writing QML Extensions with C++} tutorial also contains a chapter |
57 | on creating QML plugins. |
58 | |
59 | \sa QQmlEngine::importPlugin(), {How to Create Qt Plugins} |
60 | */ |
61 | |
62 | /*! |
63 | \fn void QQmlExtensionPlugin::registerTypes(const char *uri) |
64 | \internal |
65 | |
66 | Registers the QML types in the given \a uri. Subclasses should implement |
67 | this to call qmlRegisterType() for all types which are provided by the extension |
68 | plugin. |
69 | |
70 | The \a uri is an identifier for the plugin generated by the QML engine |
71 | based on the name and path of the extension's plugin library. |
72 | */ |
73 | |
74 | /*! |
75 | \internal |
76 | */ |
77 | QQmlExtensionPlugin::QQmlExtensionPlugin(QObject *parent) |
78 | : QObject(*(new QQmlExtensionPluginPrivate), parent) |
79 | { |
80 | } |
81 | |
82 | /*! |
83 | Constructs a QML extension plugin with the given \a parent. |
84 | |
85 | Note that this constructor is invoked automatically by the |
86 | Q_PLUGIN_METADATA() macro, so there is no need for calling it |
87 | explicitly. |
88 | */ |
89 | QQmlEngineExtensionPlugin::QQmlEngineExtensionPlugin(QObject *parent) |
90 | : QObject(parent) |
91 | { |
92 | } |
93 | |
94 | |
95 | /*! |
96 | \internal |
97 | */ |
98 | QQmlExtensionPlugin::~QQmlExtensionPlugin() = default; |
99 | |
100 | /*! |
101 | \internal |
102 | */ |
103 | QQmlEngineExtensionPlugin::~QQmlEngineExtensionPlugin() = default; |
104 | |
105 | /*! |
106 | \since 5.1 |
107 | \internal |
108 | \brief Returns the URL of the directory from which the extension is loaded. |
109 | |
110 | This is useful when the plugin also needs to load QML files or other |
111 | assets from the same directory. |
112 | */ |
113 | QUrl QQmlExtensionPlugin::baseUrl() const |
114 | { |
115 | Q_D(const QQmlExtensionPlugin); |
116 | return d->baseUrl; |
117 | } |
118 | |
119 | /*! |
120 | \internal |
121 | */ |
122 | |
123 | void QQmlExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri) |
124 | { |
125 | Q_UNUSED(engine); |
126 | Q_UNUSED(uri); |
127 | } |
128 | |
129 | /*! |
130 | Initializes the extension from the \a uri using the \a engine. Here an application |
131 | plugin might, for example, expose some data or objects to QML, |
132 | as context properties on the engine's root context. |
133 | */ |
134 | void QQmlEngineExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri) |
135 | { |
136 | Q_UNUSED(engine); |
137 | Q_UNUSED(uri); |
138 | } |
139 | |
140 | /*! |
141 | \class QQmlExtensionInterface |
142 | \internal |
143 | \inmodule QtQml |
144 | */ |
145 | |
146 | /*! |
147 | \class QQmlTypesExtensionInterface |
148 | \internal |
149 | \inmodule QtQml |
150 | */ |
151 | |
152 | /*! |
153 | \class QQmlEngineExtensionInterface |
154 | \internal |
155 | \inmodule QtQml |
156 | */ |
157 | |
158 | QT_END_NAMESPACE |
159 | |
160 | #include "moc_qqmlextensionplugin.cpp" |
161 | |