Fix syntax for ID keyword.
[blender-staging.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 /* dna-savable wmStructs here */
32 #include "DNA_windowmanager_types.h"
33
34 struct bContext;
35 struct IDProperty;
36 struct wmEvent;
37 struct wmEventHandler;
38 struct wmGesture;
39 struct wmJob;
40 struct wmNotifier;
41 struct wmOperatorType;
42 struct wmOperator;
43 struct rcti;
44 struct PointerRNA;
45 struct EnumPropertyItem;
46 struct MenuType;
47 struct wmDropBox;
48 struct wmDrag;
49 struct ImBuf;
50
51 typedef struct wmJob wmJob;
52
53 /* general API */
54 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
55
56 void            WM_init                         (struct bContext *C, int argc, char **argv);
57 void            WM_exit                         (struct bContext *C);
58 void            WM_main                         (struct bContext *C);
59
60 void            WM_init_game            (struct bContext *C);
61 void            WM_init_splash          (struct bContext *C);
62
63
64 void            WM_check                        (struct bContext *C);
65
66 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
67
68                         /* defines for 'type' WM_window_open_temp */
69 #define WM_WINDOW_RENDER                0
70 #define WM_WINDOW_USERPREFS             1
71 #define WM_WINDOW_FILESEL               2
72
73 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
74
75
76
77                         /* files */
78 int                     WM_read_homefile        (struct bContext *C, struct wmOperator *op);
79 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
80 void            WM_read_file            (struct bContext *C, char *name, struct ReportList *reports);
81 void            WM_write_file           (struct bContext *C, char *target, int fileflags, struct ReportList *reports);
82 void            WM_read_autosavefile(struct bContext *C);
83 void            WM_autosave_init        (struct wmWindowManager *wm);
84
85                         /* mouse cursors */
86 void            WM_cursor_set           (struct wmWindow *win, int curs);
87 void            WM_cursor_modal         (struct wmWindow *win, int curs);
88 void            WM_cursor_restore       (struct wmWindow *win);
89 void            WM_cursor_wait          (int val);
90 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
91 void            WM_cursor_ungrab(struct wmWindow *win);
92 void            WM_timecursor           (struct wmWindow *win, int nr);
93
94 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
95 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
96
97 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
98
99                         /* keyconfig and keymap */
100 wmKeyConfig *WM_keyconfig_add   (struct wmWindowManager *wm, char *idname);
101 wmKeyConfig *WM_keyconfig_add_user(struct wmWindowManager *wm, char *idname);
102 void            WM_keyconfig_remove     (struct wmWindowManager *wm, struct wmKeyConfig *keyconf);
103 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
104 void            WM_keyconfig_userdef(struct wmWindowManager *wm);
105
106 void            WM_keymap_init          (struct bContext *C);
107 void            WM_keymap_free          (struct wmKeyMap *keymap);
108
109 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, char *idname, int type, 
110                                                                  int val, int modifier, int keymodifier);
111 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, char *idname, int type, 
112                                                                  int val, int modifier, int keymodifier);
113 wmKeyMapItem *WM_keymap_add_menu(struct wmKeyMap *keymap, char *idname, int type,
114                                                                  int val, int modifier, int keymodifier);
115
116 void         WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
117 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
118
119 wmKeyMap        *WM_keymap_list_find(ListBase *lb, char *idname, int spaceid, int regionid);
120 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, char *idname, int spaceid, int regionid);
121 wmKeyMap        *WM_keymap_find_all(const struct bContext *C, char *idname, int spaceid, int regionid);
122 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
123 wmKeyMap        *WM_keymap_guess_opname(const struct bContext *C, char *opname);
124 int                      WM_keymap_user_init(struct wmWindowManager *wm, struct wmKeyMap *keymap);
125 wmKeyMap        *WM_keymap_copy_to_user(struct wmKeyMap *keymap);
126 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap);
127 void            WM_keymap_properties_reset(struct wmKeyMapItem *kmi);
128 void            WM_keymap_restore_item_to_default(struct bContext *C, struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
129
130 wmKeyMapItem *WM_keymap_item_find_id(struct wmKeyMap *keymap, int id);
131 int                     WM_keymap_item_compare(struct wmKeyMapItem *k1, struct wmKeyMapItem *k2);
132 int                     WM_userdef_event_map(int kmitype);
133
134 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, char *idname, struct EnumPropertyItem *items);
135 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, char *idname);
136 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
137 void            WM_modalkeymap_assign(struct wmKeyMap *km, char *opname);
138
139 const char      *WM_key_event_string(short type);
140 int                     WM_key_event_operator_id(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, int hotkey, struct wmKeyMap **keymap_r);
141 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
142
143                         /* handlers */
144
145 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
146                                                 /* boundbox, optional subwindow boundbox for offset */
147 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
148                                                 /* priority not implemented, it adds in begin */
149 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
150
151 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
152
153 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
154                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
155                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
156 void            WM_event_remove_ui_handler(ListBase *handlers,
157                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
158                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
159 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
160
161 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
162 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
163
164 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
165
166                         /* mouse */
167 void            WM_event_add_mousemove(struct bContext *C);
168 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
169
170                         /* notifiers */
171 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
172 void            WM_main_add_notifier(unsigned int type, void *reference);
173
174 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
175
176                         /* at maximum, every timestep seconds it triggers event_type events */
177 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
178 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
179 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
180
181                 /* operator api, default callbacks */
182                         /* invoke callback, uses enum property named "type" */
183 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
184 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
185                         /* invoke callback, confirm menu + exec */
186 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
187                 /* invoke callback, file selector "path" unset + exec */
188 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
189                         /* poll callback, context checks */
190 int                     WM_operator_winactive   (struct bContext *C);
191                         /* invoke callback, exec + redo popup */
192 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
193 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
194 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
195 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
196
197 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, char *message);
198
199                 /* operator api */
200 void            WM_operator_free                (struct wmOperator *op);
201 void            WM_operator_stack_clear(struct bContext *C);
202
203 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
204 struct wmOperatorType *WM_operatortype_exists(const char *idname);
205 struct wmOperatorType *WM_operatortype_first(void);
206 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
207 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
208 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
209 int                     WM_operatortype_remove(const char *idname);
210
211 struct wmOperatorType *WM_operatortype_append_macro(char *idname, char *name, int flag);
212 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
213
214
215 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
216 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
217 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
218 int         WM_operator_name_call       (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
219 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
220
221 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
222 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, int val); /* make props context sensitive or not */
223 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
224 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
225 void            WM_operator_properties_free(struct PointerRNA *ptr);
226 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action);
227 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
228 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
229
230 /* MOVE THIS SOMEWHERE ELSE */
231 #define SEL_TOGGLE              0
232 #define SEL_SELECT              1
233 #define SEL_DESELECT    2
234 #define SEL_INVERT              3
235
236                 /* operator as a python command (resultuing string must be free'd) */
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 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
243 int                                     WM_menutype_add(struct MenuType* mt);
244 void                            WM_menutype_freelink(struct MenuType* mt);
245 void                            WM_menutype_free(void);
246
247                         /* default operator callbacks for border/circle/lasso */
248 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
249 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
250 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
251 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
252 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
253 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
254 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
255 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
256
257                         /* default operator for arearegions, generates event */
258 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
259
260                         /* Gesture manager API */
261 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
262 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
263 void            WM_gestures_remove(struct bContext *C);
264
265                         /* radial control operator */
266 int                     WM_radial_control_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
267 int                     WM_radial_control_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
268 void            WM_OT_radial_control_partial(struct wmOperatorType *ot);
269 void            WM_radial_control_string(struct wmOperator *op, char str[], int maxlen);
270
271                         /* fileselecting support */
272 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
273 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
274
275                         /* drag and drop */
276 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
277 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
278
279 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
280                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
281 ListBase        *WM_dropboxmap_find(char *idname, int spaceid, int regionid);
282
283                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
284 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
285 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
286
287                         /* OpenGL utilities with safety check + working in modelview matrix mode */
288 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
289 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
290 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
291
292                         /* utilities */
293 void            WM_set_framebuffer_index_color(int index);
294 int                     WM_framebuffer_to_index(unsigned int col);
295
296                         /* threaded Jobs Manager */
297 #define WM_JOB_PRIORITY         1
298 #define WM_JOB_EXCL_RENDER      2
299
300 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, int flag);
301
302 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
303
304 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
305 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
306 void            WM_jobs_callbacks(struct wmJob *, 
307                                                           void (*startjob)(void *, short *, short *),
308                                                           void (*initjob)(void *),
309                                                           void (*update)(void *));
310
311 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
312 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner);
313 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner);
314 void            WM_jobs_stop_all(struct wmWindowManager *wm);
315
316                         /* clipboard */
317 char            *WM_clipboard_text_get(int selection);
318 void            WM_clipboard_text_set(char *buf, int selection);
319
320 #endif /* WM_API_H */
321