|
Blender V5.3
|
#include <UI_grid_view.hh>
Inherits blender::ui::AbstractView.
Inherited by blender::ed::asset::shelf::AssetView.
Public Types | |
| using | ItemIterFn = FunctionRef<void(AbstractGridViewItem &)> |
Public Member Functions | |
| AbstractGridView () | |
| ~AbstractGridView () override=default | |
| void | foreach_item (ItemIterFn iter_fn) const |
| void | foreach_filtered_item (ItemIterFn iter_fn) const |
| template<class ItemT, typename... Args> | |
| ItemT & | add_item (Args &&...args) |
| const GridViewStyle & | get_style () const |
| int | get_item_count () const |
| int | get_item_count_filtered () const |
| void | set_tile_size (int tile_width, int tile_height) |
| AbstractViewItem * | find_active_or_visible_item () const override |
| AbstractViewItem * | navigate_left (AbstractViewItem *from) override |
| AbstractViewItem * | navigate_right (AbstractViewItem *from) override |
| AbstractViewItem * | navigate_up (AbstractViewItem *from) override |
| AbstractViewItem * | navigate_down (AbstractViewItem *from) override |
| void | scroll_active_into_view (bContext *C, bool scroll_active_to_center=false) override |
| void | page_scroll (bContext *C, PageScrollDirection direction) override |
| IndexRange | get_visible_range (const View2D &v2d, const AbstractGridViewItem *force_visible_item) const |
| Public Member Functions inherited from blender::ui::AbstractView | |
| virtual | ~AbstractView ()=default |
| void | register_item (AbstractViewItem &item) |
| virtual std::unique_ptr< DropTargetInterface > | create_drop_target () |
| virtual bool | listen (const wmNotifier &) const |
| virtual bool | begin_filtering (const bContext &C) const |
| virtual void | draw_overlays (const ARegion ®ion, const Block &block) const |
| virtual bool | supports_scrolling () const |
| virtual bool | is_fully_visible () const |
| virtual void | scroll (ViewScrollDirection direction) |
| virtual std::optional< uiViewState > | persistent_state () const |
| virtual void | persistent_state_apply (const uiViewState &state) |
| bool | is_renaming () const |
| bool | begin_renaming () |
| void | end_renaming () |
| Span< char > | get_rename_buffer () const |
| MutableSpan< char > | get_rename_buffer () |
| std::optional< rcti > | get_bounds () const |
| std::string | get_context_menu_title () const |
| void | set_context_menu_title (const std::string &title) |
| bool | get_popup_keep_open () const |
| void | set_popup_keep_open () |
| void | clear_search_highlight () |
| void | allow_multiselect_items () |
| bool | is_multiselect_supported () const |
Protected Member Functions | |
| virtual void | build_items ()=0 |
| Protected Member Functions inherited from blender::ui::AbstractView | |
| AbstractView ()=default | |
| virtual void | change_state_delayed () |
| void | update_from_old (Block &new_block) |
| bool | is_reconstructed () const |
| const AbstractViewItem * | search_highlight_item () const |
| void | filter (std::optional< StringRef > filter_str) |
Protected Attributes | |
| Vector< std::unique_ptr< AbstractGridViewItem > > | items_ |
| std::optional< int > | item_count_filtered_ |
| Map< StringRef, AbstractGridViewItem * > | item_map_ |
| GridViewStyle | style_ |
| int | cols_per_row_ = 0 |
Friends | |
| class | AbstractGridViewItem |
| class | GridViewBuilder |
| class | GridViewLayoutBuilder |
Definition at line 85 of file UI_grid_view.hh.
| using blender::ui::AbstractGridView::ItemIterFn = FunctionRef<void(AbstractGridViewItem &)> |
Definition at line 104 of file UI_grid_view.hh.
| blender::ui::AbstractGridView::AbstractGridView | ( | ) |
Definition at line 35 of file grid_view.cc.
References blender::ui::preview_tile_size_x(), blender::ui::preview_tile_size_y(), and style_.
Referenced by build_items().
|
overridedefault |
|
inline |
Convenience wrapper constructing the item by forwarding given arguments to the constructor of the type (ItemT).
E.g. if your grid-item type has the following constructor:
You can add an item like this:
Definition at line 253 of file UI_grid_view.hh.
References add_item().
Referenced by add_item(), blender::ed::asset::shelf::AssetView::build_items(), and build_items().
|
protectedpure virtual |
Implemented in blender::ed::asset::shelf::AssetView.
References AbstractGridView(), AbstractGridViewItem, blender::ui::AbstractView::AbstractView(), blender::ui::AbstractView::AbstractViewItem, and add_item().
Referenced by blender::ui::GridViewBuilder::build_grid_view().
|
overridevirtual |
Implements blender::ui::AbstractView.
Definition at line 145 of file grid_view.cc.
References blender::ui::AbstractView::AbstractViewItem, foreach_filtered_item(), and blender::ui::AbstractViewItem::is_active().
| void blender::ui::AbstractGridView::foreach_filtered_item | ( | ItemIterFn | iter_fn | ) | const |
Definition at line 64 of file grid_view.cc.
References items_.
Referenced by blender::ui::GridViewLayoutBuilder::build_from_view(), find_active_or_visible_item(), blender::ui::find_filtered_item_index(), get_item_count_filtered(), navigate_down(), navigate_left(), navigate_right(), navigate_up(), and scroll_active_into_view().
| void blender::ui::AbstractGridView::foreach_item | ( | ItemIterFn | iter_fn | ) | const |
Definition at line 57 of file grid_view.cc.
References items_.
| int blender::ui::AbstractGridView::get_item_count | ( | ) | const |
Definition at line 102 of file grid_view.cc.
References items_.
Referenced by blender::ed::asset::shelf::build_asset_view(), and get_item_count_filtered().
| int blender::ui::AbstractGridView::get_item_count_filtered | ( | ) | const |
Definition at line 107 of file grid_view.cc.
References blender::BLI_assert(), foreach_filtered_item(), get_item_count(), and item_count_filtered_.
Referenced by blender::ed::asset::shelf::build_asset_view(), blender::ui::GridViewBuilder::build_grid_view(), blender::ui::BuildOnlyVisibleButtonsHelper::BuildOnlyVisibleButtonsHelper(), navigate_down(), and navigate_up().
| const GridViewStyle & blender::ui::AbstractGridView::get_style | ( | ) | const |
Definition at line 97 of file grid_view.cc.
References style_.
Referenced by blender::ui::GridViewLayoutBuilder::build_from_view(), blender::ed::asset::shelf::AssetViewItem::build_grid_tile(), and blender::ui::PreviewGridItem::build_grid_tile_button().
| IndexRange blender::ui::AbstractGridView::get_visible_range | ( | const View2D & | v2d, |
| const AbstractGridViewItem * | force_visible_item ) const |
Definition at line 270 of file grid_view.cc.
References AbstractGridViewItem, blender::BLI_assert(), blender::BLI_rcti_size_y(), cols_per_row_, blender::IndexRange::contains(), blender::View2D::cur, blender::ui::find_filtered_item_index(), blender::View2D::flag, blender::IndexRange::IndexRange(), IS_EQF, blender::ui::AbstractViewItem::is_filtered_visible(), blender::View2D::mask, style_, blender::ui::GridViewStyle::tile_height, blender::View2D::tot, blender::V2D_IS_INIT, and blender::rctf::ymax.
Referenced by page_scroll(), and scroll_active_into_view().
|
overridevirtual |
Implements blender::ui::AbstractView.
Definition at line 209 of file grid_view.cc.
References AbstractGridViewItem, blender::ui::AbstractView::AbstractViewItem, cols_per_row_, blender::ui::find_filtered_item_index(), foreach_filtered_item(), and get_item_count_filtered().
|
overridevirtual |
Implements blender::ui::AbstractView.
Definition at line 160 of file grid_view.cc.
References blender::ui::AbstractView::AbstractViewItem, and foreach_filtered_item().
|
overridevirtual |
Implements blender::ui::AbstractView.
Definition at line 174 of file grid_view.cc.
References blender::ui::AbstractView::AbstractViewItem, and foreach_filtered_item().
|
overridevirtual |
Implements blender::ui::AbstractView.
Definition at line 190 of file grid_view.cc.
References AbstractGridViewItem, blender::ui::AbstractView::AbstractViewItem, cols_per_row_, blender::ui::find_filtered_item_index(), foreach_filtered_item(), and get_item_count_filtered().
|
overridevirtual |
Implements blender::ui::AbstractView.
Definition at line 229 of file grid_view.cc.
References blender::BLI_rctf_size_y(), blender::BLI_rcti_size_y(), blender::ui::Bottom, C, cols_per_row_, blender::CTX_wm_region(), blender::View2D::cur, blender::ui::Down, blender::IndexRange::first(), get_visible_range(), blender::View2D::mask, style_, blender::ui::GridViewStyle::tile_height, blender::ui::Top, blender::View2D::tot, blender::ui::Up, blender::ARegion::v2d, blender::rctf::ymax, and blender::rctf::ymin.
|
overridevirtual |
Implements blender::ui::AbstractView.
Definition at line 304 of file grid_view.cc.
References blender::ui::AbstractView::AbstractViewItem, blender::BLI_rctf_size_y(), blender::BLI_rcti_size_y(), blender::ui::Button::block, blender::ui::block_to_region_rctf(), C, cols_per_row_, blender::CTX_wm_region(), blender::View2D::cur, blender::IndexRange::first(), foreach_filtered_item(), get_visible_range(), blender::ui::AbstractViewItem::is_active(), blender::IndexRange::last(), blender::View2D::mask, blender::ui::Button::rect, style_, blender::ui::GridViewStyle::tile_height, blender::View2D::tot, blender::U, blender::ARegion::v2d, blender::ui::view2d_region_to_view_rctf(), blender::ui::AbstractViewItem::view_item_button(), blender::rctf::ymax, and blender::rctf::ymin.
| void blender::ui::AbstractGridView::set_tile_size | ( | int | tile_width, |
| int | tile_height ) |
Definition at line 121 of file grid_view.cc.
References style_, blender::ui::GridViewStyle::tile_height, and blender::ui::GridViewStyle::tile_width.
|
friend |
Definition at line 86 of file UI_grid_view.hh.
References AbstractGridViewItem.
Referenced by AbstractGridViewItem, build_items(), get_visible_range(), navigate_down(), and navigate_up().
|
friend |
Definition at line 87 of file UI_grid_view.hh.
References GridViewBuilder.
Referenced by GridViewBuilder.
|
friend |
Definition at line 88 of file UI_grid_view.hh.
References GridViewLayoutBuilder.
Referenced by GridViewLayoutBuilder.
|
protected |
Definition at line 98 of file UI_grid_view.hh.
Referenced by blender::ui::GridViewLayoutBuilder::build_from_view(), get_visible_range(), navigate_down(), navigate_up(), page_scroll(), and scroll_active_into_view().
|
mutableprotected |
Store this to avoid recomputing.
Definition at line 93 of file UI_grid_view.hh.
Referenced by get_item_count_filtered().
|
protected |
<identifier, item> map to lookup items by identifier, used for efficient lookups in update_from_old().
Definition at line 96 of file UI_grid_view.hh.
|
protected |
Definition at line 91 of file UI_grid_view.hh.
Referenced by foreach_filtered_item(), foreach_item(), and get_item_count().
|
protected |
Definition at line 97 of file UI_grid_view.hh.
Referenced by AbstractGridView(), get_style(), get_visible_range(), page_scroll(), scroll_active_into_view(), and set_tile_size().