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
|
<!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::FactoryModule 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_1FactoryModule.html">FactoryModule</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FactoryModule Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FactoryModule" -->
<p>Class that encapsulates access to a dynamic loadable module containing implementations of Windows, Widgets, and their factories.
<a href="classCEGUI_1_1FactoryModule.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"/> Collaboration diagram for CEGUI::FactoryModule:</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_1FactoryModule__coll__graph.gif" border="0" usemap="#CEGUI_1_1FactoryModule_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FactoryModule_coll__map" id="CEGUI_1_1FactoryModule_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1DynamicModule.html" title="Class that wraps and gives access to a dynamically linked module (.dll, .so, etc...)" alt="" coords="117,101,283,131"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="31,5,137,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FactoryModule-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FactoryModule.html#a856c8c491250eede95a7bc056af70cc3">FactoryModule</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct the <a class="el" href="classCEGUI_1_1FactoryModule.html" title="Class that encapsulates access to a dynamic loadable module containing implementations of Windows...">FactoryModule</a> object by loading the dynamic loadable module specified. <a href="#a856c8c491250eede95a7bc056af70cc3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FactoryModule.html#ae5d26ec2e5bc819b239b79669d6bc804">~FactoryModule</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the <a class="el" href="classCEGUI_1_1FactoryModule.html" title="Class that encapsulates access to a dynamic loadable module containing implementations of Windows...">FactoryModule</a> object and unloads any loadable module. <a href="#ae5d26ec2e5bc819b239b79669d6bc804"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FactoryModule.html#a31d5b70f4254104f0592e5a78679685f">registerFactory</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> for <em>type</em> Windows. <a href="#a31d5b70f4254104f0592e5a78679685f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FactoryModule.html#a5ba59fda2b58ee9b6cbd907c8c13a7f4">registerAllFactories</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register all factories available in this module. <a href="#a5ba59fda2b58ee9b6cbd907c8c13a7f4"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that encapsulates access to a dynamic loadable module containing implementations of Windows, Widgets, and their factories. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a856c8c491250eede95a7bc056af70cc3"></a><!-- doxytag: member="CEGUI::FactoryModule::FactoryModule" ref="a856c8c491250eede95a7bc056af70cc3" args="(const String &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::FactoryModule::FactoryModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct the <a class="el" href="classCEGUI_1_1FactoryModule.html" title="Class that encapsulates access to a dynamic loadable module containing implementations of Windows...">FactoryModule</a> object by loading the dynamic loadable module specified. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the filename of a loadable module.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="ae5d26ec2e5bc819b239b79669d6bc804"></a><!-- doxytag: member="CEGUI::FactoryModule::~FactoryModule" ref="ae5d26ec2e5bc819b239b79669d6bc804" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CEGUI::FactoryModule::~FactoryModule </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys the <a class="el" href="classCEGUI_1_1FactoryModule.html" title="Class that encapsulates access to a dynamic loadable module containing implementations of Windows...">FactoryModule</a> object and unloads any loadable module. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5ba59fda2b58ee9b6cbd907c8c13a7f4"></a><!-- doxytag: member="CEGUI::FactoryModule::registerAllFactories" ref="a5ba59fda2b58ee9b6cbd907c8c13a7f4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint CEGUI::FactoryModule::registerAllFactories </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register all factories available in this module. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>uint value indicating the number of factories registered. </dd></dl>
</div>
</div>
<a class="anchor" id="a31d5b70f4254104f0592e5a78679685f"></a><!-- doxytag: member="CEGUI::FactoryModule::registerFactory" ref="a31d5b70f4254104f0592e5a78679685f" args="(const String &type) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FactoryModule::registerFactory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> for <em>type</em> Windows. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of 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> type a factory is to be registered for.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|