diff options
| author | Rüdiger Timm <rt@openoffice.org> | 2008-07-07 12:45:13 +0000 |
|---|---|---|
| committer | Rüdiger Timm <rt@openoffice.org> | 2008-07-07 12:45:13 +0000 |
| commit | 7966f4db58c96ede35f42620e8701bd0004f61e5 (patch) | |
| tree | c2eb86d2bcbd5c667c126775b62bcda73bb18a3b | |
| parent | c3a46d263c32047566e502dc610e2450705c2423 (diff) | |
INTEGRATION: CWS impress146 (1.3.88); FILE MERGED
2008/06/26 13:38:58 cl 1.3.88.1: #i15900# fixed some documentation issues and changed publish date to correct one
5 files changed, 27 insertions, 235 deletions
diff --git a/offapi/com/sun/star/presentation/Presentation2.idl b/offapi/com/sun/star/presentation/Presentation2.idl index 143a7bfea1df..1adc04b4a45b 100644 --- a/offapi/com/sun/star/presentation/Presentation2.idl +++ b/offapi/com/sun/star/presentation/Presentation2.idl @@ -8,7 +8,7 @@ * * $RCSfile: Presentation2.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * * This file is part of OpenOffice.org. * @@ -28,27 +28,15 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_presentation_XSlideShowController_idl__ -#define __com_sun_star_presentation_XSlideShowController_idl__ +#ifndef __com_sun_star_presentation_Presentation2_idl__ +#define __com_sun_star_presentation_Presentation2_idl__ -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> +#ifndef __com_sun_star_presentation_Presentation_idl__ +#include <com/sun/star/presentation/Presentation.idl> #endif -#ifndef __com_sun_star_beans_PropertyValue_idl__ -#include <com/sun/star/beans/PropertyValue.idl> -#endif - -#ifndef __com_sun_star_drawing_XDrawPage_idl__ -#include <com/sun/star/drawing/XDrawPage.idl> -#endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> -#endif - -#ifndef __com_sun_star_lang_XComponent_idl__ -#include <com/sun/star/lang/XComponent.idl> +#ifndef __com_sun_star_presentation_XPresentation2_idl__ +#include <com/sun/star/presentation/XPresentation2.idl> #endif //============================================================================= @@ -57,219 +45,19 @@ //============================================================================= -/** gives control over a running slide show in the presentation module. +/** enhances the Presentation service to give access to a <type>XPresentation2</type> interface. - @since #i71351# + @since OOo 3.0 */ -interface XSlideShowController +service Presentation2 { - //------------------------------------------------------------------------- - - /** allows to dispose this controller and manage event listener. - - <p> You can add <type>XSlideShowListener</type> using the methods - <member>::com::sun::star::lang::XComponent::addEventListener()</member> - */ - interface ::com::sun::star::lang::XComponent; - - //------------------------------------------------------------------------- - - /** gives access to the properties of this controller. - */ - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - /** gives access to the slides that will be shown in this slideshow. - <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. - */ - interface ::com::sun::star::container::XIndexAccess; - - //------------------------------------------------------------------------- - - /** start the slideshow */ - void start( [in] sequence< ::com::sun::star::beans::PropertyValue > Arguments ); - - //------------------------------------------------------------------------- - - /** stop the slideshow - <p>a stopped show can only be restarted from the beginning with a call to - <member>start</member> - */ - void stop(); - - //------------------------------------------------------------------------- - - /** returns true if the slideshow is currently stopped */ - boolean isStopped(); - - //------------------------------------------------------------------------- - - /** start next effects that wait on a generic trigger. - <p>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 */ - void gotoNextSlide(); - - //------------------------------------------------------------------------- - - /** goto and display previous slide */ - void gotoPreviousSlide(); - - //------------------------------------------------------------------------- - - /** goto and display last slide */ - void gotoLastSlide(); - - //------------------------------------------------------------------------- - - /** goto the given textual bookmark */ - void gotoBookmark( [in] string Bookmark ); - - //------------------------------------------------------------------------- - - /** jumps to the given slide. - <p>The slide can be a slide that would normaly not be shown during - the current slideshow. - */ - void gotoSlide( [in] com::sun::star::drawing::XDrawPage Page ); - - //------------------------------------------------------------------------- - - /** 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. - <p>The slideshow continues on next user input or if - <member>resume</member> is called. - */ - void pause(); + service Presentation; - //------------------------------------------------------------------------- - - /** resumes a paused slideshow. - */ - void resume(); - - //------------------------------------------------------------------------- - - /** returns <TRUE/> if the slideshow is currently paused. - - @see <member>pause</member> - @see <member>resume</member> - */ - boolean isPaused(); - - //------------------------------------------------------------------------- - - /** pauses the slideshow and blanks the screen in the given color. - <p>Change attribute <member>Pause</member> to false to unpause - the slideshow. - */ - void blankScreen( [in] long Color ); - - //------------------------------------------------------------------------- - - /** activates the user interface of this slideshow. - - @see <member>deactivate()</member> - @see <member>isActive()</member> - */ - void activate(); - - //------------------------------------------------------------------------- - /** can be called to deactivate the user interface of this slideshow. - - <p>A deactivated - @see <member>activate()</member> - @see <member>isActive()</member> + /** enhances the XPresentation interface to give access to + a <type>XSlideShowController</type> and + to start a presentation with arguments. */ - void deactivate(); - - //------------------------------------------------------------------------- - /** determines if the slideshow is active. - - @return - <TRUE/> for UI active slideshow - <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 slide that is displayed next. */ - long getNextSlideIndex(); - - //------------------------------------------------------------------------- - - /** returns <TRUE/> if the slideshow was started to run endlessly. - */ - boolean isEndless(); - - //------------------------------------------------------------------------- - - /** Returns <TRUE/> if the slideshow was started in full-screen mode. - */ - boolean isFullScreen(); - - //------------------------------------------------------------------------- - - /** If this attribute is set to <TRUE/>, the window of the slideshow is - always on top of all other windows. - */ - [attribute] boolean AlwaysOnTop; - - //------------------------------------------------------------------------- - - /** If this attribute is <TRUE/>, the mouse is visible during the - slideshow. - */ - [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; + interface com::sun::star::presentation::XPresentation2; //------------------------------------------------------------------------- }; diff --git a/offapi/com/sun/star/presentation/XPresentation2.idl b/offapi/com/sun/star/presentation/XPresentation2.idl index 6203ca732be4..7603a72ed0c8 100644 --- a/offapi/com/sun/star/presentation/XPresentation2.idl +++ b/offapi/com/sun/star/presentation/XPresentation2.idl @@ -8,7 +8,7 @@ * * $RCSfile: XPresentation2.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * * This file is part of OpenOffice.org. * @@ -61,7 +61,7 @@ a <type>XSlideShowController</type> and to start a presentation with arguments. - @since OOo 2.4 + @since OOo 3.0 */ interface XPresentation2 { diff --git a/offapi/com/sun/star/presentation/XSlideShow.idl b/offapi/com/sun/star/presentation/XSlideShow.idl index e8946e483eae..3d7f928249c9 100644 --- a/offapi/com/sun/star/presentation/XSlideShow.idl +++ b/offapi/com/sun/star/presentation/XSlideShow.idl @@ -8,7 +8,7 @@ * * $RCSfile: XSlideShow.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * * This file is part of OpenOffice.org. * @@ -70,7 +70,10 @@ module com { module sun { module star { module presentation { slideshow from a given set of XDrawPage slides. The slideshow can be displayed simultaneously on multiple targets.<p> - @since OOo 2.4 + Note: To controll a running slideshow inside a presentation, please + use <type>XPresentation2</type> and <type>XSlideShowController</type>. + + @since OOo 3.0 */ interface XSlideShow : ::com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/presentation/XSlideShowController.idl b/offapi/com/sun/star/presentation/XSlideShowController.idl index 990e669fa37b..9476604a2c77 100644 --- a/offapi/com/sun/star/presentation/XSlideShowController.idl +++ b/offapi/com/sun/star/presentation/XSlideShowController.idl @@ -8,7 +8,7 @@ * * $RCSfile: XSlideShowController.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * * This file is part of OpenOffice.org. * @@ -55,7 +55,8 @@ /** interface to control a running slideshow. - @since OOo 2.4 + @see XPresentation2 + @since OOo 3.0 */ interface XSlideShowController { diff --git a/offapi/com/sun/star/presentation/XSlideShowListener.idl b/offapi/com/sun/star/presentation/XSlideShowListener.idl index b6590af99d9e..90b7dec18e84 100644 --- a/offapi/com/sun/star/presentation/XSlideShowListener.idl +++ b/offapi/com/sun/star/presentation/XSlideShowListener.idl @@ -8,7 +8,7 @@ * * $RCSfile: XSlideShowListener.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * * This file is part of OpenOffice.org. * @@ -41,7 +41,7 @@ module com { module sun { module star { module presentation { @see XShapeEventListener - @since OOo 2.4 + @since OOo 3.0 */ interface XSlideShowListener : ::com::sun::star::animations::XAnimationListener { |