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