| class TBrCtlDefs |
The TBrCtlDefs class contains definitions of custom data types for the Browser Control API.
Usage:
#include <brctldefs.h>
@see S60 Platform: Browser Control API Developer's Guide Version 2.0
@lib BrowserEngine.lib
@since 3.0
@file brctldefs.h
*
Rules that determine in which mode the cache operates.
| ECacheModeNormal = 0 |
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. |
| ECacheModeHistory |
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. |
| ECacheModeNoCache |
The browser should request the content from the server even if it is in the cache. |
| ECacheModeOnlyCache |
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. |
Configuration options for the Browser Control
| ECapabilityDisplayScrollBar = 0x0001 |
Displays horizontal and vertical scroll bars. |
| ECapabilityClientResolveEmbeddedURL = 0x0002 |
Sends request to load embedded content to the host application. The host application indicates whether or not the load request should proceed. |
| ECapabilityClientNotifyURL = 0x0004 |
Sends request to load a URL to the host application. The host application indicates whether or not the load request should proceed. |
| ECapabilityDisableInputAndPlugins = 0x0008 |
Disables input boxes and Netscape plug-ins. |
| ECapabilityFindItem = 0x0010 |
Adds Find Item to the Options menu. |
| ECapabilityLoadHttpFw = 0x0020 |
Allows network access for HTTP requests. If this option is not set, HTTP requests will fail. |
| ECapabilityUseDlMgr = 0x0040 |
Employs the Download Manager to download content, such as audio or video files. |
| ECapabilityLaunchViewer = 0x0080 |
Launches a viewer application to view the downloaded content. |
| ECapabilityGraphicalHistory = 0x0100 | |
| ECapabilitySavedPage = 0x0200 | |
| ECapabilityConfirmDownloads = 0x0400 | |
| ECapabilityAutoFormFill = 0x0800 | |
| ECapabilityCursorNavigation = 0x1000 | |
| ECapabilityGraphicalPage = 0x2000 | |
| ECapabilityAccessKeys = 0x4000 | |
| ECapabilityFavicon = 0x8000 | |
| ECapabilityToolBar = 0x00010000 | |
| ECapabilityWebKitLite = 0x00020000 | |
| ECapabilityFitToScreen = 0x00040000 | |
| ECapabilityPinchZoom = 0x00080000 |
The client commands.
| EClientCommandLaunchFindKeyword = 0 | |
| EClientCommandSubscribeToFeeds | |
| EClientCommandShowContextMenu | |
| EClientCommandToolbarSettings | |
| EClientCommandGotoWebAddress | |
| EClientCommandManageBookmarks | |
| EClientCommandSaveAsBookmark | |
| EClientCommandZoomIn | |
| EClientCommandZoomOut | |
| EClientCommandGoToHompage | |
| EClientCommandRotateScreen | |
| EClientCommandSavePage | |
| EClientCommandSwitchWindow | |
| EClientCommandShowHelp | |
| EClientCommandToolbarConfigure | |
| EClientCommandToolbarShowKeymap | |
| EClientCommandFullScreen | |
| EClientCommandZoomMode |
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.
| ECommandIdBrowserBase = 0 | |
| ECommandIdSubscribeToBase = 90 | |
| ECommandIdPluginBase = 100 | |
| ECommandIdWMLBase = 300 | |
| ECommandIdRange = 600 | |
| ECommandIdBase = 15000 |
The host application should define the base for the command IDs and add that base to the enum value of each command.
| ECommandDisconnect = 0 | |
| ECommandCancelFetch | |
| ECommandOpen | |
| ECommandReload | |
| ECommandBack | |
| ECommandForward |
Loads the next page. This command is used only to return to the next page after going back to a previous page. |
| ECommandClearHistory | |
| ECommandShowHistory |
Shows a list of history entries. Do not use this parameter if LoadDataL or InitLoadDataL are used. |
| ECommandAccept | |
| ECommandCancel |
Cancels the input data in the editor. Sets the focus back on the browser after the focus is shifted to a plug-in. |
| ECommandOpenToViewer | |
| ECommandAddToPhoneBook |
Adds the contact information of the link currently selected to the phone book |
| ECommandMakeCall |
Makes a phone call using the phone number in the link currently selected |
| ECommandRemoveFileName | |
| ECommandShowImages | |
| ECommandLoadImages | |
| ECommandGainFocus | |
| ECommandLoseFocus | |
| ECommandFindItem |
Do not call this parameter. It is a base for the next three commands. |
| ECommandFindItemPhoneNumber |
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. |
| ECommandFindItemEMail |
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. |
| ECommandFindItemAddress |
Displays the FindItem dialog and highlights all of the URLs in the current page. Use this parameter only if you specified the ECapabilityFindItem capability. |
| ECommandFindKeyword | |
| ECommandClearFind | |
| ECommandShowThumbnailView | |
| ECommandShowDownloads | |
| ECommandSaveLaunchParams |
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. |
| ECommandOneStepBack | |
| ECommandAppForeground | |
| ECommandAppBackground | |
| ECommandOpenNewWindow | |
| ECommandClearAutoFormFillData | |
| ECommandClearAutoFormFillPasswordData | |
| ECommandFreeMemory | |
| ECommandMemoryGood | |
| ECommandDumpRenderTree | |
| ECommandUnloadWMLEngine | |
| ECommandSmartLinkMakeCall | |
| ECommandSmartLinkSendMessage | |
| ECommandSmartLinkAddToPhoneBook | |
| ECommandShowToolBar | |
| ECommandSmartLinkSendEmail | |
| ECommandShowAnchorHref | |
| ECommandLoadFocusedImage | |
| ECommandUnLoadPluginWindows | |
| ECommandFindItemVoIPAddress |
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. |
| ECommandSmartLinkMakeVoipCall | |
| ECommandZoomSliderShow |
Zoom Slider configuration. |
| ECommandZoomSliderHide | |
| ECommandHistoryNavigateForward | |
| ECommandHistoryNavigateBack | |
| ECommandEnterFullscreenBrowsing | |
| ECommandLeaveFullscreenBrowsing | |
| ECommandZoomIn | |
| ECommandZoomOut | |
| ECommandRetryTransactions | |
| ECommandSetRetryConnectivityFlag | |
| ECommandUnSetRetryConnectivityFlag | |
| ECommandClearQuedTransactions | |
| ECommandConnToDownloadManager | |
| ECommandPauseScriptTimers |
Pause/Resume Script Timers |
| ECommandResumeScriptTimers | |
| ECommandCancelQueuedTransactions |
Commands sent by the host application to the Browser Control by calling the HandleDownloadCommandL function.
| EDownloadCmdPause |
Pauses the download identified by the aTransId parameter of the HandleDownloadCommandL function. |
| EDownloadCmdResume |
Resumes the download identified by the aTransId parameter of the HandleDownloadCommandL function. |
| EDownloadCmdCancel |
Cancels the download identified by the aTransId parameter of the HandleDownloadCommandL function. |
| EDownloadCmdMarkAsProgressive |
Notifies the Download Manager that the download is progressive. This means that the file can be played while the download is in progress. |
| EDownloadCmdMarkAsNotProgressive |
Notifies the Download Manager that the download is not progressive. This means that the file cannot be played while the download is in progress. |
Type of the focused element.
| EElementNone = 0 | |
| EElementImageBox | |
| EElementAnchor |
Element used to create either of the following: A link to another document A bookmark within a document |
| EElementTelAnchor | |
| EElementMailtoAnchor | |
| EElementInputBox | |
| EElementActivatedInputBox | |
| EElementSelectBox |
Box that contains a list of items. The user can select one of the items by clicking it. |
| EElementButton |
Push button that can contain text or images. For example, Submit. |
| EElementTextAreaBox | |
| EElementRootBox | |
| EElementObjectBox | |
| EElementActivatedObjectBox |
Box containing a plug-in that the user can manipulate; for example, by navigating links. |
| EElementDownloadedObjectBox | |
| EElementFileSelectionBoxNoContent | |
| EElementFileSelectionBoxWithContent | |
| EElementAreaBox | |
| EElementCheckBoxChecked | |
| EElementCheckBoxUnChecked | |
| EElementRadioButtonSelected | |
| EElementRadioButtonUnSelected | |
| EElementMouseButtonListener | |
| EElementScrollBar | |
| EElementSmartLinkTel | |
| EElementSmartLinkEmail | |
| EElementBrokenImage | |
| EElementSmartLinkVoip | |
| EElementSelectMultiBox |
Reserved for future use
| EFindNoMatches = 0 | |
| EFindWrapAround | |
| EFindAllMatches | |
| EFindMatch |
The size of the font selected.
| EFontSizeLevelAllSmall = 0 |
Text is shown 40% smaller than its declared size. |
| EFontSizeLevelSmaller |
Text is shown 20% smaller than its declared size. |
| EFontSizeLevelNormal |
Text is shown as its declared size. |
| EFontSizeLevelLarger |
Text is shown 20% larger than its declared size. |
| EFontSizeLevelAllLarge |
Text is shown 40% larger than its declared size. |
The load event that occurred.
| EEventNone = 0 | |
| EEventNewContentStart |
A page is beginning to load. This includes images, scripts, style sheets, and anything else embedded in the page as a single load event. |
| EEventUrlLoadingStart |
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. |
| EEventNewUrlContentArrived |
The first data chunk has arrived. This occurs when the response headers are received. |
| EEventMoreUrlContentArrived |
Another data chunk has arrived. This occurs for each chunk of data that is loaded, including the first chunk. |
| EEventNewContentDisplayed |
The first chunk of content is displayed. The previous page is destroyed at this time. This occurs once per page. |
| EEventMoreContentDisplayed |
Another chunk of content is displayed. This occurs for each chunk of content that is displayed, except for the first chunk. |
| EEventUrlLoadingFinished | |
| EEventLoadFinished |
The page has finished loading. If the host application draws a progress bar, it can be removed when this event is received. |
| EEventContentFinished | |
| EEventTitleAvailable |
A page title was encountered. After receiving this event, the host application can call PageInfoLC to receive the page title. |
| EEventLoadError | |
| EEventEnteringSecurePage |
The user is navigating from a non-secure page to a secure page. The host application displays a secure icon, if needed. |
| EEventExitingSecurePage |
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. |
| EEventSomeItemsNotSecure |
The user is entering a secure page that contains non-secure items. |
| EEventSubmittingToNonSecurePage |
The user is submitting information to a non-secure page. |
| EEventRedirectConfirmation |
User confirmation is required to redirect the browser. |
| EEventRepostConfirmation |
User confirmation is required to repost a page that has been viewed previously. |
| EEventSecureItemInNonSecurePage |
The user is entering a non-secure page that contains secure items. |
| EEventAuthenticationFailed |
Authentication failed or was cancelled. |
| EEventUploadStart |
A file is beginning to upload. |
| EEventUploadFinished |
A file has finished uploading; the last chunk of data has been transmitted. |
| EEventUploadIncrement |
Length of the data transmitted and the cumulative size of the uploaded file. |
| EEventFaviconAvailable | |
| EEventThumbnailAvailable |
Specifies the type of method to call to fetch a URL. The MbrCtlWindowObserver employs this method.
| EMethodGet |
Get method should be used to fetch content from a URL |
| EMethodPost |
POST method should be used to fetch content from a URL |
Identifies the navigation direction
| ENavigationBack | |
| ENavigationForward |
Orientation for rotating display
| EOrientationUndefined = 0 | |
| EOrientationLandscape | |
| EOrientationPortrait |
Gets the requested page information.
| EPageInfoTitle = 0 | |
| EPageInfoUrl | |
| EPageInfoContent | |
| EPageInfoSavedPage | |
| EPageInfoFocusedNodeUrl |
Returns information about the version of the Browser Control.
| EParamsUnknown = -1 | |
| EParamsSelfDownoadableTypes = 0 |
List of content types that do not use the Download Manager |
| EParamsRequestHeaders |
List of headers that the Browser Control should add to each request |
| EParamsMax |
How to notify javascript logs.
| EScriptLogDisable |
script log output disabled |
| EScriptLogToFile |
script log output to a log file |
| EScriptLogToConsole |
script log output to GUI console |
| EScriptLogToConsoleFile |
script log output to both GUI console and file |
The setting to manipulate.
| ESettingsUnknown = -1 | |
| ESettingsSmallScreen = 0 |
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. |
| ESettingsAutoLoadImages |
If set to On, images automatically load when a page is downloaded. If set to Off, images are not loaded. Default: On |
| ESettingsFontSize |
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. |
| ESettingsEmbedded |
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. |
| ESettingsTextWrapEnabled |
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. |
| ESettingsCookiesEnabled |
If set to Allow, the user can send and receive cookie information. If set to Reject, the user cannot send or receive cookie information. |
| ESettingsCSSFetchEnabled |
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 |
| ESettingsECMAScriptEnabled |
If set to Enable, ECMA Script is enabled. If set to Disable, ECMA Script is disabled. Default value: Enable |
| ESettingsIMEINotifyEnabled |
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 |
| ESettingsCharacterset |
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. |
| ESettingsSendRefererHeader |
URL of the initial page. Tells the Browser Control to send the referrer header in the request. |
| ESettingsSecurityWarnings |
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 |
| ESettingsApId |
Default access point for the Browser Control to use when connecting to the network. |
| ESettingsCurrentZoomLevelIndex | |
| ESettingsPageOverview | |
| ESettingsNumOfDownloads | |
| ESettingsLaunchAppUid |
UID of the application to restart after a reboot in order to continue an interrupted download. |
| ESettingsLaunchViewId |
View ID of the application to restart after a reboot in order to continue an interrupted download. |
| ESettingsLaunchCustomMessageId |
Message that asks the user whether to resume the download. |
| ESettingsBackList | |
| ESettingsAutoRefresh | |
| ESettingsBrowserUtf8Encoding |
If set, the browser encodes URLs using UTF-8 instead of the original content encoding.
Attention:
This is recommended only for the APAC region. |
| ESettingsAutoFormFillEnabled | |
| ESettingsSavedPage | |
| ESettingsSmartLink | |
| ESettingsAutoOpenDownloads | |
| ESettingsDisableFlash | |
| ESettingsScriptLog | |
| ESettingsToolbarOnOff |
Toolbar buttons configuration settings |
| ESettingsToolbarButton1Cmd | |
| ESettingsToolbarButton2Cmd | |
| ESettingsToolbarButton3Cmd | |
| ESettingsToolbarButton4Cmd | |
| ESettingsToolbarButton5Cmd | |
| ESettingsToolbarButton6Cmd | |
| ESettingsToolbarButton7Cmd | |
| ESettingsZoomLevelMin |
Browser Zoom level configuration settings |
| ESettingsZoomLevelMax | |
| ESettingsZoomLevelDefault | |
| ESettingsCursorShowMode | |
| ESettingsEnterKeyMode | |
| ESettingsMaxEnum |
Indicates whether the browser is in Image Map view.
| EStateImageMapView = 0 |
Currently, the only state change that can be observed is in and out of Image Map view. |
| EStateHistoryView | |
| EStateThumbnailView | |
| EStateWmlView | |
| EStateSmartTextView | |
| EStateToolBarMode | |
| EStatePluginPlayer | |
| EStateScriptLog | |
| EStateZoomSliderMode | |
| EStateFullscreenBrowsing | |
| EStateHistoryBeginning | |
| EStateHistoryEnd | |
| EStateSynchRequestMode | |
| EStatePluginFullScreen |
Returns information about the version of the Browser Control.
| EVersionInfoName = 0 | |
| EVersionInfoVersion | |
| EVersionInfoBuild | |
| EBrowserVersion |
The widget params.
| EWidgetIdentifier = 0 | |
| EWidgetBundleId | |
| EWidgetBasePath | |
| EWidgetPublishState | |
| EWidgetNetworkState |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.