include/wx/accel.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/accel.h
   3 // Purpose:     wxAcceleratorEntry and wxAcceleratorTable classes
   4 // Author:      Julian Smart, Robert Roebling, Vadim Zeitlin
   5 // Modified by:
   6 // Created:     31.05.01 (extracted from other files)
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_ACCEL_H_BASE_
  13 #define _WX_ACCEL_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_ACCEL
  18
  19 #include "wx/object.h"
  20
  21 class WXDLLIMPEXP_FWD_CORE wxAcceleratorTable;
  22 class WXDLLIMPEXP_FWD_CORE wxMenuItem;
  23 class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
  24
  25 // ----------------------------------------------------------------------------
  26 // constants
  27 // ----------------------------------------------------------------------------
  28
  29 // wxAcceleratorEntry flags
  30 enum wxAcceleratorEntryFlags
  31 {
  32     wxACCEL_NORMAL  = 0x0000,   // no modifiers
  33     wxACCEL_ALT     = 0x0001,   // hold Alt key down
  34     wxACCEL_CTRL    = 0x0002,   // hold Ctrl key down
  35     wxACCEL_SHIFT   = 0x0004,   // hold Shift key down
  36 #if defined(__WXMAC__) || defined(__WXCOCOA__)
  37     wxACCEL_CMD      = 0x0008   // Command key on OS X
  38 #else
  39     wxACCEL_CMD      = wxACCEL_CTRL
  40 #endif
  41 };
  42
  43 // ----------------------------------------------------------------------------
  44 // an entry in wxAcceleratorTable corresponds to one accelerator
  45 // ----------------------------------------------------------------------------
  46
  47 class WXDLLIMPEXP_CORE wxAcceleratorEntry
  48 {
  49 public:
  50     wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmd = 0,
  51                        wxMenuItem *item = NULL)
  52         : m_flags(flags)
  53         , m_keyCode(keyCode)
  54         , m_command(cmd)
  55         , m_item(item)
  56         { }
  57
  58     wxAcceleratorEntry(const wxAcceleratorEntry& entry)
  59         : m_flags(entry.m_flags)
  60         , m_keyCode(entry.m_keyCode)
  61         , m_command(entry.m_command)
  62         , m_item(entry.m_item)
  63         { }
  64
  65     // create accelerator corresponding to the specified string, return NULL if
  66     // string couldn't be parsed or a pointer to be deleted by the caller
  67     static wxAcceleratorEntry *Create(const wxString& str);
  68
  69     wxAcceleratorEntry& operator=(const wxAcceleratorEntry& entry)
  70     {
  71         if (&entry != this)
  72             Set(entry.m_flags, entry.m_keyCode, entry.m_command, entry.m_item);
  73         return *this;
  74     }
  75
  76     void Set(int flags, int keyCode, int cmd, wxMenuItem *item = NULL)
  77     {
  78         m_flags = flags;
  79         m_keyCode = keyCode;
  80         m_command = cmd;
  81         m_item = item;
  82     }
  83
  84     void SetMenuItem(wxMenuItem *item) { m_item = item; }
  85
  86     int GetFlags() const { return m_flags; }
  87     int GetKeyCode() const { return m_keyCode; }
  88     int GetCommand() const { return m_command; }
  89
  90     wxMenuItem *GetMenuItem() const { return m_item; }
  91
  92     bool operator==(const wxAcceleratorEntry& entry) const
  93     {
  94         return m_flags == entry.m_flags &&
  95                m_keyCode == entry.m_keyCode &&
  96                m_command == entry.m_command &&
  97                m_item == entry.m_item;
  98     }
  99
 100     bool operator!=(const wxAcceleratorEntry& entry) const
 101         { return !(*this == entry); }
 102
 103 #if defined(__WXMOTIF__)
 104     // Implementation use only
 105     bool MatchesEvent(const wxKeyEvent& event) const;
 106 #endif
 107
 108     bool IsOk() const
 109     {
 110         return  m_keyCode != 0;
 111     }
 112
 113
 114     // string <-> wxAcceleratorEntry conversion
 115     // ----------------------------------------
 116
 117     // returns a wxString for the this accelerator.
 118     // this function formats it using the <flags>-<keycode> format
 119     // where <flags> maybe a hyphen-separated list of "shift|alt|ctrl"
 120     wxString ToString() const;
 121
 122     // returns true if the given string correctly initialized this object
 123     // (i.e. if IsOk() returns true after this call)
 124     bool FromString(const wxString& str);
 125
 126
 127 private:
 128     // common part of Create() and FromString()
 129     static bool ParseAccel(const wxString& str, int *flags, int *keycode);
 130
 131
 132     int m_flags;    // combination of wxACCEL_XXX constants
 133     int m_keyCode;  // ASCII or virtual keycode
 134     int m_command;  // Command id to generate
 135
 136     // the menu item this entry corresponds to, may be NULL
 137     wxMenuItem *m_item;
 138
 139     // for compatibility with old code, use accessors now!
 140     friend class WXDLLIMPEXP_FWD_CORE wxMenu;
 141 };
 142
 143 // ----------------------------------------------------------------------------
 144 // include wxAcceleratorTable class declaration, it is only used by the library
 145 // and so doesn't have any published user visible interface
 146 // ----------------------------------------------------------------------------
 147
 148 #if defined(__WXUNIVERSAL__)
 149     #include "wx/generic/accel.h"
 150 #elif defined(__WXMSW__)
 151     #include "wx/msw/accel.h"
 152 #elif defined(__WXMOTIF__)
 153     #include "wx/motif/accel.h"
 154 #elif defined(__WXGTK20__)
 155     #include "wx/gtk/accel.h"
 156 #elif defined(__WXGTK__)
 157     #include "wx/gtk1/accel.h"
 158 #elif defined(__WXMAC__)
 159     #include "wx/osx/accel.h"
 160 #elif defined(__WXCOCOA__)
 161     #include "wx/generic/accel.h"
 162 #elif defined(__WXPM__)
 163     #include "wx/os2/accel.h"
 164 #endif
 165
 166 extern WXDLLIMPEXP_DATA_CORE(wxAcceleratorTable) wxNullAcceleratorTable;
 167
 168 #endif // wxUSE_ACCEL
 169
 170 #endif
 171     // _WX_ACCEL_H_BASE_