Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 68d373e54fb21da3730c08bede406633 > files > 516

libCommonC++1.9_3-devel-1.9.4-2mdk.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ost::CommandOptionWithArg class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ost::CommandOptionWithArg  Class Reference</h1>Derived class of <a class="el" href="classost_1_1_command_option.html">CommandOption</a> for options that have a value associated with them. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="cmdoptns_8h-source.html">cmdoptns.h</a>&gt;</code>
<p>
<p>Inheritance diagram for ost::CommandOptionWithArg::
<p><center><img src="classost_1_1_command_option_with_arg.gif" usemap="#ost::CommandOptionWithArg_map" border="0"></center>
<map name="ost::CommandOptionWithArg_map">
<area href="classost_1_1_command_option.html" alt="ost::CommandOption" shape="rect" coords="181,0,352,24">
<area href="classost_1_1_command_option_arg.html" alt="ost::CommandOptionArg" shape="rect" coords="0,112,171,136">
<area href="classost_1_1_command_option_collect.html" alt="ost::CommandOptionCollect" shape="rect" coords="181,112,352,136">
<area href="classost_1_1_command_option_rest.html" alt="ost::CommandOptionRest" shape="rect" coords="362,112,533,136">
</map>
<a href="classost_1_1_command_option_with_arg-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>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_command_option_with_arg.html#a0">CommandOptionWithArg</a> (const char *in_option_name, const char *in_option_letter, const char *in_description, <a class="el" href="classost_1_1_command_option.html#s4">OptionType</a> in_option_type, bool in_required=false, <a class="el" href="classost_1_1_command_option.html">CommandOption</a> **pp_next=&amp;<a class="el" href="namespaceost.html#a0">DefaultCommandOptionList</a>)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> contructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_command_option_with_arg.html#a1">~CommandOptionWithArg</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_command_option_with_arg.html#a2">FoundOption</a> (<a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> *cop, const char *value=0)</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_command_option_with_arg.html#a3">FoundOption</a> (<a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> *cop, const char **value, int num)</td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_command_option_with_arg.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 **&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_command_option_with_arg.html#m0">values</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Array of list of values collected for this option.</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_command_option_with_arg.html#m1">numvalue</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classost_1_1_number.html">Number</a> of values in the values array.</em> <a href="#m1">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Derived class of <a class="el" href="classost_1_1_command_option.html">CommandOption</a> for options that have a value associated with them.
<p>
Classes <a class="el" href="classost_1_1_command_option_rest.html">CommandOptionRest</a> and <a class="el" href="classost_1_1_command_option_arg.html">CommandOptionArg</a> derive from this class. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ost::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 class="md" nowrap valign="top"> ost::CommandOptionWithArg::CommandOptionWithArg </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const char *</td>
          <td class="mdname">&nbsp; <em>in_option_name</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">const char *</td>
          <td class="mdname">&nbsp; <em>in_option_letter</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">const char *</td>
          <td class="mdname">&nbsp; <em>in_description</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md"><a class="el" href="classost_1_1_command_option.html#s4">OptionType</a></td>
          <td class="mdname">&nbsp; <em>in_option_type</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">bool</td>
          <td class="mdname">&nbsp; <em>in_required</em> = false, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md"><a class="el" href="classost_1_1_command_option.html">CommandOption</a> **</td>
          <td class="mdname">&nbsp; <em>pp_next</em> = &amp; <a class="el" href="namespaceost.html#a0">DefaultCommandOptionList</a></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classost_1_1_command_option_with_arg.html">CommandOptionWithArg</a> 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>&nbsp;</td><td>
long option name </td></tr>
<tr><td valign=top><em>in_option_letter
</em>&nbsp;</td><td>
short letter name </td></tr>
<tr><td valign=top><em>in_description
</em>&nbsp;</td><td>
short description of the option </td></tr>
<tr><td valign=top><em>in_option_type
</em>&nbsp;</td><td>
the type of this option </td></tr>
<tr><td valign=top><em>in_required
</em>&nbsp;</td><td>
true if option is required </td></tr>
<tr><td valign=top><em>pp_next
</em>&nbsp;</td><td>
the linked list header </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a1" doxytag="ost::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 class="md" nowrap valign="top"> virtual ost::CommandOptionWithArg::~CommandOptionWithArg </td>
          <td class="md">(&nbsp;</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="ost::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 class="md" nowrap valign="top"> virtual void ost::CommandOptionWithArg::FoundOption </td>
          <td class="md">(&nbsp;</td>
          <td class="md"><a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> *</td>
          <td class="mdname">&nbsp; <em>cop</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">const char **</td>
          <td class="mdname">&nbsp; <em>value</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">int</td>
          <td class="mdname">&nbsp; <em>num</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented from <a class="el" href="classost_1_1_command_option.html#a3">ost::CommandOption</a>.    </td>
  </tr>
</table>
<a name="a2" doxytag="ost::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 class="md" nowrap valign="top"> virtual void ost::CommandOptionWithArg::FoundOption </td>
          <td class="md">(&nbsp;</td>
          <td class="md"><a class="el" href="classost_1_1_command_option_parse.html">CommandOptionParse</a> *</td>
          <td class="mdname">&nbsp; <em>cop</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">const char *</td>
          <td class="mdname">&nbsp; <em>value</em> = 0</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented from <a class="el" href="classost_1_1_command_option.html#a2">ost::CommandOption</a>.    </td>
  </tr>
</table>
<a name="a4" doxytag="ost::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 class="md" nowrap valign="top"> virtual bool ost::CommandOptionWithArg::HasValue </td>
          <td class="md">(&nbsp;</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented from <a class="el" href="classost_1_1_command_option.html#a6">ost::CommandOption</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m1" doxytag="ost::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 class="md" nowrap valign="top"> int ost::CommandOptionWithArg::numvalue
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classost_1_1_number.html">Number</a> of values in the values array.
<p>
    </td>
  </tr>
</table>
<a name="m0" doxytag="ost::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 class="md" nowrap valign="top"> const char** ost::CommandOptionWithArg::values
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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_8h-source.html">cmdoptns.h</a></ul>
<hr><address><small>Generated at Fri Jan 4 18:51:47 2002 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.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>