CEikRichTextEditor Class Reference

class CEikRichTextEditor : public CEikGlobalTextEditor

Rich text editor.

This is an edit window that supports rich text, including embedded objects represented either by icons or glass doors.

Since
Symbian 5.0
Public Member Functions
CEikRichTextEditor()
CEikRichTextEditor(const TGulBorder &)
~CEikRichTextEditor()
IMPORT_C voidActivateL()
IMPORT_C TBoolCheckForObjectL()
IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C voidConstructL(const CCoeControl *, TInt, TInt, TInt, TInt, TInt)
IMPORT_C voidCopyDocumentContentL(CGlobalText &, CGlobalText &)
IMPORT_C const TSize &DefaultIconicDoorSize()
IMPORT_C voidEditPictureFormatL()
IMPORT_C voidGetEmbeddedAppL(CApaDoor *&, CApaDocument *&, TInt)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidInsertObjectL(TObjectFormat)
IMPORT_C voidInsertObjectL()
IMPORT_C voidInsertObjectL(const TDesC &, TUid, TObjectFormat)
IMPORT_C voidInsertObjectL(TUid, CBase *)
IMPORT_C TIntObjectCursorPos()
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidPictureFormatChangedL()
IMPORT_C voidReEditObjectL()
IMPORT_C voidRefreshParsersL()
IMPORT_C CRichText *RichText()
IMPORT_C voidSetDefaultIconicDoorSize(const TSize &)
IMPORT_C voidSetParserObserver(MEikRichTextEditorParserObserver *)
IMPORT_C voidSetPhoneNumberGrouping(TBool)
IMPORT_C voidUpdatePictureFormatL()
IMPORT_C voidUpdatePictureFormatL(TInt, TInt)
IMPORT_C voidUpdatePictureSizeL()
IMPORT_C voidUpdatePictureSizeL(TInt, TInt)
Protected Member Functions
IMPORT_C voidEditObserver(TInt, TInt)
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
voidCommonConstructL()
TInt DeleteEmbeddedDoc(TAny *)
voidDoInsertPictureL(TBool &, const TPictureHeader &)
voidDoReEditObjectL(TInt)
voidDoReportEdwinEventL(MEikEdwinObserver::TEdwinEvent)
IMPORT_C voidDraw(const TRect &)
IMPORT_C void *ExtensionInterface(TUid)
IMPORT_C voidHandleTextPastedL(TInt, TInt &)
TInt InsertEmbeddedDocL(TAny *)
voidInsertObjectL(CApaDocument *, TObjectFormat)
voidInsertPictureL(const TPictureHeader &)
IMPORT_C voidNewPictureL(TPictureHeader &, const CStreamStore &)
IMPORT_C voidNotifyExit(TExitMode)
IMPORT_C voidReserved_2()
IMPORT_C voidReserved_3()
voidRoomForObjectL()
voidSetTextObserver(CRichText &)
IMPORT_C const CStreamStore &StreamStoreL(TInt)
TInt TryDeleteEmbeddedDocL(TAny *)
TInt UpdateEmbeddedDocL(TAny *)
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikEdwin::AddEdwinObserverL(MEikEdwinObserver *)
CEikEdwin::AddFlagToUserFlags(TUint32)
CEikEdwin::AdjustCursorForSmileyL(TInt,TCursorSelection &)
CEikEdwin::AdjustDrawRectForSmiley(const TRect &)const
CEikEdwin::AknEditorCurrentInputMode()
CEikEdwin::AknEditorFlags()
CEikEdwin::AknEdwinFlags()const
CEikEdwin::AvgCharsPerLine()const
CEikEdwin::AvgLinesInViewRect()const
CEikEdwin::CEikEdwin()
CEikEdwin::CEikEdwin(const TGulBorder &)
CEikEdwin::CalculateWidth(TInt)
CEikEdwin::CanUndo()const
CEikEdwin::CancelFepTransaction()
CEikEdwin::CancelInsertCharFormat()
CEikEdwin::CancelSelectionL(TEnd)
CEikEdwin::CcpuCanCopy()const
CEikEdwin::CcpuCanCut()const
CEikEdwin::CcpuCanPaste()const
CEikEdwin::CcpuCanUndo()const
CEikEdwin::CcpuCopyL()
CEikEdwin::CcpuCutL()
CEikEdwin::CcpuIsFocused()const
CEikEdwin::CcpuPasteL()
CEikEdwin::CcpuUndoL()
CEikEdwin::CheckEdwinExtensionL()
CEikEdwin::CheckNotReadOnlyL()
CEikEdwin::CheckRemovePictures(TInt,TInt)
CEikEdwin::CheckValidityOfChars(TInt,TInt)
CEikEdwin::ClearSelectionL()
CEikEdwin::ClearUndo()
CEikEdwin::ClipboardL(TClipboardFunc)
CEikEdwin::ConstructL(TInt,TInt,TInt,TInt)
CEikEdwin::ContentFitsToViewRect()const
CEikEdwin::ConvertSmileyIconToTextL(TInt,TDes &)
CEikEdwin::ConvertVisibleTextForSmileyL(TBool)
CEikEdwin::CopyToStoreL(CStreamStore &,CStreamDictionary &)
CEikEdwin::CountWords()
CEikEdwin::CreateCustomDrawL()
CEikEdwin::CreateLayoutL(MLayDoc *)
CEikEdwin::CreatePreAllocatedScrollBarFrameL()
CEikEdwin::CreateScrollBarFrameL()
CEikEdwin::CreateTextAndLayoutL(CParaFormatLayer *,CCharFormatLayer *)
CEikEdwin::CreateTextViewL()
CEikEdwin::CursorPos()const
CEikEdwin::DeleteHighlightL(TBool &,TBool,TBool)
CEikEdwin::DeleteL(TBool &,const TCursorSelection &,TBool,TBool)
CEikEdwin::DisplayFindTextNotFound(TDes &)
CEikEdwin::DrawContents()
CEikEdwin::DrawSmileyInTextL(RRegion &,const TRect &,CBitmapContext &,CFont &,const TDesC &,const TPoint &)
CEikEdwin::DrawTextView()const
CEikEdwin::DrawViewBackground(TBool)const
CEikEdwin::EditorBackgroundColor(TRgb &)const
CEikEdwin::EditorState()const
CEikEdwin::EdwinExtension()
CEikEdwin::EnableCcpuSupportL(TBool)
CEikEdwin::EnableKineticScrollingL(CAknPhysics *)
CEikEdwin::EnableKineticScrollingL(TBool)
CEikEdwin::EnableSmileySupportL(TBool)
CEikEdwin::ExtractTextLC(TCursorSelection)
CEikEdwin::FindL(const TDesC *,TInt)
CEikEdwin::FindTextL(const TDesC *,TInt,TInt)
CEikEdwin::FocusChanged(TDrawNow)
CEikEdwin::ForceScrollBarUpdateL()
CEikEdwin::FormatTextL()
CEikEdwin::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CEikEdwin::GetFindText(TDes *)
CEikEdwin::GetText(TDes &)const
CEikEdwin::GetTextInHBufL()const
CEikEdwin::GetTextLinesRect()const
CEikEdwin::GetWordInfo(TInt,TInt &,TInt &)const
CEikEdwin::HandleResourceChange(TInt)
CEikEdwin::HandleScrollEventL(CEikScrollBar *,TEikScrollEvent)
CEikEdwin::HandleScrollEventWithPhysics(CEikScrollBar *)
CEikEdwin::HandleSizeChangedL()
CEikEdwin::HandleTextChangedL()
CEikEdwin::HighlightStyle()const
CEikEdwin::IdleL(TAny *)
CEikEdwin::InputCapabilities()const
CEikEdwin::InsertDeleteCharsL(TInt,const TDesC &,const TCursorSelection &)
CEikEdwin::InsertFieldL(CTextField *,TUid)
CEikEdwin::InsertFromTextFileL(const TFileName &,const CPlainText::TTextOrganisation)
CEikEdwin::IsBackgroundDrawingSuppressed()const
CEikEdwin::IsReadOnly()const
CEikEdwin::IsSmileyEnabled()const
CEikEdwin::KineticScrollingEnabled()const
CEikEdwin::LayoutWidth()const
CEikEdwin::LowerPartialFormattingLength()const
CEikEdwin::Margins()const
CEikEdwin::MaxLength()const
CEikEdwin::MaximumHeight()const
CEikEdwin::MaximumHeightInLines()const
CEikEdwin::MinimumHeight()const
CEikEdwin::MinimumSize()
CEikEdwin::MopSupplyObject(TTypeUid)
CEikEdwin::MoveCursorL(TCursorPosition::TMovementType,TBool)
CEikEdwin::MoveCursorToChunkStartL(TBool,TChunkSize,TEnd)
CEikEdwin::MoveDisplayL(TCursorPosition::TMovementType)
CEikEdwin::NonPrintingCharsVisibility()const
CEikEdwin::NotifyEditorStateObserverOfStateChangeL()
CEikEdwin::NotifyNewDocumentL()
CEikEdwin::NotifyNewFormatL()
CEikEdwin::OkToDeleteSelectionL()
CEikEdwin::OnEditorStateFlagChange(TInt,TInt)
CEikEdwin::OnReformatL(const CTextView *)
CEikEdwin::OnlyASCIIChars()const
CEikEdwin::PasteFromStoreL(CStreamStore &,CStreamDictionary &)
CEikEdwin::PictographAnimationCallBack()const
CEikEdwin::PixelsOutOfBorder()const
CEikEdwin::PlaceDataOnClipboardL()
CEikEdwin::ReadAknResourceL(TResourceReader &)
CEikEdwin::ReceiveDataOverIrL()
CEikEdwin::RemoveEdwinObserver(MEikEdwinObserver *)
CEikEdwin::RemoveFlagFromUserFlags(TUint32)
CEikEdwin::ReplaceAllL(SEdwinFindModel *)
CEikEdwin::ReplaceL(SEdwinFindModel *)
CEikEdwin::ReportChinesePopupEventL(TBool)
CEikEdwin::ReportEdwinEventL(MEikEdwinObserver::TEdwinEvent)
CEikEdwin::RestoreCursorState()
CEikEdwin::RunCharMapDialogL()
CEikEdwin::ScrollBarFrame()
CEikEdwin::ScrollView(TInt,TBool &,TInt &)
CEikEdwin::ScrollViewWithBounce(TInt,TBool &,TInt &)
CEikEdwin::SelectAllL()
CEikEdwin::Selection()const
CEikEdwin::SelectionLength()const
CEikEdwin::SendDataOverIrL()
CEikEdwin::SetAknEditorAllowedInputModes(TInt)
CEikEdwin::SetAknEditorCase(TInt)
CEikEdwin::SetAknEditorCurrentCase(TInt)
CEikEdwin::SetAknEditorCurrentInputMode(TInt)
CEikEdwin::SetAknEditorFlags(TInt)
CEikEdwin::SetAknEditorInputMode(TInt)
CEikEdwin::SetAknEditorLocalLanguage(TLanguage)
CEikEdwin::SetAknEditorNumericKeymap(TAknEditorNumericKeymap)
CEikEdwin::SetAknEditorPermittedCaseModes(TInt)
CEikEdwin::SetAknEditorSpecialCharacterTable(TInt)
CEikEdwin::SetAlignment(TInt)
CEikEdwin::SetAllowPictures(TBool)
CEikEdwin::SetAllowUndo(TBool)
CEikEdwin::SetAmountToFormatL(TBool)
CEikEdwin::SetAmountToFormatL(TBool,TBool)
CEikEdwin::SetAvgCharsPerLine(TInt)
CEikEdwin::SetAvgLinesInViewRect(TInt)
CEikEdwin::SetAvkonWrap(TBool)
CEikEdwin::SetBackgroundColorL(TRgb)
CEikEdwin::SetBorderViewMargins(TMargins8)
CEikEdwin::SetCharFormatLayer(CCharFormatLayer *)
CEikEdwin::SetContainerWindowL()
CEikEdwin::SetContainerWindowL(const CCoeControl &)
CEikEdwin::SetCursorPosL(TInt,TBool)
CEikEdwin::SetCursorVisible(TBool)
CEikEdwin::SetDimmed(TBool)
CEikEdwin::SetDocumentContentL(CGlobalText &,TSetContent)
CEikEdwin::SetDocumentOwnership(TOwnershipType)
CEikEdwin::SetEdwinObserver(MEikEdwinObserver *)
CEikEdwin::SetEdwinSizeObserver(MEikEdwinSizeObserver *)
CEikEdwin::SetHighlightStyleL(TAknsHighlightStyle)
CEikEdwin::SetInputCapabilitiesL(const TCoeInputCapabilities &)
CEikEdwin::SetLineCursorDetailsL()
CEikEdwin::SetMaxLength(TInt)
CEikEdwin::SetMaximumHeight(TInt)
CEikEdwin::SetMaximumHeightInLines(TInt)
CEikEdwin::SetMinimumHeight(TInt)
CEikEdwin::SetNonPrintingCharsVisibility(TNonPrintingCharVisibility)
CEikEdwin::SetOnlyASCIIChars(TBool)
CEikEdwin::SetParaFormatLayer(CParaFormatLayer *)
CEikEdwin::SetPasteFromIrStore(TBool)
CEikEdwin::SetPictographAnimationCallBack(TCallBack &)
CEikEdwin::SetReadOnly(TBool)
CEikEdwin::SetRightWrapGutter(TInt)
CEikEdwin::SetScrollRect(const TRect &)
CEikEdwin::SetSelectionL(TInt,TInt)
CEikEdwin::SetSkinBackgroundControlContextL(MAknsControlContext *)
CEikEdwin::SetSuppressBackgroundDrawing(TBool)
CEikEdwin::SetSuppressFormatting(TBool)
CEikEdwin::SetSuppressNotifyDraw(TBool)
CEikEdwin::SetTextL(const TDesC *)
CEikEdwin::SetTextLimit(TInt)
CEikEdwin::SetTextLinesRect(const TRect &)
CEikEdwin::SetTextSkinColorIdL(TInt)
CEikEdwin::SetUndoBufferL(const TCursorSelection &)
CEikEdwin::SetUndoableText(const TCursorSelection &)
CEikEdwin::SetUpperFullFormattingLength(TInt)
CEikEdwin::SetWordDelimiters(TBool,TBool)
CEikEdwin::SetWordWrapL(TBool)
CEikEdwin::SetWysiwygModeOff()
CEikEdwin::SetWysiwygModeOn(TInt,MGraphicsDeviceMap *)
CEikEdwin::SetZoomFactorL(TZoomFactor *)
CEikEdwin::SkinBackgroundControlContext()const
CEikEdwin::SkinColorId()const
CEikEdwin::SkinEnabled()const
CEikEdwin::SkipBackgroundDrawer()const
CEikEdwin::StoreCursorState()
CEikEdwin::SupportsUndo()const
CEikEdwin::Text()const
CEikEdwin::TextLayout()const
CEikEdwin::TextLength()const
CEikEdwin::TextView()const
CEikEdwin::TrappedDraw(const TRect &)const
CEikEdwin::TrappedSizeChanged()
CEikEdwin::UndoL()
CEikEdwin::UpdateAllFieldsL()
CEikEdwin::UpdateCurrentFieldL()
CEikEdwin::UpdateLayoutWidth(TInt)
CEikEdwin::UpdateScrollBarsL()
CEikEdwin::UpperFullFormattingLength()const
CEikEdwin::UserFlags()const
CEikEdwin::~CEikEdwin()
CEikGlobalTextEditor::ApplyCharFormatL(TCharFormat &,TCharFormatMask &)
CEikGlobalTextEditor::ApplyParaFormatL(CParaFormat *,TParaFormatMask &)
CEikGlobalTextEditor::BaseConstructL()
CEikGlobalTextEditor::BoldItalicUnderlineEventL(TInt)
CEikGlobalTextEditor::CEikGlobalTextEditor()
CEikGlobalTextEditor::CEikGlobalTextEditor(const TGulBorder &)
CEikGlobalTextEditor::DoFindL()
CEikGlobalTextEditor::GlobalText()const
CEikGlobalTextEditor::InitFindL(SEdwinFindModel *&,CDesCArray *&,CDesCArray *&)
CEikGlobalTextEditor::LineCursorWidth()const
CEikGlobalTextEditor::RunFindAgainDialogL()
CEikGlobalTextEditor::RunFindDialogL()
CEikGlobalTextEditor::RunFontDialogL(TInt,CGraphicsDevice *,TInt)
CEikGlobalTextEditor::RunIndentsDialogL(TInt)
CEikGlobalTextEditor::RunPaginateDialogL(CPrintSetup *,CArrayFix< TInt > *)
CEikGlobalTextEditor::RunParaDialogsL(TInt)
CEikGlobalTextEditor::RunReplaceDialogL()
CEikGlobalTextEditor::RunTabsDialogL(TInt)
CEikGlobalTextEditor::SetButtonGroup(CCoeControl *)
CEikGlobalTextEditor::SetGraphicsDevice(CGraphicsDevice *)
CEikGlobalTextEditor::SetLineCursorBitmapL(CFbsBitmap *)
CEikGlobalTextEditor::UpdateButtonGroup()
CEikGlobalTextEditor::~CEikGlobalTextEditor()
Public Member Enumerations
enumanonymous { EShowAllPicturesAsIconic = 0x00100000, ENoTextParsers = 0x00200000, EPasteAsPlainText = 0x00400000 }
enumTObjectFormat { EAlwaysIconic, EGlassIfPossible }
Protected Member Enumerations
enumanonymous { ECropFromLeft = 0x00010000, ECropFromRight = 0x00020000, ECropFromTop = 0x00040000, ECropFromBottom = 0x00080000, EReEditingObject = 0x00100000 }
Inherited Enumerations
CCoeControl:TZoomType
CEikEdwin:TChunkSize
CEikEdwin:TClipboardFunc
CEikEdwin:TEdwinHotKeys
CEikEdwin:TEikEdwinFlags
CEikEdwin:TEnd
CEikEdwin:TFindFlags
CEikEdwin:TFlags
CEikEdwin:TOwnershipType
CEikEdwin:TSetContent
CEikGlobalTextEditor:TFontStyleFlags
Protected Attributes
TSize iDefaultIconicDoorSize
Private Attributes
CBufStore *iBufStore
TPictureHeader iEmbeddedDoc
CIdle *iEmbeddedDocUpdate
CEikParserManager *iParserManager
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder
CEikEdwin::iEdwinInternalFlags
CEikEdwin::iEdwinUserFlags
CEikEdwin::iLastPointerDocPos
CEikEdwin::iLayout
CEikEdwin::iMargins
CEikEdwin::iNumberOfLines
CEikEdwin::iText
CEikEdwin::iTextLimit
CEikEdwin::iTextView
CEikEdwin::iZoomFactor
CEikGlobalTextEditor::iCharFormatLayer
CEikGlobalTextEditor::iParaFormatLayer

Constructor & Destructor Documentation

CEikRichTextEditor()

IMPORT_CCEikRichTextEditor()

C++ default constructor.

CEikRichTextEditor(const TGulBorder &)

IMPORT_CCEikRichTextEditor(const TGulBorder &aBorder)

C++ constructor.

Parameters

const TGulBorder & aBorderBorder for the rich text editor.

~CEikRichTextEditor()

IMPORT_C~CEikRichTextEditor()

Destructor.

Member Functions Documentation

ActivateL()

IMPORT_C voidActivateL()[virtual]

From CCoeControl.

Activates the editor so that it is ready for use.

For instance, the text view is created, the editor is set to observe its rich text object, the editor's parser manager is set up, which handles the changes that occur when the cursor is moved over tagged text (for instance a URL), and all embedded objects are set to be displayed as icons, of the default size.

CheckForObjectL()

IMPORT_C TBoolCheckForObjectL()

Tests whether there is an embedded object at the cursor position.

If there is one, it is opened for editing (or for viewing if the editor is read-only).

CommonConstructL()

voidCommonConstructL()[private]

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

From CCoeControl.

Completes the construction of the rich text editor from a resource file.

The editor's paragraph and character formatting are set to default values, unless the CEikEdwin::EUserSuppliedText flag is specified in the resource.

Parameters

TResourceReader & aReaderA resource reader positioned for reading from an RTXTED resource.

ConstructL(const CCoeControl *, TInt, TInt, TInt, TInt, TInt)

IMPORT_C voidConstructL(const CCoeControl *aParent,
TIntaNumberOfLines,
TIntaTextLimit,
TIntaEdwinFlags,
TIntaFontControlFlags = EGulFontControlAll,
TIntaFontNameFlags = EGulNoSymbolFonts
)

By default Symbian 2nd phase constructor is private.

Completes construction of the rich text editor.

The editor's paragraph and character formatting are set to default values, unless the CEikEdwin::EUserSuppliedText flag is specified in aEdwinFlags.

Parameters

const CCoeControl * aParentIf not NULL, the editor's parent control. If NULL, the editor has no parent.
TInt aNumberOfLinesThe number of lines visible in the editor. This controls the editor's height.
TInt aTextLimitThe maximum number of characters that can be entered into the editor.
TInt aEdwinFlagsEdit window attribute flags. See CEikEdwin::TFlags().
TInt aFontControlFlags = EGulFontControlAll= EGulFontControlAll Flags that specify which font-related controls should not appear in font dialogs launched from the edit window. For instance EGulFontControlBold removes the bold checkbox control. The default shows all. For possible values, see gulftflg.hrh.
TInt aFontNameFlags = EGulNoSymbolFonts= EGulNoSymbolFonts The font flags. These control whether symbol and monospace fonts should be displayed in font dialogs launched from the edit window. For possible values, see gulftflg.hrh.

CopyDocumentContentL(CGlobalText &, CGlobalText &)

IMPORT_C voidCopyDocumentContentL(CGlobalText &aInText,
CGlobalText &aOutText
)[virtual]

From CEikEdwin.

Copies the contents of one text object into another.

panic
26 In debug mode, if either aInText or aOutText is NULL.

Parameters

CGlobalText & aInTextThe rich text object to copy.
CGlobalText & aOutTextOn return, contains a copy of aInText.

DefaultIconicDoorSize()

IMPORT_C const TSize &DefaultIconicDoorSize()const

Gets the size of iconic doors.

DeleteEmbeddedDoc(TAny *)

TInt DeleteEmbeddedDoc(TAny *aThis)[private, static]

Parameters

TAny * aThis

DoInsertPictureL(TBool &, const TPictureHeader &)

voidDoInsertPictureL(TBool &aFormatHasChanged,
const TPictureHeader &aPictureHeader
)[private]

Parameters

TBool & aFormatHasChanged
const TPictureHeader & aPictureHeader

DoReEditObjectL(TInt)

voidDoReEditObjectL(TIntaDocPos)[private]

Parameters

TInt aDocPos

DoReportEdwinEventL(MEikEdwinObserver::TEdwinEvent)

voidDoReportEdwinEventL(MEikEdwinObserver::TEdwinEventaEventType)[private, inline]

Parameters

MEikEdwinObserver::TEdwinEvent aEventType

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [private, virtual]

From CCoeControl.

Draws the control on request.

Parameters

const TRect & aRectIf supplied, the rectangle in which to draw the Edwin.

EditObserver(TInt, TInt)

IMPORT_C voidEditObserver(TIntaStartEdit,
TIntaEditLength
)[protected]

From MEditObserver.

This member is internal an not meant to be used.

Parameters

TInt aStartEditStart position for editing.
TInt aEditLengthThe length of the edited object.

EditPictureFormatL()

IMPORT_C voidEditPictureFormatL()

Launches a format object dialog (CEikFormatObjectDialog) if there is an embedded object at the cursor position, and the object supports being displayed as a glass door.

If the object does not support being displayed as a glass door, an object information dialog (CEikObjectInfoDialog) is launched instead.

If the embedded object's associated application cannot be found, an info message is displayed and the function leaves.

The function has no effect if there is no embedded object at the cursor position.

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

From CAknControl.

Parameters

TUid aInterface

GetEmbeddedAppL(CApaDoor *&, CApaDocument *&, TInt)

IMPORT_C voidGetEmbeddedAppL(CApaDoor *&aDoor,
CApaDocument *&aDoc,
TIntaDocPos
)

Gets a pointer to the embedded object located at the specified position.

If the object is not in memory, the function loads it.

If the object's associated application cannot be found, an info message is displayed and the function leaves.

Parameters

CApaDoor *& aDoorOn return, the embedded document's wrapper object (icon or glass door).
CApaDocument *& aDocOn return, the embedded document.
TInt aDocPosThe document position in the editor at which the embedded object is located.

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl.

Handles pointer events inside the editor.

Has no effect if the CEikEdwin::EDisplayOnly attribute flag was specified on construction.

Parameters

const TPointerEvent & aPointerEventThe pointer event to be handled.

HandleTextPastedL(TInt, TInt &)

IMPORT_C voidHandleTextPastedL(TIntaStartPos,
TInt &aLength
)[private, virtual]

Not implemented.

Parameters

TInt aStartPosNot used.
TInt & aLengthNot used.

InsertEmbeddedDocL(TAny *)

TInt InsertEmbeddedDocL(TAny *aThis)[private, static]

Parameters

TAny * aThis

InsertObjectL(TObjectFormat)

IMPORT_C voidInsertObjectL(TObjectFormataFormat)

Launches an insert object dialog (CEikInsertObjectDialog), and inserts a default document of the application type selected by the user.

The object can be displayed either as a glass door, if supported, or as an icon, and the inserted object is opened for editing.

Displays an info message and leaves if the editor's text limit has been reached.

Parameters

TObjectFormat aFormatSpecifies whether the embedded document should be displayed as an icon or as a glass door.

InsertObjectL()

IMPORT_C voidInsertObjectL()

Launches an insert object dialog (CEikInsertObjectDialog), and inserts a default document of the application type selected by the user.

The object is displayed as a glass door rather than as an icon, if supported and the inserted object is opened for editing.

Displays an info message and leaves if the editor's text limit has been reached.

Default is EGlassIfPossible.

InsertObjectL(const TDesC &, TUid, TObjectFormat)

IMPORT_C voidInsertObjectL(const TDesC &aAppDllName,
TUidaAppDllUid,
TObjectFormataFormat
)

Creates and inserts a default document of the specified application type.

CApaProcess::AddNewDocumentL() is used to create the document.

The object can be displayed either as a glass door, if supported, or as an icon, and the inserted object is opened for editing.

Displays an info message and leaves if no suitable application DLL can be found, or if the editor's text limit has been reached.

Since
Symbian 7.0

Parameters

const TDesC & aAppDllNameFilename of the application DLL.
TUid aAppDllUidUID of the application. The default is KNullUid.
TObjectFormat aFormatSpecifies whether the embedded document should be displayed as an icon or as a glass door.

InsertObjectL(TUid, CBase *)

IMPORT_C voidInsertObjectL(TUidaPictureType,
CBase *aData
)

Creates and inserts a new embedded object of the specified type.

First, an attempt is made to find an extended picture factory that supports the insertion of pictures of the specified type. If one is not found, the function leaves; if one is found, the picture is inserted at the cursor position.

Displays an info message and leaves if the editor's text limit has been reached.

Since
Symbian 6.1
leave
KErrNotSupported No picture factory which supports the specified type is available in the control's Uikon environment.

Parameters

TUid aPictureTypeThe picture type.
CBase * aDataThe base address of the data.

InsertObjectL(CApaDocument *, TObjectFormat)

voidInsertObjectL(CApaDocument *aDoc,
TObjectFormataFormat
)[private]

Parameters

CApaDocument * aDoc
TObjectFormat aFormat

InsertPictureL(const TPictureHeader &)

voidInsertPictureL(const TPictureHeader &aPictureHeader)[private]

Parameters

const TPictureHeader & aPictureHeader

NewPictureL(TPictureHeader &, const CStreamStore &)

IMPORT_C voidNewPictureL(TPictureHeader &aHdr,
const CStreamStore &aDeferredPictureStore
)const [private]

Parameters

TPictureHeader & aHdr
const CStreamStore & aDeferredPictureStore

NotifyExit(TExitMode)

IMPORT_C voidNotifyExit(TExitModeaMode)[private]

Parameters

TExitMode aMode

ObjectCursorPos()

IMPORT_C TIntObjectCursorPos()const

Gets the document position and checks whether there is an embedded object at the cursor position.

If there is no embedded object at the cursor position, or if there is a selection, an info message is displayed.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

From CCoeControl.

Handles key events.

Has no effect (apart from returning EKeyWasConsumed) if the CEikEdwin::EDisplayOnly attribute flag was specified on construction.

Handles rich text-specific hot keys, for instance to insert an object; otherwise calls CEikGlobalTextEditor::OfferKeyEventL().

Parameters

const TKeyEvent & aKeyEventThe key event.
TEventCode aTypeThe type of the event. The editor only consumes events of type EEventKey.

PictureFormatChangedL()

IMPORT_C voidPictureFormatChangedL()

Handles a change to the format of an embedded object, by updating the view, the scroll bars and reporting the event to its observers.

There is no need to call this function after calling EditPictureFormatL().

ReEditObjectL()

IMPORT_C voidReEditObjectL()

Re-edits the embedded object at the cursor position.

If there is no embedded object at the cursor position, or if there is a selection, an info message is displayed.

If there is a valid object at the cursor position, it is opened for editing (or for viewing if the editor is read-only).

RefreshParsersL()

IMPORT_C voidRefreshParsersL()

Force everything to be parsed.

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

Reserved_3()

IMPORT_C voidReserved_3()[private, virtual]

RichText()

IMPORT_C CRichText *RichText()const

Gets a pointer to the rich text object owned by the editor.

RoomForObjectL()

voidRoomForObjectL()[private]

SetDefaultIconicDoorSize(const TSize &)

IMPORT_C voidSetDefaultIconicDoorSize(const TSize &aSize)

Changes the size of the icons used to represent embedded objects.

Any existing iconic doors can be updated to the new size by calling UpdatePictureSizeL().

Parameters

const TSize & aSizeThe new iconic door size in twips.

SetParserObserver(MEikRichTextEditorParserObserver *)

IMPORT_C voidSetParserObserver(MEikRichTextEditorParserObserver *aObserver)

Sets a parser observer.

If the CEikEdwin::ENoTextParsers attribute flag was specified on construction, this function has no effect.

Its HandleCursorOverParserL() function is called when the cursor is positioned over text that has been tagged by the parser, for instance a URL.

Parameters

MEikRichTextEditorParserObserver * aObserverThe parser observer.

SetPhoneNumberGrouping(TBool)

IMPORT_C voidSetPhoneNumberGrouping(TBoolaEnable)

Activate/Disable phone number grouping.

Parameters

TBool aEnableETrue if phone number grouping is to be activated, EFalse otherwise.

SetTextObserver(CRichText &)

voidSetTextObserver(CRichText &aText)[private]

Parameters

CRichText & aText

StreamStoreL(TInt)

IMPORT_C const CStreamStore &StreamStoreL(TIntaPos)const [private]

Parameters

TInt aPos

TryDeleteEmbeddedDocL(TAny *)

TInt TryDeleteEmbeddedDocL(TAny *aThis)[private, static]

Parameters

TAny * aThis

UpdateEmbeddedDocL(TAny *)

TInt UpdateEmbeddedDocL(TAny *aThis)[private, static]

Parameters

TAny * aThis

UpdatePictureFormatL()

IMPORT_C voidUpdatePictureFormatL()

Changes all embedded objects displayed as glass doors into temporarily iconic.

The function operates throughout the editor.

Only needed when pictures are temporarily iconic.

Has no effect if there are no embedded objects in the editor or if the EShowAllPicturesAsIconic attribute flag was set during construction.

UpdatePictureFormatL(TInt, TInt)

IMPORT_C voidUpdatePictureFormatL(TIntaStartPos,
TIntaLength
)

Changes all embedded objects displayed as glass doors into temporarily iconic.

The function operates over a specified range of characters.

Has no effect if there are no embedded objects in the editor or if the EShowAllPicturesAsIconic attribute flag was set during construction.

Only needed when pictures are temporarily iconic.

Parameters

TInt aStartPosThe start position.
TInt aLengthThe number of characters, beginning at aStartPos over which the function operates.

UpdatePictureSizeL()

IMPORT_C voidUpdatePictureSizeL()

Changes the size of all icons representing embedded objects to the default iconic door size.

Also updates any objects currently displayed as glass doors, so that if displayed as icons, they will use the correct size.

The function operates throughout the editor.

UpdatePictureSizeL(TInt, TInt)

IMPORT_C voidUpdatePictureSizeL(TIntaStartPos,
TIntaLength
)

Changes the size of all icons representing embedded objects to the default iconic door size.

Also updates any objects currently displayed as glass doors, so that if displayed as icons, they will use the correct size.

The function operates over a specified range of characters.

Parameters

TInt aStartPosThe start position.
TInt aLengthThe number of characters, beginning at aStartPos over which the function operates.

WriteInternalStateL(RWriteStream &)

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [protected, virtual]

From CCoeControl.

Writes the internal state to the specified stream.

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters

RWriteStream & aWriteStreamTarget stream.

Member Enumerations Documentation

Enum anonymous

Edit window attribute flags specific to the rich text editor.

These may be specified during construction in addition to the values contained in the TFlags enum in class CEikEdwin.

Enumerators

EShowAllPicturesAsIconic = 0x00100000

All embedded objects are represented by icon rather than glass doors.

ENoTextParsers = 0x00200000

The editor has no text parsers.

Text parsers are used to recognise and tag special text strings, e.g. URLs.

EPasteAsPlainText = 0x00400000

When pasting text into the editor, the text is stripped of all formatting.

Since
3.2

Enum anonymous

Internal flags used for indicating operations.

Enumerators

ECropFromLeft = 0x00010000

Crop from left.

ECropFromRight = 0x00020000

Crop from right.

ECropFromTop = 0x00040000

Crop from top.

ECropFromBottom = 0x00080000

Crop from bottom.

EReEditingObject = 0x00100000

Object is being re-edited.

Enum TObjectFormat

Identifies how an embedded object should be represented.

One of these values is specified when the object is inserted.

Enumerators

EAlwaysIconic

The object is always represented by an icon

EGlassIfPossible

The object is represented by a glass door, if possible, or by icon, if not.

Member Data Documentation

CBufStore * iBufStore

CBufStore *iBufStore[private]

TSize iDefaultIconicDoorSize

TSize iDefaultIconicDoorSize[protected]

Default size of iconic door.

TPictureHeader iEmbeddedDoc

TPictureHeader iEmbeddedDoc[private]

CIdle * iEmbeddedDocUpdate

CIdle *iEmbeddedDocUpdate[private]

CEikParserManager * iParserManager

CEikParserManager *iParserManager[private]