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
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 __ICLANIMATIONDATAPROVIDER_H__
williamr@2
    17
#define __ICLANIMATIONDATAPROVIDER_H__
williamr@2
    18
williamr@2
    19
#include <animationdataprovider.h>
williamr@2
    20
williamr@2
    21
#include <e32std.h>
williamr@2
    22
#include <animationframe.h>
williamr@2
    23
#include <animationmixins.h>
williamr@2
    24
williamr@2
    25
_LIT8(KBitmapAnimationDataType, "bitmap");
williamr@2
    26
williamr@2
    27
class CICLAnimationDataLoader;
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
Data provider for frame based animations.
williamr@2
    31
williamr@2
    32
This data provider expects to be provided with a file which can be interpreted
williamr@2
    33
as an animation using the Image Conversion Library (ICL).  An example would be
williamr@2
    34
an animated GIF.  The default data type for this provider is "bitmap".
williamr@2
    35
williamr@2
    36
@see CBitmapAnimator
williamr@2
    37
@publishedAll
williamr@2
    38
@released
williamr@2
    39
*/
williamr@2
    40
class CICLAnimationDataProvider : public CAnimationDataProvider, public MICLAnimationDataLoaderObserver
williamr@2
    41
	{
williamr@2
    42
public:
williamr@2
    43
    IMPORT_C CICLAnimationDataProvider();
williamr@2
    44
    IMPORT_C ~CICLAnimationDataProvider();
williamr@2
    45
    IMPORT_C void SetFileL(RFs & aFs, const TFileName& aFileName);
williamr@2
    46
    IMPORT_C TPtrC8 DataType();
williamr@2
    47
    virtual void StartL();
williamr@2
    48
protected:
williamr@2
    49
	IMPORT_C virtual void CICLAnimationDataProvider_Reserved1();
williamr@2
    50
	IMPORT_C virtual void CICLAnimationDataProvider_Reserved2();
williamr@2
    51
	// From CAnimationDataProvider
williamr@2
    52
	IMPORT_C virtual void CAnimationDataProvider_Reserved1();
williamr@2
    53
	IMPORT_C virtual void CAnimationDataProvider_Reserved2();
williamr@2
    54
private:
williamr@2
    55
	TInt iCICLAnimationDataProvider_Reserved;
williamr@2
    56
private:
williamr@2
    57
    CAnimationFrame::THandles CurrentFrame() const;
williamr@2
    58
    void DecodeImageL();
williamr@2
    59
    void DataDeliveryL();
williamr@2
    60
    void Reset();
williamr@2
    61
    // From MICLAnimationDataLoaderObserver
williamr@2
    62
    virtual void DataLoaderEventL(TDataLoaderEvent aEvent, TInt aError);
williamr@2
    63
private: 
williamr@2
    64
	CICLAnimationDataLoader* iDataLoader;
williamr@2
    65
	CAnimationFrame* iCurrentFrame;
williamr@2
    66
	TInt iFlags;
williamr@2
    67
	};
williamr@2
    68
williamr@2
    69
#endif //__ICLANIMATIONDATAPROVIDER_H__