aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_element_factory.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_element_factory.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_element_factory.html329
1 files changed, 329 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_element_factory.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_element_factory.html
new file mode 100644
index 0000000..1975f4e
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_element_factory.html
@@ -0,0 +1,329 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::gui::IGUIElementFactory Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1gui_1_1_i_g_u_i_element_factory.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> </div>
89 <div class="headertitle">
90<div class="title">irr::gui::IGUIElementFactory Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::gui::IGUIElementFactory" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Interface making it possible to dynamically create GUI elements.
95 <a href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_g_u_i_element_factory_8h_source.html">IGUIElementFactory.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::gui::IGUIElementFactory:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1gui_1_1_i_g_u_i_element_factory.png" usemap="#irr::gui::IGUIElementFactory_map" alt=""/>
105 <map id="irr::gui::IGUIElementFactory_map" name="irr::gui::IGUIElementFactory_map">
106<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,165,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1gui_1_1_i_g_u_i_element_factory-members.html">List of all members.</a></p>
111<h2><a name="pub-methods"></a>
112Public Member Functions</h2>
113<ul>
114<li>virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#aaaa0dda5493286ff745310b441347019">addGUIElement</a> (<a class="el" href="namespaceirr_1_1gui.html#ae4d66df0ecf4117cdbcf9f22404bd254">EGUI_ELEMENT_TYPE</a> type, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent=0)=0
115<dl class="el"><dd class="mdescRight">adds an element to the gui environment based on its type id <a href="#aaaa0dda5493286ff745310b441347019"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#aec55be9ef891ba1b19c5d9c5a85130a4">addGUIElement</a> (const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> *typeName, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent=0)=0
116<dl class="el"><dd class="mdescRight">adds a GUI element to the GUI Environment based on its type name <a href="#aec55be9ef891ba1b19c5d9c5a85130a4"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#aae56378de5264978e70d11a36fff02e9">getCreatableGUIElementTypeCount</a> () const =0
117<dl class="el"><dd class="mdescRight">Get amount of GUI element types this factory is able to create. <a href="#aae56378de5264978e70d11a36fff02e9"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1gui.html#ae4d66df0ecf4117cdbcf9f22404bd254">EGUI_ELEMENT_TYPE</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#a9318ddb2d0d971551db4c050c3f99a2f">getCreateableGUIElementType</a> (<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> idx) const =0
118<dl class="el"><dd class="mdescRight">Get type of a createable element type. <a href="#a9318ddb2d0d971551db4c050c3f99a2f"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#aa8007c17ea40b74666c1d04c9d4de85f">getCreateableGUIElementTypeName</a> (<a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> idx) const =0
119<dl class="el"><dd class="mdescRight">Get type name of a createable GUI element type by index. <a href="#aa8007c17ea40b74666c1d04c9d4de85f"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#a1e692e1f746ee69815bf25981ee0facf">getCreateableGUIElementTypeName</a> (<a class="el" href="namespaceirr_1_1gui.html#ae4d66df0ecf4117cdbcf9f22404bd254">EGUI_ELEMENT_TYPE</a> type) const =0
120<dl class="el"><dd class="mdescRight">returns type name of a createable GUI element <a href="#a1e692e1f746ee69815bf25981ee0facf"></a><br/></dl></ul>
121<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
122<div class="textblock"><p>Interface making it possible to dynamically create GUI elements. </p>
123<p>To be able to add custom elements to Irrlicht and to make it possible for the scene manager to save and load them, simply implement this interface and register it in your gui environment via <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html#a653ac2cc8640899c23f4d55d9a5f0fdd" title="Adds an element factory to the gui environment.">IGUIEnvironment::registerGUIElementFactory</a>. Note: When implementing your own element factory, don't call <a class="el" href="classirr_1_1_i_reference_counted.html#a2b7a035532e5f409ca9482dab79185f4" title="Grabs the object. Increments the reference counter by one.">IGUIEnvironment::grab()</a> to increase the reference counter of the environment. This is not necessary because the it will <a class="el" href="classirr_1_1_i_reference_counted.html#a2b7a035532e5f409ca9482dab79185f4" title="Grabs the object. Increments the reference counter by one.">grab()</a> the factory anyway, and otherwise cyclic references will be created. </p>
124
125<p>Definition at line <a class="el" href="_i_g_u_i_element_factory_8h_source.html#l00026">26</a> of file <a class="el" href="_i_g_u_i_element_factory_8h_source.html">IGUIElementFactory.h</a>.</p>
126</div><hr/><h2>Member Function Documentation</h2>
127<a class="anchor" id="aaaa0dda5493286ff745310b441347019"></a><!-- doxytag: member="irr::gui::IGUIElementFactory::addGUIElement" ref="aaaa0dda5493286ff745310b441347019" args="(EGUI_ELEMENT_TYPE type, IGUIElement *parent=0)=0" -->
128<div class="memitem">
129<div class="memproto">
130 <table class="memname">
131 <tr>
132 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a>* irr::gui::IGUIElementFactory::addGUIElement </td>
133 <td>(</td>
134 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#ae4d66df0ecf4117cdbcf9f22404bd254">EGUI_ELEMENT_TYPE</a>&#160;</td>
135 <td class="paramname"><em>type</em>, </td>
136 </tr>
137 <tr>
138 <td class="paramkey"></td>
139 <td></td>
140 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *&#160;</td>
141 <td class="paramname"><em>parent</em> = <code>0</code>&#160;</td>
142 </tr>
143 <tr>
144 <td></td>
145 <td>)</td>
146 <td></td><td><code> [pure virtual]</code></td>
147 </tr>
148 </table>
149</div>
150<div class="memdoc">
151
152<p>adds an element to the gui environment based on its type id </p>
153<dl><dt><b>Parameters:</b></dt><dd>
154 <table class="params">
155 <tr><td class="paramname">type,:</td><td>Type of the element to add. </td></tr>
156 <tr><td class="paramname">parent,:</td><td>Parent scene node of the new element, can be null to add to the root. </td></tr>
157 </table>
158 </dd>
159</dl>
160<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the new element or null if not successful. </dd></dl>
161
162</div>
163</div>
164<a class="anchor" id="aec55be9ef891ba1b19c5d9c5a85130a4"></a><!-- doxytag: member="irr::gui::IGUIElementFactory::addGUIElement" ref="aec55be9ef891ba1b19c5d9c5a85130a4" args="(const c8 *typeName, IGUIElement *parent=0)=0" -->
165<div class="memitem">
166<div class="memproto">
167 <table class="memname">
168 <tr>
169 <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a>* irr::gui::IGUIElementFactory::addGUIElement </td>
170 <td>(</td>
171 <td class="paramtype">const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> *&#160;</td>
172 <td class="paramname"><em>typeName</em>, </td>
173 </tr>
174 <tr>
175 <td class="paramkey"></td>
176 <td></td>
177 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *&#160;</td>
178 <td class="paramname"><em>parent</em> = <code>0</code>&#160;</td>
179 </tr>
180 <tr>
181 <td></td>
182 <td>)</td>
183 <td></td><td><code> [pure virtual]</code></td>
184 </tr>
185 </table>
186</div>
187<div class="memdoc">
188
189<p>adds a GUI element to the GUI Environment based on its type name </p>
190<dl><dt><b>Parameters:</b></dt><dd>
191 <table class="params">
192 <tr><td class="paramname">typeName,:</td><td>Type name of the element to add. </td></tr>
193 <tr><td class="paramname">parent,:</td><td>Parent scene node of the new element, can be null to add it to the root. </td></tr>
194 </table>
195 </dd>
196</dl>
197<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the new element or null if not successful. </dd></dl>
198
199</div>
200</div>
201<a class="anchor" id="aae56378de5264978e70d11a36fff02e9"></a><!-- doxytag: member="irr::gui::IGUIElementFactory::getCreatableGUIElementTypeCount" ref="aae56378de5264978e70d11a36fff02e9" args="() const =0" -->
202<div class="memitem">
203<div class="memproto">
204 <table class="memname">
205 <tr>
206 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::gui::IGUIElementFactory::getCreatableGUIElementTypeCount </td>
207 <td>(</td>
208 <td class="paramname"></td><td>)</td>
209 <td> const<code> [pure virtual]</code></td>
210 </tr>
211 </table>
212</div>
213<div class="memdoc">
214
215<p>Get amount of GUI element types this factory is able to create. </p>
216
217</div>
218</div>
219<a class="anchor" id="a9318ddb2d0d971551db4c050c3f99a2f"></a><!-- doxytag: member="irr::gui::IGUIElementFactory::getCreateableGUIElementType" ref="a9318ddb2d0d971551db4c050c3f99a2f" args="(s32 idx) const =0" -->
220<div class="memitem">
221<div class="memproto">
222 <table class="memname">
223 <tr>
224 <td class="memname">virtual <a class="el" href="namespaceirr_1_1gui.html#ae4d66df0ecf4117cdbcf9f22404bd254">EGUI_ELEMENT_TYPE</a> irr::gui::IGUIElementFactory::getCreateableGUIElementType </td>
225 <td>(</td>
226 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
227 <td class="paramname"><em>idx</em></td><td>)</td>
228 <td> const<code> [pure virtual]</code></td>
229 </tr>
230 </table>
231</div>
232<div class="memdoc">
233
234<p>Get type of a createable element type. </p>
235<dl><dt><b>Parameters:</b></dt><dd>
236 <table class="params">
237 <tr><td class="paramname">idx,:</td><td>Index of the element type in this factory. Must be a value between 0 and <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#aae56378de5264978e70d11a36fff02e9" title="Get amount of GUI element types this factory is able to create.">getCreatableGUIElementTypeCount()</a> </td></tr>
238 </table>
239 </dd>
240</dl>
241
242</div>
243</div>
244<a class="anchor" id="aa8007c17ea40b74666c1d04c9d4de85f"></a><!-- doxytag: member="irr::gui::IGUIElementFactory::getCreateableGUIElementTypeName" ref="aa8007c17ea40b74666c1d04c9d4de85f" args="(s32 idx) const =0" -->
245<div class="memitem">
246<div class="memproto">
247 <table class="memname">
248 <tr>
249 <td class="memname">virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a>* irr::gui::IGUIElementFactory::getCreateableGUIElementTypeName </td>
250 <td>(</td>
251 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
252 <td class="paramname"><em>idx</em></td><td>)</td>
253 <td> const<code> [pure virtual]</code></td>
254 </tr>
255 </table>
256</div>
257<div class="memdoc">
258
259<p>Get type name of a createable GUI element type by index. </p>
260<dl><dt><b>Parameters:</b></dt><dd>
261 <table class="params">
262 <tr><td class="paramname">idx,:</td><td>Index of the type in this factory. Must be a value between 0 and <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html#aae56378de5264978e70d11a36fff02e9" title="Get amount of GUI element types this factory is able to create.">getCreatableGUIElementTypeCount()</a> </td></tr>
263 </table>
264 </dd>
265</dl>
266
267</div>
268</div>
269<a class="anchor" id="a1e692e1f746ee69815bf25981ee0facf"></a><!-- doxytag: member="irr::gui::IGUIElementFactory::getCreateableGUIElementTypeName" ref="a1e692e1f746ee69815bf25981ee0facf" args="(EGUI_ELEMENT_TYPE type) const =0" -->
270<div class="memitem">
271<div class="memproto">
272 <table class="memname">
273 <tr>
274 <td class="memname">virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a>* irr::gui::IGUIElementFactory::getCreateableGUIElementTypeName </td>
275 <td>(</td>
276 <td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#ae4d66df0ecf4117cdbcf9f22404bd254">EGUI_ELEMENT_TYPE</a>&#160;</td>
277 <td class="paramname"><em>type</em></td><td>)</td>
278 <td> const<code> [pure virtual]</code></td>
279 </tr>
280 </table>
281</div>
282<div class="memdoc">
283
284<p>returns type name of a createable GUI element </p>
285<dl><dt><b>Parameters:</b></dt><dd>
286 <table class="params">
287 <tr><td class="paramname">type,:</td><td>Type of GUI element. </td></tr>
288 </table>
289 </dd>
290</dl>
291<dl class="return"><dt><b>Returns:</b></dt><dd>Name of the type if this factory can create the type, otherwise 0. </dd></dl>
292
293</div>
294</div>
295<hr/>The documentation for this class was generated from the following file:<ul>
296<li><a class="el" href="_i_g_u_i_element_factory_8h_source.html">IGUIElementFactory.h</a></li>
297</ul>
298</div>
299</div>
300 <div id="nav-path" class="navpath">
301 <ul>
302 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
303 <li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
304 <li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element_factory.html">IGUIElementFactory</a> </li>
305<!-- window showing the filter options -->
306<div id="MSearchSelectWindow"
307 onmouseover="return searchBox.OnSearchSelectShow()"
308 onmouseout="return searchBox.OnSearchSelectHide()"
309 onkeydown="return searchBox.OnSearchSelectKey(event)">
310<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
311
312<!-- iframe showing the search results (closed by default) -->
313<div id="MSearchResultsWindow">
314<iframe src="javascript:void(0)" frameborder="0"
315 name="MSearchResults" id="MSearchResults">
316</iframe>
317</div>
318
319
320 <li class="footer">
321<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
322Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:44 for Irrlicht 3D Engine by
323<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
324 </ul>
325 </div>
326
327
328</body>
329</html>
generated by cgit v1.1 at 2024-06-27 09:17:51 +0000