Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: gulfont.h
Link against: egul.lib

Class CCleanupStackableFont

CCleanupStackableFont

Support

Supported from 6.0

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.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CCleanupStackableFontWraps a font (CFbsFont) object that can be pushed onto the cleanup stack

Defined in CCleanupStackableFont:
Font(), NewByNameL(), NewByNameLC(), NewL(), NewLC(), TakeOwnershipOfFont(), ~CCleanupStackableFont()

Inherited from CBase:
operator new()

See also:


Construction and destruction


NewL()

static CCleanupStackableFont* NewL(TResourceReader& aReader,CWsScreenDevice& aScreenDevice);

Description

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.

Return value

CCleanupStackableFont*

The CCleanupStackableFont object.


NewLC()

static CCleanupStackableFont* NewLC(TResourceReader& aReader,CWsScreenDevice& aScreenDevice);

Description

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.

Return value

CCleanupStackableFont*

Pointer to the CCleanupStackableFont object.


NewByNameL()

static CCleanupStackableFont* NewByNameL(TResourceReader& aReader,CWsScreenDevice& aScreenDevice);

Support

Supported from 6.1

Description

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.

Return value

CCleanupStackableFont*

Pointer to the CCleanupStackableFont object.


NewByNameLC()

static CCleanupStackableFont* NewByNameLC(TResourceReader& aReader,CWsScreenDevice& aScreenDevice);

Support

Supported from 6.1

Description

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.

Return value

CCleanupStackableFont*

Pointer to the CCleanupStackableFont object.


~CCleanupStackableFont()

virtual ~CCleanupStackableFont();

Description

Destructor.

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


Font()

CFbsFont& Font() const;

Description

Gets the font stored in this object.

The caller does not take ownership.

Return value

CFbsFont&

The font.


TakeOwnershipOfFont()

CFbsFont* TakeOwnershipOfFont();

Description

Gets the font stored in this object.

The caller takes ownership of the returned font.

Return value

CFbsFont*

The font.