VSTGUI  3.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
CVSTGUITimer Class Reference

A timer class, which posts timer messages to CBaseObjects. More...

#include <cvstguitimer.h>

+ Inheritance diagram for CVSTGUITimer:

Public Member Functions

 CVSTGUITimer (CBaseObject *timerObject, int fireTime=100)
 
virtual ~CVSTGUITimer ()
 
virtual bool start ()
 starts the timer More...
 
virtual bool stop ()
 stops the timer, returns wheather timer was running or not More...
 
virtual bool setFireTime (int newFireTime)
 in milliseconds More...
 
int getFireTime () const
 in milliseconds More...
 
Reference Counting Methods
virtual void forget ()
 decrease refcount and delete object if refcount == 0 More...
 
virtual void remember ()
 increase refcount More...
 
long getNbReference () const
 get refcount More...
 
Message Methods
virtual CMessageResult notify (CBaseObject *sender, const char *message)
 

Static Public Attributes

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

Protected Attributes

int fireTime
 
CBaseObjecttimerObject
 
void * platformTimer
 

Detailed Description

A timer class, which posts timer messages to CBaseObjects.

Constructor & Destructor Documentation

CVSTGUITimer ( CBaseObject timerObject,
int  fireTime = 100 
)
~CVSTGUITimer ( )
virtual

Member Function Documentation

virtual void forget ( )
inlinevirtualinherited

decrease refcount and delete object if refcount == 0

Reimplemented in CDrawContext.

int getFireTime ( ) const
inline

in milliseconds

long getNbReference ( ) const
inlineinherited

get refcount

virtual CMessageResult notify ( CBaseObject sender,
const char *  message 
)
inlinevirtualinherited
virtual void remember ( )
inlinevirtualinherited

increase refcount

bool setFireTime ( int  newFireTime)
virtual

in milliseconds

bool start ( )
virtual

starts the timer

bool stop ( )
virtual

stops the timer, returns wheather timer was running or not

Member Data Documentation

int fireTime
protected
const char * kMsgTimer = "timer fired"
static

message string posted to CBaseObject's notify method

void* platformTimer
protected
CBaseObject* timerObject
protected

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