#include <UI_grid_view.hh>

Inheritance diagram for blender::ui::PreviewGridItem:

Public Types
using	IsActiveFn = std::function< bool()>

using	ActivateFn = std::function< void(PreviewGridItem &new_active)>

Public Member Functions
	PreviewGridItem (StringRef identifier, StringRef label, int preview_icon_id)

void	build_grid_tile (uiLayout &layout) const override

void	set_on_activate_fn (ActivateFn fn)

void	set_is_active_fn (IsActiveFn fn)

Public Member Functions inherited from blender::ui::AbstractGridViewItem
virtual	~AbstractGridViewItem ()=default

const AbstractGridView &	get_view () const

Public Member Functions inherited from blender::ui::AbstractViewItem
virtual	~AbstractViewItem ()=default

virtual void	build_context_menu (bContext &C, uiLayout &column) const

virtual std::unique_ptr< AbstractViewItemDragController >	create_drag_controller () const

virtual std::unique_ptr< AbstractViewItemDropController >	create_drop_controller () const

AbstractView &	get_view () const

bool	is_active () const

virtual bool	supports_renaming () const

virtual bool	rename (StringRefNull new_name)

virtual StringRef	get_rename_string () const

bool	is_renaming () const

void	begin_renaming ()

void	end_renaming ()

void	rename_apply ()

Public Attributes
std::string	label {}

int	preview_icon_id = ICON_NONE

Protected Attributes
ActivateFn	activate_fn_

IsActiveFn	is_active_fn_

Protected Attributes inherited from blender::ui::AbstractGridViewItem
StringRef	identifier_ {}

uiButViewItem *	view_item_but_ = nullptr

Protected Attributes inherited from blender::ui::AbstractViewItem
AbstractView *	view_ = nullptr

bool	is_active_ = false

bool	is_renaming_ = false

Additional Inherited Members
Static Public Member Functions inherited from blender::ui::AbstractViewItem
template<typename ToType = AbstractViewItem>
static ToType *	from_item_handle (uiViewItemHandle *handle)

Protected Member Functions inherited from blender::ui::AbstractGridViewItem
	AbstractGridViewItem (StringRef identifier)

virtual bool	matches (const AbstractViewItem &other) const override

void	activate ()

void	deactivate ()

Protected Member Functions inherited from blender::ui::AbstractViewItem
	AbstractViewItem ()=default

virtual void	update_from_old (const AbstractViewItem &old)

void	add_rename_button (uiBlock &block)

Detailed Description

A grid item that shows preview image icons at a nicely readable size (multiple of the normal UI unit size).

Definition at line 182 of file UI_grid_view.hh.

Member Typedef Documentation

◆ ActivateFn

using blender::ui::PreviewGridItem::ActivateFn = std::function<void(PreviewGridItem &new_active)>

Definition at line 185 of file UI_grid_view.hh.

◆ IsActiveFn

using blender::ui::PreviewGridItem::IsActiveFn = std::function<bool()>

Definition at line 184 of file UI_grid_view.hh.

Constructor & Destructor Documentation

◆ PreviewGridItem()

blender::ui::PreviewGridItem::PreviewGridItem	(	StringRef	identifier,
		StringRef	label,
		int	preview_icon_id
	)

Definition at line 408 of file grid_view.cc.

Member Function Documentation

◆ build_grid_tile()

void blender::ui::PreviewGridItem::build_grid_tile ( uiLayout & layout ) const

overridevirtual

Implements blender::ui::AbstractGridViewItem.

Definition at line 413 of file grid_view.cc.

References blender::ui::AbstractGridView::get_style(), blender::ui::AbstractGridViewItem::get_view(), label, preview_icon_id, blender::ui::GridViewStyle::tile_height, blender::ui::GridViewStyle::tile_width, UI_BTYPE_PREVIEW_TILE, UI_BUT_ICON_PREVIEW, ui_def_but_icon(), UI_HAS_ICON, uiDefBut(), and uiLayoutGetBlock().

◆ set_is_active_fn()

void blender::ui::PreviewGridItem::set_is_active_fn ( IsActiveFn fn )

Set a custom callback to check if this item should be active.

Definition at line 443 of file grid_view.cc.

References is_active_fn_.

◆ set_on_activate_fn()

void blender::ui::PreviewGridItem::set_on_activate_fn ( ActivateFn fn )

Set a custom callback to execute when activating this view item. This way users don't have to sub-class PreviewGridItem, just to implement custom activation behavior (a common thing to do).

Definition at line 438 of file grid_view.cc.

References activate_fn_.