COLLADA: merge from trunk -r 24390:24522.
[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 rcti;
42 struct PointerRNA;
43 struct EnumPropertyItem;
44 struct MenuType;
45
46 typedef struct wmJob wmJob;
47
48 /* general API */
49 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
50
51 void            WM_init                         (struct bContext *C);
52 void            WM_exit                         (struct bContext *C);
53 void            WM_main                         (struct bContext *C);
54
55
56 void            WM_check                        (struct bContext *C);
57
58 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
59
60                         /* defines for 'type' WM_window_open_temp */
61 #define WM_WINDOW_RENDER                0
62 #define WM_WINDOW_USERPREFS             1
63 #define WM_WINDOW_FILESEL               2
64
65 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
66
67
68
69                         /* files */
70 int                     WM_read_homefile        (struct bContext *C, struct wmOperator *op);
71 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
72 void            WM_read_file            (struct bContext *C, char *name, struct ReportList *reports);
73 void            WM_write_file           (struct bContext *C, char *target, int fileflags, struct ReportList *reports);
74 void            WM_read_autosavefile(struct bContext *C);
75 void            WM_autosave_init        (struct bContext *C);
76
77                         /* mouse cursors */
78 void            WM_cursor_set           (struct wmWindow *win, int curs);
79 void            WM_cursor_modal         (struct wmWindow *win, int curs);
80 void            WM_cursor_restore       (struct wmWindow *win);
81 void            WM_cursor_wait          (int val);
82 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
83 void            WM_cursor_ungrab(struct wmWindow *win);
84 void            WM_timecursor           (struct wmWindow *win, int nr);
85
86 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
87 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
88
89 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
90
91                         /* keyconfig and keymap */
92 wmKeyConfig *WM_keyconfig_add   (struct wmWindowManager *wm, char *idname);
93 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
94 void            WM_keyconfig_userdef(struct wmWindowManager *wm);
95
96 void            WM_keymap_init          (struct bContext *C);
97 void            WM_keymap_free          (struct wmKeyMap *keymap);
98
99 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, char *idname, int type, 
100                                                                  int val, int modifier, int keymodifier);
101 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, char *idname, int type, 
102                                                                  int val, int modifier, int keymodifier);
103 void         WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
104 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
105
106 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, char *idname, int spaceid, int regionid);
107 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
108 wmKeyMap        *WM_keymap_copy_to_user(struct wmKeyMap *keymap);
109 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap);
110
111 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, char *idname, struct EnumPropertyItem *items);
112 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, char *idname);
113 void            WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
114 void            WM_modalkeymap_assign(struct wmKeyMap *km, char *opname);
115
116 const char      *WM_key_event_string(short type);
117 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
118 void            WM_key_event_operator_change(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, short key, short modifier);
119
120                         /* handlers */
121
122 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
123                                                 /* boundbox, optional subwindow boundbox for offset */
124 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
125                                                 /* priority not implemented, it adds in begin */
126 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
127
128 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
129
130 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
131                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
132                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
133 void            WM_event_remove_ui_handler(ListBase *handlers,
134                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
135                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
136
137 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
138 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
139
140 void            WM_event_add_mousemove(struct bContext *C);
141 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
142
143 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
144 void            WM_main_add_notifier(unsigned int type, void *reference);
145
146 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
147
148                         /* at maximum, every timestep seconds it triggers event_type events */
149 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
150 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
151 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
152
153                 /* operator api, default callbacks */
154                         /* invoke callback, uses enum property named "type" */
155 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
156                         /* invoke callback, confirm menu + exec */
157 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
158                 /* invoke callback, file selector "path" unset + exec */
159 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
160                         /* poll callback, context checks */
161 int                     WM_operator_winactive   (struct bContext *C);
162                         /* invoke callback, exec + redo popup */
163 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
164 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
165
166 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, char *message);
167
168                 /* operator api */
169 void            WM_operator_free                (struct wmOperator *op);
170 void            WM_operator_stack_clear(struct bContext *C);
171
172 wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
173 wmOperatorType *WM_operatortype_exists(const char *idname);
174 wmOperatorType *WM_operatortype_first(void);
175 void            WM_operatortype_append  (void (*opfunc)(wmOperatorType*));
176 void            WM_operatortype_append_ptr      (void (*opfunc)(wmOperatorType*, void *), void *userdata);
177 int                     WM_operatortype_remove(const char *idname);
178
179 wmOperatorType *WM_operatortype_append_macro(char *idname, char *name, int flag);
180 wmOperatorTypeMacro *WM_operatortype_macro_define(wmOperatorType *ot, const char *idname);
181
182
183 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
184 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
185 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
186 int         WM_operator_name_call       (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
187 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
188
189 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
190 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
191 void            WM_operator_properties_free(struct PointerRNA *ptr);
192 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type);
193 void            WM_operator_properties_gesture_border(wmOperatorType *ot, int extend);
194
195                 /* operator as a python command (resultuing string must be free'd) */
196 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
197 void            WM_operator_bl_idname(char *to, const char *from);
198 void            WM_operator_py_idname(char *to, const char *from);
199
200 /* *************** menu types ******************** */
201 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
202 int                                     WM_menutype_add(struct MenuType* mt);
203 void                            WM_menutype_freelink(struct MenuType* mt);
204 void                            WM_menutype_free(void);
205
206                         /* default operator callbacks for border/circle/lasso */
207 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
208 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
209 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
210 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
211 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
212 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
213 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
214 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
215
216                         /* default operator for arearegions, generates event */
217 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
218
219                         /* Gesture manager API */
220 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
221 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
222
223                         /* radial control operator */
224 int                     WM_radial_control_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
225 int                     WM_radial_control_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
226 void            WM_OT_radial_control_partial(struct wmOperatorType *ot);
227 void            WM_radial_control_string(struct wmOperator *op, char str[], int maxlen);
228
229                         /* fileselecting support */
230 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
231 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
232
233                         /* OpenGL wrappers, mimicking opengl syntax */
234 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
235 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
236
237 void            wmLoadMatrix            (float mat[][4]);
238 void            wmGetMatrix                     (float mat[][4]);
239 void            wmMultMatrix            (float mat[][4]);
240 void            wmGetSingleMatrix       (float mat[][4]);
241 void            wmScale                         (float x, float y, float z);
242 void            wmLoadIdentity          (void);         /* note: old name clear_view_mat */
243 void            wmPushMatrix            (void);         /* one level only */
244 void            wmPopMatrix                     (void);         /* one level only */
245
246 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
247 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
248 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
249
250                         /* utilities */
251 void            WM_set_framebuffer_index_color(int index);
252 int                     WM_framebuffer_to_index(unsigned int col);
253
254                         /* threaded Jobs Manager */
255 #define WM_JOB_PRIORITY         1
256 #define WM_JOB_EXCL_RENDER      2
257
258 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, int flag);
259
260 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
261
262 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
263 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
264 void            WM_jobs_callbacks(struct wmJob *, 
265                                                           void (*startjob)(void *, short *, short *),
266                                                           void (*initjob)(void *),
267                                                           void (*update)(void *));
268
269 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
270 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner);
271 void            WM_jobs_stop_all(struct wmWindowManager *wm);
272
273                         /* clipboard */
274 char            *WM_clipboard_text_get(int selection);
275 void            WM_clipboard_text_set(char *buf, int selection);
276
277 #endif /* WM_API_H */
278