Blender V5.3
blender::PanelType Struct Reference

#include <BKE_screen.hh>

Public Attributes

PanelType * next
PanelType * prev
char idname [BKE_ST_MAXNAME]
char label [BKE_ST_MAXNAME]
const char * description
int icon
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
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
ListBaseT< LinkData > children
ExtensionRNA rna_ext

Detailed Description

Definition at line 461 of file BKE_screen.hh.

Member Data Documentation

◆ active_property

char blender::PanelType::active_property[BKE_ST_MAXNAME]

◆ category

◆ children

◆ context

◆ description

const char* blender::PanelType::description

◆ draw

◆ draw_header

◆ draw_header_preset

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

Draw header preset (optional)

Definition at line 501 of file BKE_screen.hh.

Referenced by blender::ed_panel_draw(), and blender::panel_property_search().

◆ flag

int blender::PanelType::flag

Definition at line 494 of file BKE_screen.hh.

Referenced by blender::ANIM_fmodifier_panels(), blender::ui::block_apply_search_filter(), blender::buttons_context_register(), blender::buttons_navigation_bar_region_draw(), blender::ui::draw_aligned_panel(), blender::ED_clip_buttons_register(), blender::ed_panel_draw(), blender::ED_region_panels_layout_ex(), blender::ED_region_property_search(), blender::file_execute_region_panels_register(), blender::file_tool_props_region_panels_register(), blender::file_tools_region_panels_register(), blender::ui::find_highest_panel(), blender::fmodifier_panel_register(), blender::fmodifier_subpanel_register(), blender::ui::get_panel_real_size_y(), blender::ui::get_panel_size_y(), blender::graph_buttons_register(), blender::ui::handle_panel_header(), blender::ui::handler_panel_region(), blender::ui::hud_panels_register(), blender::image_buttons_register(), blender::modifier_panel_register(), blender::seq::modifier_panel_register(), blender::modifier_subpanel_register(), blender::nla_buttons_register(), blender::ui::panel_begin(), blender::ui::panel_can_be_pinned(), blender::ui::panel_drag_collapse(), blender::ui::panel_draw_aligned_backdrop(), blender::ui::panel_is_closed(), blender::ui::panel_list_matches_data(), blender::panel_property_search(), blender::ui::panel_set_expansion_from_list_data(), blender::ui::panel_set_expansion_from_search_filter_recursive(), blender::ui::panel_should_show_background(), blender::ui::panels_collapse_all(), blender::ui::paneltype_draw_impl(), blender::ui::popup_dummy_panel_set(), blender::ui::region_panels_set_expansion_from_list_data(), blender::ed::spreadsheet::register_row_filter_panels(), blender::ui::register_scene_compositor_effects_panel(), blender::ui::reorder_instanced_panel_list(), blender::ui::set_panels_list_data_expand_flag(), blender::shaderfx_panel_register(), blender::shaderfx_subpanel_register(), blender::ed::spreadsheet::spreadsheet_data_set_region_panels_register(), blender::ed::spreadsheet::spreadsheet_row_filters_layout(), blender::ui::template_constraints(), blender::ui::template_modifiers(), blender::ui::template_scene_compositor_effects(), blender::ui::template_shader_fx(), and blender::ui::template_strip_modifiers().

◆ get_list_data_expand_flag

short(*) blender::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 520 of file BKE_screen.hh.

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

◆ icon

int blender::PanelType::icon

Definition at line 470 of file BKE_screen.hh.

Referenced by blender::region_panels_collect_categories().

◆ idname

char blender::PanelType::idname[BKE_ST_MAXNAME]

Unique name.

Definition at line 465 of file BKE_screen.hh.

Referenced by blender::action_buttons_register(), blender::BKE_modifier_type_panel_id(), blender::BKE_panel_new(), blender::ui::but_copy_popover(), blender::ui::but_event_operator_string_from_panel(), blender::buttons_context_register(), blender::ed::asset::shelf::catalog_selector_panel_register(), blender::ED_clip_buttons_register(), blender::ed_panel_draw(), blender::ED_uvedit_buttons_register(), blender::file_execute_region_panels_register(), blender::file_tool_props_region_panels_register(), blender::file_tools_region_panels_register(), blender::fmodifier_panel_register(), blender::fmodifier_subpanel_register(), blender::get_panel_type_map(), blender::graph_buttons_register(), blender::ui::hud_panels_register(), blender::image_buttons_register(), blender::modifier_panel_register(), blender::seq::modifier_panel_register(), blender::modifier_subpanel_register(), blender::seq::modifier_type_panel_id(), blender::nla_buttons_register(), blender::ed::space_node::node_tree_interface_panel_register(), blender::ui::panel_find_by_type(), blender::ui::panel_list_matches_data(), blender::panel_property_search(), blender::ui::paneltype_draw_impl(), blender::ed::asset::shelf::popover_panel_register(), blender::ed::spreadsheet::register_row_filter_panels(), blender::ui::register_scene_compositor_effects_panel(), blender::ed::vse::sequencer_buttons_register(), blender::shaderfx_panel_register(), blender::shaderfx_subpanel_register(), blender::ed::spreadsheet::spreadsheet_data_set_region_panels_register(), blender::userpref_panels_register(), and blender::view3d_buttons_register().

◆ label

◆ listener

void(*) blender::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 508 of file BKE_screen.hh.

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

◆ next

PanelType* blender::PanelType::next

Definition at line 462 of file BKE_screen.hh.

◆ offset_units_xy

float2 blender::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 491 of file BKE_screen.hh.

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

◆ order

◆ owner_id

char blender::PanelType::owner_id[128]

For work-spaces to selectively show.

Definition at line 477 of file BKE_screen.hh.

Referenced by blender::panel_add_check().

◆ parent

◆ parent_id

◆ pin_to_last_property

char blender::PanelType::pin_to_last_property[BKE_ST_MAXNAME]

◆ poll

◆ prev

PanelType * blender::PanelType::prev

Definition at line 462 of file BKE_screen.hh.

◆ region_type

short blender::PanelType::region_type

◆ reorder

◆ rna_ext

ExtensionRNA blender::PanelType::rna_ext

RNA integration.

Definition at line 533 of file BKE_screen.hh.

Referenced by blender::ui::popover_panel_create(), and blender::SpaceType::~SpaceType().

◆ set_list_data_expand_flag

void(*) blender::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 527 of file BKE_screen.hh.

Referenced by blender::fmodifier_panel_register(), blender::modifier_panel_register(), blender::seq::modifier_panel_register(), blender::ed::spreadsheet::register_row_filter_panels(), blender::ui::register_scene_compositor_effects_panel(), blender::ui::set_panels_list_data_expand_flag(), blender::shaderfx_panel_register(), and blender::ui::template_constraints().

◆ space_type

short blender::PanelType::space_type

◆ translation_context

◆ ui_units_x

int blender::PanelType::ui_units_x

For popovers, 0 for default.

Definition at line 486 of file BKE_screen.hh.

Referenced by blender::ui::popover_panel_create(), and blender::ui::popover_panel_invoke().


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