<html>
<head>
<title>Ogre::ParamDictionary 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::ParamDictionary Class Reference</h1>Class to hold a dictionary of parameters for a single class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>></code>
<p>
<a href="classOgre_1_1ParamDictionary-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> </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionarya0">ParamDictionary</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionarya1">addParameter</a> (const <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> &paramDef, <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> *paramCmd)</td></tr>
<tr><td> </td><td><font size=-1><em>Method for adding a parameter definition for this class.</em> <a href="#Ogre_1_1ParamDictionarya1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a419">ParameterList</a> & </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionarya2">getParameters</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Retrieves a list of parameters valid for this object.</em> <a href="#Ogre_1_1ParamDictionarya2"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryb0">getParamCommand</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name)</td></tr>
<tr><td> </td><td><font size=-1><em>Retrieves the parameter command object for a named parameter.</em> <a href="#Ogre_1_1ParamDictionaryb0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryb1">getParamCommand</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name) const</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a419">ParameterList</a> </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryn0">mParamDefs</a></td></tr>
<tr><td> </td><td><font size=-1><em>Definitions of parameters.</em> <a href="#Ogre_1_1ParamDictionaryn0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">ParamCommandMap</a> </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryn1">mParamCommands</a></td></tr>
<tr><td> </td><td><font size=-1><em>Command objects to get/set.</em> <a href="#Ogre_1_1ParamDictionaryn1"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryl0">StringInterface</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to hold a dictionary of parameters for a single class.
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00076">76</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1ParamDictionarya0" doxytag="Ogre::ParamDictionary::ParamDictionary"></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"> Ogre::ParamDictionary::ParamDictionary </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00113">113</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1ParamDictionarya1" doxytag="Ogre::ParamDictionary::addParameter"></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"> void Ogre::ParamDictionary::addParameter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> & </td>
<td class="mdname" nowrap> <em>paramDef</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> * </td>
<td class="mdname" nowrap> <em>paramCmd</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Method for adding a parameter definition for this class.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>paramDef</em> </td><td>
A <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> object defining the parameter </td></tr>
<tr><td valign=top><em>paramCmd</em> </td><td>
Pointer to a <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> subclass to handle the getting / setting of this parameter. NB this class will not destroy this on shutdown, please ensure you do </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00120">120</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00058">Ogre::ParameterDef::name</a>.
<p>
Referenced by <a class="el" href="OgreTTYGuiElement_8cpp-source.html#l00671">Ogre::TTYGuiElement::addBaseParameters</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00064">Ogre::TextBoxGuiElement::addBaseParameters</a>(), <a class="el" href="OgreTextAreaGuiElement_8cpp-source.html#l00414">Ogre::TextAreaGuiElement::addBaseParameters</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00059">Ogre::ScrollBarGuiElement::addBaseParameters</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00074">Ogre::PopupMenuGuiElement::addBaseParameters</a>(), <a class="el" href="OgreParticleEmitter_8cpp-source.html#l00273">Ogre::ParticleEmitter::addBaseParameters</a>(), <a class="el" href="OgrePanelGuiElement_8cpp-source.html#l00303">Ogre::PanelGuiElement::addBaseParameters</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00071">Ogre::ListGuiElement::addBaseParameters</a>(), <a class="el" href="OgreGuiElement_8cpp-source.html#l00419">Ogre::GuiElement::addBaseParameters</a>(), <a class="el" href="OgreCursorGuiElement_8cpp-source.html#l00108">Ogre::CursorGuiElement::addBaseParameters</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00159">Ogre::ButtonGuiElement::addBaseParameters</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00163">Ogre::BorderPanelGuiElement::addBaseParameters</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00135">Ogre::BorderButtonGuiElement::addBaseParameters</a>(), <a class="el" href="OgreCgProgram_8cpp-source.html#l00216">Ogre::CgProgram::CgProgram</a>(), <a class="el" href="OgreColourFaderAffector_8cpp-source.html#l00040">Ogre::ColourFaderAffector::ColourFaderAffector</a>(), <a class="el" href="OgreColourFaderAffector2_8cpp-source.html#l00050">Ogre::ColourFaderAffector2::ColourFaderAffector2</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00038">Ogre::ColourImageAffector::ColourImageAffector</a>(), <a class="el" href="OgreColourInterpolatorAffector_8cpp-source.html#l00038">Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector</a>(), <a class="el" href="OgreD3D9HLSLProgram_8cpp-source.html#l00167">Ogre::D3D9HLSLProgram::D3D9HLSLProgram</a>(), <a class="el" href="OgreHollowEllipsoidEmitter_8cpp-source.html#l00048">Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter</a>(), <a class="el" href="OgreAreaEmitter_8cpp-source.html#l00041">Ogre::AreaEmitter::initDefaults</a>(), <a class="el" href="OgreParticleSystem_8cpp-source.html#l00447">Ogre::ParticleSystem::initParameters</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">Ogre::LinearForceAffector::LinearForceAffector</a>(), <a class="el" href="OgreRingEmitter_8cpp-source.html#l00040">Ogre::RingEmitter::RingEmitter</a>(), <a class="el" href="OgreRotationAffector_8cpp-source.html#l00040">Ogre::RotationAffector::RotationAffector</a>(), and <a class="el" href="OgreScaleAffector_8cpp-source.html#l00037">Ogre::ScaleAffector::ScaleAffector</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ParamDictionaryb1" doxytag="Ogre::ParamDictionary::getParamCommand"></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"> const <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a>* Ogre::ParamDictionary::getParamCommand </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>name</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00100">100</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ParamDictionaryb0" doxytag="Ogre::ParamDictionary::getParamCommand"></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"> <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a>* Ogre::ParamDictionary::getParamCommand </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>name</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the parameter command object for a named parameter.
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00087">87</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00262">Ogre::StringInterface::getParameter</a>(), and <a class="el" href="OgreStringInterface_8cpp-source.html#l00033">Ogre::StringInterface::setParameter</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ParamDictionarya2" doxytag="Ogre::ParamDictionary::getParameters"></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"> const <a class="el" href="namespaceOgre.html#a419">ParameterList</a>& Ogre::ParamDictionary::getParameters </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves a list of parameters valid for this object.
<p>
<dl compact><dt><b>
Returns: </b><dd>
A reference to a static list of <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> objects. </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00130">130</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00064">Ogre::ParameterList</a>.
<p>
Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00224">Ogre::StringInterface::getParameters</a>(). </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="Ogre_1_1ParamDictionaryl0" doxytag="Ogre::ParamDictionary::StringInterface"></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"> friend class StringInterface<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00078">78</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1ParamDictionaryn1" doxytag="Ogre::ParamDictionary::mParamCommands"></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"> <a class="el" href="namespaceOgre.html#a420">ParamCommandMap</a> Ogre::ParamDictionary::mParamCommands<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Command objects to get/set.
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00084">84</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ParamDictionaryn0" doxytag="Ogre::ParamDictionary::mParamDefs"></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"> <a class="el" href="namespaceOgre.html#a419">ParameterList</a> Ogre::ParamDictionary::mParamDefs<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Definitions of parameters.
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00081">81</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00293">Ogre::StringInterface::copyParametersTo</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:16:21 2004
</p>
</body>
</html>
