epoc32/include/banddev.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 BANDDEV_H
williamr@2
    17
#define BANDDEV_H
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
#include <gdi.h>
williamr@2
    21
williamr@2
    22
class CFbsBitmapDevice;
williamr@2
    23
class CFbsBitGc;
williamr@2
    24
williamr@2
    25
/**
williamr@4
    26
 @publishedAll
williamr@2
    27
*/
williamr@2
    28
enum TBandingDirection
williamr@2
    29
	{
williamr@2
    30
	EBandingTopToBottom,
williamr@2
    31
	EBandingBottomToTop,
williamr@2
    32
	EBandingLeftToRight,
williamr@2
    33
	EBandingRightToLeft
williamr@2
    34
	};
williamr@2
    35
williamr@2
    36
/**
williamr@2
    37
 @publishedAll
williamr@2
    38
 @released 
williamr@2
    39
 */
williamr@2
    40
class CBandedDevice : public CGraphicsDevice
williamr@2
    41
	{
williamr@2
    42
public:
williamr@2
    43
	IMPORT_C ~CBandedDevice();
williamr@2
    44
	IMPORT_C static CBandedDevice* NewL(TRect aRectInPixels, TSize aKPixelSizeInTwips, TDisplayMode aDisplayMode, TBandingDirection aBandingDirection = EBandingTopToBottom, TInt aScanLinesPerBand = 0);
williamr@2
    45
williamr@2
    46
	IMPORT_C TInt HorizontalTwipsToPixels(TInt aTwips) const;
williamr@2
    47
	IMPORT_C TInt VerticalTwipsToPixels(TInt aTwips) const;
williamr@2
    48
	IMPORT_C TInt HorizontalPixelsToTwips(TInt aPixels) const;
williamr@2
    49
	IMPORT_C TInt VerticalPixelsToTwips(TInt aPixels) const;
williamr@2
    50
	IMPORT_C virtual TInt GetNearestFontInTwips(CFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    51
	IMPORT_C virtual TInt GetNearestFontToDesignHeightInTwips(CFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    52
	IMPORT_C virtual TInt GetNearestFontToMaxHeightInTwips(CFont*& aFont, const TFontSpec& aFontSpec, TInt aMaxHeight);
williamr@2
    53
	IMPORT_C void ReleaseFont(CFont* aFont);
williamr@2
    54
williamr@2
    55
	IMPORT_C TDisplayMode DisplayMode() const;
williamr@2
    56
	IMPORT_C TSize SizeInPixels() const;
williamr@2
    57
	IMPORT_C TSize SizeInTwips() const;
williamr@2
    58
	IMPORT_C TInt CreateContext(CGraphicsContext*& aGC);
williamr@2
    59
	IMPORT_C TInt NumTypefaces() const;
williamr@2
    60
	IMPORT_C void TypefaceSupport(TTypefaceSupport& aTypefaceSupport, TInt aTypefaceIndex) const;
williamr@2
    61
	IMPORT_C TInt FontHeightInTwips(TInt aTypefaceIndex, TInt aHeightIndex) const;
williamr@2
    62
	IMPORT_C void PaletteAttributes(TBool& aModifiable, TInt& aNumEntries) const;
williamr@2
    63
	IMPORT_C void SetPalette(CPalette* aPalette);
williamr@2
    64
	IMPORT_C TInt GetPalette(CPalette*& aPalette) const;
williamr@2
    65
williamr@2
    66
	IMPORT_C TInt NumBands() const;
williamr@2
    67
	IMPORT_C TInt NextBand();
williamr@2
    68
	IMPORT_C TRect BandRect() const;
williamr@2
    69
	IMPORT_C TPoint FullOriginToBandOrigin(const TPoint& aPoint) const;
williamr@2
    70
	IMPORT_C void Reset();
williamr@2
    71
williamr@2
    72
	inline TBandingDirection BandingDirection() const {return iBandingDirection;}
williamr@2
    73
	inline CFbsBitmap* BandBitmap() const {return iBandBitmap;}
williamr@2
    74
williamr@2
    75
private:
williamr@2
    76
	CBandedDevice(TRect aRectInPixels, TBandingDirection aBandingDirection, TInt aScanLinesPerBand);
williamr@2
    77
	void ConstructL(TDisplayMode aDisplayMode, TSize aKPixelSizeInTwips);
williamr@2
    78
williamr@2
    79
private:
williamr@2
    80
	TRect iFullRectInPixels;
williamr@2
    81
	TInt iScanLinesPerBand;
williamr@2
    82
	TInt iBandIndex;
williamr@2
    83
	CFbsBitmap* iBandBitmap;
williamr@2
    84
	CFbsBitmapDevice* iBandBitmapDevice;
williamr@2
    85
	CFbsBitGc* iClearGc;
williamr@2
    86
	TBandingDirection iBandingDirection;
williamr@2
    87
	};
williamr@2
    88
williamr@2
    89
#endif