docs/doxygen/mainpages/const_keymod.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        keymod.h
   3 // Purpose:     key modifiers
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11
  12 @page page_keymodifiers Key Modifiers
  13
  14 @header{wx/defs.h}
  15
  16 The following key modifier constants are defined:
  17
  18 @verbatim
  19     enum wxKeyModifier
  20     {
  21         wxMOD_NONE      = 0x0000,
  22         wxMOD_ALT       = 0x0001,
  23         wxMOD_CONTROL   = 0x0002,
  24         wxMOD_ALTGR     = wxMOD_ALT | wxMOD_CONTROL,
  25         wxMOD_SHIFT     = 0x0004,
  26         wxMOD_META      = 0x0008,
  27     #if defined(__WXMAC__) || defined(__WXCOCOA__)
  28         wxMOD_CMD       = wxMOD_META,
  29     #else
  30         wxMOD_CMD       = wxMOD_CONTROL,
  31     #endif
  32         wxMOD_ALL       = 0xffff
  33     };
  34 @endverbatim
  35
  36 Notice that @c wxMOD_CMD should be used instead of @c wxMOD_CONTROL
  37 in portable code to account for the fact that although
  38 @c Control modifier exists under Mac OS, it is not used for the same
  39 purpose as under Windows or Unix there while the special Mac-specific
  40 @c Command modifier is used in exactly the same way.
  41
  42 */