summaryrefslogtreecommitdiff
path: root/doxygen/html/classcmd2_1_1_history.html
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/html/classcmd2_1_1_history.html')
-rw-r--r--doxygen/html/classcmd2_1_1_history.html418
1 files changed, 418 insertions, 0 deletions
diff --git a/doxygen/html/classcmd2_1_1_history.html b/doxygen/html/classcmd2_1_1_history.html
new file mode 100644
index 0000000..903c640
--- /dev/null
+++ b/doxygen/html/classcmd2_1_1_history.html
@@ -0,0 +1,418 @@
+<!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::History 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&#160;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>
+ <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&#160;List</span></a></li>
+ <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
+ <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class&#160;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_1_history.html','');
+</script>
+<div id="doc-content">
+<div class="header">
+ <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="#pub-static-attribs">Static Public Attributes</a> </div>
+ <div class="headertitle">
+<div class="title">cmd2::History Class Reference</div> </div>
+</div>
+<div class="contents">
+<!-- doxytag: class="cmd2::History" -->
+<p><a href="classcmd2_1_1_history-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&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#accd354b7c81e1cd538438b834630f3ac">zero_based_index</a></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#a28fe5dc698da4c7bf82fdcdfb2e70506">to_index</a></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#ae1db5657367e6aa9b0e43811d5b8893f">search</a></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#a8c0837240ac7747aa804ba9eebddab60">span</a></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#aef5a4f297a77df78cd0e6bb17b67fb16">append</a></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#a1c036910ea442db79fe012715b29c9db">extend</a></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#a030faac02c0b814fc676d21d8c5e049c">get</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">tuple&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#aa5204f159577beb16f07a8a9ada184ec">spanpattern</a> = re.compile(r'^\s*(?P&lt;start&gt;\-?\d+)?\s*(?P&lt;separator&gt;:|(\.{2,}))?\s*(?P&lt;end&gt;\-?\d+)?\s*$')</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">tuple&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1_history.html#a47db7cadf89510850e60e3c908a376f1">rangePattern</a> = re.compile(r'^\s*(?P&lt;start&gt;[\d]+)?\s*\-\s*(?P&lt;end&gt;[\d]+)?\s*$')</td></tr>
+</table>
+<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
+<div class="textblock"><div class="fragment"><pre class="fragment">A list of HistoryItems that knows how to respond to user requests.
+&gt;&gt;&gt; h = History([HistoryItem('first'), HistoryItem('second'), HistoryItem('third'), HistoryItem('fourth')])
+&gt;&gt;&gt; h.span('-2..')
+['third', 'fourth']
+&gt;&gt;&gt; h.span('2..3')
+['second', 'third']
+&gt;&gt;&gt; h.span('3')
+['third']
+&gt;&gt;&gt; h.span(':')
+['first', 'second', 'third', 'fourth']
+&gt;&gt;&gt; h.span('2..')
+['second', 'third', 'fourth']
+&gt;&gt;&gt; h.span('-1')
+['fourth']
+&gt;&gt;&gt; h.span('-2..-3')
+['third', 'second']
+&gt;&gt;&gt; h.search('o')
+['second', 'fourth']
+&gt;&gt;&gt; h.search('/IR/')
+['first', 'third']
+</pre></div>
+<p>Definition at line <a class="el" href="cmd2_8py_source.html#l01304">1304</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="aef5a4f297a77df78cd0e6bb17b67fb16"></a><!-- doxytag: member="cmd2::History::append" ref="aef5a4f297a77df78cd0e6bb17b67fb16" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">def cmd2::History::append </td>
+ <td>(</td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>self</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>new</em>&#160;</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#l01368">1368</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a1c036910ea442db79fe012715b29c9db"></a><!-- doxytag: member="cmd2::History::extend" ref="a1c036910ea442db79fe012715b29c9db" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">def cmd2::History::extend </td>
+ <td>(</td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>self</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>new</em>&#160;</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#l01372">1372</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a030faac02c0b814fc676d21d8c5e049c"></a><!-- doxytag: member="cmd2::History::get" ref="a030faac02c0b814fc676d21d8c5e049c" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">def cmd2::History::get </td>
+ <td>(</td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>self</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>getme</em> = <code>None</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>fromEnd</em> = <code>False</code>&#160;</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#l01376">1376</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ae1db5657367e6aa9b0e43811d5b8893f"></a><!-- doxytag: member="cmd2::History::search" ref="ae1db5657367e6aa9b0e43811d5b8893f" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">def cmd2::History::search </td>
+ <td>(</td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>self</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>target</em>&#160;</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#l01337">1337</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a8c0837240ac7747aa804ba9eebddab60"></a><!-- doxytag: member="cmd2::History::span" ref="a8c0837240ac7747aa804ba9eebddab60" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">def cmd2::History::span </td>
+ <td>(</td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>self</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>raw</em>&#160;</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#l01346">1346</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a28fe5dc698da4c7bf82fdcdfb2e70506"></a><!-- doxytag: member="cmd2::History::to_index" ref="a28fe5dc698da4c7bf82fdcdfb2e70506" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">def cmd2::History::to_index </td>
+ <td>(</td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>self</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>raw</em>&#160;</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#l01331">1331</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="accd354b7c81e1cd538438b834630f3ac"></a><!-- doxytag: member="cmd2::History::zero_based_index" ref="accd354b7c81e1cd538438b834630f3ac" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">def cmd2::History::zero_based_index </td>
+ <td>(</td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>self</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">&#160;</td>
+ <td class="paramname"><em>onebased</em>&#160;</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#l01326">1326</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<hr/><h2>Member Data Documentation</h2>
+<a class="anchor" id="a47db7cadf89510850e60e3c908a376f1"></a><!-- doxytag: member="cmd2::History::rangePattern" ref="a47db7cadf89510850e60e3c908a376f1" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">tuple <a class="el" href="classcmd2_1_1_history.html#a47db7cadf89510850e60e3c908a376f1">cmd2::History::rangePattern</a> = re.compile(r'^\s*(?P&lt;start&gt;[\d]+)?\s*\-\s*(?P&lt;end&gt;[\d]+)?\s*$')<code> [static]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Definition at line <a class="el" href="cmd2_8py_source.html#l01367">1367</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="aa5204f159577beb16f07a8a9ada184ec"></a><!-- doxytag: member="cmd2::History::spanpattern" ref="aa5204f159577beb16f07a8a9ada184ec" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">tuple <a class="el" href="classcmd2_1_1_history.html#aa5204f159577beb16f07a8a9ada184ec">cmd2::History::spanpattern</a> = re.compile(r'^\s*(?P&lt;start&gt;\-?\d+)?\s*(?P&lt;separator&gt;:|(\.{2,}))?\s*(?P&lt;end&gt;\-?\d+)?\s*$')<code> [static]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Definition at line <a class="el" href="cmd2_8py_source.html#l01345">1345</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p>
+
+</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_1_history.html">History</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</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:39:49 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>