GI.WebKitWebProcessExtension.Objects.WebProcessExtension

Represents an extension of the web process.

WebKitWebProcessExtension is a loadable module for the web process. It allows you to execute code in the web process and being able to use the DOM API, to change any request or to inject custom JavaScript code, for example.

To create a WebKitWebProcessExtension you should write a module with an initialization function that could be either webkit_web_process_extension_initialize() with prototype WebProcessExtensionInitializeFunction or webkit_web_process_extension_initialize_with_user_data() with prototype WebProcessExtensionInitializeWithUserDataFunction. This function has to be public and it has to use the G_MODULE_EXPORT macro. It is called when the web process is initialized.

c code

static void
web_page_created_callback (WebKitWebProcessExtension *extension,
                           WebKitWebPage             *web_page,
                           gpointer                   user_data)
{
    g_print ("Page %d created for %s\n",
             webkit_web_page_get_id (web_page),
             webkit_web_page_get_uri (web_page));
}

G_MODULE_EXPORT void
webkit_web_process_extension_initialize (WebKitWebProcessExtension *extension)
{
    g_signal_connect (extension, "page-created",
                      G_CALLBACK (web_page_created_callback),
                      NULL);
}

The previous piece of code shows a trivial example of an extension that notifies when a WebPage is created.

WebKit has to know where it can find the created WebKitWebProcessExtension. To do so you should use the webkit_web_context_set_web_extensions_directory() function. The signal WebKitWebContext::initialize-web-extensions is the recommended place to call it.

To provide the initialization data used by the webkit_web_process_extension_initialize_with_user_data() function, you have to call webkit_web_context_set_web_extensions_initialization_user_data() with the desired data as parameter. You can see an example of this in the following piece of code:

c code

#define WEB_EXTENSIONS_DIRECTORY // ...

static void
initialize_web_extensions (WebKitWebContext *context,
                           gpointer          user_data)
{
  // Web Extensions get a different ID for each Web Process
  static guint32 unique_id = 0;

  webkit_web_context_set_web_extensions_directory (
     context, WEB_EXTENSIONS_DIRECTORY);
  webkit_web_context_set_web_extensions_initialization_user_data (
     context, g_variant_new_uint32 (unique_id++));
}

int main (int argc, char **argv)
{
  g_signal_connect (webkit_web_context_get_default (),
                   "initialize-web-extensions",
                    G_CALLBACK (initialize_web_extensions),
                    NULL);

  GtkWidget *view = webkit_web_view_new ();

  // ...
}

Since: 2.40

Exported types

newtype WebProcessExtension

Memory-managed wrapper type.

Constructors

WebProcessExtension (ManagedPtr WebProcessExtension)

Instances

Eq WebProcessExtension

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

Methods

(==) :: WebProcessExtension -> WebProcessExtension -> Bool

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

GObject WebProcessExtension

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

ManagedPtrNewtype WebProcessExtension

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

Methods

toManagedPtr :: WebProcessExtension -> ManagedPtr WebProcessExtension

TypedObject WebProcessExtension

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

Methods

glibType :: IO GType

HasParentTypes WebProcessExtension

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

IsGValue (Maybe WebProcessExtension)

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

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes WebProcessExtension

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

type ParentTypes WebProcessExtension = '[Object]

class (GObject o, IsDescendantOf WebProcessExtension o) => IsWebProcessExtension o

Type class for types which can be safely cast to WebProcessExtension, for instance with toWebProcessExtension.

Instances

(GObject o, IsDescendantOf WebProcessExtension o) => IsWebProcessExtension o

Defined in GI.WebKitWebProcessExtension.Objects.WebProcessExtension

toWebProcessExtension :: (MonadIO m, IsWebProcessExtension o) => o -> m WebProcessExtension

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

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, sendMessageToContext, sendMessageToContextFinish, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getPage, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

getPage

webProcessExtensionGetPage

Arguments

:: (HasCallStack, MonadIO m, IsWebProcessExtension a)

=> a

extension: a WebProcessExtension

-> Word64

pageId: the identifier of the WebPage to get

-> m WebPage

Returns: the WebPage for the given pageId, or Nothing if the identifier doesn't correspond to an existing web page.

Get the web page of the given pageId.

Since: 2.40

sendMessageToContext

webProcessExtensionSendMessageToContext

Arguments

:: (HasCallStack, MonadIO m, IsWebProcessExtension a, IsUserMessage b, IsCancellable c)

=> a

extension: a WebProcessExtension

-> b

message: a UserMessage

-> Maybe c

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: (nullable): A AsyncReadyCallback to call when the request is satisfied or Nothing

-> m ()

Send message to the WebKitWebContext corresponding to extension. If message is floating, it's consumed.

If you don't expect any reply, or you simply want to ignore it, you can pass Nothing as calback. When the operation is finished, callback will be called. You can then call webProcessExtensionSendMessageToContextFinish to get the message reply.

Since: 2.40

sendMessageToContextFinish

webProcessExtensionSendMessageToContextFinish

Arguments

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

=> a

extension: a WebProcessExtension

-> b

result: a AsyncResult

-> m UserMessage

Returns: a UserMessage with the reply or Nothing in case of error. (Can throw GError)

Finish an asynchronous operation started with webProcessExtensionSendMessageToContext.

Since: 2.40

Signals

pageCreated

type WebProcessExtensionPageCreatedCallback

Arguments

 = WebPage

webPage: the WebPage created

-> IO ()

This signal is emitted when a new WebPage is created in the Web Process.

Since: 2.40

afterWebProcessExtensionPageCreated :: (IsWebProcessExtension a, MonadIO m) => a -> ((?self :: a) => WebProcessExtensionPageCreatedCallback) -> m SignalHandlerId

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

after webProcessExtension #pageCreated callback

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

onWebProcessExtensionPageCreated :: (IsWebProcessExtension a, MonadIO m) => a -> ((?self :: a) => WebProcessExtensionPageCreatedCallback) -> m SignalHandlerId

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

on webProcessExtension #pageCreated callback

userMessageReceived

type WebProcessExtensionUserMessageReceivedCallback

Arguments

 = UserMessage

message: the UserMessage received

-> IO ()

This signal is emitted when a UserMessage is received from the WebKitWebContext corresponding to extension. Messages sent by WebKitWebContext are always broadcasted to all web extensions and they can't be replied to. Calling userMessageSendReply will do nothing.

Since: 2.40

afterWebProcessExtensionUserMessageReceived :: (IsWebProcessExtension a, MonadIO m) => a -> ((?self :: a) => WebProcessExtensionUserMessageReceivedCallback) -> m SignalHandlerId

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

after webProcessExtension #userMessageReceived callback

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

onWebProcessExtensionUserMessageReceived :: (IsWebProcessExtension a, MonadIO m) => a -> ((?self :: a) => WebProcessExtensionUserMessageReceivedCallback) -> m SignalHandlerId

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

on webProcessExtension #userMessageReceived callback