wxWidgets/interface/wx/stockitem.h
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00

84 lines
2.4 KiB
C

/////////////////////////////////////////////////////////////////////////////
// Name: stockitem.h
// Purpose: interface of global functions
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Possible values for flags parameter of wxGetStockLabel().
The elements of this enum are bit masks and may be combined with each other
(except when specified otherwise).
*/
enum wxStockLabelQueryFlag
{
/**
Indicates absence of wxSTOCK_WITH_MNEMONIC and wxSTOCK_WITH_ACCELERATOR.
Requests just the label (e.g. "Print...").
*/
wxSTOCK_NOFLAGS = 0,
/**
Request the label with mnemonics character.
E.g. "&Print...".
*/
wxSTOCK_WITH_MNEMONIC = 1,
/**
Return the label with accelerator following it after TAB.
E.g. "Print...\tCtrl-P". This can be combined with
wxSTOCK_WITH_MNEMONIC to get "&Print...\tCtrl-P".
*/
wxSTOCK_WITH_ACCELERATOR = 2,
/**
Return the label without any ellipsis at the end.
By default, stock items text is returned with ellipsis, if appropriate,
this flag allows to avoid having it. So using the same example as
above, the returned string would be "Print" or "&Print" if
wxSTOCK_WITH_MNEMONIC were also used.
This flag can't be combined with wxSTOCK_WITH_ACCELERATOR.
@since 2.9.1
*/
wxSTOCK_WITHOUT_ELLIPSIS = 4,
/**
Return the label appropriate for a button and not a menu item.
Currently the main difference is that the trailing ellipsis used in
some stock labels is never included in the returned label. Also, the
mnemonics is included if this flag is used. So the returned value for
wxID_PRINT when this flag is used is "&Print".
This flag can't be combined with wxSTOCK_WITH_ACCELERATOR.
@since 2.9.1
*/
wxSTOCK_FOR_BUTTON = wxSTOCK_WITHOUT_ELLIPSIS | wxSTOCK_WITH_MNEMONIC
};
/** @addtogroup 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 flags
Combination of the elements of wxStockLabelQueryFlag.
@header{wx/stockitem.h}
*/
wxString wxGetStockLabel(wxWindowID id, long flags = wxSTOCK_WITH_MNEMONIC);
//@}