<html>
<head>
<title>Ogre::StringInterface 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::StringInterface Class Reference</h1>Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>></code>
<p>
Inheritance diagram for Ogre::StringInterface:<p><center><img src="classOgre_1_1StringInterface__inherit__graph.png" border="0" usemap="#Ogre_1_1StringInterface__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1StringInterface__inherit__map">
<area href="classOgre_1_1BillboardSet.html" shape="rect" coords="229,24,349,5" alt="">
<area href="classOgre_1_1GuiElement.html" shape="rect" coords="232,66,347,48" alt="">
<area href="classOgre_1_1HighLevelGpuProgram.html" shape="rect" coords="199,109,380,90" alt="">
<area href="classOgre_1_1ParticleAffector.html" shape="rect" coords="221,152,357,133" alt="">
<area href="classOgre_1_1ParticleEmitter.html" shape="rect" coords="221,194,357,176" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::StringInterface:<p><center><img src="classOgre_1_1StringInterface__coll__graph.png" border="0" usemap="#Ogre_1_1StringInterface__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1StringInterface__coll__map">
<area href="classOgre_1_1String.html" shape="rect" coords="33,36,113,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1StringInterface-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 </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1StringInterfacea0">~StringInterface</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Virtual desctructor, see Effective C++.</em> <a href="#Ogre_1_1StringInterfacea0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementa79">getParamDictionary</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Retrieves the parameter dictionary for this class.</em> <a href="#Ogre_1_1TTYGuiElementa79"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementa80">getParamDictionary</a> (void) const</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_1StringInterface.html#Ogre_1_1TTYGuiElementa81">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_1TTYGuiElementa81"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementa82">setParameter</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name, const <a class="el" href="classOgre_1_1String.html">String</a> &value)</td></tr>
<tr><td> </td><td><font size=-1><em>Generic parameter setting method.</em> <a href="#Ogre_1_1TTYGuiElementa82"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementa83">getParameter</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name) const</td></tr>
<tr><td> </td><td><font size=-1><em>Generic parameter retrieval method.</em> <a href="#Ogre_1_1TTYGuiElementa83"></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_1StringInterface.html#Ogre_1_1TTYGuiElementa84">copyParametersTo</a> (StringInterface *dest) const</td></tr>
<tr><td> </td><td><font size=-1><em>Method for copying this object's parameters to another object.</em> <a href="#Ogre_1_1TTYGuiElementa84"></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>bool </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementb10">createParamDictionary</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &className)</td></tr>
<tr><td> </td><td><font size=-1><em>Internal method for creating a parameter dictionary for the class, if it does not already exist.</em> <a href="#Ogre_1_1TTYGuiElementb10"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementn48">mParamDictName</a></td></tr>
<tr><td> </td><td><font size=-1><em>Class name for this instance to be used as a lookup (must be initialised by subclasses).</em> <a href="#Ogre_1_1TTYGuiElementn48"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a421">ParamDictionaryMap</a> </td><td valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementq19">msDictionary</a></td></tr>
<tr><td> </td><td><font size=-1><em>Dictionary of parameters.</em> <a href="#Ogre_1_1TTYGuiElementq19"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This class also holds a static map of class name to parameter dictionaries for each subclass to use. See <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> for details. <dd>
In order to use this class, each subclass must call createParamDictionary in their constructors which will create a parameter dictionary for the class if it does not exist yet. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00149">149</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1StringInterfacea0" doxytag="Ogre::StringInterface::~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"> virtual Ogre::StringInterface::~StringInterface </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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>
Virtual desctructor, see Effective C++.
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00184">184</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_1TTYGuiElementa84" doxytag="Ogre::StringInterface::copyParametersTo"></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::StringInterface::copyParametersTo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">StringInterface * </td>
<td class="mdname1" valign="top" nowrap> <em>dest</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Method for copying this object's parameters to another object.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the <a class="el" href="classOgre_1_1String.html">String</a> manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
<p>
Any unrecognised parameters will be ignored as with setParameter method. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>dest</em> </td><td>
Pointer to object to have it's parameters set the same as this object. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00293">293</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00081">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="OgreStringInterface_8cpp-source.html#l00033">setParameter</a>().
<p>
Referenced by <a class="el" href="OgreGuiElement_8cpp-source.html#l00590">Ogre::GuiElement::copyFromTemplate</a>(), <a class="el" href="OgreGuiContainer_8cpp-source.html#l00244">Ogre::GuiContainer::copyFromTemplate</a>(), and <a class="el" href="OgreParticleSystem_8cpp-source.html#l00170">Ogre::ParticleSystem::operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementb10" doxytag="Ogre::StringInterface::createParamDictionary"></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"> bool Ogre::StringInterface::createParamDictionary </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>className</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>
Internal method for creating a parameter dictionary for the class, if it does not already exist.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance). </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>className</em> </td><td>
the name of the class using the dictionary </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
true if a new dictionary was created, false if it was already there </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00169">169</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
Referenced by <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00044">Ogre::BorderButtonGuiElement::BorderButtonGuiElement</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00055">Ogre::BorderPanelGuiElement::BorderPanelGuiElement</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00044">Ogre::ButtonGuiElement::ButtonGuiElement</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="OgreCursorGuiElement_8cpp-source.html#l00041">Ogre::CursorGuiElement::CursorGuiElement</a>(), <a class="el" href="OgreD3D9HLSLProgram_8cpp-source.html#l00167">Ogre::D3D9HLSLProgram::D3D9HLSLProgram</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="OgreListGuiElement_8cpp-source.html#l00045">Ogre::ListGuiElement::ListGuiElement</a>(), <a class="el" href="OgrePanelGuiElement_8cpp-source.html#l00044">Ogre::PanelGuiElement::PanelGuiElement</a>(), <a class="el" href="OgrePointEmitter_8cpp-source.html#l00033">Ogre::PointEmitter::PointEmitter</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00043">Ogre::PopupMenuGuiElement::PopupMenuGuiElement</a>(), <a class="el" href="OgreRotationAffector_8cpp-source.html#l00040">Ogre::RotationAffector::RotationAffector</a>(), <a class="el" href="OgreScaleAffector_8cpp-source.html#l00037">Ogre::ScaleAffector::ScaleAffector</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00040">Ogre::ScrollBarGuiElement::ScrollBarGuiElement</a>(), <a class="el" href="OgreTextAreaGuiElement_8cpp-source.html#l00050">Ogre::TextAreaGuiElement::TextAreaGuiElement</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00039">Ogre::TextBoxGuiElement::TextBoxGuiElement</a>(), and <a class="el" href="OgreTTYGuiElement_8cpp-source.html#l00052">Ogre::TTYGuiElement::TTYGuiElement</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa80" doxytag="Ogre::StringInterface::getParamDictionary"></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_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </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>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00206">206</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa79" doxytag="Ogre::StringInterface::getParamDictionary"></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_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the parameter dictionary for this class.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Only valid to call this after createParamDictionary. </dl><dl compact><dt><b>
Returns: </b><dd>
Pointer to <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> shared by all instances of this class which you can add parameters to, retrieve parameters etc. </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00193">193</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</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>(), <a class="el" href="OgreScaleAffector_8cpp-source.html#l00037">Ogre::ScaleAffector::ScaleAffector</a>(), and <a class="el" href="OgreStringInterface_8cpp-source.html#l00033">setParameter</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa83" doxytag="Ogre::StringInterface::getParameter"></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_1String.html">String</a> Ogre::StringInterface::getParameter </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Generic parameter retrieval method.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> to convert this string back into a native type. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the parameter to get </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
<a class="el" href="classOgre_1_1String.html">String</a> value of parameter, blank if not found </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00262">262</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda0">Ogre::ParamCommand::doGet</a>(), and <a class="el" href="OgreStringInterface_8h-source.html#l00087">Ogre::ParamDictionary::getParamCommand</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa81" doxytag="Ogre::StringInterface::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::StringInterface::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#l00224">224</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00130">Ogre::ParamDictionary::getParameters</a>(), and <a class="el" href="OgreStringInterface_8h-source.html#l00064">Ogre::ParameterList</a>. </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa82" doxytag="Ogre::StringInterface::setParameter"></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"> bool Ogre::StringInterface::setParameter </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="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Generic parameter setting method.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementa81">StringInterface::getParameters</a>. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the parameter to set </td></tr>
<tr><td valign=top><em>value</em> </td><td>
<a class="el" href="classOgre_1_1String.html">String</a> value. Must be in the right format for the type specified in the parameter definition. See the <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> class for more information. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8cpp-source.html#l00033">33</a> of file <a class="el" href="OgreStringInterface_8cpp-source.html">OgreStringInterface.cpp</a>.
<p>
References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda1">Ogre::ParamCommand::doSet</a>(), <a class="el" href="OgreStringInterface_8h-source.html#l00087">Ogre::ParamDictionary::getParamCommand</a>(), and <a class="el" href="OgreStringInterface_8h-source.html#l00193">getParamDictionary</a>().
<p>
Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00293">copyParametersTo</a>(), <a class="el" href="OgreProfiler_8cpp-source.html#l00761">Ogre::Profiler::createContainer</a>(), <a class="el" href="OgreProfiler_8cpp-source.html#l00785">Ogre::Profiler::createTextArea</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01881">Ogre::MaterialSerializer::finishProgramDefinition</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00438">Ogre::ParticleSystemManager::parseAffectorAttrib</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00406">Ogre::ParticleSystemManager::parseAttrib</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00414">Ogre::OverlayManager::parseElementAttrib</a>(), and <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00422">Ogre::ParticleSystemManager::parseEmitterAttrib</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1TTYGuiElementn48" doxytag="Ogre::StringInterface::mParamDictName"></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_1String.html">String</a> Ogre::StringInterface::mParamDictName<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Class name for this instance to be used as a lookup (must be initialised by subclasses).
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00157">157</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementq19" doxytag="Ogre::StringInterface::msDictionary"></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#a421">ParamDictionaryMap</a> Ogre::StringInterface::msDictionary<code> [static, protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Dictionary of parameters.
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8cpp-source.html#l00030">30</a> of file <a class="el" href="OgreStringInterface_8cpp-source.html">OgreStringInterface.cpp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a><li><a class="el" href="OgreStringInterface_8cpp-source.html">OgreStringInterface.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:20:47 2004
</p>
</body>
</html>
