blob: 8dfe6d92bc0371b7777a64410a40409a4f1d6a22 [file] [log] [blame]
<!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::ios_info Class 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&#160;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&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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_1ios__info.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">boost::locale::ios_info Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="boost::locale::ios_info" -->
<p>This class holds an external data - beyond existing fmtflags that std::ios_base holds.
<a href="classboost_1_1locale_1_1ios__info.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="formatting_8hpp_source.html">boost/locale/formatting.hpp</a>&gt;</code></p>
<p><a href="classboost_1_1locale_1_1ios__info-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 &#160;</td><td class="memItemRight" valign="bottom"><b>string_set</b></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">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a18b06a5cf88e25361bf188f64216edf2">display_flags</a> (uint64_t flags)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#ad31ea1190ae882f20eea582312c6c573">currency_flags</a> (uint64_t flags)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#aec16372d284296c63ebd282121fa0005">date_flags</a> (uint64_t flags)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a06bdad5c9b11e57c16ad623776ce5096">time_flags</a> (uint64_t flags)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a6e90b9fcfb723495da5239fc380b0331">datetime_flags</a> (uint64_t flags)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a08b1bb49e5806900bfa1901e869497a6">domain_id</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a3f140278815b521f1568c52d0a9fea11">time_zone</a> (std::string const &amp;)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a41bc55992899be3af94de29a8e78edf7">date_time_pattern</a> (std::basic_string&lt; CharType &gt; const &amp;str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a8b72d7ac5dcd8be72f4bf49b73616db4">display_flags</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#ac98b6625dcd7e552e144510192daebb7">currency_flags</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#af46aa3529a930f328613533c6626260a">date_flags</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#ab8e618c7e292dba53d9334926522031e">time_flags</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a5e034268f4b5295ddaae948ffe8a1ec0">datetime_flags</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a91fee7df7d3802c65c28c5ef24a10707">domain_id</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a0325f6eca8b939609614fe98e4e9ab42">time_zone</a> () const </td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">std::basic_string&lt; CharType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#ac0f1059742e489433fd53500c747d30c">date_time_pattern</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classboost_1_1locale_1_1ios__info.html">ios_info</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1ios__info.html#a02f6979dffc2df97c3612d72b7c7241b">get</a> (std::ios_base &amp;ios)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class holds an external data - beyond existing fmtflags that std::ios_base holds. </p>
<p>You should almost never create this object directly. Instead, you should access it via ios_info::get(stream_object) static member function. It automatically creates default formatting data for that stream </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad31ea1190ae882f20eea582312c6c573"></a><!-- doxytag: member="boost::locale::ios_info::currency_flags" ref="ad31ea1190ae882f20eea582312c6c573" args="(uint64_t flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#ad31ea1190ae882f20eea582312c6c573">boost::locale::ios_info::currency_flags</a> </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a flags that define how to format currency </p>
</div>
</div>
<a class="anchor" id="ac98b6625dcd7e552e144510192daebb7"></a><!-- doxytag: member="boost::locale::ios_info::currency_flags" ref="ac98b6625dcd7e552e144510192daebb7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t <a class="el" href="classboost_1_1locale_1_1ios__info.html#ad31ea1190ae882f20eea582312c6c573">boost::locale::ios_info::currency_flags</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a flags that define how to format currency </p>
</div>
</div>
<a class="anchor" id="aec16372d284296c63ebd282121fa0005"></a><!-- doxytag: member="boost::locale::ios_info::date_flags" ref="aec16372d284296c63ebd282121fa0005" args="(uint64_t flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#aec16372d284296c63ebd282121fa0005">boost::locale::ios_info::date_flags</a> </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a flags that define how to format date </p>
</div>
</div>
<a class="anchor" id="af46aa3529a930f328613533c6626260a"></a><!-- doxytag: member="boost::locale::ios_info::date_flags" ref="af46aa3529a930f328613533c6626260a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t <a class="el" href="classboost_1_1locale_1_1ios__info.html#aec16372d284296c63ebd282121fa0005">boost::locale::ios_info::date_flags</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a flags that define how to format date </p>
</div>
</div>
<a class="anchor" id="a41bc55992899be3af94de29a8e78edf7"></a><!-- doxytag: member="boost::locale::ios_info::date_time_pattern" ref="a41bc55992899be3af94de29a8e78edf7" args="(std::basic_string&lt; CharType &gt; const &amp;str)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#a41bc55992899be3af94de29a8e78edf7">boost::locale::ios_info::date_time_pattern</a> </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; CharType &gt; const &amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set date/time pattern (strftime like) </p>
</div>
</div>
<a class="anchor" id="ac0f1059742e489433fd53500c747d30c"></a><!-- doxytag: member="boost::locale::ios_info::date_time_pattern" ref="ac0f1059742e489433fd53500c747d30c" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::basic_string&lt;CharType&gt; <a class="el" href="classboost_1_1locale_1_1ios__info.html#a41bc55992899be3af94de29a8e78edf7">boost::locale::ios_info::date_time_pattern</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get date/time pattern (strftime like) </p>
</div>
</div>
<a class="anchor" id="a6e90b9fcfb723495da5239fc380b0331"></a><!-- doxytag: member="boost::locale::ios_info::datetime_flags" ref="a6e90b9fcfb723495da5239fc380b0331" args="(uint64_t flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#a6e90b9fcfb723495da5239fc380b0331">boost::locale::ios_info::datetime_flags</a> </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a flags that define how to format both date and time </p>
</div>
</div>
<a class="anchor" id="a5e034268f4b5295ddaae948ffe8a1ec0"></a><!-- doxytag: member="boost::locale::ios_info::datetime_flags" ref="a5e034268f4b5295ddaae948ffe8a1ec0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t <a class="el" href="classboost_1_1locale_1_1ios__info.html#a6e90b9fcfb723495da5239fc380b0331">boost::locale::ios_info::datetime_flags</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a flags that define how to format both date and time </p>
</div>
</div>
<a class="anchor" id="a18b06a5cf88e25361bf188f64216edf2"></a><!-- doxytag: member="boost::locale::ios_info::display_flags" ref="a18b06a5cf88e25361bf188f64216edf2" args="(uint64_t flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#a18b06a5cf88e25361bf188f64216edf2">boost::locale::ios_info::display_flags</a> </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a flags that define a way for format data like number, spell, currency etc. </p>
</div>
</div>
<a class="anchor" id="a8b72d7ac5dcd8be72f4bf49b73616db4"></a><!-- doxytag: member="boost::locale::ios_info::display_flags" ref="a8b72d7ac5dcd8be72f4bf49b73616db4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t <a class="el" href="classboost_1_1locale_1_1ios__info.html#a18b06a5cf88e25361bf188f64216edf2">boost::locale::ios_info::display_flags</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a flags that define a way for format data like number, spell, currency etc. </p>
</div>
</div>
<a class="anchor" id="a08b1bb49e5806900bfa1901e869497a6"></a><!-- doxytag: member="boost::locale::ios_info::domain_id" ref="a08b1bb49e5806900bfa1901e869497a6" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#a08b1bb49e5806900bfa1901e869497a6">boost::locale::ios_info::domain_id</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set special message domain identification </p>
</div>
</div>
<a class="anchor" id="a91fee7df7d3802c65c28c5ef24a10707"></a><!-- doxytag: member="boost::locale::ios_info::domain_id" ref="a91fee7df7d3802c65c28c5ef24a10707" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classboost_1_1locale_1_1ios__info.html#a08b1bb49e5806900bfa1901e869497a6">boost::locale::ios_info::domain_id</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get special message domain identification </p>
</div>
</div>
<a class="anchor" id="a02f6979dffc2df97c3612d72b7c7241b"></a><!-- doxytag: member="boost::locale::ios_info::get" ref="a02f6979dffc2df97c3612d72b7c7241b" args="(std::ios_base &amp;ios)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classboost_1_1locale_1_1ios__info.html">ios_info</a>&amp; <a class="el" href="classboost_1_1locale_1_1ios__info.html#a02f6979dffc2df97c3612d72b7c7241b">boost::locale::ios_info::get</a> </td>
<td>(</td>
<td class="paramtype">std::ios_base &amp;&#160;</td>
<td class="paramname"><em>ios</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get <a class="el" href="classboost_1_1locale_1_1ios__info.html" title="This class holds an external data - beyond existing fmtflags that std::ios_base holds.">ios_info</a> instance for specific stream object </p>
</div>
</div>
<a class="anchor" id="a06bdad5c9b11e57c16ad623776ce5096"></a><!-- doxytag: member="boost::locale::ios_info::time_flags" ref="a06bdad5c9b11e57c16ad623776ce5096" args="(uint64_t flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#a06bdad5c9b11e57c16ad623776ce5096">boost::locale::ios_info::time_flags</a> </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a flags that define how to format time </p>
</div>
</div>
<a class="anchor" id="ab8e618c7e292dba53d9334926522031e"></a><!-- doxytag: member="boost::locale::ios_info::time_flags" ref="ab8e618c7e292dba53d9334926522031e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t <a class="el" href="classboost_1_1locale_1_1ios__info.html#a06bdad5c9b11e57c16ad623776ce5096">boost::locale::ios_info::time_flags</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a flags that define how to format time </p>
</div>
</div>
<a class="anchor" id="a3f140278815b521f1568c52d0a9fea11"></a><!-- doxytag: member="boost::locale::ios_info::time_zone" ref="a3f140278815b521f1568c52d0a9fea11" args="(std::string const &amp;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classboost_1_1locale_1_1ios__info.html#a3f140278815b521f1568c52d0a9fea11">boost::locale::ios_info::time_zone</a> </td>
<td>(</td>
<td class="paramtype">std::string const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set time zone for formatting dates and time </p>
</div>
</div>
<a class="anchor" id="a0325f6eca8b939609614fe98e4e9ab42"></a><!-- doxytag: member="boost::locale::ios_info::time_zone" ref="a0325f6eca8b939609614fe98e4e9ab42" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classboost_1_1locale_1_1ios__info.html#a3f140278815b521f1568c52d0a9fea11">boost::locale::ios_info::time_zone</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get time zone for formatting dates and time </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>boost/locale/<a class="el" href="formatting_8hpp_source.html">formatting.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_1ios__info.html">ios_info</a> </li>
<li class="footer">
&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.
</li>
</ul>
</div>
</body>
</html>