CPbkIdleFinder Class Reference

#include <app/CPbkIdleFinder.h>

class CPbkIdleFinder : public CBase

Inherits from

  • CPbkIdleFinder
    Public Member Functions
    CPbkIdleFinder(CIdleFinder *, CContactItemFieldDef *)
    ~CPbkIdleFinder()
    IMPORT_C TIntError()
    IMPORT_C CContactItemFieldDef *FieldDef()
    IMPORT_C CIdleFinder *IdleFinder()
    IMPORT_C TBoolIsComplete()
    IMPORT_C CContactIdArray *TakeContactIds()
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    Phonebook idle finder class. Wrapper for Contact Model's CIdleFinder.

    See also: CIdleFinder.

    Constructor & Destructor Documentation

    CPbkIdleFinder ( CIdleFinder *, CContactItemFieldDef * )

    CPbkIdleFinder(CIdleFinder *aFinder,
    CContactItemFieldDef *aFieldDef
    )

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

    ParameterDescription
    aFinderContact Model idle finder object. This takes ownership of aFinder.
    aFieldDefField defintion passed to aFinder. This takes ownership of aFieldDef.

    ~CPbkIdleFinder ( )

    ~CPbkIdleFinder()

    Destructor.

    Member Function Documentation

    Error ( )

    IMPORT_C TIntError()const

    Check for errors when search is complete.

    See also: CIdleFinder::Error().

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

    FieldDef ( )

    IMPORT_C CContactItemFieldDef *FieldDef()const

    Returns the CContactItemFieldDef passed to constructor. Ownership not transferred.

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

    IdleFinder ( )

    IMPORT_C CIdleFinder *IdleFinder()const

    Returns the CIdleFinder passed to constructor. Ownership not transferred.

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

    IsComplete ( )

    IMPORT_C TBoolIsComplete()const

    Tests whether a search is complete.

    See also: CIdleFinder::IsCompelete().

    Returns: ETrue if complete, EFalse if not.

    TakeContactIds ( )

    IMPORT_C CContactIdArray *TakeContactIds()

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

    See also: CIdleFinder::TakeContactIds().

    Returns: Contacts id's found in the search.

    © Nokia 2011.