sfmlinstaller

sfmlinstaller Mercurial Source Tree


Root/windows/doc/html/classsf_1_1String.htm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <head>
        <title>SFML - Simple and Fast Multimedia Library</title>
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
        <!--<link rel='stylesheet' type='text/css' href="http://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
        <link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
    </head>
    <body>
        <div id="banner-container">
            <div id="banner">
                <span id="sfml">SFML</span>
            </div>
        </div>
        <div id="content">
<!-- Generated by Doxygen 1.8.2 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.htm"><span>Main Page</span></a></li>
      <li><a href="modules.htm"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
      <li><a href="files.htm"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.htm"><span>Class List</span></a></li>
      <li><a href="classes.htm"><span>Class Index</span></a></li>
      <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
      <li><a href="functions.htm"><span>Class Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>sf</b></li><li class="navelem"><a class="el" href="classsf_1_1String.htm">String</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#friends">Friends</a> |
<a href="#related">Related Functions</a> |
<a href="classsf_1_1String-members.htm">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">sf::String Class Reference<div class="ingroups"><a class="el" href="group__system.htm">System module</a></div></div>  </div>
</div><!--header-->
<div class="contents">
 
<p>Utility string class that automatically handles conversions between types and encodings. 
 <a href="classsf_1_1String.htm#details">More...</a></p>
 
<p><code>#include <<a class="el" href="String_8hpp_source.htm">String.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac90f2b7b28f703020f8d027e98806235"><td class="memItemLeft" align="right" valign="top">typedef std::basic_string<br class="typebreak"/>
< Uint32 >::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ac90f2b7b28f703020f8d027e98806235">Iterator</a></td></tr>
<tr class="memdesc:ac90f2b7b28f703020f8d027e98806235"><td class="mdescLeft"> </td><td class="mdescRight">Iterator type.  <a href="#ac90f2b7b28f703020f8d027e98806235"></a><br/></td></tr>
<tr class="separator:ac90f2b7b28f703020f8d027e98806235"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e18efc2e8464f6eb82818902d527efa"><td class="memItemLeft" align="right" valign="top">typedef std::basic_string<br class="typebreak"/>
< Uint32 >::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a></td></tr>
<tr class="memdesc:a8e18efc2e8464f6eb82818902d527efa"><td class="mdescLeft"> </td><td class="mdescRight">Constant iterator type.  <a href="#a8e18efc2e8464f6eb82818902d527efa"></a><br/></td></tr>
<tr class="separator:a8e18efc2e8464f6eb82818902d527efa"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9563a4e93f692e0c8e8702b374ef8692"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a9563a4e93f692e0c8e8702b374ef8692">String</a> ()</td></tr>
<tr class="memdesc:a9563a4e93f692e0c8e8702b374ef8692"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor.  <a href="#a9563a4e93f692e0c8e8702b374ef8692"></a><br/></td></tr>
<tr class="separator:a9563a4e93f692e0c8e8702b374ef8692"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9df7f7696cff164794e338f3c89ccc5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ac9df7f7696cff164794e338f3c89ccc5">String</a> (char ansiChar, const std::locale &locale=std::locale())</td></tr>
<tr class="memdesc:ac9df7f7696cff164794e338f3c89ccc5"><td class="mdescLeft"> </td><td class="mdescRight">Construct from a single ANSI character and a locale.  <a href="#ac9df7f7696cff164794e338f3c89ccc5"></a><br/></td></tr>
<tr class="separator:ac9df7f7696cff164794e338f3c89ccc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefaa202d2aa5ff85b4f75a5983367e86"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#aefaa202d2aa5ff85b4f75a5983367e86">String</a> (wchar_t wideChar)</td></tr>
<tr class="memdesc:aefaa202d2aa5ff85b4f75a5983367e86"><td class="mdescLeft"> </td><td class="mdescRight">Construct from single wide character.  <a href="#aefaa202d2aa5ff85b4f75a5983367e86"></a><br/></td></tr>
<tr class="separator:aefaa202d2aa5ff85b4f75a5983367e86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e1a5027416d121187908e2ed77079ff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a8e1a5027416d121187908e2ed77079ff">String</a> (Uint32 utf32Char)</td></tr>
<tr class="memdesc:a8e1a5027416d121187908e2ed77079ff"><td class="mdescLeft"> </td><td class="mdescRight">Construct from single UTF-32 character.  <a href="#a8e1a5027416d121187908e2ed77079ff"></a><br/></td></tr>
<tr class="separator:a8e1a5027416d121187908e2ed77079ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57d2b8c289f9894f859564cad034bfc7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a57d2b8c289f9894f859564cad034bfc7">String</a> (const char *ansiString, const std::locale &locale=std::locale())</td></tr>
<tr class="memdesc:a57d2b8c289f9894f859564cad034bfc7"><td class="mdescLeft"> </td><td class="mdescRight">Construct from a null-terminated C-style ANSI string and a locale.  <a href="#a57d2b8c289f9894f859564cad034bfc7"></a><br/></td></tr>
<tr class="separator:a57d2b8c289f9894f859564cad034bfc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0aa41dcbd17b0c36c74d03d3b0147f1e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a0aa41dcbd17b0c36c74d03d3b0147f1e">String</a> (const std::string &ansiString, const std::locale &locale=std::locale())</td></tr>
<tr class="memdesc:a0aa41dcbd17b0c36c74d03d3b0147f1e"><td class="mdescLeft"> </td><td class="mdescRight">Construct from an ANSI string and a locale.  <a href="#a0aa41dcbd17b0c36c74d03d3b0147f1e"></a><br/></td></tr>
<tr class="separator:a0aa41dcbd17b0c36c74d03d3b0147f1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5742d0a9b0c754f711820c2b5c40fa55"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a5742d0a9b0c754f711820c2b5c40fa55">String</a> (const wchar_t *wideString)</td></tr>
<tr class="memdesc:a5742d0a9b0c754f711820c2b5c40fa55"><td class="mdescLeft"> </td><td class="mdescRight">Construct from null-terminated C-style wide string.  <a href="#a5742d0a9b0c754f711820c2b5c40fa55"></a><br/></td></tr>
<tr class="separator:a5742d0a9b0c754f711820c2b5c40fa55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e38151340af4f9a5f74ad24c0664074"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a5e38151340af4f9a5f74ad24c0664074">String</a> (const std::wstring &wideString)</td></tr>
<tr class="memdesc:a5e38151340af4f9a5f74ad24c0664074"><td class="mdescLeft"> </td><td class="mdescRight">Construct from a wide string.  <a href="#a5e38151340af4f9a5f74ad24c0664074"></a><br/></td></tr>
<tr class="separator:a5e38151340af4f9a5f74ad24c0664074"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea3629adf19f9fe713d4946f6c75b214"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#aea3629adf19f9fe713d4946f6c75b214">String</a> (const Uint32 *utf32String)</td></tr>
<tr class="memdesc:aea3629adf19f9fe713d4946f6c75b214"><td class="mdescLeft"> </td><td class="mdescRight">Construct from a null-terminated C-style UTF-32 string.  <a href="#aea3629adf19f9fe713d4946f6c75b214"></a><br/></td></tr>
<tr class="separator:aea3629adf19f9fe713d4946f6c75b214"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eee86dbe75d16bbcc26e97416c2e1ca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a6eee86dbe75d16bbcc26e97416c2e1ca">String</a> (const std::basic_string< Uint32 > &utf32String)</td></tr>
<tr class="memdesc:a6eee86dbe75d16bbcc26e97416c2e1ca"><td class="mdescLeft"> </td><td class="mdescRight">Construct from an UTF-32 string.  <a href="#a6eee86dbe75d16bbcc26e97416c2e1ca"></a><br/></td></tr>
<tr class="separator:a6eee86dbe75d16bbcc26e97416c2e1ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af862594d3c4070d8ddbf08cf8dce4f59"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#af862594d3c4070d8ddbf08cf8dce4f59">String</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &copy)</td></tr>
<tr class="memdesc:af862594d3c4070d8ddbf08cf8dce4f59"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor.  <a href="#af862594d3c4070d8ddbf08cf8dce4f59"></a><br/></td></tr>
<tr class="separator:af862594d3c4070d8ddbf08cf8dce4f59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3664f92c3b488bf9f60f6b8eafe1844d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a3664f92c3b488bf9f60f6b8eafe1844d">operator std::string</a> () const </td></tr>
<tr class="memdesc:a3664f92c3b488bf9f60f6b8eafe1844d"><td class="mdescLeft"> </td><td class="mdescRight">Implicit cast operator to std::string (ANSI string)  <a href="#a3664f92c3b488bf9f60f6b8eafe1844d"></a><br/></td></tr>
<tr class="separator:a3664f92c3b488bf9f60f6b8eafe1844d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20d50d45020d1dbe1779dda69ee83732"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a20d50d45020d1dbe1779dda69ee83732">operator std::wstring</a> () const </td></tr>
<tr class="memdesc:a20d50d45020d1dbe1779dda69ee83732"><td class="mdescLeft"> </td><td class="mdescRight">Implicit cast operator to std::wstring (wide string)  <a href="#a20d50d45020d1dbe1779dda69ee83732"></a><br/></td></tr>
<tr class="separator:a20d50d45020d1dbe1779dda69ee83732"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71d111ccfaf295b8b8be8ca4a3ceb5f4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a71d111ccfaf295b8b8be8ca4a3ceb5f4">toAnsiString</a> (const std::locale &locale=std::locale()) const </td></tr>
<tr class="memdesc:a71d111ccfaf295b8b8be8ca4a3ceb5f4"><td class="mdescLeft"> </td><td class="mdescRight">Convert the unicode string to an ANSI string.  <a href="#a71d111ccfaf295b8b8be8ca4a3ceb5f4"></a><br/></td></tr>
<tr class="separator:a71d111ccfaf295b8b8be8ca4a3ceb5f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd8b085ad7255543e4dc1285389d2d82"><td class="memItemLeft" align="right" valign="top">std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#afd8b085ad7255543e4dc1285389d2d82">toWideString</a> () const </td></tr>
<tr class="memdesc:afd8b085ad7255543e4dc1285389d2d82"><td class="mdescLeft"> </td><td class="mdescRight">Convert the unicode string to a wide string.  <a href="#afd8b085ad7255543e4dc1285389d2d82"></a><br/></td></tr>
<tr class="separator:afd8b085ad7255543e4dc1285389d2d82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a096255c066e5ef8c31952216b8ce9c42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.htm">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a096255c066e5ef8c31952216b8ce9c42">operator=</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:a096255c066e5ef8c31952216b8ce9c42"><td class="mdescLeft"> </td><td class="mdescRight">Overload of assignment operator.  <a href="#a096255c066e5ef8c31952216b8ce9c42"></a><br/></td></tr>
<tr class="separator:a096255c066e5ef8c31952216b8ce9c42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6563ce2c243ae2160eea8a354199f4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.htm">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ae6563ce2c243ae2160eea8a354199f4e">operator+=</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:ae6563ce2c243ae2160eea8a354199f4e"><td class="mdescLeft"> </td><td class="mdescRight">Overload of += operator to append an UTF-32 string.  <a href="#ae6563ce2c243ae2160eea8a354199f4e"></a><br/></td></tr>
<tr class="separator:ae6563ce2c243ae2160eea8a354199f4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a649b89a65866bf03652f7b5cb6de3bb6"><td class="memItemLeft" align="right" valign="top">Uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a649b89a65866bf03652f7b5cb6de3bb6">operator[]</a> (std::size_t index) const </td></tr>
<tr class="memdesc:a649b89a65866bf03652f7b5cb6de3bb6"><td class="mdescLeft"> </td><td class="mdescRight">Overload of [] operator to access a character by its position.  <a href="#a649b89a65866bf03652f7b5cb6de3bb6"></a><br/></td></tr>
<tr class="separator:a649b89a65866bf03652f7b5cb6de3bb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc989da7f4fb873ab29188d40772ab24"><td class="memItemLeft" align="right" valign="top">Uint32 & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#abc989da7f4fb873ab29188d40772ab24">operator[]</a> (std::size_t index)</td></tr>
<tr class="memdesc:abc989da7f4fb873ab29188d40772ab24"><td class="mdescLeft"> </td><td class="mdescRight">Overload of [] operator to access a character by its position.  <a href="#abc989da7f4fb873ab29188d40772ab24"></a><br/></td></tr>
<tr class="separator:abc989da7f4fb873ab29188d40772ab24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a391c1b4950cbf3d3f8040cea73af2969"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a391c1b4950cbf3d3f8040cea73af2969">clear</a> ()</td></tr>
<tr class="memdesc:a391c1b4950cbf3d3f8040cea73af2969"><td class="mdescLeft"> </td><td class="mdescRight">Clear the string.  <a href="#a391c1b4950cbf3d3f8040cea73af2969"></a><br/></td></tr>
<tr class="separator:a391c1b4950cbf3d3f8040cea73af2969"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a635d75c4cd830d5f639a41815dd0ce23"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a635d75c4cd830d5f639a41815dd0ce23">getSize</a> () const </td></tr>
<tr class="memdesc:a635d75c4cd830d5f639a41815dd0ce23"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the string.  <a href="#a635d75c4cd830d5f639a41815dd0ce23"></a><br/></td></tr>
<tr class="separator:a635d75c4cd830d5f639a41815dd0ce23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c43f0cbe84cf17fa6ba93d58b75fcdc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a6c43f0cbe84cf17fa6ba93d58b75fcdc">isEmpty</a> () const </td></tr>
<tr class="memdesc:a6c43f0cbe84cf17fa6ba93d58b75fcdc"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the string is empty or not.  <a href="#a6c43f0cbe84cf17fa6ba93d58b75fcdc"></a><br/></td></tr>
<tr class="separator:a6c43f0cbe84cf17fa6ba93d58b75fcdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#aaa78a0a46b3fbe200a4ccdedc326eb93">erase</a> (std::size_t position, std::size_t count=1)</td></tr>
<tr class="memdesc:aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="mdescLeft"> </td><td class="mdescRight">Erase one or more characters from the string.  <a href="#aaa78a0a46b3fbe200a4ccdedc326eb93"></a><br/></td></tr>
<tr class="separator:aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0b1455deabf07af13ee79812e05fa02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ad0b1455deabf07af13ee79812e05fa02">insert</a> (std::size_t position, const <a class="el" href="classsf_1_1String.htm">String</a> &str)</td></tr>
<tr class="memdesc:ad0b1455deabf07af13ee79812e05fa02"><td class="mdescLeft"> </td><td class="mdescRight">Insert one or more characters into the string.  <a href="#ad0b1455deabf07af13ee79812e05fa02"></a><br/></td></tr>
<tr class="separator:ad0b1455deabf07af13ee79812e05fa02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1fc8d6ced3b6082853f8013ea051b5c"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ae1fc8d6ced3b6082853f8013ea051b5c">find</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &str, std::size_t start=0) const </td></tr>
<tr class="memdesc:ae1fc8d6ced3b6082853f8013ea051b5c"><td class="mdescLeft"> </td><td class="mdescRight">Find a sequence of one or more characters in the string.  <a href="#ae1fc8d6ced3b6082853f8013ea051b5c"></a><br/></td></tr>
<tr class="separator:ae1fc8d6ced3b6082853f8013ea051b5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2d4e70869ebd38e225c6796e1325ae4"><td class="memItemLeft" align="right" valign="top">const Uint32 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#af2d4e70869ebd38e225c6796e1325ae4">getData</a> () const </td></tr>
<tr class="memdesc:af2d4e70869ebd38e225c6796e1325ae4"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the C-style array of characters.  <a href="#af2d4e70869ebd38e225c6796e1325ae4"></a><br/></td></tr>
<tr class="separator:af2d4e70869ebd38e225c6796e1325ae4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.htm#ac90f2b7b28f703020f8d027e98806235">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a> ()</td></tr>
<tr class="memdesc:a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator to the beginning of the string.  <a href="#a8ec30ddc08e3a6bd11c99aed782f6dfe"></a><br/></td></tr>
<tr class="separator:a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09bbf7704847ed35bf1c18aca6fba2a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.htm#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a09bbf7704847ed35bf1c18aca6fba2a2">begin</a> () const </td></tr>
<tr class="memdesc:a09bbf7704847ed35bf1c18aca6fba2a2"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator to the beginning of the string.  <a href="#a09bbf7704847ed35bf1c18aca6fba2a2"></a><br/></td></tr>
<tr class="separator:a09bbf7704847ed35bf1c18aca6fba2a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac823012f39cb6f61100418876e99d53b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.htm#ac90f2b7b28f703020f8d027e98806235">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ac823012f39cb6f61100418876e99d53b">end</a> ()</td></tr>
<tr class="memdesc:ac823012f39cb6f61100418876e99d53b"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator to the beginning of the string.  <a href="#ac823012f39cb6f61100418876e99d53b"></a><br/></td></tr>
<tr class="separator:ac823012f39cb6f61100418876e99d53b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6fb6ee1b21bd5dbdc9d6840f035eb79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.htm#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ab6fb6ee1b21bd5dbdc9d6840f035eb79">end</a> () const </td></tr>
<tr class="memdesc:ab6fb6ee1b21bd5dbdc9d6840f035eb79"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator to the beginning of the string.  <a href="#ab6fb6ee1b21bd5dbdc9d6840f035eb79"></a><br/></td></tr>
<tr class="separator:ab6fb6ee1b21bd5dbdc9d6840f035eb79"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:abaadecaf12a6b41c54d725c75fd28527"><td class="memItemLeft" align="right" valign="top">static const std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a></td></tr>
<tr class="memdesc:abaadecaf12a6b41c54d725c75fd28527"><td class="mdescLeft"> </td><td class="mdescRight">Represents an invalid position in the string.  <a href="#abaadecaf12a6b41c54d725c75fd28527"></a><br/></td></tr>
<tr class="separator:abaadecaf12a6b41c54d725c75fd28527"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a483931724196c580552b68751fb4d837"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a483931724196c580552b68751fb4d837"></a>
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="separator:a483931724196c580552b68751fb4d837"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5158a142e0966685ec7fb4e147b24ef0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5158a142e0966685ec7fb4e147b24ef0"></a>
bool </td><td class="memItemRight" valign="bottom"><b>operator<</b> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="separator:a5158a142e0966685ec7fb4e147b24ef0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a483931724196c580552b68751fb4d837"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a483931724196c580552b68751fb4d837">operator==</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:a483931724196c580552b68751fb4d837"><td class="mdescLeft"> </td><td class="mdescRight">Overload of == operator to compare two UTF-32 strings.  <a href="#a483931724196c580552b68751fb4d837"></a><br/></td></tr>
<tr class="separator:a483931724196c580552b68751fb4d837"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bfb9217788a9978499b8d5696bb0ef2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a3bfb9217788a9978499b8d5696bb0ef2">operator!=</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:a3bfb9217788a9978499b8d5696bb0ef2"><td class="mdescLeft"> </td><td class="mdescRight">Overload of != operator to compare two UTF-32 strings.  <a href="#a3bfb9217788a9978499b8d5696bb0ef2"></a><br/></td></tr>
<tr class="separator:a3bfb9217788a9978499b8d5696bb0ef2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5158a142e0966685ec7fb4e147b24ef0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a5158a142e0966685ec7fb4e147b24ef0">operator<</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:a5158a142e0966685ec7fb4e147b24ef0"><td class="mdescLeft"> </td><td class="mdescRight">Overload of < operator to compare two UTF-32 strings.  <a href="#a5158a142e0966685ec7fb4e147b24ef0"></a><br/></td></tr>
<tr class="separator:a5158a142e0966685ec7fb4e147b24ef0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac96278a8cbe282632b11f0c8c007df0c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ac96278a8cbe282632b11f0c8c007df0c">operator></a> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:ac96278a8cbe282632b11f0c8c007df0c"><td class="mdescLeft"> </td><td class="mdescRight">Overload of > operator to compare two UTF-32 strings.  <a href="#ac96278a8cbe282632b11f0c8c007df0c"></a><br/></td></tr>
<tr class="separator:ac96278a8cbe282632b11f0c8c007df0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#ac1c1bb5dcf02aad3b2c0a1bf74a11cc9">operator<=</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <= operator to compare two UTF-32 strings.  <a href="#ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"></a><br/></td></tr>
<tr class="separator:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a112689eec28e0ca9489e8c4ec6a34493"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#a112689eec28e0ca9489e8c4ec6a34493">operator>=</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:a112689eec28e0ca9489e8c4ec6a34493"><td class="mdescLeft"> </td><td class="mdescRight">Overload of >= operator to compare two UTF-32 strings.  <a href="#a112689eec28e0ca9489e8c4ec6a34493"></a><br/></td></tr>
<tr class="separator:a112689eec28e0ca9489e8c4ec6a34493"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af140f992b7698cf1448677c2c8e11bf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.htm">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.htm#af140f992b7698cf1448677c2c8e11bf1">operator+</a> (const <a class="el" href="classsf_1_1String.htm">String</a> &left, const <a class="el" href="classsf_1_1String.htm">String</a> &right)</td></tr>
<tr class="memdesc:af140f992b7698cf1448677c2c8e11bf1"><td class="mdescLeft"> </td><td class="mdescRight">Overload of binary + operator to concatenate two strings.  <a href="#af140f992b7698cf1448677c2c8e11bf1"></a><br/></td></tr>
<tr class="separator:af140f992b7698cf1448677c2c8e11bf1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility string class that automatically handles conversions between types and encodings. </p>
<p><a class="el" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> is a utility string class defined mainly for convenience.</p>
<p>It is a Unicode string (implemented using UTF-32), thus it can store any character in the world (european, chinese, arabic, hebrew, etc.).</p>
<p>It automatically handles conversions from/to ANSI and wide strings, so that you can work with standard string classes and still be compatible with functions taking a <a class="el" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a>.</p>
<div class="fragment"><div class="line"><a class="code" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> s;</div>
<div class="line"></div>
<div class="line">std::string s1 = s;  <span class="comment">// automatically converted to ANSI string</span></div>
<div class="line">std::wstring s2 = s; <span class="comment">// automatically converted to wide string</span></div>
<div class="line">s = <span class="stringliteral">"hello"</span>;         <span class="comment">// automatically converted from ANSI string</span></div>
<div class="line">s = L<span class="stringliteral">"hello"</span>;        <span class="comment">// automatically converted from wide string</span></div>
<div class="line">s += <span class="charliteral">'a'</span>;            <span class="comment">// automatically converted from ANSI string</span></div>
<div class="line">s += L<span class="charliteral">'a'</span>;           <span class="comment">// automatically converted from wide string</span></div>
</div><!-- fragment --><p>Conversions involving ANSI strings use the default user locale. However it is possible to use a custom locale if necessary: </p>
<div class="fragment"><div class="line">std::locale locale;</div>
<div class="line"><a class="code" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> s;</div>
<div class="line">...</div>
<div class="line">std::string s1 = s.<a class="code" href="classsf_1_1String.htm#a71d111ccfaf295b8b8be8ca4a3ceb5f4" title="Convert the unicode string to an ANSI string.">toAnsiString</a>(locale);</div>
<div class="line">s = <a class="code" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a>(<span class="stringliteral">"hello"</span>, locale);</div>
</div><!-- fragment --><p><a class="el" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> defines the most important functions of the standard std::string class: removing, random access, iterating, appending, comparing, etc. However it is a simple class provided for convenience, and you may have to consider using a more optimized class if your program requires complex string handling. The automatic conversion functions will then take care of converting your string to <a class="el" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a> whenever SFML requires it.</p>
<p>Please note that SFML also defines a low-level, generic interface for Unicode handling, see the <a class="el" href="classsf_1_1Utf.htm" title="Utility class providing generic functions for UTF conversions.">sf::Utf</a> classes. </p>
 
<p>Definition at line <a class="el" href="String_8hpp_source.htm#l00043">43</a> of file <a class="el" href="String_8hpp_source.htm">String.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a8e18efc2e8464f6eb82818902d527efa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::basic_string<Uint32>::const_iterator <a class="el" href="classsf_1_1String.htm#a8e18efc2e8464f6eb82818902d527efa">sf::String::ConstIterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Constant iterator type. </p>
 
<p>Definition at line <a class="el" href="String_8hpp_source.htm#l00051">51</a> of file <a class="el" href="String_8hpp_source.htm">String.hpp</a>.</p>
 
</div>
</div>
<a class="anchor" id="ac90f2b7b28f703020f8d027e98806235"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::basic_string<Uint32>::iterator <a class="el" href="classsf_1_1String.htm#ac90f2b7b28f703020f8d027e98806235">sf::String::Iterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Iterator type. </p>
 
<p>Definition at line <a class="el" href="String_8hpp_source.htm#l00050">50</a> of file <a class="el" href="String_8hpp_source.htm">String.hpp</a>.</p>
 
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9563a4e93f692e0c8e8702b374ef8692"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Default constructor. </p>
<p>This constructor creates an empty string. </p>
 
</div>
</div>
<a class="anchor" id="ac9df7f7696cff164794e338f3c89ccc5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">char </td>
          <td class="paramname"><em>ansiChar</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::locale & </td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from a single ANSI character and a locale. </p>
<p>The source character is converted to UTF-32 according to the given locale.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ansiChar</td><td>ANSI character to convert </td></tr>
    <tr><td class="paramname">locale</td><td>Locale to use for conversion </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="aefaa202d2aa5ff85b4f75a5983367e86"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">wchar_t </td>
          <td class="paramname"><em>wideChar</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from single wide character. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wideChar</td><td>Wide character to convert </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="a8e1a5027416d121187908e2ed77079ff"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">Uint32 </td>
          <td class="paramname"><em>utf32Char</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from single UTF-32 character. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">utf32Char</td><td>UTF-32 character to convert </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="a57d2b8c289f9894f859564cad034bfc7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const char * </td>
          <td class="paramname"><em>ansiString</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::locale & </td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from a null-terminated C-style ANSI string and a locale. </p>
<p>The source string is converted to UTF-32 according to the given locale.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ansiString</td><td>ANSI string to convert </td></tr>
    <tr><td class="paramname">locale</td><td>Locale to use for conversion </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="a0aa41dcbd17b0c36c74d03d3b0147f1e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const std::string & </td>
          <td class="paramname"><em>ansiString</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::locale & </td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from an ANSI string and a locale. </p>
<p>The source string is converted to UTF-32 according to the given locale.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ansiString</td><td>ANSI string to convert </td></tr>
    <tr><td class="paramname">locale</td><td>Locale to use for conversion </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="a5742d0a9b0c754f711820c2b5c40fa55"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const wchar_t * </td>
          <td class="paramname"><em>wideString</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from null-terminated C-style wide string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wideString</td><td>Wide string to convert </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="a5e38151340af4f9a5f74ad24c0664074"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const std::wstring & </td>
          <td class="paramname"><em>wideString</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from a wide string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wideString</td><td>Wide string to convert </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="aea3629adf19f9fe713d4946f6c75b214"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const Uint32 * </td>
          <td class="paramname"><em>utf32String</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from a null-terminated C-style UTF-32 string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">utf32String</td><td>UTF-32 string to assign </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="a6eee86dbe75d16bbcc26e97416c2e1ca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const std::basic_string< Uint32 > & </td>
          <td class="paramname"><em>utf32String</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Construct from an UTF-32 string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">utf32String</td><td>UTF-32 string to assign </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="af862594d3c4070d8ddbf08cf8dce4f59"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::String </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>copy</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">copy</td><td>Instance to copy </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8ec30ddc08e3a6bd11c99aed782f6dfe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.htm#ac90f2b7b28f703020f8d027e98806235">Iterator</a> sf::String::begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Return an iterator to the beginning of the string. </p>
<dl class="section return"><dt>Returns</dt><dd>Read-write iterator to the beginning of the string characters</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#ac823012f39cb6f61100418876e99d53b" title="Return an iterator to the beginning of the string.">end</a> </dd></dl>
 
</div>
</div>
<a class="anchor" id="a09bbf7704847ed35bf1c18aca6fba2a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.htm#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a> sf::String::begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Return an iterator to the beginning of the string. </p>
<dl class="section return"><dt>Returns</dt><dd>Read-only iterator to the beginning of the string characters</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#ac823012f39cb6f61100418876e99d53b" title="Return an iterator to the beginning of the string.">end</a> </dd></dl>
 
</div>
</div>
<a class="anchor" id="a391c1b4950cbf3d3f8040cea73af2969"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Clear the string. </p>
<p>This function removes all the characters from the string.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#a6c43f0cbe84cf17fa6ba93d58b75fcdc" title="Check whether the string is empty or not.">isEmpty</a>, <a class="el" href="classsf_1_1String.htm#aaa78a0a46b3fbe200a4ccdedc326eb93" title="Erase one or more characters from the string.">erase</a> </dd></dl>
 
</div>
</div>
<a class="anchor" id="ac823012f39cb6f61100418876e99d53b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.htm#ac90f2b7b28f703020f8d027e98806235">Iterator</a> sf::String::end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Return an iterator to the beginning of the string. </p>
<p>The end iterator refers to 1 position past the last character; thus it represents an invalid character and should never be accessed.</p>
<dl class="section return"><dt>Returns</dt><dd>Read-write iterator to the end of the string characters</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#a8ec30ddc08e3a6bd11c99aed782f6dfe" title="Return an iterator to the beginning of the string.">begin</a> </dd></dl>
 
</div>
</div>
<a class="anchor" id="ab6fb6ee1b21bd5dbdc9d6840f035eb79"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.htm#a8e18efc2e8464f6eb82818902d527efa">ConstIterator</a> sf::String::end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Return an iterator to the beginning of the string. </p>
<p>The end iterator refers to 1 position past the last character; thus it represents an invalid character and should never be accessed.</p>
<dl class="section return"><dt>Returns</dt><dd>Read-only iterator to the end of the string characters</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#a8ec30ddc08e3a6bd11c99aed782f6dfe" title="Return an iterator to the beginning of the string.">begin</a> </dd></dl>
 
</div>
</div>
<a class="anchor" id="aaa78a0a46b3fbe200a4ccdedc326eb93"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::erase </td>
          <td>(</td>
          <td class="paramtype">std::size_t </td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t </td>
          <td class="paramname"><em>count</em> = <code>1</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Erase one or more characters from the string. </p>
<p>This function removes a sequence of <em>count</em> characters starting from <em>position</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>Position of the first character to erase </td></tr>
    <tr><td class="paramname">count</td><td>Number of characters to erase </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="ae1fc8d6ced3b6082853f8013ea051b5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t sf::String::find </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t </td>
          <td class="paramname"><em>start</em> = <code>0</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Find a sequence of one or more characters in the string. </p>
<p>This function searches for the characters of <em>str</em> into the string, starting from <em>start</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">str</td><td>Characters to find </td></tr>
    <tr><td class="paramname">start</td><td>Where to begin searching</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Position of <em>str</em> in the string, or <a class="el" href="classsf_1_1String.htm#abaadecaf12a6b41c54d725c75fd28527" title="Represents an invalid position in the string.">String::InvalidPos</a> if not found </dd></dl>
 
</div>
</div>
<a class="anchor" id="af2d4e70869ebd38e225c6796e1325ae4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const Uint32* sf::String::getData </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Get a pointer to the C-style array of characters. </p>
<p>This functions provides a read-only access to a null-terminated C-style representation of the string. The returned pointer is temporary and is meant only for immediate use, thus it is not recommended to store it.</p>
<dl class="section return"><dt>Returns</dt><dd>Read-only pointer to the array of characters </dd></dl>
 
</div>
</div>
<a class="anchor" id="a635d75c4cd830d5f639a41815dd0ce23"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t sf::String::getSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Get the size of the string. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of characters in the string</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#a6c43f0cbe84cf17fa6ba93d58b75fcdc" title="Check whether the string is empty or not.">isEmpty</a> </dd></dl>
 
</div>
</div>
<a class="anchor" id="ad0b1455deabf07af13ee79812e05fa02"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sf::String::insert </td>
          <td>(</td>
          <td class="paramtype">std::size_t </td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>str</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Insert one or more characters into the string. </p>
<p>This function inserts the characters of <em>str</em> into the string, starting from <em>position</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>Position of insertion </td></tr>
    <tr><td class="paramname">str</td><td>Characters to insert </td></tr>
  </table>
  </dd>
</dl>
 
</div>
</div>
<a class="anchor" id="a6c43f0cbe84cf17fa6ba93d58b75fcdc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool sf::String::isEmpty </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Check whether the string is empty or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the string is empty (i.e. contains no character)</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#a391c1b4950cbf3d3f8040cea73af2969" title="Clear the string.">clear</a>, <a class="el" href="classsf_1_1String.htm#a635d75c4cd830d5f639a41815dd0ce23" title="Get the size of the string.">getSize</a> </dd></dl>
 
</div>
</div>
<a class="anchor" id="a3664f92c3b488bf9f60f6b8eafe1844d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::operator std::string </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Implicit cast operator to std::string (ANSI string) </p>
<p>The current global locale is used for conversion. If you want to explicitely specify a locale, see toAnsiString. Characters that do not fit in the target encoding are discarded from the returned string. This operator is defined for convenience, and is equivalent to calling <a class="el" href="classsf_1_1String.htm#a71d111ccfaf295b8b8be8ca4a3ceb5f4" title="Convert the unicode string to an ANSI string.">toAnsiString()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>Converted ANSI string</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#a71d111ccfaf295b8b8be8ca4a3ceb5f4" title="Convert the unicode string to an ANSI string.">toAnsiString</a>, operator std::wstring </dd></dl>
 
</div>
</div>
<a class="anchor" id="a20d50d45020d1dbe1779dda69ee83732"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sf::String::operator std::wstring </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Implicit cast operator to std::wstring (wide string) </p>
<p>Characters that do not fit in the target encoding are discarded from the returned string. This operator is defined for convenience, and is equivalent to calling <a class="el" href="classsf_1_1String.htm#afd8b085ad7255543e4dc1285389d2d82" title="Convert the unicode string to a wide string.">toWideString()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>Converted wide string</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#afd8b085ad7255543e4dc1285389d2d82" title="Convert the unicode string to a wide string.">toWideString</a>, operator std::string </dd></dl>
 
</div>
</div>
<a class="anchor" id="ae6563ce2c243ae2160eea8a354199f4e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.htm">String</a>& sf::String::operator+= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Overload of += operator to append an UTF-32 string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">right</td><td><a class="el" href="classsf_1_1String.htm" title="Utility string class that automatically handles conversions between types and encodings.">String</a> to append</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to self </dd></dl>
 
</div>
</div>
<a class="anchor" id="a096255c066e5ef8c31952216b8ce9c42"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.htm">String</a>& sf::String::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Overload of assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">right</td><td>Instance to assign</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to self </dd></dl>
 
</div>
</div>
<a class="anchor" id="a649b89a65866bf03652f7b5cb6de3bb6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint32 sf::String::operator[] </td>
          <td>(</td>
          <td class="paramtype">std::size_t </td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Overload of [] operator to access a character by its position. </p>
<p>This function provides read-only access to characters. Note: this function doesn't throw if <em>index</em> is out of range.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">index</td><td>Index of the character to get</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Character at position <em>index</em> </dd></dl>
 
</div>
</div>
<a class="anchor" id="abc989da7f4fb873ab29188d40772ab24"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Uint32& sf::String::operator[] </td>
          <td>(</td>
          <td class="paramtype">std::size_t </td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Overload of [] operator to access a character by its position. </p>
<p>This function provides read and write access to characters. Note: this function doesn't throw if <em>index</em> is out of range.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">index</td><td>Index of the character to get</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to the character at position <em>index</em> </dd></dl>
 
</div>
</div>
<a class="anchor" id="a71d111ccfaf295b8b8be8ca4a3ceb5f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string sf::String::toAnsiString </td>
          <td>(</td>
          <td class="paramtype">const std::locale & </td>
          <td class="paramname"><em>locale</em> = <code>std::locale()</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Convert the unicode string to an ANSI string. </p>
<p>The UTF-32 string is converted to an ANSI string in the encoding defined by <em>locale</em>. Characters that do not fit in the target encoding are discarded from the returned string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">locale</td><td>Locale to use for conversion</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Converted ANSI string</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#afd8b085ad7255543e4dc1285389d2d82" title="Convert the unicode string to a wide string.">toWideString</a>, operator std::string </dd></dl>
 
</div>
</div>
<a class="anchor" id="afd8b085ad7255543e4dc1285389d2d82"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::wstring sf::String::toWideString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
 
<p>Convert the unicode string to a wide string. </p>
<p>Characters that do not fit in the target encoding are discarded from the returned string.</p>
<dl class="section return"><dt>Returns</dt><dd>Converted wide string</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1String.htm#a71d111ccfaf295b8b8be8ca4a3ceb5f4" title="Convert the unicode string to an ANSI string.">toAnsiString</a>, operator std::wstring </dd></dl>
 
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a3bfb9217788a9978499b8d5696bb0ef2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Overload of != operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if both strings are different </dd></dl>
 
</div>
</div>
<a class="anchor" id="af140f992b7698cf1448677c2c8e11bf1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsf_1_1String.htm">String</a> operator+ </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Overload of binary + operator to concatenate two strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Concatenated string </dd></dl>
 
</div>
</div>
<a class="anchor" id="a5158a142e0966685ec7fb4e147b24ef0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator< </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Overload of < operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is alphabetically lesser than <em>right</em> </dd></dl>
 
</div>
</div>
<a class="anchor" id="ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator<= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Overload of <= operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is alphabetically lesser or equal than <em>right</em> </dd></dl>
 
</div>
</div>
<a class="anchor" id="a483931724196c580552b68751fb4d837"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Overload of == operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if both strings are equal </dd></dl>
 
</div>
</div>
<a class="anchor" id="ac96278a8cbe282632b11f0c8c007df0c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Overload of > operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is alphabetically greater than <em>right</em> </dd></dl>
 
</div>
</div>
<a class="anchor" id="a112689eec28e0ca9489e8c4ec6a34493"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator>= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classsf_1_1String.htm">String</a> & </td>
          <td class="paramname"><em>right</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Overload of >= operator to compare two UTF-32 strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">left</td><td>Left operand (a string) </td></tr>
    <tr><td class="paramname">right</td><td>Right operand (a string)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is alphabetically greater or equal than <em>right</em> </dd></dl>
 
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abaadecaf12a6b41c54d725c75fd28527"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::size_t sf::String::InvalidPos</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
 
<p>Represents an invalid position in the string. </p>
 
<p>Definition at line <a class="el" href="String_8hpp_source.htm#l00056">56</a> of file <a class="el" href="String_8hpp_source.htm">String.hpp</a>.</p>
 
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="String_8hpp_source.htm">String.hpp</a></li>
</ul>
</div><!-- contents -->
        </div>
        <div id="footer-container">
            <div id="footer">
                Copyright � Laurent Gomila  :: 
                Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a>  :: 
            </div>
        </div>
    <script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 
  ga('create', 'UA-41898676-1', 'srchub.org');
  ga('send', 'pageview');
Page rendered in 0.88672s using 11 queries.
Source at commit tip created 11 years 11 months ago.
By Nathan Adams, Initial commit

Archive Download this file

Branches

Tags

Page rendered in 0.88672s using 11 queries.