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 were 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. |
Methods' Details |
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
|
getSlideByIndex
- 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::IndexOutOfBoundsException
if the index is not valid.
|
|
addSlideShowListener
- Description
- adds a listener that receives events while the slide show is running.
|
|
removeSlideShowListener
- Description
- removes a listener.
|
|
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 were triggered by a generic trigger.
If there is no previous effect that can be undone then the
previous slide will be displayed.
|
|
gotoFirstSlide
- Description
- goto and display first slide
|
|
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
- 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
- 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
- Description
- stop all currently played sounds
|
|
pause
- Description
- pauses the slide show. All effects are paused.
The slide show continues on next user input or if
resume() is called.
|
|
resume
- Description
- resumes a paused slide show.
|
|
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
|
deactivate
- Description
- can be called to deactivate the user interface of this slide show.
A deactivated
- See also
- activate(), isActive()
|
|
isActive
- Description
- determines if the slide show is active.
- Returns
- `TRUE` for UI active slide show
`FALSE` otherwise
|
|
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
- Description
- returns `TRUE` if the slide show was started to run endlessly.
|
|
isFullScreen
- Description
- Returns `TRUE` if the slide show was started in full-screen mode.
|
|
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.
|
|
Copyright © 2020, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.