VSTGUI  4.2
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
CTooltipSupport Class Reference

Generic Tooltip Support class. More...

+ Inheritance diagram for CTooltipSupport:
+ Collaboration diagram for CTooltipSupport:

Public Member Functions

 CTooltipSupport (CFrame *frame, int32_t delay=1000)
 
void onMouseEntered (CView *view)
 
void onMouseExited (CView *view)
 
void onMouseMoved (const CPoint &where)
 
void onMouseDown (const CPoint &where)
 
void hideTooltip ()
 
virtual bool isTypeOf (IdStringPtr s) const
 
virtual CBaseObjectnewCopy () const
 
Reference Counting Methods
virtual void forget ()
 decrease refcount and delete object if refcount == 0 More...
 
virtual void remember ()
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 

Protected Types

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

Protected Member Functions

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

Protected Attributes

CVSTGUITimertimer
 
CFrameframe
 
SharedPointer< CViewcurrentView
 
int32_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,
int32_t  delay = 1000 
)
Parameters
frameCFrame object
delaytooltip delay time in milliseconds
~CTooltipSupport ( )
protected

+ Here is the call graph for this function:

Member Function Documentation

virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

virtual int32_t getNbReference ( ) const
inlinevirtualinherited

get refcount

void hideTooltip ( )

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual bool isTypeOf ( IdStringPtr  s) const
inlinevirtual
virtual CBaseObject* newCopy ( ) const
inlinevirtual
CMessageResult notify ( CBaseObject sender,
IdStringPtr  msg 
)
protectedvirtual

Reimplemented from CBaseObject.

+ Here is the call graph for this function:

void onMouseDown ( const CPoint where)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void onMouseEntered ( CView view)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void onMouseExited ( CView view)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void onMouseMoved ( const CPoint where)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

virtual void remember ( )
inlinevirtualinherited

increase refcount

+ Here is the caller graph for this function:

bool showTooltip ( )
protected

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

SharedPointer<CView> currentView
protected
int32_t delay
protected
CFrame* frame
protected
CPoint lastMouseMove
protected
int32_t state
protected
CVSTGUITimer* timer
protected

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