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
|
<?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" />
<!-- default_extensionfactory.cpp -->
<title>Qt 4.8: QExtensionFactory Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<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>QExtensionFactory</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="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QExtensionFactory Class Reference</h1>
<!-- $$$QExtensionFactory-brief -->
<p>The QExtensionFactory class allows you to create a factory that is able to make instances of custom extensions in Qt Designer. <a href="#details">More...</a></p>
<!-- @@@QExtensionFactory -->
<pre class="cpp"> <span class="preprocessor">#include <QExtensionFactory></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a> and <a href="qabstractextensionfactory.html">QAbstractExtensionFactory</a>.</p>
<ul>
<li><a href="qextensionfactory-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"> </td><td class="memItemRight bottomAlign"><b><a href="qextensionfactory.html#QExtensionFactory">QExtensionFactory</a></b> ( QExtensionManager * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QExtensionManager * </td><td class="memItemRight bottomAlign"><b><a href="qextensionfactory.html#extensionManager">extensionManager</a></b> () const</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QObject * </td><td class="memItemRight bottomAlign"><b><a href="qextensionfactory.html#extension">extension</a></b> ( QObject * <i>object</i>, const QString & <i>iid</i> ) const</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">1 public function inherited from <a href="qabstractextensionfactory.html#public-functions">QAbstractExtensionFactory</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QObject * </td><td class="memItemRight bottomAlign"><b><a href="qextensionfactory.html#createExtension">createExtension</a></b> ( QObject * <i>object</i>, const QString & <i>iid</i>, QObject * <i>parent</i> ) const</td></tr>
</table>
<ul>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QExtensionFactory-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QExtensionFactory class allows you to create a factory that is able to make instances of custom extensions in Qt Designer.</p>
<p>In <i>Qt Designer</i> the extensions are not created until they are required. For that reason, when implementing a custom extension, you must also create a QExtensionFactory, 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>The <a href="qextensionmanager.html">QExtensionManager</a> class provides extension management facilities for Qt Designer. When an extension is required, Qt Designer'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 requested extension for the selected object, is found. This factory will then make an instance of the extension.</p>
<p>There are four available types of extensions in Qt Designer: <a href="qdesignercontainerextension.html">QDesignerContainerExtension</a> , <a href="qdesignermembersheetextension.html">QDesignerMemberSheetExtension</a>, <a href="qdesignerpropertysheetextension.html">QDesignerPropertySheetExtension</a> and <a href="qdesignertaskmenuextension.html">QDesignerTaskMenuExtension</a>. Qt Designer'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>You can either create a new QExtensionFactory 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><a href="qextensionfactory.html#createExtension">createExtension</a>(<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"><a href="qdesignercontainerextension.html">QDesignerContainerExtension</a></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 your 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><a href="qextensionfactory.html#createExtension">createExtension</a>(<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"><a href="qdesignercontainerextension.html">QDesignerContainerExtension</a></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 QExtensionFactory class, see the <a href="designer-taskmenuextension.html">Task Menu Extension example</a>. The example shows how to create a custom widget plugin for Qt Designer, and how to to use the <a href="qdesignertaskmenuextension.html">QDesignerTaskMenuExtension</a> class to add custom items to Qt Designer's task menu.</p>
</div>
<p><b>See also </b><a href="qextensionmanager.html">QExtensionManager</a> and <a href="qabstractextensionfactory.html">QAbstractExtensionFactory</a>.</p>
<!-- @@@QExtensionFactory -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QExtensionFactory[overload1]$$$QExtensionFactoryQExtensionManager* -->
<h3 class="fn"><a name="QExtensionFactory"></a>QExtensionFactory::<span class="name">QExtensionFactory</span> ( <span class="type"><a href="qextensionmanager.html">QExtensionManager</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs an extension factory with the given <i>parent</i>.</p>
<!-- @@@QExtensionFactory -->
<!-- $$$createExtension[overload1]$$$createExtensionQObject*constQString&QObject* -->
<h3 class="fn"><a name="createExtension"></a><span class="type"><a href="qobject.html">QObject</a></span> * QExtensionFactory::<span class="name">createExtension</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>object</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>iid</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> ) const<tt> [virtual protected]</tt></h3>
<p>Creates an extension specified by <i>iid</i> for the given <i>object</i>. The extension object is created as a child of the specified <i>parent</i>.</p>
<p><b>See also </b><a href="qextensionfactory.html#extension">extension</a>().</p>
<!-- @@@createExtension -->
<!-- $$$extension[overload1]$$$extensionQObject*constQString& -->
<h3 class="fn"><a name="extension"></a><span class="type"><a href="qobject.html">QObject</a></span> * QExtensionFactory::<span class="name">extension</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>object</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>iid</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qabstractextensionfactory.html#extension">QAbstractExtensionFactory::extension</a>().</p>
<p>Returns the extension specified by <i>iid</i> for the given <i>object</i>.</p>
<p><b>See also </b><a href="qextensionfactory.html#createExtension">createExtension</a>().</p>
<!-- @@@extension -->
<!-- $$$extensionManager[overload1]$$$extensionManager -->
<h3 class="fn"><a name="extensionManager"></a><span class="type"><a href="qextensionmanager.html">QExtensionManager</a></span> * QExtensionFactory::<span class="name">extensionManager</span> () const</h3>
<p>Returns the extension manager for the extension factory.</p>
<!-- @@@extensionManager -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation 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>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
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>
</body>
</html>
|
