CCleanupStackableFont Class Reference

#include <mw/gulfont.h>

Link against: egul.lib

class CCleanupStackableFont : public CBase

Inherits from

CCleanupStackableFont

Public Member Functions
virtual	~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()

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()

Detailed Description

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.

Constructor & Destructor Documentation

~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 Function Documentation

Font ( )

IMPORT_C CFbsFont &

Font

(

)

const

Gets the font stored in this object.

The caller does not take ownership.

Returns: The font.

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.

Parameter	Description
aReader	The resource reader to use.
aScreenDevice	The screen device.

Returns: Pointer to the CCleanupStackableFont object.

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.

Parameter	Description
aReader	The resource reader to use.
aScreenDevice	The screen device.

Returns: Pointer to the CCleanupStackableFont object.

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.

Parameter	Description
aReader	The resource reader to use.
aScreenDevice	The screen device.

Returns: The CCleanupStackableFont object.

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.

Parameter	Description
aReader	The resource reader to use.
aScreenDevice	The screen device.

Returns: Pointer to the CCleanupStackableFont object.

TakeOwnershipOfFont ( )

IMPORT_C CFbsFont *

TakeOwnershipOfFont

(

)

Gets the font stored in this object.

The caller takes ownership of the returned font.

Returns: The font.