5dcf704324
Some code attempted to use `BIFIconID` instead of `int` to pass around icon-ids. Problem is, that this is just a subset of the allowed ids, more icons may be created at runtime and extend the range of valid icon-ids. Such icons could give runtime warning prints. Idea is to use a `using BIFIconID = int;` instead. This way there is still a descriptive type name, while the whole dynamic range of possible icon-ids is supported. Additionally multiple `using BIFIconID = int;` declarations are valid, so we can place these in multiple headers and use the type name in APIs instead of just `int`, whithout having to include a single header defining them. A type mismatch (one instance differs from the others) will result in a compiler error. Pull Request: https://projects.blender.org/blender/blender/pulls/111052
79 lines
2.0 KiB
C++
79 lines
2.0 KiB
C++
/* SPDX-FileCopyrightText: 2021 Blender Foundation
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup edinterface
|
|
*/
|
|
|
|
#include "BLI_vector.hh"
|
|
|
|
#include "BKE_screen.h"
|
|
|
|
#include "RNA_access.hh"
|
|
|
|
#include "ED_screen.hh"
|
|
|
|
#include "UI_interface.hh"
|
|
#include "UI_resources.hh"
|
|
|
|
#include "RNA_prototypes.h"
|
|
|
|
#include "WM_api.hh"
|
|
|
|
namespace blender::ui {
|
|
|
|
void context_path_add_generic(Vector<ContextPathItem> &path,
|
|
StructRNA &rna_type,
|
|
void *ptr,
|
|
const BIFIconID icon_override)
|
|
{
|
|
/* Add the null check here to make calling functions less verbose. */
|
|
if (!ptr) {
|
|
return;
|
|
}
|
|
|
|
PointerRNA rna_ptr;
|
|
RNA_pointer_create(nullptr, &rna_type, ptr, &rna_ptr);
|
|
char name[128];
|
|
RNA_struct_name_get_alloc(&rna_ptr, name, sizeof(name), nullptr);
|
|
|
|
/* Use a blank icon by default to check whether to retrieve it automatically from the type. */
|
|
const BIFIconID icon = icon_override == ICON_NONE ? RNA_struct_ui_icon(rna_ptr.type) :
|
|
icon_override;
|
|
|
|
if (&rna_type == &RNA_NodeTree) {
|
|
ID *id = (ID *)ptr;
|
|
path.append({name, icon, ID_REAL_USERS(id)});
|
|
}
|
|
else {
|
|
path.append({name, icon, 1});
|
|
}
|
|
}
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Breadcrumb Template
|
|
* \{ */
|
|
|
|
void template_breadcrumbs(uiLayout &layout, Span<ContextPathItem> context_path)
|
|
{
|
|
uiLayout *row = uiLayoutRow(&layout, true);
|
|
uiLayoutSetAlignment(&layout, UI_LAYOUT_ALIGN_LEFT);
|
|
|
|
for (const int i : context_path.index_range()) {
|
|
uiLayout *sub_row = uiLayoutRow(row, true);
|
|
uiLayoutSetAlignment(sub_row, UI_LAYOUT_ALIGN_LEFT);
|
|
|
|
if (i > 0) {
|
|
uiItemL(sub_row, "", ICON_RIGHTARROW_THIN);
|
|
}
|
|
uiBut *but = uiItemL_ex(
|
|
sub_row, context_path[i].name.c_str(), context_path[i].icon, false, false);
|
|
UI_but_icon_indicator_number_set(but, context_path[i].icon_indicator_number);
|
|
}
|
|
}
|
|
|
|
/** \} */
|
|
|
|
} // namespace blender::ui
|