src/third_party/WebKit/Source/core/frame/Settings.in

   1 # Defines properties which are available on the Settings object.
   2 #
   3 # Please think carefully before adding a new Setting.  Some questions to
   4 # consider are:
   5 # - Should this be a RuntimeEnabledFeature instead? Settings are for things
   6 #   which we support either values of at runtime.  Features are set at renderer
   7 #   process startup and are never changed. Features also tend to be set to a
   8 #   value based on the platform or the stability of the code in question, where
   9 #   as settings both codepaths need to be stable.
  10 # - How will you ensure test coverage of all relevant values of your setting?
  11 # - Is the default value appropriate for other platforms or ports which may
  12 #   not be aware of your setting?
  13 # - Can your setting result in behavior differences observable to web
  14 #   developers?
  15 # - Should this setting ideally be removed in the future?  If so please file
  16 #   a bug and reference it in the comments for your setting.
  17 #
  18 # One reason to add a Setting is to manage the risk associated with adding a
  19 # new feature.  For example, we may choose to ship a new UI behavior or
  20 # performance optimization to ChromeOS users first (in order to gather feedback
  21 # and metrics on its use from the wild) before attempting to ship it to
  22 # Windows.
  23 #
  24 # FIXME: Add support for global settings.
  25 # FIXME: Add support for custom getters/setters.
  26
  27 defaultTextEncodingName type=String
  28
  29 # Do not hide chars typed in password fields immediately, but let the last char stay
  30 # visible for N seconds, configured by the passwordEchoDurationInSeconds setting
  31 # FIXME: Enable automatically if passwordEchoDurationInSeconds is set to a positive value.
  32 passwordEchoEnabled initial=false
  33
  34 # Configure how long the last char should say visible in seconds.
  35 passwordEchoDurationInSeconds type=double, initial=1
  36
  37 # Sets the magnification value for validation message timer.  If the
  38 # magnification value is N, a validation message disappears automatically after
  39 # <message length> * N / 1000 seconds.  If N is equal to or less than 0, a
  40 # validation message doesn't disappears automaticaly.
  41 validationMessageTimerMagnification type=int, initial=50
  42
  43 # Number of pixels below which 2D canvas is rendered in software
  44 # even if hardware acceleration is enabled.
  45 # Hardware acceleration is useful for large canvases where it can avoid the
  46 # pixel bandwidth between the CPU and GPU. But GPU acceleration comes at
  47 # a price - extra back-buffer and texture copy. Small canvases are also
  48 # widely used for stylized fonts. Anti-aliasing text in hardware at that
  49 # scale is generally slower. So below a certain size it is better to
  50 # draw canvas in software.
  51 minimumAccelerated2dCanvasSize type=int, initial=257*256
  52
  53 minimumFontSize type=int, initial=0, invalidate=Style
  54 minimumLogicalFontSize type=int, initial=0, invalidate=Style
  55 defaultFontSize type=int, initial=0, invalidate=Style
  56 defaultFixedFontSize type=int, initial=0, invalidate=Style
  57
  58 editingBehaviorType type=EditingBehaviorType, initial=editingBehaviorTypeForPlatform()
  59
  60 caretBrowsingEnabled initial=false
  61 localStorageEnabled initial=false
  62 allowUniversalAccessFromFileURLs initial=true
  63 allowFileAccessFromFileURLs initial=true
  64 javaScriptCanOpenWindowsAutomatically initial=false
  65 supportsMultipleWindows initial=true
  66 javaScriptCanAccessClipboard initial=false
  67 shouldPrintBackgrounds initial=false
  68 shouldClearDocumentBackground initial=true
  69
  70 textAreasAreResizable initial=false, invalidate=Style
  71 acceleratedCompositingEnabled initial=true, invalidate=AcceleratedCompositing
  72
  73 shrinksStandaloneImagesToFit initial=true
  74
  75 # FIXME: Does this do anything now that we don't support page cache?
  76 pageCacheSupportsPlugins initial=false
  77
  78 needsSiteSpecificQuirks initial=false
  79 offlineWebApplicationCacheEnabled initial=false
  80 usesEncodingDetector initial=false
  81 allowScriptsToCloseWindows initial=false
  82 deferredFiltersEnabled initial=true
  83 regionBasedColumnsEnabled initial=false
  84
  85 containerCullingEnabled initial=false
  86
  87 # FIXME: This should really be disabled by default as it makes platforms that
  88 # don't support the feature download files they can't use by.
  89 # Leaving enabled for now to not change existing behavior.
  90 downloadableBinaryFontsEnabled initial=true
  91
  92 xssAuditorEnabled initial=false
  93 unsafePluginPastingEnabled initial=true
  94 treatIPAddressAsDomain initial=false
  95
  96 acceleratedCompositingForVideoEnabled initial=true, invalidate=AcceleratedCompositing
  97 acceleratedCompositingForCanvasEnabled initial=true, invalidate=AcceleratedCompositing
  98 acceleratedCompositingForFiltersEnabled initial=false, invalidate=AcceleratedCompositing
  99 acceleratedCompositingForFixedPositionEnabled initial=false, invalidate=AcceleratedCompositing
 100 acceleratedCompositingForOverflowScrollEnabled initial=false, invalidate=AcceleratedCompositing
 101 acceleratedCompositingForFixedRootBackgroundEnabled initial=false
 102
 103 forceCompositingMode initial=false, invalidate=AcceleratedCompositing
 104
 105 # Works only in conjunction with forceCompositingMode.
 106 compositedScrollingForFramesEnabled initial=false, invalidate=AcceleratedCompositing
 107
 108 # 3D canvas (WebGL) support.
 109 webGLEnabled initial=false
 110
 111 webGLErrorsToConsoleEnabled initial=true
 112 privilegedWebGLExtensionsEnabled initial=false
 113 accelerated2dCanvasEnabled initial=false
 114 antialiased2dCanvasEnabled initial=true
 115 accelerated2dCanvasMSAASampleCount type=int, initial=0
 116
 117 # WebAudio support.
 118 webAudioEnabled initial=false
 119
 120 asynchronousSpellCheckingEnabled initial=false
 121
 122 hyperlinkAuditingEnabled initial=false
 123 allowDisplayOfInsecureContent initial=true
 124 allowRunningOfInsecureContent initial=true
 125 # FIXME: Remove this temporary flag. See crbug.com/366483 for the target
 126 # milestone.
 127 allowConnectingInsecureWebSocket initial=false
 128 mediaControlsOverlayPlayButtonEnabled initial=false
 129 mediaPlaybackRequiresUserGesture initial=false
 130
 131 scrollingCoordinatorEnabled initial=false
 132 scrollAnimatorEnabled initial=true
 133
 134 shouldRespectImageOrientation initial=false
 135
 136 # Limited use by features which behave differently depending on the input
 137 # devices available.  For example, the pointer and hover media queries.
 138 # Note that we need to be careful when basing behavior or UI on this -
 139 # just because a device is present doesn't mean the user cares about it
 140 # or uses it (i.e. Chromebook Pixel users generally don't want to give up
 141 # screen real estate just because they happen to have a touchscreen).
 142 deviceSupportsTouch initial=false
 143 deviceSupportsMouse initial=true
 144
 145 # This value indicates the number of simultaneous multi-touch points supported
 146 # by the currently connected screen/digitizer that supports the most points.
 147 # From Pointer Events spec:
 148 #   http://www.w3.org/TR/pointerevents/#widl-Navigator-maxTouchPoints
 149 maxTouchPoints type=int, initial=0
 150
 151 # Whether touch gestures should be "fuzzed" to nearest touch targets.
 152 # It's expected that this is enabled everywhere by default, but it may be
 153 # disabled for testing purposes as the algorithm is not yet perfect.
 154 # crbug.com/304895 tracks removal once we're satisfied with the algorithm.
 155 touchAdjustmentEnabled initial=true
 156
 157 # A mostly-stable performance optimization. crbug.com/304518 tracks removal.
 158 compositorTouchHitTesting initial=true
 159
 160 syncXHRInDocumentsEnabled initial=true
 161 cookieEnabled initial=true
 162 navigateOnDragDrop initial=true
 163 DOMPasteAllowed initial=false
 164
 165 // FIXME: Remove this. Unfortunately many webkit_unit_tests
 166 // depend on parsing being synchronous. crbug.com/366354
 167 threadedHTMLParser initial=false
 168 useThreadedHTMLParserForDataURLs initial=false
 169
 170 allowCustomScrollbarInMainFrame initial=true
 171 webSecurityEnabled initial=true
 172
 173 # Special keyboard navigation mode intented for platforms with no
 174 # proper mouse or touch support, such as a TV controller with a remote.
 175 spatialNavigationEnabled initial=false
 176
 177 # This setting adds a means to enable/disable touch initiated drag & drop. If
 178 # enabled, the user can initiate drag using long press.
 179 # crbug.com/304894 tracks removal once it's been enabled on all platforms.
 180 touchDragDropEnabled initial=false
 181
 182 unifiedTextCheckerEnabled initial=defaultUnifiedTextCheckerEnabled
 183
 184 # Some apps could have a default video poster if it is not set.
 185 defaultVideoPosterURL type=String
 186
 187 smartInsertDeleteEnabled initial=defaultSmartInsertDeleteEnabled
 188 selectTrailingWhitespaceEnabled initial=defaultSelectTrailingWhitespaceEnabled
 189
 190 selectionIncludesAltImageText initial=false
 191 useLegacyBackgroundSizeShorthandBehavior initial=false
 192
 193 # This quirk is to maintain compatibility with Android apps built on
 194 # the Android SDK prior to and including version 18.
 195 # Presumably, this can be removed any time after 2015.
 196 # See http://crbug.com/282130.
 197 viewportMetaZeroValuesQuirk initial=false
 198
 199 # Another Android SDK <= 18 quirk, removable 2015.
 200 # See http://crbug.com/295287
 201 ignoreMainFrameOverflowHiddenQuirk initial=false
 202
 203 # Yet another Android SDK <= 18 quirk, removable 2015.
 204 # See http://crbug.com/305236
 205 reportScreenSizeInPhysicalPixelsQuirk initial=false
 206
 207 # One more Android SDK <= 18 quirk, removable 2015.
 208 # See http://crbug.com/306548
 209 viewportMetaMergeContentQuirk initial=false
 210
 211 # This quirk is to maintain compatibility with Android apps.
 212 # It will be possible to remove it once WebSettings.{get|set}UseWideViewPort
 213 # API function will be removed.
 214 # See http://crbug.com/288037.
 215 wideViewportQuirkEnabled initial=false
 216
 217 # Touch based text selection and editing on desktop.
 218 # crbug.com/304873 tracks removal once it's been enabled on all platforms.
 219 touchEditingEnabled initial=false
 220
 221 # Settings for experimental desktop pinch-zoom support (with semantics
 222 # optimized for large screens).  Pinch-zoom generally is implemented mainly
 223 # outside of blink (in the compositor) and doesn't require any settings.
 224 # These settings are for an experimental modification to how pinch-zoom
 225 # behaves.  TODO(wjmaclean): link to design document.
 226 # crbug.com/304869 tracks removal.
 227 pinchVirtualViewportEnabled initial=false
 228 useSolidColorScrollbars initial=false
 229 pinchOverlayScrollbarThickness type=int, initial=0
 230
 231 mainFrameClipsContent initial=true
 232
 233 # Enable decoration shadow nodes to test password genration feature
 234 # crbug.com/114092. This flag should not be enabled for production.
 235 passwordGenerationDecorationEnabled initial=false
 236
 237
 238 # Presumably used by LayoutTests?  Unclear.
 239 useWideViewport initial=true, invalidate=ViewportDescription
 240 loadWithOverviewMode initial=true, invalidate=ViewportDescription
 241
 242
 243 # Font scale factor for accessibility, applied as part of text autosizing.
 244 accessibilityFontScaleFactor type=double, initial=1.0, invalidate=TextAutosizing
 245
 246
 247 # Only set by Layout Tests.
 248 mediaTypeOverride type=String, initial="screen", invalidate=MediaType
 249
 250 # loadsImagesAutomatically only suppresses the network load of
 251 # the image URL. A cached image will still be rendered if requested.
 252 loadsImagesAutomatically initial=false, invalidate=ImageLoading
 253 imagesEnabled initial=true, invalidate=ImageLoading
 254
 255 javaEnabled initial=false
 256 pluginsEnabled initial=false
 257
 258 viewportEnabled initial=false, invalidate=ViewportDescription
 259 viewportMetaEnabled initial=false
 260
 261 dnsPrefetchingEnabled initial=false, invalidate=DNSPrefetching
 262
 263
 264 # FIXME: This is a temporary flag and should be removed once
 265 # accelerated overflow scroll is ready (crbug.com/254111).
 266 compositorDrivenAcceleratedScrollingEnabled initial=false, invalidate=AcceleratedCompositing
 267
 268 # FIXME: This is a temporary flag and should be removed
 269 # when squashing is ready. (crbug.com/261605)
 270 layerSquashingEnabled initial=false
 271
 272 # Clients that execute script should call ScriptController::canExecuteScripts()
 273 # instead of this function. ScriptController::canExecuteScripts() checks the
 274 # HTML sandbox, plug-in sandboxing, and other important details.
 275 scriptEnabled initial=false, invalidate=ScriptEnable
 276
 277 # Compensates for poor text legibility on mobile devices. This value is
 278 # multiplied by the font scale factor when performing text autosizing of
 279 # websites that do not set an explicit viewport description.
 280 deviceScaleAdjustment type=double, initial=1.0, invalidate=TextAutosizing