| <!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: boost::locale::basic_format< CharType > Class Template Reference</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 class="current"><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 id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</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('classboost_1_1locale_1_1basic__format.html',''); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">boost::locale::basic_format< CharType > Class Template Reference<div class="ingroups"><a class="el" href="group__format.html">Format</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <!-- doxytag: class="boost::locale::basic_format" --> |
| <p>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></p> |
| |
| <p><code>#include <<a class="el" href="format_8hpp_source.html">boost/locale/format.hpp</a>></code></p> |
| |
| <p><a href="classboost_1_1locale_1_1basic__format-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">class  </td><td class="memItemRight" valign="bottom"><b>format_guard</b></td></tr> |
| <tr><td colspan="2"><h2><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45c16f2e69842b8d223d240bbd6e210a"></a><!-- doxytag: member="boost::locale::basic_format::char_type" ref="a45c16f2e69842b8d223d240bbd6e210a" args="" --> |
| typedef CharType </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a45c16f2e69842b8d223d240bbd6e210a">char_type</a></td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Underlying character type. <br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classboost_1_1locale_1_1basic__message.html">basic_message</a>< <a class="el" href="classboost_1_1locale_1_1basic__format.html#a45c16f2e69842b8d223d240bbd6e210a">char_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a75213e5cc9d113f6b25e72542a4841f5">message_type</a></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">typedef std::basic_string<br class="typebreak"/> |
| < CharType > </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a0e1263d23f67aa38b4d857031fccf973">string_type</a></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6aba7e54f0065f2697d13ff8a859309a"></a><!-- doxytag: member="boost::locale::basic_format::stream_type" ref="a6aba7e54f0065f2697d13ff8a859309a" args="" --> |
| typedef std::basic_ostream<br class="typebreak"/> |
| < CharType > </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a6aba7e54f0065f2697d13ff8a859309a">stream_type</a></td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">output stream type for this type of character <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="classboost_1_1locale_1_1basic__format.html#a4c885ae60a5b867863b79acb75feff9e">basic_format</a> (<a class="el" href="classboost_1_1locale_1_1basic__format.html#a0e1263d23f67aa38b4d857031fccf973">string_type</a> format_string)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a155e8e60061da7461bbcc958d600c190">basic_format</a> (<a class="el" href="classboost_1_1locale_1_1basic__format.html#a75213e5cc9d113f6b25e72542a4841f5">message_type</a> const &trans)</td></tr> |
| <tr><td class="memTemplParams" colspan="2">template<typename Formattible > </td></tr> |
| <tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1basic__format.html">basic_format</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a24de7f69a5d95fd6181d888f07fc6770">operator%</a> (Formattible const &object)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a0e1263d23f67aa38b4d857031fccf973">string_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a6bc65d7993e3ab6ad51809ef8fb65400">str</a> (std::locale const &loc=std::locale()) const </td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a457c9228d13e80da3c807a51aa5ef6cd">write</a> (<a class="el" href="classboost_1_1locale_1_1basic__format.html#a6aba7e54f0065f2697d13ff8a859309a">stream_type</a> &out) const </td></tr> |
| </table> |
| <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><h3>template<typename CharType><br/> |
| class boost::locale::basic_format< CharType ></h3> |
| |
| <p>a printf like class that allows type-safe and locale aware message formatting </p> |
| <p>This class creates a formatted message similar to printf or boost::format and receives formatted entries via operator %.</p> |
| <p>For example </p> |
| <div class="fragment"><pre class="fragment"> cout << <a class="code" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">format</a>(<span class="stringliteral">"Hello {1}, you are {2} years old"</span>) % name % age << endl; |
| </pre></div><p>Formatting is enclosed between curly brackets <code>{</code> <code>}</code> and defined by a comma separated list of flags in the format key[=value] value may also be text included between single quotes <code>'</code> that is used for special purposes where inclusion of non-ASCII text is allowed</p> |
| <p>Including of literal <code>{</code> and <code>}</code> is possible by specifying double brackets <code>{{</code> and <code>}}</code> accordingly.</p> |
| <p>For example:</p> |
| <div class="fragment"><pre class="fragment"> cout << <a class="code" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">format</a>(<span class="stringliteral">"The height of water at {1,time} is {2,num=fixed,precision=3}"</span>) % <a class="code" href="group__manipulators.html#gae669b101cbeaed6f6d246ebdcaa8f39c">time</a> % height; |
| </pre></div><p>The special key -- a number without a value defines the position of an input parameter. List of keys:</p> |
| <ul> |
| <li><code></code>[0-9]+ -- digits, the index of a formatted parameter -- mandatory key.</li> |
| <li><code>num</code> or <code>number</code> -- format a number. Optional values are:<ul> |
| <li><code>hex</code> -- display hexadecimal number</li> |
| <li><code>oct</code> -- display in octal format</li> |
| <li><code>sci</code> or <code>scientific</code> -- display in scientific format</li> |
| <li><code>fix</code> or <code>fixed</code> -- display in fixed format</li> |
| </ul> |
| For example <code>number=sci</code> </li> |
| <li><code>cur</code> or <code>currency</code> -- format currency. Optional values are:</li> |
| </ul> |
| <ul> |
| <li><code>iso</code> -- display using ISO currency symbol.</li> |
| <li><code>nat</code> or <code>national</code> -- display using national currency symbol.</li> |
| </ul> |
| <ul> |
| <li><code>per</code> or <code>percent</code> -- format percent value.</li> |
| <li><code>date</code>, <code>time</code> , <code>datetime</code> or <code>dt</code> -- format date, time or date and time. Optional values are:<ul> |
| <li><code>s</code> or <code>short</code> -- display in short format</li> |
| <li><code>m</code> or <code>medium</code> -- display in medium format.</li> |
| <li><code>l</code> or <code>long</code> -- display in long format.</li> |
| <li><code>f</code> or <code>full</code> -- display in full format.</li> |
| </ul> |
| </li> |
| <li><code>ftime</code> with string (quoted) parameter -- display as with <code>strftime</code> see, <code><a class="el" href="group__manipulators.html#ga84cc8985e5305ef54394e84c10223866">as::ftime</a></code> manipulator</li> |
| <li><code>spell</code> or <code>spellout</code> -- spell the number.</li> |
| <li><code>ord</code> or <code>ordinal</code> -- format ordinal number (1st, 2nd... etc)</li> |
| <li><code>left</code> or <code><</code> -- align to left.</li> |
| <li><code>right</code> or <code>></code> -- align to right.</li> |
| <li><code>width</code> or <code>w</code> -- set field width (requires parameter).</li> |
| <li><code>precision</code> or <code>p</code> -- set precision (requires parameter).</li> |
| <li><code>locale</code> -- with parameter -- switch locale for current operation. This command generates locale with formatting facets giving more fine grained control of formatting. For example: <div class="fragment"><pre class="fragment"> cout << <a class="code" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">format</a>(<span class="stringliteral">"Today {1,date} ({1,date,locale=he_IL.UTF-8@calendar=hebrew,date} Hebrew Date)"</span>) % <a class="code" href="group__manipulators.html#gae05b82e6658dc573521518fed5f5c77f">date</a>; |
| </pre></div></li> |
| <li><code>timezone</code> or <code>tz</code> -- the name of the timezone to display the time in. For example:<br/> |
| <div class="fragment"><pre class="fragment"> cout << <a class="code" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">format</a>(<span class="stringliteral">"Time is: Local {1,time}, ({1,time,tz=EET} Eastern European Time)"</span>) % <a class="code" href="group__manipulators.html#gae05b82e6658dc573521518fed5f5c77f">date</a>; |
| </pre></div></li> |
| <li><code>local</code> - display the time in local time</li> |
| <li><code>gmt</code> - display the time in UTC time scale <div class="fragment"><pre class="fragment"> cout << <a class="code" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">format</a>(<span class="stringliteral">"Local time is: {1,time,local}, universal time is {1,time,gmt}"</span>) % <a class="code" href="group__manipulators.html#gae669b101cbeaed6f6d246ebdcaa8f39c">time</a>; |
| </pre></div></li> |
| </ul> |
| <p>Invalid formatting strings are slightly ignored. This would prevent from translator to crash the program in unexpected location. </p> |
| </div><hr/><h2>Member Typedef Documentation</h2> |
| <a class="anchor" id="a75213e5cc9d113f6b25e72542a4841f5"></a><!-- doxytag: member="boost::locale::basic_format::message_type" ref="a75213e5cc9d113f6b25e72542a4841f5" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef <a class="el" href="classboost_1_1locale_1_1basic__message.html">basic_message</a><<a class="el" href="classboost_1_1locale_1_1basic__format.html#a45c16f2e69842b8d223d240bbd6e210a">char_type</a>> <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format</a>< CharType >::<a class="el" href="classboost_1_1locale_1_1basic__format.html#a75213e5cc9d113f6b25e72542a4841f5">message_type</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>The translation message type </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0e1263d23f67aa38b4d857031fccf973"></a><!-- doxytag: member="boost::locale::basic_format::string_type" ref="a0e1263d23f67aa38b4d857031fccf973" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef std::basic_string<CharType> <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format</a>< CharType >::<a class="el" href="classboost_1_1locale_1_1basic__format.html#a0e1263d23f67aa38b4d857031fccf973">string_type</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>string type for this type of character </p> |
| |
| </div> |
| </div> |
| <hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a4c885ae60a5b867863b79acb75feff9e"></a><!-- doxytag: member="boost::locale::basic_format::basic_format" ref="a4c885ae60a5b867863b79acb75feff9e" args="(string_type format_string)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format</a>< CharType >::<a class="el" href="classboost_1_1locale_1_1basic__format.html">basic_format</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a0e1263d23f67aa38b4d857031fccf973">string_type</a> </td> |
| <td class="paramname"><em>format_string</em></td><td>)</td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Create a format class for <em>format_string</em> </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a155e8e60061da7461bbcc958d600c190"></a><!-- doxytag: member="boost::locale::basic_format::basic_format" ref="a155e8e60061da7461bbcc958d600c190" args="(message_type const &trans)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format</a>< CharType >::<a class="el" href="classboost_1_1locale_1_1basic__format.html">basic_format</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a75213e5cc9d113f6b25e72542a4841f5">message_type</a> const & </td> |
| <td class="paramname"><em>trans</em></td><td>)</td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Create a format class using message <em>trans</em>. The message if translated first according to the rules of target locale and then interpreted as format string </p> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a24de7f69a5d95fd6181d888f07fc6770"></a><!-- doxytag: member="boost::locale::basic_format::operator%" ref="a24de7f69a5d95fd6181d888f07fc6770" args="(Formattible const &object)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <div class="memtemplate"> |
| template<typename Formattible > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classboost_1_1locale_1_1basic__format.html">basic_format</a>& <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format</a>< CharType >::operator% </td> |
| <td>(</td> |
| <td class="paramtype">Formattible const & </td> |
| <td class="paramname"><em>object</em></td><td>)</td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Add new parameter to format list. The object should be a type with defined expression out << object where <code>out</code> is <code>std::basic_ostream</code>. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6bc65d7993e3ab6ad51809ef8fb65400"></a><!-- doxytag: member="boost::locale::basic_format::str" ref="a6bc65d7993e3ab6ad51809ef8fb65400" args="(std::locale const &loc=std::locale()) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a0e1263d23f67aa38b4d857031fccf973">string_type</a> <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format</a>< CharType >::<a class="el" href="classboost_1_1locale_1_1basic__format.html#a6bc65d7993e3ab6ad51809ef8fb65400">str</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::locale const & </td> |
| <td class="paramname"><em>loc</em> = <code>std::locale()</code></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Format a string using a locale <em>loc</em> </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a457c9228d13e80da3c807a51aa5ef6cd"></a><!-- doxytag: member="boost::locale::basic_format::write" ref="a457c9228d13e80da3c807a51aa5ef6cd" args="(stream_type &out) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename CharType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format</a>< CharType >::<a class="el" href="classboost_1_1locale_1_1basic__format.html#a457c9228d13e80da3c807a51aa5ef6cd">write</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1basic__format.html#a6aba7e54f0065f2697d13ff8a859309a">stream_type</a> & </td> |
| <td class="paramname"><em>out</em></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>write a formatted string to output stream <em>out</em> using out's locale </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>boost/locale/<a class="el" href="format_8hpp_source.html">format.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><b>boost</b> </li> |
| <li class="navelem"><a class="el" href="namespaceboost_1_1locale.html">locale</a> </li> |
| <li class="navelem"><a class="el" href="classboost_1_1locale_1_1basic__format.html">basic_format</a> </li> |
| |
| <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> |
