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