epoc32/include/animationevents.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/animationevents.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/animationevents.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,56 @@
     1.4 -animationevents.h
     1.5 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +//
    1.19 +
    1.20 +#ifndef __ANIMATIONEVENTS_H__
    1.21 +#define __ANIMATIONEVENTS_H__
    1.22 +
    1.23 +/** Generic events which all animation data providers can pass to animators.
    1.24 +
    1.25 +An implementation of CAnimation may intercept these and perform additional
    1.26 +processing if necessary.  
    1.27 +
    1.28 +Events specific to a particular data type should take values greater than
    1.29 +EAnimationReservedEvents.  Implementations of CAnimation should not intercept
    1.30 +or attempt to act on data type specific events.
    1.31 +@publishedAll
    1.32 +@released */
    1.33 +enum TAnimationEvent
    1.34 +	{
    1.35 +	/** Sent when the data itself has changed and the animator needs to be
    1.36 +	ready to	receive the new values */
    1.37 +	EAnimationDataChanged,
    1.38 +	/** Sent when an error occurs within the data provider and it is unable
    1.39 +	to complete the sending of the animation data */
    1.40 +	EAnimationDataProviderError,
    1.41 +	/** Specifies an upper limit for generic events.  Events larger than this
    1.42 +	are free to use for data type specific information */
    1.43 +	EAnimationReservedEvents = 0xFF
    1.44 +	};
    1.45 +
    1.46 +/** Events specific to the "bitmap" data type.  These events are only sent
    1.47 +by data providers dealing with bitmap frame animations, and are only understood
    1.48 +by bitmap animators.
    1.49 +@publishedAll
    1.50 +@released */
    1.51 +enum TBitmapAnimationEvent
    1.52 +	{
    1.53 +	/** This event contains data specifying the bitmaps for a new frame of
    1.54 +	animation */
    1.55 +	EBitmapAnimationNewFrame = EAnimationReservedEvents + 1,
    1.56 +	/** This event indicates that there are no more frames to send */
    1.57 +	EBitmapAnimationComplete,
    1.58 +	};
    1.59 +
    1.60 +#endif //__ANIMATIONEVENTS_H__