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

#include <slide.hxx>

Public Member Functions

virtual void prefetch ()=0
 Prepares to show slide. More...
 
virtual void show (bool bSlideBackgroundPainted)=0
 Shows the slide on all registered views. More...
 
virtual void hide ()=0
 Force-ends the slide. More...
 
virtual basegfx::B2ISize getSlideSize () const =0
 Query the size of this slide in user coordinates. More...
 
virtual css::uno::Reference< css::drawing::XDrawPage > getXDrawPage () const =0
 Gets the underlying API page. More...
 
virtual css::uno::Reference< css::animations::XAnimationNode > getXAnimationNode () const =0
 Gets the animation node. More...
 
virtual PolyPolygonVector getPolygons ()=0
 Gets the slide Polygons. More...
 
virtual void drawPolygons () const =0
 Draw the slide Polygons. More...
 
virtual bool isPaintOverlayActive () const =0
 Check if paint overlay is already active. More...
 
virtual void enablePaintOverlay ()=0
 
virtual void update_settings (bool bUserPaintEnabled, RGBColor const &aUserPaintColor, double dUserPaintStrokeWidth)=0
 
virtual SlideBitmapSharedPtr getCurrentSlideBitmap (const UnoViewSharedPtr &rView) const =0
 Request bitmap for current slide appearance. More...
 

Protected Member Functions

 ~Slide ()
 

Detailed Description

Definition at line 54 of file slide.hxx.

Constructor & Destructor Documentation

◆ ~Slide()

slideshow::internal::Slide::~Slide ( )
inlineprotected

Definition at line 145 of file slide.hxx.

Member Function Documentation

◆ drawPolygons()

virtual void slideshow::internal::Slide::drawPolygons ( ) const
pure virtual

Draw the slide Polygons.

◆ enablePaintOverlay()

virtual void slideshow::internal::Slide::enablePaintOverlay ( )
pure virtual

◆ getCurrentSlideBitmap()

virtual SlideBitmapSharedPtr slideshow::internal::Slide::getCurrentSlideBitmap ( const UnoViewSharedPtr rView) const
pure virtual

Request bitmap for current slide appearance.

The bitmap returned by this method depends on the current state of the slide and the contained animations. A newly generated slide will return the initial slide content here (e.g. with all 'appear' effect shapes invisible), a slide whose effects are currently running will return a bitmap corresponding to the current position on the animation timeline, and a slide whose effects have all been run will generate a bitmap with the final slide appearance (e.g. with all 'hide' effect shapes invisible).

Parameters
rViewView to retrieve bitmap for (note that the bitmap will have device-pixel equivalence to the content that would have been rendered onto the given view). Note that the view must have been added to this slide before via viewAdded().

Referenced by slideshow::internal::PaintOverlayHandler::handleMouseDragged(), and slideshow::internal::PaintOverlayHandler::repaintWithoutPolygons().

◆ getPolygons()

virtual PolyPolygonVector slideshow::internal::Slide::getPolygons ( )
pure virtual

Gets the slide Polygons.

◆ getSlideSize()

virtual basegfx::B2ISize slideshow::internal::Slide::getSlideSize ( ) const
pure virtual

Query the size of this slide in user coordinates.

This value is retrieved from the XDrawPage properties.

◆ getXAnimationNode()

virtual css::uno::Reference< css::animations::XAnimationNode > slideshow::internal::Slide::getXAnimationNode ( ) const
pure virtual

Gets the animation node.

◆ getXDrawPage()

virtual css::uno::Reference< css::drawing::XDrawPage > slideshow::internal::Slide::getXDrawPage ( ) const
pure virtual

Gets the underlying API page.

◆ hide()

virtual void slideshow::internal::Slide::hide ( )
pure virtual

Force-ends the slide.

After this call, the slide has stopped all animations, and ceased rendering/visualization on all views.

◆ isPaintOverlayActive()

virtual bool slideshow::internal::Slide::isPaintOverlayActive ( ) const
pure virtual

Check if paint overlay is already active.

◆ prefetch()

virtual void slideshow::internal::Slide::prefetch ( )
pure virtual

Prepares to show slide.

Call this method to reduce the timeout show(), and getInitialSlideBitmap() need to complete. If prefetch() is not called explicitly, the named methods will call it implicitly.

◆ show()

virtual void slideshow::internal::Slide::show ( bool  bSlideBackgroundPainted)
pure virtual

Shows the slide on all registered views.

After this call, the slide will render itself to the views, and start its animations.

Parameters
bSlideBackgroundPaintedWhen true, the initial slide content on the background layer is already rendered (e.g. from a previous slide transition). When false, Slide renders initial content of slide.

◆ update_settings()

virtual void slideshow::internal::Slide::update_settings ( bool  bUserPaintEnabled,
RGBColor const &  aUserPaintColor,
double  dUserPaintStrokeWidth 
)
pure virtual

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