offapi/com/sun/star/animations/XIterateContainer.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 #ifndef __com_sun_star_animations_XIterateContainer_idl__
  20 #define __com_sun_star_animations_XIterateContainer_idl__
  21
  22 #include <com/sun/star/animations/XTimeContainer.idl>
  23
  24
  25  module com {  module sun {  module star {  module animations {
  26
  27
  28 /** An iterate container iterates over subitems of a given target object
  29     and animates them by subsequently executes the contained effects on them.
  30     <br>
  31     This could be used to animate a target text word by word or letter by
  32     letter.
  33 */
  34 interface XIterateContainer : XTimeContainer
  35 {
  36     /** a target that contains iterable contents, f.e. a paragraph.
  37         <br>
  38         See documentation of used animation engine for supported targets.
  39     */
  40     [attribute] any Target;
  41
  42     /** This attribute specifies an optional subitem from the target element
  43         that should be animated.
  44         <br>
  45         A value of zero should always be the default and animate the complete target.
  46         <br>
  47         See documentation of used animation engine for supported subitems.
  48     */
  49     [attribute] short SubItem;
  50
  51     /** the type of iteration, this depends on the target.
  52         <br>
  53         See documentation of used animation engine for supported iteration types.
  54     */
  55     [attribute] short IterateType;
  56
  57     /** the time interval in percentage of the containers running time
  58         before the next iterated content is animated.
  59     */
  60     [attribute] double IterateInterval;
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */