switch language in User Preference's System page. with some known switch failure...
[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
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 EnumPropertyItem;
61 struct MenuType;
62 struct wmDropBox;
63 struct wmDrag;
64 struct ImBuf;
65
66 typedef struct wmJob wmJob;
67
68 /* general API */
69 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
70 void            WM_setinitialstate_fullscreen(void);
71 void            WM_setinitialstate_normal(void);
72
73 void            WM_init                         (struct bContext *C, int argc, const char **argv);
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, ListBase *wmbase);
97 int                     WM_read_homefile_proc(struct bContext *C, ListBase *wmbase);
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                         /* keyconfig and keymap */
119 wmKeyConfig *WM_keyconfig_new   (struct wmWindowManager *wm, const char *idname);
120 wmKeyConfig *WM_keyconfig_new_user(struct wmWindowManager *wm, const char *idname);
121 void            WM_keyconfig_remove     (struct wmWindowManager *wm, struct wmKeyConfig *keyconf);
122 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
123 void            WM_keyconfig_userdef(void);
124
125 void            WM_keymap_init          (struct bContext *C);
126 void            WM_keymap_free          (struct wmKeyMap *keymap);
127
128 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, const char *idname, int type, 
129                                                                  int val, int modifier, int keymodifier);
130 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, const char *idname, int type, 
131                                                                  int val, int modifier, int keymodifier);
132 wmKeyMapItem *WM_keymap_add_menu(struct wmKeyMap *keymap, const char *idname, int type,
133                                                                  int val, int modifier, int keymodifier);
134
135 void            WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
136 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
137
138 wmKeyMap        *WM_keymap_list_find(ListBase *lb, const char *idname, int spaceid, int regionid);
139 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid);
140 wmKeyMap        *WM_keymap_find_all(const struct bContext *C, const char *idname, int spaceid, int regionid);
141 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
142 wmKeyMap        *WM_keymap_guess_opname(const struct bContext *C, const char *opname);
143 int                      WM_keymap_user_init(struct wmWindowManager *wm, struct wmKeyMap *keymap);
144 wmKeyMap        *WM_keymap_copy_to_user(struct wmKeyMap *keymap);
145 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap);
146 void            WM_keymap_properties_reset(struct wmKeyMapItem *kmi, struct IDProperty *properties);
147 void            WM_keymap_restore_item_to_default(struct bContext *C, struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
148
149 wmKeyMapItem *WM_keymap_item_find_id(struct wmKeyMap *keymap, int id);
150 int                     WM_keymap_item_compare(struct wmKeyMapItem *k1, struct wmKeyMapItem *k2);
151 int                     WM_userdef_event_map(int kmitype);
152
153 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, const char *idname, struct EnumPropertyItem *items);
154 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, const char *idname);
155 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
156 void            WM_modalkeymap_assign(struct wmKeyMap *km, const char *opname);
157
158 const char      *WM_key_event_string(short type);
159 int                     WM_key_event_operator_id(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, int hotkey, struct wmKeyMap **keymap_r);
160 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
161
162                         /* handlers */
163
164 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
165                                                 /* boundbox, optional subwindow boundbox for offset */
166 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
167                                                 /* priority not implemented, it adds in begin */
168 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
169
170 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
171
172 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
173                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
174                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
175 void            WM_event_remove_ui_handler(ListBase *handlers,
176                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
177                         void (*remove)(struct bContext *C, void *userdata), void *userdata, int postpone);
178 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
179
180 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
181 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
182
183 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
184
185                         /* mouse */
186 void            WM_event_add_mousemove(struct bContext *C);
187 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
188
189                         /* notifiers */
190 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
191 void            WM_main_add_notifier(unsigned int type, void *reference);
192
193 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
194
195                         /* at maximum, every timestep seconds it triggers event_type events */
196 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
197 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
198 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
199
200                 /* operator api, default callbacks */
201                         /* invoke callback, uses enum property named "type" */
202 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
203 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
204                         /* invoke callback, confirm menu + exec */
205 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
206                 /* invoke callback, file selector "filepath" unset + exec */
207 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
208                         /* poll callback, context checks */
209 int                     WM_operator_winactive   (struct bContext *C);
210                         /* invoke callback, exec + redo popup */
211 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
212 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
213 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
214 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
215
216 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
217
218                 /* operator api */
219 void            WM_operator_free                (struct wmOperator *op);
220 void            WM_operator_stack_clear(struct wmWindowManager *wm);
221
222 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
223 struct wmOperatorType *WM_operatortype_first(void);
224 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
225 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
226 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
227 int                     WM_operatortype_remove(const char *idname);
228
229 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, int flag);
230 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
231
232
233 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
234 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, int context);
235 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
236 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
237 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
238 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
239 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
240
241 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
242 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const short no_context); /* make props context sensitive or not */
243 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
244 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
245 void            WM_operator_properties_free(struct PointerRNA *ptr);
246 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag);
247 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
248 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
249 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
250
251 wmOperator *WM_operator_last_redo(const struct bContext *C);
252
253 /* MOVE THIS SOMEWHERE ELSE */
254 #define SEL_TOGGLE              0
255 #define SEL_SELECT              1
256 #define SEL_DESELECT    2
257 #define SEL_INVERT              3
258
259
260 /* flags for WM_operator_properties_filesel */
261 #define WM_FILESEL_RELPATH              (1 << 0)
262
263 #define WM_FILESEL_DIRECTORY    (1 << 1)
264 #define WM_FILESEL_FILENAME             (1 << 2)
265 #define WM_FILESEL_FILEPATH             (1 << 3)
266
267
268                 /* operator as a python command (resultuing string must be free'd) */
269 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
270 void            WM_operator_bl_idname(char *to, const char *from);
271 void            WM_operator_py_idname(char *to, const char *from);
272
273 /* *************** menu types ******************** */
274 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
275 int                                     WM_menutype_add(struct MenuType* mt);
276 void                            WM_menutype_freelink(struct MenuType* mt);
277 void                            WM_menutype_free(void);
278
279                         /* default operator callbacks for border/circle/lasso */
280 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
281 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
282 int                     WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
283 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
284 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
285 int                     WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
286 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
287 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
288 int                     WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
289 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
290 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
291 int                     WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
292 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
293 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
294 int                     WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
295
296                         /* default operator for arearegions, generates event */
297 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
298
299                         /* Gesture manager API */
300 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
301 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
302 void            WM_gestures_remove(struct bContext *C);
303
304                         /* fileselecting support */
305 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
306 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
307
308                         /* drag and drop */
309 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
310 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
311
312 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
313                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
314 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
315
316                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
317 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
318 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
319
320                         /* OpenGL utilities with safety check + working in modelview matrix mode */
321 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
322 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
323 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
324
325                         /* utilities */
326 void            WM_set_framebuffer_index_color(int index);
327 int                     WM_framebuffer_to_index(unsigned int col);
328
329                         /* threaded Jobs Manager */
330 #define WM_JOB_PRIORITY         1
331 #define WM_JOB_EXCL_RENDER      2
332 #define WM_JOB_PROGRESS         4
333 #define WM_JOB_SUSPEND          8
334
335 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag);
336
337 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
338 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
339 char            *WM_jobs_name(struct wmWindowManager *wm, void *owner);
340
341 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
342 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
343 void            WM_jobs_callbacks(struct wmJob *, 
344                                                           void (*startjob)(void *, short *, short *, float *),
345                                                           void (*initjob)(void *),
346                                                           void (*update)(void *),
347                                                           void (*endjob)(void *));
348
349 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
350 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
351 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
352 void            WM_jobs_stop_all(struct wmWindowManager *wm);
353
354                         /* clipboard */
355 char            *WM_clipboard_text_get(int selection);
356 void            WM_clipboard_text_set(char *buf, int selection);
357
358                         /* progress */
359 void            WM_progress_set(struct wmWindow *win, float progress);
360 void            WM_progress_clear(struct wmWindow *win);
361
362 #ifdef WIN32
363                         /* Windows System Console */
364 void            WM_console_toggle(struct bContext *C, short show);
365 #endif
366
367 /* debugging only, convenience function to write on crash */
368 int write_crash_blend(void);
369
370 #ifdef __cplusplus
371 }
372 #endif
373
374 #endif /* WM_API_H */
375