<?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" />
<!-- customwidget.qdoc -->
<title>Qt 4.8: QDesignerCustomWidgetInterface 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>QDesignerCustomWidgetInterface</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="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDesignerCustomWidgetInterface Class Reference</h1>
<!-- $$$QDesignerCustomWidgetInterface-brief -->
<p>The QDesignerCustomWidgetInterface class enables Qt Designer to access and construct custom widgets. <a href="#details">More...</a></p>
<!-- @@@QDesignerCustomWidgetInterface -->
<pre class="cpp"> <span class="preprocessor">#include <QDesignerCustomWidgetInterface></span></pre><ul>
<li><a href="qdesignercustomwidgetinterface-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="qdesignercustomwidgetinterface.html#dtor.QDesignerCustomWidgetInterface">~QDesignerCustomWidgetInterface</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#codeTemplate">codeTemplate</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QWidget * </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#createWidget">createWidget</a></b> ( QWidget * <i>parent</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#domXml">domXml</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#group">group</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QIcon </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#icon">icon</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#includeFile">includeFile</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#initialize">initialize</a></b> ( QDesignerFormEditorInterface * <i>formEditor</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#isContainer">isContainer</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#isInitialized">isInitialized</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#name">name</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#toolTip">toolTip</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#whatsThis">whatsThis</a></b> () const = 0</td></tr>
</table>
<a name="macros"></a>
<h2>Macros</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdesignercustomwidgetinterface.html#QDESIGNER_WIDGET_EXPORT">QDESIGNER_WIDGET_EXPORT</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QDesignerCustomWidgetInterface-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDesignerCustomWidgetInterface class enables Qt Designer to access and construct custom widgets.</p>
<p>QDesignerCustomWidgetInterface provides a custom widget with an interface. The class contains a set of functions that must be subclassed to return basic information about the widget, such as its class name and the name of its header file. Other functions must be implemented to initialize the plugin when it is loaded, and to construct instances of the custom widget for <i>Qt Designer</i> to use.</p>
<p>When implementing a custom widget you must subclass QDesignerCustomWidgetInterface to expose your widget to <i>Qt Designer</i>. For example, this is the declaration for the plugin used in the <a href="designer-customwidgetplugin.html">Custom Widget Plugin example</a> that enables an analog clock custom widget to be used by <i>Qt Designer</i>:</p>
<pre class="cpp"> <span class="keyword">class</span> AnalogClockPlugin : <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">QDesignerCustomWidgetInterface</span>
{
Q_OBJECT
Q_INTERFACES(<span class="type">QDesignerCustomWidgetInterface</span>)
<span class="keyword">public</span>:
AnalogClockPlugin(<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">bool</span> isContainer() <span class="keyword">const</span>;
<span class="type">bool</span> isInitialized() <span class="keyword">const</span>;
<span class="type"><a href="qicon.html">QIcon</a></span> icon() <span class="keyword">const</span>;
<span class="type"><a href="qstring.html">QString</a></span> domXml() <span class="keyword">const</span>;
<span class="type"><a href="qstring.html">QString</a></span> group() <span class="keyword">const</span>;
<span class="type"><a href="qstring.html">QString</a></span> includeFile() <span class="keyword">const</span>;
<span class="type"><a href="qstring.html">QString</a></span> name() <span class="keyword">const</span>;
<span class="type"><a href="qstring.html">QString</a></span> toolTip() <span class="keyword">const</span>;
<span class="type"><a href="qstring.html">QString</a></span> whatsThis() <span class="keyword">const</span>;
<span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>createWidget(<span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>parent);
<span class="type">void</span> initialize(<span class="type"><a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a></span> <span class="operator">*</span>core);
<span class="keyword">private</span>:
<span class="type">bool</span> initialized;
};</pre>
<p>Note that the only part of the class definition that is specific to this particular custom widget is the class name. In addition, 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>After <i>Qt Designer</i> loads a custom widget plugin, it calls the interface's <a href="qdesignercustomwidgetinterface.html#initialize">initialize</a>() function to enable it to set up any resources that it may need. This function is called with a <a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a> parameter that provides the plugin with a gateway to all of <i>Qt Designer</i>'s API.</p>
<p><i>Qt Designer</i> constructs instances of the custom widget by calling the plugin's <a href="qdesignercustomwidgetinterface.html#createWidget">createWidget</a>() function with a suitable parent widget. Plugins must construct and return an instance of a custom widget with the specified parent widget.</p>
<p>In the implementation of the class you must remember to export your custom widget plugin to <i>Qt Designer</i> using the <a href="qtplugin.html#Q_EXPORT_PLUGIN2">Q_EXPORT_PLUGIN2</a>() macro. For example, if a library called <tt>libcustomwidgetplugin.so</tt> (on Unix) or <tt>libcustomwidget.dll</tt> (on Windows) contains a widget class called <tt>MyCustomWidget</tt>, we can export it by adding the following line to the file containing the plugin implementation:</p>
<pre class="cpp"> <a href="qtplugin.html#Q_EXPORT_PLUGIN2">Q_EXPORT_PLUGIN2</a>(customwidgetplugin<span class="operator">,</span> MyCustomWidget)</pre>
<p>This macro ensures that <i>Qt Designer</i> can access and construct the custom widget. Without this macro, there is no way for <i>Qt Designer</i> to use it.</p>
<p>When implementing a custom widget plugin, you build it as a separate library. If you want to include several custom widget plugins in the same library, you must in addition subclass <a href="qdesignercustomwidgetcollectioninterface.html">QDesignerCustomWidgetCollectionInterface</a>.</p>
<p><b>Warning:</b> If your custom widget plugin contains <a href="qvariant.html">QVariant</a> properties, be aware that only the following <a href="qvariant.html#Type-enum">types</a> are supported:</p>
<ul>
<li><a href="qvariant.html#Type-enum">QVariant::ByteArray</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Bool</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Color</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Cursor</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Date</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::DateTime</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Double</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Int</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Point</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Rect</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Size</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::SizePolicy</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::String</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::Time</a></li>
<li><a href="qvariant.html#Type-enum">QVariant::UInt</a></li>
</ul>
<p>For a complete example using the QDesignerCustomWidgetInterface class, see the <a href="designer-customwidgetplugin.html">Custom Widget Example</a>. The example shows how to create a custom widget plugin for <i>Qt Designer</i>.</p>
</div>
<p><b>See also </b><a href="qdesignercustomwidgetcollectioninterface.html">QDesignerCustomWidgetCollectionInterface</a> and <a href="designer-creating-custom-widgets.html">Creating Custom Widgets for Qt Designer</a>.</p>
<!-- @@@QDesignerCustomWidgetInterface -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QDesignerCustomWidgetInterface[overload1]$$$~QDesignerCustomWidgetInterface -->
<h3 class="fn"><a name="dtor.QDesignerCustomWidgetInterface"></a>QDesignerCustomWidgetInterface::<span class="name">~QDesignerCustomWidgetInterface</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the custom widget interface.</p>
<!-- @@@~QDesignerCustomWidgetInterface -->
<!-- $$$codeTemplate[overload1]$$$codeTemplate -->
<h3 class="fn"><a name="codeTemplate"></a><span class="type"><a href="qstring.html">QString</a></span> QDesignerCustomWidgetInterface::<span class="name">codeTemplate</span> () const<tt> [virtual]</tt></h3>
<p>This function is reserved for future use by <i>Qt Designer</i>.</p>
<!-- @@@codeTemplate -->
<!-- $$$createWidget[overload1]$$$createWidgetQWidget* -->
<h3 class="fn"><a name="createWidget"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * QDesignerCustomWidgetInterface::<span class="name">createWidget</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i> )<tt> [pure virtual]</tt></h3>
<p>Returns a new instance of the custom widget, with the given <i>parent</i>.</p>
<!-- @@@createWidget -->
<!-- $$$domXml[overload1]$$$domXml -->
<h3 class="fn"><a name="domXml"></a><span class="type"><a href="qstring.html">QString</a></span> QDesignerCustomWidgetInterface::<span class="name">domXml</span> () const<tt> [virtual]</tt></h3>
<p>Returns the XML that is used to describe the custom widget's properties to <i>Qt Designer</i>.</p>
<!-- @@@domXml -->
<!-- $$$group[overload1]$$$group -->
<h3 class="fn"><a name="group"></a><span class="type"><a href="qstring.html">QString</a></span> QDesignerCustomWidgetInterface::<span class="name">group</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the name of the group to which the custom widget belongs.</p>
<!-- @@@group -->
<!-- $$$icon[overload1]$$$icon -->
<h3 class="fn"><a name="icon"></a><span class="type"><a href="qicon.html">QIcon</a></span> QDesignerCustomWidgetInterface::<span class="name">icon</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the icon used to represent the custom widget in <i>Qt Designer</i>'s widget box.</p>
<!-- @@@icon -->
<!-- $$$includeFile[overload1]$$$includeFile -->
<h3 class="fn"><a name="includeFile"></a><span class="type"><a href="qstring.html">QString</a></span> QDesignerCustomWidgetInterface::<span class="name">includeFile</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the path to the include file that <a href="uic.html#uic">uic</a> uses when creating code for the custom widget.</p>
<!-- @@@includeFile -->
<!-- $$$initialize[overload1]$$$initializeQDesignerFormEditorInterface* -->
<h3 class="fn"><a name="initialize"></a><span class="type">void</span> QDesignerCustomWidgetInterface::<span class="name">initialize</span> ( <span class="type"><a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a></span> * <i>formEditor</i> )<tt> [virtual]</tt></h3>
<p>Initializes the widget for use with the specified <i>formEditor</i> interface.</p>
<p><b>See also </b><a href="qdesignercustomwidgetinterface.html#isInitialized">isInitialized</a>().</p>
<!-- @@@initialize -->
<!-- $$$isContainer[overload1]$$$isContainer -->
<h3 class="fn"><a name="isContainer"></a><span class="type">bool</span> QDesignerCustomWidgetInterface::<span class="name">isContainer</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns true if the custom widget is intended to be used as a container; otherwise returns false.</p>
<p>Most custom widgets are not used to hold other widgets, so their implementations of this function will return false, but custom containers will return true to ensure that they behave correctly in <i>Qt Designer</i>.</p>
<!-- @@@isContainer -->
<!-- $$$isInitialized[overload1]$$$isInitialized -->
<h3 class="fn"><a name="isInitialized"></a><span class="type">bool</span> QDesignerCustomWidgetInterface::<span class="name">isInitialized</span> () const<tt> [virtual]</tt></h3>
<p>Returns true if the widget has been initialized; otherwise returns false.</p>
<p><b>See also </b><a href="qdesignercustomwidgetinterface.html#initialize">initialize</a>().</p>
<!-- @@@isInitialized -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a><span class="type"><a href="qstring.html">QString</a></span> QDesignerCustomWidgetInterface::<span class="name">name</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the class name of the custom widget supplied by the interface.</p>
<p>The name returned <i>must</i> be identical to the class name used for the custom widget.</p>
<!-- @@@name -->
<!-- $$$toolTip[overload1]$$$toolTip -->
<h3 class="fn"><a name="toolTip"></a><span class="type"><a href="qstring.html">QString</a></span> QDesignerCustomWidgetInterface::<span class="name">toolTip</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns a short description of the widget that can be used by <i>Qt Designer</i> in a tool tip.</p>
<!-- @@@toolTip -->
<!-- $$$whatsThis[overload1]$$$whatsThis -->
<h3 class="fn"><a name="whatsThis"></a><span class="type"><a href="qstring.html">QString</a></span> QDesignerCustomWidgetInterface::<span class="name">whatsThis</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns a description of the widget that can be used by <i>Qt Designer</i> in "What's This?" help for the widget.</p>
<!-- @@@whatsThis -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QDESIGNER_WIDGET_EXPORT[overload1]$$$QDESIGNER_WIDGET_EXPORT -->
<h3 class="fn"><a name="QDESIGNER_WIDGET_EXPORT"></a><span class="name">QDESIGNER_WIDGET_EXPORT</span></h3>
<p>This macro is used when defining custom widgets to ensure that they are correctly exported from plugins for use with <i>Qt Designer</i>.</p>
<p>On some platforms, the symbols required by <i>Qt Designer</i> to create new widgets are removed from plugins by the build system, making them unusable. Using this macro ensures that the symbols are retained on those platforms, and has no side effects on other platforms.</p>
<p>For example, the <a href="designer-worldtimeclockplugin.html">World Time Clock Plugin</a> example exports a custom widget class with the following declaration:</p>
<pre class="cpp"> <span class="keyword">class</span> QDESIGNER_WIDGET_EXPORT WorldTimeClock : <span class="keyword">public</span> <span class="type"><a href="qwidget.html">QWidget</a></span>
{
Q_OBJECT
...
};</pre>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="designer-creating-custom-widgets.html">Creating Custom Widgets for Qt Designer</a>.</p>
<!-- @@@QDESIGNER_WIDGET_EXPORT -->
</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>
