epoc32/include/animationtls.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
equal deleted inserted replaced
1:666f914201fb 2:2fe1408b6811
     1 animationtls.h
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef __ANIMATIONTLS_H__
       
    17 #define __ANIMATIONTLS_H__
       
    18 
       
    19 #include <e32base.h>
       
    20 
       
    21 class CAnimationTicker;
       
    22 
       
    23 /** This is a wrapper around the thread local storage, which simplifies its
       
    24 use for obtaining a CAnimationTicker object that can be shared between
       
    25 animations.  The object is reference counted, and only one will exist per
       
    26 thread per DLL at any given time.
       
    27 
       
    28 You do not need to instantiate an object of this type unless you are writing a
       
    29 new animation type.  If you are writing a new animation type it is optional.
       
    30 
       
    31 @see CAnimationTicker
       
    32 @publishedAll
       
    33 @released */
       
    34 NONSHARABLE_CLASS(CAnimationTls) : public CBase
       
    35 	{
       
    36 public:
       
    37 	IMPORT_C static CAnimationTls* NewL();
       
    38 	IMPORT_C void Close();
       
    39 	IMPORT_C CAnimationTicker* Ticker();
       
    40 protected:
       
    41 	CAnimationTls();
       
    42 	~CAnimationTls();
       
    43 	IMPORT_C virtual void CAnimationTls_Reserved1();
       
    44 	IMPORT_C virtual void CAnimationTls_Reserved2();
       
    45 protected:
       
    46 	/** A Reference count of the object */
       
    47 	TInt iRefCount;
       
    48 	/** This provides timing information for animators */
       
    49 	CAnimationTicker* iTimer;
       
    50 private:
       
    51 	TInt iCAnimationTls_Reserved;
       
    52 	};
       
    53 	
       
    54 #endif // __ANIMATIONTLS_H__