2.5
[blender.git] / source / blender / windowmanager / wm_event_system.h
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2007 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef WM_EVENT_SYSTEM_H
29 #define WM_EVENT_SYSTEM_H
30
31 /* return value of handler-operator call */
32 #define WM_HANDLER_CONTINUE     0
33 #define WM_HANDLER_BREAK        1
34
35 struct ScrArea;
36 struct ARegion;
37
38 /* wmKeyMap is in DNA_windowmanager.h, it's savable */
39
40 typedef struct wmEventHandler {
41         struct wmEventHandler *next, *prev;
42         
43         int type, flag;                         /* type default=0, rest is custom */
44         
45         /* keymap handler */
46         ListBase *keymap;                       /* pointer to builtin/custom keymaps */
47         
48         rcti *bblocal, *bbwin;          /* optional local and windowspace bb */
49         
50         /* modal operator handler */
51         wmOperator *op;                                         /* for derived/modal handlers */
52         struct ScrArea *op_area;                        /* for derived/modal handlers */
53         struct ARegion *op_region;                      /* for derived/modal handlers */
54
55         /* ui handler */
56         wmUIHandlerFunc ui_handle;              /* callback receiving events */
57         wmUIHandlerRemoveFunc ui_remove;        /* callback when handler is removed */
58         void *ui_userdata;                                      /* user data pointer */
59         struct ScrArea *ui_area;                        /* for derived/modal handlers */
60         struct ARegion *ui_region;                      /* for derived/modal handlers */
61         
62 } wmEventHandler;
63
64
65 /* handler flag */
66                 /* after this handler all others are ignored */
67 #define WM_HANDLER_BLOCKING             1
68
69
70
71 /* custom types for handlers, for signalling, freeing */
72 enum {
73         WM_HANDLER_DEFAULT,
74         WM_HANDLER_TRANSFORM
75 };
76
77
78 /* wm_event_system.c */
79 void            wm_event_add(wmWindow *win, wmEvent *event_to_add);
80 void            wm_event_free_all               (wmWindow *win);
81 wmEvent         *wm_event_next                  (wmWindow *win);
82
83                         /* goes over entire hierarchy:  events -> window -> screen -> area -> region */
84 void            wm_event_do_handlers    (bContext *C);
85
86 void            wm_event_add_ghostevent(wmWindow *win, int type, void *customdata);
87
88 void            wm_event_do_notifiers   (bContext *C);
89 void            wm_draw_update                  (bContext *C);
90
91 /* wm_keymap.c */
92
93
94 #endif /* WM_EVENT_SYSTEM_H */
95