diff options
Diffstat (limited to 'doxygen/html/classexample_1_1CmdLineApp.html')
| -rw-r--r-- | doxygen/html/classexample_1_1CmdLineApp.html | 299 |
1 files changed, 299 insertions, 0 deletions
diff --git a/doxygen/html/classexample_1_1CmdLineApp.html b/doxygen/html/classexample_1_1CmdLineApp.html new file mode 100644 index 0000000..55bda32 --- /dev/null +++ b/doxygen/html/classexample_1_1CmdLineApp.html @@ -0,0 +1,299 @@ +<!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: example::CmdLineApp 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('classexample_1_1CmdLineApp.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-attribs">Static Public Attributes</a> </div> + <div class="headertitle"> +<div class="title">example::CmdLineApp Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="example::CmdLineApp" --><!-- doxytag: inherits="cmd2::Cmd" --><div class="dynheader"> +Inheritance diagram for example::CmdLineApp:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classexample_1_1CmdLineApp.png" usemap="#example::CmdLineApp_map" alt=""/> + <map id="example::CmdLineApp_map" name="example::CmdLineApp_map"> +<area href="classcmd2_1_1Cmd.html" alt="cmd2::Cmd" shape="rect" coords="0,0,136,24"/> +</map> + </div></div> + +<p><a href="classexample_1_1CmdLineApp-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="classexample_1_1CmdLineApp.html#afdc6e3337a734471574398731d582ec9">do_speak</a></td></tr> +<tr><td colspan="2"><h2><a name="pub-static-attribs"></a> +Static Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classexample_1_1CmdLineApp.html#ac9058ddc022235f3876c6b410ddeb688">do_orate</a> = do_speak</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classexample_1_1CmdLineApp.html#a5acab19a8c4c609e944ea1cb345a5ec3">do_say</a> = do_speak</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classexample_1_1CmdLineApp.html#a81a94979fcdd998c72d530e47bab88e0">maxrepeats</a> = 3</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">list </td><td class="memItemRight" valign="bottom"><a class="el" href="classexample_1_1CmdLineApp.html#a7720e4d8dd45f289c3962be91c05ac33">multilineCommands</a> = ['orate']</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classexample_1_1CmdLineApp.html#adb66a4ed5e10aa018c7e3a4da6779c76">redirector</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="example_8py_source.html#l00006">6</a> of file <a class="el" href="example_8py_source.html">example.py</a>.</p> +</div><hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="afdc6e3337a734471574398731d582ec9"></a><!-- doxytag: member="example::CmdLineApp::do_speak" ref="afdc6e3337a734471574398731d582ec9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def example::CmdLineApp::do_speak </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>arg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>opts</em> = <code>None</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<div class="fragment"><pre class="fragment">Repeats what you tell me to.</pre></div> +<p>Definition at line <a class="el" href="example_8py_source.html#l00017">17</a> of file <a class="el" href="example_8py_source.html">example.py</a>.</p> + +<p>References <a class="el" href="example_8py_source.html#l00009">maxrepeats</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00017"></a><a class="code" href="classexample_1_1CmdLineApp.html#afdc6e3337a734471574398731d582ec9">00017</a> +<a name="l00018"></a>00018 <span class="keyword">def </span><a class="code" href="classexample_1_1CmdLineApp.html#afdc6e3337a734471574398731d582ec9">do_speak</a>(self, arg, opts=None): +<a name="l00019"></a>00019 <span class="stringliteral">"""Repeats what you tell me to."""</span> +<a name="l00020"></a>00020 arg = <span class="stringliteral">''</span>.join(arg) +<a name="l00021"></a>00021 <span class="keywordflow">if</span> opts.piglatin: +<a name="l00022"></a>00022 arg = <span class="stringliteral">'%s%say'</span> % (arg[1:].rstrip(), arg[0]) +<a name="l00023"></a>00023 <span class="keywordflow">if</span> opts.shout: +<a name="l00024"></a>00024 arg = arg.upper() +<a name="l00025"></a>00025 repetitions = opts.repeat <span class="keywordflow">or</span> 1 +<a name="l00026"></a>00026 <span class="keywordflow">for</span> i <span class="keywordflow">in</span> range(min(repetitions, self.<a class="code" href="classexample_1_1CmdLineApp.html#a81a94979fcdd998c72d530e47bab88e0">maxrepeats</a>)): +<a name="l00027"></a>00027 self.stdout.write(arg) +<a name="l00028"></a>00028 self.stdout.write(<span class="stringliteral">'\n'</span>) +<a name="l00029"></a>00029 <span class="comment"># self.stdout.write is better than "print", because Cmd can be</span> +<a name="l00030"></a>00030 <span class="comment"># initialized with a non-standard output destination </span> + +</pre></div> +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="ac9058ddc022235f3876c6b410ddeb688"></a><!-- doxytag: member="example::CmdLineApp::do_orate" ref="ac9058ddc022235f3876c6b410ddeb688" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classexample_1_1CmdLineApp.html#ac9058ddc022235f3876c6b410ddeb688">example::CmdLineApp::do_orate</a> = do_speak<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="example_8py_source.html#l00032">32</a> of file <a class="el" href="example_8py_source.html">example.py</a>.</p> + +</div> +</div> +<a class="anchor" id="a5acab19a8c4c609e944ea1cb345a5ec3"></a><!-- doxytag: member="example::CmdLineApp::do_say" ref="a5acab19a8c4c609e944ea1cb345a5ec3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classexample_1_1CmdLineApp.html#a5acab19a8c4c609e944ea1cb345a5ec3">example::CmdLineApp::do_say</a> = do_speak<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="example_8py_source.html#l00031">31</a> of file <a class="el" href="example_8py_source.html">example.py</a>.</p> + +</div> +</div> +<a class="anchor" id="a81a94979fcdd998c72d530e47bab88e0"></a><!-- doxytag: member="example::CmdLineApp::maxrepeats" ref="a81a94979fcdd998c72d530e47bab88e0" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="classexample_1_1CmdLineApp.html#a81a94979fcdd998c72d530e47bab88e0">example::CmdLineApp::maxrepeats</a> = 3<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="example_8py_source.html#l00009">9</a> of file <a class="el" href="example_8py_source.html">example.py</a>.</p> + +<p>Referenced by <a class="el" href="example_8py_source.html#l00017">do_speak()</a>.</p> + +</div> +</div> +<a class="anchor" id="a7720e4d8dd45f289c3962be91c05ac33"></a><!-- doxytag: member="example::CmdLineApp::multilineCommands" ref="a7720e4d8dd45f289c3962be91c05ac33" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">list <a class="el" href="classexample_1_1CmdLineApp.html#a7720e4d8dd45f289c3962be91c05ac33">example::CmdLineApp::multilineCommands</a> = ['orate']<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Reimplemented from <a class="el" href="classcmd2_1_1Cmd.html#a05fbd7501cbc1f911e9a4925e5f0804a">cmd2::Cmd</a>.</p> + +<p>Definition at line <a class="el" href="example_8py_source.html#l00007">7</a> of file <a class="el" href="example_8py_source.html">example.py</a>.</p> + +</div> +</div> +<a class="anchor" id="adb66a4ed5e10aa018c7e3a4da6779c76"></a><!-- doxytag: member="example::CmdLineApp::redirector" ref="adb66a4ed5e10aa018c7e3a4da6779c76" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">string <a class="el" href="classexample_1_1CmdLineApp.html#adb66a4ed5e10aa018c7e3a4da6779c76">example::CmdLineApp::redirector</a> = '->'<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Reimplemented from <a class="el" href="classcmd2_1_1Cmd.html#a64b810574dab9ec12100c5344dc66735">cmd2::Cmd</a>.</p> + +<p>Definition at line <a class="el" href="example_8py_source.html#l00010">10</a> of file <a class="el" href="example_8py_source.html">example.py</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/Users/amrogers/Developer/Projects/cmd2/example/<a class="el" href="example_8py_source.html">example.py</a></li> +</ul> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespaceexample.html">example</a> </li> + <li class="navelem"><a class="el" href="classexample_1_1CmdLineApp.html">CmdLineApp</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> |