<!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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::WString Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.png" 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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WString.html">WString</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<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="#related">Related Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WString Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WString" -->
<p>A value class which describes a locale-aware unicode string.
<a href="classWt_1_1WString.html#details">More...</a></p>
<p><code>#include <Wt/WString></code></p>
<p><a href="classWt_1_1WString-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#ab1118313feb49fd2a1f7eab40f7f7a56">WString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty string. <a href="#ab1118313feb49fd2a1f7eab40f7f7a56"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a1259e1f8285f3e04ef62fb59e6c83f4e">WString</a> (const wchar_t *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a wide C string. <a href="#a1259e1f8285f3e04ef62fb59e6c83f4e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22fb311a713484d978b52b6787910da7"></a><!-- doxytag: member="Wt::WString::WString" ref="a22fb311a713484d978b52b6787910da7" args="(const WString &other)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a22fb311a713484d978b52b6787910da7">WString</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a217c6be8205e02d3e2580b6c59357bb6">WString</a> (const std::wstring &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a wide C++ string. <a href="#a217c6be8205e02d3e2580b6c59357bb6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#aa1e577f4cf6352a3a657fde3f7d3034e">WString</a> (const char *value, <a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a> encoding=LocalEncoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a C string. <a href="#aa1e577f4cf6352a3a657fde3f7d3034e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#ad2b612d535553feb1e4d08347f5475b1">WString</a> (const char *value, const std::locale &loc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a C string. <a href="#ad2b612d535553feb1e4d08347f5475b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a65df74efecfae4e46c68fe3ff28ff81d">WString</a> (const std::string &value, <a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a> encoding=LocalEncoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a C++ string. <a href="#a65df74efecfae4e46c68fe3ff28ff81d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a5aaf5904a4293de24d79ec953cf0d3b6">WString</a> (const std::string &value, const std::locale &loc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a C++ string. <a href="#a5aaf5904a4293de24d79ec953cf0d3b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3e7e1481f31514ecf58a6a344ec6ca6"></a><!-- doxytag: member="Wt::WString::~WString" ref="ad3e7e1481f31514ecf58a6a344ec6ca6" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#ad3e7e1481f31514ecf58a6a344ec6ca6">~WString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#afbd9254fb159d682ed4a2227a7ec69b7">operator=</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#afbd9254fb159d682ed4a2227a7ec69b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a5a1bf5761127553e8189a278525af71c">operator==</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator. <a href="#a5a1bf5761127553e8189a278525af71c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#accc7df36ce3febb1b2e1c297b30fafd2">operator<</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator. <a href="#accc7df36ce3febb1b2e1c297b30fafd2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a111e77b8cf401664d191eaf3f85867b1">operator></a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator. <a href="#a111e77b8cf401664d191eaf3f85867b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#abb46a3098a1a185a3498fbcf4c714c7b">operator+=</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-concatenation operator. <a href="#abb46a3098a1a185a3498fbcf4c714c7b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a0c455e324e5e756c456cd662f829373c">operator+=</a> (const std::wstring &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-concatenation operator. <a href="#a0c455e324e5e756c456cd662f829373c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a64bbf435dfe82342ce43faf9c48ee28f">operator+=</a> (const wchar_t *rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-concatenation operator. <a href="#a64bbf435dfe82342ce43faf9c48ee28f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a36d097b2ed9a2e921ad2d6a79bc3dd25">operator+=</a> (const std::string &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-concatenation operator. <a href="#a36d097b2ed9a2e921ad2d6a79bc3dd25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#acac4b0bc682e0789edc2976883ed7a5a">operator+=</a> (const char *rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Self-concatenation operator. <a href="#acac4b0bc682e0789edc2976883ed7a5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87a90e69ab25d62ba029e10ea244abaf"></a><!-- doxytag: member="Wt::WString::empty" ref="a87a90e69ab25d62ba029e10ea244abaf" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a87a90e69ab25d62ba029e10ea244abaf">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the string is empty. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a159d088da6e8f2be1035b2341889254c">toUTF8</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value as a UTF8 unicode encoded string. <a href="#a159d088da6e8f2be1035b2341889254c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#ab76d45947986f8aa20763cf99267ec23">value</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value as a wide C++ string. <a href="#ab76d45947986f8aa20763cf99267ec23"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a0b90340ac2dbacb9b4d81e92d9070066">narrow</a> (const std::locale &loc=std::locale()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value as a narrow C++ string. <a href="#a0b90340ac2dbacb9b4d81e92d9070066"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#aaf8a69faf2551af5afb4757fd02f631b">operator std::wstring</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value as a wide C++ string. <a href="#aaf8a69faf2551af5afb4757fd02f631b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a61a714a97bb6d70d60be6f9a1997e636">literal</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retuns whether the string is literal or localized. <a href="#a61a714a97bb6d70d60be6f9a1997e636"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a18807776c41bdaebd7264bbabdd2282a">key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the key for a localized string. <a href="#a18807776c41bdaebd7264bbabdd2282a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a1c3d0d7790282777ce13edececfe0095">arg</a> (const std::wstring &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with a string value. <a href="#a1c3d0d7790282777ce13edececfe0095"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a7da2111a8ca361ccd7d77df0232b3986">arg</a> (const std::string &value, <a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a>=LocalEncoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with a string value. <a href="#a7da2111a8ca361ccd7d77df0232b3986"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a4761af728bf3cc5bca4ae3770243883e">arg</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with a string value. <a href="#a4761af728bf3cc5bca4ae3770243883e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a167d99295d497bc37c11893c175e7e02">arg</a> (int value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with an integer value. <a href="#a167d99295d497bc37c11893c175e7e02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a539d0e85370e023a30a4e82e8cb1c428">arg</a> (unsigned value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with an unsigned value. <a href="#a539d0e85370e023a30a4e82e8cb1c428"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a44d7ddc45177db8e79b8d030dede4128">arg</a> (::int64_t value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with an integer value. <a href="#a44d7ddc45177db8e79b8d030dede4128"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a4a42d3d468fcb02cac44f88f340bf7d4">arg</a> (::uint64_t value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with an unsigned value. <a href="#a4a42d3d468fcb02cac44f88f340bf7d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#aadfe619a23256dab80fd238c6e4ad7d7">arg</a> (double value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the next positional argument with a double value. <a href="#aadfe619a23256dab80fd238c6e4ad7d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a130fb254a5818b9ed534eda08f9b8374"></a><!-- doxytag: member="Wt::WString::args" ref="a130fb254a5818b9ed534eda08f9b8374" args="() const " -->
const std::vector< <a class="el" href="classWt_1_1WString.html">WString</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a130fb254a5818b9ed534eda08f9b8374">args</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of arguments. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a545b18b7e07b4596281970ca1599430b">refresh</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Refreshes the string. <a href="#a545b18b7e07b4596281970ca1599430b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#abcdf277c20807ab963effd7e54732fa8">jsStringLiteral</a> (char delimiter= '\'') const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string as a JavaScript literal. <a href="#abcdf277c20807ab963effd7e54732fa8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#ae4b373b58ce67056080286a6ceca59b1">operator!=</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator. <a href="#ae4b373b58ce67056080286a6ceca59b1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a17afc7c43b5b7a710047be4a2c639575">fromUTF8</a> (const std::string &value, bool checkValid=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a UTF8 unicode encoded string. <a href="#a17afc7c43b5b7a710047be4a2c639575"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a4fbd5cdc92e39411de45acb680b1206b">fromUTF8</a> (const char *value, bool checkValid=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a WString from a UTF8 unicode encoded string. <a href="#a4fbd5cdc92e39411de45acb680b1206b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1">tr</a> (const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a localized string from a key. <a href="#a0afc7dc0f9897456d71b569a86ca26c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a42a4aad50b5a1633b1cfef4c0ffa044a">tr</a> (const std::string &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a localized string with the specified key. <a href="#a42a4aad50b5a1633b1cfef4c0ffa044a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#abcff7d3d30972762bd5d9279dc903a36">trn</a> (const char *key,::uint64_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a localized string from a key for a number <code>n</code>. <a href="#abcff7d3d30972762bd5d9279dc903a36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a641253911b8900f27f8e64521960af8e">trn</a> (const std::string &key,::uint64_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a localized string with the specified key for a number <code>n</code>. <a href="#a641253911b8900f27f8e64521960af8e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a511a12bce677dc733bd7b6b9415bff73"></a><!-- doxytag: member="Wt::WString::Empty" ref="a511a12bce677dc733bd7b6b9415bff73" args="" -->
static const <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a511a12bce677dc733bd7b6b9415bff73">Empty</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An empty string. <br/></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a> { <a class="el" href="namespaceWt.html#a55b820090cc9d15753301df90e35fd52ae31c944a7e88c44611f9317e7c1223e3">LocalEncoding</a>,
<a class="el" href="namespaceWt.html#a55b820090cc9d15753301df90e35fd52a92c04a55980fec5344377e55b271cfd0">UTF8</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration that indicates a character encoding. <a href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a552bc8e01a4bc1c6ba53607c414a82b7">WMessage</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Alias for WString (<b>deprecated</b>). <a href="#a552bc8e01a4bc1c6ba53607c414a82b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e74a971d0d341af51ffcc77fc4c5f29"></a><!-- doxytag: member="Wt::WString::operator+" ref="a8e74a971d0d341af51ffcc77fc4c5f29" args="(const WString &lhs, const WString &rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a8e74a971d0d341af51ffcc77fc4c5f29">operator+</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Concatenate two WStrings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20e373795a949c805d82cd7793ce0847"></a><!-- doxytag: member="Wt::WString::operator+" ref="a20e373795a949c805d82cd7793ce0847" args="(const WString &lhs, const std::wstring &rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a20e373795a949c805d82cd7793ce0847">operator+</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &lhs, const std::wstring &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> with a C++ wide string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29b92c396a6bdc6703a38c2da0822065"></a><!-- doxytag: member="Wt::WString::operator+" ref="a29b92c396a6bdc6703a38c2da0822065" args="(const WString &lhs, const wchar_t *rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a29b92c396a6bdc6703a38c2da0822065">operator+</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &lhs, const wchar_t *rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> with a C wide string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf52ea1a14eff4dc0f19fc089c499b58"></a><!-- doxytag: member="Wt::WString::operator+" ref="abf52ea1a14eff4dc0f19fc089c499b58" args="(const WString &lhs, const std::string &rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#abf52ea1a14eff4dc0f19fc089c499b58">operator+</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &lhs, const std::string &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a WStrin with a C++ string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8358446c46d0433f3f080698e271b91f"></a><!-- doxytag: member="Wt::WString::operator+" ref="a8358446c46d0433f3f080698e271b91f" args="(const WString &lhs, const char *rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a8358446c46d0433f3f080698e271b91f">operator+</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &lhs, const char *rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> with a C string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5c8dce7d5d1e3a9abe13a9d9093fbb2"></a><!-- doxytag: member="Wt::WString::operator+" ref="ac5c8dce7d5d1e3a9abe13a9d9093fbb2" args="(const std::wstring &lhs, const WString &rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#ac5c8dce7d5d1e3a9abe13a9d9093fbb2">operator+</a> (const std::wstring &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a C++ wide string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec7aea6adc509be52d4852cdad577aa7"></a><!-- doxytag: member="Wt::WString::operator+" ref="aec7aea6adc509be52d4852cdad577aa7" args="(const wchar_t *lhs, const WString &rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#aec7aea6adc509be52d4852cdad577aa7">operator+</a> (const wchar_t *lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a C wide string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade2e90e8c1b589d5c7cde214e05953bb"></a><!-- doxytag: member="Wt::WString::operator+" ref="ade2e90e8c1b589d5c7cde214e05953bb" args="(const std::string &lhs, const WString &rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#ade2e90e8c1b589d5c7cde214e05953bb">operator+</a> (const std::string &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a C++ string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21c7b1899a0c1fefb22cad296605c66b"></a><!-- doxytag: member="Wt::WString::operator+" ref="a21c7b1899a0c1fefb22cad296605c66b" args="(const char *lhs, const WString &rhs)" -->
WT_API <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a21c7b1899a0c1fefb22cad296605c66b">operator+</a> (const char *lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Conatenate a C string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a902005eafdaa7adc292dfb384feed65f"></a><!-- doxytag: member="Wt::WString::operator==" ref="a902005eafdaa7adc292dfb384feed65f" args="(const char *lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a902005eafdaa7adc292dfb384feed65f">operator==</a> (const char *lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b3b3574ae5e0eb9d8a74663a7ef52ad"></a><!-- doxytag: member="Wt::WString::operator==" ref="a8b3b3574ae5e0eb9d8a74663a7ef52ad" args="(const wchar_t *lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a8b3b3574ae5e0eb9d8a74663a7ef52ad">operator==</a> (const wchar_t *lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C wide string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aafe1405efe5edabdb5fa11a2f0891899"></a><!-- doxytag: member="Wt::WString::operator==" ref="aafe1405efe5edabdb5fa11a2f0891899" args="(const std::string &lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#aafe1405efe5edabdb5fa11a2f0891899">operator==</a> (const std::string &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C++ string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18fa1117aac536af9a3eeaf4a06d33e6"></a><!-- doxytag: member="Wt::WString::operator==" ref="a18fa1117aac536af9a3eeaf4a06d33e6" args="(const std::wstring &lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a18fa1117aac536af9a3eeaf4a06d33e6">operator==</a> (const std::wstring &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C++ wide string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5be68db1207e42e9cb78584aada52b7e"></a><!-- doxytag: member="Wt::WString::operator!=" ref="a5be68db1207e42e9cb78584aada52b7e" args="(const char *lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a5be68db1207e42e9cb78584aada52b7e">operator!=</a> (const char *lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add2140b578bed246c41705506987ce8d"></a><!-- doxytag: member="Wt::WString::operator!=" ref="add2140b578bed246c41705506987ce8d" args="(const wchar_t *lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#add2140b578bed246c41705506987ce8d">operator!=</a> (const wchar_t *lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C wide string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39afb0dc0c18f1c4ae9a1c36fd061722"></a><!-- doxytag: member="Wt::WString::operator!=" ref="a39afb0dc0c18f1c4ae9a1c36fd061722" args="(const std::string &lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a39afb0dc0c18f1c4ae9a1c36fd061722">operator!=</a> (const std::string &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C++ string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4bbceb2c54d45a3b0b6bc55d15a17dba"></a><!-- doxytag: member="Wt::WString::operator!=" ref="a4bbceb2c54d45a3b0b6bc55d15a17dba" args="(const std::wstring &lhs, const WString &rhs)" -->
WT_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a4bbceb2c54d45a3b0b6bc55d15a17dba">operator!=</a> (const std::wstring &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare a C++ wide string with a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82f539b8c205675c9c9f4d5d42cc9c57"></a><!-- doxytag: member="Wt::WString::operator<<" ref="a82f539b8c205675c9c9f4d5d42cc9c57" args="(std::wostream &lhs, const WString &rhs)" -->
WT_API std::wostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a82f539b8c205675c9c9f4d5d42cc9c57">operator<<</a> (std::wostream &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> to a C++ wide stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a5175831fb21a4e6245bfde54c5aaa3d2">operator<<</a> (std::ostream &lhs, const <a class="el" href="classWt_1_1WString.html">WString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> to a C++ stream. <a href="#a5175831fb21a4e6245bfde54c5aaa3d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a0de7f8ee205f8a3368d6428e4b474f11">widen</a> (const std::string &s, const std::locale &loc=std::locale())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a narrow to a wide string. <a href="#a0de7f8ee205f8a3368d6428e4b474f11"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a2986eba78638de302685abc4f8e694d0">narrow</a> (const std::wstring &s, const std::locale &loc=std::locale())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a wide to a narrow string. <a href="#a2986eba78638de302685abc4f8e694d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#aa5e236feac365794b288fd04a461406b">fromUTF8</a> (const std::string &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a UTF8 string a wide string. <a href="#aa5e236feac365794b288fd04a461406b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a302015c198cc14fb1705c99797253b48">fromUTF8</a> (const std::string &s, const std::locale &loc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a UTF8 string into a (narrow) string. <a href="#a302015c198cc14fb1705c99797253b48"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a32dae81c17e873b041a85a8509c905a5">toUTF8</a> (const std::wstring &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a wide string to UTF8. <a href="#a32dae81c17e873b041a85a8509c905a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WT_API std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WString.html#a402d7dbb582ee830e5718b50b53e971a">toUTF8</a> (const std::string &s, const std::locale &loc=std::locale())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode an character string (encoding known) to UTF8. <a href="#a402d7dbb582ee830e5718b50b53e971a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A value class which describes a locale-aware unicode string. </p>
<p>Wt offers this string to facilitate handling of unicode text through the user interface, and to offer support for localized text using message resource bundles.</p>
<p>A WString may be constructed from a std::string, std::wstring or c-style strings (const char * and const wchar_t *), and converted to each of these strings taking into account the locale in which the Wt application runs on the web server. Independent of the locale on the web server, you may convert from and to UTF8 unicode encoded std::strings.</p>
<p>By using the static functions <a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">WString::tr()</a> (or <a class="el" href="classWt_1_1WWidget.html#aa651f107ec7cf080faef6c435705fc44" title="Short hand for WString::tr()">WWidget::tr()</a>), one may construct a localized string. The key is used to retrieve its current value from the application's message-resource bundles.</p>
<p>Argument place holder in a string, denoted using {<em>n</em>} for the <em>n</em>'th argument, may be substituted by values set using <a class="el" href="classWt_1_1WString.html#a167d99295d497bc37c11893c175e7e02" title="Substitutes the next positional argument with an integer value.">arg(int)</a> and arg(std::string).</p>
<p>WString is used by all built-in widgets for displayed text. By calling <a class="el" href="classWt_1_1WApplication.html#a5c9cc1350019d69f154a2b44cdaf2596" title="Changes the locale.">WApplication::setLocale()</a> or <a class="el" href="classWt_1_1WApplication.html#a02b9d8aa1b6c2d0dc9edc1b9c63f86dc" title="Refreshes the application.">WApplication::refresh()</a>, the contents of every WString is reevaluated in the new locale, by calling <a class="el" href="classWt_1_1WString.html#a545b18b7e07b4596281970ca1599430b" title="Refreshes the string.">refresh()</a>. In this way, the contents of the whole user interface is adapted to a possibly changed locale.</p>
<p>To benefit from the localization properties of WString, you should design your own widget classes to use WString in their interface for any text that is displayed. In this way, your own widgets will automatically, and without any extra effort, participate in a relocalization triggered by <a class="el" href="classWt_1_1WApplication.html#a5c9cc1350019d69f154a2b44cdaf2596" title="Changes the locale.">WApplication::setLocale()</a>.</p>
<p>This string class does not provide anything more than basic manipulations. Instead, you should convert to a standard library string class to manipulate the string contents and perform string algorithms on them. In particular, we recommend to use the conversion methods <a class="el" href="classWt_1_1WString.html#a159d088da6e8f2be1035b2341889254c" title="Returns the value as a UTF8 unicode encoded string.">toUTF8()</a>, <a class="el" href="classWt_1_1WString.html#a17afc7c43b5b7a710047be4a2c639575" title="Creates a WString from a UTF8 unicode encoded string.">fromUTF8()</a> to convert from and to UTF8 encoded std::strings. In this way, you can support the whole unicode character set, with backward compatible support for the standard 7-bit ASCII set. Since WString internally uses UTF8-encoding, and UTF8-encoding is used by the library for communication with the browser, there is no actual conversion overhead. Only when you need to run string algorithms that require the actual length of the string in number of characters, you would need to convert to a wide string representation such as std::wstring.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a4f304244f6bc75be6cd5f41798ea5e2e" title="Returns the message resource bundle.">WApplication::messageResourceBundle()</a> </dd>
<dd>
<a class="el" href="classWt_1_1WApplication.html#a6e782f1f38a6f56e2024aab1a917a80b" title="Returns the current locale.">WApplication::locale()</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab1118313feb49fd2a1f7eab40f7f7a56"></a><!-- doxytag: member="Wt::WString::WString" ref="ab1118313feb49fd2a1f7eab40f7f7a56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::WString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an empty string. </p>
<p>Create a literal string with empty contents (""). </p>
</div>
</div>
<a class="anchor" id="a1259e1f8285f3e04ef62fb59e6c83f4e"></a><!-- doxytag: member="Wt::WString::WString" ref="a1259e1f8285f3e04ef62fb59e6c83f4e" args="(const wchar_t *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::WString </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a wide C string. </p>
<p>The wide string is implicitly converted to proper unicode. Note that there are known issues with the portability of wchar_t since its width and encoding are platform dependent. </p>
</div>
</div>
<a class="anchor" id="a217c6be8205e02d3e2580b6c59357bb6"></a><!-- doxytag: member="Wt::WString::WString" ref="a217c6be8205e02d3e2580b6c59357bb6" args="(const std::wstring &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::WString </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a wide C++ string. </p>
<p>The wide string is implicitly converted to proper unicode. Note that there are known issues with the portability of wchar_t since its width and encoding are platform dependent. </p>
</div>
</div>
<a class="anchor" id="aa1e577f4cf6352a3a657fde3f7d3034e"></a><!-- doxytag: member="Wt::WString::WString" ref="aa1e577f4cf6352a3a657fde3f7d3034e" args="(const char *value, CharEncoding encoding=LocalEncoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::WString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a> </td>
<td class="paramname"><em>encoding</em> = <code>LocalEncoding</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a C string. </p>
<p>The C string is implicitly converted to unicode. When <code>encoding</code> is <a class="el" href="namespaceWt.html#a55b820090cc9d15753301df90e35fd52ae31c944a7e88c44611f9317e7c1223e3">LocalEncoding</a>, the current locale is used to interpret the C string. When encoding is <a class="el" href="namespaceWt.html#a55b820090cc9d15753301df90e35fd52a92c04a55980fec5344377e55b271cfd0">UTF8</a>, the C string is interpreted as a UTF8 encoded unicode string. </p>
</div>
</div>
<a class="anchor" id="ad2b612d535553feb1e4d08347f5475b1"></a><!-- doxytag: member="Wt::WString::WString" ref="ad2b612d535553feb1e4d08347f5475b1" args="(const char *value, const std::locale &loc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::WString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"><em>loc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a C string. </p>
<p>The C string is implicitly converted to unicode. The string is interpreted within the character set of the given locale. </p>
</div>
</div>
<a class="anchor" id="a65df74efecfae4e46c68fe3ff28ff81d"></a><!-- doxytag: member="Wt::WString::WString" ref="a65df74efecfae4e46c68fe3ff28ff81d" args="(const std::string &value, CharEncoding encoding=LocalEncoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::WString </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a> </td>
<td class="paramname"><em>encoding</em> = <code>LocalEncoding</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a C++ string. </p>
<p>The C++ string is implicitly converted to unicode. When <code>encoding</code> is <a class="el" href="namespaceWt.html#a55b820090cc9d15753301df90e35fd52ae31c944a7e88c44611f9317e7c1223e3">LocalEncoding</a>, the current locale is used to interpret the C++ string. When encoding is <a class="el" href="namespaceWt.html#a55b820090cc9d15753301df90e35fd52a92c04a55980fec5344377e55b271cfd0">UTF8</a>, the C++ string is interpreted as a UTF8 encoded unicode string. </p>
</div>
</div>
<a class="anchor" id="a5aaf5904a4293de24d79ec953cf0d3b6"></a><!-- doxytag: member="Wt::WString::WString" ref="a5aaf5904a4293de24d79ec953cf0d3b6" args="(const std::string &value, const std::locale &loc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::WString </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"><em>loc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a C++ string. </p>
<p>The C++ string is implicitly converted to unicode. The string is interpreted within the character set of the given locale. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1c3d0d7790282777ce13edececfe0095"></a><!-- doxytag: member="Wt::WString::arg" ref="a1c3d0d7790282777ce13edececfe0095" args="(const std::wstring &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with a string value. </p>
<p>In the string, the <code>n-th</code> argument is referred to as using {<code>n}</code>.</p>
<p>For example: the string "<tt>{1} bought {2} apples in the
shop.</tt>" with first argument value "<tt>Bart</tt>" and second argument value <code>5</code> becomes: "<tt>Bart bought 5 apples in
the shop.</tt>" </p>
</div>
</div>
<a class="anchor" id="a7da2111a8ca361ccd7d77df0232b3986"></a><!-- doxytag: member="Wt::WString::arg" ref="a7da2111a8ca361ccd7d77df0232b3986" args="(const std::string &value, CharEncoding=LocalEncoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a> </td>
<td class="paramname"><em>encoding</em> = <code>LocalEncoding</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with a string value. </p>
<p>In the string, the <code>n-th</code> argument is referred to as using {<code>n}</code>.</p>
<p>For example: the string "<tt>{1} bought {2} apples in the
shop.</tt>" with first argument value "<tt>Bart</tt>" and second argument value <code>5</code> becomes: "<tt>Bart bought 5 apples in
the shop.</tt>" </p>
</div>
</div>
<a class="anchor" id="a4761af728bf3cc5bca4ae3770243883e"></a><!-- doxytag: member="Wt::WString::arg" ref="a4761af728bf3cc5bca4ae3770243883e" args="(const WString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with a string value. </p>
<p>In the string, the <code>n-th</code> argument is referred to as using {<code>n}</code>.</p>
<p>For example: the string "<tt>{1} bought {2} apples in the
shop.</tt>" with first argument value "<tt>Bart</tt>" and second argument value <code>5</code> becomes: "<tt>Bart bought 5 apples in
the shop.</tt>" </p>
</div>
</div>
<a class="anchor" id="a167d99295d497bc37c11893c175e7e02"></a><!-- doxytag: member="Wt::WString::arg" ref="a167d99295d497bc37c11893c175e7e02" args="(int value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with an integer value. </p>
<p>In the string, the <code>n-th</code> argument is reffered to as using {<code>n}</code>.</p>
<p>For example: the string "<tt>{1} bought {2} apples in the
shop.</tt>" with first argument value "<tt>Bart</tt>" and second argument value <code>5</code> becomes: "<tt>Bart bought 5 apples in
the shop.</tt>" </p>
</div>
</div>
<a class="anchor" id="a539d0e85370e023a30a4e82e8cb1c428"></a><!-- doxytag: member="Wt::WString::arg" ref="a539d0e85370e023a30a4e82e8cb1c428" args="(unsigned value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with an unsigned value. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a1c3d0d7790282777ce13edececfe0095" title="Substitutes the next positional argument with a string value.">arg()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a44d7ddc45177db8e79b8d030dede4128"></a><!-- doxytag: member="Wt::WString::arg" ref="a44d7ddc45177db8e79b8d030dede4128" args="(::int64_t value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">::int64_t </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with an integer value. </p>
<p>In the string, the <code>n-th</code> argument is reffered to as using {<code>n}</code>.</p>
<p>For example: the string "<tt>{1} bought {2} apples in the
shop.</tt>" with first argument value "<tt>Bart</tt>" and second argument value <code>5</code> becomes: "<tt>Bart bought 5 apples in
the shop.</tt>" </p>
</div>
</div>
<a class="anchor" id="a4a42d3d468fcb02cac44f88f340bf7d4"></a><!-- doxytag: member="Wt::WString::arg" ref="a4a42d3d468fcb02cac44f88f340bf7d4" args="(::uint64_t value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">::uint64_t </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with an unsigned value. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a1c3d0d7790282777ce13edececfe0095" title="Substitutes the next positional argument with a string value.">arg()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aadfe619a23256dab80fd238c6e4ad7d7"></a><!-- doxytag: member="Wt::WString::arg" ref="aadfe619a23256dab80fd238c6e4ad7d7" args="(double value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::arg </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Substitutes the next positional argument with a double value. </p>
<p>In the string, the <code>n-th</code> argument is reffered to as using {<code>n}</code>.</p>
<p>For example: the string "<tt>{1} bought {2} apples in the
shop.</tt>" with first argument value "<tt>Bart</tt>" and second argument value <code>5</code> becomes: "<tt>Bart bought 5 apples in
the shop.</tt>" </p>
</div>
</div>
<a class="anchor" id="a17afc7c43b5b7a710047be4a2c639575"></a><!-- doxytag: member="Wt::WString::fromUTF8" ref="a17afc7c43b5b7a710047be4a2c639575" args="(const std::string &value, bool checkValid=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WString::fromUTF8 </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>checkValid</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a UTF8 unicode encoded string. </p>
<p>This is equivalent to using the constructor <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>(<code>value</code>, UTF8).</p>
<p>When <code>checkValid</code> is <code>true</code>, the UTF8 encoding is validated. You should enable this only if you cannot trust the origin of the string. The library uses this internally whenever it receives data from the browser (in UTF-8 format). </p>
</div>
</div>
<a class="anchor" id="a4fbd5cdc92e39411de45acb680b1206b"></a><!-- doxytag: member="Wt::WString::fromUTF8" ref="a4fbd5cdc92e39411de45acb680b1206b" args="(const char *value, bool checkValid=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WString::fromUTF8 </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>checkValid</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a WString from a UTF8 unicode encoded string. </p>
<p>This is equivalent to using the constructor <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a>(<code>value</code>, UTF8).</p>
<p>When <code>checkValid</code> is <code>true</code>, the UTF8 encoding is validated. You should enable this only if you cannot trust the origin of the string. The library uses this internally whenever it receives data from the browser (in UTF-8 format). </p>
</div>
</div>
<a class="anchor" id="abcdf277c20807ab963effd7e54732fa8"></a><!-- doxytag: member="Wt::WString::jsStringLiteral" ref="abcdf277c20807ab963effd7e54732fa8" args="(char delimiter= '\'') const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WString::jsStringLiteral </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"><em>delimiter</em> = <code>'\''</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the string as a JavaScript literal. </p>
<p>The <code>delimiter</code> may be a single or double quote.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WWebWidget.html#a87bb5cb6d25e9feed611fb9615c5edef" title="Turn a UTF8 encoded string into a JavaScript string literal.">WWebWidget::jsStringLiteral()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a18807776c41bdaebd7264bbabdd2282a"></a><!-- doxytag: member="Wt::WString::key" ref="a18807776c41bdaebd7264bbabdd2282a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string Wt::WString::key </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the key for a localized string. </p>
<p>When the string is literal, the result is undefined. </p>
</div>
</div>
<a class="anchor" id="a61a714a97bb6d70d60be6f9a1997e636"></a><!-- doxytag: member="Wt::WString::literal" ref="a61a714a97bb6d70d60be6f9a1997e636" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WString::literal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retuns whether the string is literal or localized. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">tr()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0b90340ac2dbacb9b4d81e92d9070066"></a><!-- doxytag: member="Wt::WString::narrow" ref="a0b90340ac2dbacb9b4d81e92d9070066" args="(const std::locale &loc=std::locale()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WString::narrow </td>
<td>(</td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"><em>loc</em> = <code>std::locale()</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value as a narrow C++ string. </p>
<p>A localized string is resolved using the <a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">WApplication::localizedStrings()</a>.</p>
<p>Argument place holders are substitued with actual arguments.</p>
<p>Any wide character is narrowed using the provided locale, possibly losing information. If you wish to keep all information, use <a class="el" href="classWt_1_1WString.html#a159d088da6e8f2be1035b2341889254c" title="Returns the value as a UTF8 unicode encoded string.">toUTF8()</a> instead, which encodes wide characters in the string.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a159d088da6e8f2be1035b2341889254c" title="Returns the value as a UTF8 unicode encoded string.">toUTF8()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aaf8a69faf2551af5afb4757fd02f631b"></a><!-- doxytag: member="Wt::WString::operator std::wstring" ref="aaf8a69faf2551af5afb4757fd02f631b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WString::operator std::wstring </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value as a wide C++ string. </p>
<p>A localized string is resolved using the <a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">WApplication::localizedStrings()</a>.</p>
<p>Argument place holders are substitued with actual arguments. </p>
</div>
</div>
<a class="anchor" id="ae4b373b58ce67056080286a6ceca59b1"></a><!-- doxytag: member="Wt::WString::operator!=" ref="ae4b373b58ce67056080286a6ceca59b1" args="(const WString &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WString::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>
<p>Compares two strings and returns <code>true</code> if the strings are not exactly the same. This may require evaluating a localized string in the current locale. </p>
</div>
</div>
<a class="anchor" id="abb46a3098a1a185a3498fbcf4c714c7b"></a><!-- doxytag: member="Wt::WString::operator+=" ref="abb46a3098a1a185a3498fbcf4c714c7b" args="(const WString &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::operator+= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Self-concatenation operator. </p>
<p>Appends a string to the current value. If the string was localized, this automatically converts it to a literal string, by evaluating the string using the current locale. </p>
</div>
</div>
<a class="anchor" id="a0c455e324e5e756c456cd662f829373c"></a><!-- doxytag: member="Wt::WString::operator+=" ref="a0c455e324e5e756c456cd662f829373c" args="(const std::wstring &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::operator+= </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Self-concatenation operator. </p>
<p>Appends a string to the current value. If the string was localized, this automatically converts it to a literal string, by evaluating the string using the current locale. </p>
</div>
</div>
<a class="anchor" id="a64bbf435dfe82342ce43faf9c48ee28f"></a><!-- doxytag: member="Wt::WString::operator+=" ref="a64bbf435dfe82342ce43faf9c48ee28f" args="(const wchar_t *rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::operator+= </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Self-concatenation operator. </p>
<p>Appends a string to the current value. If the string was localized, this automatically converts it to a literal string, by evaluating the string using the current locale. </p>
</div>
</div>
<a class="anchor" id="a36d097b2ed9a2e921ad2d6a79bc3dd25"></a><!-- doxytag: member="Wt::WString::operator+=" ref="a36d097b2ed9a2e921ad2d6a79bc3dd25" args="(const std::string &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::operator+= </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Self-concatenation operator. </p>
<p>Appends a string to the current value. The right hand side is interpreted in the server locale and converted to unicode. If the string was localized, this automatically converts it to a literal string, by evaluating the string using the current locale. </p>
</div>
</div>
<a class="anchor" id="acac4b0bc682e0789edc2976883ed7a5a"></a><!-- doxytag: member="Wt::WString::operator+=" ref="acac4b0bc682e0789edc2976883ed7a5a" args="(const char *rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::operator+= </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Self-concatenation operator. </p>
<p>Appends a string to the current value. The right hand side is interpreted in the server locale and converted to unicode. If the string was localized, this automatically converts it to a literal string, by evaluating the string using the current locale. </p>
</div>
</div>
<a class="anchor" id="accc7df36ce3febb1b2e1c297b30fafd2"></a><!-- doxytag: member="Wt::WString::operator<" ref="accc7df36ce3febb1b2e1c297b30fafd2" args="(const WString &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WString::operator< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>
<p>Compares to strings lexicographically. This may require evaluating a localized string in the current locale. The unicode representation of the strings are compared. </p>
</div>
</div>
<a class="anchor" id="afbd9254fb159d682ed4a2227a7ec69b7"></a><!-- doxytag: member="Wt::WString::operator=" ref="afbd9254fb159d682ed4a2227a7ec69b7" args="(const WString &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> & Wt::WString::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<p>Copy another string into this string. </p>
</div>
</div>
<a class="anchor" id="a5a1bf5761127553e8189a278525af71c"></a><!-- doxytag: member="Wt::WString::operator==" ref="a5a1bf5761127553e8189a278525af71c" args="(const WString &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WString::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>
<p>Compares two strings and returns <code>true</code> if the strings are exactly the same. This may require evaluating a localized string in the current locale. </p>
</div>
</div>
<a class="anchor" id="a111e77b8cf401664d191eaf3f85867b1"></a><!-- doxytag: member="Wt::WString::operator>" ref="a111e77b8cf401664d191eaf3f85867b1" args="(const WString &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WString::operator> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>
<p>Compares to strings lexicographically. This may require evaluating a localized string in the current locale. The unicode representation of the strings are compared. </p>
</div>
</div>
<a class="anchor" id="a545b18b7e07b4596281970ca1599430b"></a><!-- doxytag: member="Wt::WString::refresh" ref="a545b18b7e07b4596281970ca1599430b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WString::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Refreshes the string. </p>
<p>For a localized string, its value is resolved again.</p>
<p>Returns whether the value has (potentially) changed. </p>
</div>
</div>
<a class="anchor" id="a159d088da6e8f2be1035b2341889254c"></a><!-- doxytag: member="Wt::WString::toUTF8" ref="a159d088da6e8f2be1035b2341889254c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WString::toUTF8 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value as a UTF8 unicode encoded string. </p>
<p>For a localized string, returns the current localized value.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a17afc7c43b5b7a710047be4a2c639575" title="Creates a WString from a UTF8 unicode encoded string.">fromUTF8()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0afc7dc0f9897456d71b569a86ca26c1"></a><!-- doxytag: member="Wt::WString::tr" ref="a0afc7dc0f9897456d71b569a86ca26c1" args="(const char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WString::tr </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a localized string from a key. </p>
<p>Whenever the value of the string is needed, the key is used for a lookup in the application message resource bundles taking into account the current application locale. If the key cannot be resolved, its value is set to '??key??'.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WApplication.html#a6e782f1f38a6f56e2024aab1a917a80b" title="Returns the current locale.">WApplication::locale()</a>, <a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">WApplication::localizedStrings()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a42a4aad50b5a1633b1cfef4c0ffa044a"></a><!-- doxytag: member="Wt::WString::tr" ref="a42a4aad50b5a1633b1cfef4c0ffa044a" args="(const std::string &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WString::tr </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a localized string with the specified key. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">tr(const char *)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abcff7d3d30972762bd5d9279dc903a36"></a><!-- doxytag: member="Wt::WString::trn" ref="abcff7d3d30972762bd5d9279dc903a36" args="(const char *key,::uint64_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WString::trn </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::uint64_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a localized string from a key for a number <code>n</code>. </p>
<p>Whenever the value of the string is needed, the <code>key</code> is used for a lookup in the application message resource bundles taking into account the current application locale. This function fetches the appropriate plural case for the translation corresponding to the quantity <code>n</code>. Note that usually, your string will have a place-holder for the value of <code>n</code>, and thus you will also need to bind <code>as</code> an argument.</p>
<p>For example, consider a string "quantity.cars" with two plural cases:</p>
<ul>
<li>n == 1: "{1} car"</li>
<li>n != 1: "{1} cars"</li>
</ul>
<p>You would use the following to use the string: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WString.html#abcff7d3d30972762bd5d9279dc903a36" title="Creates a localized string from a key for a number n.">Wt::WString::trn</a>(<span class="stringliteral">"quantity.cars"</span>, cars).arg(cars);
</pre></div><p>If the <code>key</code> cannot be resolved, its value is set to '??key??'.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a0afc7dc0f9897456d71b569a86ca26c1" title="Creates a localized string from a key.">tr()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a641253911b8900f27f8e64521960af8e"></a><!-- doxytag: member="Wt::WString::trn" ref="a641253911b8900f27f8e64521960af8e" args="(const std::string &key,::uint64_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WString::trn </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::uint64_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a localized string with the specified key for a number <code>n</code>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>trn(const char *) </dd></dl>
</div>
</div>
<a class="anchor" id="ab76d45947986f8aa20763cf99267ec23"></a><!-- doxytag: member="Wt::WString::value" ref="ab76d45947986f8aa20763cf99267ec23" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::wstring Wt::WString::value </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value as a wide C++ string. </p>
<p>A localized string is resolved using the <a class="el" href="classWt_1_1WApplication.html#abcbace5a9e38947bf036ae86fb3438c0" title="Returns the resource object that provides localized strings.">WApplication::localizedStrings()</a>.</p>
<p>Argument place holders are substitued with actual arguments. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a55b820090cc9d15753301df90e35fd52"></a><!-- doxytag: member="Wt::WString::CharEncoding" ref="a55b820090cc9d15753301df90e35fd52" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WString.html#a55b820090cc9d15753301df90e35fd52">CharEncoding</a><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration that indicates a character encoding. </p>
<p>Character encodings are used to represent characters in a stream of bytes. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a55b820090cc9d15753301df90e35fd52ae31c944a7e88c44611f9317e7c1223e3"></a><!-- doxytag: member="LocalEncoding" ref="a55b820090cc9d15753301df90e35fd52ae31c944a7e88c44611f9317e7c1223e3" args="" -->LocalEncoding</em> </td><td>
<p>The (server) system locale. </p>
<p>Each byte represents a character, according to the locale of the server-side system. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a55b820090cc9d15753301df90e35fd52a92c04a55980fec5344377e55b271cfd0"></a><!-- doxytag: member="UTF8" ref="a55b820090cc9d15753301df90e35fd52a92c04a55980fec5344377e55b271cfd0" args="" -->UTF8</em> </td><td>
<p>UTF-8 unicode encoding. </p>
<p>The byte stream represents unicode characters encoded using UTF-8. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa5e236feac365794b288fd04a461406b"></a><!-- doxytag: member="Wt::WString::fromUTF8" ref="aa5e236feac365794b288fd04a461406b" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WT_API std::wstring fromUTF8 </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a UTF8 string a wide string. </p>
<p>Decode a UTF8 string to a wide string. In a UTF8 encoded unicode string, some unicode characters are represented in more than one byte. This method will decode to extract the proper unicode characters from the string. The resulting string may thus be shorter (has less characters) than the original, but does not lead to a loss of information.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>toUTF8(const std::string& s), narrow(const std::wstring&) </dd></dl>
</div>
</div>
<a class="anchor" id="a302015c198cc14fb1705c99797253b48"></a><!-- doxytag: member="Wt::WString::fromUTF8" ref="a302015c198cc14fb1705c99797253b48" args="(const std::string &s, const std::locale &loc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WT_API std::string fromUTF8 </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"><em>loc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a UTF8 string into a (narrow) string. </p>
<p>Decode a UTF8 string to a normal string. Not all Unicode characters can be represented in a narrow string, and quite a lot characters will have no equivalent in the target character set, so you may loose information.</p>
<p>To distinguish from the other <a class="el" href="classWt_1_1WString.html#a17afc7c43b5b7a710047be4a2c639575" title="Creates a WString from a UTF8 unicode encoded string.">fromUTF8()</a> function, that returns a wstring, the locale is not an optional argument, as in most other locale-conversing functions. You may choose to use the default-constructed std::locale().</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a402d7dbb582ee830e5718b50b53e971a" title="Encode an character string (encoding known) to UTF8.">toUTF8(const std::string& s, const std::locale &)</a>, <a class="el" href="classWt_1_1WString.html#aa5e236feac365794b288fd04a461406b" title="Decode a UTF8 string a wide string.">fromUTF8(const std::string& s)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2986eba78638de302685abc4f8e694d0"></a><!-- doxytag: member="Wt::WString::narrow" ref="a2986eba78638de302685abc4f8e694d0" args="(const std::wstring &s, const std::locale &loc=std::locale())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WT_API std::string narrow </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"><em>loc</em> = <code>std::locale()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a wide to a narrow string. </p>
<p>Convert a wide string to a narrow string. This method will encode the characters in the given locale, if possible.</p>
<p>In general this will lead to a loss of information. If you wish to preserve all information, you should us <a class="el" href="classWt_1_1WString.html#a159d088da6e8f2be1035b2341889254c" title="Returns the value as a UTF8 unicode encoded string.">toUTF8()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>widen(const std::string&), <a class="el" href="classWt_1_1WString.html#a32dae81c17e873b041a85a8509c905a5" title="Encode a wide string to UTF8.">toUTF8(const std::wstring& s)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5175831fb21a4e6245bfde54c5aaa3d2"></a><!-- doxytag: member="Wt::WString::operator<<" ref="a5175831fb21a4e6245bfde54c5aaa3d2" args="(std::ostream &lhs, const WString &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WT_API std::ostream & operator<< </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>rhs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Output a <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> to a C++ stream. </p>
<p>The string is narrowed using the currently global C++ locale, possibly losing information. </p>
</div>
</div>
<a class="anchor" id="a32dae81c17e873b041a85a8509c905a5"></a><!-- doxytag: member="Wt::WString::toUTF8" ref="a32dae81c17e873b041a85a8509c905a5" args="(const std::wstring &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WT_API std::string toUTF8 </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a wide string to UTF8. </p>
<p>Convert a wide string to UTF8. This method will encode the given wide string in UTF8. This may result in a string that is possibly longer (has more characters), but does not lead to a loss of information.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#aa5e236feac365794b288fd04a461406b" title="Decode a UTF8 string a wide string.">fromUTF8(const std::string& s)</a>, narrow(const std::wstring&) </dd></dl>
</div>
</div>
<a class="anchor" id="a402d7dbb582ee830e5718b50b53e971a"></a><!-- doxytag: member="Wt::WString::toUTF8" ref="a402d7dbb582ee830e5718b50b53e971a" args="(const std::string &s, const std::locale &loc=std::locale())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WT_API std::string toUTF8 </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"><em>loc</em> = <code>std::locale()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode an character string (encoding known) to UTF8. </p>
<p>Convert a char * string to UTF8. This method will encode the given string in UTF8, assuming that the original string was encoded in the given locale. This conversion does not lead to a loss of information.</p>
<p>The reverse operation is in principle narrow(fromUTF8(str), locale).</p>
<p>Do not call this function multiple times: toUTF8(toUTF8(str)) is meaningless.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WString.html#a32dae81c17e873b041a85a8509c905a5" title="Encode a wide string to UTF8.">toUTF8(const std::wstring& s)</a>, <a class="el" href="classWt_1_1WString.html#aa5e236feac365794b288fd04a461406b" title="Decode a UTF8 string a wide string.">fromUTF8(const std::string &)</a>, narrow(const std::wstring&) </dd></dl>
</div>
</div>
<a class="anchor" id="a0de7f8ee205f8a3368d6428e4b474f11"></a><!-- doxytag: member="Wt::WString::widen" ref="a0de7f8ee205f8a3368d6428e4b474f11" args="(const std::string &s, const std::locale &loc=std::locale())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WT_API std::wstring widen </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"><em>loc</em> = <code>std::locale()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a narrow to a wide string. </p>
<p>Convert a narrow string to a wide string. This method will interpret the input string as being encoded in the given locale (by default the currently configured global C++ locale).</p>
<dl class="see"><dt><b>See also:</b></dt><dd>narrow(const std::wstring&), <a class="el" href="classWt_1_1WString.html#aa5e236feac365794b288fd04a461406b" title="Decode a UTF8 string a wide string.">fromUTF8(const std::string& s)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a552bc8e01a4bc1c6ba53607c414a82b7"></a><!-- doxytag: member="Wt::WString::WMessage" ref="a552bc8e01a4bc1c6ba53607c414a82b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classWt_1_1WString.html">WString</a> <a class="el" href="classWt_1_1WString.html#a552bc8e01a4bc1c6ba53607c414a82b7">WMessage</a><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Alias for WString (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000054">Deprecated:</a></b></dt><dd>use <a class="el" href="classWt_1_1WString.html" title="A value class which describes a locale-aware unicode string.">WString</a> instead.</dd></dl>
<p>WString provides all the functionality of the now deprecated WMessage, but is used more consistently through the API. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
