CTooltipSupport Class Reference

Generic Tooltip Support class. More...

Inheritance diagram for CTooltipSupport:

Public Member Functions
	CTooltipSupport (CFrame *frame, uint32_t delay=1000)
void	onMouseEntered (CView *view)
void	onMouseExited (CView *view)
void	onMouseMoved (const CPoint &where)
void	onMouseDown (const CPoint &where)
void	hideTooltip ()
CBaseObject *	newCopy () const override
Public Member Functions inherited from CBaseObject
	CBaseObject ()=default
	~CBaseObject () noexceptoverride=default
	CBaseObject (const CBaseObject &)
CBaseObject &	operator= (const CBaseObject &)
virtual CMessageResult	notify ([[maybe_unused]] CBaseObject *sender,[[maybe_unused]] IdStringPtr message)
Public Member Functions inherited from ReferenceCounted< T >
	ReferenceCounted ()=default
virtual	~ReferenceCounted () noexcept=default
	ReferenceCounted (const ReferenceCounted &)
ReferenceCounted &	operator= (const ReferenceCounted &)
void	forget () override
	decrease refcount and delete object if refcount == 0
void	remember () override
	increase refcount
virtual int32_t	getNbReference () const
	get refcount

Protected Types
enum	{   kHidden, kVisible, kHiding, kShowing,   kForceVisible }

Protected Member Functions
	~CTooltipSupport () noexceptoverride
bool	showTooltip ()
CMessageResult	notify (CBaseObject *sender, IdStringPtr msg) override

Protected Attributes
SharedPointer< CVSTGUITimer >	timer
CFrame *	frame
SharedPointer< CView >	currentView
uint32_t	delay
int32_t	state
CPoint	lastMouseMove

Detailed Description

Generic Tooltip Support class.

A generic way to add tooltip support to VSTGUI.

Example

Adding a tooltip to a view

UTF8StringPtr tooltipText = "This is a tooltip";
view->setAttribute (kCViewTooltipAttribute, strlen (tooltipText)+1, tooltipText);

Adding CTooltipSupport is done via VSTGUI::CFrame::enableTooltips (true)

Member Enumeration Documentation

anonymous enum

protected

Enumerator
kHidden
kVisible
kHiding
kShowing
kForceVisible

Constructor & Destructor Documentation

CTooltipSupport	(	CFrame *	frame,
		uint32_t	delay = 1000
	)

Parameters

frame	CFrame object
delay	tooltip delay time in milliseconds

~CTooltipSupport ( )

overrideprotectednoexcept

Member Function Documentation

void hideTooltip

(

)

CBaseObject* newCopy ( ) const

inlineoverride

CMessageResult notify ( CBaseObject *  sender, IdStringPtr  msg  )

overrideprotected

void onMouseDown

(

const CPoint &

where

)

void onMouseEntered

(

CView *

view

)

void onMouseExited

(

CView *

view

)

void onMouseMoved

(

const CPoint &

where

)

bool showTooltip ( )

protected

Member Data Documentation

SharedPointer<CView> currentView

protected

uint32_t delay

protected

CFrame* frame

protected

CPoint lastMouseMove

protected

int32_t state

protected

SharedPointer<CVSTGUITimer> timer

protected

---

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

• ctooltipsupport.h
• ctooltipsupport.cpp