Refactor: Port spreadsheet data set to UI tree view

This patch removes a bunch of specific code for drawing the spreadsheet
data set region, which was an overly specific solution for a generic UI.
Nowadays, the UI tree view API used for asset browser catalogs is a much
better way to implement this behavior.

To make this possible, the tree view API is extended in a few ways.
Collapsibility can now be turned off, and whether an item should
be active is moved to a separate virtual function.

The only visual change is that the items are now drawn in a box,
just like the asset catalog.

Differential Revision: https://developer.blender.org/D13198

1 files changed, 20 insertions, 10 deletions

diff --git a/source/blender/editors/include/UI_tree_view.hh b/source/blender/editors/include/UI_tree_view.hh
index 0d18eedeac9..8caf17741a7 100644
--- a/source/blender/editors/include/UI_tree_view.hh
+++ b/source/blender/editors/include/UI_tree_view.hh
@@ -217,15 +217,11 @@ class AbstractTreeViewItem : public TreeViewItemContainer {
   friend class TreeViewLayoutBuilder;
 
  public:
-  using IsActiveFn = std::function<bool()>;
-
  private:
   bool is_open_ = false;
   bool is_active_ = false;
   bool is_renaming_ = false;
 
-  IsActiveFn is_active_fn_;
-
  protected:
   /** This label is used for identifying an item (together with its parent's labels). */
   std::string label_{};
@@ -239,11 +235,6 @@ class AbstractTreeViewItem : public TreeViewItemContainer {
   virtual void build_context_menu(bContext &C, uiLayout &column) const;
 
   virtual void on_activate();
-  /**
-   * Set a custom callback to check if this item should be active. There's a version without
-   * arguments for checking if the item is currently in an active state.
-   */
-  virtual void is_active(IsActiveFn is_active_fn);
 
   /**
    * Queries if the tree-view item supports renaming in principle. Renaming may still fail, e.g. if
@@ -329,6 +320,17 @@ class AbstractTreeViewItem : public TreeViewItemContainer {
    */
   void activate();
 
+  /**
+   * If the result is not empty, it controls whether the item should be active or not,
+   * usually depending on the data that the view represents.
+   */
+  virtual std::optional<bool> should_be_active() const;
+
+  /**
+   * Return whether the item can be collapsed. Used to disable collapsing for items with children.
+   */
+  virtual bool supports_collapsing() const;
+
  private:
   static void rename_button_fn(bContext *, void *, char *);
   static AbstractTreeViewItem *find_tree_item_from_rename_button(const uiBut &but);
@@ -416,6 +418,7 @@ class AbstractTreeViewItemDropController {
  */
 class BasicTreeViewItem : public AbstractTreeViewItem {
  public:
+  using IsActiveFn = std::function<bool()>;
   using ActivateFn = std::function<void(BasicTreeViewItem &new_active)>;
   BIFIconID icon;
 
@@ -423,7 +426,11 @@ class BasicTreeViewItem : public AbstractTreeViewItem {
 
   void build_row(uiLayout &row) override;
   void add_label(uiLayout &layout, StringRefNull label_override = "");
-  void on_activate(ActivateFn fn);
+  void set_on_activate_fn(ActivateFn fn);
+  /**
+   * Set a custom callback to check if this item should be active.
+   */
+  void set_is_active_fn(IsActiveFn fn);
 
  protected:
   /**
@@ -433,9 +440,12 @@ class BasicTreeViewItem : public AbstractTreeViewItem {
    */
   ActivateFn activate_fn_;
 
+  IsActiveFn is_active_fn_;
+
  private:
   static void tree_row_click_fn(struct bContext *C, void *arg1, void *arg2);
 
+  std::optional<bool> should_be_active() const override;
   void on_activate() override;
 };