CParaFormatLayer Class Reference

class CParaFormatLayer : public CFormatLayer

A paragraph format layer.

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

Inherits from

CParaFormatLayer
- CFormatLayer
  - CBase

Public Member Functions
CParaFormatLayer *	CloneL()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &, const CFormatLayer *)
IMPORT_C TBool	IsIdentical(CFormatLayer *, TBool)
IMPORT_C TBool	IsIdenticalL(const CParaFormat *, const TParaFormatMask &)
CParaFormatLayer *	NewCopyBaseL(const CParaFormatLayer *)
IMPORT_C CParaFormatLayer *	NewL()
IMPORT_C CParaFormatLayer *	NewL(const CParaFormat *, const TParaFormatMask &)
IMPORT_C CParaFormatLayer *	NewL(RReadStream &)
CParaFormatLayer *	NewL(const CParaFormatLayer *)
IMPORT_C const TUint8 *	Ptr(TInt &)
IMPORT_C void	SenseEffectiveL(CParaFormat *, CParaFormat::TParaFormatGetMode)
IMPORT_C void	SenseL(CParaFormat *, TParaFormatMask &, CParaFormat::TParaFormatGetMode)
IMPORT_C void	SetL(const CParaFormat *, const TParaFormatMask &)
IMPORT_C TUid	Type()

Protected Member Functions
	CParaFormatLayer()
CFormatLayer *	RestoreNewL(RReadStream &)

Private Member Functions
	CParaFormatLayer(const CParaFormatLayer &)
void	CleanupBorders(CParaFormat *)
void	CleanupEffectiveFormat(CParaFormat *, TParaFormatMask)
IMPORT_C CFormatLayer *	DoCloneL()
void	FillParaFormatL(CParaFormat *, TParaFormatMask &, CParaFormat::TParaFormatGetMode)
CParaFormatLayer &	operator=(const CParaFormatLayer &)

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

CParaFormatLayer(const CParaFormatLayer &)

CParaFormatLayer

(

const CParaFormatLayer &

aParaFormatLayer

)

[private]

Parameters

const CParaFormatLayer & aParaFormatLayer

CParaFormatLayer()

CParaFormatLayer

(

)

[protected]

Member Functions Documentation

CleanupBorders(CParaFormat *)

void

CleanupBorders

(

CParaFormat *

aParaFormat

)

const [private]

Parameters

CParaFormat * aParaFormat

CleanupEffectiveFormat(CParaFormat *, TParaFormatMask)

void	CleanupEffectiveFormat	(	CParaFormat *	aParaFormat,
			TParaFormatMask	aMask
		)	const [private]

Parameters

CParaFormat * aParaFormat
TParaFormatMask aMask

CloneL()

CParaFormatLayer *

CloneL

(

)

const [inline]

Constructs and returns a new CParaFormatLayer 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.

A new paragraph format layer cloned from the current layer.

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.

FillParaFormatL(CParaFormat *, TParaFormatMask &, CParaFormat::TParaFormatGetMode)

void	FillParaFormatL	(	CParaFormat *	aParaFormat,
			TParaFormatMask &	aMask,
			CParaFormat::TParaFormatGetMode	aMode
		)	const [private]

Parameters

CParaFormat * aParaFormat
TParaFormatMask & aMask
CParaFormat::TParaFormatGetMode aMode

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.

ETrue if the two layers are identical, otherwise EFalse.

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.