Struct WebContext 

pub struct WebContext { /* private fields */ }

Manages aspects common to all WebViews

The WebContext manages all aspects common to all WebViews.

You can define the CacheModel with set_cache_model(), depending on the needs of your application. You can access the SecurityManager to specify the behaviour of your application regarding security using security_manager().

It is also possible to change your preferred language or enable spell checking, using set_preferred_languages(), set_spell_checking_languages() and set_spell_checking_enabled().

You can use register_uri_scheme() to register custom URI schemes, and manage several other settings.

TLS certificate validation failure is now treated as a transport error by default. To handle TLS failures differently, you can connect to load-failed-with-tls-errors. Alternatively, you can use webkit_web_context_set_tls_errors_policy() to set the policy TLSErrorsPolicy::Ignore; however, this is not appropriate for Internet applications.

Properties

memory-pressure-settings

The MemoryPressureSettings applied to the web processes created by this context.

Writeable | Construct Only

time-zone-override

The timezone override for this web context. Setting this property provides a better alternative to configure the timezone information for all webviews managed by the WebContext. The other, less optimal, approach is to globally set the TZ environment variable in the process before creating the context. However this approach might not be very convenient and can have side-effects in your application.

The expected values for this property are defined in the IANA timezone database. See this wikipedia page for instance, https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Readable | Writeable | Construct Only

Signals

automation-started

This signal is emitted when a new automation request is made. Note that it will never be emitted if automation is not enabled in context, see WebContext::set_automation_allowed() for more details.

initialize-notification-permissions

This signal is emitted when a WebContext needs to set initial notification permissions for a web process. It is emitted when a new web process is about to be launched, and signals the most appropriate moment to use WebContext::initialize_notification_permissions(). If no notification permissions have changed since the last time this signal was emitted, then there is no need to call WebContext::initialize_notification_permissions() again.

initialize-web-process-extensions

This signal is emitted when a new web process is about to be launched. It signals the most appropriate moment to use WebContext::set_web_process_extensions_initialization_user_data() and WebContext::set_web_process_extensions_directory().

user-message-received

This signal is emitted when a UserMessage is received from a web process extension. You can reply to the message using UserMessage::send_reply().

You can handle the user message asynchronously by calling g_object_ref() on message and returning true.

GLib type: GObject with reference counted clone semantics.

Implementations

impl WebContext

pub fn new() -> WebContext

Create a new WebContext.

Returns

a newly created WebContext

pub fn builder() -> WebContextBuilder

Creates a new builder-pattern struct instance to construct WebContext objects.

This method returns an instance of WebContextBuilder which can be used to create WebContext objects.

pub fn add_path_to_sandbox(&self, path: impl AsRef<Path>, read_only: bool)

Adds a path to be mounted in the sandbox.

path must exist before any web process has been created. It is a fatal error to add paths after a web process has been spawned.

Paths under /sys, /proc, and /dev are invalid. Attempting to add all of / is not valid. Since 2.40, adding the user’s entire home directory or /home is also not valid.

See also webkit_web_context_set_sandbox_enabled()

path

an absolute path to mount in the sandbox

read_only

if true the path will be read-only

pub fn cache_model(&self) -> CacheModel

Returns the current cache model.

For more information about this value check the documentation of the function set_cache_model().

Returns

the current CacheModel

pub fn geolocation_manager(&self) -> Option<GeolocationManager>

Get the GeolocationManager of self.

Returns

the GeolocationManager of self.

pub fn network_session_for_automation(&self) -> Option<NetworkSession>

Get the NetworkSession used for automation sessions started in self.

Returns

a NetworkSession, or None if automation is not enabled

pub fn security_manager(&self) -> Option<SecurityManager>

Get the SecurityManager of self.

Returns

the SecurityManager of self.

pub fn is_spell_checking_enabled(&self) -> bool

Get whether spell checking feature is currently enabled.

Returns

true If spell checking is enabled, or false otherwise.

pub fn spell_checking_languages(&self) -> Vec<GString>

Get the the list of spell checking languages.

Get the the list of spell checking languages associated with self, or None if no languages have been previously set.

See set_spell_checking_languages() for more details on the format of the languages in the list.

Returns

A None-terminated array of languages if available, or None otherwise.

pub fn time_zone_override(&self) -> Option<GString>

Get the time-zone-override property.

pub fn initialize_notification_permissions( &self, allowed_origins: &[&SecurityOrigin], disallowed_origins: &[&SecurityOrigin], )

Sets initial desktop notification permissions for the self.

allowed_origins and disallowed_origins must each be GList of SecurityOrigin objects representing origins that will, respectively, either always or never have permission to show desktop notifications. No NotificationPermissionRequest will ever be generated for any of the security origins represented in allowed_origins or disallowed_origins. This function is necessary because some webpages proactively check whether they have permission to display notifications without ever creating a permission request.

This function only affects web processes that have not already been created. The best time to call it is when handling initialize-notification-permissions so as to ensure that new web processes receive the most recent set of permissions.

allowed_origins

a GList of security origins

disallowed_origins

a GList of security origins

pub fn is_automation_allowed(&self) -> bool

Get whether automation is allowed in self.

See also set_automation_allowed().

Returns

true if automation is allowed or false otherwise.

pub fn register_uri_scheme<P: Fn(&URISchemeRequest) + 'static>( &self, scheme: &str, callback: P, )

Register scheme in self.

Register scheme in self, so that when an URI request with scheme is made in the WebContext, the WebKitURISchemeRequestCallback registered will be called with a URISchemeRequest. It is possible to handle URI scheme requests asynchronously, by calling g_object_ref() on the URISchemeRequest and calling URISchemeRequest::finish() later when the data of the request is available or URISchemeRequest::finish_error() in case of error.

⚠️ The following code is in c ⚠️

static void
about_uri_scheme_request_cb (WebKitURISchemeRequest *request,
                             gpointer                user_data)
{
    GInputStream *stream;
    gsize         stream_length;
    const gchar  *path = webkit_uri_scheme_request_get_path (request);

    if (!g_strcmp0 (path, "memory")) {
        // Create a GInputStream with the contents of memory about page, and set its length to stream_length
    } else if (!g_strcmp0 (path, "applications")) {
        // Create a GInputStream with the contents of applications about page, and set its length to stream_length
    } else if (!g_strcmp0 (path, "example")) {
        gchar *contents = g_strdup_printf ("<html><body><p>Example about page</p></body></html>");
        stream_length = strlen (contents);
        stream = g_memory_input_stream_new_from_data (contents, stream_length, g_free);
    } else {
        GError *error = g_error_new (ABOUT_HANDLER_ERROR, ABOUT_HANDLER_ERROR_INVALID, "Invalid about:%s page.", path);
        webkit_uri_scheme_request_finish_error (request, error);
        g_error_free (error);
        return;
    }
    webkit_uri_scheme_request_finish (request, stream, stream_length, "text/html");
    g_object_unref (stream);
}

scheme

the network scheme to register

callback

a WebKitURISchemeRequestCallback

user_data_destroy_func

destroy notify for user_data

pub fn send_message_to_all_extensions(&self, message: &UserMessage)

Send message to all web process extensions associated to self.

If message is floating, it’s consumed.

message

a UserMessage

pub fn set_automation_allowed(&self, allowed: bool)

Set whether automation is allowed in self.

When automation is enabled the browser could be controlled by another process by requesting an automation session. When a new automation session is requested the signal automation-started is emitted. Automation is disabled by default, so you need to explicitly call this method passing true to enable it.

Note that only one WebContext can have automation enabled, so this will do nothing if there’s another WebContext with automation already enabled.

allowed

value to set

pub fn set_cache_model(&self, cache_model: CacheModel)

Specifies a usage model for WebViews.

Specifies a usage model for WebViews, which WebKit will use to determine its caching behavior. All web views follow the cache model. This cache model determines the RAM and disk space to use for caching previously viewed content .

Research indicates that users tend to browse within clusters of documents that hold resources in common, and to revisit previously visited documents. WebKit and the frameworks below it include built-in caches that take advantage of these patterns, substantially improving document load speed in browsing situations. The WebKit cache model controls the behaviors of all of these caches, including various WebCore caches.

Browsers can improve document load speed substantially by specifying CacheModel::WebBrowser. Applications without a browsing interface can reduce memory usage substantially by specifying CacheModel::DocumentViewer. The default value is CacheModel::WebBrowser.

cache_model

a CacheModel

pub fn set_preferred_languages(&self, languages: &[&str])

Set the list of preferred languages.

Set the list of preferred languages, sorted from most desirable to least desirable. The list will be used in the following ways:

• Determining how to build the Accept-Language HTTP header that will be included in the network requests started by the WebContext.
• Setting the values of navigator.language and navigator.languages.
• The first item in the list sets the default locale for JavaScript Intl functions.

languages

a None-terminated list of language identifiers

pub fn set_spell_checking_enabled(&self, enabled: bool)

Enable or disable the spell checking feature.

enabled

Value to be set

pub fn set_spell_checking_languages(&self, languages: &[&str])

Set the list of spell checking languages to be used for spell checking.

The locale string typically is in the form lang_COUNTRY, where lang is an ISO-639 language code, and COUNTRY is an ISO-3166 country code. For instance, sv_FI for Swedish as written in Finland or pt_BR for Portuguese as written in Brazil.

You need to call this function with a valid list of languages at least once in order to properly enable the spell checking feature in WebKit.

languages

a None-terminated list of spell checking languages

pub fn set_web_process_extensions_directory(&self, directory: &str)

Set the directory where WebKit will look for web process extensions.

This method must be called before loading anything in this context, otherwise it will not have any effect. You can connect to initialize-web-process-extensions to call this method before anything is loaded.

If your web process extension is installed to an unusual location, then you may also need to call add_path_to_sandbox().

directory

the directory to add

pub fn set_web_process_extensions_initialization_user_data( &self, user_data: &Variant, )

Set user data to be passed to Web Extensions on initialization.

The data will be passed to the WebKitWebProcessExtensionInitializeWithUserDataFunction. This method must be called before loading anything in this context, otherwise it will not have any effect. You can connect to initialize-web-process-extensions to call this method before anything is loaded.

pub fn default() -> Option<WebContext>

Gets the default web context.

Returns

a WebContext

pub fn connect_automation_started<F: Fn(&Self, &AutomationSession) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when a new automation request is made. Note that it will never be emitted if automation is not enabled in context, see set_automation_allowed() for more details.

session

the AutomationSession associated with this event

pub fn connect_initialize_notification_permissions<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when a WebContext needs to set initial notification permissions for a web process. It is emitted when a new web process is about to be launched, and signals the most appropriate moment to use initialize_notification_permissions(). If no notification permissions have changed since the last time this signal was emitted, then there is no need to call initialize_notification_permissions() again.

pub fn connect_initialize_web_process_extensions<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when a new web process is about to be launched. It signals the most appropriate moment to use set_web_process_extensions_initialization_user_data() and set_web_process_extensions_directory().

pub fn connect_user_message_received<F: Fn(&Self, &UserMessage) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when a UserMessage is received from a web process extension. You can reply to the message using UserMessage::send_reply().

You can handle the user message asynchronously by calling g_object_ref() on message and returning true.

message

the UserMessage received

Returns

true if the message was handled, or false otherwise.

Trait Implementations

impl Clone for WebContext

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WebContext

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for WebContext

type ParamSpec = ParamSpecObject

type SetValue = WebContext

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, WebContext>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WebContext

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WebContext

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for WebContext

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for WebContext

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for WebContext

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for WebContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WebContext