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