include/wx/univ/inphand.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/inphand.h
   3 // Purpose:     wxInputHandler class maps the keyboard and mouse events to the
   4 //              actions which then are performed by the control
   5 // Author:      Vadim Zeitlin
   6 // Modified by:
   7 // Created:     18.08.00
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
  10 // Licence:     wxWindows license
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_UNIV_INPHAND_H_
  14 #define _WX_UNIV_INPHAND_H_
  15
  16 #ifdef __GNUG__
  17     #pragma interface "inphand.h"
  18 #endif
  19
  20 #include "wx/univ/inpcons.h"         // for wxControlAction(s)
  21
  22 // ----------------------------------------------------------------------------
  23 // types of the standard input handlers which can be passed to
  24 // wxTheme::GetInputHandler()
  25 // ----------------------------------------------------------------------------
  26
  27 #define wxINP_HANDLER_DEFAULT           _T("")
  28 #define wxINP_HANDLER_BUTTON            _T("button")
  29 #define wxINP_HANDLER_CHECKBOX          _T("checkbox")
  30 #define wxINP_HANDLER_CHECKLISTBOX      _T("checklistbox")
  31 #define wxINP_HANDLER_COMBOBOX          _T("combobox")
  32 #define wxINP_HANDLER_LISTBOX           _T("listbox")
  33 #define wxINP_HANDLER_NOTEBOOK          _T("notebook")
  34 #define wxINP_HANDLER_RADIOBTN          _T("radiobtn")
  35 #define wxINP_HANDLER_SCROLLBAR         _T("scrollbar")
  36 #define wxINP_HANDLER_SLIDER            _T("slider")
  37 #define wxINP_HANDLER_SPINBTN           _T("spinbtn")
  38 #define wxINP_HANDLER_TEXTCTRL          _T("textctrl")
  39 #define wxINP_HANDLER_TOPLEVEL          _T("toplevel")
  40
  41 // ----------------------------------------------------------------------------
  42 // wxInputHandler: maps the events to the actions
  43 // ----------------------------------------------------------------------------
  44
  45 class WXDLLEXPORT wxInputHandler : public wxObject
  46 {
  47 public:
  48     // map a keyboard event to one or more actions (pressed == TRUE if the key
  49     // was pressed, FALSE if released), returns TRUE if something was done
  50     virtual bool HandleKey(wxInputConsumer *consumer,
  51                            const wxKeyEvent& event,
  52                            bool pressed) = 0;
  53
  54     // map a mouse (click) event to one or more actions
  55     virtual bool HandleMouse(wxInputConsumer *consumer,
  56                              const wxMouseEvent& event) = 0;
  57
  58     // handle mouse movement (or enter/leave) event: it is separated from
  59     // HandleMouse() for convenience as many controls don't care about mouse
  60     // movements at all
  61     virtual bool HandleMouseMove(wxInputConsumer *consumer,
  62                                  const wxMouseEvent& event);
  63
  64     // do something with focus set/kill event: this is different from
  65     // HandleMouseMove() as the mouse maybe over the control without it having
  66     // focus
  67     //
  68     // return TRUE to refresh the control, FALSE otherwise
  69     virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
  70
  71     // react to the app getting/losing activation
  72     //
  73     // return TRUE to refresh the control, FALSE otherwise
  74     virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
  75
  76     // virtual dtor for any base class
  77     virtual ~wxInputHandler();
  78 };
  79
  80 // ----------------------------------------------------------------------------
  81 // wxStdInputHandler is just a base class for all other "standard" handlers
  82 // and also provides the way to chain input handlers together
  83 // ----------------------------------------------------------------------------
  84
  85 class WXDLLEXPORT wxStdInputHandler : public wxInputHandler
  86 {
  87 public:
  88     wxStdInputHandler(wxInputHandler *handler) : m_handler(handler) { }
  89
  90     virtual bool HandleKey(wxInputConsumer *consumer,
  91                            const wxKeyEvent& event,
  92                            bool pressed)
  93     {
  94         return m_handler ? m_handler->HandleKey(consumer, event, pressed)
  95                          : FALSE;
  96     }
  97
  98     virtual bool HandleMouse(wxInputConsumer *consumer,
  99                              const wxMouseEvent& event)
 100     {
 101         return m_handler ? m_handler->HandleMouse(consumer, event) : FALSE;
 102     }
 103
 104     virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event)
 105     {
 106         return m_handler ? m_handler->HandleMouseMove(consumer, event) : FALSE;
 107     }
 108
 109     virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event)
 110     {
 111         return m_handler ? m_handler->HandleFocus(consumer, event) : FALSE;
 112     }
 113
 114 private:
 115     wxInputHandler *m_handler;
 116 };
 117
 118 #endif // _WX_UNIV_INPHAND_H_