<html>
<head>
<link rel="stylesheet" href="page.css" type="text/css">
<title>fox-toolkit.org - Documentation</title>
</head>
<body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000>
<font face='verdana,sans-serif' size=2 >
<!---- TOPIC TITLE WITH LOGO--->
<table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a>
<br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table>
<p>
<!--- TOPIC TITLE WITH LOGO --->
<!-- Generated by Doxygen 1.3.3 -->
<h1>FXUndoList.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* U n d o / R e d o - a b l e C o m m a n d *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 2000,2004 by Jeroen van der Zijp. All Rights Reserved. *</span>
00007 <span class="comment">*********************************************************************************</span>
00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span>
00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span>
00010 <span class="comment">* License as published by the Free Software Foundation; either *</span>
00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span>
00012 <span class="comment">* *</span>
00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span>
00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
00016 <span class="comment">* Lesser General Public License for more details. *</span>
00017 <span class="comment">* *</span>
00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span>
00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span>
00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span>
00021 <span class="comment">*********************************************************************************</span>
00022 <span class="comment">* $Id: FXUndoList.h,v 1.33 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXUNDOLIST_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXUNDOLIST_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXOBJECT_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXObject.h"</span>
00029 <span class="preprocessor">#endif</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>FX {
00032
00033
00034 <span class="keyword">class </span>FXUndoList;
00035 <span class="keyword">class </span>FXCommandGroup;
00036
00037 <span class="comment"></span>
00038 <span class="comment">/**</span>
00039 <span class="comment">* Base class for undoable commands. Each undo records all the</span>
00040 <span class="comment">* information necessary to undo as well as redo a given operation.</span>
00041 <span class="comment">* Since commands are derived from FXObject, subclassed commands can</span>
00042 <span class="comment">* both send and receive messages (like ID_GETINTVALUE, for example).</span>
00043 <span class="comment">*/</span>
<a name="l00044"></a><a class="code" href="classFX_1_1FXCommand.html">00044</a> <span class="keyword">class </span>FXAPI FXCommand : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXObject.html">FXObject</a> {
00045 FXDECLARE_ABSTRACT(FXCommand)
00046 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXUndoList.html">FXUndoList</a>;
00047 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXCommandGroup.html">FXCommandGroup</a>;
00048 <span class="keyword">private</span>:
00049 FXCommand *next;
00050 <span class="keyword">private</span>:
00051 FXCommand(<span class="keyword">const</span> FXCommand&);
00052 FXCommand &operator=(<span class="keyword">const</span> FXCommand&);
00053 <span class="keyword">protected</span>:
00054 FXCommand():next(NULL){}
00055 <span class="keyword">public</span>:
00056 <span class="comment"></span>
00057 <span class="comment"> /**</span>
00058 <span class="comment"> * Undo this command; this should save the</span>
00059 <span class="comment"> * information for a subsequent redo.</span>
00060 <span class="comment"> */</span>
00061 <span class="keyword">virtual</span> <span class="keywordtype">void</span> undo() = 0;
00062 <span class="comment"></span>
00063 <span class="comment"> /**</span>
00064 <span class="comment"> * Redo this command; this should save the</span>
00065 <span class="comment"> * information for a subsequent undo.</span>
00066 <span class="comment"> */</span>
00067 <span class="keyword">virtual</span> <span class="keywordtype">void</span> redo() = 0;
00068 <span class="comment"></span>
00069 <span class="comment"> /**</span>
00070 <span class="comment"> * Return the size of the information in the undo record.</span>
00071 <span class="comment"> * The undo list may be trimmed to limit memory usage to</span>
00072 <span class="comment"> * a certain limit. The value returned should include</span>
00073 <span class="comment"> * the size of the command record itself as well as any</span>
00074 <span class="comment"> * data linked from it.</span>
00075 <span class="comment"> */</span>
00076 <span class="keyword">virtual</span> FXuint size() <span class="keyword">const</span>;
00077 <span class="comment"></span>
00078 <span class="comment"> /**</span>
00079 <span class="comment"> * Name of the undo command to be shown on a button;</span>
00080 <span class="comment"> * for example, "Undo Delete".</span>
00081 <span class="comment"> */</span>
00082 <span class="keyword">virtual</span> <a class="code" href="classFX_1_1FXString.html">FXString</a> undoName() <span class="keyword">const</span>;
00083 <span class="comment"></span>
<a name="l00084"></a><a class="code" href="classFX_1_1FXCommand.html#a5">00084</a> <span class="comment"> /**</span>
00085 <span class="comment"> * Name of the redo command to be shown on a button;</span>
00086 <span class="comment"> * for example, "Redo Delete".</span>
00087 <span class="comment"> */</span>
00088 <span class="keyword">virtual</span> <a class="code" href="classFX_1_1FXString.html">FXString</a> redoName() <span class="keyword">const</span>;
00089 <span class="comment"></span>
00090 <span class="comment"> /// Delete undo command</span>
00091 <span class="comment"></span> <span class="keyword">virtual</span> ~FXCommand(){}
00092 };
00093
00094
<a name="l00095"></a><a class="code" href="classFX_1_1FXCommandGroup.html">00095</a> <span class="comment"></span>
00096 <span class="comment">/**</span>
00097 <span class="comment">* Group of undoable commands. A group may comprise multiple</span>
00098 <span class="comment">* individual actions which together undo (or redo) a larger</span>
00099 <span class="comment">* operation. Even larger operations may be built by nesting</span>
00100 <span class="comment">* multiple undo groups.</span>
<a name="l00101"></a><a class="code" href="classFX_1_1FXCommandGroup.html#a0">00101</a> <span class="comment">*/</span>
00102 <span class="keyword">class </span>FXAPI FXCommandGroup : <span class="keyword">public</span> FXCommand {
00103 FXDECLARE(FXCommandGroup)
<a name="l00104"></a><a class="code" href="classFX_1_1FXCommandGroup.html#a1">00104</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFX_1_1FXUndoList.html">FXUndoList</a>;
00105 <span class="keyword">private</span>:
00106 FXCommand *undolist;
00107 FXCommand *redolist;
00108 FXCommandGroup *group;
00109 <span class="keyword">private</span>:
00110 FXCommandGroup(<span class="keyword">const</span> FXCommandGroup&);
00111 FXCommandGroup &operator=(<span class="keyword">const</span> FXCommandGroup&);
00112 <span class="keyword">public</span>:
00113 <span class="comment"></span>
00114 <span class="comment"> /// Construct initially empty undo command group</span>
00115 <span class="comment"></span> FXCommandGroup():undolist(NULL),redolist(NULL),group(NULL){}
00116 <span class="comment"></span>
00117 <span class="comment"> /// Return TRUE if empty</span>
00118 <span class="comment"></span> FXbool empty(){ <span class="keywordflow">return</span> !undolist; }
00119 <span class="comment"></span>
00120 <span class="comment"> /// Undo whole command group</span>
00121 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> undo();
00122 <span class="comment"></span>
00123 <span class="comment"> /// Redo whole command group</span>
<a name="l00124"></a><a class="code" href="classFX_1_1FXUndoList.html">00124</a> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> redo();
00125 <span class="comment"></span>
00126 <span class="comment"> /// Return the size of the command group</span>
00127 <span class="comment"></span> <span class="keyword">virtual</span> FXuint size() <span class="keyword">const</span>;
00128 <span class="comment"></span>
00129 <span class="comment"> /// Delete undo command and sub-commands</span>
00130 <span class="comment"></span> <span class="keyword">virtual</span> ~FXCommandGroup();
00131 };
00132
00133
00134 <span class="comment"></span>
00135 <span class="comment">/**</span>
00136 <span class="comment">* The Undo List class manages a list of undoable commands.</span>
00137 <span class="comment">*/</span>
00138 <span class="keyword">class </span>FXAPI FXUndoList : <span class="keyword">public</span> FXCommandGroup {
00139 FXDECLARE(FXUndoList)
00140 <span class="keyword">private</span>:
00141 FXint undocount; <span class="comment">// Number of undo records</span>
00142 FXint redocount; <span class="comment">// Number of redo records</span>
00143 FXint marker; <span class="comment">// Marker value</span>
00144 FXuint space; <span class="comment">// Space taken up by all the undo records</span>
00145 FXbool working; <span class="comment">// Currently busy with undo or redo</span>
00146 <span class="keyword">private</span>:
00147 FXUndoList(<span class="keyword">const</span> FXUndoList&);
00148 FXUndoList &operator=(<span class="keyword">const</span> FXUndoList&);
00149 <span class="keyword">public</span>:
00150 <span class="keywordtype">long</span> onCmdUndo(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00151 <span class="keywordtype">long</span> onUpdUndo(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00152 <span class="keywordtype">long</span> onCmdRedo(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00153 <span class="keywordtype">long</span> onUpdRedo(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00154 <span class="keywordtype">long</span> onCmdClear(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00155 <span class="keywordtype">long</span> onUpdClear(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00156 <span class="keywordtype">long</span> onCmdRevert(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00157 <span class="keywordtype">long</span> onUpdRevert(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00158 <span class="keywordtype">long</span> onCmdUndoAll(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00159 <span class="keywordtype">long</span> onCmdRedoAll(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00160 <span class="keywordtype">long</span> onUpdUndoCount(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00161 <span class="keywordtype">long</span> onUpdRedoCount(FXObject*,FXSelector,<span class="keywordtype">void</span>*);
00162 <span class="keyword">public</span>:
00163 <span class="keyword">enum</span>{
00164 ID_CLEAR=FXWindow::ID_LAST,
00165 ID_REVERT,
00166 ID_UNDO,
00167 ID_REDO,
00168 ID_UNDO_ALL,
00169 ID_REDO_ALL,
00170 ID_UNDO_COUNT,
00171 ID_REDO_COUNT,
00172 ID_LAST
00173 };
00174 <span class="keyword">public</span>:
00175 <span class="comment"></span>
00176 <span class="comment"> /**</span>
00177 <span class="comment"> * Make new empty undo list, initially unmarked.</span>
00178 <span class="comment"> */</span>
00179 FXUndoList();
00180 <span class="comment"></span>
00181 <span class="comment"> /**</span>
00182 <span class="comment"> * Cut the redo list.</span>
00183 <span class="comment"> * This is automatically invoked when a new undo command is added.</span>
00184 <span class="comment"> */</span>
00185 <span class="keywordtype">void</span> cut();
00186 <span class="comment"></span>
00187 <span class="comment"> /**</span>
00188 <span class="comment"> * Add new command, executing it if desired. The new command</span>
00189 <span class="comment"> * will be appended after the last undo command. All redo commands</span>
00190 <span class="comment"> * will be deleted.</span>
00191 <span class="comment"> */</span>
00192 <span class="keywordtype">void</span> add(FXCommand* command,FXbool doit=FALSE);
00193 <span class="comment"></span>
00194 <span class="comment"> /**</span>
00195 <span class="comment"> * Begin undo command sub-group. This begins a new group of commands that</span>
00196 <span class="comment"> * are treated as a single command. Must eventually be followed by a</span>
00197 <span class="comment"> * matching end() after recording the sub-commands. The new sub-group</span>
00198 <span class="comment"> * will be appended to its parent group's undo list when end() is called.</span>
00199 <span class="comment"> */</span>
00200 <span class="keywordtype">void</span> begin(FXCommandGroup *command);
00201 <span class="comment"></span>
00202 <span class="comment"> /**</span>
00203 <span class="comment"> * End undo command sub-group. If the sub-group is still empty, it will</span>
00204 <span class="comment"> * be deleted; otherwise, the sub-group will be added as a new command</span>
00205 <span class="comment"> * into parent group.</span>
00206 <span class="comment"> * A matching begin() must have been called previously.</span>
00207 <span class="comment"> */</span>
00208 <span class="keywordtype">void</span> end();
00209 <span class="comment"></span>
00210 <span class="comment"> /**</span>
00211 <span class="comment"> * Abort the current command sub-group being compiled. All commands</span>
00212 <span class="comment"> * already added to the sub-groups undo list will be discarded.</span>
00213 <span class="comment"> * Intermediate command groups will be left intact.</span>
00214 <span class="comment"> */</span>
00215 <span class="keywordtype">void</span> abort();
00216 <span class="comment"></span>
00217 <span class="comment"> /**</span>
00218 <span class="comment"> * Undo last command. This will move the command to the redo list.</span>
00219 <span class="comment"> */</span>
00220 <span class="keyword">virtual</span> <span class="keywordtype">void</span> undo();
00221 <span class="comment"></span>
00222 <span class="comment"> /**</span>
00223 <span class="comment"> * Redo next command. This will move the command back to the undo list.</span>
00224 <span class="comment"> */</span>
00225 <span class="keyword">virtual</span> <span class="keywordtype">void</span> redo();
00226 <span class="comment"></span>
<a name="l00227"></a><a class="code" href="classFX_1_1FXUndoList.html#a14">00227</a> <span class="comment"> /// Undo all commands</span>
00228 <span class="comment"></span> <span class="keywordtype">void</span> undoAll();
00229 <span class="comment"></span>
<a name="l00230"></a><a class="code" href="classFX_1_1FXUndoList.html#a15">00230</a> <span class="comment"> /// Redo all commands</span>
00231 <span class="comment"></span> <span class="keywordtype">void</span> redoAll();
00232 <span class="comment"></span>
00233 <span class="comment"> /// Revert to marked</span>
00234 <span class="comment"></span> <span class="keywordtype">void</span> revert();
00235 <span class="comment"></span>
00236 <span class="comment"> /// Can we undo more commands</span>
00237 <span class="comment"></span> FXbool canUndo() <span class="keyword">const</span>;
00238 <span class="comment"></span>
00239 <span class="comment"> /// Can we redo more commands</span>
00240 <span class="comment"></span> FXbool canRedo() <span class="keyword">const</span>;
00241 <span class="comment"></span>
00242 <span class="comment"> /// Can revert to marked</span>
00243 <span class="comment"></span> FXbool canRevert() <span class="keyword">const</span>;
00244 <span class="comment"></span>
<a name="l00245"></a><a class="code" href="classFX_1_1FXUndoList.html#a18">00245</a> <span class="comment"> /**</span>
00246 <span class="comment"> * Return TRUE if currently inside undo or redo operation; this</span>
00247 <span class="comment"> * is useful to avoid generating another undo command while inside</span>
<a name="l00248"></a><a class="code" href="classFX_1_1FXUndoList.html#a19">00248</a> <span class="comment"> * an undo operation.</span>
00249 <span class="comment"> */</span>
00250 FXbool busy()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> working; }
00251 <span class="comment"></span>
00252 <span class="comment"> /// Current top level undo command</span>
00253 <span class="comment"></span> FXCommand* current()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> undolist; }
00254 <span class="comment"></span>
00255 <span class="comment"> /**</span>
00256 <span class="comment"> * Return name of the first undo command available; if no</span>
00257 <span class="comment"> * undo command available this will return the empty string.</span>
00258 <span class="comment"> */</span>
00259 <span class="keyword">virtual</span> FXString undoName() <span class="keyword">const</span>;
00260 <span class="comment"></span>
00261 <span class="comment"> /**</span>
00262 <span class="comment"> * Return name of the first redo command available; if no</span>
00263 <span class="comment"> * Redo command available this will return the empty string.</span>
00264 <span class="comment"> */</span>
00265 <span class="keyword">virtual</span> FXString redoName() <span class="keyword">const</span>;
00266 <span class="comment"></span>
00267 <span class="comment"> /// Number of undo records</span>
00268 <span class="comment"></span> FXint undoCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> undocount; }
00269 <span class="comment"></span>
00270 <span class="comment"> /// Number of redo records</span>
00271 <span class="comment"></span> FXint redoCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> redocount; }
00272 <span class="comment"></span>
00273 <span class="comment"> /// Size of undo information</span>
00274 <span class="comment"></span> <span class="keyword">virtual</span> FXuint size() <span class="keyword">const</span>;
00275 <span class="comment"></span>
00276 <span class="comment"> /**</span>
00277 <span class="comment"> * Clear list, and unmark all states.</span>
00278 <span class="comment"> * All undo and redo information will be destroyed.</span>
00279 <span class="comment"> */</span>
00280 <span class="keywordtype">void</span> clear();
00281 <span class="comment"></span>
00282 <span class="comment"> /**</span>
00283 <span class="comment"> * Trim undo list down to at most nc commands.</span>
00284 <span class="comment"> * Call this periodically to prevent the undo-list from growing</span>
00285 <span class="comment"> * beyond a certain number of records.</span>
00286 <span class="comment"> */</span>
00287 <span class="keywordtype">void</span> trimCount(FXint nc);
00288 <span class="comment"></span>
00289 <span class="comment"> /**</span>
00290 <span class="comment"> * Trim undo list down to at most size sz.</span>
00291 <span class="comment"> * Call this periodically to prevent the undo-list from growing</span>
00292 <span class="comment"> * beyond a certain amount of memory.</span>
00293 <span class="comment"> */</span>
00294 <span class="keywordtype">void</span> trimSize(FXuint sz);
00295 <span class="comment"></span>
00296 <span class="comment"> /**</span>
00297 <span class="comment"> * Mark the current state of the undo list, which is initially unmarked.</span>
00298 <span class="comment"> * There can be only one active mark at any time. Call mark() at any</span>
00299 <span class="comment"> * time when you know the document to be "clean"; for example when you</span>
00300 <span class="comment"> * save the document to disk.</span>
00301 <span class="comment"> */</span>
00302 <span class="keywordtype">void</span> mark();
00303 <span class="comment"></span>
00304 <span class="comment"> /**</span>
00305 <span class="comment"> * Unmark all states in the undo list.</span>
00306 <span class="comment"> */</span>
00307 <span class="keywordtype">void</span> unmark();
00308 <span class="comment"></span>
00309 <span class="comment"> /**</span>
00310 <span class="comment"> * Check if the current state was marked, if the application has returned</span>
00311 <span class="comment"> * to the previously marked state.</span>
00312 <span class="comment"> */</span>
00313 FXbool marked() <span class="keyword">const</span>;
00314 };
00315
00316
00317 }
00318
00319 <span class="preprocessor">#endif</span>
</pre></div></font>
<!--- COPYRIGHT -->
<p>
<table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right>
<img src='../art/line.gif' width=100% height=1><font size=-1>
Copyright © 1997-2004 Jeroen van der Zijp</font>
</td></tr></table>
</p>
<!--- COPYRIGHT -->
</body>
</html>
