classic/carbon split

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

diff --git a/docs/latex/wx/cmdproc.tex b/docs/latex/wx/cmdproc.tex
index 76310b5d711f8465e5f34c70f72462a94dcda3ae..e9509feab4d4475b7ba1378fc2d2976dfc56808c 100644 (file)
--- a/docs/latex/wx/cmdproc.tex
+++ b/docs/latex/wx/cmdproc.tex
@@ -20,13 +20,13 @@ if you want different behaviour.
 
 \membersection{wxCommandProcessor::wxCommandProcessor}
 
 
 \membersection{wxCommandProcessor::wxCommandProcessor}
 

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

 
 Constructor.
 
 
 Constructor.
 

-{\it maxCommands} defaults to a rather arbitrary 100, but can be set from 1 to any integer.
-If your wxCommand classes store a lot of data, you may wish the limit the number of
-commands stored to a smaller number.
+{\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}}
 
 
 \membersection{wxCommandProcessor::\destruct{wxCommandProcessor}}
 


@@ -38,7 +38,7 @@ Destructor.
 
 \func{virtual bool}{CanUndo}{\void}
 
 
 \func{virtual bool}{CanUndo}{\void}
 

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

 
 \membersection{wxCommandProcessor::ClearCommands}
 
 
 \membersection{wxCommandProcessor::ClearCommands}
 


@@ -46,9 +46,9 @@ Returns TRUE if the currently-active command can be undone, FALSE otherwise.
 
 Deletes all the commands in the list and sets the current command pointer to NULL.
 
 
 Deletes all the commands in the list and sets the current command pointer to NULL.
 

-\membersection{wxCommandProcessor::Do}
+\membersection{wxCommandProcessor::Redo}

 
 

-\func{virtual bool}{Do}{\void}
+\func{virtual bool}{Redo}{\void}

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


@@ -76,12 +76,24 @@ Returns the edit menu associated with the command processor.
 
 Returns the string that will be appended to the Redo menu item.
 
 
 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::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}
 \membersection{wxCommandProcessor::Initialize}
 
 \func{virtual void}{Initialize}{\void}


@@ -99,6 +111,13 @@ 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.
 
 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}}
 \membersection{wxCommandProcessor::SetRedoAccelerator}\label{wxcommandprocessorsetredoaccelerator}
 
 \func{void}{SetRedoAccelerator}{\param{const wxString\&}{accel}}


@@ -113,7 +132,7 @@ Sets the string that will be appended to the Undo menu item.
 
 \membersection{wxCommandProcessor::Submit}
 
 
 \membersection{wxCommandProcessor::Submit}
 

-\func{virtual bool}{Submit}{\param{wxCommand *}{command}, \param{bool}{ storeIt = TRUE}}
+\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
 
 Submits a new command to the command processor. The command processor
 calls wxCommand::Do to execute the command; if it succeeds, the command