Symbian^3 Product Developer Library >

MSearchQueryObserver Class Reference

class MSearchQueryObserver

This class is used to notify search progress to user. Users of MSearchClientSession must implement this interface to be able to monitor the search progress. This class is used to notify search progress to user. searchclient.lib

Public Member Functions
TAny *QueryObserverExtensionL(TUid)
voidSearchCompletedL(TInt, TInt)
voidSearchPartiallyCompletedL(TUid)
voidUpdateSearchProgressL(RPointerArray< CSearchLightResult > &, TInt, TInt)

Member Functions Documentation

QueryObserverExtensionL(TUid)

TAny *QueryObserverExtensionL(TUid)[inline, virtual]

Returns the extension for this interface. If no extension is available, return NULL.

Parameters

TUid

SearchCompletedL(TInt, TInt)

voidSearchCompletedL(TIntaSearchResult,
TIntaNumberOfFoundDocuments
)[pure virtual]

This function is called when the search has been completed.

Parameters

TInt aSearchResult
TInt aNumberOfFoundDocuments

SearchPartiallyCompletedL(TUid)

voidSearchPartiallyCompletedL(TUidaPluginId)[pure virtual]

Parameters

TUid aPluginId

UpdateSearchProgressL(RPointerArray< CSearchLightResult > &, TInt, TInt)

voidUpdateSearchProgressL(RPointerArray< CSearchLightResult > &aResultArray,
TIntaCurrentProgressValue,
TIntaTotalProgressValue
)[pure virtual]

This function is called when framework notifies about the search progress. The user of CSearchClientSession can define the time how often this will be called when requesting for search.

Parameters

RPointerArray< CSearchLightResult > & aResultArray
TInt aCurrentProgressValue- The current progress of the search process.
TInt aTotalProgressValue- Final progress value of the search process.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.