:right-sidebar: True

Settings
===================================================================

.. currentmodule:: gi.repository.WebKit





.. class:: Settings(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





:Constructors:

::

    Settings(**properties)
    new() -> WebKit.Settings



Constructors
------------

.. rst-class:: interim-class

.. class:: Settings
   :no-index:


   .. classmethod:: new() -> ~gi.repository.WebKit.Settings

      Creates a new :obj:`~gi.repository.WebKit.Settings` instance with default values.

      It must be manually attached to a :obj:`~gi.repository.WebKit.WebView`.
      See also :func:`~gi.repository.WebKit.Settings.new_with_settings`.














Methods
-------

.. rst-class:: interim-class

.. class:: Settings
   :no-index:


   .. method:: font_size_to_pixels(points: int) -> int

      Convert ``points`` to the equivalent value in pixels.

      Convert ``points`` to the equivalent value in pixels, based on the current
      screen DPI. Applications can use this function to convert font size values
      in points to font size values in pixels when setting the font size properties
      of :obj:`~gi.repository.WebKit.Settings`.



      .. versionadded:: 2.20





      :param points: the font size in points to convert to pixels





   .. method:: font_size_to_points(pixels: int) -> int

      Convert ``pixels`` to the equivalent value in points.

      Convert ``pixels`` to the equivalent value in points, based on the current
      screen DPI. Applications can use this function to convert font size values
      in pixels to font size values in points when getting the font size properties
      of :obj:`~gi.repository.WebKit.Settings`.



      .. versionadded:: 2.20





      :param pixels: the font size in pixels to convert to points





   .. method:: get_all_features() -> ~gi.repository.WebKit.FeatureList

      Gets the list of all available WebKit features.

      Features can be toggled with :obj:`~gi.repository.Settings.set_feature_enabled`,
      and their current state determined with
      :obj:`~gi.repository.Settings.get_feature_enabled`.

      Note that most applications should use
      :obj:`~gi.repository.Settings.get_development_features` and
      :obj:`~gi.repository.Settings.get_experimental_features` instead.



      .. versionadded:: 2.42








   .. method:: get_allow_file_access_from_file_urls() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:allow-file-access-from-file-urls property.



      .. versionadded:: 2.10








   .. method:: get_allow_modal_dialogs() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:allow-modal-dialogs property.










   .. method:: get_allow_top_navigation_to_data_urls() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:allow-top-navigation-to-data-urls property.



      .. versionadded:: 2.28








   .. method:: get_allow_universal_access_from_file_urls() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:allow-universal-access-from-file-urls property.



      .. versionadded:: 2.14








   .. method:: get_auto_load_images() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:auto-load-images property.










   .. method:: get_cursive_font_family() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:cursive-font-family property.










   .. method:: get_default_charset() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:default-charset property.










   .. method:: get_default_font_family() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:default-font-family property.










   .. method:: get_default_font_size() -> int

      Gets the :obj:`~gi.repository.WebKit.Settings`:default-font-size property.










   .. method:: get_default_monospace_font_size() -> int

      Gets the :obj:`~gi.repository.WebKit.Settings`:default-monospace-font-size property.










   .. method:: get_development_features() -> ~gi.repository.WebKit.FeatureList

      Gets the list of available development WebKit features.

      The returned features are a subset of those returned by
      :obj:`~gi.repository.Settings.get_all_features`, and includes those which
      web and WebKit developers might find useful, but in general should
      *not* be exposed to end users; see :obj:`~gi.repository.WebKit.FeatureStatus` for
      more details.



      .. versionadded:: 2.42








   .. method:: get_disable_web_security() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:disable-web-security property.



      .. versionadded:: 2.40








   .. method:: get_draw_compositing_indicators() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:draw-compositing-indicators property.










   .. method:: get_enable_back_forward_navigation_gestures() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-back-forward-navigation-gestures property.



      .. versionadded:: 2.24








   .. method:: get_enable_caret_browsing() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-caret-browsing property.










   .. method:: get_enable_developer_extras() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-developer-extras property.










   .. method:: get_enable_dns_prefetching() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-dns-prefetching property.










   .. method:: get_enable_encrypted_media() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-encrypted-media property.



      .. versionadded:: 2.20








   .. method:: get_enable_fullscreen() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-fullscreen property.










   .. method:: get_enable_html5_database() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-html5-database property.










   .. method:: get_enable_html5_local_storage() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-html5-local-storage property.










   .. method:: get_enable_hyperlink_auditing() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-hyperlink-auditing property.










   .. method:: get_enable_javascript() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-javascript property.










   .. method:: get_enable_javascript_markup() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-javascript-markup property.



      .. versionadded:: 2.24








   .. method:: get_enable_media() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-media property.



      .. versionadded:: 2.26








   .. method:: get_enable_media_capabilities() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-media-capabilities property.



      .. versionadded:: 2.22








   .. method:: get_enable_media_stream() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-media-stream property.



      .. versionadded:: 2.4








   .. method:: get_enable_mediasource() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-mediasource property.



      .. versionadded:: 2.4








   .. method:: get_enable_mock_capture_devices() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-mock-capture-devices property.



      .. versionadded:: 2.24








   .. method:: get_enable_offline_web_application_cache() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-offline-web-application-cache property.






      .. deprecated:: 2.44

         Please do not use it in newly written code







   .. method:: get_enable_page_cache() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-page-cache property.










   .. method:: get_enable_resizable_text_areas() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-resizable-text-areas property.










   .. method:: get_enable_site_specific_quirks() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-site-specific-quirks property.










   .. method:: get_enable_smooth_scrolling() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-smooth-scrolling property.










   .. method:: get_enable_spatial_navigation() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-spatial-navigation property.



      .. versionadded:: 2.2








   .. method:: get_enable_tabs_to_links() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-tabs-to-links property.










   .. method:: get_enable_webaudio() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-webaudio property.










   .. method:: get_enable_webgl() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-webgl property.










   .. method:: get_enable_webrtc() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings.props.enable_webrtc` property.



      .. versionadded:: 2.38








   .. method:: get_enable_write_console_messages_to_stdout() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:enable-write-console-messages-to-stdout property.



      .. versionadded:: 2.2








   .. method:: get_experimental_features() -> ~gi.repository.WebKit.FeatureList

      Gets the list of available experimental WebKit features.

      The returned features are a subset of those returned by
      :obj:`~gi.repository.Settings.get_all_features`, and includes those which
      certain applications may want to expose to end users; see
      :obj:`~gi.repository.WebKit.FeatureStatus` for more details.



      .. versionadded:: 2.42








   .. method:: get_fantasy_font_family() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:fantasy-font-family property.










   .. method:: get_feature_enabled(feature: ~gi.repository.WebKit.Feature) -> bool

      Gets whether a feature is enabled.



      .. versionadded:: 2.42





      :param feature: the feature to toggle.





   .. method:: get_hardware_acceleration_policy() -> ~gi.repository.WebKit.HardwareAccelerationPolicy

      Get the :obj:`~gi.repository.WebKit.Settings`:hardware-acceleration-policy property.



      .. versionadded:: 2.16








   .. method:: get_javascript_can_access_clipboard() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:javascript-can-access-clipboard property.










   .. method:: get_javascript_can_open_windows_automatically() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:javascript-can-open-windows-automatically property.










   .. method:: get_load_icons_ignoring_image_load_setting() -> bool

      Setting no longer supported. This function returns :const:`False`.






      .. deprecated:: 2.42

         Please do not use it in newly written code







   .. method:: get_media_content_types_requiring_hardware_support() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:media-content-types-requiring-hardware-support property.



      .. versionadded:: 2.30








   .. method:: get_media_playback_allows_inline() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:media-playback-allows-inline property.










   .. method:: get_media_playback_requires_user_gesture() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:media-playback-requires-user-gesture property.










   .. method:: get_minimum_font_size() -> int

      Gets the :obj:`~gi.repository.WebKit.Settings`:minimum-font-size property.










   .. method:: get_monospace_font_family() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:monospace-font-family property.










   .. method:: get_pictograph_font_family() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:pictograph-font-family property.










   .. method:: get_print_backgrounds() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:print-backgrounds property.










   .. method:: get_sans_serif_font_family() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:sans-serif-font-family property.










   .. method:: get_serif_font_family() -> str

      Gets the :obj:`~gi.repository.WebKit.Settings`:serif-font-family property.










   .. method:: get_user_agent() -> str

      Get the :obj:`~gi.repository.WebKit.Settings`:user-agent property.










   .. method:: get_zoom_text_only() -> bool

      Get the :obj:`~gi.repository.WebKit.Settings`:zoom-text-only property.










   .. method:: set_allow_file_access_from_file_urls(allowed: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:allow-file-access-from-file-urls property.



      .. versionadded:: 2.10





      :param allowed: Value to be set





   .. method:: set_allow_modal_dialogs(allowed: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:allow-modal-dialogs property.







      :param allowed: Value to be set





   .. method:: set_allow_top_navigation_to_data_urls(allowed: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:allow-top-navigation-to-data-urls property.



      .. versionadded:: 2.28





      :param allowed: Value to be set





   .. method:: set_allow_universal_access_from_file_urls(allowed: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:allow-universal-access-from-file-urls property.



      .. versionadded:: 2.14





      :param allowed: Value to be set





   .. method:: set_auto_load_images(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:auto-load-images property.







      :param enabled: Value to be set





   .. method:: set_cursive_font_family(cursive_font_family: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:cursive-font-family property.







      :param cursive_font_family: the new default cursive font family





   .. method:: set_default_charset(default_charset: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:default-charset property.







      :param default_charset: default charset to be set





   .. method:: set_default_font_family(default_font_family: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:default-font-family property.







      :param default_font_family: the new default font family





   .. method:: set_default_font_size(font_size: int) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:default-font-size property.







      :param font_size: default font size to be set in pixels





   .. method:: set_default_monospace_font_size(font_size: int) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:default-monospace-font-size property.







      :param font_size: default monospace font size to be set in pixels





   .. method:: set_disable_web_security(disabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:disable-web-security property.



      .. versionadded:: 2.40





      :param disabled: Value to be set





   .. method:: set_draw_compositing_indicators(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:draw-compositing-indicators property.







      :param enabled: Value to be set





   .. method:: set_enable_back_forward_navigation_gestures(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-back-forward-navigation-gestures property.



      .. versionadded:: 2.24





      :param enabled: value to be set





   .. method:: set_enable_caret_browsing(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-caret-browsing property.







      :param enabled: Value to be set





   .. method:: set_enable_developer_extras(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-developer-extras property.







      :param enabled: Value to be set





   .. method:: set_enable_dns_prefetching(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-dns-prefetching property.







      :param enabled: Value to be set





   .. method:: set_enable_encrypted_media(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-encrypted-media property.



      .. versionadded:: 2.20





      :param enabled: Value to be set





   .. method:: set_enable_fullscreen(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-fullscreen property.







      :param enabled: Value to be set





   .. method:: set_enable_html5_database(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-html5-database property.







      :param enabled: Value to be set





   .. method:: set_enable_html5_local_storage(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-html5-local-storage property.







      :param enabled: Value to be set





   .. method:: set_enable_hyperlink_auditing(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-hyperlink-auditing property.







      :param enabled: Value to be set





   .. method:: set_enable_javascript(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-javascript property.







      :param enabled: Value to be set





   .. method:: set_enable_javascript_markup(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-javascript-markup property.



      .. versionadded:: 2.24





      :param enabled: Value to be set





   .. method:: set_enable_media(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-media property.



      .. versionadded:: 2.26





      :param enabled: Value to be set





   .. method:: set_enable_media_capabilities(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-media-capabilities property.



      .. versionadded:: 2.22





      :param enabled: Value to be set





   .. method:: set_enable_media_stream(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-media-stream property.



      .. versionadded:: 2.4





      :param enabled: Value to be set





   .. method:: set_enable_mediasource(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-mediasource property.



      .. versionadded:: 2.4





      :param enabled: Value to be set





   .. method:: set_enable_mock_capture_devices(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-mock-capture-devices property.



      .. versionadded:: 2.4





      :param enabled: Value to be set





   .. method:: set_enable_offline_web_application_cache(enabled: bool) -> None

      Setting no longer supported. This function does nothing.






      .. deprecated:: 2.44

         Please do not use it in newly written code




      :param enabled: Value to be set





   .. method:: set_enable_page_cache(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-page-cache property.







      :param enabled: Value to be set





   .. method:: set_enable_resizable_text_areas(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-resizable-text-areas property.







      :param enabled: Value to be set





   .. method:: set_enable_site_specific_quirks(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-site-specific-quirks property.







      :param enabled: Value to be set





   .. method:: set_enable_smooth_scrolling(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-smooth-scrolling property.







      :param enabled: Value to be set





   .. method:: set_enable_spatial_navigation(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-spatial-navigation property.



      .. versionadded:: 2.2





      :param enabled: Value to be set





   .. method:: set_enable_tabs_to_links(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-tabs-to-links property.







      :param enabled: Value to be set





   .. method:: set_enable_webaudio(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-webaudio property.







      :param enabled: Value to be set





   .. method:: set_enable_webgl(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-webgl property.







      :param enabled: Value to be set





   .. method:: set_enable_webrtc(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings.props.enable_webrtc` property.

      Setting this property to :const:`True` implies the media-stream web-setting will also be enabled.



      .. versionadded:: 2.38





      :param enabled: Value to be set





   .. method:: set_enable_write_console_messages_to_stdout(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:enable-write-console-messages-to-stdout property.



      .. versionadded:: 2.2





      :param enabled: Value to be set





   .. method:: set_fantasy_font_family(fantasy_font_family: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:fantasy-font-family property.







      :param fantasy_font_family: the new default fantasy font family





   .. method:: set_feature_enabled(feature: ~gi.repository.WebKit.Feature, enabled: bool) -> None

      Enables or disables a feature.

      The current status of the feature can be determined with
      :obj:`~gi.repository.WebKit.webkit_settings_get_feature_enabled`. To reset a feature to its
      initial status, pass the value returned by
      :obj:`~gi.repository.WebKit.webkit_feature_get_default_value` as the ``enabled`` parameter.



      .. versionadded:: 2.42





      :param feature: the feature to toggle.


      :param enabled: whether the feature will be enabled.





   .. method:: set_hardware_acceleration_policy(policy: ~gi.repository.WebKit.HardwareAccelerationPolicy) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:hardware-acceleration-policy property.



      .. versionadded:: 2.16





      :param policy: a :obj:`~gi.repository.WebKit.HardwareAccelerationPolicy`





   .. method:: set_javascript_can_access_clipboard(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:javascript-can-access-clipboard property.







      :param enabled: Value to be set





   .. method:: set_javascript_can_open_windows_automatically(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:javascript-can-open-windows-automatically property.







      :param enabled: Value to be set





   .. method:: set_load_icons_ignoring_image_load_setting(enabled: bool) -> None

      Setting no longer supported. This function does nothing.






      .. deprecated:: 2.42

         Please do not use it in newly written code




      :param enabled: Value to be set





   .. method:: set_media_content_types_requiring_hardware_support(content_types: str | None = None) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:media-content-types-requiring-hardware-support property.



      .. versionadded:: 2.30





      :param content_types: list of media content types requiring hardware support split by semicolons (:) or :const:`None` to use the default value.





   .. method:: set_media_playback_allows_inline(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:media-playback-allows-inline property.







      :param enabled: Value to be set





   .. method:: set_media_playback_requires_user_gesture(enabled: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:media-playback-requires-user-gesture property.







      :param enabled: Value to be set





   .. method:: set_minimum_font_size(font_size: int) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:minimum-font-size property.







      :param font_size: minimum font size to be set in pixels





   .. method:: set_monospace_font_family(monospace_font_family: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:monospace-font-family property.







      :param monospace_font_family: the new default monospace font family





   .. method:: set_pictograph_font_family(pictograph_font_family: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:pictograph-font-family property.







      :param pictograph_font_family: the new default pictograph font family





   .. method:: set_print_backgrounds(print_backgrounds: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:print-backgrounds property.







      :param print_backgrounds: Value to be set





   .. method:: set_sans_serif_font_family(sans_serif_font_family: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:sans-serif-font-family property.







      :param sans_serif_font_family: the new default sans-serif font family





   .. method:: set_serif_font_family(serif_font_family: str) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:serif-font-family property.







      :param serif_font_family: the new default serif font family





   .. method:: set_user_agent(user_agent: str | None = None) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:user-agent property.







      :param user_agent: The new custom user agent string or :const:`None` to use the default user agent





   .. method:: set_user_agent_with_application_details(application_name: str | None = None, application_version: str | None = None) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:user-agent property by appending the application details.

      Set the :obj:`~gi.repository.WebKit.Settings`:user-agent property by appending the application details to the default user
      agent. If no application name or version is given, the default user agent used will be used. If only
      the version is given, the default engine version is used with the given application name.







      :param application_name: The application name used for the user agent or :const:`None` to use the default user agent.


      :param application_version: The application version for the user agent or :const:`None` to user the default version.





   .. method:: set_zoom_text_only(zoom_text_only: bool) -> None

      Set the :obj:`~gi.repository.WebKit.Settings`:zoom-text-only property.







      :param zoom_text_only: Value to be set









Properties
----------

.. rst-class:: interim-class

.. class:: Settings
   :no-index:
   

   .. attribute:: props.allow_file_access_from_file_urls
      :type: bool

      Whether file access is allowed from file URLs. By default, when
      something is loaded in a :obj:`~gi.repository.WebKit.WebView` using a file URI, cross
      origin requests to other file resources are not allowed. This
      setting allows you to change that behaviour, so that it would be
      possible to do a XMLHttpRequest of a local file, for example.



      .. versionadded:: 2.10





   .. attribute:: props.allow_modal_dialogs
      :type: bool

      Determine whether it's allowed to create and run modal dialogs
      from a :obj:`~gi.repository.WebKit.WebView` through JavaScript with
      <function>window.showModalDialog</function>. If it's set to
      :const:`False`, the associated :obj:`~gi.repository.WebKit.WebView` won't be able to create
      new modal dialogs, so not even the :obj:`~gi.repository.WebKit.WebView`::create
      signal will be emitted.







   .. attribute:: props.allow_top_navigation_to_data_urls
      :type: bool

      Whether or not the top frame is allowed to navigate to data URLs. It is disabled by default
      due to the risk it poses when loading untrusted URLs, with data URLs being used in scamming
      and phishing attacks. In contrast, a scenario where it could be enabled could be an app that
      embeds a WebView and you have control of the pages being show instead of a generic browser.



      .. versionadded:: 2.28





   .. attribute:: props.allow_universal_access_from_file_urls
      :type: bool

      Whether or not JavaScript running in the context of a file scheme URL
      should be allowed to access content from any origin.  By default, when
      something is loaded in a :obj:`~gi.repository.WebKit.WebView` using a file scheme URL,
      access to the local file system and arbitrary local storage is not
      allowed. This setting allows you to change that behaviour, so that
      it would be possible to use local storage, for example.



      .. versionadded:: 2.14





   .. attribute:: props.auto_load_images
      :type: bool

      Determines whether images should be automatically loaded or not.
      On devices where network bandwidth is of concern, it might be
      useful to turn this property off.







   .. attribute:: props.cursive_font_family
      :type: str

      The font family used as the default for content using a cursive font.







   .. attribute:: props.default_charset
      :type: str

      The default text charset used when interpreting content with an unspecified charset.







   .. attribute:: props.default_font_family
      :type: str

      The font family to use as the default for content that does not specify a font.







   .. attribute:: props.default_font_size
      :type: int

      The default font size in pixels to use for content displayed if
      no font size is specified.







   .. attribute:: props.default_monospace_font_size
      :type: int

      The default font size in pixels to use for content displayed in
      monospace font if no font size is specified.







   .. attribute:: props.disable_web_security
      :type: bool

      Enable or disable support for Web Security on pages.

      This setting disables the same-origin policy, allowing every website full control over
      all other websites. This is for use in special environments where you wish to disable
      all security and allow websites to hack each other. It is impossible to use this setting
      securely.



      .. versionadded:: 2.40





   .. attribute:: props.draw_compositing_indicators
      :type: bool

      Whether to draw compositing borders and repaint counters on layers drawn
      with accelerated compositing. This is useful for debugging issues related
      to web content that is composited with the GPU.







   .. attribute:: props.enable_back_forward_navigation_gestures
      :type: bool

      Enable or disable horizontal swipe gesture for back-forward navigation.



      .. versionadded:: 2.24





   .. attribute:: props.enable_caret_browsing
      :type: bool

      Whether to enable accessibility enhanced keyboard navigation.







   .. attribute:: props.enable_developer_extras
      :type: bool

      Determines whether or not developer tools, such as the Web Inspector, are enabled.







   .. attribute:: props.enable_dns_prefetching
      :type: bool

      Determines whether or not to prefetch domain names. DNS prefetching attempts
      to resolve domain names before a user tries to follow a link.







   .. attribute:: props.enable_encrypted_media
      :type: bool

      Enable or disable support for Encrypted Media API on pages.
      EncryptedMedia is an experimental JavaScript API for playing encrypted media in HTML.
      This property will only work as intended if the EncryptedMedia feature is enabled at build time
      with the ENABLE_ENCRYPTED_MEDIA flag.

      See https://www.w3.org/TR/encrypted-media/



      .. versionadded:: 2.20





   .. attribute:: props.enable_fullscreen
      :type: bool

      Whether to enable the Javascript Fullscreen API. The API
      allows any HTML element to request fullscreen display. See also
      the current draft of the spec:
      http://www.w3.org/TR/fullscreen/







   .. attribute:: props.enable_html5_database
      :type: bool

      Whether to enable HTML5 client-side SQL database support (IndexedDB).







   .. attribute:: props.enable_html5_local_storage
      :type: bool

      Whether to enable HTML5 local storage support. Local storage provides
      simple synchronous storage access.

      HTML5 local storage specification is available at
      http://dev.w3.org/html5/webstorage/.







   .. attribute:: props.enable_hyperlink_auditing
      :type: bool

      Determines whether or not hyperlink auditing is enabled.

      The hyperlink auditing specification is available at
      http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#hyperlink-auditing.







   .. attribute:: props.enable_javascript
      :type: bool

      Determines whether or not JavaScript executes within a page.







   .. attribute:: props.enable_javascript_markup
      :type: bool

      Determines whether or not JavaScript markup is allowed in document. When this setting is disabled,
      all JavaScript-related elements and attributes are removed from the document during parsing. Note that
      executing JavaScript is still allowed if :obj:`~gi.repository.WebKit.Settings`:enable-javascript is :const:`True`.



      .. versionadded:: 2.24





   .. attribute:: props.enable_media
      :type: bool

      Enable or disable support for media playback on pages. This setting is enabled by
      default. Disabling it means ``<audio>``, ``<track>`` and ``<video>`` elements will have
      playback support disabled.



      .. versionadded:: 2.26





   .. attribute:: props.enable_media_capabilities
      :type: bool

      Enable or disable support for MediaCapabilities on pages. This
      specification intends to provide APIs to allow websites to make an optimal
      decision when picking media content for the user. The APIs will expose
      information about the decoding and encoding capabilities for a given format
      but also output capabilities to find the best match based on the device’s
      display.

      See also https://wicg.github.io/media-capabilities/



      .. versionadded:: 2.22





   .. attribute:: props.enable_media_stream
      :type: bool

      Enable or disable support for MediaStream on pages. MediaStream
      is an experimental proposal for allowing web pages to access
      audio and video devices for capture.

      See also http://dev.w3.org/2011/webrtc/editor/getusermedia.html



      .. versionadded:: 2.4





   .. attribute:: props.enable_mediasource
      :type: bool

      Enable or disable support for MediaSource on pages. MediaSource
      extends HTMLMediaElement to allow JavaScript to generate media
      streams for playback.

      See also http://www.w3.org/TR/media-source/



      .. versionadded:: 2.4





   .. attribute:: props.enable_mock_capture_devices
      :type: bool

      Enable or disable the Mock Capture Devices. Those are fake
      Microphone and Camera devices to be used as MediaStream
      sources.



      .. versionadded:: 2.24





   .. attribute:: props.enable_offline_web_application_cache
      :type: bool

      Unsupported setting. This property does nothing.






      .. deprecated:: 2.44

         Please do not use it in newly written code




   .. attribute:: props.enable_page_cache
      :type: bool

      Enable or disable the page cache. Disabling the page cache is
      generally only useful for special circumstances like low-memory
      scenarios or special purpose applications like static HTML
      viewers. This setting only controls the Page Cache, this cache
      is different than the disk-based or memory-based traditional
      resource caches, its point is to make going back and forth
      between pages much faster. For details about the different types
      of caches and their purposes see:
      http://webkit.org/blog/427/webkit-page-cache-i-the-basics/







   .. attribute:: props.enable_resizable_text_areas
      :type: bool

      Determines whether or not text areas can be resized.







   .. attribute:: props.enable_site_specific_quirks
      :type: bool

      Whether to turn on site-specific quirks. Turning this on will
      tell WebKit to use some site-specific workarounds for
      better web compatibility. For example, older versions of
      MediaWiki will incorrectly send to WebKit a CSS file with KHTML
      workarounds. By turning on site-specific quirks, WebKit will
      special-case this and other cases to make some specific sites work.







   .. attribute:: props.enable_smooth_scrolling
      :type: bool

      Enable or disable smooth scrolling.







   .. attribute:: props.enable_spatial_navigation
      :type: bool

      Whether to enable Spatial Navigation. This feature consists in the ability
      to navigate between focusable elements in a Web page, such as hyperlinks
      and form controls, by using Left, Right, Up and Down arrow keys.
      For example, if an user presses the Right key, heuristics determine whether
      there is an element they might be trying to reach towards the right, and if
      there are multiple elements, which element they probably wants.



      .. versionadded:: 2.4





   .. attribute:: props.enable_tabs_to_links
      :type: bool

      Determines whether the tab key cycles through the elements on the page.
      When this setting is enabled, users will be able to focus the next element
      in the page by pressing the tab key. If the selected element is editable,
      then pressing tab key will insert the tab character.







   .. attribute:: props.enable_webaudio
      :type: bool

      Enable or disable support for WebAudio on pages. WebAudio is an
      API for processing and synthesizing audio in web applications

      See also https://webaudio.github.io/web-audio-api







   .. attribute:: props.enable_webgl
      :type: bool

      Enable or disable support for WebGL on pages. WebGL enables web
      content to use an API based on OpenGL ES 2.0.







   .. attribute:: props.enable_webrtc
      :type: bool

      Enable WebRTC support for loaded pages.

      Enabling this setting implies that :obj:`~gi.repository.WebKit.Settings.props.enable_media_stream`
      will be enabled as well.

      See also https://www.w3.org/TR/webrtc/



      .. versionadded:: 2.38





   .. attribute:: props.enable_write_console_messages_to_stdout
      :type: bool

      Enable or disable writing console messages to stdout. These are messages
      sent to the console with console.log and related methods.



      .. versionadded:: 2.2





   .. attribute:: props.fantasy_font_family
      :type: str

      The font family used as the default for content using a fantasy font.







   .. attribute:: props.hardware_acceleration_policy
      :type: ~gi.repository.WebKit.HardwareAccelerationPolicy

      The :obj:`~gi.repository.WebKit.HardwareAccelerationPolicy` to decide how to enable and disable
      hardware acceleration. Disabling hardware acceleration might
      cause some websites to not render correctly or consume more CPU.

      Note that changing this setting might not be possible if hardware acceleration is not
      supported by the hardware or the system. In that case, you can get the value to know the
      actual policy being used, but changing the setting will not have any effect.



      .. versionadded:: 2.16





   .. attribute:: props.javascript_can_access_clipboard
      :type: bool

      Whether JavaScript can access the clipboard. The default value is :const:`False`. If
      set to :const:`True`, document.execCommand() allows cut, copy and paste commands.







   .. attribute:: props.javascript_can_open_windows_automatically
      :type: bool

      Whether JavaScript can open popup windows automatically without user
      intervention.







   .. attribute:: props.load_icons_ignoring_image_load_setting
      :type: bool

      Unsupported setting. This property does nothing.






      .. deprecated:: 2.42

         Please do not use it in newly written code




   .. attribute:: props.media_content_types_requiring_hardware_support
      :type: str

      List of media content types requiring hardware support, split by semicolons (:).
      For example: 'video/webm; codecs="vp*":video/mp4; codecs="avc*":video/&ast; codecs="av1*"'.



      .. versionadded:: 2.30





   .. attribute:: props.media_playback_allows_inline
      :type: bool

      Whether media playback is full-screen only or inline playback is allowed.
      This is :const:`True` by default, so media playback can be inline. Setting it to
      :const:`False` allows specifying that media playback should be always fullscreen.







   .. attribute:: props.media_playback_requires_user_gesture
      :type: bool

      Whether a user gesture (such as clicking the play button)
      would be required to start media playback or load media. This is off
      by default, so media playback could start automatically.
      Setting it on requires a gesture by the user to start playback, or to
      load the media.







   .. attribute:: props.minimum_font_size
      :type: int

      The minimum font size in pixels used to display text. This setting
      controls the absolute smallest size. Values other than 0 can
      potentially break page layouts.







   .. attribute:: props.monospace_font_family
      :type: str

      The font family used as the default for content using a monospace font.







   .. attribute:: props.pictograph_font_family
      :type: str

      The font family used as the default for content using a pictograph font.







   .. attribute:: props.print_backgrounds
      :type: bool

      Whether background images should be drawn during printing.







   .. attribute:: props.sans_serif_font_family
      :type: str

      The font family used as the default for content using a sans-serif font.







   .. attribute:: props.serif_font_family
      :type: str

      The font family used as the default for content using a serif font.







   .. attribute:: props.user_agent
      :type: str

      The user-agent string used by WebKit. Unusual user-agent strings may cause web
      content to render incorrectly or fail to run, as many web pages are written to
      parse the user-agent strings of only the most popular browsers. Therefore, it's
      typically better to not completely override the standard user-agent, but to use
      :func:`~gi.repository.WebKit.Settings.set_user_agent_with_application_details` instead.

      If this property is set to the empty string or :const:`None`, it will revert to the standard
      user-agent.







   .. attribute:: props.zoom_text_only
      :type: bool

      Whether :obj:`~gi.repository.WebKit.WebView`:zoom-level affects only the
      text of the page or all the contents. Other contents containing text
      like form controls will be also affected by zoom factor when
      this property is enabled.