offapi/com/sun/star/presentation/XTransitionFactory.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {
  22
  23 module rendering { interface XBitmap; };
  24
  25 module presentation {
  26
  27 interface XTransition;
  28 interface XSlideShowView;
  29
  30 /** TransitionFactory interface to request optional custom Transition instances for slide show transitions.<p>
  31
  32     This interface provides the necessary methods to query and create optional transition effects for a SlideShow<p>
  33
  34     @since OOo 2.4
  35  */
  36 interface XTransitionFactory : ::com::sun::star::uno::XInterface
  37 {
  38     /** Checks whether this instance provides an implementation for given transition id.<p>
  39      */
  40     boolean hasTransition( [in] short transitionType, [in] short transitionSubType );
  41
  42     /** Actually create a transition for the given transition id
  43
  44         @param transitionType
  45         Main type of transition (@see ::com::sun::star::animations::TransitionType)
  46
  47         @param transitionSubType
  48         Subtype for the transition (@see ::com::sun::star::animations::TransitionSubType)
  49
  50         @param transitionFadeColor
  51         Color to use (for some transitions)
  52
  53         @param view
  54         Slide show view to display on
  55
  56         @param leavingBitmap
  57         Bitmap of the slide that's going to leave the screen
  58
  59         @param enteringBitmap
  60         Bitmap of the slide that's going to enter the screen
  61      */
  62     XTransition createTransition( [in] short                                 transitionType,
  63                                   [in] short                                 transitionSubType,
  64                                   [in] long                                  transitionFadeColor,
  65                                   [in] XSlideShowView                        view,
  66                                   [in] com::sun::star::rendering::XBitmap    leavingBitmap,
  67                                   [in] com::sun::star::rendering::XBitmap    enteringBitmap );
  68 };
  69
  70 }; }; }; };
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */