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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSlideShowController.idl,v $
  10  *
  11  * $Revision: 1.4 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31 #ifndef __com_sun_star_presentation_XSlideShowController_idl__
  32 #define __com_sun_star_presentation_XSlideShowController_idl__
  33
  34 #ifndef __com_sun_star_drawing_XDrawPage_idl__
  35 #include <com/sun/star/drawing/XDrawPage.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XIndexAccess_idl__
  39 #include <com/sun/star/container/XIndexAccess.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_XComponent_idl__
  43 #include <com/sun/star/lang/XComponent.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_presentation_XSlideShow_idl__
  47 #include <com/sun/star/presentation/XSlideShow.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module presentation {
  53
  54 //=============================================================================
  55
  56 /** interface to control a running slideshow.
  57
  58     @see XPresentation2
  59     @since OOo 3.0
  60 */
  61 interface XSlideShowController
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** returns true if the slideshow is still running.
  66         If this returns false, this component is already disposed.
  67         You can start a new slideshow and get a new instance
  68         of <type>XSlideShowController</type> from <type>XPresentation2</type>
  69     */
  70     boolean isRunning();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** @returns
  75                 the number of slides in this slideshow.
  76
  77         @see getSlideByIndex
  78      */
  79     long getSlideCount();
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** gives access to the slides that will be shown in this slideshow.
  84
  85         <p>Slides are returned in the order they will be displayed in the
  86         presentation which can be different than the orders of slides in
  87         the document. Not all slides must be present and each slide can
  88         be used more than once.
  89
  90         @returns
  91             the slide at the specified index.
  92
  93         @param Index
  94             specifies the position in the list of slides that are displayed
  95             in this slideshow. The first index is 0.
  96
  97         @throws com::sun::star::lang::IndexOutOfBoundException
  98             if the index is not valid.
  99
 100      */
 101     ::com::sun::star::drawing::XDrawPage getSlideByIndex( [in] long Index )
 102             raises( com::sun::star::lang::IndexOutOfBoundsException );
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** addes a listener that recieves events while the slideshow is running. */
 107     void addSlideShowListener( [in] XSlideShowListener Listener );
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** removes a listener. */
 112     void removeSlideShowListener( [in] XSlideShowListener Listener );
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** start next effects that wait on a generic trigger.
 117         <p>If no generic triggers are waiting the next
 118         slide will be displayed.
 119     */
 120     void gotoNextEffect();
 121
 122     //-------------------------------------------------------------------------
 123
 124         /** undo the last effects that where triggered by a generic trigger.
 125                 <p>If there is no previous effect that can be undone then the
 126                 previous slide will be displayed.
 127         */
 128         void gotoPreviousEffect();
 129
 130         //-------------------------------------------------------------------------
 131
 132     /** goto and display first slide */
 133     void gotoFirstSlide();
 134
 135     //-------------------------------------------------------------------------
 136
 137     /** goto and display next slide.
 138         <p>Remaining effects on the current slide will be skiped.*/
 139     void gotoNextSlide();
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** goto and display previous slide.
 144         <p>Remaining effects on the current slide will be skiped.*/
 145     void gotoPreviousSlide();
 146
 147     //-------------------------------------------------------------------------
 148
 149     /** goto and display last slide.
 150         <p>Remaining effects on the current slide will be skiped.*/
 151     void gotoLastSlide();
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** goto the given textual bookmark */
 156     void gotoBookmark( [in] string Bookmark );
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** jumps to the given slide.
 161         <p>The slide can also be a slide that would normaly not be shown during
 162         the current slideshow.
 163
 164         @throws com::sun::star::lang::IllegalArgumentException
 165             if the given page is not a valid slide of the document for
 166             which this slideshow is started. Also not allowed are master,
 167             notes and handout pages.
 168     */
 169     void gotoSlide( [in] com::sun::star::drawing::XDrawPage Page )
 170         raises( com::sun::star::lang::IllegalArgumentException );
 171
 172     //-------------------------------------------------------------------------
 173
 174     /** jumps to the slide at the given index.
 175     */
 176     void gotoSlideIndex( [in] long Index );
 177
 178     //-------------------------------------------------------------------------
 179
 180     /** stop all currently played sounds */
 181     void stopSound();
 182
 183     //-------------------------------------------------------------------------
 184
 185     /** pauses the slideshow. All effects are paused.
 186         <p>The slideshow continues on next user input or if
 187         <member>resume</member> is called.
 188     */
 189     void pause();
 190
 191     //-------------------------------------------------------------------------
 192
 193     /** resumes a paused slideshow.
 194     */
 195     void resume();
 196
 197     //-------------------------------------------------------------------------
 198
 199     /** returns <TRUE/> if the slideshow is currently paused.
 200
 201         @see <member>pause</member>
 202         @see <member>resume</member>
 203     */
 204     boolean isPaused();
 205
 206     //-------------------------------------------------------------------------
 207
 208     /** pauses the slideshow and blanks the screen in the given color.
 209         <p>Change attribute <member>Pause</member> to false to unpause
 210         the slideshow.
 211     */
 212     void blankScreen( [in] long Color );
 213
 214     //-------------------------------------------------------------------------
 215
 216     /** activates the user interface of this slideshow.
 217
 218         @see <member>deactivate()</member>
 219         @see <member>isActive()</member>
 220     */
 221     void activate();
 222
 223     //-------------------------------------------------------------------------
 224     /** can be called to deactivate the user interface of this slideshow.
 225
 226         <p>A deactivated
 227         @see <member>activate()</member>
 228         @see <member>isActive()</member>
 229      */
 230     void deactivate();
 231
 232     //-------------------------------------------------------------------------
 233
 234     /** determines if the slideshow is active.
 235
 236         @return
 237             <TRUE/> for UI active slideshow
 238             <br>
 239             <FALSE/> otherwise
 240      */
 241     boolean isActive();
 242
 243     //-------------------------------------------------------------------------
 244
 245     /** returns slide that is currently displayed */
 246     com::sun::star::drawing::XDrawPage getCurrentSlide();
 247
 248     //-------------------------------------------------------------------------
 249
 250     /** returns the index of the current slide. */
 251     long getCurrentSlideIndex();
 252
 253     //-------------------------------------------------------------------------
 254
 255     /** the index for the slide that is displayed next. */
 256     long getNextSlideIndex();
 257
 258     //-------------------------------------------------------------------------
 259
 260     /** returns <TRUE/> if the slideshow was started to run endlessly.
 261      */
 262     boolean isEndless();
 263
 264     //-------------------------------------------------------------------------
 265
 266     /** Returns <TRUE/> if the slideshow was started in full-screen mode.
 267      */
 268     boolean isFullScreen();
 269
 270     //-------------------------------------------------------------------------
 271
 272     /** If this attribute is set to <TRUE/>, the window of the slideshow is
 273         always on top of all other windows.
 274      */
 275     [attribute] boolean AlwaysOnTop;
 276
 277     //-------------------------------------------------------------------------
 278
 279     /** If this attribute is <TRUE/>, the mouse is visible during the
 280         slideshow.
 281      */
 282     [attribute] boolean MouseVisible;
 283
 284     //-------------------------------------------------------------------------
 285
 286     /** If this is <TRUE/>, a pen is shown during presentation.
 287
 288         <p>You can draw on the presentation with this pen.</p>
 289      */
 290     [attribute] boolean UsePen;
 291
 292     //-------------------------------------------------------------------------
 293
 294     /** This attribute changes the color of the pen. */
 295     [attribute] long PenColor;
 296
 297     //-------------------------------------------------------------------------
 298
 299     /** returns the actuall <type>XSlideShow</type> instance that runs the
 300         slideshow.
 301         <br>Normaly all navigation should be done using this controller and
 302         not the <type>XSlideShow</type> itself. */
 303     XSlideShow getSlideShow();
 304
 305     //-------------------------------------------------------------------------
 306 };
 307
 308 //=============================================================================
 309
 310 }; }; }; };
 311
 312 #endif