- Your Widget Set For OpenGL
Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Related Pages

ufo::UTimerEvent Class Reference

A very simplistic time out event. More...

#include <utimerevent.hpp>

Inheritance diagram for ufo::UTimerEvent:

ufo::UEvent ufo::UObject ufo::UCollectable List of all members.

Public Member Functions

 UTimerEvent (uint32_t timeOut, const USlot0 &slot)
uint32_t getTimeOut ()
void startTimer ()
bool isReadyToRun ()
void run ()

Detailed Description

A very simplistic time out event.

If sent to the event queue, it is guaranteed that the call back is not executed before the given time has elapsed. It is executed in the event dispatch "thread". But be careful: There is absolutely no guarantee when the call back is executed.

Author:
Johannes Schmidt


Constructor & Destructor Documentation

ufo::UTimerEvent::UTimerEvent uint32_t  timeOut,
const USlot0 &  slot
 

Constructor.

Parameters:
slot The slot to be executed
timeOut The amount of milli seconds which should at least elapse before the slot is executed.


Member Function Documentation

bool ufo::UTimerEvent::isReadyToRun  ) 
 

Returns true if the time out has elapsed.

void ufo::UTimerEvent::run  ) 
 

Executes the slot.

void ufo::UTimerEvent::startTimer  ) 
 

Sets the start time used as reference time for the time out. This is automatically executed by the display object.


The documentation for this class was generated from the following file:
The libUFO Project - written by Johannes Schmidt