CMsgAddressControl Class Reference

class CMsgAddressControl : public CMsgExpandableControl

Defines an address control for message editors/viewers.

Public Member Functions
CMsgAddressControl(MMsgBaseControlObserver &)
~CMsgAddressControl()
IMPORT_C voidAddRecipientL(const TDesC &, const TDesC &, TBool, MVPbkContactLink *)
IMPORT_C voidAddRecipientsL(const CMsgRecipientList &)
IMPORT_C TBoolAddressFieldAutoHighlight()
voidConstructFromResourceL(TInt)
CMsgExpandableControlEditor *CreateEditorFromResourceL(TResourceReader &)
TUint32 EditPermission()
IMPORT_C TIntGetFirstUnverifiedStringL(HBufC *&)
IMPORT_C TIntGetNextUnverifiedStringL(HBufC *&)
IMPORT_C CMsgRecipientArray *GetRecipientsL()
IMPORT_C voidGetSizeOfAddresses(TInt &, TInt &)
voidHandleEdwinEventL(CEikEdwin *, TEdwinEvent)
voidHandleResourceChange(TInt)
IMPORT_C TIntHighlightUnvalidatedStringL()
IMPORT_C TIntHighlightUnverifiedStringL()
IMPORT_C TBoolIsPriorCharSemicolonL()
voidNotifyViewEvent(TMsgViewEvent, TInt)
TKeyResponse OfferKeyEventL(const TKeyEvent &, TEventCode)
voidReadControlPropertiesFromResourceL(TResourceReader &)
IMPORT_C TIntRefreshL(const CMsgRecipientArray &)
IMPORT_C TIntReplaceUnverifiedStringL(CMsgRecipientArray &)
IMPORT_C voidReset()
IMPORT_C TIntResetL()
IMPORT_C voidSetAddressFieldAutoHighlight(TBool)
Protected Member Functions
voidFocusChanged(TDrawNow)
voidLayoutButton()
voidPrepareForReadOnly(TBool)
Private Member Functions
voidCreateButtonL()
voidFormatAndSetCursorPosL(TInt)
TInt GetNextItemOnEntry(TDes &)
TInt ParseString(TDes &, const TPtrC &, TInt &, TInt &)
voidRemoveHighlightedEntryL()
voidResetParsingInfo()
voidSetParsingInfo(TInt, TInt, TInt)
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::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::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::ControlId()const
CMsgBaseControl::ControlModeFlags()const
CMsgBaseControl::ControlType()const
CMsgBaseControl::DistanceFromComponentAbove()const
CMsgBaseControl::IsModified()const
CMsgBaseControl::IsReadOnly()const
CMsgBaseControl::ItemFinder()
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::SetupAutomaticFindAfterFocusChangeL(TBool)
CMsgBaseControl::~CMsgBaseControl()
CMsgExpandableControl::ActivateL()
CMsgExpandableControl::Button()const
CMsgExpandableControl::CMsgExpandableControl()
CMsgExpandableControl::CMsgExpandableControl(MMsgBaseControlObserver &)
CMsgExpandableControl::Caption()const
CMsgExpandableControl::ComponentControl(TInt)const
CMsgExpandableControl::CountComponentControls()const
CMsgExpandableControl::CreateCaptionFromResourceL(TResourceReader &)
CMsgExpandableControl::CreateEditorL()
CMsgExpandableControl::Draw(const TRect &)const
CMsgExpandableControl::Editor()const
CMsgExpandableControl::GetCaptionForFep(TDes &)const
CMsgExpandableControl::HandleControlEventL(CCoeControl *,TCoeEvent)
CMsgExpandableControl::HandleFrameSizeChange()
CMsgExpandableControl::InputCapabilities()const
CMsgExpandableControl::IsFocusChangePossible(TMsgFocusDirection)const
CMsgExpandableControl::MinimumSize()
CMsgExpandableControl::ResolveLayoutsL()
CMsgExpandableControl::SetAndGetSizeL(TSize &)
CMsgExpandableControl::SetContainerWindowL(const CCoeControl &)
CMsgExpandableControl::SetTextContentL(CRichText &)
CMsgExpandableControl::SetTextContentL(const TDesC &)
CMsgExpandableControl::SizeChanged()
CMsgExpandableControl::TextContentStrippedL(TDes &,TInt,TBool)
CMsgExpandableControl::~CMsgExpandableControl()
CMsgExpandableTextEditorControl::CMsgExpandableTextEditorControl()
CMsgExpandableTextEditorControl::CMsgExpandableTextEditorControl(MMsgBaseControlObserver &)
CMsgExpandableTextEditorControl::ClipboardL(TMsgClipboardFunc)
CMsgExpandableTextEditorControl::CopyDocumentContentL(CGlobalText &,CGlobalText &)
CMsgExpandableTextEditorControl::CurrentLineRect()
CMsgExpandableTextEditorControl::EditL(TMsgEditFunc)
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()
Public Member Enumerations
enumTMsgAddressControlEditPermissionFlags {
EMsgEditCharInsert = EMsgFirstReservedFlag << 1, EMsgEditParagraphDelimiter = EMsgFirstReservedFlag << 2, EMsgEditBackspace = EMsgFirstReservedFlag << 3, EMsgEditDelete = EMsgFirstReservedFlag << 4, EMsgEditBackspaceMove = EMsgFirstReservedFlag << 5, EMsgEditRemoveEntry = EMsgFirstReservedFlag << 6
}
Inherited Enumerations
CCoeControl:TZoomType
CMsgBaseControl:TMsgEditPermissionFlags
CMsgBaseControl:TMsgViewEventFlags
Private Attributes
TBool iDuplicateEvent
TParsingInfo iParsingInfo
CMsgRecipientArray *iRecipientArray
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
CMsgExpandableControl::iButton
CMsgExpandableControl::iButtonLayout
CMsgExpandableControl::iButtonTop
CMsgExpandableControl::iCaption
CMsgExpandableControl::iCaptionLayout
CMsgExpandableControl::iCaptionTop
CMsgExpandableControl::iCtrltype
CMsgExpandableControl::iEditorLayout
CMsgExpandableControl::iFrameLayout
CMsgExpandableTextEditorControl::iCursorPos
CMsgExpandableTextEditorControl::iEditor
CMsgExpandableTextEditorControl::iEditorTop
CMsgExpandableTextEditorControl::iMaxNumberOfChars

Constructor & Destructor Documentation

CMsgAddressControl(MMsgBaseControlObserver &)

CMsgAddressControl(MMsgBaseControlObserver &aBaseControlObserver)

Constructor.

Parameters

MMsgBaseControlObserver & aBaseControlObserver

~CMsgAddressControl()

~CMsgAddressControl()[virtual]

Destructor.

Member Functions Documentation

AddRecipientL(const TDesC &, const TDesC &, TBool, MVPbkContactLink *)

IMPORT_C voidAddRecipientL(const TDesC &aName,
const TDesC &aAddress,
TBoolaVerified,
MVPbkContactLink *aContactLink
)

Adds one recipient to the address control.

Parameters

const TDesC & aName
const TDesC & aAddress
TBool aVerified
MVPbkContactLink * aContactLink

AddRecipientsL(const CMsgRecipientList &)

IMPORT_C voidAddRecipientsL(const CMsgRecipientList &aRecipients)

Adds list of recipients to the address control.

Parameters

const CMsgRecipientList & aRecipients

AddressFieldAutoHighlight()

IMPORT_C TBoolAddressFieldAutoHighlight()

Returns address highlighting value for automatic find function.

ConstructFromResourceL(TInt)

voidConstructFromResourceL(TIntaResourceId)[virtual]

Creates this control from resource.

Parameters

TInt aResourceId

CreateButtonL()

voidCreateButtonL()[private]

Creates button with label text.

CreateEditorFromResourceL(TResourceReader &)

CMsgExpandableControlEditor *CreateEditorFromResourceL(TResourceReader &aReader)[virtual]

Creates editor (CEikRichTextEditor) for the control from resource and returns pointer to it.

Parameters

TResourceReader & aReader

EditPermission()

TUint32 EditPermission()const [virtual]

Checks and returns control's edit permissions. Edit permissions are needed to check in order to know whether some key press is allowed to pass to the control or not.

FocusChanged(TDrawNow)

voidFocusChanged(TDrawNowaDrawNow)[protected, virtual]

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

Parameters

TDrawNow aDrawNow

FormatAndSetCursorPosL(TInt)

voidFormatAndSetCursorPosL(TIntaPos)[private]

Formats and sets the cursor to the beginning of the formatted band.

Parameters

TInt aPos

GetFirstUnverifiedStringL(HBufC *&)

IMPORT_C TIntGetFirstUnverifiedStringL(HBufC *&aString)

Finds the first unverified string and updates also the iParserInfo correspondingly.

Parameters

HBufC *& aString

GetNextItemOnEntry(TDes &)

TInt GetNextItemOnEntry(TDes &aEntryBuf)[private]

Finds the next unverified string on entry and updates parsing info correspondingly. Returns ETrue if found.

Parameters

TDes & aEntryBuf

GetNextUnverifiedStringL(HBufC *&)

IMPORT_C TIntGetNextUnverifiedStringL(HBufC *&aString)

Finds the next unverified string.

Parameters

HBufC *& aString

GetRecipientsL()

IMPORT_C CMsgRecipientArray *GetRecipientsL()

Returns recipients from the address control.

GetSizeOfAddresses(TInt &, TInt &)

IMPORT_C voidGetSizeOfAddresses(TInt &aEntryCount,
TInt &aSizeOfAddresses
)

Returns size of addresses.

Parameters

TInt & aEntryCountentry count
TInt & aSizeOfAddressestotal size of addresses.

HandleEdwinEventL(CEikEdwin *, TEdwinEvent)

voidHandleEdwinEventL(CEikEdwin *aEdwin,
TEdwinEventaEventType
)

Handle edwin events.

Parameters

CEikEdwin * aEdwin
TEdwinEvent aEventType

HandleResourceChange(TInt)

voidHandleResourceChange(TIntaType)[virtual]

For handling dynamic layout switch.

Parameters

TInt aType

HighlightUnvalidatedStringL()

IMPORT_C TIntHighlightUnvalidatedStringL()

Highlight unvalidated entry.

HighlightUnverifiedStringL()

IMPORT_C TIntHighlightUnverifiedStringL()

Highlights the found unverified entry.

IsPriorCharSemicolonL()

IMPORT_C TBoolIsPriorCharSemicolonL()const

Checks whether prior character is semicolon. Needed to variable selection key functionality in editors.

LayoutButton()

voidLayoutButton()[protected, virtual]

Sets the correct layout for button.

NotifyViewEvent(TMsgViewEvent, TInt)

voidNotifyViewEvent(TMsgViewEventaEvent,
TIntaParam
)[virtual]

Prepares control for viewing.

Parameters

TMsgViewEvent aEvent
TInt aParam

OfferKeyEventL(const TKeyEvent &, TEventCode)

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

Handles key events.

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

ParseString(TDes &, const TPtrC &, TInt &, TInt &)

TInt ParseString(TDes &aEntryItem,
const TPtrC &aString,
TInt &aStartPos,
TInt &aEndPos
)[private]

Finds and returns an unverified string aEntryItem from aString starting at position aStartPos. Returns a start position aStartPos and an end position aEndPos of the searched range. Returns KErrNotFound if a string cannot be found.

Parameters

TDes & aEntryItem
const TPtrC & aString
TInt & aStartPos
TInt & aEndPos

PrepareForReadOnly(TBool)

voidPrepareForReadOnly(TBoolaReadOnly)[protected, virtual]

Prepares for read only or non read only state.

Parameters

TBool aReadOnly

ReadControlPropertiesFromResourceL(TResourceReader &)

voidReadControlPropertiesFromResourceL(TResourceReader &aReader)[virtual]

Reads control properties from resource.

Parameters

TResourceReader & aReader

RefreshL(const CMsgRecipientArray &)

IMPORT_C TIntRefreshL(const CMsgRecipientArray &aArray)

Refreshes the contents of address control.

Parameters

const CMsgRecipientArray & aArray

RemoveHighlightedEntryL()

voidRemoveHighlightedEntryL()[private]

Removes highlighted entry.

ReplaceUnverifiedStringL(CMsgRecipientArray &)

IMPORT_C TIntReplaceUnverifiedStringL(CMsgRecipientArray &aArray)

Refreshes the contents of address control. OBSOLETE! User RefreshL instead.

Parameters

CMsgRecipientArray & aArray

Reset()

IMPORT_C voidReset()[virtual]

Clears content of the address control (non-leaving version; from CMsgBaseControl).

ResetL()

IMPORT_C TIntResetL()

Clears content of the address control.

ResetParsingInfo()

voidResetParsingInfo()[private, inline]

SetAddressFieldAutoHighlight(TBool)

IMPORT_C voidSetAddressFieldAutoHighlight(TBoolaValidHighlightable = EFalse)

Sets address highlighting for automatic find function on/off.

Parameters

TBool aValidHighlightable = EFalseETrue for on / EFalse for off.

SetParsingInfo(TInt, TInt, TInt)

voidSetParsingInfo(TIntaEntryNum,
TIntaStartPos,
TIntaEndPos
)[private, inline]

Parameters

TInt aEntryNum
TInt aStartPos
TInt aEndPos

Member Enumerations Documentation

Enum TMsgAddressControlEditPermissionFlags

Enumerators

EMsgEditCharInsert = EMsgFirstReservedFlag << 1
EMsgEditParagraphDelimiter = EMsgFirstReservedFlag << 2
EMsgEditBackspace = EMsgFirstReservedFlag << 3
EMsgEditDelete = EMsgFirstReservedFlag << 4
EMsgEditBackspaceMove = EMsgFirstReservedFlag << 5
EMsgEditRemoveEntry = EMsgFirstReservedFlag << 6

Member Data Documentation

TBool iDuplicateEvent

TBool iDuplicateEvent[private]

TParsingInfo iParsingInfo

TParsingInfo iParsingInfo[private]

CMsgRecipientArray * iRecipientArray

CMsgRecipientArray *iRecipientArray[private]