2.5
[blender-staging.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         int pad;
65         
66         ListBase operators;             /* operator registry */
67         
68         ListBase queue;                 /* refresh/redraw wmNotifier structs */
69         
70         ListBase reports;               /* information and error reports */
71         
72         ListBase jobs;                  /* threaded jobs manager */
73         
74         ListBase paintcursors;  /* extra overlay cursors to draw, like circles */
75         
76         /* used keymaps, optionally/partially saved */
77         ListBase keymaps;
78         
79 } wmWindowManager;
80
81
82 /* the savable part, rest of data is local in ghostwinlay */
83 typedef struct wmWindow {
84         struct wmWindow *next, *prev;
85         
86         void *ghostwin;         /* dont want to include ghost.h stuff */
87         
88         int winid, pad;         /* winid also in screens, is for retrieving this window after read */
89         
90         struct bScreen *screen; /* active screen */
91         char screenname[32];    /* MAX_ID_NAME for matching window with active screen after file read */
92         
93         short posx, posy, sizex, sizey; /* window coords */
94         short windowstate;      /* borderless, full */
95         short monitor;          /* multiscreen... no idea how to store yet */
96         short active;           /* set to 1 if an active window, for quick rejects */
97         short cursor;           /* current mouse cursor type */
98         short lastcursor;       /* for temp waitcursor */
99         short pad2;
100         int pad3;
101         
102         struct wmEvent *eventstate;     /* storage for event system */
103         
104         struct wmSubWindow *curswin;    /* internal for wm_subwindow.c only */
105
106         struct wmGesture *tweak;        /* internal for wm_operators.c */
107         
108         int drawmethod, drawfail;       /* internal for wm_draw.c only */
109         void *drawdata;                         /* internal for wm_draw.c only */
110         
111         ListBase timers;
112         
113         ListBase queue;                         /* all events (ghost level events were handled) */
114         ListBase handlers;                      /* window+screen handlers, overriding all queues */
115         
116         ListBase subwindows;    /* opengl stuff for sub windows, see notes in wm_subwindow.c */
117         ListBase gesture;               /* gesture stuff */
118 } wmWindow;
119
120 #
121 #
122 typedef struct wmOperatorType {
123         struct wmOperatorType *next, *prev;
124         
125         char *name;             /* text for ui, undo */
126         char *idname;   /* unique identifier */
127         
128         /* this callback executes the operator without any interactive input,
129          * parameters may be provided through operator properties. cannot use
130          * any interface code or input device state.
131          * - see defines below for return values */
132         int (*exec)(struct bContext *, struct wmOperator *);
133
134         /* for modal temporary operators, initially invoke is called. then
135          * any further events are handled in modal. if the operation is
136          * cancelled due to some external reason, cancel is called
137          * - see defines below for return values */
138         int (*invoke)(struct bContext *, struct wmOperator *, struct wmEvent *);
139         int (*cancel)(struct bContext *, struct wmOperator *);
140         int (*modal)(struct bContext *, struct wmOperator *, struct wmEvent *);
141
142         /* verify if the operator can be executed in the current context, note
143          * that the operator might still fail to execute even if this return true */
144         int (*poll)(struct bContext *);
145         
146         /* panel for redo and repeat */
147         void *(*uiBlock)(struct wmOperator *);
148         
149         /* rna for properties */
150         struct StructRNA *srna;
151         
152         short flag;
153
154         /* only used for operators defined with python
155          * use to store pointers to python functions */
156         void *pyop_data;
157
158 } wmOperatorType;
159
160 #define OP_MAX_TYPENAME 64
161
162 /* partial copy of the event, for matching by eventhandler */
163 typedef struct wmKeymapItem {
164         struct wmKeymapItem *next, *prev;
165         
166         char idname[64];                                /* used to retrieve operator type pointer */
167         struct PointerRNA *ptr;                 /* rna pointer to access properties */
168         
169         short type;                                             /* event code itself */
170         short val;                                              /* 0=any, 1=click, 2=release, or wheelvalue, or... */
171         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
172         short keymodifier;                              /* rawkey modifier */
173         
174         short pad;
175 } wmKeymapItem;
176
177 #define KMAP_MAX_NAME   64
178
179 /* stored in WM, the actively used keymaps */
180 typedef struct wmKeyMap {
181         struct wmKeyMap *next, *prev;
182         
183         ListBase keymap;
184         
185         char nameid[64];        /* global editor keymaps, or for more per space/region */
186         int spaceid;    /* same IDs as in DNA_space_types.h */
187         int regionid;   /* see above */
188 } wmKeyMap;
189
190
191 /* this one is the operator itself, stored in files for macros etc */
192 /* operator + operatortype should be able to redo entirely, but for different contextes */
193 typedef struct wmOperator {
194         struct wmOperator *next, *prev;
195
196         /* saved */
197         char idname[64];                        /* used to retrieve type pointer */
198         IDProperty *properties;         /* saved, user-settable properties */
199         
200         /* runtime */
201         wmOperatorType *type;           /* operator type definition from idname */
202         void *customdata;                       /* custom storage, only while operator runs */
203         struct PointerRNA *ptr;         /* rna pointer to access properties */
204         struct ReportList *reports;     /* errors and warnings storage */
205 } wmOperator;
206
207 /* operator type exec(), invoke() modal(), return values */
208 #define OPERATOR_RUNNING_MODAL  1
209 #define OPERATOR_CANCELLED              2
210 #define OPERATOR_FINISHED               4
211 /* add this flag if the event should pass through */
212 #define OPERATOR_PASS_THROUGH   8
213
214 typedef enum wmRadialControlMode {
215         WM_RADIALCONTROL_SIZE,
216         WM_RADIALCONTROL_STRENGTH,
217         WM_RADIALCONTROL_ANGLE
218 } wmRadialControlMode;
219
220 #endif /* DNA_WINDOWMANAGER_TYPES_H */
221