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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class QDesignerContainerExtension
\brief The QDesignerContainerExtension class allows you to add pages to
a custom multi-page container in Qt Designer's workspace.
\inmodule QtDesigner
\image containerextension-example.png
QDesignerContainerExtension provide an interface for creating
custom container extensions. A container extension consists of a
collection of functions that \QD needs to manage a multi-page
container plugin, and a list of the container's pages.
\warning This is \e not an extension for container plugins in
general, only custom \e multi-page containers.
To create a container extension, your extension class must inherit
from both QObject and QDesignerContainerExtension. For example:
\snippet plugins/doc_src_qtdesigner.cpp 6
Since we are implementing an interface, we must ensure that it's
made known to the meta object system using the Q_INTERFACES()
macro. This enables \QD to use the qobject_cast() function to
query for supported interfaces using nothing but a QObject
pointer.
You must reimplement several functions to enable \QD to manage a
custom multi-page container widget: \QD uses count() to keep track
of the number pages in your container, widget() to return the page
at a given index in the list of the container's pages, and
currentIndex() to return the list index of the selected page. \QD
uses the addWidget() function to add a given page to the
container, expecting it to be appended to the list of pages, while
it expects the insertWidget() function to add a given page to the
container by inserting it at a given index.
In \QD the extensions are not created until they are
required. For that reason 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 a container 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 a container
extension, is found. This factory will then create the extension
for the plugin.
There are four available types of extensions in \QD:
QDesignerContainerExtension , QDesignerMemberSheetExtension,
QDesignerPropertySheetExtension and QDesignerTaskMenuExtension.
\QD'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.
The QExtensionFactory class provides a standard extension factory,
and can also be used as an interface for custom extension
factories. You can either create a new QExtensionFactory and
reimplement the QExtensionFactory::createExtension() function. For
example:
\snippet plugins/doc_src_qtdesigner.cpp 7
Or you can use an existing factory, expanding the
QExtensionFactory::createExtension() function to make the factory
able to create a container extension as well. For example:
\snippet plugins/doc_src_qtdesigner.cpp 8
For a complete example using the QDesignerContainerExtension
class, see the \l {containerextension}{Container
Extension example}. The example shows how to create a custom
multi-page plugin for \QD.
\sa QExtensionFactory, QExtensionManager, {Creating Custom Widget
Extensions}
*/
/*!
\fn QDesignerContainerExtension::~QDesignerContainerExtension()
Destroys the extension.
*/
/*!
\fn int QDesignerContainerExtension::count() const
Returns the number of pages in the container.
*/
/*!
\fn QWidget *QDesignerContainerExtension::widget(int index) const
Returns the page at the given \a index in the extension's list of
pages.
\sa addWidget(), insertWidget()
*/
/*!
\fn int QDesignerContainerExtension::currentIndex() const
Returns the index of the currently selected page in the
container.
\sa setCurrentIndex()
*/
/*!
\fn void QDesignerContainerExtension::setCurrentIndex(int index)
Sets the currently selected page in the container to be the
page at the given \a index in the extension's list of pages.
\sa currentIndex()
*/
/*!
\fn void QDesignerContainerExtension::addWidget(QWidget *page)
Adds the given \a page to the container by appending it to the
extension's list of pages.
\sa insertWidget(), remove(), widget()
*/
/*!
\fn void QDesignerContainerExtension::insertWidget(int index, QWidget *page)
Adds the given \a page to the container by inserting it at the
given \a index in the extension's list of pages.
\sa addWidget(), remove(), widget()
*/
/*!
\fn void QDesignerContainerExtension::remove(int index)
Removes the page at the given \a index from the extension's list
of pages.
\sa addWidget(), insertWidget()
*/
/*!
\fn bool QDesignerContainerExtension::canAddWidget() const
Returns whether a widget can be added. This determines whether
the context menu options to add or insert pages are enabled.
This should return false for containers that have a single, fixed
page, for example QScrollArea or QDockWidget.
\since 5.0
\sa addWidget(), canRemove()
*/
/*!
\fn bool QDesignerContainerExtension::canRemove(int index) const
Returns whether the widget at the given \a index can be removed.
This determines whether the context menu option to remove the current
page is enabled.
This should return false for containers that have a single, fixed
page, for example QScrollArea or QDockWidget.
\since 5.0
\sa remove(), canAddWidget()
*/
|
