doc/html/boost/program_options/options_description.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class options_description</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header &lt;boost/program_options/options_description.hpp&gt;">
   9 <link rel="prev" href="options_descr_idp209859984.html" title="Class options_description_easy_init">
  10 <link rel="next" href="duplicate_option_error.html" title="Class duplicate_option_error">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="options_descr_idp209859984.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.program_options.options_description"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class options_description</span></h2>
  29 <p>boost::program_options::options_description</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="comment">// In header: &lt;<a class="link" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header &lt;boost/program_options/options_description.hpp&gt;">boost/program_options/options_description.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="options_description.html#boost.program_options.options_descriptionconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="options_description.html#idp226403792-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span>
  39                       <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="options_description.html#idp228543152-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span>
  41                       <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="options_description.html#idp214926352-bb">public member functions</a></span>
  44   <span class="keyword">void</span> <a class="link" href="options_description.html#idp214926912-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&gt;</span><span class="special">)</span><span class="special">;</span>
  45   <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span> <a class="link" href="options_description.html#idp155903952-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <span class="keyword">unsigned</span> <a class="link" href="options_description.html#idp38645552-bb"><span class="identifier">get_option_column_width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <a class="link" href="options_descr_idp209859984.html" title="Class options_description_easy_init">options_description_easy_init</a> <a class="link" href="options_description.html#idp204157040-bb"><span class="identifier">add_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48   <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&amp;</span>
  49   <a class="link" href="options_description.html#idp112501712-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50   <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span>
  51   <a class="link" href="options_description.html#idp228719792-bb"><span class="identifier">find_nothrow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  52   <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">shared_ptr</span><span class="special">&lt;</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&gt;</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <a class="link" href="options_description.html#idp156068000-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="keyword">void</span> <a class="link" href="options_description.html#idp225056704-bb"><span class="identifier">print</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54
  55   <span class="comment">// <a class="link" href="options_description.html#idp222322688-bb">friend functions</a></span>
  56   <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span>
  57   <a class="link" href="options_description.html#idp222323248-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58
  59   <span class="comment">// public data members</span>
  60   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="identifier">m_default_line_length</span><span class="special">;</span>
  61 <span class="special">}</span><span class="special">;</span></pre></div>
  62 <div class="refsect1">
  63 <a name="idp345447552"></a><h2>Description</h2>
  64 <p>A set of option descriptions. This provides convenient interface for adding new option (the add_options) method, and facilities to search for options by name.</p>
  65 <p>See here for option adding interface discussion. </p>
  66 <p><span class="bold"><strong>See Also:</strong></span></p>
  67 <p><a class="link" href="option_description.html" title="Class option_description">option_description</a> </p>
  68 <p>
  69 </p>
  70 <div class="refsect2">
  71 <a name="idp345450528"></a><h3>
  72 <a name="boost.program_options.options_descriptionconstruct-copy-destruct"></a><code class="computeroutput">options_description</code>
  73         public
  74        construct/copy/destruct</h3>
  75 <div class="orderedlist"><ol class="orderedlist" type="1">
  76 <li class="listitem">
  77 <pre class="literallayout"><a name="idp226403792-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span>
  78                     <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre>
  79 <p>Creates the instance. </p>
  80 </li>
  81 <li class="listitem">
  82 <pre class="literallayout"><a name="idp228543152-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> caption<span class="special">,</span>
  83                     <span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span>
  84                     <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre>
  85 <p>Creates the instance. The 'caption' parameter gives the name of this '<code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>' instance. Primarily useful for output. The 'description_length' specifies the number of columns that should be reserved for the description text; if the option text encroaches into this, then the description will start on the next line. </p>
  86 </li>
  87 </ol></div>
  88 </div>
  89 <div class="refsect2">
  90 <a name="idp345477280"></a><h3>
  91 <a name="idp214926352-bb"></a><code class="computeroutput">options_description</code> public member functions</h3>
  92 <div class="orderedlist"><ol class="orderedlist" type="1">
  93 <li class="listitem">
  94 <pre class="literallayout"><span class="keyword">void</span> <a name="idp214926912-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&gt;</span> desc<span class="special">)</span><span class="special">;</span></pre>
  95 <p>Adds new variable description. Throws duplicate_variable_error if either short or long name matches that of already present one. </p>
  96 </li>
  97 <li class="listitem">
  98 <pre class="literallayout"><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span> <a name="idp155903952-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span> desc<span class="special">)</span><span class="special">;</span></pre>
  99 <p>Adds a group of option description. This has the same effect as adding all option_descriptions in 'desc' individually, except that output operator will show a separate group. Returns *this. </p>
 100 </li>
 101 <li class="listitem">
 102 <pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp38645552-bb"></a><span class="identifier">get_option_column_width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 103 <p>Find the maximum width of the option column, including options in groups. </p>
 104 </li>
 105 <li class="listitem">
 106 <pre class="literallayout"><a class="link" href="options_descr_idp209859984.html" title="Class options_description_easy_init">options_description_easy_init</a> <a name="idp204157040-bb"></a><span class="identifier">add_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 107 <p>Returns an object of implementation-defined type suitable for adding options to <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>. The returned object will have overloaded operator() with parameter type matching '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructors. Calling the operator will create new <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> instance and add it. </p>
 108 </li>
 109 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&amp;</span>
 110 <a name="idp112501712-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span>
 111      <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 112 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span>
 113 <a name="idp228719792-bb"></a><span class="identifier">find_nothrow</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span>
 114              <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 115 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">shared_ptr</span><span class="special">&lt;</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&gt;</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <a name="idp156068000-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">void</span> <a name="idp225056704-bb"></a><span class="identifier">print</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> os<span class="special">,</span> <span class="keyword">unsigned</span> width <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 118 <p>Outputs 'desc' to the specified stream, calling 'f' to output each <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> element. </p>
 119 </li>
 120 </ol></div>
 121 </div>
 122 <div class="refsect2">
 123 <a name="idp345564432"></a><h3>
 124 <a name="idp222322688-bb"></a><code class="computeroutput">options_description</code> friend functions</h3>
 125 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 126 <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span>
 127 <a name="idp222323248-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span> os<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&amp;</span> desc<span class="special">)</span><span class="special">;</span></pre>
 128 <p>Produces a human readable output of 'desc', listing options, their descriptions and allowed parameters. Other <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code> instances previously passed to add will be output separately. </p>
 129 </li></ol></div>
 130 </div>
 131 </div>
 132 </div>
 133 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 134 <td align="left"></td>
 135 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
 136       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
 137       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 138       </p>
 139 </div></td>
 140 </tr></table>
 141 <hr>
 142 <div class="spirit-nav">
 143 <a accesskey="p" href="options_descr_idp209859984.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 144 </div>
 145 </body>
 146 </html>