#include <functional>
#include <optional>
#include "BLI_math_vector_types.hh"
#include "BLI_string_ref.hh"
#include "BLI_utility_mixins.hh"
#include "BLI_vector.hh"
#include "UI_interface_icons.hh"
#include "UI_interface_types.hh"

Classes
struct	PanelLayout
struct	uiItem
struct	uiLayout
struct	uiPropertySplitWrapper

Namespaces
namespace	blender
namespace	blender::ui
namespace	blender::wm

Macros
#define	UI_ITEM_NONE eUI_Item_Flag(0)

Enumerations
enum class	LayoutSeparatorType : int8_t { Auto , Space , Line }
enum class	NodeAssetMenuOperatorType : int8_t { Add , Swap }
enum class	blender::ui::LayoutDirection : int8_t { blender::ui::Horizontal = 0 , blender::ui::Vertical = 1 }
enum class	blender::ui::LayoutType : int8_t { blender::ui::Panel = 0 , blender::ui::Header = 1 , blender::ui::Menu = 2 , blender::ui::Toolbar = 3 , blender::ui::PieMenu = 4 , blender::ui::VerticalBar = 5 }
enum class	blender::ui::LayoutAlign : int8_t { blender::ui::Expand = 0 , blender::ui::Left = 1 , blender::ui::Center = 2 , blender::ui::Right = 3 }
enum class	blender::ui::ButProgressType : int8_t { blender::ui::Bar = 0 , blender::ui::Ring = 1 }
enum	eUI_Item_Flag : uint16_t { UI_ITEM_R_EXPAND = 1 << 1 , UI_ITEM_R_SLIDER = 1 << 2 , UI_ITEM_R_TOGGLE = 1 << 3 , UI_ITEM_R_ICON_NEVER = 1 << 4 , UI_ITEM_R_ICON_ONLY = 1 << 5 , UI_ITEM_R_EVENT = 1 << 6 , UI_ITEM_R_FULL_EVENT = 1 << 7 , UI_ITEM_R_NO_BG = 1 << 8 , UI_ITEM_R_IMMEDIATE = 1 << 9 , UI_ITEM_O_DEPRESS = 1 << 10 , UI_ITEM_R_COMPACT = 1 << 11 , UI_ITEM_R_CHECKBOX_INVERT = 1 << 12 , UI_ITEM_R_FORCE_BLANK_DECORATE = 1 << 13 , UI_ITEM_R_SPLIT_EMPTY_NAME = 1 << 14 , UI_ITEM_R_TEXT_BUT_FORCE_SEMI_MODAL_ACTIVE = 1 << 15 }

Functions
uiLayout &	blender::ui::block_layout (uiBlock block, LayoutDirection direction, LayoutType type, int x, int y, int size, int em, int padding, const uiStyle style)
int2	blender::ui::block_layout_resolve (uiBlock *block)
void	blender::ui::block_layout_set_current (uiBlock block, uiLayout layout)
bool	blender::ui::block_layout_needs_resolving (const uiBlock *block)
void	blender::ui::block_layout_free (uiBlock *block)
bool	UI_block_apply_search_filter (uiBlock block, const char search_filter)
void	uiLayoutSetFunc (uiLayout layout, uiMenuHandleFunc handlefunc, void argv)
void	uiLayoutSetTooltipFunc (uiLayout layout, uiButToolTipFunc func, void arg, uiCopyArgFunc copy_arg, uiFreeArgFunc free_arg)
void	uiLayoutSetTooltipCustomFunc (uiLayout layout, uiButToolTipCustomFunc func, void arg, uiCopyArgFunc copy_arg, uiFreeArgFunc free_arg)
void	UI_menutype_draw (bContext C, MenuType mt, uiLayout *layout)
void	UI_paneltype_draw (bContext C, PanelType pt, uiLayout *layout)
int	uiLayoutListItemPaddingWidth ()
void	uiLayoutListItemAddPadding (uiLayout *layout)
bool	uiLayoutEndsWithPanelHeader (const uiLayout &layout)
uiPropertySplitWrapper	uiItemPropertySplitWrapperCreate (uiLayout *parent_layout)
uiBut *	uiItemL_ex (uiLayout *layout, blender::StringRef name, int icon, bool highlight, bool redalert)
uiLayout *	uiItemL_respect_property_split (uiLayout *layout, blender::StringRef text, int icon)
void	uiItemLDrag (uiLayout layout, PointerRNA ptr, blender::StringRef name, int icon)
const char *	UI_layout_introspect (uiLayout *layout)
uiLayout *	uiItemsAlertBox (uiBlock block, const uiStyle style, const int dialog_width, const eAlertIcon icon, const int icon_size)
uiLayout *	uiItemsAlertBox (uiBlock *block, const int size, const eAlertIcon icon)

Macro Definition Documentation

◆ UI_ITEM_NONE

#define UI_ITEM_NONE eUI_Item_Flag(0)

Definition at line 904 of file UI_interface_layout.hh.

Enumeration Type Documentation

◆ eUI_Item_Flag

enum eUI_Item_Flag : uint16_t

Enumerator
UI_ITEM_R_EXPAND
UI_ITEM_R_SLIDER
UI_ITEM_R_TOGGLE	Use for booleans, causes the button to draw with an outline (emboss), instead of text with a checkbox. This is implied when toggle buttons have an icon unless UI_ITEM_R_ICON_NEVER flag is set.
UI_ITEM_R_ICON_NEVER	Don't attempt to use an icon when the icon is set to #ICON_NONE. Use for booleans, causes the buttons to always show as a checkbox even when there is an icon (which would normally show the button as a toggle).
UI_ITEM_R_ICON_ONLY
UI_ITEM_R_EVENT
UI_ITEM_R_FULL_EVENT
UI_ITEM_R_NO_BG
UI_ITEM_R_IMMEDIATE
UI_ITEM_O_DEPRESS
UI_ITEM_R_COMPACT
UI_ITEM_R_CHECKBOX_INVERT
UI_ITEM_R_FORCE_BLANK_DECORATE	Don't add a real decorator item, just blank space.
UI_ITEM_R_SPLIT_EMPTY_NAME
UI_ITEM_R_TEXT_BUT_FORCE_SEMI_MODAL_ACTIVE	Only for text buttons (for now): Force the button as active in a semi-modal state (capturing text input while leaving the remaining UI interactive).

Definition at line 867 of file UI_interface_layout.hh.

◆ LayoutSeparatorType

enum class LayoutSeparatorType : int8_t

strong

Enumerator
Auto
Space
Line

Definition at line 86 of file UI_interface_layout.hh.

◆ NodeAssetMenuOperatorType

enum class NodeAssetMenuOperatorType : int8_t

strong

Enumerator
Add
Swap

Definition at line 92 of file UI_interface_layout.hh.

Function Documentation

◆ UI_block_apply_search_filter()

bool UI_block_apply_search_filter	(	uiBlock *	block,
		const char *	search_filter )

Apply property search behavior, setting panel flags and deactivating buttons that don't match.

Note: Must not be run after #UI_block_layout_resolve.

Definition at line 5241 of file interface_layout.cc.

References block_search_filter_tag_buttons(), block_search_panel_label_matches(), PanelType::flag, uiBlock::panel, PANEL_TYPE_NO_SEARCH, Panel::type, and ui_panel_tag_search_filter_match().

Referenced by ed_panel_draw(), and panel_property_search().

◆ UI_layout_introspect()

const char * UI_layout_introspect ( uiLayout * layout )

Evaluate layout items as a Python dictionary.

Definition at line 6102 of file interface_layout.cc.

References BLI_dynstr_free(), BLI_dynstr_get_cstring(), BLI_dynstr_new(), result, and ui_layout_introspect_items().

Referenced by bpy_rna_uilayout_introspect().

◆ UI_menutype_draw()

void UI_menutype_draw	(	bContext *	C,
		MenuType *	mt,
		uiLayout *	layout )

Definition at line 5865 of file interface_layout.cc.

References uiLayout::block(), C, uiLayout::context(), CTX_store_get(), CTX_store_set(), MenuType::draw, bContextStore::entries, Vector< T, InlineBufferCapacity, Allocator >::extend(), MenuType::flag, G, G_DEBUG_WM, MenuType::idname, Menu::layout, MenuType::listener, printf, SearchOnKeyPress, Menu::type, ui_block_add_dynamic_listener(), UI_block_flag_enable(), and UI_BLOCK_NO_ACCELERATOR_KEYS.

Referenced by blender::ed::asset_browser::AssetCatalogTreeViewItem::build_context_menu(), blender::ed::object::shapekey::ShapeKeyItem::build_context_menu(), blender::ui::bonecollections::BoneCollectionItem::build_context_menu(), blender::ui::greasepencil::LayerGroupViewItem::build_context_menu(), uiLayout::menu_contents(), menu_items_from_ui_create(), ui_item_menu_hold(), ui_item_menutype_func(), UI_pie_menu_invoke(), ui_popup_context_menu_for_button(), UI_popup_menu_invoke(), wm_block_about_create(), and wm_block_splash_create().

◆ UI_paneltype_draw()

void UI_paneltype_draw	(	bContext *	C,
		PanelType *	pt,
		uiLayout *	layout )

Used for popup panels only.

Definition at line 5981 of file interface_layout.cc.

References C, uiLayout::context(), CTX_store_set(), and ui_paneltype_draw_impl().

Referenced by ui_item_paneltype_func(), and UI_popover_panel_invoke().

◆ uiItemL_ex()

uiBut * uiItemL_ex	(	uiLayout *	layout,
		blender::StringRef	name,
		int	icon,
		bool	highlight,
		bool	redalert )

Definition at line 3171 of file interface_layout.cc.

References name, UI_but_flag_enable(), UI_BUT_REDALERT, UI_SELECT_DRAW, and uiItem_simple().

Referenced by block_create__close_file_dialog(), block_create_autorun_warning(), block_create_save_file_overwrite_dialog(), blender::ed::object::shapekey::ShapeKeyItem::build_row(), blender::ui::bonecollections::BoneCollectionItem::build_row(), blender::ui::template_breadcrumbs(), ui_alert_create(), uiTemplateInputStatus(), wm_block_about_create(), wm_block_create_redo(), wm_block_dialog_create(), and wm_block_insert_unicode_create().

◆ uiItemL_respect_property_split()

uiLayout * uiItemL_respect_property_split	(	uiLayout *	layout,
		blender::StringRef	text,
		int	icon )

Helper to add a label using a property split layout if needed. After calling this the active layout will be the one to place the labeled items in. An additional layout may be returned to place decorator buttons in.

Returns: the layout to place decorators in, if #UI_ITEM_PROP_SEP is enabled. Otherwise null.

Definition at line 3211 of file interface_layout.cc.

References uiLayout::block(), blender::ui::block_layout_set_current(), uiPropertySplitWrapper::decorate_column, uiPropertySplitWrapper::label_column, uiPropertySplitWrapper::property_row, ui_item_name_add_colon(), UI_MAX_NAME_STR, uiItem_simple(), uiItemPropertySplitWrapperCreate(), and uiLayout::use_property_split().

Referenced by draw_matrix_template(), graph_panel_key_properties(), template_ID(), template_search_buttons(), ui_item_with_label(), and ui_layout_heading_label_add().

◆ uiItemLDrag()

void uiItemLDrag	(	uiLayout *	layout,
		PointerRNA *	ptr,
		blender::StringRef	name,
		int	icon )

Label icon for dragging.

Definition at line 3231 of file interface_layout.cc.

References name, ptr, RNA_struct_is_ID(), UI_but_drag_set_id(), and uiItem_simple().

Referenced by buttons_panel_context_draw().

◆ uiItemPropertySplitWrapperCreate()

uiPropertySplitWrapper uiItemPropertySplitWrapperCreate ( uiLayout * parent_layout )

Normally, we handle the split layout in uiLayout::prop(), but there are other cases where the logic is needed. Ideally, uiLayout::prop() could just call this, but it currently has too many special needs.

The returned #uiPropertySplitWrapper.decorator_column may be null when decorators are disabled (#uiLayoutGetPropDecorate() returns false).

Definition at line 3193 of file interface_layout.cc.

References uiLayout::alignment_set(), uiLayout::column(), uiPropertySplitWrapper::decorate_column, uiPropertySplitWrapper::label_column, uiPropertySplitWrapper::property_row, blender::ui::Right, uiLayout::row(), uiLayout::split(), UI_ITEM_PROP_SEP_DIVIDE, blender::ui::LayoutInternal::ui_item_prop_split_layout_hack(), and uiLayout::use_property_decorate().

Referenced by blender::ed::space_node::ui_node_draw_input(), and uiItemL_respect_property_split().

◆ uiItemsAlertBox() [1/2]

uiLayout * uiItemsAlertBox	(	uiBlock *	block,
		const int	size,
		const eAlertIcon	icon )

Definition at line 6173 of file interface_layout.cc.

References uiFontStyle::points, size(), UI_SCALE_FAC, UI_style_get_dpi(), uiItemsAlertBox(), and uiStyle::widget.

◆ uiItemsAlertBox() [2/2]

uiLayout * uiItemsAlertBox	(	uiBlock *	block,
		const uiStyle *	style,
		const int	dialog_width,
		const eAlertIcon	icon,
		const int	icon_size )

Helpers to add a big icon and create a split layout for alert popups. Returns the layout to place further items into the alert box.

Definition at line 6118 of file interface_layout.cc.

References ALERT_ICON_ERROR, ALERT_ICON_INFO, ALERT_ICON_QUESTION, ALERT_ICON_WARNING, uiBlock::alert_level, uiLayout::alignment_set(), blender::ui::block_layout(), uiLayout::column(), uiStyle::columnspace, Error, float, Info, blender::ui::Left, None, blender::ui::Panel, uiLayout::row(), uiLayout::split(), UI_SCALE_FAC, uiDefButAlert(), blender::ui::Vertical, and Warning.

Referenced by block_create__close_file_dialog(), block_create_autorun_warning(), block_create_save_file_overwrite_dialog(), ui_alert_create(), uiItemsAlertBox(), and wm_block_dialog_create().

◆ uiLayoutEndsWithPanelHeader()

bool uiLayoutEndsWithPanelHeader ( const uiLayout & layout )

Definition at line 4882 of file interface_layout.cc.

References uiLayout::items(), and uiItem::type().

Referenced by ed_panel_draw().

◆ uiLayoutListItemAddPadding()

void uiLayoutListItemAddPadding ( uiLayout * layout )

Definition at line 5107 of file interface_layout.cc.

References uiLayout::block(), blender::ui::block_layout_set_current(), uiItem::fixed_size_set(), uiLayout::row(), Sepr, uiDefBut(), and uiLayoutListItemPaddingWidth().

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

◆ uiLayoutListItemPaddingWidth()

int uiLayoutListItemPaddingWidth ( )

Definition at line 5102 of file interface_layout.cc.

References UI_SCALE_FAC.

Referenced by uiLayoutListItemAddPadding().

◆ uiLayoutSetFunc()

void uiLayoutSetFunc	(	uiLayout *	layout,
		uiMenuHandleFunc	handlefunc,
		void *	argv )

Definition at line 5648 of file interface_layout.cc.

References uiLayoutRoot::argv, uiLayoutRoot::handlefunc, and uiLayout::root().

◆ uiLayoutSetTooltipCustomFunc()

void uiLayoutSetTooltipCustomFunc	(	uiLayout *	layout,
		uiButToolTipCustomFunc	func,
		void *	arg,
		uiCopyArgFunc	copy_arg,
		uiFreeArgFunc	free_arg )

Same as above but should be used when building a fully custom tooltip instead of just generating a description.

Definition at line 5779 of file interface_layout.cc.

References uiButtonItem::but, Decorator, uiLayout::items(), uiBut::type, UI_but_func_tooltip_custom_set(), and uiLayoutSetTooltipCustomFunc().

Referenced by blender::ed::space_node::node_socket_add_tooltip(), blender::ed::space_node::node_socket_add_tooltip_in_node_editor(), and uiLayoutSetTooltipCustomFunc().

◆ uiLayoutSetTooltipFunc()

void uiLayoutSetTooltipFunc	(	uiLayout *	layout,
		uiButToolTipFunc	func,
		void *	arg,
		uiCopyArgFunc	copy_arg,
		uiFreeArgFunc	free_arg )

Set tooltip function for all buttons in the layout. func, arg and free_arg are passed on to UI_but_func_tooltip_set, so their meaning is the same.

Parameters

func	The callback function that gets called to get tooltip content
arg	An optional opaque pointer that gets passed to func
free_arg	An optional callback for freeing arg (can be set to e.g. MEM_freeN)
copy_arg	An optional callback for duplicating arg in case UI_but_func_tooltip_set is being called on multiple buttons (can be set to e.g. MEM_dupallocN). If set to NULL, arg will be passed as-is to all buttons.

Definition at line 5744 of file interface_layout.cc.

References uiButtonItem::but, Decorator, uiLayout::items(), uiBut::type, UI_but_func_tooltip_set(), and uiLayoutSetTooltipFunc().

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

Classes

Namespaces

Macros

Enumerations

Functions