source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1ConfigFile.html @ 692

Revision 692, 31.6 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::ConfigFile 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::ConfigFile Class Reference</h1>Class for quickly loading settings from a text file. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1ConfigFile-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 Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::multimap&lt; <a class="el" href="namespaceOgre.html#a471">String</a>,<br>
19 <a class="el" href="namespaceOgre.html#a471">String</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew0">SettingsMultiMap</a></td></tr>
20
21<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a>&lt; <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew0">SettingsMultiMap</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew1">SettingsIterator</a></td></tr>
22
23<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a471">String</a>,<br>
24 <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew0">SettingsMultiMap</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew2">SettingsBySection</a></td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets an iterator for stepping through all the keys / values in the file.  <a href="#Ogre_1_1ConfigFilew2"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a>&lt; <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew2">SettingsBySection</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew3">SectionIterator</a></td></tr>
28
29<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea0">ConfigFile</a> ()</td></tr>
31
32<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea1">~ConfigFile</a> ()</td></tr>
33
34<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea2">load</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;filename, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;separators="\t:=", bool trimWhitespace=true)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">load from a filename (not using resource group locations)  <a href="#Ogre_1_1ConfigFilea2"></a><br><br></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea3">load</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;filename, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;resourceGroup, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;separators="\t:=", bool trimWhitespace=true)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">load from a filename (using resource group locations)  <a href="#Ogre_1_1ConfigFilea3"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea4">load</a> (const <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;stream, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;separators="\t:=", bool trimWhitespace=true)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">load from a data stream  <a href="#Ogre_1_1ConfigFilea4"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea5">loadDirect</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;filename, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;separators="\t:=", bool trimWhitespace=true)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">load from a filename (not using resource group locations)  <a href="#Ogre_1_1ConfigFilea5"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea6">loadFromResourceSystem</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;filename, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;resourceGroup, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;separators="\t:=", bool trimWhitespace=true)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">load from a filename (using resource group locations)  <a href="#Ogre_1_1ConfigFilea6"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea7">getSetting</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;key, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;section=<a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a>) const </td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the first setting from the file with the named key.  <a href="#Ogre_1_1ConfigFilea7"></a><br><br></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a580">StringVector</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea8">getMultiSetting</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;key, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;section=<a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a>) const </td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets all settings from the file with the named key.  <a href="#Ogre_1_1ConfigFilea8"></a><br><br></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1MapIterator.html">SectionIterator</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea9">getSectionIterator</a> (void)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an iterator over all the available sections in the config file.  <a href="#Ogre_1_1ConfigFilea9"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1MapIterator.html">SettingsIterator</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea10">getSettingsIterator</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;section=<a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a>)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an iterator over all the available settings in a section.  <a href="#Ogre_1_1ConfigFilea10"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilea11">clear</a> (void)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear the settings.  <a href="#Ogre_1_1ConfigFilea11"></a><br><br></td></tr>
64<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew2">SettingsBySection</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilep0">mSettings</a></td></tr>
66
67</table>
68<hr><a name="_details"></a><h2>Detailed Description</h2>
69Class for quickly loading settings from a text file.
70<p>
71<dl compact><dt><b>Remarks:</b></dt><dd>This class is designed to quickly parse a simple file containing key/value pairs, mainly for use in configuration settings. </dd></dl>
72<dl compact><dt><b></b></dt><dd>This is a very simplified approach, no multiple values per key are allowed, no grouping or context is being kept etc. </dd></dl>
73<dl compact><dt><b></b></dt><dd>By default the key/values pairs are tokenised based on a separator of Tab, the colon (:) or equals (=) character. Each key - value pair must end in a carriage return. </dd></dl>
74<dl compact><dt><b></b></dt><dd>Settings can be optionally grouped in sections, using a header beforehand of the form [SectionName]. </dd></dl>
75
76<p>
77
78<p>
79Definition at line <a class="el" href="OgreConfigFile_8h-source.html#l00052">52</a> of file <a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a>.<hr><h2>Member Typedef Documentation</h2>
80<a class="anchor" name="Ogre_1_1ConfigFilew3" doxytag="Ogre::ConfigFile::SectionIterator" ></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"> typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a>&lt;<a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew2">SettingsBySection</a>&gt; <a class="el" href="classOgre_1_1MapIterator.html">Ogre::ConfigFile::SectionIterator</a>
87      </table>
88    </td>
89  </tr>
90</table>
91<table cellspacing=5 cellpadding=0 border=0>
92  <tr>
93    <td>
94      &nbsp;
95    </td>
96    <td>
97
98<p>
99
100<p>
101Definition at line <a class="el" href="OgreConfigFile_8h-source.html#l00081">81</a> of file <a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a>.    </td>
102  </tr>
103</table>
104<a class="anchor" name="Ogre_1_1ConfigFilew2" doxytag="Ogre::ConfigFile::SettingsBySection" ></a><p>
105<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
106  <tr>
107    <td class="mdRow">
108      <table cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <td class="md" nowrap valign="top"> typedef std::map&lt;<a class="el" href="namespaceOgre.html#a471">String</a>, <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew0">SettingsMultiMap</a>*&gt; <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew2">Ogre::ConfigFile::SettingsBySection</a>
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing=5 cellpadding=0 border=0>
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Gets an iterator for stepping through all the keys / values in the file.
124<p>
125
126<p>
127Definition at line <a class="el" href="OgreConfigFile_8h-source.html#l00080">80</a> of file <a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a>.    </td>
128  </tr>
129</table>
130<a class="anchor" name="Ogre_1_1ConfigFilew1" doxytag="Ogre::ConfigFile::SettingsIterator" ></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"> typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a>&lt;<a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew0">SettingsMultiMap</a>&gt; <a class="el" href="classOgre_1_1MapIterator.html">Ogre::ConfigFile::SettingsIterator</a>
137      </table>
138    </td>
139  </tr>
140</table>
141<table cellspacing=5 cellpadding=0 border=0>
142  <tr>
143    <td>
144      &nbsp;
145    </td>
146    <td>
147
148<p>
149
150<p>
151Definition at line <a class="el" href="OgreConfigFile_8h-source.html#l00078">78</a> of file <a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a>.    </td>
152  </tr>
153</table>
154<a class="anchor" name="Ogre_1_1ConfigFilew0" doxytag="Ogre::ConfigFile::SettingsMultiMap" ></a><p>
155<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
156  <tr>
157    <td class="mdRow">
158      <table cellpadding="0" cellspacing="0" border="0">
159        <tr>
160          <td class="md" nowrap valign="top"> typedef std::multimap&lt;<a class="el" href="namespaceOgre.html#a471">String</a>, <a class="el" href="namespaceOgre.html#a471">String</a>&gt; <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew0">Ogre::ConfigFile::SettingsMultiMap</a>
161      </table>
162    </td>
163  </tr>
164</table>
165<table cellspacing=5 cellpadding=0 border=0>
166  <tr>
167    <td>
168      &nbsp;
169    </td>
170    <td>
171
172<p>
173
174<p>
175Definition at line <a class="el" href="OgreConfigFile_8h-source.html#l00077">77</a> of file <a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a>.    </td>
176  </tr>
177</table>
178<hr><h2>Constructor &amp; Destructor Documentation</h2>
179<a class="anchor" name="Ogre_1_1ConfigFilea0" doxytag="Ogre::ConfigFile::ConfigFile" ></a><p>
180<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
181  <tr>
182    <td class="mdRow">
183      <table cellpadding="0" cellspacing="0" border="0">
184        <tr>
185          <td class="md" nowrap valign="top"> Ogre::ConfigFile::ConfigFile </td>
186          <td class="md" valign="top">(&nbsp;</td>
187          <td class="mdname1" valign="top" nowrap>          </td>
188          <td class="md" valign="top">&nbsp;)&nbsp;</td>
189          <td class="md" nowrap></td>
190        </tr>
191
192      </table>
193    </td>
194  </tr>
195</table>
196<table cellspacing=5 cellpadding=0 border=0>
197  <tr>
198    <td>
199      &nbsp;
200    </td>
201    <td>
202
203<p>
204    </td>
205  </tr>
206</table>
207<a class="anchor" name="Ogre_1_1ConfigFilea1" doxytag="Ogre::ConfigFile::~ConfigFile" ></a><p>
208<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
209  <tr>
210    <td class="mdRow">
211      <table cellpadding="0" cellspacing="0" border="0">
212        <tr>
213          <td class="md" nowrap valign="top"> virtual Ogre::ConfigFile::~<a class="el" href="classOgre_1_1ConfigFile.html">ConfigFile</a> </td>
214          <td class="md" valign="top">(&nbsp;</td>
215          <td class="mdname1" valign="top" nowrap>          </td>
216          <td class="md" valign="top">&nbsp;)&nbsp;</td>
217          <td class="md" nowrap><code> [virtual]</code></td>
218        </tr>
219
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing=5 cellpadding=0 border=0>
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232    </td>
233  </tr>
234</table>
235<hr><h2>Member Function Documentation</h2>
236<a class="anchor" name="Ogre_1_1ConfigFilea11" doxytag="Ogre::ConfigFile::clear" ></a><p>
237<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
238  <tr>
239    <td class="mdRow">
240      <table cellpadding="0" cellspacing="0" border="0">
241        <tr>
242          <td class="md" nowrap valign="top"> void Ogre::ConfigFile::clear </td>
243          <td class="md" valign="top">(&nbsp;</td>
244          <td class="md" nowrap valign="top">void&nbsp;</td>
245          <td class="mdname1" valign="top" nowrap>          </td>
246          <td class="md" valign="top">&nbsp;)&nbsp;</td>
247          <td class="md" nowrap></td>
248        </tr>
249
250      </table>
251    </td>
252  </tr>
253</table>
254<table cellspacing=5 cellpadding=0 border=0>
255  <tr>
256    <td>
257      &nbsp;
258    </td>
259    <td>
260
261<p>
262Clear the settings.
263<p>
264    </td>
265  </tr>
266</table>
267<a class="anchor" name="Ogre_1_1ConfigFilea8" doxytag="Ogre::ConfigFile::getMultiSetting" ></a><p>
268<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
269  <tr>
270    <td class="mdRow">
271      <table cellpadding="0" cellspacing="0" border="0">
272        <tr>
273          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a580">StringVector</a> Ogre::ConfigFile::getMultiSetting </td>
274          <td class="md" valign="top">(&nbsp;</td>
275          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
276          <td class="mdname" nowrap> <em>key</em>, </td>
277        </tr>
278        <tr>
279          <td class="md" nowrap align="right"></td>
280          <td></td>
281          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
282          <td class="mdname" nowrap> <em>section</em> = <a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a></td>
283        </tr>
284        <tr>
285          <td></td>
286          <td class="md">)&nbsp;</td>
287          <td class="md" colspan="2"> const</td>
288        </tr>
289
290      </table>
291    </td>
292  </tr>
293</table>
294<table cellspacing=5 cellpadding=0 border=0>
295  <tr>
296    <td>
297      &nbsp;
298    </td>
299    <td>
300
301<p>
302Gets all settings from the file with the named key.
303<p>
304    </td>
305  </tr>
306</table>
307<a class="anchor" name="Ogre_1_1ConfigFilea9" doxytag="Ogre::ConfigFile::getSectionIterator" ></a><p>
308<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
309  <tr>
310    <td class="mdRow">
311      <table cellpadding="0" cellspacing="0" border="0">
312        <tr>
313          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1MapIterator.html">SectionIterator</a> Ogre::ConfigFile::getSectionIterator </td>
314          <td class="md" valign="top">(&nbsp;</td>
315          <td class="md" nowrap valign="top">void&nbsp;</td>
316          <td class="mdname1" valign="top" nowrap>          </td>
317          <td class="md" valign="top">&nbsp;)&nbsp;</td>
318          <td class="md" nowrap></td>
319        </tr>
320
321      </table>
322    </td>
323  </tr>
324</table>
325<table cellspacing=5 cellpadding=0 border=0>
326  <tr>
327    <td>
328      &nbsp;
329    </td>
330    <td>
331
332<p>
333Get an iterator over all the available sections in the config file.
334<p>
335    </td>
336  </tr>
337</table>
338<a class="anchor" name="Ogre_1_1ConfigFilea7" doxytag="Ogre::ConfigFile::getSetting" ></a><p>
339<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
340  <tr>
341    <td class="mdRow">
342      <table cellpadding="0" cellspacing="0" border="0">
343        <tr>
344          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::ConfigFile::getSetting </td>
345          <td class="md" valign="top">(&nbsp;</td>
346          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
347          <td class="mdname" nowrap> <em>key</em>, </td>
348        </tr>
349        <tr>
350          <td class="md" nowrap align="right"></td>
351          <td></td>
352          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
353          <td class="mdname" nowrap> <em>section</em> = <a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a></td>
354        </tr>
355        <tr>
356          <td></td>
357          <td class="md">)&nbsp;</td>
358          <td class="md" colspan="2"> const</td>
359        </tr>
360
361      </table>
362    </td>
363  </tr>
364</table>
365<table cellspacing=5 cellpadding=0 border=0>
366  <tr>
367    <td>
368      &nbsp;
369    </td>
370    <td>
371
372<p>
373Gets the first setting from the file with the named key.
374<p>
375<dl compact><dt><b>Parameters:</b></dt><dd>
376  <table border="0" cellspacing="2" cellpadding="0">
377    <tr><td valign=top><em>key</em>&nbsp;</td><td>The name of the setting </td></tr>
378    <tr><td valign=top><em>section</em>&nbsp;</td><td>The name of the section it must be in (if any) </td></tr>
379  </table>
380</dl>
381    </td>
382  </tr>
383</table>
384<a class="anchor" name="Ogre_1_1ConfigFilea10" doxytag="Ogre::ConfigFile::getSettingsIterator" ></a><p>
385<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
386  <tr>
387    <td class="mdRow">
388      <table cellpadding="0" cellspacing="0" border="0">
389        <tr>
390          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1MapIterator.html">SettingsIterator</a> Ogre::ConfigFile::getSettingsIterator </td>
391          <td class="md" valign="top">(&nbsp;</td>
392          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
393          <td class="mdname1" valign="top" nowrap> <em>section</em> = <a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a>          </td>
394          <td class="md" valign="top">&nbsp;)&nbsp;</td>
395          <td class="md" nowrap></td>
396        </tr>
397
398      </table>
399    </td>
400  </tr>
401</table>
402<table cellspacing=5 cellpadding=0 border=0>
403  <tr>
404    <td>
405      &nbsp;
406    </td>
407    <td>
408
409<p>
410Get an iterator over all the available settings in a section.
411<p>
412    </td>
413  </tr>
414</table>
415<a class="anchor" name="Ogre_1_1ConfigFilea4" doxytag="Ogre::ConfigFile::load" ></a><p>
416<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
417  <tr>
418    <td class="mdRow">
419      <table cellpadding="0" cellspacing="0" border="0">
420        <tr>
421          <td class="md" nowrap valign="top"> void Ogre::ConfigFile::load </td>
422          <td class="md" valign="top">(&nbsp;</td>
423          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
424          <td class="mdname" nowrap> <em>stream</em>, </td>
425        </tr>
426        <tr>
427          <td class="md" nowrap align="right"></td>
428          <td></td>
429          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
430          <td class="mdname" nowrap> <em>separators</em> = "\t:=", </td>
431        </tr>
432        <tr>
433          <td class="md" nowrap align="right"></td>
434          <td></td>
435          <td class="md" nowrap>bool&nbsp;</td>
436          <td class="mdname" nowrap> <em>trimWhitespace</em> = true</td>
437        </tr>
438        <tr>
439          <td></td>
440          <td class="md">)&nbsp;</td>
441          <td class="md" colspan="2"></td>
442        </tr>
443
444      </table>
445    </td>
446  </tr>
447</table>
448<table cellspacing=5 cellpadding=0 border=0>
449  <tr>
450    <td>
451      &nbsp;
452    </td>
453    <td>
454
455<p>
456load from a data stream
457<p>
458    </td>
459  </tr>
460</table>
461<a class="anchor" name="Ogre_1_1ConfigFilea3" doxytag="Ogre::ConfigFile::load" ></a><p>
462<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
463  <tr>
464    <td class="mdRow">
465      <table cellpadding="0" cellspacing="0" border="0">
466        <tr>
467          <td class="md" nowrap valign="top"> void Ogre::ConfigFile::load </td>
468          <td class="md" valign="top">(&nbsp;</td>
469          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
470          <td class="mdname" nowrap> <em>filename</em>, </td>
471        </tr>
472        <tr>
473          <td class="md" nowrap align="right"></td>
474          <td></td>
475          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
476          <td class="mdname" nowrap> <em>resourceGroup</em>, </td>
477        </tr>
478        <tr>
479          <td class="md" nowrap align="right"></td>
480          <td></td>
481          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
482          <td class="mdname" nowrap> <em>separators</em> = "\t:=", </td>
483        </tr>
484        <tr>
485          <td class="md" nowrap align="right"></td>
486          <td></td>
487          <td class="md" nowrap>bool&nbsp;</td>
488          <td class="mdname" nowrap> <em>trimWhitespace</em> = true</td>
489        </tr>
490        <tr>
491          <td></td>
492          <td class="md">)&nbsp;</td>
493          <td class="md" colspan="2"></td>
494        </tr>
495
496      </table>
497    </td>
498  </tr>
499</table>
500<table cellspacing=5 cellpadding=0 border=0>
501  <tr>
502    <td>
503      &nbsp;
504    </td>
505    <td>
506
507<p>
508load from a filename (using resource group locations)
509<p>
510    </td>
511  </tr>
512</table>
513<a class="anchor" name="Ogre_1_1ConfigFilea2" doxytag="Ogre::ConfigFile::load" ></a><p>
514<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
515  <tr>
516    <td class="mdRow">
517      <table cellpadding="0" cellspacing="0" border="0">
518        <tr>
519          <td class="md" nowrap valign="top"> void Ogre::ConfigFile::load </td>
520          <td class="md" valign="top">(&nbsp;</td>
521          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
522          <td class="mdname" nowrap> <em>filename</em>, </td>
523        </tr>
524        <tr>
525          <td class="md" nowrap align="right"></td>
526          <td></td>
527          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
528          <td class="mdname" nowrap> <em>separators</em> = "\t:=", </td>
529        </tr>
530        <tr>
531          <td class="md" nowrap align="right"></td>
532          <td></td>
533          <td class="md" nowrap>bool&nbsp;</td>
534          <td class="mdname" nowrap> <em>trimWhitespace</em> = true</td>
535        </tr>
536        <tr>
537          <td></td>
538          <td class="md">)&nbsp;</td>
539          <td class="md" colspan="2"></td>
540        </tr>
541
542      </table>
543    </td>
544  </tr>
545</table>
546<table cellspacing=5 cellpadding=0 border=0>
547  <tr>
548    <td>
549      &nbsp;
550    </td>
551    <td>
552
553<p>
554load from a filename (not using resource group locations)
555<p>
556    </td>
557  </tr>
558</table>
559<a class="anchor" name="Ogre_1_1ConfigFilea5" doxytag="Ogre::ConfigFile::loadDirect" ></a><p>
560<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
561  <tr>
562    <td class="mdRow">
563      <table cellpadding="0" cellspacing="0" border="0">
564        <tr>
565          <td class="md" nowrap valign="top"> void Ogre::ConfigFile::loadDirect </td>
566          <td class="md" valign="top">(&nbsp;</td>
567          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
568          <td class="mdname" nowrap> <em>filename</em>, </td>
569        </tr>
570        <tr>
571          <td class="md" nowrap align="right"></td>
572          <td></td>
573          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
574          <td class="mdname" nowrap> <em>separators</em> = "\t:=", </td>
575        </tr>
576        <tr>
577          <td class="md" nowrap align="right"></td>
578          <td></td>
579          <td class="md" nowrap>bool&nbsp;</td>
580          <td class="mdname" nowrap> <em>trimWhitespace</em> = true</td>
581        </tr>
582        <tr>
583          <td></td>
584          <td class="md">)&nbsp;</td>
585          <td class="md" colspan="2"></td>
586        </tr>
587
588      </table>
589    </td>
590  </tr>
591</table>
592<table cellspacing=5 cellpadding=0 border=0>
593  <tr>
594    <td>
595      &nbsp;
596    </td>
597    <td>
598
599<p>
600load from a filename (not using resource group locations)
601<p>
602    </td>
603  </tr>
604</table>
605<a class="anchor" name="Ogre_1_1ConfigFilea6" doxytag="Ogre::ConfigFile::loadFromResourceSystem" ></a><p>
606<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
607  <tr>
608    <td class="mdRow">
609      <table cellpadding="0" cellspacing="0" border="0">
610        <tr>
611          <td class="md" nowrap valign="top"> void Ogre::ConfigFile::loadFromResourceSystem </td>
612          <td class="md" valign="top">(&nbsp;</td>
613          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
614          <td class="mdname" nowrap> <em>filename</em>, </td>
615        </tr>
616        <tr>
617          <td class="md" nowrap align="right"></td>
618          <td></td>
619          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
620          <td class="mdname" nowrap> <em>resourceGroup</em>, </td>
621        </tr>
622        <tr>
623          <td class="md" nowrap align="right"></td>
624          <td></td>
625          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
626          <td class="mdname" nowrap> <em>separators</em> = "\t:=", </td>
627        </tr>
628        <tr>
629          <td class="md" nowrap align="right"></td>
630          <td></td>
631          <td class="md" nowrap>bool&nbsp;</td>
632          <td class="mdname" nowrap> <em>trimWhitespace</em> = true</td>
633        </tr>
634        <tr>
635          <td></td>
636          <td class="md">)&nbsp;</td>
637          <td class="md" colspan="2"></td>
638        </tr>
639
640      </table>
641    </td>
642  </tr>
643</table>
644<table cellspacing=5 cellpadding=0 border=0>
645  <tr>
646    <td>
647      &nbsp;
648    </td>
649    <td>
650
651<p>
652load from a filename (using resource group locations)
653<p>
654    </td>
655  </tr>
656</table>
657<hr><h2>Member Data Documentation</h2>
658<a class="anchor" name="Ogre_1_1ConfigFilep0" doxytag="Ogre::ConfigFile::mSettings" ></a><p>
659<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
660  <tr>
661    <td class="mdRow">
662      <table cellpadding="0" cellspacing="0" border="0">
663        <tr>
664          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilew2">SettingsBySection</a> <a class="el" href="classOgre_1_1ConfigFile.html#Ogre_1_1ConfigFilep0">Ogre::ConfigFile::mSettings</a><code> [protected]</code>
665      </table>
666    </td>
667  </tr>
668</table>
669<table cellspacing=5 cellpadding=0 border=0>
670  <tr>
671    <td>
672      &nbsp;
673    </td>
674    <td>
675
676<p>
677
678<p>
679Definition at line <a class="el" href="OgreConfigFile_8h-source.html#l00092">92</a> of file <a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a>.    </td>
680  </tr>
681</table>
682<hr>The documentation for this class was generated from the following file:<ul>
683<li><a class="el" href="OgreConfigFile_8h-source.html">OgreConfigFile.h</a></ul>
684<hr>
685<p>
686Copyright &copy; 2000-2005 by The OGRE Team<br />
687<!--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/>
688This 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/>
689                <!--/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#">
690                <Work rdf:about="">
691                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
692        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
693                </Work>
694                <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> -->
695
696Last modified Sun Mar 12 14:38:35 2006
697</p>
698</body>
699</html>
Note: See TracBrowser for help on using the repository browser.