LibreOffice Module slideshow (master) 1
Public Member Functions | Private Attributes | List of all members
slideshow::internal::Event Class Referenceabstract

Definition of Event interface. More...

#include <event.hxx>

Inheritance diagram for slideshow::internal::Event:
[legend]
Collaboration diagram for slideshow::internal::Event:
[legend]

Public Member Functions

 Event (OUString sDescription)
 
virtual bool fire ()=0
 Execute the event. More...
 
virtual bool isCharged () const =0
 Query whether this event is still charged, i.e. More...
 
virtual double getActivationTime (double nCurrentTime) const =0
 Query the activation time instant this event shall be fired, if it was inserted at instant nCurrentTime into the queue. More...
 
const OUString & GetDescription () const
 
- Public Member Functions inherited from slideshow::internal::Disposable
virtual ~Disposable ()
 
virtual void dispose ()=0
 Dispose all object references. More...
 

Private Attributes

const OUString msDescription
 

Detailed Description

Definition of Event interface.

Definition at line 32 of file event.hxx.

Constructor & Destructor Documentation

◆ Event()

slideshow::internal::Event::Event ( OUString  sDescription)
inline

Definition at line 35 of file event.hxx.

Member Function Documentation

◆ fire()

virtual bool slideshow::internal::Event::fire ( )
pure virtual

◆ getActivationTime()

virtual double slideshow::internal::Event::getActivationTime ( double  nCurrentTime) const
pure virtual

Query the activation time instant this event shall be fired, if it was inserted at instant nCurrentTime into the queue.

Parameters
nCurrentTimeThe time from which the activation time is to be calculated from.
Returns
the time instant in seconds, on which this event is to be fired.

Implemented in slideshow::internal::RehearseTimingsActivity::WakeupEvent, slideshow::internal::Delay, slideshow::internal::DelayFacade, and slideshow::internal::WakeupEvent.

◆ GetDescription()

const OUString & slideshow::internal::Event::GetDescription ( ) const
inline

Definition at line 70 of file event.hxx.

References msDescription.

◆ isCharged()

virtual bool slideshow::internal::Event::isCharged ( ) const
pure virtual

Query whether this event is still charged, i.e.

able to fire.

Inactive events are ignored by the normal event containers (EventQueue, UserEventQueue etc.), and no explicit fire() is called upon them.

Returns
true, if this event has already been fired.

Implemented in slideshow::internal::RehearseTimingsActivity::WakeupEvent, slideshow::internal::Delay, slideshow::internal::DelayFacade, and slideshow::internal::WakeupEvent.

Member Data Documentation

◆ msDescription

const OUString slideshow::internal::Event::msDescription
private

Definition at line 73 of file event.hxx.

Referenced by GetDescription().


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