LibreOffice
LibreOffice 6.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 
253 
254 };
255 
256 
257 }; }; }; };
258 
259 #endif
260 
261 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
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::MouseVisible
boolean MouseVisible
If this attribute is TRUE, the mouse is visible during the slide show.
Definition: XSlideShowController.idl:228
com::sun::star::presentation::XSlideShowController::isEndless
boolean isEndless()
returns TRUE if the slide show was started to run endlessly.
XDrawPage.idl
com::sun::star::rendering::Color
sequence< ColorComponent > Color
Shorthand for the device-dependent color components, and easier to read.
Definition: Color.idl:28
com::sun::star::presentation::XSlideShowController::removeSlideShowListener
void removeSlideShowListener([in] XSlideShowListener Listener)
removes a listener.
XIndexAccess.idl
XComponent.idl
com::sun::star::presentation::XSlideShowController::getSlideShow
XSlideShow getSlideShow()
returns the actual XSlideShow instance that runs the slide show.
com::sun::star::presentation::XSlideShowController::isActive
boolean isActive()
determines if the slide show is active.
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:222
com::sun::star::presentation::XSlideShowController::PenColor
long PenColor
This attribute changes the color of the pen.
Definition: XSlideShowController.idl:239
com::sun::star::presentation::XSlideShowController::activate
void activate()
activates the user interface of this slide show.
com::sun::star::presentation::XSlideShowController::gotoNextSlide
void gotoNextSlide()
goto and display next slide.
com::sun::star::presentation::XSlideShowController::isRunning
boolean isRunning()
returns true if the slide show is still running.
com::sun::star::presentation::XSlideShowController::getCurrentSlide
com::sun::star::drawing::XDrawPage getCurrentSlide()
returns slide that is currently displayed
com::sun::star::presentation::XSlideShowController::gotoBookmark
void gotoBookmark([in] string Bookmark)
goto the given textual bookmark
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::blankScreen
void blankScreen([in] long Color)
pauses the slide show and blanks the screen in the given color.
com::sun::star::presentation::XSlideShowController::isPaused
boolean isPaused()
returns TRUE if the slide show is currently paused.
com::sun::star::presentation::XSlideShowController::pause
void pause()
pauses the slide show.
com::sun::star::presentation::XSlideShow
Slide show interface to perform slide show presentations.
Definition: XSlideShow.idl:49
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::getCurrentSlideIndex
long getCurrentSlideIndex()
returns the index of the current slide.
com::sun::star::presentation::XSlideShowListener
Listener interface to receive global slide show events.
Definition: XSlideShowListener.idl:33
com::sun::star::presentation::XSlideShowController::PenWidth
double PenWidth
This attribute changes the width of the pen.
Definition: XSlideShowController.idl:245
com::sun::star::presentation::XSlideShowController::gotoLastSlide
void gotoLastSlide()
goto and display last slide.
com::sun::star::presentation::XSlideShowController::deactivate
void deactivate()
can be called to deactivate the user interface of this slide show.
com
Definition: Ambiguous.idl:22
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::gotoNextEffect
void gotoNextEffect()
start next effects that wait on a generic trigger.
com::sun::star::presentation::XSlideShowController::stopSound
void stopSound()
stop all currently played sounds
com::sun::star::presentation::XSlideShowController::gotoFirstSlide
void gotoFirstSlide()
goto and display first slide
com::sun::star::presentation::XSlideShowController::gotoPreviousSlide
void gotoPreviousSlide()
goto and display previous slide.
com::sun::star::presentation::XSlideShowController
interface to control a running slide show.
Definition: XSlideShowController.idl:37
com::sun::star::drawing::XDrawPage
identifies an XShapes as a DrawPage.
Definition: XDrawPage.idl:32
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::presentation::XSlideShowController::resume
void resume()
resumes a paused slide show.
XSlideShow.idl
com::sun::star::presentation::XSlideShowController::getNextSlideIndex
long getNextSlideIndex()
the index for the slide that is displayed next.
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
com::sun::star::presentation::XSlideShowController::getSlideCount
long getSlideCount()
com::sun::star::presentation::XSlideShowController::UsePen
boolean UsePen
If this is TRUE, a pen is shown during presentation.
Definition: XSlideShowController.idl:235