Collapse all Symbian^3 Product Developer Library

CCharFormatLayer Class Reference

class CCharFormatLayer : public CFormatLayer

Character format layer.

Uses a pointer (stored in its base class CFormatLayer) to another character format layer which may be NULL. This pointer is referred to as the based-on link. A character format layer is owned by an instance of the CGlobalText class and stores the object's global character formatting. Implements persistence and allows attributes to be set and sensed.

Inherits from

CCharFormatLayer
- CFormatLayer
  - CBase

Public Member Functions
CCharFormatLayer *	CloneL()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &, const CFormatLayer *)
IMPORT_C TBool	IsIdentical(CFormatLayer *, TBool)
IMPORT_C TBool	IsIdentical(const TCharFormat &, const TCharFormatMask &)
CCharFormatLayer *	NewCopyBaseL(const CCharFormatLayer *)
IMPORT_C CCharFormatLayer *	NewL()
IMPORT_C CCharFormatLayer *	NewL(const TCharFormat &, const TCharFormatMask &)
IMPORT_C CCharFormatLayer *	NewL(RReadStream &)
CCharFormatLayer *	NewL(const CCharFormatLayer *)
CCharFormatLayer *	NewL(const TCharFormatX &, const TCharFormatXMask &)
IMPORT_C const TUint8 *	Ptr(TInt &)
IMPORT_C void	Sense(TCharFormat &, TCharFormatMask &)
void	Sense(TCharFormatX &, TCharFormatXMask &)
IMPORT_C void	SenseEffective(TCharFormat &)
void	SenseEffective(TCharFormatX &)
IMPORT_C void	SetL(const TCharFormat &, const TCharFormatMask &)
void	SetL(const TCharFormatX &, const TCharFormatXMask &)

Private Member Functions
	CCharFormatLayer()
IMPORT_C CFormatLayer *	DoCloneL()
void	FillCharFormat(TCharFormatX &, TCharFormatXMask &)
CFormatLayer *	RestoreNewL(RReadStream &)

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()
	CFormatLayer::CFormatLayer()
	CFormatLayer::ChainCount()const
	CFormatLayer::CloneLayerL(CFormatLayer *)const
	CFormatLayer::ExternalizeChainL(RWriteStream &,TInt)const
	CFormatLayer::ExternalizeLayersRecurseL(RWriteStream &,TInt)const
	CFormatLayer::InternalizeChainL(RReadStream &,const CFormatLayer *)
	CFormatLayer::IsEmpty()const
	CFormatLayer::IsIdentical(const TUint8 *,TInt)const
	CFormatLayer::Reset()
	CFormatLayer::SenseBase()const
	CFormatLayer::SetBase(const CFormatLayer *)
	CFormatLayer::Swap(CFormatLayer &)
	CFormatLayer::~CFormatLayer()

Inherited Attributes
	CFormatLayer::__DECLARE_TEST
	CFormatLayer::iBasedOn
	CFormatLayer::iStore

Constructor & Destructor Documentation

CCharFormatLayer()

CCharFormatLayer

(

)

[private]

Member Functions Documentation

CloneL()

CCharFormatLayer *

CloneL

(

)

const [inline]

Constructs and returns a new CCharFormatLayer with identical formatting to the current layer. Note that the function does not copy the original layer's based-on link - the new layer's based-on link is set to NULL, so that the two layers may not have the same effective formatting.

DoCloneL()

IMPORT_C CFormatLayer *

DoCloneL

(

)

const [private, virtual]

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Implementations of this function externalise the format layer but not its based-on link to a write stream. The presence of this function means that the standard templatedoperator<<() (defined in s32strm.h) is available to externalise objects of the derived class.

Parameters

RWriteStream & aStream

Stream to which the format layer should be externalised.

FillCharFormat(TCharFormatX &, TCharFormatXMask &)

void	FillCharFormat	(	TCharFormatX &	aCharFormat,
			TCharFormatXMask &	aMask
		)	const [private, virtual]

Parameters

TCharFormatX & aCharFormat
TCharFormatXMask & aMask

InternalizeL(RReadStream &, const CFormatLayer *)

IMPORT_C void	InternalizeL	(	RReadStream &	aStream,
			const CFormatLayer *	aBase = NULL
		)	[virtual]

Implementations of this function internalise the format layer but not its based-on link from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of the derived class. The internalised layer is set to be based on the layer specified.

Parameters

RReadStream & aStream	Stream from which the format layer should be internalised.
const CFormatLayer * aBase = NULL	The based-on link to assign to the layer. By default, NULL.

IsIdentical(CFormatLayer *, TBool)

IMPORT_C TBool	IsIdentical	(	CFormatLayer *	aLayer,
			TBool	aCheckBasedOnLink = ETrue
		)	const [virtual]

Implementations of this function compare another format layer with the current object. For the two layers to be equal, they must have the same contents and (if the second parameter is ETrue), their based-on links must point to the same format layer.

Parameters

CFormatLayer * aLayer	The layer to compare to this format layer.
TBool aCheckBasedOnLink = ETrue	If ETrue, both layers' based-on links must point to the same format layer. If EFalse, the based-on links are not used in the comparison. By default, ETrue.

IsIdentical(const TCharFormat &, const TCharFormatMask &)

IMPORT_C TBool	IsIdentical	(	const TCharFormat &	aCharFormat,
			const TCharFormatMask &	aMask
		)	const

Parameters

const TCharFormat & aCharFormat
const TCharFormatMask & aMask

NewCopyBaseL(const CCharFormatLayer *)

CCharFormatLayer *

NewCopyBaseL

(

const CCharFormatLayer *

aLayer

)

[static]

Parameters

const CCharFormatLayer * aLayer

NewL()

IMPORT_C CCharFormatLayer *

NewL

(

)

[static]

NewL(const TCharFormat &, const TCharFormatMask &)

IMPORT_C CCharFormatLayer *	NewL	(	const TCharFormat &	aFormat,
			const TCharFormatMask &	aMask
		)	[static]

Parameters

const TCharFormat & aFormat
const TCharFormatMask & aMask

NewL(RReadStream &)

IMPORT_C CCharFormatLayer *

NewL

(

RReadStream &

aStream

)

[static]

Parameters

RReadStream & aStream

NewL(const CCharFormatLayer *)

CCharFormatLayer *

NewL

(

const CCharFormatLayer *

aLayer

)

[static]

Parameters

const CCharFormatLayer * aLayer

NewL(const TCharFormatX &, const TCharFormatXMask &)

CCharFormatLayer *	NewL	(	const TCharFormatX &	aFormat,
			const TCharFormatXMask &	aMask
		)	[static]

Parameters

const TCharFormatX & aFormat
const TCharFormatXMask & aMask

Ptr(TInt &)

IMPORT_C const TUint8 *

Ptr

(

TInt &

aSize

)

const

Parameters

TInt & aSize

RestoreNewL(RReadStream &)

CFormatLayer *

RestoreNewL

(

RReadStream &

aStream

)

[private, virtual]

Parameters

RReadStream & aStream

Sense(TCharFormat &, TCharFormatMask &)

IMPORT_C void	Sense	(	TCharFormat &	aCharFormat,
			TCharFormatMask &	aMask
		)	const

Parameters

TCharFormat & aCharFormat
TCharFormatMask & aMask

Sense(TCharFormatX &, TCharFormatXMask &)

void	Sense	(	TCharFormatX &	aCharFormat,
			TCharFormatXMask &	aMask
		)	const

Parameters

TCharFormatX & aCharFormat
TCharFormatXMask & aMask

SenseEffective(TCharFormat &)

IMPORT_C void

SenseEffective

(

TCharFormat &

aCharFormat

)

const

Parameters

TCharFormat & aCharFormat

SenseEffective(TCharFormatX &)

void

SenseEffective

(

TCharFormatX &

aCharFormat

)

const

Parameters

TCharFormatX & aCharFormat

SetL(const TCharFormat &, const TCharFormatMask &)

IMPORT_C void	SetL	(	const TCharFormat &	aCharFormat,
			const TCharFormatMask &	aMask
		)

Parameters

const TCharFormat & aCharFormat
const TCharFormatMask & aMask

SetL(const TCharFormatX &, const TCharFormatXMask &)

void	SetL	(	const TCharFormatX &	aCharFormat,
			const TCharFormatXMask &	aMask
		)

Parameters

const TCharFormatX & aCharFormat
const TCharFormatXMask & aMask