a85988b6a09d3b07cfec77b068c4554fc13c989d
[blender.git] / source / blender / windowmanager / WM_types.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_TYPES_H
29 #define WM_TYPES_H
30
31 /* exported types for WM */
32
33 #include "wm_cursors.h"
34 #include "wm_event_types.h"
35 #include "wm_gesture_types.h"
36
37 /* ************** wmOperatorType ************************ */
38
39 /* flag */
40 #define OPTYPE_REGISTER         1
41
42 /* ************** wmEvent ************************ */
43
44 /* each event should have full modifier state */
45 /* event comes from eventmanager and from keymap */
46 typedef struct wmEvent {
47         struct wmEvent *next, *prev;
48         
49         short type;             /* event code itself (short, is also in keymap) */
50         short val;              /* press, release, scrollvalue */
51         short x, y;             /* mouse pointer position */
52         short unicode;  /* future, ghost? */
53         char ascii;             /* from ghost */
54         char pad1;              
55         
56         /* modifier states */
57         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
58         short keymodifier;                              /* rawkey modifier */
59         
60         /* keymap item, set by handler (weak?) */
61         const char *keymap_idname;
62         
63         /* custom data */
64         short custom;   /* custom data type, stylus, 6dof, see wm_event_types.h */
65         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
66         
67 } wmEvent;
68
69
70 /* ************** wmKeyMap ************************ */
71
72 /* modifier */
73 #define KM_SHIFT        1
74 #define KM_CTRL         2
75 #define KM_ALT          4
76 #define KM_OSKEY        8
77         /* means modifier should be pressed 2nd */
78 #define KM_SHIFT2       16
79 #define KM_CTRL2        32
80 #define KM_ALT2         64
81 #define KM_OSKEY2       128
82
83 /* val */
84 #define KM_PRESS        2
85 #define KM_RELEASE      1
86
87
88 /* ************** notifiers ****************** */
89
90 typedef struct wmNotifier {
91         struct wmNotifier *prev, *next;
92         
93         struct wmWindow *window;
94         
95         int swinid;
96         int type;
97         int value;
98         void *data;
99         
100 } wmNotifier;
101
102
103 enum {
104         WM_NOTE_WINDOW_REDRAW,
105         WM_NOTE_SCREEN_CHANGED,
106         WM_NOTE_OBJECT_CHANGED,
107         WM_NOTE_AREA_SPLIT,
108         WM_NOTE_AREA_DRAG,
109         WM_NOTE_GESTURE_CHANGED,
110         WM_NOTE_LAST
111 };
112
113 /* ************** Gesture Manager data ************** */
114 typedef struct wmGestureRect {
115         /* always this first!! */
116         wmGesture gesture;
117
118         short x1, x2;
119         short y1, y2;
120 } wmGestureRect;
121
122 #define GESTURE_RECT 0
123
124 /* ************** custom wmEvent data ************** */
125
126 #define DEV_STYLUS      1
127 #define DEV_ERASER  2
128
129 typedef struct wmTabletData {
130         int Active;                     /* 0=None, 1=Stylus, 2=Eraser */
131         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
132         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
133         float Ytilt;            /* as above */
134 } wmTabletData;
135
136 typedef struct wmBorderSelect {
137         short x1, y1;
138         short x2, y2;
139 } wmBorderSelect;
140
141 /* ****************** Messages ********************* */
142
143 enum {
144         WM_LOG_DEBUG                            = 0,
145         WM_LOG_INFO                                     = 1000,
146         WM_LOG_WARNING                          = 2000,
147         WM_ERROR_UNDEFINED                      = 3000,
148         WM_ERROR_INVALID_INPUT          = 3001,
149         WM_ERROR_INVALID_CONTEXT        = 3002,
150         WM_ERROR_OUT_OF_MEMORY          = 3003
151 };
152
153 typedef struct wmReport {
154         struct wmReport *next, *prev;
155         int type;
156         const char *typestr;
157         char *message;
158 } wmReport;
159
160 /* *************** migrated stuff, clean later? ******************************** */
161
162 typedef struct RecentFile {
163         struct RecentFile *next, *prev;
164         char *filename;
165 } RecentFile;
166
167
168 #endif /* WM_TYPES_H */
169