WebKitSettings

WebKitSettings — Control the behaviour of a WebKitWebView

Functions

WebKitSettings * webkit_settings_new ()
WebKitSettings * webkit_settings_new_with_settings ()
gboolean webkit_settings_get_auto_load_images ()
void webkit_settings_set_auto_load_images ()
gboolean webkit_settings_get_enable_frame_flattening ()
void webkit_settings_set_enable_frame_flattening ()
gboolean webkit_settings_get_enable_html5_database ()
void webkit_settings_set_enable_html5_database ()
gboolean webkit_settings_get_enable_html5_local_storage ()
void webkit_settings_set_enable_html5_local_storage ()
gboolean webkit_settings_get_enable_hyperlink_auditing ()
void webkit_settings_set_enable_hyperlink_auditing ()
gboolean webkit_settings_get_enable_java ()
void webkit_settings_set_enable_java ()
gboolean webkit_settings_get_enable_javascript ()
void webkit_settings_set_enable_javascript ()
gboolean webkit_settings_get_enable_javascript_markup ()
void webkit_settings_set_enable_javascript_markup ()
gboolean webkit_settings_get_enable_offline_web_application_cache ()
void webkit_settings_set_enable_offline_web_application_cache ()
gboolean webkit_settings_get_enable_plugins ()
void webkit_settings_set_enable_plugins ()
gboolean webkit_settings_get_enable_xss_auditor ()
void webkit_settings_set_enable_xss_auditor ()
gboolean webkit_settings_get_javascript_can_open_windows_automatically ()
void webkit_settings_set_javascript_can_open_windows_automatically ()
gboolean webkit_settings_get_load_icons_ignoring_image_load_setting ()
void webkit_settings_set_load_icons_ignoring_image_load_setting ()
const gchar * webkit_settings_get_default_font_family ()
void webkit_settings_set_default_font_family ()
const gchar * webkit_settings_get_monospace_font_family ()
void webkit_settings_set_monospace_font_family ()
const gchar * webkit_settings_get_serif_font_family ()
void webkit_settings_set_serif_font_family ()
const gchar * webkit_settings_get_sans_serif_font_family ()
void webkit_settings_set_sans_serif_font_family ()
const gchar * webkit_settings_get_cursive_font_family ()
void webkit_settings_set_cursive_font_family ()
const gchar * webkit_settings_get_fantasy_font_family ()
void webkit_settings_set_fantasy_font_family ()
const gchar * webkit_settings_get_pictograph_font_family ()
void webkit_settings_set_pictograph_font_family ()
guint32 webkit_settings_get_default_font_size ()
void webkit_settings_set_default_font_size ()
guint32 webkit_settings_get_default_monospace_font_size ()
void webkit_settings_set_default_monospace_font_size ()
guint32 webkit_settings_get_minimum_font_size ()
void webkit_settings_set_minimum_font_size ()
const gchar * webkit_settings_get_default_charset ()
void webkit_settings_set_default_charset ()
gboolean webkit_settings_get_enable_private_browsing ()
void webkit_settings_set_enable_private_browsing ()
gboolean webkit_settings_get_enable_developer_extras ()
void webkit_settings_set_enable_developer_extras ()
gboolean webkit_settings_get_enable_resizable_text_areas ()
void webkit_settings_set_enable_resizable_text_areas ()
gboolean webkit_settings_get_enable_tabs_to_links ()
void webkit_settings_set_enable_tabs_to_links ()
gboolean webkit_settings_get_enable_dns_prefetching ()
void webkit_settings_set_enable_dns_prefetching ()
gboolean webkit_settings_get_enable_caret_browsing ()
void webkit_settings_set_enable_caret_browsing ()
gboolean webkit_settings_get_enable_fullscreen ()
void webkit_settings_set_enable_fullscreen ()
gboolean webkit_settings_get_print_backgrounds ()
void webkit_settings_set_print_backgrounds ()
gboolean webkit_settings_get_enable_webaudio ()
void webkit_settings_set_enable_webaudio ()
gboolean webkit_settings_get_enable_webgl ()
void webkit_settings_set_enable_webgl ()
void webkit_settings_set_allow_modal_dialogs ()
gboolean webkit_settings_get_allow_modal_dialogs ()
gboolean webkit_settings_get_zoom_text_only ()
void webkit_settings_set_zoom_text_only ()
gboolean webkit_settings_get_javascript_can_access_clipboard ()
void webkit_settings_set_javascript_can_access_clipboard ()
gboolean webkit_settings_get_media_playback_requires_user_gesture ()
void webkit_settings_set_media_playback_requires_user_gesture ()
gboolean webkit_settings_get_media_playback_allows_inline ()
void webkit_settings_set_media_playback_allows_inline ()
gboolean webkit_settings_get_draw_compositing_indicators ()
void webkit_settings_set_draw_compositing_indicators ()
gboolean webkit_settings_get_enable_site_specific_quirks ()
void webkit_settings_set_enable_site_specific_quirks ()
gboolean webkit_settings_get_enable_page_cache ()
void webkit_settings_set_enable_page_cache ()
const gchar * webkit_settings_get_user_agent ()
void webkit_settings_set_user_agent ()
void webkit_settings_set_user_agent_with_application_details ()
gboolean webkit_settings_get_enable_smooth_scrolling ()
void webkit_settings_set_enable_smooth_scrolling ()
gboolean webkit_settings_get_enable_accelerated_2d_canvas ()
void webkit_settings_set_enable_accelerated_2d_canvas ()
gboolean webkit_settings_get_enable_write_console_messages_to_stdout ()
void webkit_settings_set_enable_write_console_messages_to_stdout ()
gboolean webkit_settings_get_enable_media_stream ()
void webkit_settings_set_enable_media_stream ()
gboolean webkit_settings_get_enable_mock_capture_devices ()
void webkit_settings_set_enable_mock_capture_devices ()
gboolean webkit_settings_get_enable_spatial_navigation ()
void webkit_settings_set_enable_spatial_navigation ()
gboolean webkit_settings_get_enable_mediasource ()
void webkit_settings_set_enable_mediasource ()
gboolean webkit_settings_get_enable_encrypted_media ()
void webkit_settings_set_enable_encrypted_media ()
gboolean webkit_settings_get_enable_media_capabilities ()
void webkit_settings_set_enable_media_capabilities ()
gboolean webkit_settings_get_allow_file_access_from_file_urls ()
void webkit_settings_set_allow_file_access_from_file_urls ()
gboolean webkit_settings_get_allow_universal_access_from_file_urls ()
void webkit_settings_set_allow_universal_access_from_file_urls ()
gboolean webkit_settings_get_allow_top_navigation_to_data_urls ()
void webkit_settings_set_allow_top_navigation_to_data_urls ()
WebKitHardwareAccelerationPolicy webkit_settings_get_hardware_acceleration_policy ()
void webkit_settings_set_hardware_acceleration_policy ()
gboolean webkit_settings_get_enable_back_forward_navigation_gestures ()
void webkit_settings_set_enable_back_forward_navigation_gestures ()
guint32 webkit_settings_font_size_to_points ()
guint32 webkit_settings_font_size_to_pixels ()
gboolean webkit_settings_get_enable_media ()
void webkit_settings_set_enable_media ()
const gchar * webkit_settings_get_media_content_types_requiring_hardware_support ()
void webkit_settings_set_media_content_types_requiring_hardware_support ()

Properties

gboolean allow-file-access-from-file-urls Read / Write / Construct
gboolean allow-modal-dialogs Read / Write / Construct
gboolean allow-top-navigation-to-data-urls Read / Write / Construct
gboolean allow-universal-access-from-file-urls Read / Write / Construct
gboolean auto-load-images Read / Write / Construct
char * cursive-font-family Read / Write / Construct
char * default-charset Read / Write / Construct
char * default-font-family Read / Write / Construct
guint default-font-size Read / Write / Construct
guint default-monospace-font-size Read / Write / Construct
gboolean draw-compositing-indicators Read / Write / Construct
gboolean enable-accelerated-2d-canvas Read / Write / Construct
gboolean enable-back-forward-navigation-gestures Read / Write / Construct
gboolean enable-caret-browsing Read / Write / Construct
gboolean enable-developer-extras Read / Write / Construct
gboolean enable-dns-prefetching Read / Write / Construct
gboolean enable-encrypted-media Read / Write / Construct
gboolean enable-frame-flattening Read / Write / Construct
gboolean enable-fullscreen Read / Write / Construct
gboolean enable-html5-database Read / Write / Construct
gboolean enable-html5-local-storage Read / Write / Construct
gboolean enable-hyperlink-auditing Read / Write / Construct
gboolean enable-java Read / Write / Construct
gboolean enable-javascript Read / Write / Construct
gboolean enable-javascript-markup Read / Write / Construct
gboolean enable-media Read / Write / Construct
gboolean enable-media-capabilities Read / Write / Construct
gboolean enable-media-stream Read / Write / Construct
gboolean enable-mediasource Read / Write / Construct
gboolean enable-mock-capture-devices Read / Write / Construct
gboolean enable-offline-web-application-cache Read / Write / Construct
gboolean enable-page-cache Read / Write / Construct
gboolean enable-plugins Read / Write / Construct
gboolean enable-private-browsing Read / Write / Construct
gboolean enable-resizable-text-areas Read / Write / Construct
gboolean enable-site-specific-quirks Read / Write / Construct
gboolean enable-smooth-scrolling Read / Write / Construct
gboolean enable-spatial-navigation Read / Write / Construct
gboolean enable-tabs-to-links Read / Write / Construct
gboolean enable-webaudio Read / Write / Construct
gboolean enable-webgl Read / Write / Construct
gboolean enable-write-console-messages-to-stdout Read / Write / Construct
gboolean enable-xss-auditor Read / Write / Construct
char * fantasy-font-family Read / Write / Construct
WebKitHardwareAccelerationPolicy hardware-acceleration-policy Read / Write / Construct
gboolean javascript-can-access-clipboard Read / Write / Construct
gboolean javascript-can-open-windows-automatically Read / Write / Construct
gboolean load-icons-ignoring-image-load-setting Read / Write / Construct
char * media-content-types-requiring-hardware-support Read / Write / Construct
gboolean media-playback-allows-inline Read / Write / Construct
gboolean media-playback-requires-user-gesture Read / Write / Construct
guint minimum-font-size Read / Write / Construct
char * monospace-font-family Read / Write / Construct
char * pictograph-font-family Read / Write / Construct
gboolean print-backgrounds Read / Write / Construct
char * sans-serif-font-family Read / Write / Construct
char * serif-font-family Read / Write / Construct
char * user-agent Read / Write / Construct
gboolean zoom-text-only Read / Write / Construct

Types and Values

Object Hierarchy

    GEnum
    ╰── WebKitHardwareAccelerationPolicy
    GObject
    ╰── WebKitSettings

Description

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.

1
2
3
/* Disable JavaScript. */
WebKitSettings *settings = webkit_web_view_group_get_settings (my_view_group);
webkit_settings_set_enable_javascript (settings, FALSE);

Functions

webkit_settings_new ()

WebKitSettings *
webkit_settings_new (void);

Creates a new WebKitSettings instance with default values. It must be manually attached to a WebKitWebView. See also webkit_settings_new_with_settings().

Returns

a new WebKitSettings instance.


webkit_settings_new_with_settings ()

WebKitSettings *
webkit_settings_new_with_settings (const gchar *first_setting_name,
                                   ...);

Creates a new WebKitSettings instance with the given settings. It must be manually attached to a WebKitWebView.

Parameters

first_setting_name

name of first setting to set

 

...

value of first setting, followed by more settings, NULL-terminated

 

Returns

a new WebKitSettings instance.


webkit_settings_get_auto_load_images ()

gboolean
webkit_settings_get_auto_load_images (WebKitSettings *settings);

Get the “auto-load-images” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If auto loading of images is enabled or FALSE otherwise.


webkit_settings_set_auto_load_images ()

void
webkit_settings_set_auto_load_images (WebKitSettings *settings,
                                      gboolean enabled);

Set the “auto-load-images” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_frame_flattening ()

gboolean
webkit_settings_get_enable_frame_flattening
                               (WebKitSettings *settings);

Get the “enable-frame-flattening” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If frame flattening is enabled or FALSE otherwise.


webkit_settings_set_enable_frame_flattening ()

void
webkit_settings_set_enable_frame_flattening
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-frame-flattening” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_html5_database ()

gboolean
webkit_settings_get_enable_html5_database
                               (WebKitSettings *settings);

Get the “enable-html5-database” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if IndexedDB support is enabled or FALSE otherwise.


webkit_settings_set_enable_html5_database ()

void
webkit_settings_set_enable_html5_database
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-html5-database” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_html5_local_storage ()

gboolean
webkit_settings_get_enable_html5_local_storage
                               (WebKitSettings *settings);

Get the “enable-html5-local-storage” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If HTML5 local storage support is enabled or FALSE otherwise.


webkit_settings_set_enable_html5_local_storage ()

void
webkit_settings_set_enable_html5_local_storage
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-html5-local-storage” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_hyperlink_auditing ()

gboolean
webkit_settings_get_enable_hyperlink_auditing
                               (WebKitSettings *settings);

Get the “enable-hyperlink-auditing” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If hyper link auditing is enabled or FALSE otherwise.


webkit_settings_set_enable_hyperlink_auditing ()

void
webkit_settings_set_enable_hyperlink_auditing
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-hyperlink-auditing” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_java ()

gboolean
webkit_settings_get_enable_java (WebKitSettings *settings);

Get the “enable-java” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If Java is enabled or FALSE otherwise.


webkit_settings_set_enable_java ()

void
webkit_settings_set_enable_java (WebKitSettings *settings,
                                 gboolean enabled);

Set the “enable-java” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_javascript ()

gboolean
webkit_settings_get_enable_javascript (WebKitSettings *settings);

Get the “enable-javascript” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If JavaScript is enabled or FALSE otherwise.


webkit_settings_set_enable_javascript ()

void
webkit_settings_set_enable_javascript (WebKitSettings *settings,
                                       gboolean enabled);

Set the “enable-javascript” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_javascript_markup ()

gboolean
webkit_settings_get_enable_javascript_markup
                               (WebKitSettings *settings);

Get the “enable-javascript-markup” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if JavaScript markup is enabled or FALSE otherwise.

Since: 2.24


webkit_settings_set_enable_javascript_markup ()

void
webkit_settings_set_enable_javascript_markup
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-javascript-markup” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.24


webkit_settings_get_enable_offline_web_application_cache ()

gboolean
webkit_settings_get_enable_offline_web_application_cache
                               (WebKitSettings *settings);

Get the “enable-offline-web-application-cache” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If HTML5 offline web application cache support is enabled or FALSE otherwise.


webkit_settings_set_enable_offline_web_application_cache ()

void
webkit_settings_set_enable_offline_web_application_cache
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-offline-web-application-cache” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_plugins ()

gboolean
webkit_settings_get_enable_plugins (WebKitSettings *settings);

webkit_settings_get_enable_plugins has been deprecated since version 2.32 and should not be used in newly-written code.

Get the “enable-plugins” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If plugins are enabled or FALSE otherwise.


webkit_settings_set_enable_plugins ()

void
webkit_settings_set_enable_plugins (WebKitSettings *settings,
                                    gboolean enabled);

webkit_settings_set_enable_plugins has been deprecated since version 2.32 and should not be used in newly-written code.

Set the “enable-plugins” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_xss_auditor ()

gboolean
webkit_settings_get_enable_xss_auditor
                               (WebKitSettings *settings);

Get the “enable-xss-auditor” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If XSS auditing is enabled or FALSE otherwise.


webkit_settings_set_enable_xss_auditor ()

void
webkit_settings_set_enable_xss_auditor
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-xss-auditor” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_javascript_can_open_windows_automatically ()

gboolean
webkit_settings_get_javascript_can_open_windows_automatically
                               (WebKitSettings *settings);

Get the “javascript-can-open-windows-automatically” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If JavaScript can open window automatically or FALSE otherwise.


webkit_settings_set_javascript_can_open_windows_automatically ()

void
webkit_settings_set_javascript_can_open_windows_automatically
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “javascript-can-open-windows-automatically” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_load_icons_ignoring_image_load_setting ()

gboolean
webkit_settings_get_load_icons_ignoring_image_load_setting
                               (WebKitSettings *settings);

Get the “load-icons-ignoring-image-load-setting” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If site icon can be loaded irrespective of image loading preference or FALSE otherwise.


webkit_settings_set_load_icons_ignoring_image_load_setting ()

void
webkit_settings_set_load_icons_ignoring_image_load_setting
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “load-icons-ignoring-image-load-setting” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_default_font_family ()

const gchar *
webkit_settings_get_default_font_family
                               (WebKitSettings *settings);

webkit_settings_set_default_font_family ()

void
webkit_settings_set_default_font_family
                               (WebKitSettings *settings,
                                const gchar *default_font_family);

Set the “default-font-family” property.

Parameters

settings

a WebKitSettings

 

default_font_family

the new default font family

 

webkit_settings_get_monospace_font_family ()

const gchar *
webkit_settings_get_monospace_font_family
                               (WebKitSettings *settings);

Gets the “monospace-font-family” property.

Parameters

settings

a WebKitSettings

 

Returns

Default font family used to display content marked with monospace font.


webkit_settings_set_monospace_font_family ()

void
webkit_settings_set_monospace_font_family
                               (WebKitSettings *settings,
                                const gchar *monospace_font_family);

Set the “monospace-font-family” property.

Parameters

settings

a WebKitSettings

 

monospace_font_family

the new default monospace font family

 

webkit_settings_get_serif_font_family ()

const gchar *
webkit_settings_get_serif_font_family (WebKitSettings *settings);

Gets the “serif-font-family” property.

Parameters

settings

a WebKitSettings

 

Returns

The default font family used to display content marked with serif font.


webkit_settings_set_serif_font_family ()

void
webkit_settings_set_serif_font_family (WebKitSettings *settings,
                                       const gchar *serif_font_family);

Set the “serif-font-family” property.

Parameters

settings

a WebKitSettings

 

serif_font_family

the new default serif font family

 

webkit_settings_get_sans_serif_font_family ()

const gchar *
webkit_settings_get_sans_serif_font_family
                               (WebKitSettings *settings);

Gets the “sans-serif-font-family” property.

Parameters

settings

a WebKitSettings

 

Returns

The default font family used to display content marked with sans-serif font.


webkit_settings_set_sans_serif_font_family ()

void
webkit_settings_set_sans_serif_font_family
                               (WebKitSettings *settings,
                                const gchar *sans_serif_font_family);

Set the “sans-serif-font-family” property.

Parameters

settings

a WebKitSettings

 

sans_serif_font_family

the new default sans-serif font family

 

webkit_settings_get_cursive_font_family ()

const gchar *
webkit_settings_get_cursive_font_family
                               (WebKitSettings *settings);

Gets the “cursive-font-family” property.

Parameters

settings

a WebKitSettings

 

Returns

The default font family used to display content marked with cursive font.


webkit_settings_set_cursive_font_family ()

void
webkit_settings_set_cursive_font_family
                               (WebKitSettings *settings,
                                const gchar *cursive_font_family);

Set the “cursive-font-family” property.

Parameters

settings

a WebKitSettings

 

cursive_font_family

the new default cursive font family

 

webkit_settings_get_fantasy_font_family ()

const gchar *
webkit_settings_get_fantasy_font_family
                               (WebKitSettings *settings);

Gets the “fantasy-font-family” property.

Parameters

settings

a WebKitSettings

 

Returns

The default font family used to display content marked with fantasy font.


webkit_settings_set_fantasy_font_family ()

void
webkit_settings_set_fantasy_font_family
                               (WebKitSettings *settings,
                                const gchar *fantasy_font_family);

Set the “fantasy-font-family” property.

Parameters

settings

a WebKitSettings

 

fantasy_font_family

the new default fantasy font family

 

webkit_settings_get_pictograph_font_family ()

const gchar *
webkit_settings_get_pictograph_font_family
                               (WebKitSettings *settings);

Gets the “pictograph-font-family” property.

Parameters

settings

a WebKitSettings

 

Returns

The default font family used to display content marked with pictograph font.


webkit_settings_set_pictograph_font_family ()

void
webkit_settings_set_pictograph_font_family
                               (WebKitSettings *settings,
                                const gchar *pictograph_font_family);

Set the “pictograph-font-family” property.

Parameters

settings

a WebKitSettings

 

pictograph_font_family

the new default pictograph font family

 

webkit_settings_get_default_font_size ()

guint32
webkit_settings_get_default_font_size (WebKitSettings *settings);

Gets the “default-font-size” property.

Parameters

settings

a WebKitSettings

 

Returns

The default font size, in pixels.


webkit_settings_set_default_font_size ()

void
webkit_settings_set_default_font_size (WebKitSettings *settings,
                                       guint32 font_size);

Set the “default-font-size” property.

Parameters

settings

a WebKitSettings

 

font_size

default font size to be set in pixels

 

webkit_settings_get_default_monospace_font_size ()

guint32
webkit_settings_get_default_monospace_font_size
                               (WebKitSettings *settings);

Gets the “default-monospace-font-size” property.

Parameters

settings

a WebKitSettings

 

Returns

Default monospace font size, in pixels.


webkit_settings_set_default_monospace_font_size ()

void
webkit_settings_set_default_monospace_font_size
                               (WebKitSettings *settings,
                                guint32 font_size);

Set the “default-monospace-font-size” property.

Parameters

settings

a WebKitSettings

 

font_size

default monospace font size to be set in pixels

 

webkit_settings_get_minimum_font_size ()

guint32
webkit_settings_get_minimum_font_size (WebKitSettings *settings);

Gets the “minimum-font-size” property.

Parameters

settings

a WebKitSettings

 

Returns

Minimum font size, in pixels.


webkit_settings_set_minimum_font_size ()

void
webkit_settings_set_minimum_font_size (WebKitSettings *settings,
                                       guint32 font_size);

Set the “minimum-font-size” property.

Parameters

settings

a WebKitSettings

 

font_size

minimum font size to be set in pixels

 

webkit_settings_get_default_charset ()

const gchar *
webkit_settings_get_default_charset (WebKitSettings *settings);

Gets the “default-charset” property.

Parameters

settings

a WebKitSettings

 

Returns

Default charset.


webkit_settings_set_default_charset ()

void
webkit_settings_set_default_charset (WebKitSettings *settings,
                                     const gchar *default_charset);

Set the “default-charset” property.

Parameters

settings

a WebKitSettings

 

default_charset

default charset to be set

 

webkit_settings_get_enable_private_browsing ()

gboolean
webkit_settings_get_enable_private_browsing
                               (WebKitSettings *settings);

webkit_settings_get_enable_private_browsing has been deprecated since version 2.16. and should not be used in newly-written code.

Use “is-ephemeral” or “is-ephemeral” instead.

Get the “enable-private-browsing” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If private browsing is enabled or FALSE otherwise.


webkit_settings_set_enable_private_browsing ()

void
webkit_settings_set_enable_private_browsing
                               (WebKitSettings *settings,
                                gboolean enabled);

webkit_settings_set_enable_private_browsing has been deprecated since version 2.16. and should not be used in newly-written code.

Use “is-ephemeral” or “is-ephemeral” instead.

Set the “enable-private-browsing” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_developer_extras ()

gboolean
webkit_settings_get_enable_developer_extras
                               (WebKitSettings *settings);

Get the “enable-developer-extras” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If developer extras is enabled or FALSE otherwise.


webkit_settings_set_enable_developer_extras ()

void
webkit_settings_set_enable_developer_extras
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-developer-extras” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_resizable_text_areas ()

gboolean
webkit_settings_get_enable_resizable_text_areas
                               (WebKitSettings *settings);

Get the “enable-resizable-text-areas” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If text areas can be resized or FALSE otherwise.


webkit_settings_set_enable_resizable_text_areas ()

void
webkit_settings_set_enable_resizable_text_areas
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-resizable-text-areas” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_tabs_to_links ()

gboolean
webkit_settings_get_enable_tabs_to_links
                               (WebKitSettings *settings);

Get the “enable-tabs-to-links” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If tabs to link is enabled or FALSE otherwise.


webkit_settings_set_enable_tabs_to_links ()

void
webkit_settings_set_enable_tabs_to_links
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-tabs-to-links” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_dns_prefetching ()

gboolean
webkit_settings_get_enable_dns_prefetching
                               (WebKitSettings *settings);

Get the “enable-dns-prefetching” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If DNS prefetching is enabled or FALSE otherwise.


webkit_settings_set_enable_dns_prefetching ()

void
webkit_settings_set_enable_dns_prefetching
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-dns-prefetching” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_caret_browsing ()

gboolean
webkit_settings_get_enable_caret_browsing
                               (WebKitSettings *settings);

Get the “enable-caret-browsing” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If caret browsing is enabled or FALSE otherwise.


webkit_settings_set_enable_caret_browsing ()

void
webkit_settings_set_enable_caret_browsing
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-caret-browsing” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_fullscreen ()

gboolean
webkit_settings_get_enable_fullscreen (WebKitSettings *settings);

Get the “enable-fullscreen” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If fullscreen support is enabled or FALSE otherwise.


webkit_settings_set_enable_fullscreen ()

void
webkit_settings_set_enable_fullscreen (WebKitSettings *settings,
                                       gboolean enabled);

Set the “enable-fullscreen” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_print_backgrounds ()

gboolean
webkit_settings_get_print_backgrounds (WebKitSettings *settings);

Get the “print-backgrounds” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If background images should be printed or FALSE otherwise.


webkit_settings_set_print_backgrounds ()

void
webkit_settings_set_print_backgrounds (WebKitSettings *settings,
                                       gboolean print_backgrounds);

Set the “print-backgrounds” property.

Parameters

settings

a WebKitSettings

 

print_backgrounds

Value to be set

 

webkit_settings_get_enable_webaudio ()

gboolean
webkit_settings_get_enable_webaudio (WebKitSettings *settings);

Get the “enable-webaudio” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If webaudio support is enabled or FALSE otherwise.


webkit_settings_set_enable_webaudio ()

void
webkit_settings_set_enable_webaudio (WebKitSettings *settings,
                                     gboolean enabled);

Set the “enable-webaudio” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_webgl ()

gboolean
webkit_settings_get_enable_webgl (WebKitSettings *settings);

Get the “enable-webgl” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If WebGL support is enabled or FALSE otherwise.


webkit_settings_set_enable_webgl ()

void
webkit_settings_set_enable_webgl (WebKitSettings *settings,
                                  gboolean enabled);

Set the “enable-webgl” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_set_allow_modal_dialogs ()

void
webkit_settings_set_allow_modal_dialogs
                               (WebKitSettings *settings,
                                gboolean allowed);

Set the “allow-modal-dialogs” property.

Parameters

settings

a WebKitSettings

 

allowed

Value to be set

 

webkit_settings_get_allow_modal_dialogs ()

gboolean
webkit_settings_get_allow_modal_dialogs
                               (WebKitSettings *settings);

Get the “allow-modal-dialogs” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if it's allowed to create and run modal dialogs or FALSE otherwise.


webkit_settings_get_zoom_text_only ()

gboolean
webkit_settings_get_zoom_text_only (WebKitSettings *settings);

Get the “zoom-text-only” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If zoom level of the view should only affect the text or FALSE if all view contents should be scaled.


webkit_settings_set_zoom_text_only ()

void
webkit_settings_set_zoom_text_only (WebKitSettings *settings,
                                    gboolean zoom_text_only);

Set the “zoom-text-only” property.

Parameters

settings

a WebKitSettings

 

zoom_text_only

Value to be set

 

webkit_settings_get_javascript_can_access_clipboard ()

gboolean
webkit_settings_get_javascript_can_access_clipboard
                               (WebKitSettings *settings);

Get the “javascript-can-access-clipboard” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If javascript-can-access-clipboard is enabled or FALSE otherwise.


webkit_settings_set_javascript_can_access_clipboard ()

void
webkit_settings_set_javascript_can_access_clipboard
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “javascript-can-access-clipboard” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_media_playback_requires_user_gesture ()

gboolean
webkit_settings_get_media_playback_requires_user_gesture
                               (WebKitSettings *settings);

Get the “media-playback-requires-user-gesture” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If an user gesture is needed to play or load media or FALSE if no user gesture is needed.


webkit_settings_set_media_playback_requires_user_gesture ()

void
webkit_settings_set_media_playback_requires_user_gesture
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “media-playback-requires-user-gesture” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_media_playback_allows_inline ()

gboolean
webkit_settings_get_media_playback_allows_inline
                               (WebKitSettings *settings);

Get the “media-playback-allows-inline” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If inline playback is allowed for media or FALSE if only fullscreen playback is allowed.


webkit_settings_set_media_playback_allows_inline ()

void
webkit_settings_set_media_playback_allows_inline
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “media-playback-allows-inline” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_draw_compositing_indicators ()

gboolean
webkit_settings_get_draw_compositing_indicators
                               (WebKitSettings *settings);

Get the “draw-compositing-indicators” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If compositing borders are drawn or FALSE otherwise.


webkit_settings_set_draw_compositing_indicators ()

void
webkit_settings_set_draw_compositing_indicators
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “draw-compositing-indicators” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_site_specific_quirks ()

gboolean
webkit_settings_get_enable_site_specific_quirks
                               (WebKitSettings *settings);

Get the “enable-site-specific-quirks” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if site specific quirks are enabled or FALSE otherwise.


webkit_settings_set_enable_site_specific_quirks ()

void
webkit_settings_set_enable_site_specific_quirks
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-site-specific-quirks” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_page_cache ()

gboolean
webkit_settings_get_enable_page_cache (WebKitSettings *settings);

Get the “enable-page-cache” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if page cache enabled or FALSE otherwise.


webkit_settings_set_enable_page_cache ()

void
webkit_settings_set_enable_page_cache (WebKitSettings *settings,
                                       gboolean enabled);

Set the “enable-page-cache” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_user_agent ()

const gchar *
webkit_settings_get_user_agent (WebKitSettings *settings);

Get the “user-agent” property.

Parameters

settings

a WebKitSettings

 

Returns

The current value of the user-agent property.


webkit_settings_set_user_agent ()

void
webkit_settings_set_user_agent (WebKitSettings *settings,
                                const gchar *user_agent);

Set the “user-agent” property.

Parameters

settings

a WebKitSettings

 

user_agent

The new custom user agent string or NULL to use the default user agent.

[allow-none]

webkit_settings_set_user_agent_with_application_details ()

void
webkit_settings_set_user_agent_with_application_details
                               (WebKitSettings *settings,
                                const gchar *application_name,
                                const gchar *application_version);

Set the “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.

Parameters

settings

a WebKitSettings

 

application_name

The application name used for the user agent or NULL to use the default user agent.

[allow-none]

application_version

The application version for the user agent or NULL to user the default version.

[allow-none]

webkit_settings_get_enable_smooth_scrolling ()

gboolean
webkit_settings_get_enable_smooth_scrolling
                               (WebKitSettings *settings);

Get the “enable-smooth-scrolling” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if smooth scrolling is enabled or FALSE otherwise.


webkit_settings_set_enable_smooth_scrolling ()

void
webkit_settings_set_enable_smooth_scrolling
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-smooth-scrolling” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

webkit_settings_get_enable_accelerated_2d_canvas ()

gboolean
webkit_settings_get_enable_accelerated_2d_canvas
                               (WebKitSettings *settings);

webkit_settings_get_enable_accelerated_2d_canvas has been deprecated since version 2.32. and should not be used in newly-written code.

Get the “enable-accelerated-2d-canvas” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if accelerated 2D canvas is enabled or FALSE otherwise.

Since: 2.2


webkit_settings_set_enable_accelerated_2d_canvas ()

void
webkit_settings_set_enable_accelerated_2d_canvas
                               (WebKitSettings *settings,
                                gboolean enabled);

webkit_settings_set_enable_accelerated_2d_canvas has been deprecated since version 2.32. and should not be used in newly-written code.

Set the “enable-accelerated-2d-canvas” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.2


webkit_settings_get_enable_write_console_messages_to_stdout ()

gboolean
webkit_settings_get_enable_write_console_messages_to_stdout
                               (WebKitSettings *settings);

Get the “enable-write-console-messages-to-stdout” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if writing console messages to stdout is enabled or FALSE otherwise.

Since: 2.2


webkit_settings_set_enable_write_console_messages_to_stdout ()

void
webkit_settings_set_enable_write_console_messages_to_stdout
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-write-console-messages-to-stdout” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.2


webkit_settings_get_enable_media_stream ()

gboolean
webkit_settings_get_enable_media_stream
                               (WebKitSettings *settings);

Get the “enable-media-stream” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If mediastream support is enabled or FALSE otherwise.

Since: 2.4


webkit_settings_set_enable_media_stream ()

void
webkit_settings_set_enable_media_stream
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-media-stream” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.4


webkit_settings_get_enable_mock_capture_devices ()

gboolean
webkit_settings_get_enable_mock_capture_devices
                               (WebKitSettings *settings);

Get the “enable-mock-capture-devices” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If mock capture devices is enabled or FALSE otherwise.

Since: 2.24


webkit_settings_set_enable_mock_capture_devices ()

void
webkit_settings_set_enable_mock_capture_devices
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-mock-capture-devices” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.4


webkit_settings_get_enable_spatial_navigation ()

gboolean
webkit_settings_get_enable_spatial_navigation
                               (WebKitSettings *settings);

Get the “enable-spatial-navigation” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If HTML5 spatial navigation support is enabled or FALSE otherwise.

Since: 2.2


webkit_settings_set_enable_spatial_navigation ()

void
webkit_settings_set_enable_spatial_navigation
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-spatial-navigation” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.2


webkit_settings_get_enable_mediasource ()

gboolean
webkit_settings_get_enable_mediasource
                               (WebKitSettings *settings);

Get the “enable-mediasource” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If MediaSource support is enabled or FALSE otherwise.

Since: 2.4


webkit_settings_set_enable_mediasource ()

void
webkit_settings_set_enable_mediasource
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-mediasource” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.4


webkit_settings_get_enable_encrypted_media ()

gboolean
webkit_settings_get_enable_encrypted_media
                               (WebKitSettings *settings);

Get the “enable-encrypted-media” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if EncryptedMedia support is enabled or FALSE otherwise.

Since: 2.20


webkit_settings_set_enable_encrypted_media ()

void
webkit_settings_set_enable_encrypted_media
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-encrypted-media” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.20


webkit_settings_get_enable_media_capabilities ()

gboolean
webkit_settings_get_enable_media_capabilities
                               (WebKitSettings *settings);

Get the “enable-media-capabilities” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if MediaCapabilities support is enabled or FALSE otherwise.

Since: 2.22


webkit_settings_set_enable_media_capabilities ()

void
webkit_settings_set_enable_media_capabilities
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-media-capabilities” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.22


webkit_settings_get_allow_file_access_from_file_urls ()

gboolean
webkit_settings_get_allow_file_access_from_file_urls
                               (WebKitSettings *settings);

Get the “allow-file-access-from-file-urls” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If file access from file URLs is allowed or FALSE otherwise.

Since: 2.10


webkit_settings_set_allow_file_access_from_file_urls ()

void
webkit_settings_set_allow_file_access_from_file_urls
                               (WebKitSettings *settings,
                                gboolean allowed);

Set the “allow-file-access-from-file-urls” property.

Parameters

settings

a WebKitSettings

 

allowed

Value to be set

 

Since: 2.10


webkit_settings_get_allow_universal_access_from_file_urls ()

gboolean
webkit_settings_get_allow_universal_access_from_file_urls
                               (WebKitSettings *settings);

Get the “allow-universal-access-from-file-urls” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If universal access from file URLs is allowed or FALSE otherwise.

Since: 2.14


webkit_settings_set_allow_universal_access_from_file_urls ()

void
webkit_settings_set_allow_universal_access_from_file_urls
                               (WebKitSettings *settings,
                                gboolean allowed);

Set the “allow-universal-access-from-file-urls” property.

Parameters

settings

a WebKitSettings

 

allowed

Value to be set

 

Since: 2.14


webkit_settings_get_allow_top_navigation_to_data_urls ()

gboolean
webkit_settings_get_allow_top_navigation_to_data_urls
                               (WebKitSettings *settings);

Get the “allow-top-navigation-to-data-urls” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE If navigation to data URLs from the top frame is allowed or FALSE\ otherwise.

Since: 2.28


webkit_settings_set_allow_top_navigation_to_data_urls ()

void
webkit_settings_set_allow_top_navigation_to_data_urls
                               (WebKitSettings *settings,
                                gboolean allowed);

Set the “allow-top-navigation-to-data-urls” property.

Parameters

settings

a WebKitSettings

 

allowed

Value to be set

 

Since: 2.28


webkit_settings_get_hardware_acceleration_policy ()

WebKitHardwareAccelerationPolicy
webkit_settings_get_hardware_acceleration_policy
                               (WebKitSettings *settings);

Get the “hardware-acceleration-policy” property.

Return: a WebKitHardwareAccelerationPolicy

Parameters

settings

a WebKitSettings

 

Since: 2.16


webkit_settings_set_hardware_acceleration_policy ()

void
webkit_settings_set_hardware_acceleration_policy
                               (WebKitSettings *settings,
                                WebKitHardwareAccelerationPolicy policy);

Set the “hardware-acceleration-policy” property.

Parameters

Since: 2.16


webkit_settings_get_enable_back_forward_navigation_gestures ()

gboolean
webkit_settings_get_enable_back_forward_navigation_gestures
                               (WebKitSettings *settings);

Get the “enable-back-forward-navigation-gestures” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if horizontal swipe gesture will trigger back-forward navigaiton or FALSE otherwise.

Since: 2.24


webkit_settings_set_enable_back_forward_navigation_gestures ()

void
webkit_settings_set_enable_back_forward_navigation_gestures
                               (WebKitSettings *settings,
                                gboolean enabled);

Set the “enable-back-forward-navigation-gestures” property.

Parameters

settings

a WebKitSettings

 

enabled

value to be set

 

Since: 2.24


webkit_settings_font_size_to_points ()

guint32
webkit_settings_font_size_to_points (guint32 pixels);

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 WebKitSettings.

Parameters

pixels

the font size in pixels to convert to points

 

Returns

the equivalent font size in points.

Since: 2.20


webkit_settings_font_size_to_pixels ()

guint32
webkit_settings_font_size_to_pixels (guint32 points);

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 WebKitSettings.

Parameters

points

the font size in points to convert to pixels

 

Returns

the equivalent font size in pixels.

Since: 2.20


webkit_settings_get_enable_media ()

gboolean
webkit_settings_get_enable_media (WebKitSettings *settings);

Get the “enable-media” property.

Parameters

settings

a WebKitSettings

 

Returns

TRUE if media support is enabled or FALSE otherwise.

Since: 2.26


webkit_settings_set_enable_media ()

void
webkit_settings_set_enable_media (WebKitSettings *settings,
                                  gboolean enabled);

Set the “enable-media” property.

Parameters

settings

a WebKitSettings

 

enabled

Value to be set

 

Since: 2.26


webkit_settings_get_media_content_types_requiring_hardware_support ()

const gchar *
webkit_settings_get_media_content_types_requiring_hardware_support
                               (WebKitSettings *settings);

Gets the “media-content-types-requiring-hardware-support” property.

Parameters

settings

a WebKitSettings

 

Returns

Media content types requiring hardware support, or NULL.

Since: 2.30


webkit_settings_set_media_content_types_requiring_hardware_support ()

void
webkit_settings_set_media_content_types_requiring_hardware_support
                               (WebKitSettings *settings,
                                const gchar *content_types);

Set the “media-content-types-requiring-hardware-support” property.

Parameters

settings

a WebKitSettings

 

content_types

list of media content types requiring hardware support split by semicolons (:) or NULL to use the default value.

[allow-none]

Since: 2.30

Types and Values

struct WebKitSettings

struct WebKitSettings;

enum WebKitHardwareAccelerationPolicy

Enum values used for determining the hardware acceleration policy.

Members

WEBKIT_HARDWARE_ACCELERATION_POLICY_ON_DEMAND

Hardware acceleration is enabled/disabled as request by web contents.

 

WEBKIT_HARDWARE_ACCELERATION_POLICY_ALWAYS

Hardware acceleration is always enabled, even for websites not requesting it.

 

WEBKIT_HARDWARE_ACCELERATION_POLICY_NEVER

Hardware acceleration is always disabled, even for websites requesting it.

 

Since: 2.16

Property Details

The “allow-file-access-from-file-urls” property

  “allow-file-access-from-file-urls” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.10


The “allow-modal-dialogs” property

  “allow-modal-dialogs”      gboolean

Determine whether it's allowed to create and run modal dialogs from a WebKitWebView through JavaScript with window.showModalDialog. If it's set to FALSE, the associated WebKitWebView won't be able to create new modal dialogs, so not even the “create” signal will be emitted.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “allow-top-navigation-to-data-urls” property

  “allow-top-navigation-to-data-urls” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.28


The “allow-universal-access-from-file-urls” property

  “allow-universal-access-from-file-urls” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.14


The “auto-load-images” property

  “auto-load-images”         gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “cursive-font-family” property

  “cursive-font-family”      char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "serif"


The “default-charset” property

  “default-charset”          char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "iso-8859-1"


The “default-font-family” property

  “default-font-family”      char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "sans-serif"


The “default-font-size” property

  “default-font-size”        guint

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: 16


The “default-monospace-font-size” property

  “default-monospace-font-size” guint

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: 13


The “draw-compositing-indicators” property

  “draw-compositing-indicators” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “enable-accelerated-2d-canvas” property

  “enable-accelerated-2d-canvas” gboolean

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.

WebKitSettings:enable-accelerated-2d-canvas has been deprecated since version 2.32. and should not be used in newly-written code.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.2


The “enable-back-forward-navigation-gestures” property

  “enable-back-forward-navigation-gestures” gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.24


The “enable-caret-browsing” property

  “enable-caret-browsing”    gboolean

Whether to enable accessibility enhanced keyboard navigation.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “enable-developer-extras” property

  “enable-developer-extras”  gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “enable-dns-prefetching” property

  “enable-dns-prefetching”   gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “enable-encrypted-media” property

  “enable-encrypted-media”   gboolean

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/

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.20


The “enable-frame-flattening” property

  “enable-frame-flattening”  gboolean

Whether to enable the frame flattening. With this setting each subframe is expanded to its contents, which will flatten all the frames to become one scrollable page. On touch devices scrollable subframes on a page can result in a confusing user experience.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “enable-fullscreen” property

  “enable-fullscreen”        gboolean

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/

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-html5-database” property

  “enable-html5-database”    gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-html5-local-storage” property

  “enable-html5-local-storage” gboolean

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/.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-hyperlink-auditing” property

  “enable-hyperlink-auditing” gboolean

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.htmlhyperlink-auditing.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-java” property

  “enable-java”              gboolean

Determines whether or not Java is enabled on the page.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-javascript” property

  “enable-javascript”        gboolean

Determines whether or not JavaScript executes within a page.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-javascript-markup” property

  “enable-javascript-markup” gboolean

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 “enable-javascript” is TRUE.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE

Since: 2.24


The “enable-media” property

  “enable-media”             gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE

Since: 2.26


The “enable-media-capabilities” property

  “enable-media-capabilities” gboolean

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/

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.22


The “enable-media-stream” property

  “enable-media-stream”      gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.4


The “enable-mediasource” property

  “enable-mediasource”       gboolean

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/

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE

Since: 2.4


The “enable-mock-capture-devices” property

  “enable-mock-capture-devices” gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.24


The “enable-offline-web-application-cache” property

  “enable-offline-web-application-cache” gboolean

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.

HTML5 offline web application specification is available at http://dev.w3.org/html5/spec/offline.html.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-page-cache” property

  “enable-page-cache”        gboolean

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/

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-plugins” property

  “enable-plugins”           gboolean

Determines whether or not plugins on the page are enabled.

WebKitSettings:enable-plugins has been deprecated since version 2.32 and should not be used in newly-written code.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “enable-private-browsing” property

  “enable-private-browsing”  gboolean

Determines whether or not private browsing is enabled. Private browsing will disable history, cache and form auto-fill for any pages visited.

WebKitSettings:enable-private-browsing has been deprecated since version 2.16. and should not be used in newly-written code.

Use “is-ephemeral” or “is-ephemeral” instead.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “enable-resizable-text-areas” property

  “enable-resizable-text-areas” gboolean

Determines whether or not text areas can be resized.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-site-specific-quirks” property

  “enable-site-specific-quirks” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-smooth-scrolling” property

  “enable-smooth-scrolling”  gboolean

Enable or disable smooth scrolling.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-spatial-navigation” property

  “enable-spatial-navigation” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.4


The “enable-tabs-to-links” property

  “enable-tabs-to-links”     gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-webaudio” property

  “enable-webaudio”          gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-webgl” property

  “enable-webgl”             gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “enable-write-console-messages-to-stdout” property

  “enable-write-console-messages-to-stdout” gboolean

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE

Since: 2.2


The “enable-xss-auditor” property

  “enable-xss-auditor”       gboolean

Whether to enable the XSS auditor. This feature filters some kinds of reflective XSS attacks on vulnerable web sites.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “fantasy-font-family” property

  “fantasy-font-family”      char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "serif"


The “hardware-acceleration-policy” property

  “hardware-acceleration-policy” WebKitHardwareAccelerationPolicy

The WebKitHardwareAccelerationPolicy to decide how to enable and disable hardware acceleration. The default value WEBKIT_HARDWARE_ACCELERATION_POLICY_ON_DEMAND enables the hardware acceleration when the web contents request it. It's possible to enforce hardware acceleration to be always enabled by using WEBKIT_HARDWARE_ACCELERATION_POLICY_ALWAYS. And it's also possible to disable it completely using WEBKIT_HARDWARE_ACCELERATION_POLICY_NEVER. Note that 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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: WEBKIT_HARDWARE_ACCELERATION_POLICY_ALWAYS

Since: 2.16


The “javascript-can-access-clipboard” property

  “javascript-can-access-clipboard” gboolean

Whether JavaScript can access the clipboard. The default value is FALSE. If set to TRUE, document.execCommand() allows cut, copy and paste commands.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “javascript-can-open-windows-automatically” property

  “javascript-can-open-windows-automatically” gboolean

Whether JavaScript can open popup windows automatically without user intervention.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “load-icons-ignoring-image-load-setting” property

  “load-icons-ignoring-image-load-setting” gboolean

Determines whether a site can load favicons irrespective of the value of “auto-load-images”.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “media-content-types-requiring-hardware-support” property

  “media-content-types-requiring-hardware-support” char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: NULL

Since: 2.30


The “media-playback-allows-inline” property

  “media-playback-allows-inline” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “media-playback-requires-user-gesture” property

  “media-playback-requires-user-gesture” gboolean

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE


The “minimum-font-size” property

  “minimum-font-size”        guint

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: 0


The “monospace-font-family” property

  “monospace-font-family”    char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "monospace"


The “pictograph-font-family” property

  “pictograph-font-family”   char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "serif"


The “print-backgrounds” property

  “print-backgrounds”        gboolean

Whether background images should be drawn during printing.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: TRUE


The “sans-serif-font-family” property

  “sans-serif-font-family”   char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "sans-serif"


The “serif-font-family” property

  “serif-font-family”        char *

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

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: "serif"


The “user-agent” property

  “user-agent”               char *

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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: NULL


The “zoom-text-only” property

  “zoom-text-only”           gboolean

Whether “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.

Owner: WebKitSettings

Flags: Read / Write / Construct

Default value: FALSE