[wxWidgets.git] / docs / latex / wx / cmdproc.tex

\section{\class{wxCommandProcessor}}\label{wxcommandprocessor}

wxCommandProcessor is a class that maintains a history of wxCommands,
with undo/redo functionality built-in. Derive a new class from this
if you want different behaviour.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/cmdproc.h>

\wxheading{See also}

\helpref{wxCommandProcessor overview}{wxcommandprocessoroverview}, \helpref{wxCommand}{wxcommand}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxCommandProcessor::wxCommandProcessor}

\func{}{wxCommandProcessor}{\param{int}{ maxCommands = $-1$}}

Constructor.

{\it maxCommands} may be set to a positive integer to limit the number of
commands stored to it, otherwise (and by default) the list of commands can grow
arbitrarily.

\membersection{wxCommandProcessor::\destruct{wxCommandProcessor}}

\func{}{\destruct{wxCommandProcessor}}{\void}

Destructor.

\membersection{wxCommandProcessor::CanUndo}

\func{virtual bool}{CanUndo}{\void}

Returns true if the currently-active command can be undone, false otherwise.

\membersection{wxCommandProcessor::ClearCommands}

\func{virtual void}{ClearCommands}{\void}

Deletes all the commands in the list and sets the current command pointer to NULL.

\membersection{wxCommandProcessor::Redo}

\func{virtual bool}{Redo}{\void}

Executes (redoes) the current command (the command that has just been undone if any).

\membersection{wxCommandProcessor::GetCommands}

\constfunc{wxList\&}{GetCommands}{\void}

Returns the list of commands.

\membersection{wxCommandProcessor::GetMaxCommands}

\constfunc{int}{GetMaxCommands}{\void}

Returns the maximum number of commands that the command processor stores.

\membersection{wxCommandProcessor::GetEditMenu}

\constfunc{wxMenu*}{GetEditMenu}{\void}

Returns the edit menu associated with the command processor.

\membersection{wxCommandProcessor::GetRedoAccelerator}\label{wxcommandprocessorgetredoaccelerator}

\constfunc{const wxString\&}{GetRedoAccelerator}{\void}

Returns the string that will be appended to the Redo menu item.

\membersection{wxCommandProcessor::GetRedoMenuLabel}\label{wxcommandprocessorgetredomenulabel}

\constfunc{wxString}{GetRedoMenuLabel}{\void}

Returns the string that will be shown for the redo menu item.

\membersection{wxCommandProcessor::GetUndoAccelerator}\label{wxcommandprocessorgetundoaccelerator}

\constfunc{const wxString\&}{GetUndoAccelerator}{\void}

Returns the string that will be appended to the Undo menu item.

\membersection{wxCommandProcessor::GetUndoMenuLabel}\label{wxcommandprocessorgetundomenulabel}

\constfunc{wxString}{GetUndoMenuLabel}{\void}

Returns the string that will be shown for the undo menu item.

\membersection{wxCommandProcessor::Initialize}

\func{virtual void}{Initialize}{\void}

Initializes the command processor, setting the current command to the
last in the list (if any), and updating the edit menu (if one has been
specified).

\membersection{wxCommandProcessor::SetEditMenu}

\func{void}{SetEditMenu}{\param{wxMenu* }{menu}}

Tells the command processor to update the Undo and Redo items on this
menu as appropriate. Set this to NULL if the menu is about to be
destroyed and command operations may still be performed, or the command
processor may try to access an invalid pointer.

\membersection{wxCommandProcessor::SetMenuStrings}

\func{void}{SetMenuStrings}{\void}

Sets the menu labels according to the currently set menu and the current
command state.

\membersection{wxCommandProcessor::SetRedoAccelerator}\label{wxcommandprocessorsetredoaccelerator}

\func{void}{SetRedoAccelerator}{\param{const wxString\&}{accel}}

Sets the string that will be appended to the Redo menu item.

\membersection{wxCommandProcessor::SetUndoAccelerator}\label{wxcommandprocessorsetundoaccelerator}

\func{void}{SetUndoAccelerator}{\param{const wxString\&}{accel}}

Sets the string that will be appended to the Undo menu item.

\membersection{wxCommandProcessor::Submit}

\func{virtual bool}{Submit}{\param{wxCommand *}{command}, \param{bool}{ storeIt = true}}

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.

{\it storeIt} indicates whether the successful command should be stored
in the history list.

\membersection{wxCommandProcessor::Undo}

\func{virtual bool}{Undo}{\void}

Undoes the command just executed.
Commit	Line	Data
a660d684 KB	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
954b8ae6 JS	11	\wxheading{Include files}
954b8ae6 JS	12
d6263458	13	<wx/cmdproc.h>
954b8ae6	14
a660d684 KB	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
84023968	23	\func{}{wxCommandProcessor}{\param{int}{ maxCommands = $-1$}}
a660d684 KB	24
	25	Constructor.
	26
84023968 VZ	27	{\it maxCommands} may be set to a positive integer to limit the number of
	28	commands stored to it, otherwise (and by default) the list of commands can grow
	29	arbitrarily.
a660d684 KB	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
cc81d32f	41	Returns true if the currently-active command can be undone, false otherwise.
a660d684 KB	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
fc9a9b2a	49	\membersection{wxCommandProcessor::Redo}
a660d684	50
fc9a9b2a	51	\func{virtual bool}{Redo}{\void}
a660d684 KB	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
5e0e6ceb JS	73	\membersection{wxCommandProcessor::GetRedoAccelerator}\label{wxcommandprocessorgetredoaccelerator}
	74
	75	\constfunc{const wxString\&}{GetRedoAccelerator}{\void}
	76
	77	Returns the string that will be appended to the Redo menu item.
	78
d863ed83 JS	79	\membersection{wxCommandProcessor::GetRedoMenuLabel}\label{wxcommandprocessorgetredomenulabel}
	80
	81	\constfunc{wxString}{GetRedoMenuLabel}{\void}
	82
	83	Returns the string that will be shown for the redo menu item.
	84
5e0e6ceb JS	85	\membersection{wxCommandProcessor::GetUndoAccelerator}\label{wxcommandprocessorgetundoaccelerator}
	86
	87	\constfunc{const wxString\&}{GetUndoAccelerator}{\void}
	88
	89	Returns the string that will be appended to the Undo menu item.
	90
d863ed83 JS	91	\membersection{wxCommandProcessor::GetUndoMenuLabel}\label{wxcommandprocessorgetundomenulabel}
	92
	93	\constfunc{wxString}{GetUndoMenuLabel}{\void}
	94
	95	Returns the string that will be shown for the undo menu item.
	96
a660d684 KB	97	\membersection{wxCommandProcessor::Initialize}
	98
	99	\func{virtual void}{Initialize}{\void}
	100
	101	Initializes the command processor, setting the current command to the
	102	last in the list (if any), and updating the edit menu (if one has been
	103	specified).
	104
	105	\membersection{wxCommandProcessor::SetEditMenu}
	106
	107	\func{void}{SetEditMenu}{\param{wxMenu* }{menu}}
	108
	109	Tells the command processor to update the Undo and Redo items on this
	110	menu as appropriate. Set this to NULL if the menu is about to be
	111	destroyed and command operations may still be performed, or the command
	112	processor may try to access an invalid pointer.
	113
d863ed83 JS	114	\membersection{wxCommandProcessor::SetMenuStrings}
	115
	116	\func{void}{SetMenuStrings}{\void}
	117
	118	Sets the menu labels according to the currently set menu and the current
	119	command state.
	120
5e0e6ceb JS	121	\membersection{wxCommandProcessor::SetRedoAccelerator}\label{wxcommandprocessorsetredoaccelerator}
	122
	123	\func{void}{SetRedoAccelerator}{\param{const wxString\&}{accel}}
	124
	125	Sets the string that will be appended to the Redo menu item.
	126
	127	\membersection{wxCommandProcessor::SetUndoAccelerator}\label{wxcommandprocessorsetundoaccelerator}
	128
	129	\func{void}{SetUndoAccelerator}{\param{const wxString\&}{accel}}
	130
	131	Sets the string that will be appended to the Undo menu item.
	132
a660d684 KB	133	\membersection{wxCommandProcessor::Submit}
a660d684 KB	134
cc81d32f	135	\func{virtual bool}{Submit}{\param{wxCommand *}{command}, \param{bool}{ storeIt = true}}
a660d684 KB	136
	137	Submits a new command to the command processor. The command processor
	138	calls wxCommand::Do to execute the command; if it succeeds, the command
	139	is stored in the history list, and the associated edit menu (if any) updated
	140	appropriately. If it fails, the command is deleted
	141	immediately. Once Submit has been called, the passed command should not
	142	be deleted directly by the application.
	143
	144	{\it storeIt} indicates whether the successful command should be stored
	145	in the history list.
	146
	147	\membersection{wxCommandProcessor::Undo}
	148
	149	\func{virtual bool}{Undo}{\void}
	150
	151	Undoes the command just executed.
	152
	153