CPbkIdleFinder Class Reference

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

Link against: pbkeng.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData

#include <cpbkidlefinder.h>

Detailed Description

Phonebook idle finder class.

Wrapper for Contact Model's CIdleFinder.

See also:: CIdleFinder.


Public Member Functions
	CPbkIdleFinder (CIdleFinder aFinder, CContactItemFieldDef aFieldDef)
	Constructor.
	~CPbkIdleFinder ()
	Destructor.
IMPORT_C TBool	IsComplete () const
	Tests whether a search is complete.
IMPORT_C CContactIdArray *	TakeContactIds ()
	Gives access and ownership of the contact ids found in the search.
IMPORT_C TInt	Error () const
	Check for errors when search is complete.
IMPORT_C CIdleFinder *	IdleFinder () const
	Returns the CIdleFinder passed to constructor.
IMPORT_C CContactItemFieldDef *	FieldDef () const
	Returns the CContactItemFieldDef passed to constructor.

Constructor & Destructor Documentation

CPbkIdleFinder::CPbkIdleFinder	(	CIdleFinder *	aFinder,
		CContactItemFieldDef *	aFieldDef
	)

Constructor.

Not exported because objects of this class are created only by CPbkContactEngine.

Parameters:

	aFinder	Contact Model idle finder object. This takes ownership of aFinder.
	aFieldDef	Field defintion passed to aFinder. This takes ownership of aFieldDef.

CPbkIdleFinder::~CPbkIdleFinder

(

)

Destructor.

Member Function Documentation

IMPORT_C TInt CPbkIdleFinder::Error

(

)

const

Check for errors when search is complete.

Returns:: Error code. KErrNone if no errors occurred during the search.

See also:: CIdleFinder::Error().

IMPORT_C CContactItemFieldDef* CPbkIdleFinder::FieldDef

(

)

const

Returns the CContactItemFieldDef passed to constructor.

Ownership not transferred.

Returns:: Symbian Contacts model contact item field definition. NULL if not set.

IMPORT_C CIdleFinder* CPbkIdleFinder::IdleFinder

(

)

const

Returns the CIdleFinder passed to constructor.

Ownership not transferred.

Returns:: Symbian Contacts model Idle finder object. NULL if not set.

IMPORT_C TBool CPbkIdleFinder::IsComplete

(

)

const

Tests whether a search is complete.

Returns:: ETrue if complete, EFalse if not.

See also:: CIdleFinder::IsCompelete().

IMPORT_C CContactIdArray* CPbkIdleFinder::TakeContactIds

(

)

Gives access and ownership of the contact ids found in the search.

Returns:: Contacts id's found in the search.

See also:: CIdleFinder::TakeContactIds().

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

cpbkidlefinder.h

CPbkIdleFinder Class Reference

Capability Information

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation