<html>
<head>
<title>Ogre::GuiElementFactory class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::GuiElementFactory Class Reference</h1>Defines the interface which all components wishing to supply <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> subclasses must implement.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreGuiElementFactory_8h-source.html">OgreGuiElementFactory.h</a>></code>
<p>
Inheritance diagram for Ogre::GuiElementFactory:<p><center><img src="classOgre_1_1GuiElementFactory__inherit__graph.png" border="0" usemap="#Ogre_1_1GuiElementFactory__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1GuiElementFactory__inherit__map">
<area href="classOgre_1_1BorderButtonGuiElementFactory.html" shape="rect" coords="229,24,467,5" alt="">
<area href="classOgre_1_1BorderPanelGuiElementFactory.html" shape="rect" coords="232,66,464,48" alt="">
<area href="classOgre_1_1ButtonGuiElementFactory.html" shape="rect" coords="249,109,447,90" alt="">
<area href="classOgre_1_1CursorGuiElementFactory.html" shape="rect" coords="248,152,448,133" alt="">
<area href="classOgre_1_1ListGuiElementFactory.html" shape="rect" coords="257,194,439,176" alt="">
<area href="classOgre_1_1PanelGuiElementFactory.html" shape="rect" coords="252,237,444,218" alt="">
<area href="classOgre_1_1PopupMenuGuiElementFactory.html" shape="rect" coords="232,280,464,261" alt="">
<area href="classOgre_1_1ScrollBarGuiElementFactory.html" shape="rect" coords="240,322,456,304" alt="">
<area href="classOgre_1_1TextAreaGuiElementFactory.html" shape="rect" coords="241,365,455,346" alt="">
<area href="classOgre_1_1TextBoxGuiElementFactory.html" shape="rect" coords="244,408,452,389" alt="">
<area href="classOgre_1_1TTYGuiElementFactory.html" shape="rect" coords="256,450,440,432" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1GuiElementFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1GuiElementFactory.html#Ogre_1_1GuiElementFactorya0">createGuiElement</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &instanceName)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Creates a new <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> instance with the name supplied.</em> <a href="#Ogre_1_1GuiElementFactorya0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1GuiElementFactory.html#Ogre_1_1TTYGuiElementFactorya2">destroyGuiElement</a> (<a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> *pElement)</td></tr>
<tr><td> </td><td><font size=-1><em>Destroys a <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> which this factory created previously.</em> <a href="#Ogre_1_1TTYGuiElementFactorya2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classOgre_1_1String.html">String</a> & </td><td valign=bottom><a class="el" href="classOgre_1_1GuiElementFactory.html#Ogre_1_1GuiElementFactorya2">getTypeName</a> (void) const=0</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the string uniquely identifying the type of element this factory creates.</em> <a href="#Ogre_1_1GuiElementFactorya2"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Defines the interface which all components wishing to supply <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> subclasses must implement.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
To allow the <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> types available for inclusion on overlays to be extended, OGRE allows external apps or plugins to register their ability to create custom GuiElements with the <a class="el" href="classOgre_1_1GuiManager.html">GuiManager</a>, using the addGuiElementFactory method. Classes wanting to do this must implement this interface.
<p>
Each <a class="el" href="classOgre_1_1GuiElementFactory.html">GuiElementFactory</a> creates a single type of <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>, identified by a 'type name' which must be unique. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreGuiElementFactory_8h-source.html#l00045">45</a> of file <a class="el" href="OgreGuiElementFactory_8h-source.html">OgreGuiElementFactory.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1GuiElementFactorya0" doxytag="Ogre::GuiElementFactory::createGuiElement"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>* Ogre::GuiElementFactory::createGuiElement </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>instanceName</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> instance with the name supplied.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1CursorGuiElementFactory.html#Ogre_1_1CursorGuiElementFactorya0">Ogre::CursorGuiElementFactory</a>, <a class="el" href="classOgre_1_1PanelGuiElementFactory.html#Ogre_1_1PanelGuiElementFactorya0">Ogre::PanelGuiElementFactory</a>, <a class="el" href="classOgre_1_1BorderPanelGuiElementFactory.html#Ogre_1_1BorderPanelGuiElementFactorya0">Ogre::BorderPanelGuiElementFactory</a>, <a class="el" href="classOgre_1_1TextAreaGuiElementFactory.html#Ogre_1_1TextAreaGuiElementFactorya0">Ogre::TextAreaGuiElementFactory</a>, <a class="el" href="classOgre_1_1TextBoxGuiElementFactory.html#Ogre_1_1TextBoxGuiElementFactorya0">Ogre::TextBoxGuiElementFactory</a>, <a class="el" href="classOgre_1_1ButtonGuiElementFactory.html#Ogre_1_1ButtonGuiElementFactorya0">Ogre::ButtonGuiElementFactory</a>, <a class="el" href="classOgre_1_1BorderButtonGuiElementFactory.html#Ogre_1_1BorderButtonGuiElementFactorya0">Ogre::BorderButtonGuiElementFactory</a>, <a class="el" href="classOgre_1_1ListGuiElementFactory.html#Ogre_1_1ListGuiElementFactorya0">Ogre::ListGuiElementFactory</a>, <a class="el" href="classOgre_1_1ScrollBarGuiElementFactory.html#Ogre_1_1ScrollBarGuiElementFactorya0">Ogre::ScrollBarGuiElementFactory</a>, <a class="el" href="classOgre_1_1PopupMenuGuiElementFactory.html#Ogre_1_1PopupMenuGuiElementFactorya0">Ogre::PopupMenuGuiElementFactory</a>, and <a class="el" href="classOgre_1_1TTYGuiElementFactory.html#Ogre_1_1TTYGuiElementFactorya0">Ogre::TTYGuiElementFactory</a>. </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementFactorya2" doxytag="Ogre::GuiElementFactory::destroyGuiElement"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::GuiElementFactory::destroyGuiElement </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pElement</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destroys a <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> which this factory created previously.
<p>
<p>
Definition at line <a class="el" href="OgreGuiElementFactory_8h-source.html#l00051">51</a> of file <a class="el" href="OgreGuiElementFactory_8h-source.html">OgreGuiElementFactory.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1GuiElementFactorya2" doxytag="Ogre::GuiElementFactory::getTypeName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual const <a class="el" href="classOgre_1_1String.html">String</a>& Ogre::GuiElementFactory::getTypeName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the string uniquely identifying the type of element this factory creates.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1CursorGuiElementFactory.html#Ogre_1_1CursorGuiElementFactorya1">Ogre::CursorGuiElementFactory</a>, <a class="el" href="classOgre_1_1PanelGuiElementFactory.html#Ogre_1_1PanelGuiElementFactorya1">Ogre::PanelGuiElementFactory</a>, <a class="el" href="classOgre_1_1BorderPanelGuiElementFactory.html#Ogre_1_1BorderPanelGuiElementFactorya1">Ogre::BorderPanelGuiElementFactory</a>, <a class="el" href="classOgre_1_1TextAreaGuiElementFactory.html#Ogre_1_1TextAreaGuiElementFactorya1">Ogre::TextAreaGuiElementFactory</a>, <a class="el" href="classOgre_1_1TextBoxGuiElementFactory.html#Ogre_1_1TextBoxGuiElementFactorya1">Ogre::TextBoxGuiElementFactory</a>, <a class="el" href="classOgre_1_1ButtonGuiElementFactory.html#Ogre_1_1ButtonGuiElementFactorya1">Ogre::ButtonGuiElementFactory</a>, <a class="el" href="classOgre_1_1BorderButtonGuiElementFactory.html#Ogre_1_1BorderButtonGuiElementFactorya1">Ogre::BorderButtonGuiElementFactory</a>, <a class="el" href="classOgre_1_1ListGuiElementFactory.html#Ogre_1_1ListGuiElementFactorya1">Ogre::ListGuiElementFactory</a>, <a class="el" href="classOgre_1_1ScrollBarGuiElementFactory.html#Ogre_1_1ScrollBarGuiElementFactorya1">Ogre::ScrollBarGuiElementFactory</a>, <a class="el" href="classOgre_1_1PopupMenuGuiElementFactory.html#Ogre_1_1PopupMenuGuiElementFactorya1">Ogre::PopupMenuGuiElementFactory</a>, and <a class="el" href="classOgre_1_1TTYGuiElementFactory.html#Ogre_1_1TTYGuiElementFactorya1">Ogre::TTYGuiElementFactory</a>.
<p>
Referenced by <a class="el" href="OgreGuiManager_8cpp-source.html#l00210">Ogre::GuiManager::addGuiElementFactory</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreGuiElementFactory_8h-source.html">OgreGuiElementFactory.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:17:43 2004
</p>
</body>
</html>
