UserContentManager

Manages user-defined content which affects web pages.

Using a #WebKitUserContentManager user CSS style sheets can be set to be injected in the web pages loaded by a #WebKitWebView, by webkit.user_content_manager.UserContentManager.addStyleSheet.

To use a #WebKitUserContentManager, it must be created using webkit.user_content_manager.UserContentManager.new_, and then used to construct a #WebKitWebView. User style sheets can be created with webkit.user_style_sheet.UserStyleSheet.new_.

User style sheets can be added and removed at any time, but they will affect the web pages loaded afterwards.

class UserContentManager : ObjectG {

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

static GType getGType();

GType gType [@property getter];

UserContentManager self();

this();

void addFilter(webkit.user_content_filter.UserContentFilter filter);

void addScript(webkit.user_script.UserScript script);

void addStyleSheet(webkit.user_style_sheet.UserStyleSheet stylesheet);

bool registerScriptMessageHandler(string name, string worldName);

bool registerScriptMessageHandlerWithReply(string name, string worldName);

void removeAllFilters();

void removeAllScripts();

void removeAllStyleSheets();

void removeFilter(webkit.user_content_filter.UserContentFilter filter);

void removeFilterById(string filterId);

void removeScript(webkit.user_script.UserScript script);

void removeStyleSheet(webkit.user_style_sheet.UserStyleSheet stylesheet);

void unregisterScriptMessageHandler(string name, string worldName);

ulong connectScriptMessageReceived(string detail, T callback, Flag!"After" after);

ulong connectScriptMessageWithReplyReceived(string detail, T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new user content manager.

Members

Functions

addFilter void addFilter(webkit.user_content_filter.UserContentFilter filter): Adds a #WebKitUserContentFilter to the given #WebKitUserContentManager.
addScript void addScript(webkit.user_script.UserScript script): Adds a #WebKitUserScript to the given #WebKitUserContentManager.
addStyleSheet void addStyleSheet(webkit.user_style_sheet.UserStyleSheet stylesheet): Adds a #WebKitUserStyleSheet to the given #WebKitUserContentManager.
connectScriptMessageReceived ulong connectScriptMessageReceived(string detail, T callback, Flag!"After" after): Connect to ScriptMessageReceived signal.
connectScriptMessageWithReplyReceived ulong connectScriptMessageWithReplyReceived(string detail, T callback, Flag!"After" after): Connect to ScriptMessageWithReplyReceived signal.
registerScriptMessageHandler bool registerScriptMessageHandler(string name, string worldName): Registers a new user script message handler in script world.
registerScriptMessageHandlerWithReply bool registerScriptMessageHandlerWithReply(string name, string worldName): Registers a new user script message handler in script world with name world_name.
removeAllFilters void removeAllFilters(): Removes all content filters from the given #WebKitUserContentManager.
removeAllScripts void removeAllScripts(): Removes all user scripts from the given #WebKitUserContentManager
removeAllStyleSheets void removeAllStyleSheets(): Removes all user style sheets from the given #WebKitUserContentManager.
removeFilter void removeFilter(webkit.user_content_filter.UserContentFilter filter): Removes a filter from the given #WebKitUserContentManager.
removeFilterById void removeFilterById(string filterId): Removes a filter by the given identifier.
removeScript void removeScript(webkit.user_script.UserScript script): Removes a #WebKitUserScript from the given #WebKitUserContentManager.
removeStyleSheet void removeStyleSheet(webkit.user_style_sheet.UserStyleSheet stylesheet): Removes a #WebKitUserStyleSheet from the given #WebKitUserContentManager.
self UserContentManager self(): Returns this, for use in with statements.
unregisterScriptMessageHandler void unregisterScriptMessageHandler(string name, string worldName): Unregisters a previously registered message handler in script world with name world_name. If null is passed as the world_name, the default world will be used.

Properties

gType GType gType [@property getter]

Static functions

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

UserContentManager