[wxWidgets.git] / interface / stockitem.h

/////////////////////////////////////////////////////////////////////////////
    // 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
*/
wxString wxGetStockLabel(wxWindowID id, bool withCodes = @true,
                         const wxString& accelerator = wxEmptyString);
Commit	Line	Data
23324ae1 FM	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	*/
	25	wxString wxGetStockLabel(wxWindowID id, bool withCodes = @true,
	26	const wxString& accelerator = wxEmptyString);
	27
	28
	29