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

// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// 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
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __ANIMATIONTLS_H__
#define __ANIMATIONTLS_H__

#include <e32base.h>

class CAnimationTicker;

/** This is a wrapper around the thread local storage, which simplifies its
use for obtaining a CAnimationTicker object that can be shared between
animations.  The object is reference counted, and only one will exist per
thread per DLL at any given time.

You do not need to instantiate an object of this type unless you are writing a
new animation type.  If you are writing a new animation type it is optional.

@see CAnimationTicker
@publishedAll
@released */
NONSHARABLE_CLASS(CAnimationTls) : public CBase
	{
public:
	IMPORT_C static CAnimationTls* NewL();
	IMPORT_C void Close();
	IMPORT_C CAnimationTicker* Ticker();
protected:
	CAnimationTls();
	~CAnimationTls();
	IMPORT_C virtual void CAnimationTls_Reserved1();
	IMPORT_C virtual void CAnimationTls_Reserved2();
protected:
	/** A Reference count of the object */
	TInt iRefCount;
	/** This provides timing information for animators */
	CAnimationTicker* iTimer;
private:
	TInt iCAnimationTls_Reserved;
	};
	
#endif // __ANIMATIONTLS_H__