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