xref: /trunk/main/offapi/com/sun/star/animations/Event.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_animations_Event_idl__
24cdf0e10cSrcweir#define __com_sun_star_animations_Event_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweir module com {  module sun {  module star {  module animations {
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweir/** an event has a source that causes an event to be fired and a trigger
37cdf0e10cSrcweir    that defines under which condition an event should be raised and
38cdf0e10cSrcweir    an offset if the event should be raised a defined amount of time
39cdf0e10cSrcweir    after the event is triggered.
40cdf0e10cSrcweir*/
41cdf0e10cSrcweirstruct Event
42cdf0e10cSrcweir{
43cdf0e10cSrcweir    /** this is the source for this event. */
44cdf0e10cSrcweir    any Source;
45cdf0e10cSrcweir
46cdf0e10cSrcweir    /** this is the trigger that fires this event. */
47cdf0e10cSrcweir    short Trigger;
48cdf0e10cSrcweir
49cdf0e10cSrcweir    /** an optional offset in seconds or <const>Timing::INDEFINITE</const>. This is the timespan
50cdf0e10cSrcweir        between the triggering of the event and actually raising the event
51cdf0e10cSrcweir    */
52cdf0e10cSrcweir    any Offset;
53cdf0e10cSrcweir
54cdf0e10cSrcweir    /** an option repeat value. If the <member>Trigger</member> is
55cdf0e10cSrcweir        <const>EventTrigger</const>, this is the number of repeats
56*a893be29SPedro Giffuni        after which the event is initially raised.
57cdf0e10cSrcweir    */
58cdf0e10cSrcweir    unsigned short Repeat;
59cdf0e10cSrcweir};
60cdf0e10cSrcweir
61cdf0e10cSrcweir//=============================================================================
62cdf0e10cSrcweir
63cdf0e10cSrcweir}; }; }; };
64cdf0e10cSrcweir
65cdf0e10cSrcweir#endif
66