rename cursor setting functions to make modal set/restore more clearly related functions.
[blender-staging.git] / source / blender / windowmanager / WM_api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26 #ifndef __WM_API_H__
27 #define __WM_API_H__
28
29 /** \file WM_api.h
30  *  \ingroup wm
31  *
32  *  \page wmpage windowmanager
33  *  \section wmabout About windowmanager
34  *  \ref wm handles events received from \ref GHOST and manages
35  *  the screens, areas and input for Blender
36  *  \section wmnote NOTE
37  *  \todo document
38  */
39
40 /* dna-savable wmStructs here */
41 #include "DNA_windowmanager_types.h"
42 #include "WM_keymap.h"
43 #include "BLI_compiler_attrs.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 struct bContext;
50 struct IDProperty;
51 struct wmEvent;
52 struct wmEventHandler;
53 struct wmGesture;
54 struct wmJob;
55 struct wmNotifier;
56 struct wmOperatorType;
57 struct wmOperator;
58 struct rcti;
59 struct PointerRNA;
60 struct PropertyRNA;
61 struct EnumPropertyItem;
62 struct MenuType;
63 struct wmDropBox;
64 struct wmDrag;
65 struct ImBuf;
66 struct ImageFormatData;
67 struct ARegion;
68
69 typedef struct wmJob wmJob;
70
71 /* general API */
72 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
73 void            WM_init_state_fullscreen_set(void);
74 void            WM_init_state_normal_set(void);
75 void            WM_init_native_pixels(bool do_it);
76
77 void            WM_init                         (struct bContext *C, int argc, const char **argv);
78 void            WM_exit_ext                     (struct bContext *C, const short do_python);
79
80 void            WM_exit                         (struct bContext *C) ATTR_NORETURN;
81
82 void            WM_main                         (struct bContext *C) ATTR_NORETURN;
83
84 bool            WM_init_game            (struct bContext *C);
85 void            WM_init_splash          (struct bContext *C);
86
87
88 void            WM_check                        (struct bContext *C);
89
90 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
91
92 int                     WM_window_pixels_x              (struct wmWindow *win);
93 int                     WM_window_pixels_y              (struct wmWindow *win);
94
95 /* defines for 'type' WM_window_open_temp */
96 #define WM_WINDOW_RENDER                0
97 #define WM_WINDOW_USERPREFS             1
98 // #define WM_WINDOW_FILESEL            2  // UNUSED
99
100 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
101                         
102                         /* returns true if draw method is triple buffer */
103 bool            WM_is_draw_triple(struct wmWindow *win);
104
105
106
107                         /* files */
108 void            WM_file_autoexec_init(const char *filepath);
109 void            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
110 void            WM_autosave_init(struct wmWindowManager *wm);
111 void            WM_recover_last_session(struct bContext *C, struct ReportList *reports);
112
113                         /* mouse cursors */
114 void            WM_cursor_set(struct wmWindow *win, int curs);
115 void            WM_cursor_modal_set(struct wmWindow *win, int curs);
116 void            WM_cursor_modal_restore(struct wmWindow *win);
117 void            WM_cursor_wait          (bool val);
118 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
119 void            WM_cursor_grab_disable(struct wmWindow *win, int mouse_ungrab_xy[2]);
120 void            WM_cursor_time          (struct wmWindow *win, int nr);
121
122 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
123                                       int (*poll)(struct bContext *C),
124                                       void (*draw)(struct bContext *C, int, int, void *customdata),
125                                       void *customdata);
126
127 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
128 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
129
130 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
131 float           WM_cursor_pressure      (const struct wmWindow *win);
132
133                         /* event map */
134 int                     WM_userdef_event_map(int kmitype);
135
136                         /* handlers */
137
138 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
139                                                 /* boundbox, optional subwindow boundbox for offset */
140 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
141                                                 /* priority not implemented, it adds in begin */
142 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
143
144 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
145
146 struct wmEventHandler *WM_event_add_ui_handler(
147         const struct bContext *C, ListBase *handlers,
148         int (*func)(struct bContext *C, const struct wmEvent *event, void *userdata),
149         void (*remove)(struct bContext *C, void *userdata), void *userdata);
150
151 void            WM_event_remove_ui_handler(ListBase *handlers,
152                                        int (*func)(struct bContext *C, const struct wmEvent *event, void *userdata),
153                                        void (*remove)(struct bContext *C, void *userdata),
154                                        void *userdata, const bool postpone);
155 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
156 void            WM_event_free_ui_handler_all(struct bContext *C, ListBase *handlers,
157                                          int (*func)(struct bContext *C, const struct wmEvent *event, void *userdata),
158                                          void (*remove)(struct bContext *C, void *userdata));
159
160 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
161 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
162
163 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
164
165                         /* mouse */
166 void            WM_event_add_mousemove(struct bContext *C);
167 int                     WM_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
168
169                         /* notifiers */
170 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
171 void            WM_main_add_notifier(unsigned int type, void *reference);
172 void            WM_main_remove_notifier_reference(const void *reference);
173
174                         /* reports */
175 void        WM_report(const struct bContext *C, ReportType type, const char *message);
176 void        WM_reportf(const struct bContext *C, ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(3, 4);
177
178 void            wm_event_add(struct wmWindow *win, const struct wmEvent *event_to_add);
179 void            wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
180
181
182                         /* at maximum, every timestep seconds it triggers event_type events */
183 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
184 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
185 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
186
187                 /* operator api, default callbacks */
188                         /* invoke callback, uses enum property named "type" */
189 int                     WM_operator_view3d_distance_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
190 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
191 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
192                         /* invoke callback, confirm menu + exec */
193 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
194                 /* invoke callback, file selector "filepath" unset + exec */
195 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
196 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
197                         /* poll callback, context checks */
198 int                     WM_operator_winactive   (struct bContext *C);
199                         /* invoke callback, exec + redo popup */
200 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
201 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
202 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
203 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
204 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
205
206 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
207
208                 /* operator api */
209 void            WM_operator_free                (struct wmOperator *op);
210 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
211 void            WM_operator_stack_clear(struct wmWindowManager *wm);
212 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
213
214 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
215 struct GHashIterator  *WM_operatortype_iter(void);
216 void            WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
217 void            WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
218 void            WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
219 int                     WM_operatortype_remove(const char *idname);
220
221 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
222 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
223
224
225 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
226 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
227 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
228 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
229 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
230 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
231 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
232 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, short is_undo);
233
234 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
235 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
236 int         WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
237 void        WM_operator_properties_reset(struct wmOperator *op);
238 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
239 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
240 void            WM_operator_properties_free(struct PointerRNA *ptr);
241 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag, short display);
242 void        WM_operator_properties_border(struct wmOperatorType *ot);
243 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
244 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, bool extend);
245 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
246 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
247 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
248 void            WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
249
250 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
251 wmOperator *WM_operator_last_redo(const struct bContext *C);
252
253 bool        WM_operator_last_properties_init(struct wmOperator *op);
254 bool        WM_operator_last_properties_store(struct wmOperator *op);
255
256 /* MOVE THIS SOMEWHERE ELSE */
257 #define SEL_TOGGLE              0
258 #define SEL_SELECT              1
259 #define SEL_DESELECT    2
260 #define SEL_INVERT              3
261
262
263 /* flags for WM_operator_properties_filesel */
264 #define WM_FILESEL_RELPATH              (1 << 0)
265
266 #define WM_FILESEL_DIRECTORY    (1 << 1)
267 #define WM_FILESEL_FILENAME             (1 << 2)
268 #define WM_FILESEL_FILEPATH             (1 << 3)
269 #define WM_FILESEL_FILES                (1 << 4)
270
271
272                 /* operator as a python command (resultuing string must be freed) */
273 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
274 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
275 void            WM_operator_bl_idname(char *to, const char *from);
276 void            WM_operator_py_idname(char *to, const char *from);
277
278 /* *************** uilist types ******************** */
279 void                WM_uilisttype_init(void);
280 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
281 int                 WM_uilisttype_add(struct uiListType *ult);
282 void                WM_uilisttype_freelink(struct uiListType *ult);
283 void                WM_uilisttype_free(void);
284
285 /* *************** menu types ******************** */
286 void                WM_menutype_init(void);
287 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
288 int                 WM_menutype_add(struct MenuType *mt);
289 void                WM_menutype_freelink(struct MenuType *mt);
290 void                WM_menutype_free(void);
291
292                         /* default operator callbacks for border/circle/lasso */
293 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
294 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
295 int                     WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
296 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
297 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
298 int                     WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
299 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
300 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
301 int                     WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
302 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
303 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
304 int                     WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
305 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
306 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
307 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
308 int                     WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
309
310                         /* Gesture manager API */
311 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
312 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
313 void            WM_gestures_remove(struct bContext *C);
314
315                         /* fileselecting support */
316 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
317 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
318 #ifndef NDEBUG
319 void            WM_event_print(const struct wmEvent *event);
320 #endif
321
322 void            WM_operator_region_active_win_set(struct bContext *C);
323
324                         /* drag and drop */
325 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
326 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
327
328 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event),
329                                     void (*copy)(struct wmDrag *, struct wmDropBox *));
330 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
331
332                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
333 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
334 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, const struct rcti *srct, bool srct_pad);
335
336                         /* OpenGL utilities with safety check + working in modelview matrix mode */
337 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
338 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
339 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
340
341                         /* utilities */
342 void            WM_framebuffer_index_set(int index);
343 int                     WM_framebuffer_to_index(unsigned int col);
344
345                         /* threaded Jobs Manager */
346 enum {
347         WM_JOB_PRIORITY     = (1 << 0),
348         WM_JOB_EXCL_RENDER  = (1 << 1),
349         WM_JOB_PROGRESS     = (1 << 2),
350         WM_JOB_SUSPEND      = (1 << 3)
351 };
352
353 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
354 enum {
355         WM_JOB_TYPE_ANY = 0,
356         WM_JOB_TYPE_COMPOSITE,
357         WM_JOB_TYPE_RENDER,
358         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
359         WM_JOB_TYPE_SCREENCAST,
360         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
361         WM_JOB_TYPE_OBJECT_SIM_FLUID,
362         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
363         WM_JOB_TYPE_FILESEL_THUMBNAIL,
364         WM_JOB_TYPE_CLIP_BUILD_PROXY,
365         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
366         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
367         WM_JOB_TYPE_CLIP_PREFETCH,
368         WM_JOB_TYPE_SEQ_BUILD_PROXY,
369         /* add as needed, screencast, seq proxy build
370          * if having hard coded values is a problem */
371 };
372
373 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
374
375 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
376 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
377 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
378 void       *WM_jobs_customdata(struct wmWindowManager *wm, void *owner);
379
380 int         WM_jobs_is_running(struct wmJob *);
381 void       *WM_jobs_customdata_get(struct wmJob *);
382 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
383 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
384 void        WM_jobs_callbacks(struct wmJob *,
385                               void (*startjob)(void *, short *, short *, float *),
386                               void (*initjob)(void *),
387                               void (*update)(void *),
388                               void (*endjob)(void *));
389
390 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
391 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
392 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
393 void            WM_jobs_kill_all(struct wmWindowManager *wm);
394 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
395 void            WM_jobs_kill_type(struct wmWindowManager *wm, int job_type);
396
397 int                     WM_jobs_has_running(struct wmWindowManager *wm);
398
399 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
400 void            WM_job_main_thread_lock_release(struct wmJob *job);
401
402                         /* clipboard */
403 char       *WM_clipboard_text_get(int selection);
404 void        WM_clipboard_text_set(char *buf, int selection);
405
406                         /* progress */
407 void            WM_progress_set(struct wmWindow *win, float progress);
408 void            WM_progress_clear(struct wmWindow *win);
409
410                         /* Draw (for screenshot) */
411 void            WM_redraw_windows(struct bContext *C);
412
413 void        WM_main_playanim(int argc, const char **argv);
414
415 /* debugging only, convenience function to write on crash */
416 int write_crash_blend(void);
417
418 #ifdef __cplusplus
419 }
420 #endif
421
422 #endif /* __WM_API_H__ */
423