/usr/include/CEGUI/elements/CEGUITooltip.h is in libcegui-mk2-dev 0.7.6-2ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 | /***********************************************************************
filename: CEGUITooltip.h
created: 21/2/2005
author: Paul D Turner
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUITooltip_h_
#define _CEGUITooltip_h_
#include "../CEGUIWindow.h"
#include "CEGUITooltipProperties.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Base class for Tooltip window renderer objects.
*/
class CEGUIEXPORT TooltipWindowRenderer : public WindowRenderer
{
public:
/*!
\brief
Constructor
*/
TooltipWindowRenderer(const String& name);
/*!
\brief
Return the size of the area that will be occupied by the tooltip text, given
any current formatting options.
\return
Size object describing the size of the rendered tooltip text in pixels.
*/
virtual Size getTextSize() const = 0;
};
/*!
\brief
Base class for Tooltip widgets.
The Tooltip class shows a simple pop-up window around the mouse position
with some text information. The tool-tip fades in when the user hovers
with the mouse over a window which has tool-tip text set, and then fades
out after some pre-set time.
\note
For Tooltip to work properly, you must specify a default tool-tip widget
type via System::setTooltip, or by setting a custom tool-tip object for
your Window(s). Additionally, you need to ensure that time pulses are
properly passed to the system via System::injectTimePulse.
*/
class CEGUIEXPORT Tooltip : public Window
{
public:
/*************************************************************************
Constants
*************************************************************************/
static const String WidgetTypeName; //!< Window factory name
static const String EventNamespace; //!< Namespace for global events
/** Event fired when the hover timeout for the tool tip gets changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Tooltip whose hover timeout has
* been changed.
*/
static const String EventHoverTimeChanged;
/** Event fired when the display timeout for the tool tip gets changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Tooltip whose display timeout has
* been changed.
*/
static const String EventDisplayTimeChanged;
/** Event fired when the fade timeout for the tooltip gets changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Tooltip whose fade timeout has
* been changed.
*/
static const String EventFadeTimeChanged;
/** Event fired when the tooltip is about to get activated.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Tooltip that is about to become
* active.
*/
static const String EventTooltipActive;
/** Event fired when the tooltip has been deactivated.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Tooltip that has become inactive.
*/
static const String EventTooltipInactive;
/************************************************************************
Object Construction and Destruction
************************************************************************/
/*!
\brief
Constructor for the Tooltip base class constructor
*/
Tooltip(const String& type, const String& name);
/*!
\brief
Destructor for the Tooltip base class.
*/
~Tooltip(void);
/************************************************************************
Public interface
************************************************************************/
/*!
\brief
Sets the target window for the tooltip. This used internally to manage tooltips, you
should not have to call this yourself.
\param wnd
Window object that the tooltip should be associated with (for now).
\return
Nothing.
*/
void setTargetWindow(Window* wnd);
/*!
\brief
return the current target window for this Tooltip.
\return
Pointer to the target window for this Tooltip or 0 for none.
*/
const Window* getTargetWindow();
/*!
\brief
Resets the timer on the tooltip when in the Active / Inactive states. This is used internally
to control the tooltip, it is not normally necessary to call this method yourself.
\return
Nothing.
*/
void resetTimer(void);
/*!
\brief
Return the number of seconds the mouse should hover stationary over the target window before
the tooltip gets activated.
\return
float value representing a number of seconds.
*/
float getHoverTime(void) const;
/*!
\brief
Set the number of seconds the tooltip should be displayed for before it automatically
de-activates itself. 0 indicates that the tooltip should never timesout and auto-deactivate.
\param seconds
float value representing a number of seconds.
\return
Nothing.
*/
void setDisplayTime(float seconds);
/*!
\brief
Return the number of seconds that should be taken to fade the tooltip into and out of
visibility.
\return
float value representing a number of seconds.
*/
float getFadeTime(void) const;
/*!
\brief
Set the number of seconds the mouse should hover stationary over the target window before
the tooltip gets activated.
\param seconds
float value representing a number of seconds.
\return
Nothing.
*/
void setHoverTime(float seconds);
/*!
\brief
Return the number of seconds the tooltip should be displayed for before it automatically
de-activates itself. 0 indicates that the tooltip never timesout and auto-deactivates.
\return
float value representing a number of seconds.
*/
float getDisplayTime(void) const;
/*!
\brief
Set the number of seconds that should be taken to fade the tooltip into and out of
visibility.
\param seconds
float value representing a number of seconds.
\return
Nothing.
*/
void setFadeTime(float seconds);
/*!
\brief
Causes the tooltip to position itself appropriately.
\return
Nothing.
*/
void positionSelf(void);
/*!
\brief
Causes the tooltip to resize itself appropriately.
\return
Nothing.
*/
void sizeSelf(void);
/*!
\brief
Return the size of the area that will be occupied by the tooltip text, given
any current formatting options.
\return
Size object describing the size of the rendered tooltip text in pixels.
*/
Size getTextSize() const;
/*!
\brief
Return the size of the area that will be occupied by the tooltip text, given
any current formatting options.
\return
Size object describing the size of the rendered tooltip text in pixels.
*/
virtual Size getTextSize_impl() const;
protected:
/*************************************************************************
Implementation Methods
*************************************************************************/
// methods to perform processing for each of the widget states
void doActiveState(float elapsed);
void doInactiveState(float elapsed);
void doFadeInState(float elapsed);
void doFadeOutState(float elapsed);
// methods to switch widget states
void switchToInactiveState(void);
void switchToActiveState(void);
void switchToFadeInState(void);
void switchToFadeOutState(void);
/*!
\brief
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
\param class_name
The class name that is to be checked.
\return
true if this window was inherited from \a class_name. false if not.
*/
virtual bool testClassName_impl(const String& class_name) const
{
if (class_name=="Tooltip") return true;
return Window::testClassName_impl(class_name);
}
// validate window renderer
virtual bool validateWindowRenderer(const String& name) const
{
return (name == "Tooltip");
}
/*************************************************************************
Event triggers
*************************************************************************/
/*!
\brief
Event trigger method called when the hover timeout gets changed.
\param e
WindowEventArgs object.
\return
Nothing.
*/
virtual void onHoverTimeChanged(WindowEventArgs& e);
/*!
\brief
Event trigger method called when the display timeout gets changed.
\param e
WindowEventArgs object.
\return
Nothing.
*/
virtual void onDisplayTimeChanged(WindowEventArgs& e);
/*!
\brief
Event trigger method called when the fade timeout gets changed.
\param e
WindowEventArgs object.
\return
Nothing.
*/
virtual void onFadeTimeChanged(WindowEventArgs& e);
/*!
\brief
Event trigger method called just before the tooltip becomes active.
\param e
WindowEventArgs object.
\return
Nothing.
*/
virtual void onTooltipActive(WindowEventArgs& e);
/*!
\brief
Event trigger method called just after the tooltip is deactivated.
\param e
WindowEventArgs object.
\return
Nothing.
*/
virtual void onTooltipInactive(WindowEventArgs& e);
/************************************************************************
Overridden from Window.
************************************************************************/
void updateSelf(float elapsed);
void onMouseEnters(MouseEventArgs& e);
void onTextChanged(WindowEventArgs& e);
/************************************************************************
Enumerations
************************************************************************/
/*!
\brief
states for tooltip
*/
enum TipState
{
Inactive, //!< Tooltip is currently inactive.
Active, //!< Tooltip is currently displayed and active.
FadeIn, //!< Tooltip is currently transitioning from Inactive to Active state.
FadeOut //!< Tooltip is currently transitioning from Active to Inactive state.
};
/************************************************************************
Data fields
************************************************************************/
TipState d_state; //!< Current tooltip state.
float d_elapsed; //!< Used to track state change timings
const Window* d_target; //!< Current target Window for this Tooltip.
float d_hoverTime; //!< tool-tip hover time (seconds mouse must stay stationary before tip shows).
float d_displayTime; //!< tool-tip display time (seconds that tip is showsn for).
float d_fadeTime; //!< tool-tip fade time (seconds it takes for tip to fade in and/or out).
//! are in positionSelf function? (to avoid infinite recursion issues)
bool d_inPositionSelf;
private:
/*************************************************************************
Static Properties for this class
*************************************************************************/
static TooltipProperties::HoverTime d_hoverTimeProperty;
static TooltipProperties::DisplayTime d_displayTimeProperty;
static TooltipProperties::FadeTime d_fadeTimeProperty;
/*************************************************************************
Private methods
*************************************************************************/
void addTooltipProperties(void);
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUITooltip_h_
|