Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/date_input_facet.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 17 years ago

added boost
File size: 23.5 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class template date_input_facet</title>
5<link rel="stylesheet" href="boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7<link rel="start" href="index.html" title="The Boost C++ Libraries">
8<link rel="up" href="date_time/doxy.html#id2466656" title="Header &lt;boost/date_time/date_facet.hpp&gt;">
9<link rel="prev" href="date_facet.html" title="Class template date_facet">
10<link rel="next" href="simple_format.html" title="Class template simple_format">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
15<td align="center"><a href="../../index.htm">Home</a></td>
16<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../people/people.htm">People</a></td>
18<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="date_facet.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2466656"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="simple_format.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="date_input_facet"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template date_input_facet</span></h2>
29<p>boost::date_time::date_input_facet &#8212; Input facet. </p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> date_type, <span class="bold"><strong>typename</strong></span> CharT,
33         <span class="bold"><strong>typename</strong></span> InItrT = std::istreambuf_iterator&lt;CharT, std::char_traits&lt;CharT&gt; &gt; &gt; 
34<span class="bold"><strong>class</strong></span> date_input_facet {
35<span class="bold"><strong>public</strong></span>:
36  <span class="emphasis"><em>// types</em></span>
37  <span class="bold"><strong>typedef</strong></span> date_type::duration_type                             duration_type;             
38  <span class="bold"><strong>typedef</strong></span> date_type::day_of_week_type                          day_of_week_type;          
39  <span class="bold"><strong>typedef</strong></span> date_type::day_type                                  day_type;                  
40  <span class="bold"><strong>typedef</strong></span> date_type::month_type                                month_type;                
41  <span class="bold"><strong>typedef</strong></span> date_type::year_type                                 year_type;                 
42  <span class="bold"><strong>typedef</strong></span> <a href="period.html" title="Class template period">boost::date_time::period</a>&lt; date_type, duration_type &gt; period_type;               
43  <span class="bold"><strong>typedef</strong></span> std::basic_string&lt; CharT &gt;                           string_type;               
44  <span class="bold"><strong>typedef</strong></span> CharT                                                char_type;                 
45  <span class="bold"><strong>typedef</strong></span> <a href="period_parser.html" title="Class template period_parser">boost::date_time::period_parser</a>&lt; date_type, CharT &gt;  period_parser_type;        
46  <span class="bold"><strong>typedef</strong></span> <a href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</a>&lt; date_type, CharT &gt;            special_values_parser_type;
47  <span class="bold"><strong>typedef</strong></span> std::vector&lt; std::basic_string&lt; CharT &gt; &gt;            input_collection_type;     
48  <span class="bold"><strong>typedef</strong></span> <a href="format_date_parser.html" title="Class template format_date_parser">format_date_parser</a>&lt; date_type, CharT &gt;               format_date_parser_type;   
49  <span class="bold"><strong>typedef</strong></span> <a href="date_generator_parser.html" title="Class template date_generator_parser">date_generator_parser</a>&lt; date_type, CharT &gt;            date_gen_parser_type;      
50  <span class="bold"><strong>typedef</strong></span> <a href="partial_date.html" title="Class template partial_date">partial_date</a>&lt; date_type &gt;                            partial_date_type;         
51  <span class="bold"><strong>typedef</strong></span> <a href="nth_kday_of_month.html" title="Class template nth_kday_of_month">nth_kday_of_month</a>&lt; date_type &gt;                       nth_kday_type;             
52  <span class="bold"><strong>typedef</strong></span> <a href="first_kday_of_month.html" title="Class template first_kday_of_month">first_kday_of_month</a>&lt; date_type &gt;                     first_kday_type;           
53  <span class="bold"><strong>typedef</strong></span> <a href="last_kday_of_month.html" title="Class template last_kday_of_month">last_kday_of_month</a>&lt; date_type &gt;                      last_kday_type;            
54  <span class="bold"><strong>typedef</strong></span> <a href="first_kday_after.html" title="Class template first_kday_after">first_kday_after</a>&lt; date_type &gt;                        kday_after_type;           
55  <span class="bold"><strong>typedef</strong></span> <a href="first_kday_before.html" title="Class template first_kday_before">first_kday_before</a>&lt; date_type &gt;                       kday_before_type;          
56
57  <span class="emphasis"><em>// <a href="date_input_facet.html#date_input_facetconstruct-copy-destruct">construct/copy/destruct</a></em></span>
58  <a href="date_input_facet.html#id2442615-bb">date_input_facet</a>(::size_t = 0);
59  <a href="date_input_facet.html#id2502308-bb">date_input_facet</a>(<span class="bold"><strong>const</strong></span> string_type &amp;, ::size_t = 0);
60  <a href="date_input_facet.html#id2520020-bb">date_input_facet</a>(<span class="bold"><strong>const</strong></span> string_type &amp;, <span class="bold"><strong>const</strong></span> format_date_parser_type &amp;,
61                   <span class="bold"><strong>const</strong></span> special_values_parser_type &amp;,
62                   <span class="bold"><strong>const</strong></span> period_parser_type &amp;, <span class="bold"><strong>const</strong></span> date_gen_parser_type &amp;,
63                   ::size_t = 0);
64
65  <span class="emphasis"><em>// <a href="date_input_facet.html#id2494977-bb">public member functions</a></em></span>
66  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2494982-bb">format</a>(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span>) ;
67  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2497791-bb">set_iso_format</a>() ;
68  <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2405430-bb">set_iso_extended_format</a>() ;
69  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2509543-bb">month_format</a>(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span>) ;
70  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2454091-bb">weekday_format</a>(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span>) ;
71  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2513198-bb">year_format</a>(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span>) ;
72  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2446312-bb">period_parser</a>(period_parser_type) ;
73  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2522194-bb">short_weekday_names</a>(<span class="bold"><strong>const</strong></span> input_collection_type &amp;) ;
74  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2342258-bb">long_weekday_names</a>(<span class="bold"><strong>const</strong></span> input_collection_type &amp;) ;
75  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2523048-bb">short_month_names</a>(<span class="bold"><strong>const</strong></span> input_collection_type &amp;) ;
76  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2508142-bb">long_month_names</a>(<span class="bold"><strong>const</strong></span> input_collection_type &amp;) ;
77  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2498103-bb">date_gen_element_strings</a>(<span class="bold"><strong>const</strong></span> input_collection_type &amp;) ;
78  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2512455-bb">date_gen_element_strings</a>(<span class="bold"><strong>const</strong></span> string_type &amp;, <span class="bold"><strong>const</strong></span> string_type &amp;,
79                                <span class="bold"><strong>const</strong></span> string_type &amp;, <span class="bold"><strong>const</strong></span> string_type &amp;,
80                                <span class="bold"><strong>const</strong></span> string_type &amp;, <span class="bold"><strong>const</strong></span> string_type &amp;,
81                                <span class="bold"><strong>const</strong></span> string_type &amp;, <span class="bold"><strong>const</strong></span> string_type &amp;,
82                                <span class="bold"><strong>const</strong></span> string_type &amp;) ;
83  <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="date_input_facet.html#id2421455-bb">special_values_parser</a>(special_values_parser_type) ;
84  <span class="type">InItrT</span> <a href="date_input_facet.html#id2518104-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, date_type &amp;) <span class="bold"><strong>const</strong></span>;
85  <span class="type">InItrT</span> <a href="date_input_facet.html#id2338300-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, month_type &amp;) <span class="bold"><strong>const</strong></span>;
86  <span class="type">InItrT</span> <a href="date_input_facet.html#id2484346-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, day_of_week_type &amp;) <span class="bold"><strong>const</strong></span>;
87  <span class="type">InItrT</span> <a href="date_input_facet.html#id2422322-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, day_type &amp;) <span class="bold"><strong>const</strong></span>;
88  <span class="type">InItrT</span> <a href="date_input_facet.html#id2428081-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, year_type &amp;) <span class="bold"><strong>const</strong></span>;
89  <span class="type">InItrT</span> <a href="date_input_facet.html#id2509654-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, duration_type &amp;) <span class="bold"><strong>const</strong></span>;
90  <span class="type">InItrT</span> <a href="date_input_facet.html#id2516001-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, period_type &amp;) <span class="bold"><strong>const</strong></span>;
91  <span class="type">InItrT</span> <a href="date_input_facet.html#id2417674-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, nth_kday_type &amp;) <span class="bold"><strong>const</strong></span>;
92  <span class="type">InItrT</span> <a href="date_input_facet.html#id2415474-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, partial_date_type &amp;) <span class="bold"><strong>const</strong></span>;
93  <span class="type">InItrT</span> <a href="date_input_facet.html#id2505189-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, first_kday_type &amp;) <span class="bold"><strong>const</strong></span>;
94  <span class="type">InItrT</span> <a href="date_input_facet.html#id2493625-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, last_kday_type &amp;) <span class="bold"><strong>const</strong></span>;
95  <span class="type">InItrT</span> <a href="date_input_facet.html#id2399020-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, kday_before_type &amp;) <span class="bold"><strong>const</strong></span>;
96  <span class="type">InItrT</span> <a href="date_input_facet.html#id2385991-bb">get</a>(InItrT &amp;, InItrT &amp;, std::ios_base &amp;, kday_after_type &amp;) <span class="bold"><strong>const</strong></span>;
97
98  <span class="bold"><strong>static</strong></span> const char_type long_weekday_format;
99  <span class="bold"><strong>static</strong></span> const char_type short_weekday_format;
100  <span class="bold"><strong>static</strong></span> const char_type long_month_format;
101  <span class="bold"><strong>static</strong></span> const char_type short_month_format;
102  <span class="bold"><strong>static</strong></span> const char_type four_digit_year_format;
103  <span class="bold"><strong>static</strong></span> const char_type two_digit_year_format;
104  <span class="bold"><strong>static</strong></span> const char_type default_period_separator;
105  <span class="bold"><strong>static</strong></span> const char_type standard_format_specifier;
106  <span class="bold"><strong>static</strong></span> const char_type iso_format_specifier;
107  <span class="bold"><strong>static</strong></span> const char_type iso_format_extended_specifier;
108  <span class="bold"><strong>static</strong></span> const char_type default_date_format;
109  <span class="bold"><strong>static</strong></span> std::locale::id id;
110};</pre></div>
111<div class="refsect1" lang="en">
112<a name="id2616853"></a><h2>Description</h2>
113<div class="refsect2" lang="en">
114<a name="id2616856"></a><h3>
115<a name="date_input_facetconstruct-copy-destruct"></a><code class="computeroutput">date_input_facet</code> construct/copy/destruct</h3>
116<div class="orderedlist"><ol type="1">
117<li><pre class="literallayout"><a name="id2442615-bb"></a>date_input_facet(::size_t a_ref = 0);</pre></li>
118<li><pre class="literallayout"><a name="id2502308-bb"></a>date_input_facet(<span class="bold"><strong>const</strong></span> string_type &amp; format, ::size_t a_ref = 0);</pre></li>
119<li><pre class="literallayout"><a name="id2520020-bb"></a>date_input_facet(<span class="bold"><strong>const</strong></span> string_type &amp; format,
120                 <span class="bold"><strong>const</strong></span> format_date_parser_type &amp; date_parser,
121                 <span class="bold"><strong>const</strong></span> special_values_parser_type &amp; sv_parser,
122                 <span class="bold"><strong>const</strong></span> period_parser_type &amp; per_parser,
123                 <span class="bold"><strong>const</strong></span> date_gen_parser_type &amp; date_gen_parser,
124                 ::size_t ref_count = 0);</pre></li>
125</ol></div>
126</div>
127<div class="refsect2" lang="en">
128<a name="id2616970"></a><h3>
129<a name="id2494977-bb"></a><code class="computeroutput">date_input_facet</code> public member functions</h3>
130<div class="orderedlist"><ol type="1">
131<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2494982-bb"></a>format(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> format) ;</pre></li>
132<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id2497791-bb"></a>set_iso_format() ;</pre></li>
133<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>void</strong></span></span> <a name="id2405430-bb"></a>set_iso_extended_format() ;</pre></li>
134<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2509543-bb"></a>month_format(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> format) ;</pre></li>
135<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2454091-bb"></a>weekday_format(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> format) ;</pre></li>
136<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2513198-bb"></a>year_format(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> format) ;</pre></li>
137<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2446312-bb"></a>period_parser(period_parser_type period_parser) ;</pre></li>
138<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2522194-bb"></a>short_weekday_names(<span class="bold"><strong>const</strong></span> input_collection_type &amp; weekday_names) ;</pre></li>
139<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2342258-bb"></a>long_weekday_names(<span class="bold"><strong>const</strong></span> input_collection_type &amp; weekday_names) ;</pre></li>
140<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2523048-bb"></a>short_month_names(<span class="bold"><strong>const</strong></span> input_collection_type &amp; month_names) ;</pre></li>
141<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2508142-bb"></a>long_month_names(<span class="bold"><strong>const</strong></span> input_collection_type &amp; month_names) ;</pre></li>
142<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2498103-bb"></a>date_gen_element_strings(<span class="bold"><strong>const</strong></span> input_collection_type &amp; col) ;</pre></li>
143<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2512455-bb"></a>date_gen_element_strings(<span class="bold"><strong>const</strong></span> string_type &amp; first,
144                              <span class="bold"><strong>const</strong></span> string_type &amp; second,
145                              <span class="bold"><strong>const</strong></span> string_type &amp; third,
146                              <span class="bold"><strong>const</strong></span> string_type &amp; fourth,
147                              <span class="bold"><strong>const</strong></span> string_type &amp; fifth,
148                              <span class="bold"><strong>const</strong></span> string_type &amp; last,
149                              <span class="bold"><strong>const</strong></span> string_type &amp; before,
150                              <span class="bold"><strong>const</strong></span> string_type &amp; after,
151                              <span class="bold"><strong>const</strong></span> string_type &amp; of) ;</pre></li>
152<li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2421455-bb"></a>special_values_parser(special_values_parser_type sv_parser) ;</pre></li>
153<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2518104-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; , date_type &amp; d) <span class="bold"><strong>const</strong></span>;</pre></li>
154<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2338300-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; , month_type &amp; m) <span class="bold"><strong>const</strong></span>;</pre></li>
155<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2484346-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; ,
156           day_of_week_type &amp; wd) <span class="bold"><strong>const</strong></span>;</pre></li>
157<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2422322-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; , day_type &amp; d) <span class="bold"><strong>const</strong></span>;</pre></li>
158<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2428081-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; , year_type &amp; y) <span class="bold"><strong>const</strong></span>;</pre></li>
159<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2509654-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios,
160           duration_type &amp; dd) <span class="bold"><strong>const</strong></span>;</pre></li>
161<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2516001-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios, period_type &amp; p) <span class="bold"><strong>const</strong></span>;</pre></li>
162<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2417674-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios,
163           nth_kday_type &amp; nkd) <span class="bold"><strong>const</strong></span>;</pre></li>
164<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2415474-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios,
165           partial_date_type &amp; pd) <span class="bold"><strong>const</strong></span>;</pre></li>
166<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2505189-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios,
167           first_kday_type &amp; fkd) <span class="bold"><strong>const</strong></span>;</pre></li>
168<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2493625-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios,
169           last_kday_type &amp; lkd) <span class="bold"><strong>const</strong></span>;</pre></li>
170<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2399020-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios,
171           kday_before_type &amp; fkb) <span class="bold"><strong>const</strong></span>;</pre></li>
172<li><pre class="literallayout"><span class="type">InItrT</span> <a name="id2385991-bb"></a>get(InItrT &amp; from, InItrT &amp; to, std::ios_base &amp; a_ios,
173           kday_after_type &amp; fka) <span class="bold"><strong>const</strong></span>;</pre></li>
174</ol></div>
175</div>
176</div>
177</div>
178<table width="100%"><tr>
179<td align="left"></td>
180<td align="right"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
181</tr></table>
182<hr>
183<div class="spirit-nav">
184<a accesskey="p" href="date_facet.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2466656"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="simple_format.html"><img src="images/next.png" alt="Next"></a>
185</div>
186</body>
187</html>
Note: See TracBrowser for help on using the repository browser.