<!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::WStringStream 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_1WStringStream.html">WStringStream</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WStringStream Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WStringStream" -->
<p><code>#include <Wt/WStringStream></code></p>
<p><a href="classWt_1_1WStringStream-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1WStringStream_1_1iterator.html">iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An implementation of an output generator for appending data. <a href="structWt_1_1WStringStream_1_1iterator.html#details">More...</a><br/></td></tr>
<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_1WStringStream.html#a43b7f6c87d76e0126c3c7b7cf818bb90">WStringStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a43b7f6c87d76e0126c3c7b7cf818bb90"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#af2d77a88c8a1d173268451cbdaf1fd58">WStringStream</a> (const <a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#af2d77a88c8a1d173268451cbdaf1fd58"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a421e887595e9c22ec5eaab1e2161bfc2"></a><!-- doxytag: member="Wt::WStringStream::operator=" ref="a421e887595e9c22ec5eaab1e2161bfc2" args="(const WStringStream &other)" -->
<a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a421e887595e9c22ec5eaab1e2161bfc2">operator=</a> (const <a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#aedb019afeb209f31484c5a1c352c1ae6">WStringStream</a> (std::ostream &sink)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor with std::ostream sink. <a href="#aedb019afeb209f31484c5a1c352c1ae6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba2117aaabcfcacfc72e5ec9d209ab49"></a><!-- doxytag: member="Wt::WStringStream::~WStringStream" ref="aba2117aaabcfcacfc72e5ec9d209ab49" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#aba2117aaabcfcacfc72e5ec9d209ab49">~WStringStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a8abecc43b2fb43c26c651522d0b7b161">append</a> (const char *s, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a string. <a href="#a8abecc43b2fb43c26c651522d0b7b161"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23e03ca1c7d82db2f5bb88724cf899f9"></a><!-- doxytag: member="Wt::WStringStream::operator<<" ref="a23e03ca1c7d82db2f5bb88724cf899f9" args="(char)" -->
<a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a23e03ca1c7d82db2f5bb88724cf899f9">operator<<</a> (char)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a character. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab075ffd112e629a09695a66f436efd83"></a><!-- doxytag: member="Wt::WStringStream::operator<<" ref="ab075ffd112e629a09695a66f436efd83" args="(const char *s)" -->
<a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#ab075ffd112e629a09695a66f436efd83">operator<<</a> (const char *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a C string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64cf621ac1e2f3cca17a8134b0e6a306"></a><!-- doxytag: member="Wt::WStringStream::operator<<" ref="a64cf621ac1e2f3cca17a8134b0e6a306" args="(const std::string &s)" -->
<a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a64cf621ac1e2f3cca17a8134b0e6a306">operator<<</a> (const std::string &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a C++ string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9ec61e8b75668d13007035f00d3cfe0"></a><!-- doxytag: member="Wt::WStringStream::operator<<" ref="ac9ec61e8b75668d13007035f00d3cfe0" args="(int)" -->
<a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#ac9ec61e8b75668d13007035f00d3cfe0">operator<<</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends an integer number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a794252387a6bcbae24281c4132175553"></a><!-- doxytag: member="Wt::WStringStream::operator<<" ref="a794252387a6bcbae24281c4132175553" args="(long long)" -->
<a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a794252387a6bcbae24281c4132175553">operator<<</a> (long long)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends an integer number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2abbfb45d500ec67ee74f8dc0d35fe4"></a><!-- doxytag: member="Wt::WStringStream::operator<<" ref="ab2abbfb45d500ec67ee74f8dc0d35fe4" args="(double)" -->
<a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#ab2abbfb45d500ec67ee74f8dc0d35fe4">operator<<</a> (double)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a double. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2eab40649e542a73582fe84544828837"></a><!-- doxytag: member="Wt::WStringStream::back_inserter" ref="a2eab40649e542a73582fe84544828837" args="()" -->
<a class="el" href="structWt_1_1WStringStream_1_1iterator.html">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a2eab40649e542a73582fe84544828837">back_inserter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator for appending. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#aac2676a3876197f38dda8432073bb8c6">c_str</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the contents as a null-terminated C string. <a href="#aac2676a3876197f38dda8432073bb8c6"></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_1WStringStream.html#a867037a82e6f4fc0ecf313903859c53d">str</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the contents as a C++ string. <a href="#a867037a82e6f4fc0ecf313903859c53d"></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_1WStringStream.html#a48bacfb1ba39384ed04b66f4518f6025">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the contents is empty. <a href="#a48bacfb1ba39384ed04b66f4518f6025"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a8e1bdf133ab67e90f675fd0e0c016d20">length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the total length. <a href="#a8e1bdf133ab67e90f675fd0e0c016d20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStringStream.html#a180abb78f4bf3e5b72b78d51b5eed158">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears the contents. <a href="#a180abb78f4bf3e5b72b78d51b5eed158"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This is an efficient std::stringstream replacement. It is in particular more efficient when a relatively short string is being composed from many different pieces (avoiding any memory allocation all-together).</p>
<p>Compared to std::stringstream, it also avoids overhead by not supporting the formatting options of the latter, and by not making use of the std::locale, which apparently hampers std::ostream performance (Wt internally uses UTF-8 encoding throughout). </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a43b7f6c87d76e0126c3c7b7cf818bb90"></a><!-- doxytag: member="Wt::WStringStream::WStringStream" ref="a43b7f6c87d76e0126c3c7b7cf818bb90" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WStringStream::WStringStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Creates a string stream. </p>
</div>
</div>
<a class="anchor" id="af2d77a88c8a1d173268451cbdaf1fd58"></a><!-- doxytag: member="Wt::WStringStream::WStringStream" ref="af2d77a88c8a1d173268451cbdaf1fd58" args="(const WStringStream &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WStringStream::WStringStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WStringStream.html">WStringStream</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>This creates a deep copy of the contents. It is not applicable to a stringstream which has already a sink set. </p>
</div>
</div>
<a class="anchor" id="aedb019afeb209f31484c5a1c352c1ae6"></a><!-- doxytag: member="Wt::WStringStream::WStringStream" ref="aedb019afeb209f31484c5a1c352c1ae6" args="(std::ostream &sink)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WStringStream::WStringStream </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>sink</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor with std::ostream sink. </p>
<p>Creates a string stream which flushes contents to an std::ostream, instead of relying on internal buffering. The output may still be internally buffered (for performance reasons), and this buffer is only flushed to the underlying ostream when you delete the string stream. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8abecc43b2fb43c26c651522d0b7b161"></a><!-- doxytag: member="Wt::WStringStream::append" ref="a8abecc43b2fb43c26c651522d0b7b161" args="(const char *s, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WStringStream::append </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Appends a string. </p>
<p>Appends <code>length</code> bytes from the given string. </p>
</div>
</div>
<a class="anchor" id="aac2676a3876197f38dda8432073bb8c6"></a><!-- doxytag: member="Wt::WStringStream::c_str" ref="aac2676a3876197f38dda8432073bb8c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Wt::WStringStream::c_str </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the contents as a null-terminated C string. </p>
<p>The behaviour is only defined for a string stream with internal buffering.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is only supported when the length of the total string is less than 1024 bytes. Returns 0 if the operation could not be completed. </dd></dl>
</div>
</div>
<a class="anchor" id="a180abb78f4bf3e5b72b78d51b5eed158"></a><!-- doxytag: member="Wt::WStringStream::clear" ref="a180abb78f4bf3e5b72b78d51b5eed158" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WStringStream::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the contents. </p>
<p>The behaviour is only defined for a string stream with internal buffering. </p>
</div>
</div>
<a class="anchor" id="a48bacfb1ba39384ed04b66f4518f6025"></a><!-- doxytag: member="Wt::WStringStream::empty" ref="a48bacfb1ba39384ed04b66f4518f6025" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WStringStream::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the contents is empty. </p>
<p>The behaviour is only defined for a string stream with internal buffering. </p>
</div>
</div>
<a class="anchor" id="a8e1bdf133ab67e90f675fd0e0c016d20"></a><!-- doxytag: member="Wt::WStringStream::length" ref="a8e1bdf133ab67e90f675fd0e0c016d20" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::size_t Wt::WStringStream::length </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the total length. </p>
<p>The behaviour is only defined for a string stream with internal buffering. </p>
</div>
</div>
<a class="anchor" id="a867037a82e6f4fc0ecf313903859c53d"></a><!-- doxytag: member="Wt::WStringStream::str" ref="a867037a82e6f4fc0ecf313903859c53d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WStringStream::str </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the contents as a C++ string. </p>
<p>The behaviour is only defined for a string stream with internal buffering. </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>
