Optionalproperties: Partial<WebKit.Settings.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeSince 2.10allow_Whether file access is allowed from file URLs. By default, when something is loaded in a 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.
Determine whether it's allowed to create and run modal dialogs
from a WebKit.WebView through JavaScript with
false, the associated WebKit.WebView won't be able to create
new modal dialogs, so not even the WebKit.WebView::create
signal will be emitted.
Since 2.28allow_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.14allow_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 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.
Since 2.10allowWhether file access is allowed from file URLs. By default, when something is loaded in a 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.
Determine whether it's allowed to create and run modal dialogs
from a WebKit.WebView through JavaScript with
false, the associated WebKit.WebView won't be able to create
new modal dialogs, so not even the WebKit.WebView::create
signal will be emitted.
Since 2.28allowWhether 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.14allowWhether 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 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.
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.
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.
The font family used as the default for content using a cursive font.
The font family used as the default for content using a cursive font.
The default text charset used when interpreting content with an unspecified charset.
The font family to use as the default for content that does not specify a font.
The default font size in pixels to use for content displayed if no font size is specified.
The default font size in pixels to use for content displayed in monospace font if no font size is specified.
The default text charset used when interpreting content with an unspecified charset.
The font family to use as the default for content that does not specify a font.
The default font size in pixels to use for content displayed if no font size is specified.
The default font size in pixels to use for content displayed in monospace font if no font size is specified.
Since 2.40disable_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.
Since 2.40disableEnable 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.
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.
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.
Since 2.46enable_Enable or disable 2D canvas acceleration. If this setting is enabled, the 2D canvas will be accelerated even if Skia CPU is used for rendering. However, the canvas can be unaccelerated even when this setting is enabled, for other reasons like its size or when willReadFrequently property is used.
Since 2.24enable_Whether to enable accessibility enhanced keyboard navigation.
Determines whether or not developer tools, such as the Web Inspector, are enabled.
Since 2.20enable_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.
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/
Whether to enable HTML5 client-side SQL database support (IndexedDB).
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/.
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.
Determines whether or not JavaScript executes within a page.
Since 2.24enable_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 WebKit.Settings.enable_javascript is true.
Since 2.26enable_Since 2.22enable_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.4enable_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
Since 2.4enable_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/
Since 2.24enable_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/
Determines whether or not text areas can be resized.
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.
Enable or disable smooth scrolling.
Since 2.4enable_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.
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.
Enable or disable support for WebAudio on pages. WebAudio is an API for processing and synthesizing audio in web applications
Enable or disable support for WebGL on pages. WebGL enables web content to use an API based on OpenGL ES 2.0.
Since 2.38enable_Enable WebRTC support for loaded pages.
Enabling this setting implies that Settings.enable_media_stream will be enabled as well.
See also https://www.w3.org/TR/webrtc/
Since 2.2enable_Since 2.46enable2dEnable or disable 2D canvas acceleration. If this setting is enabled, the 2D canvas will be accelerated even if Skia CPU is used for rendering. However, the canvas can be unaccelerated even when this setting is enabled, for other reasons like its size or when willReadFrequently property is used.
Since 2.24enableWhether to enable accessibility enhanced keyboard navigation.
Determines whether or not developer tools, such as the Web Inspector, are enabled.
Since 2.20enableEnable 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.
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/
Whether to enable HTML5 client-side SQL database support (IndexedDB).
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/.
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.
Determines whether or not JavaScript executes within a page.
Since 2.24enableDetermines 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 WebKit.Settings.enable_javascript is true.
Since 2.26enableSince 2.22enableEnable 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.4enableEnable 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/
Since 2.4enableEnable 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
Since 2.24enableEnable 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/
Determines whether or not text areas can be resized.
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.
Enable or disable smooth scrolling.
Since 2.4enableWhether 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.
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.
Enable or disable support for WebAudio on pages. WebAudio is an API for processing and synthesizing audio in web applications
Enable or disable support for WebGL on pages. WebGL enables web content to use an API based on OpenGL ES 2.0.
Since 2.38enableEnable WebRTC support for loaded pages.
Enabling this setting implies that Settings.enable_media_stream will be enabled as well.
See also https://www.w3.org/TR/webrtc/
Since 2.2enableThe font family used as the default for content using a fantasy font.
The font family used as the default for content using a fantasy font.
Since 2.16hardware_The 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.
Since 2.16hardwareThe 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.
Whether JavaScript can access the clipboard. The default value is false. If
set to true, document.execCommand() allows cut, copy and paste commands.
Whether JavaScript can open popup windows automatically without user intervention.
Whether JavaScript can access the clipboard. The default value is false. If
set to true, document.execCommand() allows cut, copy and paste commands.
Whether JavaScript can open popup windows automatically without user intervention.
Since 2.30media_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.
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.
Since 2.30mediaWhether 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.
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.
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.
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.
The font family used as the default for content using a monospace font.
The font family used as the default for content using a monospace font.
The font family used as the default for content using a pictograph font.
The font family used as the default for content using a pictograph font.
Whether background images should be drawn during printing.
Whether background images should be drawn during printing.
The font family used as the default for content using a sans-serif font.
The font family used as the default for content using a sans-serif font.
The font family used as the default for content using a serif font.
The font family used as the default for content using a serif font.
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.
If this property is set to the empty string or null, it will revert to the standard
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.
If this property is set to the empty string or null, it will revert to the standard
user-agent.
Since 2.48webrtc_Allow customization of the WebRTC UDP ports range.
In some constrained environments where a firewall blocks UDP network traffic excepted on a specific port range, this settings can be used to give hints to the WebRTC backend regarding which ports to allocate. The format is min-port:max-port, so for instance 20000:30000. The default empty string value means the OS will use no hints from the WebRTC backend. Using 0 for one of the values is allowed and means the value is unspecified.
Since 2.48webrtcAllow customization of the WebRTC UDP ports range.
In some constrained environments where a firewall blocks UDP network traffic excepted on a specific port range, this settings can be used to give hints to the WebRTC backend regarding which ports to allocate. The format is min-port:max-port, so for instance 20000:30000. The default empty string value means the OS will use no hints from the WebRTC backend. Using 0 for one of the values is allowed and means the value is unspecified.
Whether 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.
Whether 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.
Reads the contents of the given group_name from the given key_file and apply the value of
each key/value to the corresponding property on the settings.
Value types have to match with the corresponding setting property type and the group keys have to
match existing setting property names. If those conditions are not met, the function will return
false.
Supported value types are strings (unquoted), booleans (0, 1, true, false) and unsigned integers.
true if the settings were correctly applied or false on error.
SignalconnectSignalconnect_SignalemitGet the WebKit.Settings.allow_file_access_from_file_urls property.
true If file access from file URLs is allowed or false otherwise.
Get the WebKit.Settings.allow_modal_dialogs property.
true if it's allowed to create and run modal dialogs or false otherwise.
Get the WebKit.Settings.allow_top_navigation_to_data_urls property.
true If navigation to data URLs from the top frame is allowed or false\ otherwise.
Get the WebKit.Settings.allow_universal_access_from_file_urls property.
true If universal access from file URLs is allowed or false otherwise.
Get the WebKit.Settings.auto_load_images property.
true If auto loading of images is enabled or false otherwise.
Gets the WebKit.Settings.cursive_font_family property.
The default font family used to display content marked with cursive font.
Gets the WebKit.Settings.default_font_family property.
The default font family used to display content that does not specify a font.
Gets the WebKit.Settings.default_font_size property.
The default font size, in pixels.
Gets the WebKit.Settings.default_monospace_font_size property.
Default monospace font size, in pixels.
Get the WebKit.Settings.disable_web_security property.
true If web security support is disabled or false otherwise.
Get the WebKit.Settings.draw_compositing_indicators property.
true If compositing borders are drawn or false otherwise.
Get the WebKit.Settings.enable_2d_canvas_acceleration property.
true if 2D canvas acceleration is enabled or false otherwise.
Get the WebKit.Settings.enable_back_forward_navigation_gestures property.
true if horizontal swipe gesture will trigger back-forward navigaiton or false otherwise.
Get the WebKit.Settings.enable_caret_browsing property.
true If caret browsing is enabled or false otherwise.
Get the WebKit.Settings.enable_developer_extras property.
true If developer extras is enabled or false otherwise.
Get the WebKit.Settings.enable_dns_prefetching property.
true If DNS prefetching is enabled or false otherwise.
Get the WebKit.Settings.enable_encrypted_media property.
true if EncryptedMedia support is enabled or false otherwise.
Get the WebKit.Settings.enable_fullscreen property.
true If fullscreen support is enabled or false otherwise.
Get the WebKit.Settings.enable_html5_database property.
true if IndexedDB support is enabled or false otherwise.
Get the WebKit.Settings.enable_html5_local_storage property.
true If HTML5 local storage support is enabled or false otherwise.
Get the WebKit.Settings.enable_hyperlink_auditing property.
true If hyper link auditing is enabled or false otherwise.
Get the WebKit.Settings.enable_javascript property.
true If JavaScript is enabled or false otherwise.
Get the WebKit.Settings.enable_javascript_markup property.
true if JavaScript markup is enabled or false otherwise.
Get the WebKit.Settings.enable_media property.
true if media support is enabled or false otherwise.
Get the WebKit.Settings.enable_media_capabilities property.
true if MediaCapabilities support is enabled or false otherwise.
Get the WebKit.Settings.enable_media_stream property.
true If mediastream support is enabled or false otherwise.
Get the WebKit.Settings.enable_mediasource property.
true If MediaSource support is enabled or false otherwise.
Get the WebKit.Settings.enable_mock_capture_devices property.
true If mock capture devices is enabled or false otherwise.
Get the WebKit.Settings.enable_page_cache property.
true if page cache enabled or false otherwise.
Get the WebKit.Settings.enable_resizable_text_areas property.
true If text areas can be resized or false otherwise.
Get the WebKit.Settings.enable_site_specific_quirks property.
true if site specific quirks are enabled or false otherwise.
Get the WebKit.Settings.enable_smooth_scrolling property.
true if smooth scrolling is enabled or false otherwise.
Get the WebKit.Settings.enable_spatial_navigation property.
true If HTML5 spatial navigation support is enabled or false otherwise.
Get the WebKit.Settings.enable_tabs_to_links property.
true If tabs to link is enabled or false otherwise.
Get the WebKit.Settings.enable_webaudio property.
true If webaudio support is enabled or false otherwise.
Get the WebKit.Settings.enable_webgl property.
true If WebGL support is enabled or false otherwise.
Get the Settings.enable_webrtc property.
true If WebRTC support is enabled or false otherwise.
Get the WebKit.Settings.enable_write_console_messages_to_stdout property.
true if writing console messages to stdout is enabled or false otherwise.
Gets the WebKit.Settings.fantasy_font_family property.
The default font family used to display content marked with fantasy font.
Gets whether a feature is enabled.
the feature to toggle.
Whether the feature is enabled.
Get the WebKit.Settings.hardware_acceleration_policy property.
Get the WebKit.Settings.javascript_can_access_clipboard property.
true If javascript-can-access-clipboard is enabled or false otherwise.
Get the WebKit.Settings.javascript_can_open_windows_automatically property.
true If JavaScript can open window automatically or false otherwise.
Setting no longer supported. This function returns false.
false
Gets the WebKit.Settings.media_content_types_requiring_hardware_support property.
Media content types requiring hardware support, or null.
Get the WebKit.Settings.media_playback_allows_inline property.
true If inline playback is allowed for media or false if only fullscreen playback is allowed.
Get the WebKit.Settings.media_playback_requires_user_gesture property.
true If an user gesture is needed to play or load media or false if no user gesture is needed.
Gets the WebKit.Settings.monospace_font_family property.
Default font family used to display content marked with monospace font.
Gets the WebKit.Settings.pictograph_font_family property.
The default font family used to display content marked with pictograph font.
Get the WebKit.Settings.print_backgrounds property.
true If background images should be printed or false otherwise.
Gets the WebKit.Settings.sans_serif_font_family property.
The default font family used to display content marked with sans-serif font.
Gets the WebKit.Settings.serif_font_family property.
The default font family used to display content marked with serif font.
Get the WebKit.Settings.user_agent property.
The current value of the user-agent property.
Get the Settings.webrtc_udp_ports_range property.
The WebRTC UDP ports range, or null if un-set.
Get the WebKit.Settings.zoom_text_only property.
true If zoom level of the view should only affect the text or false if all view contents should be scaled.
Set the WebKit.Settings.allow_file_access_from_file_urls property.
Value to be set
Set the WebKit.Settings.allow_modal_dialogs property.
Value to be set
Set the WebKit.Settings.allow_top_navigation_to_data_urls property.
Value to be set
Set the WebKit.Settings.allow_universal_access_from_file_urls property.
Value to be set
Set the WebKit.Settings.auto_load_images property.
Value to be set
Set the WebKit.Settings.cursive_font_family property.
the new default cursive font family
Set the WebKit.Settings.default_charset property.
default charset to be set
Set the WebKit.Settings.default_font_family property.
the new default font family
Set the WebKit.Settings.default_font_size property.
default font size to be set in pixels
Set the WebKit.Settings.default_monospace_font_size property.
default monospace font size to be set in pixels
Set the WebKit.Settings.disable_web_security property.
Value to be set
Set the WebKit.Settings.draw_compositing_indicators property.
Value to be set
Set the WebKit.Settings.enable_2d_canvas_acceleration property.
Value to be set
Set the WebKit.Settings.enable_back_forward_navigation_gestures property.
value to be set
Set the WebKit.Settings.enable_caret_browsing property.
Value to be set
Set the WebKit.Settings.enable_developer_extras property.
Value to be set
Set the WebKit.Settings.enable_dns_prefetching property.
Value to be set
Set the WebKit.Settings.enable_encrypted_media property.
Value to be set
Set the WebKit.Settings.enable_fullscreen property.
Value to be set
Set the WebKit.Settings.enable_html5_database property.
Value to be set
Set the WebKit.Settings.enable_html5_local_storage property.
Value to be set
Set the WebKit.Settings.enable_hyperlink_auditing property.
Value to be set
Set the WebKit.Settings.enable_javascript property.
Value to be set
Set the WebKit.Settings.enable_javascript_markup property.
Value to be set
Set the WebKit.Settings.enable_media property.
Value to be set
Set the WebKit.Settings.enable_media_capabilities property.
Value to be set
Set the WebKit.Settings.enable_media_stream property.
Value to be set
Set the WebKit.Settings.enable_mediasource property.
Value to be set
Set the WebKit.Settings.enable_mock_capture_devices property.
Value to be set
Setting no longer supported. This function does nothing.
Value to be set
Set the WebKit.Settings.enable_page_cache property.
Value to be set
Set the WebKit.Settings.enable_resizable_text_areas property.
Value to be set
Set the WebKit.Settings.enable_site_specific_quirks property.
Value to be set
Set the WebKit.Settings.enable_smooth_scrolling property.
Value to be set
Set the WebKit.Settings.enable_spatial_navigation property.
Value to be set
Set the WebKit.Settings.enable_tabs_to_links property.
Value to be set
Set the WebKit.Settings.enable_webaudio property.
Value to be set
Set the WebKit.Settings.enable_webgl property.
Value to be set
Set the Settings.enable_webrtc property.
Setting this property to true implies the media-stream web-setting will also be enabled.
Value to be set
Set the WebKit.Settings.enable_write_console_messages_to_stdout property.
Value to be set
Set the WebKit.Settings.fantasy_font_family property.
the new default fantasy font family
Enables or disables a feature.
The current status of the feature can be determined with
webkit_settings_get_feature_enabled. To reset a feature to its
initial status, pass the value returned by
webkit_feature_get_default_value as the enabled parameter.
the feature to toggle.
whether the feature will be enabled.
Set the WebKit.Settings.hardware_acceleration_policy property.
Set the WebKit.Settings.javascript_can_access_clipboard property.
Value to be set
Set the WebKit.Settings.javascript_can_open_windows_automatically property.
Value to be set
Setting no longer supported. This function does nothing.
Value to be set
Set the WebKit.Settings.media_content_types_requiring_hardware_support property.
Optionalcontent_types: stringlist of media content types requiring hardware support split by semicolons (:) or null to use the default value.
Set the WebKit.Settings.media_playback_allows_inline property.
Value to be set
Set the WebKit.Settings.media_playback_requires_user_gesture property.
Value to be set
Set the WebKit.Settings.minimum_font_size property.
minimum font size to be set in pixels
Set the WebKit.Settings.monospace_font_family property.
the new default monospace font family
Set the WebKit.Settings.pictograph_font_family property.
the new default pictograph font family
Set the WebKit.Settings.print_backgrounds property.
Value to be set
Set the WebKit.Settings.sans_serif_font_family property.
the new default sans-serif font family
Set the WebKit.Settings.serif_font_family property.
the new default serif font family
Set the WebKit.Settings.user_agent property.
Optionaluser_agent: stringThe new custom user agent string or null to use the default user agent
Set the WebKit.Settings.user_agent property by appending the application details.
Set the 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.
Optionalapplication_name: stringThe application name used for the user agent or null to use the default user agent.
Optionalapplication_version: stringThe application version for the user agent or null to user the default version.
Set the Settings.webrtc_udp_ports_range property.
Value to be set
Set the WebKit.Settings.zoom_text_only property.
Value to be set
Staticfont_Convert points to the equivalent value in pixels.
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 WebKit.Settings.
the font size in points to convert to pixels
Staticfont_Convert pixels to the equivalent value in points.
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 WebKit.Settings.
the font size in pixels to convert to points
Staticget_Gets the list of all available WebKit features.
Features can be toggled with Settings.set_feature_enabled, and their current state determined with Settings.get_feature_enabled.
Note that most applications should use Settings.get_development_features and Settings.get_experimental_features instead.
Staticget_Gets the list of available development WebKit features.
The returned features are a subset of those returned by 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 FeatureStatus for more details.
Staticget_Gets the list of available experimental WebKit features.
The returned features are a subset of those returned by Settings.get_all_features, and includes those which certain applications may want to expose to end users; see FeatureStatus for more details.
StaticnewCreates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Control the behaviour of a WebKit.WebView.
WebKit.Settings can be applied to a WebKit.WebView to control text charset, color, font sizes, printing mode, script support, loading of images and various other things on a WebKit.WebView. After creation, a WebKit.Settings object contains default settings.