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

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