LibreOffice
LibreOffice 7.4 SDK API Reference
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 #ifndef __com_sun_star_presentation_XSlideShowController_idl__
20 #define __com_sun_star_presentation_XSlideShowController_idl__
21 
26 
27 
28  module com { module sun { module star { module presentation {
29 
30 
37 {
38 
44  boolean isRunning();
45 
46 
52  long getSlideCount();
53 
54 
75 
76 
79 
80 
83 
84 
90 
91 
97 
98 
101 
102 
106 
107 
111 
112 
116 
117 
119  void gotoBookmark( [in] string Bookmark );
120 
121 
133 
134 
137  void gotoSlideIndex( [in] long Index );
138 
139 
141  void stopSound();
142 
143 
148  void pause();
149 
150 
153  void resume();
154 
155 
161  boolean isPaused();
162 
163 
168  void blankScreen( [in] long Color );
169 
170 
176  void activate();
177 
184  void deactivate();
185 
186 
194  boolean isActive();
195 
196 
199 
200 
203 
204 
207 
208 
211  boolean isEndless();
212 
213 
216  boolean isFullScreen();
217 
218 
222  [attribute] boolean AlwaysOnTop;
223 
224 
228  [attribute] boolean MouseVisible;
229 
230 
235  [attribute] boolean UsePen;
236 
237 
239  [attribute] long PenColor;
240 
245  [attribute] double PenWidth;
246 
247 
252  void setEraseAllInk( [in] boolean EraseAllInk );
253 
259 
260 };
261 
262 
263 }; }; }; };
264 
265 #endif
266 
267 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
identifies an XShapes as a DrawPage.
Definition: XDrawPage.idl:32
interface to control a running slide show.
Definition: XSlideShowController.idl:37
void gotoBookmark([in] string Bookmark)
goto the given textual bookmark
long getCurrentSlideIndex()
returns the index of the current slide.
::com::sun::star::drawing::XDrawPage getSlideByIndex([in] long Index)
gives access to the slides that will be shown in this slide show.
void resume()
resumes a paused slide show.
double PenWidth
This attribute changes the width of the pen.
Definition: XSlideShowController.idl:245
com::sun::star::drawing::XDrawPage getCurrentSlide()
returns slide that is currently displayed
long PenColor
This attribute changes the color of the pen.
Definition: XSlideShowController.idl:239
boolean MouseVisible
If this attribute is TRUE, the mouse is visible during the slide show.
Definition: XSlideShowController.idl:228
void gotoNextSlide()
goto and display next slide.
void gotoFirstSlide()
goto and display first slide
boolean isActive()
determines if the slide show is active.
boolean isEndless()
returns TRUE if the slide show was started to run endlessly.
void gotoNextEffect()
start next effects that wait on a generic trigger.
boolean isFullScreen()
Returns TRUE if the slide show was started in full-screen mode.
void gotoPreviousSlide()
goto and display previous slide.
void activate()
activates the user interface of this slide show.
void deactivate()
can be called to deactivate the user interface of this slide show.
void removeSlideShowListener([in] XSlideShowListener Listener)
removes a listener.
boolean isRunning()
returns true if the slide show is still running.
void stopSound()
stop all currently played sounds
void setEraseAllInk([in] boolean EraseAllInk)
This method clears ink drawing from the slideshow being played.
boolean isPaused()
returns TRUE if the slide show is currently paused.
void gotoLastSlide()
goto and display last slide.
void blankScreen([in] long Color)
pauses the slide show and blanks the screen in the given color.
XSlideShow getSlideShow()
returns the actual XSlideShow instance that runs the slide show.
void addSlideShowListener([in] XSlideShowListener Listener)
adds a listener that receives events while the slide show is running.
void gotoSlide([in] com::sun::star::drawing::XDrawPage Page)
jumps to the given slide.
long getNextSlideIndex()
the index for the slide that is displayed next.
boolean UsePen
If this is TRUE, a pen is shown during presentation.
Definition: XSlideShowController.idl:235
void gotoSlideIndex([in] long Index)
jumps to the slide at the given index.
void gotoPreviousEffect()
undo the last effects that were triggered by a generic trigger.
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:222
Listener interface to receive global slide show events.
Definition: XSlideShowListener.idl:33
Slide show interface to perform slide show presentations.
Definition: XSlideShow.idl:49
sequence< ColorComponent > Color
Shorthand for the device-dependent color components, and easier to read.
Definition: Color.idl:28
Definition: Ambiguous.idl:22