CMsgBodyControl Class Reference

class CMsgBodyControl : public CMsgExpandableTextEditorControl

Defines a body control for message editors/viewers.

Inherits from

Public Member Functions
~CMsgBodyControl ()
IMPORT_C CEikRichTextEditor & Editor ()
void GetCaptionForFep ( TDes &)
void HandleResourceChange ( TInt )
IMPORT_C TCoeInputCapabilities InputCapabilities ()
IMPORT_C void InsertCharacterL (const TChar &)
IMPORT_C void InsertTextL (const TDesC &)
IMPORT_C TBool IsFocusChangePossible ( TMsgFocusDirection )
CItemFinder * ItemFinder ()
IMPORT_C CMsgBodyControl * NewL ( CCoeControl *)
void NotifyViewEvent ( TMsgViewEvent , TInt )
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void Reset ()
IMPORT_C void SetAndGetSizeL ( TSize &)
IMPORT_C void SetTextContentL ( CRichText &)
void SetupAutomaticFindAfterFocusChangeL ( TBool )
Protected Member Functions
CMsgBodyControl ( MMsgBaseControlObserver &)
CCoeControl * ComponentControl ( TInt )
void ConstructL ()
TInt CountComponentControls ()
void FocusChanged ( TDrawNow )
void PrepareForReadOnly ( TBool )
void SetContainerWindowL (const CCoeControl &)
void SizeChanged ()
Private Member Functions
CMsgBodyControlEditor * BodyControlEditor ()
void CheckCorrectControlYPosL ()
void DoNotifyViewEventL ( TMsgViewEvent , TInt )
void ResolveFontMetrics ()
void SetIcfPromptTextL ()
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::ConstructFromResourceL(TResourceReader &)
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::MinimumSize()
CCoeControl::MopSupplyObject(TTypeUid)
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::SetDimmed(TBool)
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::Draw(const TRect &)const
CEikBorderedControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CEikBorderedControl::HandlePointerEventL(const TPointerEvent &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
CMsgBaseControl::BaseConstructL()
CMsgBaseControl::CMsgBaseControl()
CMsgBaseControl::CMsgBaseControl(MMsgBaseControlObserver &)
CMsgBaseControl::ConstructFromResourceL(TInt)
CMsgBaseControl::ControlId()const
CMsgBaseControl::ControlModeFlags()const
CMsgBaseControl::ControlType()const
CMsgBaseControl::DistanceFromComponentAbove()const
CMsgBaseControl::IsModified()const
CMsgBaseControl::IsReadOnly()const
CMsgBaseControl::LabelFontL()const
CMsgBaseControl::Margins()const
CMsgBaseControl::NormalTextFontL()const
CMsgBaseControl::SetControlId(TInt)
CMsgBaseControl::SetControlModeFlags(TUint32)
CMsgBaseControl::SetControlType(TInt)
CMsgBaseControl::SetDistanceFromComponentAbove(TInt)
CMsgBaseControl::SetMargins(const TMargins &)
CMsgBaseControl::SetModified(TBool)
CMsgBaseControl::SetReadOnly(TBool)
CMsgBaseControl::~CMsgBaseControl()
CMsgExpandableTextEditorControl::ActivateL()
CMsgExpandableTextEditorControl::CMsgExpandableTextEditorControl()
CMsgExpandableTextEditorControl::CMsgExpandableTextEditorControl(MMsgBaseControlObserver &)
CMsgExpandableTextEditorControl::ClipboardL(TMsgClipboardFunc)
CMsgExpandableTextEditorControl::CopyDocumentContentL(CGlobalText &,CGlobalText &)
CMsgExpandableTextEditorControl::CurrentLineRect()
CMsgExpandableTextEditorControl::EditL(TMsgEditFunc)
CMsgExpandableTextEditorControl::EditPermission()const
CMsgExpandableTextEditorControl::HandleControlEventL(CCoeControl *,TCoeEvent)
CMsgExpandableTextEditorControl::HandleEdwinEventL(CEikEdwin *,TEdwinEvent)
CMsgExpandableTextEditorControl::HandleEdwinSizeEventL(CEikEdwin *,TEdwinSizeEvent,TSize)
CMsgExpandableTextEditorControl::IsCursorLocation(TMsgCursorLocation)const
CMsgExpandableTextEditorControl::IsPlainTextMode()const
CMsgExpandableTextEditorControl::ScrollL(TInt,TMsgScrollDirection)
CMsgExpandableTextEditorControl::SetBaseControlObserver(MMsgBaseControlObserver &)
CMsgExpandableTextEditorControl::SetCursorPosL(TInt)
CMsgExpandableTextEditorControl::SetMaxNumberOfChars(TInt)
CMsgExpandableTextEditorControl::SetPlainTextMode(TBool)
CMsgExpandableTextEditorControl::TextContent()const
CMsgExpandableTextEditorControl::VirtualHeight()
CMsgExpandableTextEditorControl::VirtualVisibleTop()
CMsgExpandableTextEditorControl::~CMsgExpandableTextEditorControl()
Inherited Enumerations
CCoeControl:TZoomType
CMsgBaseControl:TMsgEditPermissionFlags
CMsgBaseControl:TMsgViewEventFlags
Private Attributes
HBufC * iCaptionText
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder
CMsgBaseControl::iBaseControlObserver
CMsgBaseControl::iControlId
CMsgBaseControl::iControlModeFlags
CMsgBaseControl::iControlType
CMsgBaseControl::iDistanceFromComponentAbove
CMsgBaseControl::iLineHeight
CMsgBaseControl::iMargins
CMsgBaseControl::iMaxBodyHeight
CMsgExpandableTextEditorControl::iCursorPos
CMsgExpandableTextEditorControl::iEditor
CMsgExpandableTextEditorControl::iEditorTop
CMsgExpandableTextEditorControl::iMaxNumberOfChars

Constructor & Destructor Documentation

CMsgBodyControl(MMsgBaseControlObserver &)

CMsgBodyControl ( MMsgBaseControlObserver & aBaseControlObserver ) [protected]

Constructor.

Parameters

MMsgBaseControlObserver & aBaseControlObserver

~CMsgBodyControl()

~CMsgBodyControl ( ) [virtual]

Destructor.

Member Functions Documentation

BodyControlEditor()

CMsgBodyControlEditor * BodyControlEditor ( ) const [private]

Utility function to cast editor to correct type.

CheckCorrectControlYPosL()

void CheckCorrectControlYPosL ( ) [private]

ComponentControl(TInt)

CCoeControl * ComponentControl ( TInt aIndex ) const [protected, virtual]

Returns a control of index aIndex.

Parameters

TInt aIndex

ConstructL()

void ConstructL ( ) [protected]

2nd phase constructor.

CountComponentControls()

TInt CountComponentControls ( ) const [protected, virtual]

Returns a number of controls.

DoNotifyViewEventL(TMsgViewEvent, TInt)

void DoNotifyViewEventL ( TMsgViewEvent aEvent,
TInt aParam
) [private]

Performs view event handling.

Parameters

TMsgViewEvent aEvent
TInt aParam

Editor()

IMPORT_C CEikRichTextEditor & Editor ( ) const

Returns a reference to the editor control.

FocusChanged(TDrawNow)

void FocusChanged ( TDrawNow aDrawNow ) [protected, virtual]

This is called when the focus of the control is changed.

Parameters

TDrawNow aDrawNow

GetCaptionForFep(TDes &)

void GetCaptionForFep ( TDes & aCaption ) const

Returns a caption for called

Parameters

TDes & aCaption On return, contains the caption(ICF prompt text) of body control.

HandleResourceChange(TInt)

void HandleResourceChange ( TInt aType ) [virtual]

For handling dynamic layout switch.

Parameters

TInt aType

InputCapabilities()

IMPORT_C TCoeInputCapabilities InputCapabilities ( ) const [virtual]

Returns control's input capabilities.

InsertCharacterL(const TChar &)

IMPORT_C void InsertCharacterL ( const TChar & aCharacter )

Inserts a character to the editor.

Parameters

const TChar & aCharacter

InsertTextL(const TDesC &)

IMPORT_C void InsertTextL ( const TDesC & aText )

Inserts text to the editor.

Parameters

const TDesC & aText

IsFocusChangePossible(TMsgFocusDirection)

IMPORT_C TBool IsFocusChangePossible ( TMsgFocusDirection aDirection ) const [virtual]

Checks if the focus change up or down is possible and returns ETrue if it is.

Parameters

TMsgFocusDirection aDirection

ItemFinder()

CItemFinder * ItemFinder ( ) [virtual]

Returns pointer to item finder.

NewL(CCoeControl *)

IMPORT_C CMsgBodyControl * NewL ( CCoeControl * aParent ) [static]

Factory method that creates this control.

Parameters

CCoeControl * aParent

NotifyViewEvent(TMsgViewEvent, TInt)

void NotifyViewEvent ( TMsgViewEvent aEvent,
TInt aParam
) [virtual]

Prepares control for viewing.

Parameters

TMsgViewEvent aEvent
TInt aParam

OfferKeyEventL(const TKeyEvent &, TEventCode)

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

Handles key events.

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

PrepareForReadOnly(TBool)

void PrepareForReadOnly ( TBool aReadOnly ) [protected, virtual]

Prepares for read only or non read only state.

Parameters

TBool aReadOnly

Reset()

IMPORT_C void Reset ( ) [virtual]

Resets (= clears) contents of the control.

ResolveFontMetrics()

void ResolveFontMetrics ( ) [private]

Reads layout data from "LAF".

SetAndGetSizeL(TSize &)

IMPORT_C void SetAndGetSizeL ( TSize & aSize ) [virtual]

Calculates and sets the size of the control and returns new size as reference aSize.

Parameters

TSize & aSize

SetContainerWindowL(const CCoeControl &)

void SetContainerWindowL ( const CCoeControl & aContainer ) [protected, virtual]

Sets container window.

Parameters

const CCoeControl & aContainer

SetIcfPromptTextL()

void SetIcfPromptTextL ( ) [private]

Sets the captiuon(ICF prompt text) of Body control

SetTextContentL(CRichText &)

IMPORT_C void SetTextContentL ( CRichText & aText )

Sets text content to the control editor.

Parameters

CRichText & aText

SetupAutomaticFindAfterFocusChangeL(TBool)

void SetupAutomaticFindAfterFocusChangeL ( TBool aBeginning ) [virtual]

Should be called when focus is changed to body.

Parameters

TBool aBeginning ETrue if search started from the beginning of the body text, EFalse if from the end

SizeChanged()

void SizeChanged ( ) [protected, virtual]

Sets new position for all the controls.

Member Data Documentation

HBufC * iCaptionText

HBufC * iCaptionText [private]