2.5 Branch: added WM_report and WM_reportf functions for reporting
[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 wmEvent;
36 struct wmEventHandler;
37 struct wmGesture;
38
39                         /* general API */
40 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
41
42 void            WM_init                         (struct bContext *C);
43 void            WM_exit                         (struct bContext *C);
44 void            WM_main                         (struct bContext *C);
45
46                         /* files */
47 int                     WM_read_homefile        (struct bContext *C, int from_memory);
48 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
49 void            WM_read_file            (struct bContext *C, char *name);
50 void            WM_write_file           (struct bContext *C, char *target);
51 void            WM_read_autosavefile(struct bContext *C);
52 void            WM_write_autosave       (struct bContext *C);
53
54                         /* mouse cursors */
55 void            WM_init_cursor_data     (void);
56 void            WM_set_cursor           (struct bContext *C, int curs);
57 void            WM_waitcursor           (struct bContext *C, int val);
58 void            WM_timecursor           (struct bContext *C, int nr);
59
60                         /* keymap and handlers */
61 void            WM_keymap_set_item      (ListBase *lb, char *idname, short type, 
62                                                                  short val, int modifier, short keymodifier);
63 void            WM_keymap_verify_item(ListBase *lb, char *idname, short type, 
64                                                                  short val, int modifier, short keymodifier);
65 void            WM_keymap_add_item      (ListBase *lb, char *idname, short type, 
66                                                                  short val, int modifier, short keymodifier);
67 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *keymap, ListBase *handlers);
68 void            WM_event_remove_keymap_handler(ListBase *keymap, ListBase *handlers);
69 struct wmEventHandler *WM_event_add_modal_handler(ListBase *handlers, wmOperator *op);
70 void            WM_event_remove_modal_handler(ListBase *handlers, wmOperator *op);
71
72 void            WM_event_add_notifier(wmWindowManager *wm, wmWindow *window,
73                                         int swinid, int type,
74                                         int value, void *data);
75
76
77                         /* operator api, default callbacks */
78                         /* confirm menu + exec */
79 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
80                         /* context checks */
81 int                     WM_operator_winactive   (struct bContext *C);
82
83                         /* operator api */
84 wmOperatorType *WM_operatortype_find(const char *idname);
85 void            WM_operatortype_append(void (*opfunc)(wmOperatorType*));
86
87 /* 
88  * Operator property api
89  *
90  * Some notes to take care:
91  *
92  * All the OP_set_* functions append a new property to the operator,
93  * if the property already exist, just replace it with the new
94  * value in other case make a new property and append it.
95  *
96  * The OP_get_string function is a "special case", this function
97  * return a pointer to property data, so don't change/resize/free
98  * the string, because probably we get a segfault.
99  * I really think that is better duplicate the string, so we are
100  * really sure that the property data don't change.
101  *
102  * OP_get_int/float/array return 1 on success (found the property)
103  * or 0 if can't find the property in the operator.
104  * The property value are store in the "value" pointer.
105  *
106  * OP_verify_* sets the value only if it wasn't set already, and
107  * returns the existing or new value.
108  *
109  * Both array function copy the property data into the "array"
110  * pointer, but you need init the len pointer to the "array" size.
111  *
112  * For example:
113  *      int vec[] = { 1, 2, 3, 4 };
114  *      OP_set_int_array (op, "vector", vec, 4);
115  *
116  *      ...
117  *
118  *      short len;
119  *      int vec[4];
120  *      len= 4; <---- set the size!!
121  *      OP_get_int_array (op, "vector", vec, &len);
122  */
123 void OP_set_int(wmOperator *op, char *name, int value);
124 void OP_set_float(wmOperator *op, char *name, float value);
125 void OP_set_string(wmOperator *op, char *name, char *str);
126 void OP_set_int_array(wmOperator *op, char *name, int *array, short len);
127 void OP_set_float_array(wmOperator *op, char *name, float *array, short len);
128
129 int OP_get_int(wmOperator *op, char *name, int *value);
130 int OP_get_float(wmOperator *op, char *name, float *value);
131 char *OP_get_string(wmOperator *op, char *name);
132 int OP_get_int_array(wmOperator *op, char *name, int *array, short *len);
133 int OP_get_float_array(wmOperator *op, char *name, float *array, short *len);
134
135 void OP_verify_int(wmOperator *op, char *name, int value, int *result);
136 void OP_verify_float(wmOperator *op, char *name, float value, int *result);
137 char *OP_verify_string(wmOperator *op, char *name, char *str);
138 void OP_verify_int_array(wmOperator *op, char *name, int *array, short len, int *resultarray, short *resultlen);
139 void OP_verify_float_array(wmOperator *op, char *name, float *array, short len, float *resultarray, short *resultlen);
140
141 /*
142  * Need call this function in the "exit callback"
143  * of the operator, but only if you use the property system.
144  **/
145 void OP_free_property(wmOperator *op);
146
147                         /* Gesture manager API */
148 void WM_gesture_init(struct bContext *C, int type);
149 void WM_gesture_update(struct bContext *C, struct wmGesture *from);
150 void WM_gesture_end(struct bContext *C, int type);
151 void WM_gesture_free(wmWindow *win);
152
153                         /* Reporting information and errors */
154 void WM_report(struct bContext *C, int type, const char *message);
155 void WM_reportf(struct bContext *C, int type, const char *format, ...);
156
157                         /* OpenGL wrappers, mimicing opengl syntax */
158 void            wmLoadMatrix            (wmWindow *win, float mat[][4]);
159 void            wmGetMatrix                     (wmWindow *win, float mat[][4]);
160 void            wmMultMatrix            (wmWindow *win, float mat[][4]);
161 void            wmGetSingleMatrix       (wmWindow *win, float mat[][4]);
162 void            wmScale                         (wmWindow *win, float x, float y, float z);
163 void            wmLoadIdentity          (wmWindow *win);        /* note: old name clear_view_mat */
164
165 void            wmFrustum                       (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
166 void            wmOrtho                         (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
167 void            wmOrtho2                        (wmWindow *win, float x1, float x2, float y1, float y2);
168
169
170 #endif /* WM_API_H */
171