src/common/stockitem.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        common/stockitem.cpp
   3 // Purpose:     Stock buttons, menu and toolbar items labels
   4 // Author:      Vaclav Slavik
   5 // Modified by:
   6 // Created:     2004-08-15
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vaclav Slavik, 2004
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #include "wx/stockitem.h"
  28 #include "wx/intl.h"
  29 #include "wx/utils.h" // for wxStripMenuCodes()
  30
  31 bool wxIsStockID(wxWindowID id)
  32 {
  33     switch (id)
  34     {
  35         case wxID_ADD:
  36         case wxID_APPLY:
  37         case wxID_BOLD:
  38         case wxID_CANCEL:
  39         case wxID_CLEAR:
  40         case wxID_CLOSE:
  41         case wxID_COPY:
  42         case wxID_CUT:
  43         case wxID_DELETE:
  44         case wxID_FIND:
  45         case wxID_REPLACE:
  46         case wxID_BACKWARD:
  47         case wxID_DOWN:
  48         case wxID_FORWARD:
  49         case wxID_UP:
  50         case wxID_HELP:
  51         case wxID_HOME:
  52         case wxID_INDENT:
  53         case wxID_INDEX:
  54         case wxID_ITALIC:
  55         case wxID_JUSTIFY_CENTER:
  56         case wxID_JUSTIFY_FILL:
  57         case wxID_JUSTIFY_LEFT:
  58         case wxID_JUSTIFY_RIGHT:
  59         case wxID_NEW:
  60         case wxID_NO:
  61         case wxID_OK:
  62         case wxID_OPEN:
  63         case wxID_PASTE:
  64         case wxID_PREFERENCES:
  65         case wxID_PRINT:
  66         case wxID_PREVIEW:
  67         case wxID_PROPERTIES:
  68         case wxID_EXIT:
  69         case wxID_REDO:
  70         case wxID_REFRESH:
  71         case wxID_REMOVE:
  72         case wxID_REVERT_TO_SAVED:
  73         case wxID_SAVE:
  74         case wxID_SAVEAS:
  75         case wxID_STOP:
  76         case wxID_UNDELETE:
  77         case wxID_UNDERLINE:
  78         case wxID_UNDO:
  79         case wxID_UNINDENT:
  80         case wxID_YES:
  81         case wxID_ZOOM_100:
  82         case wxID_ZOOM_FIT:
  83         case wxID_ZOOM_IN:
  84         case wxID_ZOOM_OUT:
  85             return true;
  86
  87         default:
  88             return false;
  89     }
  90 }
  91
  92 wxString wxGetStockLabel(wxWindowID id, bool withCodes, const wxString& accelerator)
  93 {
  94     wxString stockLabel;
  95
  96     #define STOCKITEM(stockid, label) \
  97         case stockid:                 \
  98             stockLabel = label;       \
  99             break;
 100
 101     switch (id)
 102     {
 103         STOCKITEM(wxID_ADD,                 _("Add"))
 104         STOCKITEM(wxID_APPLY,               _("&Apply"))
 105         STOCKITEM(wxID_BOLD,                _("&Bold"))
 106         STOCKITEM(wxID_CANCEL,              _("&Cancel"))
 107         STOCKITEM(wxID_CLEAR,               _("&Clear"))
 108         STOCKITEM(wxID_CLOSE,               _("&Close"))
 109         STOCKITEM(wxID_COPY,                _("&Copy"))
 110         STOCKITEM(wxID_CUT,                 _("Cu&t"))
 111         STOCKITEM(wxID_DELETE,              _("&Delete"))
 112         STOCKITEM(wxID_FIND,                _("&Find"))
 113         STOCKITEM(wxID_REPLACE,             _("Rep&lace"))
 114         STOCKITEM(wxID_BACKWARD,            _("&Back"))
 115         STOCKITEM(wxID_DOWN,                _("&Down"))
 116         STOCKITEM(wxID_FORWARD,             _("&Forward"))
 117         STOCKITEM(wxID_UP,                  _("&Up"))
 118         STOCKITEM(wxID_HELP,                _("&Help"))
 119         STOCKITEM(wxID_HOME,                _("&Home"))
 120         STOCKITEM(wxID_INDENT,              _("Indent"))
 121         STOCKITEM(wxID_INDEX,               _("&Index"))
 122         STOCKITEM(wxID_ITALIC,              _("&Italic"))
 123         STOCKITEM(wxID_JUSTIFY_CENTER,      _("Centered"))
 124         STOCKITEM(wxID_JUSTIFY_FILL,        _("Justified"))
 125         STOCKITEM(wxID_JUSTIFY_LEFT,        _("Align Left"))
 126         STOCKITEM(wxID_JUSTIFY_RIGHT,       _("Align Right"))
 127         STOCKITEM(wxID_NEW,                 _("&New"))
 128         STOCKITEM(wxID_NO,                  _("&No"))
 129         STOCKITEM(wxID_OK,                  _("&OK"))
 130         STOCKITEM(wxID_OPEN,                _("&Open"))
 131         STOCKITEM(wxID_PASTE,               _("&Paste"))
 132         STOCKITEM(wxID_PREFERENCES,         _("&Preferences"))
 133         STOCKITEM(wxID_PRINT,               _("&Print"))
 134         STOCKITEM(wxID_PREVIEW,             _("Print previe&w"))
 135         STOCKITEM(wxID_PROPERTIES,          _("&Properties"))
 136         STOCKITEM(wxID_EXIT,                _("&Quit"))
 137         STOCKITEM(wxID_REDO,                _("&Redo"))
 138         STOCKITEM(wxID_REFRESH,             _("Refresh"))
 139         STOCKITEM(wxID_REMOVE,              _("Remove"))
 140         STOCKITEM(wxID_REVERT_TO_SAVED,     _("Revert to Saved"))
 141         STOCKITEM(wxID_SAVE,                _("&Save"))
 142         STOCKITEM(wxID_SAVEAS,              _("Save &As..."))
 143         STOCKITEM(wxID_STOP,                _("&Stop"))
 144         STOCKITEM(wxID_UNDELETE,            _("Undelete"))
 145         STOCKITEM(wxID_UNDERLINE,           _("&Underline"))
 146         STOCKITEM(wxID_UNDO,                _("&Undo"))
 147         STOCKITEM(wxID_UNINDENT,            _("&Unindent"))
 148         STOCKITEM(wxID_YES,                 _("&Yes"))
 149         STOCKITEM(wxID_ZOOM_100,            _("&Actual Size"))
 150         STOCKITEM(wxID_ZOOM_FIT,            _("Zoom to &Fit"))
 151         STOCKITEM(wxID_ZOOM_IN,             _("Zoom &In"))
 152         STOCKITEM(wxID_ZOOM_OUT,            _("Zoom &Out"))
 153
 154         default:
 155             wxFAIL_MSG( _T("invalid stock item ID") );
 156             break;
 157     };
 158
 159     #undef STOCKITEM
 160
 161     if(!withCodes)
 162     {
 163         stockLabel = wxStripMenuCodes( stockLabel );
 164     }
 165     else if (!stockLabel.empty() && !accelerator.empty())
 166     {
 167         stockLabel += _T("\t");
 168         stockLabel += accelerator;
 169     }
 170
 171     return stockLabel;
 172 }
 173
 174 bool wxIsStockLabel(wxWindowID id, const wxString& label)
 175 {
 176     if (label.empty())
 177         return true;
 178
 179     wxString stock = wxGetStockLabel(id);
 180
 181     if (label == stock)
 182         return true;
 183
 184     stock.Replace(_T("&"), wxEmptyString);
 185     if (label == stock)
 186         return true;
 187
 188     return false;
 189 }
 190
 191
 192 #ifdef __WXGTK20__
 193
 194 #include <gtk/gtk.h>
 195
 196 const char *wxGetStockGtkID(wxWindowID id)
 197 {
 198     #define STOCKITEM(wx,gtk)      \
 199         case wx:                   \
 200             return gtk;
 201
 202     #define STOCKITEM_MISSING(wx)  \
 203         case wx:                 \
 204             return NULL;
 205
 206     #if GTK_CHECK_VERSION(2,4,0)
 207         #define STOCKITEM_24(wx,gtk) STOCKITEM(wx,gtk)
 208     #else
 209         #define STOCKITEM_24(wx,gtk) STOCKITEM_MISSING(wx)
 210     #endif
 211
 212     switch (id)
 213     {
 214         STOCKITEM(wxID_ADD,              GTK_STOCK_ADD)
 215         STOCKITEM(wxID_APPLY,            GTK_STOCK_APPLY)
 216         STOCKITEM(wxID_BOLD,             GTK_STOCK_BOLD)
 217         STOCKITEM(wxID_CANCEL,           GTK_STOCK_CANCEL)
 218         STOCKITEM(wxID_CLEAR,            GTK_STOCK_CLEAR)
 219         STOCKITEM(wxID_CLOSE,            GTK_STOCK_CLOSE)
 220         STOCKITEM(wxID_COPY,             GTK_STOCK_COPY)
 221         STOCKITEM(wxID_CUT,              GTK_STOCK_CUT)
 222         STOCKITEM(wxID_DELETE,           GTK_STOCK_DELETE)
 223         STOCKITEM(wxID_FIND,             GTK_STOCK_FIND)
 224         STOCKITEM(wxID_REPLACE,          GTK_STOCK_FIND_AND_REPLACE)
 225         STOCKITEM(wxID_BACKWARD,         GTK_STOCK_GO_BACK)
 226         STOCKITEM(wxID_DOWN,             GTK_STOCK_GO_DOWN)
 227         STOCKITEM(wxID_FORWARD,          GTK_STOCK_GO_FORWARD)
 228         STOCKITEM(wxID_UP,               GTK_STOCK_GO_UP)
 229         STOCKITEM(wxID_HELP,             GTK_STOCK_HELP)
 230         STOCKITEM(wxID_HOME,             GTK_STOCK_HOME)
 231         STOCKITEM_24(wxID_INDENT,        GTK_STOCK_INDENT)
 232         STOCKITEM(wxID_INDEX,            GTK_STOCK_INDEX)
 233         STOCKITEM(wxID_ITALIC,           GTK_STOCK_ITALIC)
 234         STOCKITEM(wxID_JUSTIFY_CENTER,   GTK_STOCK_JUSTIFY_CENTER)
 235         STOCKITEM(wxID_JUSTIFY_FILL,     GTK_STOCK_JUSTIFY_FILL)
 236         STOCKITEM(wxID_JUSTIFY_LEFT,     GTK_STOCK_JUSTIFY_LEFT)
 237         STOCKITEM(wxID_JUSTIFY_RIGHT,    GTK_STOCK_JUSTIFY_RIGHT)
 238         STOCKITEM(wxID_NEW,              GTK_STOCK_NEW)
 239         STOCKITEM(wxID_NO,               GTK_STOCK_NO)
 240         STOCKITEM(wxID_OK,               GTK_STOCK_OK)
 241         STOCKITEM(wxID_OPEN,             GTK_STOCK_OPEN)
 242         STOCKITEM(wxID_PASTE,            GTK_STOCK_PASTE)
 243         STOCKITEM(wxID_PREFERENCES,      GTK_STOCK_PREFERENCES)
 244         STOCKITEM(wxID_PRINT,            GTK_STOCK_PRINT)
 245         STOCKITEM(wxID_PREVIEW,          GTK_STOCK_PRINT_PREVIEW)
 246         STOCKITEM(wxID_PROPERTIES,       GTK_STOCK_PROPERTIES)
 247         STOCKITEM(wxID_EXIT,             GTK_STOCK_QUIT)
 248         STOCKITEM(wxID_REDO,             GTK_STOCK_REDO)
 249         STOCKITEM(wxID_REFRESH,          GTK_STOCK_REFRESH)
 250         STOCKITEM(wxID_REMOVE,           GTK_STOCK_REMOVE)
 251         STOCKITEM(wxID_REVERT_TO_SAVED,  GTK_STOCK_REVERT_TO_SAVED)
 252         STOCKITEM(wxID_SAVE,             GTK_STOCK_SAVE)
 253         STOCKITEM(wxID_SAVEAS,           GTK_STOCK_SAVE_AS)
 254         STOCKITEM(wxID_STOP,             GTK_STOCK_STOP)
 255         STOCKITEM(wxID_UNDELETE,         GTK_STOCK_UNDELETE)
 256         STOCKITEM(wxID_UNDERLINE,        GTK_STOCK_UNDERLINE)
 257         STOCKITEM(wxID_UNDO,             GTK_STOCK_UNDO)
 258         STOCKITEM_24(wxID_UNINDENT,      GTK_STOCK_UNINDENT)
 259         STOCKITEM(wxID_YES,              GTK_STOCK_YES)
 260         STOCKITEM(wxID_ZOOM_100,         GTK_STOCK_ZOOM_100)
 261         STOCKITEM(wxID_ZOOM_FIT,         GTK_STOCK_ZOOM_FIT)
 262         STOCKITEM(wxID_ZOOM_IN,          GTK_STOCK_ZOOM_IN)
 263         STOCKITEM(wxID_ZOOM_OUT,         GTK_STOCK_ZOOM_OUT)
 264
 265         default:
 266             wxFAIL_MSG( _T("invalid stock item ID") );
 267             break;
 268     };
 269
 270     #undef STOCKITEM
 271
 272     return NULL;
 273 }
 274
 275 #endif // __WXGTK20__