Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / include / ED_space_api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup editors
21  */
22
23 #ifndef __ED_SPACE_API_H__
24 #define __ED_SPACE_API_H__
25
26 struct ARegionType;
27 struct bContext;
28
29 void ED_spacetypes_init(void);
30 void ED_spacemacros_init(void);
31
32 /* the pluginnable API for export to editors */
33
34 /* calls for registering default spaces */
35 void ED_spacetype_outliner(void);
36 void ED_spacetype_view3d(void);
37 void ED_spacetype_ipo(void);
38 void ED_spacetype_image(void);
39 void ED_spacetype_node(void);
40 void ED_spacetype_buttons(void);
41 void ED_spacetype_info(void);
42 void ED_spacetype_file(void);
43 void ED_spacetype_action(void);
44 void ED_spacetype_nla(void);
45 void ED_spacetype_script(void);
46 void ED_spacetype_text(void);
47 void ED_spacetype_sequencer(void);
48 void ED_spacetype_logic(void);
49 void ED_spacetype_console(void);
50 void ED_spacetype_userpref(void);
51 void ED_spacetype_clip(void);
52 void ED_spacetype_statusbar(void);
53 void ED_spacetype_topbar(void);
54
55 /* calls for instancing and freeing spacetype static data
56  * called in WM_init_exit */
57 /* in space_file.c */
58 void ED_file_init(void);
59 void ED_file_exit(void);
60
61 #define REGION_DRAW_POST_VIEW   0
62 #define REGION_DRAW_POST_PIXEL  1
63 #define REGION_DRAW_PRE_VIEW    2
64
65 void *ED_region_draw_cb_activate(struct ARegionType *,
66                                  void (*draw)(const struct bContext *, struct ARegion *, void *),
67                                  void *custumdata, int type);
68 void ED_region_draw_cb_draw(const struct bContext *, struct ARegion *, int);
69 void ED_region_draw_cb_exit(struct ARegionType *, void *);
70 /* generic callbacks */
71 /* ed_util.c */
72 void ED_region_draw_mouse_line_cb(const struct bContext *C, struct ARegion *ar, void *arg_info);
73
74 #endif /* __ED_SPACE_API_H__ */