]> git.saurik.com Git - wxWidgets.git/blame_incremental - interface/stockitem.h
make it callable from any path
[wxWidgets.git] / interface / stockitem.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2 // Name: stockitem.h
3 // Purpose: documentation for global functions
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
8
9 /**
10 Returns label that should be used for given @e id element.
11
12 @param id
13 given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
14
15 @param withCodes
16 if @false then strip accelerator code from the label;
17 useful for getting labels without accelerator char code like for toolbar
18 tooltip or
19 on platforms without traditional keyboard like smartphones
20
21 @param accelerator
22 optional accelerator string automatically added to label; useful
23 for building labels for wxMenuItem
24*/
25wxString wxGetStockLabel(wxWindowID id, bool withCodes = @true,
26 const wxString& accelerator = wxEmptyString);
27
28
29