Class
WebKit2Settings
Description [src]
class WebKit2.Settings : GObject.Object {
parent: GObject,
priv: WebKitSettingsPrivate*
}
Control the behaviour of a WebKitWebView
.
WebKitSettings
can be applied to a WebKitWebView
to control text charset,
color, font sizes, printing mode, script support, loading of images and various
other things on a WebKitWebView
. After creation, a WebKitSettings
object
contains default settings.
// Disable JavaScript
WebKitSettings *settings = webkit_web_view_group_get_settings (my_view_group);
webkit_settings_set_enable_javascript (settings, FALSE);
Functions
webkit_settings_get_development_features
Gets the list of available development WebKit features.
since: 2.42
webkit_settings_get_experimental_features
Gets the list of available experimental WebKit features.
since: 2.42
Instance methods
webkit_settings_get_allow_file_access_from_file_urls
Get the WebKitSettings:allow-file-access-from-file-urls
property.
since: 2.10
webkit_settings_get_allow_top_navigation_to_data_urls
Get the WebKitSettings:allow-top-navigation-to-data-urls
property.
since: 2.28
webkit_settings_get_allow_universal_access_from_file_urls
Get the WebKitSettings:allow-universal-access-from-file-urls
property.
since: 2.14
webkit_settings_get_default_monospace_font_size
Gets the WebKitSettings:default-monospace-font-size
property.
webkit_settings_get_disable_web_security
Get the WebKitSettings:disable-web-security
property.
since: 2.40
webkit_settings_get_draw_compositing_indicators
Get the WebKitSettings:draw-compositing-indicators
property.
webkit_settings_get_enable_accelerated_2d_canvas
Get the WebKitSettings:enable-accelerated-2d-canvas
property.
deprecated: 2.32. since: 2.2
webkit_settings_get_enable_back_forward_navigation_gestures
Get the WebKitSettings:enable-back-forward-navigation-gestures
property.
since: 2.24
webkit_settings_get_enable_developer_extras
Get the WebKitSettings:enable-developer-extras
property.
webkit_settings_get_enable_encrypted_media
Get the WebKitSettings:enable-encrypted-media
property.
since: 2.20
webkit_settings_get_enable_frame_flattening
Frame flattening is no longer supported. This function returns FALSE
.
deprecated: 2.38
webkit_settings_get_enable_html5_local_storage
Get the WebKitSettings:enable-html5-local-storage
property.
webkit_settings_get_enable_hyperlink_auditing
Get the WebKitSettings:enable-hyperlink-auditing
property.
webkit_settings_get_enable_javascript_markup
Get the WebKitSettings:enable-javascript-markup
property.
since: 2.24
webkit_settings_get_enable_media_capabilities
Get the WebKitSettings:enable-media-capabilities
property.
since: 2.22
webkit_settings_get_enable_media_stream
Get the WebKitSettings:enable-media-stream
property.
since: 2.4
webkit_settings_get_enable_mediasource
Get the WebKitSettings:enable-mediasource
property.
since: 2.4
webkit_settings_get_enable_mock_capture_devices
Get the WebKitSettings:enable-mock-capture-devices
property.
since: 2.24
webkit_settings_get_enable_offline_web_application_cache
Get the WebKitSettings:enable-offline-web-application-cache
property.
webkit_settings_get_enable_private_browsing
Get the WebKitSettings:enable-private-browsing
property.
deprecated: 2.16.
webkit_settings_get_enable_resizable_text_areas
Get the WebKitSettings:enable-resizable-text-areas
property.
webkit_settings_get_enable_site_specific_quirks
Get the WebKitSettings:enable-site-specific-quirks
property.
webkit_settings_get_enable_smooth_scrolling
Get the WebKitSettings:enable-smooth-scrolling
property.
webkit_settings_get_enable_spatial_navigation
Get the WebKitSettings:enable-spatial-navigation
property.
since: 2.2
webkit_settings_get_enable_write_console_messages_to_stdout
Get the WebKitSettings:enable-write-console-messages-to-stdout
property.
since: 2.2
webkit_settings_get_enable_xss_auditor
The XSS auditor has been removed. This function returns FALSE
.
deprecated: 2.38.
webkit_settings_get_hardware_acceleration_policy
Get the WebKitSettings:hardware-acceleration-policy
property.
since: 2.16
webkit_settings_get_javascript_can_access_clipboard
Get the WebKitSettings:javascript-can-access-clipboard
property.
webkit_settings_get_javascript_can_open_windows_automatically
Get the WebKitSettings:javascript-can-open-windows-automatically
property.
webkit_settings_get_load_icons_ignoring_image_load_setting
Setting no longer supported. This function returns FALSE
.
deprecated: 2.42
webkit_settings_get_media_content_types_requiring_hardware_support
Gets the WebKitSettings:media-content-types-requiring-hardware-support
property.
since: 2.30
webkit_settings_get_media_playback_allows_inline
Get the WebKitSettings:media-playback-allows-inline
property.
webkit_settings_get_media_playback_requires_user_gesture
Get the WebKitSettings:media-playback-requires-user-gesture
property.
webkit_settings_set_allow_file_access_from_file_urls
Set the WebKitSettings:allow-file-access-from-file-urls
property.
since: 2.10
webkit_settings_set_allow_top_navigation_to_data_urls
Set the WebKitSettings:allow-top-navigation-to-data-urls
property.
since: 2.28
webkit_settings_set_allow_universal_access_from_file_urls
Set the WebKitSettings:allow-universal-access-from-file-urls
property.
since: 2.14
webkit_settings_set_default_monospace_font_size
Set the WebKitSettings:default-monospace-font-size
property.
webkit_settings_set_disable_web_security
Set the WebKitSettings:disable-web-security
property.
since: 2.40
webkit_settings_set_draw_compositing_indicators
Set the WebKitSettings:draw-compositing-indicators
property.
webkit_settings_set_enable_accelerated_2d_canvas
Set the WebKitSettings:enable-accelerated-2d-canvas
property.
deprecated: 2.32. since: 2.2
webkit_settings_set_enable_back_forward_navigation_gestures
Set the WebKitSettings:enable-back-forward-navigation-gestures
property.
since: 2.24
webkit_settings_set_enable_developer_extras
Set the WebKitSettings:enable-developer-extras
property.
webkit_settings_set_enable_encrypted_media
Set the WebKitSettings:enable-encrypted-media
property.
since: 2.20
webkit_settings_set_enable_frame_flattening
Frame flattening is no longer supported. This function does nothing.
deprecated: 2.38
webkit_settings_set_enable_html5_local_storage
Set the WebKitSettings:enable-html5-local-storage
property.
webkit_settings_set_enable_hyperlink_auditing
Set the WebKitSettings:enable-hyperlink-auditing
property.
webkit_settings_set_enable_javascript_markup
Set the WebKitSettings:enable-javascript-markup
property.
since: 2.24
webkit_settings_set_enable_media_capabilities
Set the WebKitSettings:enable-media-capabilities
property.
since: 2.22
webkit_settings_set_enable_media_stream
Set the WebKitSettings:enable-media-stream
property.
since: 2.4
webkit_settings_set_enable_mediasource
Set the WebKitSettings:enable-mediasource
property.
since: 2.4
webkit_settings_set_enable_mock_capture_devices
Set the WebKitSettings:enable-mock-capture-devices
property.
since: 2.4
webkit_settings_set_enable_offline_web_application_cache
Set the WebKitSettings:enable-offline-web-application-cache
property.
webkit_settings_set_enable_private_browsing
Set the WebKitSettings:enable-private-browsing
property.
deprecated: 2.16.
webkit_settings_set_enable_resizable_text_areas
Set the WebKitSettings:enable-resizable-text-areas
property.
webkit_settings_set_enable_site_specific_quirks
Set the WebKitSettings:enable-site-specific-quirks
property.
webkit_settings_set_enable_smooth_scrolling
Set the WebKitSettings:enable-smooth-scrolling
property.
webkit_settings_set_enable_spatial_navigation
Set the WebKitSettings:enable-spatial-navigation
property.
since: 2.2
webkit_settings_set_enable_write_console_messages_to_stdout
Set the WebKitSettings:enable-write-console-messages-to-stdout
property.
since: 2.2
webkit_settings_set_enable_xss_auditor
The XSS auditor has been removed. This function does nothing.
deprecated: 2.38.
webkit_settings_set_hardware_acceleration_policy
Set the WebKitSettings:hardware-acceleration-policy
property.
since: 2.16
webkit_settings_set_javascript_can_access_clipboard
Set the WebKitSettings:javascript-can-access-clipboard
property.
webkit_settings_set_javascript_can_open_windows_automatically
Set the WebKitSettings:javascript-can-open-windows-automatically
property.
webkit_settings_set_load_icons_ignoring_image_load_setting
Setting no longer supported. This function does nothing.
deprecated: 2.42
webkit_settings_set_media_content_types_requiring_hardware_support
Set the WebKitSettings:media-content-types-requiring-hardware-support
property.
since: 2.30
webkit_settings_set_media_playback_allows_inline
Set the WebKitSettings:media-playback-allows-inline
property.
webkit_settings_set_media_playback_requires_user_gesture
Set the WebKitSettings:media-playback-requires-user-gesture
property.
webkit_settings_set_user_agent_with_application_details
Set the WebKitSettings:user-agent
property by appending the application details.
Properties
WebKit2.Settings:allow-file-access-from-file-urls
Whether file access is allowed from file URLs. By default, when
something is loaded in a WebKitWebView
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.
since: 2.10
WebKit2.Settings:allow-modal-dialogs
Determine whether it’s allowed to create and run modal dialogs
from a WebKitWebView
through JavaScript with
FALSE
, the associated WebKitWebView
won’t be able to create
new modal dialogs, so not even the WebKitWebView::create
signal will be emitted.
WebKit2.Settings:allow-top-navigation-to-data-urls
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.
since: 2.28
WebKit2.Settings:allow-universal-access-from-file-urls
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 WebKitWebView
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.
since: 2.14
WebKit2.Settings:auto-load-images
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.
WebKit2.Settings:cursive-font-family
The font family used as the default for content using a cursive font.
WebKit2.Settings:default-charset
The default text charset used when interpreting content with an unspecified charset.
WebKit2.Settings:default-font-family
The font family to use as the default for content that does not specify a font.
WebKit2.Settings:default-font-size
The default font size in pixels to use for content displayed if no font size is specified.
WebKit2.Settings:default-monospace-font-size
The default font size in pixels to use for content displayed in monospace font if no font size is specified.
WebKit2.Settings:disable-web-security
Enable or disable support for Web Security on pages.
since: 2.40
WebKit2.Settings:draw-compositing-indicators
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.
WebKit2.Settings:enable-accelerated-2d-canvas
Enable or disable accelerated 2D canvas. Accelerated 2D canvas is only available if WebKit was compiled with a version of Cairo including the unstable CairoGL API. When accelerated 2D canvas is enabled, WebKit may render some 2D canvas content using hardware accelerated drawing operations.
deprecated: 2.32. since: 2.2
WebKit2.Settings:enable-back-forward-navigation-gestures
Enable or disable horizontal swipe gesture for back-forward navigation.
since: 2.24
WebKit2.Settings:enable-caret-browsing
Whether to enable accessibility enhanced keyboard navigation.
WebKit2.Settings:enable-developer-extras
Determines whether or not developer tools, such as the Web Inspector, are enabled.
WebKit2.Settings:enable-dns-prefetching
Determines whether or not to prefetch domain names. DNS prefetching attempts to resolve domain names before a user tries to follow a link.
WebKit2.Settings:enable-encrypted-media
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.
since: 2.20
WebKit2.Settings:enable-frame-flattening
Frame flattening is no longer supported. This property does nothing.
deprecated: 2.38
WebKit2.Settings:enable-fullscreen
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/
WebKit2.Settings:enable-html5-database
Whether to enable HTML5 client-side SQL database support (IndexedDB).
WebKit2.Settings:enable-html5-local-storage
Whether to enable HTML5 local storage support. Local storage provides simple synchronous storage access.
WebKit2.Settings:enable-java
Determines whether or not Java is enabled on the page.
deprecated: 2.38
WebKit2.Settings:enable-javascript-markup
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 WebKitSettings:enable-javascript
is TRUE
.
since: 2.24
WebKit2.Settings:enable-media
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.
since: 2.26
WebKit2.Settings:enable-media-capabilities
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.
since: 2.22
WebKit2.Settings:enable-media-stream
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.
since: 2.4
WebKit2.Settings:enable-mediasource
Enable or disable support for MediaSource on pages. MediaSource extends HTMLMediaElement to allow JavaScript to generate media streams for playback.
since: 2.4
WebKit2.Settings:enable-mock-capture-devices
Enable or disable the Mock Capture Devices. Those are fake Microphone and Camera devices to be used as MediaStream sources.
since: 2.24
WebKit2.Settings:enable-offline-web-application-cache
Whether to enable HTML5 offline web application cache support. Offline web application cache allows web applications to run even when the user is not connected to the network.
WebKit2.Settings:enable-page-cache
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/
WebKit2.Settings:enable-plugins
Determines whether or not plugins on the page are enabled.
deprecated: 2.32
WebKit2.Settings:enable-private-browsing
Determines whether or not private browsing is enabled. Private browsing will disable history, cache and form auto-fill for any pages visited.
deprecated: 2.16.
WebKit2.Settings:enable-site-specific-quirks
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.
WebKit2.Settings:enable-spatial-navigation
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.
since: 2.4
WebKit2.Settings:enable-tabs-to-links
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.
WebKit2.Settings:enable-webaudio
Enable or disable support for WebAudio on pages. WebAudio is an API for processing and synthesizing audio in web applications.
WebKit2.Settings:enable-webgl
Enable or disable support for WebGL on pages. WebGL enables web content to use an API based on OpenGL ES 2.0.
WebKit2.Settings:enable-write-console-messages-to-stdout
Enable or disable writing console messages to stdout. These are messages sent to the console with console.log and related methods.
since: 2.2
WebKit2.Settings:enable-xss-auditor
Whether to enable the XSS auditor. This feature filters some kinds of reflective XSS attacks on vulnerable web sites.
deprecated: 2.38
WebKit2.Settings:fantasy-font-family
The font family used as the default for content using a fantasy font.
WebKit2.Settings:hardware-acceleration-policy
The WebKitHardwareAccelerationPolicy
to decide how to enable and disable
hardware acceleration. Disabling hardware acceleration might
cause some websites to not render correctly or consume more CPU.
since: 2.16
WebKit2.Settings:javascript-can-access-clipboard
Whether JavaScript can access the clipboard. The default value is FALSE
. If
set to TRUE
, document.execCommand() allows cut, copy and paste commands.
WebKit2.Settings:javascript-can-open-windows-automatically
Whether JavaScript can open popup windows automatically without user intervention.
WebKit2.Settings:load-icons-ignoring-image-load-setting
Unsupported setting. This property does nothing.
deprecated: 2.42
WebKit2.Settings:media-content-types-requiring-hardware-support
List of media content types requiring hardware support, split by semicolons (:). For example: ‘video/webm; codecs=”vp“:video/mp4; codecs=”avc“:video/* codecs=”av1*”’.
since: 2.30
WebKit2.Settings:media-playback-allows-inline
Whether media playback is full-screen only or inline playback is allowed.
This is TRUE
by default, so media playback can be inline. Setting it to
FALSE
allows specifying that media playback should be always fullscreen.
WebKit2.Settings:media-playback-requires-user-gesture
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.
WebKit2.Settings:minimum-font-size
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.
WebKit2.Settings:monospace-font-family
The font family used as the default for content using a monospace font.
WebKit2.Settings:pictograph-font-family
The font family used as the default for content using a pictograph font.
WebKit2.Settings:sans-serif-font-family
The font family used as the default for content using a sans-serif font.
WebKit2.Settings:serif-font-family
The font family used as the default for content using a serif font.
WebKit2.Settings:user-agent
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
webkit_settings_set_user_agent_with_application_details()
instead.
WebKit2.Settings:zoom-text-only
Whether WebKitWebView: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.
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct WebKit2SettingsClass {
GObjectClass parent_class;
void (* _webkit_reserved0) (
void
);
void (* _webkit_reserved1) (
void
);
void (* _webkit_reserved2) (
void
);
void (* _webkit_reserved3) (
void
);
}
Class members
parent_class: GObjectClass
- No description available.
_webkit_reserved0: void (* _webkit_reserved0) ( void )
- No description available.
_webkit_reserved1: void (* _webkit_reserved1) ( void )
- No description available.
_webkit_reserved2: void (* _webkit_reserved2) ( void )
- No description available.
_webkit_reserved3: void (* _webkit_reserved3) ( void )
- No description available.