<html>
<head>
<title>Ogre::String class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::String Class Reference</h1>Wrapper object for <a class="el" href="classOgre_1_1String.html">String</a> to allow DLL export.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreString_8h-source.html">OgreString.h</a>></code>
<p>
Collaboration diagram for Ogre::String:<p><center><img src="classOgre_1_1String__coll__graph.png" border="0" usemap="#Ogre_1_1String__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1String__coll__map">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1String-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef std::stringstream </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Strings0">StrStreamType</a></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa0">String</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#Ogre_1_1Stringa0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa1">String</a> (const String &rhs)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa2">String</a> (const <a class="el" href="namespaceOgre.html#a417">_StringBase</a> &rhs)</td></tr>
<tr><td> </td><td><font size=-1><em>Copy constructor for std::string's.</em> <a href="#Ogre_1_1Stringa2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa3">String</a> (const char *rhs)</td></tr>
<tr><td> </td><td><font size=-1><em>Copy-constructor for C-style strings.</em> <a href="#Ogre_1_1Stringa3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa4">operator const char *</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Used for interaction with functions that require the old C-style strings.</em> <a href="#Ogre_1_1Stringa4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa5">trim</a> (bool left=true, bool right=true)</td></tr>
<tr><td> </td><td><font size=-1><em>Removes any whitespace characters, be it standard space or TABs and so on.</em> <a href="#Ogre_1_1Stringa5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::vector< String > </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa6">split</a> (const String &delims="\t\n", unsigned int maxSplits=0) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a StringVector that contains all the substrings delimited by the characters in the passed <code>delims</code> argument.</em> <a href="#Ogre_1_1Stringa6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>String </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa7">toLowerCase</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Upper-cases all the characters in the string.</em> <a href="#Ogre_1_1Stringa7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>String </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa8">toUpperCase</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Lower-cases all the characters in the string.</em> <a href="#Ogre_1_1Stringa8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa9">toReal</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Converts the contents of the string to a Real.</em> <a href="#Ogre_1_1Stringa9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa10">startsWith</a> (const String &pattern, bool lowerCase=true) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether the string begins with the pattern passed in.</em> <a href="#Ogre_1_1Stringa10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa11">endsWith</a> (const String &pattern, bool lowerCase=true) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether the string ends with the pattern passed in.</em> <a href="#Ogre_1_1Stringa11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>template<typename T> String & </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringa12">operator<<</a> (T value)</td></tr>
<tr><td> </td><td><font size=-1><em>Template operator for appending another type into the string.</em> <a href="#Ogre_1_1Stringa12"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>String </td><td valign=bottom><a class="el" href="classOgre_1_1String.html#Ogre_1_1Stringp0">BLANK</a> = String("")</td></tr>
<tr><td> </td><td><font size=-1><em>Constant blank string, useful for returning by ref where local does not exist.</em> <a href="#Ogre_1_1Stringp0"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Wrapper object for <a class="el" href="classOgre_1_1String.html">String</a> to allow DLL export.
<p>
<dl compact><dt><b>
Note: </b><dd>
Derived from std::string. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreString_8h-source.html#l00097">97</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.<hr><h2>Member Typedef Documentation</h2>
<a name="Ogre_1_1Strings0" doxytag="Ogre::String::StrStreamType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef std::stringstream Ogre::String::StrStreamType
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreString_8h-source.html#l00100">100</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>. </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1Stringa0" doxytag="Ogre::String::String"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::String::String </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>
Default constructor.
<p>
<p>
Definition at line <a class="el" href="OgreString_8h-source.html#l00104">104</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.
<p>
References <a class="el" href="OgreString_8h-source.html#l00035">Ogre::_StringBase</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Stringa1" doxytag="Ogre::String::String"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::String::String </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </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="OgreString_8h-source.html#l00106">106</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.
<p>
References <a class="el" href="OgreString_8h-source.html#l00035">Ogre::_StringBase</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Stringa2" doxytag="Ogre::String::String"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::String::String </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a417">_StringBase</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </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>
Copy constructor for std::string's.
<p>
<p>
Definition at line <a class="el" href="OgreString_8h-source.html#l00110">110</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.
<p>
References <a class="el" href="OgreString_8h-source.html#l00035">Ogre::_StringBase</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Stringa3" doxytag="Ogre::String::String"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::String::String </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </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>
Copy-constructor for C-style strings.
<p>
<p>
Definition at line <a class="el" href="OgreString_8h-source.html#l00114">114</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.
<p>
References <a class="el" href="OgreString_8h-source.html#l00035">Ogre::_StringBase</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1Stringa11" doxytag="Ogre::String::endsWith"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::String::endsWith </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>pattern</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>lowerCase</em> = true</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether the string ends with the pattern passed in.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pattern</em> </td><td>
The pattern to compare with. </td></tr>
<tr><td valign=top><em>lowerCase</em> </td><td>
If true, the end of the string will be lower cased before comparison, pattern should also be in lower case. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00143">143</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>.
<p>
References <a class="el" href="OgreString_8cpp-source.html#l00101">toLowerCase</a>().
<p>
Referenced by <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00264">Ogre::D3D9Texture::_loadCubeTex</a>(), and <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Stringa4" doxytag="Ogre::String::operator const char *"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::String::operator const char * </td>
<td class="md" valign="top">( </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>
Used for interaction with functions that require the old C-style strings.
<p>
<p>
Definition at line <a class="el" href="OgreString_8h-source.html#l00119">119</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Stringa12" doxytag="Ogre::String::operator<<"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<typename T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> String& Ogre::String::operator<< </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">T </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </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>
Template operator for appending another type into the string.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Because this operator is templated, you can append any value into a string as long as there is an operator<<(std::basic_iostream, type) or similar method defined somewhere. All the primitive types have this already, and many of the <a class="el" href="namespaceOgre.html">Ogre</a> types do too (see <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> for an example). </dl>
<p>
Definition at line <a class="el" href="OgreString_8h-source.html#l00183">183</a> of file <a class="el" href="OgreString_8h-source.html">OgreString.h</a>.
<p>
References <a class="el" href="OgreString_8h-source.html#l00035">Ogre::_StringBase</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Stringa6" doxytag="Ogre::String::split"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::vector< String > Ogre::String::split </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>delims</em> = "\t\n", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>maxSplits</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a StringVector that contains all the substrings delimited by the characters in the passed <code>delims</code> argument.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>delims</em> </td><td>
A list of delimiter characters to split by </td></tr>
<tr><td valign=top><em>maxSplits</em> </td><td>
The maximum number of splits to perform (0 for unlimited splits). If this parameters is > 0, the splitting process will stop after this many splits, left to right. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00060">60</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>.
<p>
Referenced by <a class="el" href="OgreCgProgram_8cpp-source.html#l00057">Ogre::CgProgram::buildArgs</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00107">Ogre::TextBoxGuiElement::CmdTextArea::doSet</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00086">Ogre::TextBoxGuiElement::CmdBackPanel::doSet</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00110">Ogre::ScrollBarGuiElement::CmdScrollBit::doSet</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00099">Ogre::ScrollBarGuiElement::CmdDownButton::doSet</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00088">Ogre::ScrollBarGuiElement::CmdUpButton::doSet</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00132">Ogre::PopupMenuGuiElement::CmdHSpacing::doSet</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00121">Ogre::PopupMenuGuiElement::CmdVSpacing::doSet</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00110">Ogre::PopupMenuGuiElement::CmdItemTemplate::doSet</a>(), <a class="el" href="OgrePanelGuiElement_8cpp-source.html#l00331">Ogre::PanelGuiElement::CmdTiling::doSet</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00153">Ogre::ListGuiElement::CmdHSpacing::doSet</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00139">Ogre::ListGuiElement::CmdScrollBar::doSet</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00127">Ogre::ListGuiElement::CmdVSpacing::doSet</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00115">Ogre::ListGuiElement::CmdItemTemplate::doSet</a>(), <a class="el" href="OgreCgProgram_8cpp-source.html#l00286">Ogre::CgProgram::CmdProfiles::doSet</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00421">Ogre::ButtonGuiElement::CmdButtonCaption::doSet</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00388">Ogre::ButtonGuiElement::CmdButtonDisabledMaterial::doSet</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00375">Ogre::ButtonGuiElement::CmdButtonHiliteUpMaterial::doSet</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00362">Ogre::ButtonGuiElement::CmdButtonHiliteDownMaterial::doSet</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00349">Ogre::ButtonGuiElement::CmdButtonUpMaterial::doSet</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00336">Ogre::ButtonGuiElement::CmdButtonDownMaterial::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00781">Ogre::BorderPanelGuiElement::CmdBorderBottomUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00764">Ogre::BorderPanelGuiElement::CmdBorderTopUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00747">Ogre::BorderPanelGuiElement::CmdBorderRightUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00730">Ogre::BorderPanelGuiElement::CmdBorderLeftUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00713">Ogre::BorderPanelGuiElement::CmdBorderTopRightUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00696">Ogre::BorderPanelGuiElement::CmdBorderTopLeftUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00679">Ogre::BorderPanelGuiElement::CmdBorderBottomRightUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00662">Ogre::BorderPanelGuiElement::CmdBorderBottomLeftUV::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00650">Ogre::BorderPanelGuiElement::CmdBorderMaterial::doSet</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00633">Ogre::BorderPanelGuiElement::CmdBorderSize::doSet</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00342">Ogre::BorderButtonGuiElement::CmdBorderButtonCaption::doSet</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00329">Ogre::BorderButtonGuiElement::CmdBorderDisabledMaterial::doSet</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00316">Ogre::BorderButtonGuiElement::CmdBorderHiliteUpMaterial::doSet</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00303">Ogre::BorderButtonGuiElement::CmdBorderHiliteDownMaterial::doSet</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00290">Ogre::BorderButtonGuiElement::CmdBorderUpMaterial::doSet</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00277">Ogre::BorderButtonGuiElement::CmdBorderDownMaterial::doSet</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01932">Ogre::MaterialSerializer::invokeParser</a>(), <a class="el" href="OgreSkeleton_8cpp-source.html#l00063">Ogre::Skeleton::load</a>(), <a class="el" href="OgreMesh_8cpp-source.html#l00123">Ogre::Mesh::load</a>(), <a class="el" href="OgreBspLevel_8cpp-source.html#l00640">Ogre::BspLevel::loadEntities</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00438">Ogre::ParticleSystemManager::parseAffectorAttrib</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00884">Ogre::parseAlphaOpEx</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00697">Ogre::parseAlphaRejection</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00101">Ogre::parseAmbient</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00581">Ogre::parseAnimTexture</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00406">Ogre::ParticleSystemManager::parseAttrib</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00395">Ogre::OverlayManager::parseAttrib</a>(), <a class="el" href="OgreFontManager_8cpp-source.html#l00126">Ogre::FontManager::parseAttribute</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00326">Ogre::OverlayManager::parseChildren</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00774">Ogre::parseColourOpEx</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00857">Ogre::parseColourOpFallback</a>(), <a class="el" href="OgreStringConverter_8cpp-source.html#l00268">Ogre::StringConverter::parseColourValue</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00613">Ogre::parseCubicTexture</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00118">Ogre::parseDiffuse</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00414">Ogre::OverlayManager::parseElementAttrib</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00154">Ogre::parseEmissive</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00422">Ogre::ParticleSystemManager::parseEmitterAttrib</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00504">Ogre::parseFiltering</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00434">Ogre::parseFogging</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01567">Ogre::parseFragmentProgram</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00387">Ogre::parseIteration</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01118">Ogre::parseLodDistances</a>(), <a class="el" href="OgreStringConverter_8cpp-source.html#l00218">Ogre::StringConverter::parseMatrix3</a>(), <a class="el" href="OgreStringConverter_8cpp-source.html#l00235">Ogre::StringConverter::parseMatrix4</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00451">Ogre::OverlayManager::parseNewMesh</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00062">Ogre::OverlayManager::parseOverlayFile</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01315">Ogre::parseParamIndexed</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01340">Ogre::parseParamIndexedAuto</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01365">Ogre::parseParamNamed</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01402">Ogre::parseParamNamedAuto</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01610">Ogre::parseProgramCustomParameter</a>(), <a class="el" href="OgreStringConverter_8cpp-source.html#l00253">Ogre::StringConverter::parseQuaternion</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01028">Ogre::parseScale</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00201">Ogre::parseSceneBlend</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00058">Ogre::ParticleSystemManager::parseScript</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01762">Ogre::MaterialSerializer::parseScriptLine</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00980">Ogre::parseScroll</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00996">Ogre::parseScrollAnim</a>(), <a class="el" href="OgreQuake3ShaderManager_8cpp-source.html#l00202">Ogre::Quake3ShaderManager::parseShaderAttrib</a>(), <a class="el" href="OgreQuake3ShaderManager_8cpp-source.html#l00255">Ogre::Quake3ShaderManager::parseShaderPassAttrib</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00135">Ogre::parseSpecular</a>(), <a class="el" href="OgreStringConverter_8cpp-source.html#l00287">Ogre::StringConverter::parseStringVector</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00548">Ogre::parseTexture</a>(), <a class="el" href="OgreStringConverter_8cpp-source.html#l00202">Ogre::StringConverter::parseVector3</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01541">Ogre::parseVertexProgram</a>(), and <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01043">Ogre::parseWaveXform</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Stringa10" doxytag="Ogre::String::startsWith"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::String::startsWith </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>pattern</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>lowerCase</em> = true</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether the string begins with the pattern passed in.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pattern</em> </td><td>
The pattern to compare with. </td></tr>
<tr><td valign=top><em>lowerCase</em> </td><td>
If true, the end of the string will be lower cased before comparison, pattern should also be in lower case. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00129">129</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>.
<p>
References <a class="el" href="OgreString_8cpp-source.html#l00101">toLowerCase</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Stringa7" doxytag="Ogre::String::toLowerCase"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String Ogre::String::toLowerCase </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Upper-cases all the characters in the string.
<p>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00101">101</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>.
<p>
Referenced by <a class="el" href="OgreString_8cpp-source.html#l00143">endsWith</a>(), <a class="el" href="OgreZip_8cpp-source.html#l00168">Ogre::Zip::getAllNamesLike</a>(), <a class="el" href="OgreQuake3Shader_8cpp-source.html#l00269">Ogre::Quake3Shader::getAlternateName</a>(), <a class="el" href="OgreCodec_8cpp-source.html#l00035">Ogre::Codec::getCodec</a>(), <a class="el" href="OgreSkeleton_8cpp-source.html#l00063">Ogre::Skeleton::load</a>(), <a class="el" href="OgreMesh_8cpp-source.html#l00123">Ogre::Mesh::load</a>(), <a class="el" href="OgreBspLevel_8cpp-source.html#l00640">Ogre::BspLevel::loadEntities</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00884">Ogre::parseAlphaOpEx</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00697">Ogre::parseAlphaRejection</a>(), <a class="el" href="OgreFontManager_8cpp-source.html#l00126">Ogre::FontManager::parseAttribute</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00679">Ogre::parseColourOp</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00774">Ogre::parseColourOpEx</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00857">Ogre::parseColourOpFallback</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00321">Ogre::parseColourWrite</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00336">Ogre::parseCullHardware</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00352">Ogre::parseCullSoftware</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00276">Ogre::parseDepthCheck</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00306">Ogre::parseDepthFunc</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00291">Ogre::parseDepthWrite</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00960">Ogre::parseEnvMap</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00504">Ogre::parseFiltering</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00434">Ogre::parseFogging</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01567">Ogre::parseFragmentProgram</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00387">Ogre::parseIteration</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00368">Ogre::parseLighting</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00379">Ogre::ParticleSystemManager::parseNewAffector</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00349">Ogre::ParticleSystemManager::parseNewEmitter</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01315">Ogre::parseParamIndexed</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01340">Ogre::parseParamIndexedAuto</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00201">Ogre::parseSceneBlend</a>(), <a class="el" href="OgreQuake3ShaderManager_8cpp-source.html#l00045">Ogre::Quake3ShaderManager::parseShaderFile</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00488">Ogre::parseShading</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l00663">Ogre::parseTexAddressMode</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01541">Ogre::parseVertexProgram</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01043">Ogre::parseWaveXform</a>(), and <a class="el" href="OgreString_8cpp-source.html#l00129">startsWith</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Stringa9" doxytag="Ogre::String::toReal"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::String::toReal </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>
Converts the contents of the string to a Real.
<p>
<dl compact><dt><b>
Remarks: </b><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. </dl>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00124">124</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Stringa8" doxytag="Ogre::String::toUpperCase"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String Ogre::String::toUpperCase </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Lower-cases all the characters in the string.
<p>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00113">113</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Stringa5" doxytag="Ogre::String::trim"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::String::trim </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname" nowrap> <em>left</em> = true, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>right</em> = true</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>
Removes any whitespace characters, be it standard space or TABs and so on.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
The user may specify wether they want to trim only the beginning or the end of the <a class="el" href="classOgre_1_1String.html">String</a> ( the default action is to trim both). </dl>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00034">34</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>.
<p>
Referenced by <a class="el" href="OgreDataChunk_8cpp-source.html#l00168">Ogre::DataChunk::getLine</a>(), <a class="el" href="OgreConfigFile_8cpp-source.html#l00037">Ogre::ConfigFile::load</a>(), and <a class="el" href="OgreBspLevel_8cpp-source.html#l00640">Ogre::BspLevel::loadEntities</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1Stringp0" doxytag="Ogre::String::BLANK"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String Ogre::String::BLANK = String("")<code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constant blank string, useful for returning by ref where local does not exist.
<p>
<p>
Definition at line <a class="el" href="OgreString_8cpp-source.html#l00032">32</a> of file <a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreString_8h-source.html">OgreString.h</a><li><a class="el" href="OgreString_8cpp-source.html">OgreString.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:20:46 2004
</p>
</body>
</html>
