Struct webkit6::UserContentManager

pub struct UserContentManager { /* private fields */ }

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_add_style_sheet().

To use a #WebKitUserContentManager, it must be created using webkit_user_content_manager_new(), and then used to construct a #WebKitWebView. User style sheets can be created with webkit_user_style_sheet_new().

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

Signals

script-message-received

This signal is emitted when JavaScript in a web view calls window.webkit.messageHandlers..postMessage(), after registering using webkit_user_content_manager_register_script_message_handler()

Detailed

script-message-with-reply-received

This signal is emitted when JavaScript in a web view calls window.webkit.messageHandlers..postMessage(), after registering using webkit_user_content_manager_register_script_message_handler_with_reply()

The given @reply can be used to send a return value with webkit_script_message_reply_return_value() or an error message with webkit_script_message_reply_return_error_message(). If none of them are called, an automatic reply with an undefined value will be sent.

It is possible to handle the reply asynchronously, by simply calling g_object_ref() on the @reply and returning true.

Detailed

GLib type: GObject with reference counted clone semantics.

Implementations

impl UserContentManager

pub fn new() -> UserContentManager

Creates a new user content manager.

Returns

A #WebKitUserContentManager

pub fn add_filter(&self, filter: &UserContentFilter)

Adds a #WebKitUserContentFilter to the given #WebKitUserContentManager.

The same #WebKitUserContentFilter can be reused with multiple #WebKitUserContentManager instances.

Filters need to be saved and loaded from #WebKitUserContentFilterStore.

filter

A #WebKitUserContentFilter

pub fn add_script(&self, script: &UserScript)

Adds a #WebKitUserScript to the given #WebKitUserContentManager.

The same #WebKitUserScript can be reused with multiple #WebKitUserContentManager instances.

script

A #WebKitUserScript

pub fn add_style_sheet(&self, stylesheet: &UserStyleSheet)

Adds a #WebKitUserStyleSheet to the given #WebKitUserContentManager.

The same #WebKitUserStyleSheet can be reused with multiple #WebKitUserContentManager instances.

stylesheet

A #WebKitUserStyleSheet

pub fn register_script_message_handler( &self, name: &str, world_name: Option<&str>, ) -> bool

Registers a new user script message handler in script world.

After it is registered, scripts can use window.webkit.messageHandlers.<name>.postMessage(value) to send messages. Those messages are received by connecting handlers to the #WebKitUserContentManager::script-message-received signal. The handler name is used as the detail of the signal. To avoid race conditions between registering the handler name, and starting to receive the signals, it is recommended to connect to the signal before registering the handler name:

⚠️ The following code is in c ⚠️

WebKitWebView *view = webkit_web_view_new ();
WebKitUserContentManager *manager = webkit_web_view_get_user_content_manager ();
g_signal_connect (manager, "script-message-received::foobar",
                  G_CALLBACK (handle_script_message), NULL);
webkit_user_content_manager_register_script_message_handler (manager, "foobar");

Registering a script message handler will fail if the requested name has been already registered before.

If None is passed as the @world_name, the default world will be used.

The registered handler can be unregistered by using webkit_user_content_manager_unregister_script_message_handler().

name

Name of the script message channel

world_name

the name of a #WebKitScriptWorld

Returns

true if message handler was registered successfully, or false otherwise.

pub fn register_script_message_handler_with_reply( &self, name: &str, world_name: Option<&str>, ) -> bool

Registers a new user script message handler in script world with name @world_name.

Different from webkit_user_content_manager_register_script_message_handler(), when using this function to register the handler, the connected signal is script-message-with-reply-received, and a reply provided by the user is expected. Otherwise, the user will receive a default undefined value.

If None is passed as the @world_name, the default world will be used. See webkit_user_content_manager_register_script_message_handler() for full description.

Registering a script message handler will fail if the requested name has been already registered before.

The registered handler can be unregistered by using webkit_user_content_manager_unregister_script_message_handler().

name

Name of the script message channel

world_name

the name of a #WebKitScriptWorld

Returns

true if message handler was registered successfully, or false otherwise.

pub fn remove_all_filters(&self)

Removes all content filters from the given #WebKitUserContentManager.

pub fn remove_all_scripts(&self)

Removes all user scripts from the given #WebKitUserContentManager

See also webkit_user_content_manager_remove_script().

pub fn remove_all_style_sheets(&self)

Removes all user style sheets from the given #WebKitUserContentManager.

pub fn remove_filter(&self, filter: &UserContentFilter)

Removes a filter from the given #WebKitUserContentManager.

Since 2.24

filter

A #WebKitUserContentFilter

pub fn remove_filter_by_id(&self, filter_id: &str)

Removes a filter by the given identifier.

Removes a filter from the given #WebKitUserContentManager given the identifier of a #WebKitUserContentFilter as returned by webkit_user_content_filter_get_identifier().

filter_id

Filter identifier

pub fn remove_script(&self, script: &UserScript)

Removes a #WebKitUserScript from the given #WebKitUserContentManager.

See also webkit_user_content_manager_remove_all_scripts().

script

A #WebKitUserScript

pub fn remove_style_sheet(&self, stylesheet: &UserStyleSheet)

Removes a #WebKitUserStyleSheet from the given #WebKitUserContentManager.

See also webkit_user_content_manager_remove_all_style_sheets().

stylesheet

A #WebKitUserStyleSheet

pub fn unregister_script_message_handler( &self, name: &str, world_name: Option<&str>, )

Unregisters a previously registered message handler in script world with name @world_name. If None is passed as the @world_name, the default world will be used.

Note that this does not disconnect handlers for the #WebKitUserContentManager::script-message-received signal; they will be kept connected, but the signal will not be emitted unless the handler name is registered again.

See also webkit_user_content_manager_register_script_message_handler().

name

Name of the script message channel

world_name

the name of a #WebKitScriptWorld

pub fn connect_script_message_received<F: Fn(&Self, &Value) + 'static>( &self, detail: Option<&str>, f: F, ) -> SignalHandlerId

This signal is emitted when JavaScript in a web view calls window.webkit.messageHandlers..postMessage(), after registering using webkit_user_content_manager_register_script_message_handler()

value

the value received from the JavaScript world.

pub fn connect_script_message_with_reply_received<F: Fn(&Self, &Value, &ScriptMessageReply) -> bool + 'static>( &self, detail: Option<&str>, f: F, ) -> SignalHandlerId

This signal is emitted when JavaScript in a web view calls window.webkit.messageHandlers..postMessage(), after registering using webkit_user_content_manager_register_script_message_handler_with_reply()

The given @reply can be used to send a return value with webkit_script_message_reply_return_value() or an error message with webkit_script_message_reply_return_error_message(). If none of them are called, an automatic reply with an undefined value will be sent.

It is possible to handle the reply asynchronously, by simply calling g_object_ref() on the @reply and returning true.

value

the value received from the JavaScript world.

reply

the #WebKitScriptMessageReply to send the reply to the script message.

Returns

true to stop other handlers from being invoked for the event. false to propagate the event further.

Trait Implementations

impl Clone for UserContentManager

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 UserContentManager

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

Formats the value using the given formatter.

impl Default for UserContentManager

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for UserContentManager

type ParamSpec = ParamSpecObject

type SetValue = UserContentManager

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for UserContentManager

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 UserContentManager

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 UserContentManager

type Parent = Object

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

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 UserContentManager

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 UserContentManager

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for UserContentManager