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