#include <UI_interface_layout.hh>

Inherits uiItem, blender::NonCopyable, and blender::NonMovable.

Inherited by LayoutAbsolute, LayoutColumn, LayoutOverlap, LayoutRadial, LayoutRootPieMenu, LayoutRow, uiLayoutItemFlow, uiLayoutItemGridFlow, and uiLayoutItemPanelHeader.

Public Member Functions
bool	active () const
void	active_set (bool active)
bool	active_default () const
void	active_default_set (bool active_default)
bool	activate_init () const
void	activate_init_set (bool activate_init)
blender::ui::LayoutAlign	alignment () const
void	alignment_set (blender::ui::LayoutAlign alignment)
bContextStore *	context_store () const
bool	enabled () const
void	enabled_set (bool enabled)
bool	red_alert () const
void	red_alert_set (bool red_alert)
float	scale_x () const
void	scale_x_set (float scale)
float	scale_y () const
void	scale_y_set (float scale)
float	search_weight () const
void	search_weight_set (float weight)
float	ui_units_x () const
void	ui_units_x_set (float width)
float	ui_units_y () const
void	ui_units_y_set (float height)
int	width () const
void	popover (const bContext *C, blender::StringRef panel_type, std::optional< blender::StringRef > name_opt, int icon)
uiLayoutRoot *	root () const
const bContextStore *	context () const
uiLayout *	parent () const
blender::StringRef	heading () const
void	heading_reset ()
blender::Span< uiItem * >	items () const
bool	align () const
bool	variable_size () const
blender::ui::EmbossType	emboss_or_undefined () const
Structs and Defines
	uiLayout (blender::ui::ItemType type, uiLayoutRoot *root)
Special RNA Items
blender::ui::LayoutDirection	local_direction () const
Button Items
void	decorator (PointerRNA ptr, PropertyRNA prop, int index)
void	decorator (PointerRNA *ptr, std::optional< blender::StringRefNull > propname, int index)
void	label (blender::StringRef name, int icon)
void	menu (MenuType *mt, std::optional< blender::StringRef > name, int icon)
void	menu (blender::StringRef menuname, std::optional< blender::StringRef > name, int icon)
void	menu_contents (blender::StringRef menuname)
void	menu_fn (blender::StringRefNull name, int icon, uiMenuCreateFunc func, void *arg)
void	menu_fn_argN_free (blender::StringRefNull name, int icon, uiMenuCreateFunc func, void *argN)
PointerRNA	op (wmOperatorType *ot, std::optional< blender::StringRef > name, int icon, blender::wm::OpCallContext context, eUI_Item_Flag flag)
PointerRNA	op (wmOperatorType *ot, std::optional< blender::StringRef > name, int icon)
PointerRNA	op (blender::StringRefNull opname, std::optional< blender::StringRef > name, int icon)
PointerRNA	op (blender::StringRefNull opname, std::optional< blender::StringRef > name, int icon, blender::wm::OpCallContext context, eUI_Item_Flag flag)
void	op_enum (blender::StringRefNull opname, blender::StringRefNull propname, IDProperty *properties, blender::wm::OpCallContext context, eUI_Item_Flag flag, const int active=-1)
void	op_enum (blender::StringRefNull opname, blender::StringRefNull propname)
void	op_enum_items (wmOperatorType ot, const PointerRNA &ptr, PropertyRNA prop, IDProperty properties, blender::wm::OpCallContext context, eUI_Item_Flag flag, const EnumPropertyItem item_array, int totitem, int active=-1)
PointerRNA	op_menu_enum (const bContext C, wmOperatorType ot, blender::StringRefNull propname, std::optional< blender::StringRefNull > name, int icon)
PointerRNA	op_menu_enum (const bContext *C, blender::StringRefNull opname, blender::StringRefNull propname, blender::StringRefNull name, int icon)
PointerRNA	op_menu_hold (wmOperatorType ot, std::optional< blender::StringRef > name, int icon, blender::wm::OpCallContext context, eUI_Item_Flag flag, const char menu_id)
void	progress_indicator (const char *text, float factor, blender::ui::ButProgressType progress_type)
void	prop (PointerRNA ptr, PropertyRNA prop, int index, int value, eUI_Item_Flag flag, std::optional< blender::StringRef > name_opt, int icon, std::optional< blender::StringRef > placeholder=std::nullopt)
void	prop (PointerRNA *ptr, blender::StringRefNull propname, eUI_Item_Flag flag, std::optional< blender::StringRef > name, int icon)
void	popover (const bContext C, PanelType pt, std::optional< blender::StringRef > name_opt, int icon)
void	popover_group (bContext C, int space_id, int region_id, const char context, const char *category)
void	prop_enum (PointerRNA ptr, PropertyRNA prop, int value, std::optional< blender::StringRefNull > name, int icon)
void	prop_enum (PointerRNA ptr, PropertyRNA prop, const char *value, std::optional< blender::StringRefNull > name, int icon)
void	prop_enum (PointerRNA ptr, blender::StringRefNull propname, const char value, std::optional< blender::StringRefNull > name, int icon)
void	prop_menu_enum (PointerRNA ptr, PropertyRNA prop, std::optional< blender::StringRefNull > name, int icon)
void	prop_tabs_enum (bContext C, PointerRNA ptr, PropertyRNA prop, PointerRNA ptr_highlight, PropertyRNA *prop_highlight, bool icon_only)
void	props_enum (PointerRNA *ptr, blender::StringRefNull propname)
void	prop_search (PointerRNA ptr, PropertyRNA prop, PointerRNA searchptr, PropertyRNA searchprop, PropertyRNA *item_searchpropname, std::optional< blender::StringRefNull > name, int icon, bool results_are_suggestions)
void	prop_search (PointerRNA ptr, blender::StringRefNull propname, PointerRNA searchptr, blender::StringRefNull searchpropname, std::optional< blender::StringRefNull > name, int icon)
void	prop_with_popover (PointerRNA ptr, PropertyRNA prop, int index, int value, eUI_Item_Flag flag, std::optional< blender::StringRefNull > name, int icon, const char *panel_type)
void	prop_with_menu (PointerRNA ptr, PropertyRNA prop, int index, int value, eUI_Item_Flag flag, std::optional< blender::StringRefNull > name, int icon, const char *menu_type)
uiBut *	button (blender::StringRef name, int icon, std::function< void(bContext &)> func, std::optional< blender::StringRef > tooltip=std::nullopt)
void	separator (float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
void	separator_spacer ()
Public Member Functions inherited from uiItem
	uiItem (const uiItem &)=default
virtual	~uiItem ()=default
	uiItem (blender::ui::ItemType type)
blender::ui::ItemType	type () const
bool	fixed_size () const
void	fixed_size_set (bool fixed_size)
Public Member Functions inherited from blender::NonCopyable
	NonCopyable (const NonCopyable &other)=delete
NonCopyable &	operator= (const NonCopyable &other)=delete
	NonCopyable ()=default
	NonCopyable (NonCopyable &&other)=default
NonCopyable &	operator= (NonCopyable &&other)=default
Public Member Functions inherited from blender::NonMovable
	NonMovable (NonMovable &&other)=delete
NonMovable &	operator= (NonMovable &&other)=delete
	NonMovable ()=default
	NonMovable (const NonMovable &other)=default
NonMovable &	operator= (const NonMovable &other)=default

Public Attributes
int	x_ = 0
int	y_ = 0
int	w_ = 0
int	h_ = 0
short	space_ = 0

Protected Attributes
uiLayoutRoot *	root_ = nullptr
bContextStore *	context_ = nullptr
uiLayout *	parent_ = nullptr
std::string	heading_
blender::Vector< uiItem * >	items_
uiLayout *	child_items_layout_ = nullptr
float	scale_ [2] = {0.0f, 0.0f}
bool	align_ = false
bool	active_ = false
bool	active_default_ = false
bool	activate_init_ = false
bool	enabled_ = false
bool	redalert_ = false
bool	variable_size_ = false
blender::ui::LayoutAlign	alignment_ = {}
blender::ui::EmbossType	emboss_ = {}
float	units_ [2] = {0.0f, 0.0f}
float	search_weight_ = 0.0f
Protected Attributes inherited from uiItem
blender::ui::ItemInternalFlag	flag_ = {}
blender::ui::ItemType	type_ = {}

Friends
struct	blender::ui::LayoutInternal

Layout
uiBlock *	block () const
void	context_copy (const bContextStore *context)
const PointerRNA *	context_ptr_get (const blender::StringRef name, const StructRNA *type) const
void	context_ptr_set (blender::StringRef name, const PointerRNA *ptr)
std::optional< blender::StringRefNull >	context_string_get (const blender::StringRef name) const
void	context_string_set (blender::StringRef name, blender::StringRef value)
std::optional< int64_t >	context_int_get (const blender::StringRef name) const
void	context_int_set (blender::StringRef name, int64_t value)
void	context_set_from_but (const uiBut *but)
blender::wm::OpCallContext	operator_context () const
void	operator_context_set (blender::wm::OpCallContext opcontext)
void	estimate ()
void	resolve ()

Layout Items
blender::ui::EmbossType	emboss () const
void	emboss_set (blender::ui::EmbossType emboss)
Panel *	root_panel () const
bool	use_property_split () const
void	use_property_split_set (bool value)
bool	use_property_decorate () const
void	use_property_decorate_set (bool is_sep)
uiLayout &	absolute (bool align)
uiBlock *	absolute_block ()
uiLayout &	box ()
uiLayout &	column (bool align)
uiLayout &	column (bool align, blender::StringRef heading)
uiLayout &	row (bool align)
uiLayout &	row (bool align, blender::StringRef heading)
uiLayout &	column_flow (int number, bool align)
uiLayout &	grid_flow (bool row_major, int columns_len, bool even_columns, bool even_rows, bool align)
uiLayout &	list_box (uiList ui_list, PointerRNA actptr, PropertyRNA *actprop)
uiLayout &	menu_pie ()
uiLayout &	overlap ()
PanelLayout	panel_prop (const bContext C, PointerRNA open_prop_owner, blender::StringRefNull open_prop_name)
uiLayout *	panel_prop (const bContext C, PointerRNA open_prop_owner, blender::StringRefNull open_prop_name, blender::StringRef label)
PanelLayout	panel_prop_with_bool_header (const bContext C, PointerRNA open_prop_owner, blender::StringRefNull open_prop_name, PointerRNA *bool_prop_owner, blender::StringRefNull bool_prop_name, std::optional< blender::StringRef > label)
PanelLayout	panel (const bContext *C, blender::StringRef idname, bool default_closed)
uiLayout *	panel (const bContext *C, blender::StringRef idname, bool default_closed, blender::StringRef label)
uiLayout &	split (float percentage, bool align)
virtual void	estimate_impl ()
virtual void	resolve_impl ()

Detailed Description

NOTE: uiLayout properties should be considered private outside interface_layout.cc, incoming refactors would remove public access and add public read/write function methods. Meanwhile keep using uiLayout* functions to read/write this properties.

Definition at line 102 of file UI_interface_layout.hh.

Constructor & Destructor Documentation

◆ uiLayout()

uiLayout::uiLayout	(	blender::ui::ItemType	type,
		uiLayoutRoot *	root )

Definition at line 194 of file interface_layout.cc.

References root(), root_, uiItem::type(), and uiItem::uiItem().

Referenced by absolute(), blender::ui::LayoutInternal, box(), column(), column(), column_flow(), decorator(), estimate(), grid_flow(), LayoutAbsolute::LayoutAbsolute(), LayoutColumn::LayoutColumn(), LayoutColumn::LayoutColumn(), LayoutOverlap::LayoutOverlap(), LayoutRadial::LayoutRadial(), LayoutRootPieMenu::LayoutRootPieMenu(), LayoutRow::LayoutRow(), LayoutRow::LayoutRow(), list_box(), menu_pie(), op_enum_items(), overlap(), panel(), panel_prop(), panel_prop(), panel_prop_with_bool_header(), parent(), popover(), prop(), props_enum(), resolve(), LayoutRow::resolve_impl(), row(), row(), split(), uiLayoutItemFlow::uiLayoutItemFlow(), uiLayoutItemGridFlow::uiLayoutItemGridFlow(), and uiLayoutItemPanelHeader::uiLayoutItemPanelHeader().

Member Function Documentation

◆ absolute()

uiLayout & uiLayout::absolute ( bool align )

Sub-layout items.

Definition at line 5023 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), and uiLayout().

Referenced by ui_item_array(), uiTemplateReportsBanner(), uiTemplateStatusInfo(), and v3d_object_dimension_buts().

◆ absolute_block()

uiBlock * uiLayout::absolute_block ( )

Definition at line 5033 of file interface_layout.cc.

References absolute(), and block().

Referenced by image_panel_uv(), uiTemplateColorRamp(), uiTemplateHeader(), uiTemplateIcon(), uiTemplateIconView(), uiTemplateMarker(), v3d_editvertex_buts(), and view3d_panel_vgroup().

◆ activate_init()

bool uiLayout::activate_init ( ) const

inlinenodiscard

Definition at line 727 of file UI_interface_layout.hh.

References activate_init_.

Referenced by activate_init_set(), and prop().

◆ activate_init_set()

void uiLayout::activate_init_set ( bool activate_init )

inline

When set to true, the next button added in the layout will be activated on first display. Only for popups dialogs and only the first button in the popup with this flag will be activated.

Definition at line 731 of file UI_interface_layout.hh.

References activate_init(), and activate_init_.

◆ active()

bool uiLayout::active ( ) const

inlinenodiscard

Definition at line 709 of file UI_interface_layout.hh.

References active_.

Referenced by active_set(), curvemap_buttons_layout(), op_enum(), and op_enum_items().

◆ active_default()

bool uiLayout::active_default ( ) const

inlinenodiscard

Definition at line 718 of file UI_interface_layout.hh.

References active_default_.

Referenced by active_default_set(), and uiItemFullO_ptr_ex().

◆ active_default_set()

void uiLayout::active_default_set ( bool active_default )

inline

When set to true the next operator button added in the layout will be highlighted as default action when pressing return, in popup dialogs this overrides default confirmation buttons.

Definition at line 722 of file UI_interface_layout.hh.

References active_default(), and active_default_.

Referenced by file_panel_execution_execute_button().

◆ active_set()

void uiLayout::active_set ( bool active )

inline

Sets the active state of the layout and its items. When false the layout and its buttons are grayed out, user can still interact with them but generally they will not have an active use.

Definition at line 713 of file UI_interface_layout.hh.

References active(), and active_.

◆ align()

bool uiLayout::align ( ) const

nodiscard

Definition at line 6207 of file interface_layout.cc.

References align_.

Referenced by absolute(), column(), column(), column_flow(), grid_flow(), op_enum_items(), resolve(), row(), row(), split(), ui_item_align(), and ui_item_with_label().

◆ alignment()

blender::ui::LayoutAlign uiLayout::alignment ( ) const

inlinenodiscard

Definition at line 736 of file UI_interface_layout.hh.

References alignment_.

Referenced by alignment_set(), LayoutRow::resolve_impl(), uiLayoutItemFlow::resolve_impl(), uiLayoutItemGridFlow::resolve_impl(), ui_layout_heading_label_add(), ui_layout_vary_direction(), ui_text_icon_width_ex(), and uiItem_simple().

◆ alignment_set()

void uiLayout::alignment_set ( blender::ui::LayoutAlign alignment )

inline

Definition at line 741 of file UI_interface_layout.hh.

References alignment(), and alignment_.

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), blender::nodes::add_layer_name_search_button(), buttons_panel_context_draw(), curvemap_buttons_layout(), CurveProfile_buttons_layout(), blender::nodes::draw_named_attributes_panel(), blender::ed::space_node::draw_node_socket_name_editable(), blender::nodes::draw_property_for_output_socket(), fmodifier_panel_header(), graph_draw_driven_property_panel(), graph_draw_driver_settings_panel(), blender::seq::modifier_panel_header(), modifier_panel_header(), nla_panel_animdata(), blender::ed::space_node::node_update_basis_socket(), blender::seq::sound_equalizermodifier_draw(), blender::ed::spreadsheet::spreadsheet_footer_region_draw(), blender::ed::space_node::std_node_socket_draw(), blender::ui::template_breadcrumbs(), ui_layout_heading_label_add(), blender::ed::space_node::ui_node_draw_input(), uiItemPropertySplitWrapperCreate(), uiItemsAlertBox(), uiTemplateAnyID(), uiTemplateInputStatus(), and wm_block_about_create().

◆ block()

uiBlock * uiLayout::block ( ) const

nodiscard

Definition at line 5524 of file interface_layout.cc.

References root_.

Referenced by absolute(), absolute_block(), blender::nodes::add_attribute_search_button(), blender::ed::asset::shelf::add_catalog_tabs(), blender::nodes::add_layer_name_search_button(), blender::ed::asset::shelf::asset_shelf_header_draw(), blender::ed::asset::shelf::build_asset_view(), blender::ui::TreeViewLayoutBuilder::build_from_tree(), blender::ed::asset::shelf::AssetViewItem::build_grid_tile(), blender::ui::PreviewGridItem::build_grid_tile_button(), blender::ui::GridViewBuilder::build_grid_view(), blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::build_row(), blender::ui::TreeViewBuilder::build_tree_view(), blender::ed::asset::shelf::catalog_selector_panel_draw(), blender::ed::asset::shelf::catalog_tree_draw(), column(), column_flow(), context_copy(), context_int_set(), context_ptr_set(), context_string_set(), create_title_button(), curvemap_buttons_layout(), CurveProfile_buttons_layout(), decorator(), draw_constraint_header(), draw_matrix_template(), blender::ed::spreadsheet::draw_viewer_data_panel(), blender::ed::spreadsheet::draw_viewer_path_panel(), emboss(), envelope_panel_draw(), blender::ed::asset_browser::file_create_asset_catalog_tree_view_in_layout(), file_panel_execution_buttons_draw(), file_panel_operator(), fmodifier_panel_header(), format_unit_value(), graph_draw_driven_property_enabled_btn(), graph_draw_driver_settings_panel(), graph_panel_key_properties(), graph_panel_modifiers(), grid_flow(), knot_modes_menu(), blender::ui::LayoutInternal::layout_add_but(), menu(), menu_contents(), menu_item_enum_opname_menu(), menu_pie(), modifier_panel_get_property_pointers(), modifier_panel_header(), nla_panel_actclip(), nla_panel_animated_influence_header(), nla_panel_animated_strip_time(), nla_panel_animated_strip_time_header(), nla_panel_animdata(), nla_panel_evaluation(), nla_panel_modifiers(), nla_panel_properties(), nla_panel_stripname(), blender::ed::space_node::node_geometry_add_attribute_search_button(), blender::ed::space_node::node_geometry_add_layer_search_button(), blender::ed::space_node::node_geometry_add_volume_grid_search_button(), op_enum(), op_enum_items(), op_menu_enum(), overlap(), panel_draw(), panel_prop(), progress_indicator(), prop(), prop_enum(), prop_search(), prop_tabs_enum(), prop_with_menu(), prop_with_popover(), props_enum(), resolve(), LayoutRadial::resolve_impl(), root_panel(), rotation_mode_menu_callback(), row(), separator(), separator_spacer(), shaderfx_panel_header(), split(), blender::ed::spreadsheet::spreadsheet_data_set_panel_draw(), blender::ui::template_asset_shelf_popover(), template_ID(), template_ID_tabs(), template_keymap_item_properties(), template_operator_property_buts_draw_single(), template_search_buttons(), template_texture_user_menu(), blender::ed::object::shapekey::template_tree(), ui_alert_create(), ui_but_change_type(), ui_def_but_rna__menu(), ui_imageuser_layer_menu(), ui_imageuser_pass_menu(), ui_imageuser_slot_menu(), ui_imageuser_view_menu_multiview(), ui_imageuser_view_menu_rr(), ui_item_array(), ui_item_disabled(), ui_item_menu(), ui_item_menu_hold(), ui_item_rna_size(), ui_layout_box(), UI_menutype_draw(), blender::ed::space_node::ui_node_draw_input(), blender::ed::space_node::ui_node_menu_column(), ui_paneltype_draw_impl(), UI_popup_block_template_confirm_op(), ui_popup_context_menu_for_button(), ui_popup_context_menu_for_panel(), ui_template_list_layout_draw(), blender::ed::space_node::ui_template_node_link_menu(), ui_text_icon_width_ex(), uiblock_layer_pass_buttons(), uiItem_simple(), uiItemFullO_ptr_ex(), uiItemL_respect_property_split(), uiLayoutListItemAddPadding(), uiTemplateBoneCollectionTree(), uiTemplateCollectionExporters(), uiTemplateColorPicker(), uiTemplateComponentMenu(), uiTemplateConstraintHeader(), uiTemplateCryptoPicker(), uiTemplateCurveMapping(), uiTemplateCurveProfile(), uiTemplateFileSelectPath(), uiTemplateGreasePencilLayerTree(), uiTemplateImage(), uiTemplateKeymapItemProperties(), uiTemplateLayers(), uiTemplateLightLinkingCollection(), uiTemplateMarker(), uiTemplateMenuSearch(), uiTemplateMovieClip(), uiTemplateNodeLink(), uiTemplateNodeSocket(), uiTemplateNodeTreeInterface(), uiTemplateOperatorRedoProperties(), uiTemplateOperatorSearch(), uiTemplatePalette(), uiTemplatePreview(), uiTemplateRecentFiles(), uiTemplateReportsBanner(), uiTemplateRunningJobs(), uiTemplateStatusInfo(), uiTemplateTextureShow(), uiTemplateTextureUser(), v3d_object_dimension_buts(), view3d_panel_curve_data(), view3d_panel_transform(), and wm_block_dialog_create().

◆ box()

uiLayout & uiLayout::box ( )

Add a new box sub-layout, items placed in this sub-layout are added vertically one under each other in a column and are surrounded by a box.

Definition at line 4985 of file interface_layout.cc.

References Roundbox, ui_layout_box(), and uiLayout().

Referenced by blender::ui::TreeViewLayoutBuilder::build_from_tree(), draw_matrix_template(), and template_keymap_item_properties().

◆ button()

uiBut * uiLayout::button	(	blender::StringRef	name,
		int	icon,
		std::function< void(bContext &)>	func,
		std::optional< blender::StringRef >	tooltip = std::nullopt )

Simple button executing func on click.

Definition at line 3242 of file interface_layout.cc.

References But, name, UI_but_func_set(), and uiItem_simple().

Referenced by blender::ui::template_breadcrumbs().

◆ column() [1/2]

uiLayout & uiLayout::column ( bool align )

Add a new column sub-layout, items placed in this sub-layout are added vertically one under each other in a column.

Definition at line 4898 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), root_, space_, and uiLayout().

◆ column() [2/2]

uiLayout & uiLayout::column	(	bool	align,
		blender::StringRef	heading )

Add a new column sub-layout, items placed in this sub-layout are added vertically one under each other in a column.

Parameters

heading Heading label to set to the first child element added in the sub-layout through uiLayout::prop. When property split is used, this heading label is set in the split label column when there is no label defined.

Definition at line 4910 of file interface_layout.cc.

References align(), column(), heading(), heading_, and uiLayout().

◆ column_flow()

uiLayout & uiLayout::column_flow	(	int	number,
		bool	align )

Add a new column flow sub-layout, items placed in this sub-layout would be evenly distributed in columns.

Parameters

number the number of columns in which items are distributed.

Definition at line 4917 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), uiLayoutItemFlow::number, root_, space_, and uiLayout().

Referenced by template_keymap_item_properties().

◆ context()

const bContextStore * uiLayout::context ( ) const

nodiscard

Definition at line 6187 of file interface_layout.cc.

References context_.

Referenced by context_copy(), op(), op(), op_enum(), op_enum_items(), op_menu_hold(), popover(), popover_group(), UI_menutype_draw(), and UI_paneltype_draw().

◆ context_copy()

void uiLayout::context_copy ( const bContextStore * context )

Definition at line 5738 of file interface_layout.cc.

References block(), context(), context_, and CTX_store_add_all().

Referenced by menu_items_from_ui_create(), set_layout_context_from_button(), ui_popover_create_block(), and ui_popup_menu_create_block().

◆ context_int_get()

std::optional< int64_t > uiLayout::context_int_get ( const blender::StringRef name ) const

nodiscard

Definition at line 5724 of file interface_layout.cc.

References context_, CTX_store_int_lookup(), and name.

◆ context_int_set()

void uiLayout::context_int_set	(	blender::StringRef	name,
		int64_t	value )

Definition at line 5732 of file interface_layout.cc.

References block(), context_, CTX_store_add(), and name.

◆ context_ptr_get()

const PointerRNA * uiLayout::context_ptr_get	(	const blender::StringRef	name,
		const StructRNA *	type ) const

nodiscard

Definition at line 5695 of file interface_layout.cc.

References context_, CTX_store_ptr_lookup(), name, and uiItem::type().

Referenced by blender::ed::object::move_to_collection_recursive_menu_draw().

◆ context_ptr_set()

void uiLayout::context_ptr_set	(	blender::StringRef	name,
		const PointerRNA *	ptr )

Definition at line 5704 of file interface_layout.cc.

References block(), context_, CTX_store_add(), name, and ptr.

◆ context_set_from_but()

void uiLayout::context_set_from_but ( const uiBut * but )

Only for convenience.

Definition at line 5813 of file interface_layout.cc.

References context_ptr_set(), PointerRNA::data, uiBut::opptr, RNA_pointer_create_discrete(), uiBut::rnapoin, and uiBut::rnaprop.

Referenced by graph_panel_drivers_popover(), ui_item_menu_hold(), and ui_popup_context_menu_for_button().

◆ context_store()

bContextStore * uiLayout::context_store ( ) const

inlinenodiscard

Definition at line 746 of file UI_interface_layout.hh.

References context_.

Referenced by set_layout_context_from_button(), and UI_panel_context_pointer_set().

◆ context_string_get()

std::optional< blender::StringRefNull > uiLayout::context_string_get ( const blender::StringRef name ) const

nodiscard

Definition at line 5709 of file interface_layout.cc.

References context_, CTX_store_string_lookup(), and name.

◆ context_string_set()

void uiLayout::context_string_set	(	blender::StringRef	name,
		blender::StringRef	value )

Definition at line 5718 of file interface_layout.cc.

References block(), context_, CTX_store_add(), and name.

Referenced by blender::ed::space_node::add_root_catalogs_draw(), blender::ui::asset_shelf_popover_invoke(), blender::ed::space_node::swap_root_catalogs_draw(), and blender::ui::template_asset_shelf_popover().

◆ decorator() [1/2]

void uiLayout::decorator	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index )

Items. Insert a decorator item for a button with the same property as prop. To force inserting a blank dummy element, nullptr can be passed for or and prop.

Definition at line 2961 of file interface_layout.cc.

References block(), blender::ui::block_layout_set_current(), col, column(), uiButDecorator::decorated_rnaindex, uiButDecorator::decorated_rnapoin, uiButDecorator::decorated_rnaprop, Decorator, ELEM, uiBut::flag, i, blender::ui::None, prop(), ptr, RNA_property_animateable(), RNA_property_array_check(), RNA_property_array_length(), TIP_, ui_but_anim_decorate_cb(), UI_BUT_DISABLED, UI_BUT_DRAG_LOCK, UI_but_func_set(), UI_BUT_UNDO, UI_ITEM_NONE, ui_item_rna_is_expand(), UI_UNIT_X, UI_UNIT_Y, uiDefIconBut(), and uiLayout().

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), data_panel_draw(), decorator(), panel_draw(), panel_draw(), prop(), template_search_buttons(), blender::ed::space_node::ui_node_draw_input(), and uiTemplateCacheFileTimeSettings().

◆ decorator() [2/2]

void uiLayout::decorator	(	PointerRNA *	ptr,
		std::optional< blender::StringRefNull >	propname,
		int	index )

Insert a decorator item for a button with the same property as prop. To force inserting a blank dummy element, nullptr can be passed for ptr or std::nullopt for propname.

Definition at line 3016 of file interface_layout.cc.

References decorator(), prop(), ptr, RNA_struct_find_property(), RNA_struct_identifier(), RNA_warning, and ui_item_disabled().

◆ emboss()

blender::ui::EmbossType uiLayout::emboss ( ) const

nodiscard

Definition at line 5094 of file interface_layout.cc.

References block(), emboss_, and blender::ui::Undefined.

Referenced by emboss_set().

◆ emboss_or_undefined()

blender::ui::EmbossType uiLayout::emboss_or_undefined ( ) const

nodiscard

Definition at line 6215 of file interface_layout.cc.

References emboss_.

Referenced by uiItemFullO_ptr_ex().

◆ emboss_set()

void uiLayout::emboss_set ( blender::ui::EmbossType emboss )

Definition at line 5064 of file interface_layout.cc.

References emboss(), and emboss_.

Referenced by blender::ui::block_layout(), blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::build_row(), blender::ui::TreeViewLayoutBuilder::build_row(), buttons_panel_context_draw(), draw_constraint_header(), blender::ed::spreadsheet::draw_context_panel(), draw_export_controls(), draw_exporter_item(), blender::nodes::socket_items::ui::draw_item_in_list(), blender::ed::space_node::draw_node_socket_name_editable(), fmodifier_panel_header(), blender::seq::modifier_panel_header(), modifier_panel_header(), blender::nodes::node_geo_index_switch_cc::node_declare(), blender::nodes::node_geo_menu_switch_cc::node_declare(), shaderfx_panel_header(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), uiItemFullO_ptr_ex(), uiTemplateStatusInfo(), and v3d_transform_butsR().

◆ enabled()

bool uiLayout::enabled ( ) const

inlinenodiscard

Definition at line 751 of file UI_interface_layout.hh.

References enabled_.

Referenced by enabled_set().

◆ enabled_set()

void uiLayout::enabled_set ( bool enabled )

inline

Sets the enabled state of the layout and its items. When false the layout and its buttons are grayed out, user can't interaction with them, only buttons tooltips are available on hovering.

Definition at line 755 of file UI_interface_layout.hh.

References enabled(), and enabled_.

Referenced by armature_parent_clear_invoke(), armature_parent_set_invoke(), blender::ui::block_layout(), blender::chaining_panel_draw(), constraint_ops_extra_draw(), blender::edge_types_panel_draw(), blender::face_mark_panel_draw(), blender::face_mark_panel_draw_header(), gpencil_shaderfx_ops_extra_draw(), hud_panel_operator_redo_draw(), blender::intersection_panel_draw(), blender::material_mask_panel_draw(), blender::material_mask_panel_draw_header(), move_to_collection_menu_create(), nla_panel_animated_strip_time(), nla_panel_evaluation(), blender::nodes::node_geo_bake_cc::node_layout(), blender::nodes::node_geo_bake_cc::node_layout_ex(), blender::nodes::node_geo_simulation_cc::node_layout_ex(), blender::ed::space_node::node_update_basis_buttons(), blender::ed::space_node::node_update_basis_from_declaration(), blender::ed::space_node::node_update_basis_socket(), blender::occlusion_panel_draw(), blender::options_light_reference_draw(), blender::options_panel_draw(), blender::panel_draw(), panel_draw(), prop(), shape_panel_draw(), subdivisions_panel_draw(), ui_popup_context_menu_for_button(), uiTemplateImage(), uiTemplateImageSettings(), undo_history_draw_menu(), v3d_object_dimension_buts(), blender::vgroup_panel_draw(), view3d_panel_vgroup(), and wm_block_create_redo().

◆ estimate()

void uiLayout::estimate ( )

protected

Definition at line 5306 of file interface_layout.cc.

References estimate(), estimate_impl(), h_, items(), scale_x(), scale_y(), uiItem::type(), ui_item_scale(), UI_UNIT_X, UI_UNIT_Y, ui_units_x(), ui_units_y(), uiItem::uiItem(), uiLayout(), and w_.

Referenced by estimate(), and blender::ui::LayoutInternal::layout_estimate().

◆ estimate_impl()

void uiLayout::estimate_impl ( )

protectedvirtual

Reimplemented in LayoutAbsolute, LayoutColumn, LayoutOverlap, LayoutRadial, LayoutRow, uiLayoutItemBx, uiLayoutItemFlow, uiLayoutItemGridFlow, uiLayoutItemPanelHeader, and uiLayoutItemSplit.

Definition at line 3994 of file interface_layout.cc.

Referenced by estimate().

◆ grid_flow()

uiLayout & uiLayout::grid_flow	(	bool	row_major,
		int	columns_len,
		bool	even_columns,
		bool	even_rows,
		bool	align )

Add a new grid flow sub-layout, items placed in this sub-layout would be distributed in a grid.

Parameters

row_major	When true items are distributed by rows, otherwise items are distributed by columns.
columns_len	When positive is the fixed number of columns to show, when 0 its automatic defined, when negative its an automatic stepped number of columns/rows to show (e.g. when row_major is true -3 will automatically show (1,2,3,6,9,...) columns, or when row_major is false -3 will automatically show (3,6,9,...) rows).
even_columns	All columns will have the same width.
even_rows	All rows will have the same height.

Definition at line 4930 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), uiLayoutItemGridFlow::columns_len, uiLayoutItemGridFlow::even_columns, uiLayoutItemGridFlow::even_rows, blender::ui::LayoutInternal::init_from_parent(), root_, row_major, uiLayoutItemGridFlow::row_major, space_, and uiLayout().

Referenced by blender::seq::colorBalance_panel_draw(), blender::seq::sound_equalizermodifier_draw(), and ui_template_list_layout_draw().

◆ heading()

blender::StringRef uiLayout::heading ( ) const

nodiscard

Definition at line 6195 of file interface_layout.cc.

References heading_.

Referenced by column(), row(), and ui_layout_heading_label_add().

◆ heading_reset()

void uiLayout::heading_reset ( )

Definition at line 6199 of file interface_layout.cc.

References heading_.

Referenced by ui_layout_heading_label_add().

◆ items()

blender::Span< uiItem * > uiLayout::items ( ) const

nodiscard

Definition at line 6203 of file interface_layout.cc.

References items_.

Referenced by estimate(), LayoutAbsolute::estimate_impl(), LayoutColumn::estimate_impl(), LayoutOverlap::estimate_impl(), LayoutRow::estimate_impl(), uiLayoutItemFlow::estimate_impl(), uiLayoutItemGridFlow::estimate_impl(), uiLayoutItemPanelHeader::estimate_impl(), resolve(), LayoutAbsolute::resolve_impl(), LayoutColumn::resolve_impl(), LayoutOverlap::resolve_impl(), LayoutRadial::resolve_impl(), LayoutRootPieMenu::resolve_impl(), LayoutRow::resolve_impl(), uiLayoutItemFlow::resolve_impl(), uiLayoutItemGridFlow::resolve_impl(), uiLayoutItemPanelHeader::resolve_impl(), uiLayoutItemSplit::resolve_impl(), spaces_after_column_item(), ui_item_align(), ui_item_flag(), ui_item_scale(), blender::ui::LayoutInternal::ui_layout_find_button_item(), ui_layout_free(), ui_layout_has_panel_label(), ui_layout_list_set_labels_active(), ui_paneltype_draw_impl(), uiLayoutEndsWithPanelHeader(), uiLayoutSetTooltipCustomFunc(), and uiLayoutSetTooltipFunc().

◆ label()

void uiLayout::label	(	blender::StringRef	name,
		int	icon )

Adds a label item that will display text and/or icon in the layout.

Definition at line 3188 of file interface_layout.cc.

References name, and uiItem_simple().

◆ list_box()

uiLayout & uiLayout::list_box	(	uiList *	ui_list,
		PointerRNA *	actptr,
		PropertyRNA *	actprop )

Add a new list box sub-layout.

Definition at line 5005 of file interface_layout.cc.

References uiBut::custom_data, uiBut::flag, ListBox, RNA_property_description(), uiBut::rnapoin, uiBut::rnaprop, uiLayoutItemBx::roundbox, uiBut::tip, UI_BUT_UNDO, ui_layout_box(), and uiLayout().

Referenced by ui_template_list_layout_draw().

◆ local_direction()

blender::ui::LayoutDirection uiLayout::local_direction ( ) const

nodiscard

Definition at line 569 of file interface_layout.cc.

References blender::ui::Horizontal, uiItem::type(), and blender::ui::Vertical.

Referenced by op_enum_items(), prop(), ui_item_enum_expand_elem_exec(), and ui_item_local_sublayout().

◆ menu() [1/2]

void uiLayout::menu	(	blender::StringRef	menuname,
		std::optional< blender::StringRef >	name,
		int	icon )

Adds a menu item, which is a button that when active will display a menu. If menu fails to poll with WM_menutype_poll it will not be added into the layout.

Definition at line 2934 of file interface_layout.cc.

References menu(), name, RNA_warning, and WM_menutype_find().

◆ menu() [2/2]

void uiLayout::menu	(	MenuType *	mt,
		std::optional< blender::StringRef >	name,
		int	icon )

Adds a menu item, which is a button that when active will display a menu. If menu fails to poll with WM_menutype_poll it will not be added into the layout.

Definition at line 2910 of file interface_layout.cc.

References block(), C, CTX_IFACE_, MenuType::description, MenuType::label, blender::ui::Menu, name, root_, TIP_, MenuType::translation_context, ui_item_menu(), ui_item_menutype_func(), and WM_menutype_poll().

Referenced by context_menu_invoke(), menu(), blender::ed::object::move_to_collection_menu_draw(), blender::ed::object::root_catalogs_draw(), blender::ed::space_node::root_catalogs_draw(), screen_user_menu_draw(), template_operator_property_buts_draw_single(), ui_popup_context_menu_for_button(), and blender::ed::geometry::ui_template_node_operator_asset_root_items().

◆ menu_contents()

void uiLayout::menu_contents ( blender::StringRef menuname )

Adds the menu content into this layout.

Definition at line 2944 of file interface_layout.cc.

References block(), C, RNA_warning, UI_menutype_draw(), WM_menutype_find(), and WM_menutype_poll().

Referenced by blender::ed::outliner::outliner_operator_menu(), and blender::ed::vse::sequencer_add_scene_draw().

◆ menu_fn()

void uiLayout::menu_fn	(	blender::StringRefNull	name,
		int	icon,
		uiMenuCreateFunc	func,
		void *	arg )

Adds a menu item, which is a button that when active will display a menu.

Parameters

name	Label to show in the menu button.
func	Function that generates the menu layout.
arg	Pointer to data used as last argument in func.

Definition at line 3362 of file interface_layout.cc.

References name, and ui_item_menu().

Referenced by draw_constraint_header(), modifier_panel_header(), move_to_collection_menu_create(), screen_context_menu_invoke(), shaderfx_panel_header(), ui_popup_context_menu_for_button(), and workspace_add_invoke().

◆ menu_fn_argN_free()

void uiLayout::menu_fn_argN_free	(	blender::StringRefNull	name,
		int	icon,
		uiMenuCreateFunc	func,
		void *	argN )

Adds a menu item, which is a button that when active will display a menu.

Parameters

name	Label to show in the menu button.
func	Function that generates the menu layout.
argN	Pointer to data used as last argument in func, it will be freed with the menu button.

Definition at line 3371 of file interface_layout.cc.

References name, and ui_item_menu().

Referenced by workspace_add_invoke().

◆ menu_pie()

uiLayout & uiLayout::menu_pie ( )

Add a pie menu layout, buttons are arranged around a center. Only one pie menu per layout root can be added, if it's already initialized it will be returned instead of adding a new one.

Definition at line 4961 of file interface_layout.cc.

References block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), blender::ui::PieMenu, root_, ui_item_local_sublayout(), uiItem::uiItem(), and uiLayout().

Referenced by op_enum_items(), ui_item_enum_expand_exec(), and ui_pie_menu_level_invoke().

◆ op() [1/4]

PointerRNA uiLayout::op	(	blender::StringRefNull	opname,
		std::optional< blender::StringRef >	name,
		int	icon )

Adds a operator item, places a button in the layout to call the operator.

Parameters

opname	Operator id name.
name	Text to show in the layout.

Returns: Operator pointer to write properties, might be PointerRNA_NULL if operator does not exists.

Definition at line 1743 of file interface_layout.cc.

References name, op(), root_, and UI_ITEM_NONE.

◆ op() [2/4]

PointerRNA uiLayout::op	(	blender::StringRefNull	opname,
		std::optional< blender::StringRef >	name,
		int	icon,
		blender::wm::OpCallContext	context,
		eUI_Item_Flag	flag )

Adds a operator item, places a button in the layout to call the operator.

Parameters

opname	Operator id name.
name	Text to show in the layout.
context	Operator call context for WM_operator_name_call.

Returns: Operator pointer to write properties, might be PointerRNA_NULL if operator does not exists.

Definition at line 1507 of file interface_layout.cc.

References blender::StringRefNull::c_str(), context(), flag, name, op(), ot, UI_OPERATOR_ERROR_RET, and WM_operatortype_find().

◆ op() [3/4]

PointerRNA uiLayout::op	(	wmOperatorType *	ot,
		std::optional< blender::StringRef >	name,
		int	icon )

Adds a operator item, places a button in the layout to call the operator.

Parameters

ot	Operator to add.
name	Text to show in the layout.

Returns: Operator pointer to write properties.

Definition at line 1738 of file interface_layout.cc.

References name, op(), ot, root_, and UI_ITEM_NONE.

◆ op() [4/4]

PointerRNA uiLayout::op	(	wmOperatorType *	ot,
		std::optional< blender::StringRef >	name,
		int	icon,
		blender::wm::OpCallContext	context,
		eUI_Item_Flag	flag )

Adds a operator item, places a button in the layout to call the operator.

Parameters

ot	Operator to add.
name	Text to show in the layout.
context	Operator call context for WM_operator_name_call.

Returns: Operator pointer to write properties.

Definition at line 1483 of file interface_layout.cc.

References context(), flag, name, ot, ptr, and uiItemFullO_ptr_ex().

◆ op_enum() [1/2]

void uiLayout::op_enum	(	blender::StringRefNull	opname,
		blender::StringRefNull	propname )

Expands and sets each enum property value as an operator button.

Parameters

propname Name of the operator's enum property.

Definition at line 1733 of file interface_layout.cc.

References op_enum(), root_, and UI_ITEM_NONE.

◆ op_enum() [2/2]

void uiLayout::op_enum	(	blender::StringRefNull	opname,
		blender::StringRefNull	propname,
		IDProperty *	properties,
		blender::wm::OpCallContext	context,
		eUI_Item_Flag	flag,
		const int	active = -1 )

Expands and sets each enum property value as an operator button.

Parameters

propname	Name of the operator's enum property.
properties	Extra operator properties values to set.
active	an optional item to highlight.

Definition at line 1664 of file interface_layout.cc.

References active(), BLI_assert, block(), C, blender::StringRefNull::c_str(), context(), context_, CTX_store_get(), CTX_store_set(), flag, free(), MEM_freeN(), op_enum_items(), ot, prop(), PROP_ENUM, ptr, RNA_property_enum_items_gettexted(), RNA_property_enum_items_gettexted_all(), RNA_property_type(), RNA_struct_find_property(), RNA_struct_identifier(), RNA_warning, ui_item_disabled(), ui_layout_is_radial(), WM_operator_properties_create_ptr(), WM_operator_properties_sanitize(), and WM_operatortype_find().

Referenced by keyingset_active_menu_invoke(), menu_item_enum_opname_menu(), op_enum(), blender::ed::outliner::outliner_operator_menu(), blender::ed::transform::select_orientation_invoke(), toggle_cyclic_invoke(), unpack_all_invoke(), unpack_item_invoke(), blender::ed::object::bake_simulation::unpack_single_bake_invoke(), and WM_menu_invoke_ex().

◆ op_enum_items()

void uiLayout::op_enum_items	(	wmOperatorType *	ot,
		const PointerRNA &	ptr,
		PropertyRNA *	prop,
		IDProperty *	properties,
		blender::wm::OpCallContext	context,
		eUI_Item_Flag	flag,
		const EnumPropertyItem *	item_array,
		int	totitem,
		int	active = -1 )

Expands and sets each enum property value as an operator button.

Parameters

prop	Operator's enum property.
properties	Extra operator properties values to set.
item_array	Precalculated item array, could be a subset of the enum property values.
active	an optional item to highlight.

Definition at line 1525 of file interface_layout.cc.

References active(), align(), block(), blender::ui::block_layout_set_current(), blender::StringRefNull::c_str(), context(), PointerRNA::data_as(), flag, uiBut::flag, blender::ui::Horizontal, i, EnumPropertyItem::icon, EnumPropertyItem::identifier, IDP_CopyPropertyContent(), Label, label(), local_direction(), menu_pie(), EnumPropertyItem::name, op(), ot, PIE_MAX_ITEMS, prop(), PROP_ENUM, ptr, RNA_property_enum_set(), RNA_property_identifier(), RNA_property_type(), RNA_struct_identifier(), RNA_warning, separator(), split(), ui_but_tip_from_enum_item(), UI_ITEM_R_ICON_ONLY, ui_layout_is_radial(), ui_pie_menu_level_create(), UI_SELECT_DRAW, UI_UNIT_X, UI_UNIT_Y, uiDefBut(), uiDefIconBut(), uiLayout(), and EnumPropertyItem::value.

Referenced by op_enum(), and ui_pie_menu_level_invoke().

◆ op_menu_enum() [1/2]

PointerRNA uiLayout::op_menu_enum	(	const bContext *	C,
		blender::StringRefNull	opname,
		blender::StringRefNull	propname,
		blender::StringRefNull	name,
		int	icon )

Adds a op_enum menu.

Returns: Operator pointer to write extra properties to set when menu buttons are displayed, might be PointerRNA_NULL if operator does not exist.

Definition at line 3493 of file interface_layout.cc.

References C, blender::StringRefNull::c_str(), name, op_menu_enum(), ot, PointerRNA_NULL, RNA_warning, ui_item_disabled(), UI_OPERATOR_ERROR_RET, and WM_operatortype_find().

◆ op_menu_enum() [2/2]

PointerRNA uiLayout::op_menu_enum	(	const bContext *	C,
		wmOperatorType *	ot,
		blender::StringRefNull	propname,
		std::optional< blender::StringRefNull >	name,
		int	icon )

Adds a op_enum menu.

Returns: Operator pointer to write extra properties to set when menu buttons are displayed, might be PointerRNA_NULL if operator does not exist.

Definition at line 3441 of file interface_layout.cc.

References BLI_assert, block(), but_func_argN_copy(), but_func_argN_free(), C, blender::StringRefNull::c_str(), PointerRNA::data, flag, blender::ui::Menu, menu_item_enum_opname_menu(), name, MenuItemLevel::opcontext, MenuItemLevel::opname, uiBut::opptr, ot, MenuItemLevel::propname, root_, STRNCPY_UTF8, UI_BLOCK_LOOP, ui_but_add_shortcut(), ui_item_menu(), WM_key_event_operator_string(), WM_operator_properties_alloc(), WM_operator_properties_create_ptr(), and WM_operatortype_name().

Referenced by graph_panel_modifiers(), nla_panel_modifiers(), op_menu_enum(), and screen_user_menu_draw().

◆ op_menu_hold()

PointerRNA uiLayout::op_menu_hold	(	wmOperatorType *	ot,
		std::optional< blender::StringRef >	name,
		int	icon,
		blender::wm::OpCallContext	context,
		eUI_Item_Flag	flag,
		const char *	menu_id )

Adds a operator item, places a button in the layout to call the operator, if the button is held down, a menu will be displayed instead.

Parameters

ot	Operator to add.
name	Text to show in the layout.
context	Operator call context for WM_operator_name_call.
menu_id	menu to show on held down.

Returns: Operator pointer to write properties, might be PointerRNA_NULL if operator does not exists.

Definition at line 1494 of file interface_layout.cc.

References BLI_strdup(), context(), flag, name, ot, ptr, UI_but_func_hold_set(), ui_item_menu_hold(), and uiItemFullO_ptr_ex().

◆ operator_context()

blender::wm::OpCallContext uiLayout::operator_context ( ) const

nodiscard

Definition at line 5529 of file interface_layout.cc.

References root_.

Referenced by blender::ed::object::move_to_collection_menu_draw(), and UI_popup_block_template_confirm_op().

◆ operator_context_set()

void uiLayout::operator_context_set ( blender::wm::OpCallContext opcontext )

Sets the default call context for new operator buttons added in any root_ sub-layout.

Definition at line 5643 of file interface_layout.cc.

References root_.

Referenced by blender::ed::object::collection_hide_menu_draw(), constraint_ops_extra_draw(), draw_constraint_header(), ED_buttons_navbar_menu(), ed_panel_draw(), ED_screens_region_flip_menu_create(), file_os_operations_menu_draw(), file_panel_execution_buttons_draw(), gpencil_shaderfx_ops_extra_draw(), blender::ed::asset::shelf::library_selector_draw(), menu_item_enum_opname_menu(), menu_item_enum_rna_menu(), menu_items_from_ui_create(), modifier_ops_extra_draw(), move_to_collection_menu_create(), blender::ed::object::move_to_collection_menu_draw(), blender::ed::object::move_to_collection_menu_draw(), blender::ed::space_node::node_group_separate_invoke(), blender::ed::outliner::outliner_operator_menu(), recent_files_menu_draw(), screen_area_touch_menu_create(), screen_context_menu_invoke(), blender::ed::vse::sequencer_add_scene_draw(), ui_popover_create_block(), ui_popup_context_menu_for_button(), ui_popup_menu_create_block(), unpack_all_invoke(), unpack_item_invoke(), blender::ed::object::bake_simulation::unpack_single_bake_invoke(), uv_mark_seam_invoke(), weight_sample_group_invoke(), wm_drop_import_file_invoke(), and WM_menu_invoke_ex().

◆ overlap()

uiLayout & uiLayout::overlap ( )

Add a new overlap sub-layout.

Definition at line 5041 of file interface_layout.cc.

References block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), and uiLayout().

Referenced by blender::ui::TreeViewLayoutBuilder::build_row(), and ui_template_list_layout_draw().

◆ panel() [1/2]

PanelLayout uiLayout::panel	(	const bContext *	C,
		blender::StringRef	idname,
		bool	default_closed )

Variant of panel_prop that automatically stores the open-close-state in the root panel. When a dynamic number of panels is required, it's recommended to use panel_prop instead of passing in generated id names.

Parameters

idname String that identifies the open-close-state in the root panel.

Definition at line 4859 of file interface_layout.cc.

References BKE_panel_layout_panel_state_ensure(), BLI_assert, C, panel_prop(), RNA_pointer_create_discrete(), root_panel(), and state.

◆ panel() [2/2]

uiLayout * uiLayout::panel	(	const bContext *	C,
		blender::StringRef	idname,
		bool	default_closed,
		blender::StringRef	label )

Variant of panel that automatically creates the header row with the given label and only returns the body layout.

Parameters

label Text that's shown in the panel header. It should already be translated.

Returns: NULL if the panel is closed and should not be drawn, otherwise the layout where the sub-panel should be inserted into.

Definition at line 4871 of file interface_layout.cc.

References PanelLayout::body, C, PanelLayout::header, label(), panel(), and uiLayout().

◆ panel_prop() [1/2]

PanelLayout uiLayout::panel_prop	(	const bContext *	C,
		PointerRNA *	open_prop_owner,
		blender::StringRefNull	open_prop_name )

Create a "layout panel" which is a panel that is defined as part of the uiLayout. This allows creating expandable sections which can also be nested.

The open-state of the panel is defined by an RNA property which is passed in as a pointer + property name pair. This gives the caller flexibility to decide who should own the open-state.

Parameters

C	The context is necessary because sometimes the panel may be forced to be open by the context even of the open-property is false. This can happen with e.g. property search.
layout	The uiLayout that should contain the sub-panel. Only layouts that span the full width of the region are supported for now.
open_prop_owner	Data that contains the open-property.
open_prop_name	Name of the open-property in open_prop_owner.

Returns: A PanelLayout containing layouts for both the header row and the panel body. If the panel is closed and should not be drawn, the body layout will be NULL.

Definition at line 4789 of file interface_layout.cc.

References block(), blender::ui::block_layout_set_current(), PanelLayout::body, C, blender::StringRefNull::c_str(), CTX_wm_region(), ARegion::flag, PanelLayout::header, blender::ui::LayoutInternal::init_from_parent(), Label, uiLayoutItemPanelHeader::open_prop_name, uiLayoutItemPanelHeader::open_prop_owner, RGN_FLAG_SEARCH_FILTER_ACTIVE, RNA_boolean_get(), root_, row(), space_, ui_text_icon_width(), UI_UNIT_Y, uiDefIconTextBut(), uiLayout(), and width().

Referenced by blender::seq::brightcontrast_panel_draw(), blender::seq::colorBalance_panel_draw(), blender::seq::compositor_modifier_panel_draw(), blender::seq::curves_panel_draw(), blender::nodes::draw_geometry_nodes_modifier_ui(), blender::nodes::draw_interface_panel_as_panel(), blender::nodes::draw_manage_panel(), blender::nodes::draw_warnings(), blender::seq::hue_correct_panel_draw(), panel(), blender::panel_draw(), panel_draw(), panel_prop(), panel_prop_with_bool_header(), blender::seq::tonemapmodifier_panel_draw(), uiTemplateCollectionExporters(), and blender::seq::whiteBalance_panel_draw().

◆ panel_prop() [2/2]

uiLayout * uiLayout::panel_prop	(	const bContext *	C,
		PointerRNA *	open_prop_owner,
		blender::StringRefNull	open_prop_name,
		blender::StringRef	label )

Variant of panel_prop that automatically creates the header row with the given label and only returns the body layout.

Parameters

label Text that's shown in the panel header. It should already be translated.

Returns: NULL if the panel is closed and should not be drawn, otherwise the layout where the sub-panel should be inserted into.

Definition at line 4848 of file interface_layout.cc.

References PanelLayout::body, C, PanelLayout::header, label(), panel_prop(), and uiLayout().

◆ panel_prop_with_bool_header()

PanelLayout uiLayout::panel_prop_with_bool_header	(	const bContext *	C,
		PointerRNA *	open_prop_owner,
		blender::StringRefNull	open_prop_name,
		PointerRNA *	bool_prop_owner,
		blender::StringRefNull	bool_prop_name,
		std::optional< blender::StringRef >	label )

Definition at line 4831 of file interface_layout.cc.

References C, uiItem::flag_, PanelLayout::header, label(), panel_prop(), prop(), UI_ITEM_NONE, and uiLayout().

Referenced by blender::nodes::draw_interface_panel_as_panel(), blender::panel_draw(), and panel_draw().

◆ parent()

uiLayout * uiLayout::parent ( ) const

nodiscard

Definition at line 6191 of file interface_layout.cc.

References parent_, and uiLayout().

Referenced by ui_layout_heading_find().

◆ popover() [1/2]

void uiLayout::popover	(	const bContext *	C,
		blender::StringRef	panel_type,
		std::optional< blender::StringRef >	name_opt,
		int	icon )

References Auto, C, context(), flag, name, prop(), ptr, and uiItem::type().

◆ popover() [2/2]

void uiLayout::popover	(	const bContext *	C,
		PanelType *	pt,
		std::optional< blender::StringRef >	name_opt,
		int	icon )

◆ popover_group()

void uiLayout::popover_group	(	bContext *	C,
		int	space_id,
		int	region_id,
		const char *	context,
		const char *	category )

Definition at line 3092 of file interface_layout.cc.

References BKE_regiontype_from_id(), BKE_spacetype_from_id(), C, PanelType::category, PanelType::context, context(), LISTBASE_FOREACH, ARegionType::paneltypes, PanelType::parent_id, PanelType::poll, popover(), RNA_warning, and STREQ.

◆ progress_indicator()

void uiLayout::progress_indicator	(	const char *	text,
		float	factor,
		blender::ui::ButProgressType	progress_type )

Definition at line 3300 of file interface_layout.cc.

References blender::ui::Bar, block(), blender::ui::block_layout_set_current(), uiBut::drawflag, Progress, progress_bar(), blender::ui::Ring, UI_BUT_TEXT_LEFT, UI_UNIT_X, UI_UNIT_Y, uiDefBut(), and width().

◆ prop() [1/2]

void uiLayout::prop	(	PointerRNA *	ptr,
		blender::StringRefNull	propname,
		eUI_Item_Flag	flag,
		std::optional< blender::StringRef >	name,
		int	icon )

Adds a RNA property item, and exposes it into the layout.

Definition at line 2398 of file interface_layout.cc.

References blender::StringRefNull::c_str(), flag, name, prop(), ptr, RNA_NO_INDEX, RNA_struct_find_property(), RNA_struct_identifier(), RNA_warning, and ui_item_disabled().

◆ prop() [2/2]

void uiLayout::prop	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index,
		int	value,
		eUI_Item_Flag	flag,
		std::optional< blender::StringRef >	name_opt,
		int	icon,
		std::optional< blender::StringRef >	placeholder = std::nullopt )

Adds a RNA property item, and exposes it into the layout.

Parameters

ptr	RNA pointer to the struct owner of prop.
prop	The property in ptr to add.
index	When prop is a array property, indicates what entry to expose through the layout, RNA_NO_INDEX (-1) means all.

Definition at line 1931 of file interface_layout.cc.

References activate_init(), blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, block(), blender::ui::block_layout_set_current(), Checkbox, CheckboxN, column(), CTX_data_main(), decorator(), uiBut::drawflag, ED_id_rename(), ELEM, uiBut::emboss, emboss_, enabled_set(), flag, uiItem::flag_, blender::ui::Horizontal, i, uiBut::icon, IconToggle, IconToggleN, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), Label, len, local_direction(), max_ii(), blender::ui::Menu, name, blender::ui::None, blender::ui::NoneOrStatus, nullptr, Num, NumSlider, blender::ui::PieMenu, blender::Vector< T, InlineBufferCapacity, Allocator >::pop_last(), uiButNumber::precision, uiButNumberSlider::precision, prop(), PROP_BOOLEAN, PROP_ENUM, PROP_ENUM_FLAG, PROP_FLOAT, PROP_ICONS_CONSECUTIVE, PROP_INT, PROP_POINTER, PROP_STRING, PROP_STRING_SEARCH_SUGGESTION, blender::ui::PropDecorateNoPad, ptr, red_alert(), blender::Vector< T, InlineBufferCapacity, Allocator >::reserve(), RNA_ENUM_VALUE, RNA_NO_INDEX, RNA_property_array_check(), RNA_property_array_item_char(), RNA_property_array_length(), RNA_property_boolean_get(), RNA_property_boolean_get_index(), RNA_property_editable(), RNA_property_enum_get(), RNA_property_flag(), RNA_property_string_search_flag(), RNA_property_type(), RNA_property_ui_icon(), RNA_property_ui_name(), RNA_struct_name_property(), uiBut::rnaindex, uiBut::rnapoin, uiBut::rnaprop, root_, Row, row(), space_, split(), uiButNumber::step_size, uiButNumberSlider::step_size, str, uiBut::str, Text, Toggle, uiBut::type, uiItem::type(), UI_BLOCK_LIST_ITEM, ui_block_new_button_group(), UI_BUT2_FORCE_SEMI_MODAL_ACTIVE, UI_BUT_ACTIVATE_ON_INIT, ui_but_add_search(), ui_but_change_type(), UI_BUT_CHECKBOX_INVERT, UI_but_flag2_enable(), UI_but_flag_enable(), UI_but_func_rename_full_set(), UI_BUT_LIST_ITEM, UI_but_placeholder_set(), UI_BUT_REDALERT, UI_BUT_TEXT_LEFT, UI_BUT_TEXT_RIGHT, ui_def_but_icon_clear(), ui_item_array(), ui_item_enum_expand(), ui_item_name_add_colon(), UI_ITEM_PROP_SEP_DIVIDE, blender::ui::LayoutInternal::ui_item_prop_split_layout_hack(), UI_ITEM_R_CHECKBOX_INVERT, UI_ITEM_R_COMPACT, UI_ITEM_R_EXPAND, UI_ITEM_R_FORCE_BLANK_DECORATE, UI_ITEM_R_ICON_NEVER, UI_ITEM_R_ICON_ONLY, UI_ITEM_R_NO_BG, UI_ITEM_R_SLIDER, UI_ITEM_R_SPLIT_EMPTY_NAME, UI_ITEM_R_TEXT_BUT_FORCE_SEMI_MODAL_ACTIVE, UI_ITEM_R_TOGGLE, ui_item_rna_is_expand(), ui_item_rna_size(), ui_item_with_label(), ui_layout_heading_find(), ui_layout_heading_label_add(), UI_MAX_NAME_STR, UI_UNIT_Y, uiDefAutoButR(), uiDefBut(), uiDefButR_prop(), uiDefIconButR_prop(), uiDefIconTextButR_prop(), uiLayout(), use_property_decorate(), use_property_split(), and w().

◆ prop_enum() [1/3]

void uiLayout::prop_enum	(	PointerRNA *	ptr,
		blender::StringRefNull	propname,
		const char *	value,
		std::optional< blender::StringRefNull >	name,
		int	icon )

Add a enum property value item. This button acts like a radio button that are used to chose a single enum value from a set of the enum property value items.

Definition at line 2539 of file interface_layout.cc.

References blender::StringRefNull::c_str(), name, prop(), prop_enum(), ptr, RNA_struct_find_property(), RNA_struct_identifier(), RNA_warning, ui_item_disabled(), and UNLIKELY.

◆ prop_enum() [2/3]

void uiLayout::prop_enum	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		const char *	value,
		std::optional< blender::StringRefNull >	name,
		int	icon )

Add a enum property value item. This button acts like a radio button that are used to chose a single enum value from a set of the enum property value items.

Definition at line 2490 of file interface_layout.cc.

References block(), blender::StringRefNull::c_str(), CTX_IFACE_, flag, free(), EnumPropertyItem::identifier, blender::StringRefBase::is_empty(), MEM_freeN(), name, prop(), PROP_ENUM, ptr, RNA_ENUM_VALUE, RNA_enum_value_from_id(), RNA_property_enum_items(), RNA_property_identifier(), RNA_property_translation_context(), RNA_property_type(), RNA_struct_identifier(), RNA_warning, ui_item_disabled(), UI_ITEM_NONE, UI_ITEM_R_ICON_ONLY, and UNLIKELY.

◆ prop_enum() [3/3]

void uiLayout::prop_enum	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	value,
		std::optional< blender::StringRefNull >	name,
		int	icon )

Add a enum property value item. This button acts like a radio button that are used to chose a single enum value from a set of the enum property value items.

Definition at line 2474 of file interface_layout.cc.

References blender::StringRefNull::c_str(), name, prop(), PROP_ENUM, ptr, RNA_ENUM_VALUE, RNA_property_identifier(), RNA_property_type(), RNA_struct_identifier(), RNA_warning, ui_item_disabled(), and UI_ITEM_NONE.

Referenced by prop_enum().

◆ prop_menu_enum()

void uiLayout::prop_menu_enum	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		std::optional< blender::StringRefNull >	name,
		int	icon )

Add a enum property item, and exposes its value throw a radio button menu.

Definition at line 3520 of file interface_layout.cc.

References but_func_argN_copy(), but_func_argN_free(), blender::ui::Menu, menu_item_enum_rna_menu(), name, MenuItemLevel::opcontext, prop(), MenuItemLevel::propname, ptr, RNA_property_description(), RNA_property_identifier(), RNA_property_ui_name(), MenuItemLevel::rnapoin, root_, STRNCPY_UTF8, and ui_item_menu().

◆ prop_search() [1/2]

void uiLayout::prop_search	(	PointerRNA *	ptr,
		blender::StringRefNull	propname,
		PointerRNA *	searchptr,
		blender::StringRefNull	searchpropname,
		std::optional< blender::StringRefNull >	name,
		int	icon )

Adds a RNA enum/pointer/string/ property item, and exposes it into the layout. Button input would suggest values from the search property collection, input must match a suggested value.

Parameters

searchprop Collection property in searchptr from where to take input values.

Definition at line 2796 of file interface_layout.cc.

References blender::StringRefNull::c_str(), name, prop(), prop_search(), ptr, RNA_struct_find_property(), RNA_struct_identifier(), RNA_warning, and PointerRNA::type.

◆ prop_search() [2/2]

void uiLayout::prop_search	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		PointerRNA *	searchptr,
		PropertyRNA *	searchprop,
		PropertyRNA *	item_searchpropname,
		std::optional< blender::StringRefNull >	name,
		int	icon,
		bool	results_are_suggestions )

Adds a RNA enum/pointer/string/ property item, and exposes it into the layout. Button input would suggest values from the search property collection.

Parameters

searchprop	Collection property in searchptr from where to take input values.
results_are_suggestions	Allow inputs that not match any suggested value.
item_searchpropname	The name of the string property in the collection items to use for searching (if unset, code will use RNA_struc.

Definition at line 2733 of file interface_layout.cc.

References block(), ELEM, name, prop(), PROP_COLLECTION, PROP_ENUM, PROP_POINTER, PROP_STRING, ptr, RNA_property_identifier(), RNA_property_pointer_type(), RNA_property_type(), RNA_property_ui_name(), RNA_struct_identifier(), RNA_struct_ui_icon(), RNA_warning, PointerRNA::type, uiItem::type(), ui_block_new_button_group(), ui_but_add_search(), ui_item_name_add_colon(), ui_item_rna_size(), ui_item_with_label(), UI_MAX_NAME_STR, UI_UNIT_X, use_property_split(), and w().

Referenced by blender::modifier::greasepencil::draw_layer_filter_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::nodes::draw_property_for_socket(), blender::modifier::greasepencil::draw_vertex_group_settings(), edbm_blend_from_shape_ui(), modifier_vgroup_ui(), blender::nodes::node_shader_normal_map_cc::node_shader_buts_normal_map(), blender::nodes::node_shader_tangent_cc::node_shader_buts_tangent(), blender::nodes::node_shader_uvmap_cc::node_shader_buts_uvmap(), blender::nodes::node_shader_vertex_color_cc::node_shader_buts_vertex_color(), blender::panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), prop_search(), and weightvg_ui_common().

◆ prop_tabs_enum()

void uiLayout::prop_tabs_enum	(	bContext *	C,
		PointerRNA *	ptr,
		PropertyRNA *	prop,
		PointerRNA *	ptr_highlight,
		PropertyRNA *	prop_highlight,
		bool	icon_only )

Expands enum property value items as tabs buttons.

Definition at line 3546 of file interface_layout.cc.

References block(), blender::ui::block_layout_set_current(), C, prop(), ptr, ui_item_enum_expand_tabs(), and UI_UNIT_Y.

◆ prop_with_menu()

void uiLayout::prop_with_menu	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index,
		int	value,
		eUI_Item_Flag	flag,
		std::optional< blender::StringRefNull >	name,
		int	icon,
		const char *	menu_type )

Adds a RNA property item, and sets a custom menu to expose its value.

Definition at line 2444 of file interface_layout.cc.

References block(), blender::StringRefNull::c_str(), flag, i, Menu, name, prop(), ptr, RNA_property_identifier(), RNA_struct_identifier(), RNA_warning, uiBut::rnaprop, uiBut::type, ui_but_rna_menu_convert_to_menu_type(), and ui_item_disabled().

◆ prop_with_popover()

void uiLayout::prop_with_popover	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index,
		int	value,
		eUI_Item_Flag	flag,
		std::optional< blender::StringRefNull >	name,
		int	icon,
		const char *	panel_type )

Adds a RNA property item, and sets a custom popover to expose its value.

Definition at line 2415 of file interface_layout.cc.

References block(), blender::StringRefNull::c_str(), Color, ELEM, flag, i, Menu, name, prop(), ptr, RNA_property_identifier(), RNA_struct_identifier(), RNA_warning, uiBut::rnaprop, uiBut::type, ui_but_rna_menu_convert_to_panel_type(), and ui_item_disabled().

◆ props_enum()

void uiLayout::props_enum	(	PointerRNA *	ptr,
		blender::StringRefNull	propname )

Expands enum property value items as radio buttons.

Definition at line 2555 of file interface_layout.cc.

References block(), blender::StringRefNull::c_str(), column(), uiBut::drawflag, free(), i, MEM_freeN(), name, prop(), PROP_ENUM, ptr, RNA_property_enum_items_gettexted(), RNA_property_type(), RNA_struct_find_property(), RNA_struct_identifier(), RNA_warning, split(), split(), UI_BUT_TEXT_LEFT, ui_but_tip_from_enum_item(), ui_item_disabled(), and uiLayout().

Referenced by menu_item_enum_rna_menu().

◆ red_alert()

bool uiLayout::red_alert ( ) const

inlinenodiscard

Definition at line 760 of file UI_interface_layout.hh.

References redalert_.

Referenced by prop(), red_alert_set(), uiItem_simple(), and uiItemFullO_ptr_ex().

◆ red_alert_set()

void uiLayout::red_alert_set ( bool red_alert )

inline

When set to true new items added in the layout are highlighted with the error state color TH_REDALERT.

Definition at line 764 of file UI_interface_layout.hh.

References red_alert(), and redalert_.

Referenced by draw_constraint_header(), graph_panel_driverVar__singleProp(), modifier_panel_header(), and shaderfx_panel_header().

◆ resolve()

void uiLayout::resolve ( )

protected

Definition at line 5383 of file interface_layout.cc.

References active, align(), block(), blender::ui::ItemInternal::box_item(), blender::ui::ItemInternal::box_item_set(), uiButtonItem::but, uiBut::drawflag, enabled, items(), resolve(), resolve_impl(), UI_BUT_BOX_ITEM, UI_BUT_DISABLED, UI_BUT_INACTIVE, ui_item_align(), ui_item_flag(), uiItem::uiItem(), and uiLayout().

Referenced by blender::ui::LayoutInternal::layout_resolve(), and resolve().

◆ resolve_impl()

void uiLayout::resolve_impl ( )

protectedvirtual

Reimplemented in LayoutAbsolute, LayoutColumn, LayoutOverlap, LayoutRadial, LayoutRootPieMenu, LayoutRow, uiLayoutItemBx, uiLayoutItemFlow, uiLayoutItemGridFlow, uiLayoutItemPanelBody, uiLayoutItemPanelHeader, and uiLayoutItemSplit.

Definition at line 3998 of file interface_layout.cc.

Referenced by resolve().

◆ root()

uiLayoutRoot * uiLayout::root ( ) const

nodiscard

◆ root_panel()

Panel * uiLayout::root_panel ( ) const

nodiscard

Definition at line 5089 of file interface_layout.cc.

References block().

Referenced by blender::nodes::draw_geometry_nodes_operator_redo_ui(), panel(), uiLayoutItemPanelBody::resolve_impl(), and uiLayoutItemPanelHeader::resolve_impl().

◆ row() [1/2]

uiLayout & uiLayout::row ( bool align )

Add a new row sub-layout, items placed in this sub-layout are added horizontally next to each other in row.

Definition at line 4777 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), root_, space_, and uiLayout().

◆ row() [2/2]

uiLayout & uiLayout::row	(	bool	align,
		blender::StringRef	heading )

Add a new row sub-layout, items placed in this sub-layout are added horizontally next to each other in row.

Parameters

heading Heading label to set to the first child element added in the sub-layout through uiLayout::prop. When property split is used, this heading label is set in the split label column when there is no label defined.

Definition at line 4891 of file interface_layout.cc.

References align(), heading(), heading_, row(), and uiLayout().

◆ scale_x()

float uiLayout::scale_x ( ) const

inlinenodiscard

Definition at line 778 of file UI_interface_layout.hh.

References scale_.

Referenced by estimate(), and ui_text_icon_width_ex().

◆ scale_x_set()

void uiLayout::scale_x_set ( float scale )

inline

Definition at line 782 of file UI_interface_layout.hh.

References scale_.

Referenced by file_panel_execution_cancel_button(), file_panel_execution_execute_button(), and blender::ui::template_asset_shelf_popover().

◆ scale_y()

float uiLayout::scale_y ( ) const

inlinenodiscard

Definition at line 787 of file UI_interface_layout.hh.

References scale_.

Referenced by estimate().

◆ scale_y_set()

void uiLayout::scale_y_set ( float scale )

inline

Definition at line 791 of file UI_interface_layout.hh.

References scale_.

Referenced by block_create__close_file_dialog(), ED_region_header_layout(), ED_time_scrub_channel_search_draw(), file_overwrite_detailed_info_show(), file_panel_execution_buttons_draw(), blender::ui::template_asset_shelf_popover(), ui_alert_create(), and wm_block_dialog_create().

◆ search_weight()

float uiLayout::search_weight ( ) const

inlinenodiscard

Definition at line 769 of file UI_interface_layout.hh.

References search_weight_.

◆ search_weight_set()

void uiLayout::search_weight_set ( float weight )

inline

Definition at line 773 of file UI_interface_layout.hh.

References search_weight_.

◆ separator()

void uiLayout::separator	(	float	factor = 1.0f,
		LayoutSeparatorType	type = LayoutSeparatorType::Auto )

Adds a separator item, that adds empty space between items.

Definition at line 3252 of file interface_layout.cc.

References Auto, block(), blender::ui::block_layout_set_current(), uiButSeparatorLine::is_vertical, Line, Sepr, SeprLine, uiItem::type(), UI_block_can_add_separator(), ui_block_is_menu(), ui_block_is_pie_menu(), UI_SCALE_FAC, UI_UNIT_Y, uiDefBut(), and w_.

Referenced by blender::ed::asset::shelf::add_catalog_tabs(), blender::ed::asset::shelf::asset_shelf_header_draw(), block_create__close_file_dialog(), block_create_autorun_warning(), block_create_save_file_overwrite_dialog(), blender::ed::geometry::catalog_assets_draw(), blender::ed::object::catalog_assets_draw(), blender::ed::geometry::catalog_assets_draw_unassigned(), colorband_tools_fn(), constraint_ops_extra_draw(), create_title_button(), draw_constraint_header(), ED_region_header_layout(), ED_screens_footer_tools_menu_create(), ED_screens_header_tools_menu_create(), edbm_bevel_ui(), edbm_intersect_boolean_ui(), edbm_intersect_ui(), file_overwrite_detailed_info_show(), fmodifier_influence_draw(), fmodifier_panel_header(), geometry_panel_draw(), gpencil_shaderfx_ops_extra_draw(), graph_draw_driver_settings_panel(), graph_panel_drivers_popover(), image_save_as_draw(), insert_key_menu_invoke(), modifier_ops_extra_draw(), blender::seq::modifier_panel_header(), modifier_panel_header(), move_to_collection_menu_create(), blender::ed::object::move_to_collection_menu_draw(), blender::ed::object::move_to_collection_menu_draw(), nla_panel_animdata(), nla_panel_properties(), blender::ed::space_node::node_catalog_assets_draw(), blender::nodes::node_shader_script_cc::node_shader_buts_script_ex(), blender::ed::space_node::node_update_basis_from_declaration(), op_enum_items(), blender::ed::outliner::outliner_operator_menu(), blender::ed::outliner::outliner_orphans_purge_ui(), blender::panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), panel_draw(), preferences_extension_repo_add_ui(), recent_files_menu_draw(), blender::ed::object::root_catalogs_draw(), blender::ed::space_node::root_catalogs_draw(), screen_area_menu_items(), screen_area_options_invoke(), screen_area_touch_menu_create(), screen_user_menu_draw(), blender::ed::vse::sequencer_add_catalog_assets_draw(), blender::ed::vse::sequencer_add_draw(), blender::ed::vse::sequencer_add_scene_draw(), blender::ed::vse::sequencer_split_ui(), shaderfx_panel_header(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), subdivisions_panel_draw(), template_keymap_item_properties(), ui_alert_create(), ui_def_but_rna__menu(), ui_imageuser_layer_menu(), ui_imageuser_pass_menu(), ui_imageuser_slot_menu(), ui_imageuser_view_menu_multiview(), ui_imageuser_view_menu_rr(), ui_item_enum_expand_exec(), blender::ed::space_node::ui_node_draw_input(), ui_paneltype_draw_impl(), ui_popup_context_menu_for_button(), UI_popup_menu_reports(), uiTemplateColorPicker(), uiTemplateEventFromKeymapItem(), uiTemplateImage(), uiTemplateInputStatus(), uiTemplateInputStatus3DView(), uiTemplateInputStatusAzone(), uiTemplateInputStatusBorder(), uiTemplateInputStatusHeader(), uiTemplateStatusBarModalItem(), uiTemplateStatusInfo(), blender::ed::object::unassigned_assets_draw(), uv_pack_islands_ui(), wm_block_about_create(), wm_block_create_redo(), wm_block_dialog_create(), wm_block_insert_unicode_create(), wm_block_splash_create(), wm_clear_recent_files_ui(), workspace_add_invoke(), and workspace_add_menu().

◆ separator_spacer()

void uiLayout::separator_spacer ( )

Adds a spacer item that inserts empty horizontal space between other items in the layout.

Definition at line 3342 of file interface_layout.cc.

References block(), blender::ui::block_layout_set_current(), printf, SeprSpacer, ui_block_is_popup_any(), UI_DIR_RIGHT, UI_UNIT_X, UI_UNIT_Y, and uiDefBut().

Referenced by blender::ed::asset::shelf::asset_shelf_header_draw(), buttons_panel_context_draw(), and blender::ed::spreadsheet::spreadsheet_footer_region_draw().

◆ split()

uiLayout & uiLayout::split	(	float	percentage,
		bool	align )

Add a new split sub-layout, items placed in this sub-layout are added horizontally next to each other in row, but width is splitted between the first item and remaining items.

Parameters

percentage Width percent to split.

Definition at line 5051 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), root_, split(), and uiLayout().

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), blender::nodes::add_layer_name_search_button(), block_create__close_file_dialog(), block_create_autorun_warning(), block_create_save_file_overwrite_dialog(), blender::nodes::node_composite_colorbalance_cc::cmp_node_colorbalance_declare(), blender::seq::colorBalance_panel_draw(), colorband_buttons_layout(), curvemap_buttons_layout(), blender::nodes::draw_named_attributes_panel(), blender::nodes::draw_property_for_output_socket(), blender::ed::space_node::node_buts_image_user(), op_enum_items(), panel_draw(), props_enum(), split(), blender::ed::space_node::std_node_socket_draw(), ui_alert_create(), ui_def_but_rna__menu(), UI_popup_block_template_confirm_op(), blender::ed::space_node::ui_template_node_link_menu(), uiItemPropertySplitWrapperCreate(), uiItemsAlertBox(), uiTemplateAnyID(), uiTemplateMovieClip(), undo_history_draw_menu(), v3d_transform_butsR(), view3d_panel_curve_data(), wm_block_insert_unicode_create(), and wm_block_splash_create().