Blender V5.3
UI_tree_view.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
11
12#pragma once
13
14#include <functional>
15#include <memory>
16#include <string>
17
18#include "BLI_enum_flags.hh"
19#include "BLI_vector.hh"
20
21#include "UI_abstract_view.hh"
22
23namespace blender {
24
25struct bContext;
26
27namespace ui {
28
32struct Layout;
33
35 None = 0,
38};
39
40/* ---------------------------------------------------------------------- */
45
54class TreeViewItemContainer {
55 friend class AbstractTreeView;
57
58 /* Private constructor, so only the friends above can create this! */
59 TreeViewItemContainer() = default;
60
61 protected:
64 TreeViewItemContainer *root_ = nullptr;
67
72 bool is_flat_ = false;
73
74 public:
75 enum class IterOptions {
76 None = 0,
77 SkipCollapsed = 1 << 0,
78 SkipFiltered = 1 << 1,
79 };
81
95 template<class ItemT, typename... Args> inline ItemT &add_tree_item(Args &&...args);
100 AbstractTreeViewItem &add_tree_item(std::unique_ptr<AbstractTreeViewItem> item);
101
102 protected:
104 void foreach_parent(ItemIterFn iter_fn) const;
105 void sort_alpha();
106 /* Sort tree item list in reverse order. */
108};
109
111
118
120
121/* ---------------------------------------------------------------------- */
124
125class AbstractTreeView : public AbstractView, public TreeViewItemContainer {
126 /* Shared pointer so the pointer can be kept persistent over redraws. The grip button gets a
127 * pointer to modify the value on resizing, and it uses it to identify the button over redraws.
128 */
129 /* TODO support region zoom. */
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);
147 /* `char[UI_MAX_NAME_STR]` wrapped in shared pointer, to keep a stable pointer over
148 * reconstruction that can be passed to buttons. */
149 std::shared_ptr<char[]> search_string_{new char[256 /*UI_MAX_NAME_STR*/]{}};
150
154 std::shared_ptr<char> sort_alpha_ = std::make_shared<char>(0);
158 std::shared_ptr<TreeViewSortOrder> invert_sort_type_ = std::make_shared<TreeViewSortOrder>(
160
162 friend class TreeViewBuilder;
165
166 public:
167 /* virtual */ ~AbstractTreeView() override = default;
168
169 void draw_overlays(const ARegion &region, const Block &block) const override;
170
172 void foreach_root_item(ItemIterFn iter_fn) const;
173
174 bool is_fully_visible() const override;
175 void scroll(ViewScrollDirection direction) override;
176
184 void set_default_rows(int default_rows);
189 void scroll_active_into_view(bContext *C, bool scroll_active_to_center = false) override;
190
191 protected:
192 virtual void build_tree() = 0;
193
194 std::optional<uiViewState> persistent_state() const override;
195 void persistent_state_apply(const uiViewState &state) override;
196
197 private:
198 void foreach_view_item(FunctionRef<void(AbstractViewItem &)> iter_fn) const final;
199 void update_children_from_old(const AbstractView &old_view) override;
200 static void update_children_from_old_recursive(const TreeViewOrItem &new_items,
201 const TreeViewOrItem &old_items);
202 static AbstractTreeViewItem *find_matching_child(
203 const AbstractTreeViewItem &lookup_item, const Span<AbstractTreeViewItem *> possible_items);
204 std::optional<int> tot_visible_row_count() const;
205
206 bool supports_scrolling() const override;
207
208 void draw_hierarchy_lines(const ARegion &region, const Block &block) const;
209 void get_hierarchy_lines(const TreeViewOrItem &parent,
210 const float aspect,
211 Vector<std::pair<int2, int2>> &lines,
212 int &visible_item_index) const;
213
214 int count_visible_descendants(const AbstractTreeViewItem &parent) const;
215 void sort_inverted();
216 AbstractViewItem *find_active_or_visible_item() const override;
217 AbstractViewItem *navigate_left(AbstractViewItem *from) override;
218 AbstractViewItem *navigate_right(AbstractViewItem *from) override;
219 AbstractViewItem *navigate_up(AbstractViewItem *from) override;
220 AbstractViewItem *navigate_down(AbstractViewItem *from) override;
221
222 void page_scroll(bContext *C, PageScrollDirection direction) override;
223};
224
226
227/* ---------------------------------------------------------------------- */
230
238class AbstractTreeViewItem : public AbstractViewItem, public TreeViewItemContainer {
239 friend class AbstractTreeView;
241 /* Higher-level API. */
243
244 private:
245 bool is_open_ = false;
246
247 protected:
249 std::string label_;
250
251 public:
253 /* virtual */ ~AbstractTreeViewItem() override = default;
254
255 virtual void build_row(Layout &row) = 0;
256
257 /* virtual */ std::optional<std::string> debug_name() const override;
258
259 std::unique_ptr<DropTargetInterface> create_item_drop_target() final;
260 virtual std::unique_ptr<TreeViewItemDropTarget> create_drop_target();
261
267 std::optional<rctf> get_win_rect(const ARegion &region) const;
268
270
277 bool toggle_collapsed();
284 virtual bool set_collapsed(bool collapsed);
291 virtual void on_collapse_change(bContext &C, bool is_collapsed);
296 virtual std::optional<bool> should_be_collapsed() const;
297
305
310 bool is_collapsed() const;
311 bool is_collapsible() const;
312
313 int count_parents() const;
315 /* Return first child view item. */
317
318 void on_filter() override;
319 StringRefNull label() const;
320
321 protected:
323 /* virtual */ StringRef get_rename_string() const override;
325 /* virtual */ bool rename(const bContext &C, StringRefNull new_name) override;
326
331 virtual bool supports_collapsing() const;
332
337
338 void change_state_delayed() override;
339
341 /* virtual */ bool matches(const AbstractViewItem &other) const override;
342
344 /* virtual */ void update_from_old(const AbstractViewItem &old) override;
345
346 bool should_be_filtered_visible(StringRefNull filter_string) const override;
357 virtual bool matches_single(const AbstractTreeViewItem &other) const;
358
360
361 private:
362 static void collapse_chevron_click_fn(bContext *, void *but_arg1, void *);
363
368 bool set_state_active() final;
369
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);
375
376 bool has_active_child() const;
377};
378
380
381/* ---------------------------------------------------------------------- */
386
391 public:
392 using IsActiveFn = std::function<bool()>;
393 using ActivateFn = std::function<void(bContext &C, BasicTreeViewItem &new_active)>;
395
396 explicit BasicTreeViewItem(StringRef label, BIFIconID icon = ICON_NONE);
397
398 void build_row(Layout &row) override;
399 void add_label(Layout &layout, StringRefNull label_override = "");
404 void set_is_active_fn(IsActiveFn is_active_fn);
405
406 protected:
412
414
415 private:
416 std::optional<bool> should_be_active() const override;
417 void on_activate(bContext &C) override;
418};
419
421
422/* ---------------------------------------------------------------------- */
425
436 protected:
439
440 public:
443
444 std::optional<DropLocation> choose_drop_location(const ARegion &region,
445 const wmEvent &event) const override;
446
449 template<class ViewType> inline ViewType &get_view() const;
450};
451
453
454/* ---------------------------------------------------------------------- */
457
459 public:
460 static void build_tree_view(const bContext &C,
461 AbstractTreeView &tree_view,
462 Layout &layout,
463 bool add_box = true);
464
465 private:
466 static void ensure_min_rows_items(AbstractTreeView &tree_view);
467};
468
470
471/* ---------------------------------------------------------------------- */
472
473template<class ItemT, typename... Args>
474inline ItemT &TreeViewItemContainer::add_tree_item(Args &&...args)
475{
476 static_assert(std::is_base_of_v<AbstractTreeViewItem, ItemT>,
477 "Type must derive from and implement the AbstractTreeViewItem interface");
478
479 return dynamic_cast<ItemT &>(
480 add_tree_item(std::make_unique<ItemT>(std::forward<Args>(args)...)));
481}
482
483template<class ViewType> ViewType &TreeViewItemDropTarget::get_view() const
484{
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());
488}
489
490} // namespace ui
491} // namespace blender
#define final(a, b, c)
Definition BLI_hash_c.hh:21
#define C
Definition RandGen.cpp:29
Abstract base class for defining a customizable tree-view item.
std::optional< rctf > get_win_rect(const ARegion &region) const
Definition tree_view.cc:780
void update_from_old(const AbstractViewItem &old) override
Definition tree_view.cc:741
AbstractTreeViewItem * get_child()
Definition tree_view.cc:807
AbstractTreeView & get_tree_view() const
Definition tree_view.cc:775
std::unique_ptr< DropTargetInterface > create_item_drop_target() final
Definition tree_view.cc:760
StringRef get_rename_string() const override
Definition tree_view.cc:728
bool matches(const AbstractViewItem &other) const override
Definition tree_view.cc:916
void toggle_collapsed_from_view(bContext &C)
Definition tree_view.cc:840
virtual void build_row(Layout &row)=0
virtual std::unique_ptr< TreeViewItemDropTarget > create_drop_target()
Definition tree_view.cc:765
virtual void on_collapse_change(bContext &C, bool is_collapsed)
Definition tree_view.cc:860
~AbstractTreeViewItem() override=default
virtual std::optional< bool > should_be_collapsed() const
Definition tree_view.cc:865
AbstractTreeViewItem * get_parent()
Definition tree_view.cc:802
virtual bool set_collapsed(bool collapsed)
Definition tree_view.cc:847
virtual bool matches_single(const AbstractTreeViewItem &other) const
Definition tree_view.cc:755
bool should_be_filtered_visible(StringRefNull filter_string) const override
Definition tree_view.cc:749
std::optional< std::string > debug_name() const override
Definition tree_view.cc:770
virtual bool supports_collapsing() const
Definition tree_view.cc:723
bool rename(const bContext &C, StringRefNull new_name) override
Definition tree_view.cc:733
StringRefNull label() const
Definition tree_view.cc:951
void scroll(ViewScrollDirection direction) override
Definition tree_view.cc:508
void foreach_root_item(ItemIterFn iter_fn) const
Definition tree_view.cc:132
bool is_fully_visible() const override
Definition tree_view.cc:503
void scroll_active_into_view(bContext *C, bool scroll_active_to_center=false) override
Definition tree_view.cc:517
void persistent_state_apply(const uiViewState &state) override
Definition tree_view.cc:265
void draw_overlays(const ARegion &region, const Block &block) const override
Definition tree_view.cc:430
~AbstractTreeView() override=default
TreeViewSortOrder invert_sort_type_get() const
Definition tree_view.cc:370
void foreach_item(ItemIterFn iter_fn, IterOptions options=IterOptions::None) const
Definition tree_view.cc:127
std::optional< uiViewState > persistent_state() const override
Definition tree_view.cc:242
void set_default_rows(int default_rows)
Definition tree_view.cc:234
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
static void build_tree_view(const bContext &C, AbstractTreeView &tree_view, Layout &layout, bool add_box=true)
ItemT & add_tree_item(Args &&...args)
AbstractTreeViewItem * parent_
TreeViewItemContainer * root_
void foreach_item_recursive(ItemIterFn iter_fn, IterOptions options=IterOptions::None) const
Definition tree_view.cc:67
void foreach_sort_invert(TreeViewSortOrder order)
Definition tree_view.cc:109
Vector< std::unique_ptr< AbstractTreeViewItem > > children_
void foreach_parent(ItemIterFn iter_fn) const
Definition tree_view.cc:87
FunctionRef< void(AbstractTreeViewItem &)> ItemIterFn
AbstractTreeViewItem & view_item_
TreeViewItemDropTarget(AbstractTreeViewItem &view_item, DropBehavior behavior=DropBehavior::Insert)
Definition tree_view.cc:557
std::optional< DropLocation > choose_drop_location(const ARegion &region, const wmEvent &event) const override
Definition tree_view.cc:563
CCL_NAMESPACE_BEGIN struct Options options
const int state
TreeViewItemContainer TreeViewOrItem
ENUM_OPERATORS(ButPointerType)
BMesh Iterators.
unsigned char uint8_t
Definition BKE_text.h:79
int BIFIconID
Definition ED_asset.hh:30