Collapse all Symbian^3 Product Developer Library

TOpenFontGlyphData Class Reference

class TOpenFontGlyphData

Font glyph data.

Objects of this type are used by rasterizers to supply glyph data to font and bitmap server clients. Unless you are writing a rasterizer you will not need to use an object of this type.

The object cannot be constructed and destroyed by normal means. It resides on a specified heap. It is created by New() and deleted by RHeap::Free().

COpenFont::RasterizeL()

Public Member Functions
TPtrC8	Bitmap()
const TUint8 *	BitmapPointer()
TUint8 *	BufferEnd()
TUint8 *	BufferStart()
TInt	BytesNeeded()
TInt	GlyphIndex()
const TOpenFontCharMetrics *	Metrics()
IMPORT_C TOpenFontGlyphData *	New(RHeap *, TInt)
TBool	Overflow()
void	SetBitmapPointer(const TUint8 *)
void	SetBytesNeeded(TInt)
void	SetGlyphIndex(TInt)
void	SetMetrics(TOpenFontCharMetrics &)
void	SetMetricsPointer(const TOpenFontCharMetrics *)
void	SetPointersToInternalBuffers()

Private Member Functions
	TOpenFontGlyphData()
	~TOpenFontGlyphData()

Private Attributes
const TUint8 *	iBitmap
TUint8	iBitmapBuffer
TInt	iBitmapBufferSize
TInt	iBytesNeeded
TInt	iGlyphIndex
const TOpenFontCharMetrics *	iMetrics
TOpenFontCharMetrics	iMetricsBuffer
TAny *	iReserved

Constructor & Destructor Documentation

TOpenFontGlyphData()

TOpenFontGlyphData

(

)

[private]

~TOpenFontGlyphData()

~TOpenFontGlyphData

(

)

[private]

Member Functions Documentation

Bitmap()

TPtrC8

Bitmap

(

)

const [inline]

Gets a constant pointer descriptor containing the bitmap this object represents.

BitmapPointer()

const TUint8 *

BitmapPointer

(

)

const [inline]

Gets a pointer to the bitmap.

This points either to the buffer used to write the bitmap when it is first rasterized, or to the cache if the character was already rasterized.

BufferEnd()

TUint8 *

BufferEnd

(

)

[inline]

Gets a pointer to the end of the bitmap buffer.

BufferStart()

TUint8 *

BufferStart

(

)

[inline]

Gets a pointer to the start of the bitmap buffer.

BytesNeeded()

TInt

BytesNeeded

(

)

const [inline]

Gets the number of bytes needed to store the glyph bitmap.

SetBytesNeeded()

GlyphIndex()

TInt

GlyphIndex

(

)

const [inline]

Gets the glyph index.

This is the index of a particular glyph within the font file.

Note: This makes it possible to gain access to glyphs which are not referenced by the Unicode character set. However, this feature is not yet supported by Symbian OS.

SetGlyphIndex()

Metrics()

const TOpenFontCharMetrics *

Metrics

(

)

const [inline]

Gets the character's metrics.

New(RHeap *, TInt)

IMPORT_C TOpenFontGlyphData *	New	(	RHeap *	aHeap,
			TInt	aBufferSize
		)	[static]

Parameters

RHeap * aHeap
TInt aBufferSize

Overflow()

TBool

Overflow

(

)

const [inline]

Tests whether the bitmap buffer is large enough to hold the bitmap.

SetBitmapPointer(const TUint8 *)

void

SetBitmapPointer

(

const TUint8 *

aBitmap

)

[inline]

Sets the pointer to the bitmap buffer.

Parameters

const TUint8 * aBitmap

The pointer to the bitmap buffer.

SetBytesNeeded(TInt)

void

SetBytesNeeded

(

TInt

aBytes

)

[inline]

Sets the number of bytes needed to store the glyph bitmap.

BytesNeeded()

Parameters

TInt aBytes

The number of bytes needed to store the glyph bitmap.

SetGlyphIndex(TInt)

void

SetGlyphIndex

(

TInt

aGlyphIndex

)

[inline]

Sets the glyph index.

Parameters

TInt aGlyphIndex

The glyph index.

SetMetrics(TOpenFontCharMetrics &)

void

SetMetrics

(

TOpenFontCharMetrics &

aMetrics

)

[inline]

Sets the character's metrics, passing a reference to a TOpenFontCharMetrics object.

Parameters

TOpenFontCharMetrics & aMetrics

The character's open font character metrics.

SetMetricsPointer(const TOpenFontCharMetrics *)

void

SetMetricsPointer

(

const TOpenFontCharMetrics *

aMetrics

)

[inline]

Sets the character's metrics, passing a pointer to a TOpenFontCharMetrics object.

Parameters

const TOpenFontCharMetrics * aMetrics

A pointer to the character's open font character metrics.

SetPointersToInternalBuffers()

void

SetPointersToInternalBuffers

(

)

[inline]

Sets the bitmap and metrics pointers to point to the internal buffers.

The alternative is that the pointers point to the cache of metrics and bitmaps that have already been rasterized.

Member Data Documentation

const TUint8 * iBitmap

const TUint8 *

iBitmap

[private]

TUint8 iBitmapBuffer

TUint8

iBitmapBuffer

[private]

TInt iBitmapBufferSize

TInt

iBitmapBufferSize

[private]

TInt iBytesNeeded

TInt

iBytesNeeded

[private]

TInt iGlyphIndex

TInt

iGlyphIndex

[private]

const TOpenFontCharMetrics * iMetrics

const TOpenFontCharMetrics *

iMetrics

[private]

TOpenFontCharMetrics iMetricsBuffer

TOpenFontCharMetrics

iMetricsBuffer

[private]

TAny * iReserved

TAny *

iReserved

[private]