brctldefs.h

Go to the documentation of this file.
00001 /*
00002 * ==============================================================================
00003 *  Name        : BrCtlDefs.h
00004 *  Part of     : WebKit \ BrowserControl
00005 *  Interface   : Browser Control API
00006 *  Description : Enum Definition of the Browser Control API
00007 *  Version     : %Version%
00008 *
00009 *    Copyright (c) 2006, Nokia Corporation
00010 *    All rights reserved.
00011 *
00012 *   Redistribution and use in source and binary forms, with or without
00013 *   modification, are permitted provided that the following conditions
00014 *   are met:
00015 *
00016 *      * Redistributions of source code must retain the above copyright
00017 *        notice, this list of conditions and the following disclaimer.
00018 *      * Redistributions in binary form must reproduce the above copyright
00019 *        notice, this list of conditions and the following disclaimer in
00020 *        the documentation and/or other materials provided with the
00021 *        distribution.
00022 *      * Neither the name of the Nokia Corporation nor the names of its
00023 *        contributors may be used to endorse or promote products derived
00024 *        from this software without specific prior written permission.
00025 *
00026 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
00030 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
00036 *   USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
00037 *   DAMAGE.
00038 *
00039 *    Please see file patentlicense.txt for further grants.
00040 * ==============================================================================
00041 */
00042 
00043 
00044 #ifndef BRCTLDEFS_H
00045 #define BRCTLDEFS_H
00046 
00047 //  INCLUDES
00048 
00049 // DATA TYPES
00050 
00051 // FORWARD DECLARATIONS
00052 
00053 // EXPORTED FUNCTION
00054 
00069 class TBrCtlDefs
00070     {
00071     public:
00077         enum TBrCtlCommandId
00078             {
00079             ECommandIdBrowserBase = 0, 
00080             ECommandIdSubscribeToBase = 90, 
00081             ECommandIdPluginBase = 100, 
00082             ECommandIdWMLBase = 300, 
00083             ECommandIdRange = 600,   
00084             ECommandIdBase = 15000   
00085 
00086             };
00090         enum TBrCtlCacheMode
00091             {
00098             ECacheModeNormal = 0,
00104             ECacheModeHistory,
00108             ECacheModeNoCache,
00114             ECacheModeOnlyCache
00115             };
00122         enum TBrCtlCommands
00123             {
00124             ECommandDisconnect = 0, 
00125             ECommandCancelFetch, 
00126             ECommandOpen, 
00127             ECommandReload, 
00128             ECommandBack, 
00129 
00133             ECommandForward,
00134             ECommandClearHistory, 
00135 
00139             ECommandShowHistory,
00140             ECommandAccept, 
00141 
00145             ECommandCancel,
00146             ECommandOpenToViewer, 
00147 
00151             ECommandAddToPhoneBook,
00155             ECommandMakeCall,
00156             ECommandRemoveFileName, 
00157             ECommandShowImages, 
00158             ECommandLoadImages, 
00159             ECommandGainFocus, 
00160             ECommandLoseFocus, 
00161 
00164             ECommandFindItem,
00170             ECommandFindItemPhoneNumber,
00176             ECommandFindItemEMail,
00182             ECommandFindItemAddress,
00183             ECommandFindKeyword, 
00184             ECommandClearFind, 
00185             ECommandShowThumbnailView, 
00186             ECommandShowDownloads, 
00187 
00195             ECommandSaveLaunchParams,
00196             ECommandOneStepBack, 
00197             ECommandAppForeground, 
00198             ECommandAppBackground, 
00199             ECommandOpenNewWindow, 
00200             ECommandClearAutoFormFillData, 
00201             ECommandClearAutoFormFillPasswordData, 
00202             ECommandFreeMemory, 
00203             ECommandMemoryGood, 
00204             ECommandDumpRenderTree, 
00205             ECommandUnloadWMLEngine, 
00206             ECommandSmartLinkMakeCall, 
00207             ECommandSmartLinkSendMessage, 
00208             ECommandSmartLinkAddToPhoneBook, 
00209             ECommandShowToolBar, 
00210             ECommandSmartLinkSendEmail, 
00211             ECommandShowAnchorHref,  
00212             ECommandLoadFocusedImage, 
00213             ECommandUnLoadPluginWindows, 
00214             ECommandFindItemVoIPAddress, 
00215             ECommandSmartLinkMakeVoipCall   
00216 
00221             };
00225         enum TBrCtlLoadEvent
00226             {
00227             EEventNone = 0,                     // Non event, Not used.
00232             EEventNewContentStart,
00236             EEventUrlLoadingStart,
00241             EEventNewUrlContentArrived,
00246             EEventMoreUrlContentArrived,
00251             EEventNewContentDisplayed,
00256             EEventMoreContentDisplayed,
00257             EEventUrlLoadingFinished,           
00258 
00262             EEventLoadFinished,
00263             EEventContentFinished,  
00264 
00268             EEventTitleAvailable,
00269             EEventLoadError,      
00270 
00274             EEventEnteringSecurePage,
00279             EEventExitingSecurePage,
00283             EEventSomeItemsNotSecure,
00287             EEventSubmittingToNonSecurePage,
00291             EEventRedirectConfirmation,
00295             EEventRepostConfirmation,
00299             EEventSecureItemInNonSecurePage,
00303             EEventAuthenticationFailed,
00307             EEventUploadStart,
00311             EEventUploadFinished,
00315             EEventUploadIncrement,
00316             EEventFaviconAvailable,
00317             EEventThumbnailAvailable
00318             };
00323         enum TBrCtlSettings
00324             {
00325             ESettingsUnknown = -1, 
00326 
00330             ESettingsSmallScreen = 0,
00335             ESettingsAutoLoadImages,
00343             ESettingsFontSize,
00348             ESettingsEmbedded,
00354             ESettingsTextWrapEnabled,
00359             ESettingsCookiesEnabled,
00366             ESettingsCSSFetchEnabled,
00372             ESettingsECMAScriptEnabled,
00380             ESettingsIMEINotifyEnabled,
00409             ESettingsCharacterset,
00414             ESettingsSendRefererHeader,
00426             ESettingsSecurityWarnings,
00431             ESettingsApId,
00432             ESettingsCurrentZoomLevelIndex, 
00433             ESettingsPageOverview,  
00434             ESettingsNumOfDownloads, 
00435 
00439             ESettingsLaunchAppUid,
00444             ESettingsLaunchViewId,
00448             ESettingsLaunchCustomMessageId, 
00449             ESettingsBackList, 
00450             ESettingsAutoRefresh, 
00451 
00456             ESettingsBrowserUtf8Encoding,
00457             ESettingsAutoFormFillEnabled, 
00458             ESettingsSavedPage,           
00459             ESettingsSmartLink,
00460             ESettingsAutoOpenDownloads, // For automatically open the downloaded files      
00461             ESettingsDisableFlash, 
00462             ESettingsMaxEnum              
00463             };
00464 
00468         enum TBrCtlFontSizeLevel
00469             {
00473             EFontSizeLevelAllSmall = 0,
00477             EFontSizeLevelSmaller,
00481             EFontSizeLevelNormal,
00485             EFontSizeLevelLarger,
00489             EFontSizeLevelAllLarge
00490             };
00494         enum TBrCtlCapabilities
00495             {
00499             ECapabilityDisplayScrollBar         = 0x0001,
00505             ECapabilityClientResolveEmbeddedURL = 0x0002,
00511             ECapabilityClientNotifyURL          = 0x0004,
00515             ECapabilityDisableInputAndPlugins   = 0x0008,
00519             ECapabilityFindItem                 = 0x0010,
00524             ECapabilityLoadHttpFw               = 0x0020,
00528             ECapabilityUseDlMgr                 = 0x0040,
00532             ECapabilityLaunchViewer             = 0x0080,
00533             ECapabilityGraphicalHistory     = 0x0100, 
00534             ECapabilitySavedPage        = 0x0200,  
00535             ECapabilityConfirmDownloads = 0x0400, 
00536             ECapabilityAutoFormFill     = 0x0800,
00537             ECapabilityCursorNavigation = 0x1000,
00538             ECapabilityGraphicalPage    = 0x2000,
00539             ECapabilityAccessKeys       = 0x4000,
00540             ECapabilityFavicon          = 0x8000,
00541             ECapabilityToolBar          = 0x00010000,
00542             ECapabilityWebKitLite       = 0x00020000
00543             };
00544 
00548         enum TBrCtlPageInfo
00549             {
00550             EPageInfoTitle = 0, 
00551             EPageInfoUrl,    
00552             EPageInfoContent, 
00553             EPageInfoSavedPage, 
00554             EPageInfoFocusedNodeUrl //< URL of the focused link. The function leaves if the focus is not on an anchor or imagemap
00555             };
00559         enum TBrCtlState
00560             {
00565             EStateImageMapView = 0,
00566             EStateHistoryView, 
00567             EStateThumbnailView, 
00568             EStateWmlView,        
00569             EStateSmartTextView,   
00570             EStateToolBarMode,      
00571             EStatePluginPlayer
00572             };
00576         enum TBrCtlElementType
00577             {
00578             EElementNone = 0, 
00579             EElementImageBox, 
00580 
00585             EElementAnchor,
00586             EElementTelAnchor, 
00587             EElementMailtoAnchor, 
00588             EElementInputBox, 
00589             EElementActivatedInputBox, 
00590 
00594             EElementSelectBox,
00598             EElementButton,
00599             EElementTextAreaBox, 
00600             EElementRootBox, 
00601             EElementObjectBox, 
00602 
00606             EElementActivatedObjectBox,
00607             EElementDownloadedObjectBox, 
00608             EElementFileSelectionBoxNoContent, 
00609             EElementFileSelectionBoxWithContent, 
00610             EElementAreaBox, 
00611             EElementCheckBoxChecked, 
00612             EElementCheckBoxUnChecked, 
00613             EElementRadioButtonSelected, 
00614             EElementRadioButtonUnSelected, 
00615 
00616             EElementMouseButtonListener, 
00617             EElementScrollBar,    
00618 
00619             EElementSmartLinkTel, 
00620             EElementSmartLinkEmail, 
00621             EElementBrokenImage, 
00622             EElementSmartLinkVoip 
00623         };
00624 
00628         enum TBrCtlNavigationDirection
00629             {
00630             ENavigationBack, 
00631             ENavigationForward 
00632             };
00636         enum TBrCtlVersionInfo
00637           {
00638           EVersionInfoName = 0, 
00639           EVersionInfoVersion,  
00640           EVersionInfoBuild     
00641           };
00642 
00646         enum TBrCtlParams
00647             {
00648             EParamsUnknown = -1, 
00649 
00652             EParamsSelfDownoadableTypes = 0,
00656             EParamsRequestHeaders,
00657             EParamsMax 
00658             };
00659 
00663     enum TBrCtlFindResponse
00664       {
00665       EFindNoMatches = 0, 
00666       EFindWrapAround,    
00667       EFindAllMatches,    
00668       EFindMatch          
00669       };
00670 
00675         enum TBrCtlMethod
00676             {
00680             EMethodGet,
00684             EMethodPost
00685             };
00690       enum TBrCtlDownloadCmd
00691       {
00696       EDownloadCmdPause,
00701       EDownloadCmdResume,
00706       EDownloadCmdCancel,
00711       EDownloadCmdMarkAsProgressive,
00716       EDownloadCmdMarkAsNotProgressive
00717       };
00718 
00719     enum TBrCtlBitmapInfo
00720       {
00721       EBitmapThumbnail = 0,
00722       EBitmapFavicon
00723       };
00724 
00728     enum TBrCtlClientCommands
00729         {
00730         EClientCommandLaunchFindKeyword = 0,
00731         EClientCommandSubscribeToFeeds,
00732         EClientCommandShowContextMenu
00733         };
00734 
00738     enum TBrCtlWidgetParams
00739         {
00740         EWidgetIdentifier = 0,
00741         EWidgetBundleId,
00742         EWidgetBasePath
00743         };
00744         
00748     enum TBrCtlOrientation
00749         {
00750         EOrientationUndefined = 0,
00751         EOrientationLandscape,
00752         EOrientationPortrait
00753         };
00754 
00755     };
00756 
00757 // BRCTLDEFS_H
00758 #endif
00759 
00760 // End of File

Copyright © Nokia Corporation 2001-2008
Back to top