VSTGUI  4.3
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:
+ Collaboration 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
 
virtual void beforeDelete ()
 
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...
 
Message Methods
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 
)

+ Here is the call graph for this function:

~CVSTGUITimer ( )
protected

+ Here is the call graph for this function:

Member Function Documentation

virtual void beforeDelete ( )
inlinevirtualinherited

Reimplemented in CView.

+ Here is the caller graph for this function:

void fire ( )
protected

+ Here is the call graph for this function:

virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

+ Here is the call graph for this function:

uint32_t getFireTime ( ) const
inline

in milliseconds

virtual int32_t getNbReference ( ) const
inlinevirtualinherited

get refcount

virtual bool isTypeOf ( IdStringPtr  s) const
inlinevirtual
virtual CBaseObject* newCopy ( ) const
inlinevirtual
virtual void remember ( )
inlinevirtualinherited

increase refcount

+ Here is the caller graph for this function:

bool setFireTime ( uint32_t  newFireTime)
virtual

in milliseconds

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool start ( )
virtual

starts the timer

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool stop ( )
virtual

stops the timer, returns whether timer was running or not

+ Here is the caller graph for this function:

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: