#include <BKE_screen.hh>

Public Attributes
PanelType *	next
PanelType *	prev
char	idname [BKE_ST_MAXNAME]
char	label [BKE_ST_MAXNAME]
const char *	description
char	translation_context [BKE_ST_MAXNAME]
char	context [BKE_ST_MAXNAME]
char	category [BKE_ST_MAXNAME]
char	owner_id [128]
char	parent_id [BKE_ST_MAXNAME]
char	active_property [BKE_ST_MAXNAME]
char	pin_to_last_property [BKE_ST_MAXNAME]
short	space_type
short	region_type
int	ui_units_x
blender::float2	offset_units_xy
int	order
int	flag
bool(*	poll )(const bContext C, PanelType pt)
void(*	draw_header )(const bContext C, Panel panel)
void(*	draw_header_preset )(const bContext C, Panel panel)
void(*	draw )(const bContext C, Panel panel)
void(*	listener )(const wmRegionListenerParams *params)
void(*	reorder )(bContext C, Panel pa, int new_index)
short(*	get_list_data_expand_flag )(const bContext C, Panel pa)
void(*	set_list_data_expand_flag )(const bContext C, Panel pa, short expand_flag)
PanelType *	parent
ListBase	children
ExtensionRNA	rna_ext

Detailed Description

Definition at line 311 of file BKE_screen.hh.

Member Data Documentation

◆ active_property

char PanelType::active_property[BKE_ST_MAXNAME]

Boolean property identifier of the panel custom data. Used to draw a highlighted border.

Definition at line 330 of file BKE_screen.hh.

Referenced by blender::seq::modifier_panel_register(), modifier_panel_register(), modifier_subpanel_register(), panel_custom_data_active_get(), and panel_custom_data_active_set().

◆ category

◆ children

ListBase PanelType::children

Definition at line 380 of file BKE_screen.hh.

Referenced by ed_panel_draw(), fmodifier_subpanel_register(), modifier_subpanel_register(), nla_buttons_register(), panel_add_instanced(), panel_property_search(), shaderfx_subpanel_register(), and ui_paneltype_draw_impl().

◆ context

char PanelType::context[BKE_ST_MAXNAME]

For buttons window.

Definition at line 322 of file BKE_screen.hh.

Referenced by blender::seq::modifier_panel_register(), modifier_panel_register(), modifier_subpanel_register(), panel_add_check(), panel_type_context_poll(), panels_collapse_all(), uiLayout::popover_group(), reorder_instanced_panel_list(), shaderfx_panel_register(), and shaderfx_subpanel_register().

◆ description

const char* PanelType::description

For panel tooltip.

Definition at line 319 of file BKE_screen.hh.

Referenced by blender::ed::asset::shelf::catalog_selector_panel_register(), uiLayout::popover(), and blender::ed::asset::shelf::popover_panel_register().

◆ draw

void(* PanelType::draw) (const bContext *C, Panel *panel)

Draw entirely, view changes should be handled here.

Definition at line 352 of file BKE_screen.hh.

Referenced by action_buttons_register(), buttons_context_register(), blender::ed::asset::shelf::catalog_selector_panel_register(), ED_clip_buttons_register(), ed_panel_draw(), ED_uvedit_buttons_register(), 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(), panel_add_check(), panel_property_search(), 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_paneltype_draw_impl(), and view3d_buttons_register().

◆ draw_header

void(* PanelType::draw_header) (const bContext *C, Panel *panel)

Draw header (optional)

Definition at line 348 of file BKE_screen.hh.

Referenced by ed_panel_draw(), file_tool_props_region_panels_register(), fmodifier_panel_register(), fmodifier_subpanel_register(), graph_buttons_register(), hud_panels_register(), blender::seq::modifier_panel_register(), modifier_panel_register(), modifier_subpanel_register(), nla_buttons_register(), panel_property_search(), uiLayout::popover(), blender::ed::spreadsheet::register_row_filter_panels(), blender::ed::vse::sequencer_buttons_register(), shaderfx_panel_register(), shaderfx_subpanel_register(), and ui_paneltype_draw_impl().

◆ draw_header_preset

void(* PanelType::draw_header_preset) (const bContext *C, Panel *panel)

Draw header preset (optional)

Definition at line 350 of file BKE_screen.hh.

Referenced by ed_panel_draw(), and panel_property_search().

◆ flag

int PanelType::flag

Definition at line 343 of file BKE_screen.hh.

Referenced by ANIM_fmodifier_panels(), buttons_context_register(), ED_clip_buttons_register(), ed_panel_draw(), ED_region_panels_layout_ex(), ED_region_property_search(), file_execute_region_panels_register(), file_tool_props_region_panels_register(), file_tools_region_panels_register(), find_highest_panel(), fmodifier_panel_register(), fmodifier_subpanel_register(), get_panel_real_size_y(), get_panel_size_y(), graph_buttons_register(), hud_panels_register(), image_buttons_register(), blender::seq::modifier_panel_register(), modifier_panel_register(), modifier_subpanel_register(), nla_buttons_register(), panel_draw_aligned_backdrop(), panel_property_search(), panel_set_expansion_from_list_data(), panel_set_expansion_from_search_filter_recursive(), panels_collapse_all(), region_panels_set_expansion_from_list_data(), blender::ed::spreadsheet::register_row_filter_panels(), set_panels_list_data_expand_flag(), shaderfx_panel_register(), shaderfx_subpanel_register(), blender::ed::spreadsheet::spreadsheet_data_set_region_panels_register(), blender::ed::spreadsheet::spreadsheet_row_filters_layout(), UI_block_apply_search_filter(), ui_draw_aligned_panel(), ui_handle_panel_header(), ui_handler_panel_region(), UI_panel_begin(), UI_panel_can_be_pinned(), ui_panel_drag_collapse(), UI_panel_is_closed(), UI_panel_should_show_background(), UI_popup_dummy_panel_set(), uiTemplateConstraints(), uiTemplateModifiers(), uiTemplateShaderFx(), and uiTemplateStripModifiers().

◆ get_list_data_expand_flag

short(* PanelType::get_list_data_expand_flag) (const bContext *C, Panel *pa)

Get the panel and sub-panel's expansion state from the expansion flag in the corresponding data item. Called on draw updates.

Note: Sub-panels are indexed in depth first order, the visual order you would see if all panels were expanded.

Definition at line 369 of file BKE_screen.hh.

Referenced by fmodifier_panel_register(), blender::seq::modifier_panel_register(), modifier_panel_register(), panel_set_expansion_from_list_data(), blender::ed::spreadsheet::register_row_filter_panels(), shaderfx_panel_register(), and uiTemplateConstraints().

◆ idname

char PanelType::idname[BKE_ST_MAXNAME]

Unique name.

Definition at line 315 of file BKE_screen.hh.

Referenced by action_buttons_register(), BKE_modifier_type_panel_id(), BKE_panel_new(), buttons_context_register(), blender::ed::asset::shelf::catalog_selector_panel_register(), ED_clip_buttons_register(), ed_panel_draw(), ED_uvedit_buttons_register(), file_execute_region_panels_register(), file_tool_props_region_panels_register(), file_tools_region_panels_register(), fmodifier_panel_register(), fmodifier_subpanel_register(), get_panel_type_map(), graph_buttons_register(), hud_panels_register(), image_buttons_register(), blender::seq::modifier_panel_register(), modifier_panel_register(), modifier_subpanel_register(), blender::seq::modifier_type_panel_id(), nla_buttons_register(), blender::ed::space_node::node_tree_interface_panel_register(), panel_property_search(), 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_but_copy_popover(), ui_but_event_operator_string_from_panel(), UI_panel_find_by_type(), and view3d_buttons_register().

◆ label

char PanelType::label[BKE_ST_MAXNAME]

For panel header.

Definition at line 317 of file BKE_screen.hh.

◆ listener

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

Listener to redraw the region this is contained in on changes. Only used for panels displayed in popover regions.

Definition at line 357 of file BKE_screen.hh.

Referenced by blender::ed::asset::shelf::catalog_selector_panel_register(), blender::ed::asset::shelf::popover_panel_register(), and ui_paneltype_draw_impl().

◆ next

PanelType* PanelType::next

Definition at line 312 of file BKE_screen.hh.

◆ offset_units_xy

blender::float2 PanelType::offset_units_xy

For popovers, position the popover at the given offset (multiplied by UI_UNIT_X/UI_UNIT_Y) relative to the top left corner, if it's not attached to a button.

Definition at line 340 of file BKE_screen.hh.

Referenced by blender::ed::asset::shelf::popover_panel_register(), and ui_block_func_POPOVER().

◆ order

int PanelType::order

Definition at line 341 of file BKE_screen.hh.

Referenced by image_buttons_register(), blender::ed::space_node::node_tree_interface_panel_register(), and blender::ed::vse::sequencer_buttons_register().

◆ owner_id

char PanelType::owner_id[128]

For work-spaces to selectively show.

Definition at line 326 of file BKE_screen.hh.

Referenced by panel_add_check().

◆ parent

PanelType* PanelType::parent

Sub panels.

Definition at line 379 of file BKE_screen.hh.

Referenced by fmodifier_subpanel_register(), modifier_subpanel_register(), nla_buttons_register(), panel_add_check(), panel_draw_aligned_backdrop(), panel_draw_aligned_widgets(), panel_draw_border(), shaderfx_subpanel_register(), ui_handle_panel_header(), UI_panel_can_be_pinned(), UI_panel_label_offset(), and ui_popup_context_menu_for_panel().

◆ parent_id

char PanelType::parent_id[BKE_ST_MAXNAME]

Parent idname for sub-panels.

Definition at line 328 of file BKE_screen.hh.

Referenced by fmodifier_subpanel_register(), modifier_subpanel_register(), nla_buttons_register(), uiLayout::popover_group(), and shaderfx_subpanel_register().

◆ pin_to_last_property

char PanelType::pin_to_last_property[BKE_ST_MAXNAME]

Definition at line 331 of file BKE_screen.hh.

Referenced by modifier_panel_register(), panel_custom_pin_to_last_get(), and panel_custom_pin_to_last_set().

◆ poll

bool(* PanelType::poll) (const bContext *C, PanelType *pt)

Verify if the panel should draw or not.

Definition at line 346 of file BKE_screen.hh.

Referenced by action_buttons_register(), buttons_context_register(), ED_clip_buttons_register(), ed_panel_draw(), ED_uvedit_buttons_register(), 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(), panel_add_check(), panel_property_search(), uiLayout::popover(), uiLayout::popover_group(), blender::ed::asset::shelf::popover_panel_register(), blender::ed::vse::sequencer_buttons_register(), shaderfx_panel_register(), shaderfx_subpanel_register(), ui_paneltype_draw_impl(), UI_popover_panel_invoke(), and view3d_buttons_register().

◆ prev

PanelType * PanelType::prev

Definition at line 312 of file BKE_screen.hh.

◆ region_type

short PanelType::region_type

Definition at line 333 of file BKE_screen.hh.

Referenced by hud_panels_register(), and ui_but_event_operator_string_from_panel().

◆ reorder

void(* PanelType::reorder) (bContext *C, Panel *pa, int new_index)

Reorder function, called when drag and drop finishes.

Definition at line 362 of file BKE_screen.hh.

Referenced by fmodifier_panel_register(), blender::seq::modifier_panel_register(), modifier_panel_register(), blender::ed::spreadsheet::register_row_filter_panels(), reorder_instanced_panel_list(), shaderfx_panel_register(), and uiTemplateConstraints().

◆ rna_ext

ExtensionRNA PanelType::rna_ext

RNA integration.

Definition at line 383 of file BKE_screen.hh.

◆ set_list_data_expand_flag

void(* PanelType::set_list_data_expand_flag) (const bContext *C, Panel *pa, short expand_flag)

Set the expansion bit-field from the closed / open state of this panel and its sub-panels. Called when the expansion state of the panel changes with user input.

Note: Sub-panels are indexed in depth first order, the visual order you would see if all panels were expanded.

Definition at line 376 of file BKE_screen.hh.

Referenced by fmodifier_panel_register(), blender::seq::modifier_panel_register(), modifier_panel_register(), blender::ed::spreadsheet::register_row_filter_panels(), shaderfx_panel_register(), and uiTemplateConstraints().

◆ space_type

short PanelType::space_type

Definition at line 332 of file BKE_screen.hh.