<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CommandOptionWithArg class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Thu Oct 4 15:32:59 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>CommandOptionWithArg Class Reference</h1>Derived class of <a class="el" href="class_commandoption.html">CommandOption</a> for options that have a value associated with them.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cmdoptns_h-source.html">cmdoptns.h</a>></code>
<p>
<p>Inheritance diagram for CommandOptionWithArg:
<p><center><img src="class_commandoptionwitharg.gif" usemap="#CommandOptionWithArg_map" border="0"></center>
<map name="CommandOptionWithArg_map">
<area href="class_commandoption.html" alt="CommandOption" shape="rect" coords="159,0,308,24">
<area href="class_commandoptionarg.html" alt="CommandOptionArg" shape="rect" coords="0,112,149,136">
<area href="class_commandoptioncollect.html" alt="CommandOptionCollect" shape="rect" coords="159,112,308,136">
<area href="class_commandoptionrest.html" alt="CommandOptionRest" shape="rect" coords="318,112,467,136">
</map>
<a href="class_commandoptionwitharg-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html#a0">CommandOptionWithArg</a> (const char *in_option_name, const char *in_option_letter, const char *in_description, <a class="el" href="class_commandoption.html#s4">OptionType</a> in_option_type, <a class="el" href="config_h.html#a17">bool</a> in_required=false, <a class="el" href="class_commandoption.html">CommandOption</a> **pp_next=&<a class="el" href="cmdoptns_h.html#a0">DefaultCommandOptionList</a>)</td></tr>
<tr><td> </td><td><font size=-1><em>CommandOptionWithArg contructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html#a1">~CommandOptionWithArg</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html#a2">FoundOption</a> (<a class="el" href="class_commandoptionparse.html">CommandOptionParse</a> *cop, const char *value=0)</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html#a3">FoundOption</a> (<a class="el" href="class_commandoptionparse.html">CommandOptionParse</a> *cop, const char **value, int num)</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="config_h.html#a17">bool</a> </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html#a4">HasValue</a> ()</td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>const char** </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html#m0">values</a></td></tr>
<tr><td> </td><td><font size=-1><em>Array of list of values collected for this option.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_commandoptionwitharg.html#m1">numvalue</a></td></tr>
<tr><td> </td><td><font size=-1><em><a class="el" href="class_number.html">Number</a> of values in the values array.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Derived class of <a class="el" href="class_commandoption.html">CommandOption</a> for options that have a value associated with them.
<p>
Classes <a class="el" href="class_commandoptionrest.html">CommandOptionRest</a> and <a class="el" href="class_commandoptionarg.html">CommandOptionArg</a> derive from this class.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="CommandOptionWithArg::CommandOptionWithArg"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
CommandOptionWithArg::CommandOptionWithArg (
</b></td>
<td valign="bottom"><b>
const char * <em>in_option_name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>in_option_letter</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>in_description</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="class_commandoption.html#s4">OptionType</a> <em>in_option_type</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="config_h.html#a17">bool</a> <em>in_required</em> = false,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="class_commandoption.html">CommandOption</a> ** <em>pp_next</em> = & <a class="el" href="cmdoptns_h.html#a0">DefaultCommandOptionList</a> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
CommandOptionWithArg contructor.
<p>
Note the default values for required and pp_next.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>in_option_name</em>
</td><td>
long option name </td></tr>
<tr><td valign=top><em>in_option_letter</em>
</td><td>
short letter name </td></tr>
<tr><td valign=top><em>in_description</em>
</td><td>
short description of the option </td></tr>
<tr><td valign=top><em>in_option_type</em>
</td><td>
the type of this option </td></tr>
<tr><td valign=top><em>in_required</em>
</td><td>
true if option is required </td></tr>
<tr><td valign=top><em>pp_next</em>
</td><td>
the linked list header </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="CommandOptionWithArg::~CommandOptionWithArg"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
virtual CommandOptionWithArg::~CommandOptionWithArg (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="CommandOptionWithArg::FoundOption"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
virtual void CommandOptionWithArg::FoundOption (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_commandoptionparse.html">CommandOptionParse</a> * <em>cop</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char ** <em>value</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>num</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="class_commandoption.html#a3">CommandOption</a>. </td>
</tr>
</table>
<a name="a2" doxytag="CommandOptionWithArg::FoundOption"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
virtual void CommandOptionWithArg::FoundOption (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_commandoptionparse.html">CommandOptionParse</a> * <em>cop</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>value</em> = 0 )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="class_commandoption.html#a2">CommandOption</a>. </td>
</tr>
</table>
<a name="a4" doxytag="CommandOptionWithArg::HasValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
virtual <a class="el" href="config_h.html#a17">bool</a> CommandOptionWithArg::HasValue (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="class_commandoption.html#a6">CommandOption</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m1" doxytag="CommandOptionWithArg::numvalue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int CommandOptionWithArg::numvalue
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="class_number.html">Number</a> of values in the values array.
<p>
</td>
</tr>
</table>
<a name="m0" doxytag="CommandOptionWithArg::values"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char ** CommandOptionWithArg::values
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Array of list of values collected for this option.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cmdoptns_h-source.html">cmdoptns.h</a></ul>
<hr><address><small>Generated at Thu Oct 4 15:32:59 2001 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
123
