GI.WebKit2.Objects.WebContext

Exported types

newtype WebContext

Constructors

WebContext (ManagedPtr WebContext)

Instances

GObject WebContext

Methods

gobjectType :: WebContext -> IO GType

IsObject WebContext

IsWebContext WebContext

((~) * info (ResolveWebContextMethod t WebContext), MethodInfo * info WebContext p) => IsLabel t (WebContext -> p)

Methods

fromLabel :: Proxy# Symbol t -> WebContext -> p

((~) * info (ResolveWebContextMethod t WebContext), MethodInfo * info WebContext p) => IsLabelProxy t (WebContext -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> WebContext -> p

HasAttributeList * WebContext

type AttributeList WebContext

type AttributeList WebContext

type SignalList WebContext

type SignalList WebContext

class GObject o => IsWebContext o

Instances

(GObject a, UnknownAncestorError Constraint WebContext a) => IsWebContext a

IsWebContext WebContext

toWebContext :: IsWebContext o => o -> IO WebContext

noWebContext :: Maybe WebContext

Methods

allowTlsCertificateForHost

data WebContextAllowTlsCertificateForHostMethodInfo

Instances

((~) * signature (b -> Text -> m ()), MonadIO m, IsWebContext a, IsTlsCertificate b) => MethodInfo * WebContextAllowTlsCertificateForHostMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextAllowTlsCertificateForHostMethodInfo a -> signature -> s

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

data WebContextClearCacheMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextClearCacheMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextClearCacheMethodInfo a -> signature -> s

webContextClearCache

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m ()

Clears all resources currently cached. See also webContextSetCacheModel.

downloadUri

data WebContextDownloadUriMethodInfo

Instances

((~) * signature (Text -> m Download), MonadIO m, IsWebContext a) => MethodInfo * WebContextDownloadUriMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextDownloadUriMethodInfo a -> signature -> s

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

data WebContextGetCacheModelMethodInfo

Instances

((~) * signature (m CacheModel), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetCacheModelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetCacheModelMethodInfo a -> signature -> s

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

data WebContextGetCookieManagerMethodInfo

Instances

((~) * signature (m CookieManager), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetCookieManagerMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetCookieManagerMethodInfo a -> signature -> s

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

data WebContextGetFaviconDatabaseMethodInfo

Instances

((~) * signature (m FaviconDatabase), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetFaviconDatabaseMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetFaviconDatabaseMethodInfo a -> signature -> s

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

data WebContextGetFaviconDatabaseDirectoryMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetFaviconDatabaseDirectoryMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetFaviconDatabaseDirectoryMethodInfo a -> signature -> s

webContextGetFaviconDatabaseDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m Text

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

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.

getPlugins

data WebContextGetPluginsMethodInfo

Instances

((~) * signature (Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsWebContext a, IsCancellable b) => MethodInfo * WebContextGetPluginsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetPluginsMethodInfo a -> signature -> s

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 ()

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

data WebContextGetPluginsFinishMethodInfo

Instances

((~) * signature (b -> m [Plugin]), MonadIO m, IsWebContext a, IsAsyncResult b) => MethodInfo * WebContextGetPluginsFinishMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetPluginsFinishMethodInfo a -> signature -> s

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 Plugin<!-- -->s with objectUnref when you're done with them. (Can throw GError)

Finish an asynchronous operation started with webkit_web_context_get_plugins.

getProcessModel

data WebContextGetProcessModelMethodInfo

Instances

((~) * signature (m ProcessModel), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetProcessModelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetProcessModelMethodInfo a -> signature -> s

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

getSecurityManager

data WebContextGetSecurityManagerMethodInfo

Instances

((~) * signature (m SecurityManager), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetSecurityManagerMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetSecurityManagerMethodInfo a -> signature -> s

webContextGetSecurityManager

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m SecurityManager

Returns: the SecurityManager of context.

Get the SecurityManager of context.

getSpellCheckingEnabled

data WebContextGetSpellCheckingEnabledMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetSpellCheckingEnabledMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetSpellCheckingEnabledMethodInfo a -> signature -> s

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

data WebContextGetSpellCheckingLanguagesMethodInfo

Instances

((~) * signature (m [Text]), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetSpellCheckingLanguagesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetSpellCheckingLanguagesMethodInfo a -> signature -> s

webContextGetSpellCheckingLanguages

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m [Text]

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

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.

getTlsErrorsPolicy

data WebContextGetTlsErrorsPolicyMethodInfo

Instances

((~) * signature (m TLSErrorsPolicy), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetTlsErrorsPolicyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetTlsErrorsPolicyMethodInfo a -> signature -> s

webContextGetTlsErrorsPolicy

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> m TLSErrorsPolicy

Returns: a TLSErrorsPolicy

Get the TLS errors policy of context

getWebProcessCountLimit

data WebContextGetWebProcessCountLimitMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetWebProcessCountLimitMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetWebProcessCountLimitMethodInfo a -> signature -> s

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.

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

Since: 2.10

getWebsiteDataManager

data WebContextGetWebsiteDataManagerMethodInfo

Instances

((~) * signature (m WebsiteDataManager), MonadIO m, IsWebContext a) => MethodInfo * WebContextGetWebsiteDataManagerMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextGetWebsiteDataManagerMethodInfo a -> signature -> s

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

data WebContextInitializeNotificationPermissionsMethodInfo

Instances

((~) * signature ([SecurityOrigin] -> [SecurityOrigin] -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextInitializeNotificationPermissionsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextInitializeNotificationPermissionsMethodInfo a -> signature -> s

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::initialize-notification-permissions so as to ensure that new web processes receive the most recent set of permissions.

Since: 2.16

isEphemeral

data WebContextIsEphemeralMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsWebContext a) => MethodInfo * WebContextIsEphemeralMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextIsEphemeralMethodInfo a -> signature -> s

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 WebView<!-- -->s 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

data WebContextPrefetchDnsMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextPrefetchDnsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextPrefetchDnsMethodInfo a -> signature -> s

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, so that if a URI of hostname is requested the load will be performed more quickly.

registerUriScheme

data WebContextRegisterUriSchemeMethodInfo

Instances

((~) * signature (Text -> URISchemeRequestCallback -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextRegisterUriSchemeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextRegisterUriSchemeMethodInfo a -> signature -> s

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

<informalexample><programlisting> static void about_uri_scheme_request_cb (WebKitURISchemeRequest *request, gpointer user_data) { GInputStream *stream; gsize stream_length; const gchar *path;

path = webkit_uri_scheme_request_get_path (request); if (!g_strcmp0 (path, "plugins")) { /<!-- -->* Create a GInputStream with the contents of plugins about page, and set its length to stream_length *<!-- -->/ } else 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;

contents = g_strdup_printf ("&lt;html&gt;&lt;body&gt;&lt;p&gt;Example about page&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;"); stream_length = strlen (contents); stream = g_memory_input_stream_new_from_data (contents, stream_length, g_free); } else { GError *error;

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); } </programlisting></informalexample>

setAdditionalPluginsDirectory

data WebContextSetAdditionalPluginsDirectoryMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetAdditionalPluginsDirectoryMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetAdditionalPluginsDirectoryMethodInfo a -> signature -> s

webContextSetAdditionalPluginsDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> Text

directory: the directory to add

-> m ()

Set an additional directory where WebKit will look for plugins.

setCacheModel

data WebContextSetCacheModelMethodInfo

Instances

((~) * signature (CacheModel -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetCacheModelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetCacheModelMethodInfo a -> signature -> s

webContextSetCacheModel

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> CacheModel

cacheModel: a CacheModel

-> m ()

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

data WebContextSetDiskCacheDirectoryMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetDiskCacheDirectoryMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetDiskCacheDirectoryMethodInfo a -> signature -> s

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

data WebContextSetFaviconDatabaseDirectoryMethodInfo

Instances

((~) * signature (Maybe Text -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetFaviconDatabaseDirectoryMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetFaviconDatabaseDirectoryMethodInfo a -> signature -> s

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 be used to store the favicons database for context on disk. Passing Nothing as path means using the default directory for the platform (see getUserDataDir).

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

data WebContextSetNetworkProxySettingsMethodInfo

Instances

((~) * signature (NetworkProxyMode -> Maybe NetworkProxySettings -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetNetworkProxySettingsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetNetworkProxySettingsMethodInfo a -> signature -> s

webContextSetNetworkProxySettings

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> NetworkProxyMode

proxyMode: a NetworkProxyMode

-> Maybe NetworkProxySettings

proxySettings: a NetworkProxySettings, or Nothing

-> m ()

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

data WebContextSetPreferredLanguagesMethodInfo

Instances

((~) * signature (Maybe [Text] -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetPreferredLanguagesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetPreferredLanguagesMethodInfo a -> signature -> s

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, sorted from most desirable to least desirable. The list will be used to build the "Accept-Language" header that will be included in the network requests started by the WebContext.

setProcessModel

data WebContextSetProcessModelMethodInfo

Instances

((~) * signature (ProcessModel -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetProcessModelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetProcessModelMethodInfo a -> signature -> s

webContextSetProcessModel

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> ProcessModel

processModel: a ProcessModel

-> m ()

Specifies a process model for WebViews, which WebKit will use to determine how auxiliary processes are handled. The default setting (ProcessModelSharedSecondaryProcess) is suitable for most applications which embed a small amount of WebViews, or are used to display documents which are considered safe — like local files.

Applications which may potentially use a large amount of WebViews —for example a multi-tabbed web browser— may want to use ProcessModelMultipleSecondaryProcesses, which 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.

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

setSpellCheckingEnabled

data WebContextSetSpellCheckingEnabledMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetSpellCheckingEnabledMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetSpellCheckingEnabledMethodInfo a -> signature -> s

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

data WebContextSetSpellCheckingLanguagesMethodInfo

Instances

((~) * signature ([Text] -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetSpellCheckingLanguagesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetSpellCheckingLanguagesMethodInfo a -> signature -> s

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

data WebContextSetTlsErrorsPolicyMethodInfo

Instances

((~) * signature (TLSErrorsPolicy -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetTlsErrorsPolicyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetTlsErrorsPolicyMethodInfo a -> signature -> s

webContextSetTlsErrorsPolicy

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: a WebContext

-> TLSErrorsPolicy

policy: a TLSErrorsPolicy

-> m ()

Set the TLS errors policy of context as policy

setWebExtensionsDirectory

data WebContextSetWebExtensionsDirectoryMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetWebExtensionsDirectoryMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetWebExtensionsDirectoryMethodInfo a -> signature -> s

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::initialize-web-extensions to call this method before anything is loaded.

setWebExtensionsInitializationUserData

data WebContextSetWebExtensionsInitializationUserDataMethodInfo

Instances

((~) * signature (GVariant -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetWebExtensionsInitializationUserDataMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetWebExtensionsInitializationUserDataMethodInfo a -> signature -> s

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::initialize-web-extensions to call this method before anything is loaded.

Since: 2.4

setWebProcessCountLimit

data WebContextSetWebProcessCountLimitMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsWebContext a) => MethodInfo * WebContextSetWebProcessCountLimitMethodInfo a signature

Methods

overloadedMethod :: MethodProxy WebContextSetWebProcessCountLimitMethodInfo a -> signature -> s

webContextSetWebProcessCountLimit

Arguments

:: (HasCallStack, MonadIO m, IsWebContext a)

=> a

context: the WebContext

-> Word32

limit: the maximum number of web processes

-> m ()

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

Properties

localStorageDirectory

data WebContextLocalStorageDirectoryPropertyInfo

Instances

AttrInfo WebContextLocalStorageDirectoryPropertyInfo

Associated Types

type AttrAllowedOps WebContextLocalStorageDirectoryPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint WebContextLocalStorageDirectoryPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint WebContextLocalStorageDirectoryPropertyInfo :: * -> Constraint

type AttrGetType WebContextLocalStorageDirectoryPropertyInfo :: *

type AttrLabel WebContextLocalStorageDirectoryPropertyInfo :: Symbol

type AttrOrigin WebContextLocalStorageDirectoryPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint WebContextLocalStorageDirectoryPropertyInfo o => Proxy * WebContextLocalStorageDirectoryPropertyInfo -> o -> IO (AttrGetType WebContextLocalStorageDirectoryPropertyInfo)

attrSet :: (AttrBaseTypeConstraint WebContextLocalStorageDirectoryPropertyInfo o, AttrSetTypeConstraint WebContextLocalStorageDirectoryPropertyInfo b) => Proxy * WebContextLocalStorageDirectoryPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint WebContextLocalStorageDirectoryPropertyInfo o => Proxy * WebContextLocalStorageDirectoryPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint WebContextLocalStorageDirectoryPropertyInfo o, AttrSetTypeConstraint WebContextLocalStorageDirectoryPropertyInfo b) => Proxy * WebContextLocalStorageDirectoryPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin WebContextLocalStorageDirectoryPropertyInfo

type AttrOrigin WebContextLocalStorageDirectoryPropertyInfo = WebContext

type AttrLabel WebContextLocalStorageDirectoryPropertyInfo

type AttrLabel WebContextLocalStorageDirectoryPropertyInfo = "local-storage-directory"

type AttrGetType WebContextLocalStorageDirectoryPropertyInfo

type AttrGetType WebContextLocalStorageDirectoryPropertyInfo = Maybe Text

type AttrBaseTypeConstraint WebContextLocalStorageDirectoryPropertyInfo

type AttrBaseTypeConstraint WebContextLocalStorageDirectoryPropertyInfo = IsWebContext

type AttrSetTypeConstraint WebContextLocalStorageDirectoryPropertyInfo

type AttrSetTypeConstraint WebContextLocalStorageDirectoryPropertyInfo = * ~ Text

type AttrAllowedOps WebContextLocalStorageDirectoryPropertyInfo

type AttrAllowedOps WebContextLocalStorageDirectoryPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructWebContextLocalStorageDirectory :: IsWebContext o => Text -> IO (GValueConstruct o)

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

webContextLocalStorageDirectory :: AttrLabelProxy "localStorageDirectory"

websiteDataManager

data WebContextWebsiteDataManagerPropertyInfo

Instances

AttrInfo WebContextWebsiteDataManagerPropertyInfo

Associated Types

type AttrAllowedOps WebContextWebsiteDataManagerPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint WebContextWebsiteDataManagerPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint WebContextWebsiteDataManagerPropertyInfo :: * -> Constraint

type AttrGetType WebContextWebsiteDataManagerPropertyInfo :: *

type AttrLabel WebContextWebsiteDataManagerPropertyInfo :: Symbol

type AttrOrigin WebContextWebsiteDataManagerPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint WebContextWebsiteDataManagerPropertyInfo o => Proxy * WebContextWebsiteDataManagerPropertyInfo -> o -> IO (AttrGetType WebContextWebsiteDataManagerPropertyInfo)

attrSet :: (AttrBaseTypeConstraint WebContextWebsiteDataManagerPropertyInfo o, AttrSetTypeConstraint WebContextWebsiteDataManagerPropertyInfo b) => Proxy * WebContextWebsiteDataManagerPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint WebContextWebsiteDataManagerPropertyInfo o => Proxy * WebContextWebsiteDataManagerPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint WebContextWebsiteDataManagerPropertyInfo o, AttrSetTypeConstraint WebContextWebsiteDataManagerPropertyInfo b) => Proxy * WebContextWebsiteDataManagerPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin WebContextWebsiteDataManagerPropertyInfo

type AttrOrigin WebContextWebsiteDataManagerPropertyInfo = WebContext

type AttrLabel WebContextWebsiteDataManagerPropertyInfo

type AttrLabel WebContextWebsiteDataManagerPropertyInfo = "website-data-manager"

type AttrGetType WebContextWebsiteDataManagerPropertyInfo

type AttrGetType WebContextWebsiteDataManagerPropertyInfo = WebsiteDataManager

type AttrBaseTypeConstraint WebContextWebsiteDataManagerPropertyInfo

type AttrBaseTypeConstraint WebContextWebsiteDataManagerPropertyInfo = IsWebContext

type AttrSetTypeConstraint WebContextWebsiteDataManagerPropertyInfo

type AttrSetTypeConstraint WebContextWebsiteDataManagerPropertyInfo = IsWebsiteDataManager

type AttrAllowedOps WebContextWebsiteDataManagerPropertyInfo

type AttrAllowedOps WebContextWebsiteDataManagerPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

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

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

webContextWebsiteDataManager :: AttrLabelProxy "websiteDataManager"

Signals

downloadStarted

type C_WebContextDownloadStartedCallback = Ptr () -> Ptr Download -> Ptr () -> IO ()

type WebContextDownloadStartedCallback = Download -> IO ()

data WebContextDownloadStartedSignalInfo

Instances

SignalInfo WebContextDownloadStartedSignalInfo

Associated Types

type HaskellCallbackType WebContextDownloadStartedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o WebContextDownloadStartedSignalInfo -> o -> HaskellCallbackType WebContextDownloadStartedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType WebContextDownloadStartedSignalInfo

type HaskellCallbackType WebContextDownloadStartedSignalInfo = WebContextDownloadStartedCallback

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

genClosure_WebContextDownloadStarted :: WebContextDownloadStartedCallback -> IO Closure

mk_WebContextDownloadStartedCallback :: C_WebContextDownloadStartedCallback -> IO (FunPtr C_WebContextDownloadStartedCallback)

noWebContextDownloadStartedCallback :: Maybe WebContextDownloadStartedCallback

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

wrap_WebContextDownloadStartedCallback :: WebContextDownloadStartedCallback -> Ptr () -> Ptr Download -> Ptr () -> IO ()

initializeNotificationPermissions

type C_WebContextInitializeNotificationPermissionsCallback = Ptr () -> Ptr () -> IO ()

type WebContextInitializeNotificationPermissionsCallback = IO ()

data WebContextInitializeNotificationPermissionsSignalInfo

Instances

SignalInfo WebContextInitializeNotificationPermissionsSignalInfo

Associated Types

type HaskellCallbackType WebContextInitializeNotificationPermissionsSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o WebContextInitializeNotificationPermissionsSignalInfo -> o -> HaskellCallbackType WebContextInitializeNotificationPermissionsSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType WebContextInitializeNotificationPermissionsSignalInfo

type HaskellCallbackType WebContextInitializeNotificationPermissionsSignalInfo = WebContextInitializeNotificationPermissionsCallback

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

genClosure_WebContextInitializeNotificationPermissions :: WebContextInitializeNotificationPermissionsCallback -> IO Closure

mk_WebContextInitializeNotificationPermissionsCallback :: C_WebContextInitializeNotificationPermissionsCallback -> IO (FunPtr C_WebContextInitializeNotificationPermissionsCallback)

noWebContextInitializeNotificationPermissionsCallback :: Maybe WebContextInitializeNotificationPermissionsCallback

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

wrap_WebContextInitializeNotificationPermissionsCallback :: WebContextInitializeNotificationPermissionsCallback -> Ptr () -> Ptr () -> IO ()

initializeWebExtensions

type C_WebContextInitializeWebExtensionsCallback = Ptr () -> Ptr () -> IO ()

type WebContextInitializeWebExtensionsCallback = IO ()

data WebContextInitializeWebExtensionsSignalInfo

Instances

SignalInfo WebContextInitializeWebExtensionsSignalInfo

Associated Types

type HaskellCallbackType WebContextInitializeWebExtensionsSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o WebContextInitializeWebExtensionsSignalInfo -> o -> HaskellCallbackType WebContextInitializeWebExtensionsSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType WebContextInitializeWebExtensionsSignalInfo

type HaskellCallbackType WebContextInitializeWebExtensionsSignalInfo = WebContextInitializeWebExtensionsCallback

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

genClosure_WebContextInitializeWebExtensions :: WebContextInitializeWebExtensionsCallback -> IO Closure

mk_WebContextInitializeWebExtensionsCallback :: C_WebContextInitializeWebExtensionsCallback -> IO (FunPtr C_WebContextInitializeWebExtensionsCallback)

noWebContextInitializeWebExtensionsCallback :: Maybe WebContextInitializeWebExtensionsCallback

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

wrap_WebContextInitializeWebExtensionsCallback :: WebContextInitializeWebExtensionsCallback -> Ptr () -> Ptr () -> IO ()