New API to access Operator properties.
[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
38                         /* general API */
39 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
40
41 void            WM_init                         (struct bContext *C);
42 void            WM_exit                         (struct bContext *C);
43 void            WM_main                         (struct bContext *C);
44
45                         /* files */
46 int                     WM_read_homefile        (struct bContext *C, int from_memory);
47 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
48 void            WM_read_file            (struct bContext *C, char *name);
49 void            WM_write_file           (struct bContext *C, char *target);
50 void            WM_read_autosavefile(struct bContext *C);
51 void            WM_write_autosave       (struct bContext *C);
52
53                         /* mouse cursors */
54 void            WM_init_cursor_data     (void);
55 void            WM_set_cursor           (struct bContext *C, int curs);
56 void            WM_waitcursor           (struct bContext *C, int val);
57 void            WM_timecursor           (struct bContext *C, int nr);
58
59                         /* keymap and handlers */
60 void            WM_keymap_set_item      (ListBase *lb, char *idname, short type, 
61                                                                  short val, int modifier, short keymodifier);
62 void            WM_keymap_verify_item(ListBase *lb, char *idname, short type, 
63                                                                  short val, int modifier, short keymodifier);
64 void            WM_keymap_add_item      (ListBase *lb, char *idname, short type, 
65                                                                  short val, int modifier, short keymodifier);
66 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *keymap, ListBase *handlers);
67 struct wmEventHandler *WM_event_add_modal_handler(ListBase *handlers, wmOperator *op);
68 void            WM_event_remove_modal_handler(ListBase *handlers, wmOperator *op);
69
70 void            WM_event_add_notifier(wmWindowManager *wm, wmWindow *window, int swinid, int type, 
71                                                                   int value);
72
73
74                         /* operator api, default callbacks */
75                         /* confirm menu + exec */
76 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
77                         /* context checks */
78 int                     WM_operator_winactive   (struct bContext *C);
79
80                         /* operator api */
81 wmOperatorType *WM_operatortype_find(const char *idname);
82 void            WM_operatortypelist_append(ListBase *lb);
83
84 /* 
85  * Operator property api
86  *
87  * Some notes to take care:
88  *
89  * OP_set_int try to append a new property to the operator,
90  * if the property already exist, just replace it with the
91  * value in other case make a new property and append it.
92  *
93  * OP_get_int return 0 on success (found the property) or
94  * != 0 if can't found the property in the operator.
95  * The property value are store in the "value" pointer.
96  */
97 void OP_set_int(wmOperator *op, char *name, int value);
98 int OP_get_int(wmOperator *op, char *name, int *value);
99
100                         /* OpenGL wrappers, mimicing opengl syntax */
101 void            wmLoadMatrix            (wmWindow *win, float mat[][4]);
102 void            wmGetMatrix                     (wmWindow *win, float mat[][4]);
103 void            wmMultMatrix            (wmWindow *win, float mat[][4]);
104 void            wmGetSingleMatrix       (wmWindow *win, float mat[][4]);
105 void            wmScale                         (wmWindow *win, float x, float y, float z);
106 void            wmLoadIdentity          (wmWindow *win);        /* note: old name clear_view_mat */
107
108 void            wmFrustum                       (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
109 void            wmOrtho                         (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
110 void            wmOrtho2                        (wmWindow *win, float x1, float x2, float y1, float y2);
111
112
113 #endif /* WM_API_H */
114