ToolTipListener Class Reference

#include <tooltiplistener.h>

Inheritance diagram for ToolTipListener:

Public Member Functions
	ToolTipListener ()
void	setToolTip (const std::string &str)
std::string	getToolTip () const
void	mouseMoved (MouseEvent &event)
void	mouseExited (MouseEvent &event)
Public Member Functions inherited from MouseListener
virtual	~MouseListener ()
virtual void	mouseEntered (MouseEvent &event)
virtual void	mousePressed (MouseEvent &event)
virtual void	mouseReleased (MouseEvent &event)
virtual void	mouseClicked (MouseEvent &event)
virtual void	mouseWheelMovedUp (MouseEvent &event)
virtual void	mouseWheelMovedDown (MouseEvent &event)
virtual void	mouseDragged (MouseEvent &event)

Protected Attributes
std::string	mToolTip

Additional Inherited Members
Protected Member Functions inherited from MouseListener
	MouseListener ()

Detailed Description

Definition at line 31 of file tooltiplistener.h.

Constructor & Destructor Documentation

ToolTipListener()

ToolTipListener::ToolTipListener

(

)

Definition at line 31 of file tooltiplistener.cpp.

                                 :
    MouseListener(),
    mToolTip()
{
}

Member Function Documentation

getToolTip()

std::string ToolTipListener::getToolTip ( ) const

inline

Definition at line 41 of file tooltiplistener.h.

        { return mToolTip; }

References mToolTip.

mouseExited()

void ToolTipListener::mouseExited ( MouseEvent &  event )

virtual

Called when the mouse has exited the widget area.

Parameters

event

Describes the event.

Reimplemented from MouseListener.

Definition at line 58 of file tooltiplistener.cpp.

{
    if (mToolTip.empty() || (textBoxPopup == nullptr))
        return;
    textBoxPopup->hide();
}

References Popup::hide(), mToolTip, and textBoxPopup.

Referenced by CheckBox::mouseExited().

mouseMoved()

void ToolTipListener::mouseMoved ( MouseEvent &  event )

virtual

Called when the mouse has moved in the widget area and no mouse button has been pressed (i.e no widget is being dragged).

Parameters

event

Describes the event.

Reimplemented from MouseListener.

Definition at line 37 of file tooltiplistener.cpp.

{
    if (mToolTip.empty() || (textBoxPopup == nullptr))
        return;
 
    int x = 0;
    int y = 0;
    if (viewport != nullptr)
    {
        x = viewport->mMouseX;
        y = viewport->mMouseY;
    }
    else
    {
        Gui::getMouseState(x, y);
    }
 
    event.consume();
    textBoxPopup->show(x, y, mToolTip);
}

References Gui::getMouseState(), Viewport::mMouseX, Viewport::mMouseY, mToolTip, TextBoxPopup::show(), textBoxPopup, viewport, x, and y.

setToolTip()

void ToolTipListener::setToolTip ( const std::string &  str )

inline

Definition at line 38 of file tooltiplistener.h.

        { mToolTip = str; }

References mToolTip.

Referenced by SetupItemCheckBox::createControls(), SetupItemTextField::createControls(), SetupItemIntTextField::createControls(), SetupItemLabel::createControls(), SetupItemDropDown::createControls(), SetupItemDropDownStr::createControls(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), SetupItemSliderList::createControls(), SetupQuickItem::createControls(), and SetupActionDropDown::createControls().

Field Documentation

mToolTip

std::string ToolTipListener::mToolTip

protected

Definition at line 49 of file tooltiplistener.h.

Referenced by getToolTip(), mouseExited(), mouseMoved(), and setToolTip().

---

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

• src/listeners/tooltiplistener.h (986a3bf)
• src/listeners/tooltiplistener.cpp (986a3bf)