offapi/com/sun/star/animations/Event.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_animations_Event_idl__
  28 #define __com_sun_star_animations_Event_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module animations {
  37
  38 //=============================================================================
  39
  40 /** an event has a source that causes an event to be fired and a trigger
  41     that defines under which condition an event should be raised and
  42     an offset if the event should be raised a defined amount of time
  43     after the event is triggered.
  44 */
  45 struct Event
  46 {
  47     /** this is the source for this event. */
  48     any Source;
  49
  50     /** this is the trigger that fires this event. */
  51     short Trigger;
  52
  53     /** an optional offset in seconds or <const>Timing::INDEFINITE</const>. This is the timespan
  54         between the triggering of the event and actually raising the event
  55     */
  56     any Offset;
  57
  58     /** an option repeat value. If the <member>Trigger</member> is
  59         <const>EventTrigger</const>, this is the number of repeats
  60         after wich the event is initially raised.
  61     */
  62     unsigned short Repeat;
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; };
  68
  69 #endif