group__format.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  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&#160;Page</span></a></li>
  40. <li><a href="pages.html"><span>Related&#160;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> &#124;
  66. <a href="#typedef-members">Typedefs</a> &#124;
  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>
  74. Classes</h2></td></tr>
  75. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format&lt; CharType &gt;</a></td></tr>
  76. <tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
  78. </table><table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  80. Typedefs</h2></td></tr>
  81. <tr class="memitem:gad7914df7b54382c1ad7f5360676fe2e8"><td class="memItemLeft" align="right" valign="top">typedef basic_format&lt; char &gt;&#160;</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">&#160;</td></tr>
  83. <tr class="memitem:ga610f3ae827801febc962019cf82a2227"><td class="memItemLeft" align="right" valign="top">typedef basic_format&lt; wchar_t &gt;&#160;</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">&#160;</td></tr>
  85. <tr class="memitem:ga7e1b668f020290ebca6570b4c12a36e6"><td class="memItemLeft" align="right" valign="top">typedef basic_format&lt; char16_t &gt;&#160;</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">&#160;</td></tr>
  87. <tr class="memitem:ga70ce1d532e859739182439f1f3321032"><td class="memItemLeft" align="right" valign="top">typedef basic_format&lt; char32_t &gt;&#160;</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">&#160;</td></tr>
  89. </table><table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  91. Functions</h2></td></tr>
  92. <tr class="memitem:ga3af8a407e83e679baaf375da5e2ba048"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
  93. <tr class="memitem:ga3af8a407e83e679baaf375da5e2ba048"><td class="memTemplItemLeft" align="right" valign="top">std::basic_ostream&lt; CharType &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__format.html#ga3af8a407e83e679baaf375da5e2ba048">boost::locale::operator&lt;&lt;</a> (std::basic_ostream&lt; CharType &gt; &amp;out, basic_format&lt; CharType &gt; const &amp;fmt)</td></tr>
  94. <tr class="separator:ga3af8a407e83e679baaf375da5e2ba048"><td class="memSeparator" colspan="2">&#160;</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&lt;char&gt; <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&lt;char16_t&gt; <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. </div>
  124. </div>
  125. <a class="anchor" id="ga70ce1d532e859739182439f1f3321032"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">typedef basic_format&lt;char32_t&gt; <a class="el" href="group__format.html#ga70ce1d532e859739182439f1f3321032">boost::locale::u32format</a></td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. <p>Definition of char32_t based format </p>
  135. </div>
  136. </div>
  137. <a class="anchor" id="ga610f3ae827801febc962019cf82a2227"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">typedef basic_format&lt;wchar_t&gt; <a class="el" href="group__format.html#ga610f3ae827801febc962019cf82a2227">boost::locale::wformat</a></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Definition of wchar_t based format </p>
  147. <dl><dt><b>Examples: </b></dt><dd><a class="el" href="whello_8cpp-example.html#a1">whello.cpp</a>.</dd>
  148. </dl>
  149. </div>
  150. </div>
  151. <h2 class="groupheader">Function Documentation</h2>
  152. <a class="anchor" id="ga3af8a407e83e679baaf375da5e2ba048"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <div class="memtemplate">
  156. template&lt;typename CharType &gt; </div>
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">std::basic_ostream&lt;CharType&gt;&amp; boost::locale::operator&lt;&lt; </td>
  160. <td>(</td>
  161. <td class="paramtype">std::basic_ostream&lt; CharType &gt; &amp;&#160;</td>
  162. <td class="paramname"><em>out</em>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype">basic_format&lt; CharType &gt; const &amp;&#160;</td>
  168. <td class="paramname"><em>fmt</em>&#160;</td>
  169. </tr>
  170. <tr>
  171. <td></td>
  172. <td>)</td>
  173. <td></td><td></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>Write formatted message to stream.</p>
  178. <p>This operator actually causes actual text formatting. It uses the locale of <em>out</em> stream </p>
  179. </div>
  180. </div>
  181. </div><!-- contents -->
  182. </div><!-- doc-content -->
  183. <li class="footer">
  184. &copy; 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.
  185. </li>
  186. </ul>
  187. </div>
  188. </body>
  189. </html>