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