Panel_Runtime Struct Reference

#include <BKE_screen.hh>

Public Attributes
int	region_ofsx = 0
PointerRNA *	custom_data_ptr = nullptr
uiBlock *	block = nullptr
bContextStore *	context = nullptr
LayoutPanels	layout_panels

Detailed Description

Definition at line 430 of file BKE_screen.hh.

Member Data Documentation

block

uiBlock* Panel_Runtime::block = nullptr

Pointer to the panel's block. Useful when changes to panel #uiBlocks need some context from traversal of the panel "tree".

Definition at line 447 of file BKE_screen.hh.

Referenced by panel_draw_aligned_backdrop(), panel_draw_border(), panel_remove_invisible_layouts_recursive(), UI_block_draw(), ui_draw_layout_panels_backdrop(), ui_layout_panel_header_under_mouse(), UI_panel_begin(), UI_panel_header_buttons_begin(), UI_panel_header_buttons_end(), and UI_popup_dummy_panel_set().

context

bContextStore* Panel_Runtime::context = nullptr

Non-owning pointer. The context is stored in the block.

Definition at line 450 of file BKE_screen.hh.

Referenced by reorder_instanced_panel_list(), and UI_panel_context_pointer_set().

custom_data_ptr

PointerRNA* Panel_Runtime::custom_data_ptr = nullptr

Pointer for storing which data the panel corresponds to. Useful when there can be multiple instances of the same panel type.

Note

A panel and its sub-panels share the same custom data pointer. This avoids freeing the same pointer twice when panels are removed.

Definition at line 441 of file BKE_screen.hh.

Referenced by panel_add_instanced(), UI_panel_custom_data_get(), UI_panel_custom_data_set(), ui_panel_custom_data_set_recursive(), and ui_paneltype_draw_impl().

layout_panels

LayoutPanels Panel_Runtime::layout_panels

Information about nested layout panels generated in layout code.

Definition at line 453 of file BKE_screen.hh.

Referenced by ed_panel_draw(), ui_draw_layout_panels_backdrop(), ui_layout_panel_header_under_mouse(), ui_layout_panel_popup_scroll_apply(), ui_panel_drag_collapse(), and UI_popup_dummy_panel_set().

region_ofsx

int Panel_Runtime::region_ofsx = 0

Applied to Panel.ofsx, but saved separately so we can track changes between redraws.

Definition at line 432 of file BKE_screen.hh.

Referenced by panel_calculate_size_recursive(), and uiAlignPanelStep().

---

The documentation for this struct was generated from the following file:

• BKE_screen.hh