 |
Blender V4.3
|
|
Blender V4.3
|
#include <cctype>#include <cstdio>#include <cstdlib>#include <cstring>#include <fmt/format.h>#include "DNA_object_types.h"#include "DNA_screen_types.h"#include "ED_screen.hh"#include "BLI_listbase.h"#include "BLI_string.h"#include "BLI_utildefines.h"#include "BLT_translation.hh"#include "BKE_context.hh"#include "BKE_global.hh"#include "BKE_idprop.hh"#include "BKE_lib_id.hh"#include "BKE_screen.hh"#include "MEM_guardedalloc.h"#include "RNA_access.hh"#include "RNA_prototypes.hh"#include "UI_interface.hh"#include "UI_interface_icons.hh"#include "UI_resources.hh"#include "UI_string_search.hh"#include "UI_view2d.hh"#include "WM_api.hh"#include "WM_types.hh"#include "interface_intern.hh"Go to the source code of this file.
Classes | |
| struct | CollItemSearch |
| struct | uiButStore |
| struct | uiButStoreElem |
Functions | |
| uiBut * | uiDefAutoButR (uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, int index, const char *name, int icon, int x, int y, int width, int height) |
| void | uiDefAutoButsArrayR (uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, const int icon, const int x, const int y, const int tot_width, const int height) |
| eAutoPropButsReturn | uiDefAutoButsRNA (uiLayout *layout, PointerRNA *ptr, bool(*check_prop)(PointerRNA *ptr, PropertyRNA *prop, void *user_data), void *user_data, PropertyRNA *prop_activate_init, const eButLabelAlign label_align, const bool compact) |
| void | UI_but_func_identity_compare_set (uiBut *but, uiButIdentityCompareFunc cmp_fn) |
| static bool | add_collection_search_item (CollItemSearch &cis, const bool requires_exact_data_name, const bool has_id_icon, uiSearchItems *items) |
| void | ui_rna_collection_search_update_fn (const bContext *C, void *arg, const char *str, uiSearchItems *items, const bool is_first) |
| int | UI_icon_from_id (const ID *id) |
| int | UI_icon_from_report_type (int type) |
| int | UI_icon_colorid_from_report_type (int type) |
| int | UI_text_colorid_from_report_type (int type) |
| int | UI_calc_float_precision (int prec, double value) |
| std::optional< std::string > | UI_but_online_manual_id (const uiBut *but) |
| std::optional< std::string > | UI_but_online_manual_id_from_active (const bContext *C) |
| static rctf | ui_but_rect_to_view (const uiBut *but, const ARegion *region, const View2D *v2d) |
| static bool | ui_view2d_cur_ensure_rect_in_view (View2D *v2d, const rctf *rect) |
| void | UI_but_ensure_in_view (const bContext *C, ARegion *region, const uiBut *but) |
Button Store | |
Modal Button Store API. Store for modal operators & handlers to register button pointers which are maintained while drawing or nullptr when removed. This is needed since button pointers are continuously freed and re-allocated. | |
| uiButStore * | UI_butstore_create (uiBlock *block) |
| void | UI_butstore_free (uiBlock *block, uiButStore *bs_handle) |
| bool | UI_butstore_is_valid (uiButStore *bs_handle) |
| bool | UI_butstore_is_registered (uiBlock *block, uiBut *but) |
| void | UI_butstore_register (uiButStore *bs_handle, uiBut **but_p) |
| void | UI_butstore_unregister (uiButStore *bs_handle, uiBut **but_p) |
| bool | UI_butstore_register_update (uiBlock *block, uiBut *but_dst, const uiBut *but_src) |
| void | UI_butstore_clear (uiBlock *block) |
| void | UI_butstore_update (uiBlock *block) |
Key Event from UI | |
| static bool | ui_key_event_property_match (const char *opname, IDProperty *properties, const bool is_strict, wmOperatorType *ui_optype, PointerRNA *ui_opptr) |
| std::optional< std::string > | UI_key_event_operator_string (const bContext *C, const char *opname, IDProperty *properties, const bool is_strict) |
|
static |
Definition at line 378 of file interface_utils.cc.
References BKE_id_full_name_ui_prefix_get(), CollItemSearch::data, CollItemSearch::has_sep_char, CollItemSearch::iconid, CollItemSearch::is_id, CollItemSearch::name, CollItemSearch::name_prefix_offset, UI_BUT_HAS_SEP_CHAR, UI_icon_from_library(), UI_MAX_DRAW_STR, UI_search_item_add(), and UI_SEP_CHAR.
Adjust the view so the rectangle of but is in view, with some extra margin.
It's important that this is only executed after buttons received their final uiBut.rect. E.g. UI_panels_end() modifies them, so if that is executed, this function must not be called before it.
| region | The region the button is placed in. Make sure this is actually the one the button is placed in, not just the context region. |
Definition at line 787 of file interface_utils.cc.
References BLI_rctf_pad(), ED_region_tag_redraw_no_rebuild(), View2D::flag, ui_but_rect_to_view(), UI_UNIT_X, ui_view2d_cur_ensure_rect_in_view(), UI_view2d_curRect_changed(), and V2D_IS_INIT.
Referenced by ui_but_update_view_for_active(), and ui_textedit_begin().
| void UI_but_func_identity_compare_set | ( | uiBut * | but, |
| uiButIdentityCompareFunc | cmp_fn ) |
Callback to compare the identity of two buttons, used to identify buttons over redraws. If the callback returns true, the given buttons are considered to be matching and relevant state is preserved (copied from the old to the new button). If it returns false, it's considered non-matching and no further checks are done.
If this is set, it is always executed instead of the default comparisons. However it is only executed for buttons that have the same type and the same callback. So callbacks can assume the button types match.
Definition at line 361 of file interface_utils.cc.
References cmp_fn(), and uiBut::identity_cmp_func.
Referenced by blender::ed::outliner::outliner_draw_overrides_restrictbuts().
| std::optional< std::string > UI_but_online_manual_id | ( | const uiBut * | but | ) |
Definition at line 702 of file interface_utils.cc.
References PointerRNA::data, wmOperatorType::idname, OP_MAX_TYPENAME, uiBut::optype, RNA_property_identifier(), RNA_struct_identifier(), uiBut::rnapoin, uiBut::rnaprop, PointerRNA::type, and WM_operator_py_idname().
Referenced by UI_but_online_manual_id_from_active(), and ui_popup_context_menu_for_button().
| std::optional< std::string > UI_but_online_manual_id_from_active | ( | const bContext * | C | ) |
Definition at line 717 of file interface_utils.cc.
References UI_but_online_manual_id(), and UI_context_active_but_get().
Referenced by doc_view_manual_ui_context_exec().
|
static |
Definition at line 727 of file interface_utils.cc.
References uiBut::block, uiBut::rect, ui_block_to_region_rctf(), and UI_view2d_region_to_view_rctf().
Referenced by UI_but_ensure_in_view().
| void UI_butstore_clear | ( | uiBlock * | block | ) |
NULL all pointers, don't free since the owner needs to be able to inspect.
Definition at line 916 of file interface_utils.cc.
References uiBut::block, uiBlock::butstore, and LISTBASE_FOREACH.
Referenced by UI_block_free().
| uiButStore * UI_butstore_create | ( | uiBlock * | block | ) |
Create a new button store, the caller must manage and run UI_butstore_free
Definition at line 830 of file interface_utils.cc.
References BLI_addtail(), uiButStore::block, and uiBlock::butstore.
Referenced by ui_but_add_search(), and ui_multibut_states_create().
| void UI_butstore_free | ( | uiBlock * | block, |
| uiButStore * | bs_handle ) |
Definition at line 840 of file interface_utils.cc.
References BLI_assert, BLI_findindex(), BLI_freelistN(), BLI_remlink(), uiButStore::block, uiBlock::butstore, uiButStore::items, and MEM_freeN().
Referenced by ui_multibut_free(), and ui_rna_collection_search_arg_free_fn().
Definition at line 866 of file interface_utils.cc.
References uiBlock::butstore, and LISTBASE_FOREACH.
Referenced by ui_but_free().
| bool UI_butstore_is_valid | ( | uiButStore * | bs_handle | ) |
Definition at line 861 of file interface_utils.cc.
References uiButStore::block.
| void UI_butstore_register | ( | uiButStore * | bs_handle, |
| uiBut ** | but_p ) |
Definition at line 879 of file interface_utils.cc.
References BLI_addtail(), BLI_assert, uiButStoreElem::but_p, and uiButStore::items.
Referenced by ui_but_add_search(), and ui_multibut_add().
Update the pointer for a registered button.
Definition at line 900 of file interface_utils.cc.
References uiBlock::butstore, and LISTBASE_FOREACH.
Referenced by ui_but_update_from_old_block().
| void UI_butstore_unregister | ( | uiButStore * | bs_handle, |
| uiBut ** | but_p ) |
Definition at line 888 of file interface_utils.cc.
References BLI_assert, BLI_remlink(), uiButStore::items, LISTBASE_FOREACH_MUTABLE, and MEM_freeN().
| void UI_butstore_update | ( | uiBlock * | block | ) |
Map freed buttons from the old block and update pointers.
Definition at line 926 of file interface_utils.cc.
References BLI_assert, BLI_movelisttolist(), uiBlock::butstore, ELEM, ListBase::first, LIKELY, LISTBASE_FOREACH, uiBlock::oldblock, and ui_but_find_new().
Referenced by UI_block_update_from_old().
Returns the best "UI" precision for given floating value, so that e.g. 10.000001 rather gets drawn as '10'...
Definition at line 650 of file interface_utils.cc.
References BLI_assert, CLAMP, e, fabs(), int, pow(), and UI_PRECISION_FLOAT_MAX.
Referenced by outputNumInput(), and ui_but_calc_float_precision().
Definition at line 602 of file interface_utils.cc.
References RPT_DEBUG_ALL, RPT_ERROR_ALL, RPT_INFO_ALL, RPT_OPERATOR, RPT_PROPERTY, RPT_WARNING_ALL, TH_INFO_DEBUG, TH_INFO_ERROR, TH_INFO_INFO, TH_INFO_OPERATOR, TH_INFO_PROPERTY, and TH_INFO_WARNING.
Referenced by report_line_data(), and uiTemplateReportsBanner().
Definition at line 556 of file interface_utils.cc.
References Object::data, GS, ID_OB, OB_EMPTY, ptr, RNA_id_pointer_create(), RNA_struct_ui_icon(), Object::type, PointerRNA::type, and UI_icon_from_id().
Referenced by object_mouse_select_menu(), and UI_icon_from_id().
See: BKE_report_type_str
Definition at line 579 of file interface_utils.cc.
References RPT_DEBUG_ALL, RPT_ERROR_ALL, RPT_INFO_ALL, RPT_OPERATOR, RPT_PROPERTY, and RPT_WARNING_ALL.
Referenced by report_line_data(), UI_popup_menu_reports(), and uiTemplateReportsBanner().
| std::optional< std::string > UI_key_event_operator_string | ( | const bContext * | C, |
| const char * | opname, | ||
| IDProperty * | properties, | ||
| bool | is_strict ) |
A version of WM_key_event_operator_string that's limited to UI elements.
This supports showing shortcuts in context-menus (for example), for actions that can also be activated using shortcuts while the cursor is over the button. Without this those shortcuts aren't discoverable for users.
Definition at line 995 of file interface_utils.cc.
References uiBut::block, uiBlock::buttons, CTX_wm_region(), uiListDyn::custom_activate_opptr, uiListDyn::custom_activate_optype, uiBut::custom_data, uiListDyn::custom_drag_opptr, uiListDyn::custom_drag_optype, ED_KEYMAP_UI, KM_CLICK, KM_CLICK_DRAG, KM_NOTHING, LEFTMOUSE, LISTBASE_FOREACH_BACKWARD, uiBut::rect, uiBut::type, UI_BTYPE_LISTBOX, UI_BTYPE_PREVIEW_TILE, ui_but_contains_rect(), ui_key_event_property_match(), UI_region_active_but_get(), and WM_keymap_item_raw_to_string().
Referenced by WM_key_event_operator_string().
|
static |
Follow the logic from wm_keymap_item_find_in_keymap.
Definition at line 971 of file interface_utils.cc.
References PointerRNA::data, wmOperatorType::idname, IDP_EqualsProperties_ex(), and STREQ.
Referenced by UI_key_event_operator_string().
| void ui_rna_collection_search_update_fn | ( | const bContext * | C, |
| void * | arg, | ||
| const char * | str, | ||
| uiSearchItems * | items, | ||
| const bool | is_first ) |
Definition at line 403 of file interface_utils.cc.
References b, BKE_id_full_name_ui_prefix_get(), BLI_assert, BLI_STATIC_ASSERT, ELEM, flag, G, StringPropertySearchVisitParams::icon_id, ID_IS_LINKED, StringPropertySearchVisitParams::info, MAX_ID_FULL_NAME_UI, MEM_freeN(), PROP_ID_SELF_CHECK, PROP_POINTER, PROP_STRING, PROP_STRING_SEARCH_SORT, PROP_STRING_SEARCH_SUPPORTED, RNA_PROP_BEGIN, RNA_PROP_END, RNA_property_flag(), RNA_property_pointer_poll(), RNA_property_string_get_alloc(), RNA_property_string_search(), RNA_property_string_search_flag(), RNA_property_type(), RNA_struct_find_property(), RNA_struct_is_ID(), RNA_struct_name_get_alloc(), str, ui_id_icon_get(), UI_MAX_DRAW_STR, and UI_SEP_CHAR.
Referenced by jump_to_target_button(), template_search_menu(), ui_but_add_search(), and ui_popup_context_menu_for_button().
Definition at line 625 of file interface_utils.cc.
References RPT_DEBUG_ALL, RPT_ERROR_ALL, RPT_INFO_ALL, RPT_OPERATOR, RPT_PROPERTY, RPT_WARNING_ALL, TH_INFO_DEBUG_TEXT, TH_INFO_ERROR_TEXT, TH_INFO_INFO_TEXT, TH_INFO_OPERATOR_TEXT, TH_INFO_PROPERTY_TEXT, and TH_INFO_WARNING_TEXT.
Referenced by report_line_data(), and uiTemplateReportsBanner().
To get a margin (typically wanted), add the margin to rect directly.
Based on file_ensure_inside_viewbounds(), could probably share code.
Definition at line 745 of file interface_utils.cc.
References BLI_assert, BLI_rctf_inside_rctf(), BLI_rctf_size_x(), BLI_rctf_size_y(), View2D::cur, rect_height(), rect_width(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.
Referenced by UI_but_ensure_in_view().
| uiBut * uiDefAutoButR | ( | uiBlock * | block, |
| PointerRNA * | ptr, | ||
| PropertyRNA * | prop, | ||
| int | index, | ||
| const char * | name, | ||
| int | icon, | ||
| int | x, | ||
| int | y, | ||
| int | width, | ||
| int | height ) |
Definition at line 50 of file interface_utils.cc.
References ELEM, IFACE_, PROP_BOOLEAN, PROP_COLLECTION, PROP_COLOR, PROP_COLOR_GAMMA, PROP_ENUM, PROP_FACTOR, PROP_FLOAT, PROP_INT, PROP_PERCENTAGE, PROP_POINTER, PROP_STRING, PROP_TEXTEDIT_UPDATE, ptr, RNA_property_array_check(), RNA_property_collection_length(), RNA_property_flag(), RNA_property_pointer_get(), RNA_property_pointer_type(), RNA_property_subtype(), RNA_property_type(), RNA_struct_ui_icon(), SNPRINTF, PointerRNA::type, UI_BTYPE_CHECKBOX, UI_BTYPE_COLOR, UI_BTYPE_ICON_TOGGLE, UI_BTYPE_LABEL, UI_BTYPE_MENU, UI_BTYPE_NUM, UI_BTYPE_NUM_SLIDER, UI_BTYPE_SEARCH_MENU, UI_BTYPE_TEXT, ui_but_add_search(), UI_BUT_DISABLED, UI_but_flag_enable(), UI_BUT_TEXTEDIT_UPDATE, UI_BUT_VALUE_CLEAR, uiDefBut(), uiDefButR_prop(), uiDefIconButR_prop(), and uiDefIconTextButR_prop().
Referenced by ANIM_channel_draw_widgets(), draw_grease_pencil_layer_widgets(), blender::ed::outliner::outliner_draw_overrides_rna_buts(), blender::ed::outliner::outliner_draw_rnabuts(), template_search_add_button_name(), ui_item_array(), ui_item_with_label(), uiDefAutoButsArrayR(), uiItemFullR(), uiTemplateImage(), and uiTemplateLayers().
| void uiDefAutoButsArrayR | ( | uiBlock * | block, |
| PointerRNA * | ptr, | ||
| PropertyRNA * | prop, | ||
| const int | icon, | ||
| const int | x, | ||
| const int | y, | ||
| const int | tot_width, | ||
| const int | height ) |
Definition at line 261 of file interface_utils.cc.
References len, ptr, RNA_property_array_length(), UI_block_align_begin(), UI_block_align_end(), and uiDefAutoButR().
Referenced by blender::ed::outliner::outliner_draw_overrides_rna_buts().
| eAutoPropButsReturn uiDefAutoButsRNA | ( | uiLayout * | layout, |
| PointerRNA * | ptr, | ||
| bool(* | check_prop )(PointerRNA *ptr, PropertyRNA *prop, void *user_data), | ||
| void * | user_data, | ||
| PropertyRNA * | prop_activate_init, | ||
| eButLabelAlign | label_align, | ||
| bool | compact ) |
check_prop callback filters functions to avoid drawing certain properties, in cases where PROP_HIDDEN flag can't be used for a property.
| prop_activate_init | Property to activate on initial popup (UI_BUT_ACTIVATE_ON_INIT). |
Definition at line 284 of file interface_utils.cc.
References BLI_assert, col, ELEM, flag, PROP_BOOLEAN, PROP_FLOAT, PROP_HIDDEN, PROP_INT, PROP_STRING, ptr, RNA_property_array_check(), RNA_property_flag(), RNA_property_type(), RNA_property_ui_name(), RNA_STRUCT_BEGIN, RNA_STRUCT_END, UI_BUT_LABEL_ALIGN_COLUMN, UI_BUT_LABEL_ALIGN_NONE, UI_BUT_LABEL_ALIGN_SPLIT_COLUMN, UI_ITEM_NONE, UI_ITEM_R_COMPACT, UI_PROP_BUTS_ANY_FAILED_CHECK, UI_PROP_BUTS_NONE_ADDED, uiItemFullR(), uiItemL(), uiLayoutColumn(), uiLayoutSetActivateInit(), and uiLayoutSetPropSep().
Referenced by edbm_average_normals_ui(), edbm_normals_tools_ui(), edbm_point_normals_ui(), image_open_draw(), image_save_as_draw(), screenshot_draw(), sequencer_add_draw(), and template_operator_property_buts_draw_single().