Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: presentation ::

interface XSlideShowView
Description
View interface to display slideshow presentations on.

This interface provides the necessary methods to enable an XSlideShow interface to display a presentation. The slideshow can be displayed simultaneously on multiple views

Since
OOo 2.4

Methods' Summary
getCanvas Get view canvas. 
clear This method clears the whole view area. The slideshow uses this method to fully erase the view content. Since the slideshow has no notion of view size, this is the only reliable way to wholly clear the view.  
getTransformation Query the current transformation matrix for this view. 
addTransformationChangedListener Add a listener to get notified when the transformation matrix changes. 
removeTransformationChangedListener Revoke a previously registered transformation matrix change listener. 
addPaintListener Add a listener to get notified when this view needs a repaint. 
removePaintListener Revoke a previously registered paint listener. 
addMouseListener Add a mouse listener to the view. 
removeMouseListener Revoke a previously registered mouse listener. 
addMouseMotionListener Add a mouse motion listener to the view. 
removeMouseMotionListener Revoke a previously registered mouse move listener. 
setMouseCursor Change the mouse cursor currently in effect. 
getCanvasArea Get rectangle defining area inside of canvas device which this slideshow view uses.  
Methods' Details
getCanvas
::com::sun::star::rendering::XSpriteCanvas
getCanvas();

Description
Get view canvas.

This method gets the underlying XCanvas to display on this view.

Returns
XSpriteCanvas to display on. Must be valid, and the same object, as long as this view is added to any slide show.
clear
void
clear();

Description
This method clears the whole view area. The slideshow uses this method to fully erase the view content. Since the slideshow has no notion of view size, this is the only reliable way to wholly clear the view.
getTransformation
::com::sun::star::geometry::AffineMatrix2D
getTransformation();

Description
Query the current transformation matrix for this view.

This method returns the transformation matrix of the view. When notified via the transformation change listener, the show will be displayed using the new transformation.

Returns
the view transformation matrix. Note that the slide show itself will paint all slides as one-by-one boxes, one therefore has to at least provide a scaling at this matrix to blow this up to the desired device pixel size (640 times 480, or whatever size the output view has). Furthermore, the aspect ratio of the scaling should match that of the slides (otherwise, the slides will be scaled anisotrophically).
addTransformationChangedListener
void
addTransformationChangedListener( [in] ::com::sun::star::util::XModifyListener  xListener );

Description
Add a listener to get notified when the transformation matrix changes.

This method registers a listener with the view, which will get called everytime the transformation matrix changes.

Parameter xListener
Listener interface to call when the transformation matrix changes.
removeTransformationChangedListener
void
removeTransformationChangedListener( [in] ::com::sun::star::util::XModifyListener  xListener );

Description
Revoke a previously registered transformation matrix change listener.

Parameter xListener
Listener interface to revoke from being called.
addPaintListener
void
addPaintListener( [in] ::com::sun::star::awt::XPaintListener  xListener );

Description
Add a listener to get notified when this view needs a repaint.

This method registers a listener with the view, which will get called everytime the view needs an update of their screen representation.

Parameter xListener
Listener interface to call when the view needs a repaint.
removePaintListener
void
removePaintListener( [in] ::com::sun::star::awt::XPaintListener  xListener );

Description
Revoke a previously registered paint listener.

Parameter xListener
Listener interface to revoke from being called.
addMouseListener
void
addMouseListener( [in] ::com::sun::star::awt::XMouseListener  xListener );

Description
Add a mouse listener to the view.

This method registers a listener with the view, which will get called everytime the mouse is clicked on the view.

Parameter xListener
Listener interface to call when the mouse is clicked on the view.
removeMouseListener
void
removeMouseListener( [in] ::com::sun::star::awt::XMouseListener  xListener );

Description
Revoke a previously registered mouse listener.

Parameter xListener
Listener interface to revoke from being called.
addMouseMotionListener
void
addMouseMotionListener( [in] ::com::sun::star::awt::XMouseMotionListener  xListener );

Description
Add a mouse motion listener to the view.

This method registers a listener with the view, which will get called everytime the mouse is moved on the view.

Parameter xListener
Listener interface to call when the mouse is moved on the view.
removeMouseMotionListener
void
removeMouseMotionListener( [in] ::com::sun::star::awt::XMouseMotionListener  xListener );

Description
Revoke a previously registered mouse move listener.

Parameter xListener
Listener interface to revoke from being called.
setMouseCursor
void
setMouseCursor( [in] short  nPointerShape );

Description
Change the mouse cursor currently in effect.

This method changes the mouse cursor currently in effect, for this view.

Parameter nPointerShape
New mouse cursor shape to display for this view. Must be from the ::com::sun::star::awt::SystemPointer constant group.
getCanvasArea
::com::sun::star::awt::Rectangle
getCanvasArea();

Description
Get rectangle defining area inside of canvas device which this slideshow view uses.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.