CEikGlobalTextEditor Class Reference

class CEikGlobalTextEditor : public CEikEdwin

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
Public Member Functions
CEikGlobalTextEditor ()
CEikGlobalTextEditor (const TGulBorder &)
~CEikGlobalTextEditor ()
IMPORT_C void ActivateL ()
IMPORT_C void ApplyCharFormatL ( TCharFormat &, TCharFormatMask &)
IMPORT_C void ApplyParaFormatL ( CParaFormat *, TParaFormatMask &)
IMPORT_C void BoldItalicUnderlineEventL ( TInt )
IMPORT_C void ConstructFromResourceL ( TResourceReader &)
IMPORT_C void ConstructL (const CCoeControl *, TInt , TInt , TInt , TInt , TInt )
IMPORT_C TBool DoFindL ()
IMPORT_C CGlobalText * GlobalText ()
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void InitFindL ( SEdwinFindModel *&, CDesCArray *&, CDesCArray *&)
IMPORT_C TInt LineCursorWidth ()
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void RunFindAgainDialogL ()
IMPORT_C void RunFindDialogL ()
IMPORT_C TBool RunFontDialogL ( TInt , CGraphicsDevice *, TInt )
IMPORT_C void RunIndentsDialogL ( TInt )
IMPORT_C TBool RunPaginateDialogL ( CPrintSetup *, CArrayFix < TInt > *)
IMPORT_C void RunParaDialogsL ( TInt )
IMPORT_C void RunReplaceDialogL ()
IMPORT_C void RunTabsDialogL ( TInt )
IMPORT_C void SetButtonGroup ( CCoeControl *)
IMPORT_C void SetGraphicsDevice ( CGraphicsDevice *)
IMPORT_C void SetLineCursorBitmapL ( CFbsBitmap *)
IMPORT_C void UpdateButtonGroup ()
Protected Member Functions
IMPORT_C void BaseConstructL ()
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
void CheckDocumentNotEmptyL ()
void CreateFindModelL ()
IMPORT_C void * ExtensionInterface ( TUid )
void GetTextForFindL ()
IMPORT_C void Reserved_2 ()
IMPORT_C void Reserved_3 ()
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::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()
Public Member Enumerations
enum TFontStyleFlags { EStandard  = 0x00, EBold  = 0x01, EItalic  = 0x02, EUnderline  = 0x04 }
Inherited Enumerations
CCoeControl:TZoomType
CEikEdwin:TChunkSize
CEikEdwin:TClipboardFunc
CEikEdwin:TEdwinHotKeys
CEikEdwin:TEikEdwinFlags
CEikEdwin:TEnd
CEikEdwin:TFindFlags
CEikEdwin:TFlags
CEikEdwin:TOwnershipType
CEikEdwin:TSetContent
Protected Attributes
CCharFormatLayer * iCharFormatLayer
CParaFormatLayer * iParaFormatLayer
Private Attributes
CEikDialogToolBar * iButGroup
CDesCArray * iFindList
SEdwinFindModel * iFindModel
TInt iFontControlFlags
TInt iFontNameFlags
CGraphicsDevice * iGraphicsDevice
CFbsBitmap * iLineCursor
TInt iLineCursorWidth
CDesCArray * iReplaceList
TInt iSpare
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

Constructor & Destructor Documentation

CEikGlobalTextEditor()

IMPORT_C CEikGlobalTextEditor ( )

C++ default constructor.

CEikGlobalTextEditor(const TGulBorder &)

IMPORT_C CEikGlobalTextEditor ( const TGulBorder & aBorder )

C++ default constructor.

Parameters

const TGulBorder & aBorder The editor's border.

~CEikGlobalTextEditor()

IMPORT_C ~CEikGlobalTextEditor ( )

Destructor.

Member Functions Documentation

ActivateL()

IMPORT_C void ActivateL ( ) [virtual]

From CCoeControl .

Sets the editor ready for drawing.

ApplyCharFormatL(TCharFormat &, TCharFormatMask &)

IMPORT_C void ApplyCharFormatL ( 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.

Parameters

TCharFormat & aCharFormat Contain the new character formatting values to apply.
TCharFormatMask & aCharMask Bitmask specifying the character format attributes to change.

ApplyParaFormatL(CParaFormat *, TParaFormatMask &)

IMPORT_C void ApplyParaFormatL ( 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.

Parameters

CParaFormat * aParaFormat Contains the new paragraph formatting values to apply.
TParaFormatMask & aParaMask Bitmask specifying the paragraph format attributes to change.

BaseConstructL()

IMPORT_C void BaseConstructL ( ) [protected]

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 void BoldItalicUnderlineEventL ( TInt aFontFlag )

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.

Parameters

TInt aFontFlag The format attribute toggle. See the TFontStyleFlags enum.

CheckDocumentNotEmptyL()

void CheckDocumentNotEmptyL ( ) [private]

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader ) [virtual]

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

Parameters

TResourceReader & aReader A reader positioned for reading from a GTXTED resource.

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

IMPORT_C void ConstructL ( const CCoeControl * aParent,
TInt aNumberOfLines,
TInt aTextLimit,
TInt aEdwinFlags,
TInt aFontControlFlags,
TInt aFontNameFlags
)

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.

Parameters

const CCoeControl * aParent The editor's parent control. Omit if the editor has no parent.
TInt aNumberOfLines The editor's number of lines.
TInt aTextLimit The maximum length of the editor in characters.
TInt aEdwinFlags The editor's flags. See CEikEdwin::TFlags.
TInt aFontControlFlags A 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.
TInt aFontNameFlags The editor's font name flags. For possible values, see gulftflg.hrh.

CreateFindModelL()

void CreateFindModelL ( ) [private]

DoFindL()

IMPORT_C TBool DoFindL ( )

Searches for text.

Returns ETrue if text is found.

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

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

Parameters

TUid aInterface

GetTextForFindL()

void GetTextForFindL ( ) [private]

GlobalText()

IMPORT_C CGlobalText * GlobalText ( ) const

Gets the global text that is being edited.

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

From CCoeControl .

Handles pointer events.

Parameters

const TPointerEvent & aPointerEvent Pointer to an event that is to be handled.

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

IMPORT_C void InitFindL ( SEdwinFindModel *& aModel,
CDesCArray *& aFindList,
CDesCArray *& aReplaceList
)

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

Parameters

SEdwinFindModel *& aModel The find model to be used.
CDesCArray *& aFindList The find list to be used.
CDesCArray *& aReplaceList The replace list to be used.

LineCursorWidth()

IMPORT_C TInt LineCursorWidth ( ) const [virtual]

From CEikEdwin .

Gets the width of a line cursor in pixels.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [virtual]

From CCoeControl .

Handles key events.

Parameters

const TKeyEvent & aKeyEvent The key code and modifier
TEventCode aType The type of the event: e.g. Key up.

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

Reserved_3()

IMPORT_C void Reserved_3 ( ) [private, virtual]

RunFindAgainDialogL()

IMPORT_C void RunFindAgainDialogL ( )

Runs the find dialog again.

RunFindDialogL()

IMPORT_C void RunFindDialogL ( )

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

RunFontDialogL(TInt, CGraphicsDevice *, TInt)

IMPORT_C TBool RunFontDialogL ( TInt aFontFlags = EGulNoSymbolFonts,
CGraphicsDevice * aGraphicsDevice = NULL,
TInt aFontControlFlags = EGulFontControlAll
)

Runs a dialog enabling a user to set the font.

Updates the button group to reflect any text formatting applied.

Parameters

TInt aFontFlags = EGulNoSymbolFonts = EGulNoSymbolFonts Specifies which font types should appear in the list. For possible values see gulftflg.hrh.
CGraphicsDevice * aGraphicsDevice = NULL = NULL The graphics device. This is used to get the list of available fonts. If NULL the default screen device is used.
TInt aFontControlFlags = EGulFontControlAll = 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.

RunIndentsDialogL(TInt)

IMPORT_C void RunIndentsDialogL ( TInt aPageWidth )

Runs indents dialog.

Changes the paragraph format to indent all text.

Parameters

TInt aPageWidth Width of page in twips.

RunPaginateDialogL(CPrintSetup *, CArrayFix< TInt > *)

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

Runs a dialog enabling a user to do pagination.

Parameters

CPrintSetup * aPrintSetup The printer setup.
CArrayFix < TInt > * aCharsPerPage Page table (array of characters per page).

RunParaDialogsL(TInt)

IMPORT_C void RunParaDialogsL ( TInt aCommand )

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.

Parameters

TInt aCommand User selected command. One of EEikCmdParaAlign, EEikCmdParaSpacing or EEikCmdParaBorder.

RunReplaceDialogL()

IMPORT_C void RunReplaceDialogL ( )

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 void RunTabsDialogL ( TInt aPageWidth )

Runs a dialog enabling an user to set tab position.

Parameters

TInt aPageWidth Width of the page in twips.

SetButtonGroup(CCoeControl *)

IMPORT_C void SetButtonGroup ( CCoeControl * aButtonGroup )

Not implemented.

Parameters

CCoeControl * aButtonGroup Not used

SetGraphicsDevice(CGraphicsDevice *)

IMPORT_C void SetGraphicsDevice ( CGraphicsDevice * aGraphicsDevice )

Sets the Graphics device to be used.

Parameters

CGraphicsDevice * aGraphicsDevice Wanted graphics device.

SetLineCursorBitmapL(CFbsBitmap *)

IMPORT_C void SetLineCursorBitmapL ( CFbsBitmap * aBitmap )

Not implemented.

Parameters

CFbsBitmap * aBitmap Not used

UpdateButtonGroup()

IMPORT_C void UpdateButtonGroup ( )

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

WriteInternalStateL(RWriteStream &)

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

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.

Parameters

RWriteStream & aWriteStream The stream to write to.

Member Enumerations Documentation

Enum TFontStyleFlags

Font style

Enumerators

EStandard = 0x00

Normal font

EBold = 0x01

Bolded font

EItalic = 0x02

Italic font

EUnderline = 0x04

Underlined font

Member Data Documentation

CEikDialogToolBar * iButGroup

CEikDialogToolBar * iButGroup [private]

CCharFormatLayer * iCharFormatLayer

CCharFormatLayer * iCharFormatLayer [protected]

Stores the object's global character formatting.

CDesCArray * iFindList

CDesCArray * iFindList [private]

SEdwinFindModel * iFindModel

SEdwinFindModel * iFindModel [private]

TInt iFontControlFlags

TInt iFontControlFlags [private]

TInt iFontNameFlags

TInt iFontNameFlags [private]

CGraphicsDevice * iGraphicsDevice

CGraphicsDevice * iGraphicsDevice [private]

CFbsBitmap * iLineCursor

CFbsBitmap * iLineCursor [private]

TInt iLineCursorWidth

TInt iLineCursorWidth [private]

CParaFormatLayer * iParaFormatLayer

CParaFormatLayer * iParaFormatLayer [protected]

Stores the object's global paragraph formatting.

CDesCArray * iReplaceList

CDesCArray * iReplaceList [private]

TInt iSpare

TInt iSpare [private]