- fix for crash if drivers were used in the .B.blend
[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 #define WM_HANDLER_HANDLED      2
35 #define WM_HANDLER_MODAL        4 /* MODAL|BREAK means unhandled */
36
37 struct ScrArea;
38 struct ARegion;
39
40 /* wmKeyMap is in DNA_windowmanager.h, it's savable */
41
42 typedef struct wmEventHandler {
43         struct wmEventHandler *next, *prev;
44         
45         int type, flag;                         /* type default=0, rest is custom */
46         
47         /* keymap handler */
48         wmKeyMap *keymap;                       /* pointer to builtin/custom keymaps */
49         rcti *bblocal, *bbwin;          /* optional local and windowspace bb */
50         
51         /* modal operator handler */
52         wmOperator *op;                                         /* for derived/modal handlers */
53         struct ScrArea *op_area;                        /* for derived/modal handlers */
54         struct ARegion *op_region;                      /* for derived/modal handlers */
55
56         /* ui handler */
57         wmUIHandlerFunc ui_handle;              /* callback receiving events */
58         wmUIHandlerRemoveFunc ui_remove;        /* callback when handler is removed */
59         void *ui_userdata;                                      /* user data pointer */
60         struct ScrArea *ui_area;                        /* for derived/modal handlers */
61         struct ARegion *ui_region;                      /* for derived/modal handlers */
62         struct ARegion *ui_menu;                        /* for derived/modal handlers */
63         
64         /* fileselect handler re-uses modal operator data */
65         struct bScreen *filescreen;                     /* screen it started in, to validate exec */
66         
67 } wmEventHandler;
68
69
70 /* handler flag */
71                 /* after this handler all others are ignored */
72 #define WM_HANDLER_BLOCKING             1
73
74
75
76 /* custom types for handlers, for signalling, freeing */
77 enum {
78         WM_HANDLER_DEFAULT,
79         WM_HANDLER_FILESELECT
80 };
81
82
83 /* wm_event_system.c */
84 void            wm_event_add                    (wmWindow *win, wmEvent *event_to_add);
85 void            wm_event_free_all               (wmWindow *win);
86 void            wm_event_free                   (wmEvent *event);
87 void            wm_event_free_handler   (wmEventHandler *handler);
88
89                         /* goes over entire hierarchy:  events -> window -> screen -> area -> region */
90 void            wm_event_do_handlers    (bContext *C);
91
92 void            wm_event_add_ghostevent (wmWindow *win, int type, void *customdata);
93
94 void            wm_event_do_notifiers   (bContext *C);
95
96 /* wm_keymap.c */
97
98
99 #endif /* WM_EVENT_SYSTEM_H */
100