CPbkSingleItemFetchDlg Class Reference

API published in: S60 2nd Ed
API deprecated in: S60 5th Ed

Link against: pbkview.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData


#include <cpbksingleitemfetchdlg.h>

Detailed Description

Phonebook Single Item Fetch API.

This class is used to construct a Phonebook UI dialog where the user is able to select a single contact entry from a contact list. Then the user must select a particular field of that selected contact. The selected contact item and field are then returned to the client.


Public Member Functions

IMPORT_C void  SetMopParent (MObjectProvider *aParent)
IMPORT_C TInt  ExecuteLD ()
  Executes this dialog.
  ~CPbkSingleItemFetchDlg ()
  Destructor.

Static Public Member Functions

static IMPORT_C CPbkSingleItemFetchDlg NewL (TParams &aParams, CPbkContactEngine &aEngine)
  Creates a new single entry fetch dialog.

Friends

class  TFetchCallback

Data Structures

class   TParams
  Single item fetch parameter class. More...

Constructor & Destructor Documentation

CPbkSingleItemFetchDlg::~CPbkSingleItemFetchDlg  ) 
 

Destructor.

Also cancels this dialog if ExecuteLD() has been called.


Member Function Documentation

IMPORT_C TInt CPbkSingleItemFetchDlg::ExecuteLD  ) 
 

Executes this dialog.

NOTE: this object is deleted when ExecuteLD returns or leaves! NOTE: current status pane layout is replaced with the Phonebook one. Restoring the original pane is left to be the responsibility of the caller.

Returns:
A non-zero value if not canceled.
static IMPORT_C CPbkSingleItemFetchDlg* CPbkSingleItemFetchDlg::NewL TParams aParams,
CPbkContactEngine aEngine
[static]
 

Creates a new single entry fetch dialog.

Parameters:
aParams  Fetch parameters,
See also:
TParams
Parameters:
aEngine  Phonebook engine
IMPORT_C void CPbkSingleItemFetchDlg::SetMopParent MObjectProvider *  aParent  ) 
 
See also:
CCoeControl::SetMopParent(MObjectProvider* aParent)

Friends And Related Function Documentation

friend class TFetchCallback [friend]
 

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top