include/wx/kbdstate.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/kbdstate.h
   3 // Purpose:     Declaration of wxKeyboardState class
   4 // Author:      Vadim Zeitlin
   5 // Created:     2008-09-19
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_KBDSTATE_H_
  12 #define _WX_KBDSTATE_H_
  13
  14 #include "wx/defs.h"
  15
  16 // ----------------------------------------------------------------------------
  17 // wxKeyboardState stores the state of the keyboard modifier keys
  18 // ----------------------------------------------------------------------------
  19
  20 class WXDLLIMPEXP_CORE wxKeyboardState
  21 {
  22 public:
  23     wxKeyboardState(bool controlDown = false,
  24                     bool shiftDown = false,
  25                     bool altDown = false,
  26                     bool metaDown = false)
  27         : m_controlDown(controlDown),
  28           m_shiftDown(shiftDown),
  29           m_altDown(altDown),
  30           m_metaDown(metaDown)
  31     {
  32     }
  33
  34     // default copy ctor, assignment operator and dtor are ok
  35
  36
  37     // accessors for the various modifier keys
  38     // ---------------------------------------
  39
  40     // should be used check if the key event has exactly the given modifiers:
  41     // "GetModifiers() = wxMOD_CONTROL" is easier to write than "ControlDown()
  42     // && !MetaDown() && !AltDown() && !ShiftDown()"
  43     int GetModifiers() const
  44     {
  45         return (m_controlDown ? wxMOD_CONTROL : 0) |
  46                (m_shiftDown ? wxMOD_SHIFT : 0) |
  47                (m_metaDown ? wxMOD_META : 0) |
  48 #ifdef __WXOSX__
  49                (m_rawControlDown ? wxMOD_RAW_CONTROL : 0) |
  50 #endif
  51                (m_altDown ? wxMOD_ALT : 0);
  52     }
  53
  54     // returns true if any modifiers at all are pressed
  55     bool HasModifiers() const { return GetModifiers() != wxMOD_NONE; }
  56
  57     // accessors for individual modifier keys
  58     bool ControlDown() const { return m_controlDown; }
  59     bool RawControlDown() const
  60     {
  61 #ifdef __WXOSX__
  62         return m_rawControlDown;
  63 #else
  64         return m_controlDown;
  65 #endif
  66     }
  67     bool ShiftDown() const { return m_shiftDown; }
  68     bool MetaDown() const { return m_metaDown; }
  69     bool AltDown() const { return m_altDown; }
  70
  71     // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
  72     // Apple ("Command") key under Macs: it makes often sense to use it instead
  73     // of, say, ControlDown() because Cmd key is used for the same thing under
  74     // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
  75     // purpose under Mac)
  76     bool CmdDown() const
  77     {
  78         return ControlDown();
  79     }
  80
  81     // these functions are mostly used by wxWidgets itself
  82     // ---------------------------------------------------
  83
  84     void SetControlDown(bool down) { m_controlDown = down; }
  85     void SetRawControlDown(bool down)
  86     {
  87 #ifdef __WXOSX__
  88         m_rawControlDown = down;
  89 #else
  90         m_controlDown = down;
  91 #endif
  92     }
  93     void SetShiftDown(bool down)   { m_shiftDown = down; }
  94     void SetAltDown(bool down)     { m_altDown = down; }
  95     void SetMetaDown(bool down)    { m_metaDown = down; }
  96
  97
  98     // for backwards compatibility with the existing code accessing these
  99     // members of wxKeyEvent directly, these variables are public, however you
 100     // should not use them in any new code, please use the accessors instead
 101 public:
 102     bool m_controlDown     : 1;
 103     bool m_shiftDown       : 1;
 104     bool m_altDown         : 1;
 105     bool m_metaDown        : 1;
 106 #ifdef __WXOSX__
 107     bool m_rawControlDown : 1;
 108 #endif
 109 };
 110
 111 #endif // _WX_KBDSTATE_H_
 112