Fix tracking rectangles in 64-bit build by remembering the tag as the 64-bit integer...

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

diff --git a/src/common/stockitem.cpp b/src/common/stockitem.cpp
index c6325d7a2e37ae991093cff74f0fedf6564273a1..aa9515f0e0b8ac38003d40153d6c04069485eea5 100644 (file)
--- a/src/common/stockitem.cpp
+++ b/src/common/stockitem.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        common/stockitem.cpp
+// Name:        src/common/stockitem.cpp

 // Purpose:     Stock buttons, menu and toolbar items labels
 // Author:      Vaclav Slavik
 // Modified by:
 // Purpose:     Stock buttons, menu and toolbar items labels
 // Author:      Vaclav Slavik
 // Modified by:


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

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "stockitem.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"
 


@@ -29,161 +25,254 @@
 #endif
 
 #include "wx/stockitem.h"
 #endif
 
 #include "wx/stockitem.h"

-#include "wx/intl.h"

 
 

-wxString wxGetStockItemLabel(wxStockItemID item)
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/utils.h" // for wxStripMenuCodes()
+#endif
+
+bool wxIsStockID(wxWindowID id)

 {
 {

+    switch (id)
+    {
+        case wxID_ABOUT:
+        case wxID_ADD:
+        case wxID_APPLY:
+        case wxID_BOLD:
+        case wxID_CANCEL:
+        case wxID_CLEAR:
+        case wxID_CLOSE:
+        case wxID_COPY:
+        case wxID_CUT:
+        case wxID_DELETE:
+        case wxID_EDIT:
+        case wxID_FIND:
+        case wxID_FILE:
+        case wxID_REPLACE:
+        case wxID_BACKWARD:
+        case wxID_DOWN:
+        case wxID_FORWARD:
+        case wxID_UP:
+        case wxID_HELP:
+        case wxID_HOME:
+        case wxID_INDENT:
+        case wxID_INDEX:
+        case wxID_ITALIC:
+        case wxID_JUSTIFY_CENTER:
+        case wxID_JUSTIFY_FILL:
+        case wxID_JUSTIFY_LEFT:
+        case wxID_JUSTIFY_RIGHT:
+        case wxID_NEW:
+        case wxID_NO:
+        case wxID_OK:
+        case wxID_OPEN:
+        case wxID_PASTE:
+        case wxID_PREFERENCES:
+        case wxID_PRINT:
+        case wxID_PREVIEW:
+        case wxID_PROPERTIES:
+        case wxID_EXIT:
+        case wxID_REDO:
+        case wxID_REFRESH:
+        case wxID_REMOVE:
+        case wxID_REVERT_TO_SAVED:
+        case wxID_SAVE:
+        case wxID_SAVEAS:
+        case wxID_SELECTALL:
+        case wxID_STOP:
+        case wxID_UNDELETE:
+        case wxID_UNDERLINE:
+        case wxID_UNDO:
+        case wxID_UNINDENT:
+        case wxID_YES:
+        case wxID_ZOOM_100:
+        case wxID_ZOOM_FIT:
+        case wxID_ZOOM_IN:
+        case wxID_ZOOM_OUT:
+            return true;
+
+        default:
+            return false;
+    }
+}
+
+wxString wxGetStockLabel(wxWindowID id, long flags)
+{
+    wxString stockLabel;
+

     #define STOCKITEM(stockid, label) \
         case stockid:                 \
     #define STOCKITEM(stockid, label) \
         case stockid:                 \

-            return label;
+            stockLabel = label;       \
+            break;

 
 

-    switch (item)
+    switch (id)

     {
     {

-        STOCKITEM(wxSTOCK_ADD,                 _("Add"))
-        STOCKITEM(wxSTOCK_APPLY,               _("&Apply"))
-        STOCKITEM(wxSTOCK_BOLD,                _("&Bold"))
-        STOCKITEM(wxSTOCK_CANCEL,              _("&Cancel"))
-        STOCKITEM(wxSTOCK_CLEAR,               _("&Clear"))
-        STOCKITEM(wxSTOCK_CLOSE,               _("&Close"))
-        STOCKITEM(wxSTOCK_COPY,                _("&Copy"))
-        STOCKITEM(wxSTOCK_CUT,                 _("Cu&t"))
-        STOCKITEM(wxSTOCK_DELETE,              _("&Delete"))
-        STOCKITEM(wxSTOCK_FIND,                _("&Find"))
-        STOCKITEM(wxSTOCK_FIND_AND_REPLACE,    _("Find and rep&lace"))
-        STOCKITEM(wxSTOCK_GO_BACK,             _("&Back"))
-        STOCKITEM(wxSTOCK_GO_DOWN,             _("&Down"))
-        STOCKITEM(wxSTOCK_GO_FORWARD,          _("&Forward"))
-        STOCKITEM(wxSTOCK_GO_UP,               _("&Up"))
-        STOCKITEM(wxSTOCK_HELP,                _("&Help"))
-        STOCKITEM(wxSTOCK_HOME,                _("&Home"))
-        STOCKITEM(wxSTOCK_INDENT,              _("Indent"))
-        STOCKITEM(wxSTOCK_INDEX,               _("&Index"))
-        STOCKITEM(wxSTOCK_ITALIC,              _("&Italic"))
-        STOCKITEM(wxSTOCK_JUSTIFY_CENTER,      _("Centered"))
-        STOCKITEM(wxSTOCK_JUSTIFY_FILL,        _("Justified"))
-        STOCKITEM(wxSTOCK_JUSTIFY_LEFT,        _("Align Left"))
-        STOCKITEM(wxSTOCK_JUSTIFY_RIGHT,       _("Align Right"))
-        STOCKITEM(wxSTOCK_NEW,                 _("&New"))
-        STOCKITEM(wxSTOCK_NO,                  _("&No"))
-        STOCKITEM(wxSTOCK_OK,                  _("&OK"))
-        STOCKITEM(wxSTOCK_OPEN,                _("&Open"))
-        STOCKITEM(wxSTOCK_PASTE,               _("&Paste"))
-        STOCKITEM(wxSTOCK_PREFERENCES,         _("&Preferences"))
-        STOCKITEM(wxSTOCK_PRINT,               _("&Print"))
-        STOCKITEM(wxSTOCK_PRINT_PREVIEW,       _("Print previe&w"))
-        STOCKITEM(wxSTOCK_PROPERTIES,          _("&Properties"))
-        STOCKITEM(wxSTOCK_QUIT,                _("&Quit"))
-        STOCKITEM(wxSTOCK_REDO,                _("&Redo"))
-        STOCKITEM(wxSTOCK_REFRESH,             _("Refresh"))
-        STOCKITEM(wxSTOCK_REMOVE,              _("Remove"))
-        STOCKITEM(wxSTOCK_REVERT_TO_SAVED,     _("Revert to Saved"))
-        STOCKITEM(wxSTOCK_SAVE,                _("&Save"))
-        STOCKITEM(wxSTOCK_SAVE_AS,             _("Save &As..."))
-        STOCKITEM(wxSTOCK_STOP,                _("&Stop"))
-        STOCKITEM(wxSTOCK_UNDELETE,            _("Undelete"))
-        STOCKITEM(wxSTOCK_UNDERLINE,           _("&Underline"))
-        STOCKITEM(wxSTOCK_UNDO,                _("&Undo"))
-        STOCKITEM(wxSTOCK_UNINDENT,            _("&Unindent"))
-        STOCKITEM(wxSTOCK_YES,                 _("&Yes"))
-        STOCKITEM(wxSTOCK_ZOOM_100,            _("&Actual Size"))
-        STOCKITEM(wxSTOCK_ZOOM_FIT,            _("Zoom to &Fit"))
-        STOCKITEM(wxSTOCK_ZOOM_IN,             _("Zoom &In"))
-        STOCKITEM(wxSTOCK_ZOOM_OUT,            _("Zoom &Out"))
-
-        case wxSTOCK_NONE:
+        STOCKITEM(wxID_ABOUT,               _("&About..."))
+        STOCKITEM(wxID_ADD,                 _("Add"))
+        STOCKITEM(wxID_APPLY,               _("&Apply"))
+        STOCKITEM(wxID_BOLD,                _("&Bold"))
+        STOCKITEM(wxID_CANCEL,              _("&Cancel"))
+        STOCKITEM(wxID_CLEAR,               _("&Clear"))
+        STOCKITEM(wxID_CLOSE,               _("&Close"))
+        STOCKITEM(wxID_COPY,                _("&Copy"))
+        STOCKITEM(wxID_CUT,                 _("Cu&t"))
+        STOCKITEM(wxID_DELETE,              _("&Delete"))
+        STOCKITEM(wxID_EDIT,                _("&Edit"))
+        STOCKITEM(wxID_FIND,                _("&Find"))
+        STOCKITEM(wxID_FILE,                _("&File"))
+        STOCKITEM(wxID_REPLACE,             _("Rep&lace"))
+        STOCKITEM(wxID_BACKWARD,            _("&Back"))
+        STOCKITEM(wxID_DOWN,                _("&Down"))
+        STOCKITEM(wxID_FORWARD,             _("&Forward"))
+        STOCKITEM(wxID_UP,                  _("&Up"))
+        STOCKITEM(wxID_HELP,                _("&Help"))
+        STOCKITEM(wxID_HOME,                _("&Home"))
+        STOCKITEM(wxID_INDENT,              _("Indent"))
+        STOCKITEM(wxID_INDEX,               _("&Index"))
+        STOCKITEM(wxID_ITALIC,              _("&Italic"))
+        STOCKITEM(wxID_JUSTIFY_CENTER,      _("Centered"))
+        STOCKITEM(wxID_JUSTIFY_FILL,        _("Justified"))
+        STOCKITEM(wxID_JUSTIFY_LEFT,        _("Align Left"))
+        STOCKITEM(wxID_JUSTIFY_RIGHT,       _("Align Right"))
+        STOCKITEM(wxID_NEW,                 _("&New"))
+        STOCKITEM(wxID_NO,                  _("&No"))
+        STOCKITEM(wxID_OK,                  _("&OK"))
+        STOCKITEM(wxID_OPEN,                _("&Open..."))
+        STOCKITEM(wxID_PASTE,               _("&Paste"))
+        STOCKITEM(wxID_PREFERENCES,         _("&Preferences"))
+        STOCKITEM(wxID_PRINT,               _("&Print..."))
+        STOCKITEM(wxID_PREVIEW,             _("Print previe&w"))
+        STOCKITEM(wxID_PROPERTIES,          _("&Properties"))
+        STOCKITEM(wxID_EXIT,                _("&Quit"))
+        STOCKITEM(wxID_REDO,                _("&Redo"))
+        STOCKITEM(wxID_REFRESH,             _("Refresh"))
+        STOCKITEM(wxID_REMOVE,              _("Remove"))
+        STOCKITEM(wxID_REVERT_TO_SAVED,     _("Revert to Saved"))
+        STOCKITEM(wxID_SAVE,                _("&Save"))
+        STOCKITEM(wxID_SAVEAS,              _("Save &As..."))
+        STOCKITEM(wxID_SELECTALL,           _("Select &All"))
+        STOCKITEM(wxID_STOP,                _("&Stop"))
+        STOCKITEM(wxID_UNDELETE,            _("Undelete"))
+        STOCKITEM(wxID_UNDERLINE,           _("&Underline"))
+        STOCKITEM(wxID_UNDO,                _("&Undo"))
+        STOCKITEM(wxID_UNINDENT,            _("&Unindent"))
+        STOCKITEM(wxID_YES,                 _("&Yes"))
+        STOCKITEM(wxID_ZOOM_100,            _("&Actual Size"))
+        STOCKITEM(wxID_ZOOM_FIT,            _("Zoom to &Fit"))
+        STOCKITEM(wxID_ZOOM_IN,             _("Zoom &In"))
+        STOCKITEM(wxID_ZOOM_OUT,            _("Zoom &Out"))
+

         default:
             wxFAIL_MSG( _T("invalid stock item ID") );
             break;
     };
 
     #undef STOCKITEM
         default:
             wxFAIL_MSG( _T("invalid stock item ID") );
             break;
     };
 
     #undef STOCKITEM

-    
-    return wxEmptyString;
+
+    if ( !(flags & wxSTOCK_WITH_MNEMONIC) )
+    {
+        stockLabel = wxStripMenuCodes(stockLabel);
+    }
+
+#if wxUSE_ACCEL
+    if ( !stockLabel.empty() && (flags & wxSTOCK_WITH_ACCELERATOR) )
+    {
+        wxAcceleratorEntry accel = wxGetStockAccelerator(id);
+        if (accel.IsOk())
+            stockLabel << _T('\t') << accel.ToString();
+    }
+#endif // wxUSE_ACCEL
+
+    return stockLabel;

 }
 
 }
 

+wxString wxGetStockHelpString(wxWindowID id, wxStockHelpStringClient client)
+{
+    wxString stockHelp;

 
 

-#ifdef __WXGTK20__
+    #define STOCKITEM(stockid, ctx, helpstr)             \
+        case stockid:                                    \
+            if (client==ctx) stockHelp = helpstr;        \
+            break;

 
 

-#include <gtk/gtk.h>
+    switch (id)
+    {
+        // NB: these help string should be not too specific as they could be used
+        //     in completely different programs!
+        STOCKITEM(wxID_ABOUT,    wxSTOCK_MENU, _("Show about dialog"))
+        STOCKITEM(wxID_COPY,     wxSTOCK_MENU, _("Copy selection"))
+        STOCKITEM(wxID_CUT,      wxSTOCK_MENU, _("Cut selection"))
+        STOCKITEM(wxID_DELETE,   wxSTOCK_MENU, _("Delete selection"))
+        STOCKITEM(wxID_REPLACE,  wxSTOCK_MENU, _("Replace selection"))
+        STOCKITEM(wxID_PASTE,    wxSTOCK_MENU, _("Paste selection"))
+        STOCKITEM(wxID_EXIT,     wxSTOCK_MENU, _("Quit this program"))
+        STOCKITEM(wxID_REDO,     wxSTOCK_MENU, _("Redo last action"))
+        STOCKITEM(wxID_UNDO,     wxSTOCK_MENU, _("Undo last action"))
+        STOCKITEM(wxID_CLOSE,    wxSTOCK_MENU, _("Close current document"))
+        STOCKITEM(wxID_SAVE,     wxSTOCK_MENU, _("Save current document"))
+        STOCKITEM(wxID_SAVEAS,   wxSTOCK_MENU, _("Save current document with a different filename"))

 
 

-const char *wxStockItemToGTK(wxStockItemID item)
+        default:
+            // there's no stock help string for this ID / client
+            return wxEmptyString;
+    }
+
+    #undef STOCKITEM
+
+    return stockHelp;
+}
+
+#if wxUSE_ACCEL
+
+wxAcceleratorEntry wxGetStockAccelerator(wxWindowID id)

 {
 {

-    #define STOCKITEM(stockid)            \
-        case wx##stockid:                 \
-            return GTK_##stockid;
-    
-    #define STOCKITEM_MISSING(stockid)    \
-        case wx##stockid:                 \
-            return NULL;
-
-    #if GTK_CHECK_VERSION(2,4,0)
-        #define STOCKITEM_24(stockid) STOCKITEM(stockid)
-    #else
-        #define STOCKITEM_24(stockid) STOCKITEM_MISSING(stockid)
-    #endif
-
-    switch (item)
+    wxAcceleratorEntry ret;
+
+    #define STOCKITEM(stockid, flags, keycode)      \
+        case stockid:                               \
+            ret.Set(flags, keycode, stockid);       \
+            break;
+
+    switch (id)

     {
     {

-        STOCKITEM(STOCK_ADD)
-        STOCKITEM(STOCK_APPLY)
-        STOCKITEM(STOCK_BOLD)
-        STOCKITEM(STOCK_CANCEL)
-        STOCKITEM(STOCK_CLEAR)
-        STOCKITEM(STOCK_CLOSE)
-        STOCKITEM(STOCK_COPY)
-        STOCKITEM(STOCK_CUT)
-        STOCKITEM(STOCK_DELETE)
-        STOCKITEM(STOCK_FIND)
-        STOCKITEM(STOCK_FIND_AND_REPLACE)
-        STOCKITEM(STOCK_GO_BACK)
-        STOCKITEM(STOCK_GO_DOWN)
-        STOCKITEM(STOCK_GO_FORWARD)
-        STOCKITEM(STOCK_GO_UP)
-        STOCKITEM(STOCK_HELP)
-        STOCKITEM(STOCK_HOME)
-        STOCKITEM_24(STOCK_INDENT)
-        STOCKITEM(STOCK_INDEX)
-        STOCKITEM(STOCK_ITALIC)
-        STOCKITEM(STOCK_JUSTIFY_CENTER)
-        STOCKITEM(STOCK_JUSTIFY_FILL)
-        STOCKITEM(STOCK_JUSTIFY_LEFT)
-        STOCKITEM(STOCK_JUSTIFY_RIGHT)
-        STOCKITEM(STOCK_NEW)
-        STOCKITEM(STOCK_NO)
-        STOCKITEM(STOCK_OK)
-        STOCKITEM(STOCK_OPEN)
-        STOCKITEM(STOCK_PASTE)
-        STOCKITEM(STOCK_PREFERENCES)
-        STOCKITEM(STOCK_PRINT)
-        STOCKITEM(STOCK_PRINT_PREVIEW)
-        STOCKITEM(STOCK_PROPERTIES)
-        STOCKITEM(STOCK_QUIT)
-        STOCKITEM(STOCK_REDO)
-        STOCKITEM(STOCK_REFRESH)
-        STOCKITEM(STOCK_REMOVE)
-        STOCKITEM(STOCK_REVERT_TO_SAVED)
-        STOCKITEM(STOCK_SAVE)
-        STOCKITEM(STOCK_SAVE_AS)
-        STOCKITEM(STOCK_STOP)
-        STOCKITEM(STOCK_UNDELETE)
-        STOCKITEM(STOCK_UNDERLINE)
-        STOCKITEM(STOCK_UNDO)
-        STOCKITEM_24(STOCK_UNINDENT)
-        STOCKITEM(STOCK_YES)
-        STOCKITEM(STOCK_ZOOM_100)
-        STOCKITEM(STOCK_ZOOM_FIT)
-        STOCKITEM(STOCK_ZOOM_IN)
-        STOCKITEM(STOCK_ZOOM_OUT)
-
-        case wxSTOCK_NONE:
+        STOCKITEM(wxID_COPY,                wxACCEL_CTRL,'C')
+        STOCKITEM(wxID_CUT,                 wxACCEL_CTRL,'X')
+        STOCKITEM(wxID_FIND,                wxACCEL_CTRL,'F')
+        STOCKITEM(wxID_REPLACE,             wxACCEL_CTRL,'R')
+        STOCKITEM(wxID_HELP,                wxACCEL_CTRL,'H')
+        STOCKITEM(wxID_NEW,                 wxACCEL_CTRL,'N')
+        STOCKITEM(wxID_OPEN,                wxACCEL_CTRL,'O')
+        STOCKITEM(wxID_PASTE,               wxACCEL_CTRL,'V')
+        STOCKITEM(wxID_SAVE,                wxACCEL_CTRL,'S')
+

         default:
         default:

-            wxFAIL_MSG( _T("invalid stock item ID") );
+            // set the wxAcceleratorEntry to return into an invalid state:
+            // there's no stock accelerator for that.
+            ret.Set(0, 0, id);

             break;
     };
 
     #undef STOCKITEM
             break;
     };
 
     #undef STOCKITEM

-    
-    return NULL;
+
+    // always use wxAcceleratorEntry::IsOk on returned value !
+    return ret;

 }
 
 }
 

-#endif // __WXGTK20__
+#endif // wxUSE_ACCEL
+
+bool wxIsStockLabel(wxWindowID id, const wxString& label)
+{
+    if (label.empty())
+        return true;
+
+    wxString stock = wxGetStockLabel(id);
+
+    if (label == stock)
+        return true;
+
+    stock.Replace(_T("&"), wxEmptyString);
+    if (label == stock)
+        return true;
+
+    return false;
+}