diff options
Diffstat (limited to 'offapi/com/sun/star/presentation/XSlideShow.idl')
| -rw-r--r-- | offapi/com/sun/star/presentation/XSlideShow.idl | 48 |
1 files changed, 12 insertions, 36 deletions
diff --git a/offapi/com/sun/star/presentation/XSlideShow.idl b/offapi/com/sun/star/presentation/XSlideShow.idl index d63d71c34..e6fb016f7 100644 --- a/offapi/com/sun/star/presentation/XSlideShow.idl +++ b/offapi/com/sun/star/presentation/XSlideShow.idl @@ -27,62 +27,38 @@ #ifndef _com_sun_star_presentation_XSlideShow_idl #define _com_sun_star_presentation_XSlideShow_idl -#ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif -#ifndef __com_sun_star_beans_PropertyValue_idl__ #include <com/sun/star/beans/PropertyValue.idl> -#endif -#ifndef __com_sun_star_geometry_RealRectangle2D_idl__ #include <com/sun/star/geometry/RealRectangle2D.idl> -#endif -#ifndef __com_sun_star_rendering_XSpriteCanvas_idl__ #include <com/sun/star/rendering/XSpriteCanvas.idl> -#endif -#ifndef __com_sun_star_animations_XAnimationNode_idl__ #include <com/sun/star/animations/XAnimationNode.idl> -#endif -#endif -#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ #include <com/sun/star/lang/XMultiServiceFactory.idl> -#ifndef __com_sun_star_drawing_XDrawPage_idl__ #include <com/sun/star/drawing/XDrawPage.idl> -#endif -#ifndef __com_sun_star_drawing_XDrawPagesSupplier_idl__ #include <com/sun/star/drawing/XDrawPagesSupplier.idl> -#endif -#ifndef __com_sun_star_drawing_XShape_idl__ #include <com/sun/star/drawing/XShape.idl> -#endif -#ifndef __com_sun_star_presentation_XSlideShowView_idl__ #include <com/sun/star/presentation/XSlideShowView.idl> -#endif -#ifndef __com_sun_star_presentation_XSlideShowListener_idl__ #include <com/sun/star/presentation/XSlideShowListener.idl> -#endif -#ifndef __com_sun_star_presentation_XShapeEventListener_idl__ #include <com/sun/star/presentation/XShapeEventListener.idl> -#endif module com { module sun { module star { module presentation { -/** Slideshow interface to perform slideshow presentations.<p> +/** Slide show interface to perform slide show presentations.<p> This interface provides the necessary methods to run and control a - slideshow from a given set of XDrawPage slides. The slideshow can + slide show from a given set of XDrawPage slides. The slide show can be displayed simultaneously on multiple targets.<p> - Note: To controll a running slideshow inside a presentation, please + Note: To control a running slide show inside a presentation, please use <type>XPresentation2</type> and <type>XSlideShowController</type>. @since OOo 3.0 */ interface XSlideShow : ::com::sun::star::uno::XInterface { - /** Trigger the next effect of the slideshow.<p> + /** Trigger the next effect of the slide show.<p> This method triggers the next effect on the currently - displayed slide. If there is currently no slideshow running, + displayed slide. If there is currently no slide show running, this method does nothing. If there are no more effects on the current slide, a possible slide transition effect is issued and the next slide is displayed.<p> @@ -95,7 +71,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface */ boolean nextEffect(); - /** Undo the last effect in the main sequence of the slideshow.<p> + /** Undo the last effect in the main sequence of the slide show.<p> The current slide is displayed as if the last user-triggered effect has never been triggered. If there is no previous effect on the @@ -103,7 +79,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface XSlideShowListener objects, which can then trigger a change to the previous slide. Note that this command is executed asynchronously. Multiple calls to update() may be necessary to complete its execution. - If there is currently no slideshow running, this method does + If there is currently no slide show running, this method does nothing.<p> @return <TRUE/>, if the previous effect was successfully @@ -166,7 +142,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface <li>name: Prefetch, value: ::com::sun::star::drawing::XDrawPage. When given, this slide is prepared in the background to be displayed next. The next call to displaySlide() with the given slide may be faster if there was - enough time for prefatching. If the next call to displaySlide() uses + enough time for prefetching. If the next call to displaySlide() uses a different slide, this will still work but will not have any performance improvements </li> @@ -175,7 +151,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface are triggered. This is typically used when going back one effect leads to the previous slide. On that slide all effects have to be shown in order to continue the backward - travelling. + traveling. When <FALSE/>, the default, then no main sequence effect is triggered. </li> @@ -213,7 +189,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface /** Query the currently displayed slide.<p> @return the instance of the current slide. If there's no - slideshow running at the moment, this method returns an + slide show running at the moment, this method returns an empty reference. */ ::com::sun::star::drawing::XDrawPage getCurrentSlide(); @@ -226,7 +202,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface void registerUserPaintPolygons([in] ::com::sun::star::lang::XMultiServiceFactory xDocFactory); - /** Change a property of the slideshow.<p> + /** Change a property of the slide show.<p> @param aShowProperty Property values, which influence the way the slides are @@ -305,7 +281,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface /** Add a slide show listener.<p> This method adds a listener to the slide show, which will get - notified when a registerend shape is clicked upon, or a new + notified when a registered shape is clicked upon, or a new slide is about to be displayed. Note that the listeners will <em>not</em> be notified, when the slide change is directly requested by one of the nextSlide(), previousSlide() or |