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
38namespace blink {
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    enum V8CacheOptions {
56        V8CacheOptionsOff,
57        V8CacheOptionsParse,
58        V8CacheOptionsCode
59    };
60
61    // Bit field values to tell Blink what kind of pointer/hover types are
62    // available on the system. These must match the enums in
63    // core/css/PointerProperties.h and their equality is compile-time asserted
64    // in WebSettingsImpl.cpp.
65    enum PointerType {
66        PointerTypeNone = 1,
67        PointerTypeCoarse = 2,
68        PointerTypeFine = 4
69    };
70
71    enum HoverType {
72        HoverTypeNone = 1,
73        // Indicates that the primary pointing system can hover, but it requires
74        // a significant action on the user’s part. e.g. hover on “long press”.
75        HoverTypeOnDemand = 2,
76        HoverTypeHover = 4
77    };
78
79    virtual bool mainFrameResizesAreOrientationChanges() const = 0;
80    virtual int availablePointerTypes() const = 0;
81    virtual PointerType primaryPointerType() const = 0;
82    virtual int availableHoverTypes() const = 0;
83    virtual HoverType primaryHoverType() const = 0;
84    virtual bool shrinksViewportContentToFit() const = 0;
85    virtual bool viewportEnabled() const = 0;
86    virtual void setAccelerated2dCanvasEnabled(bool) = 0;
87    virtual void setAccelerated2dCanvasMSAASampleCount(int) = 0;
88    virtual void setAcceleratedCompositingEnabled(bool) = 0;
89    virtual void setPreferCompositingToLCDTextEnabled(bool) = 0;
90    // Not implemented yet, see http://crbug.com/178119
91    virtual void setAcceleratedCompositingForTransitionEnabled(bool) { };
92    // If set to true, allows frames with an https origin to display passive
93    // contents at an insecure URL. Otherwise, disallows it. The
94    // FrameLoaderClient set to the frame may override the value set by this
95    // method.
96    virtual void setAccessibilityEnabled(bool) = 0;
97    virtual void setAllowDisplayOfInsecureContent(bool) = 0;
98    virtual void setAllowFileAccessFromFileURLs(bool) = 0;
99    virtual void setAllowCustomScrollbarInMainFrame(bool) = 0;
100    // If set to true, allows frames with an https origin to run active
101    // contents at an insecure URL. This includes WebSockets. Otherwise,
102    // disallows it. The FrameLoaderClient set to the frame may override the
103    // value set by this method.
104    virtual void setAllowRunningOfInsecureContent(bool) = 0;
105    // If set to true, allows frames with an https origin to connect WebSockets
106    // with an insecure URL (ws://). Otherwise, disallows it. Only when this is
107    // set to true, this value overrides the value set by
108    // setAllowRunningOfInsecureContent() for WebSockets. The FrameLoaderClient
109    // set to the frame may override the value set by this method.
110    virtual void setAllowConnectingInsecureWebSocket(bool) = 0;
111    virtual void setAllowScriptsToCloseWindows(bool) = 0;
112    virtual void setAllowUniversalAccessFromFileURLs(bool) = 0;
113    virtual void setAntialiased2dCanvasEnabled(bool) = 0;
114    virtual void setAsynchronousSpellCheckingEnabled(bool) = 0;
115    virtual void setAutoZoomFocusedNodeToLegibleScale(bool) = 0;
116    virtual void setCaretBrowsingEnabled(bool) = 0;
117    virtual void setClobberUserAgentInitialScaleQuirk(bool) = 0;
118    virtual void setContainerCullingEnabled(bool) = 0;
119    virtual void setCookieEnabled(bool) = 0;
120    virtual void setNavigateOnDragDrop(bool) = 0;
121    virtual void setCursiveFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
122    virtual void setDNSPrefetchingEnabled(bool) = 0;
123    virtual void setDOMPasteAllowed(bool) = 0;
124    virtual void setDefaultFixedFontSize(int) = 0;
125    virtual void setDefaultFontSize(int) = 0;
126    virtual void setDefaultTextEncodingName(const WebString&) = 0;
127    virtual void setDefaultVideoPosterURL(const WebString&) = 0;
128    virtual void setDisallowFullscreenForNonMediaElements(bool) = 0;
129    void setDeferred2dCanvasEnabled(bool) { } // temporary stub
130    virtual void setDeferredFiltersEnabled(bool) = 0;
131    virtual void setDeferredImageDecodingEnabled(bool) = 0;
132    virtual void setDeviceScaleAdjustment(float) = 0;
133    virtual void setDeviceSupportsMouse(bool) = 0;
134    virtual void setDeviceSupportsTouch(bool) = 0;
135    virtual void setDoubleTapToZoomEnabled(bool) = 0;
136    virtual void setDownloadableBinaryFontsEnabled(bool) = 0;
137    virtual void setEditingBehavior(EditingBehavior) = 0;
138    virtual void setEnableScrollAnimator(bool) = 0;
139    virtual void setEnableTouchAdjustment(bool) = 0;
140    virtual void setRegionBasedColumnsEnabled(bool) = 0;
141    virtual void setExperimentalWebGLEnabled(bool) = 0;
142    virtual void setFantasyFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
143    virtual void setFixedFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
144    virtual void setForceZeroLayoutHeight(bool) = 0;
145    virtual void setFullscreenSupported(bool) = 0;
146    virtual void setHyperlinkAuditingEnabled(bool) = 0;
147    virtual void setIgnoreMainFrameOverflowHiddenQuirk(bool) = 0;
148    virtual void setImagesEnabled(bool) = 0;
149    virtual void setInlineTextBoxAccessibilityEnabled(bool) = 0;
150    virtual void setJavaEnabled(bool) = 0;
151    virtual void setJavaScriptCanAccessClipboard(bool) = 0;
152    virtual void setJavaScriptCanOpenWindowsAutomatically(bool) = 0;
153    virtual void setJavaScriptEnabled(bool) = 0;
154    virtual void setLayerSquashingEnabled(bool) = 0;
155    virtual void setLoadsImagesAutomatically(bool) = 0;
156    virtual void setLoadWithOverviewMode(bool) = 0;
157    virtual void setLocalStorageEnabled(bool) = 0;
158    virtual void setMainFrameClipsContent(bool) = 0;
159    virtual void setMainFrameResizesAreOrientationChanges(bool) = 0;
160    virtual void setMaxTouchPoints(int) = 0;
161    virtual void setMediaControlsOverlayPlayButtonEnabled(bool) = 0;
162    virtual void setMediaPlaybackRequiresUserGesture(bool) = 0;
163    virtual void setMinimumAccelerated2dCanvasSize(int) = 0;
164    virtual void setMinimumFontSize(int) = 0;
165    virtual void setMinimumLogicalFontSize(int) = 0;
166    virtual void setMockScrollbarsEnabled(bool) = 0;
167    virtual void setOfflineWebApplicationCacheEnabled(bool) = 0;
168    virtual void setOpenGLMultisamplingEnabled(bool) = 0;
169    virtual void setPasswordEchoDurationInSeconds(double) = 0;
170    virtual void setPasswordEchoEnabled(bool) = 0;
171    virtual void setPerTilePaintingEnabled(bool) = 0;
172    virtual void setPictographFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
173    virtual void setPinchOverlayScrollbarThickness(int) = 0;
174    virtual void setPinchVirtualViewportEnabled(bool) = 0;
175    virtual void setPluginsEnabled(bool) = 0;
176    virtual void setAvailablePointerTypes(int) = 0;
177    virtual void setPrimaryPointerType(PointerType) = 0;
178    virtual void setAvailableHoverTypes(int) = 0;
179    virtual void setPrimaryHoverType(HoverType) = 0;
180    virtual void setRenderVSyncNotificationEnabled(bool) = 0;
181    virtual void setReportScreenSizeInPhysicalPixelsQuirk(bool) = 0;
182    virtual void setSansSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
183    virtual void setSelectTrailingWhitespaceEnabled(bool) = 0;
184    virtual void setSelectionIncludesAltImageText(bool) = 0;
185    virtual void setSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
186    virtual void setShouldPrintBackgrounds(bool) = 0;
187    virtual void setShouldClearDocumentBackground(bool) = 0;
188    virtual void setShouldRespectImageOrientation(bool) = 0;
189    virtual void setShowFPSCounter(bool) = 0;
190    virtual void setShowPaintRects(bool) = 0;
191    virtual void setShrinksStandaloneImagesToFit(bool) = 0;
192    virtual void setShrinksViewportContentToFit(bool) = 0;
193    virtual void setSmartInsertDeleteEnabled(bool) = 0;
194    // Spatial navigation feature, when enabled, improves the experience
195    // of keyboard-controlling the web pages which originally were not designed
196    // for keyboard navigation. It allows to use arrow keys to move focus between
197    // the adjacent HTML elements. As a side effect, it extends the criteria for
198    // elements to be focusable to include any element which has click or keyboard
199    // event handlers specified. User can also trigger click handlers for such
200    // elements using SPACE or ENTER keys.
201    virtual void setSpatialNavigationEnabled(bool) = 0;
202    virtual void setStandardFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
203    virtual void setSupportDeprecatedTargetDensityDPI(bool) = 0;
204    virtual void setSupportsMultipleWindows(bool) = 0;
205    virtual void setSyncXHRInDocumentsEnabled(bool) = 0;
206    virtual void setTextAreasAreResizable(bool) = 0;
207    virtual void setTextAutosizingEnabled(bool) = 0;
208    virtual void setAccessibilityFontScaleFactor(float) = 0;
209    virtual void setThreadedScrollingEnabled(bool) = 0;
210    virtual void setTouchDragDropEnabled(bool) = 0;
211    virtual void setTouchEditingEnabled(bool) = 0;
212    virtual void setUnifiedTextCheckerEnabled(bool) = 0;
213    virtual void setUnsafePluginPastingEnabled(bool) = 0;
214    virtual void setUseLegacyBackgroundSizeShorthandBehavior(bool) = 0;
215    virtual void setUseSolidColorScrollbars(bool) = 0;
216    virtual void setUseWideViewport(bool) = 0;
217    virtual void setUsesEncodingDetector(bool) = 0;
218    virtual void setV8CacheOptions(V8CacheOptions) = 0;
219    virtual void setV8ScriptStreamingEnabled(bool) = 0;
220    virtual void setValidationMessageTimerMagnification(int) = 0;
221    virtual void setViewportEnabled(bool) = 0;
222    virtual void setViewportMetaEnabled(bool) = 0;
223    virtual void setViewportMetaLayoutSizeQuirk(bool) = 0;
224    virtual void setViewportMetaMergeContentQuirk(bool) = 0;
225    virtual void setViewportMetaNonUserScalableQuirk(bool) = 0;
226    virtual void setViewportMetaZeroValuesQuirk(bool) = 0;
227    virtual void setWebAudioEnabled(bool) = 0;
228    virtual void setWebGLErrorsToConsoleEnabled(bool) = 0;
229    virtual void setWebSecurityEnabled(bool) = 0;
230    virtual void setWideViewportQuirkEnabled(bool) = 0;
231    virtual void setXSSAuditorEnabled(bool) = 0;
232
233protected:
234    ~WebSettings() { }
235};
236
237} // namespace blink
238
239#endif
240