54class TreeViewItemContainer {
59 TreeViewItemContainer() =
default;
64 TreeViewItemContainer *
root_ =
nullptr;
77 SkipCollapsed = 1 << 0,
78 SkipFiltered = 1 << 1,
95 template<
class ItemT,
typename... Args>
inline ItemT &
add_tree_item(Args &&...args);
130 std::shared_ptr<int> custom_height_ =
nullptr;
133 std::shared_ptr<int> scroll_value_ =
nullptr;
137 int last_tot_items_ = 0;
138 bool scroll_active_into_view_on_draw_ =
false;
142 std::shared_ptr<char> show_display_options_ = std::make_shared<char>(0);
146 std::shared_ptr<char> invert_search_filter_ = std::make_shared<char>(0);
149 std::shared_ptr<char[]> search_string_{
new char[256 ]{}};
154 std::shared_ptr<char> sort_alpha_ = std::make_shared<char>(0);
158 std::shared_ptr<TreeViewSortOrder> invert_sort_type_ = std::make_shared<TreeViewSortOrder>(
199 void update_children_from_old(
const AbstractView &old_view)
override;
200 static void update_children_from_old_recursive(
const TreeViewOrItem &new_items,
204 std::optional<int> tot_visible_row_count()
const;
206 bool supports_scrolling()
const override;
208 void draw_hierarchy_lines(
const ARegion ®ion,
const Block &block)
const;
211 Vector<std::pair<int2, int2>> &lines,
212 int &visible_item_index)
const;
215 void sort_inverted();
245 bool is_open_ =
false;
257 std::optional<std::string>
debug_name()
const override;
362 static
void collapse_chevron_click_fn(
bContext *,
void *but_arg1,
void *);
368 bool set_state_active()
final;
370 void add_treerow_button(
Block &block);
371 int indent_width() const;
372 void add_indent(
Layout &row) const;
373 void add_collapse_chevron(
Block &block) const;
374 void add_rename_button(
Layout &row);
376 bool has_active_child() const;
416 std::optional<bool> should_be_active()
const override;
445 const wmEvent &event)
const override;
449 template<
class ViewType>
inline ViewType &
get_view()
const;
463 bool add_box =
true);
473template<
class ItemT,
typename... Args>
476 static_assert(std::is_base_of_v<AbstractTreeViewItem, ItemT>,
477 "Type must derive from and implement the AbstractTreeViewItem interface");
479 return dynamic_cast<ItemT &
>(
480 add_tree_item(std::make_unique<ItemT>(std::forward<Args>(args)...)));
485 static_assert(std::is_base_of_v<AbstractTreeView, ViewType>,
486 "Type must derive from and implement the ui::AbstractTreeView interface");
487 return dynamic_cast<ViewType &
>(
view_item_.get_tree_view());
Abstract base class for defining a customizable tree-view item.
std::optional< rctf > get_win_rect(const ARegion ®ion) const
void update_from_old(const AbstractViewItem &old) override
bool is_collapsed() const
AbstractTreeViewItem * get_child()
void change_state_delayed() override
int count_parents() const
AbstractTreeView & get_tree_view() const
std::unique_ptr< DropTargetInterface > create_item_drop_target() final
bool is_collapsible() const
StringRef get_rename_string() const override
bool matches(const AbstractViewItem &other) const override
void toggle_collapsed_from_view(bContext &C)
virtual void build_row(Layout &row)=0
virtual std::unique_ptr< TreeViewItemDropTarget > create_drop_target()
virtual void on_collapse_change(bContext &C, bool is_collapsed)
friend class TreeViewLayoutBuilder
~AbstractTreeViewItem() override=default
virtual std::optional< bool > should_be_collapsed() const
AbstractTreeViewItem * get_parent()
virtual bool set_collapsed(bool collapsed)
virtual bool matches_single(const AbstractTreeViewItem &other) const
bool should_be_filtered_visible(StringRefNull filter_string) const override
std::optional< std::string > debug_name() const override
friend class AbstractTreeView
virtual bool supports_collapsing() const
void uncollapse_by_default()
bool rename(const bContext &C, StringRefNull new_name) override
StringRefNull label() const
friend class TreeViewItemAPIWrapper
void ensure_parents_uncollapsed()
void on_filter() override
void scroll(ViewScrollDirection direction) override
void foreach_root_item(ItemIterFn iter_fn) const
friend class AbstractTreeViewItem
bool is_fully_visible() const override
void scroll_active_into_view(bContext *C, bool scroll_active_to_center=false) override
friend class TreeViewItemDropTarget
void persistent_state_apply(const uiViewState &state) override
void draw_overlays(const ARegion ®ion, const Block &block) const override
friend class TreeViewLayoutBuilder
~AbstractTreeView() override=default
TreeViewSortOrder invert_sort_type_get() const
virtual void build_tree()=0
void foreach_item(ItemIterFn iter_fn, IterOptions options=IterOptions::None) const
std::optional< uiViewState > persistent_state() const override
void set_default_rows(int default_rows)
friend class TreeViewBuilder
AbstractViewItem()=default
friend class AbstractViewItem
void add_label(Layout &layout, StringRefNull label_override="")
BasicTreeViewItem(StringRef label, BIFIconID icon=ICON_NONE)
std::function< bool()> IsActiveFn
std::function< void(bContext &C, BasicTreeViewItem &new_active)> ActivateFn
void set_is_active_fn(IsActiveFn is_active_fn)
void set_on_activate_fn(ActivateFn fn)
void build_row(Layout &row) override
DropTargetInterface()=default
static void build_tree_view(const bContext &C, AbstractTreeView &tree_view, Layout &layout, bool add_box=true)
ItemT & add_tree_item(Args &&...args)
friend class AbstractTreeViewItem
AbstractTreeViewItem * parent_
TreeViewItemContainer * root_
void foreach_item_recursive(ItemIterFn iter_fn, IterOptions options=IterOptions::None) const
void foreach_sort_invert(TreeViewSortOrder order)
Vector< std::unique_ptr< AbstractTreeViewItem > > children_
void foreach_parent(ItemIterFn iter_fn) const
friend class AbstractTreeView
FunctionRef< void(AbstractTreeViewItem &)> ItemIterFn
AbstractTreeViewItem & view_item_
TreeViewItemDropTarget(AbstractTreeViewItem &view_item, DropBehavior behavior=DropBehavior::Insert)
const DropBehavior behavior_
std::optional< DropLocation > choose_drop_location(const ARegion ®ion, const wmEvent &event) const override
ViewType & get_view() const
CCL_NAMESPACE_BEGIN struct Options options
TreeViewItemContainer TreeViewOrItem
ENUM_OPERATORS(ButPointerType)