/*

* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Base class for Contact and RMU match observers

*

*/

#ifndef FREESTYLEEMAILUICLSMATCHOBSERVERINTERFACE_H

#define FREESTYLEEMAILUICLSMATCHOBSERVERINTERFACE_H

//  INCLUDES

#include <e32base.h>

//#include <cntdef.h>				// TContactItemId

#include <MPsResultsObserver.h>

#include <CPcsDefs.h>

// FORWARD DECLARATIONS

class CRepository;

class CPSRequestHandler;

class CFSEmailUiClsListsHandler;

class CVPbkContactManager;

// CLASS DECLARATION

/**

 * Base class for Contact and RMU match observers

 *

 *

 */

class CFSEmailUiClsMatchObserver : public CBase, public MPsResultsObserver

	{

public:

	static CFSEmailUiClsMatchObserver* CFSEmailUiClsMatchObserver::NewL( CRepository& aCr, 

				CFSEmailUiClsListsHandler& aListsHandler,

				CPSRequestHandler& aRequestHandler,

				CVPbkContactManager* aContactManager );

	static CFSEmailUiClsMatchObserver* CFSEmailUiClsMatchObserver::NewLC( CRepository& aCr, 

				CFSEmailUiClsListsHandler& aListsHandler,

				CPSRequestHandler& aRequestHandler,

				CVPbkContactManager* aContactManager);	

    /**

     * Destructor.

     *

     */  

  	 virtual ~CFSEmailUiClsMatchObserver();

 public: // New methods

   /**

    * Sets new search text and either starts a search or buffers the search 

    * request. 

    *

    * @param aText new search text.

    */

 	virtual void SearchMatchesL( const TDesC& aText );

   /**

    * Sets given input mode to current matcher. 

    *

    * @param aInputMode weather the predictive input mode is to be set on/off.

    *				If EQwerty, multitap mode is set. If EItut predictive mode is set.

    */

 	virtual void SetInputMode( TKeyboardModes aInputMode ); 

 public: // From MPsResultsObserver

	 virtual void HandlePsResultsUpdate(RPointerArray<CPsClientData>& searchResults,

	 		                                    RPointerArray<CPsPattern>& searchSeqs);

	 void HandlePsResultsUpdateL(RPointerArray<CPsClientData>& searchResults,

	          RPointerArray<CPsPattern>& searchSeqs );

	 virtual void HandlePsError(TInt aErrorCode);

	 virtual void CachingStatus(TCachingStatus& aStatus, TInt& aError);

 protected:

    /**

     * C++ default constructor.

     *

	 * @param aCR refenrence to aknfep cenrep

	 * @param aListsHandler reference to listshandler object.

	 * @param aContactListingService reference to contact listing service object who provides

	 *									matcher object for the MRU list

     *

     */

  	 CFSEmailUiClsMatchObserver( CRepository& aCr, 

  			 					CFSEmailUiClsListsHandler& aListsHandler,

  			 					CPSRequestHandler& aRequestHandler,

  			 					CVPbkContactManager* aContactManager );

	/**

	 * Returns wheather current input mode is predictive (EItut) or QWERTY. 

	 *

	 * @return TKeyboardModes EItut if predictive. EQwerty if anything else.

	 */

	virtual TKeyboardModes GetInputMode();

	void ConstructL();

 protected: // Functions from base classes

 private:

	/**

	 * Chech the status of PCS cache

	 * KErrNone, if Cache is OK. In progress = KErrNotReady, 

	 * not started = KErrNotFound, complete with errors = KErrCorrupt

	 */ 

	 TInt CheckCacheStatusL();

	   /**

	    * Takes a list of email entries linked like in the following example:

	    * "EMAILADDRESS \x001F EMAILADDRESS \x001F EMAILADDRESS" 

	    * Reads the consecutive entries and appends it to an array

	    *

	    * @param aEmail list of email entries linked by <SPACE><UnitSeparator><SPACE>

	    * @param aEmailFields array to which entries are appended

	    */

	 void ChopEmailEntriesList(TPtrC &aEmail, RArray<TPtrC> &aEmailFields);

 protected: // data

	// Pointer to Predictive contact search engine client

	CPSRequestHandler* iRequestHandler;	// owned

	// Pointer to Predictive contact search query object

	CPsQuery* iQuery;

	// Refenrence to AknFepCenRep

	CRepository&	iAknFepCenRep;    

    // Reference to lists handler

    CFSEmailUiClsListsHandler& iListHandler;

    // What input mode is currently in use. EItut or QWERTY

    TKeyboardModes iInputMode;

    CVPbkContactManager* iContactManager;

    };

#endif  // FREESTYLEEMAILUICLSMATCHOBSERVERINTERFACE_H

// End of File