1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: undo/redo capable command processing framework
4 // Author: Julian Smart (extracted from docview.h by VZ)
8 // Copyright: (c) wxWindows team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_CMDPROC_H_
13 #define _WX_CMDPROC_H_
15 #if defined(__GNUG__) && !defined(__APPLE__)
16 #pragma interface "cmdproc.h"
19 #include "wx/object.h"
22 // ----------------------------------------------------------------------------
23 // wxCommand: a single command capable of performing itself
24 // ----------------------------------------------------------------------------
26 class WXDLLEXPORT wxCommand
: public wxObject
29 wxCommand(bool canUndoIt
= FALSE
, const wxString
& name
= wxT(""));
32 // Override this to perform a command
33 virtual bool Do() = 0;
35 // Override this to undo a command
36 virtual bool Undo() = 0;
38 virtual bool CanUndo() const { return m_canUndo
; }
39 virtual wxString
GetName() const { return m_commandName
; }
43 wxString m_commandName
;
46 DECLARE_CLASS(wxCommand
)
49 // ----------------------------------------------------------------------------
50 // wxCommandProcessor: wxCommand manager
51 // ----------------------------------------------------------------------------
53 class WXDLLEXPORT wxCommandProcessor
: public wxObject
56 // if max number of commands is -1, it is unlimited
57 wxCommandProcessor(int maxCommands
= -1);
58 virtual ~wxCommandProcessor();
60 // Pass a command to the processor. The processor calls Do(); if
61 // successful, is appended to the command history unless storeIt is FALSE.
62 virtual bool Submit(wxCommand
*command
, bool storeIt
= TRUE
);
64 // just store the command without executing it
65 virtual void Store(wxCommand
*command
);
69 virtual bool CanUndo() const;
70 virtual bool CanRedo() const;
72 // Initialises the current command and menu strings.
73 virtual void Initialize();
75 // Sets the Undo/Redo menu strings for the current menu.
76 virtual void SetMenuStrings();
78 // Gets the current Undo menu label.
79 wxString
GetUndoMenuLabel() const;
81 // Gets the current Undo menu label.
82 wxString
GetRedoMenuLabel() const;
85 // Call this to manage an edit menu.
86 void SetEditMenu(wxMenu
*menu
) { m_commandEditMenu
= menu
; }
87 wxMenu
*GetEditMenu() const { return m_commandEditMenu
; }
90 // command list access
91 wxList
& GetCommands() const { return (wxList
&) m_commands
; }
92 wxCommand
*GetCurrentCommand() const
94 return (wxCommand
*)(m_currentCommand
? m_currentCommand
->Data() : NULL
);
96 int GetMaxCommands() const { return m_maxNoCommands
; }
97 virtual void ClearCommands();
99 // By default, the accelerators are "\tCtrl+Z" and "\tCtrl+Y"
100 const wxString
& GetUndoAccelerator() const { return m_undoAccelerator
; }
101 const wxString
& GetRedoAccelerator() const { return m_redoAccelerator
; }
103 void SetUndoAccelerator(const wxString
& accel
) { m_undoAccelerator
= accel
; }
104 void SetRedoAccelerator(const wxString
& accel
) { m_redoAccelerator
= accel
; }
107 // for further flexibility, command processor doesn't call wxCommand::Do()
108 // and Undo() directly but uses these functions which can be overridden in
110 virtual bool DoCommand(wxCommand
& cmd
);
111 virtual bool UndoCommand(wxCommand
& cmd
);
115 wxNode
* m_currentCommand
;
118 wxMenu
* m_commandEditMenu
;
119 #endif // wxUSE_MENUS
121 wxString m_undoAccelerator
;
122 wxString m_redoAccelerator
;
125 DECLARE_DYNAMIC_CLASS(wxCommandProcessor
)
126 DECLARE_NO_COPY_CLASS(wxCommandProcessor
)
129 #endif // _WX_CMDPROC_H_