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

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