epoc32/include/mw/brctldefs.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Enum Definition of the Browser Control API
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef BRCTLDEFS_H
williamr@2
    20
#define BRCTLDEFS_H
williamr@2
    21
williamr@2
    22
//  INCLUDES
williamr@2
    23
williamr@2
    24
// DATA TYPES
williamr@2
    25
williamr@2
    26
// FORWARD DECLARATIONS
williamr@2
    27
williamr@2
    28
// EXPORTED FUNCTION
williamr@2
    29
williamr@2
    30
/**
williamr@2
    31
* The TBrCtlDefs class contains definitions of custom data types for the Browser Control API.
williamr@2
    32
*
williamr@2
    33
* Usage:
williamr@2
    34
*
williamr@2
    35
* @code
williamr@4
    36
*  #include <brctldefs.h>
williamr@2
    37
*
williamr@2
    38
* @see S60 Platform: Browser Control API Developer's Guide Version 2.0
williamr@2
    39
* @lib BrowserEngine.lib
williamr@2
    40
* @since 3.0
williamr@4
    41
* @file brctldefs.h
williamr@2
    42
* @endcode     *
williamr@2
    43
*/
williamr@2
    44
class TBrCtlDefs
williamr@2
    45
    {
williamr@2
    46
    public:
williamr@2
    47
        /**
williamr@2
    48
         * The Browser Control uses 600 command IDs, whose default
williamr@2
    49
         * range is from 15000 - 15600. The host application can specify
williamr@2
    50
         * any desired range through the API.
williamr@2
    51
         */
williamr@2
    52
        enum TBrCtlCommandId
williamr@2
    53
            {
williamr@2
    54
            ECommandIdBrowserBase = 0, ///< The base Browser ID.
williamr@2
    55
            ECommandIdSubscribeToBase = 90, ///< The SubscribeToBase ID.
williamr@2
    56
            ECommandIdPluginBase = 100, ///< The base plug-in ID.
williamr@2
    57
            ECommandIdWMLBase = 300, ///< The base WML ID.
williamr@2
    58
            ECommandIdRange = 600,   ///< The maximum number of command IDs.
williamr@2
    59
            ECommandIdBase = 15000   ///< The base value for the command IDs.
williamr@2
    60
williamr@2
    61
            };
williamr@2
    62
        /**
williamr@2
    63
        * Rules that determine in which mode the cache operates.
williamr@2
    64
        */
williamr@2
    65
        enum TBrCtlCacheMode
williamr@2
    66
            {
williamr@2
    67
            /**
williamr@2
    68
            * Normal caching operation.
williamr@2
    69
            * If the requested entity is in the cache and it has not expired,
williamr@2
    70
            * get it from the cache. If the requested entity is not in the cache,
williamr@2
    71
            * or if it has expired, the browser should request it from the server.
williamr@2
    72
            */
williamr@2
    73
            ECacheModeNormal = 0,
williamr@2
    74
            /**
williamr@2
    75
            * If the requested entity is in the cache, get it from the cache
williamr@2
    76
            * even if it has expired. If the requested entity is not in the cache,
williamr@2
    77
            * the browser should request it from the server.
williamr@2
    78
            */
williamr@2
    79
            ECacheModeHistory,
williamr@2
    80
            /**
williamr@2
    81
            * The browser should request the content from the server even if it is in the cache.
williamr@2
    82
            */
williamr@2
    83
            ECacheModeNoCache,
williamr@2
    84
            /**
williamr@2
    85
            * If the requested entity is in the cache, get it from the cache
williamr@2
    86
            * even if it has expired. If the requested entity is not in the cache,
williamr@2
    87
            * return an error.
williamr@2
    88
            */
williamr@2
    89
            ECacheModeOnlyCache
williamr@2
    90
            };
williamr@2
    91
        /**
williamr@2
    92
        * The host application can send these commands
williamr@2
    93
        * to the Browser Control by calling the HandleCommandL function.
williamr@2
    94
        * @attention The host application should define the base for the command
williamr@2
    95
        * IDs and add that base to the enum value of each command.
williamr@2
    96
        */
williamr@2
    97
        enum TBrCtlCommands
williamr@2
    98
            {
williamr@2
    99
            ECommandDisconnect = 0, ///< Unloads the HTTP Framework
williamr@2
   100
            ECommandCancelFetch, ///< Cancels all outstanding requests
williamr@2
   101
            ECommandOpen, ///< Activates the focused element
williamr@2
   102
            ECommandReload, ///< Reloads the current page
williamr@2
   103
            ECommandBack, ///< Loads the previous page, if available
williamr@2
   104
            /**
williamr@2
   105
            * Loads the next page. This command is used only to return
williamr@2
   106
            * to the next page after going back to a previous page.
williamr@2
   107
            */
williamr@2
   108
            ECommandForward,
williamr@2
   109
            ECommandClearHistory, ///< Clears the history stack
williamr@2
   110
            /**
williamr@2
   111
            * Shows a list of history entries. Do not use this parameter if
williamr@2
   112
            * LoadDataL or InitLoadDataL are used.
williamr@2
   113
            */
williamr@2
   114
            ECommandShowHistory,
williamr@2
   115
            ECommandAccept, ///< Accepts the input data in the editor.
williamr@2
   116
            /**
williamr@2
   117
            * Cancels the input data in the editor. Sets the focus back
williamr@2
   118
            * on the browser after the focus is shifted to a plug-in.
williamr@2
   119
            */
williamr@2
   120
            ECommandCancel,
williamr@2
   121
            ECommandOpenToViewer, ///< Opens object data in an external viewer
williamr@2
   122
            /**
williamr@2
   123
            * Adds the contact information of the link currently selected to
williamr@2
   124
            * the phone book
williamr@2
   125
            */
williamr@2
   126
            ECommandAddToPhoneBook,
williamr@2
   127
            /**
williamr@2
   128
            *Makes a phone call using the phone number in the link currently selected
williamr@2
   129
            */
williamr@2
   130
            ECommandMakeCall,
williamr@2
   131
            ECommandRemoveFileName, ///< Removes the file name from a file selection box
williamr@2
   132
            ECommandShowImages, ///< Shows a list of the images in the current page
williamr@2
   133
            ECommandLoadImages, ///< Loads images when automatic image loading is turned off
williamr@2
   134
            ECommandGainFocus, ///< Called when the Browser Control returns from background
williamr@2
   135
            ECommandLoseFocus, ///< Called when the Browser Control goes to the background
williamr@2
   136
            /**
williamr@2
   137
            * Do not call this parameter. It is a base for the next three commands.
williamr@2
   138
            */
williamr@2
   139
            ECommandFindItem,
williamr@2
   140
            /**
williamr@2
   141
            * Displays the FindItem dialog and highlights all of the
williamr@2
   142
            * phone numbers in the current page. Use this parameter only
williamr@2
   143
            * if you specified the ECapabilityFindItem capability.
williamr@2
   144
            */
williamr@2
   145
            ECommandFindItemPhoneNumber,
williamr@2
   146
            /**
williamr@2
   147
            * Displays the FindItem dialog and highlights all of the e-mail
williamr@2
   148
            * addresses in the current page. Use this parameter only if you
williamr@2
   149
            * specified the ECapabilityFindItem capability.
williamr@2
   150
            */
williamr@2
   151
            ECommandFindItemEMail,
williamr@2
   152
            /**
williamr@2
   153
            * Displays the FindItem dialog and highlights all of the URLs in
williamr@2
   154
            * the current page. Use this parameter only if you specified
williamr@2
   155
            * the ECapabilityFindItem capability.
williamr@2
   156
            */
williamr@2
   157
            ECommandFindItemAddress,
williamr@2
   158
            ECommandFindKeyword, ///< Reserved for future use.
williamr@2
   159
            ECommandClearFind, ///< Reserved for future use.
williamr@2
   160
            ECommandShowThumbnailView, ///< Reserved for future use.
williamr@2
   161
            ECommandShowDownloads, ///< Tells the Download Manager to display the list of downloads.
williamr@2
   162
            /**
williamr@2
   163
            * Saves the following launch parameters when the application
williamr@2
   164
            * unexpectedly shuts down. These parameters all have the prefix ESettingsLaunch:
williamr@2
   165
            * AppUid, ViewId, CustomMessageId
williamr@2
   166
            * When the phone reboots, it uses these parameters to restart
williamr@2
   167
            * the host application and resume the interrupted downloads.
williamr@2
   168
            * NOTE: These parameters must be set before calling this command.
williamr@2
   169
            */
williamr@2
   170
            ECommandSaveLaunchParams,
williamr@2
   171
            ECommandOneStepBack, ///< Reserved for future use.
williamr@2
   172
            ECommandAppForeground, ///<
williamr@2
   173
            ECommandAppBackground, ///<
williamr@2
   174
            ECommandOpenNewWindow, ///<
williamr@2
   175
            ECommandClearAutoFormFillData, ///<
williamr@2
   176
            ECommandClearAutoFormFillPasswordData, ///<
williamr@2
   177
            ECommandFreeMemory, ///<
williamr@2
   178
            ECommandMemoryGood, ///<
williamr@2
   179
            ECommandDumpRenderTree, ///<
williamr@2
   180
            ECommandUnloadWMLEngine, ///<
williamr@2
   181
            ECommandSmartLinkMakeCall, ///<
williamr@2
   182
            ECommandSmartLinkSendMessage, ///<
williamr@2
   183
            ECommandSmartLinkAddToPhoneBook, ///<
williamr@2
   184
            ECommandShowToolBar, ///<Shows the toolbar
williamr@2
   185
            ECommandSmartLinkSendEmail, ///<
williamr@2
   186
            ECommandShowAnchorHref,  ///<Display the URL of a hyperlink - supported only for HTML
williamr@2
   187
            ECommandLoadFocusedImage, ///<Load the focuesd image - supported only for HTML
williamr@2
   188
            ECommandUnLoadPluginWindows, ///<Unload plugin windows
williamr@2
   189
            /**
williamr@2
   190
            * Displays the FindItem dialog and highlights all of the VoIP
williamr@2
   191
            * addresses in the current page. Use this parameter only if you
williamr@2
   192
            * specified the ECapabilityFindItem capability.
williamr@2
   193
            */
williamr@2
   194
            ECommandFindItemVoIPAddress, ///<Find VoIP address item
williamr@2
   195
            ECommandSmartLinkMakeVoipCall,   ///<MakeVoip Callthrough smartlink
williamr@2
   196
            /**
williamr@2
   197
            * Zoom Slider configuration.
williamr@2
   198
            */
williamr@2
   199
            ECommandZoomSliderShow, ///< Zoom slider visible.
williamr@2
   200
            ECommandZoomSliderHide, ///< Zoom slider hidden.
williamr@2
   201
            ECommandHistoryNavigateForward,
williamr@2
   202
            ECommandHistoryNavigateBack,
williamr@2
   203
            /*
williamr@2
   204
             ** Enter/Exit Fullscreen Browsing
williamr@2
   205
             */
williamr@2
   206
             ECommandEnterFullscreenBrowsing,
williamr@2
   207
             ECommandLeaveFullscreenBrowsing,
williamr@2
   208
             ECommandZoomIn,
williamr@2
   209
             ECommandZoomOut
williamr@2
   210
            };
williamr@2
   211
        /**
williamr@2
   212
        * The load event that occurred.
williamr@2
   213
        */
williamr@2
   214
        enum TBrCtlLoadEvent
williamr@2
   215
            {
williamr@2
   216
            EEventNone = 0,                     // Non event, Not used.
williamr@2
   217
            /**
williamr@2
   218
            * A page is beginning to load. This includes images, scripts,
williamr@2
   219
            * style sheets, and anything else embedded in the page as a single load event.
williamr@2
   220
            */
williamr@2
   221
            EEventNewContentStart,
williamr@2
   222
            /** A URL is beginning to load. This notifies the observer of a
williamr@2
   223
            * separate load event for each image or other element embedded in the page.
williamr@2
   224
            */
williamr@2
   225
            EEventUrlLoadingStart,
williamr@2
   226
            /**
williamr@2
   227
            * The first data chunk has arrived. This occurs when the response
williamr@2
   228
            * headers are received.
williamr@2
   229
            */
williamr@2
   230
            EEventNewUrlContentArrived,
williamr@2
   231
            /**
williamr@2
   232
            * Another data chunk has arrived.
williamr@2
   233
            * This occurs for each chunk of data that is loaded, including the first chunk.
williamr@2
   234
            */
williamr@2
   235
            EEventMoreUrlContentArrived,
williamr@2
   236
            /**
williamr@2
   237
            * The first chunk of content is displayed. The previous page is
williamr@2
   238
            * destroyed at this time. This occurs once per page.
williamr@2
   239
            */
williamr@2
   240
            EEventNewContentDisplayed,
williamr@2
   241
            /**
williamr@2
   242
            * Another chunk of content is displayed. This occurs for each
williamr@2
   243
            * chunk of content that is displayed, except for the first chunk.
williamr@2
   244
            */
williamr@2
   245
            EEventMoreContentDisplayed,
williamr@2
   246
            EEventUrlLoadingFinished,           ///< A URL has finished loading.
williamr@2
   247
            /**
williamr@2
   248
            * The page has finished loading. If the host application draws a
williamr@2
   249
            * progress bar, it can be removed when this event is received.
williamr@2
   250
            */
williamr@2
   251
            EEventLoadFinished,
williamr@2
   252
            EEventContentFinished,  ///< The content has finished loading.
williamr@2
   253
            /**
williamr@2
   254
            * A page title was encountered. After receiving this
williamr@2
   255
            * event, the host application can call PageInfoLC to receive the page title.
williamr@2
   256
            */
williamr@2
   257
            EEventTitleAvailable,
williamr@2
   258
            EEventLoadError,      ///< An error occurred while loading the page.
williamr@2
   259
            /**
williamr@2
   260
            * The user is navigating from a non-secure page to a secure page.
williamr@2
   261
            * The host application displays a secure icon, if needed.
williamr@2
   262
            */
williamr@2
   263
            EEventEnteringSecurePage,
williamr@2
   264
            /**
williamr@2
   265
            * The user is navigating from a secure page to a non-secure page.
williamr@2
   266
            * If the host application displays a secure icon, that icon should be removed.
williamr@2
   267
            */
williamr@2
   268
            EEventExitingSecurePage,
williamr@2
   269
            /**
williamr@2
   270
            * The user is entering a secure page that contains non-secure items.
williamr@2
   271
            */
williamr@2
   272
            EEventSomeItemsNotSecure,
williamr@2
   273
            /**
williamr@2
   274
            * The user is submitting information to a non-secure page.
williamr@2
   275
            */
williamr@2
   276
            EEventSubmittingToNonSecurePage,
williamr@2
   277
            /**
williamr@2
   278
            * User confirmation is required to redirect the browser.
williamr@2
   279
            */
williamr@2
   280
            EEventRedirectConfirmation,
williamr@2
   281
            /**
williamr@2
   282
            * User confirmation is required to repost a page that has been viewed previously.
williamr@2
   283
            */
williamr@2
   284
            EEventRepostConfirmation,
williamr@2
   285
            /**
williamr@2
   286
            * The user is entering a non-secure page that contains secure items.
williamr@2
   287
            */
williamr@2
   288
            EEventSecureItemInNonSecurePage,
williamr@2
   289
            /**
williamr@2
   290
            * Authentication failed or was cancelled.
williamr@2
   291
            */
williamr@2
   292
            EEventAuthenticationFailed,
williamr@2
   293
            /**
williamr@2
   294
            * A file is beginning to upload.
williamr@2
   295
            */
williamr@2
   296
            EEventUploadStart,
williamr@2
   297
            /**
williamr@2
   298
            * A file has finished uploading; the last chunk of data has been transmitted.
williamr@2
   299
            */
williamr@2
   300
            EEventUploadFinished,
williamr@2
   301
            /**
williamr@2
   302
            * Length of the data transmitted and the cumulative size of the uploaded file.
williamr@2
   303
            */
williamr@2
   304
            EEventUploadIncrement,
williamr@2
   305
            EEventFaviconAvailable,
williamr@2
   306
            EEventThumbnailAvailable
williamr@2
   307
            };
williamr@2
   308
        /**
williamr@2
   309
        * The setting to manipulate.
williamr@2
   310
        */
williamr@2
   311
williamr@2
   312
        enum TBrCtlSettings
williamr@2
   313
            {
williamr@2
   314
            ESettingsUnknown = -1, ///< Not used
williamr@2
   315
            /**
williamr@2
   316
            * If set to On, large pages are optimized for display on a small screen.
williamr@2
   317
            * If set to Off, all pages display in their original format.
williamr@2
   318
            */
williamr@2
   319
            ESettingsSmallScreen = 0,
williamr@2
   320
            /**
williamr@2
   321
            * If set to On, images automatically load when a page is downloaded.
williamr@2
   322
            * If set to Off, images are not loaded. Default: On
williamr@2
   323
            */
williamr@2
   324
            ESettingsAutoLoadImages,
williamr@2
   325
            /**
williamr@2
   326
            * If set to All.Large, all text is shown 40% larger than its declared size.
williamr@2
   327
            * If set to Larger, all text is shown 20% larger than its declared size.
williamr@2
   328
            * If set to Normal, all text is shown as its declared size.
williamr@2
   329
            * If set to Smaller, all text is shown 20% smaller than its declared size.
williamr@2
   330
            * If set to All.Small, all text is shown 40% smaller than its declared size.
williamr@2
   331
            */
williamr@2
   332
            ESettingsFontSize,
williamr@2
   333
            /**
williamr@2
   334
            * If set to On, the host application is embedded within another application.
williamr@2
   335
            * If set to Off, the host application is not embedded within another application.
williamr@2
   336
            */
williamr@2
   337
            ESettingsEmbedded,
williamr@2
   338
            /**
williamr@2
   339
            * If set to On, paragraphs are automatically wrapped to fit into the display width.
williamr@2
   340
            * If set to Off, paragraphs are not automatically wrapped.
williamr@2
   341
            * @attention This parameter is not shown if ESettingsSmallScreen is set to On.
williamr@2
   342
            */
williamr@2
   343
            ESettingsTextWrapEnabled,
williamr@2
   344
            /**
williamr@2
   345
            * If set to Allow, the user can send and receive cookie information.
williamr@2
   346
            * If set to Reject, the user cannot send or receive cookie information.
williamr@2
   347
            */
williamr@2
   348
            ESettingsCookiesEnabled,
williamr@2
   349
            /**
williamr@2
   350
            * If set to Finest, external style sheets are downloaded when
williamr@2
   351
            * Small Screen Layout is used. If set to Fastest, external style
williamr@2
   352
            * sheets are not downloaded when Small Screen Layout is used.
williamr@2
   353
            * Default value: Fastest
williamr@2
   354
            */
williamr@2
   355
            ESettingsCSSFetchEnabled,
williamr@2
   356
            /**
williamr@2
   357
            * If set to Enable, ECMA Script is enabled.
williamr@2
   358
            * If set to Disable, ECMA Script is disabled.
williamr@2
   359
            * Default value: Enable
williamr@2
   360
            */
williamr@2
   361
            ESettingsECMAScriptEnabled,
williamr@2
   362
            /**
williamr@2
   363
            * Device unique identification number sent to a server for billing
williamr@2
   364
            * purposes in e-commerce. If set to Enable, the Browser Control
williamr@2
   365
            * sends the International Mobile Equipment Identity (IMEI) to the server.
williamr@2
   366
            * If set to Disable, the Browser Control does not send the IMEI to the server.
williamr@2
   367
            * Default value: Disable
williamr@2
   368
            */
williamr@2
   369
            ESettingsIMEINotifyEnabled,
williamr@2
   370
            /**
williamr@2
   371
            * Character coding. If set to Automatic, the character set is
williamr@2
   372
            * automatically selected according to the following criteria, in order or priority:
williamr@2
   373
            * 1. Detected from the Byte Order Mark (BOM)
williamr@2
   374
            * 2. Detected from XML Document Type Definition (DTD)
williamr@2
   375
            * 3. Declared in <meta> element
williamr@2
   376
            * 4. Detected from HTTP headers
williamr@2
   377
            * 5. Variant-specific default character set for automatic detection.
williamr@2
   378
            * Possible character codings are:
williamr@2
   379
            * Latin
williamr@2
   380
            * Simplified Chinese
williamr@2
   381
            * Traditional Chinese
williamr@2
   382
            * Unicode (UTF-8)
williamr@2
   383
            * Unicode (ucs-2)
williamr@2
   384
            * ISO 8859 - 2,4,5,7,or 9
williamr@2
   385
            * Hebrew (ISO-Logical)
williamr@2
   386
            * Hebrew (ISO-Visual)
williamr@2
   387
            * Hebrew (Windows)
williamr@2
   388
            * Arabic (ISO)
williamr@2
   389
            * Arabic (Windows)
williamr@2
   390
            * Windows - 1250, 1251, 1253, 1254, or 1257
williamr@2
   391
            * Thai
williamr@2
   392
            * Thai (Windows 874)
williamr@2
   393
            * Shift_jis
williamr@2
   394
            * Euc-jp
williamr@2
   395
            * ISO-2022-jp
williamr@2
   396
            * The default value is variant-specific.
williamr@2
   397
            */
williamr@2
   398
            ESettingsCharacterset,
williamr@2
   399
            /**
williamr@2
   400
            * URL of the initial page. Tells the
williamr@2
   401
            * Browser Control to send the referrer header in the request.
williamr@2
   402
            */
williamr@2
   403
            ESettingsSendRefererHeader,
williamr@2
   404
            /**
williamr@2
   405
            * One of the following:
williamr@2
   406
            * Certificate not valid yet
williamr@2
   407
            * Server certificate expired
williamr@2
   408
            * Server certificate not received
williamr@2
   409
            * Invalid server certificate
williamr@2
   410
            * Authority certificate not valid yet
williamr@2
   411
            * Authority certificate expired
williamr@2
   412
            * Authority certificate not found
williamr@2
   413
            * Authority certificate corrupted
williamr@2
   414
            */
williamr@2
   415
            ESettingsSecurityWarnings,
williamr@2
   416
            /**
williamr@2
   417
            * Default access point for the Browser Control to use when
williamr@2
   418
            * connecting to the network.
williamr@2
   419
            */
williamr@2
   420
            ESettingsApId,
williamr@2
   421
            ESettingsCurrentZoomLevelIndex, ///< Reserved for future use.
williamr@2
   422
            ESettingsPageOverview,  ///< Reserved for future use.
williamr@2
   423
            ESettingsNumOfDownloads, ///< Number of downloads in progress.
williamr@2
   424
            /**
williamr@2
   425
            * UID of the application to
williamr@2
   426
            * restart after a reboot in order to continue an interrupted download.
williamr@2
   427
            */
williamr@2
   428
            ESettingsLaunchAppUid,
williamr@2
   429
            /**
williamr@2
   430
            * View ID of the application to
williamr@2
   431
            * restart after a reboot in order to continue an interrupted download.
williamr@2
   432
            */
williamr@2
   433
            ESettingsLaunchViewId,
williamr@2
   434
            /**
williamr@2
   435
            * Message that asks the user whether to resume the download.
williamr@2
   436
            */
williamr@2
   437
            ESettingsLaunchCustomMessageId, ///< Reserved for future use.
williamr@2
   438
            ESettingsBackList, ///< Reserved for future use.
williamr@2
   439
            ESettingsAutoRefresh, ///< Reserved for future use.
williamr@2
   440
            /**
williamr@2
   441
            * If set, the browser encodes URLs using UTF-8 instead of
williamr@2
   442
            * the original content encoding.
williamr@2
   443
            * @attention This is recommended only for the APAC region.
williamr@2
   444
            */
williamr@2
   445
            ESettingsBrowserUtf8Encoding,
williamr@2
   446
            ESettingsAutoFormFillEnabled, ///< For enabling the auto fill
williamr@2
   447
            ESettingsSavedPage,           ///< Save the page
williamr@2
   448
            ESettingsSmartLink,
williamr@2
   449
            ESettingsAutoOpenDownloads, // For automatically open the downloaded files
williamr@2
   450
            ESettingsDisableFlash, ///<Enable/Disable the flash
williamr@2
   451
            ESettingsScriptLog,         /// script log
williamr@2
   452
            /**
williamr@2
   453
            * Toolbar buttons configuration settings
williamr@2
   454
            */
williamr@2
   455
            ESettingsToolbarOnOff,
williamr@2
   456
            ESettingsToolbarButton1Cmd,
williamr@2
   457
            ESettingsToolbarButton2Cmd,
williamr@2
   458
            ESettingsToolbarButton3Cmd,
williamr@2
   459
            ESettingsToolbarButton4Cmd,
williamr@2
   460
            ESettingsToolbarButton5Cmd,
williamr@2
   461
            ESettingsToolbarButton6Cmd,
williamr@2
   462
            ESettingsToolbarButton7Cmd,
williamr@2
   463
            /**
williamr@2
   464
            * Browser Zoom level configuration settings
williamr@2
   465
            */
williamr@2
   466
            ESettingsZoomLevelMin,          ///< Minimum Zoom level supported
williamr@2
   467
            ESettingsZoomLevelMax,          ///< Maximum Zoom level supported
williamr@2
   468
            ESettingsZoomLevelDefault,      ///< Default Zoom level for new page
williamr@4
   469
            /*
williamr@4
   470
            * Browser cursor show mode -- some phone doesn't have cursor inside Browser
williamr@4
   471
            */
williamr@4
   472
            ESettingsCursorShowMode,
williamr@4
   473
            
williamr@4
   474
            /*
williamr@4
   475
             * Enter key mode - default behavior is like in desktop browser - submit the form
williamr@4
   476
             * The alternative is to select the link is one is activated.
williamr@4
   477
             */
williamr@4
   478
            ESettingsEnterKeyMode, 
williamr@4
   479
            
williamr@2
   480
            ESettingsMaxEnum              ///< Must be last one
williamr@2
   481
            };
williamr@2
   482
williamr@2
   483
            /**
williamr@2
   484
            * The size of the font selected.
williamr@2
   485
            */
williamr@2
   486
        enum TBrCtlFontSizeLevel
williamr@2
   487
            {
williamr@2
   488
            /**
williamr@2
   489
            * Text is shown 40% smaller than its declared size.
williamr@2
   490
            */
williamr@2
   491
            EFontSizeLevelAllSmall = 0,
williamr@2
   492
            /**
williamr@2
   493
            * Text is shown 20% smaller than its declared size.
williamr@2
   494
            */
williamr@2
   495
            EFontSizeLevelSmaller,
williamr@2
   496
            /**
williamr@2
   497
            * Text is shown as its declared size.
williamr@2
   498
            */
williamr@2
   499
            EFontSizeLevelNormal,
williamr@2
   500
            /**
williamr@2
   501
            * Text is shown 20% larger than its declared size.
williamr@2
   502
            */
williamr@2
   503
            EFontSizeLevelLarger,
williamr@2
   504
            /**
williamr@2
   505
            * Text is shown 40% larger than its declared size.
williamr@2
   506
            */
williamr@2
   507
            EFontSizeLevelAllLarge
williamr@2
   508
            };
williamr@2
   509
        /**
williamr@2
   510
        * Configuration options for the Browser Control
williamr@2
   511
        */
williamr@2
   512
        enum TBrCtlCapabilities
williamr@2
   513
            {
williamr@2
   514
            /**
williamr@2
   515
            * Displays horizontal and vertical scroll bars.
williamr@2
   516
            */
williamr@2
   517
            ECapabilityDisplayScrollBar         = 0x0001,
williamr@2
   518
            /**
williamr@2
   519
            * Sends request to load embedded content to the host application.
williamr@2
   520
            * The host application indicates whether or not the load request
williamr@2
   521
            * should proceed.
williamr@2
   522
            */
williamr@2
   523
            ECapabilityClientResolveEmbeddedURL = 0x0002,
williamr@2
   524
            /**
williamr@2
   525
            * Sends request to load a URL to the host application.
williamr@2
   526
            * The host application indicates whether or not the load
williamr@2
   527
            * request should proceed.
williamr@2
   528
            */
williamr@2
   529
            ECapabilityClientNotifyURL          = 0x0004,
williamr@2
   530
            /**
williamr@2
   531
            * Disables input boxes and Netscape plug-ins.
williamr@2
   532
            */
williamr@2
   533
            ECapabilityDisableInputAndPlugins   = 0x0008,
williamr@2
   534
            /**
williamr@2
   535
            * Adds Find Item to the Options menu.
williamr@2
   536
            */
williamr@2
   537
            ECapabilityFindItem                 = 0x0010,
williamr@2
   538
            /**
williamr@2
   539
            * Allows network access for HTTP requests.
williamr@2
   540
            * If this option is not set, HTTP requests will fail.
williamr@2
   541
            */
williamr@2
   542
            ECapabilityLoadHttpFw               = 0x0020,
williamr@2
   543
            /**
williamr@2
   544
            * Employs the Download Manager to download content, such as audio or video files.
williamr@2
   545
            */
williamr@2
   546
            ECapabilityUseDlMgr                 = 0x0040,
williamr@2
   547
            /**
williamr@2
   548
            * Launches a viewer application to view the downloaded content.
williamr@2
   549
            */
williamr@2
   550
            ECapabilityLaunchViewer             = 0x0080,
williamr@2
   551
            ECapabilityGraphicalHistory     = 0x0100, ///< Reserved for future use.
williamr@2
   552
            ECapabilitySavedPage        = 0x0200,  ///< Reserved for future use.
williamr@2
   553
            ECapabilityConfirmDownloads = 0x0400, ///< Enables confirmation dialog in the Download Manager.
williamr@2
   554
            ECapabilityAutoFormFill     = 0x0800,
williamr@2
   555
            ECapabilityCursorNavigation = 0x1000,
williamr@2
   556
            ECapabilityGraphicalPage    = 0x2000,
williamr@2
   557
            ECapabilityAccessKeys       = 0x4000,
williamr@2
   558
            ECapabilityFavicon          = 0x8000,
williamr@2
   559
            ECapabilityToolBar          = 0x00010000,
williamr@2
   560
            ECapabilityWebKitLite       = 0x00020000,
williamr@2
   561
            ECapabilityFitToScreen      = 0x00040000
williamr@2
   562
            };
williamr@2
   563
williamr@2
   564
        /**
williamr@2
   565
        * Gets the requested page information.
williamr@2
   566
        */
williamr@2
   567
        enum TBrCtlPageInfo
williamr@2
   568
            {
williamr@2
   569
            EPageInfoTitle = 0, ///< Page title, if a title was specified
williamr@2
   570
            EPageInfoUrl,    ///< URL of the current page
williamr@2
   571
            EPageInfoContent, ///< Page content as a text buffer
williamr@2
   572
            EPageInfoSavedPage, ///< Page content, including all embedded content, as a buffer
williamr@2
   573
            EPageInfoFocusedNodeUrl //< URL of the focused link. The function leaves if the focus is not on an anchor or imagemap
williamr@2
   574
            };
williamr@2
   575
        /**
williamr@2
   576
        * Indicates whether the browser is in Image Map view.
williamr@2
   577
        */
williamr@2
   578
        enum TBrCtlState
williamr@2
   579
            {
williamr@2
   580
            /**
williamr@2
   581
            * Currently, the
williamr@2
   582
            * only state change that can be observed is in and out of Image Map view.
williamr@2
   583
            */
williamr@2
   584
            EStateImageMapView = 0,
williamr@2
   585
            EStateHistoryView, ///< For future use
williamr@2
   586
            EStateThumbnailView, ///< For future use
williamr@2
   587
            EStateWmlView,        ///< For WML view
williamr@2
   588
            EStateSmartTextView,   ///< For Smart text recognition mode
williamr@2
   589
            EStateToolBarMode,      ///< For toolbar
williamr@2
   590
            EStatePluginPlayer,
williamr@2
   591
            EStateScriptLog,
williamr@2
   592
            EStateZoomSliderMode,    ///< For ZoomSlider
williamr@2
   593
            EStateFullscreenBrowsing,    ///< For entering/escaping fullscreen browsing
williamr@2
   594
            EStateHistoryBeginning,
williamr@2
   595
            EStateHistoryEnd,
williamr@2
   596
            EStateSynchRequestMode,  ///< For synchronous (XHR) requests
williamr@2
   597
            EStatePluginFullScreen
williamr@2
   598
            };
williamr@2
   599
        /**
williamr@2
   600
        * Type of the focused element.
williamr@2
   601
        */
williamr@2
   602
        enum TBrCtlElementType
williamr@2
   603
            {
williamr@2
   604
            EElementNone = 0, ///< No element is present.
williamr@2
   605
            EElementImageBox, ///< Box containing an image.
williamr@2
   606
            /**
williamr@2
   607
            * Element used to create either of the following:
williamr@2
   608
            * A link to another document
williamr@2
   609
            * A bookmark within a document
williamr@2
   610
            */
williamr@2
   611
            EElementAnchor,
williamr@2
   612
            EElementTelAnchor, ///< Anchor with a "tel:" scheme
williamr@2
   613
            EElementMailtoAnchor, ///< Anchor with a "mailto:" scheme
williamr@2
   614
            EElementInputBox, ///< Input box that can be selected and activated.
williamr@2
   615
            EElementActivatedInputBox, ///< Input box that contains an entry field into which the user can type.
williamr@2
   616
            /**
williamr@2
   617
            * Box that contains a list of items. The user
williamr@2
   618
            * can select one of the items by clicking it.
williamr@2
   619
            */
williamr@2
   620
            EElementSelectBox,
williamr@2
   621
            /**
williamr@2
   622
            * Push button that can contain text or images. For example, Submit.
williamr@2
   623
            */
williamr@2
   624
            EElementButton,
williamr@2
   625
            EElementTextAreaBox, ///< Input box that contains more than one line.
williamr@2
   626
            EElementRootBox, ///< Root of the document.
williamr@2
   627
            EElementObjectBox, ///< Placeholder for a plug-in that has not yet been downloaded.
williamr@2
   628
            /**
williamr@2
   629
            * Box containing a plug-in that the user can
williamr@2
   630
            * manipulate; for example, by navigating links.
williamr@2
   631
            */
williamr@2
   632
            EElementActivatedObjectBox,
williamr@2
   633
            EElementDownloadedObjectBox, ///< Plug-in that is present but is not being manipulated.
williamr@2
   634
            EElementFileSelectionBoxNoContent, ///< File-browsing box in which no file is selected.
williamr@2
   635
            EElementFileSelectionBoxWithContent, ///< File-browsing box in which a file was selected previously.
williamr@2
   636
            EElementAreaBox, ///< Image map.
williamr@2
   637
            EElementCheckBoxChecked, ///< A check box that was selected.
williamr@2
   638
            EElementCheckBoxUnChecked, ///< A check box that was not selected.
williamr@2
   639
            EElementRadioButtonSelected, ///< A radio button that was selected.
williamr@2
   640
            EElementRadioButtonUnSelected, ///< A radio button that was not selected.
williamr@2
   641
williamr@2
   642
            EElementMouseButtonListener, ///< A Mouse button listener
williamr@2
   643
            EElementScrollBar,    ///< A scroll bar
williamr@2
   644
williamr@2
   645
            EElementSmartLinkTel, ///< A telephone number in the page.
williamr@2
   646
            EElementSmartLinkEmail, ///< an email address in the page.
williamr@2
   647
            EElementBrokenImage, ///< A missing image
williamr@2
   648
            EElementSmartLinkVoip, ///< A voip smartlink
williamr@2
   649
            EElementSelectMultiBox ///< A select box with multiple select
williamr@2
   650
        };
williamr@2
   651
williamr@2
   652
        /**
williamr@2
   653
        * Identifies the navigation direction
williamr@2
   654
        */
williamr@2
   655
        enum TBrCtlNavigationDirection
williamr@2
   656
            {
williamr@2
   657
            ENavigationBack, ///< Navigate to the previous page
williamr@2
   658
            ENavigationForward ///< Navigate to the next page
williamr@2
   659
            };
williamr@2
   660
williamr@2
   661
       /**
williamr@2
   662
        * Returns information about the version of the Browser Control.
williamr@2
   663
        */
williamr@2
   664
        enum TBrCtlVersionInfo
williamr@2
   665
          {
williamr@2
   666
          EVersionInfoName = 0, ///< Name of the Browser Control
williamr@2
   667
          EVersionInfoVersion,  ///< Version of the Browser Control
williamr@2
   668
          EVersionInfoBuild,    ///< Build of the Browser Control
williamr@2
   669
          EBrowserVersion   ///< Browser Version
williamr@2
   670
          };
williamr@2
   671
williamr@2
   672
        /**
williamr@2
   673
        * Returns information about the version of the Browser Control.
williamr@2
   674
        */
williamr@2
   675
        enum TBrCtlParams
williamr@2
   676
            {
williamr@2
   677
            EParamsUnknown = -1, ///< Not used
williamr@2
   678
            /**
williamr@2
   679
            * List of content types that do not use the Download Manager
williamr@2
   680
            */
williamr@2
   681
            EParamsSelfDownoadableTypes = 0,
williamr@2
   682
            /**
williamr@2
   683
            * List of headers that the Browser Control should add to each request
williamr@2
   684
            */
williamr@2
   685
            EParamsRequestHeaders,
williamr@2
   686
            EParamsMax ///< Not used
williamr@2
   687
            };
williamr@2
   688
williamr@2
   689
        /**
williamr@2
   690
        * Reserved for future use
williamr@2
   691
        */
williamr@2
   692
    enum TBrCtlFindResponse
williamr@2
   693
      {
williamr@2
   694
      EFindNoMatches = 0, ///< Reserved for future use
williamr@2
   695
      EFindWrapAround,    ///< Reserved for future use
williamr@2
   696
      EFindAllMatches,    ///< Reserved for future use
williamr@2
   697
      EFindMatch          ///< Reserved for future use
williamr@2
   698
      };
williamr@2
   699
williamr@2
   700
    /**
williamr@2
   701
    * Specifies the type of method to call to fetch a URL.
williamr@2
   702
    * The MbrCtlWindowObserver employs this method.
williamr@2
   703
    */
williamr@2
   704
        enum TBrCtlMethod
williamr@2
   705
            {
williamr@2
   706
            /**
williamr@2
   707
            * Get method should be used to fetch content from a URL
williamr@2
   708
            */
williamr@2
   709
            EMethodGet,
williamr@2
   710
            /**
williamr@2
   711
            * POST method should be used to fetch content from a URL
williamr@2
   712
            */
williamr@2
   713
            EMethodPost
williamr@2
   714
            };
williamr@2
   715
     /**
williamr@2
   716
     * Commands sent by the host application
williamr@2
   717
     * to the Browser Control by calling the HandleDownloadCommandL function.
williamr@2
   718
     */
williamr@2
   719
      enum TBrCtlDownloadCmd
williamr@2
   720
      {
williamr@2
   721
      /**
williamr@2
   722
      * Pauses the download identified
williamr@2
   723
      * by the aTransId parameter of the HandleDownloadCommandL function.
williamr@2
   724
      */
williamr@2
   725
      EDownloadCmdPause,
williamr@2
   726
      /**
williamr@2
   727
      * Resumes the download identified by
williamr@2
   728
      * the aTransId parameter of the HandleDownloadCommandL function.
williamr@2
   729
      */
williamr@2
   730
      EDownloadCmdResume,
williamr@2
   731
      /**
williamr@2
   732
      * Cancels the download identified by the
williamr@2
   733
      * aTransId parameter of the HandleDownloadCommandL function.
williamr@2
   734
      */
williamr@2
   735
      EDownloadCmdCancel,
williamr@2
   736
      /**
williamr@2
   737
      * Notifies the Download Manager that the download is progressive.
williamr@2
   738
      * This means that the file can be played while the download is in progress.
williamr@2
   739
      */
williamr@2
   740
      EDownloadCmdMarkAsProgressive,
williamr@2
   741
      /**
williamr@2
   742
      * Notifies the Download Manager that the download is not progressive.
williamr@2
   743
      * This means that the file cannot be played while the download is in progress.
williamr@2
   744
      */
williamr@2
   745
      EDownloadCmdMarkAsNotProgressive
williamr@2
   746
      };
williamr@2
   747
williamr@2
   748
    enum TBrCtlBitmapInfo
williamr@2
   749
      {
williamr@2
   750
      EBitmapThumbnail = 0,
williamr@2
   751
      EBitmapFavicon
williamr@2
   752
      };
williamr@2
   753
williamr@2
   754
    /**
williamr@2
   755
    * The client commands.
williamr@2
   756
    */
williamr@2
   757
    enum TBrCtlClientCommands
williamr@2
   758
        {
williamr@2
   759
        EClientCommandLaunchFindKeyword = 0,
williamr@2
   760
        EClientCommandSubscribeToFeeds,
williamr@2
   761
        EClientCommandShowContextMenu,
williamr@2
   762
        EClientCommandToolbarSettings,
williamr@2
   763
        EClientCommandGotoWebAddress,
williamr@2
   764
        EClientCommandManageBookmarks,
williamr@2
   765
        EClientCommandSaveAsBookmark,
williamr@2
   766
        EClientCommandZoomIn,
williamr@2
   767
        EClientCommandZoomOut,
williamr@2
   768
        EClientCommandGoToHompage,
williamr@2
   769
        EClientCommandRotateScreen,
williamr@2
   770
        EClientCommandSavePage,
williamr@2
   771
        EClientCommandSwitchWindow,
williamr@2
   772
        EClientCommandShowHelp,
williamr@2
   773
        EClientCommandToolbarConfigure,
williamr@2
   774
        EClientCommandToolbarShowKeymap,
williamr@2
   775
        EClientCommandFullScreen,
williamr@2
   776
        EClientCommandZoomMode
williamr@2
   777
        };
williamr@2
   778
williamr@2
   779
    /**
williamr@2
   780
    * The widget params.
williamr@2
   781
    */
williamr@2
   782
    enum TBrCtlWidgetParams
williamr@2
   783
        {
williamr@2
   784
        EWidgetIdentifier = 0,
williamr@2
   785
        EWidgetBundleId,
williamr@2
   786
        EWidgetBasePath,
williamr@4
   787
        EWidgetPublishState,
williamr@4
   788
        EWidgetNetworkState
williamr@2
   789
        };
williamr@2
   790
williamr@2
   791
    /**
williamr@2
   792
    * Orientation for rotating display
williamr@2
   793
    */
williamr@2
   794
    enum TBrCtlOrientation
williamr@2
   795
        {
williamr@2
   796
        EOrientationUndefined = 0,
williamr@2
   797
        EOrientationLandscape,
williamr@2
   798
        EOrientationPortrait
williamr@2
   799
        };
williamr@2
   800
williamr@2
   801
    /**
williamr@2
   802
    * How to notify javascript logs.
williamr@2
   803
    */
williamr@2
   804
    enum TBrCtlScriptLog
williamr@2
   805
            {
williamr@2
   806
            /**
williamr@2
   807
            * script log output disabled
williamr@2
   808
            */
williamr@2
   809
            EScriptLogDisable,
williamr@2
   810
            /**
williamr@2
   811
            * script log output to a log file
williamr@2
   812
            */
williamr@2
   813
            EScriptLogToFile,
williamr@2
   814
            /**
williamr@2
   815
            * script log output to GUI console
williamr@2
   816
            */
williamr@2
   817
            EScriptLogToConsole,
williamr@2
   818
            /**
williamr@2
   819
            * script log output to both GUI console and file
williamr@2
   820
            */
williamr@2
   821
            EScriptLogToConsoleFile
williamr@2
   822
            };
williamr@2
   823
williamr@2
   824
    enum TBrCtlFormData
williamr@2
   825
        {
williamr@2
   826
        EFormDataOff,
williamr@2
   827
        EFormDataOnly,
williamr@2
   828
        EFormDataPlusPassword
williamr@2
   829
        };
williamr@4
   830
    enum TCursorSettings
williamr@4
   831
        {
williamr@4
   832
        ENoCursor = 0,
williamr@4
   833
        EDefaultCursor
williamr@4
   834
        };
williamr@4
   835
    
williamr@4
   836
    enum TEnterKeySettings
williamr@4
   837
        {
williamr@4
   838
        EEnterKeyDefault = 0,
williamr@4
   839
        EEnterKeyCanActivateLink
williamr@4
   840
        };
williamr@2
   841
    };
williamr@2
   842
#endif      // BRCTLDEFS_H
williamr@2
   843
williamr@2
   844
// End of File