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_RAW_CTRL= 0x0008,   //
  38 #else
  39     wxACCEL_RAW_CTRL= wxACCEL_CTRL,
  40 #endif
  41     wxACCEL_CMD     = wxACCEL_CTRL
  42 };
  43
  44 // ----------------------------------------------------------------------------
  45 // an entry in wxAcceleratorTable corresponds to one accelerator
  46 // ----------------------------------------------------------------------------
  47
  48 class WXDLLIMPEXP_CORE wxAcceleratorEntry
  49 {
  50 public:
  51     wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmd = 0,
  52                        wxMenuItem *item = NULL)
  53         : m_flags(flags)
  54         , m_keyCode(keyCode)
  55         , m_command(cmd)
  56         , m_item(item)
  57         { }
  58
  59     wxAcceleratorEntry(const wxAcceleratorEntry& entry)
  60         : m_flags(entry.m_flags)
  61         , m_keyCode(entry.m_keyCode)
  62         , m_command(entry.m_command)
  63         , m_item(entry.m_item)
  64         { }
  65
  66     // create accelerator corresponding to the specified string, return NULL if
  67     // string couldn't be parsed or a pointer to be deleted by the caller
  68     static wxAcceleratorEntry *Create(const wxString& str);
  69
  70     wxAcceleratorEntry& operator=(const wxAcceleratorEntry& entry)
  71     {
  72         if (&entry != this)
  73             Set(entry.m_flags, entry.m_keyCode, entry.m_command, entry.m_item);
  74         return *this;
  75     }
  76
  77     void Set(int flags, int keyCode, int cmd, wxMenuItem *item = NULL)
  78     {
  79         m_flags = flags;
  80         m_keyCode = keyCode;
  81         m_command = cmd;
  82         m_item = item;
  83     }
  84
  85     void SetMenuItem(wxMenuItem *item) { m_item = item; }
  86
  87     int GetFlags() const { return m_flags; }
  88     int GetKeyCode() const { return m_keyCode; }
  89     int GetCommand() const { return m_command; }
  90
  91     wxMenuItem *GetMenuItem() const { return m_item; }
  92
  93     bool operator==(const wxAcceleratorEntry& entry) const
  94     {
  95         return m_flags == entry.m_flags &&
  96                m_keyCode == entry.m_keyCode &&
  97                m_command == entry.m_command &&
  98                m_item == entry.m_item;
  99     }
 100
 101     bool operator!=(const wxAcceleratorEntry& entry) const
 102         { return !(*this == entry); }
 103
 104 #if defined(__WXMOTIF__)
 105     // Implementation use only
 106     bool MatchesEvent(const wxKeyEvent& event) const;
 107 #endif
 108
 109     bool IsOk() const
 110     {
 111         return  m_keyCode != 0;
 112     }
 113
 114
 115     // string <-> wxAcceleratorEntry conversion
 116     // ----------------------------------------
 117
 118     // returns a wxString for the this accelerator.
 119     // this function formats it using the <flags>-<keycode> format
 120     // where <flags> maybe a hyphen-separated list of "shift|alt|ctrl"
 121     wxString ToString() const { return AsPossiblyLocalizedString(true); }
 122
 123     // same as above but without translating, useful if the string is meant to
 124     // be stored in a file or otherwise stored, instead of being shown to the
 125     // user
 126     wxString ToRawString() const { return AsPossiblyLocalizedString(false); }
 127
 128     // returns true if the given string correctly initialized this object
 129     // (i.e. if IsOk() returns true after this call)
 130     bool FromString(const wxString& str);
 131
 132
 133 private:
 134     wxString AsPossiblyLocalizedString(bool localized) const;
 135
 136     // common part of Create() and FromString()
 137     static bool ParseAccel(const wxString& str, int *flags, int *keycode);
 138
 139
 140     int m_flags;    // combination of wxACCEL_XXX constants
 141     int m_keyCode;  // ASCII or virtual keycode
 142     int m_command;  // Command id to generate
 143
 144     // the menu item this entry corresponds to, may be NULL
 145     wxMenuItem *m_item;
 146
 147     // for compatibility with old code, use accessors now!
 148     friend class WXDLLIMPEXP_FWD_CORE wxMenu;
 149 };
 150
 151 // ----------------------------------------------------------------------------
 152 // include wxAcceleratorTable class declaration, it is only used by the library
 153 // and so doesn't have any published user visible interface
 154 // ----------------------------------------------------------------------------
 155
 156 #if defined(__WXUNIVERSAL__)
 157     #include "wx/generic/accel.h"
 158 #elif defined(__WXMSW__)
 159     #include "wx/msw/accel.h"
 160 #elif defined(__WXMOTIF__)
 161     #include "wx/motif/accel.h"
 162 #elif defined(__WXGTK20__)
 163     #include "wx/gtk/accel.h"
 164 #elif defined(__WXGTK__)
 165     #include "wx/gtk1/accel.h"
 166 #elif defined(__WXMAC__)
 167     #include "wx/osx/accel.h"
 168 #elif defined(__WXCOCOA__)
 169     #include "wx/generic/accel.h"
 170 #elif defined(__WXPM__)
 171     #include "wx/os2/accel.h"
 172 #endif
 173
 174 extern WXDLLIMPEXP_DATA_CORE(wxAcceleratorTable) wxNullAcceleratorTable;
 175
 176 #endif // wxUSE_ACCEL
 177
 178 #endif
 179     // _WX_ACCEL_H_BASE_