Blender V5.3
wm_tooltip.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#include "MEM_guardedalloc.h"
12
13#include "BLI_math_vector_c.hh"
14#include "BLI_time.hh"
15
16#include "BKE_context.hh"
17
18#include "UI_interface.hh"
19
20#include "WM_api.hh"
21#include "WM_types.hh"
22
23namespace blender {
24
30
32 bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
33{
35
37 if (screen->tool_tip == nullptr) {
38 screen->tool_tip = MEM_new_zeroed<wmTooltipState>(__func__);
39 }
40 screen->tool_tip->area_from = area;
41 screen->tool_tip->region_from = region;
42 screen->tool_tip->init = init;
43 WM_tooltip_init(C, win);
44}
45
47 bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init, double delay)
48{
50
53 if (screen->tool_tip == nullptr) {
54 screen->tool_tip = MEM_new_zeroed<wmTooltipState>(__func__);
55 }
56 screen->tool_tip->area_from = area;
57 screen->tool_tip->region_from = region;
58 screen->tool_tip->timer = WM_event_timer_add(wm, win, TIMER, delay);
59 screen->tool_tip->init = init;
60
61 /* Mouse position will be updated when the tooltip is shown, but save now
62 * because we cancel the showing if there is movement before timer expiry. */
64}
65
67 bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
68{
69 WM_tooltip_timer_init_ex(C, win, area, region, init, UI_TOOLTIP_DELAY);
70}
71
73{
76 if (screen->tool_tip != nullptr) {
77 if (screen->tool_tip->timer != nullptr) {
78 WM_event_timer_remove(wm, win, screen->tool_tip->timer);
79 screen->tool_tip->timer = nullptr;
80 }
81 }
82}
83
85{
88 if (screen->tool_tip != nullptr) {
89 if (screen->tool_tip->region) {
90 ui::tooltip_free(C, screen, screen->tool_tip->region);
91 screen->tool_tip->region = nullptr;
93 }
94 MEM_delete(screen->tool_tip);
95 screen->tool_tip = nullptr;
96 }
97}
98
100{
103 if (screen->tool_tip->region) {
104 ui::tooltip_free(C, screen, screen->tool_tip->region);
105 screen->tool_tip->region = nullptr;
106 }
107 const int pass_prev = screen->tool_tip->pass;
108 double pass_delay = 0.0;
109
110 {
111 ScrArea *area_prev = CTX_wm_area(C);
112 ARegion *region_prev = CTX_wm_region(C);
115 screen->tool_tip->region = screen->tool_tip->init(C,
116 screen->tool_tip->region_from,
117 &screen->tool_tip->pass,
118 &pass_delay,
119 &screen->tool_tip->exit_on_event);
120 CTX_wm_area_set(C, area_prev);
121 CTX_wm_region_set(C, region_prev);
122 }
123
125 if (pass_prev != screen->tool_tip->pass) {
126 /* The pass changed, add timer for next pass. */
128 screen->tool_tip->timer = WM_event_timer_add(wm, win, TIMER, pass_delay);
129 }
130 if (screen->tool_tip->region == nullptr) {
131 WM_tooltip_clear(C, win);
132 }
133}
134
136{
139 if (screen->tool_tip != nullptr) {
140 if (screen->tool_tip->region) {
141 ui::tooltip_free(C, screen, screen->tool_tip->region);
142 screen->tool_tip->region = nullptr;
143 }
144 WM_tooltip_init(C, win);
145 }
146}
147
148} // namespace blender
Platform independent time functions.
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define UI_TOOLTIP_DELAY
void tooltip_free(bContext *C, bScreen *screen, ARegion *region)
BMesh Iterators.
static double g_tooltip_time_closed
Definition wm_tooltip.cc:25
ScrArea * CTX_wm_area(const bContext *C)
MINLINE void copy_v2_v2_int(int r[2], const int a[2])
double WM_tooltip_time_closed()
Definition wm_tooltip.cc:26
void WM_tooltip_timer_init_ex(bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init, double delay)
Definition wm_tooltip.cc:46
ARegion *(*)(bContext *C, ARegion *region, int *pass, double *r_pass_delay, bool *r_exit_on_event) wmTooltipInitFn
Definition WM_api.hh:2381
void WM_tooltip_clear(bContext *C, wmWindow *win)
Definition wm_tooltip.cc:84
void WM_tooltip_timer_init(bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
Definition wm_tooltip.cc:66
void WM_tooltip_timer_clear(bContext *C, wmWindow *win)
Definition wm_tooltip.cc:72
void WM_tooltip_refresh(bContext *C, wmWindow *win)
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
void WM_tooltip_init(bContext *C, wmWindow *win)
Definition wm_tooltip.cc:99
wmWindowManager * CTX_wm_manager(const bContext *C)
double BLI_time_now_seconds()
Definition time.cc:30
void CTX_wm_region_set(bContext *C, ARegion *region)
void WM_event_timer_remove(wmWindowManager *wm, wmWindow *, wmTimer *timer)
wmTimer * WM_event_timer_add(wmWindowManager *wm, wmWindow *win, const wmEventType event_type, const double time_step)
bScreen * WM_window_get_active_screen(const wmWindow *win)
void WM_tooltip_immediate_init(bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
Definition wm_tooltip.cc:31
ARegion * CTX_wm_region(const bContext *C)
void CTX_wm_area_set(bContext *C, ScrArea *area)
struct wmTooltipState * tool_tip
ARegion *(*) init(bContext *C, ARegion *region, int *pass, double *pass_delay, bool *r_exit_on_event)
Definition WM_types.hh:1542
bke::WindowRuntime * runtime