diff options
Diffstat (limited to 'doxygen/html/classcmd2_1_1OptionParser.html')
| -rw-r--r-- | doxygen/html/classcmd2_1_1OptionParser.html | 278 |
1 files changed, 278 insertions, 0 deletions
diff --git a/doxygen/html/classcmd2_1_1OptionParser.html b/doxygen/html/classcmd2_1_1OptionParser.html new file mode 100644 index 0000000..548b736 --- /dev/null +++ b/doxygen/html/classcmd2_1_1OptionParser.html @@ -0,0 +1,278 @@ +<!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>Cmd2: cmd2::OptionParser Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.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="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Cmd2 + + </div> + + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <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>Packages</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li><a href="dirs.html"><span>Directories</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</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('classcmd2_1_1OptionParser.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">cmd2::OptionParser Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="cmd2::OptionParser" --> +<p><a href="classcmd2_1_1OptionParser-members.html">List of all members.</a></p> +<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">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1OptionParser.html#ada4f39b453e033ae4356709f8ee9f340">error</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1OptionParser.html#ad82c8fb7559af2e4b1663e0762a80c89">exit</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1OptionParser.html#a6f2d24051471268be245221149bc9c6a">print_help</a></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"> +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00064">64</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> +</div><hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ada4f39b453e033ae4356709f8ee9f340"></a><!-- doxytag: member="cmd2::OptionParser::error" ref="ada4f39b453e033ae4356709f8ee9f340" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::OptionParser::error </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>msg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<div class="fragment"><pre class="fragment">error(msg : string) + +Print a usage message incorporating 'msg' to stderr and exit. +If you override this in a subclass, it should not return -- it +should either exit or raise an exception. +</pre></div> +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00077">77</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00077"></a><a class="code" href="classcmd2_1_1OptionParser.html#ada4f39b453e033ae4356709f8ee9f340">00077</a> +<a name="l00078"></a>00078 <span class="keyword">def </span><a class="code" href="classcmd2_1_1OptionParser.html#ada4f39b453e033ae4356709f8ee9f340">error</a>(self, msg): +<a name="l00079"></a>00079 <span class="stringliteral">"""error(msg : string)</span> +<a name="l00080"></a>00080 <span class="stringliteral"></span> +<a name="l00081"></a>00081 <span class="stringliteral"> Print a usage message incorporating 'msg' to stderr and exit.</span> +<a name="l00082"></a>00082 <span class="stringliteral"> If you override this in a subclass, it should not return -- it</span> +<a name="l00083"></a>00083 <span class="stringliteral"> should either exit or raise an exception.</span> +<a name="l00084"></a>00084 <span class="stringliteral"> """</span> +<a name="l00085"></a>00085 <span class="keywordflow">raise</span> optparse.OptParseError(msg) + +</pre></div> +</div> +</div> +<a class="anchor" id="ad82c8fb7559af2e4b1663e0762a80c89"></a><!-- doxytag: member="cmd2::OptionParser::exit" ref="ad82c8fb7559af2e4b1663e0762a80c89" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::OptionParser::exit </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>status</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>msg</em> = <code>None</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00065">65</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00065"></a><a class="code" href="classcmd2_1_1OptionParser.html#ad82c8fb7559af2e4b1663e0762a80c89">00065</a> +<a name="l00066"></a>00066 <span class="keyword">def </span><a class="code" href="classcmd2_1_1OptionParser.html#ad82c8fb7559af2e4b1663e0762a80c89">exit</a>(self, status=0, msg=None): +<a name="l00067"></a>00067 self.values._exit = <span class="keyword">True</span> +<a name="l00068"></a>00068 <span class="keywordflow">if</span> msg: +<a name="l00069"></a>00069 <span class="keywordflow">print</span> (msg) + +</pre></div> +</div> +</div> +<a class="anchor" id="a6f2d24051471268be245221149bc9c6a"></a><!-- doxytag: member="cmd2::OptionParser::print_help" ref="a6f2d24051471268be245221149bc9c6a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::OptionParser::print_help </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>args</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>kwargs</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00070">70</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00070"></a><a class="code" href="classcmd2_1_1OptionParser.html#a6f2d24051471268be245221149bc9c6a">00070</a> +<a name="l00071"></a>00071 <span class="keyword">def </span><a class="code" href="classcmd2_1_1OptionParser.html#a6f2d24051471268be245221149bc9c6a">print_help</a>(self, *args, **kwargs): +<a name="l00072"></a>00072 <span class="keywordflow">try</span>: +<a name="l00073"></a>00073 <span class="keywordflow">print</span> (self._func.__doc__) +<a name="l00074"></a>00074 <span class="keywordflow">except</span> AttributeError: +<a name="l00075"></a>00075 <span class="keywordflow">pass</span> +<a name="l00076"></a>00076 optparse.OptionParser.print_help(self, *args, **kwargs) + +</pre></div> +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/Users/amrogers/Developer/Projects/cmd2/<a class="el" href="cmd2_8py_source.html">cmd2.py</a></li> +</ul> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespacecmd2.html">cmd2</a> </li> + <li class="navelem"><a class="el" href="classcmd2_1_1OptionParser.html">OptionParser</a> </li> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + + + <li class="footer">Generated on Fri Sep 9 2011 10:50:48 for Cmd2 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> + </ul> + </div> + + +</body> +</html> |