src/actions.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; -*-
   2 #ifndef __actions_hh
   3 #define __actions_hh
   4
   5 /*! @file actions.hh
   6   @brief The action interface for user-available actions
   7 */
   8
   9 #include "otk/display.hh"
  10 #include "otk/point.hh"
  11 #include "otk/rect.hh"
  12 #include "otk/eventhandler.hh"
  13
  14 namespace ob {
  15
  16 //! The action interface for user-available actions
  17 /*!
  18   When these actions are fired, hooks to the guile engine are fired so that
  19   guile code is run.
  20 */
  21 class OBActions : public otk::OtkEventHandler {
  22 public:
  23   struct MouseButtonAction {
  24     Window win;
  25     unsigned int button;
  26     Time time;
  27     MouseButtonAction() { win = 0; button = 0; time = 0; }
  28   };
  29
  30 private:
  31   // milliseconds XXX: config option
  32   static const unsigned int DOUBLECLICKDELAY;
  33
  34   //! The last 2 button release processed for CLICKs
  35   MouseButtonAction _release;
  36   //! The mouse button currently being watched from a press for a CLICK
  37   unsigned int _button;
  38   //! The window the last enter action occured on (where the mouse is located)
  39   Window _enter_win;
  40
  41   void insertPress(Window win, unsigned int button, Time time);
  42
  43 public:
  44   OBActions();
  45   virtual ~OBActions();
  46
  47   virtual void buttonPressHandler(const XButtonEvent &e);
  48   virtual void buttonReleaseHandler(const XButtonEvent &e);
  49
  50
  51
  52
  53   //! Notify that a mouse enter action has occured on a window.
  54   /*!
  55     @param win The window on which the action was performed.
  56     @param modifiers The modifier state for the action.
  57   */
  58   void enter(Window win, unsigned int modifiers);
  59
  60   //! Notify that a mouse leave action has occured on a window.
  61   /*!
  62     @param modifiers The modifier state for the action.
  63   */
  64   void leave(unsigned int modifiers);
  65
  66   //! Notify that a mouse drag is taking place.
  67   /*!
  68     @param win The window the drag is on
  69     @param delta The change in position of the mouse pointer
  70     @param modifiers The modifier state during the drag.
  71   */
  72   void drag(Window win, otk::Point delta, unsigned int modifiers,
  73             unsigned int button, Time time);
  74
  75   //! Notify that a key press has occured on a window.
  76   /*!
  77     @param win The window the key press was on
  78     @param modifiers The modifier state for the action.
  79     @param keycode The keycode of the key pressed.
  80   */
  81   void key(Window win, unsigned int modifiers, unsigned int keycode);
  82 };
  83
  84 }
  85
  86 #endif // __actions_hh