X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/stockitem.h diff --git a/interface/stockitem.h b/interface/stockitem.h index 3bcf0b2d08..61f958d3ee 100644 --- a/interface/stockitem.h +++ b/interface/stockitem.h @@ -1,29 +1,31 @@ ///////////////////////////////////////////////////////////////////////////// - // Name: stockitem.h - // Purpose: documentation for global functions - // Author: wxWidgets team - // RCS-ID: $Id$ - // Licence: wxWindows license - ///////////////////////////////////////////////////////////////////////////// - - /** - Returns label that should be used for given @e id element. - - @param id - given id of the wxMenuItem, wxButton, wxToolBar tool, etc. - - @param withCodes - if @false then strip accelerator code from the label; - useful for getting labels without accelerator char code like for toolbar - tooltip or - on platforms without traditional keyboard like smartphones - - @param accelerator - optional accelerator string automatically added to label; useful - for building labels for wxMenuItem +// Name: stockitem.h +// Purpose: interface of global functions +// Author: wxWidgets team +// RCS-ID: $Id$ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** @ingroup group_funcmacro_misc */ +//@{ + +/** + Returns label that should be used for given @a id element. + + @param id + Given id of the wxMenuItem, wxButton, wxToolBar tool, etc. + @param withCodes + If @false then strip accelerator code from the label; useful for + getting labels without accelerator char code like for toolbar tooltip + or on platforms without traditional keyboard like smartphones. + @param accelerator + Optional accelerator string automatically added to label; useful for + building labels for wxMenuItem. + + @header{wx/stockitem.h} */ -wxString wxGetStockLabel(wxWindowID id, bool withCodes = @true, +wxString wxGetStockLabel(wxWindowID id, bool withCodes = true, const wxString& accelerator = wxEmptyString); +//@} - \ No newline at end of file