williamr@2: // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: // Class for opening and manipulating the internet uri list.
williamr@2: // 
williamr@2: //
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  @file
williamr@2:  @publishedAll
williamr@2:  @released
williamr@2: */
williamr@2: 
williamr@2: #ifndef __INETURILIST_H__
williamr@2: #define __INETURILIST_H__
williamr@2: 
williamr@2: #include <ineturilistdef.h>
williamr@2: #include <ineturi.h>
williamr@2: #include <uri8.h>
williamr@2: #include <babitflags.h>
williamr@2: 
williamr@2: class CInetUriListImpl;
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: This class defines the interface that can be implemented by an application to receive the
williamr@2: query results. 
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: class MQueryResultsCallback
williamr@2: 	{
williamr@2: 	public:
williamr@2: 	/**
williamr@2: 	The callback function that will be called when there is at least one query result.
williamr@2: 	
williamr@2: 	@param aUri The Inet URI object. Ownership will be passed. The application should close the 
williamr@2: 				object handle.
williamr@2: 	@return ETrue - More query results, if any, should follow.
williamr@2: 			EFalse - No more query result is required and querying will be stopped.
williamr@2: 	*/
williamr@2: 	virtual TBool OnQueryResultsL ( RInetUri aUri ) =0;
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: This class defines the interface that can be implemented by an application that wishes to do
williamr@2: protocol and scheme-based normalisation of the URI before query operation.
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: class MUriCustomiser
williamr@2: 	{
williamr@2: 	public:
williamr@2: 	/**
williamr@2: 	The callback function that will be called to perform scheme and protocol-based normalisation.
williamr@2: 	The URI will be syntax normalised before calling this function.
williamr@2: 	
williamr@2: 	@param aUri The syntax normalised URI.
williamr@2: 	@return Final normalised URI, which is syntax and protocol/scheme based.
williamr@2: 	*/
williamr@2: 	virtual CUri8* OnUriCustomisationL ( const TUriC8& aUri ) =0;	
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: RInetUriList represents a handle to the list as a whole. Opening the handle will initiate a connection the
williamr@2: URI List server. This class is responsible for adding, removing, updating, or retrieving the URI and
williamr@2: its associated properties.
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: class RInetUriList
williamr@2: 	{
williamr@2: public:
williamr@2: 	IMPORT_C RInetUriList ();
williamr@2: 
williamr@2: 	IMPORT_C void OpenL ();
williamr@2: 	IMPORT_C void Close ();
williamr@2: 	
williamr@2: 	IMPORT_C void AddL ( const RInetUri& aInetUri );
williamr@2: 	IMPORT_C void RemoveL ( const RInetUri& aInetUri );
williamr@2: 	IMPORT_C void UpdateL ( const RInetUri& aInetUri );
williamr@2: 	
williamr@2: 	IMPORT_C RInetUri OpenInetUriL ( const TDesC8& aUri, InetUriList::TServiceType aServiceType );
williamr@2: 	IMPORT_C TInt Count ( InetUriList::TServiceType aServiceType, InetUriList::TListType aListType );
williamr@2: 	
williamr@2: 	IMPORT_C TInt GetListType ( const TDesC8& aUri, InetUriList::TServiceType aServiceType, InetUriList::TListType& aListType );
williamr@2: 	
williamr@2: 	IMPORT_C void QueryUriL ( const TQueryArgs& aArgs, MQueryResultsCallback* aQueryCallback, MUriCustomiser* aUriOptimiser =NULL );
williamr@2: private:
williamr@2: 	CInetUriListImpl* iInetUriListImpl; // // The internal list object that this handle is connected to
williamr@2: 	};
williamr@2: 
williamr@2: #endif //__INETURILIST_H__