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

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