![]() |
Home | Libraries | People | FAQ | More |
boost::program_options::options_description
// In header: <boost/program_options/options_description.hpp> class options_description { public: // construct/copy/destruct ( = , = ); (, = , = ); // public member functions (option_description >); options_description & (options_description &); () ; options_description_easy_init (); option_description & (, , = , = ) ; option_description * (, , = , = ) ; option_description > > & () ; (, = ) ; // friend functions (, options_description &); // public data members static m_default_line_length; };
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.
See here for option adding interface discussion.
See Also:
options_description
public
construct/copy/destruct( line_length = , min_description_length = );
Creates the instance.
( caption, line_length = , min_description_length = );
Creates the instance. The 'caption' parameter gives the name of this 'options_description
' 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.
options_description
public member functions(option_description > desc);
Adds new variable description. Throws duplicate_variable_error if either short or long name matches that of already present one.
options_description & (options_description & desc);
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.
() ;
Find the maximum width of the option column, including options in groups.
options_description_easy_init ();
Returns an object of implementation-defined type suitable for adding options to options_description
. The returned object will have overloaded operator() with parameter type matching 'option_description
' constructors. Calling the operator will create new option_description
instance and add it.
option_description & ( name, approx, long_ignore_case = , short_ignore_case = ) ;
option_description * ( name, approx, long_ignore_case = , short_ignore_case = ) ;
option_description > > & () ;
( os, width = ) ;
Outputs 'desc' to the specified stream, calling 'f' to output each option_description
element.
options_description
friend functions( os, options_description & desc);
Produces a human readable output of 'desc', listing options, their descriptions and allowed parameters. Other options_description
instances previously passed to add will be output separately.