Blender V5.3
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.hh"
#include "BLI_listbase.hh"
#include "BLI_math_color_c.hh"
#include "BLI_math_vector_c.hh"
#include "BLI_path_utils.hh"
#include "BLI_rect.hh"
#include "BLI_string_utf8.hh"
#include "BLI_utildefines.hh"
#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_enum_types.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  blender::ui::TooltipFormat
struct  blender::ui::TooltipField
struct  blender::ui::TooltipData

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::ui

Macros

#define TIP_SPACER   0.3f
#define TIP_PADDING_X   1.95f
#define TIP_PADDING_Y   1.28f
#define TIP_MAXWIDTH   600

Functions

 blender::ui::BLI_STATIC_ASSERT (int(TIP_LC_MAX)==int(TIP_LC_ALERT)+1, "invalid lc-max")
void blender::ui::tooltip_text_field_add (TooltipData &data, std::string text, std::string suffix, const TooltipStyle style, const TooltipColorID color_id, const bool is_pad=false)
void blender::ui::tooltip_image_field_add (TooltipData &data, const TooltipImage &image_data)
ToolTip Callbacks (Draw & Free)
static void blender::ui::color_blend_f3_f3 (float dest[3], const float source[3], const float fac)
static void blender::ui::tooltip_region_draw_cb (const bContext *, ARegion *region)
static void blender::ui::tooltip_region_free_cb (ARegion *region)
ToolTip Creation Utility Functions
static std::string blender::ui::tooltip_text_python_from_op (bContext *C, wmOperatorType *ot, PointerRNA *opptr)
ToolTip Creation
static std::string blender::ui::tooltip_with_period (StringRef tip)
static std::unique_ptr< TooltipData > blender::ui::tooltip_data_from_tool (bContext *C, Button *but, bool is_quick_tip)
static std::string blender::ui::tooltip_color_string (const float4 &color, const StringRefNull title, const int max_title_len, const bool show_alpha, const bool show_hex=false)
void blender::ui::tooltip_color_field_add (TooltipData &data, const float4 &color, bool has_alpha, bool is_gamma, const ColorManagedDisplay *display, TooltipColorID color_id)
void blender::ui::tooltip_uibut_python_add (TooltipData &data, bContext &C, Button &but, ButtonExtraOpIcon *extra_icon)
static const char * blender::ui::icon_id_to_name (BIFIconID icon_value)
static void blender::ui::tooltip_uibut_icon_add (TooltipData &data, Button &but)
static std::unique_ptr< TooltipData > blender::ui::tooltip_data_from_button_or_extra_icon (bContext *C, Button *but, ButtonExtraOpIcon *extra_icon, const bool is_quick_tip)
static std::unique_ptr< TooltipData > blender::ui::tooltip_data_from_gizmo (bContext *C, wmGizmo *gz)
static std::unique_ptr< TooltipData > blender::ui::tooltip_data_from_custom_func (bContext *C, Button *but)
static ARegion * blender::ui::tooltip_create_with_data (bContext *C, std::unique_ptr< TooltipData > data_uptr, const float init_position[2], const rcti *init_rect_overlap)
ToolTip Public API
ARegion * blender::ui::tooltip_create_from_button_or_extra_icon (bContext *C, ARegion *butregion, Button *but, ButtonExtraOpIcon *extra_icon, bool is_quick_tip)
ARegion * blender::ui::tooltip_create_from_button (bContext *C, ARegion *butregion, Button *but, bool is_quick_tip)
ARegion * blender::ui::tooltip_create_from_gizmo (bContext *C, wmGizmo *gz)
ARegion * blender::ui::tooltip_create_from_func (bContext *C, const FunctionRef< void(TooltipData &data)> create_fn, const float init_position[2])
static void blender::ui::tooltip_from_image (Image &ima, TooltipData &data)
static void blender::ui::tooltip_from_clip (MovieClip &clip, TooltipData &data)
static void blender::ui::tooltip_from_vfont (const VFont &font, TooltipData &data)
static std::unique_ptr< TooltipData > blender::ui::tooltip_data_from_search_item_tooltip_data (ID *id)
ARegion * blender::ui::tooltip_create_from_search_item_generic (bContext *C, const ARegion *searchbox_region, const rcti *item_rect, ID *id)
void blender::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

◆ TIP_MAXWIDTH

#define TIP_MAXWIDTH   600

Definition at line 95 of file interface_region_tooltip.cc.

Referenced by blender::ui::tooltip_create_with_data().

◆ TIP_PADDING_X

#define TIP_PADDING_X   1.95f

◆ TIP_PADDING_Y

#define TIP_PADDING_Y   1.28f

◆ TIP_SPACER

#define TIP_SPACER   0.3f