/usr/share/qt5/doc/qtdesigner/qdesignercustomwidgetinterface.html is in qttools5-doc-html 5.2.1-8build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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>QDesignerCustomWidgetInterface Class | QtDesigner </title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtdesigner-manual.html">Qt Designer Manual</a></li>
<li><a href="qtdesigner-module.html">C++ Classes</a></li>
<li>QDesignerCustomWidgetInterface</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<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</h1>
<!-- $$$QDesignerCustomWidgetInterface-brief -->
<p>The QDesignerCustomWidgetInterface class enables Qt Designer to access and construct custom widgets. <a href="#details">More...</a></p>
<!-- @@@QDesignerCustomWidgetInterface -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QDesignerCustomWidgetInterface></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += designer</tt></td></tr></table><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="qtdesigner-customwidgetplugin-example.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="../qtcore/qobject.html">QObject</a></span><span class="operator">,</span> <span class="keyword">public</span> <span class="type">QDesignerCustomWidgetInterface</span>
{
Q_OBJECT
Q_PLUGIN_METADATA(IID <span class="string">"org.qt-project.Qt.QDesignerCustomWidgetInterface"</span> FILE <span class="string">"analogclock.json"</span>)
Q_INTERFACES(<span class="type">QDesignerCustomWidgetInterface</span>)
<span class="keyword">public</span>:
AnalogClockPlugin(<span class="type"><a href="../qtcore/qobject.html">QObject</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
bool isContainer() <span class="keyword">const</span>;
bool isInitialized() <span class="keyword">const</span>;
<span class="type">QIcon</span> icon() <span class="keyword">const</span>;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> domXml() <span class="keyword">const</span>;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> group() <span class="keyword">const</span>;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> includeFile() <span class="keyword">const</span>;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> name() <span class="keyword">const</span>;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> toolTip() <span class="keyword">const</span>;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> whatsThis() <span class="keyword">const</span>;
<span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span> <span class="operator">*</span>createWidget(<span class="type"><a href="../qtwidgets/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>:
bool 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="../qtcore/qobject.html#Q_INTERFACES">Q_INTERFACES</a>() macro. This enables <i>Qt Designer</i> to use the <a href="../qtcore/qobject.html#qobject_cast">qobject_cast</a>() function to query for supported interfaces using nothing but a <a href="../qtcore/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>Exporting your custom widget plugin to <i>Qt Designer</i> using the <a href="../qtcore/qtplugin.html#Q_PLUGIN_METADATA">Q_PLUGIN_METADATA</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 header:</p>
<pre class="cpp"><a href="../qtcore/qtplugin.html#Q_PLUGIN_METADATA">Q_PLUGIN_METADATA</a>(IID <span class="string">"org.qt-project.Qt.QDesignerCustomWidgetInterface"</span>)</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="../qtcore/qvariant.html">QVariant</a> properties, be aware that only the following <a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">types</a> are supported:</p>
<ul>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::ByteArray</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Bool</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Color</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Cursor</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Date</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::DateTime</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Double</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Int</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Point</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Rect</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Size</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::SizePolicy</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::String</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::Time</a></li>
<li><a href="../qtcore/qvariant-obsolete.html#Type-enum" class="obsolete">QVariant::UInt</a></li>
</ul>
<p>For a complete example using the QDesignerCustomWidgetInterface class, see the <a href="qtdesigner-customwidgetplugin-example.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="../qtcore/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="../qtwidgets/qwidget.html">QWidget</a></span> * QDesignerCustomWidgetInterface::<span class="name">createWidget</span>(<span class="type"><a href="../qtwidgets/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="../qtcore/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="../qtcore/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">QIcon</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="../qtcore/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 uic 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="../qtcore/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="../qtcore/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="../qtcore/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="qtdesigner-worldtimeclockplugin-example.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="../qtwidgets/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>
</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.<br> 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.<br> 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. </p>
</div>
</body>
</html>
|