1.1 --- a/epoc32/include/mw/brctldefs.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mw/brctldefs.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,822 @@
1.4 -brctldefs.h
1.5 +/*
1.6 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Eclipse Public License v1.0"
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: Enum Definition of the Browser Control API
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +#ifndef BRCTLDEFS_H
1.24 +#define BRCTLDEFS_H
1.25 +
1.26 +// INCLUDES
1.27 +
1.28 +// DATA TYPES
1.29 +
1.30 +// FORWARD DECLARATIONS
1.31 +
1.32 +// EXPORTED FUNCTION
1.33 +
1.34 +/**
1.35 +* The TBrCtlDefs class contains definitions of custom data types for the Browser Control API.
1.36 +*
1.37 +* Usage:
1.38 +*
1.39 +* @code
1.40 +* #include <BrCtlDefs.h>
1.41 +*
1.42 +* @see S60 Platform: Browser Control API Developer's Guide Version 2.0
1.43 +* @lib BrowserEngine.lib
1.44 +* @since 3.0
1.45 +* @file BrCtlDefs.h
1.46 +* @endcode *
1.47 +*/
1.48 +class TBrCtlDefs
1.49 + {
1.50 + public:
1.51 + /**
1.52 + * The Browser Control uses 600 command IDs, whose default
1.53 + * range is from 15000 - 15600. The host application can specify
1.54 + * any desired range through the API.
1.55 + */
1.56 + enum TBrCtlCommandId
1.57 + {
1.58 + ECommandIdBrowserBase = 0, ///< The base Browser ID.
1.59 + ECommandIdSubscribeToBase = 90, ///< The SubscribeToBase ID.
1.60 + ECommandIdPluginBase = 100, ///< The base plug-in ID.
1.61 + ECommandIdWMLBase = 300, ///< The base WML ID.
1.62 + ECommandIdRange = 600, ///< The maximum number of command IDs.
1.63 + ECommandIdBase = 15000 ///< The base value for the command IDs.
1.64 +
1.65 + };
1.66 + /**
1.67 + * Rules that determine in which mode the cache operates.
1.68 + */
1.69 + enum TBrCtlCacheMode
1.70 + {
1.71 + /**
1.72 + * Normal caching operation.
1.73 + * If the requested entity is in the cache and it has not expired,
1.74 + * get it from the cache. If the requested entity is not in the cache,
1.75 + * or if it has expired, the browser should request it from the server.
1.76 + */
1.77 + ECacheModeNormal = 0,
1.78 + /**
1.79 + * If the requested entity is in the cache, get it from the cache
1.80 + * even if it has expired. If the requested entity is not in the cache,
1.81 + * the browser should request it from the server.
1.82 + */
1.83 + ECacheModeHistory,
1.84 + /**
1.85 + * The browser should request the content from the server even if it is in the cache.
1.86 + */
1.87 + ECacheModeNoCache,
1.88 + /**
1.89 + * If the requested entity is in the cache, get it from the cache
1.90 + * even if it has expired. If the requested entity is not in the cache,
1.91 + * return an error.
1.92 + */
1.93 + ECacheModeOnlyCache
1.94 + };
1.95 + /**
1.96 + * The host application can send these commands
1.97 + * to the Browser Control by calling the HandleCommandL function.
1.98 + * @attention The host application should define the base for the command
1.99 + * IDs and add that base to the enum value of each command.
1.100 + */
1.101 + enum TBrCtlCommands
1.102 + {
1.103 + ECommandDisconnect = 0, ///< Unloads the HTTP Framework
1.104 + ECommandCancelFetch, ///< Cancels all outstanding requests
1.105 + ECommandOpen, ///< Activates the focused element
1.106 + ECommandReload, ///< Reloads the current page
1.107 + ECommandBack, ///< Loads the previous page, if available
1.108 + /**
1.109 + * Loads the next page. This command is used only to return
1.110 + * to the next page after going back to a previous page.
1.111 + */
1.112 + ECommandForward,
1.113 + ECommandClearHistory, ///< Clears the history stack
1.114 + /**
1.115 + * Shows a list of history entries. Do not use this parameter if
1.116 + * LoadDataL or InitLoadDataL are used.
1.117 + */
1.118 + ECommandShowHistory,
1.119 + ECommandAccept, ///< Accepts the input data in the editor.
1.120 + /**
1.121 + * Cancels the input data in the editor. Sets the focus back
1.122 + * on the browser after the focus is shifted to a plug-in.
1.123 + */
1.124 + ECommandCancel,
1.125 + ECommandOpenToViewer, ///< Opens object data in an external viewer
1.126 + /**
1.127 + * Adds the contact information of the link currently selected to
1.128 + * the phone book
1.129 + */
1.130 + ECommandAddToPhoneBook,
1.131 + /**
1.132 + *Makes a phone call using the phone number in the link currently selected
1.133 + */
1.134 + ECommandMakeCall,
1.135 + ECommandRemoveFileName, ///< Removes the file name from a file selection box
1.136 + ECommandShowImages, ///< Shows a list of the images in the current page
1.137 + ECommandLoadImages, ///< Loads images when automatic image loading is turned off
1.138 + ECommandGainFocus, ///< Called when the Browser Control returns from background
1.139 + ECommandLoseFocus, ///< Called when the Browser Control goes to the background
1.140 + /**
1.141 + * Do not call this parameter. It is a base for the next three commands.
1.142 + */
1.143 + ECommandFindItem,
1.144 + /**
1.145 + * Displays the FindItem dialog and highlights all of the
1.146 + * phone numbers in the current page. Use this parameter only
1.147 + * if you specified the ECapabilityFindItem capability.
1.148 + */
1.149 + ECommandFindItemPhoneNumber,
1.150 + /**
1.151 + * Displays the FindItem dialog and highlights all of the e-mail
1.152 + * addresses in the current page. Use this parameter only if you
1.153 + * specified the ECapabilityFindItem capability.
1.154 + */
1.155 + ECommandFindItemEMail,
1.156 + /**
1.157 + * Displays the FindItem dialog and highlights all of the URLs in
1.158 + * the current page. Use this parameter only if you specified
1.159 + * the ECapabilityFindItem capability.
1.160 + */
1.161 + ECommandFindItemAddress,
1.162 + ECommandFindKeyword, ///< Reserved for future use.
1.163 + ECommandClearFind, ///< Reserved for future use.
1.164 + ECommandShowThumbnailView, ///< Reserved for future use.
1.165 + ECommandShowDownloads, ///< Tells the Download Manager to display the list of downloads.
1.166 + /**
1.167 + * Saves the following launch parameters when the application
1.168 + * unexpectedly shuts down. These parameters all have the prefix ESettingsLaunch:
1.169 + * AppUid, ViewId, CustomMessageId
1.170 + * When the phone reboots, it uses these parameters to restart
1.171 + * the host application and resume the interrupted downloads.
1.172 + * NOTE: These parameters must be set before calling this command.
1.173 + */
1.174 + ECommandSaveLaunchParams,
1.175 + ECommandOneStepBack, ///< Reserved for future use.
1.176 + ECommandAppForeground, ///<
1.177 + ECommandAppBackground, ///<
1.178 + ECommandOpenNewWindow, ///<
1.179 + ECommandClearAutoFormFillData, ///<
1.180 + ECommandClearAutoFormFillPasswordData, ///<
1.181 + ECommandFreeMemory, ///<
1.182 + ECommandMemoryGood, ///<
1.183 + ECommandDumpRenderTree, ///<
1.184 + ECommandUnloadWMLEngine, ///<
1.185 + ECommandSmartLinkMakeCall, ///<
1.186 + ECommandSmartLinkSendMessage, ///<
1.187 + ECommandSmartLinkAddToPhoneBook, ///<
1.188 + ECommandShowToolBar, ///<Shows the toolbar
1.189 + ECommandSmartLinkSendEmail, ///<
1.190 + ECommandShowAnchorHref, ///<Display the URL of a hyperlink - supported only for HTML
1.191 + ECommandLoadFocusedImage, ///<Load the focuesd image - supported only for HTML
1.192 + ECommandUnLoadPluginWindows, ///<Unload plugin windows
1.193 + /**
1.194 + * Displays the FindItem dialog and highlights all of the VoIP
1.195 + * addresses in the current page. Use this parameter only if you
1.196 + * specified the ECapabilityFindItem capability.
1.197 + */
1.198 + ECommandFindItemVoIPAddress, ///<Find VoIP address item
1.199 + ECommandSmartLinkMakeVoipCall, ///<MakeVoip Callthrough smartlink
1.200 + /**
1.201 + * Zoom Slider configuration.
1.202 + */
1.203 + ECommandZoomSliderShow, ///< Zoom slider visible.
1.204 + ECommandZoomSliderHide, ///< Zoom slider hidden.
1.205 + ECommandHistoryNavigateForward,
1.206 + ECommandHistoryNavigateBack,
1.207 + /*
1.208 + ** Enter/Exit Fullscreen Browsing
1.209 + */
1.210 + ECommandEnterFullscreenBrowsing,
1.211 + ECommandLeaveFullscreenBrowsing,
1.212 + ECommandZoomIn,
1.213 + ECommandZoomOut
1.214 + };
1.215 + /**
1.216 + * The load event that occurred.
1.217 + */
1.218 + enum TBrCtlLoadEvent
1.219 + {
1.220 + EEventNone = 0, // Non event, Not used.
1.221 + /**
1.222 + * A page is beginning to load. This includes images, scripts,
1.223 + * style sheets, and anything else embedded in the page as a single load event.
1.224 + */
1.225 + EEventNewContentStart,
1.226 + /** A URL is beginning to load. This notifies the observer of a
1.227 + * separate load event for each image or other element embedded in the page.
1.228 + */
1.229 + EEventUrlLoadingStart,
1.230 + /**
1.231 + * The first data chunk has arrived. This occurs when the response
1.232 + * headers are received.
1.233 + */
1.234 + EEventNewUrlContentArrived,
1.235 + /**
1.236 + * Another data chunk has arrived.
1.237 + * This occurs for each chunk of data that is loaded, including the first chunk.
1.238 + */
1.239 + EEventMoreUrlContentArrived,
1.240 + /**
1.241 + * The first chunk of content is displayed. The previous page is
1.242 + * destroyed at this time. This occurs once per page.
1.243 + */
1.244 + EEventNewContentDisplayed,
1.245 + /**
1.246 + * Another chunk of content is displayed. This occurs for each
1.247 + * chunk of content that is displayed, except for the first chunk.
1.248 + */
1.249 + EEventMoreContentDisplayed,
1.250 + EEventUrlLoadingFinished, ///< A URL has finished loading.
1.251 + /**
1.252 + * The page has finished loading. If the host application draws a
1.253 + * progress bar, it can be removed when this event is received.
1.254 + */
1.255 + EEventLoadFinished,
1.256 + EEventContentFinished, ///< The content has finished loading.
1.257 + /**
1.258 + * A page title was encountered. After receiving this
1.259 + * event, the host application can call PageInfoLC to receive the page title.
1.260 + */
1.261 + EEventTitleAvailable,
1.262 + EEventLoadError, ///< An error occurred while loading the page.
1.263 + /**
1.264 + * The user is navigating from a non-secure page to a secure page.
1.265 + * The host application displays a secure icon, if needed.
1.266 + */
1.267 + EEventEnteringSecurePage,
1.268 + /**
1.269 + * The user is navigating from a secure page to a non-secure page.
1.270 + * If the host application displays a secure icon, that icon should be removed.
1.271 + */
1.272 + EEventExitingSecurePage,
1.273 + /**
1.274 + * The user is entering a secure page that contains non-secure items.
1.275 + */
1.276 + EEventSomeItemsNotSecure,
1.277 + /**
1.278 + * The user is submitting information to a non-secure page.
1.279 + */
1.280 + EEventSubmittingToNonSecurePage,
1.281 + /**
1.282 + * User confirmation is required to redirect the browser.
1.283 + */
1.284 + EEventRedirectConfirmation,
1.285 + /**
1.286 + * User confirmation is required to repost a page that has been viewed previously.
1.287 + */
1.288 + EEventRepostConfirmation,
1.289 + /**
1.290 + * The user is entering a non-secure page that contains secure items.
1.291 + */
1.292 + EEventSecureItemInNonSecurePage,
1.293 + /**
1.294 + * Authentication failed or was cancelled.
1.295 + */
1.296 + EEventAuthenticationFailed,
1.297 + /**
1.298 + * A file is beginning to upload.
1.299 + */
1.300 + EEventUploadStart,
1.301 + /**
1.302 + * A file has finished uploading; the last chunk of data has been transmitted.
1.303 + */
1.304 + EEventUploadFinished,
1.305 + /**
1.306 + * Length of the data transmitted and the cumulative size of the uploaded file.
1.307 + */
1.308 + EEventUploadIncrement,
1.309 + EEventFaviconAvailable,
1.310 + EEventThumbnailAvailable
1.311 + };
1.312 + /**
1.313 + * The setting to manipulate.
1.314 + */
1.315 +
1.316 + enum TBrCtlSettings
1.317 + {
1.318 + ESettingsUnknown = -1, ///< Not used
1.319 + /**
1.320 + * If set to On, large pages are optimized for display on a small screen.
1.321 + * If set to Off, all pages display in their original format.
1.322 + */
1.323 + ESettingsSmallScreen = 0,
1.324 + /**
1.325 + * If set to On, images automatically load when a page is downloaded.
1.326 + * If set to Off, images are not loaded. Default: On
1.327 + */
1.328 + ESettingsAutoLoadImages,
1.329 + /**
1.330 + * If set to All.Large, all text is shown 40% larger than its declared size.
1.331 + * If set to Larger, all text is shown 20% larger than its declared size.
1.332 + * If set to Normal, all text is shown as its declared size.
1.333 + * If set to Smaller, all text is shown 20% smaller than its declared size.
1.334 + * If set to All.Small, all text is shown 40% smaller than its declared size.
1.335 + */
1.336 + ESettingsFontSize,
1.337 + /**
1.338 + * If set to On, the host application is embedded within another application.
1.339 + * If set to Off, the host application is not embedded within another application.
1.340 + */
1.341 + ESettingsEmbedded,
1.342 + /**
1.343 + * If set to On, paragraphs are automatically wrapped to fit into the display width.
1.344 + * If set to Off, paragraphs are not automatically wrapped.
1.345 + * @attention This parameter is not shown if ESettingsSmallScreen is set to On.
1.346 + */
1.347 + ESettingsTextWrapEnabled,
1.348 + /**
1.349 + * If set to Allow, the user can send and receive cookie information.
1.350 + * If set to Reject, the user cannot send or receive cookie information.
1.351 + */
1.352 + ESettingsCookiesEnabled,
1.353 + /**
1.354 + * If set to Finest, external style sheets are downloaded when
1.355 + * Small Screen Layout is used. If set to Fastest, external style
1.356 + * sheets are not downloaded when Small Screen Layout is used.
1.357 + * Default value: Fastest
1.358 + */
1.359 + ESettingsCSSFetchEnabled,
1.360 + /**
1.361 + * If set to Enable, ECMA Script is enabled.
1.362 + * If set to Disable, ECMA Script is disabled.
1.363 + * Default value: Enable
1.364 + */
1.365 + ESettingsECMAScriptEnabled,
1.366 + /**
1.367 + * Device unique identification number sent to a server for billing
1.368 + * purposes in e-commerce. If set to Enable, the Browser Control
1.369 + * sends the International Mobile Equipment Identity (IMEI) to the server.
1.370 + * If set to Disable, the Browser Control does not send the IMEI to the server.
1.371 + * Default value: Disable
1.372 + */
1.373 + ESettingsIMEINotifyEnabled,
1.374 + /**
1.375 + * Character coding. If set to Automatic, the character set is
1.376 + * automatically selected according to the following criteria, in order or priority:
1.377 + * 1. Detected from the Byte Order Mark (BOM)
1.378 + * 2. Detected from XML Document Type Definition (DTD)
1.379 + * 3. Declared in <meta> element
1.380 + * 4. Detected from HTTP headers
1.381 + * 5. Variant-specific default character set for automatic detection.
1.382 + * Possible character codings are:
1.383 + * Latin
1.384 + * Simplified Chinese
1.385 + * Traditional Chinese
1.386 + * Unicode (UTF-8)
1.387 + * Unicode (ucs-2)
1.388 + * ISO 8859 - 2,4,5,7,or 9
1.389 + * Hebrew (ISO-Logical)
1.390 + * Hebrew (ISO-Visual)
1.391 + * Hebrew (Windows)
1.392 + * Arabic (ISO)
1.393 + * Arabic (Windows)
1.394 + * Windows - 1250, 1251, 1253, 1254, or 1257
1.395 + * Thai
1.396 + * Thai (Windows 874)
1.397 + * Shift_jis
1.398 + * Euc-jp
1.399 + * ISO-2022-jp
1.400 + * The default value is variant-specific.
1.401 + */
1.402 + ESettingsCharacterset,
1.403 + /**
1.404 + * URL of the initial page. Tells the
1.405 + * Browser Control to send the referrer header in the request.
1.406 + */
1.407 + ESettingsSendRefererHeader,
1.408 + /**
1.409 + * One of the following:
1.410 + * Certificate not valid yet
1.411 + * Server certificate expired
1.412 + * Server certificate not received
1.413 + * Invalid server certificate
1.414 + * Authority certificate not valid yet
1.415 + * Authority certificate expired
1.416 + * Authority certificate not found
1.417 + * Authority certificate corrupted
1.418 + */
1.419 + ESettingsSecurityWarnings,
1.420 + /**
1.421 + * Default access point for the Browser Control to use when
1.422 + * connecting to the network.
1.423 + */
1.424 + ESettingsApId,
1.425 + ESettingsCurrentZoomLevelIndex, ///< Reserved for future use.
1.426 + ESettingsPageOverview, ///< Reserved for future use.
1.427 + ESettingsNumOfDownloads, ///< Number of downloads in progress.
1.428 + /**
1.429 + * UID of the application to
1.430 + * restart after a reboot in order to continue an interrupted download.
1.431 + */
1.432 + ESettingsLaunchAppUid,
1.433 + /**
1.434 + * View ID of the application to
1.435 + * restart after a reboot in order to continue an interrupted download.
1.436 + */
1.437 + ESettingsLaunchViewId,
1.438 + /**
1.439 + * Message that asks the user whether to resume the download.
1.440 + */
1.441 + ESettingsLaunchCustomMessageId, ///< Reserved for future use.
1.442 + ESettingsBackList, ///< Reserved for future use.
1.443 + ESettingsAutoRefresh, ///< Reserved for future use.
1.444 + /**
1.445 + * If set, the browser encodes URLs using UTF-8 instead of
1.446 + * the original content encoding.
1.447 + * @attention This is recommended only for the APAC region.
1.448 + */
1.449 + ESettingsBrowserUtf8Encoding,
1.450 + ESettingsAutoFormFillEnabled, ///< For enabling the auto fill
1.451 + ESettingsSavedPage, ///< Save the page
1.452 + ESettingsSmartLink,
1.453 + ESettingsAutoOpenDownloads, // For automatically open the downloaded files
1.454 + ESettingsDisableFlash, ///<Enable/Disable the flash
1.455 + ESettingsScriptLog, /// script log
1.456 + /**
1.457 + * Toolbar buttons configuration settings
1.458 + */
1.459 + ESettingsToolbarOnOff,
1.460 + ESettingsToolbarButton1Cmd,
1.461 + ESettingsToolbarButton2Cmd,
1.462 + ESettingsToolbarButton3Cmd,
1.463 + ESettingsToolbarButton4Cmd,
1.464 + ESettingsToolbarButton5Cmd,
1.465 + ESettingsToolbarButton6Cmd,
1.466 + ESettingsToolbarButton7Cmd,
1.467 + /**
1.468 + * Browser Zoom level configuration settings
1.469 + */
1.470 + ESettingsZoomLevelMin, ///< Minimum Zoom level supported
1.471 + ESettingsZoomLevelMax, ///< Maximum Zoom level supported
1.472 + ESettingsZoomLevelDefault, ///< Default Zoom level for new page
1.473 + ESettingsMaxEnum ///< Must be last one
1.474 + };
1.475 +
1.476 + /**
1.477 + * The size of the font selected.
1.478 + */
1.479 + enum TBrCtlFontSizeLevel
1.480 + {
1.481 + /**
1.482 + * Text is shown 40% smaller than its declared size.
1.483 + */
1.484 + EFontSizeLevelAllSmall = 0,
1.485 + /**
1.486 + * Text is shown 20% smaller than its declared size.
1.487 + */
1.488 + EFontSizeLevelSmaller,
1.489 + /**
1.490 + * Text is shown as its declared size.
1.491 + */
1.492 + EFontSizeLevelNormal,
1.493 + /**
1.494 + * Text is shown 20% larger than its declared size.
1.495 + */
1.496 + EFontSizeLevelLarger,
1.497 + /**
1.498 + * Text is shown 40% larger than its declared size.
1.499 + */
1.500 + EFontSizeLevelAllLarge
1.501 + };
1.502 + /**
1.503 + * Configuration options for the Browser Control
1.504 + */
1.505 + enum TBrCtlCapabilities
1.506 + {
1.507 + /**
1.508 + * Displays horizontal and vertical scroll bars.
1.509 + */
1.510 + ECapabilityDisplayScrollBar = 0x0001,
1.511 + /**
1.512 + * Sends request to load embedded content to the host application.
1.513 + * The host application indicates whether or not the load request
1.514 + * should proceed.
1.515 + */
1.516 + ECapabilityClientResolveEmbeddedURL = 0x0002,
1.517 + /**
1.518 + * Sends request to load a URL to the host application.
1.519 + * The host application indicates whether or not the load
1.520 + * request should proceed.
1.521 + */
1.522 + ECapabilityClientNotifyURL = 0x0004,
1.523 + /**
1.524 + * Disables input boxes and Netscape plug-ins.
1.525 + */
1.526 + ECapabilityDisableInputAndPlugins = 0x0008,
1.527 + /**
1.528 + * Adds Find Item to the Options menu.
1.529 + */
1.530 + ECapabilityFindItem = 0x0010,
1.531 + /**
1.532 + * Allows network access for HTTP requests.
1.533 + * If this option is not set, HTTP requests will fail.
1.534 + */
1.535 + ECapabilityLoadHttpFw = 0x0020,
1.536 + /**
1.537 + * Employs the Download Manager to download content, such as audio or video files.
1.538 + */
1.539 + ECapabilityUseDlMgr = 0x0040,
1.540 + /**
1.541 + * Launches a viewer application to view the downloaded content.
1.542 + */
1.543 + ECapabilityLaunchViewer = 0x0080,
1.544 + ECapabilityGraphicalHistory = 0x0100, ///< Reserved for future use.
1.545 + ECapabilitySavedPage = 0x0200, ///< Reserved for future use.
1.546 + ECapabilityConfirmDownloads = 0x0400, ///< Enables confirmation dialog in the Download Manager.
1.547 + ECapabilityAutoFormFill = 0x0800,
1.548 + ECapabilityCursorNavigation = 0x1000,
1.549 + ECapabilityGraphicalPage = 0x2000,
1.550 + ECapabilityAccessKeys = 0x4000,
1.551 + ECapabilityFavicon = 0x8000,
1.552 + ECapabilityToolBar = 0x00010000,
1.553 + ECapabilityWebKitLite = 0x00020000,
1.554 + ECapabilityFitToScreen = 0x00040000
1.555 + };
1.556 +
1.557 + /**
1.558 + * Gets the requested page information.
1.559 + */
1.560 + enum TBrCtlPageInfo
1.561 + {
1.562 + EPageInfoTitle = 0, ///< Page title, if a title was specified
1.563 + EPageInfoUrl, ///< URL of the current page
1.564 + EPageInfoContent, ///< Page content as a text buffer
1.565 + EPageInfoSavedPage, ///< Page content, including all embedded content, as a buffer
1.566 + EPageInfoFocusedNodeUrl //< URL of the focused link. The function leaves if the focus is not on an anchor or imagemap
1.567 + };
1.568 + /**
1.569 + * Indicates whether the browser is in Image Map view.
1.570 + */
1.571 + enum TBrCtlState
1.572 + {
1.573 + /**
1.574 + * Currently, the
1.575 + * only state change that can be observed is in and out of Image Map view.
1.576 + */
1.577 + EStateImageMapView = 0,
1.578 + EStateHistoryView, ///< For future use
1.579 + EStateThumbnailView, ///< For future use
1.580 + EStateWmlView, ///< For WML view
1.581 + EStateSmartTextView, ///< For Smart text recognition mode
1.582 + EStateToolBarMode, ///< For toolbar
1.583 + EStatePluginPlayer,
1.584 + EStateScriptLog,
1.585 + EStateZoomSliderMode, ///< For ZoomSlider
1.586 + EStateFullscreenBrowsing, ///< For entering/escaping fullscreen browsing
1.587 + EStateHistoryBeginning,
1.588 + EStateHistoryEnd,
1.589 + EStateSynchRequestMode, ///< For synchronous (XHR) requests
1.590 + EStatePluginFullScreen
1.591 + };
1.592 + /**
1.593 + * Type of the focused element.
1.594 + */
1.595 + enum TBrCtlElementType
1.596 + {
1.597 + EElementNone = 0, ///< No element is present.
1.598 + EElementImageBox, ///< Box containing an image.
1.599 + /**
1.600 + * Element used to create either of the following:
1.601 + * A link to another document
1.602 + * A bookmark within a document
1.603 + */
1.604 + EElementAnchor,
1.605 + EElementTelAnchor, ///< Anchor with a "tel:" scheme
1.606 + EElementMailtoAnchor, ///< Anchor with a "mailto:" scheme
1.607 + EElementInputBox, ///< Input box that can be selected and activated.
1.608 + EElementActivatedInputBox, ///< Input box that contains an entry field into which the user can type.
1.609 + /**
1.610 + * Box that contains a list of items. The user
1.611 + * can select one of the items by clicking it.
1.612 + */
1.613 + EElementSelectBox,
1.614 + /**
1.615 + * Push button that can contain text or images. For example, Submit.
1.616 + */
1.617 + EElementButton,
1.618 + EElementTextAreaBox, ///< Input box that contains more than one line.
1.619 + EElementRootBox, ///< Root of the document.
1.620 + EElementObjectBox, ///< Placeholder for a plug-in that has not yet been downloaded.
1.621 + /**
1.622 + * Box containing a plug-in that the user can
1.623 + * manipulate; for example, by navigating links.
1.624 + */
1.625 + EElementActivatedObjectBox,
1.626 + EElementDownloadedObjectBox, ///< Plug-in that is present but is not being manipulated.
1.627 + EElementFileSelectionBoxNoContent, ///< File-browsing box in which no file is selected.
1.628 + EElementFileSelectionBoxWithContent, ///< File-browsing box in which a file was selected previously.
1.629 + EElementAreaBox, ///< Image map.
1.630 + EElementCheckBoxChecked, ///< A check box that was selected.
1.631 + EElementCheckBoxUnChecked, ///< A check box that was not selected.
1.632 + EElementRadioButtonSelected, ///< A radio button that was selected.
1.633 + EElementRadioButtonUnSelected, ///< A radio button that was not selected.
1.634 +
1.635 + EElementMouseButtonListener, ///< A Mouse button listener
1.636 + EElementScrollBar, ///< A scroll bar
1.637 +
1.638 + EElementSmartLinkTel, ///< A telephone number in the page.
1.639 + EElementSmartLinkEmail, ///< an email address in the page.
1.640 + EElementBrokenImage, ///< A missing image
1.641 + EElementSmartLinkVoip, ///< A voip smartlink
1.642 + EElementSelectMultiBox ///< A select box with multiple select
1.643 + };
1.644 +
1.645 + /**
1.646 + * Identifies the navigation direction
1.647 + */
1.648 + enum TBrCtlNavigationDirection
1.649 + {
1.650 + ENavigationBack, ///< Navigate to the previous page
1.651 + ENavigationForward ///< Navigate to the next page
1.652 + };
1.653 +
1.654 + /**
1.655 + * Returns information about the version of the Browser Control.
1.656 + */
1.657 + enum TBrCtlVersionInfo
1.658 + {
1.659 + EVersionInfoName = 0, ///< Name of the Browser Control
1.660 + EVersionInfoVersion, ///< Version of the Browser Control
1.661 + EVersionInfoBuild, ///< Build of the Browser Control
1.662 + EBrowserVersion ///< Browser Version
1.663 + };
1.664 +
1.665 + /**
1.666 + * Returns information about the version of the Browser Control.
1.667 + */
1.668 + enum TBrCtlParams
1.669 + {
1.670 + EParamsUnknown = -1, ///< Not used
1.671 + /**
1.672 + * List of content types that do not use the Download Manager
1.673 + */
1.674 + EParamsSelfDownoadableTypes = 0,
1.675 + /**
1.676 + * List of headers that the Browser Control should add to each request
1.677 + */
1.678 + EParamsRequestHeaders,
1.679 + EParamsMax ///< Not used
1.680 + };
1.681 +
1.682 + /**
1.683 + * Reserved for future use
1.684 + */
1.685 + enum TBrCtlFindResponse
1.686 + {
1.687 + EFindNoMatches = 0, ///< Reserved for future use
1.688 + EFindWrapAround, ///< Reserved for future use
1.689 + EFindAllMatches, ///< Reserved for future use
1.690 + EFindMatch ///< Reserved for future use
1.691 + };
1.692 +
1.693 + /**
1.694 + * Specifies the type of method to call to fetch a URL.
1.695 + * The MbrCtlWindowObserver employs this method.
1.696 + */
1.697 + enum TBrCtlMethod
1.698 + {
1.699 + /**
1.700 + * Get method should be used to fetch content from a URL
1.701 + */
1.702 + EMethodGet,
1.703 + /**
1.704 + * POST method should be used to fetch content from a URL
1.705 + */
1.706 + EMethodPost
1.707 + };
1.708 + /**
1.709 + * Commands sent by the host application
1.710 + * to the Browser Control by calling the HandleDownloadCommandL function.
1.711 + */
1.712 + enum TBrCtlDownloadCmd
1.713 + {
1.714 + /**
1.715 + * Pauses the download identified
1.716 + * by the aTransId parameter of the HandleDownloadCommandL function.
1.717 + */
1.718 + EDownloadCmdPause,
1.719 + /**
1.720 + * Resumes the download identified by
1.721 + * the aTransId parameter of the HandleDownloadCommandL function.
1.722 + */
1.723 + EDownloadCmdResume,
1.724 + /**
1.725 + * Cancels the download identified by the
1.726 + * aTransId parameter of the HandleDownloadCommandL function.
1.727 + */
1.728 + EDownloadCmdCancel,
1.729 + /**
1.730 + * Notifies the Download Manager that the download is progressive.
1.731 + * This means that the file can be played while the download is in progress.
1.732 + */
1.733 + EDownloadCmdMarkAsProgressive,
1.734 + /**
1.735 + * Notifies the Download Manager that the download is not progressive.
1.736 + * This means that the file cannot be played while the download is in progress.
1.737 + */
1.738 + EDownloadCmdMarkAsNotProgressive
1.739 + };
1.740 +
1.741 + enum TBrCtlBitmapInfo
1.742 + {
1.743 + EBitmapThumbnail = 0,
1.744 + EBitmapFavicon
1.745 + };
1.746 +
1.747 + /**
1.748 + * The client commands.
1.749 + */
1.750 + enum TBrCtlClientCommands
1.751 + {
1.752 + EClientCommandLaunchFindKeyword = 0,
1.753 + EClientCommandSubscribeToFeeds,
1.754 + EClientCommandShowContextMenu,
1.755 + EClientCommandToolbarSettings,
1.756 + EClientCommandGotoWebAddress,
1.757 + EClientCommandManageBookmarks,
1.758 + EClientCommandSaveAsBookmark,
1.759 + EClientCommandZoomIn,
1.760 + EClientCommandZoomOut,
1.761 + EClientCommandGoToHompage,
1.762 + EClientCommandRotateScreen,
1.763 + EClientCommandSavePage,
1.764 + EClientCommandSwitchWindow,
1.765 + EClientCommandShowHelp,
1.766 + EClientCommandToolbarConfigure,
1.767 + EClientCommandToolbarShowKeymap,
1.768 + EClientCommandFullScreen,
1.769 + EClientCommandZoomMode
1.770 + };
1.771 +
1.772 + /**
1.773 + * The widget params.
1.774 + */
1.775 + enum TBrCtlWidgetParams
1.776 + {
1.777 + EWidgetIdentifier = 0,
1.778 + EWidgetBundleId,
1.779 + EWidgetBasePath,
1.780 + EWidgetPublishState
1.781 + };
1.782 +
1.783 + /**
1.784 + * Orientation for rotating display
1.785 + */
1.786 + enum TBrCtlOrientation
1.787 + {
1.788 + EOrientationUndefined = 0,
1.789 + EOrientationLandscape,
1.790 + EOrientationPortrait
1.791 + };
1.792 +
1.793 + /**
1.794 + * How to notify javascript logs.
1.795 + */
1.796 + enum TBrCtlScriptLog
1.797 + {
1.798 + /**
1.799 + * script log output disabled
1.800 + */
1.801 + EScriptLogDisable,
1.802 + /**
1.803 + * script log output to a log file
1.804 + */
1.805 + EScriptLogToFile,
1.806 + /**
1.807 + * script log output to GUI console
1.808 + */
1.809 + EScriptLogToConsole,
1.810 + /**
1.811 + * script log output to both GUI console and file
1.812 + */
1.813 + EScriptLogToConsoleFile
1.814 + };
1.815 +
1.816 + enum TBrCtlFormData
1.817 + {
1.818 + EFormDataOff,
1.819 + EFormDataOnly,
1.820 + EFormDataPlusPassword
1.821 + };
1.822 + };
1.823 +
1.824 +#endif // BRCTLDEFS_H
1.825 +
1.826 +// End of File