:: salhelper ::

class Timer


Base Classes
salhelper::SimpleReferenceObject (public)
  |  
  +--Timer
Known Derived Classes
None.

virtual abstract interface template
YES YES YES NO
Summary
Interface for the Timer and handling the event
File
timer.hxx

Public Members

Methods


Timer( );
Constructor.

Timer( const TTimeValue & Time );
Constructor.

Timer( const TTimeValue & Time, const TTimeValue & RepeatTime );
Constructor.
void
start( );
Start timer.
void
stop( );
Abort timer prematurely.
sal_Bool
isTicking( ) const;
Returns sal_True if timer is running.
sal_Bool
isExpired( ) const;
Is the timer expired?
sal_Bool
expiresBefore( const Timer * pTimer ) const;
Does pTimer expires before us?
void
setAbsoluteTime( const TTimeValue & Time );
Set the absolute time when the timer should fire.
void
setRemainingTime( const TTimeValue & Remaining );
Set the time to fire to 'now' + Remaining.
void
setRemainingTime( const TTimeValue & Remaining, const TTimeValue & Repeat );
Set the time to fire to 'now' + Remaining with repeat interveal * Repeat.
void
addTime( const TTimeValue & Time );
Adds Time to the 'fire time'.
TTimeValue
getRemainingTime( ) const;
Returns the remaining time before timer expiration relative to now.

Protected Members

Methods

virtual
~Timer( );
Destructor.
virtual void
onShot( ) = 0;
What should be done when the 'timer fires'.

Data

TTimeValue m_aTimeOut; holds (initial) exparation time of this timer.
TTimeValue m_aExpired; holds the time of exparation of this timer.
TTimeValue m_aRepeatDelta; holds the time interveal of successive expirations.
Timer * m_pNext; Pointer to the next timer (to fire).

Private Members

Methods


Timer( const Timer & rTimer );
Copy constructor disabled.
void
operator=( const Timer & rTimer );
Assignment operator disabled.

Top of Page