web_plat/launcher_api/inc/BrowserOverriddenSettings.h
changeset 0 dd21522fd290
child 17 c8a366e56285
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  enables other applications to launch browser in embedded mode
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef BROWSER_OVERRIDDEN_SETTINGS_H
       
    20 #define BROWSER_OVERRIDDEN_SETTINGS_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32std.h>
       
    24 #include <e32def.h>
       
    25 
       
    26 // DATA TYPES
       
    27 typedef enum
       
    28 {
       
    29     EBrowserOverSettingsSmallScreen = 0,
       
    30     EBrowserOverSettingsAutoLoadImages,
       
    31     EBrowserOverSettingsFontSize,
       
    32     EBrowserOverSettingsFullScreen,
       
    33     EBrowserOverSettingsCustomAp,
       
    34     EBrowserOverSettingsContextId,
       
    35     EBrowserOverSettingsUndefinied = KMaxTUint16
       
    36 } TBrowserOverSettings;
       
    37 
       
    38 typedef enum 
       
    39 {
       
    40   EBrowserOverFontSizeLevelAllSmall = 0,
       
    41   EBrowserOverFontSizeLevelSmaller,
       
    42   EBrowserOverFontSizeLevelNormal,
       
    43   EBrowserOverFontSizeLevelLarger,    
       
    44   EBrowserOverFontSizeLevelAllLarge,
       
    45   EBrowserOverFontSizeLevelUndefined = KMaxTUint16
       
    46 } TBrowserOverFontSizeLevel;
       
    47 
       
    48 typedef enum 
       
    49 {
       
    50   EBrowserOverFullScreenValueNormal = 0,
       
    51   EBrowserOverFullScreenValueSoftKeysOnly,
       
    52   EBrowserOverFullScreenValueFullScreen,
       
    53   EBrowserOverFullScreenValueUndefined = KMaxTUint16
       
    54 } TBrowserOverFullScreenValue;
       
    55 
       
    56 typedef enum
       
    57 {
       
    58   EBrowserContextIdNormal = 0,
       
    59   EBrowserContextIdFeeds,
       
    60   EBrowserContextIdUndefined = KMaxTUint16
       
    61 } TBrowserOverContextId;
       
    62 
       
    63 // CLASS DECLARATION
       
    64 
       
    65 /**
       
    66 *  This class stores values to pass to the browser in embedded mode
       
    67 *
       
    68 */
       
    69 class TBrowserOverriddenSettings
       
    70 {
       
    71 public :// Constructors and destructor 
       
    72    inline TBrowserOverriddenSettings();
       
    73 
       
    74 public: // New functions
       
    75    /**
       
    76    * SetBrowserSetting sets the the settings which will be overriden
       
    77    * @param aBrowserSetting describes which type of setting to set
       
    78    * @param aValue the value to set
       
    79    * @return void
       
    80    */
       
    81    inline void SetBrowserSetting(TBrowserOverSettings aBrowserSetting, TUint aValue);
       
    82    
       
    83    /**
       
    84    * GetBrowserSetting gets the value of the setting
       
    85    * @param aBrowserSetting describes which type of setting to get
       
    86    * @return the value of the setting
       
    87    */
       
    88    inline TUint GetBrowserSetting(TBrowserOverSettings aBrowserSetting);
       
    89 private:// Data
       
    90    //stores the value for the small screen setting can be 0 or 1
       
    91    //if not set then KMaxUint
       
    92    TUint iSmallScreen;
       
    93    //stores the value for the auto load image setting can be 0 or 1
       
    94    //if not set then KMaxUint
       
    95    TUint iAutoLoadImage;
       
    96    //stores the value for the font size setting can be 0,1,2,3 or 4
       
    97    TUint iFontSize;
       
    98    //stores the value for the small screen setting can be 0 or 1
       
    99    TUint iFullScreen;
       
   100    // Custom access point provided by the operator. If specified, contains an id of a read only
       
   101    // access point what is then set as default  and it cannot be changed manually. If not 
       
   102    // defined, operator menu works as before.
       
   103    // from operator menu( 0 - not specified, otherwise contains the access point id)
       
   104    TUint iCustomAp;
       
   105    // Allow the contextId of the call to be passed as a parameter
       
   106    TUint iContextId;   
       
   107 };
       
   108 
       
   109 #include <BrowserOverriddenSettings.inl>
       
   110 
       
   111 #endif  //BROWSER_OVERRIDDEN_SETTINGS_H