GED 2006 (C++)
File detail
Source code
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>GED 2006: CmdHistory Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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>
<h1>CmdHistory Class Reference</h1><!-- doxytag: class="CmdHistory" --><code>#include <<a class="el" href="command_8h-source.html">command.h</a>></code>
<p>
<p>Inheritance diagram for CmdHistory:
<p><center><img src="classCmdHistory.png" usemap="#CmdHistory_map" border="0" alt=""></center>
<map name="CmdHistory_map">
<area href="classImage.html" alt="Image" shape="rect" coords="45,56,125,80">
<area href="classPluginImage.html" alt="PluginImage" shape="rect" coords="0,112,80,136">
<area href="classPNGImage.html" alt="PNGImage" shape="rect" coords="90,112,170,136">
</map>
<a href="classCmdHistory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#0ff3780a236036b62d74a55f56234397">CmdHistory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#75508123c5b627f019e37343127eeecb">~CmdHistory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCmdHistory.html">CmdHistory</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#844f048ae189e30c90ca21ba4cd5da31">operator<<</a> (<a class="el" href="classCmd.html">Cmd</a> *pCmd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#3d5f984db47cc4c8a8e2caa15b9084c9">undoAvailable</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How many undo step is available. <a href="#3d5f984db47cc4c8a8e2caa15b9084c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#8ebe7942aa611531bd2d135b93cf62e7">canUndo</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if undo is possible. <a href="#8ebe7942aa611531bd2d135b93cf62e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#6dbf1374dd49e57e5f50ef5174d9ee73">canRedo</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if redo is possible. <a href="#6dbf1374dd49e57e5f50ef5174d9ee73"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#48b03dc159c0c16ef83f4198e4c8bc17">rollBack</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cancel last operation. Needed if command crashes during execution. <a href="#48b03dc159c0c16ef83f4198e4c8bc17"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#5445c7f33cd26252ce7568ffb56e6efc">undo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Undo last command. <a href="#5445c7f33cd26252ce7568ffb56e6efc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#1eb01397ee525b6be9c76816cf5eec2f">redo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Undo last undo. <a href="#1eb01397ee525b6be9c76816cf5eec2f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#700190c397fa362ade32bddb6f20355c">needSave</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if image has changed since last saving. <a href="#700190c397fa362ade32bddb6f20355c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#269dde96f66aa615b0859dbe337c45bb">setSaved</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">May be called when document is saved. <a href="#269dde96f66aa615b0859dbe337c45bb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#3c648f427ddccf276cfbbf2729fa6feb">startMacro</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classMacroCmd.html">MacroCmd</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory.html#b98b578ee178aa7d3118a75e88da1ff7">createMacroCmd</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCmdHistory_1_1ErrUnderflow.html">ErrUnderflow</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class maintaing command history and macro recording. This is one of base classes for <a class="el" href="classImage.html">Image</a> class.
<p>
<p>
Definition at line <a class="el" href="command_8h-source.html#l00188">188</a> of file <a class="el" href="command_8h-source.html">command.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0ff3780a236036b62d74a55f56234397"></a><!-- doxytag: member="CmdHistory::CmdHistory" ref="0ff3780a236036b62d74a55f56234397" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CmdHistory::CmdHistory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="75508123c5b627f019e37343127eeecb"></a><!-- doxytag: member="CmdHistory::~CmdHistory" ref="75508123c5b627f019e37343127eeecb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CmdHistory::~CmdHistory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="844f048ae189e30c90ca21ba4cd5da31"></a><!-- doxytag: member="CmdHistory::operator<<" ref="844f048ae189e30c90ca21ba4cd5da31" args="(Cmd *pCmd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCmdHistory.html">CmdHistory</a>& CmdHistory::operator<< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCmd.html">Cmd</a> * </td>
<td class="paramname"> <em>pCmd</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put command to history list. *pCmd object must by allocated on the heap and can never be destroyed. <a class="el" href="classCmdHistory.html">CmdHistory</a> destroys it. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pCmd</em> </td><td>Pointer to command. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this. Needed for << operator concatenation. </dd></dl>
<p>
Reimplemented in <a class="el" href="classImage.html#2952f609feb02d0b33dc57d6ecb84192">Image</a>.
<p>
Referenced by <a class="el" href="image_8h-source.html#l00062">Image::operator<<()</a>.
</div>
</div><p>
<a class="anchor" name="3d5f984db47cc4c8a8e2caa15b9084c9"></a><!-- doxytag: member="CmdHistory::undoAvailable" ref="3d5f984db47cc4c8a8e2caa15b9084c9" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CmdHistory::undoAvailable </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
How many undo step is available.
<p>
</div>
</div><p>
<a class="anchor" name="8ebe7942aa611531bd2d135b93cf62e7"></a><!-- doxytag: member="CmdHistory::canUndo" ref="8ebe7942aa611531bd2d135b93cf62e7" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CmdHistory::canUndo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
True if undo is possible.
<p>
</div>
</div><p>
<a class="anchor" name="6dbf1374dd49e57e5f50ef5174d9ee73"></a><!-- doxytag: member="CmdHistory::canRedo" ref="6dbf1374dd49e57e5f50ef5174d9ee73" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CmdHistory::canRedo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
True if redo is possible.
<p>
</div>
</div><p>
<a class="anchor" name="48b03dc159c0c16ef83f4198e4c8bc17"></a><!-- doxytag: member="CmdHistory::rollBack" ref="48b03dc159c0c16ef83f4198e4c8bc17" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CmdHistory::rollBack </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cancel last operation. Needed if command crashes during execution.
<p>
</div>
</div><p>
<a class="anchor" name="5445c7f33cd26252ce7568ffb56e6efc"></a><!-- doxytag: member="CmdHistory::undo" ref="5445c7f33cd26252ce7568ffb56e6efc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CmdHistory::undo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Undo last command.
<p>
</div>
</div><p>
<a class="anchor" name="1eb01397ee525b6be9c76816cf5eec2f"></a><!-- doxytag: member="CmdHistory::redo" ref="1eb01397ee525b6be9c76816cf5eec2f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CmdHistory::redo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Undo last undo.
<p>
</div>
</div><p>
<a class="anchor" name="700190c397fa362ade32bddb6f20355c"></a><!-- doxytag: member="CmdHistory::needSave" ref="700190c397fa362ade32bddb6f20355c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CmdHistory::needSave </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
True if image has changed since last saving.
<p>
</div>
</div><p>
<a class="anchor" name="269dde96f66aa615b0859dbe337c45bb"></a><!-- doxytag: member="CmdHistory::setSaved" ref="269dde96f66aa615b0859dbe337c45bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CmdHistory::setSaved </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
May be called when document is saved.
<p>
</div>
</div><p>
<a class="anchor" name="3c648f427ddccf276cfbbf2729fa6feb"></a><!-- doxytag: member="CmdHistory::startMacro" ref="3c648f427ddccf276cfbbf2729fa6feb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CmdHistory::startMacro </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start macro loading.
</div>
</div><p>
<a class="anchor" name="b98b578ee178aa7d3118a75e88da1ff7"></a><!-- doxytag: member="CmdHistory::createMacroCmd" ref="b98b578ee178aa7d3118a75e88da1ff7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMacroCmd.html">MacroCmd</a>* CmdHistory::createMacroCmd </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create new macro. Note that startMacro method should be called first. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return pointer to on heap allocated <a class="el" href="classMacroCmd.html">MacroCmd</a>. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="command_8h-source.html">command.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 29 00:01:04 2007 for GED 2006 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Back to main page
classCmdHistory.html [Download]