LibreOffice
LibreOffice 6.0 SDK C/C++ API Reference
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
salhelper::Timer Class Referenceabstract

Interface for the Timer and handling the event. More...

#include <timer.hxx>

Inheritance diagram for salhelper::Timer:
salhelper::SimpleReferenceObject

Public Member Functions

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

Protected Member Functions

virtual ~Timer () SAL_OVERRIDE
 Destructor. More...
 
virtual void onShot ()=0
 What should be done when the 'timer fires'. More...
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 

Protected Attributes

TTimeValue m_aTimeOut
 holds (initial) exparation time of this timer. More...
 
TTimeValue m_aExpired
 holds the time of exparation of this timer. More...
 
TTimeValue m_aRepeatDelta
 holds the time interveal of successive expirations. More...
 
Timerm_pNext
 Pointer to the next timer (to fire). More...
 

Friends

class TimerManager
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 see general class documentation More...
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 see general class documentation More...
 
static void operator delete (void *pPtr)
 see general class documentation More...
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 see general class documentation More...
 

Detailed Description

Interface for the Timer and handling the event.

Constructor & Destructor Documentation

salhelper::Timer::Timer ( )

Constructor.

salhelper::Timer::Timer ( const TTimeValue Time)

Constructor.

salhelper::Timer::Timer ( const TTimeValue Time,
const TTimeValue RepeatTime 
)

Constructor.

virtual salhelper::Timer::~Timer ( )
protectedvirtual

Destructor.

Member Function Documentation

void salhelper::Timer::addTime ( const TTimeValue Time)

Adds Time to the 'fire time'.

sal_Bool salhelper::Timer::expiresBefore ( const Timer pTimer) const

Does pTimer expires before us?

TTimeValue salhelper::Timer::getRemainingTime ( ) const

Returns the remaining time before timer expiration relative to now.

sal_Bool salhelper::Timer::isExpired ( ) const

Is the timer expired?

sal_Bool salhelper::Timer::isTicking ( ) const

Returns sal_True if timer is running.

virtual void salhelper::Timer::onShot ( )
protectedpure virtual

What should be done when the 'timer fires'.

void salhelper::Timer::setAbsoluteTime ( const TTimeValue Time)

Set the absolute time when the timer should fire.

void salhelper::Timer::setRemainingTime ( const TTimeValue Remaining)

Set the time to fire to 'now' + Remaining.

void salhelper::Timer::setRemainingTime ( const TTimeValue Remaining,
const TTimeValue Repeat 
)

Set the time to fire to 'now' + Remaining with repeat interveal Repeat.

void salhelper::Timer::start ( )

Start timer.

void salhelper::Timer::stop ( )

Abort timer prematurely.

Friends And Related Function Documentation

friend class TimerManager
friend

Member Data Documentation

TTimeValue salhelper::Timer::m_aExpired
protected

holds the time of exparation of this timer.

TTimeValue salhelper::Timer::m_aRepeatDelta
protected

holds the time interveal of successive expirations.

TTimeValue salhelper::Timer::m_aTimeOut
protected

holds (initial) exparation time of this timer.

Timer* salhelper::Timer::m_pNext
protected

Pointer to the next timer (to fire).


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