LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
XSlideShowController.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21 module com { module sun { module star { module presentation {
22
23
29 interface XSlideShowController
30{
31
37 boolean isRunning();
38
39
45 long getSlideCount();
46
47
66 ::com::sun::star::drawing::XDrawPage getSlideByIndex( [in] long Index )
67 raises( com::sun::star::lang::IndexOutOfBoundsException );
68
69
71 void addSlideShowListener( [in] XSlideShowListener Listener );
72
73
75 void removeSlideShowListener( [in] XSlideShowListener Listener );
76
77
82 void gotoNextEffect();
83
84
89 void gotoPreviousEffect();
90
91
93 void gotoFirstSlide();
94
95
98 void gotoNextSlide();
99
100
103 void gotoPreviousSlide();
104
105
108 void gotoLastSlide();
109
110
112 void gotoBookmark( [in] string Bookmark );
113
114
124 void gotoSlide( [in] com::sun::star::drawing::XDrawPage Page )
125 raises( com::sun::star::lang::IllegalArgumentException );
126
127
130 void gotoSlideIndex( [in] long Index );
131
132
134 void stopSound();
135
136
141 void pause();
142
143
146 void resume();
147
148
154 boolean isPaused();
155
156
161 void blankScreen( [in] long Color );
162
163
169 void activate();
170
177 void deactivate();
178
179
187 boolean isActive();
188
189
191 com::sun::star::drawing::XDrawPage getCurrentSlide();
192
193
195 long getCurrentSlideIndex();
196
197
199 long getNextSlideIndex();
200
201
204 boolean isEndless();
205
206
209 boolean isFullScreen();
210
211
215 [attribute] boolean AlwaysOnTop;
216
217
221 [attribute] boolean MouseVisible;
222
223
228 [attribute] boolean UsePen;
229
230
232 [attribute] long PenColor;
233
238 [attribute] double PenWidth;
239
240
245 void setEraseAllInk( [in] boolean EraseAllInk );
246
251 XSlideShow getSlideShow();
252
253};
254
255
256}; }; }; };
257
258/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition IndexOutOfBoundsException.idl:31
com::sun::star::drawing::XDrawPage
identifies an XShapes as a DrawPage.
Definition XDrawPage.idl:28
com::sun::star::presentation::XSlideShowController
interface to control a running slide show.
Definition XSlideShowController.idl:30
com::sun::star::presentation::XSlideShowController::gotoBookmark
void gotoBookmark([in] string Bookmark)
goto the given textual bookmark
com::sun::star::presentation::XSlideShowController::getCurrentSlideIndex
long getCurrentSlideIndex()
returns the index of the current slide.
com::sun::star::presentation::XSlideShowController::getSlideByIndex
::com::sun::star::drawing::XDrawPage getSlideByIndex([in] long Index)
gives access to the slides that will be shown in this slide show.
com::sun::star::presentation::XSlideShowController::resume
void resume()
resumes a paused slide show.
com::sun::star::presentation::XSlideShowController::PenWidth
double PenWidth
This attribute changes the width of the pen.
Definition XSlideShowController.idl:238
com::sun::star::presentation::XSlideShowController::getCurrentSlide
com::sun::star::drawing::XDrawPage getCurrentSlide()
returns slide that is currently displayed
com::sun::star::presentation::XSlideShowController::PenColor
long PenColor
This attribute changes the color of the pen.
Definition XSlideShowController.idl:232
com::sun::star::presentation::XSlideShowController::MouseVisible
boolean MouseVisible
If this attribute is TRUE, the mouse is visible during the slide show.
Definition XSlideShowController.idl:221
com::sun::star::presentation::XSlideShowController::gotoNextSlide
void gotoNextSlide()
goto and display next slide.
com::sun::star::presentation::XSlideShowController::gotoFirstSlide
void gotoFirstSlide()
goto and display first slide
com::sun::star::presentation::XSlideShowController::isActive
boolean isActive()
determines if the slide show is active.
com::sun::star::presentation::XSlideShowController::isEndless
boolean isEndless()
returns TRUE if the slide show was started to run endlessly.
com::sun::star::presentation::XSlideShowController::gotoNextEffect
void gotoNextEffect()
start next effects that wait on a generic trigger.
com::sun::star::presentation::XSlideShowController::pause
void pause()
pauses the slide show.
com::sun::star::presentation::XSlideShowController::isFullScreen
boolean isFullScreen()
Returns TRUE if the slide show was started in full-screen mode.
com::sun::star::presentation::XSlideShowController::gotoPreviousSlide
void gotoPreviousSlide()
goto and display previous slide.
com::sun::star::presentation::XSlideShowController::activate
void activate()
activates the user interface of this slide show.
com::sun::star::presentation::XSlideShowController::deactivate
void deactivate()
can be called to deactivate the user interface of this slide show.
com::sun::star::presentation::XSlideShowController::removeSlideShowListener
void removeSlideShowListener([in] XSlideShowListener Listener)
removes a listener.
com::sun::star::presentation::XSlideShowController::isRunning
boolean isRunning()
returns true if the slide show is still running.
com::sun::star::presentation::XSlideShowController::stopSound
void stopSound()
stop all currently played sounds
com::sun::star::presentation::XSlideShowController::setEraseAllInk
void setEraseAllInk([in] boolean EraseAllInk)
This method clears ink drawing from the slideshow being played.
com::sun::star::presentation::XSlideShowController::isPaused
boolean isPaused()
returns TRUE if the slide show is currently paused.
com::sun::star::presentation::XSlideShowController::gotoLastSlide
void gotoLastSlide()
goto and display last slide.
com::sun::star::presentation::XSlideShowController::blankScreen
void blankScreen([in] long Color)
pauses the slide show and blanks the screen in the given color.
com::sun::star::presentation::XSlideShowController::getSlideShow
XSlideShow getSlideShow()
returns the actual XSlideShow instance that runs the slide show.
com::sun::star::presentation::XSlideShowController::getSlideCount
long getSlideCount()
com::sun::star::presentation::XSlideShowController::addSlideShowListener
void addSlideShowListener([in] XSlideShowListener Listener)
adds a listener that receives events while the slide show is running.
com::sun::star::presentation::XSlideShowController::gotoSlide
void gotoSlide([in] com::sun::star::drawing::XDrawPage Page)
jumps to the given slide.
com::sun::star::presentation::XSlideShowController::getNextSlideIndex
long getNextSlideIndex()
the index for the slide that is displayed next.
com::sun::star::presentation::XSlideShowController::UsePen
boolean UsePen
If this is TRUE, a pen is shown during presentation.
Definition XSlideShowController.idl:228
com::sun::star::presentation::XSlideShowController::gotoSlideIndex
void gotoSlideIndex([in] long Index)
jumps to the slide at the given index.
com::sun::star::presentation::XSlideShowController::gotoPreviousEffect
void gotoPreviousEffect()
undo the last effects that were triggered by a generic trigger.
com::sun::star::presentation::XSlideShowController::AlwaysOnTop
boolean AlwaysOnTop
If this attribute is set to TRUE, the window of the slide show is always on top of all other windows.
Definition XSlideShowController.idl:215
com::sun::star::presentation::XSlideShowListener
Listener interface to receive global slide show events.
Definition XSlideShowListener.idl:29
com::sun::star::presentation::XSlideShow
Slide show interface to perform slide show presentations.
Definition XSlideShow.idl:34
com
Definition Ambiguous.idl:20