[wxWidgets.git] / src / 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
///////////////////////////////////////////////////////////////////////////////

// ============================================================================
// declarations
// ============================================================================

// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------

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

#ifdef __BORLANDC__
    #pragma hdrstop
#endif

#include "wx/stockitem.h"

#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_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;

#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(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_JUSTIFY_CENTER,      _("Centered"),            _("Centered"));
        STOCKITEM(wxID_JUSTIFY_FILL,        _("Justified"),           _("Justified"));
        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_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_SAVE,                _("&Save"),               _("Save"));
        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_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"));

        default:
            wxFAIL_MSG( wxT("invalid stock item ID") );
            break;
    };

    #undef STOCKITEM

    if ( flags & wxSTOCK_WITHOUT_ELLIPSIS )
    {
        wxString baseLabel;
        if ( stockLabel.EndsWith("...", &baseLabel) )
            stockLabel = baseLabel;

        // 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" );
    }

#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;
}

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

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

    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 (id)
    {
        STOCKITEM(wxID_COPY,                wxACCEL_CMD,'C')
        STOCKITEM(wxID_CUT,                 wxACCEL_CMD,'X')
        STOCKITEM(wxID_FIND,                wxACCEL_CMD,'F')
        STOCKITEM(wxID_HELP,                wxACCEL_CMD,'H')
        STOCKITEM(wxID_NEW,                 wxACCEL_CMD,'N')
        STOCKITEM(wxID_OPEN,                wxACCEL_CMD,'O')
        STOCKITEM(wxID_PASTE,               wxACCEL_CMD,'V')
        STOCKITEM(wxID_REDO,                wxACCEL_CMD | wxACCEL_SHIFT,'Z')
        STOCKITEM(wxID_REPLACE,             wxACCEL_CMD,'R')
        STOCKITEM(wxID_SAVE,                wxACCEL_CMD,'S')
        STOCKITEM(wxID_UNDO,                wxACCEL_CMD,'Z')

        default:
            // set the wxAcceleratorEntry to return into an invalid state:
            // there's no stock accelerator for that.
            ret.Set(0, 0, id);
            break;
    };

    #undef STOCKITEM

    // always use wxAcceleratorEntry::IsOk on returned value !
    return ret;
}

#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;
}
Commit	Line	Data
401e3b6e	1	///////////////////////////////////////////////////////////////////////////////
88a7a4e1	2	// Name: src/common/stockitem.cpp
401e3b6e VS	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
401e3b6e VS	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"
88a7a4e1 WS	28
	29	#ifndef WX_PRECOMP
	30	#include "wx/intl.h"
de6185e2	31	#include "wx/utils.h" // for wxStripMenuCodes()
88a7a4e1 WS	32	#endif
88a7a4e1 WS	33
5f7bcb48 VS	34	bool wxIsStockID(wxWindowID id)
	35	{
	36	switch (id)
	37	{
ee0a94cf	38	case wxID_ABOUT:
5f7bcb48 VS	39	case wxID_ADD:
5f7bcb48 VS	40	case wxID_APPLY:
6b1eedc1	41	case wxID_BACKWARD:
5f7bcb48	42	case wxID_BOLD:
6b1eedc1	43	case wxID_BOTTOM:
5f7bcb48	44	case wxID_CANCEL:
6b1eedc1	45	case wxID_CDROM:
5f7bcb48 VS	46	case wxID_CLEAR:
5f7bcb48 VS	47	case wxID_CLOSE:
6b1eedc1	48	case wxID_CONVERT:
5f7bcb48 VS	49	case wxID_COPY:
	50	case wxID_CUT:
	51	case wxID_DELETE:
6b1eedc1	52	case wxID_DOWN:
ee0a94cf	53	case wxID_EDIT:
6b1eedc1 VZ	54	case wxID_EXECUTE:
6b1eedc1 VZ	55	case wxID_EXIT:
ee0a94cf	56	case wxID_FILE:
6b1eedc1 VZ	57	case wxID_FIND:
	58	case wxID_FIRST:
	59	case wxID_FLOPPY:
5f7bcb48	60	case wxID_FORWARD:
6b1eedc1	61	case wxID_HARDDISK:
5f7bcb48 VS	62	case wxID_HELP:
	63	case wxID_HOME:
	64	case wxID_INDENT:
	65	case wxID_INDEX:
6b1eedc1	66	case wxID_INFO:
5f7bcb48	67	case wxID_ITALIC:
6b1eedc1	68	case wxID_JUMP_TO:
5f7bcb48 VS	69	case wxID_JUSTIFY_CENTER:
	70	case wxID_JUSTIFY_FILL:
	71	case wxID_JUSTIFY_LEFT:
	72	case wxID_JUSTIFY_RIGHT:
6b1eedc1 VZ	73	case wxID_LAST:
6b1eedc1 VZ	74	case wxID_NETWORK:
5f7bcb48 VS	75	case wxID_NEW:
	76	case wxID_NO:
	77	case wxID_OK:
	78	case wxID_OPEN:
	79	case wxID_PASTE:
	80	case wxID_PREFERENCES:
5f7bcb48	81	case wxID_PREVIEW:
6b1eedc1	82	case wxID_PRINT:
5f7bcb48	83	case wxID_PROPERTIES:
5f7bcb48 VS	84	case wxID_REDO:
	85	case wxID_REFRESH:
	86	case wxID_REMOVE:
6b1eedc1	87	case wxID_REPLACE:
5f7bcb48 VS	88	case wxID_REVERT_TO_SAVED:
	89	case wxID_SAVE:
	90	case wxID_SAVEAS:
ee0a94cf	91	case wxID_SELECTALL:
6b1eedc1 VZ	92	case wxID_SELECT_COLOR:
	93	case wxID_SELECT_FONT:
	94	case wxID_SORT_ASCENDING:
	95	case wxID_SORT_DESCENDING:
	96	case wxID_SPELL_CHECK:
5f7bcb48	97	case wxID_STOP:
6b1eedc1 VZ	98	case wxID_STRIKETHROUGH:
6b1eedc1 VZ	99	case wxID_TOP:
5f7bcb48 VS	100	case wxID_UNDELETE:
	101	case wxID_UNDERLINE:
	102	case wxID_UNDO:
	103	case wxID_UNINDENT:
6b1eedc1	104	case wxID_UP:
5f7bcb48 VS	105	case wxID_YES:
	106	case wxID_ZOOM_100:
	107	case wxID_ZOOM_FIT:
	108	case wxID_ZOOM_IN:
	109	case wxID_ZOOM_OUT:
	110	return true;
	111
	112	default:
	113	return false;
d0ee33f5	114	}
5f7bcb48 VS	115	}
5f7bcb48 VS	116
ee0a94cf	117	wxString wxGetStockLabel(wxWindowID id, long flags)
401e3b6e	118	{
634629fa WS	119	wxString stockLabel;
634629fa WS	120
f8a1c571 VZ	121	#ifdef __WXMSW__
	122	// special case: the "Cancel" button shouldn't have a mnemonic under MSW
	123	// for consistency with the native dialogs (which don't use any mnemonic
	124	// for it because it is already bound to Esc implicitly)
	125	if ( id == wxID_CANCEL )
	126	flags &= ~wxSTOCK_WITH_MNEMONIC;
	127	#endif // __WXMSW__
	128
	129
	130	#define STOCKITEM(stockid, labelWithMnemonic, labelPlain) \
	131	case stockid: \
	132	if(flags & wxSTOCK_WITH_MNEMONIC) \
	133	stockLabel = labelWithMnemonic; \
	134	else \
	135	stockLabel = labelPlain; \
	136	break
401e3b6e	137
5f7bcb48	138	switch (id)
401e3b6e	139	{
f8a1c571 VZ	140	STOCKITEM(wxID_ABOUT, _("&About..."), _("About..."));
	141	STOCKITEM(wxID_ADD, _("Add"), _("Add"));
	142	STOCKITEM(wxID_APPLY, _("&Apply"), _("Apply"));
	143	STOCKITEM(wxID_BACKWARD, _("&Back"), _("Back"));
	144	STOCKITEM(wxID_BOLD, _("&Bold"), _("Bold"));
	145	STOCKITEM(wxID_BOTTOM, _("&Bottom"), _("Bottom"));
	146	STOCKITEM(wxID_CANCEL, _("&Cancel"), _("Cancel"));
	147	STOCKITEM(wxID_CDROM, _("&CD-Rom"), _("CD-Rom"));
	148	STOCKITEM(wxID_CLEAR, _("&Clear"), _("Clear"));
	149	STOCKITEM(wxID_CLOSE, _("&Close"), _("Close"));
	150	STOCKITEM(wxID_CONVERT, _("&Convert"), _("Convert"));
	151	STOCKITEM(wxID_COPY, _("&Copy"), _("Copy"));
	152	STOCKITEM(wxID_CUT, _("Cu&t"), _("Cut"));
	153	STOCKITEM(wxID_DELETE, _("&Delete"), _("Delete"));
	154	STOCKITEM(wxID_DOWN, _("&Down"), _("Down"));
	155	STOCKITEM(wxID_EDIT, _("&Edit"), _("Edit"));
	156	STOCKITEM(wxID_EXECUTE, _("&Execute"), _("Execute"));
	157	STOCKITEM(wxID_EXIT, _("&Quit"), _("Quit"));
	158	STOCKITEM(wxID_FILE, _("&File"), _("File"));
	159	STOCKITEM(wxID_FIND, _("&Find"), _("Find"));
	160	STOCKITEM(wxID_FIRST, _("&First"), _("First"));
	161	STOCKITEM(wxID_FLOPPY, _("&Floppy"), _("Floppy"));
	162	STOCKITEM(wxID_FORWARD, _("&Forward"), _("Forward"));
	163	STOCKITEM(wxID_HARDDISK, _("&Harddisk"), _("Harddisk"));
	164	STOCKITEM(wxID_HELP, _("&Help"), _("Help"));
	165	STOCKITEM(wxID_HOME, _("&Home"), _("Home"));
	166	STOCKITEM(wxID_INDENT, _("Indent"), _("Indent"));
	167	STOCKITEM(wxID_INDEX, _("&Index"), _("Index"));
	168	STOCKITEM(wxID_INFO, _("&Info"), _("Info"));
	169	STOCKITEM(wxID_ITALIC, _("&Italic"), _("Italic"));
	170	STOCKITEM(wxID_JUSTIFY_CENTER, _("Centered"), _("Centered"));
	171	STOCKITEM(wxID_JUSTIFY_FILL, _("Justified"), _("Justified"));
	172	STOCKITEM(wxID_LAST, _("&Last"), _("Last"));
	173	STOCKITEM(wxID_NETWORK, _("&Network"), _("Network"));
	174	STOCKITEM(wxID_NEW, _("&New"), _("New"));
	175	STOCKITEM(wxID_NO, _("&No"), _("No"));
	176	STOCKITEM(wxID_OK, _("&OK"), _("OK"));
	177	STOCKITEM(wxID_OPEN, _("&Open..."), _("Open..."));
	178	STOCKITEM(wxID_PASTE, _("&Paste"), _("Paste"));
	179	STOCKITEM(wxID_PREFERENCES, _("&Preferences"), _("Preferences"));
	180	STOCKITEM(wxID_PRINT, _("&Print..."), _("Print..."));
	181	STOCKITEM(wxID_PROPERTIES, _("&Properties"), _("Properties"));
	182	STOCKITEM(wxID_REDO, _("&Redo"), _("Redo"));
	183	STOCKITEM(wxID_REFRESH, _("Refresh"), _("Refresh"));
	184	STOCKITEM(wxID_REMOVE, _("Remove"), _("Remove"));
	185	STOCKITEM(wxID_REPLACE, _("Rep&lace"), _("Replace"));
	186	STOCKITEM(wxID_SAVE, _("&Save"), _("Save"));
	187	STOCKITEM(wxID_SELECT_COLOR, _("&Color"), _("Color"));
	188	STOCKITEM(wxID_SELECT_FONT, _("&Font"), _("Font"));
	189	STOCKITEM(wxID_SORT_ASCENDING, _("&Ascending"), _("Ascending"));
	190	STOCKITEM(wxID_SORT_DESCENDING, _("&Descending"), _("Descending"));
	191	STOCKITEM(wxID_STOP, _("&Stop"), _("Stop"));
	192	STOCKITEM(wxID_STRIKETHROUGH, _("&Strikethrough"), _("Strikethrough"));
	193	STOCKITEM(wxID_TOP, _("&Top"), _("Top"));
	194	STOCKITEM(wxID_UNDELETE, _("Undelete"), _("Undelete"));
	195	STOCKITEM(wxID_UNDERLINE, _("&Underline"), _("Underline"));
	196	STOCKITEM(wxID_UNDO, _("&Undo"), _("Undo"));
	197	STOCKITEM(wxID_UNINDENT, _("&Unindent"), _("Unindent"));
	198	STOCKITEM(wxID_UP, _("&Up"), _("Up"));
	199	STOCKITEM(wxID_YES, _("&Yes"), _("Yes"));
5f7bcb48	200
401e3b6e	201	default:
9a83f860	202	wxFAIL_MSG( wxT("invalid stock item ID") );
401e3b6e VS	203	break;
	204	};
	205
	206	#undef STOCKITEM
d775fa82	207
95ad763a	208	if ( flags & wxSTOCK_WITHOUT_ELLIPSIS )
e94ee791 VZ	209	{
	210	wxString baseLabel;
	211	if ( stockLabel.EndsWith("...", &baseLabel) )
	212	stockLabel = baseLabel;
	213
95ad763a VZ	214	// accelerators only make sense for the menu items which should have
	215	// ellipsis too while wxSTOCK_WITHOUT_ELLIPSIS is mostly useful for
	216	// buttons which shouldn't have accelerators in their labels
e94ee791	217	wxASSERT_MSG( !(flags & wxSTOCK_WITH_ACCELERATOR),
95ad763a	218	"labels without ellipsis shouldn't use accelerators" );
e94ee791 VZ	219	}
e94ee791 VZ	220
b137e493	221	#if wxUSE_ACCEL
9b3c3047	222	if ( !stockLabel.empty() && (flags & wxSTOCK_WITH_ACCELERATOR) )
634629fa	223	{
ee0a94cf RR	224	wxAcceleratorEntry accel = wxGetStockAccelerator(id);
ee0a94cf RR	225	if (accel.IsOk())
9a83f860	226	stockLabel << wxT('\t') << accel.ToString();
634629fa	227	}
b137e493 WS	228	#endif // wxUSE_ACCEL
b137e493 WS	229
634629fa	230	return stockLabel;
401e3b6e VS	231	}
401e3b6e VS	232
345319d6 VZ	233	wxString wxGetStockHelpString(wxWindowID id, wxStockHelpStringClient client)
	234	{
	235	wxString stockHelp;
	236
	237	#define STOCKITEM(stockid, ctx, helpstr) \
	238	case stockid: \
	239	if (client==ctx) stockHelp = helpstr; \
	240	break;
	241
	242	switch (id)
	243	{
	244	// NB: these help string should be not too specific as they could be used
	245	// in completely different programs!
	246	STOCKITEM(wxID_ABOUT, wxSTOCK_MENU, _("Show about dialog"))
	247	STOCKITEM(wxID_COPY, wxSTOCK_MENU, _("Copy selection"))
	248	STOCKITEM(wxID_CUT, wxSTOCK_MENU, _("Cut selection"))
	249	STOCKITEM(wxID_DELETE, wxSTOCK_MENU, _("Delete selection"))
	250	STOCKITEM(wxID_REPLACE, wxSTOCK_MENU, _("Replace selection"))
	251	STOCKITEM(wxID_PASTE, wxSTOCK_MENU, _("Paste selection"))
	252	STOCKITEM(wxID_EXIT, wxSTOCK_MENU, _("Quit this program"))
	253	STOCKITEM(wxID_REDO, wxSTOCK_MENU, _("Redo last action"))
	254	STOCKITEM(wxID_UNDO, wxSTOCK_MENU, _("Undo last action"))
	255	STOCKITEM(wxID_CLOSE, wxSTOCK_MENU, _("Close current document"))
	256	STOCKITEM(wxID_SAVE, wxSTOCK_MENU, _("Save current document"))
	257	STOCKITEM(wxID_SAVEAS, wxSTOCK_MENU, _("Save current document with a different filename"))
	258
	259	default:
	260	// there's no stock help string for this ID / client
	261	return wxEmptyString;
	262	}
	263
	264	#undef STOCKITEM
	265
	266	return stockHelp;
	267	}
	268
b137e493 WS	269	#if wxUSE_ACCEL
b137e493 WS	270
ee0a94cf RR	271	wxAcceleratorEntry wxGetStockAccelerator(wxWindowID id)
	272	{
	273	wxAcceleratorEntry ret;
	274
	275	#define STOCKITEM(stockid, flags, keycode) \
	276	case stockid: \
	277	ret.Set(flags, keycode, stockid); \
	278	break;
	279
	280	switch (id)
	281	{
ad7aff71 SC	282	STOCKITEM(wxID_COPY, wxACCEL_CMD,'C')
	283	STOCKITEM(wxID_CUT, wxACCEL_CMD,'X')
	284	STOCKITEM(wxID_FIND, wxACCEL_CMD,'F')
	285	STOCKITEM(wxID_HELP, wxACCEL_CMD,'H')
	286	STOCKITEM(wxID_NEW, wxACCEL_CMD,'N')
	287	STOCKITEM(wxID_OPEN, wxACCEL_CMD,'O')
	288	STOCKITEM(wxID_PASTE, wxACCEL_CMD,'V')
	289	STOCKITEM(wxID_REDO, wxACCEL_CMD \| wxACCEL_SHIFT,'Z')
	290	STOCKITEM(wxID_REPLACE, wxACCEL_CMD,'R')
	291	STOCKITEM(wxID_SAVE, wxACCEL_CMD,'S')
	292	STOCKITEM(wxID_UNDO, wxACCEL_CMD,'Z')
ee0a94cf RR	293
	294	default:
	295	// set the wxAcceleratorEntry to return into an invalid state:
	296	// there's no stock accelerator for that.
	297	ret.Set(0, 0, id);
	298	break;
	299	};
	300
	301	#undef STOCKITEM
	302
	303	// always use wxAcceleratorEntry::IsOk on returned value !
	304	return ret;
	305	}
	306
b137e493 WS	307	#endif // wxUSE_ACCEL
b137e493 WS	308
5f7bcb48 VS	309	bool wxIsStockLabel(wxWindowID id, const wxString& label)
	310	{
	311	if (label.empty())
	312	return true;
	313
	314	wxString stock = wxGetStockLabel(id);
	315
	316	if (label == stock)
	317	return true;
d775fa82	318
9a83f860	319	stock.Replace(wxT("&"), wxEmptyString);
5f7bcb48 VS	320	if (label == stock)
5f7bcb48 VS	321	return true;
d775fa82	322
5f7bcb48 VS	323	return false;
5f7bcb48 VS	324	}