slideshow::internal::Activity Class Reference

#include <activity.hxx>

Inheritance diagram for slideshow::internal::Activity:

Collaboration diagram for slideshow::internal::Activity:

Public Member Functions
virtual bool	perform ()=0
	Perform the activity associated with this interface's implementation. More...
virtual double	calcTimeLag () const =0
	Calculates whether the activity lags time. More...
virtual bool	isActive () const =0
	Query whether this activity is still continuing. More...
virtual void	dequeued ()=0
	Notifies the Activity that it has now left the ActivitiesQueue. More...
virtual void	end ()=0
	Forces this activity deactivate and get to its end state (if possible), but does not dispose. More...
Public Member Functions inherited from slideshow::internal::Disposable
virtual	~Disposable ()
virtual void	dispose ()=0
	Dispose all object references. More...
Public Member Functions inherited from slideshow::internal::SharedPtrAble
virtual	~SharedPtrAble ()

Detailed Description

Definition at line 33 of file activity.hxx.

Member Function Documentation

calcTimeLag()

virtual double slideshow::internal::Activity::calcTimeLag ( ) const

pure virtual

Calculates whether the activity lags time.

If this method returns a time lag greater than 0.0, the ActivitiesQueue will adjust the global slideshow time, by subtracting the given amount of lag.

Returns

time lag or 0.0. Value must be greater or equal than zero.

Implemented in slideshow::internal::ActivityBase, slideshow::internal::SimpleContinuousActivityBase, slideshow::internal::SetActivity< AnimationT >, and slideshow::internal::RehearseTimingsActivity.

dequeued()

virtual void slideshow::internal::Activity::dequeued ( )

pure virtual

Notifies the Activity that it has now left the ActivitiesQueue.

Use this method to react on the queue removal event. For animated shapes, this is e.g. used to switch back to the non-sprite presentation mode of the shape.

Implemented in slideshow::internal::ActivityBase, slideshow::internal::SetActivity< AnimationT >, and slideshow::internal::RehearseTimingsActivity.

end()

virtual void slideshow::internal::Activity::end ( )

pure virtual

Forces this activity deactivate and get to its end state (if possible), but does not dispose.

Implemented in slideshow::internal::ActivityBase, slideshow::internal::SetActivity< AnimationT >, and slideshow::internal::RehearseTimingsActivity.

isActive()

virtual bool slideshow::internal::Activity::isActive ( ) const

pure virtual

Query whether this activity is still continuing.

Returns

true, if this activity still continues. Returns false, if activity has ended. It is required that operator() returns false, when isActive() returns false. Furthermore, it is required that the inactive state is persistent; an activity that has become inactive (i.e. isActive() once returned false) must stay in that state eternally.

Implemented in slideshow::internal::ActivityBase, slideshow::internal::SetActivity< AnimationT >, and slideshow::internal::RehearseTimingsActivity.

perform()

virtual bool slideshow::internal::Activity::perform ( )

pure virtual

Perform the activity associated with this interface's implementation.

Returns

true, if activity continues, or false, if activity has ended.

Implemented in slideshow::internal::ActivityBase, slideshow::internal::ContinuousActivityBase, slideshow::internal::ContinuousKeyTimeActivityBase, slideshow::internal::DiscreteActivityBase, slideshow::internal::SimpleContinuousActivityBase, slideshow::internal::SetActivity< AnimationT >, and slideshow::internal::RehearseTimingsActivity.

---

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

• activity.hxx