Changed version to 2.5.1

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

diff --git a/docs/latex/wx/command.tex b/docs/latex/wx/command.tex
index 9bd25f28110452380c71a0aa3d2c19327fa9fbb3..9c1f7bddd45b996a39e0ca15685f34cf8ae25919 100644 (file)
--- a/docs/latex/wx/command.tex
+++ b/docs/latex/wx/command.tex
@@ -9,6 +9,10 @@ change the data or view.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/cmdproc.h>
+

 \wxheading{See also}
 
 \overview{Overview}{wxcommandoverview}
 \wxheading{See also}
 
 \overview{Overview}{wxcommandoverview}


@@ -17,14 +21,14 @@ change the data or view.
 
 \membersection{wxCommand::wxCommand}
 
 
 \membersection{wxCommand::wxCommand}
 

-\func{}{wxCommand}{\param{bool}{ canUndo = FALSE}, \param{const wxString\& }{name = NULL}}
+\func{}{wxCommand}{\param{bool}{ canUndo = false}, \param{const wxString\& }{name = NULL}}

 
 Constructor. wxCommand is an abstract class, so you will need to derive
 a new class and call this constructor from your own constructor.
 
 {\it canUndo} tells the command processor whether this command is undo-able. You
 can achieve the same functionality by overriding the CanUndo member function (if for example
 
 Constructor. wxCommand is an abstract class, so you will need to derive
 a new class and call this constructor from your own constructor.
 
 {\it canUndo} tells the command processor whether this command is undo-able. You
 can achieve the same functionality by overriding the CanUndo member function (if for example

-the criteria for undoability is context-dependant).
+the criteria for undoability is context-dependent).

 
 {\it name} must be supplied for the command processor to display the command name
 in the application's edit menu.
 
 {\it name} must be supplied for the command processor to display the command name
 in the application's edit menu.


@@ -39,15 +43,15 @@ Destructor.
 
 \func{bool}{CanUndo}{\void}
 
 
 \func{bool}{CanUndo}{\void}
 

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

 
 \membersection{wxCommand::Do}
 
 \func{bool}{Do}{\void}
 
 Override this member function to execute the appropriate action when called.
 
 \membersection{wxCommand::Do}
 
 \func{bool}{Do}{\void}
 
 Override this member function to execute the appropriate action when called.

-Return TRUE to indicate that the action has taken place, FALSE otherwise.
-Returning FALSE will indicate to the command processor that the action is
+Return true to indicate that the action has taken place, false otherwise.
+Returning false will indicate to the command processor that the action is

 not undoable and should not be added to the command history.
 
 \membersection{wxCommand::GetName}
 not undoable and should not be added to the command history.
 
 \membersection{wxCommand::GetName}


@@ -61,8 +65,8 @@ Returns the command name.
 \func{bool}{Undo}{\void}
 
 Override this member function to un-execute a previous Do.
 \func{bool}{Undo}{\void}
 
 Override this member function to un-execute a previous Do.

-Return TRUE to indicate that the action has taken place, FALSE otherwise.
-Returning FALSE will indicate to the command processor that the action is
+Return true to indicate that the action has taken place, false otherwise.
+Returning false will indicate to the command processor that the action is

 not redoable and no change should be made to the command history.
 
 How you implement this command is totally application dependent, but typical
 not redoable and no change should be made to the command history.
 
 How you implement this command is totally application dependent, but typical