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