Collapse all Symbian^3 Application Developer Library

CCleanupStackableFont Class Reference

class CCleanupStackableFont : public CBase

Wraps a font ( CFbsFont ) object that can be pushed onto the cleanup stack.

By default, the cleanup stack only handles CBase-derived classes, and untyped (TAny*) objects that can be cleaned up by a simple memory free call. Fonts must also be released, which this class handles automatically in its destructor.

The font is initialised from a resource file, and can be identified by name or UID.

CFbsFont

Inherits from

CCleanupStackableFont
- CBase

Public Member Functions
	~CCleanupStackableFont ()
IMPORT_C CFbsFont &	Font ()
IMPORT_C CCleanupStackableFont *	NewByNameL ( TResourceReader &, CWsScreenDevice &)
IMPORT_C CCleanupStackableFont *	NewByNameLC ( TResourceReader &, CWsScreenDevice &)
IMPORT_C CCleanupStackableFont *	NewL ( TResourceReader &, CWsScreenDevice &)
IMPORT_C CCleanupStackableFont *	NewLC ( TResourceReader &, CWsScreenDevice &)
IMPORT_C CFbsFont *	TakeOwnershipOfFont ()

Private Member Functions
	CCleanupStackableFont ( CWsScreenDevice &)
CCleanupStackableFont *	NewLC ( TBool , TResourceReader &, CWsScreenDevice &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CFbsFont *	iFont
CWsScreenDevice &	iScreenDevice

Constructor & Destructor Documentation

CCleanupStackableFont(CWsScreenDevice &)

CCleanupStackableFont

(

CWsScreenDevice &

aScreenDevice

)

[private]

Parameters

CWsScreenDevice & aScreenDevice

~CCleanupStackableFont()

IMPORT_C

~CCleanupStackableFont

(

)

[virtual]

Destructor.

This releases the font. The font is only deleted if its access count is zero (so that no client is using it).

Member Functions Documentation

Font()

IMPORT_C CFbsFont &

Font

(

)

const

Gets the font stored in this object.

The caller does not take ownership.

NewByNameL(TResourceReader &, CWsScreenDevice &)

IMPORT_C CCleanupStackableFont *	NewByNameL	(	TResourceReader &	aReader,
			CWsScreenDevice &	aScreenDevice
		)	[static]

Allocates and constructs a new CCleanupStackableFont .

aReader should be initialised to read a resource of type NAMED_FONT.

Parameters

TResourceReader & aReader	The resource reader to use.
CWsScreenDevice & aScreenDevice	The screen device.

NewByNameLC(TResourceReader &, CWsScreenDevice &)

IMPORT_C CCleanupStackableFont *	NewByNameLC	(	TResourceReader &	aReader,
			CWsScreenDevice &	aScreenDevice
		)	[static]

Allocates and constructs a new CCleanupStackableFont , leaving it on the cleanup stack.

aReader should be initialised to read a resource of type NAMED_FONT.

Parameters

TResourceReader & aReader	The resource reader to use.
CWsScreenDevice & aScreenDevice	The screen device.

NewL(TResourceReader &, CWsScreenDevice &)

IMPORT_C CCleanupStackableFont *	NewL	(	TResourceReader &	aReader,
			CWsScreenDevice &	aScreenDevice
		)	[static]

Allocates and constructs a new CCleanupStackableFont .

aReader should be initialised to read a resource of type FONT.

Parameters

TResourceReader & aReader	The resource reader to use.
CWsScreenDevice & aScreenDevice	The screen device.

NewLC(TResourceReader &, CWsScreenDevice &)

IMPORT_C CCleanupStackableFont *	NewLC	(	TResourceReader &	aReader,
			CWsScreenDevice &	aScreenDevice
		)	[static]

Allocates and constructs a new CCleanupStackableFont , leaving it on the cleanup stack.

aReader should be initialised to read a resource of type FONT.

Parameters

TResourceReader & aReader	The resource reader to use.
CWsScreenDevice & aScreenDevice	The screen device.

NewLC(TBool, TResourceReader &, CWsScreenDevice &)

CCleanupStackableFont *	NewLC	(	TBool	aByUid,
			TResourceReader &	aReader,
			CWsScreenDevice &	aScreenDevice
		)	[private, static]

Parameters

TBool aByUid
TResourceReader & aReader
CWsScreenDevice & aScreenDevice

TakeOwnershipOfFont()

IMPORT_C CFbsFont *

TakeOwnershipOfFont

(

)

Gets the font stored in this object.

The caller takes ownership of the returned font.

Member Data Documentation

CFbsFont * iFont

CFbsFont *

iFont

[private]

CWsScreenDevice & iScreenDevice

CWsScreenDevice &

iScreenDevice

[private]