Whole lot of changes.... here a shortlist:
[blender.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  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef DNA_SCREEN_TYPES_H
29 #define DNA_SCREEN_TYPES_H
30
31 #include "DNA_listBase.h"
32 #include "DNA_vec_types.h"
33
34 #include "DNA_ID.h"
35 #include "DNA_scriptlink_types.h"
36
37 struct Scene;
38 struct SpaceType;
39 struct SpaceLink;
40 struct ARegionType;
41 struct bContext;
42 struct wmNotifier;
43 struct wmWindowManager;
44                 
45
46 typedef struct bScreen {
47         ID id;
48         
49         ListBase vertbase, edgebase, areabase;
50         struct Scene *scene;
51         
52         short scenenr, screennr;                        /* only for pupmenu */
53         
54         short full, winid;                                      /* winid from WM, starts with 1 */
55         short do_draw;                                          /* notifier for drawing edges */
56         short do_refresh;                                       /* notifier for scale screen, changed screen, etc */
57         
58         short mainwin;                                          /* screensize subwindow, for screenedges and global menus */
59         short subwinactive;                                     /* active subwindow */
60         
61         short handler[8];                                       /* similar to space handler */
62 } bScreen;
63
64 typedef struct ScrVert {
65         struct ScrVert *next, *prev, *newv;
66         vec2s vec;
67         int flag;
68 } ScrVert;
69
70 typedef struct ScrEdge {
71         struct ScrEdge *next, *prev;
72         ScrVert *v1, *v2;
73         short border;                   /* 1 when at edge of screen */
74         short flag;
75         int pad;
76 } ScrEdge;
77
78 #ifndef DNA_USHORT_FIX
79 #define DNA_USHORT_FIX
80 /**
81  * @deprecated This typedef serves to avoid badly typed functions when
82  * @deprecated compiling while delivering a proper dna.c. Do not use
83  * @deprecated it in any case.
84  */
85 typedef unsigned short dna_ushort_fix;
86 #endif
87
88
89
90 typedef struct Panel {          /* the part from uiBlock that needs saved in file */
91         struct Panel *next, *prev;
92
93         char panelname[64], tabname[64];        /* defined as UI_MAX_NAME_STR */
94         char drawname[64];                                      /* panelname is identifier for restoring location */
95         short ofsx, ofsy, sizex, sizey;
96         short flag, active;                                     /* active= used currently by a uiBlock */
97         short control;
98         short snap;
99         short old_ofsx, old_ofsy;               /* for stow */
100         int sortcounter;                        /* when sorting panels, it uses this to put new ones in right place */
101         struct Panel *paneltab;         /* this panel is tabbed in *paneltab */
102 } Panel;
103
104 typedef struct ScrArea {
105         struct ScrArea *next, *prev;
106         
107         ScrVert *v1, *v2, *v3, *v4;
108         bScreen *full;                  /* if area==full, this is the parent */
109
110         rcti totrct;                    /* rect bound by v1 v2 v3 v4 */
111         rcti headrct, winrct;   /* OLD! gets converted to region */
112
113         char spacetype, butspacetype;   /* SPACE_..., butspacetype is button arg  */
114         short winx, winy;                               /* size */
115         
116         short headertype;                               /* OLD! 0=no header, 1= down, 2= up */
117         short headbutlen, headbutofs;   /* OLD! */
118         short cursor, flag;
119
120         ScriptLink scriptlink;
121         
122         struct SpaceType *type;         /* callbacks for this space type */
123         
124         ListBase spacedata;
125         ListBase uiblocks;
126         ListBase panels;
127         ListBase regionbase;    /* ARegion */
128         ListBase handlers;              /* wmEventHandler */
129 } ScrArea;
130
131 typedef struct ARegion {
132         struct ARegion *next, *prev;
133         
134         rcti winrct;
135         short swinid;
136         short regiontype;                       /* window, header, etc. identifier for drawing */
137         short alignment;                        /* how it should split */
138         short size;                                     /* current split size in pixels */
139         short minsize;                          /* set by spacedata's region init */
140         short flag;                                     /* hide, ... */
141         
142         float fsize;                            /* current split size in float */
143         
144         int pad;
145         short do_draw, do_refresh;      /* cached notifier events */
146         
147         struct ARegionType *type;       /* callbacks for this region type */
148         
149         ListBase handlers;
150         
151 } ARegion;
152
153
154 /* area->flag */
155 #define HEADER_NO_PULLDOWN      1
156
157 /* If you change EDGEWIDTH, also do the global arrat edcol[]  */
158 #define EDGEWIDTH       1
159 #define EDGEWIDTH2      0
160 #define AREAGRID        4
161 #define AREAMINX        32
162 #define HEADERY         26
163 #define AREAMINY        (HEADERY+EDGEWIDTH)
164
165 #define HEADERDOWN      1
166 #define HEADERTOP       2
167
168 #define SCREENNORMAL    0
169 #define SCREENFULL      1
170 #define SCREENAUTOPLAY  2
171
172 /* sa->win_swap */
173 #define WIN_FRONT_OK    1
174 #define WIN_BACK_OK             2
175 #define WIN_EQUAL               3
176
177 #define L_SCROLL 1                      /* left scrollbar */
178 #define R_SCROLL 2
179 #define VERT_SCROLL 3
180 #define T_SCROLL 4
181 #define B_SCROLL 8
182 #define HOR_SCROLL  12
183 #define B_SCROLLO   16          /* special hack for outliner hscroll - prevent hanging */
184 #define HOR_SCROLLO 20          /*        in older versions of blender                       */
185
186 /* Panel->snap - for snapping to screen edges */
187 #define PNL_SNAP_NONE           0
188 #define PNL_SNAP_TOP            1
189 #define PNL_SNAP_RIGHT          2
190 #define PNL_SNAP_BOTTOM 4
191 #define PNL_SNAP_LEFT           8
192
193 #define PNL_SNAP_DIST           9.0
194
195 /* screen handlers */
196 #define SCREEN_MAXHANDLER               8
197
198 #define SCREEN_HANDLER_ANIM             1
199 #define SCREEN_HANDLER_PYTHON   2
200 #define SCREEN_HANDLER_VERSE    3
201
202 /* regiontype, first two are the default set */
203 #define RGN_TYPE_WINDOW         0
204 #define RGN_TYPE_HEADER         1
205
206 /* region alignment */
207 #define RGN_ALIGN_NONE          0
208 #define RGN_ALIGN_TOP           1
209 #define RGN_ALIGN_BOTTOM        2
210 #define RGN_ALIGN_LEFT          3
211 #define RGN_ALIGN_RIGHT         4
212 #define RGN_ALIGN_HSPLIT        5
213 #define RGN_ALIGN_VSPLIT        6
214
215 /* region flag */
216 #define RGN_FLAG_HIDDEN         1
217 #define RGN_FLAG_TOO_SMALL      2
218
219
220 #endif
221