diff options
Diffstat (limited to 'doc/html/boost/program_options/untyped_value.html')
| -rw-r--r-- | doc/html/boost/program_options/untyped_value.html | 52 |
1 files changed, 29 insertions, 23 deletions
diff --git a/doc/html/boost/program_options/untyped_value.html b/doc/html/boost/program_options/untyped_value.html index be0ab4ba6e..1a133b2e1c 100644 --- a/doc/html/boost/program_options/untyped_value.html +++ b/doc/html/boost/program_options/untyped_value.html @@ -1,3 +1,4 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> @@ -37,64 +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#idp88021472-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#idp229457200-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#idp196632960-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#idp196633520-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#idp193645040-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#idp152705472-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#idp87035424-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#idp152248352-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#idp96440576-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#idp144156352-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#idp143046000-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#idp212329248-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#idp212329696-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#idp212331584-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#idp74056048-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#idp111112960-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#idp111114864-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#idp163849840-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#idp163851616-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#idp207682304-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#idp207684800-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="idp340551904"></a><h2>Description</h2> +<a name="idp346847120"></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="idp340552704"></a><h3> +<a name="idp346847920"></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="idp88021472-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="idp229457200-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="idp340560544"></a><h3> -<a name="idp196632960-bb"></a><code class="computeroutput">untyped_value</code> public member functions</h3> +<a name="idp346855696"></a><h3> +<a name="idp212329248-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="idp196633520-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="idp212329696-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="idp193645040-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="idp212331584-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="idp152705472-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="idp74056048-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="idp87035424-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="idp111112960-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="idp111114864-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="idp152248352-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="idp163849840-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="idp96440576-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="idp163851616-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="idp144156352-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="idp207682304-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="idp143046000-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="idp207684800-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> |