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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 wmKeyConfig;
  41 struct bContext;
  42 struct SpaceType;
  43 struct Scene;
  44 struct bScreen;
  45 struct ARegion;
  46 struct uiBlock;
  47 struct rcti;
  48
  49 /* regions */
  50 void    ED_region_do_listen(struct ARegion *ar, struct wmNotifier *note);
  51 void    ED_region_do_draw(struct bContext *C, struct ARegion *ar);
  52 void    ED_region_exit(struct bContext *C, struct ARegion *ar);
  53 void    ED_region_pixelspace(struct ARegion *ar);
  54 void    ED_region_set(const struct bContext *C, struct ARegion *ar);
  55 void    ED_region_init(struct bContext *C, struct ARegion *ar);
  56 void    ED_region_tag_redraw(struct ARegion *ar);
  57 void    ED_region_tag_redraw_partial(struct ARegion *ar, struct rcti *rct);
  58 void    ED_region_panels_init(struct wmWindowManager *wm, struct ARegion *ar);
  59 void    ED_region_panels(const struct bContext *C, struct ARegion *ar, int vertical, char *context, int contextnr);
  60 void    ED_region_header_init(struct ARegion *ar);
  61 void    ED_region_header(const struct bContext *C, struct ARegion *ar);
  62 void    ED_region_toggle_hidden(struct bContext *C, struct ARegion *ar);
  63 void    region_scissor_winrct(struct ARegion *ar, struct rcti *winrct);
  64
  65 /* spaces */
  66 void    ED_spacetypes_init(void);
  67 void    ED_spacetypes_keymap(struct wmKeyConfig *keyconf);
  68 int             ED_area_header_switchbutton(const struct bContext *C, struct uiBlock *block, int yco);
  69 int             ED_area_header_standardbuttons(const struct bContext *C, struct uiBlock *block, int yco);
  70 void    ED_area_overdraw(struct bContext *C);
  71 void    ED_area_overdraw_flush(struct bContext *C, struct ScrArea *sa, struct ARegion *ar);
  72
  73
  74 /* areas */
  75 void    ED_area_initialize(struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa);
  76 void    ED_area_exit(struct bContext *C, struct ScrArea *sa);
  77 int             ED_screen_area_active(const struct bContext *C);
  78 void    ED_area_do_listen(ScrArea *sa, struct wmNotifier *note);
  79 void    ED_area_tag_redraw(ScrArea *sa);
  80 void    ED_area_tag_refresh(ScrArea *sa);
  81 void    ED_area_do_refresh(struct bContext *C, ScrArea *sa);
  82 void    ED_area_headerprint(ScrArea *sa, const char *str);
  83 void    ED_area_newspace(struct bContext *C, ScrArea *sa, int type);
  84 void    ED_area_prevspace(struct bContext *C, ScrArea *sa);
  85 void    ED_area_swapspace(struct bContext *C, ScrArea *sa1, ScrArea *sa2);
  86
  87 /* screens */
  88 void    ED_screens_initialize(struct wmWindowManager *wm);
  89 void    ED_screen_draw(struct wmWindow *win);
  90 void    ED_screen_refresh(struct wmWindowManager *wm, struct wmWindow *win);
  91 void    ED_screen_do_listen(struct wmWindow *win, struct wmNotifier *note);
  92 bScreen *ED_screen_duplicate(struct wmWindow *win, struct bScreen *sc);
  93 bScreen *ED_screen_add(struct wmWindow *win, struct Scene *scene, char *name);
  94 void    ED_screen_set(struct bContext *C, struct bScreen *sc);
  95 void    ED_screen_delete(struct bContext *C, struct bScreen *sc);
  96 void    ED_screen_set_scene(struct bContext *C, struct Scene *scene);
  97 void    ED_screen_delete_scene(struct bContext *C, struct Scene *scene);
  98 void    ED_screen_set_subwinactive(struct wmWindow *win, struct wmEvent *event);
  99 void    ED_screen_exit(struct bContext *C, struct wmWindow *window, struct bScreen *screen);
 100 void    ED_screen_animation_timer(struct bContext *C, int redraws, int sync, int enable);
 101 void    ED_screen_animation_timer_update(struct bScreen *screen, int redraws);
 102 int             ED_screen_full_newspace(struct bContext *C, ScrArea *sa, int type);
 103 void    ED_screen_full_prevspace(struct bContext *C, ScrArea *sa);
 104 void    ED_screen_full_restore(struct bContext *C, ScrArea *sa);
 105
 106 void    ED_screen_new_window(struct bContext *C, struct rcti *position, int type);
 107
 108 /* anim */
 109 void    ED_update_for_newframe(const struct bContext *C, int mute);
 110 void    ED_refresh_viewport_fps(struct bContext *C);
 111 int ED_screen_animation_play(struct bContext *C, int sync, int mode);
 112
 113 /* screen keymaps */
 114 void    ED_operatortypes_screen(void);
 115 void    ED_keymap_screen(struct wmKeyConfig *keyconf);
 116
 117 /* operators; context poll callbacks */
 118 int             ED_operator_screenactive(struct bContext *C);
 119 int             ED_operator_screen_mainwinactive(struct bContext *C);
 120 int             ED_operator_areaactive(struct bContext *C);
 121 int             ED_operator_regionactive(struct bContext *C);
 122
 123 int             ED_operator_scene_editable(struct bContext *C);
 124
 125 int             ED_operator_view3d_active(struct bContext *C);
 126 int             ED_operator_timeline_active(struct bContext *C);
 127 int             ED_operator_outliner_active(struct bContext *C);
 128 int             ED_operator_file_active(struct bContext *C);
 129 int             ED_operator_action_active(struct bContext *C);
 130 int             ED_operator_buttons_active(struct bContext *C);
 131 int             ED_operator_node_active(struct bContext *C);
 132 int             ED_operator_ipo_active(struct bContext *C);
 133 int             ED_operator_sequencer_active(struct bContext *C);
 134 int             ED_operator_image_active(struct bContext *C);
 135 int             ED_operator_nla_active(struct bContext *C);
 136 int             ED_operator_logic_active(struct bContext *C);
 137
 138 int             ED_operator_object_active(struct bContext *C);
 139 int             ED_operator_object_active_editable(struct bContext *C);
 140 int             ED_operator_editmesh(struct bContext *C);
 141 int             ED_operator_editmesh_view3d(struct bContext *C);
 142 int             ED_operator_editarmature(struct bContext *C);
 143 int             ED_operator_editcurve(struct bContext *C);
 144 int             ED_operator_editsurf(struct bContext *C);
 145 int             ED_operator_editsurfcurve(struct bContext *C);
 146 int             ED_operator_editfont(struct bContext *C);
 147 int             ED_operator_editlattice(struct bContext *C);
 148 int             ED_operator_editmball(struct bContext *C);
 149 int             ED_operator_uvedit(struct bContext *C);
 150 int             ED_operator_uvmap(struct bContext *C);
 151 int             ED_operator_posemode(struct bContext *C);
 152
 153
 154 /* default keymaps, bitflags */
 155 #define ED_KEYMAP_UI            1
 156 #define ED_KEYMAP_VIEW2D        2
 157 #define ED_KEYMAP_MARKERS       4
 158 #define ED_KEYMAP_ANIMATION     8
 159 #define ED_KEYMAP_FRAMES        16
 160 #define ED_KEYMAP_GPENCIL       32
 161 #define ED_KEYMAP_HEADER        64
 162
 163 #endif /* ED_SCREEN_H */
 164