interface_region_tooltip.cc File Reference

#include <algorithm>
#include <cstdarg>
#include <cstdlib>
#include <cstring>
#include <memory>
#include <fmt/format.h>
#include "AS_essentials_library.hh"
#include "MEM_guardedalloc.h"
#include "DNA_userdef_types.h"
#include "BLI_fileops.h"
#include "BLI_listbase.h"
#include "BLI_math_color.h"
#include "BLI_math_vector.h"
#include "BLI_path_utils.hh"
#include "BLI_rect.h"
#include "BLI_string_utf8.h"
#include "BLI_utildefines.h"
#include "BKE_context.hh"
#include "BKE_idtype.hh"
#include "BKE_image.hh"
#include "BKE_library.hh"
#include "BKE_main.hh"
#include "BKE_paint.hh"
#include "BKE_path_templates.hh"
#include "BKE_screen.hh"
#include "BKE_vfont.hh"
#include "BIF_glutil.hh"
#include "DNA_vfont_types.h"
#include "GPU_immediate.hh"
#include "GPU_immediate_util.hh"
#include "GPU_state.hh"
#include "IMB_colormanagement.hh"
#include "IMB_imbuf.hh"
#include "IMB_imbuf_types.hh"
#include "IMB_thumbs.hh"
#include "MOV_read.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "RNA_access.hh"
#include "RNA_path.hh"
#include "RNA_prototypes.hh"
#include "BLF_api.hh"
#include "BLT_translation.hh"
#include "ED_screen.hh"
#include "interface_intern.hh"
#include "interface_regions_intern.hh"

Go to the source code of this file.

Classes
struct	uiTooltipFormat
struct	uiTooltipField
struct	uiTooltipData

Macros
#define	UI_TIP_SPACER   0.3f
#define	UI_TIP_PADDING_X   1.95f
#define	UI_TIP_PADDING_Y   1.28f
#define	UI_TIP_MAXWIDTH   600

Functions
	BLI_STATIC_ASSERT (int(UI_TIP_LC_MAX)==int(UI_TIP_LC_ALERT)+1, "invalid lc-max")
void	UI_tooltip_text_field_add (uiTooltipData &data, std::string text, std::string suffix, const uiTooltipStyle style, const uiTooltipColorID color_id, const bool is_pad)
void	UI_tooltip_image_field_add (uiTooltipData &data, const uiTooltipImage &image_data)
ToolTip Callbacks (Draw & Free)
static void	color_blend_f3_f3 (float dest[3], const float source[3], const float fac)
static void	ui_tooltip_region_draw_cb (const bContext *, ARegion *region)
static void	ui_tooltip_region_free_cb (ARegion *region)
ToolTip Creation Utility Functions
static std::string	ui_tooltip_text_python_from_op (bContext *C, wmOperatorType *ot, PointerRNA *opptr)
ToolTip Creation
static bool	ui_tooltip_period_needed (blender::StringRef tip)
static std::unique_ptr< uiTooltipData >	ui_tooltip_data_from_tool (bContext *C, uiBut *but, bool is_quick_tip)
static std::string	ui_tooltip_color_string (const blender::float4 &color, const blender::StringRefNull title, const int max_title_len, const bool show_alpha, const bool show_hex=false)
void	UI_tooltip_color_field_add (uiTooltipData &data, const blender::float4 &original_color, const bool has_alpha, const bool is_gamma, const ColorManagedDisplay *display, const uiTooltipColorID color_id)
void	UI_tooltip_uibut_python_add (uiTooltipData &data, bContext &C, uiBut &but, uiButExtraOpIcon *extra_icon)
static std::unique_ptr< uiTooltipData >	ui_tooltip_data_from_button_or_extra_icon (bContext *C, uiBut *but, uiButExtraOpIcon *extra_icon, const bool is_quick_tip)
static std::unique_ptr< uiTooltipData >	ui_tooltip_data_from_gizmo (bContext *C, wmGizmo *gz)
static std::unique_ptr< uiTooltipData >	ui_tooltip_data_from_custom_func (bContext *C, uiBut *but)
static ARegion *	ui_tooltip_create_with_data (bContext *C, std::unique_ptr< uiTooltipData > data_uptr, const float init_position[2], const rcti *init_rect_overlap)
ToolTip Public API
ARegion *	UI_tooltip_create_from_button_or_extra_icon (bContext *C, ARegion *butregion, uiBut *but, uiButExtraOpIcon *extra_icon, bool is_quick_tip)
ARegion *	UI_tooltip_create_from_button (bContext *C, ARegion *butregion, uiBut *but, bool is_quick_tip)
ARegion *	UI_tooltip_create_from_gizmo (bContext *C, wmGizmo *gz)
static void	ui_tooltip_from_image (Image &ima, uiTooltipData &data)
static void	ui_tooltip_from_clip (MovieClip &clip, uiTooltipData &data)
static void	ui_tooltip_from_vfont (const VFont &font, uiTooltipData &data)
static std::unique_ptr< uiTooltipData >	ui_tooltip_data_from_search_item_tooltip_data (ID *id)
ARegion *	UI_tooltip_create_from_search_item_generic (bContext *C, const ARegion *searchbox_region, const rcti *item_rect, ID *id)
void	UI_tooltip_free (bContext *C, bScreen *screen, ARegion *region)

Detailed Description

ToolTip Region and Construction

Definition in file interface_region_tooltip.cc.

Macro Definition Documentation

UI_TIP_MAXWIDTH

#define UI_TIP_MAXWIDTH   600

Definition at line 92 of file interface_region_tooltip.cc.

Referenced by ui_tooltip_create_with_data().

UI_TIP_PADDING_X

#define UI_TIP_PADDING_X   1.95f

Definition at line 89 of file interface_region_tooltip.cc.

Referenced by ui_tooltip_create_with_data(), and ui_tooltip_region_draw_cb().

UI_TIP_PADDING_Y

#define UI_TIP_PADDING_Y   1.28f

Definition at line 90 of file interface_region_tooltip.cc.

Referenced by ui_tooltip_create_with_data(), and ui_tooltip_region_draw_cb().

UI_TIP_SPACER

#define UI_TIP_SPACER   0.3f

Definition at line 88 of file interface_region_tooltip.cc.

Referenced by ui_tooltip_create_with_data(), and ui_tooltip_region_draw_cb().

Function Documentation

BLI_STATIC_ASSERT()

BLI_STATIC_ASSERT	(	int(UI_TIP_LC_MAX)	= =int(UI_TIP_LC_ALERT)+1,
		"invalid lc-max"	)

References UI_TIP_LC_ALERT, and UI_TIP_LC_MAX.

color_blend_f3_f3()

void color_blend_f3_f3 ( float dest[3], const float source[3], const float fac )

static

Definition at line 155 of file interface_region_tooltip.cc.

Referenced by ui_tooltip_region_draw_cb().

UI_tooltip_color_field_add()

void UI_tooltip_color_field_add	(	uiTooltipData &	data,
		const blender::float4 &	original_color,
		const bool	has_alpha,
		const bool	is_gamma,
		const ColorManagedDisplay *	display,
		const uiTooltipColorID	color_id )

Definition at line 839 of file interface_region_tooltip.cc.

References uiTooltipImage::background, blf_mono_font, BLF_size(), BLF_width(), uiTooltipImage::border, Checkerboard_Fixed, data, DISPLAY_SPACE_COLOR_INSPECTION, uiTooltipImage::height, IB_byte_data, uiTooltipImage::ibuf, IMB_allocImBuf(), IMB_colormanagement_scene_linear_to_display_v3(), IMB_colormanagement_scene_linear_to_srgb_v3(), IMB_colormanagement_srgb_to_scene_linear_v3(), IMB_freeImBuf(), IMB_rectfill_area(), None, uiFontStyle::points, uiTooltipImage::premultiplied, rgb_to_hsv_v(), blender::StringRefBase::size(), TIP_, uiStyle::tooltip, UI_SCALE_FAC, UI_style_get(), UI_TIP_STYLE_MONO, UI_TIP_STYLE_SPACER, ui_tooltip_color_string(), UI_tooltip_image_field_add(), UI_tooltip_text_field_add(), w(), and uiTooltipImage::width.

Referenced by ui_tooltip_data_from_button_or_extra_icon().

ui_tooltip_color_string()

std::string ui_tooltip_color_string ( const blender::float4 & color, const blender::StringRefNull title, const int max_title_len, const bool show_alpha, const bool show_hex = false )

static

Definition at line 806 of file interface_region_tooltip.cc.

References hex, rgba_float_to_uchar(), and blender::StringRefBase::size().

Referenced by UI_tooltip_color_field_add().

UI_tooltip_create_from_button()

ARegion * UI_tooltip_create_from_button	(	bContext *	C,
		ARegion *	butregion,
		uiBut *	but,
		bool	is_quick_tip )

Parameters

is_quick_tip

See UI_but_func_quick_tooltip_set for what a quick tooltip is.

Definition at line 1714 of file interface_region_tooltip.cc.

References C, and UI_tooltip_create_from_button_or_extra_icon().

Referenced by ui_search_menu_create_tooltip().

UI_tooltip_create_from_button_or_extra_icon()

ARegion * UI_tooltip_create_from_button_or_extra_icon	(	bContext *	C,
		ARegion *	butregion,
		uiBut *	but,
		uiButExtraOpIcon *	extra_icon,
		bool	is_quick_tip )

Definition at line 1648 of file interface_region_tooltip.cc.

References BLI_rctf_cent_x(), BLI_rctf_cent_y(), BLI_rctf_size_y(), BLI_rcti_rctf_copy_round(), uiBut::block, C, CTX_wm_window(), data, uiBut::drawflag, wmWindow::eventstate, Label, uiBut::rect, uiBut::tip_custom_func, uiBut::type, ui_block_to_window_fl(), ui_block_to_window_rctf(), UI_but_has_quick_tooltip(), UI_but_is_tool(), UI_BUT_NO_TOOLTIP, UI_POPUP_MARGIN, ui_tooltip_create_with_data(), ui_tooltip_data_from_button_or_extra_icon(), ui_tooltip_data_from_custom_func(), ui_tooltip_data_from_tool(), UI_UNIT_Y, wmEvent::xy, and rctf::ymin.

Referenced by ui_but_tooltip_init(), and UI_tooltip_create_from_button().

UI_tooltip_create_from_gizmo()

ARegion * UI_tooltip_create_from_gizmo	(	bContext *	C,
		wmGizmo *	gz )

Definition at line 1722 of file interface_region_tooltip.cc.

References bounds(), C, CTX_wm_window(), data, wmWindow::eventstate, float, wmGizmoType::screen_bounds_get, wmGizmo::type, ui_tooltip_create_with_data(), ui_tooltip_data_from_gizmo(), and wmEvent::xy.

Referenced by WM_gizmomap_tooltip_init().

UI_tooltip_create_from_search_item_generic()

ARegion * UI_tooltip_create_from_search_item_generic	(	bContext *	C,
		const ARegion *	searchbox_region,
		const rcti *	item_rect,
		ID *	id )

Create a tooltip from search-item tooltip data item_tooltip data. To be called from a callback set with UI_but_func_search_set_tooltip().

Parameters

item_rect

Rectangle of the search item in search region space (ui_searchbox_butrect()) which is passed to the tooltip callback.

Definition at line 1957 of file interface_region_tooltip.cc.

References C, CTX_wm_window(), data, wmWindow::eventstate, UI_POPUP_MARGIN, ui_tooltip_create_with_data(), ui_tooltip_data_from_search_item_tooltip_data(), ARegion::winrct, wmEvent::xy, and rcti::ymin.

Referenced by template_ID_search_menu_item_tooltip().

ui_tooltip_create_with_data()

ARegion * ui_tooltip_create_with_data ( bContext * C, std::unique_ptr< uiTooltipData > data_uptr, const float init_position[2], const rcti * init_rect_overlap )

static

Definition at line 1392 of file interface_region_tooltip.cc.

References BLF_disable(), BLF_DRAW_STR_DUMMY_MAX, BLF_enable(), BLF_height_max(), blf_mono_font, BLF_NONE, BLF_size(), BLF_width(), BLF_WORD_WRAP, BLF_wordwrap(), BLI_rcti_cent_x(), BLI_rcti_cent_y(), BLI_rcti_clamp(), BLI_rcti_inside_rcti(), BLI_rcti_pad(), BLI_rcti_rctf_copy(), BLI_rcti_size_x(), BLI_rcti_size_y(), BLI_rcti_translate(), C, CTX_wm_screen(), CTX_wm_window(), data, ARegionType::draw, ED_region_floating_init(), ED_region_tag_redraw(), uiTooltipField::format, ARegionType::free, uiTooltipField::geom, HardLimit, i, uiTooltipField::image, ResultBLF::lines, uiTooltipField::lines, max_ff(), max_ii(), min_ii(), pad, Path, ARegion::regiondata, ARegionType::regionid, RGN_TYPE_TEMPORARY, round, ARegion::runtime, uiTooltipFormat::style, uiTooltipField::text, uiTooltipField::text_suffix, uiStyle::tooltip, Typographical, U, UI_fontstyle_set(), UI_POPUP_MARGIN, ui_region_temp_add(), UI_SCALE_FAC, UI_style_get(), UI_TIP_MAXWIDTH, UI_TIP_PADDING_X, UI_TIP_PADDING_Y, UI_TIP_SPACER, UI_TIP_STYLE_IMAGE, UI_TIP_STYLE_MONO, UI_TIP_STYLE_SPACER, ui_tooltip_region_draw_cb(), ui_tooltip_region_free_cb(), w(), ResultBLF::width, ARegion::winrct, WM_window_native_pixel_size(), uiTooltipField::x_pos, rctf::xmax, rcti::xmax, rctf::xmin, rcti::xmin, rctf::ymax, rcti::ymax, rctf::ymin, and rcti::ymin.

Referenced by UI_tooltip_create_from_button_or_extra_icon(), UI_tooltip_create_from_gizmo(), and UI_tooltip_create_from_search_item_generic().

ui_tooltip_data_from_button_or_extra_icon()

std::unique_ptr< uiTooltipData > ui_tooltip_data_from_button_or_extra_icon ( bContext * C, uiBut * but, uiButExtraOpIcon * extra_icon, const bool is_quick_tip )

static

Definition at line 979 of file interface_region_tooltip.cc.

References BKE_build_template_variables_for_prop(), BKE_path_contains_template_syntax(), BKE_path_template_error_to_string(), BKE_path_validate_template(), BLI_assert, BLI_path_contains(), BLI_path_is_rel(), uiBut::block, C, blender::StringRefNull::c_str(), Color, CTX_wm_operator_poll_msg_clear(), CTX_wm_operator_poll_msg_get(), data, uiBut::disabled_info, uiBut::drawstr, ELEM, error(), blender::asset_system::essentials_directory_path(), Library::filepath, uiBut::flag, ID_IS_LINKED, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), ID::lib, MEM_freeN(), nullptr, uiBut::opcontext, wmOperatorCallParams::opcontext, uiBut::optype, wmOperatorCallParams::optype, uiButExtraOpIcon::optype_params, PointerRNA::owner_id, PROP_DIRPATH, PROP_ENUM_FLAG, PROP_FILENAME, PROP_FILEPATH, PROP_FLOAT, PROP_NONE, PROP_PASSWORD, PROP_PATH_SUPPORTS_BLEND_RELATIVE, PROP_PATH_SUPPORTS_TEMPLATES, PROP_UNIT_ROTATION, RNA_property_array_check(), RNA_property_array_length(), RNA_property_flag(), RNA_property_float_get(), RNA_property_float_get_index(), RNA_property_string_get(), RNA_property_subtype(), RNA_property_type(), uiBut::rnaindex, uiBut::rnapoin, uiBut::rnaprop, Row, SearchMenu, blender::StringRefBase::size(), blender::StringRefBase::startswith(), blender::StringRefBase::substr(), Text, TIP_, uiBut::tip_func, uiBut::type, U, ui_block_is_menu(), ui_block_is_pie_menu(), ui_but_anim_expression_get(), UI_but_cm_display_get(), ui_but_context_poll_operator_ex(), UI_BUT_DISABLED, UI_BUT_DRIVEN, UI_but_extra_icon_string_get_label(), UI_but_extra_icon_string_get_operator_keymap(), UI_but_extra_icon_string_get_tooltip(), UI_but_extra_operator_icon_optype_get(), ui_but_is_color_gamma(), UI_BUT_REDALERT, UI_but_rna_enum_item_get(), ui_but_string_get(), UI_but_string_get_label(), UI_but_string_get_operator_keymap(), UI_but_string_get_property_keymap(), UI_but_string_get_rna_property_identifier(), UI_but_string_get_rna_struct_identifier(), UI_but_string_get_tooltip(), UI_but_string_get_tooltip_label(), UI_but_unit_type_get(), ui_but_v3_get(), UI_TIP_LC_ALERT, UI_TIP_LC_NORMAL, UI_TIP_LC_VALUE, UI_TIP_STYLE_HEADER, UI_TIP_STYLE_NORMAL, UI_TIP_STYLE_SPACER, UI_tooltip_color_field_add(), ui_tooltip_period_needed(), UI_tooltip_text_field_add(), UI_tooltip_uibut_python_add(), and USER_TOOLTIPS_PYTHON.

Referenced by UI_tooltip_create_from_button_or_extra_icon().

ui_tooltip_data_from_custom_func()

std::unique_ptr< uiTooltipData > ui_tooltip_data_from_custom_func ( bContext * C, uiBut * but )

static

Definition at line 1381 of file interface_region_tooltip.cc.

References C, data, nullptr, uiBut::tip_arg, and uiBut::tip_custom_func.

Referenced by UI_tooltip_create_from_button_or_extra_icon().

ui_tooltip_data_from_gizmo()

std::unique_ptr< uiTooltipData > ui_tooltip_data_from_gizmo ( bContext * C, wmGizmo * gz )

static

Definition at line 1307 of file interface_region_tooltip.cc.

References ARRAY_SIZE, BLT_I18NCONTEXT_OPERATOR_DEFAULT, C, CTX_TIP_, data, PointerRNA::data, wmGizmo::drag_part, wmGizmo::highlight_part, i, wmOperatorType::idname, blender::wm::InvokeDefault, nullptr, wmGizmoProperty::prop, wmGizmoOpElem::ptr, RNA_property_ui_description(), wmGizmo::target_properties, TIP_, wmGizmoOpElem::type, UI_TIP_LC_VALUE, UI_TIP_STYLE_HEADER, UI_TIP_STYLE_NORMAL, UI_tooltip_text_field_add(), WM_gizmo_operator_get(), WM_key_event_operator_string(), and WM_operatortype_description_or_name().

Referenced by UI_tooltip_create_from_gizmo().

ui_tooltip_data_from_search_item_tooltip_data()

std::unique_ptr< uiTooltipData > ui_tooltip_data_from_search_item_tooltip_data ( ID * id )

static

Additional info about the item (e.g. library name of a linked data-block).

Definition at line 1917 of file interface_region_tooltip.cc.

References BKE_idtype_idcode_to_name(), data, Library::filepath, GS, Library::id, ID_IM, ID_IS_LINKED, ID_MC, ID_VF, ID::lib, ID::name, nullptr, TIP_, UI_TIP_LC_MAIN, UI_TIP_LC_NORMAL, UI_TIP_STYLE_HEADER, UI_TIP_STYLE_NORMAL, ui_tooltip_from_clip(), ui_tooltip_from_image(), ui_tooltip_from_vfont(), and UI_tooltip_text_field_add().

Referenced by UI_tooltip_create_from_search_item_generic().

ui_tooltip_data_from_tool()

std::unique_ptr< uiTooltipData > ui_tooltip_data_from_tool ( bContext * C, uiBut * but, bool is_quick_tip )

static

Special tool-system exception.

Definition at line 466 of file interface_region_tooltip.cc.

References BLI_assert, BLI_strdup(), uiBut::block, BLT_I18NCONTEXT_OPERATOR_DEFAULT, BPY_run_string_as_intptr(), BPY_run_string_as_string(), BPY_run_string_as_string_and_len(), C, CTX_IFACE_, CTX_wm_area(), CTX_wm_space_data(), CTX_wm_window(), data, PointerRNA::data, uiBut::drawstr, uiBlock::flag, wmOperatorType::idname, IFACE_, blender::wm::InvokeRegionWin, wmKeyMap::items, KM_SHIFT, LISTBASE_FOREACH, MAX_NAME, MEM_freeN(), nullptr, uiBut::opptr, uiBut::optype, RNA_boolean_set(), RNA_property_enum_get(), RNA_property_is_set(), RNA_string_get(), RNA_string_set(), RNA_struct_find_property(), SNPRINTF_UTF8, ScrArea::spacetype, str, STREQ, TIP_, U, UI_BLOCK_SHOW_SHORTCUT_ALWAYS, UI_but_string_get_operator_keymap(), UI_TIP_LC_ALERT, UI_TIP_LC_MAIN, UI_TIP_LC_NORMAL, UI_TIP_LC_PYTHON, UI_TIP_LC_VALUE, UI_TIP_STYLE_MONO, UI_TIP_STYLE_NORMAL, ui_tooltip_period_needed(), UI_tooltip_text_field_add(), ui_tooltip_text_python_from_op(), UNUSED_VARS, USER_TOOLTIPS_PYTHON, WM_key_event_operator_string(), WM_keymap_item_to_string(), WM_operator_properties_create_ptr(), and WM_operator_properties_free().

Referenced by UI_tooltip_create_from_button_or_extra_icon().

UI_tooltip_free()

void UI_tooltip_free	(	bContext *	C,
		bScreen *	screen,
		ARegion *	region )

Definition at line 1975 of file interface_region_tooltip.cc.

References C, and ui_region_temp_remove().

Referenced by WM_tooltip_clear(), WM_tooltip_init(), and WM_tooltip_refresh().

ui_tooltip_from_clip()

void ui_tooltip_from_clip ( MovieClip & clip, uiTooltipData & data )

static

Definition at line 1818 of file interface_region_tooltip.cc.

References MovieClip::anim, uiTooltipImage::background, BLI_path_split_dir_part(), uiTooltipImage::border, Box, Checkerboard_Themed, data, FILE_MAX, MovieClip::filepath, uiTooltipImage::height, uiTooltipImage::ibuf, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE, IMB_byte_from_float(), IMB_freeImBuf(), IMB_scale(), IMB_TC_RECORD_RUN, MOV_decode_preview_frame(), MOV_get_duration_frames(), MOV_get_image_height(), MOV_get_image_width(), uiTooltipImage::premultiplied, MovieClip::source, TIP_, UI_SCALE_FAC, UI_TIP_LC_NORMAL, UI_TIP_STYLE_NORMAL, UI_TIP_STYLE_SPACER, UI_tooltip_image_field_add(), UI_tooltip_text_field_add(), and uiTooltipImage::width.

Referenced by ui_tooltip_data_from_search_item_tooltip_data().

ui_tooltip_from_image()

void ui_tooltip_from_image ( Image & ima, uiTooltipData & data )

static

Definition at line 1745 of file interface_region_tooltip.cc.

References Image::anims, uiTooltipImage::background, BKE_image_has_anim(), BKE_image_preview(), BLI_path_split_dir_part(), uiTooltipImage::border, Checkerboard_Themed, Image::colorspace_settings, data, FILE_MAX, Image::filepath, ListBase::first, uiTooltipImage::height, uiTooltipImage::ibuf, Image::id, IMA_SRC_FILE, IMA_SRC_GENERATED, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE, IMA_SRC_TILED, IMA_SRC_VIEWER, IMB_freeImBuf(), IMB_TC_RECORD_RUN, MOV_get_duration_frames(), ColorManagedColorspaceSettings::name, uiTooltipImage::premultiplied, Image::source, TIP_, UI_SCALE_FAC, UI_TIP_LC_NORMAL, UI_TIP_STYLE_NORMAL, UI_TIP_STYLE_SPACER, UI_tooltip_image_field_add(), UI_tooltip_text_field_add(), ID::us, w(), uiTooltipImage::width, ImBuf::x, and ImBuf::y.

Referenced by ui_tooltip_data_from_search_item_tooltip_data().

ui_tooltip_from_vfont()

void ui_tooltip_from_vfont ( const VFont & font, uiTooltipData & data )

static

Definition at line 1877 of file interface_region_tooltip.cc.

References uiTooltipImage::background, BKE_vfont_is_builtin(), BLI_exists(), BLI_path_abs(), uiTooltipImage::border, data, FILE_MAX, VFont::filepath, uiTooltipImage::height, uiTooltipImage::ibuf, VFont::id, ID_BLEND_PATH_FROM_GLOBAL, IMB_font_preview(), IMB_freeImBuf(), None, uiTooltipImage::premultiplied, rgba_uchar_to_float(), STRNCPY(), uiWidgetColors::text, uiTooltipImage::text_color, TIP_, UI_SCALE_FAC, UI_TIP_LC_ALERT, UI_TIP_STYLE_NORMAL, ui_tooltip_get_theme(), UI_tooltip_image_field_add(), UI_tooltip_text_field_add(), uiTooltipImage::width, ImBuf::x, and ImBuf::y.

Referenced by ui_tooltip_data_from_search_item_tooltip_data().

UI_tooltip_image_field_add()

void UI_tooltip_image_field_add	(	uiTooltipData &	data,
		const uiTooltipImage &	image_data )

Parameters

image	Image buffer (duplicated, ownership is not transferred to data).
image_size	Display size for the image (pixels without UI scale applied).

Definition at line 142 of file interface_region_tooltip.cc.

References data, uiTooltipField::format, uiTooltipImage::ibuf, uiTooltipField::image, IMB_dupImBuf(), uiTooltipFormat::style, and UI_TIP_STYLE_IMAGE.

Referenced by file_draw_tooltip_custom_func(), UI_tooltip_color_field_add(), ui_tooltip_from_clip(), ui_tooltip_from_image(), ui_tooltip_from_vfont(), and uiTemplateRecentFiles_tooltip_func().

ui_tooltip_period_needed()

bool ui_tooltip_period_needed ( blender::StringRef tip )

static

Definition at line 444 of file interface_region_tooltip.cc.

References blender::StringRefBase::back(), ELEM, blender::StringRefBase::find(), blender::StringRefBase::is_empty(), and blender::StringRefBase::not_found.

Referenced by ui_tooltip_data_from_button_or_extra_icon(), and ui_tooltip_data_from_tool().

ui_tooltip_region_draw_cb()

void ui_tooltip_region_draw_cb ( const bContext * , ARegion * region )

static

Definition at line 164 of file interface_region_tooltip.cc.

References uiFontStyleDraw_Params::align, BLF_descender(), BLF_disable(), blf_mono_font, BLF_size(), BLF_WORD_WRAP, BLF_wordwrap(), BLI_assert, Checkerboard_Fixed, Checkerboard_Themed, color_blend_f3_f3(), uiTooltipFormat::color_id, copy_v3_v3(), data, uiTooltipField::format, uiTooltipField::geom, GPU_blend(), GPU_BLEND_ALPHA, GPU_BLEND_ALPHA_PREMULT, GPU_BLEND_NONE, GPU_SHADER_3D_IMAGE_COLOR, GPU_SHADER_3D_UNIFORM_COLOR, GPU_vertformat_attr_add(), HardLimit, i, uiTooltipField::image, imm_draw_box_checker_2d(), imm_draw_box_checker_2d_ex(), imm_draw_box_wire_2d(), immBindBuiltinProgram(), immDrawPixelsTexScaledFullSize(), immDrawPixelsTexSetup(), immUnbindProgram(), immUniformColor4fv(), immVertexFormat(), uiWidgetColors::inner, uiTooltipField::lines, Path, uiFontStyle::points, pos, ARegion::regiondata, rgb_float_to_uchar(), rgb_uchar_to_float(), srgb_to_grayscale(), state, uiTooltipFormat::style, uiTooltipField::text, uiWidgetColors::text, uiTooltipField::text_suffix, TH_BACK, TH_REDALERT, Typographical, U, UI_ALPHA_CHECKER_DARK, UI_ALPHA_CHECKER_LIGHT, ui_draw_tooltip_background(), UI_fontstyle_draw(), UI_fontstyle_set(), UI_GetThemeColor3fv(), UI_GetThemeColor4fv(), UI_SCALE_FAC, UI_style_get(), UI_STYLE_TEXT_LEFT, UI_TIP_LC_ACTIVE, UI_TIP_LC_ALERT, UI_TIP_LC_MAIN, UI_TIP_LC_MAX, UI_TIP_LC_NORMAL, UI_TIP_LC_PYTHON, UI_TIP_LC_VALUE, UI_TIP_PADDING_X, UI_TIP_PADDING_Y, UI_TIP_SPACER, UI_TIP_STYLE_HEADER, UI_TIP_STYLE_IMAGE, UI_TIP_STYLE_MONO, UI_TIP_STYLE_NORMAL, UI_TIP_STYLE_SPACER, ui_tooltip_get_theme(), uiFontStyle::uifont_id, wmOrtho2_region_pixelspace(), uiFontStyleDraw_Params::word_wrap, uiTooltipField::x_pos, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by ui_tooltip_create_with_data().

ui_tooltip_region_free_cb()

void ui_tooltip_region_free_cb ( ARegion * region )

static

Definition at line 367 of file interface_region_tooltip.cc.

References data, uiTooltipField::image, IMB_freeImBuf(), and ARegion::regiondata.

Referenced by ui_tooltip_create_with_data().

UI_tooltip_text_field_add()

void UI_tooltip_text_field_add	(	uiTooltipData &	data,
		std::string	text,
		std::string	suffix,
		const uiTooltipStyle	style,
		const uiTooltipColorID	color_id,
		const bool	is_pad = false )

Parameters

text	Allocated text (transfer ownership to data) or null.
suffix	Allocated text (transfer ownership to data) or null.

Definition at line 122 of file interface_region_tooltip.cc.

References uiTooltipFormat::color_id, data, uiTooltipField::format, uiTooltipFormat::style, uiTooltipField::text, uiTooltipField::text_suffix, UI_TIP_LC_NORMAL, UI_TIP_STYLE_SPACER, and UI_tooltip_text_field_add().

Referenced by blender::ed::asset::asset_tooltip(), blender::ed::spreadsheet::SpreadsheetLayoutDrawer::draw_float4x4(), file_draw_tooltip_custom_func(), blender::ed::space_node::node_header_custom_tooltip(), ui_block_colorpicker(), UI_tooltip_color_field_add(), ui_tooltip_data_from_button_or_extra_icon(), ui_tooltip_data_from_gizmo(), ui_tooltip_data_from_search_item_tooltip_data(), ui_tooltip_data_from_tool(), ui_tooltip_from_clip(), ui_tooltip_from_image(), ui_tooltip_from_vfont(), UI_tooltip_text_field_add(), UI_tooltip_uibut_python_add(), and uiTemplateRecentFiles_tooltip_func().

ui_tooltip_text_python_from_op()

std::string ui_tooltip_text_python_from_op ( bContext * C, wmOperatorType * ot, PointerRNA * opptr )

static

Definition at line 385 of file interface_region_tooltip.cc.

References C, ot, str, WM_operator_pystring_abbreviate(), and WM_operator_pystring_ex().

Referenced by ui_tooltip_data_from_tool(), and UI_tooltip_uibut_python_add().

UI_tooltip_uibut_python_add()

void UI_tooltip_uibut_python_add	(	uiTooltipData &	data,
		bContext &	C,
		uiBut &	but,
		uiButExtraOpIcon *	extra_icon )

Add Python-related information to the tooltip. The caller is responsible for checking USER_TOOLTIPS_PYTHON.

Definition at line 927 of file interface_region_tooltip.cc.

References C, data, nullptr, uiBut::optype, PointerRNA::owner_id, RNA_path_full_property_py_ex(), RNA_path_full_struct_py(), uiBut::rnaindex, uiBut::rnapoin, uiBut::rnaprop, str, TIP_, UI_but_extra_operator_icon_opptr_get(), UI_but_extra_operator_icon_optype_get(), UI_but_operator_ptr_ensure(), UI_but_string_get_rna_property_identifier(), UI_but_string_get_rna_struct_identifier(), UI_TIP_LC_PYTHON, UI_TIP_STYLE_MONO, UI_tooltip_text_field_add(), ui_tooltip_text_python_from_op(), and WM_operator_properties_sanitize().

Referenced by ui_tooltip_data_from_button_or_extra_icon().