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.
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 __ANIMATIONCONFIG_H__
williamr@2
    17
#define __ANIMATIONCONFIG_H__
williamr@2
    18
williamr@2
    19
struct TAnimationConfig
williamr@2
    20
/** These are passed to animator objects when an animation is started and
williamr@2
    21
provide some control over the manner in which the animation runs.
williamr@2
    22
@publishedAll
williamr@2
    23
@released*/
williamr@2
    24
	{
williamr@2
    25
	enum TFlags
williamr@2
    26
	/** Flag values used by animator objects when an animation is started that
williamr@2
    27
	provide some control over the manner in which the animation runs. 
williamr@2
    28
williamr@2
    29
	@publishedAll
williamr@2
    30
	@released */
williamr@2
    31
 		{
williamr@2
    32
		/** If set, interpret the iData member as the number of times the
williamr@2
    33
		animation should run before automatically stopping itself.*/
williamr@2
    34
		ELoop				= 0x0001,
williamr@2
    35
		/** If set, the animation will start as soon as it can.  By default,
williamr@2
    36
		animations wait for the data to be completely loaded before starting.*/
williamr@2
    37
		EStartImmediately	= 0x0010,
williamr@2
    38
		/** If set, and ELoop is set, interpret the iData member as a number
williamr@2
    39
		of frames to run through, instead of complete cycles.*/
williamr@2
    40
		ECountFrames		= 0x0020,
williamr@2
    41
		/** By default animations which stop after a number of loops return
williamr@2
    42
		to the first frame.  If this flag is set they stop on the last frame.*/
williamr@2
    43
		EEndOnLastFrame 	= 0x0040,
williamr@2
    44
		};
williamr@2
    45
	/** Set this to a combination of the values in TFlags.*/
williamr@2
    46
	TInt iFlags;
williamr@2
    47
	/** The meaning of this item depends on the value of the iFlags member.*/
williamr@2
    48
	TInt iData;
williamr@2
    49
	};
williamr@2
    50
williamr@2
    51
#endif //__ANIMATIONCONFIG_H__