LibreOffice
LibreOffice 6.0 SDK API Reference
Public Member Functions | Public Attributes | List of all members
XSlideShowController Interface Reference

interface to control a running slide show. More...

import"XSlideShowController.idl";

Public Member Functions

boolean isRunning ()
 returns true if the slide show is still running. More...
 
long getSlideCount ()
 
::com::sun::star::drawing::XDrawPage getSlideByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 gives access to the slides that will be shown in this slide show. More...
 
void addSlideShowListener ([in] XSlideShowListener Listener)
 adds a listener that receives events while the slide show is running. More...
 
void removeSlideShowListener ([in] XSlideShowListener Listener)
 removes a listener. More...
 
void gotoNextEffect ()
 start next effects that wait on a generic trigger. More...
 
void gotoPreviousEffect ()
 undo the last effects that where triggered by a generic trigger. More...
 
void gotoFirstSlide ()
 goto and display first slide More...
 
void gotoNextSlide ()
 goto and display next slide. More...
 
void gotoPreviousSlide ()
 goto and display previous slide. More...
 
void gotoLastSlide ()
 goto and display last slide. More...
 
void gotoBookmark ([in] string Bookmark)
 goto the given textual bookmark More...
 
void gotoSlide ([in] com::sun::star::drawing::XDrawPage Page) raises ( com::sun::star::lang::IllegalArgumentException )
 jumps to the given slide. More...
 
void gotoSlideIndex ([in] long Index)
 jumps to the slide at the given index. More...
 
void stopSound ()
 stop all currently played sounds More...
 
void pause ()
 pauses the slide show. More...
 
void resume ()
 resumes a paused slide show. More...
 
boolean isPaused ()
 returns TRUE if the slide show is currently paused. More...
 
void blankScreen ([in] long Color)
 pauses the slide show and blanks the screen in the given color. More...
 
void activate ()
 activates the user interface of this slide show. More...
 
void deactivate ()
 can be called to deactivate the user interface of this slide show. More...
 
boolean isActive ()
 determines if the slide show is active. More...
 
com::sun::star::drawing::XDrawPage getCurrentSlide ()
 returns slide that is currently displayed More...
 
long getCurrentSlideIndex ()
 returns the index of the current slide. More...
 
long getNextSlideIndex ()
 the index for the slide that is displayed next. More...
 
boolean isEndless ()
 returns TRUE if the slide show was started to run endlessly. More...
 
boolean isFullScreen ()
 Returns TRUE if the slide show was started in full-screen mode. More...
 
XSlideShow getSlideShow ()
 returns the actual XSlideShow instance that runs the slide show. More...
 

Public Attributes

boolean AlwaysOnTop
 If this attribute is set to TRUE, the window of the slide show is always on top of all other windows. More...
 
boolean MouseVisible
 If this attribute is TRUE, the mouse is visible during the slide show. More...
 
boolean UsePen
 If this is TRUE, a pen is shown during presentation. More...
 
long PenColor
 This attribute changes the color of the pen. More...
 
double PenWidth
 This attribute changes the width of the pen. More...
 

Detailed Description

interface to control a running slide show.

See also
XPresentation2
Since
OOo 3.0

Member Function Documentation

void activate ( )

activates the user interface of this slide show.

See also
deactivate()
isActive()
void addSlideShowListener ( [in] XSlideShowListener  Listener)

adds a listener that receives events while the slide show is running.

void blankScreen ( [in] long  Color)

pauses the slide show and blanks the screen in the given color.

Change attribute Pause to false to unpause the slide show.

void deactivate ( )

can be called to deactivate the user interface of this slide show.

A deactivated

See also
activate()
isActive()

returns slide that is currently displayed

long getCurrentSlideIndex ( )

returns the index of the current slide.

long getNextSlideIndex ( )

the index for the slide that is displayed next.

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.
Parameters
Indexspecifies the position in the list of slides that are displayed in this slide show. The first index is 0.
Exceptions
com::sun::star::lang::IndexOutOfBoundExceptionif the index is not valid.
long getSlideCount ( )
Returns
the number of slides in this slide show.
See also
getSlideByIndex
XSlideShow 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.

void gotoBookmark ( [in] string  Bookmark)

goto the given textual bookmark

void gotoFirstSlide ( )

goto and display first slide

void gotoLastSlide ( )

goto and display last slide.

Remaining effects on the current slide will be skipped.

void gotoNextEffect ( )

start next effects that wait on a generic trigger.

If no generic triggers are waiting the next slide will be displayed.

void gotoNextSlide ( )

goto and display next slide.

Remaining effects on the current slide will be skipped.

void gotoPreviousEffect ( )

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.

void gotoPreviousSlide ( )

goto and display previous slide.

Remaining effects on the current slide will be skipped.

jumps to the given slide.

The slide can also be a slide that would normally not be shown during the current slide show.

Exceptions
com::sun::star::lang::IllegalArgumentExceptionif 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.
void gotoSlideIndex ( [in] long  Index)

jumps to the slide at the given index.

boolean isActive ( )

determines if the slide show is active.

Returns
TRUE for UI active slide show
FALSE otherwise
boolean isEndless ( )

returns TRUE if the slide show was started to run endlessly.

boolean isFullScreen ( )

Returns TRUE if the slide show was started in full-screen mode.

boolean isPaused ( )

returns TRUE if the slide show is currently paused.

See also
pause()
resume()
boolean 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

void pause ( )

pauses the slide show.

All effects are paused.

The slide show continues on next user input or if resume() is called.

void removeSlideShowListener ( [in] XSlideShowListener  Listener)

removes a listener.

void resume ( )

resumes a paused slide show.

void stopSound ( )

stop all currently played sounds

Member Data Documentation

boolean AlwaysOnTop
attribute

If this attribute is set to TRUE, the window of the slide show is always on top of all other windows.

boolean MouseVisible
attribute

If this attribute is TRUE, the mouse is visible during the slide show.

long PenColor
attribute

This attribute changes the color of the pen.

double PenWidth
attribute

This attribute changes the width of the pen.

Since
LibreOffice 4.2
boolean UsePen
attribute

If this is TRUE, a pen is shown during presentation.

You can draw on the presentation with this pen.


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