epoc32/include/iclanimationdataprovider.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 __ICLANIMATIONDATAPROVIDER_H__
#define __ICLANIMATIONDATAPROVIDER_H__

#include <animationdataprovider.h>

#include <e32std.h>
#include <animationframe.h>
#include <animationmixins.h>

_LIT8(KBitmapAnimationDataType, "bitmap");

class CICLAnimationDataLoader;

/**
Data provider for frame based animations.

This data provider expects to be provided with a file which can be interpreted
as an animation using the Image Conversion Library (ICL).  An example would be
an animated GIF.  The default data type for this provider is "bitmap".

@see CBitmapAnimator
@publishedAll
@released
*/
class CICLAnimationDataProvider : public CAnimationDataProvider, public MICLAnimationDataLoaderObserver
	{
public:
    IMPORT_C CICLAnimationDataProvider();
    IMPORT_C ~CICLAnimationDataProvider();
    IMPORT_C void SetFileL(RFs & aFs, const TFileName& aFileName);
    IMPORT_C TPtrC8 DataType();
    virtual void StartL();
protected:
	IMPORT_C virtual void CICLAnimationDataProvider_Reserved1();
	IMPORT_C virtual void CICLAnimationDataProvider_Reserved2();
	// From CAnimationDataProvider
	IMPORT_C virtual void CAnimationDataProvider_Reserved1();
	IMPORT_C virtual void CAnimationDataProvider_Reserved2();
private:
	TInt iCICLAnimationDataProvider_Reserved;
private:
    CAnimationFrame::THandles CurrentFrame() const;
    void DecodeImageL();
    void DataDeliveryL();
    void Reset();
    // From MICLAnimationDataLoaderObserver
    virtual void DataLoaderEventL(TDataLoaderEvent aEvent, TInt aError);
private: 
	CICLAnimationDataLoader* iDataLoader;
	CAnimationFrame* iCurrentFrame;
	TInt iFlags;
	};

#endif //__ICLANIMATIONDATAPROVIDER_H__