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

#include <interface_intern.h>

Public Attributes

uiBlocknext
 
uiBlockprev
 
ListBase buttons
 
struct Panelpanel
 
uiBlockoldblock
 
ListBase butstore
 
ListBase button_groups
 
ListBase layouts
 
struct uiLayoutcurlayout
 
ListBase contexts
 
ListBase views
 
char name [UI_MAX_NAME_STR]
 
float winmat [4][4]
 
rctf rect
 
float aspect
 
uint puphash
 
uiButHandleFunc func
 
voidfunc_arg1
 
voidfunc_arg2
 
uiButHandleNFunc funcN
 
voidfunc_argN
 
uiMenuHandleFunc butm_func
 
voidbutm_func_arg
 
uiBlockHandleFunc handle_func
 
voidhandle_func_arg
 
uiBlockInteraction_CallbackData custom_interaction_callbacks
 
int(* block_event_func )(const struct bContext *C, struct uiBlock *, const struct wmEvent *)
 
void(* drawextra )(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect)
 
voiddrawextra_arg1
 
voiddrawextra_arg2
 
int flag
 
short alignnr
 
short content_hints
 
char direction
 
char theme_style
 
eUIEmbossType emboss
 
bool auto_open
 
char _pad [5]
 
double auto_open_last
 
const char * lockstr
 
bool lock
 
bool active
 
bool tooltipdisabled
 
bool endblock
 
eBlockBoundsCalc bounds_type
 
int bounds_offset [2]
 
int bounds
 
int minbounds
 
rctf safety
 
ListBase saferct
 
uiPopupBlockHandlehandle
 
struct wmOperatorui_operator
 
voidevil_C
 
struct UnitSettingsunit
 
ColorPickerData color_pickers
 
bool is_color_gamma_picker
 
char display_device [64]
 
struct PieMenuData pie_data
 

Detailed Description

Definition at line 473 of file interface_intern.h.

Member Data Documentation

◆ _pad

char uiBlock::_pad[5]

Definition at line 542 of file interface_intern.h.

◆ active

bool uiBlock::active

To keep blocks while drawing and free them afterwards.

Definition at line 549 of file interface_intern.h.

Referenced by panel_remove_invisible_layouts_recursive(), UI_block_begin(), UI_block_end_ex(), UI_block_layout_resolve(), and UI_block_region_set().

◆ alignnr

short uiBlock::alignnr

Definition at line 530 of file interface_intern.h.

Referenced by UI_block_align_begin(), ui_def_but(), and ui_item_layout().

◆ aspect

float uiBlock::aspect

◆ auto_open

bool uiBlock::auto_open

◆ auto_open_last

double uiBlock::auto_open_last

◆ block_event_func

int(* uiBlock::block_event_func) (const struct bContext *C, struct uiBlock *, const struct wmEvent *)

Custom extra event handling.

Definition at line 522 of file interface_intern.h.

Referenced by ui_block_func_COLOR(), and ui_handle_menu_event().

◆ bounds

int uiBlock::bounds

◆ bounds_offset

int uiBlock::bounds_offset[2]

◆ bounds_type

eBlockBoundsCalc uiBlock::bounds_type

◆ butm_func

uiMenuHandleFunc uiBlock::butm_func

◆ butm_func_arg

void* uiBlock::butm_func_arg

Definition at line 513 of file interface_intern.h.

Referenced by ui_apply_but_func(), and UI_block_func_butmenu_set().

◆ butstore

ListBase uiBlock::butstore

◆ button_groups

ListBase uiBlock::button_groups

◆ buttons

ListBase uiBlock::buttons

Definition at line 476 of file interface_intern.h.

Referenced by button_activate_exit(), colorband_buttons_layout(), blender::ui::find_item_from_rename_button(), menu_items_from_ui_create(), panel_remove_invisible_layouts_recursive(), template_operator_property_buts_draw_single(), template_texture_user_menu(), ui_apply_but_ROW(), ui_block_active_but_get(), UI_block_active_only_flagged_buttons(), ui_block_align_calc(), ui_block_bounds_calc(), ui_block_bounds_calc_text(), UI_block_can_add_separator(), UI_block_draw(), UI_block_end_ex(), UI_block_free(), ui_block_func_POPOVER(), ui_block_func_POPUP(), ui_block_interaction_begin(), UI_block_is_empty_ex(), ui_block_message_subscribe(), UI_block_order_flip(), ui_block_pie_dir_activate(), UI_block_translate(), UI_block_update_from_old(), ui_block_view_find_matching_view_item_but_in_old_block(), UI_but_active_only_ex(), ui_but_anim_decorate_find_attached_button(), ui_but_change_type(), ui_but_drag_multi_edit_get(), ui_but_find_new(), ui_but_find_old(), ui_but_first(), ui_but_last(), ui_but_update_from_old_block(), ui_colorpicker_hide_reveal(), ui_colorpicker_small_wheel_cb(), UI_context_active_but_prop_get_filebrowser(), ui_def_but(), ui_handle_menu_event(), ui_item_enum_expand_tabs(), ui_layer_but_cb(), ui_menu_block_set_keyaccels(), ui_menu_block_set_keymaps(), ui_menu_scroll_apply_offset_y(), ui_multibut_restore(), ui_multibut_states_apply(), ui_multibut_states_create(), ui_multibut_states_tag(), blender::ed::space_node::ui_node_menu_column(), ui_offset_panel_block(), ui_pie_handler(), ui_popup_block_clip(), ui_popup_block_position(), ui_popup_block_refresh(), ui_popup_block_scrolltest(), ui_popup_context_menu_for_panel(), ui_popup_menu_memory__internal(), blender::ed::space_node::ui_template_node_link_menu(), ui_textedit_next_but(), ui_textedit_prev_but(), ui_update_color_picker_buts_rgb(), ui_update_flexible_spacing(), uiItemFullR(), uiItemFullR_with_menu(), uiItemFullR_with_popover(), uiItemsEnumR(), uiItemsFullEnumO_items(), and uiTemplateKeymapItemProperties().

◆ color_pickers

ColorPickerData uiBlock::color_pickers
Note
only accessed by color picker templates.

Definition at line 580 of file interface_intern.h.

Referenced by ui_block_colorpicker_create(), UI_block_free(), and UI_block_update_from_old().

◆ content_hints

short uiBlock::content_hints

Hints about the buttons of this block. Used to avoid iterating over buttons to find out if some criteria is met by any. Instead, check this criteria when adding the button and set a flag here if it's met.

Definition at line 534 of file interface_intern.h.

Referenced by ui_but_submenu_enable(), ui_popup_block_position(), and widget_draw_text_icon().

◆ contexts

ListBase uiBlock::contexts

◆ curlayout

struct uiLayout* uiBlock::curlayout

◆ custom_interaction_callbacks

uiBlockInteraction_CallbackData uiBlock::custom_interaction_callbacks

◆ direction

char uiBlock::direction

◆ display_device

char uiBlock::display_device[64]

Display device name used to display this block, used by color widgets to transform colors from/to scene linear.

Definition at line 589 of file interface_intern.h.

Referenced by UI_block_begin(), and ui_block_cm_display_get().

◆ drawextra

void(* uiBlock::drawextra) (const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect)

Custom extra draw function for custom blocks.

Definition at line 525 of file interface_intern.h.

Referenced by UI_but_func_drawextra_set(), and widget_draw_extra_mask().

◆ drawextra_arg1

void* uiBlock::drawextra_arg1

Definition at line 526 of file interface_intern.h.

Referenced by UI_but_func_drawextra_set(), and widget_draw_extra_mask().

◆ drawextra_arg2

void* uiBlock::drawextra_arg2

Definition at line 527 of file interface_intern.h.

Referenced by UI_but_func_drawextra_set(), and widget_draw_extra_mask().

◆ emboss

eUIEmbossType uiBlock::emboss

◆ endblock

bool uiBlock::endblock

True when UI_block_end has been called.

Definition at line 553 of file interface_intern.h.

Referenced by UI_block_active_only_flagged_buttons(), UI_block_draw(), UI_block_end_ex(), and ui_popup_block_refresh().

◆ evil_C

void* uiBlock::evil_C

◆ flag

int uiBlock::flag

Definition at line 529 of file interface_intern.h.

Referenced by button_activate_exit(), button_activate_state(), menu_item_enum_opname_menu(), menu_item_enum_rna_menu(), template_operator_property_buts_draw_single(), UI_block_align_begin(), UI_block_align_end(), UI_block_begin(), ui_block_bounds_calc_popup(), UI_block_draw(), UI_block_end_ex(), UI_block_flag_disable(), UI_block_flag_enable(), ui_block_func_COLOR(), ui_block_func_POPUP(), ui_block_is_menu(), ui_block_is_pie_menu(), ui_block_is_popover(), UI_block_is_search_only(), UI_block_order_flip(), ui_block_pie_dir_activate(), UI_block_set_search_only(), UI_but_func_search_set(), ui_but_update_ex(), ui_def_but(), ui_def_but_rna__menu(), ui_draw_but(), ui_draw_clip_tri(), ui_draw_menu_back(), ui_handle_button_event(), ui_handle_menu_event(), ui_handle_menu_return_submenu(), ui_handle_menus_recursive(), ui_item_menu_hold(), ui_item_menutype_func(), ui_item_paneltype_func(), ui_menu_block_set_keymaps(), ui_menu_scroll_step(), ui_menu_scroll_test(), ui_menu_scroll_to_but(), ui_mouse_motion_towards_check(), UI_pie_menu_begin(), ui_popover_create_block(), UI_popover_end(), ui_popup_block_clip(), ui_popup_block_refresh(), ui_popup_block_scrolltest(), ui_popup_handler(), UI_popup_menu_begin_ex(), ui_popup_menu_create(), ui_region_winrct_get_no_margin(), ui_searchbox_create_generic_ex(), ui_tooltip_data_from_tool(), uiItemFullR(), uiItemL_(), uiItemMenuEnumFullO_ptr(), uiItemsEnumR(), uiItemsFullEnumO_items(), and widget_draw_text_icon().

◆ func

uiButHandleFunc uiBlock::func

◆ func_arg1

void* uiBlock::func_arg1

Definition at line 506 of file interface_intern.h.

Referenced by UI_block_func_set(), and ui_def_but().

◆ func_arg2

void* uiBlock::func_arg2

Definition at line 507 of file interface_intern.h.

Referenced by UI_block_func_set(), UI_block_funcN_set(), and ui_def_but().

◆ func_argN

void* uiBlock::func_argN

Definition at line 510 of file interface_intern.h.

Referenced by UI_block_free(), UI_block_funcN_set(), and ui_def_but().

◆ funcN

uiButHandleNFunc uiBlock::funcN

Definition at line 509 of file interface_intern.h.

Referenced by UI_block_funcN_set(), and ui_def_but().

◆ handle

uiPopupBlockHandle* uiBlock::handle

◆ handle_func

uiBlockHandleFunc uiBlock::handle_func

◆ handle_func_arg

void* uiBlock::handle_func_arg

◆ is_color_gamma_picker

bool uiBlock::is_color_gamma_picker

Block for color picker with gamma baked in.

Definition at line 583 of file interface_intern.h.

Referenced by ui_block_func_COLOR(), and ui_but_is_color_gamma().

◆ layouts

ListBase uiBlock::layouts

◆ lock

bool uiBlock::lock

Definition at line 547 of file interface_intern.h.

Referenced by UI_block_lock_clear(), UI_block_lock_set(), and ui_def_but().

◆ lockstr

const char* uiBlock::lockstr

Definition at line 545 of file interface_intern.h.

Referenced by UI_block_lock_clear(), UI_block_lock_set(), and ui_def_but().

◆ minbounds

int uiBlock::minbounds

◆ name

char uiBlock::name[UI_MAX_NAME_STR]

◆ next

uiBlock* uiBlock::next

Definition at line 474 of file interface_intern.h.

◆ oldblock

uiBlock* uiBlock::oldblock

◆ panel

struct Panel* uiBlock::panel

◆ pie_data

struct PieMenuData uiBlock::pie_data

◆ prev

uiBlock * uiBlock::prev

Definition at line 474 of file interface_intern.h.

◆ puphash

uint uiBlock::puphash

Unique hash used to implement popup menu memory.

Definition at line 503 of file interface_intern.h.

Referenced by UI_pie_menu_begin(), UI_popup_menu_begin_ex(), and ui_popup_menu_memory__internal().

◆ rect

rctf uiBlock::rect

◆ saferct

ListBase uiBlock::saferct

◆ safety

rctf uiBlock::safety

Pull-downs, to detect outside, can differ per case how it is created.

Definition at line 563 of file interface_intern.h.

Referenced by ui_block_bounds_calc(), ui_popup_block_position(), and ui_popup_block_refresh().

◆ theme_style

char uiBlock::theme_style

UI_BLOCK_THEME_STYLE_*

Definition at line 538 of file interface_intern.h.

Referenced by UI_block_theme_style_set(), and ui_draw_but().

◆ tooltipdisabled

bool uiBlock::tooltipdisabled

To avoid tool-tip after click.

Definition at line 551 of file interface_intern.h.

Referenced by button_tooltip_timer_reset(), and UI_block_update_from_old().

◆ ui_operator

struct wmOperator* uiBlock::ui_operator

use so presets can find the operator, across menus and from nested popups which fail for operator context.

Definition at line 571 of file interface_intern.h.

Referenced by template_operator_property_buts_draw_single().

◆ unit

struct UnitSettings* uiBlock::unit

unit system, used a lot for numeric buttons so include here rather than fetching through the scene every time.

Definition at line 578 of file interface_intern.h.

Referenced by UI_block_begin(), UI_block_free(), ui_but_convert_to_unit_alt_name(), ui_but_is_unit(), ui_but_is_unit_radians(), ui_get_but_scale_unit(), ui_get_but_step_unit(), ui_get_but_string_unit(), ui_number_from_string_units_with_but(), and ui_numedit_apply_snapf().

◆ views

ListBase uiBlock::views

A block can store "views" on data-sets. Currently tree-views (#AbstractTreeView) only. Others are imaginable, e.g. table-views, grid-views, etc. These are stored here to support state that is persistent over redraws (e.g. collapsed tree-view items).

Definition at line 493 of file interface_intern.h.

Referenced by ui_block_add_view_impl(), ui_block_free_views(), ui_block_view_find_idname(), ui_block_view_find_matching_in_old_block_impl(), and UI_block_views_listen().

◆ winmat

float uiBlock::winmat[4][4]

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