epoc32/include/animationtls.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
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@2
     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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 __ANIMATIONTLS_H__
williamr@2
    17
#define __ANIMATIONTLS_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
class CAnimationTicker;
williamr@2
    22
williamr@2
    23
/** This is a wrapper around the thread local storage, which simplifies its
williamr@2
    24
use for obtaining a CAnimationTicker object that can be shared between
williamr@2
    25
animations.  The object is reference counted, and only one will exist per
williamr@2
    26
thread per DLL at any given time.
williamr@2
    27
williamr@2
    28
You do not need to instantiate an object of this type unless you are writing a
williamr@2
    29
new animation type.  If you are writing a new animation type it is optional.
williamr@2
    30
williamr@2
    31
@see CAnimationTicker
williamr@2
    32
@publishedAll
williamr@2
    33
@released */
williamr@2
    34
NONSHARABLE_CLASS(CAnimationTls) : public CBase
williamr@2
    35
	{
williamr@2
    36
public:
williamr@2
    37
	IMPORT_C static CAnimationTls* NewL();
williamr@2
    38
	IMPORT_C void Close();
williamr@2
    39
	IMPORT_C CAnimationTicker* Ticker();
williamr@2
    40
protected:
williamr@2
    41
	CAnimationTls();
williamr@2
    42
	~CAnimationTls();
williamr@2
    43
	IMPORT_C virtual void CAnimationTls_Reserved1();
williamr@2
    44
	IMPORT_C virtual void CAnimationTls_Reserved2();
williamr@2
    45
protected:
williamr@2
    46
	/** A Reference count of the object */
williamr@2
    47
	TInt iRefCount;
williamr@2
    48
	/** This provides timing information for animators */
williamr@2
    49
	CAnimationTicker* iTimer;
williamr@2
    50
private:
williamr@2
    51
	TInt iCAnimationTls_Reserved;
williamr@2
    52
	};
williamr@2
    53
	
williamr@2
    54
#endif // __ANIMATIONTLS_H__