williamr@2: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: #ifndef __ANIMATIONEVENTS_H__
williamr@2: #define __ANIMATIONEVENTS_H__
williamr@2: 
williamr@2: /** Generic events which all animation data providers can pass to animators.
williamr@2: 
williamr@2: An implementation of CAnimation may intercept these and perform additional
williamr@2: processing if necessary.  
williamr@2: 
williamr@2: Events specific to a particular data type should take values greater than
williamr@2: EAnimationReservedEvents.  Implementations of CAnimation should not intercept
williamr@2: or attempt to act on data type specific events.
williamr@2: @publishedAll
williamr@2: @released */
williamr@2: enum TAnimationEvent
williamr@2: 	{
williamr@2: 	/** Sent when the data itself has changed and the animator needs to be
williamr@2: 	ready to	receive the new values */
williamr@2: 	EAnimationDataChanged,
williamr@2: 	/** Sent when an error occurs within the data provider and it is unable
williamr@2: 	to complete the sending of the animation data */
williamr@2: 	EAnimationDataProviderError,
williamr@2: 	/** Specifies an upper limit for generic events.  Events larger than this
williamr@2: 	are free to use for data type specific information */
williamr@2: 	EAnimationReservedEvents = 0xFF
williamr@2: 	};
williamr@2: 
williamr@2: /** Events specific to the "bitmap" data type.  These events are only sent
williamr@2: by data providers dealing with bitmap frame animations, and are only understood
williamr@2: by bitmap animators.
williamr@2: @publishedAll
williamr@2: @released */
williamr@2: enum TBitmapAnimationEvent
williamr@2: 	{
williamr@2: 	/** This event contains data specifying the bitmaps for a new frame of
williamr@2: 	animation */
williamr@2: 	EBitmapAnimationNewFrame = EAnimationReservedEvents + 1,
williamr@2: 	/** This event indicates that there are no more frames to send */
williamr@2: 	EBitmapAnimationComplete,
williamr@2: 	};
williamr@2: 
williamr@2: #endif //__ANIMATIONEVENTS_H__