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