1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/animationdataprovider.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,66 @@
     1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __ANIMATIONDATAPROVIDER_H__
    1.20 +#define __ANIMATIONDATAPROVIDER_H__
    1.21 +
    1.22 +#include <e32std.h>
    1.23 +#include <animationframe.h>
    1.24 +
    1.25 +class MAnimationDataProviderObserver;
    1.26 +
    1.27 +_LIT8(KUndefinedAnimationDataType, "undefined");
    1.28 +
    1.29 +/**
    1.30 +Pure virtual base class for data providers.
    1.31 +
    1.32 +A data provider takes an animation specification (such as a file), converts
    1.33 +it (if needed) into a format recognised by an animator (such as CAnimationFrame
    1.34 +objects), and passes it to the animator, via the medium of an animation.
    1.35 +
    1.36 +Most animation types take a data provider as an argument during contruction.
    1.37 +For more detailed usage instructions, refer to the documentation of the derived
    1.38 +classes.
    1.39 +
    1.40 +@see CAnimation
    1.41 +@see MAnimationDataProviderObserver
    1.42 +@publishedAll
    1.43 +@released
    1.44 +*/
    1.45 +class CAnimationDataProvider : public CBase
    1.46 +	{
    1.47 +public:
    1.48 +    IMPORT_C void SetObserver(MAnimationDataProviderObserver* aObserver);
    1.49 +    /** Called from the animation when it is ready to begin receiving data. */
    1.50 +    virtual void StartL() = 0;
    1.51 +    /** Called from the animation to obtain the type of data to expect.
    1.52 +    @return An 8 bit identifier string*/
    1.53 +    virtual TPtrC8 DataType() = 0;
    1.54 +protected:
    1.55 +	IMPORT_C CAnimationDataProvider();
    1.56 +	IMPORT_C virtual void CAnimationDataProvider_Reserved1();
    1.57 +	IMPORT_C virtual void CAnimationDataProvider_Reserved2();
    1.58 +
    1.59 +    IMPORT_C void SendEventL(TInt aEvent);
    1.60 +    IMPORT_C void SendEventL(TInt aEvent, TInt aData);
    1.61 +    IMPORT_C void SendEventL(TInt aEvent, TAny* aData, TInt aDataSize);
    1.62 +protected: 
    1.63 +	/** Reserved for future use */
    1.64 +	TInt iCAnimationDataProvider_Reserved;
    1.65 +	/** The destination to send data to. Usually an animation class. */
    1.66 +	MAnimationDataProviderObserver* iObserver;
    1.67 +	};
    1.68 +
    1.69 +#endif // __ANIMATIONDATAPROVIDER_H__