S60 3rd Edition API Reference: CSpdiaControl Class Reference

CSpdiaControl Class Reference

API published in: S60 1st Ed

Link against: spdctrl.lib

#include <spdiacontrol.h>

Inherits MPbkContactDbObserver, and MPbkThumbnailGetObserver.


Public Member Functions

IMPORT_C TBool AssignDialNumberL (TInt aLocation, CEikStatusPane *aStatusPane=NULL)
 Puts a query on the screen asking for '.
IMPORT_C TInt ExecuteLD (TContactItemId aId, TInt aFieldIdx)
 Runs the Speed Dial Selection Grid Dialog.
IMPORT_C void Cancel ()
 Cancels and dismisses this dialog.
IMPORT_C TBool DialNumberL (TInt aLocation, TDes &aPhoneNumber, CEikStatusPane *aStatusPane=NULL)
 The assigned number of the location is obtained.
virtual IMPORT_C ~CSpdiaControl ()
 Destructor.
IMPORT_C TBool VoiceMailL (TDes &aNumber)
 The number of voice mail returned, if voice mail is assigned.
IMPORT_C CPbkContactEngine * PbkEngine () const
 Returns the owned Phone Book Engine.
IMPORT_C TInt Index (TInt aDial) const
 The value converted into the index of an array from the location of speeddial is returned.
IMPORT_C TInt Number (TInt aIndex) const
 The value converted into the the location of speeddial from index of an array is returned.
IMPORT_C TContactItemId ContactId (TInt aIndex) const
 Returns the phone book contact item's id.
IMPORT_C const TDesC & PhoneDialNumber (TInt aDial) const
 Returns the phone number of a speed dial contact.
IMPORT_C const TDesC & PhoneNumber (TInt aIndex) const
 Returns the phone number of a speed dial contact.
IMPORT_C HBufC * ContactTitleL (TContactItemId aCid, TBool aUnnamed)
 Gets a title text from contact item's id.
IMPORT_C TInt IconIndex (TInt aIndex) const
 Returns the icon index of a grid array.
IMPORT_C TInt ThumbIndex (TInt aIndex) const
 Returns the thumbnail index of a grid array.
IMPORT_C CArrayPtr< CGulIcon > * IconArray () const
 Returns the array of icons.
IMPORT_C TBool CreateGridDataL (CAknGrid *aGrid, TBool aIndex)
 Icons, thumbnails and text array for the grid are created.
IMPORT_C TBool AssignDialIndexL (TInt aIndex)
 Assigns the index data at the index in the phone book's contact entry.
IMPORT_C TBool RemoveDialIndexL (TInt aIndex, TBool aConfirmation=ETrue)
 Removes a speed dial from the phone book's contact entry.
IMPORT_C TBool AssignNumberL (TInt aIndex, CEikStatusPane *aStatusPane, CCoeControl *aContainer, TBool aConfirmation)
 deprecated - do not use
IMPORT_C void ApplyCellSpdiaPaneStyleL (CAknGrid &aListBox, TSize &aSize)
IMPORT_C void DrawShadow (CWindowGc &aGc, const TSize &aSize)
IMPORT_C void SetLayout (const TRect &aRect)
 The position which a shadow draws is set up.
IMPORT_C TInt Size () const
 deprecated - do not use
IMPORT_C TInt VMBoxPosition () const
 Returns the position of voice mail box.
IMPORT_C TInt SpdIconIndex (TInt aIndex) const
 Returns the icon index of grid array.
IMPORT_C TInt NumberType (TInt aIndex) const
 Returns type of the phone number.
IMPORT_C void DeleteIconArray ()
 Build ver 2.6 .
IMPORT_C void ReloadIconArray ()
 Build ver 2.6 .
IMPORT_C TInt VoiceMailType ()
IMPORT_C TInt GetSpdCtrlLastError ()
 Returns last error.
IMPORT_C TBool CheckingIfPopUpNeeded ()
 Internal rutine to check if pop up has to be shown to enable the One-Key-Dialling setting.
TBool CreateDataL (const CAknGrid &aGrid)
 Creates a grid itemArray.
TBool ConfirmationNumberL (TInt aIndex, TInt aId, TInt aPromptId)
 Display confirmation dialog from id's.
void DrawShadow (CWindowGc &aGc) const
 Thumbnail's shadow is drawn.

Static Public Member Functions

static IMPORT_C CSpdiaControl * NewL ()
 Creates a new instace of this class.
static IMPORT_C CSpdiaControl * NewL (CPbkContactEngine &aPbkEngine)
 Creates a new instace of this class.

Constructor & Destructor Documentation

virtual IMPORT_C CSpdiaControl::~CSpdiaControl (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C void CSpdiaControl::ApplyCellSpdiaPaneStyleL ( CAknGrid &  aListBox,
TSize &  aSize
) 
 
IMPORT_C TBool CSpdiaControl::AssignDialIndexL ( TInt  aIndex  ) 
 

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

Parameters:
aIndex a index of array.
IMPORT_C TBool CSpdiaControl::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:
aLocation a location to assign speed dial.
aStatusPane not used. ETrue if success.
IMPORT_C TBool CSpdiaControl::AssignNumberL ( TInt  aIndex,
CEikStatusPane *  aStatusPane,
CCoeControl *  aContainer,
TBool  aConfirmation
) 
 

deprecated - do not use

IMPORT_C void CSpdiaControl::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.

IMPORT_C TBool CSpdiaControl::CheckingIfPopUpNeeded (   ) 
 

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

Public since 3rd Ed FP1

Returns:
bool value of one key calling status on or off.
TBool CSpdiaControl::ConfirmationNumberL ( TInt  aIndex,
TInt  aId,
TInt  aPromptId
) 
 

Display confirmation dialog from id's.

Parameters:
aIndex a index of array.
aId resource id
aPromptId prompt id
IMPORT_C TContactItemId CSpdiaControl::ContactId ( TInt  aIndex  )  const
 

Returns the phone book contact item's id.

Parameters:
aIndex a index of array.
Returns:
a contact item's id, if not found -1
IMPORT_C HBufC* CSpdiaControl::ContactTitleL ( TContactItemId  aCid,
TBool  aUnnamed
) 
 

Gets a title text from contact item's id.

Note: calls CPbkContactItem::GetContactTitleOrNullL() or CPbkContactEngine::UnnamedTitle()

Parameters:
aCid contact item's id
aUnnamed if title is empty, unname or NULL.
Returns:
a buffer containing the title. An unnametitle will be set if a title is empty.
TBool CSpdiaControl::CreateDataL ( const CAknGrid &  aGrid  ) 
 

Creates a grid itemArray.

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

Parameters:
aGrid the grid to set up
aUpdate updates in an event.
IMPORT_C TBool CSpdiaControl::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:
aGrid the grid to set up
aIndex (TInt) if <-1, All values are set up.
IMPORT_C void CSpdiaControl::DeleteIconArray (   ) 
 

Build ver 2.6 .

Deletes the old icon array.

IMPORT_C TBool CSpdiaControl::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:
aLocation a location of speed dial.
aPhonenumber reference of phonenumber.
aStatusPane not used.
Returns:
EFalse if user cancel or failed.
void CSpdiaControl::DrawShadow ( CWindowGc &  aGc  )  const
 

Thumbnail's shadow is drawn.

Parameters:
aGc window gc
IMPORT_C void CSpdiaControl::DrawShadow ( CWindowGc &  aGc,
const TSize &  aSize
) 
 
IMPORT_C TInt CSpdiaControl::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:
aId a contact item id. (Don't open)
aFieldId index to aItems field set.
Returns:
nonzero if accepted, zero if canceled.
IMPORT_C TInt CSpdiaControl::GetSpdCtrlLastError (   ) 
 

Returns last error.

IMPORT_C CArrayPtr<CGulIcon>* CSpdiaControl::IconArray (   )  const
 

Returns the array of icons.

IMPORT_C TInt CSpdiaControl::IconIndex ( TInt  aIndex  )  const
 

Returns the icon index of a grid array.

Parameters:
aIndex a index of array.
IMPORT_C TInt CSpdiaControl::Index ( TInt  aDial  )  const
 

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

Parameters:
aDial a location of speed dial.
Returns:
the index of a speeddial index data, if not found -1
static IMPORT_C CSpdiaControl* CSpdiaControl::NewL ( CPbkContactEngine &  aPbkEngine  )  [static]
 

Creates a new instace of this class.

Parameters:
aPbkEngine reference of CPbkContactEngine.
static IMPORT_C CSpdiaControl* CSpdiaControl::NewL (   )  [static]
 

Creates a new instace of this class.

IMPORT_C TInt CSpdiaControl::Number ( TInt  aIndex  )  const
 

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

Parameters:
aIndex a index of array.
Returns:
location of speed dial(1-9), if not found -1
IMPORT_C TInt CSpdiaControl::NumberType ( TInt  aIndex  )  const
 

Returns type of the phone number.

IMPORT_C CPbkContactEngine* CSpdiaControl::PbkEngine (   )  const
 

Returns the owned Phone Book Engine.

IMPORT_C const TDesC& CSpdiaControl::PhoneDialNumber ( TInt  aDial  )  const
 

Returns the phone number of a speed dial contact.

Note: A character invalid as a phone number is removed.

Parameters:
aDial a location of speeddial.
Returns:
phone number
IMPORT_C const TDesC& CSpdiaControl::PhoneNumber ( TInt  aIndex  )  const
 

Returns the phone number of a speed dial contact.

Note: left and right spaces are removed.

Parameters:
aIndex a index of array.
IMPORT_C void CSpdiaControl::ReloadIconArray (   ) 
 

Build ver 2.6 .

Reloads the new skin icons

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

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

Parameters:
aIndex a index of array.
aConfirmation when remove, confirm is displayed. ETrue if success
IMPORT_C void CSpdiaControl::SetLayout ( const TRect &  aRect  ) 
 

The position which a shadow draws is set up.

Parameters:
aRect 
IMPORT_C TInt CSpdiaControl::Size (   )  const
 

deprecated - do not use

IMPORT_C TInt CSpdiaControl::SpdIconIndex ( TInt  aIndex  )  const
 

Returns the icon index of grid array.

IMPORT_C TInt CSpdiaControl::ThumbIndex ( TInt  aIndex  )  const
 

Returns the thumbnail index of a grid array.

Parameters:
aIndex a index of array.
IMPORT_C TInt CSpdiaControl::VMBoxPosition (   )  const
 

Returns the position of voice mail box.

IMPORT_C TBool CSpdiaControl::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:
aNumber reference of phone number. EFalse if user cancel or failed.
IMPORT_C TInt CSpdiaControl::VoiceMailType (   ) 
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top