docs/latex/wx/cmdproc.tex

   1 \section{\class{wxCommandProcessor}}\label{wxcommandprocessor}
   2
   3 wxCommandProcessor is a class that maintains a history of wxCommands,
   4 with undo/redo functionality built-in. Derive a new class from this
   5 if you want different behaviour.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxObject}{wxobject}
  10
  11 \wxheading{Include files}
  12
  13 <wx/docview.h>
  14
  15 \wxheading{See also}
  16
  17 \helpref{wxCommandProcessor overview}{wxcommandprocessoroverview}, \helpref{wxCommand}{wxcommand}
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21 \membersection{wxCommandProcessor::wxCommandProcessor}
  22
  23 \func{}{wxCommandProcessor}{\param{int}{ maxCommands = 100}}
  24
  25 Constructor.
  26
  27 {\it maxCommands} defaults to a rather arbitrary 100, but can be set from 1 to any integer.
  28 If your wxCommand classes store a lot of data, you may wish the limit the number of
  29 commands stored to a smaller number.
  30
  31 \membersection{wxCommandProcessor::\destruct{wxCommandProcessor}}
  32
  33 \func{}{\destruct{wxCommandProcessor}}{\void}
  34
  35 Destructor.
  36
  37 \membersection{wxCommandProcessor::CanUndo}
  38
  39 \func{virtual bool}{CanUndo}{\void}
  40
  41 Returns TRUE if the currently-active command can be undone, FALSE otherwise.
  42
  43 \membersection{wxCommandProcessor::ClearCommands}
  44
  45 \func{virtual void}{ClearCommands}{\void}
  46
  47 Deletes all the commands in the list and sets the current command pointer to NULL.
  48
  49 \membersection{wxCommandProcessor::Do}
  50
  51 \func{virtual bool}{Do}{\void}
  52
  53 Executes (redoes) the current command (the command that has just been undone if any).
  54
  55 \membersection{wxCommandProcessor::GetCommands}
  56
  57 \constfunc{wxList\&}{GetCommands}{\void}
  58
  59 Returns the list of commands.
  60
  61 \membersection{wxCommandProcessor::GetMaxCommands}
  62
  63 \constfunc{int}{GetMaxCommands}{\void}
  64
  65 Returns the maximum number of commands that the command processor stores.
  66
  67 \membersection{wxCommandProcessor::GetEditMenu}
  68
  69 \constfunc{wxMenu*}{GetEditMenu}{\void}
  70
  71 Returns the edit menu associated with the command processor.
  72
  73 \membersection{wxCommandProcessor::Initialize}
  74
  75 \func{virtual void}{Initialize}{\void}
  76
  77 Initializes the command processor, setting the current command to the
  78 last in the list (if any), and updating the edit menu (if one has been
  79 specified).
  80
  81 \membersection{wxCommandProcessor::SetEditMenu}
  82
  83 \func{void}{SetEditMenu}{\param{wxMenu* }{menu}}
  84
  85 Tells the command processor to update the Undo and Redo items on this
  86 menu as appropriate. Set this to NULL if the menu is about to be
  87 destroyed and command operations may still be performed, or the command
  88 processor may try to access an invalid pointer.
  89
  90 \membersection{wxCommandProcessor::Submit}
  91
  92 \func{virtual bool}{Submit}{\param{wxCommand *}{command}, \param{bool}{ storeIt = TRUE}}
  93
  94 Submits a new command to the command processor. The command processor
  95 calls wxCommand::Do to execute the command; if it succeeds, the command
  96 is stored in the history list, and the associated edit menu (if any) updated
  97 appropriately. If it fails, the command is deleted
  98 immediately. Once Submit has been called, the passed command should not
  99 be deleted directly by the application.
 100
 101 {\it storeIt} indicates whether the successful command should be stored
 102 in the history list.
 103
 104 \membersection{wxCommandProcessor::Undo}
 105
 106 \func{virtual bool}{Undo}{\void}
 107
 108 Undoes the command just executed.
 109
 110