Blender V5.3
UI_abstract_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
19
20#pragma once
21
22#include <array>
23#include <memory>
24#include <optional>
25#include <string>
26
27#include "DNA_defs.h"
28#include "DNA_vec_types.h"
29
30#include "BLI_span.hh"
31#include "BLI_string_ref.hh"
32
33#include "UI_interface.hh"
35
36#include "WM_types.hh"
37
38namespace blender {
39
40struct bContext;
41struct wmNotifier;
42
43namespace ui {
44
45struct ViewLink;
46struct ButtonViewItem;
49
53};
54
56 Up,
58 Top,
59 Bottom,
60};
61
62struct Layout;
63
65 friend class AbstractViewItem;
66 friend struct ViewLink;
67
68 bool is_reconstructed_ = false;
76 std::unique_ptr<std::array<char, MAX_NAME>> rename_buffer_;
77 /* Search/filter string from the previous redraw, stored to detect changes. */
78 std::string prev_filter_string_;
79
80 bool needs_filtering_ = true;
81
82 /* See #get_bounds(). */
83 std::optional<rcti> bounds_;
84
85 std::string context_menu_title;
87 bool popup_keep_open_ = false;
88 bool is_multiselect_supported_ = false;
89
90 public:
91 virtual ~AbstractView() = default;
99 virtual std::unique_ptr<DropTargetInterface> create_drop_target();
100
102 virtual bool listen(const wmNotifier &) const;
103
109 virtual bool begin_filtering(const bContext &C) const;
110
111 virtual void draw_overlays(const ARegion &region, const Block &block) const;
112
113 virtual void foreach_view_item(FunctionRef<void(AbstractViewItem &)> iter_fn) const = 0;
114
115 virtual bool supports_scrolling() const;
116
120 virtual bool is_fully_visible() const;
121
122 virtual void scroll(ViewScrollDirection direction);
123
131 virtual std::optional<uiViewState> persistent_state() const;
136 virtual void persistent_state_apply(const uiViewState &state);
137
143
145 bool is_renaming() const;
147 bool begin_renaming();
148 void end_renaming();
155 std::optional<rcti> get_bounds() const;
156
157 std::string get_context_menu_title() const;
158 void set_context_menu_title(const std::string &title);
159
160 bool get_popup_keep_open() const;
162 void set_popup_keep_open();
163
166 bool is_multiselect_supported() const;
172
173 virtual void scroll_active_into_view(bContext *C, bool scroll_active_to_center = false) = 0;
174
175 virtual void page_scroll(bContext *C, PageScrollDirection direction) = 0;
176
177 protected:
178 AbstractView() = default;
179
187 virtual void change_state_delayed();
188
189 virtual void update_children_from_old(const AbstractView &old_view) = 0;
190
197 void update_from_old(Block &new_block);
202 bool is_reconstructed() const;
203
204 void filter(std::optional<StringRef> filter_str);
206};
207
209 friend class AbstractView;
210 friend class ViewItemAPIWrapper;
211
212 protected:
217 AbstractView *view_ = nullptr;
220 bool is_activatable_ = true;
221 bool is_interactive_ = true;
223 bool is_hovered_ = false;
224 bool is_active_ = false;
226 bool is_selected_ = false;
227 bool is_renaming_ = false;
230
233
241 bool select_on_click_ = false;
246
247 public:
248 virtual ~AbstractViewItem() = default;
249
250 virtual void build_context_menu(bContext &C, Layout &column) const;
251
263 virtual bool set_state_active();
270 virtual void on_activate(bContext &C);
276 virtual std::optional<bool> should_be_active() const;
277
278 virtual std::optional<bool> should_be_selected() const;
279 virtual void set_selected(const bool select);
284 virtual bool supports_renaming() const;
292 virtual bool rename(const bContext &C, StringRefNull new_name);
297 virtual StringRef get_rename_string() const;
298
303 virtual std::unique_ptr<AbstractViewItemDragController> create_drag_controller() const;
311 virtual std::unique_ptr<DropTargetInterface> create_item_drop_target();
312
318 virtual std::optional<std::string> debug_name() const;
319
320 bool is_filtered_visible() const;
321
323 AbstractView &get_view() const;
324
331
334 void disable_interaction();
335 bool is_interactive() const;
336
337 void disable_activatable();
343 void select_on_click_set();
344 bool is_select_on_click() const;
361 void activate(bContext &C);
369 void deactivate();
375 bool is_hovered() const;
380 bool is_active() const;
381 bool is_selected() const;
386 bool is_search_highlight() const;
387
388 bool is_renaming() const;
389 void begin_renaming();
390 void end_renaming();
391 void rename_apply(const bContext &C);
392
393 virtual void delete_item(bContext *C);
394 virtual void on_filter();
395
396 protected:
397 AbstractViewItem() = default;
398
406 virtual bool matches(const AbstractViewItem &other) const = 0;
407
415 virtual void update_from_old(const AbstractViewItem &old);
416
421 virtual void change_state_delayed();
422
427 virtual bool should_be_filtered_visible(StringRefNull filter_string) const;
428
434 void add_rename_button(Block &block);
435};
436
437/* ---------------------------------------------------------------------- */
440
446 protected:
448
449 public:
452
453 virtual std::optional<eWM_DragDataType> get_drag_type() const = 0;
454 virtual void *create_drag_data() const = 0;
461 virtual void on_drag_start(bContext &C, ui::AbstractViewItem &item);
462
465 template<class ViewType> inline ViewType &get_view() const;
466};
467
468template<class ViewType> ViewType &AbstractViewItemDragController::get_view() const
469{
470 static_assert(std::is_base_of_v<AbstractView, ViewType>,
471 "Type must derive from and implement the ui::AbstractView interface");
472 return dynamic_cast<ViewType &>(view_);
473}
474
476
477} // namespace ui
478} // namespace blender
#define C
Definition RandGen.cpp:29
virtual void on_drag_start(bContext &C, ui::AbstractViewItem &item)
virtual std::optional< eWM_DragDataType > get_drag_type() const =0
virtual void * create_drag_data() const =0
virtual void delete_item(bContext *C)
virtual void set_selected(const bool select)
virtual void update_from_old(const AbstractViewItem &old)
virtual bool should_be_filtered_visible(StringRefNull filter_string) const
virtual void on_activate(bContext &C)
virtual std::unique_ptr< DropTargetInterface > create_item_drop_target()
virtual bool supports_renaming() const
virtual ~AbstractViewItem()=default
virtual std::optional< bool > should_be_active() const
virtual bool rename(const bContext &C, StringRefNull new_name)
virtual bool matches(const AbstractViewItem &other) const =0
ui::ButtonViewItem * view_item_button() const
ui::ButtonViewItem * view_item_but_
virtual std::optional< bool > should_be_selected() const
virtual StringRef get_rename_string() const
void rename_apply(const bContext &C)
void activate_for_context_menu(bContext &C)
virtual std::unique_ptr< AbstractViewItemDragController > create_drag_controller() const
virtual std::optional< std::string > debug_name() const
virtual void build_context_menu(bContext &C, Layout &column) const
virtual bool supports_scrolling() const
virtual AbstractViewItem * navigate_left(AbstractViewItem *from)=0
virtual bool is_fully_visible() const
const AbstractViewItem * search_highlight_item() const
virtual void persistent_state_apply(const uiViewState &state)
bool is_multiselect_supported() const
virtual bool listen(const wmNotifier &) const
std::optional< rcti > get_bounds() const
virtual void change_state_delayed()
virtual std::unique_ptr< DropTargetInterface > create_drop_target()
virtual void foreach_view_item(FunctionRef< void(AbstractViewItem &)> iter_fn) const =0
virtual void page_scroll(bContext *C, PageScrollDirection direction)=0
virtual void scroll_active_into_view(bContext *C, bool scroll_active_to_center=false)=0
virtual bool begin_filtering(const bContext &C) const
virtual void scroll(ViewScrollDirection direction)
virtual void update_children_from_old(const AbstractView &old_view)=0
void register_item(AbstractViewItem &item)
virtual ~AbstractView()=default
Span< char > get_rename_buffer() const
virtual AbstractViewItem * navigate_down(AbstractViewItem *from)=0
virtual AbstractViewItem * navigate_right(AbstractViewItem *from)=0
virtual void draw_overlays(const ARegion &region, const Block &block) const
virtual std::optional< uiViewState > persistent_state() const
void update_from_old(Block &new_block)
virtual AbstractViewItem * navigate_up(AbstractViewItem *from)=0
virtual AbstractViewItem * find_active_or_visible_item() const =0
std::string get_context_menu_title() const
void filter(std::optional< StringRef > filter_str)
void set_context_menu_title(const std::string &title)
const int state
BMesh Iterators.