epoc32/include/mw/animationticker.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 __ANIMATIONTICKER_H__
williamr@2
    17
#define __ANIMATIONTICKER_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
class MAnimationTickee;
williamr@2
    22
williamr@2
    23
/** This provides timing information for animators.
williamr@2
    24
williamr@2
    25
You do not need to instantiate an object of this type unless you are writing a
williamr@2
    26
new animation type.
williamr@2
    27
williamr@2
    28
@see MAnimationTickee
williamr@2
    29
@see CAnimationTls
williamr@2
    30
@publishedAll
williamr@2
    31
@released*/
williamr@2
    32
NONSHARABLE_CLASS(CAnimationTicker) : public CBase
williamr@2
    33
	{
williamr@2
    34
public:
williamr@2
    35
    IMPORT_C static CAnimationTicker* NewL(TTimeIntervalMicroSeconds32 aTickLength = 100000);
williamr@2
    36
    IMPORT_C ~CAnimationTicker();
williamr@2
    37
    
williamr@2
    38
	IMPORT_C TInt Add(MAnimationTickee* aTickee);
williamr@2
    39
	IMPORT_C TInt Remove(MAnimationTickee* aTickee);
williamr@2
    40
	IMPORT_C void Freeze();
williamr@2
    41
	IMPORT_C void Unfreeze();
williamr@2
    42
	
williamr@2
    43
	/** This provides the resolution of the timer.
williamr@2
    44
	@return iTickLength The resolution of the timer */
williamr@2
    45
	inline const TTimeIntervalMicroSeconds32& TickLength() const { return iTickLength; }
williamr@2
    46
	void OnTick();
williamr@2
    47
protected:
williamr@2
    48
	IMPORT_C virtual void CAnimationTicker_Reserved1();
williamr@2
    49
	IMPORT_C virtual void CAnimationTicker_Reserved2();
williamr@2
    50
private:
williamr@2
    51
	TInt iCAnimationTicker_Reserved;
williamr@2
    52
private:
williamr@2
    53
	CAnimationTicker();
williamr@2
    54
	void ConstructL(TTimeIntervalMicroSeconds32 aTickLength);
williamr@2
    55
	void StartTickingL();
williamr@2
    56
	void StopTicking();
williamr@2
    57
private:
williamr@2
    58
	TInt iFreeze;
williamr@2
    59
	TTimeIntervalMicroSeconds32 iTickLength;
williamr@2
    60
	CPeriodic* iPeriodic;
williamr@2
    61
	RPointerArray<MAnimationTickee> iTickees;
williamr@2
    62
	};
williamr@2
    63
williamr@2
    64
#endif //__ANIMATIONTICKER_H__