Struct webkit_web_process_extension6::WebProcessExtension

pub struct WebProcessExtension { /* private fields */ }

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 #WebKitWebProcessExtensionInitializeFunction or webkit_web_process_extension_initialize_with_user_data() with prototype #WebKitWebProcessExtensionInitializeWithUserDataFunction. 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.

⚠️ The following code is in c ⚠️

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 #WebKitWebPage 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:

⚠️ The following code is in c ⚠️

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

  // ...
}

Signals

page-created

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

user-message-received

This signal is emitted when a #WebKitUserMessage 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 webkit_user_message_send_reply() will do nothing.

GLib type: GObject with reference counted clone semantics.

Implementations

impl WebProcessExtension

pub fn page(&self, page_id: u64) -> Option<WebPage>

Get the web page of the given @page_id.

page_id

the identifier of the #WebKitWebPage to get

Returns

the #WebKitWebPage for the given @page_id, or None if the identifier doesn’t correspond to an existing web page.

pub fn send_message_to_context<P: FnOnce(Result<UserMessage, Error>) + 'static>( &self, message: &UserMessage, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Send @message to the #WebKitWebContext corresponding to @self. If @message is floating, it’s consumed.

If you don’t expect any reply, or you simply want to ignore it, you can pass None as @calback. When the operation is finished, @callback will be called. You can then call webkit_web_process_extension_send_message_to_context_finish() to get the message reply.

message

a #WebKitUserMessage

cancellable

a #GCancellable or None to ignore

callback

A #GAsyncReadyCallback to call when the request is satisfied or None

pub fn send_message_to_context_future( &self, message: &UserMessage, ) -> Pin<Box_<dyn Future<Output = Result<UserMessage, Error>> + 'static>>

pub fn connect_page_created<F: Fn(&Self, &WebPage) + 'static>( &self, f: F, ) -> SignalHandlerId

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

web_page

the #WebKitWebPage created

pub fn connect_user_message_received<F: Fn(&Self, &UserMessage) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when a #WebKitUserMessage 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 webkit_user_message_send_reply() will do nothing.

message

the #WebKitUserMessage received

Trait Implementations

impl Clone for WebProcessExtension

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebProcessExtension

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for WebProcessExtension

type ParamSpec = ParamSpecObject

type SetValue = WebProcessExtension

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, WebProcessExtension>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WebProcessExtension

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WebProcessExtension

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for WebProcessExtension

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for WebProcessExtension

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for WebProcessExtension

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for WebProcessExtension

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WebProcessExtension