#include <BKE_screen.hh>

Public Attributes
ARegionType *	next
ARegionType *	prev
int	regionid
void(*	init )(wmWindowManager wm, ARegion region)
void(*	exit )(wmWindowManager wm, ARegion region)
bool(*	poll )(const RegionPollParams *params)
void(*	draw )(const bContext C, ARegion region)
void(*	draw_overlay )(const bContext C, ARegion region)
void(*	layout )(const bContext C, ARegion region)
int(*	snap_size )(const ARegion *region, int size, int axis)
void(*	listener )(const wmRegionListenerParams *params)
void(*	message_subscribe )(const wmRegionMessageSubscribeParams *params)
void(*	free )(ARegion *)
void (	duplicate )(void *poin)
void(*	operatortypes )()
void(*	keymap )(wmKeyConfig *keyconf)
void(*	cursor )(wmWindow win, ScrArea area, ARegion *region)
bContextDataCallback	context
void(*	on_poll_success )(const bContext C, ARegion region)
void(*	on_user_resize )(const ARegion *region)
void(*	on_view2d_changed )(const bContext C, ARegion region)
ListBase	drawcalls
ListBase	paneltypes
ListBase	headertypes
int	minsizex
int	minsizey
int	prefsizex
int	prefsizey
int	keymapflag
short	do_lock
short	lock
bool	clip_gizmo_events_by_ui
short	event_cursor

Detailed Description

Definition at line 189 of file BKE_screen.hh.

Member Data Documentation

◆ clip_gizmo_events_by_ui

bool ARegionType::clip_gizmo_events_by_ui

Don't handle gizmos events behind uiBlock's with UI_BLOCK_CLIP_EVENTS flag set.

Definition at line 279 of file BKE_screen.hh.

Referenced by ED_spacetype_node(), ED_spacetype_sequencer(), and wm_handlers_do_gizmo_handler().

◆ context

bContextDataCallback ARegionType::context

Definition at line 237 of file BKE_screen.hh.

Referenced by CTX_data_dir_get_ex(), ctx_data_get(), ED_spacetype_image(), ED_spacetype_outliner(), and ED_spacetype_view3d().

◆ cursor

void(* ARegionType::cursor) (wmWindow *win, ScrArea *area, ARegion *region)

Definition at line 234 of file BKE_screen.hh.

Referenced by ED_region_cursor_set(), ED_spacetype_console(), ED_spacetype_node(), ED_spacetype_sequencer(), ED_spacetype_text(), and ED_spacetype_view3d().

◆ do_lock

short ARegionType::do_lock

Definition at line 277 of file BKE_screen.hh.

Referenced by ED_region_do_draw(), and ED_region_do_layout().

◆ draw

◆ draw_overlay

void(* ARegionType::draw_overlay) (const bContext *C, ARegion *region)

Handler to draw overlays. This handler is called every draw loop.

Note: Some editors should return early if the interface is locked (check with CTX_wm_interface_locked) to avoid accessing scene data that another thread may be modifying

Definition at line 214 of file BKE_screen.hh.

Referenced by ED_spacetype_action(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_sequencer(), wm_draw_window_onscreen(), and wm_region_draw_overlay().

◆ drawcalls

ListBase ARegionType::drawcalls

Definition at line 261 of file BKE_screen.hh.

Referenced by ED_region_draw_cb_activate(), ed_region_draw_cb_draw(), ED_region_draw_cb_exit(), and ED_region_draw_cb_remove_by_type().

◆ duplicate

void *(* ARegionType::duplicate) (void *poin)

Definition at line 227 of file BKE_screen.hh.

Referenced by BKE_area_region_copy(), ED_spacetype_image(), and ED_spacetype_view3d().

◆ event_cursor

short ARegionType::event_cursor

Definition at line 281 of file BKE_screen.hh.

Referenced by ED_spacetype_console(), ED_spacetype_node(), ED_spacetype_sequencer(), ED_spacetype_text(), and region_cursor_set_ex().

◆ exit

void(* ARegionType::exit) (wmWindowManager *wm, ARegion *region)

Definition at line 197 of file BKE_screen.hh.

Referenced by ED_region_exit(), and ED_spacetype_view3d().

◆ free

void(* ARegionType::free) (ARegion *)

Definition at line 224 of file BKE_screen.hh.

Referenced by BKE_area_region_free(), ED_area_type_hud(), ED_spacetype_image(), ED_spacetype_outliner(), ED_spacetype_view3d(), blender::ed::spreadsheet::register_spacetype(), ui_searchbox_create_generic_ex(), and ui_tooltip_create_with_data().

◆ headertypes

ListBase ARegionType::headertypes

Definition at line 267 of file BKE_screen.hh.

Referenced by ED_region_header_layout(), and blender::ed::asset::shelf::header_regiontype_register().

◆ init

void(* ARegionType::init) (wmWindowManager *wm, ARegion *region)

◆ keymap

void(* ARegionType::keymap) (wmKeyConfig *keyconf)

Definition at line 232 of file BKE_screen.hh.

◆ keymapflag

◆ layout

void(* ARegionType::layout) (const bContext *C, ARegion *region)

Definition at line 216 of file BKE_screen.hh.

Referenced by ED_area_type_hud(), ED_region_do_layout(), ED_spacetype_buttons(), ED_spacetype_image(), ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_topbar(), ED_spacetype_userpref(), ED_spacetype_view3d(), region_rect_recursive(), blender::ed::spreadsheet::register_spacetype(), ui_popup_block_create(), ui_searchbox_create_generic_ex(), and wm_draw_window_offscreen().

◆ listener

void(* ARegionType::listener) (const wmRegionListenerParams *params)

◆ lock

short ARegionType::lock

Definition at line 277 of file BKE_screen.hh.

Referenced by ED_area_type_hud(), ED_spacetype_node(), ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().

◆ message_subscribe

void(* ARegionType::message_subscribe) (const wmRegionMessageSubscribeParams *params)

Definition at line 222 of file BKE_screen.hh.

Referenced by ED_region_message_subscribe(), ED_spacetype_action(), ED_spacetype_buttons(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_info(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_node(), ED_spacetype_outliner(), ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_topbar(), and ED_spacetype_view3d().

◆ minsizex

int ARegionType::minsizex

Definition at line 270 of file BKE_screen.hh.

◆ minsizey

int ARegionType::minsizey

Definition at line 270 of file BKE_screen.hh.

◆ next

ARegionType* ARegionType::next

Definition at line 190 of file BKE_screen.hh.

◆ on_poll_success

void(* ARegionType::on_poll_success) (const bContext *C, ARegion *region)

Called on every frame in which the region's poll succeeds, regardless of visibility, before drawing, visibility evaluation and initialization. Allows the region to override visibility.

Definition at line 243 of file BKE_screen.hh.

Referenced by ED_spacetype_image(), and ED_spacetype_view3d().

◆ on_user_resize

void(* ARegionType::on_user_resize) (const ARegion *region)

Called whenever the user changes the region's size. Not called when the size is changed through other means, like to adjust for a scaled down window.

Definition at line 249 of file BKE_screen.hh.

Referenced by ED_spacetype_image(), ED_spacetype_view3d(), and region_scale_modal().

◆ on_view2d_changed

void(* ARegionType::on_view2d_changed) (const bContext *C, ARegion *region)

Definition at line 258 of file BKE_screen.hh.

Referenced by ED_spacetype_sequencer(), and UI_view2d_curRect_changed().

◆ operatortypes

void(* ARegionType::operatortypes) ()

Definition at line 230 of file BKE_screen.hh.

◆ paneltypes

ListBase ARegionType::paneltypes

Definition at line 264 of file BKE_screen.hh.

Referenced by buttons_context_register(), buttons_main_region_layout_properties(), buttons_navigation_bar_region_draw(), blender::ed::asset::shelf::catalog_selector_panel_register(), ED_clip_buttons_register(), ED_region_panels_ex(), ED_region_panels_layout(), ED_uvedit_buttons_register(), ED_view3d_buttons_region_layout_ex(), file_execute_region_panels_register(), file_tool_props_region_panels_register(), file_tools_region_panels_register(), fmodifier_panel_register(), fmodifier_subpanel_register(), graph_buttons_register(), hud_panels_register(), image_buttons_region_layout(), image_buttons_register(), modifier_panel_register(), modifier_subpanel_register(), nla_buttons_register(), blender::ed::asset::shelf::popover_panel_register(), property_search_for_context(), blender::ed::spreadsheet::register_row_filter_panels(), sequencer_buttons_register(), shaderfx_panel_register(), shaderfx_subpanel_register(), blender::ed::spreadsheet::spreadsheet_data_set_region_panels_register(), UI_panel_add_instanced(), ui_panel_category_active_set(), uiItemPopoverPanelFromGroup(), userpref_main_region_layout(), and view3d_buttons_register().

◆ poll

bool(* ARegionType::poll) (const RegionPollParams *params)

Optional callback to decide whether the region should be treated as existing given the current context. When returning false, the region will be kept in storage, but is not available to the user in any way. Callbacks can assume that context has the owning area and space-data set.

Definition at line 204 of file BKE_screen.hh.

Referenced by ED_spacetype_clip(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_sequencer(), ED_spacetype_userpref(), ED_spacetype_view3d(), and region_poll().

◆ prefsizex

int ARegionType::prefsizex

◆ prefsizey

◆ prev

ARegionType * ARegionType::prev