offapi/com/sun/star/animations/XIterateContainer.idl

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