epoc32/include/w32stdgraphic.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2005-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
// Standard CWsGraphic plugins
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#ifndef __W32STDGRAPHIC_H__
williamr@2
    19
#define __W32STDGRAPHIC_H__
williamr@2
    20
williamr@2
    21
#include <w32std.h>
williamr@2
    22
#include <icl/imagedata.h>
williamr@2
    23
	
williamr@2
    24
class TWsGraphicAnimation: public TWsGraphicMsgFixedBase
williamr@2
    25
/** data attached to a CWindowGc::DrawWsGraphic to allow the artwork to understand VCR-style
williamr@2
    26
	play-stop-pause commands.
williamr@2
    27
	@publishedAll
williamr@2
    28
	@released
williamr@2
    29
*/	{
williamr@2
    30
public:
williamr@2
    31
	enum
williamr@2
    32
		{
williamr@2
    33
		ETypeId = 0x10281AB1
williamr@2
    34
		};
williamr@2
    35
	IMPORT_C TWsGraphicAnimation();
williamr@2
    36
	IMPORT_C void Play(TBool aLoop);
williamr@2
    37
	IMPORT_C void Pause();
williamr@2
    38
	IMPORT_C void Stop(TBool aImmediately);
williamr@2
    39
	IMPORT_C TBool IsPlaying() const;
williamr@2
    40
	IMPORT_C TBool IsStopped() const;
williamr@2
    41
	IMPORT_C TBool IsStopping() const;
williamr@2
    42
	IMPORT_C TBool IsPaused() const;
williamr@2
    43
	IMPORT_C TBool Loops() const;
williamr@2
    44
private:
williamr@2
    45
	TUint State() const;
williamr@2
    46
	void SetState(TUint aState);
williamr@2
    47
private:
williamr@2
    48
	enum 
williamr@2
    49
		{
williamr@2
    50
		// animation state in lowest nibble
williamr@2
    51
		EStopped	= 0x00,
williamr@2
    52
		EPlaying	= 0x01,
williamr@2
    53
		EStopping	= 0x02,
williamr@2
    54
		EPaused		= 0x03,
williamr@2
    55
		EStateMask	= 0x0F,
williamr@2
    56
		// other flags above
williamr@2
    57
		ELoop		= 0x10,
williamr@2
    58
		};
williamr@2
    59
	TUint iFlags;
williamr@2
    60
	TTime iPlay;
williamr@2
    61
	TTime iPauseOrStopping;
williamr@2
    62
	};
williamr@2
    63
williamr@2
    64
NONSHARABLE_CLASS(CWsGraphicBitmap): public CWsGraphic
williamr@2
    65
/** Client representation of a window-server-side CFbsBitmap owned by this Client
williamr@2
    66
williamr@2
    67
@publishedAll
williamr@2
    68
@released
williamr@2
    69
*/
williamr@2
    70
	{
williamr@2
    71
public:
williamr@2
    72
	IMPORT_C static CWsGraphicBitmap* NewL(const CFbsBitmap* aBitmap,const CFbsBitmap* aMask);
williamr@2
    73
	IMPORT_C static CWsGraphicBitmap* NewL(TUid aUid,const CFbsBitmap* aBitmap,const CFbsBitmap* aMask);
williamr@2
    74
	IMPORT_C static CWsGraphicBitmap* NewL(const TWsGraphicId& aReplace,const CFbsBitmap* aBitmap,const CFbsBitmap* aMask);
williamr@2
    75
	IMPORT_C ~CWsGraphicBitmap();
williamr@2
    76
public: // protected virtuals from CWsGraphic promoted to public
williamr@2
    77
	IMPORT_C TInt ShareGlobally();
williamr@2
    78
	IMPORT_C TInt UnShareGlobally();
williamr@2
    79
	IMPORT_C TInt Share(TSecureId aClientId);
williamr@2
    80
	IMPORT_C TInt UnShare(TSecureId aClientId);
williamr@2
    81
private:
williamr@2
    82
	CWsGraphicBitmap();
williamr@2
    83
	void HandleMessage(const TDesC8& aData);
williamr@2
    84
	void OnReplace();
williamr@2
    85
};
williamr@2
    86
williamr@2
    87
NONSHARABLE_CLASS(CWsGraphicBitmapAnimation): public CWsGraphic
williamr@2
    88
/** Client representation of a window-server-side CFbsBitmap owned by this Client
williamr@2
    89
williamr@2
    90
@publishedAll
williamr@2
    91
@released
williamr@2
    92
*/
williamr@2
    93
	{
williamr@2
    94
public:
williamr@2
    95
	NONSHARABLE_CLASS(CFrame): public CBase
williamr@2
    96
		{
williamr@2
    97
	public:
williamr@2
    98
		IMPORT_C static CFrame* NewL();
williamr@2
    99
		IMPORT_C ~CFrame();
williamr@2
   100
		// public getters/setters
williamr@2
   101
		IMPORT_C TFrameInfo FrameInfo() const;
williamr@2
   102
		IMPORT_C void SetFrameInfo(const TFrameInfo& aFrameInfo);
williamr@2
   103
		IMPORT_C const CFbsBitmap* Bitmap() const;
williamr@2
   104
		IMPORT_C void SetBitmap(CFbsBitmap* aBitmap);
williamr@2
   105
		IMPORT_C const CFbsBitmap* Mask() const;
williamr@2
   106
		IMPORT_C void SetMask(CFbsBitmap* aMask);
williamr@2
   107
	private:
williamr@2
   108
		CFrame();
williamr@2
   109
	private:
williamr@2
   110
		friend class CWsGraphicBitmapAnimation;
williamr@2
   111
		TFrameInfo iFrameInfo;
williamr@2
   112
		CFbsBitmap* iBitmap;
williamr@2
   113
		CFbsBitmap* iMask;
williamr@2
   114
		};
williamr@2
   115
	typedef TArray<CFrame*> TFrames;
williamr@2
   116
public:
williamr@2
   117
	IMPORT_C static CWsGraphicBitmapAnimation* NewL(const TFrames& aFrames);
williamr@2
   118
	IMPORT_C static CWsGraphicBitmapAnimation* NewL(TUid aUid,const TFrames& aFrames);
williamr@2
   119
	IMPORT_C static CWsGraphicBitmapAnimation* NewL(const TWsGraphicId& aReplace,const TFrames& aFrames);
williamr@2
   120
	IMPORT_C ~CWsGraphicBitmapAnimation();
williamr@2
   121
public: // protected virtuals from CWsGraphic promoted to public
williamr@2
   122
	IMPORT_C TInt ShareGlobally();
williamr@2
   123
	IMPORT_C TInt UnShareGlobally();
williamr@2
   124
	IMPORT_C TInt Share(TSecureId aClientId);
williamr@2
   125
	IMPORT_C TInt UnShare(TSecureId aClientId);
williamr@2
   126
private:
williamr@2
   127
	CWsGraphicBitmapAnimation();
williamr@2
   128
	static HBufC8* PackLC(const TFrames& aFrames);
williamr@2
   129
	void HandleMessage(const TDesC8& aData);
williamr@2
   130
	void OnReplace();
williamr@2
   131
};
williamr@2
   132
williamr@2
   133
#endif //__W32STDGRAPHIC_H__