View2D - Initial commit of Pan-View Operator
[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 #ifndef DNA_USHORT_FIX
79 #define DNA_USHORT_FIX
80 /**
81  * @deprecated This typedef serves to avoid badly typed functions when
82  * @deprecated compiling while delivering a proper dna.c. Do not use
83  * @deprecated it in any case.
84  */
85 /*typedef unsigned short dna_ushort_fix;*/
86 #endif
87
88
89
90 typedef struct Panel {          /* the part from uiBlock that needs saved in file */
91         struct Panel *next, *prev;
92
93         char panelname[64], tabname[64];        /* defined as UI_MAX_NAME_STR */
94         char drawname[64];                                      /* panelname is identifier for restoring location */
95         short ofsx, ofsy, sizex, sizey;
96         short flag, active;                                     /* active= used currently by a uiBlock */
97         short control;
98         short snap;
99         short old_ofsx, old_ofsy;               /* for stow */
100         int sortcounter;                        /* when sorting panels, it uses this to put new ones in right place */
101         struct Panel *paneltab;         /* this panel is tabbed in *paneltab */
102 } Panel;
103
104 typedef struct ScrArea {
105         struct ScrArea *next, *prev;
106         
107         ScrVert *v1, *v2, *v3, *v4;
108         bScreen *full;                  /* if area==full, this is the parent */
109
110         rcti totrct;                    /* rect bound by v1 v2 v3 v4 */
111
112         char spacetype, butspacetype;   /* SPACE_..., butspacetype is button arg  */
113         short winx, winy;                               /* size */
114         
115         short headertype;                               /* OLD! 0=no header, 1= down, 2= up */
116         short headbutlen, headbutofs;   /* OLD! */
117         short cursor, flag;
118
119         ScriptLink scriptlink;
120         
121         struct SpaceType *type;         /* callbacks for this space type */
122         
123         ListBase spacedata;
124         ListBase uiblocks;
125         ListBase panels;
126         ListBase regionbase;    /* ARegion */
127         ListBase handlers;              /* wmEventHandler */
128         ListBase modalops;              /* wmOperator */
129         
130         ListBase actionzones;   /* AZone */
131 } ScrArea;
132
133 typedef struct ARegion {
134         struct ARegion *next, *prev;
135         
136         View2D v2d;                                     /* 2D-View scrolling/zoom info (most regions are 2d anyways) */
137         rcti winrct;                            /* coordinates of region */
138         
139         short swinid;
140         short regiontype;                       /* window, header, etc. identifier for drawing */
141         short alignment;                        /* how it should split */
142         short size;                                     /* current split size in pixels */
143         short minsize;                          /* set by spacedata's region init */
144         short flag;                                     /* hide, ... */
145         
146         float fsize;                            /* current split size in float */
147         
148         int pad;
149         short do_draw, do_refresh;      /* cached notifier events */
150         
151         struct ARegionType *type;       /* callbacks for this region type */
152         
153         ListBase uiblocks;
154         ListBase handlers;                      /* wmEventHandler */
155         ListBase modalops;                      /* wmOperator */
156         
157         void *regiondata;                       /* XXX 2.50, need spacedata equivalent? */
158 } ARegion;
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 /* sa->win_swap */
180 #define WIN_FRONT_OK    1
181 #define WIN_BACK_OK             2
182 #define WIN_EQUAL               3
183
184 /* scrollbar flags for View2D */
185         /* left scrollbar */
186 #define L_SCROLL 1                      
187 #define R_SCROLL 2
188 #define VERT_SCROLL 3
189 #define T_SCROLL 4
190 #define B_SCROLL 8
191 #define HOR_SCROLL  12
192         /* special hack for outliner hscroll - prevent hanging older versions of Blender */
193 #define B_SCROLLO   16
194 #define HOR_SCROLLO 20
195
196 /* Panel->snap - for snapping to screen edges */
197 #define PNL_SNAP_NONE           0
198 #define PNL_SNAP_TOP            1
199 #define PNL_SNAP_RIGHT          2
200 #define PNL_SNAP_BOTTOM 4
201 #define PNL_SNAP_LEFT           8
202
203 #define PNL_SNAP_DIST           9.0
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_TEMPORARY      2
216
217 /* region alignment */
218 #define RGN_ALIGN_NONE          0
219 #define RGN_ALIGN_TOP           1
220 #define RGN_ALIGN_BOTTOM        2
221 #define RGN_ALIGN_LEFT          3
222 #define RGN_ALIGN_RIGHT         4
223 #define RGN_ALIGN_HSPLIT        5
224 #define RGN_ALIGN_VSPLIT        6
225 #define RGN_ALIGN_FLOAT         7
226
227 /* region flag */
228 #define RGN_FLAG_HIDDEN         1
229 #define RGN_FLAG_TOO_SMALL      2
230
231 #endif
232