Blender: uiLayout Struct Reference

Blender V4.3

Inherits uiItem.

Inherited by uiLayoutItemBx, uiLayoutItemFlow, uiLayoutItemGridFlow, uiLayoutItemPanelBody, uiLayoutItemPanelHeader, uiLayoutItemRoot, and uiLayoutItemSplit.

Public Attributes
uiLayoutRoot *	root
bContextStore *	context
uiLayout *	parent
blender::Vector< uiItem * >	items
char	heading [UI_MAX_NAME_STR]
uiLayout *	child_items_layout
int	x
int	y
int	w
int	h
float	scale [2]
short	space
bool	align
bool	active
bool	active_default
bool	activate_init
bool	enabled
bool	redalert
bool	keepaspect
bool	variable_size
char	alignment
eUIEmbossType	emboss
float	units [2]
float	search_weight
Public Attributes inherited from uiItem
uiItemType	type
uiItemInternalFlag	flag

Additional Inherited Members
Public Member Functions inherited from uiItem
	uiItem ()=default
	uiItem (const uiItem &)=default
virtual	~uiItem ()=default

Detailed Description

Definition at line 147 of file interface_layout.cc.

Member Data Documentation

◆ activate_init

bool uiLayout::activate_init

Definition at line 164 of file interface_layout.cc.

Referenced by uiItemFullR(), uiLayoutGetActivateInit(), and uiLayoutSetActivateInit().

◆ active

bool uiLayout::active

Definition at line 162 of file interface_layout.cc.

Referenced by UI_block_layout(), ui_item_layout(), ui_litem_init_from_parent(), uiLayoutGetActive(), and uiLayoutSetActive().

◆ active_default

bool uiLayout::active_default

Definition at line 163 of file interface_layout.cc.

Referenced by uiItemFullO_ptr_ex(), uiLayoutGetActiveDefault(), and uiLayoutSetActiveDefault().

◆ align

bool uiLayout::align

Definition at line 161 of file interface_layout.cc.

Referenced by ui_item_align(), ui_item_layout(), ui_item_with_label(), ui_litem_init_from_parent(), uiItemsFullEnumO_items(), uiLayoutColumnFlow(), and uiLayoutGridFlow().

◆ alignment

char uiLayout::alignment

Definition at line 170 of file interface_layout.cc.

Referenced by ui_layout_heading_label_add(), ui_layout_vary_direction(), ui_litem_layout_column_flow(), ui_litem_layout_grid_flow(), ui_litem_layout_row(), ui_text_icon_width_ex(), uiItemPropertySplitWrapperCreate(), uiLayoutGetAlignment(), and uiLayoutSetAlignment().

◆ child_items_layout

uiLayout* uiLayout::child_items_layout

Sub layout to add child items, if not the layout itself.

Definition at line 156 of file interface_layout.cc.

Referenced by ui_item_prop_split_layout_hack(), ui_layout_add_but(), ui_layout_find_button_item(), ui_layout_remove_but(), and ui_litem_init_from_parent().

◆ context

bContextStore* uiLayout::context

Definition at line 149 of file interface_layout.cc.

Referenced by UI_block_layout(), ui_layout_add_but(), ui_litem_init_from_parent(), UI_menutype_draw(), UI_paneltype_draw(), uiItemMContents(), uiItemPopoverPanel_ptr(), uiItemsFullEnumO(), uiLayoutContextCopy(), uiLayoutGetContextStore(), uiLayoutSetContextPointer(), and uiLayoutSetContextString().

◆ emboss

eUIEmbossType uiLayout::emboss

Definition at line 171 of file interface_layout.cc.

Referenced by UI_block_layout(), ui_layout_add_but(), ui_litem_init_from_parent(), uiItemFullO_ptr_ex(), uiItemFullR(), uiLayoutGetEmboss(), and uiLayoutSetEmboss().

◆ enabled

bool uiLayout::enabled

Definition at line 165 of file interface_layout.cc.

Referenced by UI_block_layout(), ui_item_layout(), ui_litem_init_from_parent(), uiLayoutGetEnabled(), and uiLayoutSetEnabled().

◆ h

◆ heading

char uiLayout::heading[UI_MAX_NAME_STR]

Definition at line 153 of file interface_layout.cc.

Referenced by ui_layout_heading_label_add(), and ui_layout_heading_set().

◆ items

blender::Vector<uiItem *> uiLayout::items

Definition at line 151 of file interface_layout.cc.

Referenced by spaces_after_column_item(), ui_item_align(), ui_item_estimate(), ui_item_flag(), ui_item_layout(), ui_item_scale(), ui_layout_add_but(), ui_layout_find_button_item(), ui_layout_free(), ui_layout_has_panel_label(), ui_layout_list_set_labels_active(), ui_layout_remove_but(), ui_litem_estimate_absolute(), ui_litem_estimate_column(), ui_litem_estimate_column_flow(), ui_litem_estimate_grid_flow(), ui_litem_estimate_overlap(), ui_litem_estimate_panel_header(), ui_litem_estimate_row(), ui_litem_init_from_parent(), ui_litem_layout_absolute(), ui_litem_layout_column(), ui_litem_layout_column_flow(), ui_litem_layout_grid_flow(), ui_litem_layout_overlap(), ui_litem_layout_panel_header(), ui_litem_layout_radial(), ui_litem_layout_root_radial(), ui_litem_layout_row(), ui_litem_layout_split(), ui_paneltype_draw_impl(), uiLayoutEndsWithPanelHeader(), uiLayoutRadial(), and uiLayoutSetTooltipFunc().

◆ keepaspect

bool uiLayout::keepaspect

Definition at line 167 of file interface_layout.cc.

Referenced by uiLayoutGetKeepAspect(), and uiLayoutSetKeepAspect().

◆ parent

uiLayout* uiLayout::parent

Definition at line 150 of file interface_layout.cc.

Referenced by ui_layout_heading_find(), and ui_litem_init_from_parent().

◆ redalert

bool uiLayout::redalert

Definition at line 166 of file interface_layout.cc.

Referenced by ui_litem_init_from_parent(), uiItemFullO_ptr_ex(), uiItemFullR(), uiItemL_(), uiLayoutGetRedAlert(), and uiLayoutSetRedAlert().

◆ root

uiLayoutRoot* uiLayout::root

Definition at line 148 of file interface_layout.cc.

Referenced by menu_item_enum_opname_menu(), UI_block_layout(), ui_item_array(), ui_item_disabled(), ui_item_enum_expand_exec(), ui_item_layout(), ui_item_menu(), ui_item_menu_hold(), ui_item_rna_size(), ui_layout_box(), ui_layout_end(), ui_layout_is_radial(), ui_layout_vary_direction(), ui_litem_estimate_box(), ui_litem_estimate_column_flow(), ui_litem_estimate_grid_flow(), ui_litem_init_from_parent(), ui_litem_layout_box(), ui_litem_layout_column_flow(), ui_litem_layout_grid_flow(), ui_litem_layout_panel_body(), ui_litem_layout_panel_header(), ui_litem_layout_radial(), ui_litem_layout_root(), ui_menu_enumpropname(), ui_text_icon_width_ex(), uiItemBooleanO(), uiItemDecoratorR_prop(), uiItemEnumO_ptr(), uiItemEnumO_string(), uiItemEnumO_value(), uiItemEnumR_string_prop(), uiItemFloatO(), uiItemFullO_ptr_ex(), uiItemFullR(), uiItemFullR_with_menu(), uiItemFullR_with_popover(), uiItemIntO(), uiItemL_(), uiItemM_ptr(), uiItemMContents(), uiItemMenuEnumFullO_ptr(), uiItemMenuEnumR_prop(), uiItemO(), uiItemPopoverPanel_ptr(), uiItemProgressIndicator(), uiItemS_ex(), uiItemsEnumO(), uiItemsEnumR(), uiItemsFullEnumO(), uiItemsFullEnumO_items(), uiItemSpacer(), uiItemStringO(), uiItemTabsEnumR_prop(), uiLayoutAbsolute(), uiLayoutColumn(), uiLayoutColumnFlow(), uiLayoutContextCopy(), uiLayoutGetBlock(), uiLayoutGetEmboss(), uiLayoutGetOperatorContext(), uiLayoutGetRootPanel(), uiLayoutGridFlow(), uiLayoutOverlap(), uiLayoutPanelProp(), uiLayoutRadial(), uiLayoutRow(), uiLayoutSetContextPointer(), uiLayoutSetContextString(), uiLayoutSetFunc(), uiLayoutSetOperatorContext(), and uiLayoutSplit().

◆ scale

float uiLayout::scale[2]

Definition at line 159 of file interface_layout.cc.

Referenced by ui_item_estimate(), ui_text_icon_width_ex(), uiLayoutGetScaleX(), uiLayoutGetScaleY(), uiLayoutSetScaleX(), and uiLayoutSetScaleY().

◆ search_weight

float uiLayout::search_weight

Is copied to uiButs created in this layout.

Definition at line 175 of file interface_layout.cc.

Referenced by ui_layout_add_but(), uiLayoutGetSearchWeight(), and uiLayoutSetSearchWeight().

◆ space

short uiLayout::space

Definition at line 160 of file interface_layout.cc.

Referenced by UI_block_layout(), ui_item_local_sublayout(), ui_item_with_label(), ui_layout_box(), ui_litem_estimate_column(), ui_litem_estimate_column_flow(), ui_litem_estimate_row(), ui_litem_layout_column(), ui_litem_layout_panel_body(), ui_litem_layout_row(), ui_litem_layout_split(), uiItemFullR(), uiLayoutColumn(), uiLayoutColumnFlow(), uiLayoutGridFlow(), uiLayoutPanelProp(), and uiLayoutRow().

◆ units

float uiLayout::units[2]

for fixed width or height to avoid UI size changes

Definition at line 173 of file interface_layout.cc.

Referenced by ui_item_estimate(), uiLayoutGetUnitsX(), uiLayoutGetUnitsY(), uiLayoutSetUnitsX(), and uiLayoutSetUnitsY().

◆ variable_size

bool uiLayout::variable_size

For layouts inside grid-flow, they and their items shall never have a fixed maximal size.

Definition at line 169 of file interface_layout.cc.

Referenced by ui_layout_variable_size(), and ui_litem_init_from_parent().

◆ w

◆ x

int uiLayout::x

Definition at line 158 of file interface_layout.cc.

Referenced by UI_block_layout(), ui_item_move(), ui_item_position(), ui_layout_end(), ui_litem_estimate_grid_flow(), ui_litem_layout_absolute(), ui_litem_layout_box(), ui_litem_layout_column(), ui_litem_layout_column_flow(), ui_litem_layout_grid_flow(), ui_litem_layout_overlap(), ui_litem_layout_panel_header(), ui_litem_layout_radial(), ui_litem_layout_root_radial(), ui_litem_layout_row(), and ui_litem_layout_split().

◆ y

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

interface_layout.cc