xref: /aoo42x/main/offapi/com/sun/star/animations/Event.idl (revision a893be29)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_animations_Event_idl__
#define __com_sun_star_animations_Event_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module animations {

//=============================================================================

/** an event has a source that causes an event to be fired and a trigger
	that defines under which condition an event should be raised and
	an offset if the event should be raised a defined amount of time
	after the event is triggered.
*/
struct Event
{
	/** this is the source for this event. */
	any Source;

	/** this is the trigger that fires this event. */
	short Trigger;

	/** an optional offset in seconds or <const>Timing::INDEFINITE</const>. This is the timespan
		between the triggering of the event and actually raising the event
	*/
	any Offset;

	/** an option repeat value. If the <member>Trigger</member> is
		<const>EventTrigger</const>, this is the number of repeats
		after which the event is initially raised.
	*/
	unsigned short Repeat;
};

//=============================================================================

}; }; }; };

#endif