offapi/com/sun/star/animations/AnimationFill.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_AnimationFill_idl__
  20 #define __com_sun_star_animations_AnimationFill_idl__
  21
  22
  23  module com {  module sun {  module star {  module animations {
  24
  25
  26 /** This constants are used for the members fill() and fillDefault()
  27     of the an XTimeContainer.
  28
  29     @see XTimeContainer
  30     @see http://www.w3.org/TR/smil20/smil-timing.html#adef-fill
  31 */
  32 constants AnimationFill
  33 {
  34     /**  The fill behavior for the element is determined by the value of the XTiming::FillDefault attribute.
  35          This is the default value for the XTiming::Fill..
  36          If the application of fillDefault to an element would result in the element having a value
  37          of fill that is not allowed on that element, the element will instead have a fill value of
  38          AnimationFill::AUTO.
  39      */
  40     const short DEFAULT = 0;
  41
  42     /** Specifies that the value of this attribute (and of the fill behavior) are
  43         inherited from the XTiming::FillDefault value
  44         of the parent element. If there is no parent element, the value is AnimationFill::AUTO.
  45         This is the default value for the XTiming::FillDefault.
  46     */
  47     const short INHERIT = 0;
  48
  49     /** Specifies that the element will not extend past the end of the last instance of the simple duration.  */
  50     const short REMOVE = 1;
  51
  52     /** Specifies that the element will extend past the end of the last instance of the simple duration by
  53         "freezing" the element state at that point. The parent time container of the element determines how
  54         long the element is frozen (as described immediately below).
  55     */
  56     const short FREEZE = 2;
  57
  58     /** Setting this to "hold" has the same effect as setting to "freeze", except that the element is always
  59         frozen to extend to the end of the simple duration of the parent time container of the element
  60         (independent of the type of time container). For profiles that support a layered layout model
  61         (e.g., SMIL 2.0 Language Profile), held elements (elements with fill="hold") will refresh their display
  62         area when a layer is added on top then later removed.
  63     */
  64     const short HOLD = 3;
  65
  66     /** Setting this to "transition" has the same effect as setting to "freeze", except that the element is
  67         removed at the end of the transition. This value is only allowed on elements with media directly
  68         associated with them. If specified on any other element (e.g. a time container element in the SMIL
  69         language profile), the attribute is ignored. See the SMIL Transitions module.
  70     */
  71     const short TRANSITION = 4;
  72
  73     /** The fill behavior for this element depends on whether the element specifies any of the attributes
  74         that define the simple or active duration:
  75         <ul>
  76         <li>If none of the attributes duration, end, repeatCount or repeatDuration are specified on
  77         the element, then the element will have a fill behavior identical to that if it were specified
  78         as AnimationFill::FREEZE.</li>
  79         <li>Otherwise, the element will have a fill behavior identical to that if it were specified as
  80         AnimationFill::REMOVE.</li>
  81         </ul>
  82     */
  83     const short AUTO = 5;
  84 };
  85
  86
  87 }; }; }; };
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */