RNA
[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 rcti;
40 struct PointerRNA;
41
42                         /* general API */
43 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
44
45 void            WM_init                         (struct bContext *C);
46 void            WM_exit                         (struct bContext *C);
47 void            WM_main                         (struct bContext *C);
48
49 wmWindow        *WM_window_open         (struct bContext *C, struct rcti *rect);
50
51                         /* files */
52 int                     WM_read_homefile        (struct bContext *C, int from_memory);
53 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
54 void            WM_read_file            (struct bContext *C, char *name, struct ReportList *reports);
55 void            WM_write_file           (struct bContext *C, char *target, struct ReportList *reports);
56 void            WM_read_autosavefile(struct bContext *C);
57 void            WM_write_autosave       (struct bContext *C);
58
59                         /* mouse cursors */
60 void            WM_cursor_set           (struct wmWindow *win, int curs);
61 void            WM_cursor_modal         (struct wmWindow *win, int curs);
62 void            WM_cursor_restore       (struct wmWindow *win);
63 void            WM_cursor_wait          (struct wmWindow *win, int val);
64 void            WM_timecursor           (struct wmWindow *win, int nr);
65
66                         /* keymap */
67 wmKeymapItem *WM_keymap_set_item        (ListBase *lb, char *idname, short type, 
68                                                                  short val, int modifier, short keymodifier);
69 wmKeymapItem *WM_keymap_verify_item(ListBase *lb, char *idname, short type, 
70                                                                  short val, int modifier, short keymodifier);
71 wmKeymapItem *WM_keymap_add_item        (ListBase *lb, char *idname, short type, 
72                                                                  short val, int modifier, short keymodifier);
73 ListBase        *WM_keymap_listbase     (wmWindowManager *wm, const char *nameid, 
74                                                                  int spaceid, int regionid);
75
76 char            *WM_key_event_string(short type);
77 char            *WM_key_event_operator_string(struct bContext *C, char *opname, int opcontext, char *str, int len);
78
79                         /* handlers */
80
81 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, ListBase *keymap);
82                                                 /* boundbox, optional subwindow boundbox for offset */
83 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, ListBase *keymap, rcti *bb, rcti *swinbb);
84
85 void            WM_event_remove_keymap_handler(ListBase *handlers, ListBase *keymap);
86
87 struct wmEventHandler *WM_event_add_ui_handler(struct bContext *C, ListBase *handlers,
88                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
89                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
90 void            WM_event_remove_ui_handler(ListBase *handlers,
91                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
92                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
93
94 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, ListBase *handlers, wmOperator *op);
95 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
96
97 void            WM_event_add_mousemove(struct bContext *C);
98 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
99
100 void            WM_event_add_notifier(struct bContext *C, unsigned int type, void *data);
101
102 void            wm_event_add            (wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
103
104                         /* at maximum, every timestep seconds it triggers event_type events */
105 struct wmTimer *WM_event_add_window_timer(wmWindow *win, int event_type, double timestep);
106 void            WM_event_remove_window_timer(wmWindow *win, struct wmTimer *timer);
107 void            WM_event_window_timer_sleep(wmWindow *win, struct wmTimer *timer, int dosleep);
108
109                 /* operator api, default callbacks */
110                         /* invoke callback, uses enum property named "type" */
111 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
112                         /* invoke callback, confirm menu + exec */
113 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
114                         /* poll callback, context checks */
115 int                     WM_operator_winactive   (struct bContext *C);
116
117                 /* operator api */
118 void            WM_operator_free                (struct wmOperator *op);
119 wmOperatorType *WM_operatortype_find(const char *idname);
120 wmOperatorType *WM_operatortype_first(void);
121 void            WM_operatortype_append  (void (*opfunc)(wmOperatorType*));
122 void            WM_operatortype_append_ptr      (void (*opfunc)(wmOperatorType*, void *), void *userdata);
123 int                     WM_operatortype_remove(const char *idname);
124
125 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
126 int         WM_operator_name_call       (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties, struct ReportList *reports);
127
128 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
129 void            WM_operator_properties_free(struct PointerRNA *ptr);
130
131 /* operator as a python command (resultuing string must be free'd) */
132 char *WM_operator_pystring(struct wmOperator *op);
133
134                         /* default operator callbacks for border/circle/lasso */
135 int                     WM_border_select_invoke (struct bContext *C, wmOperator *op, struct wmEvent *event);
136 int                     WM_border_select_modal  (struct bContext *C, wmOperator *op, struct wmEvent *event);
137 int                     WM_gesture_circle_invoke(struct bContext *C, wmOperator *op, struct wmEvent *event);
138 int                     WM_gesture_circle_modal(struct bContext *C, wmOperator *op, struct wmEvent *event);
139
140                         /* default operator for arearegions, generates event */
141 void            WM_OT_tweak_gesture(wmOperatorType *ot);
142
143                         /* Gesture manager API */
144 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
145 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
146
147                         /* OpenGL wrappers, mimicking opengl syntax */
148 void            wmSubWindowSet          (wmWindow *win, int swinid);
149
150 void            wmLoadMatrix            (float mat[][4]);
151 void            wmGetMatrix                     (float mat[][4]);
152 void            wmMultMatrix            (float mat[][4]);
153 void            wmGetSingleMatrix       (float mat[][4]);
154 void            wmScale                         (float x, float y, float z);
155 void            wmLoadIdentity          (void);         /* note: old name clear_view_mat */
156
157 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
158 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
159 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
160
161                         /* utilities */
162 void            WM_set_framebuffer_index_color(int index);
163 int                     WM_framebuffer_to_index(unsigned int col);
164
165 #endif /* WM_API_H */
166