interface/wx/stockitem.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        stockitem.h
   3 // Purpose:     interface of global functions
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /** @ingroup group_funcmacro_misc */
  10 //@{
  11
  12 /**
  13     Returns label that should be used for given @a id element.
  14
  15     @param id
  16         Given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
  17     @param withCodes
  18         If @false then strip accelerator code from the label; useful for
  19         getting labels without accelerator char code like for toolbar tooltip
  20         or on platforms without traditional keyboard like smartphones.
  21     @param accelerator
  22         Optional accelerator string automatically added to label; useful for
  23         building labels for wxMenuItem.
  24
  25     @header{wx/stockitem.h}
  26 */
  27 wxString wxGetStockLabel(wxWindowID id, bool withCodes = true,
  28                          const wxString& accelerator = wxEmptyString);
  29
  30 //@}
  31