CMsgBioBodyControl Class Reference

class CMsgBioBodyControl : public CMsgBaseControl

The container class for bio controls, which is contained in the CMsgBody class of the editor base classes.

Public Member Functions
~CMsgBioBodyControl()
IMPORT_C CMsgBioControl &BioControl(void)
IMPORT_C voidClipboardL(TMsgClipboardFunc)
IMPORT_C TRectCurrentLineRect()
IMPORT_C voidEditL(TMsgEditFunc)
IMPORT_C TUint32EditPermission()
IMPORT_C TBoolHandleBaseControlEventRequestL(TMsgBioControlEventRequest, TInt)
IMPORT_C TBoolHandleBioCommandL(TInt)
IMPORT_C HBufC *HeaderTextL(void)
IMPORT_C TBoolIsCursorLocation(TMsgCursorLocation)
IMPORT_C TBoolIsFocusChangePossible(TMsgFocusDirection)
IMPORT_C CMsgBioBodyControl *NewL(MMsgBioControlObserver &, const TUid &, TMsvId, TMsgBioMode, CMsvSession &)
IMPORT_C voidNotifyViewEvent(TMsgViewEvent, TInt)
TKeyResponse OfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C TIntScrollL(TInt, TMsgScrollDirection)
IMPORT_C voidSetAndGetSizeL(TSize &)
IMPORT_C voidSetMenuCommandSetL(CEikMenuPane &)
IMPORT_C TIntVirtualHeight()
IMPORT_C TIntVirtualVisibleTop()
Protected Member Functions
CCoeControl *ComponentControl(TInt)
TInt CountComponentControls()
voidFocusChanged(TDrawNow)
voidPrepareForReadOnly(TBool)
voidSetContainerWindowL(const CCoeControl &)
voidSizeChanged()
Private Member Functions
CMsgBioBodyControl(CMsvSession &)
CMsgBioBodyControl()
CMsgBioBodyControl(const CMsgBioBodyControl &)
voidConstructL(MMsgBioControlObserver &, const TUid &, TMsvId, TMsgBioMode)
const CMsgBioBodyControl &operator=(const CMsgBioBodyControl &)
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::ActivateL()
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::InputCapabilities()const
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::HandleResourceChange(TInt)
CMsgBaseControl::IsModified()const
CMsgBaseControl::IsReadOnly()const
CMsgBaseControl::ItemFinder()
CMsgBaseControl::LabelFontL()const
CMsgBaseControl::Margins()const
CMsgBaseControl::NormalTextFontL()const
CMsgBaseControl::Reset()
CMsgBaseControl::SetBaseControlObserver(MMsgBaseControlObserver &)
CMsgBaseControl::SetControlId(TInt)
CMsgBaseControl::SetControlModeFlags(TUint32)
CMsgBaseControl::SetControlType(TInt)
CMsgBaseControl::SetDistanceFromComponentAbove(TInt)
CMsgBaseControl::SetMargins(const TMargins &)
CMsgBaseControl::SetModified(TBool)
CMsgBaseControl::SetReadOnly(TBool)
CMsgBaseControl::SetupAutomaticFindAfterFocusChangeL(TBool)
CMsgBaseControl::~CMsgBaseControl()
Inherited Enumerations
CCoeControl:TZoomType
CMsgBaseControl:TMsgEditPermissionFlags
CMsgBaseControl:TMsgViewEventFlags
Protected Attributes
CMsgBioControl *iBioControl
CMsgBioControlFactory *iBioControlFactory
Private Attributes
CMsvSession &iSession
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

Constructor & Destructor Documentation

CMsgBioBodyControl(CMsvSession &)

CMsgBioBodyControl(CMsvSession &aSession)[private]

Constructor

Parameters

CMsvSession & aSession

CMsgBioBodyControl()

CMsgBioBodyControl()[private]

The default constructor is hidden away from outsiders

CMsgBioBodyControl(const CMsgBioBodyControl &)

CMsgBioBodyControl(const CMsgBioBodyControl &aSource)[private]

Copy contructor prohibited.

Parameters

const CMsgBioBodyControl & aSource

~CMsgBioBodyControl()

IMPORT_C~CMsgBioBodyControl()

The destructor.

Member Functions Documentation

BioControl(void)

IMPORT_C CMsgBioControl &BioControl(void)

Gives access to the Bio Control. This is needed only in special cases.

Parameters

void

ClipboardL(TMsgClipboardFunc)

IMPORT_C voidClipboardL(TMsgClipboardFuncaFunc)[virtual]

From CMsgBaseControl. Handles clipboard operation.

Parameters

TMsgClipboardFunc aFuncThe clipboard command to be handled.

ComponentControl(TInt)

CCoeControl *ComponentControl(TIntaIndex)const [protected, virtual]

From CCoeControl. Returns a pointer to a certain sub control.

Parameters

TInt aIndexIndex of the control to be returned.

ConstructL(MMsgBioControlObserver &, const TUid &, TMsvId, TMsgBioMode)

voidConstructL(MMsgBioControlObserver &aBioControlObserver,
const TUid &aBioMsgType,
TMsvIdaId,
TMsgBioModeaEditorOrViewerMode
)[private]

Second phase constructor.

Parameters

MMsgBioControlObserver & aBioControlObserver
const TUid & aBioMsgTypeBio Message type
TMsvId aIdId of the message in Message Server.
TMsgBioMode aEditorOrViewerMode

CountComponentControls()

TInt CountComponentControls()const [protected, virtual]

From CCoeControl. Gives the number of sub controls.

CurrentLineRect()

IMPORT_C TRectCurrentLineRect()[virtual]

Returns the current control rect. From CMsgBaseControl.

EditL(TMsgEditFunc)

IMPORT_C voidEditL(TMsgEditFuncaFunc)[virtual]

From CMsgBaseControl. Handles editing operation.

Parameters

TMsgEditFunc aFuncThe editing command to be handled.

EditPermission()

IMPORT_C TUint32EditPermission()const [virtual]

From CMsgBaseControl. Returns edit permission flags.

FocusChanged(TDrawNow)

voidFocusChanged(TDrawNowaDrawNow)[protected, virtual]

Handles the change of focus.

Parameters

TDrawNow aDrawNow

HandleBaseControlEventRequestL(TMsgBioControlEventRequest, TInt)

IMPORT_C TBoolHandleBaseControlEventRequestL(TMsgBioControlEventRequestaRequest,
TIntaDelta = 0
)

Parameters

TMsgBioControlEventRequest aRequestevent type.
TInt aDelta = 0

HandleBioCommandL(TInt)

IMPORT_C TBoolHandleBioCommandL(TIntaCommand)

From CCoeControl. Handles commands.

Parameters

TInt aCommand

HeaderTextL(void)

IMPORT_C HBufC *HeaderTextL(void)const

Returns the header text. (ownership transferred)

Parameters

void

IsCursorLocation(TMsgCursorLocation)

IMPORT_C TBoolIsCursorLocation(TMsgCursorLocationaLocation)const [virtual]

Checks if cursor location is on the topmost or downmost position.

Parameters

TMsgCursorLocation aLocationTop or bottom to check for.

IsFocusChangePossible(TMsgFocusDirection)

IMPORT_C TBoolIsFocusChangePossible(TMsgFocusDirectionaDirection)const [virtual]

From CMsgBaseControl. Checks if focus change is possible.

Parameters

TMsgFocusDirection aDirectionThe direction of focus to check for.

NewL(MMsgBioControlObserver &, const TUid &, TMsvId, TMsgBioMode, CMsvSession &)

IMPORT_C CMsgBioBodyControl *NewL(MMsgBioControlObserver &aBioControlObserver,
const TUid &aBioMsgType,
TMsvIdaId,
TMsgBioModeaEditorOrViewerMode,
CMsvSession &aSession
)[static]

Two-phased constructor.

Parameters

MMsgBioControlObserver & aBioControlObserverReference to the Bio control observer.
const TUid & aBioMsgTypeThe type of Bio message.
TMsvId aIdId of the message.
TMsgBioMode aEditorOrViewerMode
CMsvSession & aSession

NotifyViewEvent(TMsgViewEvent, TInt)

IMPORT_C voidNotifyViewEvent(TMsgViewEventaEvent,
TIntaParam
)[virtual]
Prepares control for viewing.
Since
3.2

Parameters

TMsgViewEvent aEventThe event type
TInt aParamEvent related parameters

OfferKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

A CCoeControl virtual for handling key events.

Parameters

const TKeyEvent & aKeyEventThe key event.
TEventCode aTypeTEventCode

PrepareForReadOnly(TBool)

voidPrepareForReadOnly(TBoolaReadOnly)[protected, virtual]

Implementation of pure virtual in CMsgBaseControl. Prepares for read only or non read only state. This implementation does not do anything.

Parameters

TBool aReadOnlyPrepare for read only or non read only.

ScrollL(TInt, TMsgScrollDirection)

IMPORT_C TIntScrollL(TIntaPixelsToScroll,
TMsgScrollDirectionaDirection
)[virtual]
Performs the internal scrolling of control if needed. Default implementation does not perform any scrolling and returns that zero pixels were scrolled.
Since
3.2

Parameters

TInt aPixelsToScrollAmount of pixels to scroll.
TMsgScrollDirection aDirectionScrolling direction.

SetAndGetSizeL(TSize &)

IMPORT_C voidSetAndGetSizeL(TSize &aSize)[virtual]

From CMsgBaseControl. Calculates, sets and gives size of control. Calculates and sets the size of the control and returns new size as reference aSize.

Parameters

TSize & aSizeThe size

SetContainerWindowL(const CCoeControl &)

voidSetContainerWindowL(const CCoeControl &aContainer)[protected, virtual]

From CCoeControl. Parent sets the container window using this.

Parameters

const CCoeControl & aContainerThe parent control.

SetMenuCommandSetL(CEikMenuPane &)

IMPORT_C voidSetMenuCommandSetL(CEikMenuPane &aMenuPane)

This is called by the application for allowing the Bio control to add a menu item.

Parameters

CEikMenuPane & aMenuPaneReference to the applications menu.

SizeChanged()

voidSizeChanged()[protected, virtual]

From CCoeControl. Called by CONE framework. Gives this control a chance to manage layout of its sub controls.

VirtualHeight()

IMPORT_C TIntVirtualHeight()[virtual]

Returns approximate height of the control.

VirtualVisibleTop()

IMPORT_C TIntVirtualVisibleTop()[virtual]

Returns a topmost visible text position.

operator=(const CMsgBioBodyControl &)

const CMsgBioBodyControl &operator=(const CMsgBioBodyControl &aSource)[private]

Assignment operator prohibited.

Parameters

const CMsgBioBodyControl & aSource

Member Data Documentation

CMsgBioControl * iBioControl

CMsgBioControl *iBioControl[protected]

Owns the Bio Control.

CMsgBioControlFactory * iBioControlFactory

CMsgBioControlFactory *iBioControlFactory[protected]

Owns the factory. The factory needs to exist during the whole life of the Bio Control.

CMsvSession & iSession

CMsvSession &iSession[private]

The session is owned here.