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

unpublished interface XSlideShowController
Base Interfaces
XSlideShowController
┣ ::com::sun::star::lang::XComponent
┣ ::com::sun::star::beans::XPropertySet
┗ ::com::sun::star::container::XIndexAccess
   ┗ ::com::sun::star::container::XElementAccess

::com::sun::star::lang::XComponent
Description
allows to dispose this controller and manage event listener.

You can add XSlideShowListener using the methods ::::com::sun::star::lang::XComponent::addEventListener()

::com::sun::star::beans::XPropertySet
Description
gives access to the properties of this controller.
::com::sun::star::container::XIndexAccess
Description
gives access to the slides that will be shown in this slideshow.

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.

Description
gives control over a running slide show in the presentation module.

Methods' Summary
start start the slideshow  
stop stop the slideshow  
isStopped returns true if the slideshow is currently stopped  
gotoNextEffect start next effects that wait on 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 slideshow. All effects are paused.  
resume resumes a paused slideshow.  
isPaused returns true if the slideshow is currently paused.  
blankScreen pauses the slideshow and blanks the screen in the given color.  
activate activates the user interface of this slideshow.  
deactivate can be called to deactivate the user interface of this slideshow.  
isActive determines if the slideshow is active.  
getCurrentSlide returns slide that is currently displayed  
getCurrentSlideIndex returns the index of the current slide  
getNextSlideIndex the slide that is displayed next.  
isEndless returns true if the slideshow was started to run endlessly.  
isFullScreen Returns true if the slideshow was started in full-screen mode.  
Methods' Details
start
void
start( [in] sequence< ::com::sun::star::beans::PropertyValue >  Arguments );

Description
start the slideshow
stop
void
stop();

Description
stop the slideshow

a stopped show can only be restarted from the beginning with a call to start

isStopped
boolean
isStopped();

Description
returns true if the slideshow is currently stopped
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.

gotoFirstSlide
void
gotoFirstSlide();

Description
goto and display first slide
gotoNextSlide
void
gotoNextSlide();

Description
goto and display next slide
gotoPreviousSlide
void
gotoPreviousSlide();

Description
goto and display previous slide
gotoLastSlide
void
gotoLastSlide();

Description
goto and display last slide
gotoBookmark
void
gotoBookmark( [in] string  Bookmark );

Description
goto the given textual bookmark
gotoSlide
void
gotoSlide( [in] ::com::sun::star::drawing::XDrawPage  Page );

Description
jumps to the given slide.

The slide can be a slide that would normaly not be shown during the current slideshow.

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 slideshow. All effects are paused.

The slideshow continues on next user input or if resume is called.

resume
void
resume();

Description
resumes a paused slideshow.
isPaused
boolean
isPaused();

Description
returns true if the slideshow is currently paused.
See also
pause, resume
blankScreen
void
blankScreen( [in] long  Color );

Description
pauses the slideshow and blanks the screen in the given color.

Change attribute Pause to false to unpause the slideshow.

activate
void
activate();

Description
activates the user interface of this slideshow.
See also
deactivate(), isActive()
deactivate
void
deactivate();

Description
can be called to deactivate the user interface of this slideshow.

A deactivated

See also
activate(), isActive()
isActive
boolean
isActive();

Description
determines if the slideshow is active.
Returns
true for UI active slideshow
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 slide that is displayed next.
isEndless
boolean
isEndless();

Description
returns true if the slideshow was started to run endlessly.
isFullScreen
boolean
isFullScreen();

Description
Returns true if the slideshow was started in full-screen mode.
Attributes' Summary
AlwaysOnTop If this attribute is set to true, the window of the slideshow is always on top of all other windows.  
MouseVisible If this attribute is true, the mouse is visible during the slideshow.  
UsePen If this is true, a pen is shown during presentation.  
PenColor This attribute changes the color of the pen.  
Attributes' Details
AlwaysOnTop
boolean AlwaysOnTop;
Description
If this attribute is set to true, the window of the slideshow is always on top of all other windows.
MouseVisible
boolean MouseVisible;
Description
If this attribute is true, the mouse is visible during the slideshow.
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