source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1OverlayElementFactory.html @ 657

Revision 657, 10.9 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::OverlayElementFactory class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::OverlayElementFactory Class Reference</h1>Defines the interface which all components wishing to supply <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> subclasses must implement. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreOverlayElementFactory_8h-source.html">OgreOverlayElementFactory.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::OverlayElementFactory:
16<p><center><img src="classOgre_1_1OverlayElementFactory.png" usemap="#Ogre::OverlayElementFactory_map" border="0" alt=""></center>
17<map name="Ogre::OverlayElementFactory_map">
18<area href="classOgre_1_1BorderPanelOverlayElementFactory.html" alt="Ogre::BorderPanelOverlayElementFactory" shape="rect" coords="0,56,252,80">
19<area href="classOgre_1_1PanelOverlayElementFactory.html" alt="Ogre::PanelOverlayElementFactory" shape="rect" coords="262,56,514,80">
20<area href="classOgre_1_1TextAreaOverlayElementFactory.html" alt="Ogre::TextAreaOverlayElementFactory" shape="rect" coords="524,56,776,80">
21</map>
22<a href="classOgre_1_1OverlayElementFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
23<tr><td></td></tr>
24<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
25<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1OverlayElementFactory.html#Ogre_1_1OverlayElementFactorya0">createOverlayElement</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;instanceName)=0</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> instance with the name supplied.  <a href="#Ogre_1_1OverlayElementFactorya0"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1OverlayElementFactory.html#Ogre_1_1TextAreaOverlayElementFactorya2">destroyOverlayElement</a> (<a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> *pElement)</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys a <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> which this factory created previously.  <a href="#Ogre_1_1TextAreaOverlayElementFactorya2"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1OverlayElementFactory.html#Ogre_1_1OverlayElementFactorya2">getTypeName</a> (void) const=0</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the string uniquely identifying the type of element this factory creates.  <a href="#Ogre_1_1OverlayElementFactorya2"></a><br><br></td></tr>
34</table>
35<hr><a name="_details"></a><h2>Detailed Description</h2>
36Defines the interface which all components wishing to supply <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> subclasses must implement.
37<p>
38<dl compact><dt><b>Remarks:</b></dt><dd>To allow the <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> types available for inclusion on overlays to be extended, OGRE allows external apps or plugins to register their ability to create custom OverlayElements with the <a class="el" href="classOgre_1_1OverlayManager.html">OverlayManager</a>, using the addOverlayElementFactory method. Classes wanting to do this must implement this interface. </dd></dl>
39<dl compact><dt><b></b></dt><dd>Each <a class="el" href="classOgre_1_1OverlayElementFactory.html">OverlayElementFactory</a> creates a single type of <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a>, identified by a 'type name' which must be unique. </dd></dl>
40
41<p>
42
43<p>
44Definition at line <a class="el" href="OgreOverlayElementFactory_8h-source.html#l00048">48</a> of file <a class="el" href="OgreOverlayElementFactory_8h-source.html">OgreOverlayElementFactory.h</a>.<hr><h2>Member Function Documentation</h2>
45<a class="anchor" name="Ogre_1_1OverlayElementFactorya0" doxytag="Ogre::OverlayElementFactory::createOverlayElement" ></a><p>
46<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
47  <tr>
48    <td class="mdRow">
49      <table cellpadding="0" cellspacing="0" border="0">
50        <tr>
51          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* Ogre::OverlayElementFactory::createOverlayElement </td>
52          <td class="md" valign="top">(&nbsp;</td>
53          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
54          <td class="mdname1" valign="top" nowrap> <em>instanceName</em>          </td>
55          <td class="md" valign="top">&nbsp;)&nbsp;</td>
56          <td class="md" nowrap><code> [pure virtual]</code></td>
57        </tr>
58
59      </table>
60    </td>
61  </tr>
62</table>
63<table cellspacing=5 cellpadding=0 border=0>
64  <tr>
65    <td>
66      &nbsp;
67    </td>
68    <td>
69
70<p>
71Creates a new <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> instance with the name supplied.
72<p>
73
74<p>
75Implemented in <a class="el" href="classOgre_1_1PanelOverlayElementFactory.html#Ogre_1_1PanelOverlayElementFactorya0">Ogre::PanelOverlayElementFactory</a>, <a class="el" href="classOgre_1_1BorderPanelOverlayElementFactory.html#Ogre_1_1BorderPanelOverlayElementFactorya0">Ogre::BorderPanelOverlayElementFactory</a>, and <a class="el" href="classOgre_1_1TextAreaOverlayElementFactory.html#Ogre_1_1TextAreaOverlayElementFactorya0">Ogre::TextAreaOverlayElementFactory</a>.    </td>
76  </tr>
77</table>
78<a class="anchor" name="Ogre_1_1TextAreaOverlayElementFactorya2" doxytag="Ogre::OverlayElementFactory::destroyOverlayElement" ></a><p>
79<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
80  <tr>
81    <td class="mdRow">
82      <table cellpadding="0" cellspacing="0" border="0">
83        <tr>
84          <td class="md" nowrap valign="top"> virtual void Ogre::OverlayElementFactory::destroyOverlayElement </td>
85          <td class="md" valign="top">(&nbsp;</td>
86          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> *&nbsp;</td>
87          <td class="mdname1" valign="top" nowrap> <em>pElement</em>          </td>
88          <td class="md" valign="top">&nbsp;)&nbsp;</td>
89          <td class="md" nowrap><code> [virtual]</code></td>
90        </tr>
91
92      </table>
93    </td>
94  </tr>
95</table>
96<table cellspacing=5 cellpadding=0 border=0>
97  <tr>
98    <td>
99      &nbsp;
100    </td>
101    <td>
102
103<p>
104Destroys a <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> which this factory created previously.
105<p>
106
107<p>
108Definition at line <a class="el" href="OgreOverlayElementFactory_8h-source.html#l00054">54</a> of file <a class="el" href="OgreOverlayElementFactory_8h-source.html">OgreOverlayElementFactory.h</a>.    </td>
109  </tr>
110</table>
111<a class="anchor" name="Ogre_1_1OverlayElementFactorya2" doxytag="Ogre::OverlayElementFactory::getTypeName" ></a><p>
112<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
113  <tr>
114    <td class="mdRow">
115      <table cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::OverlayElementFactory::getTypeName </td>
118          <td class="md" valign="top">(&nbsp;</td>
119          <td class="md" nowrap valign="top">void&nbsp;</td>
120          <td class="mdname1" valign="top" nowrap>          </td>
121          <td class="md" valign="top">&nbsp;)&nbsp;</td>
122          <td class="md" nowrap> const<code> [pure virtual]</code></td>
123        </tr>
124
125      </table>
126    </td>
127  </tr>
128</table>
129<table cellspacing=5 cellpadding=0 border=0>
130  <tr>
131    <td>
132      &nbsp;
133    </td>
134    <td>
135
136<p>
137Gets the string uniquely identifying the type of element this factory creates.
138<p>
139
140<p>
141Implemented in <a class="el" href="classOgre_1_1PanelOverlayElementFactory.html#Ogre_1_1PanelOverlayElementFactorya1">Ogre::PanelOverlayElementFactory</a>, <a class="el" href="classOgre_1_1BorderPanelOverlayElementFactory.html#Ogre_1_1BorderPanelOverlayElementFactorya1">Ogre::BorderPanelOverlayElementFactory</a>, and <a class="el" href="classOgre_1_1TextAreaOverlayElementFactory.html#Ogre_1_1TextAreaOverlayElementFactorya1">Ogre::TextAreaOverlayElementFactory</a>.    </td>
142  </tr>
143</table>
144<hr>The documentation for this class was generated from the following file:<ul>
145<li><a class="el" href="OgreOverlayElementFactory_8h-source.html">OgreOverlayElementFactory.h</a></ul>
146<hr>
147<p>
148Copyright &copy; 2000-2005 by The OGRE Team<br />
149<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
150This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
151                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
152                <Work rdf:about="">
153                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
154        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
155                </Work>
156                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
157
158Last modified Sun Feb 12 13:01:36 2006
159</p>
160</body>
161</html>
Note: See TracBrowser for help on using the repository browser.