blob: 05e9bce4439e8ae19900653fc13ab231d64d229c [file] [log] [blame]
Torne (Richard Coles)5267f702013-06-11 10:57:24 +01001/*
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
38namespace WebKit {
39
40class WebString;
41class WebURL;
42
43// WebSettings is owned by the WebView and allows code to modify the settings for
44// the WebView's page without any knowledge of WebCore itself. For the most part,
45// these functions have a 1:1 mapping with the methods in WebCore/page/Settings.h.
46class WebSettings {
47public:
48 enum EditingBehavior {
49 EditingBehaviorMac,
50 EditingBehaviorWin,
51 EditingBehaviorUnix,
52 EditingBehaviorAndroid
53 };
54
55 virtual bool scrollAnimatorEnabled() const = 0;
56 virtual bool touchEditingEnabled() const = 0;
57 virtual bool viewportEnabled() const = 0;
58 virtual void setAccelerated2dCanvasEnabled(bool) = 0;
59 virtual void setAcceleratedCompositingEnabled(bool) = 0;
60 virtual void setAcceleratedCompositingFor3DTransformsEnabled(bool) = 0;
61 virtual void setAcceleratedCompositingForAnimationEnabled(bool) = 0;
62 virtual void setAcceleratedCompositingForCanvasEnabled(bool) = 0;
Ben Murdoch591b9582013-07-10 11:41:44 +010063 virtual void setAcceleratedCompositingForFiltersEnabled(bool) = 0;
Torne (Richard Coles)5267f702013-06-11 10:57:24 +010064 virtual void setAcceleratedCompositingForFixedPositionEnabled(bool) = 0;
65 virtual void setAcceleratedCompositingForOverflowScrollEnabled(bool) = 0;
66 virtual void setAcceleratedCompositingForTransitionEnabled(bool) = 0;
67 virtual void setAcceleratedCompositingForPluginsEnabled(bool) = 0;
68 virtual void setAcceleratedCompositingForScrollableFramesEnabled(bool) = 0;
69 virtual void setAcceleratedCompositingForVideoEnabled(bool) = 0;
70 virtual void setAcceleratedFiltersEnabled(bool) = 0;
71 virtual void setAllowDisplayOfInsecureContent(bool) = 0;
72 virtual void setAllowFileAccessFromFileURLs(bool) = 0;
73 virtual void setAllowCustomScrollbarInMainFrame(bool) = 0;
74 virtual void setAllowRunningOfInsecureContent(bool) = 0;
75 virtual void setAllowScriptsToCloseWindows(bool) = 0;
76 virtual void setAllowUniversalAccessFromFileURLs(bool) = 0;
77 virtual void setAntialiased2dCanvasEnabled(bool) = 0;
78 virtual void setAsynchronousSpellCheckingEnabled(bool) = 0;
79 virtual void setAutoZoomFocusedNodeToLegibleScale(bool) = 0;
80 virtual void setAuthorAndUserStylesEnabled(bool) = 0;
81 virtual void setCaretBrowsingEnabled(bool) = 0;
82 virtual void setCompositedScrollingForFramesEnabled(bool) = 0;
83 virtual void setCookieEnabled(bool) = 0;
84 virtual void setCursiveFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
85 virtual void setDNSPrefetchingEnabled(bool) = 0;
86 virtual void setDOMPasteAllowed(bool) = 0;
87 virtual void setDefaultFixedFontSize(int) = 0;
88 virtual void setDefaultFontSize(int) = 0;
89 virtual void setDefaultTextEncodingName(const WebString&) = 0;
90 virtual void setDefaultVideoPosterURL(const WebString&) = 0;
91 void setDeferred2dCanvasEnabled(bool) { } // temporary stub
92 virtual void setDeferredImageDecodingEnabled(bool) = 0;
93 virtual void setDeviceSupportsMouse(bool) = 0;
94 virtual void setDeviceSupportsTouch(bool) = 0;
95 virtual void setDoubleTapToZoomEnabled(bool) = 0;
96 virtual void setDownloadableBinaryFontsEnabled(bool) = 0;
97 virtual void setEditableLinkBehaviorNeverLive() = 0;
98 virtual void setEditingBehavior(EditingBehavior) = 0;
99 virtual void setEnableScrollAnimator(bool) = 0;
100 virtual void setEnableTouchAdjustment(bool) = 0;
101 virtual void setExperimentalCSSCustomFilterEnabled(bool) = 0;
102 virtual void setExperimentalCSSGridLayoutEnabled(bool) = 0;
Torne (Richard Coles)521d96e2013-06-19 11:58:24 +0100103 virtual void setRegionBasedColumnsEnabled(bool) = 0;
Torne (Richard Coles)5267f702013-06-11 10:57:24 +0100104 virtual void setCSSStickyPositionEnabled(bool) = 0;
105 virtual void setExperimentalWebGLEnabled(bool) = 0;
106 virtual void setExperimentalWebSocketEnabled(bool) = 0;
Torne (Richard Coles)5267f702013-06-11 10:57:24 +0100107 virtual void setFantasyFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
108 virtual void setFixedFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
109 virtual void setFixedPositionCreatesStackingContext(bool) = 0;
110 virtual void setFontRenderingModeNormal() = 0;
111 virtual void setForceCompositingMode(bool) = 0;
112 virtual void setFullScreenEnabled(bool) = 0;
113 virtual void setGestureTapHighlightEnabled(bool) = 0;
114 virtual void setHyperlinkAuditingEnabled(bool) = 0;
115 virtual void setImagesEnabled(bool) = 0;
116 virtual void setJavaEnabled(bool) = 0;
117 virtual void setJavaScriptCanAccessClipboard(bool) = 0;
118 virtual void setJavaScriptCanOpenWindowsAutomatically(bool) = 0;
119 virtual void setJavaScriptEnabled(bool) = 0;
120 virtual void setLayoutFallbackWidth(int) = 0;
121 virtual void setLoadsImagesAutomatically(bool) = 0;
122 virtual void setLoadWithOverviewMode(bool) = 0;
123 virtual void setLocalStorageEnabled(bool) = 0;
124 virtual void setMediaPlaybackRequiresUserGesture(bool) = 0;
125 virtual void setMemoryInfoEnabled(bool) = 0;
126 virtual void setMinimumAccelerated2dCanvasSize(int) = 0;
127 virtual void setMinimumFontSize(int) = 0;
128 virtual void setMinimumLogicalFontSize(int) = 0;
129 virtual void setMockScrollbarsEnabled(bool) = 0;
130 virtual void setNeedsSiteSpecificQuirks(bool) = 0;
131 virtual void setOfflineWebApplicationCacheEnabled(bool) = 0;
132 virtual void setOpenGLMultisamplingEnabled(bool) = 0;
133 virtual void setPasswordEchoDurationInSeconds(double) = 0;
134 virtual void setPasswordEchoEnabled(bool) = 0;
135 virtual void setPerTilePaintingEnabled(bool) = 0;
136 virtual void setPictographFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
Ben Murdoch591b9582013-07-10 11:41:44 +0100137 virtual void setPinchOverlayScrollbarThickness(int) = 0;
138 virtual void setPinchVirtualViewportEnabled(bool) = 0;
Torne (Richard Coles)5267f702013-06-11 10:57:24 +0100139 virtual void setPluginsEnabled(bool) = 0;
140 virtual void setPrivilegedWebGLExtensionsEnabled(bool) = 0;
141 virtual void setRenderVSyncNotificationEnabled(bool) = 0;
142 virtual void setSansSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
143 virtual void setSelectTrailingWhitespaceEnabled(bool) = 0;
144 virtual void setSelectionIncludesAltImageText(bool) = 0;
145 virtual void setSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
146 virtual void setShouldPrintBackgrounds(bool) = 0;
147 virtual void setShouldRespectImageOrientation(bool) = 0;
148 virtual void setShowDebugBorders(bool) = 0;
149 virtual void setShowFPSCounter(bool) = 0;
150 virtual void setShowPaintRects(bool) = 0;
151 virtual void setShrinksStandaloneImagesToFit(bool) = 0;
152 virtual void setSmartInsertDeleteEnabled(bool) = 0;
Ben Murdoch591b9582013-07-10 11:41:44 +0100153 // Spatial navigation feature, when enabled, improves the experience
154 // of keyboard-controlling the web pages which originally were not designed
155 // for keyboard navigation. It allows to use arrow keys to move focus between
156 // the adjacent HTML elements. As a side effect, it extends the criteria for
157 // elements to be focusable to include any element which has click or keyboard
158 // event handlers specified. User can also trigger click handlers for such
159 // elements using SPACE or ENTER keys.
Torne (Richard Coles)5267f702013-06-11 10:57:24 +0100160 virtual void setSpatialNavigationEnabled(bool) = 0;
161 virtual void setStandardFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
162 virtual void setSupportDeprecatedTargetDensityDPI(bool) = 0;
163 virtual void setSupportsMultipleWindows(bool) = 0;
164 virtual void setSyncXHRInDocumentsEnabled(bool) = 0;
165 virtual void setTextAreasAreResizable(bool) = 0;
166 virtual void setTextAutosizingEnabled(bool) = 0;
167 virtual void setTextAutosizingFontScaleFactor(float) = 0;
168 virtual void setTextDirectionSubmenuInclusionBehaviorNeverIncluded() { } // FIXME: Remove once its caller is gone from Chromium
169 virtual void setThreadedHTMLParser(bool) = 0;
170 virtual void setTouchDragDropEnabled(bool) = 0;
171 virtual void setTouchEditingEnabled(bool) = 0;
172 virtual void setUnifiedTextCheckerEnabled(bool) = 0;
173 virtual void setUnsafePluginPastingEnabled(bool) = 0;
174 virtual void setUserStyleSheetLocation(const WebURL&) = 0;
175 virtual void setUsesEncodingDetector(bool) = 0;
176 virtual void setUseWideViewport(bool) = 0;
177 virtual void setValidationMessageTimerMagnification(int) = 0;
178 virtual void setViewportEnabled(bool) = 0;
179 virtual void setVisualWordMovementEnabled(bool) = 0;
180 virtual void setWebAudioEnabled(bool) = 0;
181 virtual void setWebGLErrorsToConsoleEnabled(bool) = 0;
182 virtual void setWebSecurityEnabled(bool) = 0;
183 virtual void setXSSAuditorEnabled(bool) = 0;
184
185 // DEPRECATED: Delete after Chromium-side calls deleted.
186 void setApplyPageScaleFactorInCompositor(bool enabled) { }
187 void setApplyDefaultDeviceScaleFactorInCompositor(bool enabled) { }
188 void setFixedElementsLayoutRelativeToFrame(bool) { }
189 void setInitializeAtMinimumPageScale(bool enabled) { setLoadWithOverviewMode(enabled); }
190
191protected:
192 ~WebSettings() { }
193};
194
195} // namespace WebKit
196
197#endif