16fdc152086fcb0dc5a6bf2441f0447278db32c3
[WebKit-https.git] / Source / WebKit / chromium / public / WebSettings.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebSettings_h
32 #define WebSettings_h
33
34 #include "platform/WebCommon.h"
35 #include "platform/WebSize.h"
36 #include <unicode/uscript.h>
37
38 #define HAS_WEBAUDIO_FEATURE_ENABLE 1
39
40 namespace WebKit {
41
42 class WebString;
43 class WebURL;
44
45 // WebSettings is owned by the WebView and allows code to modify the settings for
46 // the WebView's page without any knowledge of WebCore itself.  For the most part,
47 // these functions have a 1:1 mapping with the methods in WebCore/page/Settings.h.
48 class WebSettings {
49 public:
50     enum EditingBehavior {
51         EditingBehaviorMac,
52         EditingBehaviorWin,
53         EditingBehaviorUnix
54     };
55
56     virtual bool forceSoftwareCompositing() const = 0;
57     virtual bool scrollAnimatorEnabled() const = 0;
58     virtual bool viewportEnabled() const = 0;
59     virtual void setAccelerated2dCanvasEnabled(bool) = 0;
60     virtual void setAcceleratedCompositingEnabled(bool) = 0;
61     virtual void setAcceleratedCompositingFor3DTransformsEnabled(bool) = 0;
62     virtual void setAcceleratedCompositingForAnimationEnabled(bool) = 0;
63     virtual void setAcceleratedCompositingForCanvasEnabled(bool) = 0;
64     virtual void setAcceleratedCompositingForFixedPositionEnabled(bool)  = 0;
65     virtual void setAcceleratedCompositingForPluginsEnabled(bool) = 0;
66     virtual void setAcceleratedCompositingForVideoEnabled(bool) = 0;
67     virtual void setAcceleratedFiltersEnabled(bool) = 0;
68     virtual void setAcceleratedPaintingEnabled(bool) = 0;
69     virtual void setAllowDisplayOfInsecureContent(bool) = 0;
70     virtual void setAllowFileAccessFromFileURLs(bool) = 0;
71     virtual void setAllowRunningOfInsecureContent(bool) = 0;
72     virtual void setAllowScriptsToCloseWindows(bool) = 0;
73     virtual void setAllowUniversalAccessFromFileURLs(bool) = 0;
74     virtual void setApplyDefaultDeviceScaleFactorInCompositor(bool) = 0;
75     virtual void setAsynchronousSpellCheckingEnabled(bool) = 0;
76     virtual void setAuthorAndUserStylesEnabled(bool) = 0;
77     virtual void setCaretBrowsingEnabled(bool) = 0;
78     virtual void setCookieEnabled(bool) = 0;
79     virtual void setCursiveFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
80     virtual void setDNSPrefetchingEnabled(bool) = 0;
81     virtual void setDOMPasteAllowed(bool) = 0;
82     virtual void setDefaultFixedFontSize(int) = 0;
83     virtual void setDefaultFontSize(int) = 0;
84     virtual void setDefaultTextEncodingName(const WebString&) = 0;
85     virtual void setDefaultTileSize(WebSize) = 0;
86     virtual void setDeferred2dCanvasEnabled(bool) = 0;
87     virtual void setDeveloperExtrasEnabled(bool) = 0;
88     virtual void setDeviceSupportsMouse(bool) = 0;
89     virtual void setDeviceSupportsTouch(bool) = 0;
90     virtual void setDownloadableBinaryFontsEnabled(bool) = 0;
91     virtual void setEditableLinkBehaviorNeverLive() = 0;
92     virtual void setEditingBehavior(EditingBehavior) = 0;
93     virtual void setEnableScrollAnimator(bool) = 0;
94     virtual void setExperimentalCSSCustomFilterEnabled(bool) = 0;
95     virtual void setExperimentalCSSGridLayoutEnabled(bool) = 0;
96     virtual void setExperimentalCSSRegionsEnabled(bool) = 0;
97     virtual void setExperimentalCSSVariablesEnabled(bool) = 0;
98     virtual void setExperimentalWebGLEnabled(bool) = 0;
99     virtual void setFantasyFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
100     virtual void setFixedElementsLayoutRelativeToFrame(bool) = 0;
101     virtual void setFixedFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
102     virtual void setFixedPositionCreatesStackingContext(bool) = 0;
103     virtual void setFontRenderingModeNormal() = 0;
104     virtual void setForceCompositingMode(bool) = 0;
105     virtual void setForceSoftwareCompositing(bool) = 0;
106     virtual void setFrameFlatteningEnabled(bool) = 0;
107     virtual void setFullScreenEnabled(bool) = 0;
108     virtual void setHyperlinkAuditingEnabled(bool) = 0;
109     virtual void setImagesEnabled(bool) = 0;
110     virtual void setInteractiveFormValidationEnabled(bool) = 0;
111     virtual void setJavaEnabled(bool) = 0;
112     virtual void setJavaScriptCanAccessClipboard(bool) = 0;
113     virtual void setJavaScriptCanOpenWindowsAutomatically(bool) = 0;
114     virtual void setJavaScriptEnabled(bool) = 0;
115     virtual void setLayoutFallbackWidth(int) = 0;
116     virtual void setLoadsImagesAutomatically(bool) = 0;
117     virtual void setLocalStorageEnabled(bool) = 0;
118     virtual void setMaxUntiledLayerSize(WebSize) = 0;
119     virtual void setMediaPlaybackRequiresUserGesture(bool) = 0;
120     virtual void setMemoryInfoEnabled(bool) = 0;
121     virtual void setMinimumAccelerated2dCanvasSize(int) = 0;
122     virtual void setMinimumFontSize(int) = 0;
123     virtual void setMinimumLogicalFontSize(int) = 0;
124     virtual void setMinimumTimerInterval(double) = 0;
125     virtual void setMockScrollbarsEnabled(bool) = 0;
126     virtual void setNeedsSiteSpecificQuirks(bool) = 0;
127     virtual void setOfflineWebApplicationCacheEnabled(bool) = 0;
128     virtual void setOpenGLMultisamplingEnabled(bool) = 0;
129     virtual void setPageCacheSupportsPlugins(bool) = 0;
130     virtual void setPasswordEchoDurationInSeconds(double) = 0;
131     virtual void setPasswordEchoEnabled(bool) = 0;
132     virtual void setPictographFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
133     virtual void setPluginsEnabled(bool) = 0;
134     virtual void setPrivilegedWebGLExtensionsEnabled(bool) = 0;
135     virtual void setRenderVSyncEnabled(bool) = 0;
136     virtual void setSansSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
137     virtual void setSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
138     virtual void setShouldPrintBackgrounds(bool) = 0;
139     virtual void setShowDebugBorders(bool) = 0;
140     virtual void setShowFPSCounter(bool) = 0;
141     virtual void setShowPaintRects(bool) = 0;
142     virtual void setShowPlatformLayerTree(bool) = 0;
143     virtual void setShrinksStandaloneImagesToFit(bool) = 0;
144     virtual void setStandardFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
145     virtual void setSyncXHRInDocumentsEnabled(bool) = 0;
146     virtual void setTextAreasAreResizable(bool) = 0;
147     virtual void setTextAutosizingEnabled(bool) = 0;
148     virtual void setTextDirectionSubmenuInclusionBehaviorNeverIncluded() = 0;
149     virtual void setUnifiedTextCheckerEnabled(bool) = 0;
150     virtual void setUserStyleSheetLocation(const WebURL&) = 0;
151     virtual void setUsesEncodingDetector(bool) = 0;
152     virtual void setUsesPageCache(bool) = 0;
153     virtual void setValidationMessageTimerMagnification(int) = 0;
154     virtual void setViewportEnabled(bool) = 0;
155     virtual void setVisualWordMovementEnabled(bool) = 0;
156     virtual void setWebAudioEnabled(bool) = 0;
157     virtual void setWebGLErrorsToConsoleEnabled(bool) = 0;
158     virtual void setWebSecurityEnabled(bool) = 0;
159     virtual void setXSSAuditorEnabled(bool) = 0;
160
161     // DEPRECATED
162     virtual void setDefaultDeviceScaleFactor(int) { }
163
164 protected:
165     ~WebSettings() { }
166 };
167
168 } // namespace WebKit
169
170 #endif