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