Various changes made in the process of working on the UI code:
[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         short customdatafree;
67         
68 } wmEvent;
69
70
71 /* ************** wmKeyMap ************************ */
72
73 /* modifier */
74 #define KM_SHIFT        1
75 #define KM_CTRL         2
76 #define KM_ALT          4
77 #define KM_OSKEY        8
78         /* means modifier should be pressed 2nd */
79 #define KM_SHIFT2       16
80 #define KM_CTRL2        32
81 #define KM_ALT2         64
82 #define KM_OSKEY2       128
83
84 /* val */
85 #define KM_PRESS        2
86 #define KM_RELEASE      1
87
88
89 /* ************** notifiers ****************** */
90
91 typedef struct wmNotifier {
92         struct wmNotifier *prev, *next;
93         
94         struct wmWindow *window;
95         
96         int swinid;
97         int type;
98         int value;
99         void *data;
100         
101 } wmNotifier;
102
103
104 enum {
105         WM_NOTE_WINDOW_REDRAW,
106         WM_NOTE_SCREEN_CHANGED,
107         WM_NOTE_OBJECT_CHANGED,
108         WM_NOTE_AREA_SPLIT,
109         WM_NOTE_AREA_DRAG,
110         WM_NOTE_GESTURE_CHANGED,
111         WM_NOTE_LAST
112 };
113
114 /* ************** Gesture Manager data ************** */
115 typedef struct wmGestureRect {
116         /* always this first!! */
117         wmGesture gesture;
118
119         short x1, x2;
120         short y1, y2;
121 } wmGestureRect;
122
123 #define GESTURE_RECT 0
124
125 /* ************** custom wmEvent data ************** */
126
127 #define DEV_STYLUS      1
128 #define DEV_ERASER  2
129
130 typedef struct wmTabletData {
131         int Active;                     /* 0=None, 1=Stylus, 2=Eraser */
132         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
133         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
134         float Ytilt;            /* as above */
135 } wmTabletData;
136
137 typedef struct wmBorderSelect {
138         short x1, y1;
139         short x2, y2;
140 } wmBorderSelect;
141
142 struct wmTimerHandle;
143 typedef struct wmTimerHandle wmTimerHandle;
144
145 /* ****************** Messages ********************* */
146
147 enum {
148         WM_LOG_DEBUG                            = 0,
149         WM_LOG_INFO                                     = 1000,
150         WM_LOG_WARNING                          = 2000,
151         WM_ERROR_UNDEFINED                      = 3000,
152         WM_ERROR_INVALID_INPUT          = 3001,
153         WM_ERROR_INVALID_CONTEXT        = 3002,
154         WM_ERROR_OUT_OF_MEMORY          = 3003
155 };
156
157 typedef struct wmReport {
158         struct wmReport *next, *prev;
159         int type;
160         const char *typestr;
161         char *message;
162 } wmReport;
163
164 /* *************** migrated stuff, clean later? ******************************** */
165
166 typedef struct RecentFile {
167         struct RecentFile *next, *prev;
168         char *filename;
169 } RecentFile;
170
171
172 #endif /* WM_TYPES_H */
173