--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/web_pub/browser_control_api/inc/BrCtlSpecialLoadObserver.h Mon Mar 30 12:54:55 2009 +0300
@@ -0,0 +1,145 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "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: Handle special load events such as network connection, deal with non-http or non-html requests
+*
+*/
+
+
+#ifndef BRCTLSPECIALLOADOBSERVER_H
+#define BRCTLSPECIALLOADOBSERVER_H
+
+// INCLUDES
+#include <e32std.h>
+#include <e32base.h>
+#include <apmstd.h>
+#include <ApEngineConsts.h>
+#include <badesca.h>
+
+// CONSTANTS
+
+// MACROS
+
+// DATA TYPES
+enum TBrCtlDownloadParam
+ {
+ EParamRequestUrl, ///< URL requested
+ EParamRealm, ///< Realm (if www)
+ EParamUsername, ///< User name (if www authentication)
+ EParamPassword, ///< Password (if www authentication)
+ EParamProxyRealm, ///< Realm in the case of proxy authentication
+ EParamProxyUsername, ///< User name (if proxy authentication)
+ EParamProxyPassword, ///< Password (if proxy authentication)
+ EParamRawRequestHeader, ///< Request header in the form: Header:Value
+ EParamReceivedContentType, ///< Type of content received
+ EParamExpectedContentType, ///< Type of content expected to appear in the markup <object> tag.
+ EParamTotalContentLength, ///< Expected length of the content
+ EParamReceivedContentLength, ///< Length of the content already received
+ EParamReceivedContent, ///< Body of the content received
+ EParamRawResponseHeader, ///< Response header in the form: Header: Value
+ EParamLocalFileName, ///< Name of the file containing the content to be downloaded
+ EParamCharset, ///< Character set of the content to be downloaded
+ EParamRefererHeader, ///< Referrer header used in the download request, if applicable
+ EParamTransactionId ///< Transaction ID
+ };
+
+// FUNCTION PROTOTYPES
+
+
+/**
+* The MBrCtlSpecialLoadObserver class handles special load events, such as
+* network connection, non-HTTP(S) load requests, and non-HTML responses.
+*
+* Usage:
+*
+* @code
+* #include <BrCtlSpecialLoadObserver.h>
+*
+*
+* @see S60 Platform: Browser Control API Developer's Guide Version 2.0
+* @lib BrowserEngine.lib
+* @file BrCtlSpecialLoadObserver.h
+* @endcode *
+*/
+class MBrCtlSpecialLoadObserver
+ {
+ public: // New functions
+ /**
+ * Request to create a network connection.
+ * @since 2.8
+ * @param aConnectionPtr Pointer to the network connection. It must
+ * be type casted to an integer. If NULL, the Proxy Filter creates
+ * a network connection automatically. It must be type casted to an integer.
+ * @param aSockSvrHandle A handle to the socket server.
+ * @param aNewConn A flag if a new connection was created. If the
+ * connection is not new, proxy filter optimization will not read
+ * the proxy again from CommsBd.
+ * ETrue if a new connection was created.
+ * EFalse if a previously created connection was used.
+ * @param aBearerType Bearer type of the new connection. For example, GPRS, WCDMA.
+ * TapBearerType is defined in ApEngineConsts.h.
+ * @return void
+ * @attention This function is called for every HTTP request for which
+ * the content was not found in the cache. This function is called
+ * whether or not a connection was established in a previous request.
+ * The host application determines whether to create a new connection
+ * or to use an existing connection.
+ */
+ virtual void NetworkConnectionNeededL(TInt* aConnectionPtr,
+ TInt* aSockSvrHandle,
+ TBool* aNewConn,
+ TApBearerType* aBearerType) = 0;
+
+ /**
+ * Requests the host application to handle non-HTTP requests. It is expected that the
+ * host application will call the Scheme Dispatcher to handle these requests.
+ * @since 2.8
+ * @param aTypeArray Array of request parameters. Examples: URL, referrer header
+ * @param aDesArray Array of values corresponding to the types in aTypeArray
+ * @return ETrue if the host application handles the scheme.
+ * EFalse if the host application cannot handle the scheme.
+ * @attention The browser checks the scheme to determine whether or
+ * not it is supported. The browser supports the following schemes:
+ * File scheme, HTTP scheme or HTTPS scheme
+ * If the URL contains a scheme that the browser does not
+ * support, such as RTSP, then the host application should pass the
+ * content to an application that can handle that scheme.
+ */
+ virtual TBool HandleRequestL(RArray<TUint>* aTypeArray, CDesCArrayFlat* aDesArray) = 0;
+
+ /**
+ * Request the host applicaion to handle downloads
+ * @since 2.8
+ * @param aTypeArray array of download parameter types
+ * @param aDesArray array of values associated with the types in the type array
+ * @return ETrue if handled by the host application
+ * EFalse if not handled by the host application
+ * @attention The host application should call the Download Manager to
+ * handle non-HTML content.
+ * Only GET requests are supported because the Browser Control must
+ * cancel the transaction before the Download Manager can take over.
+ * If a POST request is cancelled, the server may enter an unpredictable state.
+ * For POST requests, the Browser Control downloads the content before calling
+ * this function. It stores the content in a file whose name is passed to the
+ * host application by using the EParamLocalFileName parameter. The host
+ * application should check whether this parameter was passed by the
+ * Browser Control to determine whether the Browser Control already downloaded
+ * the content. If not, the host application should download the content.
+ */
+ virtual TBool HandleDownloadL(RArray<TUint>* aTypeArray, CDesCArrayFlat* aDesArray) = 0;
+
+ };
+
+#endif // BRCTLSPECIALLOADOBSERVER_H
+
+// End of File