FX::FXCommand Class Reference

Base class for undoable commands. More...

#include <FXUndoList.h>

Inheritance diagram for FX::FXCommand:

List of all members.

Public Member Functions
virtual void	undo ()=0
	Undo this command; this should save the information for a subsequent redo.
virtual void	redo ()=0
	Redo this command; this should save the information for a subsequent undo.
virtual FXuint	size () const
	Return the size of the information in the undo record.
virtual FXString	undoName () const
	Name of the undo command to be shown on a button; for example, "Undo Delete".
virtual FXString	redoName () const
	Name of the redo command to be shown on a button; for example, "Redo Delete".
virtual FXbool	canMerge () const
	Return true if this command can be merged with previous undo commands.
virtual FXbool	mergeWith (FXCommand *command)
	Called by the undo system to try and merge the new incoming command with this command; should return true if merging was possible.
virtual	~FXCommand ()
	Delete undo command.
Friends
class	FXUndoList
class	FXCommandGroup

---

Detailed Description

Base class for undoable commands.

Each undo records all the information necessary to undo as well as redo a given operation. Since commands are derived from FXObject, subclassed commands can both send and receive messages (like ID_GETINTVALUE, for example).

---

Member Function Documentation

virtual FXbool FX::FXCommand::canMerge

(

)

const [virtual]

Return true if this command can be merged with previous undo commands.

This is useful to combine e.g. multiple consecutive single-character text changes into a single block change. The default implementation returns false.

virtual FXbool FX::FXCommand::mergeWith

(

FXCommand *

command

)

[virtual]

Called by the undo system to try and merge the new incoming command with this command; should return true if merging was possible.

The default implementation returns false.

virtual FXuint FX::FXCommand::size

(

)

const [virtual]

Return the size of the information in the undo record.

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.

Reimplemented in FX::FXCommandGroup, and FX::FXUndoList.

---

The documentation for this class was generated from the following file:

• /home/jeroen/FOX/fox/fox-1.7.32/include/FXUndoList.h