c1bc70b711
A lot of files were missing copyright field in the header and
the Blender Foundation contributed to them in a sense of bug
fixing and general maintenance.
This change makes it explicit that those files are at least
partially copyrighted by the Blender Foundation.
Note that this does not make it so the Blender Foundation is
the only holder of the copyright in those files, and developers
who do not have a signed contract with the foundation still
hold the copyright as well.
Another aspect of this change is using SPDX format for the
header. We already used it for the license specification,
and now we state it for the copyright as well, following the
FAQ:
https://reuse.software/faq/
145 lines
4.1 KiB
C
145 lines
4.1 KiB
C
/* SPDX-FileCopyrightText: 2023 Blender Foundation
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup wm
|
|
*
|
|
* Manages a per-window tool-tip.
|
|
*/
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
#include "BLI_math_vector.h"
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "BKE_context.h"
|
|
|
|
#include "ED_screen.h"
|
|
|
|
#include "UI_interface.h"
|
|
|
|
#include "WM_api.h"
|
|
#include "WM_types.h"
|
|
|
|
#include "PIL_time.h"
|
|
|
|
static double g_tooltip_time_closed;
|
|
double WM_tooltip_time_closed(void)
|
|
{
|
|
return g_tooltip_time_closed;
|
|
}
|
|
|
|
void WM_tooltip_immediate_init(
|
|
bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
|
|
{
|
|
WM_tooltip_timer_clear(C, win);
|
|
|
|
bScreen *screen = WM_window_get_active_screen(win);
|
|
if (screen->tool_tip == NULL) {
|
|
screen->tool_tip = MEM_callocN(sizeof(*screen->tool_tip), __func__);
|
|
}
|
|
screen->tool_tip->area_from = area;
|
|
screen->tool_tip->region_from = region;
|
|
screen->tool_tip->init = init;
|
|
WM_tooltip_init(C, win);
|
|
}
|
|
|
|
void WM_tooltip_timer_init_ex(
|
|
bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init, double delay)
|
|
{
|
|
WM_tooltip_timer_clear(C, win);
|
|
|
|
bScreen *screen = WM_window_get_active_screen(win);
|
|
wmWindowManager *wm = CTX_wm_manager(C);
|
|
if (screen->tool_tip == NULL) {
|
|
screen->tool_tip = MEM_callocN(sizeof(*screen->tool_tip), __func__);
|
|
}
|
|
screen->tool_tip->area_from = area;
|
|
screen->tool_tip->region_from = region;
|
|
screen->tool_tip->timer = WM_event_add_timer(wm, win, TIMER, delay);
|
|
screen->tool_tip->init = init;
|
|
}
|
|
|
|
void WM_tooltip_timer_init(
|
|
bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
|
|
{
|
|
WM_tooltip_timer_init_ex(C, win, area, region, init, UI_TOOLTIP_DELAY);
|
|
}
|
|
|
|
void WM_tooltip_timer_clear(bContext *C, wmWindow *win)
|
|
{
|
|
wmWindowManager *wm = CTX_wm_manager(C);
|
|
bScreen *screen = WM_window_get_active_screen(win);
|
|
if (screen->tool_tip != NULL) {
|
|
if (screen->tool_tip->timer != NULL) {
|
|
WM_event_remove_timer(wm, win, screen->tool_tip->timer);
|
|
screen->tool_tip->timer = NULL;
|
|
}
|
|
}
|
|
}
|
|
|
|
void WM_tooltip_clear(bContext *C, wmWindow *win)
|
|
{
|
|
WM_tooltip_timer_clear(C, win);
|
|
bScreen *screen = WM_window_get_active_screen(win);
|
|
if (screen->tool_tip != NULL) {
|
|
if (screen->tool_tip->region) {
|
|
UI_tooltip_free(C, screen, screen->tool_tip->region);
|
|
screen->tool_tip->region = NULL;
|
|
g_tooltip_time_closed = PIL_check_seconds_timer();
|
|
}
|
|
MEM_freeN(screen->tool_tip);
|
|
screen->tool_tip = NULL;
|
|
}
|
|
}
|
|
|
|
void WM_tooltip_init(bContext *C, wmWindow *win)
|
|
{
|
|
WM_tooltip_timer_clear(C, win);
|
|
bScreen *screen = WM_window_get_active_screen(win);
|
|
if (screen->tool_tip->region) {
|
|
UI_tooltip_free(C, screen, screen->tool_tip->region);
|
|
screen->tool_tip->region = NULL;
|
|
}
|
|
const int pass_prev = screen->tool_tip->pass;
|
|
double pass_delay = 0.0;
|
|
|
|
{
|
|
ScrArea *area_prev = CTX_wm_area(C);
|
|
ARegion *region_prev = CTX_wm_region(C);
|
|
CTX_wm_area_set(C, screen->tool_tip->area_from);
|
|
CTX_wm_region_set(C, screen->tool_tip->region_from);
|
|
screen->tool_tip->region = screen->tool_tip->init(C,
|
|
screen->tool_tip->region_from,
|
|
&screen->tool_tip->pass,
|
|
&pass_delay,
|
|
&screen->tool_tip->exit_on_event);
|
|
CTX_wm_area_set(C, area_prev);
|
|
CTX_wm_region_set(C, region_prev);
|
|
}
|
|
|
|
copy_v2_v2_int(screen->tool_tip->event_xy, win->eventstate->xy);
|
|
if (pass_prev != screen->tool_tip->pass) {
|
|
/* The pass changed, add timer for next pass. */
|
|
wmWindowManager *wm = CTX_wm_manager(C);
|
|
screen->tool_tip->timer = WM_event_add_timer(wm, win, TIMER, pass_delay);
|
|
}
|
|
if (screen->tool_tip->region == NULL) {
|
|
WM_tooltip_clear(C, win);
|
|
}
|
|
}
|
|
|
|
void WM_tooltip_refresh(bContext *C, wmWindow *win)
|
|
{
|
|
WM_tooltip_timer_clear(C, win);
|
|
bScreen *screen = WM_window_get_active_screen(win);
|
|
if (screen->tool_tip != NULL) {
|
|
if (screen->tool_tip->region) {
|
|
UI_tooltip_free(C, screen, screen->tool_tip->region);
|
|
screen->tool_tip->region = NULL;
|
|
}
|
|
WM_tooltip_init(C, win);
|
|
}
|
|
}
|