LibreOffice LibreOffice 5.3 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
22 #include <com/sun/star/drawing/XDrawPage.idl>
23 #include <com/sun/star/container/XIndexAccess.idl>
24 #include <com/sun/star/lang/XComponent.idl>
25 #include <com/sun/star/presentation/XSlideShow.idl>
26
27
28 module com { module sun { module star { module presentation {
29
30
36 interface XSlideShowController
37 {
38
44 boolean isRunning();
45
46
52 long getSlideCount();
53
54
73 ::com::sun::star::drawing::XDrawPage getSlideByIndex( [in] long Index )
74 raises( com::sun::star::lang::IndexOutOfBoundsException );
75
76
78 void addSlideShowListener( [in] XSlideShowListener Listener );
79
80
82 void removeSlideShowListener( [in] XSlideShowListener Listener );
83
84
89 void gotoNextEffect();
90
91
96 void gotoPreviousEffect();
97
98
100 void gotoFirstSlide();
101
102
105 void gotoNextSlide();
106
107
110 void gotoPreviousSlide();
111
112
115 void gotoLastSlide();
116
117
119 void gotoBookmark( [in] string Bookmark );
120
121
131 void gotoSlide( [in] com::sun::star::drawing::XDrawPage Page )
132 raises( com::sun::star::lang::IllegalArgumentException );
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
198 com::sun::star::drawing::XDrawPage getCurrentSlide();
199
200
202 long getCurrentSlideIndex();
203
204
206 long getNextSlideIndex();
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 XSlideShow getSlideShow();
253
254 };
255
256
257 }; }; }; };
258
259 #endif
260
261 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::presentation::XSlideShowController::PenWidth
double PenWidth
This attribute changes the width of the pen.
Definition: XSlideShowController.idl:245
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::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index...
Definition: IndexOutOfBoundsException.idl:34
com::sun::star::presentation::XSlideShow
Slide show interface to perform slide show presentations.
Definition: XSlideShow.idl:48
com::sun::star::presentation::XSlideShowController
interface to control a running slide show.
Definition: XSlideShowController.idl:36
com
Definition: Ambiguous.idl:22
com::sun::star::presentation::XSlideShowListener
Listener interface to receive global slide show events.
Definition: XSlideShowListener.idl:32
XSlideShow.idl
XIndexAccess.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument...
Definition: IllegalArgumentException.idl:29
XComponent.idl
com::sun::star::presentation::XSlideShowController::UsePen
boolean UsePen
If this is TRUE, a pen is shown during presentation.
Definition: XSlideShowController.idl:235
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::MouseVisible
boolean MouseVisible
If this attribute is TRUE, the mouse is visible during the slide show.
Definition: XSlideShowController.idl:228
XDrawPage.idl
com::sun::star::drawing::XDrawPage
identifies an XShapes as a DrawPage.
Definition: XDrawPage.idl:31
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