epoc32/include/mw/iclanimationdataprovider.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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@4
    25
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    26
// For phase2 CICLAnimationDataProvider needs refactoring to convert it's derivation from
williamr@4
    27
// MICLAnimationDataLoaderObserver to having a CAnimationDataLoaderObserver* member
williamr@4
    28
#include <animationdataloaderobserver.h>
williamr@4
    29
#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    30
williamr@4
    31
williamr@2
    32
_LIT8(KBitmapAnimationDataType, "bitmap");
williamr@2
    33
williamr@2
    34
class CICLAnimationDataLoader;
williamr@2
    35
williamr@2
    36
/**
williamr@2
    37
Data provider for frame based animations.
williamr@2
    38
williamr@2
    39
This data provider expects to be provided with a file which can be interpreted
williamr@2
    40
as an animation using the Image Conversion Library (ICL).  An example would be
williamr@2
    41
an animated GIF.  The default data type for this provider is "bitmap".
williamr@2
    42
williamr@2
    43
@see CBitmapAnimator
williamr@2
    44
@publishedAll
williamr@2
    45
@released
williamr@2
    46
*/
williamr@2
    47
class CICLAnimationDataProvider : public CAnimationDataProvider, public MICLAnimationDataLoaderObserver
williamr@2
    48
	{
williamr@2
    49
public:
williamr@2
    50
    IMPORT_C CICLAnimationDataProvider();
williamr@2
    51
    IMPORT_C ~CICLAnimationDataProvider();
williamr@2
    52
    IMPORT_C void SetFileL(RFs & aFs, const TFileName& aFileName);
williamr@2
    53
    IMPORT_C TPtrC8 DataType();
williamr@2
    54
    virtual void StartL();
williamr@2
    55
protected:
williamr@2
    56
	IMPORT_C virtual void CICLAnimationDataProvider_Reserved1();
williamr@2
    57
	IMPORT_C virtual void CICLAnimationDataProvider_Reserved2();
williamr@2
    58
	// From CAnimationDataProvider
williamr@2
    59
	IMPORT_C virtual void CAnimationDataProvider_Reserved1();
williamr@2
    60
	IMPORT_C virtual void CAnimationDataProvider_Reserved2();
williamr@2
    61
private:
williamr@2
    62
	TInt iCICLAnimationDataProvider_Reserved;
williamr@2
    63
private:
williamr@2
    64
    CAnimationFrame::THandles CurrentFrame() const;
williamr@2
    65
    void DecodeImageL();
williamr@2
    66
    void DataDeliveryL();
williamr@2
    67
    void Reset();
williamr@2
    68
    // From MICLAnimationDataLoaderObserver
williamr@2
    69
    virtual void DataLoaderEventL(TDataLoaderEvent aEvent, TInt aError);
williamr@2
    70
private: 
williamr@2
    71
	CICLAnimationDataLoader* iDataLoader;
williamr@2
    72
	CAnimationFrame* iCurrentFrame;
williamr@2
    73
	TInt iFlags;
williamr@2
    74
	};
williamr@2
    75
williamr@2
    76
#endif //__ICLANIMATIONDATAPROVIDER_H__
williamr@4
    77