offapi/com/sun/star/presentation/XTransitionFactory.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: XTransitionFactory.idl,v $
  10  *
  11  * $Revision: 1.3 $
  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_XTransitionFactory_idl__
  32 #define __com_sun_star_presentation_XTransitionFactory_idl__
  33
  34 #ifndef __com_sun_star_presentation_XTransition_idl__
  35 #include <com/sun/star/presentation/XTransition.idl>
  36 #endif
  37 #ifndef __com_sun_star_geometry_RealPoint2D_idl__
  38 #include <com/sun/star/geometry/RealPoint2D.idl>
  39 #endif
  40
  41
  42 module com {  module sun {  module star {
  43
  44 module rendering { interface XBitmap; };
  45
  46 module presentation {
  47
  48 interface XTransition;
  49 interface XSlideShowView;
  50
  51 /** TransitionFactory interface to request optional custom Transition instances for slideshow transitions.<p>
  52
  53     This interface provides the necessary methods to query and create optional transition effects for a SlideShow<p>
  54
  55     @since OOo 2.4
  56  */
  57 interface XTransitionFactory : ::com::sun::star::uno::XInterface
  58 {
  59     /** Checks whether this instance provides an implementation for given transition id.<p>
  60      */
  61     boolean hasTransition( [in] short transitionType, [in] short transitionSubType );
  62
  63     /** Actually create a transition for the given transition id
  64
  65         @param transitionType
  66         Main type of transition (@see ::com::sun::star::animation::TransitionType)
  67
  68         @param transitionSubType
  69         Subtype for the transition (@see ::com::sun::star::animation::TransitionSubType)
  70
  71         @param view
  72         Slideshow view to display on
  73
  74         @param leavingBitmap
  75         Bitmap of the slide that's going to leave the screen
  76
  77         @param enteringBitmap
  78         Bitmap of the slide that's going to enter the screen
  79
  80         @param slideOffset
  81         Offset in pixel from the top, left edge of the view, such that the
  82         slide displays similar to normal slideshow
  83      */
  84     XTransition createTransition( [in] short                                 transitionType,
  85                                   [in] short                                 transitionSubType,
  86                                   [in] XSlideShowView                        view,
  87                                   [in] com::sun::star::rendering::XBitmap    leavingBitmap,
  88                                   [in] com::sun::star::rendering::XBitmap    enteringBitmap );
  89 };
  90
  91 service TransitionFactory : XTransitionFactory;
  92
  93 }; }; }; };
  94
  95 #endif
  96