Blender  V3.3
Public Attributes | List of all members
PanelType Struct Reference

#include <BKE_screen.h>

Public Attributes

struct PanelTypenext
 
struct PanelTypeprev
 
char idname [BKE_ST_MAXNAME]
 
char label [BKE_ST_MAXNAME]
 
char * description
 
char translation_context [BKE_ST_MAXNAME]
 
char context [BKE_ST_MAXNAME]
 
char category [BKE_ST_MAXNAME]
 
char owner_id [BKE_ST_MAXNAME]
 
char parent_id [BKE_ST_MAXNAME]
 
char active_property [BKE_ST_MAXNAME]
 
short space_type
 
short region_type
 
int ui_units_x
 
int order
 
int flag
 
bool(* poll )(const struct bContext *C, struct PanelType *pt)
 
void(* draw_header )(const struct bContext *C, struct Panel *panel)
 
void(* draw_header_preset )(const struct bContext *C, struct Panel *panel)
 
void(* draw )(const struct bContext *C, struct Panel *panel)
 
void(* reorder )(struct bContext *C, struct Panel *pa, int new_index)
 
short(* get_list_data_expand_flag )(const struct bContext *C, struct Panel *pa)
 
void(* set_list_data_expand_flag )(const struct bContext *C, struct Panel *pa, short expand_flag)
 
struct PanelTypeparent
 
ListBase children
 
ExtensionRNA rna_ext
 

Detailed Description

Definition at line 220 of file BKE_screen.h.

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 232 of file BKE_screen.h.

Referenced by modifier_panel_register(), modifier_subpanel_register(), panel_custom_data_active_get(), and panel_custom_data_active_set().

◆ category

char PanelType::category[BKE_ST_MAXNAME]

◆ children

ListBase PanelType::children

◆ context

char PanelType::context[BKE_ST_MAXNAME]

◆ description

char* PanelType::description

Definition at line 225 of file BKE_screen.h.

Referenced by uiItemPopoverPanel_ptr().

◆ draw

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

◆ draw_header

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

◆ draw_header_preset

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

Definition at line 246 of file BKE_screen.h.

Referenced by ed_panel_draw(), and panel_property_search().

◆ flag

int PanelType::flag

◆ get_list_data_expand_flag

short(* PanelType::get_list_data_expand_flag) (const struct bContext *C, struct 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 260 of file BKE_screen.h.

Referenced by fmodifier_panel_register(), gpencil_modifier_panel_register(), modifier_panel_register(), panel_set_expansion_from_list_data(), register_row_filter_panels(), shaderfx_panel_register(), and uiTemplateConstraints().

◆ idname

char PanelType::idname[BKE_ST_MAXNAME]

◆ label

char PanelType::label[BKE_ST_MAXNAME]

◆ next

struct PanelType* PanelType::next

Definition at line 221 of file BKE_screen.h.

◆ order

int PanelType::order

Definition at line 237 of file BKE_screen.h.

Referenced by image_buttons_register(), and sequencer_buttons_register().

◆ owner_id

char PanelType::owner_id[BKE_ST_MAXNAME]

Definition at line 229 of file BKE_screen.h.

Referenced by panel_add_check().

◆ parent

struct PanelType* PanelType::parent

◆ parent_id

char PanelType::parent_id[BKE_ST_MAXNAME]

◆ poll

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

◆ prev

struct PanelType * PanelType::prev

Definition at line 221 of file BKE_screen.h.

◆ region_type

short PanelType::region_type

Definition at line 234 of file BKE_screen.h.

Referenced by hud_panels_register(), and ui_but_event_operator_string_from_panel().

◆ reorder

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

◆ rna_ext

ExtensionRNA PanelType::rna_ext

Definition at line 274 of file BKE_screen.h.

Referenced by UI_but_string_info_get().

◆ set_list_data_expand_flag

void(* PanelType::set_list_data_expand_flag) (const struct bContext *C, struct 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 267 of file BKE_screen.h.

Referenced by fmodifier_panel_register(), gpencil_modifier_panel_register(), modifier_panel_register(), register_row_filter_panels(), shaderfx_panel_register(), and uiTemplateConstraints().

◆ space_type

short PanelType::space_type

Definition at line 233 of file BKE_screen.h.

Referenced by hud_panels_register(), and ui_but_event_operator_string_from_panel().

◆ translation_context

char PanelType::translation_context[BKE_ST_MAXNAME]

◆ ui_units_x

int PanelType::ui_units_x

Definition at line 236 of file BKE_screen.h.

Referenced by ui_popover_panel_create(), and UI_popover_panel_invoke().


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