Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- Overloaded methods
- addPathToSandbox
- allowTlsCertificateForHost
- clearCache
- downloadUri
- getCacheModel
- getCookieManager
- getDefault
- getFaviconDatabase
- getFaviconDatabaseDirectory
- getGeolocationManager
- getPlugins
- getPluginsFinish
- getProcessModel
- getSandboxEnabled
- getSecurityManager
- getSpellCheckingEnabled
- getSpellCheckingLanguages
- getTlsErrorsPolicy
- getWebProcessCountLimit
- getWebsiteDataManager
- initializeNotificationPermissions
- isAutomationAllowed
- isEphemeral
- new
- newEphemeral
- newWithWebsiteDataManager
- prefetchDns
- registerUriScheme
- sendMessageToAllExtensions
- setAdditionalPluginsDirectory
- setAutomationAllowed
- setCacheModel
- setDiskCacheDirectory
- setFaviconDatabaseDirectory
- setNetworkProxySettings
- setPreferredLanguages
- setProcessModel
- setSandboxEnabled
- setSpellCheckingEnabled
- setSpellCheckingLanguages
- setTlsErrorsPolicy
- setWebExtensionsDirectory
- setWebExtensionsInitializationUserData
- setWebProcessCountLimit
- Properties
- Signals
No description available in the introspection data.
Synopsis
- newtype WebContext = WebContext (ManagedPtr WebContext)
- class (GObject o, IsDescendantOf WebContext o) => IsWebContext o
- toWebContext :: (MonadIO m, IsWebContext o) => o -> m WebContext
- webContextAddPathToSandbox :: (HasCallStack, MonadIO m, IsWebContext a) => a -> [Char] -> Bool -> m ()
- webContextAllowTlsCertificateForHost :: (HasCallStack, MonadIO m, IsWebContext a, IsTlsCertificate b) => a -> b -> Text -> m ()
- webContextClearCache :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m ()
- webContextDownloadUri :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Text -> m Download
- webContextGetCacheModel :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m CacheModel
- webContextGetCookieManager :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m CookieManager
- webContextGetDefault :: (HasCallStack, MonadIO m) => m WebContext
- webContextGetFaviconDatabase :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m FaviconDatabase
- webContextGetFaviconDatabaseDirectory :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m (Maybe Text)
- webContextGetGeolocationManager :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m GeolocationManager
- webContextGetPlugins :: (HasCallStack, MonadIO m, IsWebContext a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- webContextGetPluginsFinish :: (HasCallStack, MonadIO m, IsWebContext a, IsAsyncResult b) => a -> b -> m [Plugin]
- webContextGetProcessModel :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m ProcessModel
- webContextGetSandboxEnabled :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m Bool
- webContextGetSecurityManager :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m SecurityManager
- webContextGetSpellCheckingEnabled :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m Bool
- webContextGetSpellCheckingLanguages :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m (Maybe [Text])
- webContextGetTlsErrorsPolicy :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m TLSErrorsPolicy
- webContextGetWebProcessCountLimit :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m Word32
- webContextGetWebsiteDataManager :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m WebsiteDataManager
- webContextInitializeNotificationPermissions :: (HasCallStack, MonadIO m, IsWebContext a) => a -> [SecurityOrigin] -> [SecurityOrigin] -> m ()
- webContextIsAutomationAllowed :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m Bool
- webContextIsEphemeral :: (HasCallStack, MonadIO m, IsWebContext a) => a -> m Bool
- webContextNew :: (HasCallStack, MonadIO m) => m WebContext
- webContextNewEphemeral :: (HasCallStack, MonadIO m) => m WebContext
- webContextNewWithWebsiteDataManager :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m WebContext
- webContextPrefetchDns :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Text -> m ()
- webContextRegisterUriScheme :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Text -> URISchemeRequestCallback -> m ()
- webContextSendMessageToAllExtensions :: (HasCallStack, MonadIO m, IsWebContext a, IsUserMessage b) => a -> b -> m ()
- webContextSetAdditionalPluginsDirectory :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Text -> m ()
- webContextSetAutomationAllowed :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Bool -> m ()
- webContextSetCacheModel :: (HasCallStack, MonadIO m, IsWebContext a) => a -> CacheModel -> m ()
- webContextSetDiskCacheDirectory :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Text -> m ()
- webContextSetFaviconDatabaseDirectory :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Maybe Text -> m ()
- webContextSetNetworkProxySettings :: (HasCallStack, MonadIO m, IsWebContext a) => a -> NetworkProxyMode -> Maybe NetworkProxySettings -> m ()
- webContextSetPreferredLanguages :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Maybe [Text] -> m ()
- webContextSetProcessModel :: (HasCallStack, MonadIO m, IsWebContext a) => a -> ProcessModel -> m ()
- webContextSetSandboxEnabled :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Bool -> m ()
- webContextSetSpellCheckingEnabled :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Bool -> m ()
- webContextSetSpellCheckingLanguages :: (HasCallStack, MonadIO m, IsWebContext a) => a -> [Text] -> m ()
- webContextSetTlsErrorsPolicy :: (HasCallStack, MonadIO m, IsWebContext a) => a -> TLSErrorsPolicy -> m ()
- webContextSetWebExtensionsDirectory :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Text -> m ()
- webContextSetWebExtensionsInitializationUserData :: (HasCallStack, MonadIO m, IsWebContext a) => a -> GVariant -> m ()
- webContextSetWebProcessCountLimit :: (HasCallStack, MonadIO m, IsWebContext a) => a -> Word32 -> m ()
- constructWebContextLocalStorageDirectory :: (IsWebContext o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebContextLocalStorageDirectory :: (MonadIO m, IsWebContext o) => o -> m (Maybe Text)
- constructWebContextProcessSwapOnCrossSiteNavigationEnabled :: (IsWebContext o, MonadIO m) => Bool -> m (GValueConstruct o)
- getWebContextProcessSwapOnCrossSiteNavigationEnabled :: (MonadIO m, IsWebContext o) => o -> m Bool
- constructWebContextWebsiteDataManager :: (IsWebContext o, MonadIO m, IsWebsiteDataManager a) => a -> m (GValueConstruct o)
- getWebContextWebsiteDataManager :: (MonadIO m, IsWebContext o) => o -> m WebsiteDataManager
- type C_WebContextAutomationStartedCallback = Ptr () -> Ptr AutomationSession -> Ptr () -> IO ()
- type WebContextAutomationStartedCallback = AutomationSession -> IO ()
- afterWebContextAutomationStarted :: (IsWebContext a, MonadIO m) => a -> WebContextAutomationStartedCallback -> m SignalHandlerId
- genClosure_WebContextAutomationStarted :: MonadIO m => WebContextAutomationStartedCallback -> m (GClosure C_WebContextAutomationStartedCallback)
- mk_WebContextAutomationStartedCallback :: C_WebContextAutomationStartedCallback -> IO (FunPtr C_WebContextAutomationStartedCallback)
- noWebContextAutomationStartedCallback :: Maybe WebContextAutomationStartedCallback
- onWebContextAutomationStarted :: (IsWebContext a, MonadIO m) => a -> WebContextAutomationStartedCallback -> m SignalHandlerId
- wrap_WebContextAutomationStartedCallback :: WebContextAutomationStartedCallback -> C_WebContextAutomationStartedCallback
- type C_WebContextDownloadStartedCallback = Ptr () -> Ptr Download -> Ptr () -> IO ()
- type WebContextDownloadStartedCallback = Download -> IO ()
- afterWebContextDownloadStarted :: (IsWebContext a, MonadIO m) => a -> WebContextDownloadStartedCallback -> m SignalHandlerId
- genClosure_WebContextDownloadStarted :: MonadIO m => WebContextDownloadStartedCallback -> m (GClosure C_WebContextDownloadStartedCallback)
- mk_WebContextDownloadStartedCallback :: C_WebContextDownloadStartedCallback -> IO (FunPtr C_WebContextDownloadStartedCallback)
- noWebContextDownloadStartedCallback :: Maybe WebContextDownloadStartedCallback
- onWebContextDownloadStarted :: (IsWebContext a, MonadIO m) => a -> WebContextDownloadStartedCallback -> m SignalHandlerId
- wrap_WebContextDownloadStartedCallback :: WebContextDownloadStartedCallback -> C_WebContextDownloadStartedCallback
- type C_WebContextInitializeNotificationPermissionsCallback = Ptr () -> Ptr () -> IO ()
- type WebContextInitializeNotificationPermissionsCallback = IO ()
- afterWebContextInitializeNotificationPermissions :: (IsWebContext a, MonadIO m) => a -> WebContextInitializeNotificationPermissionsCallback -> m SignalHandlerId
- genClosure_WebContextInitializeNotificationPermissions :: MonadIO m => WebContextInitializeNotificationPermissionsCallback -> m (GClosure C_WebContextInitializeNotificationPermissionsCallback)
- mk_WebContextInitializeNotificationPermissionsCallback :: C_WebContextInitializeNotificationPermissionsCallback -> IO (FunPtr C_WebContextInitializeNotificationPermissionsCallback)
- noWebContextInitializeNotificationPermissionsCallback :: Maybe WebContextInitializeNotificationPermissionsCallback
- onWebContextInitializeNotificationPermissions :: (IsWebContext a, MonadIO m) => a -> WebContextInitializeNotificationPermissionsCallback -> m SignalHandlerId
- wrap_WebContextInitializeNotificationPermissionsCallback :: WebContextInitializeNotificationPermissionsCallback -> C_WebContextInitializeNotificationPermissionsCallback
- type C_WebContextInitializeWebExtensionsCallback = Ptr () -> Ptr () -> IO ()
- type WebContextInitializeWebExtensionsCallback = IO ()
- afterWebContextInitializeWebExtensions :: (IsWebContext a, MonadIO m) => a -> WebContextInitializeWebExtensionsCallback -> m SignalHandlerId
- genClosure_WebContextInitializeWebExtensions :: MonadIO m => WebContextInitializeWebExtensionsCallback -> m (GClosure C_WebContextInitializeWebExtensionsCallback)
- mk_WebContextInitializeWebExtensionsCallback :: C_WebContextInitializeWebExtensionsCallback -> IO (FunPtr C_WebContextInitializeWebExtensionsCallback)
- noWebContextInitializeWebExtensionsCallback :: Maybe WebContextInitializeWebExtensionsCallback
- onWebContextInitializeWebExtensions :: (IsWebContext a, MonadIO m) => a -> WebContextInitializeWebExtensionsCallback -> m SignalHandlerId
- wrap_WebContextInitializeWebExtensionsCallback :: WebContextInitializeWebExtensionsCallback -> C_WebContextInitializeWebExtensionsCallback
- type C_WebContextUserMessageReceivedCallback = Ptr () -> Ptr UserMessage -> Ptr () -> IO CInt
- type WebContextUserMessageReceivedCallback = UserMessage -> IO Bool
- afterWebContextUserMessageReceived :: (IsWebContext a, MonadIO m) => a -> WebContextUserMessageReceivedCallback -> m SignalHandlerId
- genClosure_WebContextUserMessageReceived :: MonadIO m => WebContextUserMessageReceivedCallback -> m (GClosure C_WebContextUserMessageReceivedCallback)
- mk_WebContextUserMessageReceivedCallback :: C_WebContextUserMessageReceivedCallback -> IO (FunPtr C_WebContextUserMessageReceivedCallback)
- noWebContextUserMessageReceivedCallback :: Maybe WebContextUserMessageReceivedCallback
- onWebContextUserMessageReceived :: (IsWebContext a, MonadIO m) => a -> WebContextUserMessageReceivedCallback -> m SignalHandlerId
- wrap_WebContextUserMessageReceivedCallback :: WebContextUserMessageReceivedCallback -> C_WebContextUserMessageReceivedCallback
Exported types
newtype WebContext Source #
Memory-managed wrapper type.
WebContext (ManagedPtr WebContext) |
Instances
Eq WebContext Source # | |
Defined in GI.WebKit2.Objects.WebContext (==) :: WebContext -> WebContext -> Bool (/=) :: WebContext -> WebContext -> Bool | |
GObject WebContext Source # | |
Defined in GI.WebKit2.Objects.WebContext | |
ManagedPtrNewtype WebContext Source # | |
Defined in GI.WebKit2.Objects.WebContext toManagedPtr :: WebContext -> ManagedPtr WebContext | |
TypedObject WebContext Source # | |
Defined in GI.WebKit2.Objects.WebContext glibType :: IO GType | |
IsGValue WebContext Source # | Convert |
Defined in GI.WebKit2.Objects.WebContext toGValue :: WebContext -> IO GValue fromGValue :: GValue -> IO WebContext | |
HasParentTypes WebContext Source # | |
Defined in GI.WebKit2.Objects.WebContext | |
type ParentTypes WebContext Source # | |
Defined in GI.WebKit2.Objects.WebContext type ParentTypes WebContext = '[Object] |
class (GObject o, IsDescendantOf WebContext o) => IsWebContext o Source #
Type class for types which can be safely cast to WebContext
, for instance with toWebContext
.
Instances
(GObject o, IsDescendantOf WebContext o) => IsWebContext o Source # | |
Defined in GI.WebKit2.Objects.WebContext |
toWebContext :: (MonadIO m, IsWebContext o) => o -> m WebContext Source #
Cast to WebContext
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
addPathToSandbox
webContextAddPathToSandbox Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> [Char] |
|
-> Bool |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a, IsTlsCertificate b) | |
=> a |
|
-> b |
|
-> Text |
|
-> m () |
Ignore further TLS errors on the host
for the certificate present in info
.
Since: 2.6
clearCache
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m () |
Clears all resources currently cached.
See also webContextSetCacheModel
.
downloadUri
webContextDownloadUri Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Text |
|
-> m Download | Returns: a new |
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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m CacheModel | Returns: the current |
Returns the current cache model. For more information about this
value check the documentation of the function
webContextSetCacheModel
.
getCookieManager
webContextGetCookieManager Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m CookieManager | Returns: the |
Get the CookieManager
of the context
's WebsiteDataManager
.
getDefault
:: (HasCallStack, MonadIO m) | |
=> m WebContext | Returns: a |
Gets the default web context
getFaviconDatabase
webContextGetFaviconDatabase Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m FaviconDatabase | Returns: the |
Get the FaviconDatabase
associated with context
.
To initialize the database you need to call
webContextSetFaviconDatabaseDirectory
.
getFaviconDatabaseDirectory
webContextGetFaviconDatabaseDirectory Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m (Maybe Text) | Returns: the path of the directory of the favicons
database associated with |
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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m GeolocationManager | Returns: the |
Get the GeolocationManager
of context
.
Since: 2.26
getPlugins
:: (HasCallStack, MonadIO m, IsWebContext a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> 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
webContextGetPluginsFinish Source #
:: (HasCallStack, MonadIO m, IsWebContext a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m [Plugin] | Returns: a |
Finish an asynchronous operation started with webkit_web_context_get_plugins.
getProcessModel
webContextGetProcessModel Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m ProcessModel | Returns: the current |
Returns the current process model. For more information about this value
see webContextSetProcessModel
.
Since: 2.4
getSandboxEnabled
webContextGetSandboxEnabled Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m Bool | Returns: |
Get whether sandboxing is currently enabled.
Since: 2.26
getSecurityManager
webContextGetSecurityManager Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m SecurityManager | Returns: the |
Get the SecurityManager
of context
.
getSpellCheckingEnabled
webContextGetSpellCheckingEnabled Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m Bool | Returns: |
Get whether spell checking feature is currently enabled.
getSpellCheckingLanguages
webContextGetSpellCheckingLanguages Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m (Maybe [Text]) | Returns: A |
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
webContextGetTlsErrorsPolicy Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m TLSErrorsPolicy | Returns: a |
Get the TLS errors policy of context
getWebProcessCountLimit
webContextGetWebProcessCountLimit Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m WebsiteDataManager | Returns: a |
Get the WebsiteDataManager
of context
.
Since: 2.10
initializeNotificationPermissions
webContextInitializeNotificationPermissions Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> [SecurityOrigin] |
|
-> [SecurityOrigin] |
|
-> 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 initializeNotificationPermissions so as to ensure that new web processes receive the most recent set of permissions.
Since: 2.16
isAutomationAllowed
webContextIsAutomationAllowed Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m Bool | Returns: |
Get whether automation is allowed in context
.
See also webContextSetAutomationAllowed
.
Since: 2.18
isEphemeral
webContextIsEphemeral Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> m Bool | Returns: |
Get whether a WebContext
is ephemeral.
Since: 2.16
new
:: (HasCallStack, MonadIO m) | |
=> m WebContext | Returns: a newly created |
Create a new WebContext
Since: 2.8
newEphemeral
webContextNewEphemeral Source #
:: (HasCallStack, MonadIO m) | |
=> m WebContext | Returns: a new ephemeral |
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 Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m WebContext | Returns: a newly created |
Create a new WebContext
with a WebsiteDataManager
.
Since: 2.10
prefetchDns
webContextPrefetchDns Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Text |
|
-> 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
webContextRegisterUriScheme Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Text |
|
-> 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 ("<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;
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>
sendMessageToAllExtensions
webContextSendMessageToAllExtensions Source #
:: (HasCallStack, MonadIO m, IsWebContext a, IsUserMessage b) | |
=> a |
|
-> b |
|
-> m () |
Send message
to all WebKitWebExtension
s associated to context
.
If message
is floating, it's consumed.
Since: 2.28
setAdditionalPluginsDirectory
webContextSetAdditionalPluginsDirectory Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Text |
|
-> m () |
Set an additional directory where WebKit will look for plugins.
setAutomationAllowed
webContextSetAutomationAllowed Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Bool |
|
-> 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 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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> 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
webContextSetDiskCacheDirectory Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Text |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Maybe Text |
|
-> 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 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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> NetworkProxyMode |
|
-> Maybe NetworkProxySettings |
|
-> 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
webContextSetPreferredLanguages Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Maybe [Text] |
|
-> 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
webContextSetProcessModel Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> ProcessModel |
|
-> m () |
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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Bool |
|
-> m () |
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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Bool |
|
-> m () |
Enable or disable the spell checking feature.
setSpellCheckingLanguages
webContextSetSpellCheckingLanguages Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> [Text] |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> TLSErrorsPolicy |
|
-> m () |
Set the TLS errors policy of context
as policy
setWebExtensionsDirectory
webContextSetWebExtensionsDirectory Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Text |
|
-> 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 initializeWebExtensions to call this method before anything is loaded.
setWebExtensionsInitializationUserData
webContextSetWebExtensionsInitializationUserData Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> 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
initializeWebExtensions to call this method
before anything is loaded.
Since: 2.4
setWebProcessCountLimit
webContextSetWebProcessCountLimit Source #
:: (HasCallStack, MonadIO m, IsWebContext a) | |
=> a |
|
-> Word32 |
|
-> m () |
Deprecated: (Since version 2.26)
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) Source #
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) Source #
Get the value of the “local-storage-directory
” property.
When overloading is enabled, this is equivalent to
get
webContext #localStorageDirectory
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) Source #
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 Source #
Get the value of the “process-swap-on-cross-site-navigation-enabled
” property.
When overloading is enabled, this is equivalent to
get
webContext #processSwapOnCrossSiteNavigationEnabled
websiteDataManager
The WebsiteDataManager
associated with this context.
Since: 2.10
constructWebContextWebsiteDataManager :: (IsWebContext o, MonadIO m, IsWebsiteDataManager a) => a -> m (GValueConstruct o) Source #
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 Source #
Get the value of the “website-data-manager
” property.
When overloading is enabled, this is equivalent to
get
webContext #websiteDataManager
Signals
automationStarted
type C_WebContextAutomationStartedCallback = Ptr () -> Ptr AutomationSession -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type WebContextAutomationStartedCallback Source #
= AutomationSession |
|
-> 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 -> WebContextAutomationStartedCallback -> m SignalHandlerId Source #
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
genClosure_WebContextAutomationStarted :: MonadIO m => WebContextAutomationStartedCallback -> m (GClosure C_WebContextAutomationStartedCallback) Source #
Wrap the callback into a GClosure
.
mk_WebContextAutomationStartedCallback :: C_WebContextAutomationStartedCallback -> IO (FunPtr C_WebContextAutomationStartedCallback) Source #
Generate a function pointer callable from C code, from a C_WebContextAutomationStartedCallback
.
noWebContextAutomationStartedCallback :: Maybe WebContextAutomationStartedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
WebContextAutomationStartedCallback
onWebContextAutomationStarted :: (IsWebContext a, MonadIO m) => a -> WebContextAutomationStartedCallback -> m SignalHandlerId Source #
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
wrap_WebContextAutomationStartedCallback :: WebContextAutomationStartedCallback -> C_WebContextAutomationStartedCallback Source #
downloadStarted
type C_WebContextDownloadStartedCallback = Ptr () -> Ptr Download -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type WebContextDownloadStartedCallback Source #
This signal is emitted when a new download request is made.
afterWebContextDownloadStarted :: (IsWebContext a, MonadIO m) => a -> WebContextDownloadStartedCallback -> m SignalHandlerId Source #
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
genClosure_WebContextDownloadStarted :: MonadIO m => WebContextDownloadStartedCallback -> m (GClosure C_WebContextDownloadStartedCallback) Source #
Wrap the callback into a GClosure
.
mk_WebContextDownloadStartedCallback :: C_WebContextDownloadStartedCallback -> IO (FunPtr C_WebContextDownloadStartedCallback) Source #
Generate a function pointer callable from C code, from a C_WebContextDownloadStartedCallback
.
noWebContextDownloadStartedCallback :: Maybe WebContextDownloadStartedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
WebContextDownloadStartedCallback
onWebContextDownloadStarted :: (IsWebContext a, MonadIO m) => a -> WebContextDownloadStartedCallback -> m SignalHandlerId Source #
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
wrap_WebContextDownloadStartedCallback :: WebContextDownloadStartedCallback -> C_WebContextDownloadStartedCallback Source #
initializeNotificationPermissions
type C_WebContextInitializeNotificationPermissionsCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type WebContextInitializeNotificationPermissionsCallback = IO () Source #
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 -> WebContextInitializeNotificationPermissionsCallback -> m SignalHandlerId Source #
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
genClosure_WebContextInitializeNotificationPermissions :: MonadIO m => WebContextInitializeNotificationPermissionsCallback -> m (GClosure C_WebContextInitializeNotificationPermissionsCallback) Source #
Wrap the callback into a GClosure
.
mk_WebContextInitializeNotificationPermissionsCallback :: C_WebContextInitializeNotificationPermissionsCallback -> IO (FunPtr C_WebContextInitializeNotificationPermissionsCallback) Source #
Generate a function pointer callable from C code, from a C_WebContextInitializeNotificationPermissionsCallback
.
noWebContextInitializeNotificationPermissionsCallback :: Maybe WebContextInitializeNotificationPermissionsCallback Source #
A convenience synonym for
.Nothing
:: Maybe
WebContextInitializeNotificationPermissionsCallback
onWebContextInitializeNotificationPermissions :: (IsWebContext a, MonadIO m) => a -> WebContextInitializeNotificationPermissionsCallback -> m SignalHandlerId Source #
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
wrap_WebContextInitializeNotificationPermissionsCallback :: WebContextInitializeNotificationPermissionsCallback -> C_WebContextInitializeNotificationPermissionsCallback Source #
initializeWebExtensions
type C_WebContextInitializeWebExtensionsCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type WebContextInitializeWebExtensionsCallback = IO () Source #
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 -> WebContextInitializeWebExtensionsCallback -> m SignalHandlerId Source #
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
genClosure_WebContextInitializeWebExtensions :: MonadIO m => WebContextInitializeWebExtensionsCallback -> m (GClosure C_WebContextInitializeWebExtensionsCallback) Source #
Wrap the callback into a GClosure
.
mk_WebContextInitializeWebExtensionsCallback :: C_WebContextInitializeWebExtensionsCallback -> IO (FunPtr C_WebContextInitializeWebExtensionsCallback) Source #
Generate a function pointer callable from C code, from a C_WebContextInitializeWebExtensionsCallback
.
noWebContextInitializeWebExtensionsCallback :: Maybe WebContextInitializeWebExtensionsCallback Source #
A convenience synonym for
.Nothing
:: Maybe
WebContextInitializeWebExtensionsCallback
onWebContextInitializeWebExtensions :: (IsWebContext a, MonadIO m) => a -> WebContextInitializeWebExtensionsCallback -> m SignalHandlerId Source #
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
wrap_WebContextInitializeWebExtensionsCallback :: WebContextInitializeWebExtensionsCallback -> C_WebContextInitializeWebExtensionsCallback Source #
userMessageReceived
type C_WebContextUserMessageReceivedCallback = Ptr () -> Ptr UserMessage -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type WebContextUserMessageReceivedCallback Source #
= UserMessage |
|
-> IO Bool | Returns: |
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 -> WebContextUserMessageReceivedCallback -> m SignalHandlerId Source #
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
genClosure_WebContextUserMessageReceived :: MonadIO m => WebContextUserMessageReceivedCallback -> m (GClosure C_WebContextUserMessageReceivedCallback) Source #
Wrap the callback into a GClosure
.
mk_WebContextUserMessageReceivedCallback :: C_WebContextUserMessageReceivedCallback -> IO (FunPtr C_WebContextUserMessageReceivedCallback) Source #
Generate a function pointer callable from C code, from a C_WebContextUserMessageReceivedCallback
.
noWebContextUserMessageReceivedCallback :: Maybe WebContextUserMessageReceivedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
WebContextUserMessageReceivedCallback
onWebContextUserMessageReceived :: (IsWebContext a, MonadIO m) => a -> WebContextUserMessageReceivedCallback -> m SignalHandlerId Source #
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