<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>FX::FXCommand Class Reference</h1>Base class for undoable commands.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="FXUndoList_8h-source.html">FXUndoList.h</a>></code>
<p>
<p>Inheritance diagram for FX::FXCommand:
<p><center><img src="classFX_1_1FXCommand.png" usemap="#FX::FXCommand_map" border="0" alt=""></center>
<map name="FX::FXCommand_map">
<area href="classFX_1_1FXObject.html" alt="FX::FXObject" shape="rect" coords="0,0,142,24">
<area href="classFX_1_1FXCommandGroup.html" alt="FX::FXCommandGroup" shape="rect" coords="0,112,142,136">
<area href="classFX_1_1FXUndoList.html" alt="FX::FXUndoList" shape="rect" coords="0,168,142,192">
</map>
<a href="classFX_1_1FXCommand-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>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCommand.html#a0">undo</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCommand.html#a1">redo</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual FXuint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCommand.html#a2">size</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classFX_1_1FXString.html">FXString</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCommand.html#a3">undoName</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classFX_1_1FXString.html">FXString</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCommand.html#a4">redoName</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCommand.html#a5">~FXCommand</a> ()</td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="n0" doxytag="FX::FXCommand::FXUndoList"></a>
class </td><td class="memItemRight" valign=bottom><b>FXUndoList</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="n1" doxytag="FX::FXCommand::FXCommandGroup"></a>
class </td><td class="memItemRight" valign=bottom><b>FXCommandGroup</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for undoable commands.
<p>
Each undo records all the information necessary to undo as well as redo a given operation. Since commands are derived from <a class="el" href="classFX_1_1FXObject.html">FXObject</a>, subclassed commands can both send and receive messages (like ID_GETINTVALUE, for example).
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a5" doxytag="FX::FXCommand::~FXCommand"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual FX::FXCommand::~<a class="el" href="classFX_1_1FXCommand.html">FXCommand</a> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Delete undo command.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a0" doxytag="FX::FXCommand::undo"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void FX::FXCommand::undo </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Undo this command; this should save the information for a subsequent redo.
<p>
<p>
Implemented in <a class="el" href="classFX_1_1FXCommandGroup.html#a2">FX::FXCommandGroup</a>, and <a class="el" href="classFX_1_1FXUndoList.html#a6">FX::FXUndoList</a>. </td>
</tr>
</table>
<a name="a1" doxytag="FX::FXCommand::redo"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void FX::FXCommand::redo </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Redo this command; this should save the information for a subsequent undo.
<p>
<p>
Implemented in <a class="el" href="classFX_1_1FXCommandGroup.html#a3">FX::FXCommandGroup</a>, and <a class="el" href="classFX_1_1FXUndoList.html#a7">FX::FXUndoList</a>. </td>
</tr>
</table>
<a name="a2" doxytag="FX::FXCommand::size"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual FXuint FX::FXCommand::size </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the size of the information in the undo record.
<p>
The undo list may be trimmed to limit memory usage to a certain limit. The value returned should include the size of the command record itself as well as any data linked from it.
<p>
Reimplemented in <a class="el" href="classFX_1_1FXCommandGroup.html#a4">FX::FXCommandGroup</a>, and <a class="el" href="classFX_1_1FXUndoList.html#a20">FX::FXUndoList</a>. </td>
</tr>
</table>
<a name="a3" doxytag="FX::FXCommand::undoName"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classFX_1_1FXString.html">FXString</a> FX::FXCommand::undoName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Name of the undo command to be shown on a button; for example, "Undo Delete".
<p>
<p>
Reimplemented in <a class="el" href="classFX_1_1FXUndoList.html#a16">FX::FXUndoList</a>. </td>
</tr>
</table>
<a name="a4" doxytag="FX::FXCommand::redoName"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classFX_1_1FXString.html">FXString</a> FX::FXCommand::redoName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Name of the redo command to be shown on a button; for example, "Redo Delete".
<p>
<p>
Reimplemented in <a class="el" href="classFX_1_1FXUndoList.html#a17">FX::FXUndoList</a>. </td>
</tr>
</table>
</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>
