CPbkSingleEntryFetchDlg 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 <cpbksingleentryfetchdlg.h>

Detailed Description

Phonebook Single Entry 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. The user selection is then returned to the client.


Public Member Functions

IMPORT_C void  SetMopParent (MObjectProvider *aParent)
IMPORT_C void  ResetWhenDestroyed (CPbkSingleEntryFetchDlg **aSelfPtr)
  Sets *aSelfPtr to NULL when this dialog is destroyed.
IMPORT_C TInt  ExecuteLD ()
  Executes this dialog.
  ~CPbkSingleEntryFetchDlg ()
  Destructor.

Static Public Member Functions

static IMPORT_C CPbkSingleEntryFetchDlg NewL (TParams &aParams)
  Creates a new single entry fetch dialog.

Data Structures

class   TParams
  Single entry fetch parameter class. More...

Constructor & Destructor Documentation

CPbkSingleEntryFetchDlg::~CPbkSingleEntryFetchDlg  ) 
 

Destructor.

Also cancels this dialog and makes ExecuteLD return.


Member Function Documentation

IMPORT_C TInt CPbkSingleEntryFetchDlg::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 accepted, 0 if canceled.
static IMPORT_C CPbkSingleEntryFetchDlg* CPbkSingleEntryFetchDlg::NewL TParams aParams  )  [static]
 

Creates a new single entry fetch dialog.

Parameters:
aParams  Fetch parameters,
See also:
TParams
Returns:
New instance of this class.
IMPORT_C void CPbkSingleEntryFetchDlg::ResetWhenDestroyed CPbkSingleEntryFetchDlg **  aSelfPtr  ) 
 

Sets *aSelfPtr to NULL when this dialog is destroyed.

!aSelfPtr || *aSelfPtr==this

IMPORT_C void CPbkSingleEntryFetchDlg::SetMopParent MObjectProvider *  aParent  ) 
 
See also:
CCoeControl::SetMopParent(MObjectProvider* aParent)

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

Copyright © Nokia Corporation 2001-2008
Back to top