diff options
Diffstat (limited to 'doc/html/boost/program_options/untyped_value.html')
-rw-r--r-- | doc/html/boost/program_options/untyped_value.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/html/boost/program_options/untyped_value.html b/doc/html/boost/program_options/untyped_value.html index 0c4926b095..e0c8199de4 100644 --- a/doc/html/boost/program_options/untyped_value.html +++ b/doc/html/boost/program_options/untyped_value.html @@ -4,10 +4,10 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class untyped_value</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semanti_idp200393456.html" title="Class value_semantic_codecvt_helper<wchar_t>"> +<link rel="prev" href="value_se_idm46563246447792.html" title="Class value_semantic_codecvt_helper<wchar_t>"> <link rel="next" href="typed_value_base.html" title="Class typed_value_base"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp200393456.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_se_idm46563246447792.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.untyped_value"></a><div class="titlepage"></div> @@ -38,69 +38,69 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="untyped_value.html#boost.program_options.untyped_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="untyped_value.html#idp9324064-bb"><span class="identifier">untyped_value</span></a><span class="special">(</span><span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="untyped_value.html#idm46563246415104-bb"><span class="identifier">untyped_value</span></a><span class="special">(</span><span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="untyped_value.html#idp63059984-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="untyped_value.html#idp63060432-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp5530912-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp193839152-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp87941952-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp133422208-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp70340480-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp38142768-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp72430944-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp87383904-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="untyped_value.html#idm46563246435568-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="untyped_value.html#idm46563246435008-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idm46563246433120-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idm46563246431232-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idm46563246429344-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idm46563246427440-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idm46563246425488-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idm46563246423632-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idm46563246420256-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idm46563246417760-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <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="idp312583872"></a><h2>Description</h2> +<a name="idm45927866838416"></a><h2>Description</h2> <p>Class which specifies a simple handling of a value: the value will have string type and only one token is allowed. </p> <div class="refsect2"> -<a name="idp312584672"></a><h3> +<a name="idm45927866837616"></a><h3> <a name="boost.program_options.untyped_valueconstruct-copy-destruct"></a><code class="computeroutput">untyped_value</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp9324064-bb"></a><span class="identifier">untyped_value</span><span class="special">(</span><span class="keyword">bool</span> zero_tokens <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm46563246415104-bb"></a><span class="identifier">untyped_value</span><span class="special">(</span><span class="keyword">bool</span> zero_tokens <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp312592592"></a><h3> -<a name="idp63059984-bb"></a><code class="computeroutput">untyped_value</code> public member functions</h3> +<a name="idm45927866829632"></a><h3> +<a name="idm46563246435568-bb"></a><code class="computeroutput">untyped_value</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp63060432-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46563246435008-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the name of the option. The name is only meaningful for automatic help message. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp5530912-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idm46563246433120-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>The minimum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp193839152-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idm46563246431232-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>The maximum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp87941952-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm46563246429344-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if the option should only take adjacent token, not one from further command-line arguments. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp133422208-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm46563246427440-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp70340480-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm46563246425488-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if value must be given. Non-optional value </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp38142768-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> +<a name="idm46563246423632-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>If 'value_store' is already initialized, or new_tokens has more than one elements, throws. Otherwise, assigns the first string from 'new_tokens' to 'value_store', without any modifications. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp72430944-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm46563246420256-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Does nothing. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp87383904-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46563246417760-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Does nothing. </p> </li> </ol></div> @@ -117,7 +117,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp200393456.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_se_idm46563246447792.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |