offapi/com/sun/star/animations/XIterateContainer.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: XIterateContainer.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_animations_XIterateContainer_idl__
  31 #define __com_sun_star_animations_XIterateContainer_idl__
  32
  33 #ifndef __com_sun_star_animations_XTimeContainer_idl__
  34 #include <com/sun/star/animations/XTimeContainer.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module animations {
  40
  41 //=============================================================================
  42
  43 /** An iterate container iterates over subitems of a given target object
  44     and animates them by subsequently executes the contained effects on them.
  45     <br>
  46     This could be used to animate a target text word by word or letter by
  47     letter.
  48 */
  49 interface XIterateContainer : XTimeContainer
  50 {
  51     /** a target that contains iterateable contents, f.e. a paragraph.
  52         <br>
  53         See documentation of used animation engine for supported targets.
  54     */
  55     [attribute] any Target;
  56
  57     /** This attribute specifies an optional subitem from the target element
  58         that should be animated.
  59         <br>
  60         A value of zero should always be the default and animate the complete target.
  61         <br>
  62         See documentation of used animation engine for supported subitems.
  63     */
  64     [attribute] short SubItem;
  65
  66     /** the type of iteration, this depends on the target.
  67         <br>
  68         See documentation of used animation engine for supported iteration types.
  69     */
  70     [attribute] short IterateType;
  71
  72     /** the time interval in percentage of the containers running time
  73         before the next iterated content is animated.
  74     */
  75     [attribute] double IterateInterval;
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 #endif