CVSTGUITimer Class Reference

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

#include <cvstguitimer.h>

Inheritance diagram for CVSTGUITimer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CVSTGUITimer (CBaseObject *timerObject, int fireTime=100)
virtual ~CVSTGUITimer ()
virtual bool start ()
 starts the timer
virtual bool stop ()
 stops the timer, returns wheather timer was running or not
virtual bool setFireTime (int newFireTime)
 in milliseconds
int getFireTime () const
 in milliseconds
Reference Counting Methods



virtual void forget ()
 decrease refcount and delete object if refcount == 0
virtual void remember ()
 increase refcount
long getNbReference () const
 get refcount
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

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 (  )  [inline, virtual, inherited]

decrease refcount and delete object if refcount == 0

Reimplemented in CDrawContext.

int getFireTime (  )  const [inline]

in milliseconds

long getNbReference (  )  const [inline, inherited]

get refcount

virtual CMessageResult notify ( CBaseObject sender,
const char *  message 
) [inline, virtual, inherited]
virtual void remember (  )  [inline, virtual, inherited]

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on Fri Nov 22 11:09:19 2013 for VSTGUI by  doxygen 1.6.1