<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- container.qdoc -->
<title>Qt 4.8: QDesignerContainerExtension Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtdesigner.html">QtDesigner</a></li>
<li>QDesignerContainerExtension</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDesignerContainerExtension Class Reference</h1>
<!-- $$$QDesignerContainerExtension-brief -->
<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>
<!-- @@@QDesignerContainerExtension -->
<pre class="cpp"> <span class="preprocessor">#include <QDesignerContainerExtension></span></pre><ul>
<li><a href="qdesignercontainerextension-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#dtor.QDesignerContainerExtension">~QDesignerContainerExtension</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#addWidget">addWidget</a></b> ( QWidget * <i>page</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#count">count</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#currentIndex">currentIndex</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#insertWidget">insertWidget</a></b> ( int <i>index</i>, QWidget * <i>page</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#remove">remove</a></b> ( int <i>index</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#setCurrentIndex">setCurrentIndex</a></b> ( int <i>index</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QWidget * </td><td class="memItemRight bottomAlign"><b><a href="qdesignercontainerextension.html#widget">widget</a></b> ( int <i>index</i> ) const = 0</td></tr>
</table>
<a name="details"></a>
<!-- $$$QDesignerContainerExtension-description -->
<div class="descr">
<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" alt="" /></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="cpp"> <span class="keyword">class</span> MyContainerExtension : <span class="keyword">public</span> <span class="type"><a href="qobject.html">QObject</a></span><span class="operator">,</span>
<span class="keyword">public</span> <span class="type">QDesignerContainerExtension</span>
{
Q_OBJECT
Q_INTERFACES(<span class="type">QDesignerContainerExtension</span>)
<span class="keyword">public</span>:
MyContainerExtension(MyCustomWidget <span class="operator">*</span>widget<span class="operator">,</span>
<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
<span class="type">int</span> count() <span class="keyword">const</span>;
<span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>widget(<span class="type">int</span> index) <span class="keyword">const</span>;
<span class="type">int</span> currentIndex() <span class="keyword">const</span>;
<span class="type">void</span> setCurrentIndex(<span class="type">int</span> index);
<span class="type">void</span> addWidget(<span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>widget);
<span class="type">void</span> insertWidget(<span class="type">int</span> index<span class="operator">,</span> <span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>widget);
<span class="type">void</span> remove(<span class="type">int</span> index);
<span class="keyword">private</span>:
MyCustomWidget <span class="operator">*</span>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="cpp"> <span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>ANewExtensionFactory<span class="operator">::</span>createExtension(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>object<span class="operator">,</span>
<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>iid<span class="operator">,</span> <span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>parent) <span class="keyword">const</span>
{
<span class="keyword">if</span> (iid <span class="operator">!</span><span class="operator">=</span> Q_TYPEID(<span class="type">QDesignerContainerExtension</span>))
<span class="keyword">return</span> <span class="number">0</span>;
<span class="keyword">if</span> (MyCustomWidget <span class="operator">*</span>widget <span class="operator">=</span> qobject_cast<span class="operator"><</span>MyCustomWidget<span class="operator">*</span><span class="operator">></span>
(object))
<span class="keyword">return</span> <span class="keyword">new</span> MyContainerExtension(widget<span class="operator">,</span> parent);
<span class="keyword">return</span> <span class="number">0</span>;
}</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="cpp"> <span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>AGeneralExtensionFactory<span class="operator">::</span>createExtension(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>object<span class="operator">,</span>
<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>iid<span class="operator">,</span> <span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>parent) <span class="keyword">const</span>
{
MyCustomWidget <span class="operator">*</span>widget <span class="operator">=</span> qobject_cast<span class="operator"><</span>MyCustomWidget<span class="operator">*</span><span class="operator">></span>(object);
<span class="keyword">if</span> (widget <span class="operator">&</span><span class="operator">&</span> (iid <span class="operator">=</span><span class="operator">=</span> Q_TYPEID(<span class="type"><a href="qdesignertaskmenuextension.html">QDesignerTaskMenuExtension</a></span>))) {
<span class="keyword">return</span> <span class="keyword">new</span> MyTaskMenuExtension(widget<span class="operator">,</span> parent);
} <span class="keyword">else</span> <span class="keyword">if</span> (widget <span class="operator">&</span><span class="operator">&</span> (iid <span class="operator">=</span><span class="operator">=</span> Q_TYPEID(<span class="type">QDesignerContainerExtension</span>))) {
<span class="keyword">return</span> <span class="keyword">new</span> MyContainerExtension(widget<span class="operator">,</span> parent);
} <span class="keyword">else</span> {
<span class="keyword">return</span> <span class="number">0</span>;
}
}</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>
</div>
<p><b>See also </b><a href="qextensionfactory.html">QExtensionFactory</a>, <a href="qextensionmanager.html">QExtensionManager</a>, and <a href="designer-creating-custom-widgets-extensions.html">Creating Custom Widget Extensions</a>.</p>
<!-- @@@QDesignerContainerExtension -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QDesignerContainerExtension[overload1]$$$~QDesignerContainerExtension -->
<h3 class="fn"><a name="dtor.QDesignerContainerExtension"></a>QDesignerContainerExtension::<span class="name">~QDesignerContainerExtension</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the extension.</p>
<!-- @@@~QDesignerContainerExtension -->
<!-- $$$addWidget[overload1]$$$addWidgetQWidget* -->
<h3 class="fn"><a name="addWidget"></a><span class="type">void</span> QDesignerContainerExtension::<span class="name">addWidget</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i> )<tt> [pure virtual]</tt></h3>
<p>Adds the given <i>page</i> to the container by appending it to the extension's list of pages.</p>
<p><b>See also </b><a href="qdesignercontainerextension.html#insertWidget">insertWidget</a>(), <a href="qdesignercontainerextension.html#remove">remove</a>(), and <a href="qdesignercontainerextension.html#widget">widget</a>().</p>
<!-- @@@addWidget -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type">int</span> QDesignerContainerExtension::<span class="name">count</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the number of pages in the container.</p>
<!-- @@@count -->
<!-- $$$currentIndex[overload1]$$$currentIndex -->
<h3 class="fn"><a name="currentIndex"></a><span class="type">int</span> QDesignerContainerExtension::<span class="name">currentIndex</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the index of the currently selected page in the container.</p>
<p><b>See also </b><a href="qdesignercontainerextension.html#setCurrentIndex">setCurrentIndex</a>().</p>
<!-- @@@currentIndex -->
<!-- $$$insertWidget[overload1]$$$insertWidgetintQWidget* -->
<h3 class="fn"><a name="insertWidget"></a><span class="type">void</span> QDesignerContainerExtension::<span class="name">insertWidget</span> ( <span class="type">int</span> <i>index</i>, <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i> )<tt> [pure virtual]</tt></h3>
<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><b>See also </b><a href="qdesignercontainerextension.html#addWidget">addWidget</a>(), <a href="qdesignercontainerextension.html#remove">remove</a>(), and <a href="qdesignercontainerextension.html#widget">widget</a>().</p>
<!-- @@@insertWidget -->
<!-- $$$remove[overload1]$$$removeint -->
<h3 class="fn"><a name="remove"></a><span class="type">void</span> QDesignerContainerExtension::<span class="name">remove</span> ( <span class="type">int</span> <i>index</i> )<tt> [pure virtual]</tt></h3>
<p>Removes the page at the given <i>index</i> from the extension's list of pages.</p>
<p><b>See also </b><a href="qdesignercontainerextension.html#addWidget">addWidget</a>() and <a href="qdesignercontainerextension.html#insertWidget">insertWidget</a>().</p>
<!-- @@@remove -->
<!-- $$$setCurrentIndex[overload1]$$$setCurrentIndexint -->
<h3 class="fn"><a name="setCurrentIndex"></a><span class="type">void</span> QDesignerContainerExtension::<span class="name">setCurrentIndex</span> ( <span class="type">int</span> <i>index</i> )<tt> [pure virtual]</tt></h3>
<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><b>See also </b><a href="qdesignercontainerextension.html#currentIndex">currentIndex</a>().</p>
<!-- @@@setCurrentIndex -->
<!-- $$$widget[overload1]$$$widgetint -->
<h3 class="fn"><a name="widget"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * QDesignerContainerExtension::<span class="name">widget</span> ( <span class="type">int</span> <i>index</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the page at the given <i>index</i> in the extension's list of pages.</p>
<p><b>See also </b><a href="qdesignercontainerextension.html#addWidget">addWidget</a>() and <a href="qdesignercontainerextension.html#insertWidget">insertWidget</a>().</p>
<!-- @@@widget -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
