Blender V5.3
UI_interface.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
8
9#pragma once
10
11#include <functional>
12#include <memory>
13
14#include "BLI_function_ref.hh"
15#include "BLI_string_ref.hh"
16#include "BLI_vector.hh"
17
18#include "UI_resources.hh"
19
20#include "UI_interface_c.hh" // IWYU pragma: export
21
22namespace blender {
23
24namespace nodes::eval_log {
26}
27
28struct ARegion;
29struct bContext;
30struct PointerRNA;
31struct StructRNA;
32struct uiList;
33struct wmDrag;
34struct wmEvent;
35
36namespace ui {
37class AbstractView;
39struct Layout;
40struct SearchItems;
41
42void button_func_set(Button *but, std::function<void(bContext &)> func);
43void button_func_pushed_state_set(Button *but, std::function<bool(const Button &)> func);
44
49template<typename T> void but_func_argN_free(void *argN)
50{
51 MEM_delete(static_cast<T *>(argN));
52}
53
58template<typename T> void *but_func_argN_copy(const void *argN)
59{
60 return MEM_new<T>(__func__, *static_cast<const T *>(argN));
61}
62
63class AbstractGridView;
64class AbstractTreeView;
65class DropTargetInterface;
66
72 /* Text to display in the UI. */
73 std::string name;
74 /* #BIFIconID */
75 int icon;
77
78 std::function<void(bContext &)> handle_func;
79 /* Optional drop-down menu opened by the arrow button. */
81 void *menu_arg;
82};
83
85 StructRNA &rna_type,
86 void *ptr,
87 const BIFIconID icon_override = ICON_NONE,
88 std::function<void(bContext &)> handle_func = nullptr,
89 MenuCreateFunc menu_func = nullptr,
90 void *menu_arg = nullptr);
91
92void template_breadcrumbs(Layout &layout, Span<ContextPathItem> context_path);
93
95 bool can_create_attribute,
97 SearchItems *items,
98 bool is_first);
100 Span<const std::string *> layer_names,
101 SearchItems &items,
102 bool is_first);
103
104bool asset_shelf_popover_invoke(bContext &C, StringRef asset_shelf_idname, ReportList &reports);
124
134
145
160 public:
162 virtual ~DropTargetInterface() = default;
163
172 virtual bool can_drop(const wmDrag &drag, const char **r_disabled_hint) const = 0;
173
184 virtual std::optional<DropLocation> choose_drop_location(const ARegion &region,
185 const wmEvent &event) const;
192 virtual std::string drop_tooltip(const DragInfo &drag) const = 0;
197 virtual bool on_drop(bContext *C, const DragInfo &drag) const = 0;
198};
199
205 const ARegion &region,
206 const wmEvent &event,
207 const DropTargetInterface &drop_target,
208 const ListBaseT<wmDrag> &drags);
213std::string drop_target_tooltip(const ARegion &region,
214 const DropTargetInterface &drop_target,
215 const wmDrag &drag,
216 const wmEvent &event);
217
223std::unique_ptr<DropTargetInterface> region_views_find_drop_target_at(const ARegion *region,
224 const int xy[2]);
225
234
241 /* Storage with an inline buffer for smaller strings (small buffer optimization). */
242 struct {
243 char filter_buff[32];
244 char *filter_dyn = nullptr;
245 } storage_;
246 char *filter_ = nullptr;
247
248 public:
251
253};
254
257using uiListItemGetNameFn = FunctionRef<std::string(const PointerRNA &itemptr, int index)>;
258
275 const bContext *C,
276 uiListItemFilterFn item_filter_fn,
277 PointerRNA *dataptr,
278 const char *propname,
279 uiListItemGetNameFn get_name_fn = nullptr);
280
287 StringRef idname,
288 std::unique_ptr<AbstractGridView> grid_view);
290 StringRef idname,
291 std::unique_ptr<AbstractTreeView> tree_view);
292
293void alert(bContext *C, StringRef title, StringRef message, AlertIcon icon, bool compact);
294
295} // namespace ui
296} // namespace blender
#define C
Definition RandGen.cpp:29
virtual bool on_drop(bContext *C, const DragInfo &drag) const =0
virtual bool can_drop(const wmDrag &drag, const char **r_disabled_hint) const =0
virtual ~DropTargetInterface()=default
virtual std::string drop_tooltip(const DragInfo &drag) const =0
virtual std::optional< DropLocation > choose_drop_location(const ARegion &region, const wmEvent &event) const
eUIListFilterResult operator()(const PointerRNA &itemptr, StringRefNull name, int index)
#define str(s)
#define T
void(*)(bContext *C, Layout *layout, void *arg1) MenuCreateFunc
void attribute_search_add_items(StringRef str, bool can_create_attribute, Span< const nodes::eval_log::GeometryAttributeInfo * > infos, SearchItems *items, bool is_first)
AbstractGridView * block_add_view(Block &block, StringRef idname, std::unique_ptr< AbstractGridView > grid_view)
void button_func_set(Button *but, std::function< void(bContext &)> func)
bool drop_target_apply_drop(bContext &C, const ARegion &region, const wmEvent &event, const DropTargetInterface &drop_target, const ListBaseT< wmDrag > &drags)
void button_func_pushed_state_set(Button *but, std::function< bool(const Button &)> func)
void alert(bContext *C, StringRef title, StringRef message, AlertIcon icon, bool compact)
std::string drop_target_tooltip(const ARegion &region, const DropTargetInterface &drop_target, const wmDrag &drag, const wmEvent &event)
@ UI_LIST_ITEM_FILTER_MISMATCHES
@ UI_LIST_ITEM_FILTER_MATCHES
void * but_func_argN_copy(const void *argN)
void but_func_argN_free(void *argN)
std::unique_ptr< DropTargetInterface > region_views_find_drop_target_at(const ARegion *region, const int xy[2])
FunctionRef< eUIListFilterResult(const PointerRNA &itemptr, StringRefNull name, int index)> uiListItemFilterFn
void grease_pencil_layer_search_add_items(StringRef str, Span< const std::string * > layer_names, SearchItems &items, bool is_first)
void context_path_add_generic(Vector< ContextPathItem > &path, StructRNA &rna_type, void *ptr, const BIFIconID icon_override=ICON_NONE, std::function< void(bContext &)> handle_func=nullptr, MenuCreateFunc menu_func=nullptr, void *menu_arg=nullptr)
void template_breadcrumbs(Layout &layout, Span< ContextPathItem > context_path)
void uilist_filter_and_sort_items(uiList *ui_list, const bContext *C, uiListItemFilterFn item_filter_fn, PointerRNA *dataptr, const char *propname, uiListItemGetNameFn get_name_fn=nullptr)
bool asset_shelf_popover_invoke(bContext &C, StringRef asset_shelf_idname, ReportList &reports)
FunctionRef< std::string(const PointerRNA &itemptr, int index)> uiListItemGetNameFn
BMesh Iterators.
int BIFIconID
Definition ED_asset.hh:30
std::function< void(bContext &)> handle_func
DragInfo(const wmDrag &drag, const wmEvent &event, DropLocation drop_location)
const wmDrag & drag_data
const DropLocation drop_location
const wmEvent & event