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