2016-06-15 17:40:05 +02:00
|
|
|
/* Copyright (C) 2016 Wildfire Games.
|
2009-04-18 19:00:33 +02:00
|
|
|
* This file is part of 0 A.D.
|
|
|
|
*
|
|
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2006-04-24 01:14:18 +02:00
|
|
|
#include "precompiled.h"
|
|
|
|
|
|
|
|
#include "GUITooltip.h"
|
2015-08-21 19:08:41 +02:00
|
|
|
|
2006-04-24 01:14:18 +02:00
|
|
|
#include "CGUI.h"
|
2009-12-03 21:17:22 +01:00
|
|
|
#include "GUIutil.h"
|
2015-08-21 19:08:41 +02:00
|
|
|
#include "IGUIObject.h"
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2015-08-21 19:08:41 +02:00
|
|
|
#include "lib/timer.h"
|
2006-04-24 01:14:18 +02:00
|
|
|
#include "ps/CLogger.h"
|
|
|
|
|
|
|
|
/*
|
|
|
|
Tooltips:
|
|
|
|
When holding the mouse stationary over an object for some amount of time,
|
|
|
|
the tooltip is displayed. If the mouse moves off that object, the tooltip
|
|
|
|
disappears. If the mouse re-enters an object within a short time, the new
|
|
|
|
tooltip is displayed immediately. (This lets you run the mouse across a
|
|
|
|
series of buttons, without waiting ages for the text to pop up every time.)
|
|
|
|
|
|
|
|
See Visual Studio's toolbar buttons for an example.
|
|
|
|
|
|
|
|
|
|
|
|
Implemented as a state machine:
|
|
|
|
|
|
|
|
(where "*" lines are checked constantly, and "<" lines are handled
|
|
|
|
on entry to that state)
|
|
|
|
|
|
|
|
IN MOTION
|
|
|
|
* If the mouse stops, check whether it should have a tooltip and move to
|
|
|
|
'STATIONARY, NO TOOLTIP' or 'STATIONARY, TOOLIP'
|
|
|
|
* If the mouse enters an object with a tooltip delay of 0, switch to 'SHOWING'
|
|
|
|
|
|
|
|
STATIONARY, NO TOOLTIP
|
|
|
|
* If the mouse moves, switch to 'IN MOTION'
|
|
|
|
|
|
|
|
STATIONARY, TOOLTIP
|
|
|
|
< Set target time = now + tooltip time
|
|
|
|
* If the mouse moves, switch to 'IN MOTION'
|
|
|
|
* If now > target time, switch to 'SHOWING'
|
|
|
|
|
|
|
|
SHOWING
|
|
|
|
< Start displaying the tooltip
|
|
|
|
* If the mouse leaves the object, check whether the new object has a tooltip
|
|
|
|
and switch to 'SHOWING' or 'COOLING'
|
|
|
|
|
|
|
|
COOLING (since I can't think of a better name)
|
|
|
|
< Stop displaying the tooltip
|
|
|
|
< Set target time = now + cooldown time
|
|
|
|
* If the mouse has moved and is over a tooltipped object, switch to 'SHOWING'
|
|
|
|
* If now > target time, switch to 'STATIONARY, NO TOOLTIP'
|
|
|
|
*/
|
|
|
|
|
|
|
|
enum
|
|
|
|
{
|
|
|
|
ST_IN_MOTION,
|
|
|
|
ST_STATIONARY_NO_TOOLTIP,
|
|
|
|
ST_STATIONARY_TOOLTIP,
|
|
|
|
ST_SHOWING,
|
|
|
|
ST_COOLING
|
|
|
|
};
|
|
|
|
|
|
|
|
GUITooltip::GUITooltip()
|
|
|
|
: m_State(ST_IN_MOTION), m_PreviousObject(NULL), m_PreviousTooltipName()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
const double CooldownTime = 0.25; // TODO: Don't hard-code this value
|
|
|
|
|
2010-10-30 06:02:42 +02:00
|
|
|
bool GUITooltip::GetTooltip(IGUIObject* obj, CStr& style)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2016-06-15 17:40:05 +02:00
|
|
|
CStrW text;
|
2010-10-30 06:02:42 +02:00
|
|
|
|
2016-06-15 17:40:05 +02:00
|
|
|
if (obj && obj->SettingExists("_icon_tooltip_style") && obj->MouseOverIcon() &&
|
|
|
|
GUI<CStr>::GetSetting(obj, "_icon_tooltip_style", style) == PSRETURN_OK &&
|
|
|
|
GUI<CStrW>::GetSetting(obj, "_icon_tooltip", text) == PSRETURN_OK && !text.empty())
|
|
|
|
{
|
|
|
|
if (style.empty())
|
|
|
|
style = "default";
|
2010-10-30 06:02:42 +02:00
|
|
|
|
2016-06-15 17:40:05 +02:00
|
|
|
m_IsIconTooltip = true;
|
|
|
|
return true;
|
2010-10-31 23:00:28 +01:00
|
|
|
}
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2016-06-15 17:40:05 +02:00
|
|
|
if (obj && obj->SettingExists("tooltip_style") &&
|
|
|
|
GUI<CStr>::GetSetting(obj, "tooltip_style", style) == PSRETURN_OK &&
|
|
|
|
GUI<CStrW>::GetSetting(obj, "tooltip", text) == PSRETURN_OK &&
|
|
|
|
!text.empty())
|
|
|
|
{
|
|
|
|
if (style.empty())
|
|
|
|
style = "default";
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2016-06-15 17:40:05 +02:00
|
|
|
m_IsIconTooltip = false;
|
|
|
|
return true;
|
2006-04-24 01:14:18 +02:00
|
|
|
}
|
2010-10-31 23:00:28 +01:00
|
|
|
|
2006-04-24 01:14:18 +02:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-08-21 19:08:41 +02:00
|
|
|
void GUITooltip::ShowTooltip(IGUIObject* obj, const CPos& pos, const CStr& style, CGUI* gui)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2011-04-30 15:01:45 +02:00
|
|
|
ENSURE(obj);
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2007-02-01 15:46:14 +01:00
|
|
|
if (style.empty())
|
2006-04-24 01:14:18 +02:00
|
|
|
return;
|
|
|
|
|
|
|
|
IGUIObject* tooltipobj = gui->FindObjectByName("__tooltip_"+style);
|
2015-08-21 19:08:41 +02:00
|
|
|
if (!tooltipobj)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2015-01-22 21:36:24 +01:00
|
|
|
LOGERROR("Cannot find tooltip named '%s'", style.c_str());
|
2006-04-24 01:14:18 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
IGUIObject* usedobj = tooltipobj; // object actually used to display the tooltip in
|
|
|
|
|
|
|
|
CStr usedObjectName;
|
2016-06-15 17:40:05 +02:00
|
|
|
if (GUI<CStr>::GetSetting(tooltipobj, "use_object", usedObjectName) == PSRETURN_OK &&
|
|
|
|
!usedObjectName.empty())
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
|
|
|
usedobj = gui->FindObjectByName(usedObjectName);
|
2015-08-21 19:08:41 +02:00
|
|
|
if (!usedobj)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2015-01-22 21:36:24 +01:00
|
|
|
LOGERROR("Cannot find object named '%s' used by tooltip '%s'", usedObjectName.c_str(), style.c_str());
|
2006-04-24 01:14:18 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
2016-06-15 17:40:05 +02:00
|
|
|
else if (GUI<CPos>::SetSetting(usedobj, "_mousepos", pos) != PSRETURN_OK)
|
|
|
|
debug_warn(L"Failed to set tooltip mouse position");
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2016-06-15 17:40:05 +02:00
|
|
|
GUI<bool>::SetSetting(usedobj, "hidden", false);
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2011-02-17 21:08:20 +01:00
|
|
|
CStrW text;
|
2010-10-30 06:02:42 +02:00
|
|
|
if (m_IsIconTooltip)
|
2010-10-31 23:00:28 +01:00
|
|
|
{
|
2011-02-17 21:08:20 +01:00
|
|
|
if (GUI<CStrW>::GetSetting(obj, "_icon_tooltip", text) != PSRETURN_OK)
|
2016-06-15 17:40:05 +02:00
|
|
|
debug_warn(L"Failed to retrieve icon tooltip text");
|
2010-10-30 06:02:42 +02:00
|
|
|
}
|
2016-06-15 17:40:05 +02:00
|
|
|
else if (GUI<CStrW>::GetSetting(obj, "tooltip", text) != PSRETURN_OK)
|
|
|
|
debug_warn(L"Failed to retrieve tooltip text");
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2009-09-27 17:04:46 +02:00
|
|
|
if (usedobj->SetSetting("caption", text) != PSRETURN_OK)
|
2016-06-15 17:40:05 +02:00
|
|
|
debug_warn(L"Failed to set tooltip caption");
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2011-04-28 22:42:11 +02:00
|
|
|
SGUIMessage msg(GUIM_SETTINGS_UPDATED, "caption");
|
|
|
|
usedobj->HandleMessage(msg);
|
2006-04-24 01:14:18 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void GUITooltip::HideTooltip(const CStr& style, CGUI* gui)
|
|
|
|
{
|
2007-02-01 15:46:14 +01:00
|
|
|
if (style.empty())
|
2006-04-24 01:14:18 +02:00
|
|
|
return;
|
|
|
|
|
|
|
|
IGUIObject* tooltipobj = gui->FindObjectByName("__tooltip_"+style);
|
2015-08-21 19:08:41 +02:00
|
|
|
if (!tooltipobj)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2015-01-22 21:36:24 +01:00
|
|
|
LOGERROR("Cannot find tooltip named '%s'", style.c_str());
|
2006-04-24 01:14:18 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
CStr usedObjectName;
|
2016-06-15 17:40:05 +02:00
|
|
|
if (GUI<CStr>::GetSetting(tooltipobj, "use_object", usedObjectName) == PSRETURN_OK &&
|
|
|
|
!usedObjectName.empty())
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
|
|
|
IGUIObject* usedobj = gui->FindObjectByName(usedObjectName);
|
2015-08-21 19:08:41 +02:00
|
|
|
if (!usedobj)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2015-01-22 21:36:24 +01:00
|
|
|
LOGERROR("Cannot find object named '%s' used by tooltip '%s'", usedObjectName.c_str(), style.c_str());
|
2006-04-24 01:14:18 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2010-05-30 15:11:32 +02:00
|
|
|
usedobj->SetSetting("caption", L"");
|
2011-04-28 22:42:11 +02:00
|
|
|
SGUIMessage msg(GUIM_SETTINGS_UPDATED, "caption");
|
|
|
|
usedobj->HandleMessage(msg);
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
bool hideobject = true;
|
|
|
|
GUI<bool>::GetSetting(tooltipobj, "hide_object", hideobject);
|
|
|
|
|
|
|
|
if (hideobject)
|
|
|
|
GUI<bool>::SetSetting(usedobj, "hidden", true);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
GUI<bool>::SetSetting(tooltipobj, "hidden", true);
|
|
|
|
}
|
|
|
|
|
2015-08-21 19:08:41 +02:00
|
|
|
static int GetTooltipDelay(const CStr& style, CGUI* gui)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
|
|
|
int delay = 500; // default value (in msec)
|
|
|
|
|
|
|
|
IGUIObject* tooltipobj = gui->FindObjectByName("__tooltip_"+style);
|
2015-08-21 19:08:41 +02:00
|
|
|
if (!tooltipobj)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2015-01-22 21:36:24 +01:00
|
|
|
LOGERROR("Cannot find tooltip object named '%s'", style.c_str());
|
2006-04-24 01:14:18 +02:00
|
|
|
return delay;
|
|
|
|
}
|
|
|
|
GUI<int>::GetSetting(tooltipobj, "delay", delay);
|
|
|
|
return delay;
|
|
|
|
}
|
|
|
|
|
2015-08-21 19:08:41 +02:00
|
|
|
void GUITooltip::Update(IGUIObject* Nearest, const CPos& MousePos, CGUI* GUI)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
|
|
|
// Called once per frame, so efficiency isn't vital
|
2008-01-07 21:03:19 +01:00
|
|
|
double now = timer_Time();
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
CStr style;
|
|
|
|
int nextstate = -1;
|
|
|
|
|
|
|
|
switch (m_State)
|
|
|
|
{
|
|
|
|
case ST_IN_MOTION:
|
|
|
|
if (MousePos == m_PreviousMousePos)
|
|
|
|
{
|
|
|
|
if (GetTooltip(Nearest, style))
|
|
|
|
nextstate = ST_STATIONARY_TOOLTIP;
|
|
|
|
else
|
|
|
|
nextstate = ST_STATIONARY_NO_TOOLTIP;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
// Check for movement onto a zero-delayed tooltip
|
|
|
|
if (GetTooltip(Nearest, style) && GetTooltipDelay(style, GUI)==0)
|
|
|
|
{
|
|
|
|
// Reset any previous tooltips completely
|
|
|
|
//m_Time = now + (double)GetTooltipDelay(style, GUI) / 1000.;
|
|
|
|
HideTooltip(m_PreviousTooltipName, GUI);
|
|
|
|
|
|
|
|
nextstate = ST_SHOWING;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ST_STATIONARY_NO_TOOLTIP:
|
|
|
|
if (MousePos != m_PreviousMousePos)
|
|
|
|
nextstate = ST_IN_MOTION;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ST_STATIONARY_TOOLTIP:
|
|
|
|
if (MousePos != m_PreviousMousePos)
|
|
|
|
nextstate = ST_IN_MOTION;
|
|
|
|
else if (now >= m_Time)
|
|
|
|
{
|
|
|
|
// Make sure the tooltip still exists
|
|
|
|
if (GetTooltip(Nearest, style))
|
|
|
|
nextstate = ST_SHOWING;
|
|
|
|
else
|
|
|
|
{
|
|
|
|
// Failed to retrieve style - the object has probably been
|
|
|
|
// altered, so just restart the process
|
|
|
|
nextstate = ST_IN_MOTION;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ST_SHOWING:
|
2010-10-30 06:02:42 +02:00
|
|
|
// Handle special case of icon tooltips
|
|
|
|
if (Nearest == m_PreviousObject && (!m_IsIconTooltip || Nearest->MouseOverIcon()))
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
2010-02-28 22:26:06 +01:00
|
|
|
// Still showing the same object's tooltip, but the text might have changed
|
|
|
|
if (GetTooltip(Nearest, style))
|
|
|
|
ShowTooltip(Nearest, MousePos, style, GUI);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
// Mouse moved onto a new object
|
2006-04-24 01:14:18 +02:00
|
|
|
if (GetTooltip(Nearest, style))
|
2015-08-21 19:08:41 +02:00
|
|
|
{
|
2006-04-24 01:14:18 +02:00
|
|
|
CStr style_old;
|
|
|
|
|
2015-08-21 19:08:41 +02:00
|
|
|
// If we're displaying a tooltip with no delay, then we want to
|
2006-04-24 01:14:18 +02:00
|
|
|
// reset so that other object that should have delay can't
|
|
|
|
// "ride this tail", it have to wait.
|
|
|
|
// Notice that this doesn't apply to when you go from one delay=0
|
|
|
|
// to another delay=0
|
2015-08-21 19:08:41 +02:00
|
|
|
if (GetTooltip(m_PreviousObject, style_old) && GetTooltipDelay(style_old, GUI) == 0 &&
|
|
|
|
GetTooltipDelay(style, GUI) != 0)
|
2006-04-24 01:14:18 +02:00
|
|
|
{
|
|
|
|
HideTooltip(m_PreviousTooltipName, GUI);
|
|
|
|
nextstate = ST_IN_MOTION;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
// Hide old scrollbar
|
|
|
|
HideTooltip(m_PreviousTooltipName, GUI);
|
|
|
|
nextstate = ST_SHOWING;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
nextstate = ST_COOLING;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ST_COOLING:
|
|
|
|
if (GetTooltip(Nearest, style))
|
|
|
|
nextstate = ST_SHOWING;
|
|
|
|
else if (now >= m_Time)
|
|
|
|
nextstate = ST_IN_MOTION;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Handle state-entry code:
|
|
|
|
if (nextstate != -1)
|
|
|
|
{
|
|
|
|
switch (nextstate)
|
|
|
|
{
|
|
|
|
case ST_STATIONARY_TOOLTIP:
|
|
|
|
m_Time = now + (double)GetTooltipDelay(style, GUI) / 1000.;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ST_SHOWING:
|
|
|
|
ShowTooltip(Nearest, MousePos, style, GUI);
|
|
|
|
m_PreviousTooltipName = style;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ST_COOLING:
|
|
|
|
HideTooltip(m_PreviousTooltipName, GUI);
|
|
|
|
m_Time = now + CooldownTime;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
m_State = nextstate;
|
|
|
|
}
|
|
|
|
|
|
|
|
m_PreviousMousePos = MousePos;
|
|
|
|
m_PreviousObject = Nearest;
|
|
|
|
}
|