CPbkSelectFieldDlg Class Reference

API published in: S60 1st Ed
API deprecated in: S60 5th Ed

Link against: pbkview.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData

#include <cpbkselectfielddlg.h>

Detailed Description

Phonebook field selection dialog.

This class is used to show a Phonebook contact item field selection dialog to the user. The user is able to select a particular field from the dialog and this selection is returned to the client.


Public Member Functions
IMPORT_C	CPbkSelectFieldDlg ()
	Constructor.
IMPORT_C TPbkContactItemField *	ExecuteLD (CPbkFieldArray &aArray, TInt aCbaResourceId, const TDesC &aHeading=KNullDesC, TInt aFocusIndex=-1)
	Runs the dialog and returns selected field.
IMPORT_C	~CPbkSelectFieldDlg ()
	Destructor.
IMPORT_C void	SetObserver (MPbkControlKeyObserver *aKeyObserver)
	Registers aKeyObserver as a key event observer of this control.
IMPORT_C void	AttemptExitL (TBool aAccept)
	Attempts to exit this dialog as if a soft button was pressed.
IMPORT_C void	ResetWhenDestroyed (CPbkSelectFieldDlg **aSelfPtr)
	Sets aSelfPtr to NULL when this dialog is destroyed.

Constructor & Destructor Documentation

IMPORT_C CPbkSelectFieldDlg::CPbkSelectFieldDlg

(

)

Constructor.

IMPORT_C CPbkSelectFieldDlg::~CPbkSelectFieldDlg

(

)

Destructor.

Member Function Documentation

IMPORT_C void CPbkSelectFieldDlg::AttemptExitL

(

TBool

aAccept

)

Attempts to exit this dialog as if a soft button was pressed.

See also:: CAknPopupList::AttemptExitL(TBool).

IMPORT_C TPbkContactItemField* CPbkSelectFieldDlg::ExecuteLD	(	CPbkFieldArray &	aArray,
		TInt	aCbaResourceId,
		const TDesC &	aHeading = `KNullDesC`,
		TInt	aFocusIndex = `-1`
	)

Runs the dialog and returns selected field.

NOTE: this object is deleted when this function returns or leaves.

Parameters:

	aArray	Array of TPbkContactItemFields
	aCbaResourceId	Softkey buttons for the control.
	aHeading	Possible heading for the control.
	aFocusIndex	Field index to focus initially.

Returns:: The selected contact item field or NULL.

IMPORT_C void CPbkSelectFieldDlg::ResetWhenDestroyed

(

CPbkSelectFieldDlg **

aSelfPtr

)

Sets aSelfPtr to NULL when this dialog is destroyed.

!aSelfPtr || *aSelfPtr==this

IMPORT_C void CPbkSelectFieldDlg::SetObserver

(

MPbkControlKeyObserver *

aKeyObserver

)

Registers aKeyObserver as a key event observer of this control.

Only one observer is supported and setting a new one removes the previous setting.