From a3071747ec4c5990eb5d7f460959f79234c6600b Mon Sep 17 00:00:00 2001 From: Kurt Zenker Date: Thu, 3 Apr 2008 14:38:10 +0000 Subject: INTEGRATION: CWS presenterview (1.1.2); FILE ADDED 2008/01/09 18:24:23 cl 1.1.2.3: #i15900# moved slideshow api to offapi 2007/03/21 15:32:24 cl 1.1.2.2: #i71351# added XIndexAccess for slides in presentation and XComponent 2007/02/27 08:58:42 cl 1.1.2.1: #i71351# added api draft for a slideshow controller --- .../sun/star/presentation/XSlideShowController.idl | 307 +++++++++++++++++++++ 1 file changed, 307 insertions(+) create mode 100644 offapi/com/sun/star/presentation/XSlideShowController.idl (limited to 'offapi/com/sun/star/presentation') diff --git a/offapi/com/sun/star/presentation/XSlideShowController.idl b/offapi/com/sun/star/presentation/XSlideShowController.idl new file mode 100644 index 000000000000..33a3ad30fe45 --- /dev/null +++ b/offapi/com/sun/star/presentation/XSlideShowController.idl @@ -0,0 +1,307 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XSlideShowController.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: kz $ $Date: 2008-04-03 15:38:10 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + ************************************************************************/ +#ifndef __com_sun_star_presentation_XSlideShowController_idl__ +#define __com_sun_star_presentation_XSlideShowController_idl__ + +#ifndef __com_sun_star_drawing_XDrawPage_idl__ +#include +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include +#endif + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include +#endif + +#ifndef __com_sun_star_presentation_XSlideShow_idl__ +#include +#endif + +//============================================================================= + + module com { module sun { module star { module presentation { + +//============================================================================= + +/** interface to control a running slideshow. + + @since OOo 2.4 +*/ +interface XSlideShowController +{ + //------------------------------------------------------------------------- + + /** returns true if the slideshow is still running. + If this returns false, this component is already disposed. + You can start a new slideshow and get a new instance + of XSlideShowController from XPresentation2 + */ + boolean isRunning(); + + //------------------------------------------------------------------------- + + /** @returns + the number of slides in this slideshow. + + @see getSlideByIndex + */ + long getSlideCount(); + + //------------------------------------------------------------------------- + + /** gives access to the slides that will be shown in this slideshow. + +

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 slideshow. 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 ); + + //------------------------------------------------------------------------- + + /** addes a listener that recieves events while the slideshow is running. */ + void addSlideShowListener( [in] XSlideShowListener Listener ); + + //------------------------------------------------------------------------- + + /** removes a listener. */ + void removeSlideShowListener( [in] XSlideShowListener Listener ); + + //------------------------------------------------------------------------- + + /** start next effects that wait on a generic trigger. +

If no generic triggers are waiting the next + slide will be displayed. + */ + void gotoNextEffect(); + + //------------------------------------------------------------------------- + + /** goto and display first slide */ + void gotoFirstSlide(); + + //------------------------------------------------------------------------- + + /** goto and display next slide. +

Remaining effects on the current slide will be skiped.*/ + void gotoNextSlide(); + + //------------------------------------------------------------------------- + + /** goto and display previous slide. +

Remaining effects on the current slide will be skiped.*/ + void gotoPreviousSlide(); + + //------------------------------------------------------------------------- + + /** goto and display last slide. +

Remaining effects on the current slide will be skiped.*/ + void gotoLastSlide(); + + //------------------------------------------------------------------------- + + /** goto the given textual bookmark */ + void gotoBookmark( [in] string Bookmark ); + + //------------------------------------------------------------------------- + + /** jumps to the given slide. +

The slide can also be a slide that would normaly not be shown during + the current slideshow. + + @throws com::sun::star::lang::IllegalArgumentException + if the given page is not a valid slide of the document for + which this slideshow 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 slideshow. All effects are paused. +

The slideshow continues on next user input or if + resume is called. + */ + void pause(); + + //------------------------------------------------------------------------- + + /** resumes a paused slideshow. + */ + void resume(); + + //------------------------------------------------------------------------- + + /** returns if the slideshow is currently paused. + + @see pause + @see resume + */ + boolean isPaused(); + + //------------------------------------------------------------------------- + + /** pauses the slideshow and blanks the screen in the given color. +

Change attribute Pause to false to unpause + the slideshow. + */ + void blankScreen( [in] long Color ); + + //------------------------------------------------------------------------- + + /** activates the user interface of this slideshow. + + @see deactivate() + @see isActive() + */ + void activate(); + + //------------------------------------------------------------------------- + /** can be called to deactivate the user interface of this slideshow. + +

A deactivated + @see activate() + @see isActive() + */ + void deactivate(); + + //------------------------------------------------------------------------- + + /** determines if the slideshow is active. + + @return + for UI active slideshow +
+ 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 if the slideshow was started to run endlessly. + */ + boolean isEndless(); + + //------------------------------------------------------------------------- + + /** Returns if the slideshow was started in full-screen mode. + */ + boolean isFullScreen(); + + //------------------------------------------------------------------------- + + /** If this attribute is set to , the window of the slideshow is + always on top of all other windows. + */ + [attribute] boolean AlwaysOnTop; + + //------------------------------------------------------------------------- + + /** If this attribute is , the mouse is visible during the + slideshow. + */ + [attribute] boolean MouseVisible; + + //------------------------------------------------------------------------- + + /** If this is , a pen is shown during presentation. + +

You can draw on the presentation with this pen.

+ */ + [attribute] boolean UsePen; + + //------------------------------------------------------------------------- + + /** This attribute changes the color of the pen. */ + [attribute] long PenColor; + + //------------------------------------------------------------------------- + + /** returns the actuall XSlideShow instance that runs the + slideshow. +
Normaly all navigation should be done using this controller and + not the XSlideShow itself. */ + XSlideShow getSlideShow(); + + //------------------------------------------------------------------------- +}; + +//============================================================================= + +}; }; }; }; + +#endif -- cgit v1.2.3