2.5
[blender.git] / source / blender / editors / include / ED_screen.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) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef ED_SCREEN_H
29 #define ED_SCREEN_H
30
31 #include "DNA_screen_types.h"
32 #include "DNA_space_types.h"
33 #include "DNA_view2d_types.h"
34 #include "DNA_view3d_types.h"
35
36 struct wmWindowManager;
37 struct wmWindow;
38 struct wmNotifier;
39 struct wmEvent;
40 struct bContext;
41 struct SpaceType;
42 struct AreagionType;
43 struct uiBlock;
44
45 /* regions */
46 void    ED_region_do_listen(ARegion *ar, struct wmNotifier *note);
47 void    ED_region_do_draw(struct bContext *C, struct ARegion *ar);
48 void    ED_region_exit(struct bContext *C, struct ARegion *ar);
49 void    ED_region_pixelspace(struct ARegion *ar);
50 void    ED_region_init(struct bContext *C, struct ARegion *ar);
51 void    ED_region_tag_redraw(struct ARegion *ar);
52
53 /* spaces */
54 void    ED_spacetypes_init(void);
55 void    ED_spacetypes_keymap(struct wmWindowManager *wm);
56 struct  ARegionType *ED_regiontype_from_id(struct SpaceType *st, int regionid);
57 int             ED_area_header_standardbuttons(const struct bContext *C, struct uiBlock *block, int yco);
58 void    ED_area_overdraw(struct bContext *C);
59 void    ED_area_overdraw_flush(struct bContext *C);
60
61
62 /* areas */
63 void    ED_area_initialize(struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa);
64 void    ED_area_exit(struct bContext *C, struct ScrArea *sa);
65 int             ED_screen_area_active(const struct bContext *C);
66 void    ED_area_tag_redraw(ScrArea *sa);
67 void    ED_area_headerprint(ScrArea *sa, const char *str);
68
69 /* screens */
70 void    ED_screens_initialize(struct wmWindowManager *wm);
71 void    ED_screen_draw(struct wmWindow *win);
72 void    ED_screen_refresh(struct wmWindowManager *wm, struct wmWindow *win);
73 void    ED_screen_do_listen(struct wmWindow *win, struct wmNotifier *note);
74 bScreen *ED_screen_duplicate(struct wmWindow *win, struct bScreen *sc);
75 void    ED_screen_set_subwinactive(struct wmWindow *win, struct wmEvent *event);
76 void    ED_screen_exit(struct bContext *C, struct wmWindow *window, struct bScreen *screen);
77
78 void    ED_operatortypes_screen(void);
79 void    ED_keymap_screen(struct wmWindowManager *wm);
80
81 /* operators; context poll callbacks */
82 int             ED_operator_screenactive(struct bContext *C);
83 int             ED_operator_screen_mainwinactive(struct bContext *C);
84 int             ED_operator_areaactive(struct bContext *C);
85
86 /* default keymaps, bitflags */
87 #define ED_KEYMAP_UI            1
88 #define ED_KEYMAP_VIEW2D        2
89 #define ED_KEYMAP_MARKERS       4
90 #define ED_KEYMAP_ANIMATION     8
91
92 #endif /* ED_SCREEN_H */
93