Namespaces
namespace	bonecollections
namespace	greasepencil
namespace	light_linking
namespace	nodes
namespace	string_search

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

Enumerations
enum class	ViewScrollDirection { UP , DOWN }
enum class	DropBehavior { Reorder , Insert , ReorderAndInsert }
enum class	DropLocation { Into , Before , After }
enum class	SampleResult { UNKNOWN_FAILURE , SUCCESS , NO_BONE_3DVIEW , NO_BONE_OUTLINER , WRONG_AREA , WRONG_ARMATURE }

Functions
void	context_path_add_generic (Vector< ContextPathItem > &path, StructRNA &rna_type, void *ptr, const BIFIconID icon_override=ICON_NONE)
void	attribute_search_add_items (StringRefNull str, bool can_create_attribute, Span< const nodes::geo_eval_log::GeometryAttributeInfo * > infos, 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])
void	template_asset_shelf_popover (uiLayout &layout, const bContext &C, StringRefNull asset_shelf_id, StringRefNull name, int icon)
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 int	bonedropper_modal (bContext C, wmOperator op, const wmEvent *event)
static int	bonedropper_invoke (bContext C, wmOperator op, const wmEvent *)
static int	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 int	eyedropper_colorband_modal (bContext C, wmOperator op, const wmEvent *event)
static int	eyedropper_colorband_point_modal (bContext C, wmOperator op, const wmEvent *event)
static int	eyedropper_colorband_invoke (bContext C, wmOperator op, const wmEvent *)
static int	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)
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 106 of file UI_tree_view.hh.

Enumeration Type Documentation

◆ 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 102 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 121 of file UI_interface.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 44 of file eyedropper_bone.cc.

◆ ViewScrollDirection

enum class blender::ui::ViewScrollDirection

strong

Enumerator
UP
DOWN

Definition at line 49 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 63 of file interface_template_asset_shelf_popover.cc.

References BKE_reportf(), 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(), uiLayoutSetContextString(), 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 30 of file interface_template_attribute_search.cc.

References IFACE_, 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 37 of file interface_template_attribute_search.cc.

References IFACE_, 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	(	StringRefNull	str,
		bool	can_create_attribute,
		Span< const nodes::geo_eval_log::GeometryAttributeInfo * >	infos,
		uiSearchItems *	items,
		bool	is_first )

Definition at line 55 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::attribute_search_update_fn(), and blender::ed::space_node::attribute_search_update_fn().

◆ attribute_search_item_add()

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

static

Definition at line 44 of file interface_template_attribute_search.cc.

References 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.

Referenced by attribute_search_add_items().

◆ bonedropper_cancel()

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

static

Definition at line 153 of file eyedropper_bone.cc.

References bonedropper_exit(), and C.

Referenced by bonedropper_modal(), and UI_OT_eyedropper_bone().

◆ bonedropper_exec()

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

static

Definition at line 490 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 134 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

◆ bonedropper_invoke()

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

static

Definition at line 473 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()

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

static

◆ bonedropper_poll()

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

static

Definition at line 500 of file eyedropper_bone.cc.

References C, CTX_wm_window(), ELEM, uiBut::flag, PROP_POINTER, PROP_STRING, ptr, RNA_property_pointer_type(), RNA_property_type(), uiButSearch::rnasearchpoin, uiButSearch::rnasearchprop, uiBut::type, UI_BTYPE_SEARCH_MENU, 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

◆ bonedropper_sample_pt()

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

static

◆ bonedropper_set_draw_callback_region()

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

static

Definition at line 159 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().

◆ 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 )

Definition at line 20 of file interface_context_path.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), ID_REAL_USERS, MEM_freeN(), ptr, RNA_pointer_create(), 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::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 744 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 75 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 24 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 49 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().