summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/presentation/XSlideShowController.idl
blob: a5c619c301fd2b6080ec62e08c8a536c09c4ce9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_presentation_XSlideShowController_idl__
#define __com_sun_star_presentation_XSlideShowController_idl__

#include <com/sun/star/drawing/XDrawPage.idl>
#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/presentation/XSlideShow.idl>


 module com {  module sun {  module star {  module presentation {


/** interface to control a running slide show.

    @see XPresentation2
    @since OOo 3.0
*/
interface XSlideShowController
{

    /** returns true if the slide show is still running.
        If this returns false, this component is already disposed.
        You can start a new slide show and get a new instance
        of XSlideShowController from XPresentation2
    */
    boolean isRunning();


    /** @returns
                the number of slides in this slide show.

        @see getSlideByIndex
     */
    long getSlideCount();


    /** gives access to the slides that will be shown in this slide show.

        <p>Slides are returned in the order they will be displayed in the
        presentation which can be different than the orders of slides in
        the document. Not all slides must be present and each slide can
        be used more than once.

        @returns
            the slide at the specified index.

        @param Index
            specifies the position in the list of slides that are displayed
            in this slide show. The first index is 0.

        @throws com::sun::star::lang::IndexOutOfBoundException
            if the index is not valid.

     */
    ::com::sun::star::drawing::XDrawPage getSlideByIndex( [in] long Index )
            raises( com::sun::star::lang::IndexOutOfBoundsException );


    /** adds a listener that receives events while the slide show is running. */
    void addSlideShowListener( [in] XSlideShowListener Listener );


    /** removes a listener. */
    void removeSlideShowListener( [in] XSlideShowListener Listener );


    /** start next effects that wait on a generic trigger.
        <p>If no generic triggers are waiting the next
        slide will be displayed.
    */
    void gotoNextEffect();


    /** undo the last effects that where triggered by a generic trigger.
        <p>If there is no previous effect that can be undone then the
        previous slide will be displayed.
    */
    void gotoPreviousEffect();


    /** goto and display first slide */
    void gotoFirstSlide();


    /** goto and display next slide.
        <p>Remaining effects on the current slide will be skipped.*/
    void gotoNextSlide();


    /** goto and display previous slide.
        <p>Remaining effects on the current slide will be skipped.*/
    void gotoPreviousSlide();


    /** goto and display last slide.
        <p>Remaining effects on the current slide will be skipped.*/
    void gotoLastSlide();


    /** goto the given textual bookmark */
    void gotoBookmark( [in] string Bookmark );


    /** jumps to the given slide.
        <p>The slide can also be a slide that would normally not be shown during
        the current slide show.

        @throws com::sun::star::lang::IllegalArgumentException
            if the given page is not a valid slide of the document for
            which this slide show is started. Also not allowed are master,
            notes and handout pages.
    */
    void gotoSlide( [in] com::sun::star::drawing::XDrawPage Page )
        raises( com::sun::star::lang::IllegalArgumentException );


    /** jumps to the slide at the given index.
    */
    void gotoSlideIndex( [in] long Index );


    /** stop all currently played sounds */
    void stopSound();


    /** pauses the slide show. All effects are paused.
        <p>The slide show continues on next user input or if
        resume() is called.
    */
    void pause();


    /** resumes a paused slide show.
    */
    void resume();


    /** returns `TRUE` if the slide show is currently paused.

        @see pause()
        @see resume()
    */
    boolean isPaused();


    /** pauses the slide show and blanks the screen in the given color.
        <p>Change attribute #Pause to false to unpause
        the slide show.
    */
    void blankScreen( [in] long Color );


    /** activates the user interface of this slide show.

        @see deactivate()
        @see isActive()
    */
    void activate();

    /** can be called to deactivate the user interface of this slide show.

        <p>A deactivated
        @see activate()
        @see isActive()
     */
    void deactivate();


    /** determines if the slide show is active.

        @return
            `TRUE` for UI active slide show
            <br>
            `FALSE` otherwise
     */
    boolean isActive();


    /** returns slide that is currently displayed */
    com::sun::star::drawing::XDrawPage getCurrentSlide();


    /** returns the index of the current slide. */
    long getCurrentSlideIndex();


    /** the index for the slide that is displayed next. */
    long getNextSlideIndex();


    /** returns `TRUE` if the slide show was started to run endlessly.
     */
    boolean isEndless();


    /** Returns `TRUE` if the slide show was started in full-screen mode.
     */
    boolean isFullScreen();


    /** If this attribute is set to `TRUE`, the window of the slide show is
        always on top of all other windows.
     */
    [attribute] boolean AlwaysOnTop;


    /** If this attribute is `TRUE`, the mouse is visible during the
        slide show.
     */
    [attribute] boolean MouseVisible;


    /** If this is `TRUE`, a pen is shown during presentation.

        <p>You can draw on the presentation with this pen.</p>
     */
    [attribute] boolean UsePen;


    /** This attribute changes the color of the pen. */
    [attribute] long PenColor;


    /** returns the actual XSlideShow instance that runs the
        slide show.
        <br>Normally all navigation should be done using this controller and
        not the XSlideShow itself. */
    XSlideShow getSlideShow();

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */