blob: 376ff3567fe192b03c21e1fb0b5158a60291bfd7 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template all_date_names_put</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../date_time/doxy.html#header.boost.date_time.date_names_put_hpp" title="Header &lt;boost/date_time/date_names_put.hpp&gt;">
<link rel="prev" href="date_names_put.html" title="Class template date_names_put">
<link rel="next" href="convert_to_lower.html" title="Function convert_to_lower">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="date_names_put.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_names_put_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="convert_to_lower.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.date_time.all_date_names_put"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template all_date_names_put</span></h2>
<p>boost::date_time::all_date_names_put &#8212; A date name output facet that takes an array of char* to define strings. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.date_names_put_hpp" title="Header &lt;boost/date_time/date_names_put.hpp&gt;">boost/date_time/date_names_put.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Config<span class="special">,</span> <span class="keyword">typename</span> charT <span class="special">=</span> <span class="keyword">char</span><span class="special">,</span>
<span class="keyword">typename</span> <a class="link" href="../../OutputIterator.html" title="Concept OutputIterator">OutputIterator</a> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostreambuf_iterator</span><span class="special">&lt;</span><span class="identifier">charT</span><span class="special">&gt;</span> <span class="special">&gt;</span>
<span class="keyword">class</span> <a class="link" href="all_date_names_put.html" title="Class template all_date_names_put">all_date_names_put</a> <span class="special">:</span>
<span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">date_names_put</span><span class="special">&lt;</span> <span class="identifier">Config</span><span class="special">,</span> <span class="identifier">charT</span><span class="special">,</span> <span class="identifier">OutputIterator</span> <span class="special">&gt;</span>
<span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">OutputIterator</span> <a name="boost.date_time.all_date_names_put.iter_type"></a><span class="identifier">iter_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Config</span><span class="special">::</span><span class="identifier">month_enum</span> <a name="boost.date_time.all_date_names_put.month_enum"></a><span class="identifier">month_enum</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Config</span><span class="special">::</span><span class="identifier">weekday_enum</span> <a name="boost.date_time.all_date_names_put.weekday_enum"></a><span class="identifier">weekday_enum</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Config</span><span class="special">::</span><span class="identifier">special_value_enum</span> <a name="boost.date_time.all_date_names_put.special_value_enum"></a><span class="identifier">special_value_enum</span><span class="special">;</span>
<span class="comment">// <a class="link" href="all_date_names_put.html#boost.date_time.all_date_names_putconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="all_date_names_put.html#id590722-bb"><span class="identifier">all_date_names_put</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">,</span> <span class="identifier">charT</span> <span class="special">=</span> <span class="char">'-'</span><span class="special">,</span>
<span class="identifier">ymd_order_spec</span> <span class="special">=</span> <span class="identifier">ymd_order_iso</span><span class="special">,</span>
<span class="identifier">month_format_spec</span> <span class="special">=</span> <span class="identifier">month_as_short_string</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="all_date_names_put.html#id590678-bb">public member functions</a></span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a class="link" href="all_date_names_put.html#id590681-bb"><span class="identifier">get_short_month_names</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a class="link" href="all_date_names_put.html#id590689-bb"><span class="identifier">get_long_month_names</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a class="link" href="all_date_names_put.html#id590698-bb"><span class="identifier">get_special_value_names</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a class="link" href="all_date_names_put.html#id590706-bb"><span class="identifier">get_short_weekday_names</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a class="link" href="all_date_names_put.html#id590714-bb"><span class="identifier">get_long_weekday_names</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="comment">// <a class="link" href="all_date_names_put.html#id375283-bb">protected member functions</a></span>
<span class="keyword">void</span> <a class="link" href="all_date_names_put.html#id350192-bb"><span class="identifier">do_put_month_short</span></a><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">month_enum</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="all_date_names_put.html#id322590-bb"><span class="identifier">do_put_month_long</span></a><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">month_enum</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="all_date_names_put.html#id322612-bb"><span class="identifier">do_put_special_value</span></a><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">special_value_enum</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="all_date_names_put.html#id322634-bb"><span class="identifier">do_put_weekday_short</span></a><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">weekday_enum</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="all_date_names_put.html#id375113-bb"><span class="identifier">do_put_weekday_long</span></a><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">weekday_enum</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="all_date_names_put.html#id341798-bb"><span class="identifier">do_month_sep_char</span></a><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="all_date_names_put.html#id341813-bb"><span class="identifier">do_day_sep_char</span></a><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">ymd_order_spec</span> <a class="link" href="all_date_names_put.html#id412105-bb"><span class="identifier">do_date_order</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">month_format_spec</span> <a class="link" href="all_date_names_put.html#id404959-bb"><span class="identifier">do_month_format</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1115120"></a><h2>Description</h2>
<div class="refsect2">
<a name="id1115123"></a><h3>
<a name="boost.date_time.all_date_names_putconstruct-copy-destruct"></a><code class="computeroutput">all_date_names_put</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id590722-bb"></a><span class="identifier">all_date_names_put</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> month_short_names<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> month_long_names<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> special_value_names<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> weekday_short_names<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> weekday_long_names<span class="special">,</span>
<span class="identifier">charT</span> separator_char <span class="special">=</span> <span class="char">'-'</span><span class="special">,</span>
<span class="identifier">ymd_order_spec</span> order_spec <span class="special">=</span> <span class="identifier">ymd_order_iso</span><span class="special">,</span>
<span class="identifier">month_format_spec</span> month_format <span class="special">=</span> <span class="identifier">month_as_short_string</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
</div>
<div class="refsect2">
<a name="id1115366"></a><h3>
<a name="id590678-bb"></a><code class="computeroutput">all_date_names_put</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a name="id590681-bb"></a><span class="identifier">get_short_month_names</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a name="id590689-bb"></a><span class="identifier">get_long_month_names</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a name="id590698-bb"></a><span class="identifier">get_special_value_names</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a name="id590706-bb"></a><span class="identifier">get_short_weekday_names</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> <a name="id590714-bb"></a><span class="identifier">get_long_weekday_names</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1115692"></a><h3>
<a name="id375283-bb"></a><code class="computeroutput">all_date_names_put</code> protected member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id350192-bb"></a><span class="identifier">do_put_month_short</span><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span> oitr<span class="special">,</span> <span class="identifier">month_enum</span> moy<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Generic facet that takes array of chars. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id322590-bb"></a><span class="identifier">do_put_month_long</span><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span> oitr<span class="special">,</span> <span class="identifier">month_enum</span> moy<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Long month names. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id322612-bb"></a><span class="identifier">do_put_special_value</span><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span> oitr<span class="special">,</span> <span class="identifier">special_value_enum</span> sv<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Special values names. </li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id322634-bb"></a><span class="identifier">do_put_weekday_short</span><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span> oitr<span class="special">,</span> <span class="identifier">weekday_enum</span> wd<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id375113-bb"></a><span class="identifier">do_put_weekday_long</span><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span> oitr<span class="special">,</span> <span class="identifier">weekday_enum</span> wd<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id341798-bb"></a><span class="identifier">do_month_sep_char</span><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>char between year-month </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id341813-bb"></a><span class="identifier">do_day_sep_char</span><span class="special">(</span><span class="identifier">iter_type</span> <span class="special">&amp;</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Char to separate month-day. </li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">ymd_order_spec</span> <a name="id412105-bb"></a><span class="identifier">do_date_order</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Set the date ordering. </li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">month_format_spec</span> <a name="id404959-bb"></a><span class="identifier">do_month_format</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Set the date ordering. </li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file
<code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="date_names_put.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_names_put_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="convert_to_lower.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>