Drag and drop 2.5 integration! Finally, slashdot regulars can use
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_splash          (struct bContext *C);
61
62
63 void            WM_check                        (struct bContext *C);
64
65 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
66
67                         /* defines for 'type' WM_window_open_temp */
68 #define WM_WINDOW_RENDER                0
69 #define WM_WINDOW_USERPREFS             1
70 #define WM_WINDOW_FILESEL               2
71
72 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
73
74
75
76                         /* files */
77 int                     WM_read_homefile        (struct bContext *C, struct wmOperator *op);
78 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
79 void            WM_read_file            (struct bContext *C, char *name, struct ReportList *reports);
80 void            WM_write_file           (struct bContext *C, char *target, int fileflags, struct ReportList *reports);
81 void            WM_read_autosavefile(struct bContext *C);
82 void            WM_autosave_init        (struct wmWindowManager *wm);
83
84                         /* mouse cursors */
85 void            WM_cursor_set           (struct wmWindow *win, int curs);
86 void            WM_cursor_modal         (struct wmWindow *win, int curs);
87 void            WM_cursor_restore       (struct wmWindow *win);
88 void            WM_cursor_wait          (int val);
89 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
90 void            WM_cursor_ungrab(struct wmWindow *win);
91 void            WM_timecursor           (struct wmWindow *win, int nr);
92
93 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
94 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
95
96 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
97
98                         /* keyconfig and keymap */
99 wmKeyConfig *WM_keyconfig_add   (struct wmWindowManager *wm, char *idname);
100 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
101 void            WM_keyconfig_userdef(struct wmWindowManager *wm);
102
103 void            WM_keymap_init          (struct bContext *C);
104 void            WM_keymap_free          (struct wmKeyMap *keymap);
105
106 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, char *idname, int type, 
107                                                                  int val, int modifier, int keymodifier);
108 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, char *idname, int type, 
109                                                                  int val, int modifier, int keymodifier);
110 wmKeyMapItem *WM_keymap_add_menu(struct wmKeyMap *keymap, char *idname, int type,
111                                                                  int val, int modifier, int keymodifier);
112
113 void         WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
114 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
115
116 wmKeyMap        *WM_keymap_list_find(ListBase *lb, char *idname, int spaceid, int regionid);
117 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, char *idname, int spaceid, int regionid);
118 wmKeyMap        *WM_keymap_find_all(const struct bContext *C, char *idname, int spaceid, int regionid);
119 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
120 wmKeyMap        *WM_keymap_guess_opname(const struct bContext *C, char *opname);
121 int                      WM_keymap_user_init(struct wmWindowManager *wm, struct wmKeyMap *keymap);
122 wmKeyMap        *WM_keymap_copy_to_user(struct wmKeyMap *keymap);
123 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap);
124 void            WM_keymap_properties_reset(struct wmKeyMapItem *kmi);
125 void            WM_keymap_restore_item_to_default(struct bContext *C, struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
126
127 wmKeyMapItem *WM_keymap_item_find_id(struct wmKeyMap *keymap, int id);
128 int                     WM_keymap_item_compare(struct wmKeyMapItem *k1, struct wmKeyMapItem *k2);
129 int                     WM_userdef_event_map(int kmitype);
130
131 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, char *idname, struct EnumPropertyItem *items);
132 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, char *idname);
133 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
134 void            WM_modalkeymap_assign(struct wmKeyMap *km, char *opname);
135
136 const char      *WM_key_event_string(short type);
137 int                     WM_key_event_operator_id(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, int hotkey, struct wmKeyMap **keymap_r);
138 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
139
140                         /* handlers */
141
142 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
143                                                 /* boundbox, optional subwindow boundbox for offset */
144 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
145                                                 /* priority not implemented, it adds in begin */
146 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
147
148 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
149
150 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
151                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
152                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
153 void            WM_event_remove_ui_handler(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_area_handler(struct ListBase *handlers, void *area);
157
158 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
159 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
160
161 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
162
163                         /* mouse */
164 void            WM_event_add_mousemove(struct bContext *C);
165 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
166
167                         /* notifiers */
168 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
169 void            WM_main_add_notifier(unsigned int type, void *reference);
170
171 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
172
173                         /* at maximum, every timestep seconds it triggers event_type events */
174 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
175 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
176 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
177
178                 /* operator api, default callbacks */
179                         /* invoke callback, uses enum property named "type" */
180 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
181 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
182                         /* invoke callback, confirm menu + exec */
183 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
184                 /* invoke callback, file selector "path" unset + exec */
185 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
186                         /* poll callback, context checks */
187 int                     WM_operator_winactive   (struct bContext *C);
188                         /* invoke callback, exec + redo popup */
189 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
190 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
191 void            WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
192
193 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, char *message);
194
195                 /* operator api */
196 void            WM_operator_free                (struct wmOperator *op);
197 void            WM_operator_stack_clear(struct bContext *C);
198
199 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
200 struct wmOperatorType *WM_operatortype_exists(const char *idname);
201 struct wmOperatorType *WM_operatortype_first(void);
202 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
203 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
204 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
205 int                     WM_operatortype_remove(const char *idname);
206
207 struct wmOperatorType *WM_operatortype_append_macro(char *idname, char *name, int flag);
208 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
209
210
211 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
212 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
213 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
214 int         WM_operator_name_call       (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
215 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
216
217 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
218 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
219 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
220 void            WM_operator_properties_free(struct PointerRNA *ptr);
221 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type);
222 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
223 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
224
225 /* MOVE THIS SOMEWHERE ELSE */
226 #define SEL_TOGGLE              0
227 #define SEL_SELECT              1
228 #define SEL_DESELECT    2
229 #define SEL_INVERT              3
230
231                 /* operator as a python command (resultuing string must be free'd) */
232 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
233 void            WM_operator_bl_idname(char *to, const char *from);
234 void            WM_operator_py_idname(char *to, const char *from);
235
236 /* *************** menu types ******************** */
237 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
238 int                                     WM_menutype_add(struct MenuType* mt);
239 void                            WM_menutype_freelink(struct MenuType* mt);
240 void                            WM_menutype_free(void);
241
242                         /* default operator callbacks for border/circle/lasso */
243 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
244 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
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_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
248 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
249 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
250 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
251
252                         /* default operator for arearegions, generates event */
253 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
254
255                         /* Gesture manager API */
256 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
257 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
258 void            WM_gestures_remove(struct bContext *C);
259
260                         /* radial control operator */
261 int                     WM_radial_control_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
262 int                     WM_radial_control_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
263 void            WM_OT_radial_control_partial(struct wmOperatorType *ot);
264 void            WM_radial_control_string(struct wmOperator *op, char str[], int maxlen);
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(char *idname, int spaceid, int regionid);
277
278                         /* OpenGL wrappers, mimicking opengl syntax */
279 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
280 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
281
282 void            wmLoadMatrix            (float mat[][4]);
283 void            wmGetMatrix                     (float mat[][4]);
284 void            wmMultMatrix            (float mat[][4]);
285 void            wmGetSingleMatrix       (float mat[][4]);
286 void            wmScale                         (float x, float y, float z);
287 void            wmLoadIdentity          (void);         /* note: old name clear_view_mat */
288 void            wmPushMatrix            (void);         /* one level only */
289 void            wmPopMatrix                     (void);         /* one level only */
290
291 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
292 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
293 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
294 void            wmOrthoPixelSpace       (void);
295
296                         /* utilities */
297 void            WM_set_framebuffer_index_color(int index);
298 int                     WM_framebuffer_to_index(unsigned int col);
299
300                         /* threaded Jobs Manager */
301 #define WM_JOB_PRIORITY         1
302 #define WM_JOB_EXCL_RENDER      2
303
304 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, int flag);
305
306 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
307
308 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
309 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
310 void            WM_jobs_callbacks(struct wmJob *, 
311                                                           void (*startjob)(void *, short *, short *),
312                                                           void (*initjob)(void *),
313                                                           void (*update)(void *));
314
315 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
316 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner);
317 void            WM_jobs_stop_all(struct wmWindowManager *wm);
318
319                         /* clipboard */
320 char            *WM_clipboard_text_get(int selection);
321 void            WM_clipboard_text_set(char *buf, int selection);
322
323 #endif /* WM_API_H */
324