LibreOffice Module slideshow (master) 1
Public Types | Public Member Functions | List of all members
slideshow::internal::EnumAnimation Class Referenceabstract

Interface defining an enum animation. More...

#include <enumanimation.hxx>

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

Public Types

typedef sal_Int16 ValueType
 

Public Member Functions

virtual bool operator() (ValueType k)=0
 Set the animation to value k. More...
 
virtual ValueType getUnderlyingValue () const =0
 Request the underlying value for this animation. More...
 
- Public Member Functions inherited from slideshow::internal::Animation
virtual void prefetch ()=0
 Notify that the animation going active soon. More...
 
virtual void start (const AnimatableShapeSharedPtr &rShape, const ShapeAttributeLayerSharedPtr &rAttrLayer)=0
 Notify that the animation is about to begin. More...
 
virtual void end ()=0
 Notify that the animation is about to end. More...
 
- Public Member Functions inherited from slideshow::internal::SharedPtrAble
virtual ~SharedPtrAble ()
 

Detailed Description

Interface defining an enum animation.

This interface is a specialization of the Animation interface, and is used to animate attributes representable by a set of constant values, such as UNO constants, or enums.

Definition at line 36 of file enumanimation.hxx.

Member Typedef Documentation

◆ ValueType

Definition at line 39 of file enumanimation.hxx.

Member Function Documentation

◆ getUnderlyingValue()

virtual ValueType slideshow::internal::EnumAnimation::getUnderlyingValue ( ) const
pure virtual

Request the underlying value for this animation.

This is necessary for pure To or By animations, as the Activity cannot determine a sensible start value otherwise.

Attention: \n Note that you are only permitted to query
for the underlying value, if the animation has actually been started (via start() call).

◆ operator()()

virtual bool slideshow::internal::EnumAnimation::operator() ( ValueType  k)
pure virtual

Set the animation to value k.

Parameters
kCurrent animation value (must be in an attribute-specific permissible range). Overflowing values will be clipped to the permissible range internally.

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