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