<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.3.6 -->
<div class="qindex"><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">Class 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">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<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></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionarya0">ParamDictionary</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" 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 class="mdescLeft"> </td><td class="mdescRight">Method for adding a parameter definition for this class. <a href="#Ogre_1_1ParamDictionarya1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a517">ParameterList</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionarya2">getParameters</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a list of parameters valid for this object. <a href="#Ogre_1_1ParamDictionarya2"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryb0">getParamCommand</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the parameter command object for a named parameter. <a href="#Ogre_1_1ParamDictionaryb0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryb1">getParamCommand</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &name) const </td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a517">ParameterList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp0">mParamDefs</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Definitions of parameters. <a href="#Ogre_1_1ParamDictionaryp0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a518">ParamCommandMap</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp1">mParamCommands</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command objects to get/set. <a href="#Ogre_1_1ParamDictionaryp1"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryn0">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#l00077">77</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="Ogre_1_1ParamDictionarya0" doxytag="Ogre::ParamDictionary::ParamDictionary" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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#l00114">114</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="Ogre_1_1ParamDictionarya1" doxytag="Ogre::ParamDictionary::addParameter" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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 class="md" nowrap align="right"></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></dt><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#l00121">121</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00059">Ogre::ParameterDef::name</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1ParamDictionaryb1" doxytag="Ogre::ParamDictionary::getParamCommand" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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="namespaceOgre.html#a426">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#l00101">101</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1ParamDictionaryb0" doxytag="Ogre::ParamDictionary::getParamCommand" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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="namespaceOgre.html#a426">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#l00088">88</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.
<p>
Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00263">Ogre::StringInterface::getParameter()</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1ParamDictionarya2" doxytag="Ogre::ParamDictionary::getParameters" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a517">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></dt><dd>A reference to a static list of <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> objects. </dd></dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00131">131</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00065">Ogre::ParameterList</a>. </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="Ogre_1_1ParamDictionaryn0" doxytag="Ogre::ParamDictionary::StringInterface" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> friend class <a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a><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#l00079">79</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="Ogre_1_1ParamDictionaryp1" doxytag="Ogre::ParamDictionary::mParamCommands" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a518">ParamCommandMap</a> <a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp1">Ogre::ParamDictionary::mParamCommands</a><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#l00085">85</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1ParamDictionaryp0" doxytag="Ogre::ParamDictionary::mParamDefs" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a517">ParameterList</a> <a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp0">Ogre::ParamDictionary::mParamDefs</a><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#l00082">82</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#l00294">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 © 2000-2005 by The OGRE Team<br />
Last modified Wed Feb 23 00:24:07 2005
</p>
</body>
</html>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
04e5d8c10ae76748689b4e7f48e0fa33
>
files
>
2571
