better comment for Event_Client_Moving
[mikachu/openbox.git] / openbox / dispatch.h
1 #ifndef __dispatch_h
2 #define __dispatch_h
3
4 #include "client.h"
5 #include <X11/Xlib.h>
6
7 void dispatch_startup();
8 void dispatch_shutdown();
9
10 typedef enum {
11     Event_X_EnterNotify   = 1 << 0, /* pointer entered a window */
12     Event_X_LeaveNotify   = 1 << 1, /* pointer left a window */
13     Event_X_KeyPress      = 1 << 2, /* key pressed */
14     Event_X_KeyRelease    = 1 << 3, /* key released */
15     Event_X_ButtonPress   = 1 << 4, /* mouse button pressed */
16     Event_X_ButtonRelease = 1 << 5, /* mouse button released */
17     Event_X_MotionNotify  = 1 << 6, /* mouse motion */
18     Event_X_Bell          = 1 << 7, /* an XKB bell event */
19
20     Event_Client_New      = 1 << 8, /* new window, before mapping */
21     Event_Client_Mapped   = 1 << 9, /* new window, after mapping */
22     Event_Client_Destroy  = 1 << 10, /* unmanaged */
23     Event_Client_Unmapped = 1 << 11, /* unmanaged, after unmapping */
24     Event_Client_Focus    = 1 << 12, /* focused */
25     Event_Client_Unfocus  = 1 << 13, /* unfocused */
26     Event_Client_Urgent   = 1 << 14, /* entered/left urgent state */
27     Event_Client_Desktop  = 1 << 15, /* moved to a new desktop */
28     Event_Client_Moving   = 1 << 16, /* being interactively moved */
29
30     Event_Ob_Desktop      = 1 << 17, /* changed desktops */
31     Event_Ob_NumDesktops  = 1 << 18, /* changed the number of desktops */
32     Event_Ob_ShowDesktop  = 1 << 19, /* entered/left show-the-desktop mode */
33
34     Event_Signal          = 1 << 20, /* a signal from the OS */
35
36     EVENT_RANGE           = 1 << 21
37 } EventType;
38
39 typedef struct {
40     XEvent *e;
41     Client *client;
42 } EventData_X;
43
44 typedef struct {
45     Client *client;
46     int num[2];
47     /* Event_Client_Desktop: num[0] = new number, num[1] = old number
48        Event_Client_Urgent: num[0] = urgent state
49        Event_Client_Moving: num[0] = dest x coord, num[1] = dest y coord --
50                             change these in the handler to adjust where the
51                             window will be placed
52      */
53 } EventData_Client;
54
55 typedef struct {
56     int num[2];
57     /* Event_Ob_Desktop: num[0] = new number, num[1] = old number
58        Event_Ob_NumDesktops: num[0] = new number, num[1] = old number
59        Event_Ob_ShowDesktop: num[0] = new show-desktop mode
60      */
61 } EventData_Ob;
62
63 typedef struct {
64     int signal;
65 } EventData_Signal;
66
67 typedef struct {
68     EventData_X x;      /* for Event_X_* event types */
69     EventData_Client c; /* for Event_Client_* event types */
70     EventData_Ob o;     /* for Event_Ob_* event types */
71     EventData_Signal s; /* for Event_Signal */
72 } EventData;
73
74 typedef struct {
75     EventType type;
76     EventData data;
77 } ObEvent;
78
79 typedef void (*EventHandler)(const ObEvent *e, void *data);
80
81 typedef unsigned int EventMask;
82
83 void dispatch_register(EventMask mask, EventHandler h, void *data);
84
85 void dispatch_x(XEvent *e, Client *c);
86 void dispatch_client(EventType e, Client *c, int num0, int num1);
87 void dispatch_ob(EventType e, int num0, int num1);
88 void dispatch_signal(int signal);
89 /* *x and *y should be set with the destination of the window, they may be
90    changed by the event handlers */
91 void dispatch_move(Client *c, int *x, int *y);
92
93 #endif