PixelLightAPI  .
Protected Member Functions | Protected Attributes
PLGui::ModTooltip Class Reference

Modifier that displays a tooltip for a widget. More...

#include <ModTooltip.h>

Inheritance diagram for PLGui::ModTooltip:
Inheritance graph
[legend]

List of all members.

Protected Member Functions

virtual void OnShowTooltip ()
 Called when a tooltip shall be displayed.
virtual void OnAttach (Widget &cWidget) override
 Called when the modifier is attached to a widget.
virtual void OnDetach (Widget &cWidget) override
 Called when the modifier is detached from a widget.
virtual void OnMouseHover () override
 Called when the mouse hovers over the widget.

Protected Attributes

PLCore::String m_sTooltip

Detailed Description

Modifier that displays a tooltip for a widget.


Member Function Documentation

virtual void PLGui::ModTooltip::OnShowTooltip ( ) [protected, virtual]

Called when a tooltip shall be displayed.

virtual void PLGui::ModTooltip::OnAttach ( Widget cWidget) [override, protected, virtual]

Called when the modifier is attached to a widget.

Parameters:
[in]cWidgetWidget to which the modifier is attached

Reimplemented from PLGui::Modifier.

virtual void PLGui::ModTooltip::OnDetach ( Widget cWidget) [override, protected, virtual]

Called when the modifier is detached from a widget.

Parameters:
[in]cWidgetWidget from which the modifier is detached

Reimplemented from PLGui::Modifier.

virtual void PLGui::ModTooltip::OnMouseHover ( ) [override, protected, virtual]

Called when the mouse hovers over the widget.

Reimplemented from PLGui::WidgetFunctions.


Member Data Documentation

Tooltip text


The documentation for this class was generated from the following file:


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:18
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported