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_XAnimationListener_idl__ 24#define __com_sun_star_animations_XAnimationListener_idl__ 25 26#ifndef __com_sun_star_lang_XEventListener_idl__ 27#include <com/sun/star/lang/XEventListener.idl> 28#endif 29#ifndef __com_sun_star_animations_XAnimationNode_idl__ 30#include <com/sun/star/animations/XAnimationNode.idl> 31#endif 32 33//============================================================================= 34 35 module com { module sun { module star { module animations { 36 37//============================================================================= 38 39/** makes it possible to register listeners, which are called whenever 40 an animation event occurs. 41 42 @since OpenOffice 3.0 43 */ 44published interface XAnimationListener : ::com::sun::star::lang::XEventListener 45{ 46 /** This event is raised when the element local timeline begins to play. 47 <p>It will be raised each time the element begins the active duration (i.e. when it restarts, but not when it repeats).</p> 48 <p>It may be raised both in the course of normal (i.e. scheduled or interactive) timeline play, as well as in the 49 case that the element was begun with an interface method.</p> 50 51 @param Node 52 The node that begins to play. 53 */ 54 void beginEvent( [in] XAnimationNode Node ); 55 56 /** This event is raised at the active end of the element. 57 <p>Note that this event is not raised at the simple end of each repeat.</p> 58 <p>This event may be raised both in the course of normal (i.e. scheduled or interactive) timeline play, as well as in the 59 case that the element was ended with a DOM method.</p> 60 61 @param Node 62 The node that stops playing. 63 */ 64 void endEvent( [in] XAnimationNode Node ); 65 66 /** This event is raised when the element local timeline repeats. 67 <p>It will be raised each time the element repeats, after the first iteration.</p> 68 <p>Associated with the repeat event is an integer that indicates which repeat iteration is 69 beginning. 70 71 @param Node 72 The node that repeats. 73 74 @param Repeat 75 The value is a 0-based integer, but the repeat event is not raised for the first iteration and so the observed values will be >= 1. 76 */ 77 void repeat( [in] XAnimationNode Node, [in] long Repeat ); 78}; 79 80//============================================================================= 81 82}; }; }; }; 83 84#endif 85