CEikGlobalTextEditor Class Reference

#include <mw/eikgted.h>

Link against: eikctl.lib

class CEikGlobalTextEditor : public CEikEdwin

Inherits from

Protected Attributes
CCharFormatLayer *iCharFormatLayer
CParaFormatLayer *iParaFormatLayer
Public Member Enumerations
enumTFontStyleFlags { EStandard, EBold, EItalic, EUnderline }
Public Member Functions
CEikGlobalTextEditor()
CEikGlobalTextEditor(const TGulBorder &)
~CEikGlobalTextEditor()
virtual IMPORT_C voidActivateL()
IMPORT_C voidApplyCharFormatL(TCharFormat &, TCharFormatMask &)
IMPORT_C voidApplyParaFormatL(CParaFormat *, TParaFormatMask &)
IMPORT_C voidBoldItalicUnderlineEventL(TInt)
virtual IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C voidConstructL(const CCoeControl *, TInt, TInt, TInt, TInt, TInt)
IMPORT_C TBoolDoFindL()
IMPORT_C CGlobalText *GlobalText()
virtual IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidInitFindL(SEdwinFindModel *&, CDesCArray *&, CDesCArray *&)
virtual IMPORT_C TIntLineCursorWidth()
virtual IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidRunFindAgainDialogL()
IMPORT_C voidRunFindDialogL()
IMPORT_C TBoolRunFontDialogL(TInt, CGraphicsDevice *, TInt)
IMPORT_C voidRunIndentsDialogL(TInt)
IMPORT_C TBoolRunPaginateDialogL(CPrintSetup *, CArrayFix< TInt > *)
IMPORT_C voidRunParaDialogsL(TInt)
IMPORT_C voidRunReplaceDialogL()
IMPORT_C voidRunTabsDialogL(TInt)
IMPORT_C voidSetButtonGroup(CCoeControl *)
IMPORT_C voidSetGraphicsDevice(CGraphicsDevice *)
IMPORT_C voidSetLineCursorBitmapL(CFbsBitmap *)
IMPORT_C voidUpdateButtonGroup()
Protected Member Functions
IMPORT_C voidBaseConstructL()
virtual IMPORT_C voidWriteInternalStateL(RWriteStream &)
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
Inherited Enumerations
CCoeControl:TZoomType
CEikEdwin:TChunkSize
CEikEdwin:TClipboardFunc
CEikEdwin:TEdwinHotKeys
CEikEdwin:TEikEdwinFlags
CEikEdwin:TEnd
CEikEdwin:TFindFlags
CEikEdwin:TFlags
CEikEdwin:TOwnershipType
CEikEdwin:TSetContent
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::CCoeControlArray
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::CopyDocumentContentL(CGlobalText &,CGlobalText &)
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::Draw(const TRect &)const
CEikEdwin::DrawContents()
CEikEdwin::DrawSmileyInTextL(RRegion &,const TRect &,CBitmapContext &,CFont &,const TDesC &,const TPoint &)
CEikEdwin::DrawTextView()const
CEikEdwin::DrawViewBackground(TBool)const
CEikEdwin::EditObserver(TInt,TInt)
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::HandleTextPastedL(TInt,TInt &)
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()

Detailed Description

Global text editor.

This is an edit window which supports globally formatted text. Supports a line cursor and provides functions which make it easy to launch various dialogs, for instance search, replace, set font etc.

Since
Symbian 5.0

Member Attribute Documentation

iCharFormatLayer

CCharFormatLayer *iCharFormatLayer[protected]

Stores the object's global character formatting.

iParaFormatLayer

CParaFormatLayer *iParaFormatLayer[protected]

Stores the object's global paragraph formatting.

Member Enumeration Documentation

Enum TFontStyleFlags

Font style

EnumeratorValueDescription
EStandard0x00

Normal font

EBold0x01

Bolded font

EItalic0x02

Italic font

EUnderline0x04

Underlined font

Constructor & Destructor Documentation

CEikGlobalTextEditor ( )

IMPORT_CCEikGlobalTextEditor()

C++ default constructor.

CEikGlobalTextEditor ( const TGulBorder & )

IMPORT_CCEikGlobalTextEditor(const TGulBorder &aBorder)

C++ default constructor.

ParameterDescription
aBorderThe editor's border.

~CEikGlobalTextEditor ( )

IMPORT_C~CEikGlobalTextEditor()

Destructor.

Member Function Documentation

ActivateL ( )

IMPORT_C voidActivateL()[virtual]

Reimplemented from CEikEdwin::ActivateL()

From CCoeControl.

Sets the editor ready for drawing.

ApplyCharFormatL ( TCharFormat &, TCharFormatMask & )

IMPORT_C voidApplyCharFormatL(TCharFormat &aCharFormat,
TCharFormatMask &aCharMask
)

Applies the character formatting and updates the screen layout.

The attributes which are set in the mask are read from aCharFormat. The attributes which are not set in the mask are not changed.

ParameterDescription
aCharFormatContain the new character formatting values to apply.
aCharMaskBitmask specifying the character format attributes to change.

ApplyParaFormatL ( CParaFormat *, TParaFormatMask & )

IMPORT_C voidApplyParaFormatL(CParaFormat *aParaFormat,
TParaFormatMask &aParaMask
)

Applies the paragraph formatting and updates the screen layout.

The attributes which are set in the mask are read from aParaMask. The attributes which are not set in the mask are not changed.

ParameterDescription
aParaFormatContains the new paragraph formatting values to apply.
aParaMaskBitmask specifying the paragraph format attributes to change.

BaseConstructL ( )

IMPORT_C voidBaseConstructL()[protected]

Reimplemented from CEikEdwin::BaseConstructL()

Completes the second-phase construction of a CEikEdwin object. This protected function is called by ConstructL() and ConstructFromResourceL() after the Edwin s size, flags and text limit have been set. Derived classes should call either this function or CEikEdwin s ConstructL() or ConstructFromResourceL() functions during their construction before initialising their own members.

BoldItalicUnderlineEventL ( TInt )

IMPORT_C voidBoldItalicUnderlineEventL(TIntaFontFlag)

Toggles format in the current selection.

For a global text editor the format change is applied globally. For a rich text editor where there is no selection the format change is applied to the word at the current cursor position.

ParameterDescription
aFontFlagThe format attribute toggle. See the TFontStyleFlags enum.

ConstructFromResourceL ( TResourceReader & )

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

Reimplemented from CEikEdwin::ConstructFromResourceL(TResourceReader &)

From CCoeControl.

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

The editor's paragraph and character formatting is set to default values.

See the GTXTED resource struct

ParameterDescription
aReaderA reader positioned for reading from a GTXTED resource.

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

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

By Default symbian 2nd phase constructor is private.

Completes construction of the global text editor.

The editor's paragraph and character formatting is set to default values.

ParameterDescription
aParentThe editor's parent control. Omit if the editor has no parent.
aNumberOfLinesThe editor's number of lines.
aTextLimitThe maximum length of the editor in characters.
aEdwinFlagsThe editor's flags. See CEikEdwin::TFlags.
aFontControlFlagsA set of flags that specify which font controls should appear, e.g. specifying EGulFontControlBold removes the bold checkbox control. The default shows all. For possible values, see gulftflg.hrh.
aFontNameFlagsThe editor's font name flags. For possible values, see gulftflg.hrh.

DoFindL ( )

IMPORT_C TBoolDoFindL()

Searches for text.

Returns ETrue if text is found.

Used by RunFindDialogL(), RunFindAgainDialogL() and RunReplaceDialogL() methods.

Returns: ETrue if the text is found EFalse otherwise.

GlobalText ( )

IMPORT_C CGlobalText *GlobalText()const

Gets the global text that is being edited.

Returns: The global text being edited.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Reimplemented from CEikEdwin::HandlePointerEventL(const TPointerEvent &)

From CCoeControl.

Handles pointer events.

ParameterDescription
aPointerEventPointer to an event that is to be handled.

InitFindL ( SEdwinFindModel *&, CDesCArray *&, CDesCArray *& )

IMPORT_C voidInitFindL(SEdwinFindModel *&aModel,
CDesCArray *&aFindList,
CDesCArray *&aReplaceList
)

Sets up the find model, the find list and the replace list ready for find or replace operations.

ParameterDescription
aModelThe find model to be used.
aFindListThe find list to be used.
aReplaceListThe replace list to be used.

LineCursorWidth ( )

IMPORT_C TIntLineCursorWidth()const [virtual]

Reimplemented from CEikEdwin::LineCursorWidth()const

From CEikEdwin.

Gets the width of a line cursor in pixels.

Returns: The width of the line cursor in pixels.

OfferKeyEventL ( const TKeyEvent &, TEventCode )

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

Reimplemented from CEikEdwin::OfferKeyEventL(const TKeyEvent &,TEventCode)

From CCoeControl.

Handles key events.

ParameterDescription
aKeyEventThe key code and modifier
aTypeThe type of the event: e.g. Key up.

Returns: EKeyWasConsumed if the event was handled. EKeyWasNotConsumed if the event was not handled.

RunFindAgainDialogL ( )

IMPORT_C voidRunFindAgainDialogL()

Runs the find dialog again.

RunFindDialogL ( )

IMPORT_C voidRunFindDialogL()

Runs the find dialog. Enables an user to specify the text for which to search for.

RunFontDialogL ( TInt, CGraphicsDevice *, TInt )

IMPORT_C TBoolRunFontDialogL(TIntaFontFlags = EGulNoSymbolFonts,
CGraphicsDevice *aGraphicsDevice = NULL,
TIntaFontControlFlags = EGulFontControlAll
)

Runs a dialog enabling a user to set the font.

Updates the button group to reflect any text formatting applied.

ParameterDescription
aFontFlags= EGulNoSymbolFonts Specifies which font types should appear in the list. For possible values see gulftflg.hrh.
aGraphicsDevice= NULL The graphics device. This is used to get the list of available fonts. If NULL the default screen device is used.
aFontControlFlags= EGulFontControlAll A set of flags that specify which font controls should appear in the dialog e.g. specifying EGulFontControlBold removes the bold checkbox control. The default shows all. For possible values see gulftflg.hrh.

Returns: ETrue if user made a change and pressed OK. EFalse if user pressed cancel or made no changes.

RunIndentsDialogL ( TInt )

IMPORT_C voidRunIndentsDialogL(TIntaPageWidth)

Runs indents dialog.

Changes the paragraph format to indent all text.

ParameterDescription
aPageWidthWidth of page in twips.

RunPaginateDialogL ( CPrintSetup *, CArrayFix< TInt > * )

IMPORT_C TBoolRunPaginateDialogL(CPrintSetup *aPrintSetup,
CArrayFix< TInt > *aCharsPerPage
)

Runs a dialog enabling a user to do pagination.

ParameterDescription
aPrintSetupThe printer setup.
aCharsPerPagePage table (array of characters per page).

Returns: ETrue if pagination is succesfull EFalse otherwise.

RunParaDialogsL ( TInt )

IMPORT_C voidRunParaDialogsL(TIntaCommand)

Runs a dialog enabling a user to set one of text alignment, spacing or borders.

Depending on the user's choice another dialog is run enabling them to set their requirements.

ParameterDescription
aCommandUser selected command. One of EEikCmdParaAlign, EEikCmdParaSpacing or EEikCmdParaBorder.

RunReplaceDialogL ( )

IMPORT_C voidRunReplaceDialogL()

Runs the replace dialog.

Enables the user to specify the text to be searched for and the replacement for that text. Can replace single or multiple occurances.

RunTabsDialogL ( TInt )

IMPORT_C voidRunTabsDialogL(TIntaPageWidth)

Runs a dialog enabling an user to set tab position.

ParameterDescription
aPageWidthWidth of the page in twips.

SetButtonGroup ( CCoeControl * )

IMPORT_C voidSetButtonGroup(CCoeControl *aButtonGroup)

Not implemented.

ParameterDescription
aButtonGroupNot used

SetGraphicsDevice ( CGraphicsDevice * )

IMPORT_C voidSetGraphicsDevice(CGraphicsDevice *aGraphicsDevice)

Sets the Graphics device to be used.

ParameterDescription
aGraphicsDeviceWanted graphics device.

SetLineCursorBitmapL ( CFbsBitmap * )

IMPORT_C voidSetLineCursorBitmapL(CFbsBitmap *aBitmap)

Not implemented.

ParameterDescription
aBitmapNot used

UpdateButtonGroup ( )

IMPORT_C voidUpdateButtonGroup()

Update the buttons in the button group so that they reflect the formatting of the global text object.

WriteInternalStateL ( RWriteStream & )

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

Reimplemented from CEikEdwin::WriteInternalStateL(RWriteStream &)const

From CCoeControl.

Writes the internal state to the specified stream. Does nothing in release mode.

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.

ParameterDescription
aWriteStreamThe stream to write to.