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

A timer class, which posts timer messages to CBaseObjects or calls a lambda function (c++11 only). More...

+ Inheritance diagram for CVSTGUITimer:

Public Member Functions

 CVSTGUITimer (CBaseObject *timerObject, uint32_t fireTime=100, bool doStart=false)
 
virtual bool start ()
 starts the timer More...
 
virtual bool stop ()
 stops the timer, returns whether timer was running or not More...
 
virtual bool setFireTime (uint32_t newFireTime)
 in milliseconds More...
 
uint32_t getFireTime () const
 in milliseconds More...
 
virtual bool isTypeOf (IdStringPtr s) const
 
virtual CBaseObjectnewCopy () const
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()
 
virtual ~CBaseObject ()
 
virtual void beforeDelete ()
 
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...
 
virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)
 

Static Public Attributes

static IdStringPtr kMsgTimer = "timer fired"
 message string posted to CBaseObject's notify method More...
 

Protected Member Functions

 ~CVSTGUITimer ()
 
void fire ()
 

Protected Attributes

uint32_t fireTime
 
CBaseObjecttimerObject
 
SharedPointer< IPlatformTimer > platformTimer
 

Detailed Description

A timer class, which posts timer messages to CBaseObjects or calls a lambda function (c++11 only).

Constructor & Destructor Documentation

CVSTGUITimer ( CBaseObject timerObject,
uint32_t  fireTime = 100,
bool  doStart = false 
)
~CVSTGUITimer ( )
protected

Member Function Documentation

void fire ( )
protected
uint32_t getFireTime ( ) const
inline

in milliseconds

virtual bool isTypeOf ( IdStringPtr  s) const
inlinevirtual
virtual CBaseObject* newCopy ( ) const
inlinevirtual
bool setFireTime ( uint32_t  newFireTime)
virtual

in milliseconds

bool start ( )
virtual

starts the timer

bool stop ( )
virtual

stops the timer, returns whether timer was running or not

Member Data Documentation

uint32_t fireTime
protected
IdStringPtr kMsgTimer = "timer fired"
static

message string posted to CBaseObject's notify method

SharedPointer<IPlatformTimer> platformTimer
protected
CBaseObject* timerObject
protected

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