1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.6"/> 7<title>Boost.Locale: Format</title> 8<link href="tabs.css" rel="stylesheet" type="text/css"/> 9<script type="text/javascript" src="jquery.js"></script> 10<script type="text/javascript" src="dynsections.js"></script> 11<link href="navtree.css" rel="stylesheet" type="text/css"/> 12<script type="text/javascript" src="resize.js"></script> 13<script type="text/javascript" src="navtree.js"></script> 14<script type="text/javascript"> 15 $(document).ready(initResizable); 16 $(window).load(resizeHeight); 17</script> 18<link href="doxygen.css" rel="stylesheet" type="text/css" /> 19</head> 20<body> 21<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 22<div id="titlearea"> 23<table cellspacing="0" cellpadding="0"> 24 <tbody> 25 <tr style="height: 56px;"> 26 <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td> 27 <td style="padding-left: 0.5em;"> 28 <div id="projectname">Boost.Locale 29 </div> 30 </td> 31 </tr> 32 </tbody> 33</table> 34</div> 35<!-- end header part --> 36<!-- Generated by Doxygen 1.8.6 --> 37 <div id="navrow1" class="tabs"> 38 <ul class="tablist"> 39 <li><a href="index.html"><span>Main Page</span></a></li> 40 <li><a href="pages.html"><span>Related Pages</span></a></li> 41 <li><a href="modules.html"><span>Modules</span></a></li> 42 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 43 <li><a href="annotated.html"><span>Classes</span></a></li> 44 <li><a href="files.html"><span>Files</span></a></li> 45 <li><a href="examples.html"><span>Examples</span></a></li> 46 </ul> 47 </div> 48</div><!-- top --> 49<div id="side-nav" class="ui-resizable side-nav-resizable"> 50 <div id="nav-tree"> 51 <div id="nav-tree-contents"> 52 <div id="nav-sync" class="sync"></div> 53 </div> 54 </div> 55 <div id="splitbar" style="-moz-user-select:none;" 56 class="ui-resizable-handle"> 57 </div> 58</div> 59<script type="text/javascript"> 60$(document).ready(function(){initNavTree('group__format.html','');}); 61</script> 62<div id="doc-content"> 63<div class="header"> 64 <div class="summary"> 65<a href="#nested-classes">Classes</a> | 66<a href="#typedef-members">Typedefs</a> | 67<a href="#func-members">Functions</a> </div> 68 <div class="headertitle"> 69<div class="title">Format</div> </div> 70</div><!--header--> 71<div class="contents"> 72<table class="memberdecls"> 73<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> 74Classes</h2></td></tr> 75<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format< CharType ></a></td></tr> 76<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">a printf like class that allows type-safe and locale aware message formatting <a href="classboost_1_1locale_1_1basic__format.html#details">More...</a><br/></td></tr> 77<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 78</table><table class="memberdecls"> 79<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> 80Typedefs</h2></td></tr> 81<tr class="memitem:gad7914df7b54382c1ad7f5360676fe2e8"><td class="memItemLeft" align="right" valign="top">typedef basic_format< char > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">boost::locale::format</a></td></tr> 82<tr class="separator:gad7914df7b54382c1ad7f5360676fe2e8"><td class="memSeparator" colspan="2"> </td></tr> 83<tr class="memitem:ga610f3ae827801febc962019cf82a2227"><td class="memItemLeft" align="right" valign="top">typedef basic_format< wchar_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#ga610f3ae827801febc962019cf82a2227">boost::locale::wformat</a></td></tr> 84<tr class="separator:ga610f3ae827801febc962019cf82a2227"><td class="memSeparator" colspan="2"> </td></tr> 85<tr class="memitem:ga7e1b668f020290ebca6570b4c12a36e6"><td class="memItemLeft" align="right" valign="top">typedef basic_format< char16_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#ga7e1b668f020290ebca6570b4c12a36e6">boost::locale::u16format</a></td></tr> 86<tr class="separator:ga7e1b668f020290ebca6570b4c12a36e6"><td class="memSeparator" colspan="2"> </td></tr> 87<tr class="memitem:ga70ce1d532e859739182439f1f3321032"><td class="memItemLeft" align="right" valign="top">typedef basic_format< char32_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#ga70ce1d532e859739182439f1f3321032">boost::locale::u32format</a></td></tr> 88<tr class="separator:ga70ce1d532e859739182439f1f3321032"><td class="memSeparator" colspan="2"> </td></tr> 89</table><table class="memberdecls"> 90<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 91Functions</h2></td></tr> 92<tr class="memitem:ga3af8a407e83e679baaf375da5e2ba048"><td class="memTemplParams" colspan="2">template<typename CharType > </td></tr> 93<tr class="memitem:ga3af8a407e83e679baaf375da5e2ba048"><td class="memTemplItemLeft" align="right" valign="top">std::basic_ostream< CharType > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__format.html#ga3af8a407e83e679baaf375da5e2ba048">boost::locale::operator<<</a> (std::basic_ostream< CharType > &out, basic_format< CharType > const &fmt)</td></tr> 94<tr class="separator:ga3af8a407e83e679baaf375da5e2ba048"><td class="memSeparator" colspan="2"> </td></tr> 95</table> 96<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 97<p>This module provides printf like functionality integrated into iostreams and suitable for localization </p> 98<h2 class="groupheader">Typedef Documentation</h2> 99<a class="anchor" id="gad7914df7b54382c1ad7f5360676fe2e8"></a> 100<div class="memitem"> 101<div class="memproto"> 102 <table class="memname"> 103 <tr> 104 <td class="memname">typedef basic_format<char> <a class="el" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">boost::locale::format</a></td> 105 </tr> 106 </table> 107</div><div class="memdoc"> 108<p>Definition of char based format </p> 109<dl><dt><b>Examples: </b></dt><dd><a class="el" href="calendar_8cpp-example.html#a6">calendar.cpp</a>, and <a class="el" href="hello_8cpp-example.html#a1">hello.cpp</a>.</dd> 110</dl> 111</div> 112</div> 113<a class="anchor" id="ga7e1b668f020290ebca6570b4c12a36e6"></a> 114<div class="memitem"> 115<div class="memproto"> 116 <table class="memname"> 117 <tr> 118 <td class="memname">typedef basic_format<char16_t> <a class="el" href="group__format.html#ga7e1b668f020290ebca6570b4c12a36e6">boost::locale::u16format</a></td> 119 </tr> 120 </table> 121</div><div class="memdoc"> 122<p>Definition of char16_t based format </p> 123 124</div> 125</div> 126<a class="anchor" id="ga70ce1d532e859739182439f1f3321032"></a> 127<div class="memitem"> 128<div class="memproto"> 129 <table class="memname"> 130 <tr> 131 <td class="memname">typedef basic_format<char32_t> <a class="el" href="group__format.html#ga70ce1d532e859739182439f1f3321032">boost::locale::u32format</a></td> 132 </tr> 133 </table> 134</div><div class="memdoc"> 135<p>Definition of char32_t based format </p> 136 137</div> 138</div> 139<a class="anchor" id="ga610f3ae827801febc962019cf82a2227"></a> 140<div class="memitem"> 141<div class="memproto"> 142 <table class="memname"> 143 <tr> 144 <td class="memname">typedef basic_format<wchar_t> <a class="el" href="group__format.html#ga610f3ae827801febc962019cf82a2227">boost::locale::wformat</a></td> 145 </tr> 146 </table> 147</div><div class="memdoc"> 148<p>Definition of wchar_t based format </p> 149<dl><dt><b>Examples: </b></dt><dd><a class="el" href="whello_8cpp-example.html#a1">whello.cpp</a>.</dd> 150</dl> 151</div> 152</div> 153<h2 class="groupheader">Function Documentation</h2> 154<a class="anchor" id="ga3af8a407e83e679baaf375da5e2ba048"></a> 155<div class="memitem"> 156<div class="memproto"> 157<div class="memtemplate"> 158template<typename CharType > </div> 159 <table class="memname"> 160 <tr> 161 <td class="memname">std::basic_ostream<CharType>& boost::locale::operator<< </td> 162 <td>(</td> 163 <td class="paramtype">std::basic_ostream< CharType > & </td> 164 <td class="paramname"><em>out</em>, </td> 165 </tr> 166 <tr> 167 <td class="paramkey"></td> 168 <td></td> 169 <td class="paramtype">basic_format< CharType > const & </td> 170 <td class="paramname"><em>fmt</em> </td> 171 </tr> 172 <tr> 173 <td></td> 174 <td>)</td> 175 <td></td><td></td> 176 </tr> 177 </table> 178</div><div class="memdoc"> 179<p>Write formatted message to stream.</p> 180<p>This operator actually causes actual text formatting. It uses the locale of <em>out</em> stream </p> 181 182</div> 183</div> 184</div><!-- contents --> 185</div><!-- doc-content --> 186 187 <li class="footer"> 188© Copyright 2009-2012 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0. 189 </li> 190 </ul> 191 </div> 192</body> 193</html> 194
