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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ParamDictionary 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::ParamDictionary Class Reference</h1>Class to hold a dictionary of parameters for a single class. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1ParamDictionary-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionarya0">ParamDictionary</a> ()</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</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> &amp;paramDef, <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> *paramCmd)</td></tr>
21
22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for adding a parameter definition for this class.  <a href="#Ogre_1_1ParamDictionarya1"></a><br><br></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a518">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionarya2">getParameters</a> (void) const </td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1ParamDictionarya2"></a><br><br></td></tr>
26<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> *&nbsp;</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> &amp;name)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter command object for a named parameter.  <a href="#Ogre_1_1ParamDictionaryb0"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> *&nbsp;</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> &amp;name) const </td></tr>
31
32<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a518">ParameterList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp0">mParamDefs</a></td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Definitions of parameters.  <a href="#Ogre_1_1ParamDictionaryp0"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a519">ParamCommandMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp1">mParamCommands</a></td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command objects to get/set.  <a href="#Ogre_1_1ParamDictionaryp1"></a><br><br></td></tr>
39<tr><td colspan=2><br><h2>Friends</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>class&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryn0">StringInterface</a></td></tr>
41
42</table>
43<hr><a name="_details"></a><h2>Detailed Description</h2>
44Class to hold a dictionary of parameters for a single class.
45<p>
46
47<p>
48Definition 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>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
49<a class="anchor" name="Ogre_1_1ParamDictionarya0" doxytag="Ogre::ParamDictionary::ParamDictionary" ></a><p>
50<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
51  <tr>
52    <td class="mdRow">
53      <table cellpadding="0" cellspacing="0" border="0">
54        <tr>
55          <td class="md" nowrap valign="top"> Ogre::ParamDictionary::ParamDictionary </td>
56          <td class="md" valign="top">(&nbsp;</td>
57          <td class="mdname1" valign="top" nowrap>          </td>
58          <td class="md" valign="top">&nbsp;)&nbsp;</td>
59          <td class="md" nowrap></td>
60        </tr>
61
62      </table>
63    </td>
64  </tr>
65</table>
66<table cellspacing=5 cellpadding=0 border=0>
67  <tr>
68    <td>
69      &nbsp;
70    </td>
71    <td>
72
73<p>
74
75<p>
76Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00116">116</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
77  </tr>
78</table>
79<hr><h2>Member Function Documentation</h2>
80<a class="anchor" name="Ogre_1_1ParamDictionarya1" doxytag="Ogre::ParamDictionary::addParameter" ></a><p>
81<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
82  <tr>
83    <td class="mdRow">
84      <table cellpadding="0" cellspacing="0" border="0">
85        <tr>
86          <td class="md" nowrap valign="top"> void Ogre::ParamDictionary::addParameter </td>
87          <td class="md" valign="top">(&nbsp;</td>
88          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> &amp;&nbsp;</td>
89          <td class="mdname" nowrap> <em>paramDef</em>, </td>
90        </tr>
91        <tr>
92          <td class="md" nowrap align="right"></td>
93          <td></td>
94          <td class="md" nowrap><a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a> *&nbsp;</td>
95          <td class="mdname" nowrap> <em>paramCmd</em></td>
96        </tr>
97        <tr>
98          <td></td>
99          <td class="md">)&nbsp;</td>
100          <td class="md" colspan="2"></td>
101        </tr>
102
103      </table>
104    </td>
105  </tr>
106</table>
107<table cellspacing=5 cellpadding=0 border=0>
108  <tr>
109    <td>
110      &nbsp;
111    </td>
112    <td>
113
114<p>
115Method for adding a parameter definition for this class.
116<p>
117<dl compact><dt><b>Parameters:</b></dt><dd>
118  <table border="0" cellspacing="2" cellpadding="0">
119    <tr><td valign=top><em>paramDef</em>&nbsp;</td><td>A <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> object defining the parameter </td></tr>
120    <tr><td valign=top><em>paramCmd</em>&nbsp;</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>
121  </table>
122</dl>
123
124<p>
125Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00123">123</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
126<p>
127References <a class="el" href="OgreStringInterface_8h-source.html#l00059">Ogre::ParameterDef::name</a>.    </td>
128  </tr>
129</table>
130<a class="anchor" name="Ogre_1_1ParamDictionaryb1" doxytag="Ogre::ParamDictionary::getParamCommand" ></a><p>
131<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
132  <tr>
133    <td class="mdRow">
134      <table cellpadding="0" cellspacing="0" border="0">
135        <tr>
136          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a>* Ogre::ParamDictionary::getParamCommand </td>
137          <td class="md" valign="top">(&nbsp;</td>
138          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
139          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
140          <td class="md" valign="top">&nbsp;)&nbsp;</td>
141          <td class="md" nowrap> const<code> [protected]</code></td>
142        </tr>
143
144      </table>
145    </td>
146  </tr>
147</table>
148<table cellspacing=5 cellpadding=0 border=0>
149  <tr>
150    <td>
151      &nbsp;
152    </td>
153    <td>
154
155<p>
156
157<p>
158Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00103">103</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
159<p>
160References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
161  </tr>
162</table>
163<a class="anchor" name="Ogre_1_1ParamDictionaryb0" doxytag="Ogre::ParamDictionary::getParamCommand" ></a><p>
164<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
165  <tr>
166    <td class="mdRow">
167      <table cellpadding="0" cellspacing="0" border="0">
168        <tr>
169          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamCommand.html">ParamCommand</a>* Ogre::ParamDictionary::getParamCommand </td>
170          <td class="md" valign="top">(&nbsp;</td>
171          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
172          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
173          <td class="md" valign="top">&nbsp;)&nbsp;</td>
174          <td class="md" nowrap><code> [protected]</code></td>
175        </tr>
176
177      </table>
178    </td>
179  </tr>
180</table>
181<table cellspacing=5 cellpadding=0 border=0>
182  <tr>
183    <td>
184      &nbsp;
185    </td>
186    <td>
187
188<p>
189Retrieves the parameter command object for a named parameter.
190<p>
191
192<p>
193Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00090">90</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
194<p>
195References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.
196<p>
197Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00265">Ogre::StringInterface::getParameter()</a>.    </td>
198  </tr>
199</table>
200<a class="anchor" name="Ogre_1_1ParamDictionarya2" doxytag="Ogre::ParamDictionary::getParameters" ></a><p>
201<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
202  <tr>
203    <td class="mdRow">
204      <table cellpadding="0" cellspacing="0" border="0">
205        <tr>
206          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a518">ParameterList</a>&amp; Ogre::ParamDictionary::getParameters </td>
207          <td class="md" valign="top">(&nbsp;</td>
208          <td class="md" nowrap valign="top">void&nbsp;</td>
209          <td class="mdname1" valign="top" nowrap>          </td>
210          <td class="md" valign="top">&nbsp;)&nbsp;</td>
211          <td class="md" nowrap> const</td>
212        </tr>
213
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing=5 cellpadding=0 border=0>
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226Retrieves a list of parameters valid for this object.
227<p>
228<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>
229
230<p>
231Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00133">133</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
232<p>
233References <a class="el" href="OgreStringInterface_8h-source.html#l00065">Ogre::ParameterList</a>.    </td>
234  </tr>
235</table>
236<hr><h2>Friends And Related Function Documentation</h2>
237<a class="anchor" name="Ogre_1_1ParamDictionaryn0" doxytag="Ogre::ParamDictionary::StringInterface" ></a><p>
238<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
239  <tr>
240    <td class="mdRow">
241      <table cellpadding="0" cellspacing="0" border="0">
242        <tr>
243          <td class="md" nowrap valign="top"> friend class <a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a><code> [friend]</code>
244      </table>
245    </td>
246  </tr>
247</table>
248<table cellspacing=5 cellpadding=0 border=0>
249  <tr>
250    <td>
251      &nbsp;
252    </td>
253    <td>
254
255<p>
256
257<p>
258Definition 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>.    </td>
259  </tr>
260</table>
261<hr><h2>Member Data Documentation</h2>
262<a class="anchor" name="Ogre_1_1ParamDictionaryp1" doxytag="Ogre::ParamDictionary::mParamCommands" ></a><p>
263<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
264  <tr>
265    <td class="mdRow">
266      <table cellpadding="0" cellspacing="0" border="0">
267        <tr>
268          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a519">ParamCommandMap</a> <a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp1">Ogre::ParamDictionary::mParamCommands</a><code> [protected]</code>
269      </table>
270    </td>
271  </tr>
272</table>
273<table cellspacing=5 cellpadding=0 border=0>
274  <tr>
275    <td>
276      &nbsp;
277    </td>
278    <td>
279
280<p>
281Command objects to get/set.
282<p>
283
284<p>
285Definition 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>.    </td>
286  </tr>
287</table>
288<a class="anchor" name="Ogre_1_1ParamDictionaryp0" doxytag="Ogre::ParamDictionary::mParamDefs" ></a><p>
289<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
290  <tr>
291    <td class="mdRow">
292      <table cellpadding="0" cellspacing="0" border="0">
293        <tr>
294          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a518">ParameterList</a> <a class="el" href="classOgre_1_1ParamDictionary.html#Ogre_1_1ParamDictionaryp0">Ogre::ParamDictionary::mParamDefs</a><code> [protected]</code>
295      </table>
296    </td>
297  </tr>
298</table>
299<table cellspacing=5 cellpadding=0 border=0>
300  <tr>
301    <td>
302      &nbsp;
303    </td>
304    <td>
305
306<p>
307Definitions of parameters.
308<p>
309
310<p>
311Definition 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>.
312<p>
313Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">Ogre::StringInterface::copyParametersTo()</a>.    </td>
314  </tr>
315</table>
316<hr>The documentation for this class was generated from the following file:<ul>
317<li><a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a></ul>
318<hr>
319<p>
320Copyright &copy; 2000-2005 by The OGRE Team<br />
321<!--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/>
322This 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/>
323                <!--/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#">
324                <Work rdf:about="">
325                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
326        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
327                </Work>
328                <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> -->
329
330Last modified Sun Feb 12 13:04:09 2006
331</p>
332</body>
333</html>
Note: See TracBrowser for help on using the repository browser.