ASPiK SDK
VSTGUI::CTooltipSupport Class Reference

Generic Tooltip Support class. More...

#include <ctooltipsupport.h>

Inheritance diagram for VSTGUI::CTooltipSupport:
VSTGUI::CBaseObject VSTGUI::ReferenceCounted< T > VSTGUI::IReference

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 ()
 
- Public Member Functions inherited from VSTGUI::CBaseObject
 CBaseObject (const CBaseObject &o)
 
CBaseObjectoperator= (const CBaseObject &obj)
 
- Public Member Functions inherited from VSTGUI::ReferenceCounted< T >
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (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
 
virtual void beforeDelete ()
 

Protected Types

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

Protected Member Functions

bool showTooltip ()
 
CMessageResult notify (CBaseObject *sender, IdStringPtr msg) override
 

Protected Attributes

SharedPointer< CVSTGUITimertimer
 
CFrameframe
 
SharedPointer< CViewcurrentView
 
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)

Constructor & Destructor Documentation

◆ CTooltipSupport()

VSTGUI::CTooltipSupport::CTooltipSupport ( CFrame frame,
uint32_t  delay = 1000 
)
Parameters
frameCFrame object
delaytooltip delay time in milliseconds

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