offapi/com/sun/star/presentation/XSlideShowController.idl

   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
  24 /** interface to control a running slide show.
  25
  26     @see XPresentation2
  27     @since OOo 3.0
  28 */
  29 interface XSlideShowController
  30 {
  31
  32     /** returns true if the slide show is still running.
  33         If this returns false, this component is already disposed.
  34         You can start a new slide show and get a new instance
  35         of XSlideShowController from XPresentation2
  36     */
  37     boolean isRunning();
  38
  39
  40     /** @returns
  41                 the number of slides in this slide show.
  42
  43         @see getSlideByIndex
  44      */
  45     long getSlideCount();
  46
  47
  48     /** gives access to the slides that will be shown in this slide show.
  49
  50         <p>Slides are returned in the order they will be displayed in the
  51         presentation which can be different than the orders of slides in
  52         the document. Not all slides must be present and each slide can
  53         be used more than once.
  54
  55         @returns
  56             the slide at the specified index.
  57
  58         @param Index
  59             specifies the position in the list of slides that are displayed
  60             in this slide show. The first index is 0.
  61
  62         @throws com::sun::star::lang::IndexOutOfBoundsException
  63             if the index is not valid.
  64
  65      */
  66     ::com::sun::star::drawing::XDrawPage getSlideByIndex( [in] long Index )
  67             raises( com::sun::star::lang::IndexOutOfBoundsException );
  68
  69
  70     /** adds a listener that receives events while the slide show is running. */
  71     void addSlideShowListener( [in] XSlideShowListener Listener );
  72
  73
  74     /** removes a listener. */
  75     void removeSlideShowListener( [in] XSlideShowListener Listener );
  76
  77
  78     /** start next effects that wait on a generic trigger.
  79         <p>If no generic triggers are waiting the next
  80         slide will be displayed.
  81     */
  82     void gotoNextEffect();
  83
  84
  85     /** undo the last effects that were triggered by a generic trigger.
  86         <p>If there is no previous effect that can be undone then the
  87         previous slide will be displayed.
  88     */
  89     void gotoPreviousEffect();
  90
  91
  92     /** goto and display first slide */
  93     void gotoFirstSlide();
  94
  95
  96     /** goto and display next slide.
  97         <p>Remaining effects on the current slide will be skipped.*/
  98     void gotoNextSlide();
  99
 100
 101     /** goto and display previous slide.
 102         <p>Remaining effects on the current slide will be skipped.*/
 103     void gotoPreviousSlide();
 104
 105
 106     /** goto and display last slide.
 107         <p>Remaining effects on the current slide will be skipped.*/
 108     void gotoLastSlide();
 109
 110
 111     /** goto the given textual bookmark */
 112     void gotoBookmark( [in] string Bookmark );
 113
 114
 115     /** jumps to the given slide.
 116         <p>The slide can also be a slide that would normally not be shown during
 117         the current slide show.
 118
 119         @throws com::sun::star::lang::IllegalArgumentException
 120             if the given page is not a valid slide of the document for
 121             which this slide show is started. Also not allowed are master,
 122             notes and handout pages.
 123     */
 124     void gotoSlide( [in] com::sun::star::drawing::XDrawPage Page )
 125         raises( com::sun::star::lang::IllegalArgumentException );
 126
 127
 128     /** jumps to the slide at the given index.
 129     */
 130     void gotoSlideIndex( [in] long Index );
 131
 132
 133     /** stop all currently played sounds */
 134     void stopSound();
 135
 136
 137     /** pauses the slide show. All effects are paused.
 138         <p>The slide show continues on next user input or if
 139         resume() is called.
 140     */
 141     void pause();
 142
 143
 144     /** resumes a paused slide show.
 145     */
 146     void resume();
 147
 148
 149     /** returns `TRUE` if the slide show is currently paused.
 150
 151         @see pause()
 152         @see resume()
 153     */
 154     boolean isPaused();
 155
 156
 157     /** pauses the slide show and blanks the screen in the given color.
 158         <p>Change attribute Pause to false to unpause
 159         the slide show.
 160     */
 161     void blankScreen( [in] long Color );
 162
 163
 164     /** activates the user interface of this slide show.
 165
 166         @see deactivate()
 167         @see isActive()
 168     */
 169     void activate();
 170
 171     /** can be called to deactivate the user interface of this slide show.
 172
 173         <p>A deactivated
 174         @see activate()
 175         @see isActive()
 176      */
 177     void deactivate();
 178
 179
 180     /** determines if the slide show is active.
 181
 182         @return
 183             `TRUE` for UI active slide show
 184             <br>
 185             `FALSE` otherwise
 186      */
 187     boolean isActive();
 188
 189
 190     /** returns slide that is currently displayed */
 191     com::sun::star::drawing::XDrawPage getCurrentSlide();
 192
 193
 194     /** returns the index of the current slide. */
 195     long getCurrentSlideIndex();
 196
 197
 198     /** the index for the slide that is displayed next. */
 199     long getNextSlideIndex();
 200
 201
 202     /** returns `TRUE` if the slide show was started to run endlessly.
 203      */
 204     boolean isEndless();
 205
 206
 207     /** Returns `TRUE` if the slide show was started in full-screen mode.
 208      */
 209     boolean isFullScreen();
 210
 211
 212     /** If this attribute is set to `TRUE`, the window of the slide show is
 213         always on top of all other windows.
 214      */
 215     [attribute] boolean AlwaysOnTop;
 216
 217
 218     /** If this attribute is `TRUE`, the mouse is visible during the
 219         slide show.
 220      */
 221     [attribute] boolean MouseVisible;
 222
 223
 224     /** If this is `TRUE`, a pen is shown during presentation.
 225
 226         <p>You can draw on the presentation with this pen.</p>
 227      */
 228     [attribute] boolean UsePen;
 229
 230
 231     /** This attribute changes the color of the pen. */
 232     [attribute] long PenColor;
 233
 234     /** This attribute changes the width of the pen.
 235
 236         @since LibreOffice 4.2
 237     */
 238     [attribute] double PenWidth;
 239
 240
 241     /** This method clears ink drawing from the slideshow being played
 242
 243         @since LibreOffice 7.2
 244     */
 245     void setEraseAllInk( [in] boolean EraseAllInk );
 246
 247     /** returns the actual XSlideShow instance that runs the
 248         slide show.
 249         <br>Normally all navigation should be done using this controller and
 250         not the XSlideShow itself. */
 251     XSlideShow getSlideShow();
 252
 253 };
 254
 255
 256 }; }; }; };
 257
 258 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */