events.h

//
//  
//    The Laxkit, a windowing toolkit
//    Please consult http://laxkit.sourceforge.net about where to send any
//    correspondence about this software.
//
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Library General Public
//    License as published by the Free Software Foundation; either
//    version 2 of the License, or (at your option) any later version.
//
//    This library is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//    Library General Public License for more details.
//
//    You should have received a copy of the GNU Library General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    Copyright (C) 2010-2013 by Tom Lechner
//
#ifndef _LAX_EVENTS_H
#define _LAX_EVENTS_H

#include <lax/configured.h>

#ifdef _LAX_PLATFORM_XLIB
#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include <X11/Xft/Xft.h>
#include <X11/Xutil.h>
#endif //_LAX_PLATFORM_XLIB


#include <sys/times.h>

#include <lax/anobject.h>
#include <lax/laxdevices.h>


namespace Laxkit {

class anXWindow;
class anXApp;
class LaxDevice;
class LaxMouse;
class LaxKeyboard;


//-------------------------- Event related classes ----------------------------------

//----- EventData mask types -------
//These are used in EventData::type.
//For LAX_RandomEvent, it is assumed that EventData::send_message is defined.
//*** best way to do this???
 //Used by various control windows to determine when
 //to send a message to its owner
#define LAX_RandomEvent        0
 //input and device events
#define LAX_onFocusOn          (1<<0)
#define LAX_onFocusOff         (1<<1)
#define LAX_onMouseIn          (1<<2)
#define LAX_onMouseOut         (1<<3)
#define LAX_onMouseMove        (1<<4)
#define LAX_onButtonDown       (1<<5)
#define LAX_onButtonUp         (1<<6)
#define LAX_onKeyDown          (1<<7)
#define LAX_onKeyUp            (1<<8)
#define LAX_onDeviceChange     (1<<9)
 //state events
#define LAX_onSubmit           (1<<10)
#define LAX_onCancel           (1<<11)
#define LAX_onContentChange    (1<<12)
#define LAX_onSelectionChange  (1<<13)
#define LAX_onUpdateByEvent    (1<<14)
#define LAX_onUngrayed         (1<<15)
#define LAX_onGrayed           (1<<16)
#define LAX_onMapped           (1<<17)
#define LAX_onUnmapped         (1<<18)
 //---other events
 //sent by window controls for various purposes.
 //event->subtype will some value that makes sense to the control
#define LAX_ControlEvent       (1<<19)
#define LAX_ButtonEvent        (1<<20)
#define LAX_ShortcutEvent      (1<<21)
#define LAX_ColorEvent         (1<<22)
#define LAX_UserEvent          (1<<23)

const char *lax_event_name(int e);



//-------------------------- EventData
class EventData
{
    friend class anXApp;
 private:
    int isuserevent;
 public:
    unsigned long type;
    unsigned long subtype;
    char *send_message;

    unsigned long from; //EventReceiver object_id
    unsigned long to;
    //long info[5];
    int propagate;

    clock_t send_time;       //as returned by times()
    unsigned long xlib_time; //as sent in xlib messages

    EventData *next;

    EventData();
    EventData(const char *message, unsigned long fromwindow=0, unsigned long towindow=0);
    EventData(int message,         unsigned long fromwindow=0, unsigned long towindow=0);
    virtual ~EventData();
};

#ifdef _LAX_PLATFORM_XLIB
//-------------------------- XEventData
class XEventData : public EventData
{
 public:
    XEvent *xevent;
};
#endif //_LAX_PLATFORM_XLIB

class RefCountedEventData : public EventData
{
 public:
    anObject *object;
    int info1,info2,info3,info4;
    RefCountedEventData(anObject *obj=NULL);
    virtual ~RefCountedEventData();
    anObject *TheObject();
};

//-------------------------- StrEventData
class StrEventData : public EventData
{
 public:
    char *str;
    int info1,info2,info3,info4;
    StrEventData() { str=NULL; info1=info2=info3=info4=0; }
    StrEventData(unsigned long t, unsigned long f, unsigned long tp, const char *newmes=NULL);
    StrEventData(const char *nstr, int i1,int i2,int i3,int i4,
                 const char *message=NULL,unsigned long fromwindow=0, unsigned long towindow=0);
    virtual ~StrEventData() { if (str) delete[] str; }
};

typedef StrEventData SimpleMessage;

//-------------------------- StrsEventData
class StrsEventData : public EventData
{
 public:
    char **strs;
    int n,info,info2,info3;
    StrsEventData();
    StrsEventData(const char *nstr,const char *message, unsigned long fromwindow, unsigned long towindow);
    virtual ~StrsEventData();
};

//-------------------------- InOutData/EnterExitData/FocusChangeData
class InOutData : public EventData
{
 public:
    //****
    LaxDevice *device;
    anXWindow *target;
    int x,y;
    unsigned long child;
    InOutData(int ntype);
};

typedef InOutData FocusChangeData;
typedef InOutData EnterExitData;

//-------------------------- ButtonEventData
class MouseEventData : public EventData
{
 public:
    int x,y;
    int button, count, size;
    double pressure, tilt, depth;
    unsigned int modifiers; //of paired keyboard, if any

    anXWindow *target;
    LaxMouse *device;

    MouseEventData(int ntype);
    virtual ~MouseEventData();
};

//-------------------------- KeyEventData
class KeyEventData : public EventData
{
 public:
    unsigned int key;
    unsigned int modifiers;
    char *buffer;
    int len;

    LaxKeyboard *device;
    anXWindow *target;

    KeyEventData(int ntype);
    virtual ~KeyEventData();
};

//-------------------------- ScreenEventData
class ScreenEventData : public EventData
{
 public:
    int x,y,width,height; //rectangle that needs refreshing
    ScreenEventData(int xx,int yy,int ww,int hh);
};

//-------------------------- DeviceEventData
#define LAX_DeviceStateChange      1
#define LAX_DeviceChanged          2
#define LAX_DeviceSwitched         3
#define LAX_DeviceHierarchyChange  4

class DeviceEventData : public EventData
{
 public:
    int id,subid; //device id and subid of relevant device

    int xflags, xdev, xattachment, xenabled;
    Time xtime;
    DeviceEventData(int i=0,int si=0);
};


//-------------------------- EventReceiver ----------------------------------------
class EventReceiver : virtual public anObject
{
 public:
    EventReceiver();
    virtual ~EventReceiver();
    virtual int Event(const EventData *data,const char *mes);
};


} //namespace Laxkit

#endif