WebContext

Manages aspects common to all #WebKitWebViews

The #WebKitWebContext manages all aspects common to all #WebKitWebViews.

You can define the #WebKitCacheModel with webkit.web_context.WebContext.setCacheModel, depending on the needs of your application. You can access the #WebKitSecurityManager to specify the behaviour of your application regarding security using webkit.web_context.WebContext.getSecurityManager.

It is also possible to change your preferred language or enable spell checking, using webkit.web_context.WebContext.setPreferredLanguages, webkit.web_context.WebContext.setSpellCheckingLanguages and webkit.web_context.WebContext.setSpellCheckingEnabled.

You can use webkit.web_context.WebContext.registerUriScheme 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 #WebKitWebView::load-failed-with-tls-errors. Alternatively, you can use webkit_web_context_set_tls_errors_policy() to set the policy webkit.types.TLSErrorsPolicy.Ignore; however, this is not appropriate for Internet applications.

class WebContext : ObjectG {

this(void* ptr, Flag!"Take" take);

static GType getGType();

GType gType [@property getter];

WebContext self();

this();

static webkit.web_context.WebContext getDefault();

void addPathToSandbox(string path, bool readOnly);

webkit.types.CacheModel getCacheModel();

webkit.geolocation_manager.GeolocationManager getGeolocationManager();

webkit.network_session.NetworkSession getNetworkSessionForAutomation();

webkit.security_manager.SecurityManager getSecurityManager();

bool getSpellCheckingEnabled();

string[] getSpellCheckingLanguages();

string getTimeZoneOverride();

void initializeNotificationPermissions(webkit.security_origin.SecurityOrigin[] allowedOrigins, webkit.security_origin.SecurityOrigin[] disallowedOrigins);

bool isAutomationAllowed();

void registerUriScheme(string scheme, webkit.types.URISchemeRequestCallback callback);

void sendMessageToAllExtensions(webkit.user_message.UserMessage message);

void setAutomationAllowed(bool allowed);

void setCacheModel(webkit.types.CacheModel cacheModel);

void setPreferredLanguages(string[] languages);

void setSpellCheckingEnabled(bool enabled);

void setSpellCheckingLanguages(string[] languages);

void setWebProcessExtensionsDirectory(string directory);

void setWebProcessExtensionsInitializationUserData(glib.variant.VariantG userData);

ulong connectAutomationStarted(T callback, Flag!"After" after);

ulong connectInitializeNotificationPermissions(T callback, Flag!"After" after);

ulong connectInitializeWebProcessExtensions(T callback, Flag!"After" after);

ulong connectUserMessageReceived(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Create a new #WebKitWebContext.

Members

Functions

addPathToSandbox void addPathToSandbox(string path, bool readOnly): Adds a path to be mounted in the sandbox.
connectAutomationStarted ulong connectAutomationStarted(T callback, Flag!"After" after): Connect to AutomationStarted signal.
connectInitializeNotificationPermissions ulong connectInitializeNotificationPermissions(T callback, Flag!"After" after): Connect to InitializeNotificationPermissions signal.
connectInitializeWebProcessExtensions ulong connectInitializeWebProcessExtensions(T callback, Flag!"After" after): Connect to InitializeWebProcessExtensions signal.
connectUserMessageReceived ulong connectUserMessageReceived(T callback, Flag!"After" after): Connect to UserMessageReceived signal.
getCacheModel webkit.types.CacheModel getCacheModel(): Returns the current cache model.
getGeolocationManager webkit.geolocation_manager.GeolocationManager getGeolocationManager(): Get the #WebKitGeolocationManager of context.
getNetworkSessionForAutomation webkit.network_session.NetworkSession getNetworkSessionForAutomation(): Get the #WebKitNetworkSession used for automation sessions started in context.
getSecurityManager webkit.security_manager.SecurityManager getSecurityManager(): Get the #WebKitSecurityManager of context.
getSpellCheckingEnabled bool getSpellCheckingEnabled(): Get whether spell checking feature is currently enabled.
getSpellCheckingLanguages string[] getSpellCheckingLanguages(): Get the the list of spell checking languages.
getTimeZoneOverride string getTimeZoneOverride(): Get the #WebKitWebContext:time-zone-override property.
initializeNotificationPermissions void initializeNotificationPermissions(webkit.security_origin.SecurityOrigin[] allowedOrigins, webkit.security_origin.SecurityOrigin[] disallowedOrigins): Sets initial desktop notification permissions for the context.
isAutomationAllowed bool isAutomationAllowed(): Get whether automation is allowed in context.
registerUriScheme void registerUriScheme(string scheme, webkit.types.URISchemeRequestCallback callback): Register scheme in context.
self WebContext self(): Returns this, for use in with statements.
sendMessageToAllExtensions void sendMessageToAllExtensions(webkit.user_message.UserMessage message): Send message to all web process extensions associated to context.
setAutomationAllowed void setAutomationAllowed(bool allowed): Set whether automation is allowed in context.
setCacheModel void setCacheModel(webkit.types.CacheModel cacheModel): Specifies a usage model for WebViews.
setPreferredLanguages void setPreferredLanguages(string[] languages): Set the list of preferred languages.
setSpellCheckingEnabled void setSpellCheckingEnabled(bool enabled): Enable or disable the spell checking feature.
setSpellCheckingLanguages void setSpellCheckingLanguages(string[] languages): Set the list of spell checking languages to be used for spell checking.
setWebProcessExtensionsDirectory void setWebProcessExtensionsDirectory(string directory): Set the directory where WebKit will look for web process extensions.
setWebProcessExtensionsInitializationUserData void setWebProcessExtensionsInitializationUserData(glib.variant.VariantG userData): Set user data to be passed to Web Extensions on initialization.

Properties

gType GType gType [@property getter]

Static functions

getDefault webkit.web_context.WebContext getDefault(): Gets the default web context.
getGType GType getGType()

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

webkit web_context classes

WebContext