2.5
[blender-staging.git] / source / blender / makesdna / DNA_screen_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) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef DNA_SCREEN_TYPES_H
28 #define DNA_SCREEN_TYPES_H
29
30 #include "DNA_listBase.h"
31 #include "DNA_view2d_types.h"
32 #include "DNA_vec_types.h"
33
34 #include "DNA_scriptlink_types.h"
35 #include "DNA_ID.h"
36
37 struct SpaceType;
38 struct SpaceLink;
39 struct ARegion;
40 struct ARegionType;
41 struct Scene;
42 struct wmTimer;
43
44 typedef struct bScreen {
45         ID id;
46         
47         ListBase vertbase;                                      /* screens have vertices/edges to define areas */
48         ListBase edgebase;
49         ListBase areabase;
50         ListBase regionbase;                            /* screen level regions (menus), runtime only */
51         
52         struct Scene *scene;
53         
54         short full;                                                     /* fade out? */
55         short winid;                                            /* winid from WM, starts with 1 */
56         short do_draw;                                          /* notifier for drawing edges */
57         short do_refresh;                                       /* notifier for scale screen, changed screen, etc */
58         short do_draw_gesture;                          /* notifier for gesture draw. */
59         short do_draw_paintcursor;                      /* notifier for paint cursor draw. */
60         short swap;                                                     /* indicator to survive swap-exchange systems */
61         short pad;
62         
63         short mainwin;                                          /* screensize subwindow, for screenedges and global menus */
64         short subwinactive;                                     /* active subwindow */
65         
66         int pad2;
67         
68         struct wmTimer *animtimer;                      /* if set, screen has timer handler added in window */
69         void *context;                                          /* context callback */
70         
71         short handler[8];                                       /* similar to space handler */
72 } bScreen;
73
74 typedef struct ScrVert {
75         struct ScrVert *next, *prev, *newv;
76         vec2s vec;
77         int flag;
78 } ScrVert;
79
80 typedef struct ScrEdge {
81         struct ScrEdge *next, *prev;
82         ScrVert *v1, *v2;
83         short border;                   /* 1 when at edge of screen */
84         short flag;
85         int pad;
86 } ScrEdge;
87
88 typedef struct Panel {          /* the part from uiBlock that needs saved in file */
89         struct Panel *next, *prev;
90
91         char panelname[64], tabname[64];        /* defined as UI_MAX_NAME_STR */
92         char drawname[64];                                      /* panelname is identifier for restoring location */
93         short ofsx, ofsy, sizex, sizey;
94         short flag, active;                                     /* active= used currently by a uiBlock */
95         short control;
96         short snap;
97         int sortcounter, pad;           /* when sorting panels, it uses this to put new ones in right place */
98         struct Panel *paneltab;         /* this panel is tabbed in *paneltab */
99         void *activedata;                       /* runtime for panel manipulation */
100 } Panel;
101
102 typedef struct ScrArea {
103         struct ScrArea *next, *prev;
104         
105         ScrVert *v1, *v2, *v3, *v4;
106         bScreen *full;                  /* if area==full, this is the parent */
107
108         rcti totrct;                    /* rect bound by v1 v2 v3 v4 */
109
110         char spacetype, butspacetype;   /* SPACE_..., butspacetype is button arg  */
111         short winx, winy;                               /* size */
112         
113         short headertype;                               /* OLD! 0=no header, 1= down, 2= up */
114         short pad;
115         short do_refresh;                               /* private, for spacetype refresh callback */
116         short cursor, flag;
117
118         ScriptLink scriptlink;
119         
120         struct SpaceType *type;         /* callbacks for this space type */
121         
122         ListBase spacedata;             /* SpaceLink */
123         ListBase regionbase;    /* ARegion */
124         ListBase handlers;              /* wmEventHandler */
125         
126         ListBase actionzones;   /* AZone */
127 } ScrArea;
128
129 typedef struct ARegion {
130         struct ARegion *next, *prev;
131         
132         View2D v2d;                                     /* 2D-View scrolling/zoom info (most regions are 2d anyways) */
133         rcti winrct;                            /* coordinates of region */
134         rcti drawrct;                           /* runtime for partial redraw, same or smaller than winrct */
135         short winx, winy;                       /* size */
136         
137         short swinid;
138         short regiontype;                       /* window, header, etc. identifier for drawing */
139         short alignment;                        /* how it should split */
140         short flag;                                     /* hide, ... */
141         
142         float fsize;                            /* current split size in float */
143         
144         short do_draw;                          /* private, cached notifier events */
145         short swap;                                     /* private, indicator to survive swap-exchange */
146         int pad1;
147         
148         struct ARegionType *type;       /* callbacks for this region type */
149         
150         ListBase uiblocks;                      /* uiBlock */
151         ListBase panels;                        /* Panel */
152         ListBase handlers;                      /* wmEventHandler */
153         
154         char *headerstr;                        /* use this string to draw info */
155         void *regiondata;                       /* XXX 2.50, need spacedata equivalent? */
156 } ARegion;
157
158 /* swap */
159 #define WIN_BACK_OK             1
160 #define WIN_FRONT_OK    2
161 #define WIN_EQUAL               3
162
163 /* area->flag */
164 #define HEADER_NO_PULLDOWN      1
165 #define AREA_FLAG_DRAWJOINTO 2
166 #define AREA_FLAG_DRAWJOINFROM 4
167
168 /* If you change EDGEWIDTH, also do the global arrat edcol[]  */
169 #define EDGEWIDTH       1
170 #define AREAGRID        4
171 #define AREAMINX        32
172 #define HEADERY         26
173 #define AREAMINY        (HEADERY+EDGEWIDTH)
174
175 #define HEADERDOWN      1
176 #define HEADERTOP       2
177
178 #define SCREENNORMAL    0
179 #define SCREENFULL      1
180 #define SCREENAUTOPLAY  2
181
182 /* Panel->snap - for snapping to screen edges */
183 #define PNL_SNAP_NONE           0
184 #define PNL_SNAP_TOP            1
185 #define PNL_SNAP_RIGHT          2
186 #define PNL_SNAP_BOTTOM 4
187 #define PNL_SNAP_LEFT           8
188
189 #define PNL_SNAP_DIST           9.0
190
191 /* screen handlers */
192 #define SCREEN_MAXHANDLER               8
193
194 #define SCREEN_HANDLER_ANIM             1
195 #define SCREEN_HANDLER_PYTHON   2
196 #define SCREEN_HANDLER_VERSE    3
197
198 /* regiontype, first two are the default set */
199 #define RGN_TYPE_WINDOW         0
200 #define RGN_TYPE_HEADER         1
201 #define RGN_TYPE_CHANNELS       2
202 #define RGN_TYPE_TEMPORARY      3
203 #define RGN_TYPE_UI                     4
204
205 /* region alignment */
206 #define RGN_ALIGN_NONE          0
207 #define RGN_ALIGN_TOP           1
208 #define RGN_ALIGN_BOTTOM        2
209 #define RGN_ALIGN_LEFT          3
210 #define RGN_ALIGN_RIGHT         4
211 #define RGN_ALIGN_HSPLIT        5
212 #define RGN_ALIGN_VSPLIT        6
213 #define RGN_ALIGN_FLOAT         7
214 #define RGN_ALIGN_QSPLIT        8
215 #define RGN_OVERLAP_TOP         9
216 #define RGN_OVERLAP_BOTTOM      10
217 #define RGN_OVERLAP_LEFT        11
218 #define RGN_OVERLAP_RIGHT       12
219
220 /* region flag */
221 #define RGN_FLAG_HIDDEN         1
222 #define RGN_FLAG_TOO_SMALL      2
223
224 #endif
225