UI: bring back function to convert keyboard event to string, and
[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 struct rcti;
39
40                         /* general API */
41 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
42
43 void            WM_init                         (struct bContext *C);
44 void            WM_exit                         (struct bContext *C);
45 void            WM_main                         (struct bContext *C);
46
47 wmWindow        *WM_window_open         (struct bContext *C, struct rcti *rect);
48
49                         /* files */
50 int                     WM_read_homefile        (struct bContext *C, int from_memory);
51 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
52 void            WM_read_file            (struct bContext *C, char *name);
53 void            WM_write_file           (struct bContext *C, char *target);
54 void            WM_read_autosavefile(struct bContext *C);
55 void            WM_write_autosave       (struct bContext *C);
56
57                         /* mouse cursors */
58 void            WM_cursor_set           (struct wmWindow *win, int curs);
59 void            WM_cursor_modal         (struct wmWindow *win, int curs);
60 void            WM_cursor_restore       (struct wmWindow *win);
61 void            WM_cursor_wait          (struct wmWindow *win, int val);
62 void            WM_timecursor           (struct wmWindow *win, int nr);
63
64                         /* keymap */
65 wmKeymapItem *WM_keymap_set_item        (ListBase *lb, char *idname, short type, 
66                                                                  short val, int modifier, short keymodifier);
67 wmKeymapItem *WM_keymap_verify_item(ListBase *lb, char *idname, short type, 
68                                                                  short val, int modifier, short keymodifier);
69 wmKeymapItem *WM_keymap_add_item        (ListBase *lb, char *idname, short type, 
70                                                                  short val, int modifier, short keymodifier);
71 ListBase        *WM_keymap_listbase     (wmWindowManager *wm, const char *nameid, 
72                                                                  int spaceid, int regionid);
73
74 char            *WM_key_event_string(short type);
75
76                         /* handlers */
77
78 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, ListBase *keymap);
79                                                 /* boundbox, optional subwindow boundbox for offset */
80 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, ListBase *keymap, rcti *bb, rcti *swinbb);
81
82 void            WM_event_remove_keymap_handler(ListBase *handlers, ListBase *keymap);
83
84 struct wmEventHandler *WM_event_add_ui_handler(bContext *C, ListBase *handlers,
85                         int (*func)(bContext *C, struct wmEvent *event, void *userdata),
86                         void (*remove)(bContext *C, void *userdata), void *userdata);
87 void            WM_event_remove_ui_handler(ListBase *handlers,
88                         int (*func)(bContext *C, struct wmEvent *event, void *userdata),
89                         void (*remove)(bContext *C, void *userdata), void *userdata);
90
91 struct wmEventHandler *WM_event_add_modal_handler(bContext *C, ListBase *handlers, wmOperator *op);
92 void            WM_event_remove_handlers(bContext *C, ListBase *handlers);
93
94 void            WM_event_add_mousemove(bContext *C);
95
96 void            WM_event_add_notifier(bContext *C, int type, int value, void *data);
97
98 void            wm_event_add            (wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
99
100                         /* one-shot timer, returns wmTimerData.handle */
101 struct wmTimerHandle *WM_event_add_window_timer(wmWindow *win, int delay_ms, int interval_ms);
102 void            WM_event_remove_window_timer(wmWindow *wm, struct wmTimerHandle *handle);
103
104                         /* operator api, default callbacks */
105                         /* confirm menu + exec */
106 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
107                         /* context checks */
108 int                     WM_operator_winactive   (struct bContext *C);
109
110                         /* operator api */
111 wmOperatorType *WM_operatortype_find(const char *idname);
112 void            WM_operatortype_append  (void (*opfunc)(wmOperatorType*));
113
114 int         WM_operator_call            (struct bContext *C, const char *opstring);
115 int         WM_operator_call_rwin       (struct bContext *C, const char *opstring);
116
117                         /* default operator callbacks for border/lasso */
118 int                     WM_border_select_invoke (struct bContext *C, wmOperator *op, struct wmEvent *event);
119 int                     WM_border_select_modal  (struct bContext *C, wmOperator *op, struct wmEvent *event);
120
121                         /* default operator for arearegions, generates event */
122 void            WM_OT_tweak_gesture(wmOperatorType *ot);
123
124                         /* Gesture manager API */
125 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
126 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
127
128                         /* Reporting information and errors */
129 void            WM_report(struct bContext *C, int type, const char *message);
130 void            WM_reportf(struct bContext *C, int type, const char *format, ...);
131
132                         /* OpenGL wrappers, mimicing opengl syntax */
133 void            wmLoadMatrix            (wmWindow *win, float mat[][4]);
134 void            wmGetMatrix                     (wmWindow *win, float mat[][4]);
135 void            wmMultMatrix            (wmWindow *win, float mat[][4]);
136 void            wmGetSingleMatrix       (wmWindow *win, float mat[][4]);
137 void            wmScale                         (wmWindow *win, float x, float y, float z);
138 void            wmLoadIdentity          (wmWindow *win);        /* note: old name clear_view_mat */
139
140 void            wmFrustum                       (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
141 void            wmOrtho                         (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
142 void            wmOrtho2                        (wmWindow *win, float x1, float x2, float y1, float y2);
143
144
145 #endif /* WM_API_H */
146