Blender V5.3
interface_layout.cc File Reference
#include <algorithm>
#include <cmath>
#include <cstdlib>
#include <cstring>
#include <fmt/format.h>
#include "MEM_guardedalloc.h"
#include "DNA_screen_types.h"
#include "DNA_userdef_types.h"
#include "BLI_array.hh"
#include "BLI_dynstr.hh"
#include "BLI_enum_flags.hh"
#include "BLI_listbase.hh"
#include "BLI_math_base_c.hh"
#include "BLI_path_utils.hh"
#include "BLI_rect.hh"
#include "BLI_string_ref.hh"
#include "BLI_string_utf8.hh"
#include "BLT_translation.hh"
#include "BKE_context.hh"
#include "BKE_global.hh"
#include "BKE_idprop.hh"
#include "BKE_lib_id.hh"
#include "BKE_path_templates.hh"
#include "BKE_screen.hh"
#include "IMB_imbuf_types.hh"
#include "RNA_access.hh"
#include "RNA_prototypes.hh"
#include "UI_interface_layout.hh"
#include "ED_id_management.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "buttons/interface_label.hh"
#include "buttons/interface_label_markdown.hh"
#include "buttons/interface_textbox.hh"
#include "interface_intern.hh"

Go to the source code of this file.

Classes

struct  blender::ui::LayoutRoot
struct  blender::ui::ItemInternal
struct  blender::ui::LayoutInternal
struct  blender::ui::ButtonItem
struct  blender::ui::LayoutRow
struct  blender::ui::LayoutColumn
struct  blender::ui::LayoutRootPieMenu
struct  blender::ui::LayoutOverlap
struct  blender::ui::LayoutRadial
struct  blender::ui::LayoutAbsolute
struct  blender::ui::LayoutItemFlow
struct  blender::ui::LayoutItemGridFlow
struct  blender::ui::LayoutItemBx
struct  blender::ui::LayoutItemPanelHeader
struct  blender::ui::LayoutItemPanelBody
struct  blender::ui::LayoutItemSplit
struct  blender::ui::TextIconPadFactor
struct  blender::ui::MenuItemLevel
struct  blender::ui::UILayoutGridFlowInput
struct  blender::ui::UILayoutGridFlowOutput

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::ui

Macros

#define UI_PROP_DECORATE
#define UI_PROP_SEP_ICON_WIDTH_EXCEPTION
#define CASE_ITEM(type, name)

Functions

Button Items
static void blender::ui::item_disabled (Layout *layout, const char *name)
static void blender::ui::but_tip_from_enum_item (Button *but, const EnumPropertyItem *item)
static Button * blender::ui::uiItemFullO_ptr_ex (Layout *layout, wmOperatorType *ot, std::optional< StringRef > name, int icon, const wm::OpCallContext context, const eUI_Item_Flag flag, PointerRNA *r_opptr)
static void blender::ui::item_menu_hold (bContext *C, ARegion *butregion, Button *but)
BLI_INLINE bool blender::ui::layout_is_radial (const Layout *layout)
static void blender::ui::item_rna_size (Layout *layout, StringRef name, int icon, PointerRNA *ptr, PropertyRNA *prop, int index, bool icon_only, bool compact, int *r_w, int *r_h)
static bool blender::ui::item_rna_is_expand (PropertyRNA *prop, int index, const eUI_Item_Flag item_flag)
static Layout * blender::ui::layout_heading_find (Layout *cur_layout)
static void blender::ui::layout_heading_label_add (Layout *layout, Layout *heading_layout, bool right_align, bool respect_prop_split)
static void blender::ui::search_id_collection (StructRNA *ptype, PointerRNA *r_ptr, PropertyRNA **r_prop)
static void blender::ui::rna_collection_search_arg_free_fn (void *ptr)
void blender::ui::button_configure_search (Button *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, PropertyRNA *item_searchprop, bool results_are_suggestions)
void blender::ui::item_menutype_func (bContext *C, Layout *layout, void *arg_mt)
void blender::ui::item_paneltype_func (bContext *C, Layout *layout, void *arg_pt)
static Button * blender::ui::item_menu (Layout *layout, const StringRef name, int icon, MenuCreateFunc func, void *arg, void *argN, const std::optional< StringRef > tip, bool force_menu, ButtonArgNFree func_argN_free_fn=MEM_delete_void, ButtonArgNCopy func_argN_copy_fn=MEM_dupalloc_void)
static Button * blender::ui::uiItem_simple (Layout *layout, const StringRef name, int icon, std::optional< StringRef > tooltip=std::nullopt, const ButtonType but_type=ButtonType::Label)
Button * blender::ui::uiItemL_ex (Layout *layout, StringRef name, int icon, bool highlight, bool redalert)
static ButtonImage * blender::ui::image_find_in_old_block (Block *block, const StringRef key)
PropertySplitWrapper blender::ui::uiItemPropertySplitWrapperCreate (Layout *parent_layout)
Layout * blender::ui::uiItemL_respect_property_split (Layout *layout, StringRef text, int icon)
void blender::ui::uiItemLDrag (Layout *layout, PointerRNA *ptr, StringRef name, int icon)
static int blender::ui::menu_item_enum_opname_menu_active (bContext *C, Button *but, MenuItemLevel *lvl)
static void blender::ui::menu_item_enum_opname_menu (bContext *C, Layout *layout, void *arg)
static void blender::ui::menu_item_enum_rna_menu (bContext *, Layout *layout, void *arg)
Special RNA Items
static Layout * blender::ui::item_local_sublayout (Layout *test, Layout *layout, bool align)
static void blender::ui::layer_but_cb (bContext *C, void *arg_but, void *arg_index)
static void blender::ui::item_array (Layout *layout, Block *block, const StringRef name, int icon, PointerRNA *ptr, PropertyRNA *prop, const int len, int x, const int y, int w, const int, const bool expand, const bool slider, const int toggle, const bool icon_only, const bool compact, const bool show_text)
static void blender::ui::item_enum_expand_handle (bContext *C, void *arg1, void *arg2)
static void blender::ui::item_enum_expand_elem_exec (Layout *layout, Block *block, PointerRNA *ptr, PropertyRNA *prop, const std::optional< StringRef > uiname, const int h, const ButtonType but_type, const bool icon_only, const EnumPropertyItem *item, const bool is_first)
static void blender::ui::item_enum_expand_exec (Layout *layout, Block *block, PointerRNA *ptr, PropertyRNA *prop, const std::optional< StringRef > uiname, const int h, const ButtonType but_type, const bool icon_only)
static void blender::ui::item_enum_expand (Layout *layout, Block *block, PointerRNA *ptr, PropertyRNA *prop, const std::optional< StringRef > uiname, const int h, const bool icon_only)
static void blender::ui::item_enum_expand_tabs (Layout *layout, bContext *C, Block *block, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_highlight, PropertyRNA *prop_highlight, const std::optional< StringRef > uiname, const int h, const bool icon_only, EnumTabExpand expand_as)
static void blender::ui::keymap_but_cb (bContext *, void *but_v, void *)
static Button * blender::ui::item_with_label (Layout *layout, Block *block, const StringRef name, const int icon, PointerRNA *ptr, PropertyRNA *prop, const int index, const int x, const int y, const int w_hint, const int h, const int flag, std::optional< ButtonType > button_type_override, const char *caller_fn_name)
void blender::ui::context_active_but_prop_get_filebrowser (const bContext *C, PointerRNA *r_ptr, PropertyRNA **r_prop, bool *r_is_undo, bool *r_is_userdef)
Layout Items
static int blender::ui::litem_min_width (int itemw)
static int blender::ui::spaces_after_column_item (const Layout *litem, const Item *item, const Item *next_item, const bool is_box)
static RadialDirection blender::ui::get_radialbut_vec (float vec[2], short itemnum)
static bool blender::ui::item_is_radial_displayable (Item *item)
static bool blender::ui::item_is_radial_drawable (ButtonItem *bitem)
static void blender::ui::litem_grid_flow_compute (Span< Item * > items, const UILayoutGridFlowInput *parameters, UILayoutGridFlowOutput *results)
bool blender::ui::uiLayoutEndsWithPanelHeader (const Layout &layout)
static LayoutItemBx * blender::ui::layout_box (Layout *layout, ButtonType type)
void blender::ui::layout_list_set_labels_active (Layout *layout)
int blender::ui::uiLayoutListItemPaddingWidth ()
void blender::ui::uiLayoutListItemAddPadding (Layout *layout)
Block Layout Search Filtering
static bool blender::ui::block_search_panel_label_matches (const Block *block, const char *search_string)
static bool blender::ui::button_matches_search_filter (Button *but, const char *search_filter)
static bool blender::ui::button_group_has_search_match (const ButtonGroup &group, const char *search_filter)
static bool blender::ui::block_search_filter_tag_buttons (Block *block, const char *search_filter)
bool blender::ui::block_apply_search_filter (Block *block, const char *search_filter)
Layout
static void blender::ui::item_scale (Layout *litem, const float scale[2])
static void blender::ui::item_align (Layout *litem, short nr)
static void blender::ui::item_flag (Layout *litem, int64_t flag)
static void blender::ui::resolve_label_multiline (ButtonLabel *button)
static void blender::ui::resolve_image_height (Button *button)
static int2 blender::ui::layout_end (Layout *layout)
static void blender::ui::layout_free (Layout *layout)
static void blender::ui::layout_add_padding_button (LayoutRoot *root)
Layout & blender::ui::block_layout (Block *block, LayoutDirection direction, LayoutType type, int x, int y, int size, int em, int padding, const uiStyle *style)
void blender::ui::layout_add_but (Layout *layout, Button *but)
void blender::ui::layout_remove_but (Layout *layout, const Button *but)
bool blender::ui::layout_replace_but_ptr (Layout *layout, const void *old_but_ptr, Button *new_but)
void blender::ui::block_layout_set_current (Block *block, Layout *layout)
void blender::ui::block_layout_free (Block *block)
int2 blender::ui::block_layout_resolve (Block *block)
bool blender::ui::block_layout_needs_resolving (const Block *block)
void blender::ui::uiLayoutSetTooltipFunc (Layout *layout, ButtonToolTipFunc func, void *arg, CopyArgFunc copy_arg, FreeArgFunc free_arg)
void blender::ui::uiLayoutSetTooltipCustomFunc (Layout *layout, ButtonToolTipCustomFunc func, void *arg, CopyArgFunc copy_arg, FreeArgFunc free_arg)
wmOperatorType * blender::ui::button_operatortype_get_from_enum_menu (Button *but, PropertyRNA **r_prop)
MenuType * blender::ui::button_menutype_get (const Button *but)
PanelType * blender::ui::button_paneltype_get (const Button *but)
std::optional< StringRefNull > blender::ui::button_asset_shelf_type_idname_get (const Button *but)
void blender::ui::menutype_draw (bContext *C, MenuType *mt, Layout *layout)
static bool blender::ui::layout_has_panel_label (const Layout *layout, const PanelType *pt)
static void blender::ui::paneltype_draw_impl (bContext *C, PanelType *pt, Layout *layout, bool show_header)
void blender::ui::UI_paneltype_draw (bContext *C, PanelType *pt, Layout *layout)
Layout (Debugging/Introspection)

Serialize the layout as a Python compatible dictionary,

Note
Proper string escaping isn't used, triple quotes are used to prevent single quotes from interfering with Python syntax. If we want this to be fool-proof, we would need full Python compatible string escape support. As we don't use triple quotes in the UI it's good-enough in practice.
static void blender::ui::layout_introspect_button (fmt::appender ds, const ButtonItem *bitem)
static void blender::ui::layout_introspect_items (fmt::appender ds, Span< const Item * > items)
std::string blender::ui::layout_introspect (Layout *layout)
Alert Box with Big Icon
Layout * blender::ui::uiItemsAlertBox (Block *block, const uiStyle *style, const int dialog_width, const AlertIcon icon, const int icon_size)
Layout * blender::ui::uiItemsAlertBox (Block *block, const int size, const AlertIcon icon)

Structs and Defines

#define UI_OPERATOR_ERROR_RET(_ot, _opname, _caller_fn_name)
enum class  blender::ui::ItemType : int8_t {
  blender::ui::Button , blender::ui::LayoutRow , blender::ui::LayoutPanelHeader , blender::ui::LayoutPanelBody ,
  blender::ui::LayoutColumn , blender::ui::LayoutColumnFlow , blender::ui::LayoutRowFlow , blender::ui::LayoutGridFlow ,
  blender::ui::LayoutBox , blender::ui::LayoutAbsolute , blender::ui::LayoutSplit , blender::ui::LayoutOverlap ,
  blender::ui::LayoutRadial , blender::ui::LayoutRoot
}
enum class  blender::ui::ItemInternalFlag : uint8_t {
  blender::ui::AutoFixedSize = 1 << 0 , blender::ui::FixedSize = 1 << 1 , blender::ui::BoxItem = 1 << 2 , blender::ui::PropSep = 1 << 3 ,
  blender::ui::InsidePropSep = 1 << 4 , blender::ui::PropDecorate = 1 << 5 , blender::ui::PropDecorateNoPad = 1 << 6
}

Item

#define UI_ITEM_VARY_X   1
#define UI_ITEM_VARY_Y   2
constexpr TextIconPadFactor blender::ui::text_pad_default = {1.50f, 0.25f, 0.0f}
constexpr TextIconPadFactor blender::ui::text_pad_compact = {1.25f, 0.35f, 0.0f}
constexpr TextIconPadFactor blender::ui::text_pad_none = {0.25f, 1.50f, 0.0f}
static StringRef blender::ui::item_name_add_colon (StringRef name, char namestr[UI_MAX_NAME_STR])
static StringRefNull blender::ui::item_name_add_colon (StringRefNull name, char namestr[UI_MAX_NAME_STR])
static int blender::ui::item_fit (const int item, const int pos, const int all, const int available, const bool is_last, const LayoutAlign alignment, float *extra_pixel)
static int blender::ui::layout_vary_direction (Layout *layout)
static bool blender::ui::layout_variable_size (Layout *layout)
static int blender::ui::text_icon_width_ex (Layout *layout, const StringRef name, int icon, const TextIconPadFactor &pad_factor, const uiFontStyle *fstyle)
static int blender::ui::text_icon_width (Layout *layout, const StringRef name, const int icon, const bool compact)
static void blender::ui::item_position (Item *item, const int x, const int y, const int w, const int h)
static void blender::ui::item_translate_y (Item *item, const int delta)
static void blender::ui::item_move (Item *item, const int delta_xmin, const int delta_xmax)

Macro Definition Documentation

◆ CASE_ITEM

#define CASE_ITEM ( type,
name )
Value:
case type: { \
fmt::format_to(ds, "'type': '{}', ", name); \
break; \
} \
((void)0)

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

◆ UI_ITEM_VARY_X

#define UI_ITEM_VARY_X   1

◆ UI_ITEM_VARY_Y

#define UI_ITEM_VARY_Y   2

Definition at line 391 of file interface_layout.cc.

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

◆ UI_OPERATOR_ERROR_RET

#define UI_OPERATOR_ERROR_RET ( _ot,
_opname,
_caller_fn_name )
Value:
if (ot == nullptr) { \
item_disabled(this, _opname); \
RNA_warning_bare("%s: '%s' unknown operator", _caller_fn_name, _opname); \
return {}; \
} \
(void)0
Parameters
_caller_fn_nameA friendly function name of the caller for tracing layout item operator warnings, matching the RNA struct function name. For example "UILayout.operator()"

Definition at line 75 of file interface_layout.cc.

Referenced by blender::ui::Layout::op(), and blender::ui::Layout::op_menu_enum().

◆ UI_PROP_DECORATE

#define UI_PROP_DECORATE

Definition at line 62 of file interface_layout.cc.

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

◆ UI_PROP_SEP_ICON_WIDTH_EXCEPTION

#define UI_PROP_SEP_ICON_WIDTH_EXCEPTION

Definition at line 65 of file interface_layout.cc.