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
215
216
217
218
219
220
221
222
223
224
225
226
227
|
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::WindowFactory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1WindowFactory.html">WindowFactory</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::WindowFactory Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::WindowFactory" -->
<p>Abstract class that defines the required interface for all <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> objects.
<a href="classCEGUI_1_1WindowFactory.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::WindowFactory:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1WindowFactory__inherit__graph.gif" border="0" usemap="#CEGUI_1_1WindowFactory_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1WindowFactory_inherit__map" id="CEGUI_1_1WindowFactory_inherit__map">
<area shape="rect" id="node3" href="classCEGUI_1_1TplWindowFactory.html" title="Template based WindowFactory that can be used to automatically generate a WindowFactory given a Windo..." alt="" coords="5,83,219,112"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::WindowFactory:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1WindowFactory__coll__graph.gif" border="0" usemap="#CEGUI_1_1WindowFactory_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1WindowFactory_coll__map" id="CEGUI_1_1WindowFactory_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="33,5,140,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1WindowFactory-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WindowFactory.html#a339b6082bbdc2ee0a56fb0378341c6a8">createWindow</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object of whatever type this <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> produces. <a href="#a339b6082bbdc2ee0a56fb0378341c6a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WindowFactory.html#a991117513408e875fc2776f305fa3b4d">destroyWindow</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> *window)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the given <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object. <a href="#a991117513408e875fc2776f305fa3b4d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WindowFactory.html#ab2cb168dc985ef374ca8660fa3604415">getTypeName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string that describes the type of <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object this <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> produces. <a href="#ab2cb168dc985ef374ca8660fa3604415"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f6fd5ad1416786a18e46555a3da9ff6"></a><!-- doxytag: member="CEGUI::WindowFactory::~WindowFactory" ref="a0f6fd5ad1416786a18e46555a3da9ff6" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WindowFactory.html#a0f6fd5ad1416786a18e46555a3da9ff6">~WindowFactory</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af75675dbe376d753ba4060e48a671b0c"></a><!-- doxytag: member="CEGUI::WindowFactory::WindowFactory" ref="af75675dbe376d753ba4060e48a671b0c" args="(const String &type)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WindowFactory.html#af75675dbe376d753ba4060e48a671b0c">WindowFactory</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abea90f5009a5064068125753058afa3d"></a><!-- doxytag: member="CEGUI::WindowFactory::d_type" ref="abea90f5009a5064068125753058afa3d" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WindowFactory.html#abea90f5009a5064068125753058afa3d">d_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> holding the type of object created by this factory. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract class that defines the required interface for all <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> objects. </p>
<p>A <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> is used to create and destroy windows of a specific type. For every type of <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object wihin the system (widgets, dialogs, movable windows etc) there must be an associated <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> registered with the <a class="el" href="classCEGUI_1_1WindowFactoryManager.html" title="Class that manages WindowFactory objects.">WindowFactoryManager</a> so that the system knows how to create and destroy those types of <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> base object.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The use if of the CEGUI_DECLARE_WINDOW_FACTORY, CEGUI_DEFINE_WINDOW_FACTORY and CEGUI_WINDOW_FACTORY macros is deprecated in favour of the template class <a class="el" href="classCEGUI_1_1TplWindowFactory.html" title="Template based WindowFactory that can be used to automatically generate a WindowFactory given a Windo...">TplWindowFactory</a> and templatised <a class="el" href="classCEGUI_1_1WindowFactoryManager.html#a02c8bb07749157557fa336df08785845" title="Adds a new WindowFactory to the list of registered factories.">WindowFactoryManager::addFactory</a> function, whereby you no longer need to directly create any supporting structure for your new window type, and can simply do: <div class="fragment"><pre class="fragment"> CEGUI::WindowFactoryManager::addFactory<TplWindowFactory<MyWidget> >();
</pre></div> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a339b6082bbdc2ee0a56fb0378341c6a8"></a><!-- doxytag: member="CEGUI::WindowFactory::createWindow" ref="a339b6082bbdc2ee0a56fb0378341c6a8" args="(const String &name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1Window.html">Window</a>* CEGUI::WindowFactory::createWindow </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object of whatever type this <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> produces. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>A unique name that is to be assigned to the newly created <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the new <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1TplWindowFactory.html#a5bd12c16beeed3d6751acc9fce8dd3ab">CEGUI::TplWindowFactory< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a991117513408e875fc2776f305fa3b4d"></a><!-- doxytag: member="CEGUI::WindowFactory::destroyWindow" ref="a991117513408e875fc2776f305fa3b4d" args="(Window *window)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::WindowFactory::destroyWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td>
<td class="paramname"><em>window</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys the given <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">window</td><td>Pointer to the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object to be destroyed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1TplWindowFactory.html#a3e8bdae70b27e1864b7b80e9c369fbd5">CEGUI::TplWindowFactory< T ></a>.</p>
</div>
</div>
<a class="anchor" id="ab2cb168dc985ef374ca8660fa3604415"></a><!-- doxytag: member="CEGUI::WindowFactory::getTypeName" ref="ab2cb168dc985ef374ca8660fa3604415" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::WindowFactory::getTypeName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the string that describes the type of <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object this <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> produces. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object that contains the unique <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object type produced by this <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> </dd></dl>
<p>Referenced by <a class="el" href="classCEGUI_1_1WindowFactoryManager.html#aba30b7195b992b7e6d0b91c4d1ea770b">CEGUI::WindowFactoryManager::addFactory()</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
