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 
00219             ECommandFindItemVoIPAddress, 
00220             ECommandSmartLinkMakeVoipCall,   
00221 
00224             ECommandZoomSliderShow, 
00225             ECommandZoomSliderHide, 
00226             ECommandHistoryNavigateForward,
00227             ECommandHistoryNavigateBack,
00228             /*
00229              ** Enter/Exit Fullscreen Browsing
00230              */
00231              ECommandEnterFullscreenBrowsing,
00232              ECommandLeaveFullscreenBrowsing,
00233              ECommandZoomIn,
00234              ECommandZoomOut
00235             };
00239         enum TBrCtlLoadEvent
00240             {
00241             EEventNone = 0,                     // Non event, Not used.
00246             EEventNewContentStart,
00250             EEventUrlLoadingStart,
00255             EEventNewUrlContentArrived,
00260             EEventMoreUrlContentArrived,
00265             EEventNewContentDisplayed,
00270             EEventMoreContentDisplayed,
00271             EEventUrlLoadingFinished,           
00272 
00276             EEventLoadFinished,
00277             EEventContentFinished,  
00278 
00282             EEventTitleAvailable,
00283             EEventLoadError,      
00284 
00288             EEventEnteringSecurePage,
00293             EEventExitingSecurePage,
00297             EEventSomeItemsNotSecure,
00301             EEventSubmittingToNonSecurePage,
00305             EEventRedirectConfirmation,
00309             EEventRepostConfirmation,
00313             EEventSecureItemInNonSecurePage,
00317             EEventAuthenticationFailed,
00321             EEventUploadStart,
00325             EEventUploadFinished,
00329             EEventUploadIncrement,
00330             EEventFaviconAvailable,
00331             EEventThumbnailAvailable
00332             };
00337         enum TBrCtlSettings
00338             {
00339             ESettingsUnknown = -1, 
00340 
00344             ESettingsSmallScreen = 0,
00349             ESettingsAutoLoadImages,
00357             ESettingsFontSize,
00362             ESettingsEmbedded,
00368             ESettingsTextWrapEnabled,
00373             ESettingsCookiesEnabled,
00380             ESettingsCSSFetchEnabled,
00386             ESettingsECMAScriptEnabled,
00394             ESettingsIMEINotifyEnabled,
00423             ESettingsCharacterset,
00428             ESettingsSendRefererHeader,
00440             ESettingsSecurityWarnings,
00445             ESettingsApId,
00446             ESettingsCurrentZoomLevelIndex, 
00447             ESettingsPageOverview,  
00448             ESettingsNumOfDownloads, 
00449 
00453             ESettingsLaunchAppUid,
00458             ESettingsLaunchViewId,
00462             ESettingsLaunchCustomMessageId, 
00463             ESettingsBackList, 
00464             ESettingsAutoRefresh, 
00465 
00470             ESettingsBrowserUtf8Encoding,
00471             ESettingsAutoFormFillEnabled, 
00472             ESettingsSavedPage,           
00473             ESettingsSmartLink,
00474             ESettingsAutoOpenDownloads, // For automatically open the downloaded files
00475             ESettingsDisableFlash, 
00476             ESettingsScriptLog,         
00477 
00480             ESettingsToolbarOnOff,
00481             ESettingsToolbarButton1Cmd,
00482             ESettingsToolbarButton2Cmd,
00483             ESettingsToolbarButton3Cmd,
00484             ESettingsToolbarButton4Cmd,
00485             ESettingsToolbarButton5Cmd,
00486             ESettingsToolbarButton6Cmd,
00487             ESettingsToolbarButton7Cmd,
00491             ESettingsZoomLevelMin,          
00492             ESettingsZoomLevelMax,          
00493             ESettingsZoomLevelDefault,      
00494             ESettingsMaxEnum              
00495             };
00496 
00500         enum TBrCtlFontSizeLevel
00501             {
00505             EFontSizeLevelAllSmall = 0,
00509             EFontSizeLevelSmaller,
00513             EFontSizeLevelNormal,
00517             EFontSizeLevelLarger,
00521             EFontSizeLevelAllLarge
00522             };
00526         enum TBrCtlCapabilities
00527             {
00531             ECapabilityDisplayScrollBar         = 0x0001,
00537             ECapabilityClientResolveEmbeddedURL = 0x0002,
00543             ECapabilityClientNotifyURL          = 0x0004,
00547             ECapabilityDisableInputAndPlugins   = 0x0008,
00551             ECapabilityFindItem                 = 0x0010,
00556             ECapabilityLoadHttpFw               = 0x0020,
00560             ECapabilityUseDlMgr                 = 0x0040,
00564             ECapabilityLaunchViewer             = 0x0080,
00565             ECapabilityGraphicalHistory     = 0x0100, 
00566             ECapabilitySavedPage        = 0x0200,  
00567             ECapabilityConfirmDownloads = 0x0400, 
00568             ECapabilityAutoFormFill     = 0x0800,
00569             ECapabilityCursorNavigation = 0x1000,
00570             ECapabilityGraphicalPage    = 0x2000,
00571             ECapabilityAccessKeys       = 0x4000,
00572             ECapabilityFavicon          = 0x8000,
00573             ECapabilityToolBar          = 0x00010000,
00574             ECapabilityWebKitLite       = 0x00020000,
00575             ECapabilityFitToScreen      = 0x00040000
00576             };
00577 
00581         enum TBrCtlPageInfo
00582             {
00583             EPageInfoTitle = 0, 
00584             EPageInfoUrl,    
00585             EPageInfoContent, 
00586             EPageInfoSavedPage, 
00587             EPageInfoFocusedNodeUrl //< URL of the focused link. The function leaves if the focus is not on an anchor or imagemap
00588             };
00592         enum TBrCtlState
00593             {
00598             EStateImageMapView = 0,
00599             EStateHistoryView, 
00600             EStateThumbnailView, 
00601             EStateWmlView,        
00602             EStateSmartTextView,   
00603             EStateToolBarMode,      
00604             EStatePluginPlayer,
00605             EStateScriptLog,
00606             EStateZoomSliderMode,    
00607             EStateFullscreenBrowsing,    
00608             EStateHistoryBeginning,
00609             EStateHistoryEnd,
00610             EStateSynchRequestMode,  
00611             EStatePluginFullScreen
00612             };
00616         enum TBrCtlElementType
00617             {
00618             EElementNone = 0, 
00619             EElementImageBox, 
00620 
00625             EElementAnchor,
00626             EElementTelAnchor, 
00627             EElementMailtoAnchor, 
00628             EElementInputBox, 
00629             EElementActivatedInputBox, 
00630 
00634             EElementSelectBox,
00638             EElementButton,
00639             EElementTextAreaBox, 
00640             EElementRootBox, 
00641             EElementObjectBox, 
00642 
00646             EElementActivatedObjectBox,
00647             EElementDownloadedObjectBox, 
00648             EElementFileSelectionBoxNoContent, 
00649             EElementFileSelectionBoxWithContent, 
00650             EElementAreaBox, 
00651             EElementCheckBoxChecked, 
00652             EElementCheckBoxUnChecked, 
00653             EElementRadioButtonSelected, 
00654             EElementRadioButtonUnSelected, 
00655 
00656             EElementMouseButtonListener, 
00657             EElementScrollBar,    
00658 
00659             EElementSmartLinkTel, 
00660             EElementSmartLinkEmail, 
00661             EElementBrokenImage, 
00662             EElementSmartLinkVoip, 
00663             EElementSelectMultiBox 
00664         };
00665 
00669         enum TBrCtlNavigationDirection
00670             {
00671             ENavigationBack, 
00672             ENavigationForward 
00673             };
00674 
00678         enum TBrCtlVersionInfo
00679           {
00680           EVersionInfoName = 0, 
00681           EVersionInfoVersion,  
00682           EVersionInfoBuild,    
00683           EBrowserVersion   
00684           };
00685 
00689         enum TBrCtlParams
00690             {
00691             EParamsUnknown = -1, 
00692 
00695             EParamsSelfDownoadableTypes = 0,
00699             EParamsRequestHeaders,
00700             EParamsMax 
00701             };
00702 
00706     enum TBrCtlFindResponse
00707       {
00708       EFindNoMatches = 0, 
00709       EFindWrapAround,    
00710       EFindAllMatches,    
00711       EFindMatch          
00712       };
00713 
00718         enum TBrCtlMethod
00719             {
00723             EMethodGet,
00727             EMethodPost
00728             };
00733       enum TBrCtlDownloadCmd
00734       {
00739       EDownloadCmdPause,
00744       EDownloadCmdResume,
00749       EDownloadCmdCancel,
00754       EDownloadCmdMarkAsProgressive,
00759       EDownloadCmdMarkAsNotProgressive
00760       };
00761 
00762     enum TBrCtlBitmapInfo
00763       {
00764       EBitmapThumbnail = 0,
00765       EBitmapFavicon
00766       };
00767 
00771     enum TBrCtlClientCommands
00772         {
00773         EClientCommandLaunchFindKeyword = 0,
00774         EClientCommandSubscribeToFeeds,
00775         EClientCommandShowContextMenu,
00776         EClientCommandToolbarSettings,
00777         EClientCommandGotoWebAddress,
00778         EClientCommandManageBookmarks,
00779         EClientCommandSaveAsBookmark,
00780         EClientCommandZoomIn,
00781         EClientCommandZoomOut,
00782         EClientCommandGoToHompage,
00783         EClientCommandRotateScreen,
00784         EClientCommandSavePage,
00785         EClientCommandSwitchWindow,
00786         EClientCommandShowHelp,
00787         EClientCommandToolbarConfigure,
00788         EClientCommandToolbarShowKeymap,
00789         EClientCommandFullScreen,
00790         EClientCommandZoomMode
00791         };
00792 
00796     enum TBrCtlWidgetParams
00797         {
00798         EWidgetIdentifier = 0,
00799         EWidgetBundleId,
00800         EWidgetBasePath,
00801         EWidgetPublishState
00802         };
00803 
00807     enum TBrCtlOrientation
00808         {
00809         EOrientationUndefined = 0,
00810         EOrientationLandscape,
00811         EOrientationPortrait
00812         };
00813 
00817     enum TBrCtlScriptLog
00818             {
00822             EScriptLogDisable,
00826             EScriptLogToFile,
00830             EScriptLogToConsole,
00834             EScriptLogToConsoleFile
00835             };
00836 
00837     enum TBrCtlFormData
00838         {
00839         EFormDataOff,
00840         EFormDataOnly,
00841         EFormDataPlusPassword
00842         };
00843     };
00844 
00845 #endif      // BRCTLDEFS_H
00846 
00847 // End of File

Copyright © Nokia Corporation 2001-2007
Back to top