| <!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"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <title>Boost.Locale: Format</title> |
| |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </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 id="projectlogo"><img alt="Logo" src="boost-small.png"/></td> |
| |
| |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Boost.Locale |
| |
| </div> |
| |
| </td> |
| |
| |
| |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <!-- Generated by Doxygen 1.7.6.1 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="modules.html"><span>Modules</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| initNavTree('group__format.html',''); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Format</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <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">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> |
| <tr><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> |
| <tr><td colspan="2"><h2><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr><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> |
| <tr><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> |
| <tr><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> |
| <tr><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> |
| <tr><td colspan="2"><h2><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr><td class="memTemplParams" colspan="2">template<typename CharType > </td></tr> |
| <tr><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> |
| </table> |
| <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
| <p>This module provides printf like functionality integrated into iostreams and suitable for localization </p> |
| <hr/><h2>Typedef Documentation</h2> |
| <a class="anchor" id="gad7914df7b54382c1ad7f5360676fe2e8"></a><!-- doxytag: member="boost::locale::format" ref="gad7914df7b54382c1ad7f5360676fe2e8" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef basic_format<char> <a class="el" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">boost::locale::format</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Definition of char based format </p> |
| <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> |
| </dl> |
| </div> |
| </div> |
| <a class="anchor" id="ga7e1b668f020290ebca6570b4c12a36e6"></a><!-- doxytag: member="boost::locale::u16format" ref="ga7e1b668f020290ebca6570b4c12a36e6" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef basic_format<char16_t> <a class="el" href="group__format.html#ga7e1b668f020290ebca6570b4c12a36e6">boost::locale::u16format</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Definition of char16_t based format </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga70ce1d532e859739182439f1f3321032"></a><!-- doxytag: member="boost::locale::u32format" ref="ga70ce1d532e859739182439f1f3321032" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef basic_format<char32_t> <a class="el" href="group__format.html#ga70ce1d532e859739182439f1f3321032">boost::locale::u32format</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Definition of char32_t based format </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga610f3ae827801febc962019cf82a2227"></a><!-- doxytag: member="boost::locale::wformat" ref="ga610f3ae827801febc962019cf82a2227" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef basic_format<wchar_t> <a class="el" href="group__format.html#ga610f3ae827801febc962019cf82a2227">boost::locale::wformat</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Definition of wchar_t based format </p> |
| <dl><dt><b>Examples: </b></dt><dd><a class="el" href="whello_8cpp-example.html#a1">whello.cpp</a>.</dd> |
| </dl> |
| </div> |
| </div> |
| <hr/><h2>Function Documentation</h2> |
| <a class="anchor" id="ga3af8a407e83e679baaf375da5e2ba048"></a><!-- doxytag: member="boost::locale::operator<<" ref="ga3af8a407e83e679baaf375da5e2ba048" args="(std::basic_ostream< CharType > &out, basic_format< CharType > const &fmt)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::basic_ostream<CharType>& boost::locale::operator<< </td> |
| <td>(</td> |
| <td class="paramtype">std::basic_ostream< CharType > & </td> |
| <td class="paramname"><em>out</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">basic_format< CharType > const & </td> |
| <td class="paramname"><em>fmt</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Write formatted message to stream.</p> |
| <p>This operator actually causes actual text formatting. It uses the locale of <em>out</em> stream </p> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| |
| <li class="footer"> |
| © 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. |
| </li> |
| </ul> |
| </div> |
| |
| |
| </body> |
| </html> |