1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Designer of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <QtDesigner/extension.h>
QT_BEGIN_NAMESPACE
/*!
\class QAbstractExtensionFactory
\brief The QAbstractExtensionFactory class provides an interface
for extension factories in Qt Designer.
\inmodule QtDesigner
QAbstractExtensionFactory is not intended to be instantiated
directly; use the QExtensionFactory instead.
In \QD, extension factories are used to look up and create named
extensions as they are required. For that reason, when
implementing a custom extension, you must also create a
QExtensionFactory, i.e a class that is able to make an instance of
your extension, and register it using \QD's \l
{QExtensionManager}{extension manager}.
When an extension is required, \QD's \l
{QExtensionManager}{extension manager} will run through all its
registered factories calling QExtensionFactory::createExtension()
for each until the first one that is able to create the requested
extension for the selected object, is found. This factory will
then make an instance of the extension.
\sa QExtensionFactory, QExtensionManager
*/
/*!
\fn QAbstractExtensionFactory::~QAbstractExtensionFactory()
Destroys the extension factory.
*/
/*!
\fn QObject *QAbstractExtensionFactory::extension(QObject *object, const QString &iid) const
Returns the extension specified by \a iid for the given \a object.
*/
/*!
\class QAbstractExtensionManager
\brief The QAbstractExtensionManager class provides an interface
for extension managers in Qt Designer.
\inmodule QtDesigner
QAbstractExtensionManager is not intended to be instantiated
directly; use the QExtensionManager instead.
In \QD, extension are not created until they are required. For
that reason, when implementing a custom extension, you must also
create a QExtensionFactory, i.e a class that is able to make an
instance of your extension, and register it using \QD's \l
{QExtensionManager}{extension manager}.
When an extension is required, \QD's \l
{QExtensionManager}{extension manager} will run through all its
registered factories calling QExtensionFactory::createExtension()
for each until the first one that is able to create the requested
extension for the selected object, is found. This factory will
then make an instance of the extension.
\sa QExtensionManager, QExtensionFactory
*/
/*!
\fn QAbstractExtensionManager::~QAbstractExtensionManager()
Destroys the extension manager.
*/
/*!
\fn void QAbstractExtensionManager::registerExtensions(QAbstractExtensionFactory *factory, const QString &iid)
Register the given extension \a factory with the extension
specified by \a iid.
*/
/*!
\fn void QAbstractExtensionManager::unregisterExtensions(QAbstractExtensionFactory *factory, const QString &iid)
Unregister the given \a factory with the extension specified by \a
iid.
*/
/*!
\fn QObject *QAbstractExtensionManager::extension(QObject *object, const QString &iid) const
Returns the extension, specified by \a iid, for the given \a
object.
*/
/*!
\fn template <class T> T qt_extension(QAbstractExtensionManager* manager, QObject *object)
\relates QExtensionManager
Returns the extension of the given \a object cast to type T if the
object is of type T (or of a subclass); otherwise returns 0. The
extension is retrieved using the given extension \a manager.
\snippet lib/tools_designer_src_lib_extension_extension.cpp 0
When implementing a custom widget plugin, a pointer to \QD's
current QDesignerFormEditorInterface object (\c formEditor) is
provided by the QDesignerCustomWidgetInterface::initialize()
function's parameter.
If the widget in the example above doesn't have a defined
QDesignerPropertySheetExtension, \c propertySheet will be a null
pointer.
*/
/*!
\macro Q_DECLARE_EXTENSION_INTERFACE(ExtensionName, Identifier)
\relates QExtensionManager
Associates the given \a Identifier (a string literal) to the
extension class called \a ExtensionName. The \a Identifier must be
unique. For example:
\snippet lib/tools_designer_src_lib_extension_extension.cpp 1
Using the company and product names is a good way to ensure
uniqueness of the identifier.
When implementing a custom extension class, you must use
Q_DECLARE_EXTENSION_INTERFACE() to enable usage of the
qt_extension() function. The macro is normally located right after the
class definition for \a ExtensionName, in the associated header
file.
\sa {Q_DECLARE_INTERFACE}{Q_DECLARE_INTERFACE()}
*/
QT_END_NAMESPACE
|
