<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ucommon: shell::stringopt Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00140.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>shell::stringopt Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="shell::stringopt" --><!-- doxytag: inherits="shell::Option" -->
<p>Text option for shell parsing.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00196_source.html">shell.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for shell::stringopt:</div>
<div class="dyncontent">
<div class="center"><img src="a00460.png" border="0" usemap="#shell_1_1stringopt_inherit__map" alt="Inheritance graph"/></div>
<map name="shell_1_1stringopt_inherit__map" id="shell_1_1stringopt_inherit__map">
<area shape="rect" id="node2" href="a00138.html" title="A base class used to create parsable shell options." alt="" coords="20,229,172,256"/><area shape="rect" id="node4" href="a00099.html" title="A linked object base class for ordered objects." alt="" coords="20,155,172,181"/><area shape="rect" id="node6" href="a00065.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="25,80,167,107"/><area shape="rect" id="node8" href="a00091.html" title="A common base class for all managed objects." alt="" coords="55,5,137,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for shell::stringopt:</div>
<div class="dyncontent">
<div class="center"><img src="a00461.png" border="0" usemap="#shell_1_1stringopt_coll__map" alt="Collaboration graph"/></div>
<map name="shell_1_1stringopt_coll__map" id="shell_1_1stringopt_coll__map">
<area shape="rect" id="node2" href="a00138.html" title="A base class used to create parsable shell options." alt="" coords="20,253,172,280"/><area shape="rect" id="node4" href="a00099.html" title="A linked object base class for ordered objects." alt="" coords="20,176,172,203"/><area shape="rect" id="node6" href="a00065.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="25,91,167,117"/><area shape="rect" id="node8" href="a00091.html" title="A common base class for all managed objects." alt="" coords="55,5,137,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae862de1790ff3f85dd62debd73826d84"></a><!-- doxytag: member="shell::stringopt::operator bool" ref="ae862de1790ff3f85dd62debd73826d84" args="()" -->
 </td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60255236e13e428a8bbbb1d59f2ff258"></a><!-- doxytag: member="shell::stringopt::operator const char *" ref="a60255236e13e428a8bbbb1d59f2ff258" args="()" -->
 </td><td class="memItemRight" valign="bottom"><b>operator const char *</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b2a8d5bfece7f12aa904279afc545e4"></a><!-- doxytag: member="shell::stringopt::operator!" ref="a5b2a8d5bfece7f12aa904279afc545e4" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a079e16e8a69718d8e7209cc7a78db0c9"></a><!-- doxytag: member="shell::stringopt::operator*" ref="a079e16e8a69718d8e7209cc7a78db0c9" args="()" -->
const char * </td><td class="memItemRight" valign="bottom"><b>operator*</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e895052c242b49906230cc7d021ab78"></a><!-- doxytag: member="shell::stringopt::set" ref="a6e895052c242b49906230cc7d021ab78" args="(const char *string)" -->
void </td><td class="memItemRight" valign="bottom"><b>set</b> (const char *<a class="el" href="a00150.html">string</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac91e33b20e9bb0b45f2f3493588a1d60"></a><!-- doxytag: member="shell::stringopt::stringopt" ref="ac91e33b20e9bb0b45f2f3493588a1d60" args="(char short_option, const char *long_option=NULL, const char *help=NULL, const char *type="text", const char *def_text=NULL)" -->
 </td><td class="memItemRight" valign="bottom"><b>stringopt</b> (char short_option, const char *long_option=NULL, const char *help=NULL, const char *type="text", const char *def_text=NULL)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#ae9f76250efc21705a163b9ec78856886">assign</a> (const char *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to send option into derived receiver. <a href="#ae9f76250efc21705a163b9ec78856886"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae30e98a8ee23dce66107f4251d3e4d7e"></a><!-- doxytag: member="shell::stringopt::text" ref="ae30e98a8ee23dce66107f4251d3e4d7e" args="" -->
const char * </td><td class="memItemRight" valign="bottom"><b>text</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Text option for shell parsing. </p>
<p>This offers a quick-use class to parse a shell flag, along with a numeric text that may be saved and a use counter, as multiple invocations is an error. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00196_source.html#l00424">424</a> of file <a class="el" href="a00196_source.html">shell.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae9f76250efc21705a163b9ec78856886"></a><!-- doxytag: member="shell::stringopt::assign" ref="ae9f76250efc21705a163b9ec78856886" args="(const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* shell::stringopt::assign </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to send option into derived receiver. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>option that was received. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL or error string to use. </dd></dl>
<p>Implements <a class="el" href="a00138.html#a48007fdda8502bfab5514150b63ab6d0">shell::Option</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00196_source.html">shell.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00130.html">shell</a> </li>
<li class="navelem"><a class="el" href="a00140.html">stringopt</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
