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