Correct names of parameters in wxAffineMatrix2D documentation.

[wxWidgets.git] / interface / wx / cmdproc.h

diff --git a/interface/wx/cmdproc.h b/interface/wx/cmdproc.h
index a0bd1d0a2f0c94968ce5ede21232fbfb70c93d1b..932cca841c84fb1b1fb1df72a40a893dbba20f15 100644 (file)
--- a/interface/wx/cmdproc.h
+++ b/interface/wx/cmdproc.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxCommandProcessor and wxCommand
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxCommandProcessor and wxCommand
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxCommand
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxCommand

-    @wxheader{cmdproc.h}

 
     wxCommand is a base class for modelling an application command, which is an
     action usually performed by selecting a menu item, pressing a toolbar
 
     wxCommand is a base class for modelling an application command, which is an
     action usually performed by selecting a menu item, pressing a toolbar


@@ -36,17 +35,17 @@ public:
             Must be supplied for the command processor to display the command
             name in the application's edit menu.
     */
             Must be supplied for the command processor to display the command
             name in the application's edit menu.
     */

-    wxCommand(bool canUndo = false, const wxString& name = NULL);
+    wxCommand(bool canUndo = false, const wxString& name = wxEmptyString);

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxCommand();
+    virtual ~wxCommand();

 
     /**
         Returns @true if the command can be undone, @false otherwise.
     */
 
     /**
         Returns @true if the command can be undone, @false otherwise.
     */

-    bool CanUndo();
+    virtual bool CanUndo() const;

 
     /**
         Override this member function to execute the appropriate action when
 
     /**
         Override this member function to execute the appropriate action when


@@ -57,26 +56,26 @@ public:
                 processor that the action is not undoable and should not be
                 added to the command history.
     */
                 processor that the action is not undoable and should not be
                 added to the command history.
     */

-    bool Do();
+    virtual bool Do() = 0;

 
     /**
         Returns the command name.
     */
 
     /**
         Returns the command name.
     */

-    wxString GetName();
+    virtual wxString GetName() const;

 
     /**
         Override this member function to un-execute a previous Do.
 
         How you implement this command is totally application dependent, but
         typical strategies include:
 
     /**
         Override this member function to un-execute a previous Do.
 
         How you implement this command is totally application dependent, but
         typical strategies include:

-        
+

         - Perform an inverse operation on the last modified piece of data in
           the document. When redone, a copy of data stored in command is pasted
           back or some operation reapplied. This relies on the fact that you
           know the ordering of Undos; the user can never Undo at an arbitrary
           position in the command history.
         - Restore the entire document state (perhaps using document
         - Perform an inverse operation on the last modified piece of data in
           the document. When redone, a copy of data stored in command is pasted
           back or some operation reapplied. This relies on the fact that you
           know the ordering of Undos; the user can never Undo at an arbitrary
           position in the command history.
         - Restore the entire document state (perhaps using document

-          transactioning). Potentially very inefficient, but possibly easier to
+          transacting). Potentially very inefficient, but possibly easier to

           code if the user interface and data are complex, and an "inverse
           execute" operation is hard to write. The docview sample uses the
           first method, to remove or restore segments in the drawing.
           code if the user interface and data are complex, and an "inverse
           execute" operation is hard to write. The docview sample uses the
           first method, to remove or restore segments in the drawing.


@@ -86,14 +85,13 @@ public:
                 processor that the action is not redoable and no change should
                 be made to the command history.
     */
                 processor that the action is not redoable and no change should
                 be made to the command history.
     */

-    bool Undo();
+    virtual bool Undo() = 0;

 };
 
 
 
 /**
     @class wxCommandProcessor
 };
 
 
 
 /**
     @class wxCommandProcessor

-    @wxheader{cmdproc.h}

 
     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
 
     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


@@ -120,13 +118,13 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxCommandProcessor();
+    virtual ~wxCommandProcessor();

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

-    virtual bool CanUndo();
+    virtual bool CanUndo() const;

 
     /**
         Deletes all commands in the list and sets the current command pointer
 
     /**
         Deletes all commands in the list and sets the current command pointer


@@ -137,7 +135,7 @@ public:
     /**
         Returns the list of commands.
     */
     /**
         Returns the list of commands.
     */

-    wxList& GetCommands() const;
+    wxList& GetCommands();

 
     /**
         Returns the edit menu associated with the command processor.
 
     /**
         Returns the edit menu associated with the command processor.


@@ -182,13 +180,13 @@ public:
         the last save operation. This only works if MarkAsSaved() is called
         whenever the project is saved.
     */
         the last save operation. This only works if MarkAsSaved() is called
         whenever the project is saved.
     */

-    virtual bool IsDirty();
+    virtual bool IsDirty() const;

 
     /**
         You must call this method whenever the project is saved if you plan to
         use IsDirty().
     */
 
     /**
         You must call this method whenever the project is saved if you plan to
         use IsDirty().
     */

-    virtual void MarkAsSaved();
+    void MarkAsSaved();

 
     /**
         Executes (redoes) the current command (the command that has just been
 
     /**
         Executes (redoes) the current command (the command that has just been


@@ -208,7 +206,7 @@ public:
         Sets the menu labels according to the currently set menu and the
         current command state.
     */
         Sets the menu labels according to the currently set menu and the
         current command state.
     */

-    void SetMenuStrings();
+    virtual void SetMenuStrings();

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


@@ -221,13 +219,16 @@ public:
     void SetUndoAccelerator(const wxString& accel);
 
     /**
     void SetUndoAccelerator(const wxString& accel);
 
     /**

-        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.
+        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.

 
 

+        @param command
+            The command to submit

         @param storeIt
             Indicates whether the successful command should be stored in the
             history list.
         @param storeIt
             Indicates whether the successful command should be stored in the
             history list.