epoc32/include/mw/animationconfig.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.
     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 "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __ANIMATIONCONFIG_H__
    17 #define __ANIMATIONCONFIG_H__
    18 
    19 struct TAnimationConfig
    20 /** These are passed to animator objects when an animation is started and
    21 provide some control over the manner in which the animation runs.
    22 @publishedAll
    23 @released*/
    24 	{
    25 	enum TFlags
    26 	/** Flag values used by animator objects when an animation is started that
    27 	provide some control over the manner in which the animation runs. 
    28 
    29 	@publishedAll
    30 	@released */
    31  		{
    32 		/** If set, interpret the iData member as the number of times the
    33 		animation should run before automatically stopping itself.*/
    34 		ELoop				= 0x0001,
    35 		/** If set, the animation will start as soon as it can.  By default,
    36 		animations wait for the data to be completely loaded before starting.*/
    37 		EStartImmediately	= 0x0010,
    38 		/** If set, and ELoop is set, interpret the iData member as a number
    39 		of frames to run through, instead of complete cycles.*/
    40 		ECountFrames		= 0x0020,
    41 		/** By default animations which stop after a number of loops return
    42 		to the first frame.  If this flag is set they stop on the last frame.*/
    43 		EEndOnLastFrame 	= 0x0040,
    44 		};
    45 	/** Set this to a combination of the values in TFlags.*/
    46 	TInt iFlags;
    47 	/** The meaning of this item depends on the value of the iFlags member.*/
    48 	TInt iData;
    49 	};
    50 
    51 #endif //__ANIMATIONCONFIG_H__