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: command.h Source File</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><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>command.h</h1><a href="command_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * File: command.h - Command abstraction and command history</span>
<a name="l00003"></a>00003 <span class="comment"> * Project: GED - bitmap editor (ICP)</span>
<a name="l00004"></a>00004 <span class="comment"> * Author: Kamil Dudka, xdudka00</span>
<a name="l00005"></a>00005 <span class="comment"> * Team: xdudka00, xfilak01, xhefka00, xhradi08</span>
<a name="l00006"></a>00006 <span class="comment"> * Created: 2006-03-10</span>
<a name="l00007"></a>00007 <span class="comment"> */</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="preprocessor">#ifndef COMMAND_H</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define COMMAND_H</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include <list></span>
<a name="l00013"></a>00013 <span class="preprocessor">#include <string></span>
<a name="l00014"></a>00014
<a name="l00015"></a>00015 <span class="preprocessor">#include "<a class="code" href="framebuffer_8h.html">framebuffer.h</a>"</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="keyword">class </span><a class="code" href="classGedMacroCommand.html">GedMacroCommand</a>;
<a name="l00018"></a>00018
<a name="l00025"></a><a class="code" href="classCmd.html">00025</a> <span class="keyword">class </span><a class="code" href="classCmd.html">Cmd</a> {
<a name="l00026"></a>00026 <span class="keyword">public</span>:
<a name="l00027"></a><a class="code" href="classCmd.html#1f036f79ba540557042d21f954e01972">00027</a> <span class="keyword">virtual</span> <a class="code" href="classCmd.html#1f036f79ba540557042d21f954e01972" title="All Cmd based classes will have virtual destructor.">~Cmd</a> () { }
<a name="l00028"></a>00028 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCmd.html#91ebd2007a41d4943ea2d47f16706d97" title="Command execution. This should save undo informations.">exec</a> () = 0;
<a name="l00029"></a>00029 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCmd.html#92b768830e3583e88f417da33d9b552b" title="Revert command execution using undo informations.">unExec</a> () = 0;
<a name="l00030"></a>00030 <span class="keyword">virtual</span> std::string <a class="code" href="classCmd.html#12950146932aaa5a72e9f5a4fbb86d1c" title="Command identification. This will appear in config file.">name</a> () = 0;
<a name="l00031"></a>00031 <span class="keyword">virtual</span> std::string <a class="code" href="classCmd.html#28336769776671d47a997a8f1e43f406" title="Command export to text string. Needed for macro saving.">args</a> () = 0;
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">protected</span>:
<a name="l00038"></a><a class="code" href="classCmd.html#61ec883203e3b845694efaf2e2fc756a">00038</a> <a class="code" href="classCmd.html#61ec883203e3b845694efaf2e2fc756a">Cmd</a> (<a class="code" href="classFrameBuffer.html">FrameBuffer</a> *pFB): <a class="code" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">_fb</a> (*pFB) { }
<a name="l00039"></a>00039
<a name="l00043"></a><a class="code" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">00043</a> <a class="code" href="classFrameBuffer.html">FrameBuffer</a> &<a class="code" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">_fb</a>;
<a name="l00044"></a>00044
<a name="l00048"></a><a class="code" href="classCmd.html#9f62c1dab9a3ceb2841bd8df3b5a6a71">00048</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classCmdHistory.html">CmdHistory</a>;
<a name="l00049"></a>00049 };
<a name="l00050"></a>00050
<a name="l00056"></a><a class="code" href="classSlowUndoCmd.html">00056</a> <span class="keyword">class </span><a class="code" href="classSlowUndoCmd.html">SlowUndoCmd</a>: <span class="keyword">public</span> <a class="code" href="classCmd.html">Cmd</a> {
<a name="l00057"></a>00057 <span class="keyword">public</span>:
<a name="l00058"></a><a class="code" href="classSlowUndoCmd.html#a0fe0ca6ec2ba209691950d31924fa4e">00058</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classSlowUndoCmd.html#a0fe0ca6ec2ba209691950d31924fa4e" title="Save current frame buffer as undo information.">exec</a> () { _savePoint = <a class="code" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">_fb</a>; }
<a name="l00059"></a><a class="code" href="classSlowUndoCmd.html#56afa2d41608a96670f9d5937bbcfd4c">00059</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classSlowUndoCmd.html#56afa2d41608a96670f9d5937bbcfd4c" title="Restore saved frame buffer.">unExec</a> () { <a class="code" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">_fb</a> = _savePoint; }
<a name="l00060"></a>00060 <span class="keyword">virtual</span> std::string <a class="code" href="classSlowUndoCmd.html#ded003144be4d791e36e763b1580f0bc" title="Command identification. This will appear in config file.">name</a> () = 0;
<a name="l00061"></a>00061 <span class="keyword">virtual</span> std::string <a class="code" href="classSlowUndoCmd.html#a26ced5fe114d904dfdcd56f5d9d7188" title="Command export to text string. Needed for macro saving.">args</a> () = 0;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">protected</span>:
<a name="l00068"></a><a class="code" href="classSlowUndoCmd.html#89c85ed30ce73ef43c693f9f8eb23b78">00068</a> <a class="code" href="classSlowUndoCmd.html#89c85ed30ce73ef43c693f9f8eb23b78">SlowUndoCmd</a> (<a class="code" href="classFrameBuffer.html">FrameBuffer</a> *pFB): <a class="code" href="classCmd.html">Cmd</a> (pFB) { }
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">private</span>:
<a name="l00071"></a>00071 <a class="code" href="classFrameBuffer.html">FrameBuffer</a> _savePoint;
<a name="l00072"></a>00072 };
<a name="l00073"></a>00073
<a name="l00074"></a>00074
<a name="l00079"></a><a class="code" href="classSlowUndoSelectCmd.html">00079</a> <span class="keyword">class </span><a class="code" href="classSlowUndoSelectCmd.html">SlowUndoSelectCmd</a>: <span class="keyword">public</span> <a class="code" href="classCmd.html">Cmd</a> {
<a name="l00080"></a>00080 <span class="keyword">public</span>:
<a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classSlowUndoSelectCmd.html#302b2114591a5469e70c5b32225cd67e" title="Command execution. This should save undo informations.">exec</a> ();
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classSlowUndoSelectCmd.html#0d951b6cf06e450526173ecfe1c327cc" title="Revert command execution using undo informations.">unExec</a> ();
<a name="l00083"></a>00083 <span class="keyword">virtual</span> std::string <a class="code" href="classSlowUndoSelectCmd.html#ee3bd5a915a80da8d81d1e5934639ad2" title="Command identification. This will appear in config file.">name</a> () = 0;
<a name="l00084"></a>00084 <span class="keyword">virtual</span> std::string <a class="code" href="classSlowUndoSelectCmd.html#af48c2bf9ed3365817682dcf8594a550" title="Command export to text string. Needed for macro saving.">args</a> () = 0;
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keyword">protected</span>:
<a name="l00091"></a><a class="code" href="classSlowUndoSelectCmd.html#befc00f9c312b1767ed16388b3e8db3c">00091</a> <a class="code" href="classSlowUndoSelectCmd.html#befc00f9c312b1767ed16388b3e8db3c">SlowUndoSelectCmd</a> (<a class="code" href="classFrameBuffer.html">FrameBuffer</a> *pFB): <a class="code" href="classCmd.html">Cmd</a> (pFB) { }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keyword">private</span>:
<a name="l00094"></a>00094 <a class="code" href="structRect.html">Rect</a> _sa;
<a name="l00095"></a>00095 <a class="code" href="classFrameBuffer.html">FrameBuffer</a> _fbUndo;
<a name="l00096"></a>00096 };
<a name="l00097"></a>00097
<a name="l00101"></a><a class="code" href="classPluginCmd.html">00101</a> <span class="keyword">class </span><a class="code" href="classPluginCmd.html">PluginCmd</a>: <span class="keyword">public</span> <a class="code" href="classSlowUndoCmd.html">SlowUndoCmd</a> {
<a name="l00102"></a>00102 <span class="keyword">public</span>:
<a name="l00109"></a><a class="code" href="classPluginCmd.html#0d3c0616ff0e61f5a84b6c27bd12c8f0">00109</a> <a class="code" href="classPluginCmd.html#0d3c0616ff0e61f5a84b6c27bd12c8f0">PluginCmd</a> (<a class="code" href="classFrameBuffer.html">FrameBuffer</a> *pFB, std::string pluginName, std::string <a class="code" href="classPluginCmd.html#f7383a429feff3b9b70c1e6388c916db" title="Command export to text string. Needed for macro saving.">args</a>):
<a name="l00110"></a>00110 <a class="code" href="classSlowUndoCmd.html">SlowUndoCmd</a> (pFB),
<a name="l00111"></a>00111 _pluginName (pluginName),
<a name="l00112"></a>00112 _pluginArgs (args) { }
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPluginCmd.html#3642db0d31a13fc1e24c2f9a2d23c723" title="Save current frame buffer as undo information.">exec</a> ();
<a name="l00115"></a><a class="code" href="classPluginCmd.html#e98217cde41a539016104d5abbf2d1d1">00115</a> <span class="keyword">virtual</span> std::string <a class="code" href="classPluginCmd.html#e98217cde41a539016104d5abbf2d1d1" title="Command identification. This will appear in config file.">name</a> () { <span class="keywordflow">return</span> _pluginName; }
<a name="l00116"></a><a class="code" href="classPluginCmd.html#f7383a429feff3b9b70c1e6388c916db">00116</a> <span class="keyword">virtual</span> std::string <a class="code" href="classPluginCmd.html#f7383a429feff3b9b70c1e6388c916db" title="Command export to text string. Needed for macro saving.">args</a> () { <span class="keywordflow">return</span> _pluginArgs; }
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">private</span>:
<a name="l00119"></a>00119 std::string _pluginName;
<a name="l00120"></a>00120 std::string _pluginArgs;
<a name="l00121"></a>00121 };
<a name="l00122"></a>00122
<a name="l00126"></a><a class="code" href="classMacroCmd.html">00126</a> <span class="keyword">class </span><a class="code" href="classMacroCmd.html">MacroCmd</a>: <span class="keyword">public</span> <a class="code" href="classCmd.html">Cmd</a> {
<a name="l00127"></a>00127 <span class="keyword">public</span>:
<a name="l00132"></a><a class="code" href="classMacroCmd.html#dac5d6a2dab9c1d95f90e3b2574ba347">00132</a> <a class="code" href="classMacroCmd.html#dac5d6a2dab9c1d95f90e3b2574ba347">MacroCmd</a> (<a class="code" href="classFrameBuffer.html">FrameBuffer</a> *pFB): <a class="code" href="classCmd.html">Cmd</a> (pFB) { }
<a name="l00133"></a>00133
<a name="l00139"></a>00139 <a class="code" href="classMacroCmd.html#dac5d6a2dab9c1d95f90e3b2574ba347">MacroCmd</a> (<a class="code" href="classFrameBuffer.html">FrameBuffer</a> *pFB, std::string macName);
<a name="l00140"></a>00140
<a name="l00146"></a>00146 <a class="code" href="classMacroCmd.html">MacroCmd</a> &<a class="code" href="classMacroCmd.html#c91d5f35080377de63b6bd1fb24b4a9e">operator<< </a>(<a class="code" href="classCmd.html">Cmd</a> *pCmd);
<a name="l00147"></a>00147
<a name="l00152"></a>00152 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classMacroCmd.html#2e780443902b228549c4f2c3f969bb47">exec</a> ();
<a name="l00153"></a>00153
<a name="l00158"></a>00158 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classMacroCmd.html#5243047dbf5feae8aa69f71fbc727120">unExec</a> ();
<a name="l00159"></a>00159
<a name="l00160"></a><a class="code" href="classMacroCmd.html#1597e0e61789b0062fad21100d46a90f">00160</a> <span class="keyword">virtual</span> std::string <a class="code" href="classMacroCmd.html#1597e0e61789b0062fad21100d46a90f" title="Command identification. This will appear in config file.">name</a> () { <span class="keywordflow">return</span> <a class="code" href="classMacroCmd.html#3bb038007713095dc69a011072809a68" title="Command id string.">szCmdName</a>; }
<a name="l00161"></a><a class="code" href="classMacroCmd.html#345a33230b77a93b48a0a36a1288a08a">00161</a> <span class="keyword">virtual</span> std::string <a class="code" href="classMacroCmd.html#345a33230b77a93b48a0a36a1288a08a" title="Command export to text string. Needed for macro saving.">args</a> () { <span class="keywordflow">return</span> _macName; }
<a name="l00162"></a>00162
<a name="l00167"></a><a class="code" href="classMacroCmd.html#1f04523b1386aaa6d53af74f14328fd7">00167</a> <span class="keywordtype">void</span> <a class="code" href="classMacroCmd.html#1597e0e61789b0062fad21100d46a90f" title="Command identification. This will appear in config file.">name</a> (std::string <a class="code" href="classMacroCmd.html#1597e0e61789b0062fad21100d46a90f" title="Command identification. This will appear in config file.">name</a>) { _macName = name; }
<a name="l00168"></a>00168
<a name="l00172"></a>00172 <span class="keywordtype">void</span> <a class="code" href="classMacroCmd.html#9284eeabaa4d212251351f5bec189bd2">save</a> ();
<a name="l00173"></a>00173
<a name="l00174"></a><a class="code" href="classMacroCmd.html#3bb038007713095dc69a011072809a68">00174</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classMacroCmd.html#3bb038007713095dc69a011072809a68" title="Command id string.">szCmdName</a>;
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="keyword">private</span>:
<a name="l00177"></a>00177 <span class="keywordtype">void</span> addFromConf (<a class="code" href="classGedMacroCommand.html">GedMacroCommand</a> &);
<a name="l00178"></a>00178 <span class="keywordtype">void</span> addToConf (<a class="code" href="classCmd.html">Cmd</a> *);
<a name="l00179"></a>00179
<a name="l00180"></a>00180 std::list<Cmd *> _cmdList;
<a name="l00181"></a>00181 std::list<Cmd *>::iterator _crashPoint;
<a name="l00182"></a>00182 std::string _macName;
<a name="l00183"></a>00183 };
<a name="l00184"></a>00184
<a name="l00188"></a><a class="code" href="classCmdHistory.html">00188</a> <span class="keyword">class </span><a class="code" href="classCmdHistory.html">CmdHistory</a> {
<a name="l00189"></a>00189 <span class="keyword">public</span>:
<a name="l00190"></a>00190 <a class="code" href="classCmdHistory.html#0ff3780a236036b62d74a55f56234397">CmdHistory</a> ();
<a name="l00191"></a>00191 <a class="code" href="classCmdHistory.html#75508123c5b627f019e37343127eeecb">~CmdHistory</a> ();
<a name="l00192"></a>00192
<a name="l00199"></a>00199 <a class="code" href="classCmdHistory.html">CmdHistory</a> &<a class="code" href="classCmdHistory.html#844f048ae189e30c90ca21ba4cd5da31">operator<< </a>(<a class="code" href="classCmd.html">Cmd</a> *pCmd);
<a name="l00200"></a>00200
<a name="l00201"></a>00201 <span class="keywordtype">int</span> <a class="code" href="classCmdHistory.html#3d5f984db47cc4c8a8e2caa15b9084c9" title="How many undo step is available.">undoAvailable</a> () <span class="keyword">const</span>;
<a name="l00202"></a>00202 <span class="keywordtype">bool</span> <a class="code" href="classCmdHistory.html#8ebe7942aa611531bd2d135b93cf62e7" title="True if undo is possible.">canUndo</a> () <span class="keyword">const</span>;
<a name="l00203"></a>00203 <span class="keywordtype">bool</span> <a class="code" href="classCmdHistory.html#6dbf1374dd49e57e5f50ef5174d9ee73" title="True if redo is possible.">canRedo</a> () <span class="keyword">const</span>;
<a name="l00204"></a>00204
<a name="l00205"></a>00205 <span class="keywordtype">void</span> <a class="code" href="classCmdHistory.html#48b03dc159c0c16ef83f4198e4c8bc17" title="Cancel last operation. Needed if command crashes during execution.">rollBack</a> ();
<a name="l00206"></a>00206 <span class="keywordtype">void</span> <a class="code" href="classCmdHistory.html#5445c7f33cd26252ce7568ffb56e6efc" title="Undo last command.">undo</a> ();
<a name="l00207"></a>00207 <span class="keywordtype">void</span> <a class="code" href="classCmdHistory.html#1eb01397ee525b6be9c76816cf5eec2f" title="Undo last undo.">redo</a> ();
<a name="l00208"></a>00208
<a name="l00209"></a>00209 <span class="keywordtype">bool</span> <a class="code" href="classCmdHistory.html#700190c397fa362ade32bddb6f20355c" title="True if image has changed since last saving.">needSave</a> ();
<a name="l00210"></a>00210 <span class="keywordtype">void</span> <a class="code" href="classCmdHistory.html#269dde96f66aa615b0859dbe337c45bb" title="May be called when document is saved.">setSaved</a> ();
<a name="l00211"></a>00211
<a name="l00215"></a>00215 <span class="keywordtype">void</span> <a class="code" href="classCmdHistory.html#3c648f427ddccf276cfbbf2729fa6feb">startMacro</a> ();
<a name="l00216"></a>00216
<a name="l00221"></a>00221 <a class="code" href="classMacroCmd.html">MacroCmd</a> *<a class="code" href="classCmdHistory.html#b98b578ee178aa7d3118a75e88da1ff7">createMacroCmd</a> ();
<a name="l00222"></a>00222
<a name="l00227"></a><a class="code" href="classCmdHistory_1_1ErrUnderflow.html">00227</a> <span class="keyword">class </span><a class="code" href="classCmdHistory_1_1ErrUnderflow.html">ErrUnderflow</a> { };
<a name="l00228"></a>00228
<a name="l00229"></a>00229 <span class="keyword">private</span>:
<a name="l00230"></a>00230 std::list<Cmd *> _histList;
<a name="l00231"></a>00231 std::list<Cmd *>::iterator _now;
<a name="l00232"></a>00232 <span class="keywordtype">int</span> _iMacroOffset;
<a name="l00233"></a>00233 <span class="keywordtype">int</span> _iLastSave;
<a name="l00234"></a>00234 <span class="keywordtype">bool</span> _bSavePointLost;
<a name="l00235"></a>00235 <span class="keywordtype">bool</span> _bMacroLoading;
<a name="l00236"></a>00236 };
<a name="l00237"></a>00237
<a name="l00238"></a>00238 <span class="preprocessor">#endif</span>
</pre></div><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
command_8h-source.html [Download]