tree_element.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <memory>
#include <optional>
 
#include "BLI_string_ref.hh"
#include "UI_resources.hh"
 
struct ID;
struct ListBase;
struct SpaceOutliner;
 
namespace blender::ed::outliner {
 
class AbstractTreeDisplay;
struct TreeElement;
 
/* -------------------------------------------------------------------- */
/* Tree-Display Interface */
 
class AbstractTreeElement {
 protected:
  TreeElement &legacy_te_;
  AbstractTreeDisplay *display_;
 
  friend class AbstractTreeDisplay;
 
 public:
  virtual ~AbstractTreeElement() = default;
 
  static std::unique_ptr<AbstractTreeElement> create_from_type(int type,
                                                               TreeElement &legacy_te,
                                                               ID *owner_id,
                                                               void *create_data);
 
  virtual bool expand_poll(const SpaceOutliner &) const
  {
    return true;
  }
 
  TreeElement &get_legacy_element()
  {
    return legacy_te_;
  }
 
  virtual StringRefNull get_warning() const;
 
  virtual std::optional<BIFIconID> get_icon() const;
 
  void print_path();
 
  static void uncollapse_by_default(TreeElement *legacy_te);
 
  friend void tree_element_expand(const AbstractTreeElement &tree_element,
                                  SpaceOutliner &space_outliner);
 
 protected:
  /* Pseudo-abstract: Only allow creation through derived types. */
  AbstractTreeElement(TreeElement &legacy_te) : legacy_te_(legacy_te) {}
 
  virtual void expand(SpaceOutliner &) const {}
 
  TreeElement *add_element(ListBase *lb,
                           ID *owner_id,
                           void *create_data,
                           TreeElement *parent,
                           short type,
                           short index,
                           const bool expand = true) const;
};
 
void tree_element_expand(const AbstractTreeElement &tree_element, SpaceOutliner &space_outliner);
 
}  // namespace blender::ed::outliner