interface/stockitem.h

   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 @a id element.
  11
  12 @param id
  13     given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
  14 @param withCodes
  15     if @false then strip accelerator code from the label;
  16     useful for getting labels without accelerator char code like for toolbar
  17 tooltip or
  18     on platforms without traditional keyboard like smartphones
  19 @param accelerator
  20     optional accelerator string automatically added to label; useful
  21     for building labels for wxMenuItem
  22 */
  23 wxString wxGetStockLabel(wxWindowID id, bool withCodes = true,
  24                          const wxString& accelerator = wxEmptyString);
  25
  26