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