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