Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: presentation ::
unpublished | interface XSlideShowController |
Usage Restrictions not published Description interface to control a running slide show. Since OOo 3.0 See also XPresentation2

Methods' Summary
isRunning | returns true if the slide show is still running. If this returns false, this component is already disposed. You can start a new slide show and get a new instance of XSlideShowController from XPresentation2
getSlideCount |
getSlideByIndex | gives access to the slides that will be shown in this slide show.
addSlideShowListener | adds a listener that receives events while the slide show is running.
removeSlideShowListener | removes a listener.
gotoNextEffect | start next effects that wait on a generic trigger.
gotoPreviousEffect | undo the last effects that where triggered by a generic trigger.
gotoFirstSlide | goto and display first slide
gotoNextSlide | goto and display next slide.
gotoPreviousSlide | goto and display previous slide.
gotoLastSlide | goto and display last slide.
gotoBookmark | goto the given textual bookmark
gotoSlide | jumps to the given slide.
gotoSlideIndex | jumps to the slide at the given index.
stopSound | stop all currently played sounds
pause | pauses the slide show. All effects are paused.
resume | resumes a paused slide show.
isPaused | returns true if the slide show is currently paused.
blankScreen | pauses the slide show and blanks the screen in the given color.
activate | activates the user interface of this slide show.
deactivate | can be called to deactivate the user interface of this slide show.
isActive | determines if the slide show is active.
getCurrentSlide | returns slide that is currently displayed
getCurrentSlideIndex | returns the index of the current slide.
getNextSlideIndex | the index for the slide that is displayed next.
isEndless | returns true if the slide show was started to run endlessly.
isFullScreen | Returns true if the slide show was started in full-screen mode.
getSlideShow | returns the actual XSlideShow instance that runs the slide show. Normally all navigation should be done using this controller and not the XSlideShow itself.

Attributes' Summary
AlwaysOnTop | If this attribute is set to true, the window of the slide show is always on top of all other windows.
MouseVisible | If this attribute is true, the mouse is visible during the slide show.
UsePen | If this is true, a pen is shown during presentation.
PenColor | This attribute changes the color of the pen.

Methods' Details
isRunning
boolean
isRunning();
Description returns true if the slide show is still running. If this returns false, this component is already disposed. You can start a new slide show and get a new instance of XSlideShowController from XPresentation2
getSlideCount
long
getSlideCount();
Returns the number of slides in this slide show. See also getSlideByIndex
getSlideByIndex
::com::sun::star::drawing::XDrawPage
getSlideByIndex( | [in] long | Index )
raises( | ::com::sun::star::lang::IndexOutOfBoundsException );
Description gives access to the slides that will be shown in this slide show. Slides are returned in the order they will be displayed in the presentation which can be different than the orders of slides in the document. Not all slides must be present and each slide can be used more than once. Returns the slide at the specified index. Parameter Index specifies the position in the list of slides that are displayed in this slide show. The first index is 0. Throws com::sun::star::lang::IndexOutOfBoundException if the index is not valid.
addSlideShowListener
void
addSlideShowListener( | [in] XSlideShowListener | Listener );
Description adds a listener that receives events while the slide show is running.
removeSlideShowListener
void
removeSlideShowListener( | [in] XSlideShowListener | Listener );
Description removes a listener.
gotoNextEffect
void
gotoNextEffect();
Description start next effects that wait on a generic trigger. If no generic triggers are waiting the next slide will be displayed.
gotoPreviousEffect
void
gotoPreviousEffect();
Description undo the last effects that where triggered by a generic trigger. If there is no previous effect that can be undone then the previous slide will be displayed.
gotoFirstSlide
void
gotoFirstSlide();
Description goto and display first slide
gotoNextSlide
void
gotoNextSlide();
Description goto and display next slide. Remaining effects on the current slide will be skipped.
gotoPreviousSlide
void
gotoPreviousSlide();
Description goto and display previous slide. Remaining effects on the current slide will be skipped.
gotoLastSlide
void
gotoLastSlide();
Description goto and display last slide. Remaining effects on the current slide will be skipped.
gotoBookmark
void
gotoBookmark( | [in] string | Bookmark );
Description goto the given textual bookmark
gotoSlide
void
gotoSlide( | [in] ::com::sun::star::drawing::XDrawPage | Page )
raises( | ::com::sun::star::lang::IllegalArgumentException );
Description jumps to the given slide. The slide can also be a slide that would normally not be shown during the current slide show. Throws com::sun::star::lang::IllegalArgumentException if the given page is not a valid slide of the document for which this slide show is started. Also not allowed are master, notes and handout pages.
gotoSlideIndex
void
gotoSlideIndex( | [in] long | Index );
Description jumps to the slide at the given index.
stopSound
void
stopSound();
Description stop all currently played sounds
pause
void
pause();
Description pauses the slide show. All effects are paused. The slide show continues on next user input or if resume is called.
resume
void
resume();
Description resumes a paused slide show.
isPaused
boolean
isPaused();
Description returns true if the slide show is currently paused. See also pause, resume
blankScreen
void
blankScreen( | [in] long | Color );
Description pauses the slide show and blanks the screen in the given color. Change attribute Pause to false to unpause the slide show.
activate
void
activate();
Description activates the user interface of this slide show. See also deactivate(), isActive()
deactivate
void
deactivate();
Description can be called to deactivate the user interface of this slide show. A deactivated See also activate(), isActive()
isActive
boolean
isActive();
Description determines if the slide show is active. Returns true for UI active slide show false otherwise
getCurrentSlide
::com::sun::star::drawing::XDrawPage
getCurrentSlide();
Description returns slide that is currently displayed
getCurrentSlideIndex
long
getCurrentSlideIndex();
Description returns the index of the current slide.
getNextSlideIndex
long
getNextSlideIndex();
Description the index for the slide that is displayed next.
isEndless
boolean
isEndless();
Description returns true if the slide show was started to run endlessly.
isFullScreen
boolean
isFullScreen();
Description Returns true if the slide show was started in full-screen mode.
getSlideShow
XSlideShow
getSlideShow();
Description returns the actual XSlideShow instance that runs the slide show. Normally all navigation should be done using this controller and not the XSlideShow itself.

Attributes' Details
AlwaysOnTop
boolean AlwaysOnTop; Description If this attribute is set to true, the window of the slide show is always on top of all other windows.
MouseVisible
boolean MouseVisible; Description If this attribute is true, the mouse is visible during the slide show.
UsePen
boolean UsePen; Description If this is true, a pen is shown during presentation. You can draw on the presentation with this pen.
PenColor
long PenColor; Description This attribute changes the color of the pen.

Top of Page

Copyright © 2000, 2013 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.