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

Represents a shape containing playable content rendered by external engine (e.g. More...

#include <iexternalmediashapebase.hxx>

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

Public Member Functions

virtual void play ()=0
 Notify the Shape that it should start with playback. More...
 
virtual void stop ()=0
 Notify the Shape that it should stop playback. More...
 
virtual void pause ()=0
 Notify the Shape that it should pause playback. More...
 
virtual bool isPlaying () const =0
 Query whether the media is currently playing. More...
 
virtual void setMediaTime (double fTime)=0
 Set media time in seconds. More...
 
virtual void setLooping (bool)
 
- Public Member Functions inherited from slideshow::internal::Shape
 Shape ()
 
virtual ~Shape ()
 
 Shape (const Shape &)=delete
 
Shapeoperator= (const Shape &)=delete
 
virtual css::uno::Reference< css::drawing::XShape > getXShape () const =0
 Get the associated XShape of this shape. More...
 
virtual void addViewLayer (const ViewLayerSharedPtr &rNewLayer, bool bRedrawLayer)=0
 Add a new view layer. More...
 
virtual bool removeViewLayer (const ViewLayerSharedPtr &rNewLayer)=0
 Withdraw the shape from a view layer. More...
 
virtual void clearAllViewLayers ()=0
 Withdraw all view layers at once. More...
 
virtual bool update () const =0
 Update the shape. More...
 
virtual bool render () const =0
 Render the shape. More...
 
virtual bool isContentChanged () const =0
 Query whether shape content changed. More...
 
virtual ::basegfx::B2DRectangle getBounds () const =0
 Get the current shape position and size. More...
 
virtual ::basegfx::B2DRectangle getDomBounds () const =0
 Get the DOM position and size of the shape. More...
 
virtual ::basegfx::B2DRectangle getUpdateArea () const =0
 Get the current shape update area. More...
 
virtual bool isVisible () const =0
 Query whether the shape is visible at all. More...
 
virtual double getPriority () const =0
 Get the shape priority. More...
 
virtual bool isBackgroundDetached () const =0
 Query whether the Shape is currently detached from the background. More...
 
virtual bool isForeground () const
 Check whether the shape belongs to the foreground. More...
 
virtual void setIsForeground (const bool bIsForeground)
 Set the flag that holds whether the shape is in the foreground or not. More...
 

Detailed Description

Represents a shape containing playable content rendered by external engine (e.g.

media or applet).

This interface adds media handling methods to a shape. It allows starting/stopping and pausing playback.

Definition at line 36 of file iexternalmediashapebase.hxx.

Member Function Documentation

◆ isPlaying()

virtual bool slideshow::internal::IExternalMediaShapeBase::isPlaying ( ) const
pure virtual

Query whether the media is currently playing.

Implemented in slideshow::internal::ExternalShapeBase.

◆ pause()

virtual void slideshow::internal::IExternalMediaShapeBase::pause ( )
pure virtual

Notify the Shape that it should pause playback.

This method stops playback on all registered views. The media stays visible (for videos)

Implemented in slideshow::internal::ExternalShapeBase.

◆ play()

virtual void slideshow::internal::IExternalMediaShapeBase::play ( )
pure virtual

Notify the Shape that it should start with playback.

This method enters playback mode on all registered views. It makes the media initially visible (for videos).

Implemented in slideshow::internal::ExternalShapeBase.

◆ setLooping()

virtual void slideshow::internal::IExternalMediaShapeBase::setLooping ( bool  )
inlinevirtual

Reimplemented in slideshow::internal::ExternalShapeBase.

Definition at line 76 of file iexternalmediashapebase.hxx.

◆ setMediaTime()

virtual void slideshow::internal::IExternalMediaShapeBase::setMediaTime ( double  fTime)
pure virtual

Set media time in seconds.

Parameters
fTimeTime in seconds of the media time line, that should now be presented

Implemented in slideshow::internal::ExternalShapeBase.

◆ stop()

virtual void slideshow::internal::IExternalMediaShapeBase::stop ( )
pure virtual

Notify the Shape that it should stop playback.

This method leaves playback mode on all registered views. The media is then rewound to the start, and removed from screen (for videos)

Implemented in slideshow::internal::ExternalShapeBase.


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