summaryrefslogtreecommitdiff
path: root/doxygen/xml/classcmd2_1_1_history.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/xml/classcmd2_1_1_history.xml')
-rw-r--r--doxygen/xml/classcmd2_1_1_history.xml165
1 files changed, 165 insertions, 0 deletions
diff --git a/doxygen/xml/classcmd2_1_1_history.xml b/doxygen/xml/classcmd2_1_1_history.xml
new file mode 100644
index 0000000..d42671a
--- /dev/null
+++ b/doxygen/xml/classcmd2_1_1_history.xml
@@ -0,0 +1,165 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.5.1">
+ <compounddef id="classcmd2_1_1_history" kind="class" prot="public">
+ <compoundname>cmd2::History</compoundname>
+ <sectiondef kind="public-static-attrib">
+ <memberdef kind="variable" id="classcmd2_1_1_history_1aa5204f159577beb16f07a8a9ada184ec" prot="public" static="yes" mutable="no">
+ <type>tuple</type>
+ <definition>tuple cmd2::History::spanpattern</definition>
+ <argsstring></argsstring>
+ <name>spanpattern</name>
+ <initializer>re.compile(r&apos;^\s*(?P&lt;start&gt;\-?\d+)?\s*(?P&lt;separator&gt;:|(\.{2,}))?\s*(?P&lt;end&gt;\-?\d+)?\s*$&apos;)</initializer>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1345" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1345" bodyend="-1"/>
+ </memberdef>
+ <memberdef kind="variable" id="classcmd2_1_1_history_1a47db7cadf89510850e60e3c908a376f1" prot="public" static="yes" mutable="no">
+ <type>tuple</type>
+ <definition>tuple cmd2::History::rangePattern</definition>
+ <argsstring></argsstring>
+ <name>rangePattern</name>
+ <initializer>re.compile(r&apos;^\s*(?P&lt;start&gt;[\d]+)?\s*\-\s*(?P&lt;end&gt;[\d]+)?\s*$&apos;)</initializer>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1367" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1367" bodyend="-1"/>
+ </memberdef>
+ </sectiondef>
+ <sectiondef kind="public-func">
+ <memberdef kind="function" id="classcmd2_1_1_history_1accd354b7c81e1cd538438b834630f3ac" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::History::zero_based_index</definition>
+ <argsstring></argsstring>
+ <name>zero_based_index</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1326" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1326" bodyend="1330"/>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1_history_1a28fe5dc698da4c7bf82fdcdfb2e70506" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::History::to_index</definition>
+ <argsstring></argsstring>
+ <name>to_index</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1331" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1331" bodyend="1336"/>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1_history_1ae1db5657367e6aa9b0e43811d5b8893f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::History::search</definition>
+ <argsstring></argsstring>
+ <name>search</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1337" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1337" bodyend="1344"/>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1_history_1a8c0837240ac7747aa804ba9eebddab60" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::History::span</definition>
+ <argsstring></argsstring>
+ <name>span</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1346" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1346" bodyend="1366"/>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1_history_1aef5a4f297a77df78cd0e6bb17b67fb16" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::History::append</definition>
+ <argsstring></argsstring>
+ <name>append</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1368" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1368" bodyend="1371"/>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1_history_1a1c036910ea442db79fe012715b29c9db" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::History::extend</definition>
+ <argsstring></argsstring>
+ <name>extend</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1372" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1372" bodyend="1375"/>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1_history_1a030faac02c0b814fc676d21d8c5e049c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::History::get</definition>
+ <argsstring></argsstring>
+ <name>get</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1376" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1376" bodyend="1408"/>
+ </memberdef>
+ </sectiondef>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+<para><verbatim>A list of HistoryItems that knows how to respond to user requests.
+&gt;&gt;&gt; h = History([HistoryItem(&apos;first&apos;), HistoryItem(&apos;second&apos;), HistoryItem(&apos;third&apos;), HistoryItem(&apos;fourth&apos;)])
+&gt;&gt;&gt; h.span(&apos;-2..&apos;)
+[&apos;third&apos;, &apos;fourth&apos;]
+&gt;&gt;&gt; h.span(&apos;2..3&apos;)
+[&apos;second&apos;, &apos;third&apos;]
+&gt;&gt;&gt; h.span(&apos;3&apos;)
+[&apos;third&apos;]
+&gt;&gt;&gt; h.span(&apos;:&apos;)
+[&apos;first&apos;, &apos;second&apos;, &apos;third&apos;, &apos;fourth&apos;]
+&gt;&gt;&gt; h.span(&apos;2..&apos;)
+[&apos;second&apos;, &apos;third&apos;, &apos;fourth&apos;]
+&gt;&gt;&gt; h.span(&apos;-1&apos;)
+[&apos;fourth&apos;]
+&gt;&gt;&gt; h.span(&apos;-2..-3&apos;)
+[&apos;third&apos;, &apos;second&apos;]
+&gt;&gt;&gt; h.search(&apos;o&apos;)
+[&apos;second&apos;, &apos;fourth&apos;]
+&gt;&gt;&gt; h.search(&apos;/IR/&apos;)
+[&apos;first&apos;, &apos;third&apos;]
+</verbatim> </para> </detaileddescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1325" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1304" bodyend="1409"/>
+ <listofallmembers>
+ <member refid="classcmd2_1_1_history_1aef5a4f297a77df78cd0e6bb17b67fb16" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>append</name></member>
+ <member refid="classcmd2_1_1_history_1a1c036910ea442db79fe012715b29c9db" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>extend</name></member>
+ <member refid="classcmd2_1_1_history_1a030faac02c0b814fc676d21d8c5e049c" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>get</name></member>
+ <member refid="classcmd2_1_1_history_1a47db7cadf89510850e60e3c908a376f1" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>rangePattern</name></member>
+ <member refid="classcmd2_1_1_history_1ae1db5657367e6aa9b0e43811d5b8893f" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>search</name></member>
+ <member refid="classcmd2_1_1_history_1a8c0837240ac7747aa804ba9eebddab60" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>span</name></member>
+ <member refid="classcmd2_1_1_history_1aa5204f159577beb16f07a8a9ada184ec" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>spanpattern</name></member>
+ <member refid="classcmd2_1_1_history_1a28fe5dc698da4c7bf82fdcdfb2e70506" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>to_index</name></member>
+ <member refid="classcmd2_1_1_history_1accd354b7c81e1cd538438b834630f3ac" prot="public" virt="non-virtual"><scope>cmd2::History</scope><name>zero_based_index</name></member>
+ </listofallmembers>
+ </compounddef>
+</doxygen>