CSpdiaControl Class Reference

class CSpdiaControl : public CCoeControl

Inherits from

Public Member Functions
~CSpdiaControl ()
IMPORT_C void ApplyCellSpdiaPaneStyleL ( CAknGrid &, TSize &)
IMPORT_C TBool AssignDialIndexL ( TInt )
IMPORT_C TBool AssignDialNumberL ( TInt , CEikStatusPane *)
IMPORT_C TBool AssignNumberL ( TInt , CEikStatusPane *, CCoeControl *, TBool )
IMPORT_C void Cancel ()
IMPORT_C TBool CheckingIfPopUpNeeded ()
IMPORT_C TContactItemId ContactId ( TInt )
IMPORT_C HBufC * ContactTitleL ( TContactItemId , TBool )
TBool CreateDataL (const CAknGrid &)
IMPORT_C TBool CreateGridDataL ( CAknGrid *, TBool )
IMPORT_C void DeleteIconArray ()
IMPORT_C TBool DialNumberL ( TInt , TDes &, CEikStatusPane *)
IMPORT_C void DrawShadow ( CWindowGc &, const TSize &)
void DrawShadow ( CWindowGc &)
IMPORT_C TInt ExecuteLD ( TContactItemId , TInt )
IMPORT_C TInt GetSpdCtrlLastError ()
IMPORT_C CArrayPtr < CGulIcon > * IconArray ()
IMPORT_C TInt IconIndex ( TInt )
IMPORT_C TInt Index ( TInt )
IMPORT_C CSpdiaControl * NewL ()
IMPORT_C CSpdiaControl * NewL ( CPbkContactEngine &)
IMPORT_C TInt Number ( TInt )
IMPORT_C TInt NumberType ( TInt )
IMPORT_C CPbkContactEngine * PbkEngine ()
IMPORT_C const TDesC & PhoneDialNumber ( TInt )
IMPORT_C const TDesC & PhoneNumber ( TInt )
IMPORT_C void ReloadIconArray ()
IMPORT_C TBool RemoveDialIndexL ( TInt , TBool )
IMPORT_C void SetLayout (const TRect &)
IMPORT_C TInt Size ()
IMPORT_C TInt SpdIconIndex ( TInt )
IMPORT_C TInt ThumbIndex ( TInt )
IMPORT_C TInt VMBoxPosition ()
IMPORT_C TBool VoiceMailL ( TDes &)
IMPORT_C TInt VoiceMailType ()
Private Member Functions
CSpdiaControl ()
CSpdiaControl ( CPbkContactEngine *)
void AppendTextL (const TSpdiaIndexData &, TPtr &)
void AppendThumbnail (const TSpdiaIndexData &, TPtr &, TBool )
void AssignDialL ( TContactItemId , TInt , TInt )
void ChangeIndexDataL ( TInt , const TSpdiaIndexData &)
TBool CheckSpaceBelowCriticalLevelL ()
TBool CheckingIfPopUpNeededL ()
void ConstructL ()
TInt ConvThumbType (const TSize &)
TBool CreateIndexIconL ( TInt , TSpdiaIndexData &, TBool )
HBufC * CreateItemDescriptorLC (const TSpdiaIndexData &)
void Draw (const TRect &)
TPbkContactItemField * FindFieldL ( CPbkContactItem &, TPbkFieldId )
TInt FindIconIndex ( TInt )
TSize GetThumbnailSize ()
void HandleDatabaseEventL ( TContactDbObserverEvent )
TInt HasOperation (const MPbkThumbnailOperation &)
TInt IconPositionL (const CPbkContactItem &, TInt , TInt &)
void InitIndexDataL ()
void InitializeArray ()
HBufC * ItemDescriptorLC ( TInt , const TSpdiaIndexData &)
TTypeUid::Ptr MopSupplyObject ( TTypeUid )
void PbkThumbnailGetComplete (MPbkThumbnailOperation &, CFbsBitmap *)
void PbkThumbnailGetCompleteL (MPbkThumbnailOperation &, CFbsBitmap *)
void PbkThumbnailGetFailed (MPbkThumbnailOperation &, TInt )
void ReloadIconArrayL ()
void ResetArray ()
void SetContactId ( TInt , TContactItemId )
TInt SetIconArrayL ( CArrayPtrFlat < CGulIcon > *)
void SetIndexDataL ( TInt , TSpdiaIndexData &)
void SetItemDataL ( CDesCArray &)
void SetOperationsL ()
void SizeChanged ()
TSize ThumbSize ( TInt )
TInt ThumbType ( TInt )
TBool UpdateIndexDataL ( TInt )
Inherited Functions
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::ComponentControl(TInt)const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CountComponentControls()const
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::FocusChanged(TDrawNow)
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)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::HandlePointerEventL(const TPointerEvent &)
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HandleResourceChange(TInt)
CCoeControl::HasBorder()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::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
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::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
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::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateL(RWriteStream &)const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Private Member Enumerations
enum TGridUse { EGridUse , EGridUseAndUpdate , EGridNoUse }
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
CAknsBasicBackgroundControlContext * iBgContext
TBuf < 254 > iBmpPath
TBool iBooleanVarForAddingDialogVariation
RArray < TAknsItemID > * iDialSkinBmp
CPbkContactEngine * iEngine
TInt iError
TBool iExEngine
TInt iFileOffset
TInt iFocusedGrid
CAknGrid * iGrid
CSpdiaGridDlg * iGridDlg
TGridUse iGridUsed
CArrayPtrFlat < CGulIcon > * iIconArray
RArray < TInt > * iIcons
TInt iIconsCount
RArray < TInt > * iIconsId
TInt iIconsIdCount
RArray < TInt > * iIconsMask
TInt iIconsMaskCount
CPbkThumbnailManager * iManager
CPbkContactChangeNotifier * iPbkNotifier
RPbkViewResourceFile * iPbkResourceFile
CPbkSingleItemFetchDlg * iPbkSingleItem
TBool iPopupDialog
CAknQueryDialog * iQueryDialog
TBuf < 254 > iRscPath
CAknQueryDialog * iSaveChangesDialog
TBool iSaveDlg
CArrayFixFlat < TSpdiaIndexData > * iSdmArray
TInt iSdmCount
CArrayFixFlat < TAknLayoutRect > * iShadowLayout
RArray < TAknsItemID > * iSkinIcons
CPAlbImageFactory * iThumbFactory
TInt iType
TAknLayoutRect icellLayout
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CSpdiaControl()

CSpdiaControl ( ) [private]

C++ default constructor.

CSpdiaControl(CPbkContactEngine *)

CSpdiaControl ( CPbkContactEngine * aPbkEngine ) [private]

C++ constructor.

Parameters

CPbkContactEngine * aPbkEngine

~CSpdiaControl()

IMPORT_C ~CSpdiaControl ( ) [virtual]

Destructor.

Member Functions Documentation

AppendTextL(const TSpdiaIndexData &, TPtr &)

void AppendTextL ( const TSpdiaIndexData & aSdmData,
TPtr & aText
) [private]

A descriptor is added to a text.

Parameters

const TSpdiaIndexData & aSdmData reference to the data currently used.
TPtr & aText the text for storing

AppendThumbnail(const TSpdiaIndexData &, TPtr &, TBool)

void AppendThumbnail ( const TSpdiaIndexData & aSdmData,
TPtr & aText,
TBool aFixedLocation
) [private]

The descriptor for thumbnail is added.

Parameters

const TSpdiaIndexData & aSdmData reference to the data currently used.
TPtr & aText
TBool aFixedLocation

ApplyCellSpdiaPaneStyleL(CAknGrid &, TSize &)

IMPORT_C void ApplyCellSpdiaPaneStyleL ( CAknGrid & aListBox,
TSize & aSize
)

Parameters

CAknGrid & aListBox
TSize & aSize

AssignDialIndexL(TInt)

IMPORT_C TBool AssignDialIndexL ( TInt aIndex )

Assigns the index data at the index in the phone book's contact entry.

Parameters

TInt aIndex a index of array.

AssignDialL(TContactItemId, TInt, TInt)

void AssignDialL ( TContactItemId aId,
TInt aFieldIdx,
TInt aDial
) [private]

Assigns the index data at aDial in the phone book's contact entry

Parameters

TContactItemId aId
TInt aFieldIdx
TInt aDial

AssignDialNumberL(TInt, CEikStatusPane *)

IMPORT_C TBool AssignDialNumberL ( TInt aLocation,
CEikStatusPane * aStatusPane = NULL
)

Puts a query on the screen asking for '...Assign it now'. When the user goes through, it will assign speed dial.

Parameters

TInt aLocation a location to assign speed dial.
CEikStatusPane * aStatusPane = NULL not used. ETrue if success.

AssignNumberL(TInt, CEikStatusPane *, CCoeControl *, TBool)

IMPORT_C TBool AssignNumberL ( TInt aIndex,
CEikStatusPane * aStatusPane,
CCoeControl * aContainer,
TBool aConfirmation
)

deprecated - do not use

Parameters

TInt aIndex
CEikStatusPane * aStatusPane
CCoeControl * aContainer
TBool aConfirmation

Cancel()

IMPORT_C void Cancel ( )

Cancels and dismisses this dialog. In other words makes ExecuteLD return just like cancel was pressed. Used when user switches a application and all modal dialogs are closed.

ChangeIndexDataL(TInt, const TSpdiaIndexData &)

void ChangeIndexDataL ( TInt aIndex,
const TSpdiaIndexData & aSdmData
) [private]

Speeddial index data is changed by the data of parameters.

Parameters

TInt aIndex a index of array.
const TSpdiaIndexData & aSdmData reference to the data currently used.

CheckSpaceBelowCriticalLevelL()

TBool CheckSpaceBelowCriticalLevelL ( ) [private]

Checks if the Flash File System storage will fall below Critical Level. Warning will be displayed if sotrage is below Critical Level.

CheckingIfPopUpNeeded()

IMPORT_C TBool CheckingIfPopUpNeeded ( )

Internal rutine to check if pop up has to be shown to enable the One-Key-Dialling setting.

CheckingIfPopUpNeededL()

TBool CheckingIfPopUpNeededL ( ) [private]

Internal rutine to check if pop up has to be shown to enable the One-Key-Dialling setting.

ConstructL()

void ConstructL ( ) [private]

Constructor

ContactId(TInt)

IMPORT_C TContactItemId ContactId ( TInt aIndex ) const

Returns the phone book contact item's id.

Parameters

TInt aIndex a index of array.

ContactTitleL(TContactItemId, TBool)

IMPORT_C HBufC * ContactTitleL ( TContactItemId aCid,
TBool aUnnamed
)

Gets a title text from contact item's id. Note: calls CPbkContactItem::GetContactTitleOrNullL() or CPbkContactEngine::UnnamedTitle()

Parameters

TContactItemId aCid contact item's id
TBool aUnnamed if title is empty, unname or NULL.

ConvThumbType(const TSize &)

TInt ConvThumbType ( const TSize & aSize ) const [private]

Returns the type from a size of thumbnail.

Parameters

const TSize & aSize a thumbnail size

CreateDataL(const CAknGrid &)

TBool CreateDataL ( const CAknGrid & aGrid )

Creates a grid itemArray. Note: It calls, when using a grid except SDM.

Parameters

const CAknGrid & aGrid the grid to set up

CreateGridDataL(CAknGrid *, TBool)

IMPORT_C TBool CreateGridDataL ( CAknGrid * aGrid,
TBool aIndex
)

Icons, thumbnails and text array for the grid are created. Note: If a aIndex parameter is set, only the data of the value will be set up. Note: CreateDataL() is used if App to be used is except SD.

Parameters

CAknGrid * aGrid the grid to set up
TBool aIndex (TInt) if <-1, All values are set up.

CreateIndexIconL(TInt, TSpdiaIndexData &, TBool)

TBool CreateIndexIconL ( TInt aIndex,
TSpdiaIndexData & aSdmData,
TBool aSetUpdateThumb
) [private]

Creates icon data for SDM control data by the data of parameters.

Parameters

TInt aIndex a index of array.
TSpdiaIndexData & aSdmData reference to the data currently used.
TBool aSetUpdateThumb thumbnail load start parameter set in index data

CreateItemDescriptorLC(const TSpdiaIndexData &)

HBufC * CreateItemDescriptorLC ( const TSpdiaIndexData & aSdmData ) [private]

Creates Item's descriptor for Grid.

Parameters

const TSpdiaIndexData & aSdmData reference to the data currently used. a buffer containing the descriptor text.

DeleteIconArray()

IMPORT_C void DeleteIconArray ( )

Build ver 2.6 . Deletes the old icon array.

DialNumberL(TInt, TDes &, CEikStatusPane *)

IMPORT_C TBool DialNumberL ( TInt aLocation,
TDes & aPhoneNumber,
CEikStatusPane * aStatusPane = NULL
)

The assigned number of the location is obtained. Note: Voice mail number will be returned if the location is the position of Voice mail. Note: If the location is empty, required dialog will be displayed and a location will be assigned.

Parameters

TInt aLocation a location of speed dial.
TDes & aPhoneNumber
CEikStatusPane * aStatusPane = NULL not used.

Draw(const TRect &)

void Draw ( const TRect & aRect ) const [private, virtual]

Draw this control

Parameters

const TRect & aRect

DrawShadow(CWindowGc &, const TSize &)

IMPORT_C void DrawShadow ( CWindowGc & aGc,
const TSize & aSize
)

Parameters

CWindowGc & aGc
const TSize & aSize

DrawShadow(CWindowGc &)

void DrawShadow ( CWindowGc & aGc ) const

Thumbnail's shadow is drawn.

Parameters

CWindowGc & aGc window gc

ExecuteLD(TContactItemId, TInt)

IMPORT_C TInt ExecuteLD ( TContactItemId aId,
TInt aFieldIdx
)

Runs the Speed Dial Selection Grid Dialog. If accepted sets speed dial key to aItem's aFieldId. Note: Calls CPbkContactEngine::SetFieldAsSpeedDialL() . If necessary, calls CPbkContactEngine::RemoveSpeedDialFieldL() .

Parameters

TContactItemId aId a contact item id. (Don't open)
TInt aFieldIdx

FindFieldL(CPbkContactItem &, TPbkFieldId)

TPbkContactItemField * FindFieldL ( CPbkContactItem & aItem,
TPbkFieldId aFieldId
) [private]

Searches contact item's fiels of this contact for a match.

Parameters

CPbkContactItem & aItem contact item to search.
TPbkFieldId aFieldId field id to search.

FindIconIndex(TInt)

TInt FindIconIndex ( TInt aId ) const [private]

Searches icon of grid array for a match.

Parameters

TInt aId phone book icon id to match to.

GetSpdCtrlLastError()

IMPORT_C TInt GetSpdCtrlLastError ( )

Returns last error.

GetThumbnailSize()

TSize GetThumbnailSize ( ) [private]

Gets actual size of thumbnial to be drawn.

HandleDatabaseEventL(TContactDbObserverEvent)

void HandleDatabaseEventL ( TContactDbObserverEvent aEvent ) [private]

From MContactDbObserver , Handles an event of type aEventType.

Parameters

TContactDbObserverEvent aEvent

HasOperation(const MPbkThumbnailOperation &)

TInt HasOperation ( const MPbkThumbnailOperation & aOperation ) [private]

Does it have a thumbnail operation object to match?

Parameters

const MPbkThumbnailOperation & aOperation a thumbnail operation object to match to.

IconArray()

IMPORT_C CArrayPtr < CGulIcon > * IconArray ( ) const

Returns the array of icons

IconIndex(TInt)

IMPORT_C TInt IconIndex ( TInt aIndex ) const

Returns the icon index of a grid array.

Parameters

TInt aIndex a index of array.

IconPositionL(const CPbkContactItem &, TInt, TInt &)

TInt IconPositionL ( const CPbkContactItem & aItem,
TInt aDial,
TInt & aFieldId
) [private]

The position on the array that a grid uses from an item and a phone number is returned.

Parameters

const CPbkContactItem & aItem contacd item
TInt aDial phone number
TInt & aFieldId

Index(TInt)

IMPORT_C TInt Index ( TInt aDial ) const

The value converted into the index of an array from the location of speeddial is returned.

Parameters

TInt aDial a location of speed dial.

InitIndexDataL()

void InitIndexDataL ( ) [private]

Index data are initialized.

InitializeArray()

void InitializeArray ( ) [private]

ItemDescriptorLC(TInt, const TSpdiaIndexData &)

HBufC * ItemDescriptorLC ( TInt aIndex,
const TSpdiaIndexData & aSdmData
) [private]

Gets Item's descriptor for Grid.

Parameters

TInt aIndex a index of array.
const TSpdiaIndexData & aSdmData reference to the data currently used.

MopSupplyObject(TTypeUid)

TTypeUid::Ptr MopSupplyObject ( TTypeUid aId ) [private]

Passes skin information when needed.

Parameters

TTypeUid aId

NewL()

IMPORT_C CSpdiaControl * NewL ( ) [static]

Creates a new instace of this class.

NewL(CPbkContactEngine &)

IMPORT_C CSpdiaControl * NewL ( CPbkContactEngine & aPbkEngine ) [static]

Creates a new instace of this class.

Parameters

CPbkContactEngine & aPbkEngine reference of CPbkContactEngine.

Number(TInt)

IMPORT_C TInt Number ( TInt aIndex ) const

The value converted into the the location of speeddial from index of an array is returned.

Parameters

TInt aIndex a index of array.

NumberType(TInt)

IMPORT_C TInt NumberType ( TInt aIndex ) const

Returns type of the phone number.

Parameters

TInt aIndex

PbkEngine()

IMPORT_C CPbkContactEngine * PbkEngine ( ) const

Returns the owned Phone Book Engine.

PbkThumbnailGetComplete(MPbkThumbnailOperation &, CFbsBitmap *)

void PbkThumbnailGetComplete ( MPbkThumbnailOperation & aOperation,
CFbsBitmap * aBitmap
) [private]

Called when thumbnail loading is completed.

Parameters

MPbkThumbnailOperation & aOperation the completed operation.
CFbsBitmap * aBitmap The loaded bitmap. Callee is responsible of the bitmap.

PbkThumbnailGetCompleteL(MPbkThumbnailOperation &, CFbsBitmap *)

void PbkThumbnailGetCompleteL ( MPbkThumbnailOperation & aOperation,
CFbsBitmap * aBitmap
) [private]

Called when thumbnail loading is completed.

Parameters

MPbkThumbnailOperation & aOperation the completed operation.
CFbsBitmap * aBitmap The loaded bitmap. Callee is responsible of the bitmap.

PbkThumbnailGetFailed(MPbkThumbnailOperation &, TInt)

void PbkThumbnailGetFailed ( MPbkThumbnailOperation & aOperation,
TInt aError
) [private]

Called if the thumbnail loading fails.

Parameters

MPbkThumbnailOperation & aOperation the failed operation.
TInt aError error code of the failure.

PhoneDialNumber(TInt)

IMPORT_C const TDesC & PhoneDialNumber ( TInt aDial ) const

Returns the phone number of a speed dial contact. Note: A character invalid as a phone number is removed.

Parameters

TInt aDial a location of speeddial.

PhoneNumber(TInt)

IMPORT_C const TDesC & PhoneNumber ( TInt aIndex ) const

Returns the phone number of a speed dial contact. Note: left and right spaces are removed.

Parameters

TInt aIndex a index of array.

ReloadIconArray()

IMPORT_C void ReloadIconArray ( )

Build ver 2.6 . Reloads the new skin icons

ReloadIconArrayL()

void ReloadIconArrayL ( ) [private]

Build ver 2.6 . Reloads the new skin icons

RemoveDialIndexL(TInt, TBool)

IMPORT_C TBool RemoveDialIndexL ( TInt aIndex,
TBool aConfirmation = ETrue
)

Removes a speed dial from the phone book's contact entry.

Parameters

TInt aIndex a index of array.
TBool aConfirmation = ETrue when remove, confirm is displayed. ETrue if success

ResetArray()

void ResetArray ( ) [private]

A text array that a grid has is erased.

SetContactId(TInt, TContactItemId)

void SetContactId ( TInt aIndex,
TContactItemId aCid
) [private]

Set phonebook contact itmes'id.

Parameters

TInt aIndex a index of array.
TContactItemId aCid phone book contact item's id.

SetIconArrayL(CArrayPtrFlat< CGulIcon > *)

TInt SetIconArrayL ( CArrayPtrFlat < CGulIcon > * aArray ) [private]

An icon array is created and set.

if need loadthumbL ETrue

Parameters

CArrayPtrFlat < CGulIcon > * aArray

SetIndexDataL(TInt, TSpdiaIndexData &)

void SetIndexDataL ( TInt aIndex,
TSpdiaIndexData & aSdmData
) [private]

Speeddial index data is set by the data of parameters.

Parameters

TInt aIndex a index of array.
TSpdiaIndexData & aSdmData reference to the data currently used.

SetItemDataL(CDesCArray &)

void SetItemDataL ( CDesCArray & aArray ) [private]

The data of items are added to an array.

Parameters

CDesCArray & aArray

SetLayout(const TRect &)

IMPORT_C void SetLayout ( const TRect & aRect )

The position which a shadow draws is set up.

Parameters

const TRect & aRect

SetOperationsL()

void SetOperationsL ( ) [private]

Operations to a CPbkThumbnailManager are set. Note: call GetThumbnailAsyncL().

Size()

IMPORT_C TInt Size ( ) const

deprecated - do not use

SizeChanged()

void SizeChanged ( ) [private, virtual]

Set size for the skin background context.

SpdIconIndex(TInt)

IMPORT_C TInt SpdIconIndex ( TInt aIndex ) const

Returns the icon index of grid array.

Parameters

TInt aIndex

ThumbIndex(TInt)

IMPORT_C TInt ThumbIndex ( TInt aIndex ) const

Returns the thumbnail index of a grid array.

Parameters

TInt aIndex a index of array.

ThumbSize(TInt)

TSize ThumbSize ( TInt aIndex ) const [private]

Returns the thumbnail size.

Parameters

TInt aIndex a index of array.

ThumbType(TInt)

TInt ThumbType ( TInt aIndex ) const [private]

Returns the thumbnail type.

Parameters

TInt aIndex a index of array.

UpdateIndexDataL(TInt)

TBool UpdateIndexDataL ( TInt aIndex ) [private]

Updates data set to match index of the owned index data array.

Parameters

TInt aIndex

VMBoxPosition()

IMPORT_C TInt VMBoxPosition ( ) const

Returns the position of voice mail box

VoiceMailL(TDes &)

IMPORT_C TBool VoiceMailL ( TDes & aNumber )

The number of voice mail returned, if voice mail is assigned. Note: If the location is empty, required dialog will be displayed and voice mail will be defined.

Parameters

TDes & aNumber reference of phone number. EFalse if user cancel or failed.

VoiceMailType()

IMPORT_C TInt VoiceMailType ( )

Member Enumerations Documentation

Enum TGridUse

Enumerators

EGridUse
EGridUseAndUpdate
EGridNoUse

Member Data Documentation

CAknsBasicBackgroundControlContext * iBgContext

CAknsBasicBackgroundControlContext * iBgContext [private]

TBuf< 254 > iBmpPath

TBuf < 254 > iBmpPath [private]

TBool iBooleanVarForAddingDialogVariation

TBool iBooleanVarForAddingDialogVariation [private]

RArray< TAknsItemID > * iDialSkinBmp

RArray < TAknsItemID > * iDialSkinBmp [private]

CPbkContactEngine * iEngine

CPbkContactEngine * iEngine [private]

TInt iError

TInt iError [private]

TBool iExEngine

TBool iExEngine [private]

TInt iFileOffset

TInt iFileOffset [private]

TInt iFocusedGrid

TInt iFocusedGrid [private]

CAknGrid * iGrid

CAknGrid * iGrid [private]

CSpdiaGridDlg * iGridDlg

CSpdiaGridDlg * iGridDlg [private]

TGridUse iGridUsed

TGridUse iGridUsed [private]

CArrayPtrFlat< CGulIcon > * iIconArray

CArrayPtrFlat < CGulIcon > * iIconArray [private]

RArray< TInt > * iIcons

RArray < TInt > * iIcons [private]

TInt iIconsCount

TInt iIconsCount [private]

RArray< TInt > * iIconsId

RArray < TInt > * iIconsId [private]

TInt iIconsIdCount

TInt iIconsIdCount [private]

RArray< TInt > * iIconsMask

RArray < TInt > * iIconsMask [private]

TInt iIconsMaskCount

TInt iIconsMaskCount [private]

CPbkThumbnailManager * iManager

CPbkThumbnailManager * iManager [private]

CPbkContactChangeNotifier * iPbkNotifier

CPbkContactChangeNotifier * iPbkNotifier [private]

RPbkViewResourceFile * iPbkResourceFile

RPbkViewResourceFile * iPbkResourceFile [private]

CPbkSingleItemFetchDlg * iPbkSingleItem

CPbkSingleItemFetchDlg * iPbkSingleItem [private]

TBool iPopupDialog

TBool iPopupDialog [private]

CAknQueryDialog * iQueryDialog

CAknQueryDialog * iQueryDialog [private]

TBuf< 254 > iRscPath

TBuf < 254 > iRscPath [private]

CAknQueryDialog * iSaveChangesDialog

CAknQueryDialog * iSaveChangesDialog [private]

TBool iSaveDlg

TBool iSaveDlg [private]

CArrayFixFlat< TSpdiaIndexData > * iSdmArray

CArrayFixFlat < TSpdiaIndexData > * iSdmArray [private]

TInt iSdmCount

TInt iSdmCount [private]

CArrayFixFlat< TAknLayoutRect > * iShadowLayout

CArrayFixFlat < TAknLayoutRect > * iShadowLayout [private]

RArray< TAknsItemID > * iSkinIcons

RArray < TAknsItemID > * iSkinIcons [private]

CPAlbImageFactory * iThumbFactory

CPAlbImageFactory * iThumbFactory [private]

TInt iType

TInt iType [private]

TAknLayoutRect icellLayout

TAknLayoutRect icellLayout [private]