///////////////////////////////////////////////////////////////////////////////
-// Name: common/stockitem.cpp
+// Name: src/common/stockitem.cpp
// Purpose: Stock buttons, menu and toolbar items labels
// Author: Vaclav Slavik
// Modified by:
// Created: 2004-08-15
-// RCS-ID: $Id$
// Copyright: (c) Vaclav Slavik, 2004
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// 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"
#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)
{
- #define STOCKITEM(stockid, label) \
- case stockid: \
- return label; \
- break;
+ switch (id)
+ {
+ case wxID_ABOUT:
+ case wxID_ADD:
+ case wxID_APPLY:
+ case wxID_BACKWARD:
+ case wxID_BOLD:
+ case wxID_BOTTOM:
+ case wxID_CANCEL:
+ case wxID_CDROM:
+ case wxID_CLEAR:
+ case wxID_CLOSE:
+ case wxID_CONVERT:
+ case wxID_COPY:
+ case wxID_CUT:
+ case wxID_DELETE:
+ case wxID_DOWN:
+ case wxID_EDIT:
+ case wxID_EXECUTE:
+ case wxID_EXIT:
+ case wxID_FILE:
+ case wxID_FIND:
+ case wxID_FIRST:
+ case wxID_FLOPPY:
+ case wxID_FORWARD:
+ case wxID_HARDDISK:
+ case wxID_HELP:
+ case wxID_HOME:
+ case wxID_INDENT:
+ case wxID_INDEX:
+ case wxID_INFO:
+ case wxID_ITALIC:
+ case wxID_JUMP_TO:
+ case wxID_JUSTIFY_CENTER:
+ case wxID_JUSTIFY_FILL:
+ case wxID_JUSTIFY_LEFT:
+ case wxID_JUSTIFY_RIGHT:
+ case wxID_LAST:
+ case wxID_NETWORK:
+ case wxID_NEW:
+ case wxID_NO:
+ case wxID_OK:
+ case wxID_OPEN:
+ case wxID_PASTE:
+ case wxID_PREFERENCES:
+ case wxID_PREVIEW:
+ case wxID_PRINT:
+ case wxID_PROPERTIES:
+ case wxID_REDO:
+ case wxID_REFRESH:
+ case wxID_REMOVE:
+ case wxID_REPLACE:
+ case wxID_REVERT_TO_SAVED:
+ case wxID_SAVE:
+ case wxID_SAVEAS:
+ case wxID_SELECTALL:
+ case wxID_SELECT_COLOR:
+ case wxID_SELECT_FONT:
+ case wxID_SORT_ASCENDING:
+ case wxID_SORT_DESCENDING:
+ case wxID_SPELL_CHECK:
+ case wxID_STOP:
+ case wxID_STRIKETHROUGH:
+ case wxID_TOP:
+ case wxID_UNDELETE:
+ case wxID_UNDERLINE:
+ case wxID_UNDO:
+ case wxID_UNINDENT:
+ case wxID_UP:
+ 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;
- switch (item)
+#ifdef __WXMSW__
+ // special case: the "Cancel" button shouldn't have a mnemonic under MSW
+ // for consistency with the native dialogs (which don't use any mnemonic
+ // for it because it is already bound to Esc implicitly)
+ if ( id == wxID_CANCEL )
+ flags &= ~wxSTOCK_WITH_MNEMONIC;
+#endif // __WXMSW__
+
+
+ #define STOCKITEM(stockid, labelWithMnemonic, labelPlain) \
+ case stockid: \
+ if(flags & wxSTOCK_WITH_MNEMONIC) \
+ stockLabel = labelWithMnemonic; \
+ else \
+ stockLabel = labelPlain; \
+ break
+
+ 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"), _("About"));
+ STOCKITEM(wxID_ADD, _("Add"), _("Add"));
+ STOCKITEM(wxID_APPLY, _("&Apply"), _("Apply"));
+ STOCKITEM(wxID_BACKWARD, _("&Back"), _("Back"));
+ STOCKITEM(wxID_BOLD, _("&Bold"), _("Bold"));
+ STOCKITEM(wxID_BOTTOM, _("&Bottom"), _("Bottom"));
+ STOCKITEM(wxID_CANCEL, _("&Cancel"), _("Cancel"));
+ STOCKITEM(wxID_CDROM, _("&CD-Rom"), _("CD-Rom"));
+ STOCKITEM(wxID_CLEAR, _("&Clear"), _("Clear"));
+ STOCKITEM(wxID_CLOSE, _("&Close"), _("Close"));
+ STOCKITEM(wxID_CONVERT, _("&Convert"), _("Convert"));
+ STOCKITEM(wxID_COPY, _("&Copy"), _("Copy"));
+ STOCKITEM(wxID_CUT, _("Cu&t"), _("Cut"));
+ STOCKITEM(wxID_DELETE, _("&Delete"), _("Delete"));
+ STOCKITEM(wxID_DOWN, _("&Down"), _("Down"));
+ STOCKITEM(wxID_EDIT, _("&Edit"), _("Edit"));
+ STOCKITEM(wxID_EXECUTE, _("&Execute"), _("Execute"));
+ STOCKITEM(wxID_EXIT, _("&Quit"), _("Quit"));
+ STOCKITEM(wxID_FILE, _("&File"), _("File"));
+ STOCKITEM(wxID_FIND, _("&Find"), _("Find"));
+ STOCKITEM(wxID_FIRST, _("&First"), _("First"));
+ STOCKITEM(wxID_FLOPPY, _("&Floppy"), _("Floppy"));
+ STOCKITEM(wxID_FORWARD, _("&Forward"), _("Forward"));
+ STOCKITEM(wxID_HARDDISK, _("&Harddisk"), _("Harddisk"));
+ STOCKITEM(wxID_HELP, _("&Help"), _("Help"));
+ STOCKITEM(wxID_HOME, _("&Home"), _("Home"));
+ STOCKITEM(wxID_INDENT, _("Indent"), _("Indent"));
+ STOCKITEM(wxID_INDEX, _("&Index"), _("Index"));
+ STOCKITEM(wxID_INFO, _("&Info"), _("Info"));
+ STOCKITEM(wxID_ITALIC, _("&Italic"), _("Italic"));
+ STOCKITEM(wxID_JUMP_TO, _("&Jump to"), _("Jump to"));
+ STOCKITEM(wxID_JUSTIFY_CENTER, _("Centered"), _("Centered"));
+ STOCKITEM(wxID_JUSTIFY_FILL, _("Justified"), _("Justified"));
+ STOCKITEM(wxID_JUSTIFY_LEFT, _("Align Left"), _("Align Left"));
+ STOCKITEM(wxID_JUSTIFY_RIGHT, _("Align Right"), _("Align Right"));
+ STOCKITEM(wxID_LAST, _("&Last"), _("Last"));
+ STOCKITEM(wxID_NETWORK, _("&Network"), _("Network"));
+ STOCKITEM(wxID_NEW, _("&New"), _("New"));
+ STOCKITEM(wxID_NO, _("&No"), _("No"));
+ STOCKITEM(wxID_OK, _("&OK"), _("OK"));
+ STOCKITEM(wxID_OPEN, _("&Open..."), _("Open..."));
+ STOCKITEM(wxID_PASTE, _("&Paste"), _("Paste"));
+ STOCKITEM(wxID_PREFERENCES, _("&Preferences"), _("Preferences"));
+ STOCKITEM(wxID_PREVIEW, _("Print previe&w..."), _("Print preview..."));
+ STOCKITEM(wxID_PRINT, _("&Print..."), _("Print..."));
+ STOCKITEM(wxID_PROPERTIES, _("&Properties"), _("Properties"));
+ STOCKITEM(wxID_REDO, _("&Redo"), _("Redo"));
+ STOCKITEM(wxID_REFRESH, _("Refresh"), _("Refresh"));
+ STOCKITEM(wxID_REMOVE, _("Remove"), _("Remove"));
+ STOCKITEM(wxID_REPLACE, _("Rep&lace"), _("Replace"));
+ STOCKITEM(wxID_REVERT_TO_SAVED, _("Revert to Saved"), _("Revert to Saved"));
+ STOCKITEM(wxID_SAVE, _("&Save"), _("Save"));
+ STOCKITEM(wxID_SAVEAS, _("&Save as"), _("Save as"));
+ STOCKITEM(wxID_SELECTALL, _("Select &All"), _("Select All"));
+ STOCKITEM(wxID_SELECT_COLOR, _("&Color"), _("Color"));
+ STOCKITEM(wxID_SELECT_FONT, _("&Font"), _("Font"));
+ STOCKITEM(wxID_SORT_ASCENDING, _("&Ascending"), _("Ascending"));
+ STOCKITEM(wxID_SORT_DESCENDING, _("&Descending"), _("Descending"));
+ STOCKITEM(wxID_SPELL_CHECK, _("&Spell Check"), _("Spell Check"));
+ STOCKITEM(wxID_STOP, _("&Stop"), _("Stop"));
+ STOCKITEM(wxID_STRIKETHROUGH, _("&Strikethrough"), _("Strikethrough"));
+ STOCKITEM(wxID_TOP, _("&Top"), _("Top"));
+ STOCKITEM(wxID_UNDELETE, _("Undelete"), _("Undelete"));
+ STOCKITEM(wxID_UNDERLINE, _("&Underline"), _("Underline"));
+ STOCKITEM(wxID_UNDO, _("&Undo"), _("Undo"));
+ STOCKITEM(wxID_UNINDENT, _("&Unindent"), _("Unindent"));
+ STOCKITEM(wxID_UP, _("&Up"), _("Up"));
+ STOCKITEM(wxID_YES, _("&Yes"), _("Yes"));
+ STOCKITEM(wxID_ZOOM_100, _("&Actual Size"), _("Actual Size"));
+ STOCKITEM(wxID_ZOOM_FIT, _("Zoom to &Fit"), _("Zoom to Fit"));
+ STOCKITEM(wxID_ZOOM_IN, _("Zoom &In"), _("Zoom In"));
+ STOCKITEM(wxID_ZOOM_OUT, _("Zoom &Out"), _("Zoom Out"));
+
default:
- wxFAIL_MSG( _T("invalid stock item ID") );
+ wxFAIL_MSG( wxT("invalid stock item ID") );
break;
};
#undef STOCKITEM
-
- return wxEmptyString;
-}
+ if ( flags & wxSTOCK_WITHOUT_ELLIPSIS )
+ {
+ wxString baseLabel;
+ if ( stockLabel.EndsWith("...", &baseLabel) )
+ stockLabel = baseLabel;
-#ifdef __WXGTK20__
+ // accelerators only make sense for the menu items which should have
+ // ellipsis too while wxSTOCK_WITHOUT_ELLIPSIS is mostly useful for
+ // buttons which shouldn't have accelerators in their labels
+ wxASSERT_MSG( !(flags & wxSTOCK_WITH_ACCELERATOR),
+ "labels without ellipsis shouldn't use accelerators" );
+ }
-#include <gtk/gtk.h>
+#if wxUSE_ACCEL
+ if ( !stockLabel.empty() && (flags & wxSTOCK_WITH_ACCELERATOR) )
+ {
+ wxAcceleratorEntry accel = wxGetStockAccelerator(id);
+ if (accel.IsOk())
+ stockLabel << wxT('\t') << accel.ToString();
+ }
+#endif // wxUSE_ACCEL
+
+ return stockLabel;
+}
-const char *wxStockItemToGTK(wxStockItemID item)
+wxString wxGetStockHelpString(wxWindowID id, wxStockHelpStringClient client)
{
- #define STOCKITEM(stockid) \
- case wx##stockid: \
- return GTK_##stockid; \
- break;
-
- #define STOCKITEM_MISSING(stockid) \
- case wx##stockid: \
- return NULL; \
+ wxString stockHelp;
+
+ #define STOCKITEM(stockid, ctx, helpstr) \
+ case stockid: \
+ if (client==ctx) stockHelp = helpstr; \
break;
- #if GTK_CHECK_VERSION(2,4,0)
- #define STOCKITEM_24(stockid) STOCKITEM(stockid)
- #else
- #define STOCKITEM_24(stockid) STOCKITEM_MISSING(stockid)
- #endif
+ 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"))
+
+ default:
+ // there's no stock help string for this ID / client
+ return wxEmptyString;
+ }
+
+ #undef STOCKITEM
+
+ return stockHelp;
+}
+
+#if wxUSE_ACCEL
+
+wxAcceleratorEntry wxGetStockAccelerator(wxWindowID id)
+{
+ wxAcceleratorEntry ret;
+
+ #define STOCKITEM(stockid, flags, keycode) \
+ case stockid: \
+ ret.Set(flags, keycode, stockid); \
+ break;
- switch (item)
+ 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_HELP, wxACCEL_CTRL,'H')
+ STOCKITEM(wxID_NEW, wxACCEL_CTRL,'N')
+ STOCKITEM(wxID_OPEN, wxACCEL_CTRL,'O')
+ STOCKITEM(wxID_PASTE, wxACCEL_CTRL,'V')
+ STOCKITEM(wxID_PRINT, wxACCEL_CTRL,'P')
+ STOCKITEM(wxID_REDO, wxACCEL_CTRL | wxACCEL_SHIFT,'Z')
+ STOCKITEM(wxID_REPLACE, wxACCEL_CTRL,'R')
+ STOCKITEM(wxID_SAVE, wxACCEL_CTRL,'S')
+ STOCKITEM(wxID_UNDO, wxACCEL_CTRL,'Z')
+#ifdef __WXOSX__
+ STOCKITEM(wxID_PREFERENCES, wxACCEL_CTRL,',')
+#endif
+
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
-
- 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(wxT("&"), wxEmptyString);
+ if (label == stock)
+ return true;
+
+ return false;
+}
projects / wxWidgets.git / blobdiff