Symbian^3 Application Developer Library >

CFsRichText Class Reference

class CFsRichText : public CRichText

Inherits from

Public Member Functions
~CFsRichText ()
IMPORT_C TRichTextExapandArea GetExpandAreaL ( TInt )
IMPORT_C TRichTextHotSpotArea GetHotSpotAreaL ( TInt )
IMPORT_C TInt GetNumberOfExpandAreas ()
IMPORT_C TInt GetNumberOfHotSpotAreas ()
IMPORT_C TInt GetNumberOfPicture ()
IMPORT_C TRichTextPictureArea GetPictureAreaL ( TInt )
IMPORT_C CFsRichText * NewL (const CParaFormatLayer *, const CCharFormatLayer *, TDocumentStorage , TInt , TParaType )
IMPORT_C CFsRichText * NewL (const CParaFormatLayer *, const CCharFormatLayer *, const CStyleList &, TDocumentStorage , TInt , TParaType )
IMPORT_C CFsRichText * NewL (const CStreamStore &, TStreamId , const CParaFormatLayer *, const CCharFormatLayer *, MTextFieldFactory *, TDocumentStorage )
IMPORT_C CFsRichText * NewL (const CStreamStore &, TStreamId , const CParaFormatLayer *, const CCharFormatLayer *, MPictureFactory *, MRichTextStoreResolver *, MTextFieldFactory *, TDocumentStorage )
IMPORT_C void Reset ()
IMPORT_C TBool SetExpandL ( TInt , TInt , TInt )
IMPORT_C TBool SetHotSpotL ( TInt , TInt , TInt )
IMPORT_C TBool SetPictureL ( TFileName , TInt )
Private Member Functions
CFsRichText (const CParaFormatLayer *, const CCharFormatLayer *, CStyleList *)
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()
CEditableText::CancelFepInlineEdit(TBool &,TInt &,TInt &,TInt &,TInt)
CEditableText::CommitFepInlineEditL(TBool &,TInt &,TInt &,TInt &,TInt)
CEditableText::GetLengthOfInlineText()const
CEditableText::GetPositionOfInlineTextInDocument()const
CEditableText::HasChanged()const
CEditableText::OverrideFormatOfInlineTextIfApplicable(TPtrC &,TCharFormat &,TInt)const
CEditableText::RestoreL(const CStreamStore &,TStreamId)
CEditableText::StartFepInlineEditL(TBool &,TInt &,TInt &,TInt &,TInt,const TDesC &,TInt,TInt,MFepInlineTextFormatRetriever &)
CEditableText::StoreL(CStreamStore &)const
CEditableText::UpdateFepInlineTextL(TBool &,TInt &,TInt &,TInt &,TInt,const TDesC &)
CEditableText::~CEditableText()
CGlobalText::CGlobalText()
CGlobalText::CGlobalText(const CParaFormatLayer *,const CCharFormatLayer *)
CGlobalText::CancelSelectLabel()
CGlobalText::EnquirePageBreak(TInt,TInt)const
CGlobalText::GlobalCharFormatLayer()const
CGlobalText::GlobalParaFormatLayer()const
CGlobalText::LdDocumentLength()const
CGlobalText::LdToParagraphStart(TInt &)const
CGlobalText::NewL(const CParaFormatLayer *,const CCharFormatLayer *,TDocumentStorage,TInt)
CGlobalText::SelectParagraphLabel(TInt)
CGlobalText::SetGlobalCharFormat(const CCharFormatLayer *)
CGlobalText::SetGlobalParaFormat(const CParaFormatLayer *)
CGlobalText::~CGlobalText()
CPlainText::CPlainText()
CPlainText::ConstructL(TDocumentStorage,TInt)
CPlainText::ConstructL(const CStreamStore &,TStreamId,MTextFieldFactory *,TDocumentStorage)
CPlainText::ConsumeAdornmentL(RReadStream &)
CPlainText::ConvertAllFieldsToText()
CPlainText::ConvertFieldToText(TInt)
CPlainText::CopyComponentsL(CStreamStore &,CStoreMap &,TInt,TInt)const
CPlainText::Delete(TInt,TInt)
CPlainText::DoConstructL(TDocumentStorage,TInt,MTextFieldFactory *)
CPlainText::DoCopyToStoreL(CStreamStore &,CStreamDictionary &,TInt,TInt)const
CPlainText::DoExternalizeFieldDataL(RWriteStream &)const
CPlainText::DoExternalizePlainTextL(RWriteStream &)const
CPlainText::DoExtract(TDes &,TInt,TInt,TUint)const
CPlainText::DoInternalizeFieldDataL(RReadStream &)
CPlainText::DoInternalizePlainTextL(RReadStream &)
CPlainText::DoPasteFromStoreL(const CStreamStore &,TStreamId,TInt)
CPlainText::DoPtDelete(TInt,TInt)
CPlainText::DoPtInsertL(TInt,const TDesC &)
CPlainText::DocumentLength()const
CPlainText::ExportAsTextL(const TDes &,TTextOrganisation,TInt)const
CPlainText::ExportTextL(TInt,RWriteStream &,TTextOrganisation,TInt,TInt,TInt,TInt *,TInt *)const
CPlainText::ExportTextL(TInt,RWriteStream &,const TImportExportParam &,TImportExportResult &)const
CPlainText::ExternalizeFieldDataL(RWriteStream &)const
CPlainText::ExternalizePlainTextL(RWriteStream &)const
CPlainText::ExternalizePlainTextNoLengthCountL(RWriteStream &)const
CPlainText::Extract(TDes &,TInt)const
CPlainText::Extract(TDes &,TInt,TInt)const
CPlainText::ExtractSelectively(TDes &,TInt,TInt,TUint)
CPlainText::FieldCount()const
CPlainText::FieldFactory()const
CPlainText::FindFields(TFindFieldInfo &,TInt,TInt)const
CPlainText::FindFields(TInt)const
CPlainText::GetWordInfo(TInt,TInt &,TInt &,TBool,TBool)const
CPlainText::ImportTextFileL(TInt,const TDes &,TTextOrganisation)
CPlainText::ImportTextL(TInt,RReadStream &,TTextOrganisation,TInt,TInt,TInt *,TInt *)
CPlainText::ImportTextL(TInt,RReadStream &,const TImportExportParam &,TImportExportResult &)
CPlainText::InsertFieldL(TInt,CTextField *,TUid)
CPlainText::InsertL(TInt,const CPlainText *)
CPlainText::InternalizeFieldDataL(RReadStream &)
CPlainText::InternalizePlainTextL(RReadStream &)
CPlainText::InternalizePlainTextL(RReadStream &,TInt)
CPlainText::NewL(TDocumentStorage,TInt)
CPlainText::NewL(const CStreamStore &,TStreamId,MTextFieldFactory *,TDocumentStorage)
CPlainText::NewTextFieldL(TUid)const
CPlainText::PageContainingPos(TInt)const
CPlainText::PasteComponentsL(const CStreamStore &,TInt)
CPlainText::PtInsertL(TInt,const TDesC &)
CPlainText::Read(TInt)const
CPlainText::Read(TInt,TInt)const
CPlainText::RemoveField(TInt)
CPlainText::RestoreFieldComponentsL(const CStreamStore &)
CPlainText::ScanParas(TInt &,TUint &)const
CPlainText::ScanWords(TInt &,TUint &)const
CPlainText::SetFieldFactory(MTextFieldFactory *)
CPlainText::SetPageTable(TPageTable *)
CPlainText::StoreFieldComponentsL(CStreamStore &,CStoreMap &)const
CPlainText::TextField(TInt)const
CPlainText::ToParagraphStart(TInt &)const
CPlainText::UidFromStreamL(RReadStream &)
CPlainText::UpdateAllFieldsL()
CPlainText::WordCount()const
CPlainText::~CPlainText()
CRichText::ActivateDefaultParserL(MParser *)
CRichText::ActivateParserL(MParser *)
CRichText::AppendParagraphL(TInt)
CRichText::AppendTakingSolePictureOwnershipL(const CRichText &)
CRichText::ApplyCharFormatL(const TCharFormat &,const TCharFormatMask &,TInt,TInt)
CRichText::ApplyExtendedCharFormatL(const TCharFormatX &,const TCharFormatXMask &,TInt,TInt)
CRichText::ApplyParaFormatL(const CParaFormat *,const TParaFormatMask &,TInt,TInt)
CRichText::ApplyParagraphStyleL(const CParagraphStyle &,TInt,TInt,CParagraphStyle::TApplyParaStyleMode)
CRichText::CRichText(const CParaFormatLayer *,const CCharFormatLayer *,CStyleList *)
CRichText::CancelInsertCharFormat()
CRichText::CharPosOfParagraph(TInt &,TInt)const
CRichText::CompletePasteRichTextFromStoreL(const CStreamStore &,TStreamId &,TInt,CParagraphStyle::TStylePasteMode)
CRichText::ComponentInfo()const
CRichText::ConstructL(TDocumentStorage,TInt,TParaType)
CRichText::ConstructL(const CStreamStore &,TStreamId,MPictureFactory *,MRichTextStoreResolver *,MTextFieldFactory *,TDocumentStorage)
CRichText::CopyComponentsL(CStreamStore &,CStoreMap &,TInt,TInt,TStreamId)const
CRichText::CopyToStoreL(CStreamStore &,CStreamDictionary &,TInt,TInt)const
CRichText::CopyToStreamL(RWriteStream &,TInt,TInt)const
CRichText::CopyToStreamL(RWriteStream &,TInt,TInt,TStreamId)const
CRichText::CopyToStreamL(RWriteStream &,TInt,TInt,TStreamId,TBool)const
CRichText::CursorOverTag(TInt,MParser *&,TInt &,TInt &)const
CRichText::DeactivateParser(MParser *)
CRichText::DeactivateParserDefaults()
CRichText::DelSetInsertCharFormatL(TInt,TInt)
CRichText::DeleteFromParagraph(TInt,TInt)
CRichText::DeleteL(TInt,TInt)
CRichText::DeleteParagraph(TInt,TInt)
CRichText::DetachFromStoreL(CPicture::TDetach)
CRichText::DetachFromStoreL(CPicture::TDetach,TInt,TInt)
CRichText::DoAppendTakingSolePictureOwnershipL(const CRichText &)
CRichText::DoCopyToStoreL(CStreamStore &,TInt,TInt,TStreamId,TBool)const
CRichText::DoExternalizeMarkupDataL(RWriteStream &)const
CRichText::DoExternalizeStyleDataL(RWriteStream &)const
CRichText::DoInternalizeMarkupDataL(RReadStream &)
CRichText::DoInternalizeStyleDataL(RReadStream &)
CRichText::DoInternalizeStyleDataL(RReadStream &,const CStyleList *)
CRichText::DropPictureOwnership(TInt)
CRichText::ExtendedInterface(TAny *&,TUid)
CRichText::ExternalizeL(RWriteStream &)const
CRichText::ExternalizeMarkupDataL(RWriteStream &)const
CRichText::ExternalizeStyleDataL(RWriteStream &)const
CRichText::GetCharFormat(TCharFormat &,TCharFormatMask &,TInt,TInt)const
CRichText::GetChars(TPtrC &,TCharFormat &,TInt)const
CRichText::GetExtendedCharFormat(TCharFormatX &,TCharFormatXMask &,TInt,TInt)const
CRichText::GetParaFormatL(CParaFormat *,TParaFormatMask &,TInt,TInt,CParaFormat::TParaFormatGetMode)const
CRichText::GetParagraphFormatL(CParaFormat *,TInt)const
CRichText::GetPictureSizeInTwips(TSize &,TInt)const
CRichText::GetSpecificCharFormat(TCharFormat &,TCharFormatMask &,TInt)const
CRichText::GetSpecificCharFormatRight(TCharFormat &,TCharFormatMask &,TInt)const
CRichText::GetSpecificParagraphFormatL(CParaFormat *,TParaFormatMask &,TInt)const
CRichText::GetTextAndExtendedFormat(TPtrC &,TCharFormatX &,TInt)const
CRichText::HasMarkupData()const
CRichText::InsertL(TInt,const TChar &)
CRichText::InsertL(TInt,const TDesC &)
CRichText::InsertL(TInt,const TPictureHeader &)
CRichText::InternalizeL(RReadStream &)
CRichText::InternalizeL(RReadStream &,const CStyleList *)
CRichText::InternalizeMarkupDataL(RReadStream &)
CRichText::InternalizeStyleDataL(RReadStream &)
CRichText::NotifyStyleChangedL(const CParagraphStyle *,const CParagraphStyle *)
CRichText::NotifyStyleDeletedL(const CParagraphStyle *)
CRichText::ParagraphCount()const
CRichText::ParagraphNumberForPos(TInt &)const
CRichText::ParagraphStyle(TBool &,TInt,TInt)const
CRichText::ParseText(TInt &,TInt &,TBool)
CRichText::PasteFromStoreL(const CStreamStore &,const CStreamDictionary &,TInt)
CRichText::PasteFromStoreL(const CStreamStore &,const CStreamDictionary &,TInt,CParagraphStyle::TStylePasteMode)
CRichText::PastePlainTextFromStoreL(const CStreamStore &,TStreamId &,TInt)
CRichText::PasteRichTextFromStoreL(const CStreamStore &,const CStreamDictionary &,TStreamId &,TInt,CParagraphStyle::TStylePasteMode)
CRichText::PictureCount()const
CRichText::PictureFactory()const
CRichText::PictureHandleL(TInt,MLayDoc::TForcePictureLoad)const
CRichText::PictureHeader(TInt)const
CRichText::PositionOfNextTag(TInt)const
CRichText::PositionOfNextTag(TInt,const MParser *)const
CRichText::PositionOfPrevTag(TInt)const
CRichText::PositionOfPrevTag(TInt,const MParser *)const
CRichText::PrepareAppendMarkupL(const CRichText &)
CRichText::RemoveSpecificCharFormatL(TInt,TInt)
CRichText::RemoveSpecificParaFormatL(TInt,TInt)
CRichText::RestoreComponentsL(const CStreamStore &)
CRichText::RestoreStylesL(const CStreamStore &,TStreamId,const CParaFormatLayer *,const CCharFormatLayer *)
CRichText::RestoreWithStyleListL(const CStreamStore &,TStreamId,const CStyleList &)
CRichText::RtInsertL(TInt,const TDesC &)
CRichText::SetEditObserver(MEditObserver *)
CRichText::SetHasChanged(TBool)
CRichText::SetInsertCharFormatL(const TCharFormat &,const TCharFormatMask &,TInt)
CRichText::SetPictureFactory(MPictureFactory *,MRichTextStoreResolver *)
CRichText::SetStyleListExternallyOwned(TBool)
CRichText::SetStyleListExternallyOwned(const CStyleList &)
CRichText::StoreComponentsL(CStreamStore &,CStoreMap &)const
CRichText::StoreMarkupComponentsL(CStreamStore &,CStoreMap &)const
CRichText::StoreMarkupL(CStreamStore &,CStoreMap &)const
CRichText::StoreResolver()const
CRichText::StoreStylesL(CStreamStore &,CStoreMap &)const
CRichText::StyleCount()const
CRichText::StyleList()const
CRichText::StyleListExternallyOwned()const
CRichText::StyleListPresent()const
CRichText::UpdateFieldL(TInt)
CRichText::~CRichText()
Inherited Enumerations
CEditableText:@89
CEditableText:@90
CEditableText:TDocumentStorage
CPlainText:@91
CPlainText:@92
CPlainText:@93
CPlainText:TScanDataEnd
CPlainText:TTextOrganisation
CPlainText:TUnitOfText
CRichText:@117
CRichText:TParaType
Private Attributes
RArray < TRichTextExapandArea > iExpandAreaArray
RArray < TRichTextHotSpotArea > iHotSpotAreaArray
RArray < TRichTextPictureArea > iPictureAreaArray
Inherited Attributes
CEditableText::iHasChanged
CGlobalText::iGlobalCharFormatLayer
CGlobalText::iGlobalParaFormatLayer
CPlainText::iByteStore
CPlainText::iFieldFactory
CPlainText::iFieldSet
CPlainText::iPageTable

Constructor & Destructor Documentation

CFsRichText(const CParaFormatLayer *, const CCharFormatLayer *, CStyleList *)

CFsRichText ( const CParaFormatLayer * aGlobalParaLayer,
const CCharFormatLayer * aGlobalCharLayer,
CStyleList * aStyleList = NULL
) [private]

Parameters

const CParaFormatLayer * aGlobalParaLayer
const CCharFormatLayer * aGlobalCharLayer
CStyleList * aStyleList = NULL

~CFsRichText()

IMPORT_C ~CFsRichText ( )

Member Functions Documentation

GetExpandAreaL(TInt)

IMPORT_C TRichTextExapandArea GetExpandAreaL ( TInt aIndex )

Parameters

TInt aIndex

GetHotSpotAreaL(TInt)

IMPORT_C TRichTextHotSpotArea GetHotSpotAreaL ( TInt aIndex )

Parameters

TInt aIndex

GetNumberOfExpandAreas()

IMPORT_C TInt GetNumberOfExpandAreas ( )

GetNumberOfHotSpotAreas()

IMPORT_C TInt GetNumberOfHotSpotAreas ( )

GetNumberOfPicture()

IMPORT_C TInt GetNumberOfPicture ( )

GetPictureAreaL(TInt)

IMPORT_C TRichTextPictureArea GetPictureAreaL ( TInt aIndex )

Parameters

TInt aIndex

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

IMPORT_C CFsRichText * 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 CFsRichText * 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 CFsRichText * 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 CFsRichText * 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

Reset()

IMPORT_C void Reset ( ) [virtual]

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

SetExpandL(TInt, TInt, TInt)

IMPORT_C TBool SetExpandL ( TInt aStartIndex,
TInt aLength,
TInt aCaptionLength
)

Parameters

TInt aStartIndex
TInt aLength
TInt aCaptionLength

SetHotSpotL(TInt, TInt, TInt)

IMPORT_C TBool SetHotSpotL ( TInt aStartIndex,
TInt aLength,
TInt aId = 0
)

Parameters

TInt aStartIndex
TInt aLength
TInt aId = 0

SetPictureL(TFileName, TInt)

IMPORT_C TBool SetPictureL ( TFileName aFileName,
TInt aIndex
)

Parameters

TFileName aFileName
TInt aIndex

Member Data Documentation

RArray< TRichTextExapandArea > iExpandAreaArray

RArray < TRichTextExapandArea > iExpandAreaArray [private]

RArray< TRichTextHotSpotArea > iHotSpotAreaArray

RArray < TRichTextHotSpotArea > iHotSpotAreaArray [private]

RArray< TRichTextPictureArea > iPictureAreaArray

RArray < TRichTextPictureArea > iPictureAreaArray [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.