1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_presentation_XTransitionFactory_idl__
28#define __com_sun_star_presentation_XTransitionFactory_idl__
29
30#ifndef __com_sun_star_presentation_XTransition_idl__
31#include <com/sun/star/presentation/XTransition.idl>
32#endif
33#ifndef __com_sun_star_geometry_RealPoint2D_idl__
34#include <com/sun/star/geometry/RealPoint2D.idl>
35#endif
36
37
38module com {  module sun {  module star {
39
40module rendering { interface XBitmap; };
41
42module presentation {
43
44interface XTransition;
45interface XSlideShowView;
46
47/** TransitionFactory interface to request optional custom Transition instances for slideshow transitions.<p>
48
49    This interface provides the necessary methods to query and create optional transition effects for a SlideShow<p>
50
51    @since OOo 2.4
52 */
53interface XTransitionFactory : ::com::sun::star::uno::XInterface
54{
55    /** Checks whether this instance provides an implementation for given transition id.<p>
56     */
57    boolean hasTransition( [in] short transitionType, [in] short transitionSubType );
58
59    /** Actually create a transition for the given transition id
60
61        @param transitionType
62        Main type of transition (@see ::com::sun::star::animation::TransitionType)
63
64        @param transitionSubType
65        Subtype for the transition (@see ::com::sun::star::animation::TransitionSubType)
66
67        @param view
68        Slideshow view to display on
69
70        @param leavingBitmap
71        Bitmap of the slide that's going to leave the screen
72
73        @param enteringBitmap
74        Bitmap of the slide that's going to enter the screen
75
76        @param slideOffset
77        Offset in pixel from the top, left edge of the view, such that the
78        slide displays similar to normal slideshow
79     */
80    XTransition createTransition( [in] short                                 transitionType,
81                                  [in] short                                 transitionSubType,
82                                  [in] XSlideShowView                        view,
83                                  [in] com::sun::star::rendering::XBitmap    leavingBitmap,
84                                  [in] com::sun::star::rendering::XBitmap    enteringBitmap );
85};
86
87service TransitionFactory : XTransitionFactory;
88
89}; }; }; };
90
91#endif
92
93