NLA SoC: Merge from 2.5
[blender.git] / source / blender / makesdna / DNA_windowmanager_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 DNA_WINDOWMANAGER_TYPES_H
29 #define DNA_WINDOWMANAGER_TYPES_H
30
31 #include "DNA_listBase.h"
32 #include "DNA_vec_types.h"
33
34 #include "DNA_ID.h"
35
36 /* defined here: */
37 struct wmWindowManager;
38 struct wmWindow;
39
40 struct wmEvent;
41 struct wmGesture;
42 struct wmOperatorType;
43 struct wmOperator;
44
45 /* forwards */
46 struct bContext;
47 struct wmLocal;
48 struct bScreen;
49 struct uiBlock;
50 struct wmSubWindow;
51 struct wmTimer;
52 struct StructRNA;
53 struct PointerRNA;
54 struct ReportList;
55
56 /* windowmanager is saved, tag WMAN */
57 typedef struct wmWindowManager {
58         ID id;
59         
60         struct wmWindow *windrawable, *winactive;               /* separate active from drawable */
61         ListBase windows;
62         
63         int initialized;                /* set on file read */
64         short file_saved;               /* indicator whether data was saved */
65         short pad;
66         
67         ListBase operators;             /* operator registry */
68         
69         ListBase queue;                 /* refresh/redraw wmNotifier structs */
70         
71         ListBase reports;               /* information and error reports */
72         
73         ListBase jobs;                  /* threaded jobs manager */
74         
75         ListBase paintcursors;  /* extra overlay cursors to draw, like circles */
76         
77         /* used keymaps, optionally/partially saved */
78         ListBase keymaps;
79         
80 } wmWindowManager;
81
82
83 /* the savable part, rest of data is local in ghostwinlay */
84 typedef struct wmWindow {
85         struct wmWindow *next, *prev;
86         
87         void *ghostwin;         /* dont want to include ghost.h stuff */
88         
89         int winid, pad;         /* winid also in screens, is for retrieving this window after read */
90         
91         struct bScreen *screen;         /* active screen */
92         struct bScreen *newscreen;      /* temporary when switching */
93         char screenname[32];    /* MAX_ID_NAME for matching window with active screen after file read */
94         
95         short posx, posy, sizex, sizey; /* window coords */
96         short windowstate;      /* borderless, full */
97         short monitor;          /* multiscreen... no idea how to store yet */
98         short active;           /* set to 1 if an active window, for quick rejects */
99         short cursor;           /* current mouse cursor type */
100         short lastcursor;       /* for temp waitcursor */
101         short addmousemove;     /* internal: tag this for extra mousemove event, makes cursors/buttons active on UI switching */
102         int pad3;
103         
104         struct wmEvent *eventstate;     /* storage for event system */
105         
106         struct wmSubWindow *curswin;    /* internal for wm_subwindow.c only */
107
108         struct wmGesture *tweak;        /* internal for wm_operators.c */
109         
110         int drawmethod, drawfail;       /* internal for wm_draw.c only */
111         void *drawdata;                         /* internal for wm_draw.c only */
112         
113         ListBase timers;
114         
115         ListBase queue;                         /* all events (ghost level events were handled) */
116         ListBase handlers;                      /* window+screen handlers, overriding all queues */
117         
118         ListBase subwindows;    /* opengl stuff for sub windows, see notes in wm_subwindow.c */
119         ListBase gesture;               /* gesture stuff */
120 } wmWindow;
121
122 /* should be somthing like DNA_EXCLUDE 
123  * but the preprocessor first removes all comments, spaces etc */
124
125 #
126 #
127 typedef struct wmOperatorType {
128         struct wmOperatorType *next, *prev;
129         
130         char *name;             /* text for ui, undo */
131         char *idname;           /* unique identifier */
132         char *description;      /* tooltips and python docs */
133         
134         /* this callback executes the operator without any interactive input,
135          * parameters may be provided through operator properties. cannot use
136          * any interface code or input device state.
137          * - see defines below for return values */
138         int (*exec)(struct bContext *, struct wmOperator *);
139
140         /* for modal temporary operators, initially invoke is called. then
141          * any further events are handled in modal. if the operation is
142          * cancelled due to some external reason, cancel is called
143          * - see defines below for return values */
144         int (*invoke)(struct bContext *, struct wmOperator *, struct wmEvent *);
145         int (*cancel)(struct bContext *, struct wmOperator *);
146         int (*modal)(struct bContext *, struct wmOperator *, struct wmEvent *);
147
148         /* verify if the operator can be executed in the current context, note
149          * that the operator might still fail to execute even if this return true */
150         int (*poll)(struct bContext *);
151         
152         /* panel for redo and repeat */
153         void *(*uiBlock)(struct wmOperator *);
154         
155         /* rna for properties */
156         struct StructRNA *srna;
157         
158         short flag;
159
160         /* only used for operators defined with python
161          * use to store pointers to python functions */
162         void *pyop_data;
163
164 } wmOperatorType;
165
166 #define OP_MAX_TYPENAME 64
167
168 /* partial copy of the event, for matching by eventhandler */
169 typedef struct wmKeymapItem {
170         struct wmKeymapItem *next, *prev;
171         
172         char idname[64];                                /* used to retrieve operator type pointer */
173         struct PointerRNA *ptr;                 /* rna pointer to access properties */
174         
175         short type;                                             /* event code itself */
176         short val;                                              /* 0=any, 1=click, 2=release, or wheelvalue, or... */
177         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
178         short keymodifier;                              /* rawkey modifier */
179         
180         short pad;
181 } wmKeymapItem;
182
183 #define KMAP_MAX_NAME   64
184
185 /* stored in WM, the actively used keymaps */
186 typedef struct wmKeyMap {
187         struct wmKeyMap *next, *prev;
188         
189         ListBase keymap;
190         
191         char nameid[64];        /* global editor keymaps, or for more per space/region */
192         int spaceid;    /* same IDs as in DNA_space_types.h */
193         int regionid;   /* see above */
194 } wmKeyMap;
195
196
197 /* this one is the operator itself, stored in files for macros etc */
198 /* operator + operatortype should be able to redo entirely, but for different contextes */
199 typedef struct wmOperator {
200         struct wmOperator *next, *prev;
201
202         /* saved */
203         char idname[64];                        /* used to retrieve type pointer */
204         IDProperty *properties;         /* saved, user-settable properties */
205         
206         /* runtime */
207         wmOperatorType *type;           /* operator type definition from idname */
208         void *customdata;                       /* custom storage, only while operator runs */
209         struct PointerRNA *ptr;         /* rna pointer to access properties */
210         struct ReportList *reports;     /* errors and warnings storage */
211 } wmOperator;
212
213 /* operator type exec(), invoke() modal(), return values */
214 #define OPERATOR_RUNNING_MODAL  1
215 #define OPERATOR_CANCELLED              2
216 #define OPERATOR_FINISHED               4
217 /* add this flag if the event should pass through */
218 #define OPERATOR_PASS_THROUGH   8
219
220 typedef enum wmRadialControlMode {
221         WM_RADIALCONTROL_SIZE,
222         WM_RADIALCONTROL_STRENGTH,
223         WM_RADIALCONTROL_ANGLE
224 } wmRadialControlMode;
225
226 /* ************** wmEvent ************************ */
227 /* for read-only rna access, dont save this */
228
229 /* each event should have full modifier state */
230 /* event comes from eventmanager and from keymap */
231 typedef struct wmEvent {
232         struct wmEvent *next, *prev;
233         
234         short type;                     /* event code itself (short, is also in keymap) */
235         short val;                      /* press, release, scrollvalue */
236         short x, y;                     /* mouse pointer position, screen coord */
237         short mval[2];          /* region mouse position, name convention pre 2.5 :) */
238         short prevx, prevy;     /* previous mouse pointer position */
239         short unicode;          /* future, ghost? */
240         char ascii;                     /* from ghost */
241         char pad;
242         
243         /* modifier states */
244         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
245         short keymodifier;                              /* rawkey modifier */
246         
247         /* keymap item, set by handler (weak?) */
248         const char *keymap_idname;
249         
250         /* custom data */
251         short custom;   /* custom data type, stylus, 6dof, see wm_event_types.h */
252         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
253         short customdatafree;
254         
255 } wmEvent;
256
257 #endif /* DNA_WINDOWMANAGER_TYPES_H */
258