include/wx/os2/accel.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        accel.h
   3 // Purpose:     wxAcceleratorTable class
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/13/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_ACCEL_H_
  13 #define _WX_ACCEL_H_
  14
  15 #include "wx/object.h"
  16
  17 class WXDLLEXPORT wxAcceleratorTable;
  18
  19 // Hold Ctrl key down
  20 #define wxACCEL_ALT     0x01
  21
  22 // Hold Ctrl key down
  23 #define wxACCEL_CTRL    0x02
  24
  25  // Hold Shift key down
  26 #define wxACCEL_SHIFT   0x04
  27
  28  // Hold no key down
  29 #define wxACCEL_NORMAL  0x00
  30
  31 class WXDLLEXPORT wxAcceleratorEntry
  32 {
  33 public:
  34     wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmd = 0)
  35     {
  36         m_flags = flags; m_keyCode = keyCode; m_command = cmd;
  37     }
  38
  39     inline void Set(int flags, int keyCode, int cmd)
  40          { m_flags = flags; m_keyCode = keyCode; m_command = cmd; }
  41
  42     inline int GetFlags() const { return m_flags; }
  43     inline int GetKeyCode() const { return m_keyCode; }
  44     inline int GetCommand() const { return m_command; }
  45
  46     int             m_flags;
  47     int                     m_keyCode; // ASCII or virtual keycode
  48     int                     m_command; // Command id to generate
  49 };
  50
  51 class WXDLLEXPORT wxAcceleratorTable: public wxObject
  52 {
  53 DECLARE_DYNAMIC_CLASS(wxAcceleratorTable)
  54 public:
  55     wxAcceleratorTable();
  56     wxAcceleratorTable(const wxString& rsResource); // Load from .rc resource
  57     wxAcceleratorTable( int                n
  58                        ,wxAcceleratorEntry vaEntries[]
  59                       ); // Load from array
  60
  61     // Copy constructors
  62     inline wxAcceleratorTable(const wxAcceleratorTable& rAccel) { Ref(rAccel); }
  63     inline wxAcceleratorTable(const wxAcceleratorTable* pAccel) { if (pAccel) Ref(*pAccel); }
  64
  65     ~wxAcceleratorTable();
  66
  67     inline wxAcceleratorTable& operator = (const wxAcceleratorTable& rAccel)
  68     { if (*this == rAccel) return (*this); Ref(rAccel); return *this; };
  69     inline bool operator == (const wxAcceleratorTable& rAccel)
  70     { return m_refData == rAccel.m_refData; };
  71     inline bool operator != (const wxAcceleratorTable& rAccel)
  72     { return m_refData != rAccel.m_refData; };
  73
  74     bool Ok() const;
  75     void SetHACCEL(WXHACCEL hAccel);
  76     WXHACCEL GetHACCEL(void) const;
  77
  78     // translate the accelerator, return TRUE if done
  79     bool Translate( WXHWND hWnd
  80                    ,WXMSG* pMsg
  81                   ) const;
  82 };
  83
  84 WXDLLEXPORT_DATA(extern wxAcceleratorTable) wxNullAcceleratorTable;
  85
  86 #endif
  87     // _WX_ACCEL_H_