S60 3rd Edition API Reference: brctldefs.h Source 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 #start_since SINCE_3_1_SDK
00198             ,ECommandAppForeground, 
00199             ECommandAppBackground, 
00200             ECommandOpenNewWindow, 
00201             ECommandClearAutoFormFillData, 
00202             ECommandClearAutoFormFillPasswordData, 
00203             ECommandFreeMemory, 
00204             ECommandMemoryGood, 
00205             ECommandDumpRenderTree, 
00206             ECommandUnloadWMLEngine, 
00207             ECommandSmartLinkMakeCall, 
00208             ECommandSmartLinkSendMessage, 
00209             ECommandSmartLinkAddToPhoneBook, 
00210             ECommandShowToolBar 
00211 #end_since SINCE_3_1_SDK
00212             };
00216         enum TBrCtlLoadEvent
00217             {
00218             EEventNone = 0,                     // Non event, Not used.
00223             EEventNewContentStart,
00227             EEventUrlLoadingStart,
00232             EEventNewUrlContentArrived,
00237             EEventMoreUrlContentArrived,
00242             EEventNewContentDisplayed,
00247             EEventMoreContentDisplayed,
00248             EEventUrlLoadingFinished,           
00249 
00253             EEventLoadFinished,
00254             EEventContentFinished,  
00255 
00259             EEventTitleAvailable,
00260             EEventLoadError,      
00261 
00265             EEventEnteringSecurePage,
00270             EEventExitingSecurePage,
00274             EEventSomeItemsNotSecure,
00278             EEventSubmittingToNonSecurePage,
00282             EEventRedirectConfirmation,
00286             EEventRepostConfirmation,
00290             EEventSecureItemInNonSecurePage,
00294             EEventAuthenticationFailed,
00298             EEventUploadStart,
00302             EEventUploadFinished,
00306             EEventUploadIncrement,
00307             EEventFaviconAvailable,
00308             EEventThumbnailAvailable
00309             };
00314         enum TBrCtlSettings
00315             {
00316             ESettingsUnknown = -1, 
00317 
00321             ESettingsSmallScreen = 0,
00326             ESettingsAutoLoadImages,
00334             ESettingsFontSize,
00339             ESettingsEmbedded,
00345             ESettingsTextWrapEnabled,
00350             ESettingsCookiesEnabled,
00357             ESettingsCSSFetchEnabled,
00363             ESettingsECMAScriptEnabled,
00371             ESettingsIMEINotifyEnabled,
00400             ESettingsCharacterset,
00405             ESettingsSendRefererHeader,
00417             ESettingsSecurityWarnings,
00422             ESettingsApId,
00423             ESettingsCurrentZoomLevelIndex, 
00424             ESettingsPageOverview,  
00425             ESettingsNumOfDownloads, 
00426 
00430             ESettingsLaunchAppUid,
00435             ESettingsLaunchViewId,
00439             ESettingsLaunchCustomMessageId, 
00440             ESettingsBackList, 
00441             ESettingsAutoRefresh, 
00442 
00447             ESettingsBrowserUtf8Encoding,
00448 #start_since SINCE_3_1_SDK
00449             ESettingsAutoFormFillEnabled, 
00450             ESettingsSavedPage,           
00451             ESettingsSmartLink,
00452 #end_since SINCE_3_1_SDK
00453             ESettingsMaxEnum              
00454             };
00455 
00459         enum TBrCtlFontSizeLevel
00460             {
00464             EFontSizeLevelAllSmall = 0,
00468             EFontSizeLevelSmaller,
00472             EFontSizeLevelNormal,
00476             EFontSizeLevelLarger,
00480             EFontSizeLevelAllLarge
00481             };
00485         enum TBrCtlCapabilities
00486             {
00490             ECapabilityDisplayScrollBar         = 0x0001,
00496             ECapabilityClientResolveEmbeddedURL = 0x0002,
00502             ECapabilityClientNotifyURL          = 0x0004,
00506             ECapabilityDisableInputAndPlugins   = 0x0008,
00510             ECapabilityFindItem                 = 0x0010,
00515             ECapabilityLoadHttpFw               = 0x0020,
00519             ECapabilityUseDlMgr                 = 0x0040,
00523             ECapabilityLaunchViewer             = 0x0080,
00524             ECapabilityGraphicalHistory     = 0x0100, 
00525             ECapabilitySavedPage        = 0x0200,  
00526             ECapabilityConfirmDownloads = 0x0400 
00527 #start_since SINCE_3_1_SDK
00528             ,ECapabilityAutoFormFill     = 0x0800,
00529             ECapabilityCursorNavigation = 0x1000,
00530             ECapabilityGraphicalPage    = 0x2000,
00531             ECapabilityAccessKeys       = 0x4000,
00532             ECapabilityFavicon          = 0x8000,
00533             ECapabilityToolBar          = 0x00010000
00534 #end_since SINCE_3_1_SDK
00535             };
00536 
00540         enum TBrCtlPageInfo
00541             {
00542             EPageInfoTitle = 0, 
00543             EPageInfoUrl,    
00544             EPageInfoContent, 
00545             EPageInfoSavedPage 
00546             };
00550         enum TBrCtlState
00551             {
00556             EStateImageMapView = 0,
00557             EStateHistoryView, 
00558             EStateThumbnailView 
00559 #start_since SINCE_3_1_SDK
00560             ,EStateWmlView,        
00561             EStateSmartTextView,   
00562             EStateToolBarMode,      
00563             EStatePluginPlayer
00564 #end_since SINCE_3_1_SDK
00565             };
00569         enum TBrCtlElementType
00570             {
00571             EElementNone = 0, 
00572             EElementImageBox, 
00573 
00578             EElementAnchor,
00579             EElementTelAnchor, 
00580             EElementMailtoAnchor, 
00581             EElementInputBox, 
00582             EElementActivatedInputBox, 
00583 
00587             EElementSelectBox,
00591             EElementButton,
00592             EElementTextAreaBox, 
00593             EElementRootBox, 
00594             EElementObjectBox, 
00595 
00599             EElementActivatedObjectBox,
00600             EElementDownloadedObjectBox, 
00601             EElementFileSelectionBoxNoContent, 
00602             EElementFileSelectionBoxWithContent, 
00603             EElementAreaBox, 
00604             EElementCheckBoxChecked, 
00605             EElementCheckBoxUnChecked, 
00606             EElementRadioButtonSelected, 
00607             EElementRadioButtonUnSelected 
00608 
00609 #start_since SINCE_3_1_SDK
00610             ,EElementMouseButtonListener, 
00611             EElementScrollBar,    
00612 
00613             EElementSmartLinkTel, 
00614             EElementSmartLinkEmail 
00615 #end_since SINCE_3_1_SDK
00616         };
00617 
00621         enum TBrCtlNavigationDirection
00622             {
00623             ENavigationBack, 
00624             ENavigationForward 
00625             };
00629         enum TBrCtlVersionInfo
00630           {
00631           EVersionInfoName = 0, 
00632           EVersionInfoVersion,  
00633           EVersionInfoBuild     
00634           };
00635 
00639         enum TBrCtlParams
00640             {
00641             EParamsUnknown = -1, 
00642 
00645             EParamsSelfDownoadableTypes = 0,
00649             EParamsRequestHeaders,
00650             EParamsMax 
00651             };
00652 
00656     enum TBrCtlFindResponse
00657       {
00658       EFindNoMatches = 0, 
00659       EFindWrapAround,    
00660       EFindAllMatches,    
00661       EFindMatch          
00662       };
00663 
00668         enum TBrCtlMethod
00669             {
00673             EMethodGet,
00677             EMethodPost
00678             };
00683       enum TBrCtlDownloadCmd
00684       {
00689       EDownloadCmdPause,
00694       EDownloadCmdResume,
00699       EDownloadCmdCancel,
00704       EDownloadCmdMarkAsProgressive,
00709       EDownloadCmdMarkAsNotProgressive
00710       };
00711 
00712 #start_since SINCE_3_1_SDK
00713 
00716     enum TBrCtlBitmapInfo
00717       {
00718       EBitmapThumbnail = 0,
00719       EBitmapFavicon
00720       };
00721 #end_since SINCE_3_1_SDK
00722 
00723 #start_since SINCE_3_1_SDK
00724 
00728     enum TBrCtlClientCommands
00729         {
00730         EClientCommandLaunchFindKeyword = 0,
00731         EClientCommandSubscribeToFeeds
00732         };
00733 #end_since SINCE_3_1_SDK
00734 #ifdef  RD_BROWSER_WIDGETS
00735 
00738     enum TBrCtlWidgetParams
00739         {
00740         EWidgetIdentifier = 0,
00741         EWidgetBundleId,
00742         EWidgetBasePath
00743         };
00744 //RD_BROWSER_WIDGETS
00745 #endif
00746     };
00747 
00748 // BRCTLDEFS_H
00749 #endif
00750 
00751 // End of File