#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 209 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 304 of file BKE_screen.hh.

Referenced by ED_spacetype_node(), and blender::ed::vse::ED_spacetype_sequencer().

◆ context

bContextDataCallback ARegionType::context

Return context data.

Definition at line 257 of file BKE_screen.hh.

Referenced by ED_spacetype_image(), ED_spacetype_node(), ED_spacetype_outliner(), and ED_spacetype_view3d().

◆ cursor

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

Allows default cursor per region.

Definition at line 254 of file BKE_screen.hh.

Referenced by ED_spacetype_console(), ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_text(), ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().

◆ do_lock

short ARegionType::do_lock

Return without drawing. lock is set by region definition, and copied to do_lock by render. Set as bitflag value in ARegionDrawLockFlags.

Definition at line 302 of file BKE_screen.hh.

Referenced by ED_region_do_draw(), and ED_region_do_layout().

◆ draw

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

Draw entirely, view changes should be handled here.

Definition at line 226 of file BKE_screen.hh.

Referenced by ED_area_type_hud(), ED_region_do_draw(), ED_spacetype_action(), ED_spacetype_buttons(), ED_spacetype_clip(), ED_spacetype_console(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_info(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_node(), ED_spacetype_outliner(), ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_text(), ED_spacetype_topbar(), ED_spacetype_userpref(), ED_spacetype_view3d(), blender::ed::spreadsheet::register_spacetype(), ui_popup_block_create(), ui_searchbox_create_generic_ex(), and ui_tooltip_create_with_data().

◆ 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 234 of file BKE_screen.hh.

Referenced by ED_spacetype_action(), ED_spacetype_ipo(), ED_spacetype_nla(), and blender::ed::vse::ED_spacetype_sequencer().

◆ drawcalls

ListBase ARegionType::drawcalls

Custom drawing callbacks.

Definition at line 283 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)

Split region, copy data optionally.

Definition at line 247 of file BKE_screen.hh.

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

◆ event_cursor

short ARegionType::event_cursor

Call cursor function on each move event.

Definition at line 306 of file BKE_screen.hh.

Referenced by ED_spacetype_console(), ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_text(), and blender::ed::spreadsheet::register_spacetype().

◆ exit

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

Exit is called when the region is hidden or removed.

Definition at line 217 of file BKE_screen.hh.

Referenced by ED_spacetype_view3d().

◆ free

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

Definition at line 244 of file BKE_screen.hh.

Referenced by BKE_area_region_free(), ED_area_type_hud(), ED_spacetype_image(), ED_spacetype_node(), 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

Header type definitions.

Definition at line 289 of file BKE_screen.hh.

Referenced by blender::ed::asset::shelf::header_regiontype_register().

◆ init

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

Add handlers, stuff you only do once or on area/region type/size changes.

Definition at line 215 of file BKE_screen.hh.

Referenced by ED_area_type_hud(), ED_spacetype_action(), ED_spacetype_buttons(), ED_spacetype_clip(), ED_spacetype_console(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_info(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_node(), ED_spacetype_outliner(), ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_text(), ED_spacetype_topbar(), ED_spacetype_userpref(), ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().

◆ keymap

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

Add items to keymap.

Definition at line 252 of file BKE_screen.hh.

◆ keymapflag

int ARegionType::keymapflag

◆ layout

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

Optional, compute button layout before drawing for dynamic size.

Definition at line 236 of file BKE_screen.hh.

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

◆ listener

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

Contextual changes should be handled here.

Definition at line 240 of file BKE_screen.hh.

Referenced by ED_area_type_hud(), ED_spacetype_action(), ED_spacetype_buttons(), ED_spacetype_clip(), ED_spacetype_console(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_info(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_node(), ED_spacetype_outliner(), ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_topbar(), ED_spacetype_userpref(), ED_spacetype_view3d(), blender::ed::spreadsheet::register_spacetype(), ui_popup_block_create(), and ui_searchbox_create_generic_ex().

◆ lock

short ARegionType::lock

Definition at line 302 of file BKE_screen.hh.

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

◆ message_subscribe

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

Optional callback to generate subscriptions.

Definition at line 242 of file BKE_screen.hh.

Referenced by 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(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_topbar(), and ED_spacetype_view3d().

◆ minsizex

int ARegionType::minsizex

Hardcoded constraints, smaller than these values region is not visible.

Definition at line 292 of file BKE_screen.hh.

◆ minsizey

int ARegionType::minsizey

Definition at line 292 of file BKE_screen.hh.

◆ next

ARegionType* ARegionType::next

Definition at line 210 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 263 of file BKE_screen.hh.

Referenced by ED_spacetype_image(), ED_spacetype_node(), 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 269 of file BKE_screen.hh.

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

◆ on_view2d_changed

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

Is called whenever the current visible View2D's region changes.

Used from user code such as view navigation/zoom operators to inform region about changes. The goal is to support zoom-to-fit features which gets disabled when manual navigation is performed.

This callback is not called on indirect changes of the current viewport (which could happen when the v2d->tot is changed and cur is adopted accordingly).

Definition at line 280 of file BKE_screen.hh.

Referenced by blender::ed::vse::ED_spacetype_sequencer().

◆ operatortypes

void(* ARegionType::operatortypes) ()

Register operator types on startup.

Definition at line 250 of file BKE_screen.hh.

◆ paneltypes

ListBase ARegionType::paneltypes

Panels type definitions.

Definition at line 286 of file BKE_screen.hh.

Referenced by buttons_context_register(), blender::ed::asset::shelf::catalog_selector_panel_register(), ED_clip_buttons_register(), 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_register(), blender::seq::modifier_panel_register(), modifier_panel_register(), modifier_subpanel_register(), nla_buttons_register(), blender::ed::space_node::node_tree_interface_panel_register(), uiLayout::popover_group(), blender::ed::asset::shelf::popover_panel_register(), blender::ed::spreadsheet::register_row_filter_panels(), blender::ed::vse::sequencer_buttons_register(), shaderfx_panel_register(), shaderfx_subpanel_register(), blender::ed::spreadsheet::spreadsheet_data_set_region_panels_register(), UI_panel_add_instanced(), 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 224 of file BKE_screen.hh.

Referenced by ED_spacetype_action(), ED_spacetype_clip(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_ipo(), ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_userpref(), and ED_spacetype_view3d().

◆ prefsizex

int ARegionType::prefsizex

When new region opens (region prefsizex/y are zero then.

Definition at line 294 of file BKE_screen.hh.

Referenced by ED_area_type_hud(), ED_spacetype_action(), ED_spacetype_buttons(), ED_spacetype_clip(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_text(), ED_spacetype_topbar(), ED_spacetype_userpref(), ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().

◆ prefsizey

◆ prev

ARegionType * ARegionType::prev