Blender V5.3
blender::ui::Layout Struct Reference

#include <UI_interface_layout.hh>

Inherits blender::ui::Item, blender::blender::NonCopyable, and blender::blender::NonMovable.

Inherited by blender::ui::LayoutAbsolute, blender::ui::LayoutColumn, blender::ui::LayoutItemFlow, blender::ui::LayoutItemGridFlow, blender::ui::LayoutItemPanelHeader, blender::ui::LayoutOverlap, blender::ui::LayoutRadial, blender::ui::LayoutRootPieMenu, and blender::ui::LayoutRow.

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)
LayoutAlign alignment () const
void alignment_set (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 prop_with_menu (PointerRNA *ptr, blender::StringRefNull propname, eUI_Item_Flag flag, std::optional< blender::StringRefNull > name, int icon, const char *menu_type)
LayoutRoot * root () const
const bContextStore * context () const
Layout * parent () const
StringRef heading () const
void heading_reset ()
Span< Item * > items () const
bool align () const
bool variable_size () const
EmbossType emboss_or_undefined () const
Structs and Defines
 Layout (ItemType type, LayoutRoot *root)
Special RNA Items
LayoutDirection local_direction () const
Button Items
void decorator (PointerRNA *ptr, PropertyRNA *prop, int index)
void decorator (PointerRNA *ptr, std::optional< StringRefNull > propname, int index)
void label (StringRef name, int icon)
void label_multiline (StringRefNull label, int icon, FontStyleAlign align=UI_STYLE_TEXT_LEFT, int max_lines=0)
void label_markdown (StringRef text)
bool image (StringRef key, FunctionRef< ImBuf *()> create_fn)
void link (StringRef url, StringRef name, int icon)
void menu (MenuType *mt, std::optional< StringRef > name, int icon)
void menu (StringRef menuname, std::optional< StringRef > name, int icon)
void menu_contents (StringRef menuname)
void menu_fn (StringRefNull name, int icon, MenuCreateFunc func, void *arg)
void menu_fn_argN_free (StringRefNull name, int icon, MenuCreateFunc func, void *argN)
PointerRNA op (wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
PointerRNA op (wmOperatorType *ot, std::optional< StringRef > name, int icon)
PointerRNA op (StringRefNull opname, std::optional< StringRef > name, int icon)
PointerRNA op (StringRefNull opname, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
void op_enum (StringRefNull opname, StringRefNull propname, IDProperty *properties, wm::OpCallContext context, eUI_Item_Flag flag, const int active=-1)
void op_enum (StringRefNull opname, StringRefNull propname)
void op_enum_items (wmOperatorType *ot, const PointerRNA &ptr, PropertyRNA *prop, IDProperty *properties, 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, StringRefNull propname, std::optional< StringRefNull > name, int icon)
PointerRNA op_menu_enum (const bContext *C, StringRefNull opname, StringRefNull propname, StringRefNull name, int icon)
PointerRNA op_menu_hold (wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag, const char *menu_id)
void progress_indicator (const char *text, float factor, ButProgressType progress_type)
void prop (PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
void prop (PointerRNA *ptr, StringRefNull propname, eUI_Item_Flag flag, std::optional< StringRef > name, int icon)
void popover (const bContext *C, PanelType *pt, std::optional< StringRef > name_opt, int icon)
void popover (const bContext *C, StringRef panel_type, std::optional< StringRef > name_opt, int icon, PopupAttachDirection direction=PopupAttachDirection::Vertical)
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< StringRefNull > name, int icon)
void prop_enum (PointerRNA *ptr, PropertyRNA *prop, const char *value, std::optional< StringRefNull > name, int icon)
void prop_enum (PointerRNA *ptr, StringRefNull propname, const char *value, std::optional< StringRefNull > name, int icon)
void prop_menu_enum (PointerRNA *ptr, PropertyRNA *prop, std::optional< StringRefNull > name, int icon)
void prop_tabs_enum (bContext *C, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *ptr_highlight, PropertyRNA *prop_highlight, bool icon_only, EnumTabExpand expand_as=EnumTabExpand::Default)
void props_enum (PointerRNA *ptr, StringRefNull propname)
void prop_search (PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, PropertyRNA *item_searchpropname, std::optional< StringRefNull > name, int icon, bool results_are_suggestions)
void prop_search (PointerRNA *ptr, StringRefNull propname, PointerRNA *searchptr, StringRefNull searchpropname, std::optional< StringRefNull > name, int icon)
void textbox (const bContext *C, PointerRNA *ptr, StringRefNull propname, std::optional< StringRefNull > name_opt=std::nullopt, std::optional< StringRefNull > placeholder=std::nullopt, const int initial_visible_lines=3)
void textbox_with_state (PointerRNA *ptr, StringRefNull propname, TextboxState *textbox_state, std::optional< StringRefNull > name_opt=std::nullopt, std::optional< StringRefNull > placeholder=std::nullopt)
void prop_with_popover (PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< 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< StringRefNull > name, int icon, const char *menu_type)
Button * button (StringRef name, int icon, std::function< void(bContext &)> func, std::optional< StringRef > tooltip=std::nullopt)
void separator (float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
void separator_spacer ()
Item
int2 size () const
int2 offset () const
Public Member Functions inherited from blender::ui::Item
 Item (const Item &)=default
virtual ~Item ()=default
 Item (ItemType type)
ItemType type () const
bool fixed_size () const
void fixed_size_set (bool fixed_size)
int2 size () const
int2 offset () const
Public Member Functions inherited from blender::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::blender::NonMovable
 NonMovable (NonMovable &&other)=delete
NonMovable & operator= (NonMovable &&other)=delete
 NonMovable ()=default
 NonMovable (const NonMovable &other)=default
NonMovable & operator= (const NonMovable &other)=default

Static Public Attributes

static constexpr float PROPERTY_SPLIT_FACTOR = 0.4f

Protected Attributes

LayoutRoot * root_ = nullptr
bContextStore * context_ = nullptr
Layout * parent_ = nullptr
std::string heading_
Vector< Item * > items_
Layout * child_items_layout_ = nullptr
int x_ = 0
int y_ = 0
int w_ = 0
int h_ = 0
short space_ = 0
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
LayoutAlign alignment_ = {}
EmbossType emboss_ = {}
float units_ [2] = {0.0f, 0.0f}
float search_weight_ = 0.0f
Protected Attributes inherited from blender::ui::Item
ItemInternalFlag flag_ = {}
ItemType type_ = {}

Friends

struct LayoutInternal

Layout

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

Layout Items

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

Detailed Description

Definition at line 121 of file UI_interface_layout.hh.

Constructor & Destructor Documentation

◆ Layout()

Member Function Documentation

◆ absolute()

◆ activate_init()

bool blender::ui::Layout::activate_init ( ) const
inlinenodiscard

Definition at line 800 of file UI_interface_layout.hh.

References activate_init_.

Referenced by activate_init_set(), and prop().

◆ activate_init_set()

void blender::ui::Layout::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 804 of file UI_interface_layout.hh.

References activate_init(), and activate_init_.

Referenced by blender::nodes::socket_items::ops::add_item(), and blender::ui::uiDefAutoButsRNA().

◆ active()

bool blender::ui::Layout::active ( ) const
inlinenodiscard

◆ active_default()

bool blender::ui::Layout::active_default ( ) const
inlinenodiscard

Definition at line 791 of file UI_interface_layout.hh.

References active_default_.

Referenced by active_default_set(), and blender::ui::uiItemFullO_ptr_ex().

◆ active_default_set()

void blender::ui::Layout::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 795 of file UI_interface_layout.hh.

References active_default(), and active_default_.

Referenced by blender::file_panel_execution_execute_button().

◆ active_set()

void blender::ui::Layout::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 786 of file UI_interface_layout.hh.

References active(), and active_.

Referenced by blender::advanced_panel_draw(), blender::ui::block_layout(), blender::AssetLibraryListItem::build_row(), blender::AssetLibraryRepoItem::build_row(), blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::build_row(), blender::ed::object::shapekey::ShapeKeyItem::build_row(), blender::ed::spreadsheet::CurvesViewItem::build_row(), blender::ed::spreadsheet::GeometryBundleViewItem::build_row(), blender::ed::spreadsheet::GreasePencilViewItem::build_row(), blender::ed::spreadsheet::InstancesViewItem::build_row(), blender::ed::spreadsheet::MeshViewItem::build_row(), blender::ed::spreadsheet::PointCloudViewItem::build_row(), blender::ed::spreadsheet::VolumeGridsViewItem::build_row(), blender::ui::bonecollections::BoneCollectionItem::build_row(), blender::ui::ProjectAssetLibraryListItem::build_row(), blender::ui::TreeViewLayoutBuilder::build_row(), blender::clamp_panel_draw(), blender::composition_panel_draw(), blender::constant_offset_draw(), blender::data_panel_draw(), blender::draw_active_library_settings(), blender::nodes::draw_bake_button_row(), blender::nodes::draw_common_bake_settings(), blender::nodes::draw_interface_panel_as_panel(), blender::modifier::greasepencil::draw_layer_filter_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::nodes::draw_named_attributes_panel(), blender::ui::nodes::draw_node_inputs_recursive(), blender::nodes::draw_property_for_socket(), blender::ui::draw_property_for_socket(), blender::modifier::greasepencil::draw_vertex_group_settings(), blender::ED_screens_header_tools_menu_create(), blender::edbm_bevel_ui(), blender::edbm_circularize_ui(), blender::edbm_decimate_ui(), blender::edge_panel_draw(), blender::edge_types_panel_draw(), blender::face_corner_panel_draw(), blender::face_corner_uv_panel_draw(), blender::face_corner_vcol_panel_draw(), blender::face_mark_panel_draw(), blender::face_panel_draw(), blender::falloff_panel_draw(), blender::fmodifier_frame_range_draw(), blender::fmodifier_get_pointers(), blender::fmodifier_influence_draw(), blender::geometry_panel_draw(), blender::graph_panel_cursor(), blender::intersection_panel_draw(), blender::limits_panel_draw(), blender::material_mask_panel_draw(), blender::material_mask_panel_draw_header(), blender::materials_panel_draw(), blender::modifier_panel_header(), blender::modifier_vgroup_ui(), blender::nla_panel_actclip(), blender::nla_panel_properties(), blender::ed::space_node::node_buts_image_user(), blender::nodes::node_shader_bsdf_principled_cc::node_declare(), blender::nodes::node_composite_defocus_cc::node_draw_buttons(), 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_texture_buts_proc(), 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::object_offset_draw(), blender::occlusion_panel_draw(), blender::offset_panel_draw(), blender::options_light_reference_draw(), blender::options_panel_draw(), blender::panel_draw(), blender::panel_draw(), blender::path_panel_draw(), blender::preferences_extension_repo_add_ui(), blender::profile_panel_draw(), blender::random_panel_draw(), blender::relative_offset_draw(), blender::ed::vse::sequencer_split_ui(), blender::ed::object::shade_auto_smooth_ui(), blender::shaderfx_panel_header(), blender::shading_panel_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), blender::ed::spreadsheet::spreadsheet_row_filters_layout(), blender::ed::space_node::std_node_socket_draw(), blender::ed::space_node::std_node_socket_interface_draw(), blender::stepped_panel_draw(), blender::symmetry_panel_draw(), blender::ui::template_cache_file_time_settings(), blender::ui::template_keymap_item_properties(), blender::ui::template_running_jobs(), blender::uiTemplateImage(), blender::uiTemplateMarker(), blender::uiTemplateNodeLink(), blender::unwrap_draw(), blender::uv_pack_islands_ui(), blender::vert_vcol_panel_draw(), blender::vertex_group_panel_draw(), blender::vertex_panel_draw(), blender::vertex_vgroup_panel_draw(), blender::wave_panel_draw(), and blender::wm_open_mainfile_ui().

◆ align()

bool blender::ui::Layout::align ( ) const
nodiscard

◆ alignment()

◆ alignment_set()

void blender::ui::Layout::alignment_set ( LayoutAlign alignment)
inline

Definition at line 814 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(), blender::ed::asset::shelf::AssetViewItem::build_grid_tile(), blender::AssetLibraryListItem::build_row(), blender::AssetLibraryRepoItem::build_row(), blender::ed::object::shapekey::ShapeKeyItem::build_row(), blender::ui::ProjectAssetLibraryListItem::build_row(), blender::buttons_panel_context_draw(), blender::ui::curvemap_buttons_layout(), blender::ui::CurveProfile_buttons_layout(), blender::draw_active_library_settings(), blender::ui::draw_effect_panel_header(), blender::nodes::draw_named_attributes_panel(), blender::ed::space_node::draw_node_socket_name_editable(), blender::nodes::draw_property_for_output_socket(), blender::file_banner_remote_asset_libraries_layout(), blender::fmodifier_panel_header(), blender::graph_draw_driven_property_panel(), blender::graph_draw_driver_settings_panel(), blender::ui::label_markdown_dev_config_block_margins_table(), blender::ui::label_markdown_dev_config_details_row(), blender::ui::label_markdown_dev_config_headers_table(), blender::ui::label_markdown_dev_config_list_spacing_table(), blender::ui::layout_heading_label_add(), link(), blender::modifier_panel_header(), blender::seq::modifier_panel_header(), blender::nla_panel_animdata(), blender::nodes::node_composite_color_cc::node_declare(), blender::nodes::node_fn_input_bool_cc::node_declare(), blender::nodes::node_fn_input_color_cc::node_declare(), blender::nodes::node_fn_input_int_cc::node_declare(), blender::nodes::node_fn_input_int_vector_cc::node_declare(), blender::nodes::node_fn_input_menu_cc::node_declare(), blender::nodes::node_fn_input_rotation_cc::node_declare(), blender::nodes::node_fn_input_string_cc::node_declare(), blender::nodes::node_fn_input_vector_cc::node_declare(), blender::nodes::node_geo_image_cc::node_declare(), blender::nodes::node_geo_input_collection_cc::node_declare(), blender::nodes::node_geo_input_font_cc::node_declare(), blender::nodes::node_geo_input_material_cc::node_declare(), blender::nodes::node_geo_input_object_cc::node_declare(), blender::nodes::node_shader_rgb_cc::node_declare(), blender::ed::space_node::node_update_basis_socket(), blender::ui::panel_category_tabs_draw_all(), blender::panel_draw(), blender::project_new_ui(), blender::nodes::node_shader_value_cc::sh_node_value_declare(), blender::seq::sound_equalizermodifier_draw(), blender::ed::spreadsheet::spreadsheet_footer_region_draw(), blender::ed::space_node::std_node_socket_draw(), blender::ui::template_any_id(), blender::ui::template_breadcrumbs(), textbox_with_state(), blender::ed::space_node::ui_node_draw_input(), blender::ui::uiItemPropertySplitWrapperCreate(), blender::ui::uiItemsAlertBox(), blender::uiTemplateImageInfo(), blender::ui::uiTemplateInputStatus(), blender::uiTemplateMovieclipInformation(), blender::userpref_asset_libraries_panel_draw(), blender::view3d_panel_curve_data(), and blender::wm_block_about_create().

◆ block()

Block * blender::ui::Layout::block ( ) const
nodiscard

Definition at line 6020 of file interface_layout.cc.

References blender::ui::LayoutRoot::block, and root_.

Referenced by absolute(), blender::nodes::add_attribute_search_button(), blender::ed::asset::shelf::add_catalog_tabs(), blender::nodes::add_layer_name_search_button(), blender::ui::alert_create(), 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(), blender::ui::colorspaces_menu_add_button(), column(), column_flow(), context_copy(), context_int_set(), context_ptr_set(), context_string_set(), blender::ui::create_title_button(), blender::ui::curvemap_buttons_layout(), blender::ui::CurveProfile_buttons_layout(), decorator(), blender::ui::def_but_rna__menu(), blender::ui::draw_constraint_header(), blender::draw_library_list(), blender::ui::draw_matrix_template(), blender::ed::spreadsheet::draw_viewer_data_panel(), blender::ed::spreadsheet::draw_viewer_path_panel(), emboss(), blender::envelope_panel_draw(), blender::ed::asset_browser::file_create_asset_catalog_tree_view_in_layout(), blender::file_panel_execution_buttons_draw(), blender::file_panel_operator(), blender::fmodifier_panel_header(), blender::ui::format_unit_value(), blender::graph_draw_driven_property_enabled_btn(), blender::graph_draw_driver_settings_panel(), blender::graph_panel_key_properties(), blender::grease_pencil_cap_menu(), grid_flow(), image(), blender::image_panel_uv(), blender::ui::item_array(), blender::ui::item_disabled(), blender::ui::item_menu(), blender::ui::item_menu_hold(), blender::ui::item_rna_size(), blender::knot_modes_menu(), label_markdown(), blender::ui::label_markdown_dev_config(), label_multiline(), blender::ui::LayoutInternal::layout_add_but(), blender::ui::layout_box(), link(), menu(), menu_contents(), blender::ui::menu_item_enum_opname_menu(), menu_pie(), blender::ui::menutype_draw(), blender::modifier_panel_get_property_pointers(), blender::modifier_panel_header(), blender::nla_panel_actclip(), blender::nla_panel_animated_influence_header(), blender::nla_panel_animated_strip_time(), blender::nla_panel_animated_strip_time_header(), blender::nla_panel_animdata(), blender::nla_panel_evaluation(), blender::nla_panel_modifiers(), blender::nla_panel_properties(), blender::nla_panel_stripname(), blender::ed::space_node::node_bundle_type_add_string_search_button(), 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(), blender::panel_draw(), panel_prop(), blender::ui::paneltype_draw_impl(), popover(), blender::ui::popup_block_template_confirm_op(), blender::ui::popup_context_menu_for_button(), blender::ui::popup_context_menu_for_panel(), progress_indicator(), prop(), prop_enum(), prop_search(), prop_tabs_enum(), prop_with_menu(), prop_with_popover(), props_enum(), blender::recent_files_menu_label(), resolve(), blender::ui::LayoutRadial::resolve_impl(), root_panel(), blender::ui::rotation_mode_menu_callback(), row(), separator(), separator_spacer(), blender::shaderfx_panel_header(), split(), blender::ed::spreadsheet::spreadsheet_data_set_panel_draw(), blender::ui::template_asset_shelf_popover(), blender::ui::template_bone_collection_tree(), blender::ui::template_collection_exporters(), blender::ui::template_collection_importer(), blender::ui::template_color_picker(), blender::ui::template_color_ramp(), blender::ui::template_component_menu(), blender::ui::template_constraint_header(), blender::ui::template_crypto_picker(), blender::ui::template_curve_mapping(), blender::ui::template_curve_profile(), blender::ui::template_file_select_path(), blender::ui::template_filepath_split_button(), blender::ui::template_filepath_split_name_buttons(), blender::ui::template_grease_pencil_layer_tree(), blender::ui::template_header(), blender::ui::template_histogram(), blender::ui::template_icon(), blender::ui::template_icon_view(), blender::ui::template_ID(), blender::ui::template_ID_session_uid(), blender::ui::template_ID_tabs(), blender::ui::template_keymap_item_properties(), blender::ui::template_layers(), blender::ui::template_light_linking_collection(), blender::ui::template_node_socket(), blender::ui::template_operator_property_buts_draw_single(), blender::ui::template_operator_redo_properties(), blender::ui::template_palette(), blender::ui::template_preview(), blender::ui::template_project_splash(), blender::ui::template_recent_file(), blender::ui::template_recent_projects(), blender::ui::template_running_jobs(), blender::ui::template_search_buttons(), blender::template_texture_user_menu(), blender::ed::object::shapekey::template_tree(), blender::ui::template_tree_interface(), blender::ui::template_uilist_layout_draw(), blender::ui::template_vectorscope(), blender::ui::template_waveform(), blender::ui::text_icon_width_ex(), textbox_with_state(), blender::ui_imageuser_layer_menu(), blender::ui_imageuser_pass_menu(), blender::ui_imageuser_slot_menu(), blender::ui_imageuser_view_menu_multiview(), blender::ui_imageuser_view_menu_rr(), blender::ed::space_node::ui_node_draw_input(), blender::ed::space_node::ui_node_menu_column(), blender::ed::space_node::ui_template_node_link_menu(), blender::uiblock_layer_pass_buttons(), blender::ui::uiItem_simple(), blender::ui::uiItemFullO_ptr_ex(), blender::ui::uiItemL_respect_property_split(), blender::ui::uiLayoutListItemAddPadding(), blender::uiTemplateImage(), blender::ui::uiTemplateKeymapItemProperties(), blender::uiTemplateMarker(), blender::ui::uiTemplateMenuSearch(), blender::uiTemplateMovieClip(), blender::uiTemplateNodeLink(), blender::ui::uiTemplateOperatorSearch(), blender::ui::uiTemplateReportsBanner(), blender::ui::uiTemplateStatusInfo(), blender::uiTemplateTextureShow(), blender::uiTemplateTextureUser(), blender::uiTemplateTrack(), blender::v3d_editvertex_buts(), blender::v3d_object_dimension_buts(), blender::view3d_panel_curve_data(), blender::view3d_panel_transform(), blender::view3d_panel_vgroup(), and blender::wm_block_dialog_create().

◆ box()

Layout & blender::ui::Layout::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 5392 of file interface_layout.cc.

References Layout(), blender::ui::layout_box(), and blender::ui::Roundbox.

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

◆ button()

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

◆ column() [1/2]

Layout & blender::ui::Layout::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 5305 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), uiStyle::buttonspacey, blender::ui::LayoutInternal::init_from_parent(), Layout(), root_, space_, and blender::ui::LayoutRoot::style.

Referenced by blender::advanced_panel_draw(), blender::ui::alert_create(), blender::axis_mapping_panel_draw(), blender::bake_panel_draw(), blender::block_create__close_file_dialog(), blender::block_create_autorun_warning(), blender::block_create_save_file_overwrite_dialog(), blender::block_create_save_modified_images_dialog(), blender::ed::asset::shelf::build_asset_view(), blender::ui::TreeViewLayoutBuilder::build_from_tree(), blender::ui::GridViewLayoutBuilder::build_from_view(), blender::ed::asset::shelf::AssetViewItem::build_grid_tile(), blender::ui::TreeViewLayoutBuilder::build_row(), blender::caps_panel_draw(), blender::chaining_panel_draw(), blender::clamp_panel_draw(), blender::seq::colorBalance_panel_draw(), blender::ui::colorspaces_menu_draw(), column(), blender::ui::component_menu(), blender::composition_panel_draw(), blender::constant_offset_draw(), blender::ui::constraint_ops_extra_draw(), blender::cycles_panel_draw(), blender::data_panel_draw(), decorator(), blender::draw_active_library_settings(), blender::nodes::draw_bake_button_row(), blender::nodes::draw_bake_panel(), blender::nodes::node_geo_viewer_cc::draw_color(), blender::nodes::draw_common_bake_settings(), blender::ui::draw_export_properties(), blender::draw_fill_tile(), blender::ui::draw_import_controls(), blender::ui::draw_import_properties(), blender::nodes::socket_items::ui::draw_items_list_with_operators(), blender::modifier::greasepencil::draw_layer_filter_settings(), blender::nodes::draw_mask_input_type_settings(), blender::seq::draw_mask_input_type_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::ui::draw_matrix_template(), blender::ed::asset::draw_menu_for_catalog(), blender::ui::nodes::draw_node_inputs_recursive(), blender::ed::asset::draw_node_menu_for_catalog(), blender::nodes::node_geo_viewer_cc::draw_vector(), blender::modifier::greasepencil::draw_vertex_group_settings(), blender::nodes::draw_warnings(), blender::ui::draw_warnings(), blender::seq::echomodifier_draw(), blender::ED_screens_header_tools_menu_create(), blender::edbm_bevel_ui(), blender::edbm_decimate_ui(), blender::edge_data_panel_draw(), blender::edge_types_panel_draw(), blender::envelope_panel_draw(), blender::file_overwrite_detailed_info_show(), blender::file_panel_asset_catalog_buttons_draw(), blender::fmodifier_frame_range_draw(), blender::fn_generator_panel_draw(), blender::nodes::node_composite_file_output_cc::format_layout(), blender::generate_panel_draw(), blender::generator_panel_draw(), blender::gpencil_shaderfx_ops_extra_draw(), blender::graph_draw_driver_settings_panel(), blender::graph_panel_cursor(), blender::graph_panel_cursor_header(), blender::graph_panel_driverVar__contextProp(), blender::graph_panel_driverVar__locDiff(), blender::graph_panel_driverVar__rotDiff(), blender::graph_panel_driverVar__singleProp(), blender::graph_panel_driverVar__transChan(), blender::graph_panel_key_properties(), blender::graph_panel_properties(), blender::grease_pencil_cap_menu(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_sequence_ui(), blender::ui::hud_panel_operator_redo_draw(), blender::image_new_draw(), blender::image_save_as_draw(), blender::intersection_panel_draw(), blender::ui::item_local_sublayout(), blender::knot_modes_menu(), blender::ui::label_markdown_dev_config(), blender::ui::label_markdown_dev_config_block_margins_table(), blender::ui::label_markdown_dev_config_details_row(), blender::ui::label_markdown_dev_config_headers_table(), blender::ui::label_markdown_dev_config_list_spacing_table(), blender::layers_panel_draw(), blender::limits_panel_draw(), blender::material_mask_panel_draw(), blender::materials_panel_draw(), blender::ed::mesh::set_attribute::mesh_set_attribute_ui(), blender::nla_panel_actclip(), blender::nla_panel_animated_influence_header(), blender::nla_panel_animated_strip_time_header(), blender::nla_panel_animdata(), blender::nla_panel_properties(), blender::ed::space_node::node_buts_image_user(), blender::ed::space_node::node_buts_image_views(), blender::ed::space_node::node_buts_mix_rgb(), blender::nodes::node_shader_output_linestyle_cc::node_buts_output_linestyle(), blender::ed::space_node::node_composit_buts_cryptomatte(), blender::ed::space_node::node_composit_buts_cryptomatte_legacy(), blender::nodes::node_composite_color_cc::node_declare(), blender::nodes::node_composite_plane_track_deform_cc::node_declare(), blender::nodes::node_fn_input_color_cc::node_declare(), blender::nodes::node_fn_input_int_vector_cc::node_declare(), blender::nodes::node_fn_input_rotation_cc::node_declare(), blender::nodes::node_fn_input_vector_cc::node_declare(), blender::nodes::node_shader_rgb_cc::node_declare(), blender::nodes::node_composite_defocus_cc::node_draw_buttons(), blender::nodes::node_composite_keying_screen_cc::node_draw_buttons(), blender::nodes::node_composite_render_layer_cc::node_draw_buttons(), blender::nodes::node_composite_track_position_cc::node_draw_buttons(), blender::nodes::node_geo_bake_cc::node_layout(), blender::nodes::node_geo_bake_cc::node_layout_ex(), blender::nodes::node_geo_combine_list_cc::node_layout_ex(), blender::nodes::node_geo_gizmo_transform_cc::node_layout_ex(), blender::nodes::node_geo_index_switch_cc::node_layout_ex(), blender::nodes::node_geo_simulation_cc::node_layout_ex(), blender::nodes::node_shader_tex_brick_cc::node_shader_buts_tex_brick(), blender::nodes::node_shader_tex_sky_cc::node_shader_buts_tex_sky(), blender::ed::space_node::node_texture_buts_bricks(), blender::ed::space_node::node_texture_buts_proc(), blender::ed::space_node::node_tree_interface_draw(), blender::noise_panel_draw(), blender::normals_panel_draw(), blender::object_offset_draw(), blender::occlusion_panel_draw(), blender::options_light_reference_draw(), blender::options_panel_draw(), blender::ed::outliner::outliner_orphans_purge_ui(), blender::ui::panel_category_tabs_draw_all(), blender::panel_draw(), blender::panel_draw(), blender::ui::paneltype_draw_impl(), blender::path_panel_draw(), blender::seq::pitchmodifier_draw(), blender::ed::asset::shelf::popover_panel_draw(), blender::ui::popup_context_menu_for_button(), blender::position_panel_draw(), blender::preferences_asset_library_add_ui(), blender::profile_panel_draw(), prop(), props_enum(), blender::recent_files_menu_list(), blender::relative_offset_draw(), blender::ed::curves::select_ends_ui(), blender::ed::vse::sequencer_add_ui(), blender::ed::curves::set_attribute_ui(), blender::ed::pointcloud::set_attribute_ui(), blender::ed::object::shade_auto_smooth_ui(), blender::shading_panel_draw(), blender::smooth_panel_draw(), blender::solver_options_panel_draw(), blender::seq::sound_equalizermodifier_draw(), blender::ed::space_node::std_node_socket_draw(), blender::ed::space_node::std_node_socket_interface_draw(), blender::stepped_panel_draw(), blender::symmetry_panel_draw(), blender::ui::template_add_button_search_menu(), blender::ui::template_collection_exporters(), blender::ui::template_collection_importer(), blender::ui::template_color_picker(), blender::ui::template_colormanaged_view_settings(), blender::ui::template_histogram(), blender::ui::template_layers(), blender::ui::template_node_inputs(), blender::ui::template_operator_property_buts_draw_single(), blender::ui::template_palette(), blender::ui::template_preview(), blender::ui::template_project_asset_libraries_tree(), blender::ui::template_uilist_flags(), blender::ui::template_uilist_layout_draw(), blender::ui::template_vectorscope(), blender::ui::template_waveform(), blender::texture_paint_add_texture_paint_slot_ui(), blender::texture_panel_draw(), blender::tile_add_draw(), blender::time_panel_draw(), blender::seq::tonemapmodifier_panel_draw(), blender::ui_imageuser_layer_menu(), blender::ui_imageuser_pass_menu(), blender::ui_imageuser_view_menu_multiview(), blender::ui_imageuser_view_menu_rr(), blender::ed::space_node::ui_node_draw_input(), blender::ed::space_node::ui_node_draw_node(), blender::ed::space_node::ui_node_draw_recursive(), blender::ed::space_node::ui_node_menu_column(), blender::ed::object::ui_template_modifier_asset_menu_items(), blender::ed::space_node::ui_template_node_asset_menu_items(), blender::ed::geometry::ui_template_node_operator_asset_menu_items(), blender::ed::geometry::ui_template_node_operator_registration_errors(), blender::ui::uiDefAutoButsRNA(), blender::ui::uiItemPropertySplitWrapperCreate(), blender::ui::uiItemsAlertBox(), blender::uiTemplateImage(), blender::uiTemplateImageInfo(), blender::uiTemplateImageSettings(), blender::uiTemplateImageStereo3d(), blender::uiTemplateMarker(), blender::uiTemplateMovieClip(), blender::uiTemplateMovieclipInformation(), blender::uiTemplateTrack(), blender::uiTemplateViewsFormat(), blender::unwrap_draw(), blender::userpref_asset_libraries_panel_draw(), blender::uv_panel_draw(), blender::v3d_editarmature_buts(), blender::v3d_editmetaball_buts(), blender::v3d_posearmature_buts(), blender::vertex_group_panel_draw(), blender::vgroup_panel_draw(), blender::view3d_panel_curve_data(), blender::view3d_panel_transform(), blender::view3d_panel_vgroup(), blender::wm_block_about_create(), blender::wm_block_create_redo(), blender::wm_block_dialog_create(), blender::wm_block_image_save_errors(), blender::wm_open_mainfile_ui(), and blender::wm_stereo3d_set_draw().

◆ column() [2/2]

Layout & blender::ui::Layout::column ( bool align,
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
headingHeading label to set to the first child element added in the sub-layout through #Layout::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 5317 of file interface_layout.cc.

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

◆ column_flow()

Layout & blender::ui::Layout::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
numberthe number of columns in which items are distributed.

Definition at line 5324 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), uiStyle::columnspace, blender::ui::LayoutInternal::init_from_parent(), Layout(), blender::ui::LayoutItemFlow::number, root_, space_, and blender::ui::LayoutRoot::style.

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

◆ context()

const bContextStore * blender::ui::Layout::context ( ) const
nodiscard

◆ context_copy()

◆ context_int_get()

std::optional< int64_t > blender::ui::Layout::context_int_get ( const StringRef name) const
nodiscard

Definition at line 6210 of file interface_layout.cc.

References context_, and blender::CTX_store_int_lookup().

◆ context_int_set()

void blender::ui::Layout::context_int_set ( StringRef name,
int64_t value )

◆ context_ptr_get()

const PointerRNA * blender::ui::Layout::context_ptr_get ( const StringRef name,
const StructRNA * type ) const
nodiscard

◆ context_ptr_set()

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

◆ context_set_from_but()

◆ context_store()

bContextStore * blender::ui::Layout::context_store ( ) const
inlinenodiscard

◆ context_string_get()

std::optional< StringRefNull > blender::ui::Layout::context_string_get ( const StringRef name) const
nodiscard

Definition at line 6196 of file interface_layout.cc.

References context_, and blender::CTX_store_string_lookup().

◆ context_string_set()

◆ decorator() [1/2]

◆ decorator() [2/2]

void blender::ui::Layout::decorator ( PointerRNA * ptr,
std::optional< 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 3154 of file interface_layout.cc.

References decorator(), blender::ui::item_disabled(), prop(), blender::RNA_struct_find_property(), blender::RNA_struct_identifier(), RNA_warning_bare, and blender::PointerRNA::type.

◆ emboss()

EmbossType blender::ui::Layout::emboss ( ) const
nodiscard

◆ emboss_or_undefined()

EmbossType blender::ui::Layout::emboss_or_undefined ( ) const
nodiscard

Definition at line 6696 of file interface_layout.cc.

References emboss_.

Referenced by LayoutInternal, and blender::ui::uiItemFullO_ptr_ex().

◆ emboss_set()

◆ enabled()

bool blender::ui::Layout::enabled ( ) const
inlinenodiscard

Definition at line 824 of file UI_interface_layout.hh.

References enabled_.

Referenced by enabled_set(), and resolve().

◆ enabled_set()

void blender::ui::Layout::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 828 of file UI_interface_layout.hh.

References enabled(), and enabled_.

Referenced by blender::armature_parent_clear_invoke(), blender::armature_parent_set_invoke(), blender::bake_panel_draw(), blender::ui::block_layout(), blender::AssetLibraryListItem::build_row(), blender::ui::ProjectAssetLibraryListItem::build_row(), blender::chaining_panel_draw(), blender::ui::constraint_ops_extra_draw(), blender::draw_active_library_settings(), blender::ed::asset::draw_asset_menu_item(), blender::ui::draw_effect_extra_menu(), blender::edge_types_panel_draw(), blender::face_mark_panel_draw(), blender::face_mark_panel_draw_header(), blender::gpencil_shaderfx_ops_extra_draw(), blender::graph_panel_properties(), blender::ui::hud_panel_operator_redo_draw(), blender::intersection_panel_draw(), blender::material_mask_panel_draw(), blender::material_mask_panel_draw_header(), blender::modifier_ops_extra_draw(), blender::seq::modifier_ops_extra_draw(), blender::move_to_collection_menu_create(), blender::nla_panel_animated_strip_time(), blender::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_tree_interface_draw(), 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(), blender::ui::popup_context_menu_for_button(), blender::project_new_ui(), prop(), blender::shape_panel_draw(), blender::subdivisions_panel_draw(), blender::ui::template_collection_exporters(), blender::ui::template_project_asset_libraries_tree(), blender::ui::template_project_splash(), blender::uiTemplateImage(), blender::uiTemplateImageSettings(), blender::undo_history_draw_menu(), blender::userpref_asset_libraries_panel_draw(), blender::v3d_object_dimension_buts(), blender::vgroup_panel_draw(), blender::view3d_panel_vgroup(), blender::wm_block_create_redo(), blender::wm_open_mainfile_ui(), and blender::wm_xr_viewfinder_ui_action_enum_block().

◆ estimate()

◆ estimate_impl()

◆ grid_flow()

Layout & blender::ui::Layout::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_majorWhen true items are distributed by rows, otherwise items are distributed by columns.
columns_lenWhen 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_columnsAll columns will have the same width.
even_rowsAll rows will have the same height.

Definition at line 5337 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), blender::ui::LayoutItemGridFlow::columns_len, uiStyle::columnspace, blender::ui::LayoutItemGridFlow::even_columns, blender::ui::LayoutItemGridFlow::even_rows, blender::ui::LayoutInternal::init_from_parent(), Layout(), root_, blender::ui::LayoutItemGridFlow::row_major, space_, and blender::ui::LayoutRoot::style.

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

◆ heading()

StringRef blender::ui::Layout::heading ( ) const
nodiscard

Definition at line 6676 of file interface_layout.cc.

References heading_.

Referenced by column(), blender::ui::layout_heading_label_add(), LayoutInternal, and row().

◆ heading_reset()

void blender::ui::Layout::heading_reset ( )

Definition at line 6680 of file interface_layout.cc.

References heading_.

Referenced by blender::ui::layout_heading_label_add(), and LayoutInternal.

◆ image()

bool blender::ui::Layout::image ( StringRef key,
FunctionRef< ImBuf *()> create_fn )

Adds an image filling the layout width, with the height following the image aspect ratio.

To avoid recreating the image on every redraw, the image of the previous redraw is reused if it has the same #key. Otherwise #create_fn is called, and the button takes ownership of the returned image buffer.

Returns
False if no image could be created.

Definition at line 3425 of file interface_layout.cc.

References blender::BLI_assert(), block(), blender::ui::block_layout_set_current(), blender::ui::image_find_in_old_block(), blender::blender::StringRefBase::is_empty(), blender::ui::ButtonImage::key, root_, UI_UNIT_X, UI_UNIT_Y, blender::ui::uiDefButImage(), and blender::ui::LayoutRoot::use_dynamic_height.

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

◆ items()

◆ label()

void blender::ui::Layout::label ( StringRef name,
int icon )

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

Definition at line 3339 of file interface_layout.cc.

References blender::ui::uiItem_simple().

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), blender::ui::BasicTreeViewItem::add_label(), blender::nodes::add_layer_name_search_button(), blender::ui::alert_create(), blender::bake_panel_draw(), blender::block_create__close_file_dialog(), blender::block_create_autorun_warning(), blender::block_create_save_file_overwrite_dialog(), blender::ed::asset::shelf::build_asset_view(), blender::AssetLibraryListItem::build_row(), blender::AssetLibraryProjectHeading::build_row(), blender::AssetLibraryRepoItem::build_row(), blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::build_row(), blender::ed::spreadsheet::BundleViewerTreeItem::build_row(), blender::ed::spreadsheet::ClosureInOutViewerTreeItem::build_row(), blender::ed::spreadsheet::CurvesDomainViewItem::build_row(), blender::ed::spreadsheet::CurvesViewItem::build_row(), blender::ed::spreadsheet::EvaluteClosureViewerPathItem::build_row(), blender::ed::spreadsheet::ForeachElementViewerPathItem::build_row(), blender::ed::spreadsheet::GeometryBundleClosureInOutViewItem::build_row(), blender::ed::spreadsheet::GeometryBundleItemViewItem::build_row(), blender::ed::spreadsheet::GeometryBundleViewItem::build_row(), blender::ed::spreadsheet::GreasePencilLayerCurvesDomainViewItem::build_row(), blender::ed::spreadsheet::GreasePencilLayersViewItem::build_row(), blender::ed::spreadsheet::GreasePencilLayerViewItem::build_row(), blender::ed::spreadsheet::GreasePencilViewItem::build_row(), blender::ed::spreadsheet::GroupNodeViewerPathItem::build_row(), blender::ed::spreadsheet::IDViewerPathItem::build_row(), blender::ed::spreadsheet::InstanceReferenceViewItem::build_row(), blender::ed::spreadsheet::InstancesViewItem::build_row(), blender::ed::spreadsheet::MeshDomainViewItem::build_row(), blender::ed::spreadsheet::MeshViewItem::build_row(), blender::ed::spreadsheet::ModifierViewerPathItem::build_row(), blender::ed::spreadsheet::PointCloudViewItem::build_row(), blender::ed::spreadsheet::PointsViewItem::build_row(), blender::ed::spreadsheet::RepeatViewerPathItem::build_row(), blender::ed::spreadsheet::RootGeometryViewItem::build_row(), blender::ed::spreadsheet::SimulationViewerPathPathItem::build_row(), blender::ed::spreadsheet::ViewerNodeItem::build_row(), blender::ed::spreadsheet::ViewerNodeViewerPathItem::build_row(), blender::ed::spreadsheet::VolumeGridsViewItem::build_row(), blender::ui::bonecollections::BoneCollectionItem::build_row(), blender::ui::ProjectAssetLibraryListItem::build_row(), blender::buttons_panel_context_draw(), blender::ed::geometry::catalog_assets_draw_unassigned(), blender::chaining_panel_draw(), blender::ed::object::collection_exporter_menu_draw(), blender::ed::object::collection_importer_menu_draw(), blender::seq::colorBalance_panel_draw(), blender::composition_panel_draw(), blender::cycles_panel_draw(), blender::ui::def_but_rna__menu(), blender::ui::def_but_rna__menu_type(), blender::ui::def_but_rna__panel_type(), blender::draw_active_library_settings(), blender::nodes::node_geo_viewer_cc::draw_bool(), blender::nodes::node_geo_viewer_cc::draw_color(), blender::ui::draw_constraint_header(), blender::ed::spreadsheet::draw_context_panel(), blender::ed::spreadsheet::draw_context_panel_without_context(), blender::nodes::node_geo_viewer_cc::draw_data_block(), blender::nodes::node_geo_viewer_cc::draw_empty_data_block(), blender::nodes::draw_error_message(), blender::ui::draw_export_controls(), blender::nodes::node_geo_viewer_cc::draw_gpointer(), blender::ui::draw_import_controls(), blender::nodes::node_geo_viewer_cc::draw_int(), blender::nodes::draw_interface_panel_as_panel(), blender::ui::draw_matrix_template(), blender::nodes::draw_named_attributes_panel(), blender::ui::nodes::draw_node_inputs_recursive(), blender::ed::space_node::draw_node_socket_name_editable(), blender::nodes::draw_property_for_output_socket(), blender::nodes::draw_property_for_socket(), blender::nodes::node_geo_viewer_cc::draw_string(), blender::nodes::node_geo_viewer_cc::draw_vector(), blender::nodes::draw_warnings(), blender::driver_dvar_invalid_name_query_cb(), blender::edge_types_panel_draw(), blender::face_mark_panel_draw(), blender::face_mark_panel_draw_header(), blender::file_banner_remote_asset_libraries_layout(), blender::file_overwrite_detailed_info_show(), blender::fmodifier_panel_header(), blender::generator_panel_draw(), blender::graph_draw_driven_property_panel(), blender::graph_draw_driver_settings_panel(), blender::graph_panel_drivers_popover(), blender::graph_panel_key_properties(), blender::graph_panel_properties(), blender::handle_operator_asset_reference_props(), blender::ui::item_enum_expand_exec(), blender::ui::item_menu_hold(), blender::ui::label_markdown_dev_config_block_margins_table(), blender::ui::label_markdown_dev_config_details_row(), label_multiline(), blender::ui::layout_heading_label_add(), blender::ui::menu_add_shortcut(), blender::ui::menu_change_shortcut(), blender::metadata_panel_draw_field(), blender::new_project_draw_folder_info(), blender::nla_panel_animdata(), blender::nla_panel_stripname(), blender::ed::space_node::node_buts_image_user(), blender::ed::space_node::node_composit_buts_cryptomatte(), blender::ed::space_node::node_composit_buts_cryptomatte_legacy(), blender::nodes::node_fn_input_menu_cc::node_declare(), blender::nodes::node_composite_defocus_cc::node_draw_buttons(), blender::nodes::node_composite_denoise_cc::node_draw_buttons(), blender::nodes::node_geo_bake_cc::node_layout_ex(), blender::nodes::node_geo_combine_list_cc::node_layout_ex(), blender::nodes::node_geo_index_switch_cc::node_layout_ex(), blender::nodes::node_geo_simulation_cc::node_layout_ex(), blender::ed::space_node::node_socket_button_label(), blender::ed::space_node::node_socket_undefined_draw(), blender::ed::space_node::node_socket_undefined_interface_draw(), blender::occlusion_panel_draw(), op_enum_items(), blender::options_light_reference_draw(), blender::options_panel_draw(), blender::ed::outliner::outliner_orphans_purge_ui(), blender::nodes::node_composite_file_output_cc::output_path_layout(), panel(), blender::panel_draw(), blender::panel_draw(), panel_prop(), panel_prop_with_bool_header(), blender::ui::paneltype_draw_impl(), blender::ui::popup_menu_reports(), blender::project_new_ui(), props_enum(), blender::recent_files_menu_draw(), blender::ed::object::root_catalogs_draw(), blender::ed::space_node::root_catalogs_draw(), blender::ed::vse::root_catalogs_draw(), blender::root_catalogs_draw(), blender::screen_user_menu_draw(), blender::ed::vse::sequencer_add_scene_draw(), blender::shaderfx_panel_end(), blender::shaderfx_panel_header(), blender::seq::sound_equalizermodifier_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), blender::ed::spreadsheet::spreadsheet_footer_region_draw(), blender::ed::space_node::std_node_socket_draw(), blender::ui::template_any_id(), blender::ui::template_breadcrumbs(), blender::ui::template_event_from_keymap_item(), blender::ui::template_filepath_split_name_buttons(), blender::ui::template_keymap_item_properties(), blender::ui::template_operator_property_buts_draw_single(), blender::ui::template_palette_menu(), blender::ui::template_project_splash(), blender::ui::template_recent_projects(), blender::ui::template_status_bar_modal_item(), blender::template_texture_user_menu(), blender::ed::space_node::ui_node_draw_input(), blender::ed::space_node::ui_node_draw_recursive(), blender::ed::space_node::ui_node_menu_column(), blender::ed::space_node::ui_template_node_link_menu(), blender::ed::geometry::ui_template_node_operator_registration_errors(), blender::ui::uiDefAutoButsRNA(), blender::ui::uilist_draw_item_default(), blender::uiTemplateImageInfo(), blender::uiTemplateImageSettings(), blender::ui::uiTemplateInputStatus(), blender::ui::uiTemplateInputStatus3DView(), blender::ui::uiTemplateInputStatusAzone(), blender::ui::uiTemplateInputStatusBorder(), blender::ui::uiTemplateInputStatusHeader(), blender::uiTemplateMovieclipInformation(), blender::ui::uiTemplateStatusInfo(), blender::uiTemplateTextureUser(), blender::ed::object::unassigned_assets_draw(), blender::ed::vse::unassigned_assets_draw(), blender::unassigned_assets_draw(), blender::userpref_asset_libraries_panel_draw(), blender::v3d_editarmature_buts(), blender::v3d_editmetaball_buts(), blender::v3d_posearmature_buts(), blender::v3d_transform_butsR(), blender::vgroup_panel_draw(), blender::view3d_panel_curve_data(), blender::wm_block_insert_unicode_create(), blender::wm_block_splash_create(), blender::WM_window_modal_keymap_status_draw(), blender::wm_xr_viewfinder_ui_action_label_block(), blender::wm_xr_viewfinder_ui_missing_captures_label_block(), blender::wm_xr_viewfinder_ui_settings_left_label_block(), and blender::wm_xr_viewfinder_ui_settings_right_label_block().

◆ label_markdown()

◆ label_multiline()

◆ link()

◆ list_box()

◆ local_direction()

◆ menu() [1/2]

◆ menu() [2/2]

void blender::ui::Layout::menu ( StringRef menuname,
std::optional< 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 3074 of file interface_layout.cc.

References menu(), RNA_warning_bare, and blender::WM_menutype_find().

◆ menu_contents()

◆ menu_fn()

void blender::ui::Layout::menu_fn ( StringRefNull name,
int icon,
MenuCreateFunc func,
void * arg )

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

Parameters
nameLabel to show in the menu button.
funcFunction that generates the menu layout.
argPointer to data used as last argument in func.

Definition at line 3693 of file interface_layout.cc.

References blender::ui::item_menu().

Referenced by blender::ui::draw_constraint_header(), blender::ui::draw_effect_panel_header(), blender::modifier_panel_header(), blender::seq::modifier_panel_header(), blender::move_to_collection_menu_create(), blender::ui::popup_context_menu_for_button(), blender::screen_context_menu_invoke(), blender::shaderfx_panel_header(), blender::ui::template_breadcrumbs(), and blender::workspace_add_menu_draw().

◆ menu_fn_argN_free()

void blender::ui::Layout::menu_fn_argN_free ( StringRefNull name,
int icon,
MenuCreateFunc func,
void * argN )

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

Parameters
nameLabel to show in the menu button.
funcFunction that generates the menu layout.
argNPointer to data used as last argument in func, it will be freed with the menu button.

Definition at line 3702 of file interface_layout.cc.

References blender::ui::item_menu().

Referenced by blender::workspace_add_menu_draw().

◆ menu_pie()

Layout & blender::ui::Layout::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 5368 of file interface_layout.cc.

References block(), blender::ui::block_layout_set_current(), blender::ui::LayoutInternal::init_from_parent(), blender::ui::Item::Item(), blender::ui::item_local_sublayout(), items(), Layout(), blender::ui::LayoutRoot::layout, blender::ui::LayoutRadial, blender::ui::PieMenu, root_, and blender::ui::LayoutRoot::type.

Referenced by blender::ui::item_enum_expand_exec(), op_enum_items(), and blender::ui::pie_menu_level_invoke().

◆ offset()

◆ op() [1/4]

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

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

Parameters
opnameOperator id name.
nameText to show in the layout.
Returns
Operator pointer to write properties, might be null if operator does not exists.

Definition at line 1796 of file interface_layout.cc.

References op(), blender::ui::LayoutRoot::opcontext, root_, and UI_ITEM_NONE.

◆ op() [2/4]

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

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

Parameters
opnameOperator id name.
nameText to show in the layout.
contextOperator call context for WM_operator_name_call.
Returns
Operator pointer to write properties, might be null if operator does not exists.

Definition at line 1557 of file interface_layout.cc.

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

◆ op() [3/4]

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

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

Parameters
otOperator to add.
nameText to show in the layout.
Returns
Operator pointer to write properties.

Definition at line 1791 of file interface_layout.cc.

References op(), blender::ui::LayoutRoot::opcontext, root_, and UI_ITEM_NONE.

◆ op() [4/4]

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

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

Parameters
otOperator to add.
nameText to show in the layout.
contextOperator call context for WM_operator_name_call.
Returns
Operator pointer to write properties.

Definition at line 1533 of file interface_layout.cc.

References context(), and blender::ui::uiItemFullO_ptr_ex().

Referenced by blender::ed::geometry::add_node_group_operator_button(), blender::armature_parent_clear_invoke(), blender::armature_parent_set_invoke(), blender::bake_panel_draw(), blender::ed::asset_browser::AssetCatalogTreeViewItem::build_context_menu(), blender::ui::but_menu_add_path_operators(), blender::buttons_panel_context_draw(), blender::ed::object::collection_exporter_menu_draw(), blender::ed::object::collection_hide_menu_draw(), blender::ed::object::collection_importer_control_menu_draw(), blender::ed::object::collection_importer_menu_draw(), blender::ui::colorband_tools_fn(), blender::ui::constraint_ops_extra_draw(), blender::ed::asset::draw_asset_menu_item(), blender::nodes::draw_bake_button_row(), blender::ui::draw_constraint_header(), blender::ed::spreadsheet::draw_context_panel(), blender::ui::draw_effect_extra_menu(), blender::ui::draw_effect_panel_header(), blender::ui::draw_export_controls(), blender::nodes::socket_items::ui::draw_extend_socket_fn(), blender::nodes::draw_geometry_nodes_modifier_ui(), blender::nodes::socket_items::ui::draw_items_list_with_operators(), blender::ED_buttons_navbar_menu(), blender::ED_screens_header_tools_menu_create(), blender::ED_screens_region_flip_menu_create(), blender::file_banner_remote_asset_libraries_layout(), blender::file_os_operations_menu_item(), blender::file_panel_asset_catalog_buttons_draw(), blender::file_panel_execution_cancel_button(), blender::file_panel_execution_execute_button(), blender::generate_panel_draw(), blender::gpencil_shaderfx_ops_extra_draw(), blender::graph_draw_driver_settings_panel(), blender::graph_panel_cursor(), blender::graph_panel_drivers_popover(), blender::graph_panel_modifiers(), blender::insert_key_menu_invoke(), blender::ed::asset::shelf::library_selector_draw(), blender::menu_add_item_for_move_assign_unassign(), blender::modifier_ops_extra_draw(), blender::seq::modifier_ops_extra_draw(), blender::modifier_panel_header(), blender::seq::modifier_panel_header(), blender::move_to_collection_menu_create(), blender::ed::object::move_to_collection_menu_draw(), blender::ed::object::move_to_collection_menu_draw(), blender::nla_panel_actclip(), blender::nla_panel_modifiers(), blender::ed::space_node::node_composit_buts_cryptomatte_legacy_ex(), blender::nodes::node_composite_render_layer_cc::node_draw_buttons(), blender::ed::space_node::node_group_separate_invoke(), blender::nodes::node_geo_closure_cc::node_layout_ex(), blender::nodes::node_geo_combine_bundle_cc::node_layout_ex(), blender::nodes::node_geo_combine_list_cc::node_layout_ex(), blender::nodes::node_geo_evaluate_closure_cc::node_layout_ex(), blender::nodes::node_geo_index_switch_cc::node_layout_ex(), blender::nodes::node_geo_separate_bundle_cc::node_layout_ex(), blender::nodes::node_shader_script_cc::node_shader_buts_script(), blender::ed::space_node::node_tree_interface_draw(), op(), op(), op(), op_enum_items(), blender::ui::override_idtemplate_menu_draw(), blender::panel_draw(), blender::panel_draw(), blender::ed::object::parent_set_invoke_menu(), blender::ui::popup_block_template_confirm_op(), blender::ui::popup_context_menu_for_button(), blender::ui::popup_context_menu_for_panel(), blender::ed::object::pose_ik_add_invoke(), blender::recent_files_menu_draw(), blender::repeat_history_invoke(), blender::screen_area_menu_items(), blender::screen_area_options_invoke(), blender::screen_area_touch_menu_create(), blender::screen_context_menu_invoke(), blender::screen_user_menu_draw(), blender::ed::object::select_grouped_collection(), blender::ed::vse::sequencer_add_catalog_assets_draw(), blender::ed::vse::sequencer_add_scene_draw(), blender::ed::vse::sequencer_add_unassigned_assets_draw(), blender::shaderfx_panel_header(), blender::shape_panel_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), blender::ed::spreadsheet::spreadsheet_row_filters_layout(), blender::subdivisions_panel_draw(), blender::ui::template_cache_file(), blender::ui::template_collection_exporters(), blender::ui::template_collection_importer(), blender::ui::template_filepath_buttons(), blender::ui::template_operator_property_buts_draw_single(), blender::ui::template_operator_redo_properties(), blender::ui::template_palette_menu(), blender::ui::template_project_asset_libraries_tree(), blender::ui::template_project_splash(), blender::ui::template_recent_file(), blender::ui::template_recent_projects(), blender::ui::template_uilist_flags(), blender::text_resolve_conflict_invoke(), blender::uiTemplateEditModeSelection(), blender::uiTemplateImage(), blender::uiTemplateMovieClip(), blender::ui::uiTemplateStatusInfo(), blender::ed::object::unassigned_assets_draw(), blender::ed::vse::unassigned_assets_draw(), blender::unassigned_assets_draw(), blender::undo_history_draw_menu(), blender::unpack_menu(), blender::userpref_asset_libraries_panel_draw(), blender::uv_mark_seam_invoke(), blender::view3d_panel_vgroup(), blender::weight_sample_group_invoke(), blender::wm_block_splash_create(), blender::wm_drop_import_file_invoke(), blender::workspace_add_menu_draw(), and blender::workspace_append_button().

◆ op_enum() [1/2]

void blender::ui::Layout::op_enum ( StringRefNull opname,
StringRefNull propname )

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

Parameters
propnameName of the operator's enum property.

Definition at line 1786 of file interface_layout.cc.

References op_enum(), blender::ui::LayoutRoot::opcontext, root_, and UI_ITEM_NONE.

◆ op_enum() [2/2]

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

◆ op_enum_items()

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

◆ op_menu_enum() [1/2]

PointerRNA blender::ui::Layout::op_menu_enum ( const bContext * C,
StringRefNull opname,
StringRefNull propname,
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 null if operator does not exist.

Definition at line 3820 of file interface_layout.cc.

References C, blender::StringRefNull::c_str(), blender::ui::item_disabled(), op_menu_enum(), RNA_warning_bare, blender::wmOperatorType::srna, UI_OPERATOR_ERROR_RET, and blender::WM_operatortype_find().

◆ op_menu_enum() [2/2]

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

◆ op_menu_hold()

PointerRNA blender::ui::Layout::op_menu_hold ( wmOperatorType * ot,
std::optional< StringRef > name,
int icon,
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
otOperator to add.
nameText to show in the layout.
contextOperator call context for WM_operator_name_call.
menu_idmenu to show on held down.
Returns
Operator pointer to write properties, might be null if operator does not exists.

Definition at line 1544 of file interface_layout.cc.

References blender::BLI_strdup(), blender::ui::button_func_hold_set(), context(), blender::ui::item_menu_hold(), and blender::ui::uiItemFullO_ptr_ex().

◆ operator_context()

wm::OpCallContext blender::ui::Layout::operator_context ( ) const
nodiscard

◆ operator_context_set()

void blender::ui::Layout::operator_context_set ( wm::OpCallContext opcontext)

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

Definition at line 6137 of file interface_layout.cc.

References blender::ui::LayoutRoot::opcontext, and root_.

Referenced by blender::ed::object::collection_hide_menu_draw(), blender::ui::constraint_ops_extra_draw(), blender::ui::draw_constraint_header(), blender::ED_buttons_navbar_menu(), blender::ed_panel_draw(), blender::ED_screens_region_flip_menu_create(), blender::file_os_operations_menu_draw(), blender::file_panel_execution_buttons_draw(), blender::gpencil_shaderfx_ops_extra_draw(), blender::ed::asset::shelf::library_selector_draw(), blender::ui::menu_item_enum_opname_menu(), blender::ui::menu_item_enum_rna_menu(), blender::ui::menu_items_from_ui_create(), blender::modifier_ops_extra_draw(), blender::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(), blender::ui::popover_create_block(), blender::ui::popup_context_menu_for_button(), blender::ui::popup_menu_create_block(), blender::recent_files_menu_draw(), blender::screen_area_touch_menu_create(), blender::screen_context_menu_invoke(), blender::ed::vse::sequencer_add_scene_draw(), blender::unpack_all_invoke(), blender::unpack_item_invoke(), blender::ed::object::bake_simulation::unpack_single_bake_invoke(), blender::uv_mark_seam_invoke(), blender::weight_sample_group_invoke(), blender::wm_drop_import_file_invoke(), and blender::WM_menu_invoke_ex().

◆ overlap()

◆ panel() [1/2]

PanelLayout blender::ui::Layout::panel ( const bContext * C,
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
idnameString that identifies the open-close-state in the root panel.

Definition at line 5266 of file interface_layout.cc.

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

Referenced by blender::draw_active_library_settings(), blender::nodes::node_geo_bake_cc::draw_bake_items(), blender::ed::spreadsheet::draw_context_panel(), blender::ed::spreadsheet::draw_context_panel_content(), blender::nodes::draw_data_blocks(), blender::ui::nodes::draw_node_inputs_recursive(), blender::nodes::node_geo_simulation_cc::draw_simulation_state(), blender::ui::draw_warnings(), blender::nodes::node_composite_file_output_cc::item_layout(), blender::ui::label_markdown_dev_config(), blender::nodes::node_composite_file_output_cc::node_draw_buttons_extended(), blender::nodes::node_fn_format_string_cc::node_layout_ex(), blender::nodes::node_geo_attribute_capture_cc::node_layout_ex(), blender::nodes::node_geo_closure_cc::node_layout_ex(), blender::nodes::node_geo_closure_to_list_cc::node_layout_ex(), blender::nodes::node_geo_combine_bundle_cc::node_layout_ex(), blender::nodes::node_geo_combine_list_cc::node_layout_ex(), blender::nodes::node_geo_evaluate_closure_cc::node_layout_ex(), blender::nodes::node_geo_field_to_grid_cc::node_layout_ex(), blender::nodes::node_geo_field_to_list_cc::node_layout_ex(), blender::nodes::node_geo_foreach_geometry_element_cc::node_layout_ex(), blender::nodes::node_geo_index_switch_cc::node_layout_ex(), blender::nodes::node_geo_menu_switch_cc::node_layout_ex(), blender::nodes::node_geo_rasterize_points::node_layout_ex(), blender::nodes::node_geo_repeat_cc::node_layout_ex(), blender::nodes::node_geo_separate_bundle_cc::node_layout_ex(), blender::nodes::node_geo_viewer_cc::node_layout_ex(), blender::nodes::node_shader_raycast_cc::node_layout_ex(), blender::ed::space_node::node_tree_interface_draw(), panel(), blender::ui::paneltype_draw_impl(), popover(), blender::ui::LayoutItemPanelBody::resolve_dynamic_height(), blender::ui::LayoutItemPanelHeader::resolve_dynamic_height(), blender::ui::LayoutItemPanelBody::resolve_impl(), blender::ui::LayoutItemPanelHeader::resolve_impl(), blender::ed::spreadsheet::spreadsheet_data_set_panel_draw(), blender::ed::space_node::ui_node_draw_recursive(), and blender::uiTemplateImageSettings().

◆ panel() [2/2]

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

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

Parameters
labelText 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 5278 of file interface_layout.cc.

References blender::ui::PanelLayout::body, C, blender::ui::PanelLayout::header, label(), Layout(), and panel().

◆ panel_prop() [1/2]

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

Create a "layout panel" which is a panel that is defined as part of the Layout. 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.

Note
Only layouts that span the full width of the region are supported for now.
Parameters
CThe 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.
open_prop_ownerData that contains the open-property.
open_prop_nameName 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 5147 of file interface_layout.cc.

References block(), blender::ui::block_is_popup_any(), blender::ui::block_layout_set_current(), blender::ui::PanelLayout::body, C, blender::StringRefNull::c_str(), blender::CTX_wm_region(), blender::ARegion::flag, blender::ui::PanelLayout::header, blender::ui::LayoutInternal::init_from_parent(), blender::ui::item_disabled(), blender::ui::Label, Layout(), blender::ui::LayoutPanelBody, blender::ui::LayoutItemPanelHeader::open_prop_name, blender::ui::LayoutItemPanelHeader::open_prop_owner, uiStyle::panelspace, parent(), parent_, prop(), blender::PROP_BOOLEAN, blender::RGN_FLAG_SEARCH_FILTER_ACTIVE, blender::RNA_property_boolean_get(), blender::RNA_property_type(), blender::RNA_struct_find_property(), blender::RNA_struct_identifier(), RNA_warning_bare, root_, row(), blender::ui::Sepr, space_, blender::ui::LayoutRoot::style, uiStyle::templatespace, blender::PointerRNA::type, blender::ui::Item::type_, UI_SCALE_FAC, UI_UNIT_X, UI_UNIT_Y, blender::ui::uiDefBut(), and blender::ui::uiDefIconTextBut().

Referenced by blender::seq::brightcontrast_panel_draw(), blender::seq::colorBalance_panel_draw(), blender::seq::curves_panel_draw(), blender::nodes::draw_compositor_nodes_modifier_ui(), 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_prop(), panel_prop_with_bool_header(), blender::ui::template_collection_exporters(), blender::ui::template_collection_importer(), blender::seq::tonemapmodifier_panel_draw(), and blender::seq::whiteBalance_panel_draw().

◆ panel_prop() [2/2]

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

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

Parameters
labelText 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 5252 of file interface_layout.cc.

References blender::ui::PanelLayout::body, C, blender::ui::PanelLayout::header, label(), Layout(), and panel_prop().

◆ panel_prop_with_bool_header()

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

◆ parent()

Layout * blender::ui::Layout::parent ( ) const
nodiscard

Definition at line 6672 of file interface_layout.cc.

References Layout(), and parent_.

Referenced by blender::ui::layout_heading_find(), LayoutInternal, and panel_prop().

◆ popover() [1/2]

◆ popover() [2/2]

void blender::ui::Layout::popover ( const bContext * C,
StringRef panel_type,
std::optional< StringRef > name_opt,
int icon,
PopupAttachDirection direction = PopupAttachDirection::Vertical )

◆ popover_group()

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

◆ progress_indicator()

◆ prop() [1/2]

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

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

Parameters
ptrRNA pointer to the struct owner of prop.
propThe property in ptr to add.
indexWhen prop is a array property, indicates what entry to expose through the layout, RNA_NO_INDEX (-1) means all.

Definition at line 1982 of file interface_layout.cc.

References activate_init(), blender::blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::BLI_assert(), block(), blender::ui::block_layout_set_current(), blender::ui::BLOCK_LIST_ITEM, blender::ui::block_new_button_group(), blender::ui::BUT_ACTIVATE_ON_INIT, blender::ui::BUT_CHECKBOX_INVERT, blender::ui::BUT_FORCE_SEMI_MODAL_ACTIVE, blender::ui::BUT_LIST_ITEM, blender::ui::BUT_REDALERT, blender::ui::BUT_TEXT_LEFT, blender::ui::BUT_TEXT_RIGHT, blender::ui::button_flag_enable(), blender::ui::button_placeholder_set(), blender::ui::Block::buttons_ptrs, blender::ui::Checkbox, blender::ui::CheckboxN, column(), blender::CTX_data_main(), blender::PointerRNA::data, decorator(), blender::ui::def_but_icon_clear(), blender::ui::Button::drawflag, blender::ED_id_rename(), ELEM, blender::ui::Button::emboss, emboss_, enabled_set(), blender::ui::Block::evil_C, blender::ui::Block::first_but(), blender::ui::Block::flag, blender::ui::Item::flag_, blender::ui::Horizontal, blender::ui::Button::icon, blender::ui::IconToggle, blender::ui::IconToggleN, blender::ui::InsidePropSep, blender::blender::StringRefBase::is_empty(), blender::blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), blender::ui::item_array(), blender::ui::item_enum_expand(), blender::ui::item_name_add_colon(), blender::ui::LayoutInternal::item_prop_split_layout_hack(), blender::ui::ITEM_R_CHECKBOX_INVERT, blender::ui::ITEM_R_COMPACT, blender::ui::ITEM_R_EXPAND, blender::ui::ITEM_R_FORCE_BLANK_DECORATE, blender::ui::ITEM_R_ICON_NEVER, blender::ui::ITEM_R_ICON_ONLY, blender::ui::ITEM_R_NO_BG, blender::ui::ITEM_R_SLIDER, blender::ui::ITEM_R_SPLIT_EMPTY_NAME, blender::ui::ITEM_R_TEXT_BUT_FORCE_SEMI_MODAL_ACTIVE, blender::ui::ITEM_R_TEXT_BUT_LABEL_STYLE, blender::ui::ITEM_R_TOGGLE, blender::ui::item_rna_is_expand(), blender::ui::item_rna_size(), blender::ui::item_with_label(), blender::ui::Label, blender::ui::Block::last_but(), Layout(), blender::ui::layout_heading_find(), blender::ui::layout_heading_label_add(), len(), local_direction(), blender::max_ii(), blender::ui::Menu, blender::ui::Block::next_but(), blender::ui::None, blender::ui::NoneOrStatus, blender::nullptr, blender::ui::NumSlider, blender::PointerRNA::owner_id, blender::ui::PieMenu, blender::blender::Vector< T, InlineBufferCapacity, Allocator >::pop_last(), prop(), blender::PROP_BOOLEAN, blender::PROP_ENUM, blender::PROP_ENUM_FLAG, blender::PROP_FLOAT, blender::PROP_ICONS_CONSECUTIVE, blender::PROP_INT, blender::PROP_POINTER, blender::PROP_STRING, blender::ui::PropDecorateNoPad, PROPERTY_SPLIT_FACTOR, red_alert(), blender::blender::Vector< T, InlineBufferCapacity, Allocator >::reserve(), RNA_ENUM_VALUE, RNA_NO_INDEX, blender::RNA_property_array_check(), blender::RNA_property_array_item_char(), blender::RNA_property_array_length(), blender::RNA_property_boolean_get(), blender::RNA_property_boolean_get_index(), blender::RNA_property_editable(), blender::RNA_property_enum_get(), blender::RNA_property_flag(), blender::RNA_property_string_search_flag(), blender::RNA_property_type(), blender::RNA_property_ui_icon(), blender::RNA_property_ui_name(), blender::RNA_struct_name_property(), blender::ui::Button::rnaindex, blender::ui::Button::rnapoin, blender::ui::Button::rnaprop, root_, blender::ui::Row, row(), space_, split(), blender::ui::Button::str, str, blender::StringRef::StringRef(), blender::ui::Text, blender::ui::text_button_func_rename_full_set(), blender::ui::Toggle, blender::PointerRNA::type, blender::ui::Button::type, blender::ui::Item::type(), blender::ui::LayoutRoot::type, UI_MAX_NAME_STR, UI_UNIT_Y, blender::ui::uiDefAutoButR(), blender::ui::uiDefBut(), blender::ui::uiDefButR_prop(), blender::ui::uiDefIconButR_prop(), blender::ui::uiDefIconTextButR_prop(), use_property_decorate(), use_property_split(), and w().

Referenced by blender::nodes::add_attribute_search_button(), blender::nodes::add_attribute_search_or_value_buttons(), blender::nodes::socket_items::ops::add_item(), blender::nodes::add_layer_name_search_button(), blender::advanced_panel_draw(), blender::apply_armature_pose2bones_ui(), blender::ed::asset::shelf::asset_shelf_header_draw(), blender::axis_mapping_panel_draw(), blender::bake_panel_draw(), blender::blur_panel_draw(), blender::seq::brightcontrast_panel_draw(), blender::AssetLibraryListItem::build_row(), blender::ed::object::shapekey::ShapeKeyItem::build_row(), blender::ui::bonecollections::BoneCollectionItem::build_row(), blender::ui::ProjectAssetLibraryListItem::build_row(), blender::ui::cache_file_layer_item(), blender::caps_panel_draw(), blender::chaining_panel_draw(), blender::clamp_panel_draw(), blender::seq::colorBalance_panel_draw(), blender::ui::colorband_buttons_layout(), blender::ui::component_menu(), blender::composition_panel_draw(), blender::constant_offset_draw(), blender::constant_offset_header_draw(), blender::ui::CurveProfile_buttons_layout(), blender::cycles_panel_draw(), blender::data_panel_draw(), decorator(), decorator(), blender::draw_active_library_settings(), blender::nodes::draw_bake_data_block_list_item(), blender::nodes::draw_bake_panel(), blender::nodes::draw_common_bake_settings(), blender::ui::draw_constraint_header(), blender::ed::spreadsheet::draw_context_panel_content(), blender::modifier::greasepencil::draw_custom_curve_settings(), blender::ui::draw_effect_extra_menu(), blender::ui::draw_effect_panel_header(), blender::ui::draw_export_properties(), blender::ui::draw_exporter_item(), blender::draw_fill_tile(), blender::nodes::draw_geometry_nodes_operator_redo_ui(), blender::ed::space_node::draw_gizmo_pin_icon(), blender::nodes::socket_items::ui::draw_item_in_list(), blender::modifier::greasepencil::draw_layer_filter_settings(), blender::nodes::draw_mask_input_type_settings(), blender::seq::draw_mask_input_type_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::ed::space_node::draw_node_socket_name_editable(), blender::nodes::draw_property_for_socket(), blender::ui::draw_property_for_socket(), blender::modifier::greasepencil::draw_vertex_group_settings(), blender::seq::echomodifier_draw(), blender::ED_buttons_visible_tabs_menu(), blender::ED_screens_footer_tools_menu_create(), blender::ED_screens_header_tools_menu_create(), blender::ed_screens_statusbar_menu_create(), blender::ED_time_scrub_channel_search_draw(), blender::edbm_bevel_ui(), blender::edbm_blend_from_shape_ui(), blender::edbm_circularize_ui(), blender::edbm_curve_edge_loops_between_selected_ui(), blender::edbm_decimate_ui(), blender::edbm_fit_edge_loops_to_annotation_ui(), blender::edbm_flatten_ui(), blender::edbm_intersect_boolean_ui(), blender::edbm_intersect_ui(), blender::edbm_space_edge_loops_evenly_ui(), blender::edge_data_panel_draw(), blender::edge_panel_draw(), blender::edge_panel_draw_header(), blender::edge_types_panel_draw(), blender::envelope_panel_draw(), blender::face_corner_panel_draw(), blender::face_corner_panel_draw_header(), blender::face_corner_uv_panel_draw(), blender::face_corner_vcol_panel_draw(), blender::face_mark_panel_draw(), blender::face_mark_panel_draw_header(), blender::face_panel_draw(), blender::face_panel_draw_header(), blender::falloff_panel_draw(), blender::file_panel_asset_catalog_buttons_draw(), blender::fmodifier_delete_ui(), blender::fmodifier_frame_range_draw(), blender::fmodifier_frame_range_header_draw(), blender::fmodifier_influence_draw(), blender::fmodifier_panel_header(), blender::fn_generator_panel_draw(), blender::nodes::node_composite_file_output_cc::format_layout(), blender::generate_panel_draw(), blender::generator_panel_draw(), blender::ed::geometry::geometry_attribute_convert_ui(), blender::ed::geometry::geometry_color_attribute_add_ui(), blender::ed::geometry::geometry_color_attribute_convert_ui(), blender::geometry_panel_draw(), blender::graph_draw_driver_settings_panel(), blender::graph_panel_cursor(), blender::graph_panel_cursor_header(), blender::graph_panel_driverVar__contextProp(), blender::graph_panel_driverVar__locDiff(), blender::graph_panel_driverVar__rotDiff(), blender::graph_panel_driverVar__transChan(), blender::graph_panel_driverVar_fallback(), blender::graph_panel_key_properties(), blender::graph_panel_properties(), blender::ed::greasepencil::grease_pencil_convert_curve_type_ui(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_sequence_ui(), blender::ed::greasepencil::grease_pencil_reproject_ui(), blender::ed::greasepencil::grease_pencil_set_corner_type_ui(), blender::ed::greasepencil::grease_pencil_simplify_ui(), blender::image_new_draw(), blender::intersection_panel_draw(), blender::nodes::node_composite_file_output_cc::item_layout(), blender::ed::asset::shelf::library_selector_draw(), blender::limits_panel_draw(), blender::ed::sculpt_paint::mask::mask_from_boundary_ui(), blender::ed::sculpt_paint::mask::mask_from_cavity_ui(), blender::material_mask_panel_draw(), blender::material_mask_panel_draw_header(), blender::materials_panel_draw(), blender::ui::menu_add_shortcut(), blender::ui::menu_change_shortcut(), blender::ed::mesh::set_attribute::mesh_set_attribute_ui(), blender::mix_mode_panel_draw(), blender::modifier_grease_pencil_curve_header_draw(), blender::modifier_ops_extra_draw(), blender::seq::modifier_ops_extra_draw(), blender::modifier_panel_header(), blender::seq::modifier_panel_header(), blender::modifier_vgroup_ui(), blender::nla_panel_actclip(), blender::nla_panel_animated_influence_header(), blender::nla_panel_animated_strip_time(), blender::nla_panel_animated_strip_time_header(), blender::nla_panel_animdata(), blender::nla_panel_evaluation(), blender::nla_panel_properties(), blender::nla_panel_stripname(), blender::ed::space_node::node_buts_combsep_color(), blender::ed::space_node::node_buts_frame_ex(), blender::ed::space_node::node_buts_image_user(), blender::ed::space_node::node_buts_image_views(), blender::ed::space_node::node_buts_math(), blender::ed::space_node::node_buts_mix_rgb(), blender::ed::space_node::node_buts_normal(), blender::nodes::node_shader_output_linestyle_cc::node_buts_output_linestyle(), blender::ed::space_node::node_buts_output_shader(), blender::ed::space_node::node_buts_texture(), blender::ed::space_node::node_composit_buts_combsep_color(), blender::ed::space_node::node_composit_buts_cryptomatte(), blender::ed::space_node::node_composit_buts_cryptomatte_legacy(), blender::nodes::node_composite_color_cc::node_declare(), blender::nodes::node_composite_plane_track_deform_cc::node_declare(), blender::nodes::node_fn_input_bool_cc::node_declare(), blender::nodes::node_fn_input_color_cc::node_declare(), blender::nodes::node_fn_input_int_cc::node_declare(), blender::nodes::node_fn_input_int_vector_cc::node_declare(), blender::nodes::node_fn_input_menu_cc::node_declare(), blender::nodes::node_fn_input_rotation_cc::node_declare(), blender::nodes::node_fn_input_vector_cc::node_declare(), blender::nodes::node_geo_input_collection_cc::node_declare(), blender::nodes::node_geo_input_material_cc::node_declare(), blender::nodes::node_geo_input_object_cc::node_declare(), blender::nodes::node_geo_viewer_cc::node_declare(), blender::nodes::node_shader_bsdf_principled_cc::node_declare(), blender::nodes::node_shader_rgb_cc::node_declare(), blender::nodes::node_shader_volume_coefficients_cc::node_declare(), blender::nodes::node_composite_convert_to_display_cc::node_draw_buttons(), blender::nodes::node_composite_defocus_cc::node_draw_buttons(), blender::nodes::node_composite_file_output_cc::node_draw_buttons(), blender::nodes::node_composite_relative_to_pixel_cc::node_draw_buttons(), blender::nodes::node_composite_render_layer_cc::node_draw_buttons(), blender::nodes::node_composite_track_position_cc::node_draw_buttons(), blender::nodes::node_composite_file_output_cc::node_draw_buttons_extended(), blender::node_implicit_conversion_layout(), blender::nodes::node_fn_align_euler_to_vector_cc::node_layout(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_layout(), blender::nodes::node_fn_axes_to_rotation_cc::node_layout(), blender::nodes::node_fn_bit_math_cc::node_layout(), blender::nodes::node_fn_boolean_math_cc::node_layout(), blender::nodes::node_fn_combine_color_cc::node_layout(), blender::nodes::node_fn_compare_cc::node_layout(), blender::nodes::node_fn_float_to_int_cc::node_layout(), blender::nodes::node_fn_hash_value_cc::node_layout(), blender::nodes::node_fn_integer_math_cc::node_layout(), blender::nodes::node_fn_random_value_cc::node_layout(), blender::nodes::node_fn_rotate_euler_cc::node_layout(), blender::nodes::node_fn_rotate_rotation_cc::node_layout(), blender::nodes::node_fn_separate_color_cc::node_layout(), blender::nodes::node_fn_string_to_value_cc::node_layout(), blender::nodes::node_fn_value_to_string_cc::node_layout(), blender::nodes::node_geo_accumulate_field_cc::node_layout(), blender::nodes::node_geo_attribute_capture_cc::node_layout(), blender::nodes::node_geo_attribute_domain_size_cc::node_layout(), blender::nodes::node_geo_attribute_statistic_cc::node_layout(), blender::nodes::node_geo_bake_cc::node_layout(), blender::nodes::node_geo_blur_attribute_cc::node_layout(), blender::nodes::node_geo_bone_info_cc::node_layout(), blender::nodes::node_geo_boolean_cc::node_layout(), blender::nodes::node_geo_collection_info_cc::node_layout(), blender::nodes::node_geo_combine_list_cc::node_layout(), blender::nodes::node_geo_curve_handle_type_selection_cc::node_layout(), blender::nodes::node_geo_curve_primitive_arc_cc::node_layout(), blender::nodes::node_geo_curve_primitive_bezier_segment_cc::node_layout(), blender::nodes::node_geo_curve_primitive_circle_cc::node_layout(), blender::nodes::node_geo_curve_primitive_line_cc::node_layout(), blender::nodes::node_geo_curve_primitive_quadrilateral_cc::node_layout(), blender::nodes::node_geo_curve_sample_cc::node_layout(), blender::nodes::node_geo_curve_set_handle_type_cc::node_layout(), blender::nodes::node_geo_curve_spline_type_cc::node_layout(), blender::nodes::node_geo_curve_to_points_cc::node_layout(), blender::nodes::node_geo_curve_trim_cc::node_layout(), blender::nodes::node_geo_delete_geometry_cc::node_layout(), blender::nodes::node_geo_distribute_points_in_grid_cc::node_layout(), blender::nodes::node_geo_distribute_points_on_faces_cc::node_layout(), blender::nodes::node_geo_duplicate_elements_cc::node_layout(), blender::nodes::node_geo_enable_output_cc::node_layout(), blender::nodes::node_geo_evaluate_at_index_cc::node_layout(), blender::nodes::node_geo_evaluate_on_domain_cc::node_layout(), blender::nodes::node_geo_extrude_mesh_cc::node_layout(), blender::nodes::node_geo_field_average_cc::node_layout(), blender::nodes::node_geo_field_min_and_max_cc::node_layout(), blender::nodes::node_geo_field_to_grid_cc::node_layout(), blender::nodes::node_geo_field_variance_cc::node_layout(), blender::nodes::node_geo_filter_list_cc::node_layout(), blender::nodes::node_geo_foreach_geometry_element_cc::input_node::node_layout(), blender::nodes::node_geo_get_bundle_item_cc::node_layout(), blender::nodes::node_geo_get_named_grid_cc::node_layout(), blender::nodes::node_geo_gizmo_dial_cc::node_layout(), blender::nodes::node_geo_gizmo_linear_cc::node_layout(), blender::nodes::node_geo_grid_advect_cc::node_layout(), blender::nodes::node_geo_grid_clip_cc::node_layout(), blender::nodes::node_geo_grid_deactivate_voxels::node_layout(), blender::nodes::node_geo_grid_dilate_erode_cc::node_layout(), blender::nodes::node_geo_grid_info_cc::node_layout(), blender::nodes::node_geo_grid_mean_cc::node_layout(), blender::nodes::node_geo_grid_median_cc::node_layout(), blender::nodes::node_geo_grid_prune_cc::node_layout(), blender::nodes::node_geo_grid_to_points_cc::node_layout(), blender::nodes::node_geo_grid_topology_boolean::node_layout(), blender::nodes::node_geo_grid_voxelize_cc::node_layout(), blender::nodes::node_geo_image_texture_cc::node_layout(), blender::nodes::node_geo_index_switch_cc::node_layout(), blender::nodes::node_geo_input_named_attribute_cc::node_layout(), blender::nodes::node_geo_list_get_item_cc::node_layout(), blender::nodes::node_geo_list_length_cc::node_layout(), blender::nodes::node_geo_menu_switch_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_circle_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_cone_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_cylinder_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_line_cc::node_layout(), blender::nodes::node_geo_mesh_to_curve_cc::node_layout(), blender::nodes::node_geo_mesh_to_points_cc::node_layout(), blender::nodes::node_geo_object_info_cc::node_layout(), blender::nodes::node_geo_proximity_cc::node_layout(), blender::nodes::node_geo_raycast_cc::node_layout(), blender::nodes::node_geo_sample_grid_cc::node_layout(), blender::nodes::node_geo_sample_grid_index_cc::node_layout(), blender::nodes::node_geo_sample_index_cc::node_layout(), blender::nodes::node_geo_sample_nearest_cc::node_layout(), blender::nodes::node_geo_sample_nearest_surface_cc::node_layout(), blender::nodes::node_geo_sample_uv_surface_cc::node_layout(), blender::nodes::node_geo_scale_elements_cc::node_layout(), blender::nodes::node_geo_sdf_grid_boolean_cc::node_layout(), blender::nodes::node_geo_separate_geometry_cc::node_layout(), blender::nodes::node_geo_set_curve_handles_cc::node_layout(), blender::nodes::node_geo_set_grid_background::node_layout(), blender::nodes::node_geo_set_grid_transform::node_layout(), blender::nodes::node_geo_set_mesh_normal_cc::node_layout(), blender::nodes::node_geo_set_shade_smooth_cc::node_layout(), blender::nodes::node_geo_sort_elements_cc::node_layout(), blender::nodes::node_geo_sort_list_cc::node_layout(), blender::nodes::node_geo_split_to_instances_cc::node_layout(), blender::nodes::node_geo_store_bundle_item_cc::node_layout(), blender::nodes::node_geo_store_named_attribute_cc::node_layout(), blender::nodes::node_geo_store_named_grid_cc::node_layout(), blender::nodes::node_geo_switch_cc::node_layout(), blender::nodes::node_geo_tool_active_element_cc::node_layout(), blender::nodes::node_geo_tool_set_selection_cc::node_layout(), blender::nodes::node_geo_warning_cc::node_layout(), blender::nodes::node_fn_input_int_vector_cc::node_layout_ex(), blender::nodes::node_fn_input_vector_cc::node_layout_ex(), blender::nodes::node_geo_attribute_capture_cc::node_layout_ex(), blender::nodes::node_geo_bake_cc::node_layout_ex(), blender::nodes::node_geo_closure_cc::node_layout_ex(), blender::nodes::node_geo_combine_bundle_cc::node_layout_ex(), blender::nodes::node_geo_curve_resample_cc::node_layout_ex(), blender::nodes::node_geo_distribute_points_on_faces_cc::node_layout_ex(), blender::nodes::node_geo_evaluate_closure_cc::node_layout_ex(), blender::nodes::node_geo_foreach_geometry_element_cc::node_layout_ex(), blender::nodes::node_geo_get_bundle_item_cc::node_layout_ex(), blender::nodes::node_geo_gizmo_transform_cc::node_layout_ex(), blender::nodes::node_geo_index_switch_cc::node_layout_ex(), blender::nodes::node_geo_input_normal_cc::node_layout_ex(), blender::nodes::node_geo_list_get_item_cc::node_layout_ex(), blender::nodes::node_geo_menu_switch_cc::node_layout_ex(), blender::nodes::node_geo_realize_instances_cc::node_layout_ex(), blender::nodes::node_geo_repeat_cc::node_layout_ex(), blender::nodes::node_geo_separate_bundle_cc::node_layout_ex(), blender::nodes::node_geo_store_bundle_item_cc::node_layout_ex(), blender::nodes::node_shader_raycast_cc::node_layout_ex(), blender::nodes::node_shader_raycast_cc::node_shader_buts(), blender::nodes::node_shader_ambient_occlusion_cc::node_shader_buts_ambient_occlusion(), blender::nodes::node_shader_attribute_cc::node_shader_buts_attribute(), blender::nodes::node_shader_bevel_cc::node_shader_buts_bevel(), blender::nodes::node_shader_bump_cc::node_shader_buts_bump(), blender::nodes::node_shader_clamp_cc::node_shader_buts_clamp(), blender::ed::space_node::node_shader_buts_displacement(), blender::nodes::node_shader_bsdf_glass_cc::node_shader_buts_glass(), blender::ed::space_node::node_shader_buts_glossy(), blender::nodes::node_shader_bsdf_glossy_cc::node_shader_buts_glossy(), blender::nodes::node_shader_bsdf_hair_cc::node_shader_buts_hair(), blender::nodes::node_shader_ies_light_cc::node_shader_buts_ies(), blender::nodes::node_shader_light_evaluation_cc::node_shader_buts_light_evaluation(), blender::nodes::node_shader_map_range_cc::node_shader_buts_map_range(), blender::nodes::node_shader_mapping_cc::node_shader_buts_mapping(), blender::nodes::node_shader_bsdf_metallic_cc::node_shader_buts_metallic(), blender::nodes::node_shader_normal_map_cc::node_shader_buts_normal_map(), blender::nodes::node_shader_output_aov_cc::node_shader_buts_output_aov(), blender::nodes::node_shader_bsdf_hair_principled_cc::node_shader_buts_principled_hair(), blender::nodes::node_shader_radial_tiling_cc::node_shader_buts_radial_tiling(), blender::ed::space_node::node_shader_buts_scatter(), blender::nodes::node_shader_volume_scatter_cc::node_shader_buts_scatter(), blender::nodes::node_shader_script_cc::node_shader_buts_script(), blender::nodes::node_shader_script_cc::node_shader_buts_script_ex(), blender::nodes::node_shader_bsdf_sheen_cc::node_shader_buts_sheen(), blender::nodes::node_shader_subsurface_scattering_cc::node_shader_buts_subsurface(), blender::nodes::node_shader_tangent_cc::node_shader_buts_tangent(), blender::nodes::node_shader_tex_brick_cc::node_shader_buts_tex_brick(), blender::nodes::node_shader_tex_coord_cc::node_shader_buts_tex_coord(), blender::ed::space_node::node_shader_buts_tex_environment(), blender::ed::space_node::node_shader_buts_tex_environment_ex(), blender::nodes::node_shader_tex_gabor_cc::node_shader_buts_tex_gabor(), blender::nodes::node_shader_tex_gradient_cc::node_shader_buts_tex_gradient(), blender::ed::space_node::node_shader_buts_tex_image(), blender::nodes::node_shader_tex_magic_cc::node_shader_buts_tex_magic(), blender::nodes::node_shader_tex_noise_cc::node_shader_buts_tex_noise(), blender::nodes::node_shader_tex_sky_cc::node_shader_buts_tex_sky(), blender::nodes::node_shader_tex_voronoi_cc::node_shader_buts_tex_voronoi(), blender::nodes::node_shader_tex_wave_cc::node_shader_buts_tex_wave(), blender::nodes::node_shader_bsdf_toon_cc::node_shader_buts_toon(), blender::nodes::node_shader_uv_along_stroke_cc::node_shader_buts_uvalongstroke(), blender::nodes::node_shader_uvmap_cc::node_shader_buts_uvmap(), blender::nodes::node_shader_vector_math_cc::node_shader_buts_vect_math(), blender::nodes::node_shader_vector_transform_cc::node_shader_buts_vect_transform(), blender::nodes::node_shader_vector_rotate_cc::node_shader_buts_vector_rotate(), blender::nodes::node_shader_vertex_color_cc::node_shader_buts_vertex_color(), blender::nodes::node_shader_tex_white_noise_cc::node_shader_buts_white_noise(), blender::nodes::node_shader_wireframe_cc::node_shader_buts_wireframe(), blender::ed::space_node::node_texture_buts_bricks(), blender::ed::space_node::node_texture_buts_combsep_color(), blender::ed::space_node::node_texture_buts_output(), blender::ed::space_node::node_texture_buts_proc(), blender::ed::space_node::node_tree_interface_draw(), blender::noise_panel_draw(), blender::normals_panel_draw(), blender::ed::object::object_convert_ui(), blender::object_offset_draw(), blender::object_offset_header_draw(), blender::occlusion_panel_draw(), blender::offset_panel_draw(), op_enum(), op_enum_items(), blender::options_light_reference_draw(), blender::options_panel_draw(), blender::ed::outliner::outliner_orphans_purge_ui(), blender::panel_draw(), blender::panel_draw(), panel_prop(), panel_prop_with_bool_header(), blender::path_panel_draw(), blender::path_panel_draw_header(), blender::seq::pitchmodifier_draw(), blender::ed::asset::shelf::popover_panel_draw(), blender::ui::popup_context_menu_for_panel(), blender::position_panel_draw(), blender::preferences_asset_library_add_ui(), blender::preferences_extension_repo_add_ui(), blender::profile_panel_draw(), blender::project_asset_library_add_ui(), blender::project_new_ui(), prop(), prop(), prop_enum(), prop_enum(), prop_enum(), prop_menu_enum(), prop_search(), prop_search(), prop_tabs_enum(), prop_with_menu(), prop_with_menu(), prop_with_popover(), props_enum(), blender::random_panel_draw(), blender::random_panel_header_draw(), blender::relative_offset_draw(), blender::relative_offset_header_draw(), blender::restrictions_panel_draw(), blender::screen_user_menu_draw(), blender::ed::sculpt_paint::color::sculpt_color_filter_ui(), blender::ed::sculpt_paint::filter::sculpt_mesh_ui_exec(), blender::segment_list_item_draw(), blender::ed::curves::select_ends_ui(), blender::ed::curves::select_random_ui(), blender::ed::pointcloud::select_random_ui(), blender::ed::sculpt_paint::select_random::select_random_ui(), blender::ed::vse::sequencer_add_ui(), blender::ed::vse::sequencer_box_blade_ui(), blender::ed::vse::sequencer_split_ui(), blender::ed::curves::set_attribute_ui(), blender::ed::pointcloud::set_attribute_ui(), blender::nodes::node_sh_mix_cc::sh_node_mix_layout(), blender::nodes::node_shader_value_cc::sh_node_value_declare(), blender::ed::object::shade_auto_smooth_ui(), blender::shaderfx_panel_header(), blender::shading_panel_draw(), blender::smooth_panel_draw(), blender::solver_options_panel_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), blender::ed::space_node::std_node_socket_draw(), blender::ed::space_node::std_node_socket_interface_draw(), blender::stepped_panel_draw(), blender::symmetry_panel_draw(), blender::symmetry_panel_header_draw(), blender::ui::template_any_id(), blender::ui::template_cache_file(), blender::ui::template_cache_file_time_settings(), blender::ui::template_cache_file_velocity(), blender::ui::template_colormanaged_view_settings(), blender::ui::template_filepath_buttons(), blender::ui::template_keymap_item_properties(), blender::ui::template_path_builder(), blender::ui::template_preview(), textbox_with_state(), blender::texture_paint_add_texture_paint_slot_ui(), blender::texture_panel_draw(), blender::tile_add_draw(), blender::time_panel_draw(), blender::time_remapping_panel_draw(), blender::seq::tonemapmodifier_panel_draw(), blender::transform_panel_draw(), blender::ed::space_node::ui_node_draw_input(), blender::ed::space_node::ui_node_draw_recursive(), blender::ui::uiDefAutoButsRNA(), blender::ui::uilist_draw_filter_default(), blender::ui::uilist_draw_item_default(), blender::uiTemplateImage(), blender::uiTemplateImageFormatViews(), blender::uiTemplateImageSettings(), blender::uiTemplateImageStereo3d(), blender::uiTemplateMovieClip(), blender::uiTemplatePaintModeSelection(), blender::uiTemplateViewsFormat(), blender::unwrap_draw(), blender::uv_pack_islands_ui(), blender::uv_panel_draw(), blender::v3d_editarmature_buts(), blender::v3d_editmetaball_buts(), blender::v3d_transform_butsR(), blender::velocity_panel_draw(), blender::vert_vcol_panel_draw(), blender::vertex_group_panel_draw(), blender::vertex_panel_draw(), blender::vertex_panel_draw_header(), blender::vertex_vgroup_panel_draw(), blender::vgroup_panel_draw(), blender::view3d_panel_vgroup(), blender::wave_header_draw(), blender::wave_panel_draw(), blender::weightvg_ui_common(), blender::seq::whiteBalance_panel_draw(), blender::wm_clear_recent_files_ui(), blender::wm_open_mainfile_ui(), blender::wm_stereo3d_set_draw(), and blender::wm_xr_viewfinder_ui_action_enum_block().

◆ prop() [2/2]

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

◆ prop_enum() [1/3]

◆ prop_enum() [2/3]

void blender::ui::Layout::prop_enum ( PointerRNA * ptr,
PropertyRNA * prop,
int value,
std::optional< 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 2544 of file interface_layout.cc.

References blender::StringRefNull::c_str(), blender::ui::item_disabled(), prop(), blender::PROP_ENUM, RNA_ENUM_VALUE, blender::RNA_property_identifier(), blender::RNA_property_type(), blender::RNA_struct_identifier(), RNA_warning_bare, blender::PointerRNA::type, and UI_ITEM_NONE.

Referenced by prop_enum(), props_enum(), and blender::wm_xr_viewfinder_ui_action_enum_block().

◆ prop_enum() [3/3]

void blender::ui::Layout::prop_enum ( PointerRNA * ptr,
StringRefNull propname,
const char * value,
std::optional< 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 2613 of file interface_layout.cc.

References blender::StringRefNull::c_str(), blender::ui::item_disabled(), prop(), prop_enum(), blender::RNA_struct_find_property(), blender::RNA_struct_identifier(), RNA_warning_bare, and blender::PointerRNA::type.

◆ prop_menu_enum()

◆ prop_search() [1/2]

void blender::ui::Layout::prop_search ( PointerRNA * ptr,
PropertyRNA * prop,
PointerRNA * searchptr,
PropertyRNA * searchprop,
PropertyRNA * item_searchpropname,
std::optional< 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
searchpropCollection property in searchptr from where to take input values.
item_searchpropnameThe name of the string property in the collection items to use for searching (if unset, code will use RNA_struct).
results_are_suggestionsAllow inputs that not match any suggested value.

Definition at line 2858 of file interface_layout.cc.

References blender::BLI_assert(), block(), blender::ui::block_new_button_group(), blender::ui::button_configure_search(), ELEM, blender::ui::item_name_add_colon(), blender::ui::item_rna_size(), blender::ui::item_with_label(), prop(), blender::PROP_COLLECTION, blender::PROP_ENUM, blender::PROP_POINTER, blender::PROP_STRING, blender::RNA_property_identifier(), blender::RNA_property_pointer_type(), blender::RNA_property_type(), blender::RNA_property_ui_name(), blender::RNA_struct_identifier(), blender::RNA_struct_ui_icon(), RNA_warning_bare, blender::ui::SearchMenu, blender::PointerRNA::type, blender::ui::Button::type, blender::ui::Item::type(), UI_MAX_NAME_STR, UI_UNIT_X, use_property_split(), and w().

Referenced by blender::modifier::greasepencil::draw_layer_filter_settings(), blender::nodes::draw_mask_input_type_settings(), blender::seq::draw_mask_input_type_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::nodes::draw_property_for_socket(), blender::ui::draw_property_for_socket(), blender::modifier::greasepencil::draw_vertex_group_settings(), blender::edbm_blend_from_shape_ui(), blender::graph_panel_driverVar__locDiff(), blender::graph_panel_driverVar__rotDiff(), blender::graph_panel_driverVar__transChan(), blender::layers_panel_draw(), blender::modifier_vgroup_ui(), blender::nodes::node_composite_plane_track_deform_cc::node_declare(), blender::nodes::node_composite_keying_screen_cc::node_draw_buttons(), blender::nodes::node_composite_track_position_cc::node_draw_buttons(), blender::nodes::node_shader_normal_map_cc::node_shader_buts_normal_map(), blender::nodes::node_shader_output_aov_cc::node_shader_buts_output_aov(), 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(), blender::panel_draw(), prop_search(), blender::texture_panel_draw(), blender::vertex_group_panel_draw(), blender::vgroup_panel_draw(), and blender::weightvg_ui_common().

◆ prop_search() [2/2]

void blender::ui::Layout::prop_search ( PointerRNA * ptr,
StringRefNull propname,
PointerRNA * searchptr,
StringRefNull searchpropname,
std::optional< 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
searchpropnameCollection property in searchptr from where to take input values.

Definition at line 2936 of file interface_layout.cc.

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

◆ prop_tabs_enum()

void blender::ui::Layout::prop_tabs_enum ( bContext * C,
PointerRNA * ptr,
PropertyRNA * prop,
PointerRNA * ptr_highlight,
PropertyRNA * prop_highlight,
bool icon_only,
EnumTabExpand expand_as = EnumTabExpand::Default )

Expands enum property value items as tabs buttons.

Definition at line 3873 of file interface_layout.cc.

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

◆ prop_with_menu() [1/2]

void blender::ui::Layout::prop_with_menu ( PointerRNA * ptr,
blender::StringRefNull propname,
eUI_Item_Flag flag,
std::optional< blender::StringRefNull > name,
int icon,
const char * menu_type )

◆ prop_with_menu() [2/2]

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

◆ prop_with_popover()

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

◆ props_enum()

◆ red_alert()

bool blender::ui::Layout::red_alert ( ) const
inlinenodiscard

◆ red_alert_set()

◆ resolve()

◆ resolve_dynamic_height()

◆ resolve_impl()

◆ root()

◆ root_panel()

◆ row() [1/2]

Layout & blender::ui::Layout::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 5135 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), uiStyle::buttonspacex, blender::ui::LayoutInternal::init_from_parent(), Layout(), root_, space_, and blender::ui::LayoutRoot::style.

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), blender::nodes::socket_items::ops::add_item(), blender::advanced_panel_draw(), blender::armature_parent_clear_invoke(), blender::armature_parent_set_invoke(), blender::ed::asset::shelf::asset_shelf_header_draw(), blender::axis_mapping_panel_draw(), blender::ed::asset::shelf::build_asset_view(), blender::ui::TreeViewLayoutBuilder::build_from_tree(), blender::ui::GridViewLayoutBuilder::build_from_view(), blender::ed::asset::shelf::AssetViewItem::build_grid_tile(), blender::AssetLibraryListItem::build_row(), blender::AssetLibraryRepoItem::build_row(), blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::build_row(), blender::ed::object::shapekey::ShapeKeyItem::build_row(), blender::ui::bonecollections::BoneCollectionItem::build_row(), blender::ui::greasepencil::LayerGroupViewItem::build_row(), blender::ui::greasepencil::LayerViewItem::build_row(), blender::ui::ProjectAssetLibraryListItem::build_row(), blender::ui::TreeViewLayoutBuilder::build_row(), blender::buttons_panel_context_draw(), blender::ui::cache_file_layer_item(), blender::clamp_panel_draw(), blender::ed::object::collection_hide_menu_draw(), blender::ui::colorband_buttons_layout(), blender::ui::curvemap_buttons_layout(), blender::ui::CurveProfile_buttons_layout(), blender::data_panel_draw(), blender::draw_active_library_settings(), blender::ed::asset::draw_asset_menu_item(), blender::nodes::draw_bake_button_row(), blender::nodes::draw_bake_data_block_list_item(), blender::ui::draw_constraint_header(), blender::modifier::greasepencil::draw_custom_curve_settings(), blender::ui::draw_effect_extra_menu(), blender::ui::draw_effect_panel_header(), blender::nodes::draw_error_message(), blender::ui::draw_export_controls(), blender::ui::draw_exporter_item(), blender::ui::draw_import_controls(), blender::nodes::socket_items::ui::draw_item_in_list(), blender::nodes::socket_items::ui::draw_items_list_with_operators(), blender::modifier::greasepencil::draw_layer_filter_settings(), blender::nodes::draw_mask_input_type_settings(), blender::seq::draw_mask_input_type_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::ui::draw_matrix_template(), blender::ui::nodes::draw_node_input(), blender::nodes::draw_property_for_socket(), blender::ui::draw_property_for_socket(), blender::modifier::greasepencil::draw_vertex_group_settings(), blender::ed_panel_draw(), blender::edbm_bevel_ui(), blender::edbm_circularize_ui(), blender::edbm_curve_edge_loops_between_selected_ui(), blender::edbm_decimate_ui(), blender::edbm_fit_edge_loops_to_annotation_ui(), blender::edbm_flatten_ui(), blender::edbm_intersect_boolean_ui(), blender::edbm_intersect_ui(), blender::edbm_space_edge_loops_evenly_ui(), blender::edge_types_panel_draw(), blender::envelope_panel_draw(), blender::falloff_panel_draw(), blender::file_banner_remote_asset_libraries_layout(), blender::file_draw_banner(), blender::file_panel_asset_catalog_buttons_draw(), blender::file_panel_execution_buttons_draw(), blender::file_panel_execution_cancel_button(), blender::file_panel_execution_execute_button(), blender::fmodifier_influence_draw(), blender::fmodifier_panel_header(), blender::generate_panel_draw(), blender::generator_panel_draw(), blender::geometry_panel_draw(), blender::graph_draw_driven_property_panel(), blender::graph_draw_driver_settings_panel(), blender::graph_panel_driverVar__contextProp(), blender::graph_panel_driverVar__singleProp(), blender::graph_panel_driverVar_fallback(), blender::graph_panel_modifiers(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_sequence_ui(), blender::ed::greasepencil::grease_pencil_reproject_ui(), blender::intersection_panel_draw(), blender::ui::item_local_sublayout(), blender::ui::LayoutInternal::item_prop_split_layout_hack(), blender::ui::item_with_label(), blender::ui::label_markdown_dev_config(), blender::ui::label_markdown_dev_config_block_margins_table(), blender::ui::label_markdown_dev_config_details_row(), blender::ui::label_markdown_dev_config_headers_table(), blender::ui::label_markdown_dev_config_list_spacing_table(), blender::ed::asset::shelf::library_selector_draw(), blender::limits_panel_draw(), link(), blender::material_mask_panel_draw(), blender::metadata_panel_draw_field(), blender::mix_mode_panel_draw(), blender::modifier_error_message_draw(), blender::modifier_ops_extra_draw(), blender::seq::modifier_ops_extra_draw(), blender::modifier_panel_header(), blender::seq::modifier_panel_header(), blender::modifier_vgroup_ui(), blender::move_to_collection_menu_create(), blender::nla_panel_actclip(), blender::nla_panel_animdata(), blender::nla_panel_modifiers(), blender::nla_panel_properties(), blender::nla_panel_stripname(), blender::ed::space_node::node_buts_mix_rgb(), blender::nodes::node_shader_output_linestyle_cc::node_buts_output_linestyle(), blender::ed::space_node::node_composit_buts_cryptomatte(), blender::ed::space_node::node_composit_buts_cryptomatte_legacy(), blender::nodes::node_fn_input_bool_cc::node_declare(), blender::nodes::node_fn_input_int_cc::node_declare(), blender::nodes::node_fn_input_int_vector_cc::node_declare(), blender::nodes::node_fn_input_menu_cc::node_declare(), blender::nodes::node_fn_input_rotation_cc::node_declare(), blender::nodes::node_fn_input_vector_cc::node_declare(), blender::nodes::node_composite_render_layer_cc::node_draw_buttons(), blender::nodes::node_geo_bake_cc::node_layout(), blender::nodes::node_geo_bake_cc::node_layout_ex(), blender::nodes::node_geo_combine_list_cc::node_layout_ex(), blender::nodes::node_geo_index_switch_cc::node_layout_ex(), blender::nodes::node_geo_simulation_cc::node_layout_ex(), blender::nodes::node_shader_ies_light_cc::node_shader_buts_ies(), blender::nodes::node_shader_script_cc::node_shader_buts_script(), blender::ed::space_node::node_texture_buts_proc(), blender::ed::space_node::node_tree_interface_draw(), blender::ed::space_node::node_update_basis_socket(), blender::options_panel_draw(), blender::ed::outliner::outliner_orphans_purge_ui(), blender::panel_draw(), blender::panel_draw(), panel_prop(), blender::ui::paneltype_draw_impl(), popover(), blender::ed::asset::shelf::popover_panel_draw(), blender::preferences_asset_library_add_ui(), blender::preferences_extension_repo_add_ui(), blender::profile_panel_draw(), blender::project_new_ui(), prop(), resolve_dynamic_height(), blender::ui::LayoutItemGridFlow::resolve_impl(), blender::restrictions_panel_draw(), row(), blender::screen_user_menu_draw(), blender::ed::sculpt_paint::filter::sculpt_mesh_ui_exec(), blender::segment_list_item_draw(), blender::ed::vse::sequencer_split_ui(), blender::nodes::node_shader_value_cc::sh_node_value_declare(), blender::shaderfx_panel_end(), blender::shaderfx_panel_header(), blender::shape_panel_draw(), blender::seq::sound_equalizermodifier_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), blender::ed::space_node::std_node_socket_draw(), blender::stepped_panel_draw(), blender::subdivisions_panel_draw(), blender::ui::template_action(), blender::ui::template_any_id(), blender::ui::template_asset_shelf_popover(), blender::ui::template_breadcrumbs(), blender::ui::template_cache_file(), blender::ui::template_cache_file_time_settings(), blender::ui::template_collection_exporters(), blender::ui::template_collection_importer(), blender::ui::template_color_picker(), blender::ui::template_filepath_buttons(), blender::ui::template_filepath_split_name_buttons(), blender::ui::template_id(), blender::ui::template_ID_session_uid(), blender::ui::template_keymap_item_properties(), blender::ui::template_layers(), blender::ui::template_node_inputs(), blender::ui::template_operator_property_buts_draw_single(), blender::ui::template_palette(), blender::ui::template_palette_menu(), blender::ui::template_path_builder(), blender::ui::template_preview(), blender::ui::template_project_asset_libraries_tree(), blender::ui::template_project_splash(), blender::ui::template_running_jobs(), blender::ui::template_search_buttons(), blender::ui::template_uilist_flags(), blender::ui::template_uilist_layout_draw(), textbox_with_state(), blender::ed::space_node::ui_node_draw_input(), blender::uiblock_layer_pass_buttons(), blender::ui::uiItemPropertySplitWrapperCreate(), blender::ui::uiItemsAlertBox(), blender::ui::uiLayoutListItemAddPadding(), blender::ui::uilist_draw_filter_default(), blender::uiTemplateEditModeSelection(), blender::uiTemplateImage(), blender::uiTemplateImageSettings(), blender::ui::uiTemplateInputStatus(), blender::uiTemplateMovieClip(), blender::uiTemplatePaintModeSelection(), blender::ui::uiTemplateStatusInfo(), blender::undo_history_draw_menu(), blender::userpref_asset_libraries_panel_draw(), blender::uv_pack_islands_ui(), blender::v3d_transform_butsR(), blender::vertex_group_panel_draw(), blender::vgroup_panel_draw(), blender::view3d_panel_curve_data(), blender::view3d_panel_vgroup(), blender::wm_block_about_create(), blender::WM_window_modal_keymap_status_draw(), blender::wm_xr_viewfinder_ui_action_enum_block(), and blender::workspace_add_menu().

◆ row() [2/2]

Layout & blender::ui::Layout::row ( bool align,
StringRef heading )

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

Parameters
headingHeading label to set to the first child element added in the sub-layout through #Layout::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 5298 of file interface_layout.cc.

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

◆ scale_x()

float blender::ui::Layout::scale_x ( ) const
inlinenodiscard

Definition at line 851 of file UI_interface_layout.hh.

References scale_.

Referenced by estimate(), and blender::ui::text_icon_width_ex().

◆ scale_x_set()

◆ scale_y()

float blender::ui::Layout::scale_y ( ) const
inlinenodiscard

Definition at line 860 of file UI_interface_layout.hh.

References scale_.

Referenced by estimate().

◆ scale_y_set()

◆ search_weight()

float blender::ui::Layout::search_weight ( ) const
inlinenodiscard

Definition at line 842 of file UI_interface_layout.hh.

References search_weight_.

◆ search_weight_set()

void blender::ui::Layout::search_weight_set ( float weight)
inline

Definition at line 846 of file UI_interface_layout.hh.

References search_weight_.

◆ separator()

void blender::ui::Layout::separator ( float factor = 1.0f,
LayoutSeparatorType type = LayoutSeparatorType::Auto )

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

Definition at line 3585 of file interface_layout.cc.

References blender::ui::Auto, block(), blender::ui::block_can_add_separator(), blender::ui::block_is_menu(), blender::ui::block_is_pie_menu(), blender::ui::block_layout_set_current(), blender::ui::ButtonSeparatorLine::is_vertical, blender::ui::Line, blender::ui::Sepr, blender::ui::SeprLine, blender::ui::Item::type(), UI_SCALE_FAC, UI_UNIT_Y, blender::ui::uiDefBut(), and w_.

Referenced by blender::ed::asset::shelf::add_catalog_tabs(), blender::ui::alert_create(), blender::ed::asset::shelf::asset_shelf_header_draw(), blender::block_create__close_file_dialog(), blender::block_create_autorun_warning(), blender::block_create_save_file_overwrite_dialog(), blender::block_create_save_modified_images_dialog(), blender::ed::asset::shelf::build_asset_view(), blender::ui::TreeViewLayoutBuilder::build_from_tree(), blender::catalog_assets_draw(), blender::ed::geometry::catalog_assets_draw(), blender::ed::object::catalog_assets_draw(), blender::ed::vse::catalog_assets_draw(), blender::ed::geometry::catalog_assets_draw_unassigned(), blender::ed::object::collection_importer_control_menu_draw(), blender::seq::colorBalance_panel_draw(), blender::ui::colorband_tools_fn(), blender::ui::constraint_ops_extra_draw(), blender::ui::create_title_button(), blender::ui::def_but_rna__menu(), blender::ui::draw_constraint_header(), blender::ui::draw_effect_extra_menu(), blender::ui::draw_effect_panel_header(), blender::ui::draw_import_properties(), blender::ED_region_header_layout(), blender::ED_screens_footer_tools_menu_create(), blender::ED_screens_header_tools_menu_create(), blender::edbm_bevel_ui(), blender::edbm_intersect_boolean_ui(), blender::edbm_intersect_ui(), blender::file_overwrite_detailed_info_show(), blender::file_panel_asset_catalog_buttons_draw(), blender::fmodifier_influence_draw(), blender::fmodifier_panel_header(), blender::geometry_panel_draw(), blender::gpencil_shaderfx_ops_extra_draw(), blender::graph_draw_driver_settings_panel(), blender::graph_panel_drivers_popover(), blender::image_save_as_draw(), blender::insert_key_menu_invoke(), blender::ui::item_enum_expand_exec(), blender::ui::label_markdown_dev_config(), blender::modifier_ops_extra_draw(), blender::seq::modifier_ops_extra_draw(), blender::modifier_panel_header(), blender::seq::modifier_panel_header(), blender::move_to_collection_menu_create(), blender::ed::object::move_to_collection_menu_draw(), blender::ed::object::move_to_collection_menu_draw(), blender::nla_panel_animdata(), blender::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_tree_interface_draw(), 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(), blender::panel_draw(), blender::ui::popup_context_menu_for_button(), blender::ui::popup_context_menu_for_panel(), blender::ui::popup_menu_reports(), blender::preferences_extension_repo_add_ui(), prop_with_menu(), props_enum(), blender::recent_files_menu_draw(), blender::recent_files_menu_list(), blender::ed::object::root_catalogs_draw(), blender::ed::space_node::root_catalogs_draw(), blender::ed::vse::root_catalogs_draw(), blender::root_catalogs_draw(), blender::screen_area_menu_items(), blender::screen_area_options_invoke(), blender::screen_area_touch_menu_create(), blender::screen_user_menu_draw(), blender::ed::vse::sequencer_add_catalog_assets_draw(), blender::ed::vse::sequencer_add_scene_draw(), blender::ed::vse::sequencer_add_ui(), blender::ed::vse::sequencer_split_ui(), blender::shaderfx_panel_header(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw_header(), blender::subdivisions_panel_draw(), blender::ui::template_collection_exporters(), blender::ui::template_collection_importer(), blender::ui::template_color_picker(), blender::ui::template_event_from_keymap_item(), blender::ui::template_keymap_item_properties(), blender::ui::template_preview(), blender::ui::template_project_asset_libraries_tree(), blender::ui::template_project_splash(), blender::ui::template_status_bar_modal_item(), blender::ui::template_uilist_flags(), blender::ui_imageuser_layer_menu(), blender::ui_imageuser_pass_menu(), blender::ui_imageuser_slot_menu(), blender::ui_imageuser_view_menu_multiview(), blender::ui_imageuser_view_menu_rr(), blender::ed::space_node::ui_node_draw_input(), blender::uiTemplateImage(), blender::ui::uiTemplateInputStatus(), blender::ui::uiTemplateInputStatus3DView(), blender::ui::uiTemplateInputStatusAzone(), blender::ui::uiTemplateInputStatusBorder(), blender::ui::uiTemplateInputStatusHeader(), blender::uiTemplateMovieClip(), blender::ui::uiTemplateStatusInfo(), blender::ed::object::unassigned_assets_draw(), blender::ed::vse::unassigned_assets_draw(), blender::unassigned_assets_draw(), blender::unwrap_draw(), blender::userpref_asset_libraries_panel_draw(), blender::uv_pack_islands_ui(), blender::wm_block_about_create(), blender::wm_block_create_redo(), blender::wm_block_dialog_create(), blender::wm_block_image_save_errors(), blender::wm_block_insert_unicode_create(), blender::wm_block_splash_create(), blender::wm_clear_recent_files_ui(), blender::workspace_add_menu(), and blender::workspace_add_menu_draw().

◆ separator_spacer()

◆ size()

◆ split()

Layout & blender::ui::Layout::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 split between the first item and remaining items.

Parameters
percentageWidth percent to split.

Definition at line 5450 of file interface_layout.cc.

References align(), block(), blender::ui::block_layout_set_current(), uiStyle::columnspace, blender::ui::LayoutInternal::init_from_parent(), Layout(), root_, split(), and blender::ui::LayoutRoot::style.

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), blender::nodes::add_layer_name_search_button(), blender::ui::alert_create(), blender::block_create__close_file_dialog(), blender::block_create_autorun_warning(), blender::block_create_save_file_overwrite_dialog(), blender::block_create_save_modified_images_dialog(), blender::seq::colorBalance_panel_draw(), blender::ui::colorband_buttons_layout(), blender::ui::curvemap_buttons_layout(), blender::ui::def_but_rna__menu(), blender::nodes::draw_named_attributes_panel(), blender::nodes::draw_property_for_output_socket(), blender::generator_panel_draw(), blender::graph_panel_key_properties(), blender::ed::space_node::node_buts_image_user(), blender::nodes::node_composite_color_balance_cc::node_declare(), op_enum_items(), blender::panel_draw(), blender::ui::popup_block_template_confirm_op(), blender::project_new_ui(), prop(), props_enum(), blender::seq::sound_equalizermodifier_draw(), split(), blender::ed::space_node::std_node_socket_draw(), blender::ui::template_any_id(), blender::ed::space_node::ui_template_node_link_menu(), blender::ui::uiItemPropertySplitWrapperCreate(), blender::ui::uiItemsAlertBox(), blender::undo_history_draw_menu(), blender::v3d_transform_butsR(), blender::view3d_panel_curve_data(), blender::view3d_panel_vgroup(), blender::wm_block_dialog_create(), blender::wm_block_insert_unicode_create(), and blender::wm_block_splash_create().

◆ textbox()

void blender::ui::Layout::textbox ( const bContext * C,
PointerRNA * ptr,
StringRefNull propname,
std::optional< StringRefNull > name_opt = std::nullopt,
std::optional< StringRefNull > placeholder = std::nullopt,
const int initial_visible_lines = 3 )

Adds a string property item as textbox, this will let multi-line text editing, textbox state will stored in the current context region.

Definition at line 2808 of file interface_layout.cc.

References C, blender::CTX_wm_region(), blender::RNA_struct_identifier(), blender::ui::textbox_ensure_state(), textbox_with_state(), and blender::PointerRNA::type.

Referenced by blender::ed::space_node::node_tree_interface_draw().

◆ textbox_with_state()

◆ ui_units_x()

float blender::ui::Layout::ui_units_x ( ) const
inlinenodiscard

◆ ui_units_x_set()

◆ ui_units_y()

float blender::ui::Layout::ui_units_y ( ) const
inlinenodiscard

Definition at line 878 of file UI_interface_layout.hh.

References units_.

Referenced by estimate().

◆ ui_units_y_set()

void blender::ui::Layout::ui_units_y_set ( float height)
inline

Sets a fixed height size for this layout.

Definition at line 882 of file UI_interface_layout.hh.

References units_.

Referenced by blender::ed::asset::shelf::AssetViewItem::build_grid_tile().

◆ use_property_decorate()

bool blender::ui::Layout::use_property_decorate ( ) const
nodiscard

◆ use_property_decorate_set()

void blender::ui::Layout::use_property_decorate_set ( bool is_decorate)

Sets when to add an extra button to insert keyframes next to new property buttons added in the layout.

Definition at line 5483 of file interface_layout.cc.

References blender::ui::Item::flag_, blender::ui::PropDecorate, and SET_FLAG_FROM_TEST.

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), blender::nodes::add_layer_name_search_button(), blender::ui::block_layout(), blender::ed::object::shapekey::ShapeKeyItem::build_row(), blender::ui::greasepencil::LayerGroupViewItem::build_row(), blender::ui::greasepencil::LayerViewItem::build_row(), blender::cycles_panel_draw(), blender::data_panel_draw(), blender::nodes::draw_bake_panel(), blender::nodes::draw_common_bake_settings(), blender::modifier::greasepencil::draw_custom_curve_settings(), blender::ui::draw_export_properties(), blender::draw_fill_tile(), blender::nodes::draw_geometry_nodes_modifier_ui(), blender::nodes::draw_geometry_nodes_operator_redo_ui(), blender::ui::draw_import_properties(), blender::modifier::greasepencil::draw_layer_filter_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::nodes::draw_property_for_socket(), blender::ui::draw_property_for_socket(), blender::modifier::greasepencil::draw_vertex_group_settings(), blender::edbm_bevel_ui(), blender::edbm_blend_from_shape_ui(), blender::edbm_intersect_boolean_ui(), blender::edbm_intersect_ui(), blender::envelope_panel_draw(), blender::fmodifier_frame_range_draw(), blender::fn_generator_panel_draw(), blender::nodes::node_composite_file_output_cc::format_layout(), blender::generator_panel_draw(), blender::ed::geometry::geometry_attribute_convert_ui(), blender::ed::geometry::geometry_color_attribute_add_ui(), blender::ed::geometry::geometry_color_attribute_convert_ui(), blender::graph_panel_cursor(), blender::graph_panel_key_properties(), blender::graph_panel_properties(), blender::ed::greasepencil::grease_pencil_convert_curve_type_ui(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_sequence_ui(), blender::ed::greasepencil::grease_pencil_reproject_ui(), blender::ed::greasepencil::grease_pencil_set_corner_type_ui(), blender::ed::greasepencil::grease_pencil_simplify_ui(), blender::image_new_draw(), blender::image_save_as_draw(), blender::nodes::node_composite_file_output_cc::item_layout(), blender::limits_panel_draw(), blender::ed::sculpt_paint::mask::mask_from_boundary_ui(), blender::ed::sculpt_paint::mask::mask_from_cavity_ui(), blender::ed::mesh::set_attribute::mesh_set_attribute_ui(), blender::modifier_vgroup_ui(), blender::nla_panel_actclip(), blender::nla_panel_animdata(), blender::nla_panel_properties(), blender::nodes::node_composite_movie_clip_cc::node_draw_buttons_extended(), blender::node_implicit_conversion_layout(), blender::nodes::node_fn_align_euler_to_vector_cc::node_layout(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_layout(), blender::nodes::node_geo_attribute_capture_cc::node_layout(), blender::nodes::node_geo_enable_output_cc::node_layout(), blender::nodes::node_geo_extrude_mesh_cc::node_layout(), blender::nodes::node_geo_get_bundle_item_cc::node_layout(), blender::nodes::node_geo_get_named_grid_cc::node_layout(), blender::nodes::node_geo_grid_deactivate_voxels::node_layout(), blender::nodes::node_geo_grid_info_cc::node_layout(), blender::nodes::node_geo_grid_to_points_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_circle_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_cone_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_cylinder_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_line_cc::node_layout(), blender::nodes::node_geo_set_grid_background::node_layout(), blender::nodes::node_geo_set_grid_transform::node_layout(), blender::nodes::node_geo_split_to_instances_cc::node_layout(), blender::nodes::node_geo_store_bundle_item_cc::node_layout(), blender::nodes::node_geo_store_named_attribute_cc::node_layout(), blender::nodes::node_geo_store_named_grid_cc::node_layout(), blender::nodes::node_geo_tool_active_element_cc::node_layout(), blender::nodes::node_geo_warning_cc::node_layout(), blender::nodes::node_fn_input_int_vector_cc::node_layout_ex(), blender::nodes::node_fn_input_vector_cc::node_layout_ex(), blender::nodes::node_geo_closure_cc::node_layout_ex(), blender::nodes::node_geo_combine_bundle_cc::node_layout_ex(), blender::nodes::node_geo_evaluate_closure_cc::node_layout_ex(), blender::nodes::node_geo_get_bundle_item_cc::node_layout_ex(), blender::nodes::node_geo_gizmo_transform_cc::node_layout_ex(), blender::nodes::node_geo_list_get_item_cc::node_layout_ex(), blender::nodes::node_geo_separate_bundle_cc::node_layout_ex(), blender::nodes::node_geo_simulation_cc::node_layout_ex(), blender::nodes::node_geo_store_bundle_item_cc::node_layout_ex(), blender::ed::space_node::node_tree_interface_draw(), blender::noise_panel_draw(), blender::panel_draw(), blender::panel_draw(), blender::preferences_asset_library_add_ui(), blender::preferences_extension_repo_add_ui(), blender::profile_panel_draw(), blender::project_asset_library_add_ui(), blender::ed::geometry::run_node_group_ui(), blender::screenshot_draw(), blender::ed::curves::select_ends_ui(), blender::ed::vse::sequencer_box_blade_ui(), blender::ed::vse::sequencer_split_ui(), blender::ed::curves::set_attribute_ui(), blender::ed::pointcloud::set_attribute_ui(), blender::ed::object::shade_auto_smooth_ui(), blender::smooth_panel_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw(), blender::stepped_panel_draw(), blender::ui::template_cache_file_time_settings(), blender::ui::template_operator_property_buts_draw_single(), blender::texture_paint_add_texture_paint_slot_ui(), blender::tile_add_draw(), blender::ed::space_node::ui_node_draw_input(), blender::ed::space_node::ui_node_draw_recursive(), blender::uiTemplateImage(), blender::uiTemplateImageSettings(), blender::uiTemplateViewsFormat(), blender::unwrap_draw(), blender::uv_pack_islands_ui(), blender::wm_clear_recent_files_ui(), and blender::wm_stereo3d_set_draw().

◆ use_property_split()

◆ use_property_split_set()

void blender::ui::Layout::use_property_split_set ( bool is_sep)

Sets when to split property's label into a separate button when adding new property buttons.

Definition at line 5473 of file interface_layout.cc.

References blender::ui::Item::flag_, blender::ui::PropSep, and SET_FLAG_FROM_TEST.

Referenced by blender::nodes::add_attribute_search_or_value_buttons(), blender::advanced_panel_draw(), blender::axis_mapping_panel_draw(), blender::bake_panel_draw(), blender::blur_panel_draw(), blender::seq::brightcontrast_panel_draw(), blender::caps_panel_draw(), blender::chaining_panel_draw(), blender::clamp_panel_draw(), blender::seq::colorBalance_panel_draw(), blender::composition_panel_draw(), blender::constant_offset_draw(), blender::ui::CurveProfile_buttons_layout(), blender::cycles_panel_draw(), blender::data_panel_draw(), blender::nodes::draw_bake_panel(), blender::nodes::draw_common_bake_settings(), blender::nodes::draw_compositor_nodes_effect_ui(), blender::nodes::draw_compositor_nodes_modifier_ui(), blender::modifier::greasepencil::draw_custom_curve_settings(), blender::ui::draw_effect_panel(), blender::ui::draw_export_properties(), blender::draw_fill_tile(), blender::nodes::draw_geometry_nodes_modifier_ui(), blender::nodes::draw_geometry_nodes_operator_redo_ui(), blender::modifier::greasepencil::draw_layer_filter_settings(), blender::nodes::draw_mask_input_type_settings(), blender::seq::draw_mask_input_type_settings(), blender::modifier::greasepencil::draw_material_filter_settings(), blender::ui::draw_matrix_template(), blender::modifier::greasepencil::draw_vertex_group_settings(), blender::seq::echomodifier_draw(), blender::edbm_average_normals_ui(), blender::edbm_bevel_ui(), blender::edbm_blend_from_shape_ui(), blender::edbm_circularize_ui(), blender::edbm_curve_edge_loops_between_selected_ui(), blender::edbm_decimate_ui(), blender::edbm_fit_edge_loops_to_annotation_ui(), blender::edbm_flatten_ui(), blender::edbm_intersect_boolean_ui(), blender::edbm_intersect_ui(), blender::edbm_point_normals_ui(), blender::edbm_space_edge_loops_evenly_ui(), blender::edge_data_panel_draw(), blender::edge_panel_draw(), blender::edge_types_panel_draw(), blender::envelope_panel_draw(), blender::face_corner_panel_draw(), blender::face_corner_uv_panel_draw(), blender::face_corner_vcol_panel_draw(), blender::face_mark_panel_draw(), blender::face_panel_draw(), blender::falloff_panel_draw(), blender::fmodifier_delete_ui(), blender::fmodifier_frame_range_draw(), blender::fn_generator_panel_draw(), blender::nodes::node_composite_file_output_cc::format_layout(), blender::generate_panel_draw(), blender::generator_panel_draw(), blender::ed::geometry::geometry_attribute_convert_ui(), blender::ed::geometry::geometry_color_attribute_add_ui(), blender::ed::geometry::geometry_color_attribute_convert_ui(), blender::geometry_panel_draw(), blender::graph_panel_cursor(), blender::graph_panel_key_properties(), blender::graph_panel_properties(), blender::ed::greasepencil::grease_pencil_convert_curve_type_ui(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_sequence_ui(), blender::ed::greasepencil::grease_pencil_reproject_ui(), blender::ed::greasepencil::grease_pencil_set_corner_type_ui(), blender::ed::greasepencil::grease_pencil_simplify_ui(), blender::image_new_draw(), blender::image_save_as_draw(), blender::intersection_panel_draw(), blender::nodes::node_composite_file_output_cc::item_layout(), blender::ui::LayoutInternal::item_prop_split_layout_hack(), blender::ui::label_markdown_dev_config(), blender::layers_panel_draw(), blender::limits_panel_draw(), blender::ed::sculpt_paint::mask::mask_from_boundary_ui(), blender::ed::sculpt_paint::mask::mask_from_cavity_ui(), blender::material_mask_panel_draw(), blender::materials_panel_draw(), blender::ed::mesh::set_attribute::mesh_set_attribute_ui(), blender::mix_mode_panel_draw(), blender::nla_panel_actclip(), blender::nla_panel_animated_strip_time(), blender::nla_panel_animdata(), blender::nla_panel_evaluation(), blender::nla_panel_properties(), blender::nodes::node_composite_movie_clip_cc::node_draw_buttons_extended(), blender::node_implicit_conversion_layout(), blender::nodes::node_fn_align_euler_to_vector_cc::node_layout(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_layout(), blender::nodes::node_geo_attribute_capture_cc::node_layout(), blender::nodes::node_geo_enable_output_cc::node_layout(), blender::nodes::node_geo_extrude_mesh_cc::node_layout(), blender::nodes::node_geo_get_bundle_item_cc::node_layout(), blender::nodes::node_geo_get_named_grid_cc::node_layout(), blender::nodes::node_geo_grid_deactivate_voxels::node_layout(), blender::nodes::node_geo_grid_info_cc::node_layout(), blender::nodes::node_geo_grid_to_points_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_circle_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_cone_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_cylinder_cc::node_layout(), blender::nodes::node_geo_mesh_primitive_line_cc::node_layout(), blender::nodes::node_geo_set_grid_background::node_layout(), blender::nodes::node_geo_set_grid_transform::node_layout(), blender::nodes::node_geo_split_to_instances_cc::node_layout(), blender::nodes::node_geo_store_bundle_item_cc::node_layout(), blender::nodes::node_geo_store_named_attribute_cc::node_layout(), blender::nodes::node_geo_store_named_grid_cc::node_layout(), blender::nodes::node_geo_tool_active_element_cc::node_layout(), blender::nodes::node_geo_warning_cc::node_layout(), blender::nodes::node_fn_input_int_vector_cc::node_layout_ex(), blender::nodes::node_fn_input_vector_cc::node_layout_ex(), blender::nodes::node_geo_closure_cc::node_layout_ex(), blender::nodes::node_geo_combine_bundle_cc::node_layout_ex(), blender::nodes::node_geo_evaluate_closure_cc::node_layout_ex(), blender::nodes::node_geo_get_bundle_item_cc::node_layout_ex(), blender::nodes::node_geo_gizmo_transform_cc::node_layout_ex(), blender::nodes::node_geo_list_get_item_cc::node_layout_ex(), blender::nodes::node_geo_separate_bundle_cc::node_layout_ex(), blender::nodes::node_geo_simulation_cc::node_layout_ex(), blender::nodes::node_geo_store_bundle_item_cc::node_layout_ex(), blender::ed::space_node::node_tree_interface_draw(), blender::noise_panel_draw(), blender::normals_panel_draw(), blender::ed::object::object_convert_ui(), blender::object_offset_draw(), blender::occlusion_panel_draw(), blender::offset_panel_draw(), blender::options_light_reference_draw(), blender::options_panel_draw(), blender::ed::outliner::outliner_id_remap_ui(), blender::override_layers_panel_draw(), blender::panel_draw(), blender::panel_draw(), blender::path_panel_draw(), blender::seq::pitchmodifier_draw(), blender::position_panel_draw(), blender::preferences_asset_library_add_ui(), blender::preferences_extension_repo_add_ui(), blender::profile_panel_draw(), blender::project_asset_library_add_ui(), blender::random_panel_draw(), blender::relative_offset_draw(), blender::replace_action_ui(), blender::restrictions_panel_draw(), blender::ed::geometry::run_node_group_ui(), blender::screenshot_draw(), blender::ed::curves::select_ends_ui(), blender::ed::vse::sequencer_box_blade_ui(), blender::ed::vse::sequencer_split_ui(), blender::ed::curves::set_attribute_ui(), blender::ed::pointcloud::set_attribute_ui(), blender::ed::object::shade_auto_smooth_ui(), blender::shading_panel_draw(), blender::smooth_panel_draw(), blender::solver_options_panel_draw(), blender::seq::sound_equalizermodifier_draw(), blender::ed::spreadsheet::spreadsheet_filter_panel_draw(), blender::stepped_panel_draw(), blender::symmetry_panel_draw(), blender::ui::template_cache_file(), blender::ui::template_operator_property_buts_draw_single(), blender::texture_paint_add_texture_paint_slot_ui(), blender::texture_panel_draw(), blender::tile_add_draw(), blender::time_panel_draw(), blender::time_remapping_panel_draw(), blender::seq::tonemapmodifier_panel_draw(), blender::transform_panel_draw(), blender::ed::space_node::ui_node_draw_node(), blender::ed::space_node::ui_node_draw_recursive(), blender::ui::uiDefAutoButsRNA(), blender::uiTemplateImage(), blender::uiTemplateImageSettings(), blender::uiTemplateViewsFormat(), blender::unwrap_draw(), blender::uv_pack_islands_ui(), blender::uv_panel_draw(), blender::velocity_panel_draw(), blender::vert_vcol_panel_draw(), blender::vertex_group_panel_draw(), blender::vertex_panel_draw(), blender::vertex_vgroup_panel_draw(), blender::vgroup_panel_draw(), blender::view3d_panel_curve_data(), blender::wave_panel_draw(), blender::weightvg_ui_common(), blender::seq::whiteBalance_panel_draw(), blender::wm_clear_recent_files_ui(), and blender::wm_stereo3d_set_draw().

◆ variable_size()

bool blender::ui::Layout::variable_size ( ) const
nodiscard

Definition at line 6692 of file interface_layout.cc.

References variable_size_.

Referenced by blender::ui::layout_variable_size(), and LayoutInternal.

◆ width()

◆ LayoutInternal

Member Data Documentation

◆ activate_init_

bool blender::ui::Layout::activate_init_ = false
protected

Definition at line 144 of file UI_interface_layout.hh.

Referenced by activate_init(), and activate_init_set().

◆ active_

bool blender::ui::Layout::active_ = false
protected

◆ active_default_

bool blender::ui::Layout::active_default_ = false
protected

Definition at line 143 of file UI_interface_layout.hh.

Referenced by active_default(), and active_default_set().

◆ align_

bool blender::ui::Layout::align_ = false
protected

Definition at line 141 of file UI_interface_layout.hh.

Referenced by align(), and blender::ui::LayoutInternal::init_from_parent().

◆ alignment_

LayoutAlign blender::ui::Layout::alignment_ = {}
protected

Definition at line 149 of file UI_interface_layout.hh.

Referenced by alignment(), and alignment_set().

◆ child_items_layout_

◆ context_

◆ emboss_

◆ enabled_

bool blender::ui::Layout::enabled_ = false
protected

◆ h_

◆ heading_

std::string blender::ui::Layout::heading_
protected

Definition at line 129 of file UI_interface_layout.hh.

Referenced by column(), heading(), heading_reset(), and row().

◆ items_

◆ parent_

◆ PROPERTY_SPLIT_FACTOR

◆ redalert_

bool blender::ui::Layout::redalert_ = false
protected

◆ root_

◆ scale_

float blender::ui::Layout::scale_[2] = {0.0f, 0.0f}
protected

Definition at line 140 of file UI_interface_layout.hh.

Referenced by scale_x(), scale_x_set(), scale_y(), and scale_y_set().

◆ search_weight_

float blender::ui::Layout::search_weight_ = 0.0f
protected

Is copied to uiButs created in this layout.

Definition at line 154 of file UI_interface_layout.hh.

Referenced by blender::ui::LayoutInternal::layout_add_but(), search_weight(), and search_weight_set().

◆ space_

◆ units_

float blender::ui::Layout::units_[2] = {0.0f, 0.0f}
protected

for fixed width or height to avoid UI size changes

Definition at line 152 of file UI_interface_layout.hh.

Referenced by ui_units_x(), ui_units_x_set(), ui_units_y(), and ui_units_y_set().

◆ variable_size_

bool blender::ui::Layout::variable_size_ = false
protected

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

Definition at line 148 of file UI_interface_layout.hh.

Referenced by blender::ui::LayoutInternal::init_from_parent(), and variable_size().

◆ w_

◆ x_

◆ y_


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