CPbkSingleItemFetchDlg::TParams 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>

Single item fetch parameter class.


Public Member Functions
IMPORT_C	TParams ()
	C++ constructor.
IMPORT_C	operator TCleanupItem ()
	Returns a cleanup item which will handle cleanup of this object in case a leave occurs.
Data Fields
CContactViewBase *	iContactView
	Contact view to display.
const CPbkFieldIdArray *	iFieldIdArray
	Array of field types to fetch.
CPbkContactItem *	iContactItem
	Returns an contact item of the selected entry, undefined if the dialog is canceled.
TPbkContactItemField *	iContactItemField
	Returns a field of the selected entry, undefined if the dialog is canceled.
TInt	iCbaId
	OPTIONAL: Fetch softkey resource ID.

IMPORT_C CPbkSingleItemFetchDlg::TParams::TParams

(

)

C++ constructor.

IMPORT_C CPbkSingleItemFetchDlg::TParams::operator TCleanupItem

(

)

Returns a cleanup item which will handle cleanup of this object in case a leave occurs.

OPTIONAL: Fetch softkey resource ID.

If 0, Default softkeys are used.

Returns an contact item of the selected entry, undefined if the dialog is canceled.

Caller is responsible of deleting iContactItem.

Returns a field of the selected entry, undefined if the dialog is canceled.

This is iContactItem's field so it is deleted when iContactItem is deleted.

CContactViewBase* CPbkSingleItemFetchDlg::TParams::iContactView

Contact view to display.

If NULL, loads the default contact view containing all names in the contact database.

const CPbkFieldIdArray* CPbkSingleItemFetchDlg::TParams::iFieldIdArray

Array of field types to fetch.

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