doc/html/boost/date_time/all_date_names_put.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Class template all_date_names_put</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <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;">
  10 <link rel="prev" href="date_names_put.html" title="Class template date_names_put">
  11 <link rel="next" href="convert_to_lower.html" title="Function convert_to_lower">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.date_time.all_date_names_put"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template all_date_names_put</span></h2>
  30 <p>boost::date_time::all_date_names_put &#8212; A date name output facet that takes an array of char* to define strings. </p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <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;
  34
  35 </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>
  36          <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>
  37 <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>
  38   <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>
  39 <span class="special">{</span>
  40 <span class="keyword">public</span><span class="special">:</span>
  41   <span class="comment">// types</span>
  42   <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>
  43   <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>
  44   <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>
  45   <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>
  46
  47   <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>
  48   <a class="link" href="all_date_names_put.html#idp495982624-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>
  49                      <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>
  50                      <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>
  51                      <span class="identifier">ymd_order_spec</span> <span class="special">=</span> <span class="identifier">ymd_order_iso</span><span class="special">,</span>
  52                      <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>
  53
  54   <span class="comment">// <a class="link" href="all_date_names_put.html#idp495976304-bb">public member functions</a></span>
  55   <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#idp495976864-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>
  56   <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#idp495977984-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>
  57   <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#idp495979104-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>
  58   <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#idp495980224-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>
  59   <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#idp495981344-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>
  60
  61   <span class="comment">// <a class="link" href="all_date_names_put.html#idp495989280-bb">protected member functions</a></span>
  62   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="all_date_names_put.html#idp495989856-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>
  63   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="all_date_names_put.html#idp495992944-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>
  64   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="all_date_names_put.html#idp495996000-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>
  65   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="all_date_names_put.html#idp495999056-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>
  66   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="all_date_names_put.html#idp496001824-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>
  67   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="all_date_names_put.html#idp496004592-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>
  68   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="all_date_names_put.html#idp496006976-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>
  69   <span class="keyword">virtual</span> <span class="identifier">ymd_order_spec</span> <a class="link" href="all_date_names_put.html#idp496009360-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>
  70   <span class="keyword">virtual</span> <span class="identifier">month_format_spec</span> <a class="link" href="all_date_names_put.html#idp496011040-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>
  71 <span class="special">}</span><span class="special">;</span></pre></div>
  72 <div class="refsect1">
  73 <a name="idp221665792"></a><h2>Description</h2>
  74 <div class="refsect2">
  75 <a name="idp221666208"></a><h3>
  76 <a name="boost.date_time.all_date_names_putconstruct-copy-destruct"></a><code class="computeroutput">all_date_names_put</code>
  77         public
  78        construct/copy/destruct</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp495982624-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>
  80                    <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>
  81                    <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>
  82                    <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>
  83                    <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>
  84                    <span class="identifier">charT</span> separator_char <span class="special">=</span> <span class="char">'-'</span><span class="special">,</span>
  85                    <span class="identifier">ymd_order_spec</span> order_spec <span class="special">=</span> <span class="identifier">ymd_order_iso</span><span class="special">,</span>
  86                    <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>
  87 </div>
  88 <div class="refsect2">
  89 <a name="idp221695744"></a><h3>
  90 <a name="idp495976304-bb"></a><code class="computeroutput">all_date_names_put</code> public member functions</h3>
  91 <div class="orderedlist"><ol class="orderedlist" type="1">
  92 <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="idp495976864-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>
  93 <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="idp495977984-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>
  94 <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="idp495979104-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>
  95 <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="idp495980224-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>
  96 <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="idp495981344-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>
  97 </ol></div>
  98 </div>
  99 <div class="refsect2">
 100 <a name="idp221735808"></a><h3>
 101 <a name="idp495989280-bb"></a><code class="computeroutput">all_date_names_put</code> protected member functions</h3>
 102 <div class="orderedlist"><ol class="orderedlist" type="1">
 103 <li class="listitem">
 104 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp495989856-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>
 105 <li class="listitem">
 106 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp495992944-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>
 107 <li class="listitem">
 108 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span>
 109 <a name="idp495996000-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>
 110 <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp495999056-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>
 111 <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp496001824-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>
 112 <li class="listitem">
 113 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp496004592-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>
 114 <li class="listitem">
 115 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp496006976-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>
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">ymd_order_spec</span> <a name="idp496009360-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>
 118 <li class="listitem">
 119 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">month_format_spec</span> <a name="idp496011040-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>
 120 </ol></div>
 121 </div>
 122 </div>
 123 </div>
 124 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 125 <td align="left"></td>
 126 <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
 127     <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>
 128 </div></td>
 129 </tr></table>
 130 <hr>
 131 <div class="spirit-nav">
 132 <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>
 133 </div>
 134 </body>
 135 </html>