epoc32/include/bitdev.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
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) 1997-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 __BITDEV_H__
williamr@2
    17
#define __BITDEV_H__
williamr@2
    18
williamr@2
    19
#include <fbs.h>
williamr@2
    20
#include <bitbase.h>
williamr@2
    21
#include <bitstd.h>
williamr@2
    22
#include <graphicsaccelerator.h>
williamr@2
    23
williamr@2
    24
class CFbsDrawDevice;
williamr@2
    25
class TSurfaceId;
williamr@2
    26
williamr@4
    27
/** Screen device orientations.
williamr@4
    28
williamr@4
    29
WARNING: Enumeration for internal use ONLY.  Compatibility is not guaranteed in future releases.
williamr@4
    30
williamr@4
    31
@publishedAll
williamr@4
    32
@released
williamr@4
    33
 */
williamr@2
    34
enum TDeviceOrientation
williamr@2
    35
	{
williamr@2
    36
	EDeviceOrientationNormal = 1,
williamr@2
    37
	EDeviceOrientation90CW = 2,
williamr@2
    38
	EDeviceOrientation180 = 4,
williamr@2
    39
	EDeviceOrientation270CW = 8
williamr@2
    40
	};
williamr@2
    41
williamr@2
    42
/** Abstract base class for graphics devices to which bitmaps and fonts can be 
williamr@2
    43
drawn.
williamr@2
    44
williamr@2
    45
The class implements the pure virtual CBitmapDevice functions and additionally 
williamr@2
    46
provides:
williamr@2
    47
williamr@2
    48
support for creating and enquiring about fonts
williamr@2
    49
williamr@2
    50
comparing two device rectangles
williamr@2
    51
williamr@2
    52
creating a graphics context for the device.
williamr@2
    53
williamr@2
    54
CFbsBitmapDevice and CFbsScreenDevice are derived fom this class.
williamr@2
    55
williamr@2
    56
@see CFbsBitmapDevice
williamr@2
    57
@see CFbsScreenDevice 
williamr@2
    58
@publishedAll
williamr@2
    59
@released
williamr@2
    60
*/
williamr@2
    61
class CFbsDevice : public CBitmapDevice
williamr@2
    62
	{
williamr@2
    63
	friend class CFbsBitGc;
williamr@2
    64
public:
williamr@2
    65
	IMPORT_C ~CFbsDevice();
williamr@2
    66
	IMPORT_C TInt CreateContext(CFbsBitGc*& aGc);
williamr@2
    67
	inline TInt CreateContext(CGraphicsContext*& aGc);
williamr@2
    68
	IMPORT_C TDisplayMode DisplayMode() const;
williamr@2
    69
	IMPORT_C TSize SizeInPixels() const;
williamr@2
    70
	IMPORT_C TBool RectCompare(const TRect& aSourceRect,const CFbsDevice& aDevice,const TRect& aDeviceRect) const;
williamr@2
    71
	IMPORT_C TInt AddFile(const TDesC& aName,TInt& aId);
williamr@2
    72
	IMPORT_C void RemoveFile(TInt aId=0);
williamr@2
    73
	IMPORT_C virtual TInt GetNearestFontInTwips(CFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    74
	IMPORT_C virtual TInt GetNearestFontInPixels(CFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    75
	IMPORT_C virtual TInt GetNearestFontToDesignHeightInTwips(CFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    76
	IMPORT_C virtual TInt GetNearestFontToDesignHeightInPixels(CFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    77
	IMPORT_C virtual TInt GetNearestFontToMaxHeightInTwips(CFont*& aFont, const TFontSpec& aFontSpec, TInt aMaxHeight); 
williamr@2
    78
	IMPORT_C virtual TInt GetNearestFontToMaxHeightInPixels(CFont*& aFont, const TFontSpec& aFontSpec, TInt aMaxHeight);
williamr@2
    79
	IMPORT_C TInt GetFontById(CFont*& aFont,TUid aFileId,const TAlgStyle& aStyle);
williamr@2
    80
	inline TInt GetNearestFontInTwips(CFbsFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    81
	inline TInt GetNearestFontInPixels(CFbsFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    82
	inline TInt GetNearestFontToDesignHeightInTwips(CFbsFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    83
	inline TInt GetNearestFontToDesignHeightInPixels(CFbsFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    84
	inline TInt GetNearestFontToMaxHeightInTwips(CFbsFont*& aFont, const TFontSpec& aFontSpec, TInt aMaxHeight);
williamr@2
    85
	inline TInt GetNearestFontToMaxHeightInPixels(CFbsFont*& aFont, const TFontSpec& aFontSpec, TInt aMaxHeight);
williamr@2
    86
	inline TInt GetFontById(CFbsFont*& aFont,TUid aFileId,const TAlgStyle& aStyle);
williamr@2
    87
	IMPORT_C void ReleaseFont(CFont* aFont);
williamr@2
    88
	IMPORT_C TInt FontHeightInTwips(TInt aTypefaceIndex,TInt aHeightIndex) const;
williamr@2
    89
	IMPORT_C TInt FontHeightInPixels(TInt aTypefaceIndex,TInt aHeightIndex) const;
williamr@2
    90
	IMPORT_C TInt NumTypefaces() const;
williamr@2
    91
	IMPORT_C void TypefaceSupport(TTypefaceSupport& aTypefaceSupport,TInt aTypefaceIndex) const;
williamr@2
    92
	IMPORT_C TInt SetCustomPalette(const CPalette* aPalette);
williamr@2
    93
	inline CGraphicsAccelerator* GraphicsAccelerator() const;
williamr@2
    94
	inline CFbsBitGc::TGraphicsOrientation Orientation() const;
williamr@2
    95
	IMPORT_C static TDisplayMode DisplayMode16M();
williamr@2
    96
	IMPORT_C TInt SetScalingFactor(const TPoint& aOrigin,
williamr@2
    97
								   TInt aFactorX, TInt aFactorY,
williamr@2
    98
								   TInt aDivisorX, TInt aDivisorY);
williamr@2
    99
	IMPORT_C void GetDrawRect(TRect& aRect) const;
williamr@2
   100
	IMPORT_C TInt RegisterLinkedTypeface(const CLinkedTypefaceSpecification& aLinkedTypefaceSpec, TInt& aId);
williamr@4
   101
	IMPORT_C TInt SetDrawDeviceOffset(const TPoint& aOrigin);
williamr@4
   102
williamr@2
   103
protected:
williamr@2
   104
	CFbsDevice();
williamr@2
   105
	virtual void DrawingBegin(TBool /*aAlways*/ = EFalse) {}
williamr@2
   106
	virtual void DrawingEnd(TBool /*aAlways*/ = EFalse) {}
williamr@2
   107
	
williamr@2
   108
	/**
williamr@2
   109
	Sets the bit level.
williamr@2
   110
	*/
williamr@2
   111
	virtual void SetBits() {}
williamr@2
   112
	
williamr@2
   113
	/**
williamr@4
   114
	This method has been deprecated.  Sprites are no longer supported in BitGDI.
williamr@4
   115
	Calling this method has no effect.
williamr@4
   116
	@deprecated
williamr@2
   117
	*/
williamr@2
   118
	virtual void CancelSprite() const {}
williamr@2
   119
	
williamr@2
   120
	/**
williamr@4
   121
	This method has been deprecated.  Sprites are no longer supported in BitGDI.
williamr@4
   122
	Calling this method has no effect.
williamr@4
   123
	@return TSpriteBase* NULL.
williamr@4
   124
	@deprecated
williamr@2
   125
	*/
williamr@2
   126
	virtual TSpriteBase* HideSprite() const {return(NULL);}
williamr@2
   127
	
williamr@2
   128
	/**
williamr@4
   129
	This method has been deprecated.  Sprites are no longer supported in BitGDI.
williamr@4
   130
	Calling this method has no effect.
williamr@4
   131
	@param aRect Ignored.
williamr@4
   132
	@param aClippingRegion Ignored. 
williamr@4
   133
  	@return TSpriteBase* NULL.
williamr@4
   134
  	@deprecated
williamr@2
   135
	*/
williamr@2
   136
	virtual TSpriteBase* HideSprite(const TRect&,const TRegion*) const {return(NULL);}
williamr@2
   137
	
williamr@2
   138
	/**
williamr@4
   139
	This method has been deprecated.  Sprites are no longer supported in BitGDI.
williamr@4
   140
	Calling this method has no effect.
williamr@4
   141
	@param aSprite Ignored.
williamr@4
   142
	@deprecated
williamr@2
   143
	*/
williamr@2
   144
	virtual void ShowSprite(TSpriteBase*) const {}
williamr@2
   145
	
williamr@2
   146
	/**
williamr@4
   147
	This method has been deprecated.  Sprites are no longer supported in BitGDI.
williamr@4
   148
	Calling this method has no effect.
williamr@4
   149
	@param aSprite Ignored. 
williamr@4
   150
 	@param aRect Ignored. 
williamr@4
   151
 	@param aClippingRegion Ignored.
williamr@4
   152
 	@deprecated
williamr@2
   153
 	*/
williamr@2
   154
	virtual void ShowSprite(TSpriteBase*,const TRect&,const TRegion*) const {}
williamr@2
   155
	TInt GetNearestFbsFont(CFbsFont*& aFont,const TFontSpec& aFontSpec);
williamr@2
   156
	void DoGetScanLine(TDes8& aBuf,const TPoint& aPixel,TInt aLength,TDisplayMode aDispMode);
williamr@2
   157
	void ReadLineDiffMode(TInt,TInt,TInt,TAny*,TDisplayMode) const;
williamr@2
   158
	void TruncateRect(TRect& aRect);
williamr@2
   159
	TBool SetOrientation(CFbsBitGc::TGraphicsOrientation aOrientation);
williamr@2
   160
	void DrawingBegin(const CFbsBitmap* aBitmap, TBool aAlways = EFalse);
williamr@2
   161
	void DrawingEnd(const CFbsBitmap* aBitmap, TBool aAlways = EFalse);
williamr@2
   162
protected:
williamr@2
   163
	CFbsDrawDevice* iDrawDevice;
williamr@2
   164
	RFbsSession* iFbs;
williamr@2
   165
	CFbsTypefaceStore* iTypefaceStore;
williamr@2
   166
	TInt iSpare;
williamr@2
   167
	TBool iScreenDevice;
williamr@2
   168
	TUint8* iBitBltMaskedBuffer;
williamr@2
   169
	CGraphicsAccelerator* iGraphicsAccelerator;
williamr@2
   170
	CFbsBitGc::TGraphicsOrientation iOrientation;
williamr@2
   171
	};
williamr@2
   172
williamr@2
   173
/** A graphics device interface that provides direct access to the screen, without 
williamr@2
   174
the mediation of the window server.
williamr@2
   175
williamr@2
   176
@publishedAll
williamr@2
   177
@released
williamr@2
   178
*/
williamr@2
   179
class CFbsScreenDevice : public CFbsDevice
williamr@2
   180
	{
williamr@2
   181
public:
williamr@2
   182
	IMPORT_C static CFbsScreenDevice* NewL(const TDesC& aLibname,TDisplayMode aDispMode);
williamr@2
   183
	IMPORT_C static CFbsScreenDevice* NewL(const TDesC& aLibname,TDisplayMode aDispMode, TRgb aWhite);
williamr@2
   184
	IMPORT_C static CFbsScreenDevice* NewL(TInt aScreenNo, TDisplayMode aDispMode);
williamr@2
   185
	IMPORT_C virtual ~CFbsScreenDevice();
williamr@2
   186
	IMPORT_C void GetScanLine(TDes8& aBuf,const TPoint& aStartPixel,TInt aLength,TDisplayMode aDispMode) const;
williamr@2
   187
	IMPORT_C void GetPixel(TRgb& aColor,const TPoint& aPixel) const;
williamr@2
   188
	IMPORT_C TInt HorizontalPixelsToTwips(TInt aPixels) const;
williamr@2
   189
	IMPORT_C TInt VerticalPixelsToTwips(TInt aPixels) const;
williamr@2
   190
	IMPORT_C TInt HorizontalTwipsToPixels(TInt aTwips) const;
williamr@2
   191
	IMPORT_C TInt VerticalTwipsToPixels(TInt aTwips) const;
williamr@2
   192
	IMPORT_C void SetAutoUpdate(TBool aValue);
williamr@4
   193
	IMPORT_C void DrawSpriteBegin();		//< @deprecated
williamr@4
   194
	IMPORT_C void DrawSpriteEnd();		//< @deprecated
williamr@4
   195
	IMPORT_C void CancelSprite() const;		//< @deprecated
williamr@4
   196
	IMPORT_C TSpriteBase* HideSprite() const;		//< @deprecated
williamr@4
   197
	IMPORT_C TSpriteBase* HideSprite(const TRect& aRect,const TRegion* aClippingRegion) const;		//< @deprecated
williamr@4
   198
	IMPORT_C void ShowSprite(TSpriteBase* aSprite) const;		//< @deprecated
williamr@4
   199
	IMPORT_C void ShowSprite(TSpriteBase* aSprite,const TRect& aRect,const TRegion* aClippingRegion) const;		//< @deprecated
williamr@2
   200
	IMPORT_C void ChangeScreenDevice(CFbsScreenDevice* aOldDevice);
williamr@2
   201
	IMPORT_C void PaletteAttributes(TBool& aModifiable,TInt& aNumEntries) const;
williamr@2
   202
	IMPORT_C void SetPalette(CPalette* aPalette);
williamr@2
   203
	IMPORT_C TInt GetPalette(CPalette*& aPalette) const;
williamr@2
   204
	IMPORT_C void Update();
williamr@2
   205
	IMPORT_C void Update(const TRegion& aRegion);
williamr@2
   206
	IMPORT_C TSize SizeInTwips() const;
williamr@2
   207
	IMPORT_C RHardwareBitmap HardwareBitmap();
williamr@2
   208
	IMPORT_C const TUint32* Bits() const;
williamr@2
   209
	IMPORT_C TInt Stride() const;
williamr@2
   210
	IMPORT_C TInt ScreenNo() const;
williamr@4
   211
	IMPORT_C TUint DeviceOrientationsAvailable() const;	/**< WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. */
williamr@4
   212
	IMPORT_C TBool SetDeviceOrientation(TDeviceOrientation aOrientation) const;	/**< WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. */
williamr@4
   213
	IMPORT_C void GetSurface(TSurfaceId& aSurface) const; /**< WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. */
williamr@4
   214
	IMPORT_C TDeviceOrientation DeviceOrientation() const; /**< WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases. */
williamr@2
   215
private:
williamr@2
   216
	CFbsScreenDevice(TInt aScreenNo);
williamr@2
   217
	void ConstructL(TInt aScreenNo, TDisplayMode aDispMode);
williamr@2
   218
private:
williamr@4
   219
	TInt iSpare1_CFbsScreenDevice;
williamr@4
   220
	TInt iSpare2_CFbsScreenDevice;
williamr@2
   221
    TInt iScreenNo;
williamr@2
   222
	};
williamr@2
   223
williamr@2
   224
/** A graphics device to which a bitmap managed by the font and bitmap server can 
williamr@2
   225
be drawn.
williamr@2
   226
williamr@2
   227
The class specialises the bitmap graphics device interface CBitmapDevice for 
williamr@2
   228
drawing to in-memory bitmaps. 
williamr@2
   229
@publishedAll
williamr@2
   230
@released
williamr@2
   231
*/
williamr@2
   232
class CFbsBitmapDevice : public CFbsDevice
williamr@2
   233
	{
williamr@2
   234
public:
williamr@2
   235
	IMPORT_C static CFbsBitmapDevice* NewL(CFbsBitmap* aFbsBitmap);
williamr@2
   236
	IMPORT_C static CFbsBitmapDevice* NewL(CFbsBitmap* aFbsBitmap,const TDesC& aLibname);
williamr@2
   237
	IMPORT_C virtual ~CFbsBitmapDevice();
williamr@2
   238
	IMPORT_C TInt Resize(const TSize& aSize);
williamr@2
   239
	IMPORT_C virtual void GetScanLine(TDes8& aBuf,const TPoint& aStartPixel,TInt aLength,TDisplayMode iDispMode) const;
williamr@2
   240
	IMPORT_C virtual void GetPixel(TRgb& aColor,const TPoint& aPixel) const;
williamr@2
   241
	IMPORT_C virtual TInt HorizontalPixelsToTwips(TInt aPixels) const;
williamr@2
   242
	IMPORT_C virtual TInt VerticalPixelsToTwips(TInt aPixels) const;
williamr@2
   243
	IMPORT_C virtual TInt HorizontalTwipsToPixels(TInt aTwips) const;
williamr@2
   244
	IMPORT_C virtual TInt VerticalTwipsToPixels(TInt aTwips) const;
williamr@2
   245
	IMPORT_C virtual TSize SizeInTwips() const;
williamr@2
   246
	IMPORT_C virtual void PaletteAttributes(TBool& aModifiable,TInt& aNumEntries) const;
williamr@2
   247
	IMPORT_C virtual void SetPalette(CPalette* aPalette);
williamr@2
   248
	IMPORT_C virtual TInt GetPalette(CPalette*& aPalette) const;
williamr@2
   249
	IMPORT_C virtual void DrawingBegin(TBool aAlways = EFalse);
williamr@2
   250
	IMPORT_C virtual void DrawingEnd(TBool aAlways = EFalse);
williamr@2
   251
	IMPORT_C TInt SwapWidthAndHeight();
williamr@4
   252
williamr@2
   253
private:
williamr@2
   254
	CFbsBitmapDevice();
williamr@2
   255
	virtual void SetBits();
williamr@2
   256
	void ConstructL(CFbsBitmap* aFbsBitmap);
williamr@2
   257
	void ConstructL(CFbsBitmap* aFbsBitmap,const TDesC& aLibname);
williamr@2
   258
private:
williamr@2
   259
	CFbsBitGcBitmap* iFbsBmp;
williamr@2
   260
	};
williamr@2
   261
williamr@2
   262
#include <bitdev.inl>
williamr@2
   263
#endif