GI.WebKit2.Objects.WebContext

Manages aspects common to all WebViews

The WebContext manages all aspects common to all WebViews.

You can define the CacheModel and ProcessModel with webContextSetCacheModel and webContextSetProcessModel, depending on the needs of your application. You can access the SecurityManager to specify the behaviour of your application regarding security using webContextGetSecurityManager.

It is also possible to change your preferred language or enable spell checking, using webContextSetPreferredLanguages, webContextSetSpellCheckingLanguages and webContextSetSpellCheckingEnabled.

You can use webContextRegisterUriScheme 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 WebView::loadFailedWithTlsErrors. Alternatively, you can use webContextSetTlsErrorsPolicy to set the policy TLSErrorsPolicyIgnore; however, this is not appropriate for Internet applications.

Exported types

newtype WebContext

Memory-managed wrapper type.

Constructors

WebContext (ManagedPtr WebContext)

Instances

Eq WebContext

Defined in GI.WebKit2.Objects.WebContext

Methods

(==) :: WebContext -> WebContext -> Bool

(/=) :: WebContext -> WebContext -> Bool

GObject WebContext

Defined in GI.WebKit2.Objects.WebContext

ManagedPtrNewtype WebContext

Defined in GI.WebKit2.Objects.WebContext

Methods

toManagedPtr :: WebContext -> ManagedPtr WebContext

TypedObject WebContext

Defined in GI.WebKit2.Objects.WebContext

Methods

glibType :: IO GType

HasParentTypes WebContext

Defined in GI.WebKit2.Objects.WebContext

IsGValue (Maybe WebContext)

Convert WebContext to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2.Objects.WebContext

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe WebContext -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe WebContext)

type ParentTypes WebContext

Defined in GI.WebKit2.Objects.WebContext

type ParentTypes WebContext = '[Object]

class (GObject o, IsDescendantOf WebContext o) => IsWebContext o

Type class for types which can be safely cast to WebContext, for instance with toWebContext.

Instances

(GObject o, IsDescendantOf WebContext o) => IsWebContext o

Defined in GI.WebKit2.Objects.WebContext

toWebContext :: (MonadIO m, IsWebContext o) => o -> m WebContext

Cast to WebContext, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addPathToSandbox, allowTlsCertificateForHost, bindProperty, bindPropertyFull, clearCache, downloadUri, forceFloating, freezeNotify, getv, initializeNotificationPermissions, isAutomationAllowed, isEphemeral, isFloating, notify, notifyByPspec, prefetchDns, ref, refSink, registerUriScheme, runDispose, sendMessageToAllExtensions, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getCacheModel, getCookieManager, getData, getFaviconDatabase, getFaviconDatabaseDirectory, getGeolocationManager, getPlugins, getPluginsFinish, getProcessModel, getProperty, getQdata, getSandboxEnabled, getSecurityManager, getSpellCheckingEnabled, getSpellCheckingLanguages, getTimeZoneOverride, getTlsErrorsPolicy, getUseSystemAppearanceForScrollbars, getWebProcessCountLimit, getWebsiteDataManager.

Setters

setAdditionalPluginsDirectory, setAutomationAllowed, setCacheModel, setData, setDataFull, setDiskCacheDirectory, setFaviconDatabaseDirectory, setNetworkProxySettings, setPreferredLanguages, setProcessModel, setProperty, setSandboxEnabled, setSpellCheckingEnabled, setSpellCheckingLanguages, setTlsErrorsPolicy, setUseSystemAppearanceForScrollbars, setWebExtensionsDirectory, setWebExtensionsInitializationUserData, setWebProcessCountLimit.

addPathToSandbox

webContextAddPathToSandbox

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> [Char]

path: an absolute path to mount in the sandbox

-> Bool

readOnly: if True the path will be read-only

-> m ()

Adds a path to be mounted in the sandbox.

path must exist before any web process has been created otherwise it will be silently ignored. It is a fatal error to add paths after a web process has been spawned.

Paths in directories such as /sys, /proc, and /dev or all of / are not valid.

See also webContextSetSandboxEnabled

Since: 2.26

allowTlsCertificateForHost

webContextAllowTlsCertificateForHost

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a, IsTlsCertificate b)

=> a

context: a WebContext

-> b

certificate: a TlsCertificate

-> Text

host: the host for which a certificate is to be allowed

-> m ()

Ignore further TLS errors on the host for the certificate present in info.

Since: 2.6

clearCache

webContextClearCache

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m ()

Clears all resources currently cached.

See also webContextSetCacheModel.

downloadUri

webContextDownloadUri

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Text

uri: the URI to download

-> m Download

Returns: a new Download representing the download operation.

Requests downloading of the specified URI string.

The download operation will not be associated to any WebView, if you are interested in starting a download from a particular WebView use webViewDownloadUri instead.

getCacheModel

webContextGetCacheModel

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> m CacheModel

Returns: the current CacheModel

Returns the current cache model.

For more information about this value check the documentation of the function webContextSetCacheModel.

getCookieManager

webContextGetCookieManager

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m CookieManager

Returns: the CookieManager of context.

Get the CookieManager of the context's WebsiteDataManager.

getDefault

webContextGetDefault

Arguments

:: (HasCallStack, MonadIO m)

=> m WebContext

Returns: a WebContext

Gets the default web context.

getFaviconDatabase

webContextGetFaviconDatabase

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m FaviconDatabase

Returns: the FaviconDatabase of context.

Get the FaviconDatabase associated with context.

To initialize the database you need to call webContextSetFaviconDatabaseDirectory.

getFaviconDatabaseDirectory

webContextGetFaviconDatabaseDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m (Maybe Text)

Returns: the path of the directory of the favicons database associated with context, or Nothing.

Get the directory path to store the favicons database.

Get the directory path being used to store the favicons database for context, or Nothing if webContextSetFaviconDatabaseDirectory hasn't been called yet.

This function will always return the same path after having called webContextSetFaviconDatabaseDirectory for the first time.

getGeolocationManager

webContextGetGeolocationManager

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m GeolocationManager

Returns: the GeolocationManager of context.

Get the GeolocationManager of context.

Since: 2.26

getPlugins

webContextGetPlugins

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a, IsCancellable b)

=> a

context: a WebContext

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Deprecated: (Since version 2.32)

Asynchronously get the list of installed plugins.

When the operation is finished, callback will be called. You can then call webContextGetPluginsFinish to get the result of the operation.

getPluginsFinish

webContextGetPluginsFinish

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a, IsAsyncResult b)

=> a

context: a WebContext

-> b

result: a AsyncResult

-> m [Plugin]

Returns: a List of Plugin. You must free the List with g_list_free() and unref the Plugins with objectUnref when you're done with them. (Can throw GError)

Deprecated: (Since version 2.32)

Finish an asynchronous operation started with webkit_web_context_get_plugins.

getProcessModel

webContextGetProcessModel

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> m ProcessModel

Returns: the current ProcessModel

Returns the current process model.

For more information about this value see webContextSetProcessModel.

Since: 2.4

getSandboxEnabled

webContextGetSandboxEnabled

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m Bool

Returns: True if sandboxing is enabled, or False otherwise.

Get whether sandboxing is currently enabled.

Since: 2.26

getSecurityManager

webContextGetSecurityManager

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m SecurityManager

Returns: the SecurityManager of context.

Get the SecurityManager of context.

getSpellCheckingEnabled

webContextGetSpellCheckingEnabled

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m Bool

Returns: True If spell checking is enabled, or False otherwise.

Get whether spell checking feature is currently enabled.

getSpellCheckingLanguages

webContextGetSpellCheckingLanguages

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m (Maybe [Text])

Returns: A Nothing-terminated array of languages if available, or Nothing otherwise.

Get the the list of spell checking languages.

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

See webContextSetSpellCheckingLanguages for more details on the format of the languages in the list.

getTimeZoneOverride

webContextGetTimeZoneOverride

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m Text

Get the WebContext:timeZoneOverride property.

Since: 2.38

getTlsErrorsPolicy

webContextGetTlsErrorsPolicy

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m TLSErrorsPolicy

Returns: a TLSErrorsPolicy

Deprecated: (Since version 2.32.)Use websiteDataManagerGetTlsErrorsPolicy instead.

Get the TLS errors policy of context.

getUseSystemAppearanceForScrollbars

webContextGetUseSystemAppearanceForScrollbars

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m Bool

Returns: True if scrollbars are rendering using the system appearance, or False otherwise

Get the WebContext:useSystemAppearanceForScrollbars property.

Since: 2.30

getWebProcessCountLimit

webContextGetWebProcessCountLimit

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> m Word32

Returns: the maximum limit of web processes, or 0 if there isn't a limit.

Deprecated: (Since version 2.26)

Gets the maximum number of web processes that can be created at the same time for the context.

This function is now deprecated and always returns 0 (no limit). See also webContextSetWebProcessCountLimit.

Since: 2.10

getWebsiteDataManager

webContextGetWebsiteDataManager

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> m WebsiteDataManager

Returns: a WebsiteDataManager

Get the WebsiteDataManager of context.

Since: 2.10

initializeNotificationPermissions

webContextInitializeNotificationPermissions

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> [SecurityOrigin]

allowedOrigins: a List of security origins

-> [SecurityOrigin]

disallowedOrigins: a List of security origins

-> m ()

Sets initial desktop notification permissions for the context.

allowedOrigins and disallowedOrigins must each be List 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 allowedOrigins or disallowedOrigins. 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 WebContext::initializeNotificationPermissions so as to ensure that new web processes receive the most recent set of permissions.

Since: 2.16

isAutomationAllowed

webContextIsAutomationAllowed

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> m Bool

Returns: True if automation is allowed or False otherwise.

Get whether automation is allowed in context.

See also webContextSetAutomationAllowed.

Since: 2.18

isEphemeral

webContextIsEphemeral

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> m Bool

Returns: True if context is ephemeral or False otherwise.

Get whether a WebContext is ephemeral.

Since: 2.16

new

webContextNew

Arguments

:: (HasCallStack, MonadIO m)

=> m WebContext

Returns: a newly created WebContext

Create a new WebContext.

Since: 2.8

newEphemeral

webContextNewEphemeral

Arguments

:: (HasCallStack, MonadIO m)

=> m WebContext

Returns: a new ephemeral WebContext.

Create a new ephemeral WebContext.

An ephemeral WebContext is a context created with an ephemeral WebsiteDataManager. This is just a convenient method to create ephemeral contexts without having to create your own WebsiteDataManager. All WebViews associated with this context will also be ephemeral. Websites will not store any data in the client storage. This is normally used to implement private instances.

Since: 2.16

newWithWebsiteDataManager

webContextNewWithWebsiteDataManager

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m WebContext

Returns: a newly created WebContext

Create a new WebContext with a WebsiteDataManager.

Since: 2.10

prefetchDns

webContextPrefetchDns

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Text

hostname: a hostname to be resolved

-> m ()

Resolve the domain name of the given hostname in advance.

Resolve the domain name of the given hostname in advance, so that if a URI of hostname is requested the load will be performed more quickly.

registerUriScheme

webContextRegisterUriScheme

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Text

scheme: the network scheme to register

-> URISchemeRequestCallback

callback: a URISchemeRequestCallback

-> m ()

Register scheme in context.

Register scheme in context, so that when an URI request with scheme is made in the WebContext, the URISchemeRequestCallback registered will be called with a URISchemeRequest. It is possible to handle URI scheme requests asynchronously, by calling objectRef on the URISchemeRequest and calling uRISchemeRequestFinish later when the data of the request is available or uRISchemeRequestFinishError in case of error.

c code

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);
}

sendMessageToAllExtensions

webContextSendMessageToAllExtensions

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a, IsUserMessage b)

=> a

context: the WebContext

-> b

message: a UserMessage

-> m ()

Send message to all WebKitWebExtensions associated to context.

If message is floating, it's consumed.

Since: 2.28

setAdditionalPluginsDirectory

webContextSetAdditionalPluginsDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Text

directory: the directory to add

-> m ()

Deprecated: (Since version 2.32)

Set an additional directory where WebKit will look for plugins.

setAutomationAllowed

webContextSetAutomationAllowed

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> Bool

allowed: value to set

-> m ()

Set whether automation is allowed in context.

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 WebContext::automationStarted 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.

Since: 2.18

setCacheModel

webContextSetCacheModel

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> CacheModel

cacheModel: a CacheModel

-> m ()

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 CacheModelWebBrowser. Applications without a browsing interface can reduce memory usage substantially by specifying CacheModelDocumentViewer. The default value is CacheModelWebBrowser.

setDiskCacheDirectory

webContextSetDiskCacheDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Text

directory: the directory to set

-> m ()

Deprecated: (Since version 2.10.)Use webContextNewWithWebsiteDataManager instead.

Set the directory where disk cache files will be stored.

This method must be called before loading anything in this context, otherwise it will not have any effect.

Note that this method overrides the directory set in the WebsiteDataManager, but it doesn't change the value returned by websiteDataManagerGetDiskCacheDirectory since the WebsiteDataManager is immutable.

setFaviconDatabaseDirectory

webContextSetFaviconDatabaseDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Maybe Text

path: an absolute path to the icon database directory or Nothing to use the defaults

-> m ()

Set the directory path to store the favicons database.

Set the directory path to be used to store the favicons database for context on disk. Passing Nothing as path means using the default directory for the platform (see getUserCacheDir).

Calling this method also means enabling the favicons database for its use from the applications, so that's why it's expected to be called only once. Further calls for the same instance of WebContext won't cause any effect.

setNetworkProxySettings

webContextSetNetworkProxySettings

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> NetworkProxyMode

proxyMode: a NetworkProxyMode

-> Maybe NetworkProxySettings

proxySettings: a NetworkProxySettings, or Nothing

-> m ()

Deprecated: (Since version 2.32.)Use websiteDataManagerSetNetworkProxySettings instead.

Set the network proxy settings to be used by connections started in context.

By default NetworkProxyModeDefault is used, which means that the system settings will be used (proxyResolverGetDefault). If you want to override the system default settings, you can either use NetworkProxyModeNoProxy to make sure no proxies are used at all, or NetworkProxyModeCustom to provide your own proxy settings. When proxyMode is NetworkProxyModeCustom proxySettings must be a valid NetworkProxySettings; otherwise, proxySettings must be Nothing.

Since: 2.16

setPreferredLanguages

webContextSetPreferredLanguages

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Maybe [Text]

languages: a Nothing-terminated list of language identifiers

-> m ()

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.

setProcessModel

webContextSetProcessModel

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> ProcessModel

processModel: a ProcessModel

-> m ()

Specifies a process model for WebViews.

Specifies a process model for WebViews, which WebKit will use to determine how auxiliary processes are handled.

ProcessModelMultipleSecondaryProcesses will use one process per view most of the time, while still allowing for web views to share a process when needed (for example when different views interact with each other). Using this model, when a process hangs or crashes, only the WebViews using it stop working, while the rest of the WebViews in the application will still function normally.

ProcessModelSharedSecondaryProcess is deprecated since 2.26, using it has no effect for security reasons.

This method **must be called before any web process has been created**, as early as possible in your application. Calling it later will make your application crash.

Since: 2.4

setSandboxEnabled

webContextSetSandboxEnabled

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Bool

enabled: if True enable sandboxing

-> m ()

Set whether WebKit subprocesses will be sandboxed.

Set whether WebKit subprocesses will be sandboxed, limiting access to the system. This method **must be called before any web process has been created**, as early as possible in your application. Calling it later is a fatal error.

This is only implemented on Linux and is a no-op otherwise.

Since: 2.26

setSpellCheckingEnabled

webContextSetSpellCheckingEnabled

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Bool

enabled: Value to be set

-> m ()

Enable or disable the spell checking feature.

setSpellCheckingLanguages

webContextSetSpellCheckingLanguages

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> [Text]

languages: a Nothing-terminated list of spell checking languages

-> m ()

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.

setTlsErrorsPolicy

webContextSetTlsErrorsPolicy

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> TLSErrorsPolicy

policy: a TLSErrorsPolicy

-> m ()

Deprecated: (Since version 2.32.)Use websiteDataManagerSetTlsErrorsPolicy instead.

Set the TLS errors policy of context as policy.

setUseSystemAppearanceForScrollbars

webContextSetUseSystemAppearanceForScrollbars

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Bool

enabled: value to set

-> m ()

Set the WebContext:useSystemAppearanceForScrollbars property.

Since: 2.30

setWebExtensionsDirectory

webContextSetWebExtensionsDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Text

directory: the directory to add

-> m ()

Set the directory where WebKit will look for Web Extensions.

This method must be called before loading anything in this context, otherwise it will not have any effect. You can connect to WebContext::initializeWebExtensions to call this method before anything is loaded.

setWebExtensionsInitializationUserData

webContextSetWebExtensionsInitializationUserData

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> GVariant

userData: a GVariant

-> m ()

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

The data will be passed to the WebKitWebExtensionInitializeWithUserDataFunction. This method must be called before loading anything in this context, otherwise it will not have any effect. You can connect to WebContext::initializeWebExtensions to call this method before anything is loaded.

Since: 2.4

setWebProcessCountLimit

webContextSetWebProcessCountLimit

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> Word32

limit: the maximum number of web processes

-> m ()

Deprecated: (Since version 2.26)

Sets the maximum number of web processes.

Sets the maximum number of web processes that can be created at the same time for the context. The default value is 0 and means no limit.

This function is now deprecated and does nothing for security reasons.

Since: 2.10

Properties

localStorageDirectory

The directory where local storage data will be saved.

Since: 2.8

constructWebContextLocalStorageDirectory :: (IsWebContext o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “local-storage-directory” property. This is rarely needed directly, but it is used by new.

getWebContextLocalStorageDirectory :: (MonadIO m, IsWebContext o) => o -> m (Maybe Text)

Get the value of the “local-storage-directory” property. When overloading is enabled, this is equivalent to

get webContext #localStorageDirectory

memoryPressureSettings

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

Since: 2.34

constructWebContextMemoryPressureSettings :: (IsWebContext o, MonadIO m) => MemoryPressureSettings -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “memory-pressure-settings” property. This is rarely needed directly, but it is used by new.

processSwapOnCrossSiteNavigationEnabled

Whether swap Web processes on cross-site navigations is enabled.

When enabled, pages from each security origin will be handled by their own separate Web processes, which are started (and terminated) on demand as the user navigates across different domains. This is an important security measure which helps prevent websites stealing data from other visited pages.

Since: 2.28

constructWebContextProcessSwapOnCrossSiteNavigationEnabled :: (IsWebContext o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “process-swap-on-cross-site-navigation-enabled” property. This is rarely needed directly, but it is used by new.

getWebContextProcessSwapOnCrossSiteNavigationEnabled :: (MonadIO m, IsWebContext o) => o -> m Bool

Get the value of the “process-swap-on-cross-site-navigation-enabled” property. When overloading is enabled, this is equivalent to

get webContext #processSwapOnCrossSiteNavigationEnabled

timeZoneOverride

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.

Since: 2.38

constructWebContextTimeZoneOverride :: (IsWebContext o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “time-zone-override” property. This is rarely needed directly, but it is used by new.

getWebContextTimeZoneOverride :: (MonadIO m, IsWebContext o) => o -> m Text

Get the value of the “time-zone-override” property. When overloading is enabled, this is equivalent to

get webContext #timeZoneOverride

useSystemAppearanceForScrollbars

Whether to use system appearance for rendering scrollbars.

This is enabled by default for backwards compatibility, but it's only recommened to use when the application includes other widgets to ensure consistency, or when consistency with other applications is required too.

Since: 2.30

constructWebContextUseSystemAppearanceForScrollbars :: (IsWebContext o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “use-system-appearance-for-scrollbars” property. This is rarely needed directly, but it is used by new.

getWebContextUseSystemAppearanceForScrollbars :: (MonadIO m, IsWebContext o) => o -> m Bool

Get the value of the “use-system-appearance-for-scrollbars” property. When overloading is enabled, this is equivalent to

get webContext #useSystemAppearanceForScrollbars

setWebContextUseSystemAppearanceForScrollbars :: (MonadIO m, IsWebContext o) => o -> Bool -> m ()

Set the value of the “use-system-appearance-for-scrollbars” property. When overloading is enabled, this is equivalent to

set webContext [ #useSystemAppearanceForScrollbars := value ]

websiteDataManager

The WebsiteDataManager associated with this context.

Since: 2.10

constructWebContextWebsiteDataManager :: (IsWebContext o, MonadIO m, IsWebsiteDataManager a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “website-data-manager” property. This is rarely needed directly, but it is used by new.

getWebContextWebsiteDataManager :: (MonadIO m, IsWebContext o) => o -> m WebsiteDataManager

Get the value of the “website-data-manager” property. When overloading is enabled, this is equivalent to

get webContext #websiteDataManager

Signals

automationStarted

type WebContextAutomationStartedCallback

Arguments

 = AutomationSession

session: the AutomationSession associated with this event

-> IO ()

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 webContextSetAutomationAllowed for more details.

Since: 2.18

afterWebContextAutomationStarted :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextAutomationStartedCallback) -> m SignalHandlerId

Connect a signal handler for the automationStarted signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webContext #automationStarted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebContextAutomationStarted :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextAutomationStartedCallback) -> m SignalHandlerId

Connect a signal handler for the automationStarted signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webContext #automationStarted callback

downloadStarted

type WebContextDownloadStartedCallback

Arguments

 = Download

download: the Download associated with this event

-> IO ()

This signal is emitted when a new download request is made.

afterWebContextDownloadStarted :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextDownloadStartedCallback) -> m SignalHandlerId

Connect a signal handler for the downloadStarted signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webContext #downloadStarted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebContextDownloadStarted :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextDownloadStartedCallback) -> m SignalHandlerId

Connect a signal handler for the downloadStarted signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webContext #downloadStarted callback

initializeNotificationPermissions

type WebContextInitializeNotificationPermissionsCallback = IO ()

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 webContextInitializeNotificationPermissions. If no notification permissions have changed since the last time this signal was emitted, then there is no need to call webContextInitializeNotificationPermissions again.

Since: 2.16

afterWebContextInitializeNotificationPermissions :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextInitializeNotificationPermissionsCallback) -> m SignalHandlerId

Connect a signal handler for the initializeNotificationPermissions signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webContext #initializeNotificationPermissions callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebContextInitializeNotificationPermissions :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextInitializeNotificationPermissionsCallback) -> m SignalHandlerId

Connect a signal handler for the initializeNotificationPermissions signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webContext #initializeNotificationPermissions callback

initializeWebExtensions

type WebContextInitializeWebExtensionsCallback = IO ()

This signal is emitted when a new web process is about to be launched. It signals the most appropriate moment to use webContextSetWebExtensionsInitializationUserData and webContextSetWebExtensionsDirectory.

Since: 2.4

afterWebContextInitializeWebExtensions :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextInitializeWebExtensionsCallback) -> m SignalHandlerId

Connect a signal handler for the initializeWebExtensions signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webContext #initializeWebExtensions callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebContextInitializeWebExtensions :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextInitializeWebExtensionsCallback) -> m SignalHandlerId

Connect a signal handler for the initializeWebExtensions signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webContext #initializeWebExtensions callback

userMessageReceived

type WebContextUserMessageReceivedCallback

Arguments

 = UserMessage

message: the UserMessage received

-> IO Bool

Returns: True if the message was handled, or False otherwise.

This signal is emitted when a UserMessage is received from a WebKitWebExtension. You can reply to the message using userMessageSendReply.

You can handle the user message asynchronously by calling objectRef on message and returning True.

Since: 2.28

afterWebContextUserMessageReceived :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextUserMessageReceivedCallback) -> m SignalHandlerId

Connect a signal handler for the userMessageReceived signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webContext #userMessageReceived callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebContextUserMessageReceived :: (IsWebContext a, MonadIO m) => a -> ((?self :: a) => WebContextUserMessageReceivedCallback) -> m SignalHandlerId

Connect a signal handler for the userMessageReceived signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webContext #userMessageReceived callback