webengine/osswebengine/WebKit/win/WebPreferences.h
changeset 0 dd21522fd290
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2  * Copyright (C) 2006, 2007 Apple Inc.  All rights reserved.
       
     3  *
       
     4  * Redistribution and use in source and binary forms, with or without
       
     5  * modification, are permitted provided that the following conditions
       
     6  * are met:
       
     7  * 1. Redistributions of source code must retain the above copyright
       
     8  *    notice, this list of conditions and the following disclaimer.
       
     9  * 2. Redistributions in binary form must reproduce the above copyright
       
    10  *    notice, this list of conditions and the following disclaimer in the
       
    11  *    documentation and/or other materials provided with the distribution.
       
    12  *
       
    13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
       
    14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
       
    15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
       
    16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
       
    17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
       
    18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
       
    19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
       
    20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
       
    21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
       
    22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
       
    23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
       
    24  */
       
    25 
       
    26 #ifndef WebPreferences_H
       
    27 #define WebPreferences_H
       
    28 
       
    29 #include "IWebPreferences.h"
       
    30 #include "IWebPreferencesPrivate.h"
       
    31 #include <CoreFoundation/CoreFoundation.h>
       
    32 #include <WebCore/BString.h>
       
    33 #include <wtf/RetainPtr.h>
       
    34 
       
    35 // {A20B5645-692D-4147-BF80-E8CD84BE82A1}
       
    36 DEFINE_GUID(IID_WebPreferences, 0xa20b5645, 0x692d, 0x4147, 0xbf, 0x80, 0xe8, 0xcd, 0x84, 0xbe, 0x82, 0xa1);
       
    37 
       
    38 class WebPreferences : public IWebPreferences, public IWebPreferencesPrivate {
       
    39 public:
       
    40     static WebPreferences* createInstance();
       
    41 protected:
       
    42     WebPreferences();
       
    43     ~WebPreferences();
       
    44 
       
    45 public:
       
    46     // IUnknown
       
    47     virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID riid, void** ppvObject);
       
    48     virtual ULONG STDMETHODCALLTYPE AddRef(void);
       
    49     virtual ULONG STDMETHODCALLTYPE Release(void);
       
    50 
       
    51     // IWebPreferences
       
    52     virtual HRESULT STDMETHODCALLTYPE standardPreferences( 
       
    53         /* [retval][out] */ IWebPreferences** standardPreferences);
       
    54     
       
    55     virtual HRESULT STDMETHODCALLTYPE initWithIdentifier( 
       
    56         /* [in] */ BSTR anIdentifier,
       
    57         /* [retval][out] */ IWebPreferences** preferences);
       
    58     
       
    59     virtual HRESULT STDMETHODCALLTYPE identifier( 
       
    60         /* [retval][out] */ BSTR* ident);
       
    61     
       
    62     virtual HRESULT STDMETHODCALLTYPE standardFontFamily( 
       
    63         /* [retval][out] */ BSTR* family);
       
    64     
       
    65     virtual HRESULT STDMETHODCALLTYPE setStandardFontFamily( 
       
    66         /* [in] */ BSTR family);
       
    67     
       
    68     virtual HRESULT STDMETHODCALLTYPE fixedFontFamily( 
       
    69         /* [retval][out] */ BSTR* family);
       
    70     
       
    71     virtual HRESULT STDMETHODCALLTYPE setFixedFontFamily( 
       
    72         /* [in] */ BSTR family);
       
    73     
       
    74     virtual HRESULT STDMETHODCALLTYPE serifFontFamily( 
       
    75         /* [retval][out] */ BSTR* fontFamily);
       
    76     
       
    77     virtual HRESULT STDMETHODCALLTYPE setSerifFontFamily( 
       
    78         /* [in] */ BSTR family);
       
    79     
       
    80     virtual HRESULT STDMETHODCALLTYPE sansSerifFontFamily( 
       
    81         /* [retval][out] */ BSTR* family);
       
    82     
       
    83     virtual HRESULT STDMETHODCALLTYPE setSansSerifFontFamily( 
       
    84         /* [in] */ BSTR family);
       
    85     
       
    86     virtual HRESULT STDMETHODCALLTYPE cursiveFontFamily( 
       
    87         /* [retval][out] */ BSTR* family);
       
    88     
       
    89     virtual HRESULT STDMETHODCALLTYPE setCursiveFontFamily( 
       
    90         /* [in] */ BSTR family);
       
    91     
       
    92     virtual HRESULT STDMETHODCALLTYPE fantasyFontFamily( 
       
    93         /* [retval][out] */ BSTR* family);
       
    94     
       
    95     virtual HRESULT STDMETHODCALLTYPE setFantasyFontFamily( 
       
    96         /* [in] */ BSTR family);
       
    97     
       
    98     virtual HRESULT STDMETHODCALLTYPE defaultFontSize( 
       
    99         /* [retval][out] */ int* fontSize);
       
   100     
       
   101     virtual HRESULT STDMETHODCALLTYPE setDefaultFontSize( 
       
   102         /* [in] */ int fontSize);
       
   103     
       
   104     virtual HRESULT STDMETHODCALLTYPE defaultFixedFontSize( 
       
   105         /* [retval][out] */ int* fontSize);
       
   106     
       
   107     virtual HRESULT STDMETHODCALLTYPE setDefaultFixedFontSize( 
       
   108         /* [in] */ int fontSize);
       
   109     
       
   110     virtual HRESULT STDMETHODCALLTYPE minimumFontSize( 
       
   111         /* [retval][out] */ int* fontSize);
       
   112     
       
   113     virtual HRESULT STDMETHODCALLTYPE setMinimumFontSize( 
       
   114         /* [in] */ int fontSize);
       
   115     
       
   116     virtual HRESULT STDMETHODCALLTYPE minimumLogicalFontSize( 
       
   117         /* [retval][out] */ int* fontSize);
       
   118     
       
   119     virtual HRESULT STDMETHODCALLTYPE setMinimumLogicalFontSize( 
       
   120         /* [in] */ int fontSize);
       
   121     
       
   122     virtual HRESULT STDMETHODCALLTYPE defaultTextEncodingName( 
       
   123         /* [retval][out] */ BSTR* name);
       
   124     
       
   125     virtual HRESULT STDMETHODCALLTYPE setDefaultTextEncodingName( 
       
   126         /* [in] */ BSTR name);
       
   127     
       
   128     virtual HRESULT STDMETHODCALLTYPE userStyleSheetEnabled( 
       
   129         /* [retval][out] */ BOOL* enabled);
       
   130     
       
   131     virtual HRESULT STDMETHODCALLTYPE setUserStyleSheetEnabled( 
       
   132         /* [in] */ BOOL enabled);
       
   133     
       
   134     virtual HRESULT STDMETHODCALLTYPE userStyleSheetLocation( 
       
   135         /* [retval][out] */ BSTR* location);
       
   136     
       
   137     virtual HRESULT STDMETHODCALLTYPE setUserStyleSheetLocation( 
       
   138         /* [in] */ BSTR location);
       
   139     
       
   140     virtual HRESULT STDMETHODCALLTYPE isJavaEnabled( 
       
   141         /* [retval][out] */ BOOL* enabled);
       
   142     
       
   143     virtual HRESULT STDMETHODCALLTYPE setJavaEnabled( 
       
   144         /* [in] */ BOOL enabled);
       
   145     
       
   146     virtual HRESULT STDMETHODCALLTYPE isJavaScriptEnabled( 
       
   147         /* [retval][out] */ BOOL* enabled);
       
   148     
       
   149     virtual HRESULT STDMETHODCALLTYPE setJavaScriptEnabled( 
       
   150         /* [in] */ BOOL enabled);
       
   151     
       
   152     virtual HRESULT STDMETHODCALLTYPE javaScriptCanOpenWindowsAutomatically( 
       
   153         /* [retval][out] */ BOOL* enabled);
       
   154     
       
   155     virtual HRESULT STDMETHODCALLTYPE setJavaScriptCanOpenWindowsAutomatically( 
       
   156         /* [in] */ BOOL enabled);
       
   157     
       
   158     virtual HRESULT STDMETHODCALLTYPE arePlugInsEnabled( 
       
   159         /* [retval][out] */ BOOL* enabled);
       
   160     
       
   161     virtual HRESULT STDMETHODCALLTYPE setPlugInsEnabled( 
       
   162         /* [in] */ BOOL enabled);
       
   163     
       
   164     virtual HRESULT STDMETHODCALLTYPE allowsAnimatedImages( 
       
   165         /* [retval][out] */ BOOL* enabled);
       
   166     
       
   167     virtual HRESULT STDMETHODCALLTYPE setAllowsAnimatedImages( 
       
   168         /* [in] */ BOOL enabled);
       
   169     
       
   170     virtual HRESULT STDMETHODCALLTYPE allowAnimatedImageLooping( 
       
   171         /* [retval][out] */ BOOL* enabled);
       
   172     
       
   173     virtual HRESULT STDMETHODCALLTYPE setAllowAnimatedImageLooping( 
       
   174         /* [in] */ BOOL enabled);
       
   175     
       
   176     virtual HRESULT STDMETHODCALLTYPE setLoadsImagesAutomatically( 
       
   177         /* [in] */ BOOL enabled);
       
   178     
       
   179     virtual HRESULT STDMETHODCALLTYPE loadsImagesAutomatically( 
       
   180         /* [retval][out] */ BOOL* enabled);
       
   181     
       
   182     virtual HRESULT STDMETHODCALLTYPE setAutosaves( 
       
   183         /* [in] */ BOOL enabled);
       
   184     
       
   185     virtual HRESULT STDMETHODCALLTYPE autosaves( 
       
   186         /* [retval][out] */ BOOL* enabled);
       
   187     
       
   188     virtual HRESULT STDMETHODCALLTYPE setShouldPrintBackgrounds( 
       
   189         /* [in] */ BOOL enabled);
       
   190     
       
   191     virtual HRESULT STDMETHODCALLTYPE shouldPrintBackgrounds( 
       
   192         /* [retval][out] */ BOOL* enabled);
       
   193     
       
   194     virtual HRESULT STDMETHODCALLTYPE setPrivateBrowsingEnabled( 
       
   195         /* [in] */ BOOL enabled);
       
   196     
       
   197     virtual HRESULT STDMETHODCALLTYPE privateBrowsingEnabled( 
       
   198         /* [retval][out] */ BOOL* enabled);
       
   199     
       
   200     virtual HRESULT STDMETHODCALLTYPE setTabsToLinks( 
       
   201         /* [in] */ BOOL enabled);
       
   202     
       
   203     virtual HRESULT STDMETHODCALLTYPE tabsToLinks( 
       
   204         /* [retval][out] */ BOOL* enabled);
       
   205 
       
   206     virtual HRESULT STDMETHODCALLTYPE textAreasAreResizable( 
       
   207         /* [retval][out] */ BOOL *enabled);
       
   208     
       
   209     virtual HRESULT STDMETHODCALLTYPE setTextAreasAreResizable( 
       
   210         /* [in] */ BOOL enabled);
       
   211 
       
   212     virtual HRESULT STDMETHODCALLTYPE usesPageCache( 
       
   213         /* [retval][out] */ BOOL *usesPageCache);
       
   214 
       
   215     virtual HRESULT STDMETHODCALLTYPE setUsesPageCache( 
       
   216         /* [in] */ BOOL usesPageCache);
       
   217 
       
   218     virtual HRESULT STDMETHODCALLTYPE pageCacheSize( 
       
   219         /* [retval][out] */ unsigned int *limit);
       
   220 
       
   221     virtual HRESULT STDMETHODCALLTYPE objectCacheSize( 
       
   222         /* [retval][out] */ unsigned int *limit);
       
   223     
       
   224     virtual HRESULT STDMETHODCALLTYPE iconDatabaseLocation(
       
   225         /* [retval][out] */ BSTR* location);
       
   226 
       
   227     virtual HRESULT STDMETHODCALLTYPE setIconDatabaseLocation(
       
   228         /* [in] */ BSTR location);
       
   229 
       
   230     virtual HRESULT STDMETHODCALLTYPE iconDatabaseEnabled(
       
   231         /* [retval][out] */ BOOL* enabled);
       
   232 
       
   233     virtual HRESULT STDMETHODCALLTYPE setIconDatabaseEnabled(
       
   234         /* [in] */ BOOL enabled);
       
   235 
       
   236     virtual HRESULT STDMETHODCALLTYPE fontSmoothing( 
       
   237         /* [retval][out] */ FontSmoothingType* smoothingType);
       
   238     
       
   239     virtual HRESULT STDMETHODCALLTYPE setFontSmoothing( 
       
   240         /* [in] */ FontSmoothingType smoothingType);
       
   241 
       
   242     virtual HRESULT STDMETHODCALLTYPE editableLinkBehavior( 
       
   243         /* [retval][out] */ WebKitEditableLinkBehavior* behavior);
       
   244     
       
   245     virtual HRESULT STDMETHODCALLTYPE setEditableLinkBehavior( 
       
   246         /* [in] */ WebKitEditableLinkBehavior behavior);
       
   247 
       
   248     virtual HRESULT STDMETHODCALLTYPE cookieStorageAcceptPolicy( 
       
   249         /* [retval][out] */ WebKitCookieStorageAcceptPolicy *acceptPolicy);
       
   250         
       
   251     virtual HRESULT STDMETHODCALLTYPE setCookieStorageAcceptPolicy( 
       
   252         /* [in] */ WebKitCookieStorageAcceptPolicy acceptPolicy);
       
   253 
       
   254     virtual HRESULT STDMETHODCALLTYPE continuousSpellCheckingEnabled( 
       
   255         /* [retval][out] */ BOOL *enabled);
       
   256     
       
   257     virtual HRESULT STDMETHODCALLTYPE setContinuousSpellCheckingEnabled( 
       
   258         /* [in] */ BOOL enabled);
       
   259     
       
   260     virtual HRESULT STDMETHODCALLTYPE grammarCheckingEnabled( 
       
   261         /* [retval][out] */ BOOL *enabled);
       
   262     
       
   263     virtual HRESULT STDMETHODCALLTYPE setGrammarCheckingEnabled( 
       
   264         /* [in] */ BOOL enabled);
       
   265 
       
   266     virtual HRESULT STDMETHODCALLTYPE allowContinuousSpellChecking( 
       
   267         /* [retval][out] */ BOOL *enabled);
       
   268     
       
   269     virtual HRESULT STDMETHODCALLTYPE setAllowContinuousSpellChecking( 
       
   270         /* [in] */ BOOL enabled);
       
   271 
       
   272     virtual HRESULT STDMETHODCALLTYPE isDOMPasteAllowed( 
       
   273         /* [retval][out] */ BOOL *enabled);
       
   274     
       
   275     virtual HRESULT STDMETHODCALLTYPE setDOMPasteAllowed( 
       
   276         /* [in] */ BOOL enabled);
       
   277 
       
   278     // IWebPreferencesPrivate
       
   279     virtual HRESULT STDMETHODCALLTYPE setDeveloperExtrasEnabled(
       
   280         /* [in] */ BOOL);
       
   281 
       
   282     virtual HRESULT STDMETHODCALLTYPE developerExtrasEnabled(
       
   283         /* [retval][out] */ BOOL*);
       
   284 
       
   285 
       
   286     // WebPreferences
       
   287 
       
   288     // This method accesses a different preference key than developerExtrasEnabled.
       
   289     // See <rdar://5343767> for the justification.
       
   290     bool developerExtrasDisabledByOverride();
       
   291 
       
   292     static BSTR webPreferencesChangedNotification();
       
   293     static void setInstance(WebPreferences* instance, BSTR identifier);
       
   294     static void removeReferenceForIdentifier(BSTR identifier);
       
   295     static WebPreferences* sharedStandardPreferences();
       
   296 
       
   297     // From WebHistory.h
       
   298     HRESULT historyItemLimit(int* limit);
       
   299     HRESULT setHistoryItemLimit(int limit);
       
   300     HRESULT historyAgeInDaysLimit(int* limit);
       
   301     HRESULT setHistoryAgeInDaysLimit(int limit);
       
   302 
       
   303 protected:
       
   304     HRESULT postPreferencesChangesNotification();
       
   305     const void* valueForKey(CFStringRef key);
       
   306     BSTR stringValueForKey(CFStringRef key);
       
   307     int integerValueForKey(CFStringRef key);
       
   308     BOOL boolValueForKey(CFStringRef key);
       
   309     float floatValueForKey(CFStringRef key);
       
   310     void setStringValue(CFStringRef key, LPCTSTR value);
       
   311     void setIntegerValue(CFStringRef key, int value);
       
   312     void setBoolValue(CFStringRef key, BOOL value);
       
   313     static WebPreferences* getInstanceForIdentifier(BSTR identifier);
       
   314     static void initializeDefaultSettings();
       
   315     void save();
       
   316     void load();
       
   317     void migrateDefaultSettingsFromSafari3Beta();
       
   318     void removeValuesMatchingDefaultSettings();
       
   319     static HRESULT preferencesPath(LPTSTR path, size_t cchPath);
       
   320     static HRESULT safeCreateFileWithData(LPCTSTR path, void* data, size_t length);
       
   321 
       
   322 protected:
       
   323     ULONG m_refCount;
       
   324     RetainPtr<CFMutableDictionaryRef> m_privatePrefs;
       
   325     bool m_autoSaves;
       
   326     WebCore::BString m_identifier;
       
   327     static CFDictionaryRef s_defaultSettings;
       
   328     static WebPreferences* s_standardPreferences;
       
   329 };
       
   330 
       
   331 #endif