better docs for Get/SetLabel methods

[wxWidgets.git] / src / common / cmdproc.cpp

diff --git a/src/common/cmdproc.cpp b/src/common/cmdproc.cpp
index 6d4ea446425ac5bb408393fc5c080c4c258c4602..789e950f95abd09ef8ded525709314174572f54d 100644 (file)
--- a/src/common/cmdproc.cpp
+++ b/src/common/cmdproc.cpp
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     05.11.00
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     05.11.00
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "cmdproc.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -32,6 +28,7 @@
     #include "wx/intl.h"
     #include "wx/string.h"
     #include "wx/menu.h"
     #include "wx/intl.h"
     #include "wx/string.h"
     #include "wx/menu.h"

+    #include "wx/accel.h"

 #endif //WX_PRECOMP
 
 #include "wx/cmdproc.h"
 #endif //WX_PRECOMP
 
 #include "wx/cmdproc.h"


@@ -53,10 +50,6 @@ wxCommand::wxCommand(bool canUndoIt, const wxString& name)
     m_commandName = name;
 }
 
     m_commandName = name;
 }
 

-wxCommand::~wxCommand()
-{
-}
-

 // ----------------------------------------------------------------------------
 // Command processor
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Command processor
 // ----------------------------------------------------------------------------


@@ -65,10 +58,16 @@ wxCommandProcessor::wxCommandProcessor(int maxCommands)
 {
     m_maxNoCommands = maxCommands;
 #if wxUSE_MENUS
 {
     m_maxNoCommands = maxCommands;
 #if wxUSE_MENUS

-    m_commandEditMenu = (wxMenu *) NULL;
+    m_commandEditMenu = NULL;

 #endif // wxUSE_MENUS
 #endif // wxUSE_MENUS

-    m_undoAccelerator = wxT("\tCtrl+Z");
-    m_redoAccelerator = wxT("\tCtrl+Y");
+
+#if wxUSE_ACCEL
+    m_undoAccelerator = '\t' + wxAcceleratorEntry(wxACCEL_CTRL, 'Z').ToString();
+    m_redoAccelerator = '\t' + wxAcceleratorEntry(wxACCEL_CTRL, 'Y').ToString();
+#endif // wxUSE_ACCEL
+
+    m_lastSavedCommand =
+    m_currentCommand = wxList::compatibility_iterator();

 }
 
 wxCommandProcessor::~wxCommandProcessor()
 }
 
 wxCommandProcessor::~wxCommandProcessor()


@@ -88,28 +87,30 @@ bool wxCommandProcessor::UndoCommand(wxCommand& cmd)
 
 // Pass a command to the processor. The processor calls Do();
 // if successful, is appended to the command history unless
 
 // Pass a command to the processor. The processor calls Do();
 // if successful, is appended to the command history unless

-// storeIt is FALSE.
+// storeIt is false.

 bool wxCommandProcessor::Submit(wxCommand *command, bool storeIt)
 {
 bool wxCommandProcessor::Submit(wxCommand *command, bool storeIt)
 {

-    wxCHECK_MSG( command, FALSE, _T("no command in wxCommandProcessor::Submit") );
+    wxCHECK_MSG( command, false, wxT("no command in wxCommandProcessor::Submit") );

 
     if ( !DoCommand(*command) )
     {
         // the user code expects the command to be deleted anyhow
         delete command;
 
 
     if ( !DoCommand(*command) )
     {
         // the user code expects the command to be deleted anyhow
         delete command;
 

-        return FALSE;
+        return false;

     }
 
     if ( storeIt )
         Store(command);
     }
 
     if ( storeIt )
         Store(command);

+    else
+        delete command;

 
 

-    return TRUE;
+    return true;

 }
 
 void wxCommandProcessor::Store(wxCommand *command)
 {
 }
 
 void wxCommandProcessor::Store(wxCommand *command)
 {

-    wxCHECK_RET( command, _T("no command in wxCommandProcessor::Store") );
+    wxCHECK_RET( command, wxT("no command in wxCommandProcessor::Store") );

 
     if ( (int)m_commands.GetCount() == m_maxNoCommands )
     {
 
     if ( (int)m_commands.GetCount() == m_maxNoCommands )
     {


@@ -117,6 +118,10 @@ void wxCommandProcessor::Store(wxCommand *command)
         wxCommand *firstCommand = (wxCommand *)firstNode->GetData();
         delete firstCommand;
         m_commands.Erase(firstNode);
         wxCommand *firstCommand = (wxCommand *)firstNode->GetData();
         delete firstCommand;
         m_commands.Erase(firstNode);

+
+        // Make sure m_lastSavedCommand won't point to freed memory
+        if ( m_lastSavedCommand == firstNode )
+            m_lastSavedCommand = wxList::compatibility_iterator();

     }
 
     // Correct a bug: we must chop off the current 'branch'
     }
 
     // Correct a bug: we must chop off the current 'branch'


@@ -131,6 +136,11 @@ void wxCommandProcessor::Store(wxCommand *command)
             wxList::compatibility_iterator next = node->GetNext();
             delete (wxCommand *)node->GetData();
             m_commands.Erase(node);
             wxList::compatibility_iterator next = node->GetNext();
             delete (wxCommand *)node->GetData();
             m_commands.Erase(node);

+
+            // Make sure m_lastSavedCommand won't point to freed memory
+            if ( m_lastSavedCommand == node )
+                m_lastSavedCommand = wxList::compatibility_iterator();
+

             node = next;
         }
     }
             node = next;
         }
     }


@@ -149,17 +159,21 @@ bool wxCommandProcessor::Undo()
         {
             m_currentCommand = m_currentCommand->GetPrevious();
             SetMenuStrings();
         {
             m_currentCommand = m_currentCommand->GetPrevious();
             SetMenuStrings();

-            return TRUE;
+            return true;

         }
     }
 
         }
     }
 

-    return FALSE;
+    return false;

 }
 
 bool wxCommandProcessor::Redo()
 {
 }
 
 bool wxCommandProcessor::Redo()
 {

-    wxCommand *redoCommand = (wxCommand *) NULL;
-    wxList::compatibility_iterator redoNode = 0;
+    wxCommand *redoCommand = NULL;
+    wxList::compatibility_iterator redoNode
+#if !wxUSE_STL
+        = NULL          // just to avoid warnings
+#endif // !wxUSE_STL
+        ;

 
     if ( m_currentCommand )
     {
 
     if ( m_currentCommand )
     {


@@ -186,10 +200,10 @@ bool wxCommandProcessor::Redo()
         {
             m_currentCommand = redoNode;
             SetMenuStrings();
         {
             m_currentCommand = redoNode;
             SetMenuStrings();

-            return TRUE;
+            return true;

         }
     }
         }
     }

-    return FALSE;
+    return false;

 }
 
 bool wxCommandProcessor::CanUndo() const
 }
 
 bool wxCommandProcessor::CanUndo() const


@@ -202,15 +216,15 @@ bool wxCommandProcessor::CanUndo() const
 bool wxCommandProcessor::CanRedo() const
 {
     if (m_currentCommand && !m_currentCommand->GetNext())
 bool wxCommandProcessor::CanRedo() const
 {
     if (m_currentCommand && !m_currentCommand->GetNext())

-        return FALSE;
+        return false;

 
     if (m_currentCommand && m_currentCommand->GetNext())
 
     if (m_currentCommand && m_currentCommand->GetNext())

-        return TRUE;
+        return true;

 
     if (!m_currentCommand && (m_commands.GetCount() > 0))
 
     if (!m_currentCommand && (m_commands.GetCount() > 0))

-        return TRUE;
+        return true;

 
 

-    return FALSE;
+    return false;

 }
 
 void wxCommandProcessor::Initialize()
 }
 
 void wxCommandProcessor::Initialize()


@@ -226,7 +240,7 @@ void wxCommandProcessor::SetMenuStrings()
     {
         wxString undoLabel = GetUndoMenuLabel();
         wxString redoLabel = GetRedoMenuLabel();
     {
         wxString undoLabel = GetUndoMenuLabel();
         wxString redoLabel = GetRedoMenuLabel();

-        
+

         m_commandEditMenu->SetLabel(wxID_UNDO, undoLabel);
         m_commandEditMenu->Enable(wxID_UNDO, CanUndo());
 
         m_commandEditMenu->SetLabel(wxID_UNDO, undoLabel);
         m_commandEditMenu->Enable(wxID_UNDO, CanUndo());
 


@@ -244,7 +258,7 @@ wxString wxCommandProcessor::GetUndoMenuLabel() const
     {
         wxCommand *command = (wxCommand *)m_currentCommand->GetData();
         wxString commandName(command->GetName());
     {
         wxCommand *command = (wxCommand *)m_currentCommand->GetData();
         wxString commandName(command->GetName());

-        if (commandName == wxT("")) commandName = _("Unnamed command");
+        if (commandName.empty()) commandName = _("Unnamed command");

         bool canUndo = command->CanUndo();
         if (canUndo)
             buf = wxString(_("&Undo ")) + commandName + m_undoAccelerator;
         bool canUndo = command->CanUndo();
         if (canUndo)
             buf = wxString(_("&Undo ")) + commandName + m_undoAccelerator;


@@ -255,7 +269,7 @@ wxString wxCommandProcessor::GetUndoMenuLabel() const
     {
         buf = _("&Undo") + m_undoAccelerator;
     }
     {
         buf = _("&Undo") + m_undoAccelerator;
     }

-    
+

     return buf;
 }
 
     return buf;
 }
 


@@ -270,7 +284,7 @@ wxString wxCommandProcessor::GetRedoMenuLabel() const
         {
             wxCommand *redoCommand = (wxCommand *)m_currentCommand->GetNext()->GetData();
             wxString redoCommandName(redoCommand->GetName());
         {
             wxCommand *redoCommand = (wxCommand *)m_currentCommand->GetNext()->GetData();
             wxString redoCommandName(redoCommand->GetName());

-            if (redoCommandName == wxT("")) redoCommandName = _("Unnamed command");
+            if (redoCommandName.empty()) redoCommandName = _("Unnamed command");

             buf = wxString(_("&Redo ")) + redoCommandName + m_redoAccelerator;
         }
         else
             buf = wxString(_("&Redo ")) + redoCommandName + m_redoAccelerator;
         }
         else


@@ -290,7 +304,7 @@ wxString wxCommandProcessor::GetRedoMenuLabel() const
             // we've undone to the start of the list, but can redo the first.
             wxCommand *redoCommand = (wxCommand *)m_commands.GetFirst()->GetData();
             wxString redoCommandName(redoCommand->GetName());
             // we've undone to the start of the list, but can redo the first.
             wxCommand *redoCommand = (wxCommand *)m_commands.GetFirst()->GetData();
             wxString redoCommandName(redoCommand->GetName());

-            if (redoCommandName == wxT("")) redoCommandName = _("Unnamed command");
+            if (redoCommandName.empty()) redoCommandName = _("Unnamed command");

             buf = wxString(_("&Redo ")) + redoCommandName + m_redoAccelerator;
         }
     }
             buf = wxString(_("&Redo ")) + redoCommandName + m_redoAccelerator;
         }
     }


@@ -307,7 +321,9 @@ void wxCommandProcessor::ClearCommands()
         m_commands.Erase(node);
         node = m_commands.GetFirst();
     }
         m_commands.Erase(node);
         node = m_commands.GetFirst();
     }

+

     m_currentCommand = wxList::compatibility_iterator();
     m_currentCommand = wxList::compatibility_iterator();

+    m_lastSavedCommand = wxList::compatibility_iterator();

 }
 
 
 }