CRichText Class Reference

aReplicas = 1

)

Parameters

TInt aReplicas = 1

AppendTakingSolePictureOwnershipL(const CRichText &)

IMPORT_C void

AppendTakingSolePictureOwnershipL

(

const CRichText &

aSource

)

Parameters

const CRichText & aSource

ApplyCharFormatL(const TCharFormat &, const TCharFormatMask &, TInt, TInt)

IMPORT_C void	ApplyCharFormatL	(	const TCharFormat &	aFormat,
			const TCharFormatMask &	aMask,
			TInt	aPos,
			TInt	aLength
		)	[virtual]

Parameters

const TCharFormat & aFormat
const TCharFormatMask & aMask
TInt aPos
TInt aLength

ApplyExtendedCharFormatL(const TCharFormatX &, const TCharFormatXMask &, TInt, TInt)

void	ApplyExtendedCharFormatL	(	const TCharFormatX &	aFormat,
			const TCharFormatXMask &	aMask,
			TInt	aPos,
			TInt	aLength
		)

Parameters

const TCharFormatX & aFormat
const TCharFormatXMask & aMask
TInt aPos
TInt aLength

ApplyParaFormatL(const CParaFormat *, const TParaFormatMask &, TInt, TInt)

IMPORT_C void	ApplyParaFormatL	(	const CParaFormat *	aFormat,
			const TParaFormatMask &	aMask,
			TInt	aPos,
			TInt	aLength
		)	[virtual]

Parameters

const CParaFormat * aFormat
const TParaFormatMask & aMask
TInt aPos
TInt aLength

ApplyParagraphStyleL(const CParagraphStyle &, TInt, TInt, CParagraphStyle::TApplyParaStyleMode)

IMPORT_C void	ApplyParagraphStyleL	(	const CParagraphStyle &	aStyle,
			TInt	aPos,
			TInt	aLength,
			CParagraphStyle::TApplyParaStyleMode	aMode
		)

Parameters

const CParagraphStyle & aStyle
TInt aPos
TInt aLength
CParagraphStyle::TApplyParaStyleMode aMode

CallEditObserver(TInt, TInt)

void	CallEditObserver	(	TInt	aStart,
			TInt	aExtent
		)	const [private]

Parameters

TInt aStart
TInt aExtent

CancelInsertCharFormat()

IMPORT_C void

CancelInsertCharFormat

(

)

CharPosOfParagraph(TInt &, TInt)

IMPORT_C TInt	CharPosOfParagraph	(	TInt &	aLength,
			TInt	aParaOffset
		)	const [virtual]

Parameters

TInt & aLength
TInt aParaOffset

CompletePastePlainTextL(TInt, TInt)

void	CompletePastePlainTextL	(	TInt	aPos,
			TInt	aCharacterCount
		)	[private]

Parameters

TInt aPos
TInt aCharacterCount

CompletePasteRichTextFromStoreL(const CStreamStore &, TStreamId &, TInt, CParagraphStyle::TStylePasteMode)

void	CompletePasteRichTextFromStoreL	(	const CStreamStore &	aStore,
			TStreamId &	aRichTextStreamId,
			TInt	aPos,
			CParagraphStyle::TStylePasteMode	aStylePasteMode
		)	[protected]

Parameters

const CStreamStore & aStore
TStreamId & aRichTextStreamId
TInt aPos
CParagraphStyle::TStylePasteMode aStylePasteMode

ComponentInfo()

IMPORT_C TEtextComponentInfo

ComponentInfo

(

)

const [virtual]

ConstructL(TDocumentStorage, TInt, TParaType)

IMPORT_C void	ConstructL	(	TDocumentStorage	aStorage,
			TInt	aDefaultTextGranularity,
			TParaType	aParaType
		)	[protected]

Parameters

TDocumentStorage aStorage
TInt aDefaultTextGranularity
TParaType aParaType

ConstructL(const CStreamStore &, TStreamId, MPictureFactory , MRichTextStoreResolver , MTextFieldFactory *, TDocumentStorage)

IMPORT_C void	ConstructL	(	const CStreamStore &	aStore,
			TStreamId	aStreamId,
			MPictureFactory *	aFactory,
			MRichTextStoreResolver *	aStoreResolver,
			MTextFieldFactory *	aFieldFactory = NULL,
			TDocumentStorage	aStorage = ESegmentedStorage
		)	[protected]

Parameters

const CStreamStore & aStore
TStreamId aStreamId
MPictureFactory * aFactory
MRichTextStoreResolver * aStoreResolver
MTextFieldFactory * aFieldFactory = NULL
TDocumentStorage aStorage = ESegmentedStorage

CopyComponentsL(CStreamStore &, CStoreMap &, TInt, TInt, TStreamId)

IMPORT_C void	CopyComponentsL	(	CStreamStore &	aStore,
			CStoreMap &	aMap,
			TInt	aPos,
			TInt	aLength,
			TStreamId	aGlobalTextId
		)	const [protected]

Parameters

CStreamStore & aStore
CStoreMap & aMap
TInt aPos
TInt aLength
TStreamId aGlobalTextId

CopyToStoreL(CStreamStore &, CStreamDictionary &, TInt, TInt)

IMPORT_C void	CopyToStoreL	(	CStreamStore &	aStore,
			CStreamDictionary &	aDictionary,
			TInt	aPos,
			TInt	aLength
		)	const [virtual]

Copies a portion of the text to the clipboard.

Parameters

CStreamStore & aStore	The clipboard's store (see class CClipboard).
CStreamDictionary & aDictionary	The clipboard's stream dictionary (see class CClipboard).
TInt aPos	A valid document position from which to begin copying.
TInt aLength	The number of characters to copy.

CopyToStreamL(RWriteStream &, TInt, TInt, TStreamId)

IMPORT_C void	CopyToStreamL	(	RWriteStream &	aStream,
			TInt	aPos,
			TInt	aLength,
			TStreamId	aGlobalTextId
		)	const [protected]

Parameters

RWriteStream & aStream
TInt aPos
TInt aLength
TStreamId aGlobalTextId

CopyToStreamL(RWriteStream &, TInt, TInt)

IMPORT_C void	CopyToStreamL	(	RWriteStream &	aStream,
			TInt	aPos,
			TInt	aLength
		)	const [protected]

Parameters

RWriteStream & aStream
TInt aPos
TInt aLength

CopyToStreamL(RWriteStream &, TInt, TInt, TStreamId, TBool)

void	CopyToStreamL	(	RWriteStream &	aStream,
			TInt	aPos,
			TInt	aLength,
			TStreamId	aGlobalTextId,
			TBool	aCopyStyles
		)	const [protected]

Parameters

RWriteStream & aStream
TInt aPos
TInt aLength
TStreamId aGlobalTextId
TBool aCopyStyles

CreateAndGenerateMarkupComponentL()

void

CreateAndGenerateMarkupComponentL

(

)

[private]

CreateEmptyMarkupComponentL()

TBool

CreateEmptyMarkupComponentL

(

)

[private]

CreateParserETextTLSL()

void

CreateParserETextTLSL

(

)

[private, static]

CursorOverTag(TInt, MParser *&, TInt &, TInt &)

IMPORT_C TBool	CursorOverTag	(	TInt	aPos,
			MParser *&	aParser,
			TInt &	aTagStart,
			TInt &	aLength
		)	const

Parameters

TInt aPos
MParser *& aParser
TInt & aTagStart
TInt & aLength

DeactivateParser(MParser *)

IMPORT_C void

DeactivateParser

(

MParser *

aParser

)

[static]

Parameters

MParser * aParser

DeactivateParserDefaults()

IMPORT_C void

DeactivateParserDefaults

(

)

[static]

DelSetInsertCharFormatL(TInt, TInt)

IMPORT_C TBool	DelSetInsertCharFormatL	(	TInt	aPos,
			TInt	aLength
		)

Parameters

TInt aPos
TInt aLength

DeleteFromParagraph(TInt, TInt)

IMPORT_C void	DeleteFromParagraph	(	TInt	aPos,
			TInt	aLength
		)

Parameters

TInt aPos
TInt aLength

DeleteL(TInt, TInt)

IMPORT_C TBool	DeleteL	(	TInt	aPos,
			TInt	aLength
		)	[virtual]

Deletes one or more characters beginning at (and including) the character at the specified document position.

Indicates whether or not two paragraphs have been merged as a result of the delete, so that the resulting paragraph needs to be reformatted. This value is only relevant to rich text, so for plain and global text implementations, the function always returns EFalse.

Parameters

TInt aPos	The document position from which to delete.
TInt aLength	The number of characters to delete.

DeleteParagraph(TInt, TInt)

IMPORT_C void	DeleteParagraph	(	TInt	aPos,
			TInt	aLength
		)

Parameters

TInt aPos
TInt aLength

DetachFromStoreL(CPicture::TDetach)

IMPORT_C void

DetachFromStoreL

(

CPicture::TDetach

aDegree

)

Parameters

CPicture::TDetach aDegree

DetachFromStoreL(CPicture::TDetach, TInt, TInt)

IMPORT_C void	DetachFromStoreL	(	CPicture::TDetach	aDegree,
			TInt	aPos,
			TInt	aLength
		)

Parameters

CPicture::TDetach aDegree
TInt aPos
TInt aLength

DoAppendTakingSolePictureOwnershipL(const CRichText &)

void

DoAppendTakingSolePictureOwnershipL

(

const CRichText &

aSource

)

[protected]

Parameters

const CRichText & aSource

DoApplyExtendedCharFormatL(const TCharFormatX &, const TCharFormatXMask &, TInt, TInt)

void	DoApplyExtendedCharFormatL	(	const TCharFormatX &	aFormat,
			const TCharFormatXMask &	aMask,
			TInt	aPos,
			TInt	aLength
		)	[private]

Parameters

const TCharFormatX & aFormat
const TCharFormatXMask & aMask
TInt aPos
TInt aLength

DoCopyToStoreL(CStreamStore &, TInt, TInt, TStreamId, TBool)

TStreamId	DoCopyToStoreL	(	CStreamStore &	aStore,
			TInt	aPos,
			TInt	aLength,
			TStreamId	aGlobalTextId,
			TBool	aCopyStyles
		)	const [protected]

Parameters

CStreamStore & aStore
TInt aPos
TInt aLength
TStreamId aGlobalTextId
TBool aCopyStyles

DoCursorOverTag(TInt, MParser *&, TInt &, TInt &)

TBool	DoCursorOverTag	(	TInt	aPos,
			MParser *&	aParser,
			TInt &	aTagStart,
			TInt &	aLength
		)	const [private]

Parameters

TInt aPos
MParser *& aParser
TInt & aTagStart
TInt & aLength

DoExternalizeMarkupDataL(RWriteStream &)

IMPORT_C void

DoExternalizeMarkupDataL

(

aStream

)

const [protected]

Parameters

RWriteStream & aStream

DoExternalizeStyleDataL(RWriteStream &)

IMPORT_C void

DoExternalizeStyleDataL

(

aStream

)

const [protected]

Parameters

RWriteStream & aStream

DoInternalizeMarkupDataL(RReadStream &)

IMPORT_C void

DoInternalizeMarkupDataL

(

aStream

)

[protected]

Parameters

RReadStream & aStream

DoInternalizeStyleDataL(RReadStream &)

IMPORT_C void

DoInternalizeStyleDataL

(

aStream

)

[protected]

Parameters

RReadStream & aStream

DoInternalizeStyleDataL(RReadStream &, const CStyleList *)

void	DoInternalizeStyleDataL	(	RReadStream &	aStream,
			const CStyleList *	aExternalStyleList
		)	[protected]

Parameters

RReadStream & aStream
const CStyleList * aExternalStyleList

DoPasteRtFromStoreL(const CStreamStore &, const CStreamDictionary &, TInt, CParagraphStyle::TStylePasteMode)

TInt	DoPasteRtFromStoreL	(	const CStreamStore &	aStore,
			const CStreamDictionary &	aDictionary,
			TInt	aPos,
			CParagraphStyle::TStylePasteMode	aStylePasteMode
		)	[private]

Parameters

const CStreamStore & aStore
const CStreamDictionary & aDictionary
TInt aPos
CParagraphStyle::TStylePasteMode aStylePasteMode

DropPictureOwnership(TInt)

IMPORT_C void

DropPictureOwnership

(

aPos

)

Parameters

TInt aPos

ExtendedInterface(TAny *&, TUid)

IMPORT_C void	ExtendedInterface	(	TAny *&	aInterface,
			TUid	aInterfaceId
		)	[virtual]

Parameters

TAny *& aInterface
TUid aInterfaceId

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

aStream

)

const [virtual]

Parameters

RWriteStream & aStream

ExternalizeMarkupDataL(RWriteStream &)

IMPORT_C void

ExternalizeMarkupDataL

(

aStream

)

const

Parameters

RWriteStream & aStream

ExternalizeStyleDataL(RWriteStream &)

IMPORT_C void

ExternalizeStyleDataL

(

aStream

)

const

Parameters

RWriteStream & aStream

GenerateMarkupL()

void

GenerateMarkupL

(

)

[private]

GetCharFormat(TCharFormat &, TCharFormatMask &, TInt, TInt)

IMPORT_C void	GetCharFormat	(	TCharFormat &	aFormat,
			TCharFormatMask &	aVaries,
			TInt	aPos,
			TInt	aLength
		)	const [virtual]

Parameters

TCharFormat & aFormat
TCharFormatMask & aVaries
TInt aPos
TInt aLength

GetChars(TPtrC &, TCharFormat &, TInt)

IMPORT_C void	GetChars	(	TPtrC &	aView,
			TCharFormat &	aFormat,
			TInt	aPos
		)	const [virtual]

Parameters

TPtrC & aView
TCharFormat & aFormat
TInt aPos

GetExtendedCharFormat(TCharFormatX &, TCharFormatXMask &, TInt, TInt)

void	GetExtendedCharFormat	(	TCharFormatX &	aFormat,
			TCharFormatXMask &	aVaries,
			TInt	aPos,
			TInt	aLength
		)	const

Parameters

TCharFormatX & aFormat
TCharFormatXMask & aVaries
TInt aPos
TInt aLength

GetParaFormatL(CParaFormat *, TParaFormatMask &, TInt, TInt, CParaFormat::TParaFormatGetMode)

IMPORT_C void	GetParaFormatL	(	CParaFormat *	aFormat,
			TParaFormatMask &	aVaries,
			TInt	aPos,
			TInt	aLength,
			CParaFormat::TParaFormatGetMode	aMode = CParaFormat::EAllAttributes
		)	const [virtual]

Parameters

CParaFormat * aFormat
TParaFormatMask & aVaries
TInt aPos
TInt aLength
CParaFormat::TParaFormatGetMode aMode = CParaFormat::EAllAttributes

GetParagraphFormatL(CParaFormat *, TInt)

IMPORT_C void	GetParagraphFormatL	(	CParaFormat *	aFormat,
			TInt	aPos
		)	const [virtual]

Parameters

CParaFormat * aFormat
TInt aPos

GetPictureSizeInTwips(TSize &, TInt)

IMPORT_C TInt	GetPictureSizeInTwips	(	TSize &	aSize,
			TInt	aPos
		)	const [virtual]

Parameters

TSize & aSize
TInt aPos

GetSpecificCharFormat(TCharFormat &, TCharFormatMask &, TInt)

IMPORT_C void	GetSpecificCharFormat	(	TCharFormat &	aFormat,
			TCharFormatMask &	aMask,
			TInt	aPos
		)	const

Parameters

TCharFormat & aFormat
TCharFormatMask & aMask
TInt aPos

GetSpecificCharFormatLeftRight(TCharFormat &, TCharFormatMask &, TInt, TBool)

void	GetSpecificCharFormatLeftRight	(	TCharFormat &	aFormat,
			TCharFormatMask &	aMask,
			TInt	aPos,
			TBool	aLeft
		)	const [private]

Parameters

TCharFormat & aFormat
TCharFormatMask & aMask
TInt aPos
TBool aLeft

GetSpecificCharFormatRight(TCharFormat &, TCharFormatMask &, TInt)

IMPORT_C void	GetSpecificCharFormatRight	(	TCharFormat &	aFormat,
			TCharFormatMask &	aMask,
			TInt	aPos
		)	const

Parameters

TCharFormat & aFormat
TCharFormatMask & aMask
TInt aPos

GetSpecificParagraphFormatL(CParaFormat *, TParaFormatMask &, TInt)

IMPORT_C void	GetSpecificParagraphFormatL	(	CParaFormat *	aFormat,
			TParaFormatMask &	aMask,
			TInt	aPos
		)	const

Parameters

CParaFormat * aFormat
TParaFormatMask & aMask
TInt aPos

GetTextAndExtendedFormat(TPtrC &, TCharFormatX &, TInt)

void	GetTextAndExtendedFormat	(	TPtrC &	aText,
			TCharFormatX &	aFormat,
			TInt	aPos
		)	const

Parameters

TPtrC & aText
TCharFormatX & aFormat
TInt aPos

HasMarkupData()

IMPORT_C TBool

HasMarkupData

(

)

const

IndexPresent()

TBool

IndexPresent

(

)

const [private]

InsertL(TInt, const TChar &)

IMPORT_C void	InsertL	(	TInt	aInsertPos,
			const TChar &	aChar
		)	[virtual]

Inserts a single character or a descriptor into the text object at a specified document position.

Parameters

TInt aInsertPos	A valid document position at which to insert the character or descriptor.
const TChar & aChar	The character to insert.

InsertL(TInt, const TDesC &)

IMPORT_C void	InsertL	(	TInt	aInsertPos,
			const TDesC &	aBuf
		)	[virtual]

Inserts a single character or a descriptor into the text object at a specified document position.

Parameters

TInt aInsertPos	A valid document position at which to insert the character or descriptor.
const TDesC & aBuf	The descriptor to insert.

InsertL(TInt, const TPictureHeader &)

IMPORT_C void	InsertL	(	TInt	aPos,
			const TPictureHeader &	aHeader
		)

Parameters

TInt aPos
const TPictureHeader & aHeader

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

aStream

)

[virtual]

Parameters

RReadStream & aStream

InternalizeL(RReadStream &, const CStyleList *)

void	InternalizeL	(	RReadStream &	aStream,
			const CStyleList *	aExternalStyleList
		)	[protected]

Parameters

RReadStream & aStream
const CStyleList * aExternalStyleList

InternalizeMarkupDataL(RReadStream &)

IMPORT_C void

InternalizeMarkupDataL

(

aStream

)

Parameters

RReadStream & aStream

InternalizeStyleDataL(RReadStream &)

IMPORT_C void

InternalizeStyleDataL

(

aStream

)

Parameters

RReadStream & aStream

KillIndex()

void

KillIndex

(

)

[private]

KillStyleList()

void

KillStyleList

(

)

[private]

NewL(const CParaFormatLayer , const CCharFormatLayer , TDocumentStorage, TInt, TParaType)

IMPORT_C CRichText *	NewL	(	const CParaFormatLayer *	aGlobalParaLayer,
			const CCharFormatLayer *	aGlobalCharLayer,
			TDocumentStorage	aStorage = ESegmentedStorage,
			TInt	aDefaultTextGranularity = EDefaultTextGranularity,
			TParaType	aParaType = EMultiPara
		)	[static]

Parameters

const CParaFormatLayer * aGlobalParaLayer
const CCharFormatLayer * aGlobalCharLayer
TDocumentStorage aStorage = ESegmentedStorage
TInt aDefaultTextGranularity = EDefaultTextGranularity
TParaType aParaType = EMultiPara

NewL(const CParaFormatLayer , const CCharFormatLayer , const CStyleList &, TDocumentStorage, TInt, TParaType)

IMPORT_C CRichText *	NewL	(	const CParaFormatLayer *	aGlobalParaLayer,
			const CCharFormatLayer *	aGlobalCharLayer,
			const CStyleList &	aStyleList,
			TDocumentStorage	aStorage = ESegmentedStorage,
			TInt	aDefaultTextGranularity = EDefaultTextGranularity,
			TParaType	aParaType = EMultiPara
		)	[static]

Parameters

const CParaFormatLayer * aGlobalParaLayer
const CCharFormatLayer * aGlobalCharLayer
const CStyleList & aStyleList
TDocumentStorage aStorage = ESegmentedStorage
TInt aDefaultTextGranularity = EDefaultTextGranularity
TParaType aParaType = EMultiPara

NewL(const CStreamStore &, TStreamId, const CParaFormatLayer , const CCharFormatLayer , MTextFieldFactory *, TDocumentStorage)

IMPORT_C CRichText *	NewL	(	const CStreamStore &	aStore,
			TStreamId	aStreamId,
			const CParaFormatLayer *	aGlobalParaLayer,
			const CCharFormatLayer *	aGlobalCharLayer,
			MTextFieldFactory *	aFieldFactory = NULL,
			TDocumentStorage	aStorage = ESegmentedStorage
		)	[static]

Parameters

const CStreamStore & aStore
TStreamId aStreamId
const CParaFormatLayer * aGlobalParaLayer
const CCharFormatLayer * aGlobalCharLayer
MTextFieldFactory * aFieldFactory = NULL
TDocumentStorage aStorage = ESegmentedStorage

NewL(const CStreamStore &, TStreamId, const CParaFormatLayer , const CCharFormatLayer , MPictureFactory , MRichTextStoreResolver , MTextFieldFactory *, TDocumentStorage)

IMPORT_C CRichText *	NewL	(	const CStreamStore &	aStore,
			TStreamId	aStreamId,
			const CParaFormatLayer *	aGlobalParaLayer,
			const CCharFormatLayer *	aGlobalCharLayer,
			MPictureFactory *	aPictureFactory,
			MRichTextStoreResolver *	aStoreResolver,
			MTextFieldFactory *	aFieldFactory = NULL,
			TDocumentStorage	aStorage = ESegmentedStorage
		)	[static]

Parameters

const CStreamStore & aStore
TStreamId aStreamId
const CParaFormatLayer * aGlobalParaLayer
const CCharFormatLayer * aGlobalCharLayer
MPictureFactory * aPictureFactory
MRichTextStoreResolver * aStoreResolver
MTextFieldFactory * aFieldFactory = NULL
TDocumentStorage aStorage = ESegmentedStorage

NotifyStyleChangedL(const CParagraphStyle , const CParagraphStyle )

IMPORT_C void	NotifyStyleChangedL	(	const CParagraphStyle *	aTo,
			const CParagraphStyle *	aFrom
		)

Parameters

const CParagraphStyle * aTo
const CParagraphStyle * aFrom

NotifyStyleDeletedL(const CParagraphStyle *)

void

NotifyStyleDeletedL

(

const CParagraphStyle *

aStyle

)

[inline]

Removes a style from all paragraphs to which it applies. The formatting is reset to the global character and paragraph format layers, except that any specific formatting which has been applied to the paragraphs is retained.

Notes:

This function should be called on the text content object after deleting a style in the style list.

A panic occurs if the rich text object does not use a style list (this can be tested for using StyleListPresent()).

Parameters

const CParagraphStyle * aStyle

Pointer to the style to remove from the rich text object.

OverrideFormatForParsersIfApplicable(TPtrC &, TCharFormatX &, TInt)

void	OverrideFormatForParsersIfApplicable	(	TPtrC &	aText,
			TCharFormatX &	aFormat,
			TInt	aStartPos
		)	const [private]

Parameters

TPtrC & aText
TCharFormatX & aFormat
TInt aStartPos

ParaTypeIsSingle()

TBool

ParaTypeIsSingle

(

)

const [private, inline]

ParagraphCount()

IMPORT_C TInt

ParagraphCount

(

)

const [virtual]

Returns a count of the number of paragraphs in the document.

The number of paragraphs in the document. Notes: The end-of-text paragraph delimiter at the end of every document means this function always returns a count of at least one.

ParagraphNumberForPos(TInt &)

IMPORT_C TInt

ParagraphNumberForPos

(

TInt &

aPos

)

const [virtual]

Parameters

TInt & aPos

ParagraphStyle(TBool &, TInt, TInt)

IMPORT_C const CParaFormatLayer *	ParagraphStyle	(	TBool &	aStyleChangesOverRange,
			TInt	aPos,
			TInt	aLength
		)	const

Parameters

TBool & aStyleChangesOverRange
TInt aPos
TInt aLength

ParseText(TInt &, TInt &, TBool)

IMPORT_C TBool	ParseText	(	TInt &	aStartOfTags,
			TInt &	aLength,
			TBool	aForceScanAllText
		)

Parameters

TInt & aStartOfTags
TInt & aLength
TBool aForceScanAllText

PasteFromStoreL(const CStreamStore &, const CStreamDictionary &, TInt)

IMPORT_C TInt	PasteFromStoreL	(	const CStreamStore &	aStore,
			const CStreamDictionary &	aDictionary,
			TInt	aPos
		)	[virtual]

Pastes the contents of the clipboard into the text object at the specified document position.

The number of characters pasted.

Parameters

const CStreamStore & aStore	The clipboard's store (see class CClipboard).
const CStreamDictionary & aDictionary	The clipboard's stream dictionary (see class CClipboard).
TInt aPos	A valid document position at which to paste the text.

PasteFromStoreL(const CStreamStore &, const CStreamDictionary &, TInt, CParagraphStyle::TStylePasteMode)

IMPORT_C TInt	PasteFromStoreL	(	const CStreamStore &	aStore,
			const CStreamDictionary &	aDictionary,
			TInt	aPos,
			CParagraphStyle::TStylePasteMode	aStylePasteMode
		)

Parameters

const CStreamStore & aStore
const CStreamDictionary & aDictionary
TInt aPos
CParagraphStyle::TStylePasteMode aStylePasteMode

PastePlainTextFromStoreL(const CStreamStore &, TStreamId &, TInt)

TInt	PastePlainTextFromStoreL	(	const CStreamStore &	aStore,
			TStreamId &	anId,
			TInt	aPos
		)	[protected]

Parameters

const CStreamStore & aStore
TStreamId & anId
TInt aPos

PasteRichTextFromStoreL(const CStreamStore &, const CStreamDictionary &, TStreamId &, TInt, CParagraphStyle::TStylePasteMode)

TInt	PasteRichTextFromStoreL	(	const CStreamStore &	aStore,
			const CStreamDictionary &	aDictionary,
			TStreamId &	anId,
			TInt	aPos,
			CParagraphStyle::TStylePasteMode	aStylePasteMode
		)	[protected]

Parameters

const CStreamStore & aStore
const CStreamDictionary & aDictionary
TStreamId & anId
TInt aPos
CParagraphStyle::TStylePasteMode aStylePasteMode

PictureCount()

IMPORT_C TInt

PictureCount

(

)

const

PictureFactory()

MPictureFactory *

PictureFactory

(

)

const [inline]

Gets the picture factory. A picture factory may be set during construction, or by calling CRichText::SetPictureFactory().

The picture factory

PictureHandleL(TInt, MLayDoc::TForcePictureLoad)

IMPORT_C CPicture *	PictureHandleL	(	TInt	aPos,
			MLayDoc::TForcePictureLoad	aForceLoad = MLayDoc::EForceLoadTrue
		)	const [virtual]

Parameters

TInt aPos
MLayDoc::TForcePictureLoad aForceLoad = MLayDoc::EForceLoadTrue

PictureHeader(TInt)

IMPORT_C TPictureHeader

PictureHeader

(

aPos

)

const

Parameters

TInt aPos

PositionOfNextTag(TInt)

IMPORT_C TInt

PositionOfNextTag

(

aPos

)

const

Parameters

TInt aPos

PositionOfNextTag(TInt, const MParser *)

IMPORT_C TInt	PositionOfNextTag	(	TInt	aPos,
			const MParser *	aParser
		)	const

Parameters

TInt aPos
const MParser * aParser

PositionOfPrevTag(TInt)

IMPORT_C TInt

PositionOfPrevTag

(

aPos

)

const

Parameters

TInt aPos

PositionOfPrevTag(TInt, const MParser *)

IMPORT_C TInt	PositionOfPrevTag	(	TInt	aPos,
			const MParser *	aParser
		)	const

Parameters

TInt aPos
const MParser * aParser

PrepareAppendMarkupL(const CRichText &)

void

PrepareAppendMarkupL

(

const CRichText &

aSource

)

[protected]

Parameters

const CRichText & aSource

RemoveSpecificCharFormatL(TInt, TInt)

IMPORT_C void	RemoveSpecificCharFormatL	(	TInt	aPos,
			TInt	aLength
		)

Parameters

TInt aPos
TInt aLength

RemoveSpecificParaFormatL(TInt, TInt)

IMPORT_C void	RemoveSpecificParaFormatL	(	TInt	aPos,
			TInt	aLength
		)

Parameters

TInt aPos
TInt aLength

Reset()

IMPORT_C void

Reset

(

)

[virtual]

Deletes the text content and components from the text object, leaving the single end-of-text paragraph delimiter.

RestoreComponentsL(const CStreamStore &)

IMPORT_C void

RestoreComponentsL

(

const CStreamStore &

aStore

)

[virtual]

Restores the text components, e.g. fields, pictures and formatting from the stream store. Does not restore the text content.

Parameters

const CStreamStore & aStore

The stream store from which the text components are restored.

RestoreStylesL(const CStreamStore &, TStreamId, const CParaFormatLayer , const CCharFormatLayer )

void	RestoreStylesL	(	const CStreamStore &	aStore,
			TStreamId	aId,
			const CParaFormatLayer *	aParaFormatLayer,
			const CCharFormatLayer *	aCharFormatLayer
		)	[protected]

Parameters

const CStreamStore & aStore
TStreamId aId
const CParaFormatLayer * aParaFormatLayer
const CCharFormatLayer * aCharFormatLayer

RestoreWithStyleListL(const CStreamStore &, TStreamId, const CStyleList &)

IMPORT_C void	RestoreWithStyleListL	(	const CStreamStore &	aStore,
			TStreamId	aStreamId,
			const CStyleList &	aExternalStyleList
		)

Parameters

const CStreamStore & aStore
TStreamId aStreamId
const CStyleList & aExternalStyleList

RtInsertL(TInt, const TDesC &)

IMPORT_C void	RtInsertL	(	TInt	aPos,
			const TDesC &	aBuf
		)	[protected]

Parameters

TInt aPos
const TDesC & aBuf

SetEditObserver(MEditObserver *)

IMPORT_C void

SetEditObserver

(

MEditObserver *

aEditObserver

)

Parameters

MEditObserver * aEditObserver

SetExtendedInsertCharFormatL(const TCharFormatX &, const TCharFormatXMask &, TInt)

void	SetExtendedInsertCharFormatL	(	const TCharFormatX &	aFormat,
			const TCharFormatXMask &	aMask,
			TInt	aPos
		)	[private]

Parameters

const TCharFormatX & aFormat
const TCharFormatXMask & aMask
TInt aPos

SetHasChanged(TBool)

IMPORT_C void

SetHasChanged

(

TBool

aHasChanged

)

[virtual]

Parameters

TBool aHasChanged

SetInsertCharFormatL(const TCharFormat &, const TCharFormatMask &, TInt)

IMPORT_C void	SetInsertCharFormatL	(	const TCharFormat &	aFormat,
			const TCharFormatMask &	aMask,
			TInt	aPos
		)

Parameters

const TCharFormat & aFormat
const TCharFormatMask & aMask
TInt aPos

SetParaTypeIsSingle(TBool)

void

SetParaTypeIsSingle

(

TBool

aBool

)

[private, inline]

Parameters

TBool aBool

SetPictureFactory(MPictureFactory , MRichTextStoreResolver )

IMPORT_C void	SetPictureFactory	(	MPictureFactory *	aPictureFactory,
			MRichTextStoreResolver *	aStoreResolver
		)

Parameters

MPictureFactory * aPictureFactory
MRichTextStoreResolver * aStoreResolver

SetStyleListExternallyOwned(TBool)

void

SetStyleListExternallyOwned

(

TBool

aExternallyOwned

)

[inline]

Sets whether the style list used by this rich text object is owned by the object itself, or is externally owned.

Parameters

TBool aExternallyOwned

ETrue if the style list should be marked as externally owned, EFalse if not.

SetStyleListExternallyOwned(const CStyleList &)

IMPORT_C void

SetStyleListExternallyOwned

(

const CStyleList &

aStyleList

)

Parameters

const CStyleList & aStyleList

StoreComponentsL(CStreamStore &, CStoreMap &)

IMPORT_C void	StoreComponentsL	(	CStreamStore &	aStore,
			CStoreMap &	aMap
		)	const [virtual]

Stores the text components, e.g. fields, pictures and formatting to the stream store specified. Does not store the text content.

Parameters

CStreamStore & aStore	Stream store to which the text components are written.
CStoreMap & aMap	A store map. This binds the address of text components to the stream ID of aStore. This is needed to support deferred loading of pictures in rich text.

StoreMarkupComponentsL(CStreamStore &, CStoreMap &)

IMPORT_C void	StoreMarkupComponentsL	(	CStreamStore &	aStore,
			CStoreMap &	aMap
		)	const

Parameters

CStreamStore & aStore
CStoreMap & aMap

StoreMarkupL(CStreamStore &, CStoreMap &)

void	StoreMarkupL	(	CStreamStore &	aStore,
			CStoreMap &	aMap
		)	const [protected]

Parameters

CStreamStore & aStore
CStoreMap & aMap

StoreResolver()

MRichTextStoreResolver *

StoreResolver

(

)

const [inline]

Gets the store resolver. A store resolver may be set during construction, or by calling CRichText::SetPictureFactory().

The store resolver. This determines which file store the picture is stored in.

StoreStylesL(CStreamStore &, CStoreMap &)

void	StoreStylesL	(	CStreamStore &	aStore,
			CStoreMap &	aMap
		)	const [protected]

Parameters

CStreamStore & aStore
CStoreMap & aMap

StyleCount()

TInt

StyleCount

(

)

const [inline]

Gets the number of styles contained in the rich text object's style list. Returns zero if there is no style list present.

The number of styles in the style list

StyleList()

CStyleList *

StyleList

(

)

const [inline]

Gets a pointer to the style list used by the rich text object.

The object's style list. NULL if no style list present.

StyleListExternallyOwned()

TBool

StyleListExternallyOwned

(

)

const [inline]

Tests whether the style list used by this rich text object is owned by the object itself, or is externally owned. This value is set using SetStyleListExternallyOwned().

ETrue if the rich text object's style list is externally owned. EFalse if it owns its style list, or if it does not use a style list.

StyleListPresent()

TBool

StyleListPresent

(

)

const [inline]

Tests whether the rich text object uses a style list. The style list may be owned by the object itself, or may be externally owned.

ETrue if the object uses a style list. EFalse if not

UpdateFieldL(TInt)

IMPORT_C void

UpdateFieldL

(