Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: presentation ::
unpublished | interface XSlideShow |
Usage Restrictions not published Description Slide show interface to perform slide show presentations. This interface provides the necessary methods to run and control a slide show from a given set of XDrawPage slides. The slide show can be displayed simultaneously on multiple targets. Note: To control a running slide show inside a presentation, please use XPresentation2 and XSlideShowController. Since OOo 3.0

Methods' Summary
nextEffect | Trigger the next effect of the slide show.
previousEffect | Undo the last effect in the main sequence of the slide show.
startShapeActivity | Start a shape-intrinsic animation or activity.
stopShapeActivity | Stop a shape-intrinsic animation or activity.
displaySlide | Jump to the given slide.
pause | Change the pause state of the slide show.
getCurrentSlide | Query the currently displayed slide.
registerUserPaintPolygons | Register drawn polygons in presentation mode
setProperty | Change a property of the slide show.
addView | Add a view to the slide show.
removeView | Remove view from the slide show.
update | Update the animations.
addSlideShowListener | Add a slide show listener.
removeSlideShowListener | Revoke a previously registered slide show listener.
addShapeEventListener | Add a shape event listener.
removeShapeEventListener | Revoke a previously registered shape event listener.
setShapeCursor | Set a special mouse cursor for a shape.

Methods' Details
nextEffect
boolean
nextEffect();
Description Trigger the next effect of the slide show. This method triggers the next effect on the currently displayed slide. If there is currently no slide show running, this method does nothing. If there are no more effects on the current slide, a possible slide transition effect is issued and the next slide is displayed. Returns true, if the next effect was successfully triggered. This method returns false, if there is no show running, the last effect on the last slide was already triggered, or the implementation failed to trigger the next effect.
previousEffect
boolean
previousEffect();
Description Undo the last effect in the main sequence of the slide show. The current slide is displayed as if the last user-triggered effect has never been triggered. If there is no previous effect on the current slide then slideEnded(true) is called at the registered XSlideShowListener objects, which can then trigger a change to the previous slide. Note that this command is executed asynchronously. Multiple calls to update() may be necessary to complete its execution. If there is currently no slide show running, this method does nothing. Returns true, if the previous effect was successfully triggered. This method returns false, if there is no show running, the first effect on the first slide was not yet triggered, or the implementation failed to trigger the previous effect.
startShapeActivity
boolean
startShapeActivity( | [in] ::com::sun::star::drawing::XShape | xShape );
Description Start a shape-intrinsic animation or activity. This method starts an animation or activity intrinsic to the given shape. Shape-intrinsic activities are things like video playback for multimedia shapes, sounds, GIF animations and drawing layer animations (flipping between shapes in a group, or scroll text). Parameter xShape The shape to start the activity for
stopShapeActivity
boolean
stopShapeActivity( | [in] ::com::sun::star::drawing::XShape | xShape );
Description Stop a shape-intrinsic animation or activity. This method stops an animation or activity intrinsic to the given shape. Shape-intrinsic activities are things like video playback for multimedia shapes, sounds, GIF animations and drawing layer animations (flipping between shapes in a group, or scroll text). Parameter xShape The shape to stop the activity for
displaySlide
void
displaySlide( | [in] ::com::sun::star::drawing::XDrawPage | xSlide,
| [in] ::com::sun::star::drawing::XDrawPagesSupplier | xDrawPages,
| [in] ::com::sun::star::animations::XAnimationNode | aAnimationNode,
| [in] sequence< ::com::sun::star::beans::PropertyValue > | aProperties );
Description Jump to the given slide. This method ends all effects on the current slide, displays a possible slide transition, followed by the given slide. If the current slide is equal to the requested slide here, this method does nothing (this especially means, that any currently active effects will remain running). Parameter xPage The slide to display. Parameter xDrawPages For future use. Parameter xAnimationNode The animation node determine the animations to display. Parameter aProperties Sequence of property values, which influence the way the slide is displayed. Currently, the following values are recognized: name: Prefetch, value: ::com::sun::star::drawing::XDrawPage. When given, this slide is prepared in the background to be displayed next. The next call to displaySlide() with the given slide may be faster if there was enough time for prefetching. If the next call to displaySlide() uses a different slide, this will still work but will not have any performance improvements name: SkipAllMainSequenceEffects, value: boolean. When true then all main sequence effects on the new slide are triggered. This is typically used when going back one effect leads to the previous slide. On that slide all effects have to be shown in order to continue the backward traveling. When false, the default, then no main sequence effect is triggered. name: SkipSlideTransition, value: boolean. When true then the slide transition animation, if there is any, is not displayed. This is typically used when going back one effect leads to the previous slide. Typically used together with SkipAllMainSequenceEffects also being true. When false, the default, then the slide transition effect, if it exists, is played.
pause
boolean
pause( | [in] boolean | bPauseShow );
Description Change the pause state of the slide show. This method either pauses the slide show (all currently running effects are stopped), or starts a previously stopped show again (all paused effects start again). Parameter bPauseShow When true, the show is paused. When false, and the show was paused, it starts running at the paused position again. Returns true, if the requested action was successfully performed.
getCurrentSlide
::com::sun::star::drawing::XDrawPage
getCurrentSlide();
Description Query the currently displayed slide. Returns the instance of the current slide. If there's no slide show running at the moment, this method returns an empty reference.
registerUserPaintPolygons
void
registerUserPaintPolygons( | [in] ::com::sun::star::lang::XMultiServiceFactory | xDocFactory );
Description Register drawn polygons in presentation mode Parameter xDocFactory
setProperty
boolean
setProperty( | [in] ::com::sun::star::beans::PropertyValue | aShowProperty );
Description Change a property of the slide show. Parameter aShowProperty Property values, which influence the way the slides are shown. Note that this might possibly be a subset of what is supported on show(). Currently, the following values are recognized: name: AutomaticAdvancement, value: double. When given, effects and slides are advanced automatically. The double value specifies the timeout between the end of one effect until the start of the next one. Negative values are truncated to zero here. When given, but with empty value, automatic advancement is disabled again. name: UserPaintColor, value: long. When given, the slide show will display a small stylus as the mouse cursor. When pressing the left mouse key, the user can paint a thin line in the given color. A changed property is effective immediately.
addView
boolean
addView( | [in] XSlideShowView | xView );
Description Add a view to the slide show. This method adds a view to the slide show. After successful completion of this method, the slide show will be visible on the added view, scaled according to the view's output area. Parameter xView The view to add Returns true, if the view has been successfully added. Otherwise, false is returned (e.g. if the view is already added).
removeView
boolean
removeView( | [in] XSlideShowView | xView );
Description Remove view from the slide show. This method removes the given view from the slide show. After successful completion of this method, the slide show will cease to display on this view. Parameter xView View to remove Returns true, if the view was successfully removed, false otherwise (e.g. if the view was not added in the first place).
update
boolean
update( | [out] double | nNextTimeout );
Description Update the animations. This method updates all currently active slide animations. The XSlideShow implementations do not render animations automatically, but must be called from their clients. This allows for various update mechanisms to be employed, ranging from a dedicated rendering thread, over timer-based updates, to rendering in an idle function. Either way, the client of this interface decide about the details. Parameter nNextTimeout Via this value, the implementation can return a timeout value, denoting the maximal time span that must not be exceeded from the return of this method to the next update call. Otherwise, the animations might show visible jerks. Returns true, if further update calls are required. If false is returned, no further update calls are necessary, until anyone of the other interface methods is called (most notably, the next/previousSlide(), nextEffect() and show() methods will nearly always make further update() calls necessary).
addSlideShowListener
void
addSlideShowListener( | [in] XSlideShowListener | xListener );
Description Add a slide show listener. This method adds a listener to the slide show, which will get notified when a registered shape is clicked upon, or a new slide is about to be displayed. Note that the listeners will not be notified, when the slide change is directly requested by one of the nextSlide(), previousSlide() or displaySlide() methods. Parameter xListener Listener to add.
removeSlideShowListener
void
removeSlideShowListener( | [in] XSlideShowListener | xListener );
Description Revoke a previously registered slide show listener. Parameter xListener Listener interface to revoke from being called.
addShapeEventListener
void
addShapeEventListener( | [in] XShapeEventListener | xListener,
| [in] ::com::sun::star::drawing::XShape | xShape );
Description Add a shape event listener. This method adds a listener to the slide show, which will get notified when a mouse click is performed on the given shape. This can be used by clients of the slide show to trigger external actions, such as jumps to different slides. Parameter xListener Listener to add. Parameter xShape Shape to register a listener for.
removeShapeEventListener
void
removeShapeEventListener( | [in] XShapeEventListener | xListener,
| [in] ::com::sun::star::drawing::XShape | xShape );
Description Revoke a previously registered shape event listener. Parameter xListener Listener interface to revoke from being called. Parameter xShape Shape for which the listener should be revoked.
setShapeCursor
void
setShapeCursor( | [in] ::com::sun::star::drawing::XShape | xShape,
| [in] short | nPointerShape );
Description Set a special mouse cursor for a shape. This method requests the slide show to display a special cursor, whenever the mouse is hovering over the given shape. Parameter xShape Shape to display a special mouse cursor. Parameter nPointerShape Type of mouse cursor to display. Must be one of the ::com::sun::star::awt::SystemPointer values.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.