RNA: review of commits in the past days, check the diffs for the
[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  * 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 ARegionType;
40 struct Scene;
41
42 typedef struct bScreen {
43         ID id;
44         
45         ListBase vertbase, edgebase;
46         ListBase areabase;
47         ListBase regionbase;                            /* screen level regions, runtime only */
48         struct Scene *scene;
49         
50         short scenenr, screennr;                        /* only for pupmenu */
51         
52         short full, winid;                                      /* winid from WM, starts with 1 */
53         short do_draw;                                          /* notifier for drawing edges */
54         short do_refresh;                                       /* notifier for scale screen, changed screen, etc */
55         short do_gesture;                                       /* notifier for gesture draw. */
56         short pad[3];
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 typedef struct Panel {          /* the part from uiBlock that needs saved in file */
79         struct Panel *next, *prev;
80
81         char panelname[64], tabname[64];        /* defined as UI_MAX_NAME_STR */
82         char drawname[64];                                      /* panelname is identifier for restoring location */
83         short ofsx, ofsy, sizex, sizey;
84         short flag, active;                                     /* active= used currently by a uiBlock */
85         short control;
86         short snap;
87         short old_ofsx, old_ofsy;               /* for stow */
88         int sortcounter;                        /* when sorting panels, it uses this to put new ones in right place */
89         struct Panel *paneltab;         /* this panel is tabbed in *paneltab */
90 } Panel;
91
92 typedef struct ScrArea {
93         struct ScrArea *next, *prev;
94         
95         ScrVert *v1, *v2, *v3, *v4;
96         bScreen *full;                  /* if area==full, this is the parent */
97
98         rcti totrct;                    /* rect bound by v1 v2 v3 v4 */
99
100         char spacetype, butspacetype;   /* SPACE_..., butspacetype is button arg  */
101         short winx, winy;                               /* size */
102         
103         short headertype;                               /* OLD! 0=no header, 1= down, 2= up */
104         short headbutlen, headbutofs;   /* OLD! */
105         short cursor, flag;
106
107         ScriptLink scriptlink;
108         
109         struct SpaceType *type;         /* callbacks for this space type */
110         
111         ListBase spacedata;
112         ListBase uiblocks;
113         ListBase panels;
114         ListBase regionbase;    /* ARegion */
115         ListBase handlers;              /* wmEventHandler */
116         
117         ListBase actionzones;   /* AZone */
118 } ScrArea;
119
120 typedef struct ARegion {
121         struct ARegion *next, *prev;
122         
123         View2D v2d;                                     /* 2D-View scrolling/zoom info (most regions are 2d anyways) */
124         rcti winrct;                            /* coordinates of region */
125         
126         short swinid;
127         short regiontype;                       /* window, header, etc. identifier for drawing */
128         short alignment;                        /* how it should split */
129         short size;                                     /* current split size in pixels */
130         short minsize;                          /* set by spacedata's region init */
131         short flag;                                     /* hide, ... */
132         
133         float fsize;                            /* current split size in float */
134         
135         int pad;
136         short do_draw, do_refresh;      /* cached notifier events */
137         
138         struct ARegionType *type;       /* callbacks for this region type */
139         
140         ListBase uiblocks;
141         ListBase handlers;                      /* wmEventHandler */
142         
143         void *regiondata;                       /* XXX 2.50, need spacedata equivalent? */
144 } ARegion;
145
146 /* area->flag */
147 #define HEADER_NO_PULLDOWN      1
148 #define AREA_FLAG_DRAWJOINTO 2
149 #define AREA_FLAG_DRAWJOINFROM 4
150
151 /* If you change EDGEWIDTH, also do the global arrat edcol[]  */
152 #define EDGEWIDTH       1
153 #define AREAGRID        4
154 #define AREAMINX        32
155 #define HEADERY         26
156 #define AREAMINY        (HEADERY+EDGEWIDTH)
157
158 #define HEADERDOWN      1
159 #define HEADERTOP       2
160
161 #define SCREENNORMAL    0
162 #define SCREENFULL      1
163 #define SCREENAUTOPLAY  2
164
165 /* sa->win_swap */
166 #define WIN_FRONT_OK    1
167 #define WIN_BACK_OK             2
168 #define WIN_EQUAL               3
169
170 /* Panel->snap - for snapping to screen edges */
171 #define PNL_SNAP_NONE           0
172 #define PNL_SNAP_TOP            1
173 #define PNL_SNAP_RIGHT          2
174 #define PNL_SNAP_BOTTOM 4
175 #define PNL_SNAP_LEFT           8
176
177 #define PNL_SNAP_DIST           9.0
178
179 /* screen handlers */
180 #define SCREEN_MAXHANDLER               8
181
182 #define SCREEN_HANDLER_ANIM             1
183 #define SCREEN_HANDLER_PYTHON   2
184 #define SCREEN_HANDLER_VERSE    3
185
186 /* regiontype, first two are the default set */
187 #define RGN_TYPE_WINDOW         0
188 #define RGN_TYPE_HEADER         1
189 #define RGN_TYPE_TEMPORARY      2
190
191 /* region alignment */
192 #define RGN_ALIGN_NONE          0
193 #define RGN_ALIGN_TOP           1
194 #define RGN_ALIGN_BOTTOM        2
195 #define RGN_ALIGN_LEFT          3
196 #define RGN_ALIGN_RIGHT         4
197 #define RGN_ALIGN_HSPLIT        5
198 #define RGN_ALIGN_VSPLIT        6
199 #define RGN_ALIGN_FLOAT         7
200
201 /* region flag */
202 #define RGN_FLAG_HIDDEN         1
203 #define RGN_FLAG_TOO_SMALL      2
204
205 #endif
206