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
|
/****************************************************************************
**
** 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 "default_extensionfactory.h"
#include "qextensionmanager.h"
#include <qpointer.h>
#include <QtCore/qdebug.h>
QT_BEGIN_NAMESPACE
/*!
\class QExtensionFactory
\brief The QExtensionFactory class allows you to create a factory
that is able to make instances of custom extensions in Qt
Designer.
\inmodule QtDesigner
In \QD the extensions 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}.
The QExtensionManager class provides extension management
facilities for Qt Designer. When an extension is required, Qt
Designer'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 a requested extension for the selected
object, is found. This factory will then make an instance of the
extension.
There are four available types of extensions in Qt Designer:
QDesignerContainerExtension , QDesignerMemberSheetExtension,
QDesignerPropertySheetExtension and QDesignerTaskMenuExtension. Qt
Designer's behavior is the same whether the requested extension is
associated with a multi page container, a member sheet, a property
sheet or a task menu.
You can either create a new QExtensionFactory and reimplement the
QExtensionFactory::createExtension() function. For example:
\snippet lib/tools_designer_src_lib_extension_default_extensionfactory.cpp 0
Or you can use an existing factory, expanding the
QExtensionFactory::createExtension() function to make the factory
able to create your extension as well. For example:
\snippet lib/tools_designer_src_lib_extension_default_extensionfactory.cpp 1
For a complete example using the QExtensionFactory class, see the
\l {taskmenuextension}{Task Menu Extension example}. The
example shows how to create a custom widget plugin for Qt
Designer, and how to to use the QDesignerTaskMenuExtension class
to add custom items to Qt Designer's task menu.
\sa QExtensionManager, QAbstractExtensionFactory
*/
/*!
Constructs an extension factory with the given \a parent.
*/
QExtensionFactory::QExtensionFactory(QExtensionManager *parent)
: QObject(parent)
{
}
/*!
Returns the extension specified by \a iid for the given \a object.
\sa createExtension()
*/
QObject *QExtensionFactory::extension(QObject *object, const QString &iid) const
{
if (!object)
return nullptr;
const IdObjectKey key = qMakePair(iid, object);
ExtensionMap::iterator it = m_extensions.find(key);
if (it == m_extensions.end()) {
if (QObject *ext = createExtension(object, iid, const_cast<QExtensionFactory*>(this))) {
connect(ext, &QObject::destroyed, this, &QExtensionFactory::objectDestroyed);
it = m_extensions.insert(key, ext);
}
}
if (!m_extended.contains(object)) {
connect(object, &QObject::destroyed, this, &QExtensionFactory::objectDestroyed);
m_extended.insert(object, true);
}
if (it == m_extensions.end())
return nullptr;
return it.value();
}
void QExtensionFactory::objectDestroyed(QObject *object)
{
for (auto it = m_extensions.begin(); it != m_extensions.end(); ) {
if (it.key().second == object || object == it.value())
it = m_extensions.erase(it);
else
++it;
}
m_extended.remove(object);
}
/*!
Creates an extension specified by \a iid for the given \a object.
The extension object is created as a child of the specified \a
parent.
\sa extension()
*/
QObject *QExtensionFactory::createExtension(QObject *object, const QString &iid, QObject *parent) const
{
Q_UNUSED(object);
Q_UNUSED(iid);
Q_UNUSED(parent);
return nullptr;
}
/*!
Returns the extension manager for the extension factory.
*/
QExtensionManager *QExtensionFactory::extensionManager() const
{
return static_cast<QExtensionManager *>(parent());
}
QT_END_NAMESPACE
|
