uevent.hpp

/* ==================================================== ======== ======= *
 *
 *  uevent.hpp
 *  Ubit Project
 *  Author: Eric Lecolinet
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 EricLecolinet / ENST Paris / http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE : 
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE 
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 
 * YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU 
 * GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION; 
 * EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************
 * ==================================================== [(c)Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _uevent_hpp_
#define _uevent_hpp_
//pragma ident  "@(#)uevent.hpp ubit:05.05.00"
#include <ubit/udefs.hpp>
#include <ubit/uchild.hpp>
#include <ubit/ueventImpl.hpp>
namespace ubit {

/* ==================================================== ======== ======= */
class UEvent : public UEventImpl {
public:
  enum {ShiftButton = 1<<0, ControlButton = 1<<2};

  enum {LeftButton = 1<<8, MidButton = 1<<9, RightButton = 1<<10};
     
  enum {MButton1 = LeftButton, MButton2 = MidButton, MButton3 = RightButton};

  virtual UInputEvent* inputEvent() {return null;}
  virtual UMouseEvent* mouseEvent() {return null;}  
  virtual UKeyEvent*   keyEvent()   {return null;}
  virtual UWheelEvent* wheelEvent() {return null;}
  virtual UPaintEvent* paintEvent() {return null;}
  virtual UMessageEvent* messageEvent() {return null;}

  const UCond& getCond() const {return *cond;}
  UGroup* getSource() const;  

  UView* getView() const {return sourceView;}
  UView* getParentView() const;
  
  UBrick* getTarget() const;
  UWin* getWin() const;

  UView* getWinView() const;
  
  UEventFlow* getFlow() const {return eflow;}
  int getFlowID() const;
  UDisp* getDisp() const;
  UNatDisp* getNatDisp() const;

  USysEvent getSysEvent() const {return sys_event;}

  UTime getWhen() const;
      
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // advanced event management (for transparent tools etc.)
    
  bool isConsumed() const {return is_consumed;}
  void consume() {is_consumed = true;}
  bool isIgnored() const {return is_ignored;}
  void ignore() {is_ignored = true;}
  void addFlagdef(const UFlagdef*);
  
  const UFlagdef* getFlagdef(const UFlag&) const;

  const UPropdef* getPropdef(const UFlag&) const;
  
  // void goThrough(UBox*, bool go_through_children = true);
  // events will go through this object.

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // constructors
  
  UEvent(UEventFlow* = null, UView* hardwin_view = null, USysEvent = null,
         UTime = 0, const UCond* = null);
  UEvent(UBrick* source);
private:
  friend class UEventFlow;
  friend class UControl;
  friend class UGroup;
  friend class UView;
};

/* ==================================================== ======== ======= */
class UInputEvent : public UEvent {
public:
  virtual UInputEvent* inputEvent() {return this;}

  int getState() const;
  int getButtonState() const;

  bool isShiftDown() const;
  bool isControlDown() const;
  bool isAltDown() const;
  bool isAltGraphDown() const;
  bool isMetaDown() const;

  virtual bool setPosAndSource(int x_hardwin, int y_hardwin);
  UInputEvent(UEventFlow* f, UView* v, USysEvent e, UTime t, const UCond& c) 
    : UEvent(f,v,e,t,&c) {}
};
  
/* ==================================================== ======== ======= */
class UMouseEvent : public UInputEvent {
public:
  virtual UMouseEvent* mouseEvent() {return this;}

  int getX() const;
  int getY() const;
  
  int getXwin() const {return xmouse;}
  int getYwin() const {return ymouse;}
  
  int getXscreen() const;
  int getYscreen() const;

  virtual int getButton() const;
  virtual int getClickCount() const;
  
  virtual bool isBrowsing() const {return is_browsing;}
  virtual bool isFirstDrag() const;  
  
  virtual UData* getData();
  virtual UStr*  getStr();
  virtual UData* getData(UDataProps&);
  virtual UStr*  getStr(UDataProps&);
  int getButtons() const;
  
  UMouseEvent(UEventFlow* f, UView* v, USysEvent e, UTime t, const UCond& c) 
    : UInputEvent(f,v,e,t,c) {}
};
    
/* ==================================================== ======== ======= */
class UKeyEvent : public UInputEvent {
public:
  virtual UKeyEvent* keyEvent() {return this;}

  virtual unsigned short getKeyChar() const;

  virtual unsigned long getKeyCode() const;
  
  virtual void setKeyChar(unsigned short);
  virtual void setKeyCode(unsigned long);

  virtual int decodeKey();
  // [Impl] decodes a key event, sets its keycode and keychar, returns the number of printable chars.
  
  UKeyEvent(UEventFlow* f, UView* v, USysEvent e, UTime t, const UCond& c)
    : UInputEvent(f,v,e,t,c) {}
};

/* ==================================================== ======== ======= */
class UWheelEvent : public UInputEvent {
public:
  enum {WHEEL_DELTA = 120};
  
  virtual UWheelEvent* wheelEvent() {return this;}

  virtual int getWheelDelta() const;
  UWheelEvent(UEventFlow* f, UView* v, USysEvent e, UTime t, const UCond& c) 
    : UInputEvent(f,v,e,t,c) {}
};

/* ==================================================== ======== ======= */
class UPaintEvent : public UEvent {
public:
  virtual UPaintEvent* paintEvent() {return this;}

  UPaintEvent(UEventFlow*, UView* hardwin_view, USysEvent);
};

/* ==================================================== ======== ======= */
class UMessageEvent : public UEvent {
public:
  virtual UMessageEvent* messageEvent() {return this;}

  const UStr* getMessage() const;
  UMessagePort* getMessagePort() const;
  
  UMessageEvent(UEventFlow* f, UView* v, USysEvent e);
};
  
/* ==================================================== [(c)Elc] ======= */
/* ==================================================== ======== ======= */
struct UDataProps {
  UDataProps(); 
  ~UDataProps();

  UData* data;
  
  UChildIter dataIter, endIter;
  URegion region;
  bool exactMatch;
  int strpos, strpos2;

  UWinContext* winContext;
  UContext* dataContext;
  int getX(UEvent*);
  int getY(UEvent*);
  int getWidth();
  int getHeight();

  // - - impl - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  void set(UContext&, UData*, 
           UChildIter data_iter, UChildIter end_iter, 
           const URegion&, int _strpos, bool exact_match);
           
  void merge(UContext&, UData*,
             UChildIter data_iter, UChildIter end_iter, 
             const URegion&, bool exact_match);
};

}
#endif
/* ==================================================== [TheEnd] ======= */

---