diff options
Diffstat (limited to 'doc/html/boost/date_time/period_formatter.html')
| -rw-r--r-- | doc/html/boost/date_time/period_formatter.html | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/html/boost/date_time/period_formatter.html b/doc/html/boost/date_time/period_formatter.html index b080b9bce4..ccb34dcf02 100644 --- a/doc/html/boost/date_time/period_formatter.html +++ b/doc/html/boost/date_time/period_formatter.html @@ -45,22 +45,22 @@ <span class="keyword">enum</span> <a name="boost.date_time.period_formatter.range_display_options"></a>range_display_options <span class="special">{</span> AS_OPEN_RANGE, AS_CLOSED_RANGE <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="period_formatter.html#boost.date_time.period_formatterconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="period_formatter.html#idp496767456-bb"><span class="identifier">period_formatter</span></a><span class="special">(</span><span class="identifier">range_display_options</span> <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> + <a class="link" href="period_formatter.html#idp515932608-bb"><span class="identifier">period_formatter</span></a><span class="special">(</span><span class="identifier">range_display_options</span> <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_separator</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_start_delimeter</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_open_range_end_delimeter</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="period_formatter.html#idp496742400-bb">public member functions</a></span> - <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp496742960-bb"><span class="identifier">put_period_separator</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp496745120-bb"><span class="identifier">put_period_start_delimeter</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp496747280-bb"><span class="identifier">put_period_end_delimeter</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">range_display_options</span> <a class="link" href="period_formatter.html#idp496749456-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="period_formatter.html#idp496750576-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="identifier">range_display_options</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="period_formatter.html#idp496752688-bb"><span class="identifier">delimiter_strings</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> + <span class="comment">// <a class="link" href="period_formatter.html#idp515907552-bb">public member functions</a></span> + <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp515908112-bb"><span class="identifier">put_period_separator</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp515910272-bb"><span class="identifier">put_period_start_delimeter</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp515912432-bb"><span class="identifier">put_period_end_delimeter</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">range_display_options</span> <a class="link" href="period_formatter.html#idp515914608-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="period_formatter.html#idp515915728-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="identifier">range_display_options</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="period_formatter.html#idp515917840-bb"><span class="identifier">delimiter_strings</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">></span> - <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp496756288-bb"><span class="identifier">put_period</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> + <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#idp515921440-bb"><span class="identifier">put_period</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="comment">// public data members</span> @@ -70,7 +70,7 @@ <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp226569232"></a><h2>Description</h2> +<a name="idp201889776"></a><h2>Description</h2> <p>Provides settings for the following:</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p>period_separator – default '/'</p></li> @@ -89,35 +89,35 @@ </pre> <p> where the date formatting is controlled by the date facet </p> <div class="refsect2"> -<a name="idp226588576"></a><h3> +<a name="idp201909120"></a><h3> <a name="boost.date_time.period_formatterconstruct-copy-destruct"></a><code class="computeroutput">period_formatter</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp496767456-bb"></a><span class="identifier">period_formatter</span><span class="special">(</span><span class="identifier">range_display_options</span> range_option_in <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> +<pre class="literallayout"><a name="idp515932608-bb"></a><span class="identifier">period_formatter</span><span class="special">(</span><span class="identifier">range_display_options</span> range_option_in <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_separator <span class="special">=</span> <span class="identifier">default_period_separator</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_start_delimeter <span class="special">=</span> <span class="identifier">default_period_start_delimeter</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_open_range_end_delimeter <span class="special">=</span> <span class="identifier">default_period_open_range_end_delimeter</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_closed_range_end_delimeter <span class="special">=</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">)</span><span class="special">;</span></pre>Constructor that sets up period formatter options – default should suffice most cases. </li></ol></div> </div> <div class="refsect2"> -<a name="idp226614816"></a><h3> -<a name="idp496742400-bb"></a><code class="computeroutput">period_formatter</code> public member functions</h3> +<a name="idp201935296"></a><h3> +<a name="idp515907552-bb"></a><code class="computeroutput">period_formatter</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">OutItrT</span> <a name="idp496742960-bb"></a><span class="identifier">put_period_separator</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the characters between period elements into stream – default is /. </li> +<pre class="literallayout"><span class="identifier">OutItrT</span> <a name="idp515908112-bb"></a><span class="identifier">put_period_separator</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the characters between period elements into stream – default is /. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">OutItrT</span> <a name="idp496745120-bb"></a><span class="identifier">put_period_start_delimeter</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the period start characters into stream – default is [. </li> +<pre class="literallayout"><span class="identifier">OutItrT</span> <a name="idp515910272-bb"></a><span class="identifier">put_period_start_delimeter</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the period start characters into stream – default is [. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">OutItrT</span> <a name="idp496747280-bb"></a><span class="identifier">put_period_end_delimeter</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the period end characters into stream as controled by open/closed range setting. </li> -<li class="listitem"><pre class="literallayout"><span class="identifier">range_display_options</span> <a name="idp496749456-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<pre class="literallayout"><span class="identifier">OutItrT</span> <a name="idp515912432-bb"></a><span class="identifier">put_period_end_delimeter</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the period end characters into stream as controled by open/closed range setting. </li> +<li class="listitem"><pre class="literallayout"><span class="identifier">range_display_options</span> <a name="idp515914608-bb"></a><span class="identifier">range_option</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">void</span> <a name="idp496750576-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="identifier">range_display_options</span> option<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Reset the range_option control. </li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp496752688-bb"></a><span class="identifier">delimiter_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp515915728-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="identifier">range_display_options</span> option<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Reset the range_option control. </li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp515917840-bb"></a><span class="identifier">delimiter_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">></span> - <span class="identifier">OutItrT</span> <a name="idp496756288-bb"></a><span class="identifier">put_period</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> a_fill<span class="special">,</span> + <span class="identifier">OutItrT</span> <a name="idp515921440-bb"></a><span class="identifier">put_period</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> a_fill<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&</span> p<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&</span> facet<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Generic code to output a period – no matter the period type. <p>This generic code will output any period using a facet to to output the 'elements'. For example, in the case of a date_period the elements will be instances of a date which will be formatted according the to setup in the passed facet parameter.</p> <p>The steps for formatting a period are always the same:</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |