epoc32/include/animationevents.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // 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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __ANIMATIONEVENTS_H__
    17 #define __ANIMATIONEVENTS_H__
    18 
    19 /** Generic events which all animation data providers can pass to animators.
    20 
    21 An implementation of CAnimation may intercept these and perform additional
    22 processing if necessary.  
    23 
    24 Events specific to a particular data type should take values greater than
    25 EAnimationReservedEvents.  Implementations of CAnimation should not intercept
    26 or attempt to act on data type specific events.
    27 @publishedAll
    28 @released */
    29 enum TAnimationEvent
    30 	{
    31 	/** Sent when the data itself has changed and the animator needs to be
    32 	ready to	receive the new values */
    33 	EAnimationDataChanged,
    34 	/** Sent when an error occurs within the data provider and it is unable
    35 	to complete the sending of the animation data */
    36 	EAnimationDataProviderError,
    37 	/** Specifies an upper limit for generic events.  Events larger than this
    38 	are free to use for data type specific information */
    39 	EAnimationReservedEvents = 0xFF
    40 	};
    41 
    42 /** Events specific to the "bitmap" data type.  These events are only sent
    43 by data providers dealing with bitmap frame animations, and are only understood
    44 by bitmap animators.
    45 @publishedAll
    46 @released */
    47 enum TBitmapAnimationEvent
    48 	{
    49 	/** This event contains data specifying the bitmaps for a new frame of
    50 	animation */
    51 	EBitmapAnimationNewFrame = EAnimationReservedEvents + 1,
    52 	/** This event indicates that there are no more frames to send */
    53 	EBitmapAnimationComplete,
    54 	};
    55 
    56 #endif //__ANIMATIONEVENTS_H__