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

Revision 657, 25.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::StringUtil 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::StringUtil Class Reference</h1>Utility class for manipulating Strings. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreString_8h-source.html">OgreString.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1StringUtil-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::ostringstream&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtilw0">StrStreamType</a></td></tr>
19
20<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile0">trim</a> (<a class="el" href="namespaceOgre.html#a426">String</a> &amp;str, bool left=true, bool right=true)</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes any whitespace characters, be it standard space or TABs and so on.  <a href="#Ogre_1_1StringUtile0"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector&lt; <a class="el" href="namespaceOgre.html#a426">String</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile1">split</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;str, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;delims="\t\n", unsigned int maxSplits=0)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a StringVector that contains all the substrings delimited by the characters in the passed <code>delims</code> argument.  <a href="#Ogre_1_1StringUtile1"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile2">toLowerCase</a> (<a class="el" href="namespaceOgre.html#a426">String</a> &amp;str)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Upper-cases all the characters in the string.  <a href="#Ogre_1_1StringUtile2"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile3">toUpperCase</a> (<a class="el" href="namespaceOgre.html#a426">String</a> &amp;str)</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lower-cases all the characters in the string.  <a href="#Ogre_1_1StringUtile3"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile4">toReal</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;str)</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts the contents of the string to a Real.  <a href="#Ogre_1_1StringUtile4"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile5">startsWith</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;str, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;pattern, bool lowerCase=true)</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether the string begins with the pattern passed in.  <a href="#Ogre_1_1StringUtile5"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile6">endsWith</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;str, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;pattern, bool lowerCase=true)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether the string ends with the pattern passed in.  <a href="#Ogre_1_1StringUtile6"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile7">standardisePath</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;init)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for standardising paths - use forward slashes only, end with slash.  <a href="#Ogre_1_1StringUtile7"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile8">splitFilename</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;qualifiedName, <a class="el" href="namespaceOgre.html#a426">String</a> &amp;outBasename, <a class="el" href="namespaceOgre.html#a426">String</a> &amp;outPath)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for splitting a fully qualified filename into the base name and path.  <a href="#Ogre_1_1StringUtile8"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtile9">match</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;str, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;pattern, bool caseSensitive=true)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple pattern-matching routine allowing a wildcard pattern.  <a href="#Ogre_1_1StringUtile9"></a><br><br></td></tr>
51<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">BLANK</a></td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant blank string, useful for returning by ref where local does not exist.  <a href="#Ogre_1_1StringUtils0"></a><br><br></td></tr>
55</table>
56<hr><a name="_details"></a><h2>Detailed Description</h2>
57Utility class for manipulating Strings.
58<p>
59
60<p>
61Definition at line <a class="el" href="OgreString_8h-source.html#l00085">85</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.<hr><h2>Member Typedef Documentation</h2>
62<a class="anchor" name="Ogre_1_1StringUtilw0" doxytag="Ogre::StringUtil::StrStreamType" ></a><p>
63<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
64  <tr>
65    <td class="mdRow">
66      <table cellpadding="0" cellspacing="0" border="0">
67        <tr>
68          <td class="md" nowrap valign="top"> typedef std::ostringstream <a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtilw0">Ogre::StringUtil::StrStreamType</a>
69      </table>
70    </td>
71  </tr>
72</table>
73<table cellspacing=5 cellpadding=0 border=0>
74  <tr>
75    <td>
76      &nbsp;
77    </td>
78    <td>
79
80<p>
81
82<p>
83Definition at line <a class="el" href="OgreString_8h-source.html#l00088">88</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.    </td>
84  </tr>
85</table>
86<hr><h2>Member Function Documentation</h2>
87<a class="anchor" name="Ogre_1_1StringUtile6" doxytag="Ogre::StringUtil::endsWith" ></a><p>
88<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
89  <tr>
90    <td class="mdRow">
91      <table cellpadding="0" cellspacing="0" border="0">
92        <tr>
93          <td class="md" nowrap valign="top"> bool Ogre::StringUtil::endsWith </td>
94          <td class="md" valign="top">(&nbsp;</td>
95          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
96          <td class="mdname" nowrap> <em>str</em>, </td>
97        </tr>
98        <tr>
99          <td class="md" nowrap align="right"></td>
100          <td></td>
101          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
102          <td class="mdname" nowrap> <em>pattern</em>, </td>
103        </tr>
104        <tr>
105          <td class="md" nowrap align="right"></td>
106          <td></td>
107          <td class="md" nowrap>bool&nbsp;</td>
108          <td class="mdname" nowrap> <em>lowerCase</em> = true</td>
109        </tr>
110        <tr>
111          <td></td>
112          <td class="md">)&nbsp;</td>
113          <td class="md" colspan="2"><code> [static]</code></td>
114        </tr>
115
116      </table>
117    </td>
118  </tr>
119</table>
120<table cellspacing=5 cellpadding=0 border=0>
121  <tr>
122    <td>
123      &nbsp;
124    </td>
125    <td>
126
127<p>
128Returns whether the string ends with the pattern passed in.
129<p>
130<dl compact><dt><b>Parameters:</b></dt><dd>
131  <table border="0" cellspacing="2" cellpadding="0">
132    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to compare with. </td></tr>
133    <tr><td valign=top><em>lowerCase</em>&nbsp;</td><td>If true, the end of the string will be lower cased before comparison, pattern should also be in lower case. </td></tr>
134  </table>
135</dl>
136    </td>
137  </tr>
138</table>
139<a class="anchor" name="Ogre_1_1StringUtile9" doxytag="Ogre::StringUtil::match" ></a><p>
140<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
141  <tr>
142    <td class="mdRow">
143      <table cellpadding="0" cellspacing="0" border="0">
144        <tr>
145          <td class="md" nowrap valign="top"> bool Ogre::StringUtil::match </td>
146          <td class="md" valign="top">(&nbsp;</td>
147          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
148          <td class="mdname" nowrap> <em>str</em>, </td>
149        </tr>
150        <tr>
151          <td class="md" nowrap align="right"></td>
152          <td></td>
153          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
154          <td class="mdname" nowrap> <em>pattern</em>, </td>
155        </tr>
156        <tr>
157          <td class="md" nowrap align="right"></td>
158          <td></td>
159          <td class="md" nowrap>bool&nbsp;</td>
160          <td class="mdname" nowrap> <em>caseSensitive</em> = true</td>
161        </tr>
162        <tr>
163          <td></td>
164          <td class="md">)&nbsp;</td>
165          <td class="md" colspan="2"><code> [static]</code></td>
166        </tr>
167
168      </table>
169    </td>
170  </tr>
171</table>
172<table cellspacing=5 cellpadding=0 border=0>
173  <tr>
174    <td>
175      &nbsp;
176    </td>
177    <td>
178
179<p>
180Simple pattern-matching routine allowing a wildcard pattern.
181<p>
182<dl compact><dt><b>Parameters:</b></dt><dd>
183  <table border="0" cellspacing="2" cellpadding="0">
184    <tr><td valign=top><em>str</em>&nbsp;</td><td>String to test </td></tr>
185    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>Pattern to match against; can include simple '*' wildcards </td></tr>
186    <tr><td valign=top><em>caseSensitive</em>&nbsp;</td><td>Whether the match is case sensitive or not </td></tr>
187  </table>
188</dl>
189    </td>
190  </tr>
191</table>
192<a class="anchor" name="Ogre_1_1StringUtile1" doxytag="Ogre::StringUtil::split" ></a><p>
193<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
194  <tr>
195    <td class="mdRow">
196      <table cellpadding="0" cellspacing="0" border="0">
197        <tr>
198          <td class="md" nowrap valign="top"> std::vector&lt; <a class="el" href="namespaceOgre.html#a426">String</a> &gt; Ogre::StringUtil::split </td>
199          <td class="md" valign="top">(&nbsp;</td>
200          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
201          <td class="mdname" nowrap> <em>str</em>, </td>
202        </tr>
203        <tr>
204          <td class="md" nowrap align="right"></td>
205          <td></td>
206          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
207          <td class="mdname" nowrap> <em>delims</em> = "\t\n", </td>
208        </tr>
209        <tr>
210          <td class="md" nowrap align="right"></td>
211          <td></td>
212          <td class="md" nowrap>unsigned int&nbsp;</td>
213          <td class="mdname" nowrap> <em>maxSplits</em> = 0</td>
214        </tr>
215        <tr>
216          <td></td>
217          <td class="md">)&nbsp;</td>
218          <td class="md" colspan="2"><code> [static]</code></td>
219        </tr>
220
221      </table>
222    </td>
223  </tr>
224</table>
225<table cellspacing=5 cellpadding=0 border=0>
226  <tr>
227    <td>
228      &nbsp;
229    </td>
230    <td>
231
232<p>
233Returns a StringVector that contains all the substrings delimited by the characters in the passed <code>delims</code> argument.
234<p>
235<dl compact><dt><b>Parameters:</b></dt><dd>
236  <table border="0" cellspacing="2" cellpadding="0">
237    <tr><td valign=top><em>delims</em>&nbsp;</td><td>A list of delimiter characters to split by </td></tr>
238    <tr><td valign=top><em>maxSplits</em>&nbsp;</td><td>The maximum number of splits to perform (0 for unlimited splits). If this parameters is &gt; 0, the splitting process will stop after this many splits, left to right. </td></tr>
239  </table>
240</dl>
241    </td>
242  </tr>
243</table>
244<a class="anchor" name="Ogre_1_1StringUtile8" doxytag="Ogre::StringUtil::splitFilename" ></a><p>
245<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
246  <tr>
247    <td class="mdRow">
248      <table cellpadding="0" cellspacing="0" border="0">
249        <tr>
250          <td class="md" nowrap valign="top"> void Ogre::StringUtil::splitFilename </td>
251          <td class="md" valign="top">(&nbsp;</td>
252          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
253          <td class="mdname" nowrap> <em>qualifiedName</em>, </td>
254        </tr>
255        <tr>
256          <td class="md" nowrap align="right"></td>
257          <td></td>
258          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
259          <td class="mdname" nowrap> <em>outBasename</em>, </td>
260        </tr>
261        <tr>
262          <td class="md" nowrap align="right"></td>
263          <td></td>
264          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
265          <td class="mdname" nowrap> <em>outPath</em></td>
266        </tr>
267        <tr>
268          <td></td>
269          <td class="md">)&nbsp;</td>
270          <td class="md" colspan="2"><code> [static]</code></td>
271        </tr>
272
273      </table>
274    </td>
275  </tr>
276</table>
277<table cellspacing=5 cellpadding=0 border=0>
278  <tr>
279    <td>
280      &nbsp;
281    </td>
282    <td>
283
284<p>
285Method for splitting a fully qualified filename into the base name and path.
286<p>
287<dl compact><dt><b>Remarks:</b></dt><dd>Path is standardised as in standardisePath </dd></dl>
288    </td>
289  </tr>
290</table>
291<a class="anchor" name="Ogre_1_1StringUtile7" doxytag="Ogre::StringUtil::standardisePath" ></a><p>
292<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
293  <tr>
294    <td class="mdRow">
295      <table cellpadding="0" cellspacing="0" border="0">
296        <tr>
297          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::StringUtil::standardisePath </td>
298          <td class="md" valign="top">(&nbsp;</td>
299          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
300          <td class="mdname1" valign="top" nowrap> <em>init</em>          </td>
301          <td class="md" valign="top">&nbsp;)&nbsp;</td>
302          <td class="md" nowrap><code> [static]</code></td>
303        </tr>
304
305      </table>
306    </td>
307  </tr>
308</table>
309<table cellspacing=5 cellpadding=0 border=0>
310  <tr>
311    <td>
312      &nbsp;
313    </td>
314    <td>
315
316<p>
317Method for standardising paths - use forward slashes only, end with slash.
318<p>
319    </td>
320  </tr>
321</table>
322<a class="anchor" name="Ogre_1_1StringUtile5" doxytag="Ogre::StringUtil::startsWith" ></a><p>
323<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
324  <tr>
325    <td class="mdRow">
326      <table cellpadding="0" cellspacing="0" border="0">
327        <tr>
328          <td class="md" nowrap valign="top"> bool Ogre::StringUtil::startsWith </td>
329          <td class="md" valign="top">(&nbsp;</td>
330          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
331          <td class="mdname" nowrap> <em>str</em>, </td>
332        </tr>
333        <tr>
334          <td class="md" nowrap align="right"></td>
335          <td></td>
336          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
337          <td class="mdname" nowrap> <em>pattern</em>, </td>
338        </tr>
339        <tr>
340          <td class="md" nowrap align="right"></td>
341          <td></td>
342          <td class="md" nowrap>bool&nbsp;</td>
343          <td class="mdname" nowrap> <em>lowerCase</em> = true</td>
344        </tr>
345        <tr>
346          <td></td>
347          <td class="md">)&nbsp;</td>
348          <td class="md" colspan="2"><code> [static]</code></td>
349        </tr>
350
351      </table>
352    </td>
353  </tr>
354</table>
355<table cellspacing=5 cellpadding=0 border=0>
356  <tr>
357    <td>
358      &nbsp;
359    </td>
360    <td>
361
362<p>
363Returns whether the string begins with the pattern passed in.
364<p>
365<dl compact><dt><b>Parameters:</b></dt><dd>
366  <table border="0" cellspacing="2" cellpadding="0">
367    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to compare with. </td></tr>
368    <tr><td valign=top><em>lowerCase</em>&nbsp;</td><td>If true, the end of the string will be lower cased before comparison, pattern should also be in lower case. </td></tr>
369  </table>
370</dl>
371    </td>
372  </tr>
373</table>
374<a class="anchor" name="Ogre_1_1StringUtile2" doxytag="Ogre::StringUtil::toLowerCase" ></a><p>
375<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
376  <tr>
377    <td class="mdRow">
378      <table cellpadding="0" cellspacing="0" border="0">
379        <tr>
380          <td class="md" nowrap valign="top"> void Ogre::StringUtil::toLowerCase </td>
381          <td class="md" valign="top">(&nbsp;</td>
382          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
383          <td class="mdname1" valign="top" nowrap> <em>str</em>          </td>
384          <td class="md" valign="top">&nbsp;)&nbsp;</td>
385          <td class="md" nowrap><code> [static]</code></td>
386        </tr>
387
388      </table>
389    </td>
390  </tr>
391</table>
392<table cellspacing=5 cellpadding=0 border=0>
393  <tr>
394    <td>
395      &nbsp;
396    </td>
397    <td>
398
399<p>
400Upper-cases all the characters in the string.
401<p>
402    </td>
403  </tr>
404</table>
405<a class="anchor" name="Ogre_1_1StringUtile4" doxytag="Ogre::StringUtil::toReal" ></a><p>
406<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
407  <tr>
408    <td class="mdRow">
409      <table cellpadding="0" cellspacing="0" border="0">
410        <tr>
411          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::StringUtil::toReal </td>
412          <td class="md" valign="top">(&nbsp;</td>
413          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
414          <td class="mdname1" valign="top" nowrap> <em>str</em>          </td>
415          <td class="md" valign="top">&nbsp;)&nbsp;</td>
416          <td class="md" nowrap><code> [static]</code></td>
417        </tr>
418
419      </table>
420    </td>
421  </tr>
422</table>
423<table cellspacing=5 cellpadding=0 border=0>
424  <tr>
425    <td>
426      &nbsp;
427    </td>
428    <td>
429
430<p>
431Converts the contents of the string to a Real.
432<p>
433<dl compact><dt><b>Remarks:</b></dt><dd>Assumes the only contents of the string are a valid parsable Real. Defaults to a value of 0.0 if conversion is not possible. </dd></dl>
434    </td>
435  </tr>
436</table>
437<a class="anchor" name="Ogre_1_1StringUtile3" doxytag="Ogre::StringUtil::toUpperCase" ></a><p>
438<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
439  <tr>
440    <td class="mdRow">
441      <table cellpadding="0" cellspacing="0" border="0">
442        <tr>
443          <td class="md" nowrap valign="top"> void Ogre::StringUtil::toUpperCase </td>
444          <td class="md" valign="top">(&nbsp;</td>
445          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
446          <td class="mdname1" valign="top" nowrap> <em>str</em>          </td>
447          <td class="md" valign="top">&nbsp;)&nbsp;</td>
448          <td class="md" nowrap><code> [static]</code></td>
449        </tr>
450
451      </table>
452    </td>
453  </tr>
454</table>
455<table cellspacing=5 cellpadding=0 border=0>
456  <tr>
457    <td>
458      &nbsp;
459    </td>
460    <td>
461
462<p>
463Lower-cases all the characters in the string.
464<p>
465    </td>
466  </tr>
467</table>
468<a class="anchor" name="Ogre_1_1StringUtile0" doxytag="Ogre::StringUtil::trim" ></a><p>
469<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
470  <tr>
471    <td class="mdRow">
472      <table cellpadding="0" cellspacing="0" border="0">
473        <tr>
474          <td class="md" nowrap valign="top"> void Ogre::StringUtil::trim </td>
475          <td class="md" valign="top">(&nbsp;</td>
476          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
477          <td class="mdname" nowrap> <em>str</em>, </td>
478        </tr>
479        <tr>
480          <td class="md" nowrap align="right"></td>
481          <td></td>
482          <td class="md" nowrap>bool&nbsp;</td>
483          <td class="mdname" nowrap> <em>left</em> = true, </td>
484        </tr>
485        <tr>
486          <td class="md" nowrap align="right"></td>
487          <td></td>
488          <td class="md" nowrap>bool&nbsp;</td>
489          <td class="mdname" nowrap> <em>right</em> = true</td>
490        </tr>
491        <tr>
492          <td></td>
493          <td class="md">)&nbsp;</td>
494          <td class="md" colspan="2"><code> [static]</code></td>
495        </tr>
496
497      </table>
498    </td>
499  </tr>
500</table>
501<table cellspacing=5 cellpadding=0 border=0>
502  <tr>
503    <td>
504      &nbsp;
505    </td>
506    <td>
507
508<p>
509Removes any whitespace characters, be it standard space or TABs and so on.
510<p>
511<dl compact><dt><b>Remarks:</b></dt><dd>The user may specify wether they want to trim only the beginning or the end of the String ( the default action is to trim both). </dd></dl>
512    </td>
513  </tr>
514</table>
515<hr><h2>Member Data Documentation</h2>
516<a class="anchor" name="Ogre_1_1StringUtils0" doxytag="Ogre::StringUtil::BLANK" ></a><p>
517<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
518  <tr>
519    <td class="mdRow">
520      <table cellpadding="0" cellspacing="0" border="0">
521        <tr>
522          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">Ogre::StringUtil::BLANK</a><code> [static]</code>
523      </table>
524    </td>
525  </tr>
526</table>
527<table cellspacing=5 cellpadding=0 border=0>
528  <tr>
529    <td>
530      &nbsp;
531    </td>
532    <td>
533
534<p>
535Constant blank string, useful for returning by ref where local does not exist.
536<p>
537
538<p>
539Definition at line <a class="el" href="OgreString_8h-source.html#l00162">162</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.    </td>
540  </tr>
541</table>
542<hr>The documentation for this class was generated from the following file:<ul>
543<li><a class="el" href="OgreString_8h-source.html">OgreString.h</a></ul>
544<hr>
545<p>
546Copyright &copy; 2000-2005 by The OGRE Team<br />
547<!--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/>
548This 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/>
549                <!--/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#">
550                <Work rdf:about="">
551                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
552        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
553                </Work>
554                <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> -->
555
556Last modified Sun Feb 12 13:04:06 2006
557</p>
558</body>
559</html>
Note: See TracBrowser for help on using the repository browser.