1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_animations_XTransitionFilter_idl__ 24#define __com_sun_star_animations_XTransitionFilter_idl__ 25 26#ifndef __com_sun_star_animations_XAnimate_idl__ 27#include <com/sun/star/animations/XAnimate.idl> 28#endif 29 30//============================================================================= 31 32 module com { module sun { module star { module animations { 33 34//============================================================================= 35 36/** 37 Base members <member>XAnimate::Values</member>, <member>XAnimate::From</member>, 38 <member>XAnimate::To</member> and <member>XAnimate::By</member> can be used 39 with <atom>double</atom> values that set the transition progress the specific 40 amount of time. 41 42 43 @see http://www.w3.org/TR/smil20/smil-transitions.html#edef-transitionFilter 44*/ 45interface XTransitionFilter : XAnimate 46{ 47 /** This is the type or family of transition. 48 <br>This attribute is required and must be one of the transition families listed in 49 <const>TransitionType</const>. 50 */ 51 [attribute] short Transition; 52 53 /** This is the subtype of the transition. 54 <br> 55 This must be one of the transition subtypes appropriate for the specified <member>Type</member> 56 as listed in <const>TransitionSubType</const>. 57 <const>TransitionSubType::DEFAULT</const> is the default. 58 */ 59 [attribute] short Subtype; 60 61 /** Indicates whether the transitionFilter's parent element will transition in or out. 62 Legal values are <true/> indicating that the parent media will become more visible as 63 the transition progress increases and <false/> indicating that the parent media will 64 become less visible as the transition progress increases. 65 66 The default value is <true/>. 67 */ 68 [attribute] boolean Mode; 69 70 /** This specifies the direction the transition will run. 71 <br> 72 The legal values are <true/> for forward and <false/> for reverse. 73 The default value is <true/>. 74 Note that this does not impact the media being transitioned to, but 75 only affects the geometry of the transition. 76 Transitions which do not have a reverse interpretation should ignore the 77 direction attribute and assume the default value of <true/>. 78 */ 79 [attribute] boolean Direction; 80 81 /** If the value of the <member>Type</member> attribute is <const>TransitionType::FADE</const> and 82 the value of the <member>Subtype</member> attribute is <const>TransitionSubType::FADETOCOLOR</const> or 83 <const>TransitionSubType::FADEFROMCOLOR</const>, then this attribute specifies the starting or ending 84 color of the fade. 85 The default value is 0 (black). 86 87 */ 88 [attribute] long FadeColor; 89}; 90 91//============================================================================= 92 93}; }; }; }; 94 95#endif 96