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 /**
  10     Possible values for flags parameter of wxGetStockLabel().
  11
  12     The elements of this enum are bit masks and may be combined with each other
  13     (except when specified otherwise).
  14  */
  15 enum wxStockLabelQueryFlag
  16 {
  17     /**
  18         Indicates absence of wxSTOCK_WITH_MNEMONIC and wxSTOCK_WITH_ACCELERATOR.
  19
  20         Requests just the label (e.g. "Print...").
  21      */
  22     wxSTOCK_NOFLAGS = 0,
  23
  24     /**
  25         Request the label with mnemonics character.
  26
  27         E.g. "&amp;Print...".
  28      */
  29     wxSTOCK_WITH_MNEMONIC = 1,
  30
  31     /**
  32         Return the label with accelerator following it after TAB.
  33
  34         E.g. "Print...\tCtrl-P". This can be combined with
  35         wxSTOCK_WITH_MNEMONIC to get "&Print...\tCtrl-P".
  36      */
  37     wxSTOCK_WITH_ACCELERATOR = 2
  38 };
  39
  40 /** @addtogroup group_funcmacro_misc */
  41 //@{
  42
  43 /**
  44     Returns label that should be used for given @a id element.
  45
  46     @param id
  47         Given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
  48     @param flags
  49         Combination of the elements of wxStockLabelQueryFlag.
  50
  51     @header{wx/stockitem.h}
  52 */
  53 wxString wxGetStockLabel(wxWindowID id, long flags = wxSTOCK_WITH_MNEMONIC);
  54
  55 //@}
  56