Merging r39652 through r39842 from trunk into vgroup_modifiers.
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
29 /** \file blender/windowmanager/wm_event_system.h
30  *  \ingroup wm
31  */
32
33 #ifndef WM_EVENT_SYSTEM_H
34 #define WM_EVENT_SYSTEM_H
35
36 /* return value of handler-operator call */
37 #define WM_HANDLER_CONTINUE     0
38 #define WM_HANDLER_BREAK        1
39 #define WM_HANDLER_HANDLED      2
40 #define WM_HANDLER_MODAL        4 /* MODAL|BREAK means unhandled */
41
42 struct ScrArea;
43 struct ARegion;
44
45 /* wmKeyMap is in DNA_windowmanager.h, it's savable */
46
47 typedef struct wmEventHandler {
48         struct wmEventHandler *next, *prev;
49         
50         int type, flag;                         /* type default=0, rest is custom */
51         
52         /* keymap handler */
53         wmKeyMap *keymap;                       /* pointer to builtin/custom keymaps */
54         rcti *bblocal, *bbwin;          /* optional local and windowspace bb */
55         
56         /* modal operator handler */
57         wmOperator *op;                                         /* for derived/modal handlers */
58         struct ScrArea *op_area;                        /* for derived/modal handlers */
59         struct ARegion *op_region;                      /* for derived/modal handlers */
60
61         /* ui handler */
62         wmUIHandlerFunc ui_handle;              /* callback receiving events */
63         wmUIHandlerRemoveFunc ui_remove;        /* callback when handler is removed */
64         void *ui_userdata;                                      /* user data pointer */
65         struct ScrArea *ui_area;                        /* for derived/modal handlers */
66         struct ARegion *ui_region;                      /* for derived/modal handlers */
67         struct ARegion *ui_menu;                        /* for derived/modal handlers */
68         
69         /* fileselect handler re-uses modal operator data */
70         struct bScreen *filescreen;                     /* screen it started in, to validate exec */
71         
72         /* drop box handler */
73         ListBase *dropboxes;
74         
75 } wmEventHandler;
76
77
78 /* handler flag */
79                 /* after this handler all others are ignored */
80 #define WM_HANDLER_BLOCKING             1
81                 /* handler tagged to be freed in wm_handlers_do() */
82 #define WM_HANDLER_DO_FREE              2
83
84
85
86 /* custom types for handlers, for signalling, freeing */
87 enum {
88         WM_HANDLER_DEFAULT,
89         WM_HANDLER_FILESELECT
90 };
91
92
93 /* wm_event_system.c */
94 void            wm_event_free_all               (wmWindow *win);
95 void            wm_event_free                   (wmEvent *event);
96 void            wm_event_free_handler   (wmEventHandler *handler);
97
98                         /* goes over entire hierarchy:  events -> window -> screen -> area -> region */
99 void            wm_event_do_handlers    (bContext *C);
100
101 void            wm_event_add_ghostevent (wmWindowManager *wm, wmWindow *win, int type, int time, void *customdata);
102
103 void            wm_event_do_notifiers   (bContext *C);
104
105 /* wm_keymap.c */
106
107 /* wm_dropbox.c */
108 void            wm_dropbox_free(void);
109 void            wm_drags_check_ops(bContext *C, wmEvent *event);
110 void            wm_drags_draw(bContext *C, wmWindow *win, rcti *rect);
111
112 #endif /* WM_EVENT_SYSTEM_H */
113