Home | History | Annotate | Download | only in web
      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 namespace blink {
     39 
     40 class WebString;
     41 class 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.
     46 class WebSettings {
     47 public:
     48     enum EditingBehavior {
     49         EditingBehaviorMac,
     50         EditingBehaviorWin,
     51         EditingBehaviorUnix,
     52         EditingBehaviorAndroid
     53     };
     54 
     55     virtual bool mainFrameResizesAreOrientationChanges() const = 0;
     56     virtual bool shrinksViewportContentToFit() const = 0;
     57     virtual bool scrollAnimatorEnabled() const = 0;
     58     virtual bool touchEditingEnabled() const = 0;
     59     virtual bool viewportEnabled() const = 0;
     60     virtual bool viewportMetaEnabled() const = 0;
     61     virtual void setAccelerated2dCanvasEnabled(bool) = 0;
     62     virtual void setAccelerated2dCanvasMSAASampleCount(int) = 0;
     63     virtual void setAcceleratedCompositingEnabled(bool) = 0;
     64     virtual void setAcceleratedCompositingForCanvasEnabled(bool) = 0;
     65     virtual void setAcceleratedCompositingForFiltersEnabled(bool) = 0;
     66     virtual void setAcceleratedCompositingForFixedPositionEnabled(bool) = 0;
     67     virtual void setAcceleratedCompositingForFixedRootBackgroundEnabled(bool) = 0;
     68     virtual void setAcceleratedCompositingForOverflowScrollEnabled(bool) = 0;
     69     virtual void setCompositorDrivenAcceleratedScrollingEnabled(bool) = 0;
     70     // Not implemented yet, see http://crbug.com/178119
     71     virtual void setAcceleratedCompositingForTransitionEnabled(bool) { };
     72     virtual void setAcceleratedCompositingForVideoEnabled(bool) = 0;
     73     // If set to true, allows frames with an https origin to display passive
     74     // contents at an insecure URL. Otherwise, disallows it. The
     75     // FrameLoaderClient set to the frame may override the value set by this
     76     // method.
     77     virtual void setAllowDisplayOfInsecureContent(bool) = 0;
     78     virtual void setAllowFileAccessFromFileURLs(bool) = 0;
     79     virtual void setAllowCustomScrollbarInMainFrame(bool) = 0;
     80     // If set to true, allows frames with an https origin to run active
     81     // contents at an insecure URL. This includes WebSockets. Otherwise,
     82     // disallows it. The FrameLoaderClient set to the frame may override the
     83     // value set by this method.
     84     virtual void setAllowRunningOfInsecureContent(bool) = 0;
     85     // If set to true, allows frames with an https origin to connect WebSockets
     86     // with an insecure URL (ws://). Otherwise, disallows it. Only when this is
     87     // set to true, this value overrides the value set by
     88     // setAllowRunningOfInsecureContent() for WebSockets. The FrameLoaderClient
     89     // set to the frame may override the value set by this method.
     90     virtual void setAllowConnectingInsecureWebSocket(bool) = 0;
     91     virtual void setAllowScriptsToCloseWindows(bool) = 0;
     92     virtual void setAllowUniversalAccessFromFileURLs(bool) = 0;
     93     virtual void setAntialiased2dCanvasEnabled(bool) = 0;
     94     virtual void setAsynchronousSpellCheckingEnabled(bool) = 0;
     95     virtual void setAutoZoomFocusedNodeToLegibleScale(bool) = 0;
     96     virtual void setCaretBrowsingEnabled(bool) = 0;
     97     virtual void setClobberUserAgentInitialScaleQuirk(bool) = 0;
     98     virtual void setCompositedScrollingForFramesEnabled(bool) = 0;
     99     virtual void setCompositorTouchHitTesting(bool) = 0;
    100     virtual void setContainerCullingEnabled(bool) = 0;
    101     virtual void setCookieEnabled(bool) = 0;
    102     virtual void setNavigateOnDragDrop(bool) = 0;
    103     virtual void setCursiveFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
    104     virtual void setDNSPrefetchingEnabled(bool) = 0;
    105     virtual void setDOMPasteAllowed(bool) = 0;
    106     virtual void setDefaultFixedFontSize(int) = 0;
    107     virtual void setDefaultFontSize(int) = 0;
    108     virtual void setDefaultTextEncodingName(const WebString&) = 0;
    109     virtual void setDefaultVideoPosterURL(const WebString&) = 0;
    110     virtual void setDisallowFullscreenForNonMediaElements(bool) = 0;
    111     void setDeferred2dCanvasEnabled(bool) { } // temporary stub
    112     virtual void setDeferredFiltersEnabled(bool) = 0;
    113     virtual void setDeferredImageDecodingEnabled(bool) = 0;
    114     virtual void setDeviceScaleAdjustment(float) = 0;
    115     virtual void setDeviceSupportsMouse(bool) = 0;
    116     virtual void setDeviceSupportsTouch(bool) = 0;
    117     virtual void setDoubleTapToZoomEnabled(bool) = 0;
    118     virtual void setDownloadableBinaryFontsEnabled(bool) = 0;
    119     virtual void setEditingBehavior(EditingBehavior) = 0;
    120     virtual void setEnableScrollAnimator(bool) = 0;
    121     virtual void setEnableTouchAdjustment(bool) = 0;
    122     virtual void setRegionBasedColumnsEnabled(bool) = 0;
    123     virtual void setExperimentalWebGLEnabled(bool) = 0;
    124     virtual void setFantasyFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
    125     virtual void setFixedFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
    126     virtual void setFullscreenSupported(bool) = 0;
    127     virtual void setGestureTapHighlightEnabled(bool) = 0;
    128     virtual void setForceZeroLayoutHeight(bool) = 0;
    129     virtual void setHyperlinkAuditingEnabled(bool) = 0;
    130     virtual void setIgnoreMainFrameOverflowHiddenQuirk(bool) = 0;
    131     virtual void setImagesEnabled(bool) = 0;
    132     virtual void setJavaEnabled(bool) = 0;
    133     virtual void setJavaScriptCanAccessClipboard(bool) = 0;
    134     virtual void setJavaScriptCanOpenWindowsAutomatically(bool) = 0;
    135     virtual void setJavaScriptEnabled(bool) = 0;
    136     virtual void setLayerSquashingEnabled(bool) = 0;
    137     virtual void setLoadsImagesAutomatically(bool) = 0;
    138     virtual void setLoadWithOverviewMode(bool) = 0;
    139     virtual void setLocalStorageEnabled(bool) = 0;
    140     virtual void setMainFrameClipsContent(bool) = 0;
    141     virtual void setMainFrameResizesAreOrientationChanges(bool) = 0;
    142     virtual void setMaxTouchPoints(int) = 0;
    143     virtual void setMediaControlsOverlayPlayButtonEnabled(bool) = 0;
    144     virtual void setMediaPlaybackRequiresUserGesture(bool) = 0;
    145     virtual void setMinimumAccelerated2dCanvasSize(int) = 0;
    146     virtual void setMinimumFontSize(int) = 0;
    147     virtual void setMinimumLogicalFontSize(int) = 0;
    148     virtual void setMockScrollbarsEnabled(bool) = 0;
    149     virtual void setNeedsSiteSpecificQuirks(bool) = 0;
    150     virtual void setOfflineWebApplicationCacheEnabled(bool) = 0;
    151     virtual void setOpenGLMultisamplingEnabled(bool) = 0;
    152     virtual void setPasswordEchoDurationInSeconds(double) = 0;
    153     virtual void setPasswordEchoEnabled(bool) = 0;
    154     virtual void setPerTilePaintingEnabled(bool) = 0;
    155     virtual void setPictographFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
    156     virtual void setPinchOverlayScrollbarThickness(int) = 0;
    157     virtual void setPinchVirtualViewportEnabled(bool) = 0;
    158     virtual void setPluginsEnabled(bool) = 0;
    159     virtual void setRenderVSyncNotificationEnabled(bool) = 0;
    160     virtual void setReportScreenSizeInPhysicalPixelsQuirk(bool) = 0;
    161     virtual void setSansSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
    162     virtual void setSelectTrailingWhitespaceEnabled(bool) = 0;
    163     virtual void setSelectionIncludesAltImageText(bool) = 0;
    164     virtual void setSerifFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
    165     virtual void setShouldPrintBackgrounds(bool) = 0;
    166     virtual void setShouldClearDocumentBackground(bool) = 0;
    167     virtual void setShouldRespectImageOrientation(bool) = 0;
    168     virtual void setShowFPSCounter(bool) = 0;
    169     virtual void setShowPaintRects(bool) = 0;
    170     virtual void setShrinksStandaloneImagesToFit(bool) = 0;
    171     virtual void setShrinksViewportContentToFit(bool) = 0;
    172     virtual void setSmartInsertDeleteEnabled(bool) = 0;
    173     // Spatial navigation feature, when enabled, improves the experience
    174     // of keyboard-controlling the web pages which originally were not designed
    175     // for keyboard navigation. It allows to use arrow keys to move focus between
    176     // the adjacent HTML elements. As a side effect, it extends the criteria for
    177     // elements to be focusable to include any element which has click or keyboard
    178     // event handlers specified. User can also trigger click handlers for such
    179     // elements using SPACE or ENTER keys.
    180     virtual void setSpatialNavigationEnabled(bool) = 0;
    181     virtual void setStandardFontFamily(const WebString&, UScriptCode = USCRIPT_COMMON) = 0;
    182     virtual void setSupportDeprecatedTargetDensityDPI(bool) = 0;
    183     virtual void setSupportsMultipleWindows(bool) = 0;
    184     virtual void setSyncXHRInDocumentsEnabled(bool) = 0;
    185     virtual void setTextAreasAreResizable(bool) = 0;
    186     virtual void setTextAutosizingEnabled(bool) = 0;
    187     virtual void setAccessibilityFontScaleFactor(float) = 0;
    188     virtual void setTouchDragDropEnabled(bool) = 0;
    189     virtual void setTouchEditingEnabled(bool) = 0;
    190     virtual void setUnifiedTextCheckerEnabled(bool) = 0;
    191     virtual void setUnsafePluginPastingEnabled(bool) = 0;
    192     virtual void setUseExpandedHeuristicsForGpuRasterization(bool) = 0;
    193     virtual void setUseLegacyBackgroundSizeShorthandBehavior(bool) = 0;
    194     virtual void setUseSolidColorScrollbars(bool) = 0;
    195     virtual void setUseWideViewport(bool) = 0;
    196     virtual void setUsesEncodingDetector(bool) = 0;
    197     virtual void setValidationMessageTimerMagnification(int) = 0;
    198     virtual void setViewportEnabled(bool) = 0;
    199     virtual void setViewportMetaEnabled(bool) = 0;
    200     virtual void setViewportMetaLayoutSizeQuirk(bool) = 0;
    201     virtual void setViewportMetaMergeContentQuirk(bool) = 0;
    202     virtual void setViewportMetaNonUserScalableQuirk(bool) = 0;
    203     virtual void setViewportMetaZeroValuesQuirk(bool) = 0;
    204     virtual void setWebAudioEnabled(bool) = 0;
    205     virtual void setWebGLErrorsToConsoleEnabled(bool) = 0;
    206     virtual void setWebSecurityEnabled(bool) = 0;
    207     virtual void setWideViewportQuirkEnabled(bool) = 0;
    208     virtual void setXSSAuditorEnabled(bool) = 0;
    209 
    210 protected:
    211     ~WebSettings() { }
    212 };
    213 
    214 } // namespace blink
    215 
    216 #endif
    217