LibreOffice
LibreOffice 24.8 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 
20 
21  module com { module sun { module star { module presentation {
22 
23 
30 {
31 
37  boolean isRunning();
38 
39 
45  long getSlideCount();
46 
47 
68 
69 
72 
73 
76 
77 
83 
84 
90 
91 
94 
95 
98  void gotoNextSlide();
99 
100 
104 
105 
109 
110 
112  void gotoBookmark( [in] string Bookmark );
113 
114 
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 
192 
193 
196 
197 
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 
252 
253 };
254 
255 
256 }; }; }; };
257 
258 /* 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:27
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:31
identifies an XShapes as a DrawPage.
Definition: XDrawPage.idl:28
interface to control a running slide show.
Definition: XSlideShowController.idl:30
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:238
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:232
boolean MouseVisible
If this attribute is TRUE, the mouse is visible during the slide show.
Definition: XSlideShowController.idl:221
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:228
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:215
Listener interface to receive global slide show events.
Definition: XSlideShowListener.idl:29
Slide show interface to perform slide show presentations.
Definition: XSlideShow.idl:34
sequence< ColorComponent > Color
Shorthand for the device-dependent color components, and easier to read.
Definition: Color.idl:23
Definition: Ambiguous.idl:20