// Purpose: interface of wxCommandProcessor and wxCommand
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
know the ordering of Undos; the user can never Undo at an arbitrary
position in the command history.
- Restore the entire document state (perhaps using document
- transactioning). Potentially very inefficient, but possibly easier to
+ transacting). Potentially very inefficient, but possibly easier to
code if the user interface and data are complex, and an "inverse
execute" operation is hard to write. The docview sample uses the
first method, to remove or restore segments in the drawing.
*/
virtual bool CanUndo() const;
+ /**
+ Returns @true if the currently-active command can be redone, @false
+ otherwise.
+ */
+ virtual bool CanRedo() const;
+
/**
Deletes all commands in the list and sets the current command pointer
to @NULL.
*/
wxList& GetCommands();
+ /**
+ Returns the current command.
+ */
+ wxCommand *GetCurrentCommand() const;
+
/**
Returns the edit menu associated with the command processor.
*/
void SetUndoAccelerator(const wxString& accel);
/**
- Submits a new command to the command processor. The command processor
- calls wxCommand::Do() to execute the command; if it succeeds, the
- command is stored in the history list, and the associated edit menu (if
- any) updated appropriately. If it fails, the command is deleted
- immediately. Once Submit() has been called, the passed command should
- not be deleted directly by the application.
+ Submits a new command to the command processor.
+
+ The command processor calls wxCommand::Do() to execute the command;
+ if it succeeds, the command is stored in the history list, and the
+ associated edit menu (if any) updated appropriately.
+ If it fails, the command is deleted immediately. Once Submit() has been
+ called, the passed command should not be deleted directly by the application.
+ @param command
+ The command to submit
@param storeIt
Indicates whether the successful command should be stored in the
history list.
*/
virtual bool Submit(wxCommand* command, bool storeIt = true);
+ /**
+ Just store the command without executing it. The command is stored in the
+ history list, and the associated edit menu (if any) updated appropriately.
+ */
+ virtual void Store(wxCommand *command);
+
/**
Undoes the last command executed.
*/