X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d6263458e4d9bd4e1dd8999f923013c340e2d83b..83930b2fd2c41cd965926e669115696c1e8eef0d:/docs/latex/wx/command.tex?ds=sidebyside diff --git a/docs/latex/wx/command.tex b/docs/latex/wx/command.tex index f65c6f298f..c4ebccd515 100644 --- a/docs/latex/wx/command.tex +++ b/docs/latex/wx/command.tex @@ -19,54 +19,54 @@ change the data or view. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxCommand::wxCommand} +\membersection{wxCommand::wxCommand}\label{wxcommandctor} -\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 -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. -\membersection{wxCommand::\destruct{wxCommand}} +\membersection{wxCommand::\destruct{wxCommand}}\label{wxcommanddtor} \func{}{\destruct{wxCommand}}{\void} Destructor. -\membersection{wxCommand::CanUndo} +\membersection{wxCommand::CanUndo}\label{wxcommandcanundo} \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} +\membersection{wxCommand::Do}\label{wxcommanddo} \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} +\membersection{wxCommand::GetName}\label{wxcommandgetname} \func{wxString}{GetName}{\void} Returns the command name. -\membersection{wxCommand::Undo} +\membersection{wxCommand::Undo}\label{wxcommandundo} \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