blender::ui Namespace Reference

Namespaces
namespace	string_search
namespace	greasepencil
namespace	bonecollections
namespace	light_linking
namespace	nodes

Classes
class	AbstractView
class	AbstractViewItem
class	AbstractViewItemDragController
class	AbstractGridViewItem
struct	GridViewStyle
class	AbstractGridView
class	GridViewItemDropTarget
class	GridViewBuilder
class	PreviewGridItem
struct	ContextPathItem
struct	DragInfo
class	DropTargetInterface
class	TreeViewItemContainer
class	AbstractTreeView
class	AbstractTreeViewItem
	Abstract base class for defining a customizable tree-view item. More...
class	BasicTreeViewItem
class	TreeViewItemDropTarget
class	TreeViewBuilder
struct	BoneDropper
struct	BoneSampleData
struct	EyedropperColorband
struct	EyedropperColorband_Context
struct	ItemInternal
struct	LayoutInternal
class	ViewItemAPIWrapper
class	BuildOnlyVisibleButtonsHelper
class	GridViewLayoutBuilder
class	TreeViewLayoutBuilder

Enumerations
enum class	ViewScrollDirection { UP , DOWN }
enum class	DropBehavior { Reorder , Insert , ReorderAndInsert }
enum class	DropLocation { Into , Before , After }
enum class	EmbossType : uint8_t {   Emboss = 0 , None = 1 , Pulldown = 2 , PieMenu = 3 ,   NoneOrStatus = 4 , Undefined = 255 }
enum class	LayoutDirection : int8_t { Horizontal = 0 , Vertical = 1 }
enum class	LayoutType : int8_t {   Panel = 0 , Header = 1 , Menu = 2 , Toolbar = 3 ,   PieMenu = 4 , VerticalBar = 5 }
enum class	LayoutAlign : int8_t { Expand = 0 , Left = 1 , Center = 2 , Right = 3 }
enum class	ButProgressType : int8_t { Bar = 0 , Ring = 1 }
enum class	SampleResult {   UNKNOWN_FAILURE , SUCCESS , NO_BONE_3DVIEW , NO_BONE_OUTLINER ,   WRONG_AREA , WRONG_ARMATURE }
enum class	ItemType : int8_t {   Button , LayoutRow , LayoutPanelHeader , LayoutPanelBody ,   LayoutColumn , LayoutColumnFlow , LayoutRowFlow , LayoutGridFlow ,   LayoutBox , LayoutAbsolute , LayoutSplit , LayoutOverlap ,   LayoutRadial , LayoutRoot }
enum class	ItemInternalFlag : uint8_t {   AutoFixedSize = 1 << 0 , FixedSize = 1 << 1 , BoxItem = 1 << 2 , PropSep = 1 << 3 ,   InsidePropSep = 1 << 4 , PropDecorate = 1 << 5 , PropDecorateNoPad = 1 << 6 }

Functions
void	context_path_add_generic (Vector< ContextPathItem > &path, StructRNA &rna_type, void *ptr, const BIFIconID icon_override=ICON_NONE, std::function< void(bContext &)> handle_func=nullptr)
void	attribute_search_add_items (StringRef str, bool can_create_attribute, Span< const nodes::geo_eval_log::GeometryAttributeInfo * > infos, uiSearchItems *items, bool is_first)
void	grease_pencil_layer_search_add_items (StringRef str, Span< const std::string * > layer_names, uiSearchItems &items, bool is_first)
bool	asset_shelf_popover_invoke (bContext &C, blender::StringRef asset_shelf_idname, ReportList &reports)
bool	drop_target_apply_drop (bContext &C, const ARegion &region, const wmEvent &event, const DropTargetInterface &drop_target, const ListBase &drags)
std::string	drop_target_tooltip (const ARegion &region, const DropTargetInterface &drop_target, const wmDrag &drag, const wmEvent &event)
std::unique_ptr< DropTargetInterface >	region_views_find_drop_target_at (const ARegion *region, const int xy[2])
char	but_pointer_bit_max_index (ButPointerType pointer_type)
void	template_asset_shelf_popover (uiLayout &layout, const bContext &C, StringRefNull asset_shelf_id, StringRef name, int icon)
uiLayout &	block_layout (uiBlock *block, LayoutDirection direction, LayoutType type, int x, int y, int size, int em, int padding, const uiStyle *style)
int2	block_layout_resolve (uiBlock *block)
void	block_layout_set_current (uiBlock *block, uiLayout *layout)
bool	block_layout_needs_resolving (const uiBlock *block)
void	block_layout_free (uiBlock *block)
static void	datadropper_draw_cb (const bContext *, ARegion *, void *arg)
static bool	is_bone_dropper_valid (BoneDropper *bone_dropper)
static int	bonedropper_init (bContext *C, wmOperator *op)
static void	bonedropper_exit (bContext *C, wmOperator *op)
static void	bonedropper_cancel (bContext *C, wmOperator *op)
static void	bonedropper_set_draw_callback_region (ScrArea &area, BoneDropper &bdr)
static BoneSampleData	sample_data_from_3d_view (bContext *C, const int mval[2], const BoneDropper &bdr)
static BoneSampleData	sample_data_from_outliner (bContext *C, const int mval[2], const BoneDropper &bdr)
static BoneSampleData	bonedropper_sample_pt (bContext *C, wmWindow &win, ScrArea &area, BoneDropper &bdr, const int event_xy[2])
static SampleResult	bonedropper_sample (bContext *C, BoneDropper &bdr, const int event_xy[2])
static void	generate_sample_warning (SampleResult result, wmOperator *op)
static wmOperatorStatus	bonedropper_modal (bContext *C, wmOperator *op, const wmEvent *event)
static wmOperatorStatus	bonedropper_invoke (bContext *C, wmOperator *op, const wmEvent *)
static wmOperatorStatus	bonedropper_exec (bContext *C, wmOperator *op)
static bool	bonedropper_poll (bContext *C)
void	UI_OT_eyedropper_bone (wmOperatorType *ot)
static bool	eyedropper_colorband_init (bContext *C, wmOperator *op)
static void	eyedropper_colorband_sample_point (bContext *C, EyedropperColorband *eye, const int m_xy[2])
static bool	eyedropper_colorband_sample_callback (int mx, int my, void *userdata)
static void	eyedropper_colorband_sample_segment (bContext *C, EyedropperColorband *eye, const int m_xy[2])
static void	eyedropper_colorband_exit (bContext *C, wmOperator *op)
static void	eyedropper_colorband_apply (bContext *C, wmOperator *op)
static void	eyedropper_colorband_cancel (bContext *C, wmOperator *op)
static wmOperatorStatus	eyedropper_colorband_modal (bContext *C, wmOperator *op, const wmEvent *event)
static wmOperatorStatus	eyedropper_colorband_point_modal (bContext *C, wmOperator *op, const wmEvent *event)
static wmOperatorStatus	eyedropper_colorband_invoke (bContext *C, wmOperator *op, const wmEvent *)
static wmOperatorStatus	eyedropper_colorband_exec (bContext *C, wmOperator *op)
static bool	eyedropper_colorband_poll (bContext *C)
void	UI_OT_eyedropper_colorramp (wmOperatorType *ot)
void	UI_OT_eyedropper_colorramp_point (wmOperatorType *ot)
static StringRef	attribute_data_type_string (const eCustomDataType type)
static StringRef	attribute_domain_string (const bke::AttrDomain domain)
static bool	attribute_search_item_add (uiSearchItems *items, const GeometryAttributeInfo &item)
void	grease_pencil_layer_search_add_items (const StringRef str, const Span< const std::string * > layer_names, uiSearchItems &seach_items, const bool is_first)
static std::optional< int >	find_filtered_item_index (const AbstractGridViewItem &item)
static int	unpadded_item_height ()
static int	padded_item_height ()
static uiButViewItem *	find_first_view_item_but (const uiBlock &block, const AbstractTreeView &view)
static int	count_visible_items (AbstractTreeView &tree_view)
Breadcrumb Template
void	template_breadcrumbs (uiLayout &layout, Span< ContextPathItem > context_path)
Renaming
static AbstractViewItem *	find_item_from_rename_button (const uiBut &rename_but)
static void	rename_button_fn (bContext *C, void *arg, char *)

Tree-View Item Container
Base class for tree-view and tree-view items, so both can contain children.
using	TreeViewOrItem = TreeViewItemContainer
	ENUM_OPERATORS (TreeViewItemContainer::IterOptions, TreeViewItemContainer::IterOptions::SkipCollapsed)

Typedef Documentation

TreeViewOrItem

using blender::ui::TreeViewOrItem = TreeViewItemContainer

The container class is the base for both the tree-view and the items. This alias gives it a clearer name for handles that accept both. Use whenever something wants to act on child-items, irrespective of if they are stored at root level or as children of some other item.

Definition at line 112 of file UI_tree_view.hh.

Enumeration Type Documentation

ButProgressType

enum class blender::ui::ButProgressType : int8_t

strong

Enumerator
Bar
Ring

Definition at line 840 of file UI_interface_layout.hh.

DropBehavior

enum class blender::ui::DropBehavior

strong

Some drop targets simply allow dropping onto/into them, others support dragging in-between them. Classes implementing the drop-target interface can use this type to control the behavior by letting it influence the result of #choose_drop_location().

Enumerator
Reorder	Enable dropping before (#DropLocation::Before) and after (#DropLocation::After) the drop target. Typically used for reordering items.
Insert	Only enable dropping onto/into the drop target (#DropLocation::Into).
ReorderAndInsert	Enable dropping onto/into (#DropLocation::Into), before (#DropLocation::Before) and after (#DropLocation::After) the drop target. Typically used for reordering items with nesting support.

Definition at line 109 of file UI_interface.hh.

DropLocation

enum class blender::ui::DropLocation

strong

Information on how dragged data should be inserted on drop, as determined through #DropTargetInterface::choose_drop_location(). Also see DropBehavior.

Enumerator
Into
Before
After

Definition at line 128 of file UI_interface.hh.

EmbossType

enum class blender::ui::EmbossType : uint8_t

strong

uiBlock.emboss and uiBut.emboss

Enumerator
Emboss	Use widget style for drawing.
None	Nothing, only icon and/or text
Pulldown	Pull-down menu style
PieMenu	Pie Menu
NoneOrStatus	The same as #EmbossType::None, unless the button has a coloring status like an animation state or red alert.
Undefined	For layout engine, use emboss from block.

Definition at line 127 of file UI_interface_c.hh.

ItemInternalFlag

enum class blender::ui::ItemInternalFlag : uint8_t

strong

Enumerator
AutoFixedSize
FixedSize
BoxItem
PropSep
InsidePropSep
PropDecorate
PropDecorateNoPad

Definition at line 125 of file interface_layout.cc.

ItemType

enum class blender::ui::ItemType : int8_t

strong

Enumerator
Button
LayoutRow
LayoutPanelHeader
LayoutPanelBody
LayoutColumn
LayoutColumnFlow
LayoutRowFlow
LayoutGridFlow
LayoutBox
LayoutAbsolute
LayoutSplit
LayoutOverlap
LayoutRadial
LayoutRoot

Definition at line 98 of file interface_layout.cc.

LayoutAlign

enum class blender::ui::LayoutAlign : int8_t

strong

Enumerator
Expand
Left
Center
Right

Definition at line 834 of file UI_interface_layout.hh.

LayoutDirection

enum class blender::ui::LayoutDirection : int8_t

strong

Enumerator
Horizontal
Vertical

Definition at line 820 of file UI_interface_layout.hh.

LayoutType

enum class blender::ui::LayoutType : int8_t

strong

Enumerator
Panel
Header
Menu
Toolbar
PieMenu
VerticalBar

Definition at line 825 of file UI_interface_layout.hh.

SampleResult

enum class blender::ui::SampleResult

strong

Enumerator
UNKNOWN_FAILURE
SUCCESS
NO_BONE_3DVIEW
NO_BONE_OUTLINER
WRONG_AREA
WRONG_ARMATURE

Definition at line 40 of file eyedropper_bone.cc.

ViewScrollDirection

enum class blender::ui::ViewScrollDirection

strong

Enumerator
UP
DOWN

Definition at line 50 of file UI_abstract_view.hh.

Function Documentation

asset_shelf_popover_invoke()

bool blender::ui::asset_shelf_popover_invoke	(	bContext &	C,
		blender::StringRef	asset_shelf_idname,
		ReportList &	reports )

Definition at line 66 of file interface_template_asset_shelf_popover.cc.

References BKE_reportf(), uiLayout::context_string_set(), RPT_ERROR, blender::ed::asset::shelf::type_find_from_idname(), blender::ed::asset::shelf::type_poll_for_popup(), ui_item_paneltype_func(), ui_popover_panel_create(), and WM_paneltype_find().

Referenced by asset_shelf_popover_invoke().

attribute_data_type_string()

StringRef blender::ui::attribute_data_type_string ( const eCustomDataType type )

static

Definition at line 33 of file interface_template_attribute_search.cc.

References IFACE_, name, rna_enum_attribute_type_items, and RNA_enum_name_from_value().

Referenced by attribute_search_item_add().

attribute_domain_string()

StringRef blender::ui::attribute_domain_string ( const bke::AttrDomain domain )

static

Definition at line 40 of file interface_template_attribute_search.cc.

References IFACE_, name, rna_enum_attribute_domain_items, and RNA_enum_name_from_value().

Referenced by attribute_search_item_add().

attribute_search_add_items()

void blender::ui::attribute_search_add_items	(	StringRef	str,
		bool	can_create_attribute,
		Span< const nodes::geo_eval_log::GeometryAttributeInfo * >	infos,
		uiSearchItems *	items,
		bool	is_first )

Definition at line 58 of file interface_template_attribute_search.cc.

References blender::string_search::StringSearch< T >::add(), blender::bke::allow_procedural_attribute_access(), attribute_search_item_add(), blender::nodes::geo_eval_log::GeometryAttributeInfo::name, blender::string_search::StringSearch< T >::query(), str, and UI_search_item_add().

Referenced by blender::ed::space_node::attribute_search_update_fn(), and blender::nodes::attribute_search_update_fn().

attribute_search_item_add()

bool blender::ui::attribute_search_item_add ( uiSearchItems * items, const GeometryAttributeInfo & item )

static

Definition at line 47 of file interface_template_attribute_search.cc.

References blender::bke::attr_type_to_custom_data_type(), attribute_data_type_string(), attribute_domain_string(), blender::nodes::geo_eval_log::GeometryAttributeInfo::data_type, blender::nodes::geo_eval_log::GeometryAttributeInfo::domain, blender::nodes::geo_eval_log::GeometryAttributeInfo::name, UI_BUT_HAS_SEP_CHAR, UI_MENU_ARROW_SEP, UI_search_item_add(), and UI_SEP_CHAR_S.

Referenced by attribute_search_add_items().

block_layout()

uiLayout & blender::ui::block_layout	(	uiBlock *	block,
		LayoutDirection	direction,
		LayoutType	type,
		int	x,
		int	y,
		int	size,
		int	em,
		int	padding,
		const uiStyle *	style )

Definition at line 5460 of file interface_layout.cc.

References uiLayout::active_set(), BLI_addtail(), uiLayoutRoot::block, uiBlock::curlayout, ELEM, uiLayout::emboss_set(), uiLayoutRoot::emh, uiLayoutRoot::emw, uiLayout::enabled_set(), uiLayout::h_, Header, Horizontal, blender::wm::InvokeRegionWin, uiLayoutRoot::layout, uiBlock::layouts, MEM_callocN(), Menu, uiLayoutRoot::opcontext, padding(), uiLayoutRoot::padding, PieMenu, uiLayout::root(), size(), uiLayout::space_, uiLayoutRoot::style, uiStyle::templatespace, uiLayoutRoot::type, ui_layout_add_padding_button(), UI_UNIT_X, UI_UNIT_Y, Undefined, uiLayout::use_property_decorate_set(), VerticalBar, uiLayout::w_, x, uiLayout::x_, y, and uiLayout::y_.

Referenced by colorband_tools_fn(), component_menu(), blender::ed::space_node::draw_tree_path(), ed_panel_draw(), ED_region_header_layout(), ED_time_scrub_channel_search_draw(), menu_add_shortcut(), menu_change_shortcut(), menu_items_from_ui_create(), 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(), panel_property_search(), blender::ed::asset::shelf::region_layout(), blender::ed::spreadsheet::spreadsheet_footer_region_draw(), UI_pie_menu_begin(), ui_popover_create_block(), ui_popup_menu_create_block(), uiItemsAlertBox(), wm_block_about_create(), wm_block_create_redo(), wm_block_dialog_create(), wm_block_insert_unicode_create(), wm_block_splash_create(), and wm_operator_ui_create().

block_layout_free()

void blender::ui::block_layout_free

(

uiBlock *

block

)

Used for property search when the layout process needs to be cancelled in order to avoid computing the locations for buttons, but the layout items created while adding the buttons must still be freed.

Definition at line 5661 of file interface_layout.cc.

References uiBlock::layouts, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), and ui_layout_free().

Referenced by panel_property_search().

block_layout_needs_resolving()

bool blender::ui::block_layout_needs_resolving

(

const uiBlock *

block

)

Definition at line 5688 of file interface_layout.cc.

References BLI_listbase_is_empty(), and uiBlock::layouts.

Referenced by ui_textedit_begin().

block_layout_resolve()

int2 blender::ui::block_layout_resolve

(

uiBlock *

block

)

Definition at line 5669 of file interface_layout.cc.

References uiBlock::active, BLI_assert, BLI_listbase_clear(), uiBlock::curlayout, uiBlock::layouts, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), ui_layout_add_padding_button(), ui_layout_end(), and ui_layout_free().

Referenced by blender::ed::space_node::draw_tree_path(), ed_panel_draw(), ED_region_header_layout(), ED_time_scrub_channel_search_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::ed::asset::shelf::region_layout(), blender::ed::spreadsheet::spreadsheet_footer_region_draw(), UI_block_end_ex(), ui_block_func_PIE(), ui_block_func_POPOVER(), ui_block_func_POPUP(), and UI_popup_menu_end_or_cancel().

block_layout_set_current()

void blender::ui::block_layout_set_current	(	uiBlock *	block,
		uiLayout *	layout )

Definition at line 5656 of file interface_layout.cc.

References uiBlock::curlayout.

Referenced by uiLayout::absolute(), blender::ui::TreeViewLayoutBuilder::build_from_tree(), blender::ui::GridViewLayoutBuilder::build_from_view(), blender::ui::GridViewBuilder::build_grid_view(), blender::ed::asset::shelf::AssetCatalogSelectorTree::Item::build_row(), blender::ui::TreeViewLayoutBuilder::build_row(), blender::ui::TreeViewBuilder::build_tree_view(), colorband_tools_fn(), uiLayout::column(), uiLayout::column_flow(), uiLayout::decorator(), ED_time_scrub_channel_search_draw(), blender::ed::asset_browser::file_create_asset_catalog_tree_view_in_layout(), uiLayout::grid_flow(), knot_modes_menu(), uiLayout::menu_pie(), uiLayout::op_enum_items(), uiLayout::overlap(), uiLayout::panel_prop(), uiLayout::progress_indicator(), uiLayout::prop(), uiLayout::prop_tabs_enum(), uiLayout::row(), uiLayout::separator(), uiLayout::separator_spacer(), uiLayout::split(), blender::ed::spreadsheet::spreadsheet_data_set_panel_draw(), ui_def_but_rna__menu(), ui_imageuser_layer_menu(), ui_imageuser_pass_menu(), ui_imageuser_view_menu_multiview(), ui_imageuser_view_menu_rr(), ui_item_array(), ui_item_disabled(), ui_item_enum_expand_exec(), ui_item_menu(), ui_item_with_label(), ui_layout_box(), blender::ed::space_node::ui_node_menu_column(), blender::ed::space_node::ui_template_node_link_menu(), uiItem_simple(), uiItemFullO_ptr_ex(), uiItemL_respect_property_split(), uiLayoutListItemAddPadding(), uiTemplateMenuSearch(), uiTemplateNodeLink(), uiTemplateOperatorSearch(), and uiTemplateRunningJobs().

bonedropper_cancel()

void blender::ui::bonedropper_cancel ( bContext * C, wmOperator * op )

static

Definition at line 149 of file eyedropper_bone.cc.

References bonedropper_exit(), and C.

Referenced by bonedropper_modal(), and UI_OT_eyedropper_bone().

bonedropper_exec()

wmOperatorStatus blender::ui::bonedropper_exec ( bContext * C, wmOperator * op )

static

Definition at line 487 of file eyedropper_bone.cc.

References bonedropper_exit(), bonedropper_init(), C, OPERATOR_CANCELLED, and OPERATOR_FINISHED.

Referenced by UI_OT_eyedropper_bone().

bonedropper_exit()

void blender::ui::bonedropper_exit ( bContext * C, wmOperator * op )

static

Definition at line 130 of file eyedropper_bone.cc.

References blender::ui::BoneDropper::area_region_type, C, CTX_wm_window(), blender::ui::BoneDropper::cursor_area, wmOperator::customdata, blender::ui::BoneDropper::draw_handle_pixel, ED_area_tag_redraw(), ED_region_draw_cb_exit(), WM_cursor_modal_restore(), and WM_event_add_mousemove().

Referenced by bonedropper_cancel(), bonedropper_exec(), and bonedropper_modal().

bonedropper_init()

int blender::ui::bonedropper_init ( bContext * C, wmOperator * op )

static

Definition at line 94 of file eyedropper_bone.cc.

References blender::ui::BoneDropper::area_region_type, BKE_regiontype_from_id(), BKE_spacetype_from_id(), C, CTX_wm_area(), blender::ui::BoneDropper::cursor_area, wmOperator::customdata, datadropper_draw_cb(), blender::ui::BoneDropper::draw_handle_pixel, ED_region_draw_cb_activate(), is_bone_dropper_valid(), blender::ui::BoneDropper::is_undo, blender::ui::BoneDropper::prop, blender::ui::BoneDropper::ptr, REGION_DRAW_POST_PIXEL, RGN_TYPE_WINDOW, uiButSearch::rnasearchpoin, uiButSearch::rnasearchprop, blender::ui::BoneDropper::search_prop, blender::ui::BoneDropper::search_ptr, SearchMenu, SPACE_VIEW3D, uiBut::type, UI_but_flag_is_set(), UI_BUT_UNDO, and UI_context_active_but_prop_get().

Referenced by bonedropper_exec(), and bonedropper_invoke().

bonedropper_invoke()

wmOperatorStatus blender::ui::bonedropper_invoke ( bContext * C, wmOperator * op, const wmEvent *  )

static

Definition at line 470 of file eyedropper_bone.cc.

References BKE_object_update_select_id(), bonedropper_init(), C, CTX_data_main(), CTX_wm_region(), CTX_wm_window(), OPERATOR_CANCELLED, OPERATOR_RUNNING_MODAL, UI_context_active_but_clear(), WM_CURSOR_EYEDROPPER, WM_cursor_modal_set(), and WM_event_add_modal_handler().

Referenced by UI_OT_eyedropper_bone().

bonedropper_modal()

wmOperatorStatus blender::ui::bonedropper_modal ( bContext * C, wmOperator * op, const wmEvent * event )

static

Definition at line 430 of file eyedropper_bone.cc.

References bonedropper_cancel(), bonedropper_exit(), bonedropper_sample(), bonedropper_sample_pt(), bonedropper_set_draw_callback_region(), C, wmOperator::customdata, EVT_MODAL_MAP, EYE_MODAL_CANCEL, EYE_MODAL_SAMPLE_CONFIRM, eyedropper_win_area_find(), generate_sample_warning(), blender::ui::BoneDropper::is_undo, MOUSEMOVE, blender::ui::BoneDropper::name, OPERATOR_CANCELLED, OPERATOR_FINISHED, OPERATOR_RUNNING_MODAL, result, SUCCESS, wmEvent::type, wmEvent::val, and wmEvent::xy.

Referenced by UI_OT_eyedropper_bone().

bonedropper_poll()

bool blender::ui::bonedropper_poll ( bContext * C )

static

Definition at line 497 of file eyedropper_bone.cc.

References C, CTX_data_active_object(), CTX_wm_operator_poll_msg_set(), CTX_wm_window(), ELEM, uiBut::flag, Object::mode, OB_ARMATURE, OB_MODE_EDIT, OB_MODE_POSE, PROP_POINTER, PROP_STRING, ptr, RNA_property_pointer_type(), RNA_property_type(), uiButSearch::rnasearchpoin, uiButSearch::rnasearchprop, SearchMenu, Object::type, uiBut::type, UI_BUT_VALUE_CLEAR, and UI_context_active_but_prop_get().

Referenced by UI_OT_eyedropper_bone().

bonedropper_sample()

SampleResult blender::ui::bonedropper_sample ( bContext * C, BoneDropper & bdr, const int event_xy[2] )

static

Definition at line 347 of file eyedropper_bone.cc.

References BLI_assert_unreachable, bPoseChannel::bone, blender::ui::BoneSampleData::bone_rna, bonedropper_sample_pt(), C, CTX_wm_reports(), PointerRNA::data, ELEM, eyedropper_win_area_find(), blender::ui::BoneSampleData::name, PointerRNA::owner_id, blender::ui::BoneDropper::prop, PROP_POINTER, PROP_STRING, blender::ui::BoneDropper::ptr, RNA_pointer_create_discrete(), RNA_property_pointer_set(), RNA_property_pointer_type(), RNA_property_string_set(), RNA_property_type(), RNA_property_update(), blender::ui::BoneSampleData::sample_result, blender::ui::BoneDropper::search_prop, blender::ui::BoneDropper::search_ptr, SPACE_OUTLINER, SPACE_VIEW3D, ScrArea::spacetype, SUCCESS, PointerRNA::type, and WRONG_AREA.

Referenced by bonedropper_modal().

bonedropper_sample_pt()

BoneSampleData blender::ui::bonedropper_sample_pt ( bContext * C, wmWindow & win, ScrArea & area, BoneDropper & bdr, const int event_xy[2] )

static

Definition at line 293 of file eyedropper_bone.cc.

References BKE_area_find_region_xy(), BLI_assert_unreachable, C, copy_v2_v2_int(), CTX_wm_area(), CTX_wm_area_set(), CTX_wm_region(), CTX_wm_region_set(), CTX_wm_window(), CTX_wm_window_set(), ED_region_tag_redraw(), ELEM, blender::ui::BoneDropper::name, blender::ui::BoneSampleData::name, blender::ui::BoneDropper::name_pos, RGN_TYPE_WINDOW, sample_data_from_3d_view(), sample_data_from_outliner(), SPACE_OUTLINER, SPACE_VIEW3D, ScrArea::spacetype, STRNCPY_UTF8, ARegion::winrct, rcti::xmin, and rcti::ymin.

Referenced by bonedropper_modal(), and bonedropper_sample().

bonedropper_set_draw_callback_region()

void blender::ui::bonedropper_set_draw_callback_region ( ScrArea & area, BoneDropper & bdr )

static

Definition at line 155 of file eyedropper_bone.cc.

References blender::ui::BoneDropper::area_region_type, BKE_area_find_region_type(), BKE_regiontype_from_id(), blender::ui::BoneDropper::cursor_area, datadropper_draw_cb(), blender::ui::BoneDropper::draw_handle_pixel, ED_region_draw_cb_activate(), ED_region_draw_cb_exit(), ED_region_tag_redraw(), REGION_DRAW_POST_PIXEL, RGN_TYPE_WINDOW, ScrArea::spacetype, and ScrArea::type.

Referenced by bonedropper_modal().

but_pointer_bit_max_index()

char blender::ui::but_pointer_bit_max_index ( ButPointerType pointer_type )

inline

Definition at line 469 of file UI_interface_c.hh.

References Char, Int, and Short.

Referenced by uiButTypeWithPointerType::uiButTypeWithPointerType().

context_path_add_generic()

void blender::ui::context_path_add_generic	(	Vector< ContextPathItem > &	path,
		StructRNA &	rna_type,
		void *	ptr,
		const BIFIconID	icon_override = ICON_NONE,
		std::function< void(bContext &)>	handle_func = nullptr )

Definition at line 22 of file interface_context_path.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), ID_REAL_USERS, MEM_freeN(), name, ptr, RNA_pointer_create_discrete(), RNA_struct_name_get_alloc(), RNA_struct_ui_icon(), and PointerRNA::type.

Referenced by blender::ed::space_node::context_path_add_node_tree_and_node_groups(), blender::ed::space_node::context_path_add_object_data(), blender::ed::space_node::context_path_add_top_level_shader_node_tree(), blender::ed::space_node::get_context_path_node_compositor(), blender::ed::space_node::get_context_path_node_geometry(), and blender::ed::space_node::get_context_path_node_shader().

count_visible_items()

int blender::ui::count_visible_items ( AbstractTreeView & tree_view )

static

Definition at line 841 of file tree_view.cc.

References blender::ui::AbstractTreeView::foreach_item(), blender::ui::TreeViewItemContainer::SkipCollapsed, and blender::ui::TreeViewItemContainer::SkipFiltered.

Referenced by blender::ui::TreeViewLayoutBuilder::build_from_tree().

datadropper_draw_cb()

void blender::ui::datadropper_draw_cb ( const bContext * , ARegion * , void * arg )

static

Definition at line 71 of file eyedropper_bone.cc.

References eyedropper_draw_cursor_text_region(), blender::ui::BoneDropper::name, and blender::ui::BoneDropper::name_pos.

Referenced by bonedropper_init(), and bonedropper_set_draw_callback_region().

drop_target_apply_drop()

bool blender::ui::drop_target_apply_drop	(	bContext &	C,
		const ARegion &	region,
		const wmEvent &	event,
		const DropTargetInterface &	drop_target,
		const ListBase &	drags )

Let a drop target handle a drop event.

Returns

True if the dropping was successful.

Definition at line 26 of file interface_drop.cc.

References C, blender::ui::DropTargetInterface::can_drop(), blender::ui::DropTargetInterface::choose_drop_location(), LISTBASE_FOREACH, and blender::ui::DropTargetInterface::on_drop().

Referenced by ui_view_drop_invoke().

drop_target_tooltip()

std::string blender::ui::drop_target_tooltip	(	const ARegion &	region,
		const DropTargetInterface &	drop_target,
		const wmDrag &	drag,
		const wmEvent &	event )

Call #DropTargetInterface::drop_tooltip() and return the result as newly allocated C string (unless the result is empty, returns null then). Needs freeing with MEM_freeN().

Definition at line 51 of file interface_drop.cc.

References blender::ui::DropTargetInterface::can_drop(), blender::ui::DropTargetInterface::choose_drop_location(), and blender::ui::DropTargetInterface::drop_tooltip().

Referenced by ui_view_drop_tooltip().

ENUM_OPERATORS()

blender::ui::ENUM_OPERATORS	(	TreeViewItemContainer::IterOptions	,
		TreeViewItemContainer::IterOptions::SkipCollapsed	)

References blender::ui::TreeViewItemContainer::SkipCollapsed.

eyedropper_colorband_apply()

void blender::ui::eyedropper_colorband_apply ( bContext * C, wmOperator * op )

static

Definition at line 164 of file eyedropper_colorband.cc.

References BKE_colorband_init_from_table_rgba(), C, blender::ui::EyedropperColorband::color_band, blender::ui::EyedropperColorband::color_buffer, wmOperator::customdata, blender::ui::EyedropperColorband::is_set, blender::ui::EyedropperColorband::prop, blender::ui::EyedropperColorband::ptr, and RNA_property_update().

Referenced by eyedropper_colorband_modal(), and eyedropper_colorband_point_modal().

eyedropper_colorband_cancel()

void blender::ui::eyedropper_colorband_cancel ( bContext * C, wmOperator * op )

static

Definition at line 180 of file eyedropper_colorband.cc.

References C, blender::ui::EyedropperColorband::color_band, wmOperator::customdata, eyedropper_colorband_exit(), blender::ui::EyedropperColorband::init_color_band, blender::ui::EyedropperColorband::is_set, blender::ui::EyedropperColorband::prop, blender::ui::EyedropperColorband::ptr, and RNA_property_update().

Referenced by eyedropper_colorband_modal(), eyedropper_colorband_point_modal(), UI_OT_eyedropper_colorramp(), and UI_OT_eyedropper_colorramp_point().

eyedropper_colorband_exec()

wmOperatorStatus blender::ui::eyedropper_colorband_exec ( bContext * C, wmOperator * op )

static

Definition at line 294 of file eyedropper_colorband.cc.

References C, eyedropper_colorband_exit(), eyedropper_colorband_init(), OPERATOR_CANCELLED, and OPERATOR_FINISHED.

Referenced by UI_OT_eyedropper_colorramp(), and UI_OT_eyedropper_colorramp_point().

eyedropper_colorband_exit()

void blender::ui::eyedropper_colorband_exit ( bContext * C, wmOperator * op )

static

Definition at line 153 of file eyedropper_colorband.cc.

References C, CTX_wm_window(), wmOperator::customdata, and WM_cursor_modal_restore().

Referenced by eyedropper_colorband_cancel(), eyedropper_colorband_exec(), eyedropper_colorband_modal(), and eyedropper_colorband_point_modal().

eyedropper_colorband_init()

bool blender::ui::eyedropper_colorband_init ( bContext * C, wmOperator * op )

static

Definition at line 60 of file eyedropper_colorband.cc.

References C, blender::ui::EyedropperColorband::color_band, ColorBand, CTX_data_pointer_get_type(), uiBut::custom_data, wmOperator::customdata, blender::ui::EyedropperColorband::init_color_band, blender::ui::EyedropperColorband::is_undo, uiBut::poin, PointerRNA_NULL, blender::ui::EyedropperColorband::prop, blender::ui::EyedropperColorband::ptr, ptr, RNA_struct_undo_check(), uiBut::rnapoin, uiBut::rnaprop, uiBut::type, UI_but_flag_is_set(), UI_BUT_UNDO, and UI_context_active_but_get().

Referenced by eyedropper_colorband_exec(), and eyedropper_colorband_invoke().

eyedropper_colorband_invoke()

wmOperatorStatus blender::ui::eyedropper_colorband_invoke ( bContext * C, wmOperator * op, const wmEvent *  )

static

Definition at line 274 of file eyedropper_colorband.cc.

References C, CTX_wm_region(), CTX_wm_window(), eyedropper_colorband_init(), OPERATOR_CANCELLED, OPERATOR_RUNNING_MODAL, UI_context_active_but_clear(), WM_CURSOR_EYEDROPPER, WM_cursor_modal_set(), and WM_event_add_modal_handler().

Referenced by UI_OT_eyedropper_colorramp(), and UI_OT_eyedropper_colorramp_point().

eyedropper_colorband_modal()

wmOperatorStatus blender::ui::eyedropper_colorband_modal ( bContext * C, wmOperator * op, const wmEvent * event )

static

Definition at line 193 of file eyedropper_colorband.cc.

References C, copy_v2_v2_int(), wmOperator::customdata, blender::ui::EyedropperColorband::event_xy_last, EVT_MODAL_MAP, EYE_MODAL_CANCEL, EYE_MODAL_SAMPLE_BEGIN, EYE_MODAL_SAMPLE_CONFIRM, EYE_MODAL_SAMPLE_RESET, eyedropper_colorband_apply(), eyedropper_colorband_cancel(), eyedropper_colorband_exit(), eyedropper_colorband_sample_point(), eyedropper_colorband_sample_segment(), blender::ui::EyedropperColorband::is_undo, MOUSEMOVE, OPERATOR_CANCELLED, OPERATOR_FINISHED, OPERATOR_RUNNING_MODAL, blender::ui::EyedropperColorband::sample_start, wmEvent::type, wmEvent::val, and wmEvent::xy.

Referenced by UI_OT_eyedropper_colorramp().

eyedropper_colorband_point_modal()

wmOperatorStatus blender::ui::eyedropper_colorband_point_modal ( bContext * C, wmOperator * op, const wmEvent * event )

static

Definition at line 232 of file eyedropper_colorband.cc.

References C, blender::ui::EyedropperColorband::color_band, blender::ui::EyedropperColorband::color_buffer, wmOperator::customdata, EVT_MODAL_MAP, EYE_MODAL_POINT_CANCEL, EYE_MODAL_POINT_CONFIRM, EYE_MODAL_POINT_REMOVE_LAST, EYE_MODAL_POINT_SAMPLE, EYE_MODAL_SAMPLE_RESET, eyedropper_colorband_apply(), eyedropper_colorband_cancel(), eyedropper_colorband_exit(), eyedropper_colorband_sample_point(), blender::ui::EyedropperColorband::init_color_band, MAXCOLORBAND, OPERATOR_CANCELLED, OPERATOR_FINISHED, OPERATOR_RUNNING_MODAL, blender::ui::EyedropperColorband::prop, blender::ui::EyedropperColorband::ptr, RNA_property_update(), wmEvent::type, wmEvent::val, and wmEvent::xy.

Referenced by UI_OT_eyedropper_colorramp_point().

eyedropper_colorband_poll()

bool blender::ui::eyedropper_colorband_poll ( bContext * C )

static

Definition at line 309 of file eyedropper_colorband.cc.

References C, ColorBand, CTX_data_pointer_get_type(), ptr, uiBut::type, and UI_context_active_but_get().

Referenced by UI_OT_eyedropper_colorramp(), and UI_OT_eyedropper_colorramp_point().

eyedropper_colorband_sample_callback()

bool blender::ui::eyedropper_colorband_sample_callback ( int mx, int my, void * userdata )

static

Definition at line 132 of file eyedropper_colorband.cc.

References C, data, and eyedropper_colorband_sample_point().

Referenced by eyedropper_colorband_sample_segment().

eyedropper_colorband_sample_point()

void blender::ui::eyedropper_colorband_sample_point ( bContext * C, EyedropperColorband * eye, const int m_xy[2] )

static

Definition at line 118 of file eyedropper_colorband.cc.

References C, col, blender::ui::EyedropperColorband::color_buffer, copy_v2_v2_int(), blender::ui::EyedropperColorband::event_xy_last, eyedropper_color_sample_fl(), and blender::ui::EyedropperColorband::is_set.

Referenced by eyedropper_colorband_modal(), eyedropper_colorband_point_modal(), and eyedropper_colorband_sample_callback().

eyedropper_colorband_sample_segment()

void blender::ui::eyedropper_colorband_sample_segment ( bContext * C, EyedropperColorband * eye, const int m_xy[2] )

static

Definition at line 142 of file eyedropper_colorband.cc.

References BLI_bitmap_draw_2d_line_v2v2i(), C, blender::ui::EyedropperColorband::event_xy_last, and eyedropper_colorband_sample_callback().

Referenced by eyedropper_colorband_modal().

find_filtered_item_index()

std::optional< int > blender::ui::find_filtered_item_index ( const AbstractGridViewItem & item )

static

Definition at line 241 of file grid_view.cc.

References BLI_assert, blender::ui::AbstractGridViewItem::get_view(), i, blender::ui::AbstractViewItem::is_filtered_visible(), and view.

find_first_view_item_but()

uiButViewItem * blender::ui::find_first_view_item_but ( const uiBlock & block, const AbstractTreeView & view )

static

Definition at line 265 of file tree_view.cc.

References uiBlock::buttons, blender::ui::AbstractViewItem::get_view(), view, uiButViewItem::view_item, and ViewItem.

find_item_from_rename_button()

AbstractViewItem * blender::ui::find_item_from_rename_button ( const uiBut & rename_but )

static

Definition at line 196 of file abstract_view_item.cc.

References BLI_assert, uiBut::block, uiBlock::buttons, blender::ui::AbstractViewItem::get_view(), blender::ui::AbstractViewItem::is_renaming(), uiBut::poin, Text, uiBut::type, view, uiButViewItem::view_item, and ViewItem.

Referenced by rename_button_fn().

generate_sample_warning()

void blender::ui::generate_sample_warning ( SampleResult result, wmOperator * op )

static

Definition at line 399 of file eyedropper_bone.cc.

References BKE_report(), NO_BONE_3DVIEW, NO_BONE_OUTLINER, wmOperator::reports, result, RPT_WARNING, SUCCESS, UNKNOWN_FAILURE, WRONG_AREA, and WRONG_ARMATURE.

Referenced by bonedropper_modal().

grease_pencil_layer_search_add_items() [1/2]

void blender::ui::grease_pencil_layer_search_add_items	(	const StringRef	str,
		const Span< const std::string * >	layer_names,
		uiSearchItems &	seach_items,
		const bool	is_first )

Definition at line 30 of file interface_template_grease_pencil_layer_search.cc.

References blender::string_search::StringSearch< T >::add(), name, blender::string_search::StringSearch< T >::query(), str, UI_BUT_HAS_SEP_CHAR, and UI_search_item_add().

grease_pencil_layer_search_add_items() [2/2]

void blender::ui::grease_pencil_layer_search_add_items	(	StringRef	str,
		Span< const std::string * >	layer_names,
		uiSearchItems &	items,
		bool	is_first )

References C, and str.

Referenced by blender::nodes::layer_name_search_update_fn(), and blender::ed::space_node::layer_search_update_fn().

is_bone_dropper_valid()

bool blender::ui::is_bone_dropper_valid ( BoneDropper * bone_dropper )

static

Definition at line 77 of file eyedropper_bone.cc.

References PointerRNA::data, ID_AR, PointerRNA::owner_id, blender::ui::BoneDropper::prop, blender::ui::BoneDropper::ptr, RNA_id_pointer_create(), RNA_property_editable(), RNA_type_to_ID_code(), blender::ui::BoneDropper::search_ptr, and PointerRNA::type.

Referenced by bonedropper_init().

padded_item_height()

int blender::ui::padded_item_height ( )

static

Definition at line 43 of file tree_view.cc.

References uiStyle::buttonspacey, UI_style_get_dpi(), and unpadded_item_height().

Referenced by blender::ui::TreeViewLayoutBuilder::build_from_tree(), blender::ui::TreeViewLayoutBuilder::build_row(), blender::ui::AbstractTreeView::persistent_state_apply(), and blender::ui::AbstractTreeView::set_default_rows().

region_views_find_drop_target_at()

std::unique_ptr< DropTargetInterface > blender::ui::region_views_find_drop_target_at	(	const ARegion *	region,
		const int	xy[2] )

Try to find a view item with a drop target under the mouse cursor, or if not found, a view with a drop target.

Parameters

xy	Coordinate to find a drop target at, in window space.

Definition at line 268 of file interface_view.cc.

References uiStyle::buttonspacex, blender::ui::AbstractTreeViewItem::create_item_drop_target(), blender::ui::AbstractViewItem::is_interactive(), UI_region_view_find_at(), UI_region_views_find_item_at(), UI_style_get_dpi(), view, and xy.

Referenced by ui_view_drop_invoke(), ui_view_drop_poll(), ui_view_drop_poll(), and ui_view_drop_tooltip().

rename_button_fn()

void blender::ui::rename_button_fn ( bContext * C, void * arg, char *  )

static

Definition at line 218 of file abstract_view_item.cc.

References BLI_assert, find_item_from_rename_button(), and blender::ui::AbstractViewItem::rename_apply().

Referenced by blender::ui::AbstractViewItem::add_rename_button().

sample_data_from_3d_view()

BoneSampleData blender::ui::sample_data_from_3d_view ( bContext * C, const int mval[2], const BoneDropper & bdr )

static

Definition at line 176 of file eyedropper_bone.cc.

References blender::ui::BoneSampleData::bone_rna, C, CTX_data_mode_enum(), CTX_MODE_EDIT_ARMATURE, CTX_MODE_POSE, Object::data, ED_armature_pick_ebone(), ED_armature_pick_pchan(), bArmature::id, Object::id, blender::ui::BoneSampleData::name, bPoseChannel::name, EditBone::name, NO_BONE_3DVIEW, Base::object, PointerRNA::owner_id, RNA_pointer_create_discrete(), blender::ui::BoneSampleData::sample_result, blender::ui::BoneDropper::search_ptr, SUCCESS, and WRONG_ARMATURE.

Referenced by bonedropper_sample_pt().

sample_data_from_outliner()

BoneSampleData blender::ui::sample_data_from_outliner ( bContext * C, const int mval[2], const BoneDropper & bdr )

static

Definition at line 225 of file eyedropper_bone.cc.

References BLI_assert, blender::ui::BoneSampleData::bone_rna, C, Object::data, PointerRNA::data, ED_outliner_give_rna_under_cursor(), GS, ID_OB, blender::ui::BoneSampleData::name, Bone::name, bPoseChannel::name, EditBone::name, ID::name, NO_BONE_OUTLINER, PointerRNA::owner_id, blender::ui::BoneSampleData::sample_result, blender::ui::BoneDropper::search_ptr, SUCCESS, PointerRNA::type, and WRONG_ARMATURE.

Referenced by bonedropper_sample_pt().

template_asset_shelf_popover()

void blender::ui::template_asset_shelf_popover	(	uiLayout &	layout,
		const bContext &	C,
		StringRefNull	asset_shelf_id,
		StringRef	name,
		int	icon )

Definition at line 26 of file interface_template_asset_shelf_popover.cc.

References uiLayout::block(), uiBlock::buttons, blender::StringRefNull::c_str(), uiLayout::context_string_set(), CTX_wm_region(), blender::ed::asset::shelf::ensure_asset_library_fetched(), Vector< T, InlineBufferCapacity, Allocator >::last(), name, uiLayout::popover(), ARegion::regiontype, RGN_TYPE_IS_HEADER_ANY, RNA_warning, uiLayout::row(), uiLayout::scale_x_set(), uiLayout::scale_y_set(), blender::ed::asset::shelf::type_find_from_idname(), UI_BUT_ICON_PREVIEW, UI_but_menu_disable_hover_open(), ui_def_but_icon(), UI_HAS_ICON, and uiLayout::ui_units_x_set().

template_breadcrumbs()

void blender::ui::template_breadcrumbs	(	uiLayout &	layout,
		Span< ContextPathItem >	context_path )

Definition at line 57 of file interface_context_path.cc.

References uiLayout::alignment_set(), uiLayout::button(), i, blender::Span< T >::index_range(), uiLayout::label(), Left, name, uiLayout::row(), UI_but_icon_indicator_number_set(), and uiItemL_ex().

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

UI_OT_eyedropper_bone()

void blender::ui::UI_OT_eyedropper_bone

(

wmOperatorType *

ot

)

Definition at line 541 of file eyedropper_bone.cc.

References bonedropper_cancel(), bonedropper_exec(), bonedropper_invoke(), bonedropper_modal(), bonedropper_poll(), OPTYPE_BLOCKING, OPTYPE_INTERNAL, OPTYPE_UNDO, and ot.

Referenced by ED_operatortypes_ui().

UI_OT_eyedropper_colorramp()

void blender::ui::UI_OT_eyedropper_colorramp

(

wmOperatorType *

ot

)

Definition at line 322 of file eyedropper_colorband.cc.

References eyedropper_colorband_cancel(), eyedropper_colorband_exec(), eyedropper_colorband_invoke(), eyedropper_colorband_modal(), eyedropper_colorband_poll(), OPTYPE_BLOCKING, OPTYPE_INTERNAL, OPTYPE_UNDO, and ot.

Referenced by ED_operatortypes_ui().

UI_OT_eyedropper_colorramp_point()

void blender::ui::UI_OT_eyedropper_colorramp_point

(

wmOperatorType *

ot

)

Definition at line 342 of file eyedropper_colorband.cc.

References eyedropper_colorband_cancel(), eyedropper_colorband_exec(), eyedropper_colorband_invoke(), eyedropper_colorband_point_modal(), eyedropper_colorband_poll(), OPTYPE_BLOCKING, OPTYPE_INTERNAL, OPTYPE_UNDO, and ot.

Referenced by ED_operatortypes_ui().

unpadded_item_height()

int blender::ui::unpadded_item_height ( )

static

Definition at line 39 of file tree_view.cc.

References UI_UNIT_Y.

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