Ars::XToolTip Class Reference

#include <arstooltip.h>

Inheritance diagram for Ars::XToolTip:

[legend]Collaboration diagram for Ars::XToolTip:

[legend]

Public Member Functions
	XToolTip (Window *pToolWindow, const int aNrMSec=1000)
virtual	~XToolTip (void)
	Standard destructor.
virtual const bool	SetupWindow (const Message &msg)
	Deregister the setup_window message.
virtual void	SetWndText (const std::string &sText)
void	ShowTip (const XPoint &DrawPoint)
void	HideTip (void)
	Hides the tooltip.
virtual const bool	SetParent (Window *pNewParent)
virtual Window *	GetParent (void) const
Protected Member Functions
virtual const bool	evMouseMove (const MouseMessage &msg)
virtual const bool	evTimer (const CtrlMessage &msg)
Private Attributes
Timer *	timer
	A pointer to a timer so that tooltips only appear after the mouse has been motionless for a bit.
XPoint	lastMousePosition
	The last mouse position.
Window *	target
const int	nrMSec

---

Detailed Description

A tooltip that can pop up over windows They are attached to an existing CWindow object, and watch for the mouse cursor to stop over the object. When the cursor stops, the tooltip makes itself visible.

Definition at line 9 of file arstooltip.h.

---

Constructor & Destructor Documentation

Ars::XToolTip::XToolTip (  Window *  pToolWindow, const int  aNrMSec = 1000 )

Construct a new label Parameters: pToolWindow  A pointer to the CWindow based object the tooltip is for Definition at line 5 of file arstooltip.cpp. References SetParent(), and timer. : nrMSec( aNrMSec ) { SetParent( pToolWindow ); timer = new Timer( this ); }

Ars::XToolTip::~XToolTip (  void   )  [virtual]

Standard destructor. Definition at line 13 of file arstooltip.cpp. References timer. { if( timer ) delete timer; timer = 0; }

---

Member Function Documentation

const bool Ars::XToolTip::evMouseMove (  const MouseMessage &  msg  )  [protected, virtual]

Reimplemented from Ars::XLabel. Definition at line 70 of file arstooltip.cpp. References Ars::Window::FindWindow(), Ars::Window::GetParent(), GetParent(), HideTip(), Ars::Window::IsVisible(), lastMousePosition, nrMSec, Ars::MouseMessage::Point, Ars::Timer::StartTimer(), Ars::Timer::StopTimer(), and timer. { if( GetParent()->GetParent() ) { lastMousePosition = msg.Point; timer->StopTimer(); if( IsVisible() ) HideTip(); if( GetParent()->FindWindow( &msg.Point ) == GetParent() ) timer->StartTimer( nrMSec ); } return XLabel::evMouseMove( msg ); }

const bool Ars::XToolTip::evTimer (  const CtrlMessage &  msg  )  [protected, virtual]

Reimplemented from Ars::MessageClient. Definition at line 58 of file arstooltip.cpp. References Ars::Message::Destination(), lastMousePosition, and ShowTip(). { bool ans = XLabel::evTimer( msg ); if( msg.Destination() == this ) { ShowTip( lastMousePosition + XPoint( -6 , 18 ) ); ans = true; } return ans; }

virtual Window* Ars::XToolTip::GetParent (  void   )  const [inline, virtual]

Reimplemented from Ars::Window. Definition at line 41 of file arstooltip.h. References target. Referenced by evMouseMove(), and ShowTip(). { return target; }

void Ars::XToolTip::HideTip (  void   )

Hides the tooltip. Definition at line 52 of file arstooltip.cpp. References Ars::Window::HideWindow(), and Ars::Window::UpdateWindow(). Referenced by evMouseMove(), and SetupWindow(). { HideWindow(); UpdateWindow( true ); }

virtual const bool Ars::XToolTip::SetParent (  Window *  pNewParent  )  [inline, virtual]

Transfer the ownership of the window, so it has a new parent Parameters: pNewParent  A pointer to a window that should be set as the parent Reimplemented from Ars::Window. Definition at line 40 of file arstooltip.h. References target. Referenced by XToolTip(). { target = pNewParent; return true; }

const bool Ars::XToolTip::SetupWindow (  const Message &  msg  )  [virtual]

Deregister the setup_window message. Reimplemented from Ars::XLabel. Definition at line 20 of file arstooltip.cpp. References HideTip(). Referenced by Ars::Window::SetupWindow(). { XLabel::SetupWindow( msg ); MessageServer::Instance().RegisterMessageClient(this, Message::MOUSE_MOVE); MessageServer::Instance().RegisterMessageClient(this, Message::CTRL_TIMER); HideTip(); return true; }

void Ars::XToolTip::SetWndText (  const std::string &  sText  )  [virtual]

Set the WindowText of the control Parameters: sText  The text to assign to the window Reimplemented from Ars::XLabel. Definition at line 32 of file arstooltip.cpp. References Ars::Window::clientRect, Ars::HPaint::GetFontSize(), Ars::HPaint::GetTextSize(), Ars::Window::GetWindowText(), Ars::XPoint::x, and Ars::XPoint::y. { XLabel::SetWndText( sText ); XPoint p = GetTextSize( GetWindowText() ); clientRect.w = w = p.x + 4; clientRect.h = h = p.y + GetFontSize(); }

void Ars::XToolTip::ShowTip (  const XPoint &  DrawPoint  )

Displays the tooltip Parameters: DrawPoint  Where to poisition the top left corner of the tooltip Definition at line 40 of file arstooltip.cpp. References GetParent(), Ars::Window::IsVisible(), Ars::Window::ShowWindow(), Ars::Window::UpdateWindow(), Ars::XPoint::x, and Ars::XPoint::y. Referenced by evTimer(). { if( GetParent()->IsVisible() ) { x = p.x; y = p.y; ShowWindow(); UpdateWindow( true ); } }

---

Field Documentation

XPoint Ars::XToolTip::lastMousePosition [private]

The last mouse position. Definition at line 13 of file arstooltip.h. Referenced by evMouseMove(), and evTimer().

const int Ars::XToolTip::nrMSec [private]

Definition at line 15 of file arstooltip.h. Referenced by evMouseMove().

Window* Ars::XToolTip::target [private]

Definition at line 14 of file arstooltip.h. Referenced by GetParent(), and SetParent().

Timer* Ars::XToolTip::timer [private]

A pointer to a timer so that tooltips only appear after the mouse has been motionless for a bit. Definition at line 12 of file arstooltip.h. Referenced by evMouseMove(), XToolTip(), and ~XToolTip().

---

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

• arstooltip.h
• arstooltip.cpp

---