1887 lines
109 KiB
HTML
1887 lines
109 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>SFML - Simple and Fast Multimedia Library</title>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
|
|
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link rel="stylesheet" type="text/css" href="search/search.css" />
|
|
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">SFML 3.0.0</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div>
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="topics.html"><span>Topics</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1String.html">String</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<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-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="#related">Related Symbols</a> |
|
|
<a href="classsf_1_1String-members.html">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.html">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="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="String_8hpp_source.html">SFML/System/String.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aea5ef84201f199e64a00f19d02a38c7a" id="r_aea5ef84201f199e64a00f19d02a38c7a"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#aea5ef84201f199e64a00f19d02a38c7a">Iterator</a> = std::u32string::iterator</td></tr>
|
|
<tr class="memdesc:aea5ef84201f199e64a00f19d02a38c7a"><td class="mdescLeft"> </td><td class="mdescRight">Iterator type. <br /></td></tr>
|
|
<tr class="separator:aea5ef84201f199e64a00f19d02a38c7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac59fdada9f3d871d45eb1b48e488dd41" id="r_ac59fdada9f3d871d45eb1b48e488dd41"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac59fdada9f3d871d45eb1b48e488dd41">ConstIterator</a> = std::u32string::const_iterator</td></tr>
|
|
<tr class="memdesc:ac59fdada9f3d871d45eb1b48e488dd41"><td class="mdescLeft"> </td><td class="mdescRight">Read-only iterator type. <br /></td></tr>
|
|
<tr class="separator:ac59fdada9f3d871d45eb1b48e488dd41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a15f73445dc4c9ba203e090daec352434" id="r_a15f73445dc4c9ba203e090daec352434"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a15f73445dc4c9ba203e090daec352434">String</a> ()=default</td></tr>
|
|
<tr class="memdesc:a15f73445dc4c9ba203e090daec352434"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a15f73445dc4c9ba203e090daec352434"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcb9432f007259c7f73258b8c8fab652" id="r_afcb9432f007259c7f73258b8c8fab652"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afcb9432f007259c7f73258b8c8fab652">String</a> (std::nullptr_t, const std::locale &={})=delete</td></tr>
|
|
<tr class="memdesc:afcb9432f007259c7f73258b8c8fab652"><td class="mdescLeft"> </td><td class="mdescRight">Deleted <code>std::nullptr_t</code> constructor. <br /></td></tr>
|
|
<tr class="separator:afcb9432f007259c7f73258b8c8fab652"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49df0509c95eec3e715464c4a9e8f08b" id="r_a49df0509c95eec3e715464c4a9e8f08b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a49df0509c95eec3e715464c4a9e8f08b">String</a> (char ansiChar, const std::locale &locale={})</td></tr>
|
|
<tr class="memdesc:a49df0509c95eec3e715464c4a9e8f08b"><td class="mdescLeft"> </td><td class="mdescRight">Construct from a single ANSI character and a locale. <br /></td></tr>
|
|
<tr class="separator:a49df0509c95eec3e715464c4a9e8f08b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefaa202d2aa5ff85b4f75a5983367e86" id="r_aefaa202d2aa5ff85b4f75a5983367e86"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aefaa202d2aa5ff85b4f75a5983367e86">String</a> (wchar_t wideChar)</td></tr>
|
|
<tr class="memdesc:aefaa202d2aa5ff85b4f75a5983367e86"><td class="mdescLeft"> </td><td class="mdescRight">Construct from single wide character. <br /></td></tr>
|
|
<tr class="separator:aefaa202d2aa5ff85b4f75a5983367e86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafbfb927c8f747e63736ec16cd6762cc" id="r_aafbfb927c8f747e63736ec16cd6762cc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aafbfb927c8f747e63736ec16cd6762cc">String</a> (char32_t utf32Char)</td></tr>
|
|
<tr class="memdesc:aafbfb927c8f747e63736ec16cd6762cc"><td class="mdescLeft"> </td><td class="mdescRight">Construct from single UTF-32 character. <br /></td></tr>
|
|
<tr class="separator:aafbfb927c8f747e63736ec16cd6762cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80dfeec3f7a585d386fe1fc364f385af" id="r_a80dfeec3f7a585d386fe1fc364f385af"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a80dfeec3f7a585d386fe1fc364f385af">String</a> (const char *ansiString, const std::locale &locale={})</td></tr>
|
|
<tr class="memdesc:a80dfeec3f7a585d386fe1fc364f385af"><td class="mdescLeft"> </td><td class="mdescRight">Construct from a null-terminated C-style ANSI string and a locale. <br /></td></tr>
|
|
<tr class="separator:a80dfeec3f7a585d386fe1fc364f385af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10cd2998619996c033499751b80f2505" id="r_a10cd2998619996c033499751b80f2505"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a10cd2998619996c033499751b80f2505">String</a> (const std::string &ansiString, const std::locale &locale={})</td></tr>
|
|
<tr class="memdesc:a10cd2998619996c033499751b80f2505"><td class="mdescLeft"> </td><td class="mdescRight">Construct from an ANSI string and a locale. <br /></td></tr>
|
|
<tr class="separator:a10cd2998619996c033499751b80f2505"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5742d0a9b0c754f711820c2b5c40fa55" id="r_a5742d0a9b0c754f711820c2b5c40fa55"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#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. <br /></td></tr>
|
|
<tr class="separator:a5742d0a9b0c754f711820c2b5c40fa55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e38151340af4f9a5f74ad24c0664074" id="r_a5e38151340af4f9a5f74ad24c0664074"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#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. <br /></td></tr>
|
|
<tr class="separator:a5e38151340af4f9a5f74ad24c0664074"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd4661f257ca19be320d83beccf4c706" id="r_acd4661f257ca19be320d83beccf4c706"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acd4661f257ca19be320d83beccf4c706">String</a> (const char32_t *utf32String)</td></tr>
|
|
<tr class="memdesc:acd4661f257ca19be320d83beccf4c706"><td class="mdescLeft"> </td><td class="mdescRight">Construct from a null-terminated C-style UTF-32 string. <br /></td></tr>
|
|
<tr class="separator:acd4661f257ca19be320d83beccf4c706"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38d69200909ad15a74ad6ef866db917a" id="r_a38d69200909ad15a74ad6ef866db917a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a38d69200909ad15a74ad6ef866db917a">String</a> (std::u32string utf32String)</td></tr>
|
|
<tr class="memdesc:a38d69200909ad15a74ad6ef866db917a"><td class="mdescLeft"> </td><td class="mdescRight">Construct from an UTF-32 string. <br /></td></tr>
|
|
<tr class="separator:a38d69200909ad15a74ad6ef866db917a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a884816a0f688cfd48f9324c9741dc257" id="r_a884816a0f688cfd48f9324c9741dc257"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a884816a0f688cfd48f9324c9741dc257">operator std::string</a> () const</td></tr>
|
|
<tr class="memdesc:a884816a0f688cfd48f9324c9741dc257"><td class="mdescLeft"> </td><td class="mdescRight">Implicit conversion operator to <code>std::string</code> (ANSI string) <br /></td></tr>
|
|
<tr class="separator:a884816a0f688cfd48f9324c9741dc257"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bd1444bebaca9bbf01ba203061f5076" id="r_a6bd1444bebaca9bbf01ba203061f5076"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6bd1444bebaca9bbf01ba203061f5076">operator std::wstring</a> () const</td></tr>
|
|
<tr class="memdesc:a6bd1444bebaca9bbf01ba203061f5076"><td class="mdescLeft"> </td><td class="mdescRight">Implicit conversion operator to <code>std::wstring</code> (wide string) <br /></td></tr>
|
|
<tr class="separator:a6bd1444bebaca9bbf01ba203061f5076"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12d6659486d24cf323b4cb70533e5d38" id="r_a12d6659486d24cf323b4cb70533e5d38"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a12d6659486d24cf323b4cb70533e5d38">toAnsiString</a> (const std::locale &locale={}) const</td></tr>
|
|
<tr class="memdesc:a12d6659486d24cf323b4cb70533e5d38"><td class="mdescLeft"> </td><td class="mdescRight">Convert the Unicode string to an ANSI string. <br /></td></tr>
|
|
<tr class="separator:a12d6659486d24cf323b4cb70533e5d38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d81aa3103e7e2062bd85d912a5aecf1" id="r_a9d81aa3103e7e2062bd85d912a5aecf1"><td class="memItemLeft" align="right" valign="top">std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d81aa3103e7e2062bd85d912a5aecf1">toWideString</a> () const</td></tr>
|
|
<tr class="memdesc:a9d81aa3103e7e2062bd85d912a5aecf1"><td class="mdescLeft"> </td><td class="mdescRight">Convert the Unicode string to a wide string. <br /></td></tr>
|
|
<tr class="separator:a9d81aa3103e7e2062bd85d912a5aecf1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2143c53e099dcc167e97ea7deeecff05" id="r_a2143c53e099dcc167e97ea7deeecff05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#a407496cc99eeb9bf75c2b4d0848d3fc7">sf::U8String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2143c53e099dcc167e97ea7deeecff05">toUtf8</a> () const</td></tr>
|
|
<tr class="memdesc:a2143c53e099dcc167e97ea7deeecff05"><td class="mdescLeft"> </td><td class="mdescRight">Convert the Unicode string to a UTF-8 string. <br /></td></tr>
|
|
<tr class="separator:a2143c53e099dcc167e97ea7deeecff05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab285f398a27d65fa60e116da99f6a39e" id="r_ab285f398a27d65fa60e116da99f6a39e"><td class="memItemLeft" align="right" valign="top">std::u16string </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab285f398a27d65fa60e116da99f6a39e">toUtf16</a> () const</td></tr>
|
|
<tr class="memdesc:ab285f398a27d65fa60e116da99f6a39e"><td class="mdescLeft"> </td><td class="mdescRight">Convert the Unicode string to a UTF-16 string. <br /></td></tr>
|
|
<tr class="separator:ab285f398a27d65fa60e116da99f6a39e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c2406161cf358a357ae95db25bddad8" id="r_a5c2406161cf358a357ae95db25bddad8"><td class="memItemLeft" align="right" valign="top">std::u32string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c2406161cf358a357ae95db25bddad8">toUtf32</a> () const</td></tr>
|
|
<tr class="memdesc:a5c2406161cf358a357ae95db25bddad8"><td class="mdescLeft"> </td><td class="mdescRight">Convert the Unicode string to a UTF-32 string. <br /></td></tr>
|
|
<tr class="separator:a5c2406161cf358a357ae95db25bddad8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdae61e813b2951a6e39015e34a143f7" id="r_afdae61e813b2951a6e39015e34a143f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#afdae61e813b2951a6e39015e34a143f7">operator+=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:afdae61e813b2951a6e39015e34a143f7"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator+=</code> to append an UTF-32 string. <br /></td></tr>
|
|
<tr class="separator:afdae61e813b2951a6e39015e34a143f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66b67d7f21d642c65c9b4e48e88e3e93" id="r_a66b67d7f21d642c65c9b4e48e88e3e93"><td class="memItemLeft" align="right" valign="top">char32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a66b67d7f21d642c65c9b4e48e88e3e93">operator[]</a> (std::size_t index) const</td></tr>
|
|
<tr class="memdesc:a66b67d7f21d642c65c9b4e48e88e3e93"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator[]</code> to access a character by its position. <br /></td></tr>
|
|
<tr class="separator:a66b67d7f21d642c65c9b4e48e88e3e93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac509d36dd836c8499a2813299dea865f" id="r_ac509d36dd836c8499a2813299dea865f"><td class="memItemLeft" align="right" valign="top">char32_t & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac509d36dd836c8499a2813299dea865f">operator[]</a> (std::size_t index)</td></tr>
|
|
<tr class="memdesc:ac509d36dd836c8499a2813299dea865f"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator[]</code> to access a character by its position. <br /></td></tr>
|
|
<tr class="separator:ac509d36dd836c8499a2813299dea865f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a391c1b4950cbf3d3f8040cea73af2969" id="r_a391c1b4950cbf3d3f8040cea73af2969"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a391c1b4950cbf3d3f8040cea73af2969">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a391c1b4950cbf3d3f8040cea73af2969"><td class="mdescLeft"> </td><td class="mdescRight">Clear the string. <br /></td></tr>
|
|
<tr class="separator:a391c1b4950cbf3d3f8040cea73af2969"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7aff54e178f5d3e399953adff5cad20" id="r_ae7aff54e178f5d3e399953adff5cad20"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7aff54e178f5d3e399953adff5cad20">getSize</a> () const</td></tr>
|
|
<tr class="memdesc:ae7aff54e178f5d3e399953adff5cad20"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the string. <br /></td></tr>
|
|
<tr class="separator:ae7aff54e178f5d3e399953adff5cad20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ba26cb6945d2bbb210b822f222aa7f6" id="r_a2ba26cb6945d2bbb210b822f222aa7f6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ba26cb6945d2bbb210b822f222aa7f6">isEmpty</a> () const</td></tr>
|
|
<tr class="memdesc:a2ba26cb6945d2bbb210b822f222aa7f6"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the string is empty or not. <br /></td></tr>
|
|
<tr class="separator:a2ba26cb6945d2bbb210b822f222aa7f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa78a0a46b3fbe200a4ccdedc326eb93" id="r_aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#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. <br /></td></tr>
|
|
<tr class="separator:aaa78a0a46b3fbe200a4ccdedc326eb93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0b1455deabf07af13ee79812e05fa02" id="r_ad0b1455deabf07af13ee79812e05fa02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0b1455deabf07af13ee79812e05fa02">insert</a> (std::size_t position, const <a class="el" href="classsf_1_1String.html">String</a> &str)</td></tr>
|
|
<tr class="memdesc:ad0b1455deabf07af13ee79812e05fa02"><td class="mdescLeft"> </td><td class="mdescRight">Insert one or more characters into the string. <br /></td></tr>
|
|
<tr class="separator:ad0b1455deabf07af13ee79812e05fa02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa189ec8656854106ab8d2e935fd9cbcc" id="r_aa189ec8656854106ab8d2e935fd9cbcc"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa189ec8656854106ab8d2e935fd9cbcc">find</a> (const <a class="el" href="classsf_1_1String.html">String</a> &str, std::size_t start=0) const</td></tr>
|
|
<tr class="memdesc:aa189ec8656854106ab8d2e935fd9cbcc"><td class="mdescLeft"> </td><td class="mdescRight">Find a sequence of one or more characters in the string. <br /></td></tr>
|
|
<tr class="separator:aa189ec8656854106ab8d2e935fd9cbcc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad460e628c287b0fa88deba2eb0b6744b" id="r_ad460e628c287b0fa88deba2eb0b6744b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad460e628c287b0fa88deba2eb0b6744b">replace</a> (std::size_t position, std::size_t length, const <a class="el" href="classsf_1_1String.html">String</a> &replaceWith)</td></tr>
|
|
<tr class="memdesc:ad460e628c287b0fa88deba2eb0b6744b"><td class="mdescLeft"> </td><td class="mdescRight">Replace a substring with another string. <br /></td></tr>
|
|
<tr class="separator:ad460e628c287b0fa88deba2eb0b6744b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82bbfee2bf23c641e5361ad505c07921" id="r_a82bbfee2bf23c641e5361ad505c07921"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a82bbfee2bf23c641e5361ad505c07921">replace</a> (const <a class="el" href="classsf_1_1String.html">String</a> &searchFor, const <a class="el" href="classsf_1_1String.html">String</a> &replaceWith)</td></tr>
|
|
<tr class="memdesc:a82bbfee2bf23c641e5361ad505c07921"><td class="mdescLeft"> </td><td class="mdescRight">Replace all occurrences of a substring with a replacement string. <br /></td></tr>
|
|
<tr class="separator:a82bbfee2bf23c641e5361ad505c07921"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492645e00032455e6d92ff0e992654ce" id="r_a492645e00032455e6d92ff0e992654ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a492645e00032455e6d92ff0e992654ce">substring</a> (std::size_t position, std::size_t length=<a class="el" href="#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a>) const</td></tr>
|
|
<tr class="memdesc:a492645e00032455e6d92ff0e992654ce"><td class="mdescLeft"> </td><td class="mdescRight">Return a part of the string. <br /></td></tr>
|
|
<tr class="separator:a492645e00032455e6d92ff0e992654ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f6c1b6979e822a52ee5d150f1e8d4c0" id="r_a0f6c1b6979e822a52ee5d150f1e8d4c0"><td class="memItemLeft" align="right" valign="top">const char32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0f6c1b6979e822a52ee5d150f1e8d4c0">getData</a> () const</td></tr>
|
|
<tr class="memdesc:a0f6c1b6979e822a52ee5d150f1e8d4c0"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the C-style array of characters. <br /></td></tr>
|
|
<tr class="separator:a0f6c1b6979e822a52ee5d150f1e8d4c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ec30ddc08e3a6bd11c99aed782f6dfe" id="r_a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#aea5ef84201f199e64a00f19d02a38c7a">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#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. <br /></td></tr>
|
|
<tr class="separator:a8ec30ddc08e3a6bd11c99aed782f6dfe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e4755d6b4d51de7c3dc2e984b79f95d" id="r_a0e4755d6b4d51de7c3dc2e984b79f95d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ac59fdada9f3d871d45eb1b48e488dd41">ConstIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e4755d6b4d51de7c3dc2e984b79f95d">begin</a> () const</td></tr>
|
|
<tr class="memdesc:a0e4755d6b4d51de7c3dc2e984b79f95d"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator to the beginning of the string. <br /></td></tr>
|
|
<tr class="separator:a0e4755d6b4d51de7c3dc2e984b79f95d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac823012f39cb6f61100418876e99d53b" id="r_ac823012f39cb6f61100418876e99d53b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#aea5ef84201f199e64a00f19d02a38c7a">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac823012f39cb6f61100418876e99d53b">end</a> ()</td></tr>
|
|
<tr class="memdesc:ac823012f39cb6f61100418876e99d53b"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator to the end of the string. <br /></td></tr>
|
|
<tr class="separator:ac823012f39cb6f61100418876e99d53b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1ab4c82ff2bdfb6903b4b1bb78a8e5c" id="r_af1ab4c82ff2bdfb6903b4b1bb78a8e5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ac59fdada9f3d871d45eb1b48e488dd41">ConstIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af1ab4c82ff2bdfb6903b4b1bb78a8e5c">end</a> () const</td></tr>
|
|
<tr class="memdesc:af1ab4c82ff2bdfb6903b4b1bb78a8e5c"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator to the end of the string. <br /></td></tr>
|
|
<tr class="separator:af1ab4c82ff2bdfb6903b4b1bb78a8e5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa7beb7ae5b26e63dcbbfa390e27a9e4b" id="r_aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1String.html">String</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa7beb7ae5b26e63dcbbfa390e27a9e4b">fromUtf8</a> (T <a class="el" href="#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a>, T <a class="el" href="#ac823012f39cb6f61100418876e99d53b">end</a>)</td></tr>
|
|
<tr class="memdesc:aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> from a UTF-8 encoded string. <br /></td></tr>
|
|
<tr class="separator:aa7beb7ae5b26e63dcbbfa390e27a9e4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81f70eecad0000a4f2e4d66f97b80300" id="r_a81f70eecad0000a4f2e4d66f97b80300"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a81f70eecad0000a4f2e4d66f97b80300"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1String.html">String</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a81f70eecad0000a4f2e4d66f97b80300">fromUtf16</a> (T <a class="el" href="#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a>, T <a class="el" href="#ac823012f39cb6f61100418876e99d53b">end</a>)</td></tr>
|
|
<tr class="memdesc:a81f70eecad0000a4f2e4d66f97b80300"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> from a UTF-16 encoded string. <br /></td></tr>
|
|
<tr class="separator:a81f70eecad0000a4f2e4d66f97b80300"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab023a4900dce37ee71ab9e29b30a23cb" id="r_ab023a4900dce37ee71ab9e29b30a23cb"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ab023a4900dce37ee71ab9e29b30a23cb"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1String.html">String</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab023a4900dce37ee71ab9e29b30a23cb">fromUtf32</a> (T <a class="el" href="#a8ec30ddc08e3a6bd11c99aed782f6dfe">begin</a>, T <a class="el" href="#ac823012f39cb6f61100418876e99d53b">end</a>)</td></tr>
|
|
<tr class="memdesc:ab023a4900dce37ee71ab9e29b30a23cb"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> from a UTF-32 encoded string. <br /></td></tr>
|
|
<tr class="separator:ab023a4900dce37ee71ab9e29b30a23cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:abaadecaf12a6b41c54d725c75fd28527" id="r_abaadecaf12a6b41c54d725c75fd28527"><td class="memItemLeft" align="right" valign="top">static const std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a> {std::u32string::npos}</td></tr>
|
|
<tr class="memdesc:abaadecaf12a6b41c54d725c75fd28527"><td class="mdescLeft"> </td><td class="mdescRight">Represents an invalid position in the string. <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 id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a483931724196c580552b68751fb4d837" id="r_a483931724196c580552b68751fb4d837"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a483931724196c580552b68751fb4d837">operator==</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="separator:a483931724196c580552b68751fb4d837"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5158a142e0966685ec7fb4e147b24ef0" id="r_a5158a142e0966685ec7fb4e147b24ef0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5158a142e0966685ec7fb4e147b24ef0">operator<</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">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 id="related" name="related"></a>
|
|
Related Symbols</h2></td></tr>
|
|
<tr><td class="ititle" colspan="2"><p>(Note that these are not member symbols.) </p>
|
|
</td></tr>
|
|
<tr class="memitem:a483931724196c580552b68751fb4d837" id="r_a483931724196c580552b68751fb4d837"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a483931724196c580552b68751fb4d837">operator==</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:a483931724196c580552b68751fb4d837"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator==</code> to compare two UTF-32 strings. <br /></td></tr>
|
|
<tr class="separator:a483931724196c580552b68751fb4d837"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bfb9217788a9978499b8d5696bb0ef2" id="r_a3bfb9217788a9978499b8d5696bb0ef2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3bfb9217788a9978499b8d5696bb0ef2">operator!=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:a3bfb9217788a9978499b8d5696bb0ef2"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator!=</code> to compare two UTF-32 strings. <br /></td></tr>
|
|
<tr class="separator:a3bfb9217788a9978499b8d5696bb0ef2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5158a142e0966685ec7fb4e147b24ef0" id="r_a5158a142e0966685ec7fb4e147b24ef0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5158a142e0966685ec7fb4e147b24ef0">operator<</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:a5158a142e0966685ec7fb4e147b24ef0"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator<</code> to compare two UTF-32 strings. <br /></td></tr>
|
|
<tr class="separator:a5158a142e0966685ec7fb4e147b24ef0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac96278a8cbe282632b11f0c8c007df0c" id="r_ac96278a8cbe282632b11f0c8c007df0c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac96278a8cbe282632b11f0c8c007df0c">operator></a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:ac96278a8cbe282632b11f0c8c007df0c"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator></code> to compare two UTF-32 strings. <br /></td></tr>
|
|
<tr class="separator:ac96278a8cbe282632b11f0c8c007df0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9" id="r_ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1c1bb5dcf02aad3b2c0a1bf74a11cc9">operator<=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator<=</code> to compare two UTF-32 strings. <br /></td></tr>
|
|
<tr class="separator:ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a112689eec28e0ca9489e8c4ec6a34493" id="r_a112689eec28e0ca9489e8c4ec6a34493"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a112689eec28e0ca9489e8c4ec6a34493">operator>=</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:a112689eec28e0ca9489e8c4ec6a34493"><td class="mdescLeft"> </td><td class="mdescRight">Overload of <code>operator>=</code> to compare two UTF-32 strings. <br /></td></tr>
|
|
<tr class="separator:a112689eec28e0ca9489e8c4ec6a34493"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af140f992b7698cf1448677c2c8e11bf1" id="r_af140f992b7698cf1448677c2c8e11bf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af140f992b7698cf1448677c2c8e11bf1">operator+</a> (const <a class="el" href="classsf_1_1String.html">String</a> &left, const <a class="el" href="classsf_1_1String.html">String</a> &right)</td></tr>
|
|
<tr class="memdesc:af140f992b7698cf1448677c2c8e11bf1"><td class="mdescLeft"> </td><td class="mdescRight">Overload of binary <code>operator+</code> to concatenate two strings. <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><code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> 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 <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code>.</p>
|
|
<div class="fragment"><div class="line"><a class="code hl_class" href="classsf_1_1String.html">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 class="ttc" id="aclasssf_1_1String_html"><div class="ttname"><a href="classsf_1_1String.html">sf::String</a></div><div class="ttdoc">Utility string class that automatically handles conversions between types and encodings.</div><div class="ttdef"><b>Definition</b> <a href="String_8hpp_source.html#l00088">String.hpp:89</a></div></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 hl_class" href="classsf_1_1String.html">sf::String</a> s;</div>
|
|
<div class="line">...</div>
|
|
<div class="line">std::string s1 = s.<a class="code hl_function" href="#a12d6659486d24cf323b4cb70533e5d38">toAnsiString</a>(locale);</div>
|
|
<div class="line">s = <a class="code hl_class" href="classsf_1_1String.html">sf::String</a>(<span class="stringliteral">"hello"</span>, locale);</div>
|
|
<div class="ttc" id="aclasssf_1_1String_html_a12d6659486d24cf323b4cb70533e5d38"><div class="ttname"><a href="#a12d6659486d24cf323b4cb70533e5d38">sf::String::toAnsiString</a></div><div class="ttdeci">std::string toAnsiString(const std::locale &locale={}) const</div><div class="ttdoc">Convert the Unicode string to an ANSI string.</div></div>
|
|
</div><!-- fragment --><p><code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> defines the most important functions of the standard <code>std::string</code> 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 <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> whenever SFML requires it.</p>
|
|
<p>Please note that SFML also defines a low-level, generic interface for Unicode handling, see the <code><a class="el" href="classsf_1_1Utf.html" title="Utility class providing generic functions for UTF conversions.">sf::Utf</a></code> classes. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00088">88</a> of file <a class="el" href="String_8hpp_source.html">String.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="ac59fdada9f3d871d45eb1b48e488dd41" name="ac59fdada9f3d871d45eb1b48e488dd41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac59fdada9f3d871d45eb1b48e488dd41">◆ </a></span>ConstIterator</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="#ac59fdada9f3d871d45eb1b48e488dd41">sf::String::ConstIterator</a> = std::u32string::const_iterator</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read-only iterator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00095">95</a> of file <a class="el" href="String_8hpp_source.html">String.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea5ef84201f199e64a00f19d02a38c7a" name="aea5ef84201f199e64a00f19d02a38c7a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea5ef84201f199e64a00f19d02a38c7a">◆ </a></span>Iterator</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="#aea5ef84201f199e64a00f19d02a38c7a">sf::String::Iterator</a> = std::u32string::iterator</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Iterator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00094">94</a> of file <a class="el" href="String_8hpp_source.html">String.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a15f73445dc4c9ba203e090daec352434" name="a15f73445dc4c9ba203e090daec352434"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15f73445dc4c9ba203e090daec352434">◆ </a></span>String() <span class="overload">[1/11]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::String::String </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>This constructor creates an empty string. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afcb9432f007259c7f73258b8c8fab652" name="afcb9432f007259c7f73258b8c8fab652"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afcb9432f007259c7f73258b8c8fab652">◆ </a></span>String() <span class="overload">[2/11]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::String::String </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::nullptr_t</td> <td class="paramname"><span class="paramname"><em></em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::locale &</td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deleted <code>std::nullptr_t</code> constructor. </p>
|
|
<p>Disallow construction from <code>nullptr</code> literal </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49df0509c95eec3e715464c4a9e8f08b" name="a49df0509c95eec3e715464c4a9e8f08b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49df0509c95eec3e715464c4a9e8f08b">◆ </a></span>String() <span class="overload">[3/11]</span></h2>
|
|
|
|
<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"><span class="paramname"><em>ansiChar</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::locale &</td> <td class="paramname"><span class="paramname"><em>locale</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</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 id="aefaa202d2aa5ff85b4f75a5983367e86" name="aefaa202d2aa5ff85b4f75a5983367e86"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefaa202d2aa5ff85b4f75a5983367e86">◆ </a></span>String() <span class="overload">[4/11]</span></h2>
|
|
|
|
<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"><span class="paramname"><em>wideChar</em></span></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 id="aafbfb927c8f747e63736ec16cd6762cc" name="aafbfb927c8f747e63736ec16cd6762cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aafbfb927c8f747e63736ec16cd6762cc">◆ </a></span>String() <span class="overload">[5/11]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::String::String </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char32_t</td> <td class="paramname"><span class="paramname"><em>utf32Char</em></span></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 id="a80dfeec3f7a585d386fe1fc364f385af" name="a80dfeec3f7a585d386fe1fc364f385af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a80dfeec3f7a585d386fe1fc364f385af">◆ </a></span>String() <span class="overload">[6/11]</span></h2>
|
|
|
|
<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"><span class="paramname"><em>ansiString</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::locale &</td> <td class="paramname"><span class="paramname"><em>locale</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</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 id="a10cd2998619996c033499751b80f2505" name="a10cd2998619996c033499751b80f2505"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10cd2998619996c033499751b80f2505">◆ </a></span>String() <span class="overload">[7/11]</span></h2>
|
|
|
|
<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"><span class="paramname"><em>ansiString</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::locale &</td> <td class="paramname"><span class="paramname"><em>locale</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</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 id="a5742d0a9b0c754f711820c2b5c40fa55" name="a5742d0a9b0c754f711820c2b5c40fa55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5742d0a9b0c754f711820c2b5c40fa55">◆ </a></span>String() <span class="overload">[8/11]</span></h2>
|
|
|
|
<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"><span class="paramname"><em>wideString</em></span></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 id="a5e38151340af4f9a5f74ad24c0664074" name="a5e38151340af4f9a5f74ad24c0664074"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e38151340af4f9a5f74ad24c0664074">◆ </a></span>String() <span class="overload">[9/11]</span></h2>
|
|
|
|
<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"><span class="paramname"><em>wideString</em></span></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 id="acd4661f257ca19be320d83beccf4c706" name="acd4661f257ca19be320d83beccf4c706"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd4661f257ca19be320d83beccf4c706">◆ </a></span>String() <span class="overload">[10/11]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::String::String </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char32_t *</td> <td class="paramname"><span class="paramname"><em>utf32String</em></span></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 id="a38d69200909ad15a74ad6ef866db917a" name="a38d69200909ad15a74ad6ef866db917a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38d69200909ad15a74ad6ef866db917a">◆ </a></span>String() <span class="overload">[11/11]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::String::String </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::u32string</td> <td class="paramname"><span class="paramname"><em>utf32String</em></span></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>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a8ec30ddc08e3a6bd11c99aed782f6dfe" name="a8ec30ddc08e3a6bd11c99aed782f6dfe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ec30ddc08e3a6bd11c99aed782f6dfe">◆ </a></span>begin() <span class="overload">[1/2]</span></h2>
|
|
|
|
<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="#aea5ef84201f199e64a00f19d02a38c7a">Iterator</a> sf::String::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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><code><a class="el" href="#ac823012f39cb6f61100418876e99d53b" title="Return an iterator to the end of the string.">end</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e4755d6b4d51de7c3dc2e984b79f95d" name="a0e4755d6b4d51de7c3dc2e984b79f95d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e4755d6b4d51de7c3dc2e984b79f95d">◆ </a></span>begin() <span class="overload">[2/2]</span></h2>
|
|
|
|
<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="#ac59fdada9f3d871d45eb1b48e488dd41">ConstIterator</a> sf::String::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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><code><a class="el" href="#ac823012f39cb6f61100418876e99d53b" title="Return an iterator to the end of the string.">end</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a391c1b4950cbf3d3f8040cea73af2969" name="a391c1b4950cbf3d3f8040cea73af2969"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a391c1b4950cbf3d3f8040cea73af2969">◆ </a></span>clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::String::clear </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></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><code><a class="el" href="#a2ba26cb6945d2bbb210b822f222aa7f6" title="Check whether the string is empty or not.">isEmpty</a></code>, <code><a class="el" href="#aaa78a0a46b3fbe200a4ccdedc326eb93" title="Erase one or more characters from the string.">erase</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac823012f39cb6f61100418876e99d53b" name="ac823012f39cb6f61100418876e99d53b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac823012f39cb6f61100418876e99d53b">◆ </a></span>end() <span class="overload">[1/2]</span></h2>
|
|
|
|
<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="#aea5ef84201f199e64a00f19d02a38c7a">Iterator</a> sf::String::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return an iterator to the end 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><code><a class="el" href="#a8ec30ddc08e3a6bd11c99aed782f6dfe" title="Return an iterator to the beginning of the string.">begin</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1ab4c82ff2bdfb6903b4b1bb78a8e5c" name="af1ab4c82ff2bdfb6903b4b1bb78a8e5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1ab4c82ff2bdfb6903b4b1bb78a8e5c">◆ </a></span>end() <span class="overload">[2/2]</span></h2>
|
|
|
|
<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="#ac59fdada9f3d871d45eb1b48e488dd41">ConstIterator</a> sf::String::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return an iterator to the end 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><code><a class="el" href="#a8ec30ddc08e3a6bd11c99aed782f6dfe" title="Return an iterator to the beginning of the string.">begin</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa78a0a46b3fbe200a4ccdedc326eb93" name="aaa78a0a46b3fbe200a4ccdedc326eb93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa78a0a46b3fbe200a4ccdedc326eb93">◆ </a></span>erase()</h2>
|
|
|
|
<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"><span class="paramname"><em>position</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>count</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erase one or more characters from the string. </p>
|
|
<p>This function removes a sequence of <code>count</code> characters starting from <code>position</code>.</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 id="aa189ec8656854106ab8d2e935fd9cbcc" name="aa189ec8656854106ab8d2e935fd9cbcc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa189ec8656854106ab8d2e935fd9cbcc">◆ </a></span>find()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>start</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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 <code>str</code> in the string, starting from <code>start</code>.</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 <code>str</code> in the string, or <code><a class="el" href="#abaadecaf12a6b41c54d725c75fd28527" title="Represents an invalid position in the string.">String::InvalidPos</a></code> if not found </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81f70eecad0000a4f2e4d66f97b80300" name="a81f70eecad0000a4f2e4d66f97b80300"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81f70eecad0000a4f2e4d66f97b80300">◆ </a></span>fromUtf16()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classsf_1_1String.html">String</a> sf::String::fromUtf16 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>begin</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>end</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> from a UTF-16 encoded string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">begin</td><td>Forward iterator to the beginning of the UTF-16 sequence </td></tr>
|
|
<tr><td class="paramname">end</td><td>Forward iterator to the end of the UTF-16 sequence</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> containing the source string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#aa7beb7ae5b26e63dcbbfa390e27a9e4b" title="Create a new sf::String from a UTF-8 encoded string.">fromUtf8</a></code>, <code><a class="el" href="#ab023a4900dce37ee71ab9e29b30a23cb" title="Create a new sf::String from a UTF-32 encoded string.">fromUtf32</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab023a4900dce37ee71ab9e29b30a23cb" name="ab023a4900dce37ee71ab9e29b30a23cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab023a4900dce37ee71ab9e29b30a23cb">◆ </a></span>fromUtf32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classsf_1_1String.html">String</a> sf::String::fromUtf32 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>begin</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>end</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> from a UTF-32 encoded string. </p>
|
|
<p>This function is provided for consistency, it is equivalent to using the constructors that takes a <code>const char32_t*</code> or a <code>std::u32string</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">begin</td><td>Forward iterator to the beginning of the UTF-32 sequence </td></tr>
|
|
<tr><td class="paramname">end</td><td>Forward iterator to the end of the UTF-32 sequence</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> containing the source string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#aa7beb7ae5b26e63dcbbfa390e27a9e4b" title="Create a new sf::String from a UTF-8 encoded string.">fromUtf8</a></code>, <code><a class="el" href="#a81f70eecad0000a4f2e4d66f97b80300" title="Create a new sf::String from a UTF-16 encoded string.">fromUtf16</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa7beb7ae5b26e63dcbbfa390e27a9e4b" name="aa7beb7ae5b26e63dcbbfa390e27a9e4b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa7beb7ae5b26e63dcbbfa390e27a9e4b">◆ </a></span>fromUtf8()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classsf_1_1String.html">String</a> sf::String::fromUtf8 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>begin</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>end</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> from a UTF-8 encoded string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">begin</td><td>Forward iterator to the beginning of the UTF-8 sequence </td></tr>
|
|
<tr><td class="paramname">end</td><td>Forward iterator to the end of the UTF-8 sequence</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A <code><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">sf::String</a></code> containing the source string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a81f70eecad0000a4f2e4d66f97b80300" title="Create a new sf::String from a UTF-16 encoded string.">fromUtf16</a></code>, <code><a class="el" href="#ab023a4900dce37ee71ab9e29b30a23cb" title="Create a new sf::String from a UTF-32 encoded string.">fromUtf32</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f6c1b6979e822a52ee5d150f1e8d4c0" name="a0f6c1b6979e822a52ee5d150f1e8d4c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f6c1b6979e822a52ee5d150f1e8d4c0">◆ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char32_t * sf::String::getData </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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 id="ae7aff54e178f5d3e399953adff5cad20" name="ae7aff54e178f5d3e399953adff5cad20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7aff54e178f5d3e399953adff5cad20">◆ </a></span>getSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::size_t sf::String::getSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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><code><a class="el" href="#a2ba26cb6945d2bbb210b822f222aa7f6" title="Check whether the string is empty or not.">isEmpty</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad0b1455deabf07af13ee79812e05fa02" name="ad0b1455deabf07af13ee79812e05fa02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0b1455deabf07af13ee79812e05fa02">◆ </a></span>insert()</h2>
|
|
|
|
<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"><span class="paramname"><em>position</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>str</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Insert one or more characters into the string. </p>
|
|
<p>This function inserts the characters of <code>str</code> into the string, starting from <code>position</code>.</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 id="a2ba26cb6945d2bbb210b822f222aa7f6" name="a2ba26cb6945d2bbb210b822f222aa7f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ba26cb6945d2bbb210b822f222aa7f6">◆ </a></span>isEmpty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::String::isEmpty </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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><code>true</code> if the string is empty (i.e. contains no character)</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a391c1b4950cbf3d3f8040cea73af2969" title="Clear the string.">clear</a></code>, <code><a class="el" href="#ae7aff54e178f5d3e399953adff5cad20" title="Get the size of the string.">getSize</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a884816a0f688cfd48f9324c9741dc257" name="a884816a0f688cfd48f9324c9741dc257"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a884816a0f688cfd48f9324c9741dc257">◆ </a></span>operator std::string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::String::operator std::string </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implicit conversion operator to <code>std::string</code> (ANSI string) </p>
|
|
<p>The current global locale is used for conversion. If you want to explicitly 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 <code><a class="el" href="#a12d6659486d24cf323b4cb70533e5d38" title="Convert the Unicode string to an ANSI string.">toAnsiString()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Converted ANSI string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a12d6659486d24cf323b4cb70533e5d38" title="Convert the Unicode string to an ANSI string.">toAnsiString</a></code>, <code>operator std::wstring</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6bd1444bebaca9bbf01ba203061f5076" name="a6bd1444bebaca9bbf01ba203061f5076"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6bd1444bebaca9bbf01ba203061f5076">◆ </a></span>operator std::wstring()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::String::operator std::wstring </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implicit conversion operator to <code>std::wstring</code> (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 <code><a class="el" href="#a9d81aa3103e7e2062bd85d912a5aecf1" title="Convert the Unicode string to a wide string.">toWideString()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Converted wide string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d81aa3103e7e2062bd85d912a5aecf1" title="Convert the Unicode string to a wide string.">toWideString</a></code>, <code>operator std::string</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afdae61e813b2951a6e39015e34a143f7" name="afdae61e813b2951a6e39015e34a143f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdae61e813b2951a6e39015e34a143f7">◆ </a></span>operator+=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1String.html">String</a> & sf::String::operator+= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload of <code>operator+=</code> 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.html" 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 id="ac509d36dd836c8499a2813299dea865f" name="ac509d36dd836c8499a2813299dea865f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac509d36dd836c8499a2813299dea865f">◆ </a></span>operator[]() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char32_t & sf::String::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload of <code>operator[]</code> to access a character by its position. </p>
|
|
<p>This function provides read and write access to characters. Note: the behavior is undefined if <code>index</code> 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 <code>index</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a66b67d7f21d642c65c9b4e48e88e3e93" name="a66b67d7f21d642c65c9b4e48e88e3e93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66b67d7f21d642c65c9b4e48e88e3e93">◆ </a></span>operator[]() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char32_t sf::String::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload of <code>operator[]</code> to access a character by its position. </p>
|
|
<p>This function provides read-only access to characters. Note: the behavior is undefined if <code>index</code> 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 <code>index</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a82bbfee2bf23c641e5361ad505c07921" name="a82bbfee2bf23c641e5361ad505c07921"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82bbfee2bf23c641e5361ad505c07921">◆ </a></span>replace() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::String::replace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>searchFor</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>replaceWith</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Replace all occurrences of a substring with a replacement string. </p>
|
|
<p>This function replaces all occurrences of <code>searchFor</code> in this string with the string <code>replaceWith</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">searchFor</td><td>The value being searched for </td></tr>
|
|
<tr><td class="paramname">replaceWith</td><td>The value that replaces found <code>searchFor</code> values </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad460e628c287b0fa88deba2eb0b6744b" name="ad460e628c287b0fa88deba2eb0b6744b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad460e628c287b0fa88deba2eb0b6744b">◆ </a></span>replace() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::String::replace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>position</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>replaceWith</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Replace a substring with another string. </p>
|
|
<p>This function replaces the substring that starts at index <code>position</code> and spans <code>length</code> characters with the string <code>replaceWith</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">position</td><td>Index of the first character to be replaced </td></tr>
|
|
<tr><td class="paramname">length</td><td>Number of characters to replace. You can pass InvalidPos to replace all characters until the end of the string. </td></tr>
|
|
<tr><td class="paramname">replaceWith</td><td><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">String</a> that replaces the given substring. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a492645e00032455e6d92ff0e992654ce" name="a492645e00032455e6d92ff0e992654ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a492645e00032455e6d92ff0e992654ce">◆ </a></span>substring()</h2>
|
|
|
|
<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.html">String</a> sf::String::substring </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>position</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>length</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="#abaadecaf12a6b41c54d725c75fd28527">InvalidPos</a></span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return a part of the string. </p>
|
|
<p>This function returns the substring that starts at index <code>position</code> and spans <code>length</code> characters.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">position</td><td>Index of the first character </td></tr>
|
|
<tr><td class="paramname">length</td><td>Number of characters to include in the substring (if the string is shorter, as many characters as possible are included). <code>InvalidPos</code> can be used to include all characters until the end of the string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings.">String</a> object containing a substring of this object </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a12d6659486d24cf323b4cb70533e5d38" name="a12d6659486d24cf323b4cb70533e5d38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12d6659486d24cf323b4cb70533e5d38">◆ </a></span>toAnsiString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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"><span class="paramname"><em>locale</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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 <code>locale</code>. 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><code><a class="el" href="#a9d81aa3103e7e2062bd85d912a5aecf1" title="Convert the Unicode string to a wide string.">toWideString</a></code>, <code>operator std::string</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab285f398a27d65fa60e116da99f6a39e" name="ab285f398a27d65fa60e116da99f6a39e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab285f398a27d65fa60e116da99f6a39e">◆ </a></span>toUtf16()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::u16string sf::String::toUtf16 </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert the Unicode string to a UTF-16 string. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Converted UTF-16 string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a2143c53e099dcc167e97ea7deeecff05" title="Convert the Unicode string to a UTF-8 string.">toUtf8</a></code>, <code><a class="el" href="#a5c2406161cf358a357ae95db25bddad8" title="Convert the Unicode string to a UTF-32 string.">toUtf32</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c2406161cf358a357ae95db25bddad8" name="a5c2406161cf358a357ae95db25bddad8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c2406161cf358a357ae95db25bddad8">◆ </a></span>toUtf32()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::u32string sf::String::toUtf32 </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert the Unicode string to a UTF-32 string. </p>
|
|
<p>This function doesn't perform any conversion, since the string is already stored as UTF-32 internally.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Converted UTF-32 string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a2143c53e099dcc167e97ea7deeecff05" title="Convert the Unicode string to a UTF-8 string.">toUtf8</a></code>, <code><a class="el" href="#ab285f398a27d65fa60e116da99f6a39e" title="Convert the Unicode string to a UTF-16 string.">toUtf16</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2143c53e099dcc167e97ea7deeecff05" name="a2143c53e099dcc167e97ea7deeecff05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2143c53e099dcc167e97ea7deeecff05">◆ </a></span>toUtf8()</h2>
|
|
|
|
<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="namespacesf.html#a407496cc99eeb9bf75c2b4d0848d3fc7">sf::U8String</a> sf::String::toUtf8 </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert the Unicode string to a UTF-8 string. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Converted UTF-8 string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#ab285f398a27d65fa60e116da99f6a39e" title="Convert the Unicode string to a UTF-16 string.">toUtf16</a></code>, <code><a class="el" href="#a5c2406161cf358a357ae95db25bddad8" title="Convert the Unicode string to a UTF-32 string.">toUtf32</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d81aa3103e7e2062bd85d912a5aecf1" name="a9d81aa3103e7e2062bd85d912a5aecf1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d81aa3103e7e2062bd85d912a5aecf1">◆ </a></span>toWideString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::wstring sf::String::toWideString </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </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><code><a class="el" href="#a12d6659486d24cf323b4cb70533e5d38" title="Convert the Unicode string to an ANSI string.">toAnsiString</a></code>, <code>operator std::wstring</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="a3bfb9217788a9978499b8d5696bb0ef2" name="a3bfb9217788a9978499b8d5696bb0ef2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3bfb9217788a9978499b8d5696bb0ef2">◆ </a></span>operator!=()</h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</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 <code>operator!=</code> 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><code>true</code> if both strings are different </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af140f992b7698cf1448677c2c8e11bf1" name="af140f992b7698cf1448677c2c8e11bf1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af140f992b7698cf1448677c2c8e11bf1">◆ </a></span>operator+()</h2>
|
|
|
|
<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.html">String</a> operator+ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</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 <code>operator+</code> 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 id="a5158a142e0966685ec7fb4e147b24ef0" name="a5158a142e0966685ec7fb4e147b24ef0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5158a142e0966685ec7fb4e147b24ef0">◆ </a></span>operator< <span class="overload">[1/2]</span></h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5158a142e0966685ec7fb4e147b24ef0" name="a5158a142e0966685ec7fb4e147b24ef0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5158a142e0966685ec7fb4e147b24ef0">◆ </a></span>operator<() <span class="overload">[2/2]</span></h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</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 <code>operator<</code> 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><code>true</code> if <code>left</code> is lexicographically before <code>right</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1c1bb5dcf02aad3b2c0a1bf74a11cc9" name="ac1c1bb5dcf02aad3b2c0a1bf74a11cc9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1c1bb5dcf02aad3b2c0a1bf74a11cc9">◆ </a></span>operator<=()</h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</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 <code>operator<=</code> 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><code>true</code> if <code>left</code> is lexicographically before or equivalent to <code>right</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a483931724196c580552b68751fb4d837" name="a483931724196c580552b68751fb4d837"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a483931724196c580552b68751fb4d837">◆ </a></span>operator== <span class="overload">[1/2]</span></h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a483931724196c580552b68751fb4d837" name="a483931724196c580552b68751fb4d837"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a483931724196c580552b68751fb4d837">◆ </a></span>operator==() <span class="overload">[2/2]</span></h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</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 <code>operator==</code> 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><code>true</code> if both strings are equal </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac96278a8cbe282632b11f0c8c007df0c" name="ac96278a8cbe282632b11f0c8c007df0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac96278a8cbe282632b11f0c8c007df0c">◆ </a></span>operator>()</h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</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 <code>operator></code> 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><code>true</code> if <code>left</code> is lexicographically after <code>right</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a112689eec28e0ca9489e8c4ec6a34493" name="a112689eec28e0ca9489e8c4ec6a34493"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a112689eec28e0ca9489e8c4ec6a34493">◆ </a></span>operator>=()</h2>
|
|
|
|
<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.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> &</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</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 <code>operator>=</code> 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><code>true</code> if <code>left</code> is lexicographically after or equivalent to <code>right</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="abaadecaf12a6b41c54d725c75fd28527" name="abaadecaf12a6b41c54d725c75fd28527"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abaadecaf12a6b41c54d725c75fd28527">◆ </a></span>InvalidPos</h2>
|
|
|
|
<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 {std::u32string::npos}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Represents an invalid position in the string. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="String_8hpp_source.html#l00102">102</a> of file <a class="el" href="String_8hpp_source.html">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.html">String.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
|
|
Copyright © Laurent Gomila ::
|
|
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|