<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QDesignerContainerExtension Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QDesignerContainerExtension Class Reference<br /><sup><sup>[<a href="qtdesigner.html">QtDesigner</a> module]</sup></sup></h1><p>The QDesignerContainerExtension class allows you to add pages to
a custom multi-page container in Qt Designer's workspace. <a href="#details">More...</a></p>
<p>Inherited by <a href="qpydesignercontainerextension.html">QPyDesignerContainerExtension</a>.</p><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qdesignercontainerextension.html#QDesignerContainerExtension">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignercontainerextension.html#QDesignerContainerExtension-2">__init__</a></b> (<i>self</i>, QDesignerContainerExtension)</li><li><div class="fn" /><b><a href="qdesignercontainerextension.html#addWidget">addWidget</a></b> (<i>self</i>, QWidget <i>widget</i>)</li><li><div class="fn" />int <b><a href="qdesignercontainerextension.html#count">count</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qdesignercontainerextension.html#currentIndex">currentIndex</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignercontainerextension.html#insertWidget">insertWidget</a></b> (<i>self</i>, int <i>index</i>, QWidget <i>widget</i>)</li><li><div class="fn" /><b><a href="qdesignercontainerextension.html#remove">remove</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" /><b><a href="qdesignercontainerextension.html#setCurrentIndex">setCurrentIndex</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />QWidget <b><a href="qdesignercontainerextension.html#widget">widget</a></b> (<i>self</i>, int <i>index</i>)</li></ul><h3>Special Methods</h3><ul><li><div class="fn" /> <b><a href="qdesignercontainerextension.html#__len__">__len__</a></b> (<i>self</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QDesignerContainerExtension class allows you to add pages to
a custom multi-page container in Qt Designer's workspace.</p>
<p>QDesignerContainerExtension provide an interface for creating
custom container extensions. A container extension consists of a
collection of functions that <i>Qt Designer</i> needs to manage a
multi-page container plugin, and a list of the container's
pages.</p>
<p class="centerAlign"><img src="images/containerextension-example.png" /></p>
<p><b>Warning:</b> This is <i>not</i> an extension for container
plugins in general, only custom <i>multi-page</i> containers.</p>
<p>To create a container extension, your extension class must
inherit from both <a href="qobject.html">QObject</a> and
QDesignerContainerExtension. For example:</p>
<pre class="highlightedCode brush: cpp">
class MyContainerExtension : public QObject,
public QDesignerContainerExtension
{
Q_OBJECT
Q_INTERFACES(QDesignerContainerExtension)
public:
MyContainerExtension(MyCustomWidget *widget,
QObject *parent = 0);
int count() const;
QWidget *widget(int index) const;
int currentIndex() const;
void setCurrentIndex(int index);
void addWidget(QWidget *widget);
void insertWidget(int index, QWidget *widget);
void remove(int index);
private:
MyCustomWidget *myWidget;
};
</pre>
<p>Since we are implementing an interface, we must ensure that it's
made known to the meta object system using the <a href="qobject.html#Q_INTERFACES">Q_INTERFACES</a>() macro. This enables
<i>Qt Designer</i> to use the <a href="qobject.html#qobject_cast">qobject_cast</a>() function to query
for supported interfaces using nothing but a <a href="qobject.html">QObject</a> pointer.</p>
<p>You must reimplement several functions to enable <i>Qt
Designer</i> to manage a custom multi-page container widget: <i>Qt
Designer</i> uses <a href="qdesignercontainerextension.html#count">count</a>() to keep track
of the number pages in your container, <a href="qdesignercontainerextension.html#widget">widget</a>() to return
the page at a given index in the list of the container's pages, and
<a href="qdesignercontainerextension.html#currentIndex">currentIndex</a>()
to return the list index of the selected page. <i>Qt Designer</i>
uses the <a href="qdesignercontainerextension.html#addWidget">addWidget</a>()
function to add a given page to the container, expecting it to be
appended to the list of pages, while it expects the <a href="qdesignercontainerextension.html#insertWidget">insertWidget</a>()
function to add a given page to the container by inserting it at a
given index.</p>
<p>In <i>Qt Designer</i> the extensions are not created until they
are required. For that reason you must also create a <a href="qextensionfactory.html">QExtensionFactory</a>, i.e a class that is
able to make an instance of your extension, and register it using
<i>Qt Designer</i>'s <a href="qextensionmanager.html">extension
manager</a>.</p>
<p>When a container extension is required, <i>Qt Designer</i>'s
<a href="qextensionmanager.html">extension manager</a> will run
through all its registered factories calling <a href="qextensionfactory.html#createExtension">QExtensionFactory.createExtension</a>()
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.</p>
<p>There are four available types of extensions in <i>Qt
Designer</i>: QDesignerContainerExtension , <a href="qdesignermembersheetextension.html">QDesignerMemberSheetExtension</a>,
<a href="qdesignerpropertysheetextension.html">QDesignerPropertySheetExtension</a>
and <a href="qdesignertaskmenuextension.html">QDesignerTaskMenuExtension</a>.
<i>Qt Designer</i>'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.</p>
<p>The <a href="qextensionfactory.html">QExtensionFactory</a> class
provides a standard extension factory, and can also be used as an
interface for custom extension factories. You can either create a
new <a href="qextensionfactory.html">QExtensionFactory</a> and
reimplement the <a href="qextensionfactory.html#createExtension">QExtensionFactory.createExtension</a>()
function. For example:</p>
<pre class="highlightedCode brush: cpp">
QObject *ANewExtensionFactory.createExtension(QObject *object,
const QString &iid, QObject *parent) const
{
if (iid != Q_TYPEID(QDesignerContainerExtension))
return 0;
if (MyCustomWidget *widget = qobject_cast<MyCustomWidget*>
(object))
return new MyContainerExtension(widget, parent);
return 0;
}
</pre>
<p>Or you can use an existing factory, expanding the <a href="qextensionfactory.html#createExtension">QExtensionFactory.createExtension</a>()
function to make the factory able to create a container extension
as well. For example:</p>
<pre class="highlightedCode brush: cpp">
QObject *AGeneralExtensionFactory.createExtension(QObject *object,
const QString &iid, QObject *parent) const
{
MyCustomWidget *widget = qobject_cast<MyCustomWidget*>(object);
if (widget && (iid == Q_TYPEID(QDesignerTaskMenuExtension))) {
return new MyTaskMenuExtension(widget, parent);
} else if (widget && (iid == Q_TYPEID(QDesignerContainerExtension))) {
return new MyContainerExtension(widget, parent);
} else {
return 0;
}
}
</pre>
<p>For a complete example using the QDesignerContainerExtension
class, see the <a href="designer-containerextension.html">Container
Extension example</a>. The example shows how to create a custom
multi-page plugin for <i>Qt Designer</i>.</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QDesignerContainerExtension" />QDesignerContainerExtension.__init__ (<i>self</i>)</h3><h3 class="fn"><a name="QDesignerContainerExtension-2" />QDesignerContainerExtension.__init__ (<i>self</i>, <a href="qdesignercontainerextension.html">QDesignerContainerExtension</a>)</h3><h3 class="fn"><a name="addWidget" />QDesignerContainerExtension.addWidget (<i>self</i>, <a href="qwidget.html">QWidget</a> <i>widget</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Adds the given <i>page</i> to the container by appending it to
the extension's list of pages.</p>
<p>See also <a href="qdesignercontainerextension.html#insertWidget">insertWidget</a>(),
<a href="qdesignercontainerextension.html#remove">remove</a>(), and
<a href="qdesignercontainerextension.html#widget">widget</a>().</p>
<h3 class="fn"><a name="count" />int QDesignerContainerExtension.count (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the number of pages in the container.</p>
<h3 class="fn"><a name="currentIndex" />int QDesignerContainerExtension.currentIndex (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the index of the currently selected page in the
container.</p>
<p>See also <a href="qdesignercontainerextension.html#setCurrentIndex">setCurrentIndex</a>().</p>
<h3 class="fn"><a name="insertWidget" />QDesignerContainerExtension.insertWidget (<i>self</i>, int <i>index</i>, <a href="qwidget.html">QWidget</a> <i>widget</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Adds the given <i>page</i> to the container by inserting it at
the given <i>index</i> in the extension's list of pages.</p>
<p>See also <a href="qdesignercontainerextension.html#addWidget">addWidget</a>(),
<a href="qdesignercontainerextension.html#remove">remove</a>(), and
<a href="qdesignercontainerextension.html#widget">widget</a>().</p>
<h3 class="fn"><a name="remove" />QDesignerContainerExtension.remove (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Removes the page at the given <i>index</i> from the extension's
list of pages.</p>
<p>See also <a href="qdesignercontainerextension.html#addWidget">addWidget</a>() and
<a href="qdesignercontainerextension.html#insertWidget">insertWidget</a>().</p>
<h3 class="fn"><a name="setCurrentIndex" />QDesignerContainerExtension.setCurrentIndex (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the currently selected page in the container to be the page
at the given <i>index</i> in the extension's list of pages.</p>
<p>See also <a href="qdesignercontainerextension.html#currentIndex">currentIndex</a>().</p>
<h3 class="fn"><a name="widget" /><a href="qwidget.html">QWidget</a> QDesignerContainerExtension.widget (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the page at the given <i>index</i> in the extension's
list of pages.</p>
<p>See also <a href="qdesignercontainerextension.html#addWidget">addWidget</a>() and
<a href="qdesignercontainerextension.html#insertWidget">insertWidget</a>().</p>
<h3 class="fn"><a name="__len__" /> QDesignerContainerExtension.__len__ (<i>self</i>)</h3><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.8.3 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2011</td><td align="right" width="25%">Qt 4.7.1</td></tr></table></div></address></body></html>
