Merging r39312 through r39329 from trunk into soc-2011-tomato
[blender.git] / source / blender / windowmanager / WM_api.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 #ifndef WM_API_H
29 #define WM_API_H
30
31 /** \file WM_api.h
32  *  \ingroup wm
33  *
34  *  \page wmpage windowmanager
35  *  \section wmabout About windowmanager
36  *  \ref wm handles events received from \ref GHOST and manages
37  *  the screens, areas and input for Blender
38  *  \section wmnote NOTE
39  *  \todo document
40  */
41
42 /* dna-savable wmStructs here */
43 #include "DNA_windowmanager_types.h"
44 #include "WM_keymap.h"
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 struct bContext;
51 struct IDProperty;
52 struct wmEvent;
53 struct wmEventHandler;
54 struct wmGesture;
55 struct wmJob;
56 struct wmNotifier;
57 struct wmOperatorType;
58 struct wmOperator;
59 struct rcti;
60 struct PointerRNA;
61 struct EnumPropertyItem;
62 struct MenuType;
63 struct wmDropBox;
64 struct wmDrag;
65 struct ImBuf;
66
67 typedef struct wmJob wmJob;
68
69 /* general API */
70 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
71 void            WM_setinitialstate_fullscreen(void);
72 void            WM_setinitialstate_normal(void);
73
74 void            WM_init                         (struct bContext *C, int argc, const char **argv);
75 void            WM_exit                         (struct bContext *C);
76 void            WM_main                         (struct bContext *C);
77
78 int             WM_init_game            (struct bContext *C);
79 void            WM_init_splash          (struct bContext *C);
80
81
82 void            WM_check                        (struct bContext *C);
83
84 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
85
86                         /* defines for 'type' WM_window_open_temp */
87 #define WM_WINDOW_RENDER                0
88 #define WM_WINDOW_USERPREFS             1
89 #define WM_WINDOW_FILESEL               2
90
91 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
92
93
94
95                         /* files */
96 int                     WM_read_homefile_exec(struct bContext *C, struct wmOperator *op);
97 int                     WM_read_homefile        (struct bContext *C, struct ReportList *reports, short from_memory);
98 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
99 void            WM_read_file            (struct bContext *C, const char *filepath, struct ReportList *reports);
100 int                     WM_write_file           (struct bContext *C, const char *target, int fileflags, struct ReportList *reports, int copy);
101 void            WM_read_autosavefile(struct bContext *C);
102 void            WM_autosave_init        (struct wmWindowManager *wm);
103
104                         /* mouse cursors */
105 void            WM_cursor_set           (struct wmWindow *win, int curs);
106 void            WM_cursor_modal         (struct wmWindow *win, int curs);
107 void            WM_cursor_restore       (struct wmWindow *win);
108 void            WM_cursor_wait          (int val);
109 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
110 void            WM_cursor_ungrab(struct wmWindow *win);
111 void            WM_timecursor           (struct wmWindow *win, int nr);
112
113 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
114 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
115
116 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
117
118                         /* event map */
119 int                     WM_userdef_event_map(int kmitype);
120
121                         /* handlers */
122
123 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
124                                                 /* boundbox, optional subwindow boundbox for offset */
125 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
126                                                 /* priority not implemented, it adds in begin */
127 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
128
129 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
130
131 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
132                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
133                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
134 void            WM_event_remove_ui_handler(ListBase *handlers,
135                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
136                         void (*remove)(struct bContext *C, void *userdata), void *userdata, int postpone);
137 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
138
139 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
140 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
141
142 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
143
144                         /* mouse */
145 void            WM_event_add_mousemove(struct bContext *C);
146 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
147
148                         /* notifiers */
149 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
150 void            WM_main_add_notifier(unsigned int type, void *reference);
151
152 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
153
154                         /* at maximum, every timestep seconds it triggers event_type events */
155 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
156 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
157 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
158
159                 /* operator api, default callbacks */
160                         /* invoke callback, uses enum property named "type" */
161 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
162 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
163                         /* invoke callback, confirm menu + exec */
164 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
165                 /* invoke callback, file selector "filepath" unset + exec */
166 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
167                         /* poll callback, context checks */
168 int                     WM_operator_winactive   (struct bContext *C);
169                         /* invoke callback, exec + redo popup */
170 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
171 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
172 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
173 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
174
175 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
176
177                 /* operator api */
178 void            WM_operator_free                (struct wmOperator *op);
179 void            WM_operator_stack_clear(struct wmWindowManager *wm);
180
181 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
182 struct GHashIterator *WM_operatortype_iter(void);
183 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
184 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
185 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
186 int                     WM_operatortype_remove(const char *idname);
187
188 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, int flag);
189 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
190
191
192 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
193 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, int context);
194 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
195 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
196 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
197 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
198 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
199
200 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
201 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const short no_context); /* make props context sensitive or not */
202 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
203 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
204 void            WM_operator_properties_free(struct PointerRNA *ptr);
205 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag);
206 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
207 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
208 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
209
210 wmOperator *WM_operator_last_redo(const struct bContext *C);
211
212 /* MOVE THIS SOMEWHERE ELSE */
213 #define SEL_TOGGLE              0
214 #define SEL_SELECT              1
215 #define SEL_DESELECT    2
216 #define SEL_INVERT              3
217
218
219 /* flags for WM_operator_properties_filesel */
220 #define WM_FILESEL_RELPATH              (1 << 0)
221
222 #define WM_FILESEL_DIRECTORY    (1 << 1)
223 #define WM_FILESEL_FILENAME             (1 << 2)
224 #define WM_FILESEL_FILEPATH             (1 << 3)
225 #define WM_FILESEL_FILES                (1 << 4)
226
227
228                 /* operator as a python command (resultuing string must be free'd) */
229 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
230 void            WM_operator_bl_idname(char *to, const char *from);
231 void            WM_operator_py_idname(char *to, const char *from);
232
233 /* *************** menu types ******************** */
234 void                            WM_menutype_init(void);
235 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
236 int                                     WM_menutype_add(struct MenuType* mt);
237 int                                     WM_menutype_contains(struct MenuType* mt);
238 void                            WM_menutype_freelink(struct MenuType* mt);
239 void                            WM_menutype_free(void);
240
241                         /* default operator callbacks for border/circle/lasso */
242 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
243 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
244 int                     WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
245 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
246 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
247 int                     WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
248 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
249 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
250 int                     WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
251 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
252 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
253 int                     WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
254 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
255 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
256 int                     WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
257
258                         /* default operator for arearegions, generates event */
259 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
260
261                         /* Gesture manager API */
262 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
263 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
264 void            WM_gestures_remove(struct bContext *C);
265
266                         /* fileselecting support */
267 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
268 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
269
270                         /* drag and drop */
271 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
272 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
273
274 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
275                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
276 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
277
278                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
279 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
280 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
281
282                         /* OpenGL utilities with safety check + working in modelview matrix mode */
283 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
284 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
285 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
286
287                         /* utilities */
288 void            WM_set_framebuffer_index_color(int index);
289 int                     WM_framebuffer_to_index(unsigned int col);
290
291                         /* threaded Jobs Manager */
292 #define WM_JOB_PRIORITY         1
293 #define WM_JOB_EXCL_RENDER      2
294 #define WM_JOB_PROGRESS         4
295 #define WM_JOB_SUSPEND          8
296
297 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag);
298
299 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
300 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
301 char            *WM_jobs_name(struct wmWindowManager *wm, void *owner);
302
303 int             WM_jobs_is_running(struct wmJob *);
304 void*           WM_jobs_get_customdata(struct wmJob *);
305 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
306 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
307 void            WM_jobs_callbacks(struct wmJob *, 
308                                                           void (*startjob)(void *, short *, short *, float *),
309                                                           void (*initjob)(void *),
310                                                           void (*update)(void *),
311                                                           void (*endjob)(void *));
312
313 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
314 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
315 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
316 void            WM_jobs_stop_all(struct wmWindowManager *wm);
317
318                         /* clipboard */
319 char            *WM_clipboard_text_get(int selection);
320 void            WM_clipboard_text_set(char *buf, int selection);
321
322                         /* progress */
323 void            WM_progress_set(struct wmWindow *win, float progress);
324 void            WM_progress_clear(struct wmWindow *win);
325
326 #ifdef WIN32
327                         /* Windows System Console */
328 void            WM_console_toggle(struct bContext *C, short show);
329 #endif
330
331 /* debugging only, convenience function to write on crash */
332 int write_crash_blend(void);
333
334 #ifdef __cplusplus
335 }
336 #endif
337
338 #endif /* WM_API_H */
339