/*

* 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:  Enum Definition of the Browser Control API

*

*/

#ifndef BRCTLDEFS_H

#define BRCTLDEFS_H

#include <browser_platform_variant.hrh>

//  INCLUDES

// DATA TYPES

// FORWARD DECLARATIONS

// EXPORTED FUNCTION

/**

* The TBrCtlDefs class contains definitions of custom data types for the Browser Control API.

*

* Usage:

*

* @code

*  #include <brctldefs.h>

*

* @see S60 Platform: Browser Control API Developer's Guide Version 2.0

* @lib BrowserEngine.lib

* @since 3.0

* @file brctldefs.h

* @endcode     *

*/

class TBrCtlDefs

    {

    public:

        /**

         * The Browser Control uses 600 command IDs, whose default

         * range is from 15000 - 15600. The host application can specify

         * any desired range through the API.

         */

        enum TBrCtlCommandId

            {

            ECommandIdBrowserBase = 0, ///< The base Browser ID.

            ECommandIdSubscribeToBase = 90, ///< The SubscribeToBase ID.

            ECommandIdPluginBase = 100, ///< The base plug-in ID.

            ECommandIdWMLBase = 300, ///< The base WML ID.

            ECommandIdRange = 600,   ///< The maximum number of command IDs.

            ECommandIdBase = 15000   ///< The base value for the command IDs.

            };

        /**

        * Rules that determine in which mode the cache operates.

        */

        enum TBrCtlCacheMode

            {

            /**

            * Normal caching operation.

            * If the requested entity is in the cache and it has not expired,

            * get it from the cache. If the requested entity is not in the cache,

            * or if it has expired, the browser should request it from the server.

            */

            ECacheModeNormal = 0,

            /**

            * If the requested entity is in the cache, get it from the cache

            * even if it has expired. If the requested entity is not in the cache,

            * the browser should request it from the server.

            */

            ECacheModeHistory,

            /**

            * The browser should request the content from the server even if it is in the cache.

            */

            ECacheModeNoCache,

            /**

            * If the requested entity is in the cache, get it from the cache

            * even if it has expired. If the requested entity is not in the cache,

            * return an error.

            */

            ECacheModeOnlyCache

            };

        /**

        * The host application can send these commands

        * to the Browser Control by calling the HandleCommandL function.

        * @attention The host application should define the base for the command

        * IDs and add that base to the enum value of each command.

        */

        enum TBrCtlCommands

            {

            ECommandDisconnect = 0, ///< Unloads the HTTP Framework

            ECommandCancelFetch, ///< Cancels all outstanding requests

            ECommandOpen, ///< Activates the focused element

            ECommandReload, ///< Reloads the current page

            ECommandBack, ///< Loads the previous page, if available

            /**

            * Loads the next page. This command is used only to return

            * to the next page after going back to a previous page.

            */

            ECommandForward,

            ECommandClearHistory, ///< Clears the history stack

            /**

            * Shows a list of history entries. Do not use this parameter if

            * LoadDataL or InitLoadDataL are used.

            */

            ECommandShowHistory,

            ECommandAccept, ///< Accepts the input data in the editor.

            /**

            * Cancels the input data in the editor. Sets the focus back

            * on the browser after the focus is shifted to a plug-in.

            */

            ECommandCancel,

            ECommandOpenToViewer, ///< Opens object data in an external viewer

            /**

            * Adds the contact information of the link currently selected to

            * the phone book

            */

            ECommandAddToPhoneBook,

            /**

            *Makes a phone call using the phone number in the link currently selected

            */

            ECommandMakeCall,

            ECommandRemoveFileName, ///< Removes the file name from a file selection box

            ECommandShowImages, ///< Shows a list of the images in the current page

            ECommandLoadImages, ///< Loads images when automatic image loading is turned off

            ECommandGainFocus, ///< Called when the Browser Control returns from background

            ECommandLoseFocus, ///< Called when the Browser Control goes to the background

            /**

            * Do not call this parameter. It is a base for the next three commands.

            */

            ECommandFindItem,

            /**

            * Displays the FindItem dialog and highlights all of the

            * phone numbers in the current page. Use this parameter only

            * if you specified the ECapabilityFindItem capability.

            */

            ECommandFindItemPhoneNumber,

            /**

            * Displays the FindItem dialog and highlights all of the e-mail

            * addresses in the current page. Use this parameter only if you

            * specified the ECapabilityFindItem capability.

            */

            ECommandFindItemEMail,

            /**

            * Displays the FindItem dialog and highlights all of the URLs in

            * the current page. Use this parameter only if you specified

            * the ECapabilityFindItem capability.

            */

            ECommandFindItemAddress,

            ECommandFindKeyword, ///< Reserved for future use.

            ECommandClearFind, ///< Reserved for future use.

            ECommandShowThumbnailView, ///< Reserved for future use.

            ECommandShowDownloads, ///< Tells the Download Manager to display the list of downloads.

            /**

            * Saves the following launch parameters when the application

            * unexpectedly shuts down. These parameters all have the prefix ESettingsLaunch:

            * AppUid, ViewId, CustomMessageId

            * When the phone reboots, it uses these parameters to restart

            * the host application and resume the interrupted downloads.

            * NOTE: These parameters must be set before calling this command.

            */

            ECommandSaveLaunchParams,

            ECommandOneStepBack, ///< Reserved for future use.

            ECommandAppForeground, ///<

            ECommandAppBackground, ///<

            ECommandOpenNewWindow, ///<

            ECommandClearAutoFormFillData, ///<

            ECommandClearAutoFormFillPasswordData, ///<

            ECommandFreeMemory, ///<

            ECommandMemoryGood, ///<

            ECommandDumpRenderTree, ///<

            ECommandUnloadWMLEngine, ///<

            ECommandSmartLinkMakeCall, ///<

            ECommandSmartLinkSendMessage, ///<

            ECommandSmartLinkAddToPhoneBook, ///<

            ECommandShowToolBar, ///<Shows the toolbar

            ECommandSmartLinkSendEmail, ///<

            ECommandShowAnchorHref,  ///<Display the URL of a hyperlink - supported only for HTML

            ECommandLoadFocusedImage, ///<Load the focuesd image - supported only for HTML

            ECommandUnLoadPluginWindows, ///<Unload plugin windows

            /**

            * Displays the FindItem dialog and highlights all of the VoIP

            * addresses in the current page. Use this parameter only if you

            * specified the ECapabilityFindItem capability.

            */

            ECommandFindItemVoIPAddress, ///<Find VoIP address item

            ECommandSmartLinkMakeVoipCall,   ///<MakeVoip Callthrough smartlink

            /**

            * Zoom Slider configuration.

            */

            ECommandZoomSliderShow, ///< Zoom slider visible.

            ECommandZoomSliderHide, ///< Zoom slider hidden.

            ECommandHistoryNavigateForward,

            ECommandHistoryNavigateBack,

            /*

             ** Enter/Exit Fullscreen Browsing

             */

             ECommandEnterFullscreenBrowsing,

             ECommandLeaveFullscreenBrowsing,

             ECommandZoomIn,

             ECommandZoomOut,

             ECommandRetryTransactions,

             ECommandSetRetryConnectivityFlag,

             ECommandUnSetRetryConnectivityFlag,

             ECommandClearQuedTransactions,

             ECommandConnToDownloadManager,

            /**

            * Pause/Resume Script Timers

            */

             ECommandPauseScriptTimers,

             ECommandResumeScriptTimers,

            };

        /**

        * The load event that occurred.

        */

        enum TBrCtlLoadEvent

            {

            EEventNone = 0,                     // Non event, Not used.

            /**

            * A page is beginning to load. This includes images, scripts,

            * style sheets, and anything else embedded in the page as a single load event.

            */

            EEventNewContentStart,

            /** A URL is beginning to load. This notifies the observer of a

            * separate load event for each image or other element embedded in the page.

            */

            EEventUrlLoadingStart,

            /**

            * The first data chunk has arrived. This occurs when the response

            * headers are received.

            */

            EEventNewUrlContentArrived,

            /**

            * Another data chunk has arrived.

            * This occurs for each chunk of data that is loaded, including the first chunk.

            */

            EEventMoreUrlContentArrived,

            /**

            * The first chunk of content is displayed. The previous page is

            * destroyed at this time. This occurs once per page.

            */

            EEventNewContentDisplayed,

            /**

            * Another chunk of content is displayed. This occurs for each

            * chunk of content that is displayed, except for the first chunk.

            */

            EEventMoreContentDisplayed,

            EEventUrlLoadingFinished,           ///< A URL has finished loading.

            /**

            * The page has finished loading. If the host application draws a

            * progress bar, it can be removed when this event is received.

            */

            EEventLoadFinished,

            EEventContentFinished,  ///< The content has finished loading.

            /**

            * A page title was encountered. After receiving this

            * event, the host application can call PageInfoLC to receive the page title.

            */

            EEventTitleAvailable,

            EEventLoadError,      ///< An error occurred while loading the page.

            /**

            * The user is navigating from a non-secure page to a secure page.

            * The host application displays a secure icon, if needed.

            */

            EEventEnteringSecurePage,

            /**

            * The user is navigating from a secure page to a non-secure page.

            * If the host application displays a secure icon, that icon should be removed.

            */

            EEventExitingSecurePage,

            /**

            * The user is entering a secure page that contains non-secure items.

            */

            EEventSomeItemsNotSecure,

            /**

            * The user is submitting information to a non-secure page.

            */

            EEventSubmittingToNonSecurePage,

            /**

            * User confirmation is required to redirect the browser.

            */

            EEventRedirectConfirmation,

            /**

            * User confirmation is required to repost a page that has been viewed previously.

            */

            EEventRepostConfirmation,

            /**

            * The user is entering a non-secure page that contains secure items.

            */

            EEventSecureItemInNonSecurePage,

            /**

            * Authentication failed or was cancelled.

            */

            EEventAuthenticationFailed,

            /**

            * A file is beginning to upload.

            */

            EEventUploadStart,

            /**

            * A file has finished uploading; the last chunk of data has been transmitted.

            */

            EEventUploadFinished,

            /**

            * Length of the data transmitted and the cumulative size of the uploaded file.

            */

            EEventUploadIncrement,

            EEventFaviconAvailable,

            EEventThumbnailAvailable

            };

        /**

        * The setting to manipulate.

        */

        enum TBrCtlSettings

            {

            ESettingsUnknown = -1, ///< Not used

            /**

            * If set to On, large pages are optimized for display on a small screen.

            * If set to Off, all pages display in their original format.

            */

            ESettingsSmallScreen = 0,

            /**

            * If set to On, images automatically load when a page is downloaded.

            * If set to Off, images are not loaded. Default: On

            */

            ESettingsAutoLoadImages,

            /**

            * If set to All.Large, all text is shown 40% larger than its declared size.

            * If set to Larger, all text is shown 20% larger than its declared size.

            * If set to Normal, all text is shown as its declared size.

            * If set to Smaller, all text is shown 20% smaller than its declared size.

            * If set to All.Small, all text is shown 40% smaller than its declared size.

            */

            ESettingsFontSize,

            /**

            * If set to On, the host application is embedded within another application.

            * If set to Off, the host application is not embedded within another application.

            */

            ESettingsEmbedded,

            /**

            * If set to On, paragraphs are automatically wrapped to fit into the display width.

            * If set to Off, paragraphs are not automatically wrapped.

            * @attention This parameter is not shown if ESettingsSmallScreen is set to On.

            */

            ESettingsTextWrapEnabled,

            /**

            * If set to Allow, the user can send and receive cookie information.

            * If set to Reject, the user cannot send or receive cookie information.

            */

            ESettingsCookiesEnabled,

            /**

            * If set to Finest, external style sheets are downloaded when

            * Small Screen Layout is used. If set to Fastest, external style

            * sheets are not downloaded when Small Screen Layout is used.

            * Default value: Fastest

            */

            ESettingsCSSFetchEnabled,

            /**

            * If set to Enable, ECMA Script is enabled.

            * If set to Disable, ECMA Script is disabled.

            * Default value: Enable

            */

            ESettingsECMAScriptEnabled,

            /**

            * Device unique identification number sent to a server for billing

            * purposes in e-commerce. If set to Enable, the Browser Control

            * sends the International Mobile Equipment Identity (IMEI) to the server.

            * If set to Disable, the Browser Control does not send the IMEI to the server.

            * Default value: Disable

            */

            ESettingsIMEINotifyEnabled,

            /**

            * Character coding. If set to Automatic, the character set is

            * automatically selected according to the following criteria, in order or priority:

            * 1. Detected from the Byte Order Mark (BOM)

            * 2. Detected from XML Document Type Definition (DTD)

            * 3. Declared in <meta> element

            * 4. Detected from HTTP headers

            * 5. Variant-specific default character set for automatic detection.

            * Possible character codings are:

            * Latin

            * Simplified Chinese

            * Traditional Chinese

            * Unicode (UTF-8)

            * Unicode (ucs-2)

            * ISO 8859 - 2,4,5,7,or 9

            * Hebrew (ISO-Logical)

            * Hebrew (ISO-Visual)

            * Hebrew (Windows)

            * Arabic (ISO)

            * Arabic (Windows)

            * Windows - 1250, 1251, 1253, 1254, or 1257

            * Thai

            * Thai (Windows 874)

            * Shift_jis

            * Euc-jp

            * ISO-2022-jp

            * The default value is variant-specific.

            */

            ESettingsCharacterset,

            /**

            * URL of the initial page. Tells the

            * Browser Control to send the referrer header in the request.

            */

            ESettingsSendRefererHeader,

            /**

            * One of the following:

            * Certificate not valid yet

            * Server certificate expired

            * Server certificate not received

            * Invalid server certificate

            * Authority certificate not valid yet

            * Authority certificate expired

            * Authority certificate not found

            * Authority certificate corrupted

            */

            ESettingsSecurityWarnings,

            /**

            * Default access point for the Browser Control to use when

            * connecting to the network.

            */

            ESettingsApId,

            ESettingsCurrentZoomLevelIndex, ///< Reserved for future use.

            ESettingsPageOverview,  ///< Reserved for future use.

            ESettingsNumOfDownloads, ///< Number of downloads in progress.

            /**

            * UID of the application to

            * restart after a reboot in order to continue an interrupted download.

            */

            ESettingsLaunchAppUid,

            /**

            * View ID of the application to

            * restart after a reboot in order to continue an interrupted download.

            */

            ESettingsLaunchViewId,

            /**

            * Message that asks the user whether to resume the download.

            */

            ESettingsLaunchCustomMessageId, ///< Reserved for future use.

            ESettingsBackList, ///< Reserved for future use.

            ESettingsAutoRefresh, ///< Reserved for future use.

            /**

            * If set, the browser encodes URLs using UTF-8 instead of

            * the original content encoding.

            * @attention This is recommended only for the APAC region.

            */

            ESettingsBrowserUtf8Encoding,

            ESettingsAutoFormFillEnabled, ///< For enabling the auto fill

            ESettingsSavedPage,           ///< Save the page

            ESettingsSmartLink,

            ESettingsAutoOpenDownloads, // For automatically open the downloaded files

            ESettingsDisableFlash, ///<Enable/Disable the flash

            ESettingsScriptLog,         /// script log

            /**

            * Toolbar buttons configuration settings

            */

            ESettingsToolbarOnOff,

            ESettingsToolbarButton1Cmd,

            ESettingsToolbarButton2Cmd,

            ESettingsToolbarButton3Cmd,

            ESettingsToolbarButton4Cmd,

            ESettingsToolbarButton5Cmd,

            ESettingsToolbarButton6Cmd,

            ESettingsToolbarButton7Cmd,

            /**

            * Browser Zoom level configuration settings

            */

            ESettingsZoomLevelMin,          ///< Minimum Zoom level supported

            ESettingsZoomLevelMax,          ///< Maximum Zoom level supported

            ESettingsZoomLevelDefault,      ///< Default Zoom level for new page

            /*

            * Browser cursor show mode -- some phone doesn't have cursor inside Browser

            */

            ESettingsCursorShowMode,

            /*

             * Enter key mode - default behavior is like in desktop browser - submit the form

             * The alternative is to select the link is one is activated.

             */

            ESettingsEnterKeyMode, 

            ESettingsMaxEnum              ///< Must be last one

            };

            /**

            * The size of the font selected.

            */

        enum TBrCtlFontSizeLevel

            {

            /**

            * Text is shown 40% smaller than its declared size.

            */

            EFontSizeLevelAllSmall = 0,

            /**

            * Text is shown 20% smaller than its declared size.

            */

            EFontSizeLevelSmaller,

            /**

            * Text is shown as its declared size.

            */

            EFontSizeLevelNormal,

            /**

            * Text is shown 20% larger than its declared size.

            */

            EFontSizeLevelLarger,

            /**

            * Text is shown 40% larger than its declared size.

            */

            EFontSizeLevelAllLarge

            };