Struct webkit_web_process_extension6::WebPage

pub struct WebPage { /* private fields */ }

A loaded web page.

Properties

uri

The current active URI of the #WebKitWebPage.

Readable

Signals

console-message-sent

Emitted when a message is sent to the console. This can be a message produced by the use of JavaScript console API, a JavaScript exception, a security error or other errors, warnings, debug or log messages. The @console_message contains information of the message.

context-menu

Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process. This signal is useful when the information available in the UI Process is not enough to build or customize the context menu, for example, to add menu entries depending on the node at the coordinates of the @hit_test_result. Otherwise, it’s recommended to use #WebKitWebView::context-menu signal instead.

document-loaded

This signal is emitted when the DOM document of a #WebKitWebPage has been loaded.

You can wait for this signal to get the DOM document

send-request

This signal is emitted when @request is about to be sent to the server. This signal can be used to modify the #WebKitURIRequest that will be sent to the server. You can also cancel the resource load operation by connecting to this signal and returning true.

In case of a server redirection this signal is emitted again with the @request argument containing the new request to be sent to the server due to the redirection and the @redirected_response parameter containing the response received by the server for the initial request.

Modifications to the #WebKitURIRequest and its associated #SoupMessageHeaders will be taken into account when the request is sent over the network.

user-message-received

This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebView corresponding to @web_page. You can reply to the message using webkit_user_message_send_reply().

You can handle the user message asynchronously by calling g_object_ref() on @message and returning true. If the last reference of @message is removed and the message has been replied, the operation in the #WebKitWebView will finish with error UserMessageError::UserMessageUnhandledMessage.

GLib type: GObject with reference counted clone semantics.

Implementations

impl WebPage

pub fn editor(&self) -> Option<WebEditor>

Gets the #WebKitWebEditor of a #WebKitWebPage.

Returns

the #WebKitWebEditor

pub fn form_manager( &self, world: Option<&ScriptWorld>, ) -> Option<WebFormManager>

Get the #WebKitWebFormManager of @self in @world.

world

a #WebKitScriptWorld

Returns

a #WebKitWebFormManager

pub fn id(&self) -> u64

Get the identifier of the #WebKitWebPage

Returns

the identifier of @self

pub fn main_frame(&self) -> Option<Frame>

Returns the main frame of a #WebKitWebPage.

Returns

the #WebKitFrame that is the main frame of @self

pub fn uri(&self) -> Option<GString>

Returns the current active URI of @self.

You can monitor the active URI by connecting to the notify::uri signal of @self.

Returns

the current active URI of @web_view or None if nothing has been loaded yet.

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

Send @message to the #WebKitWebView 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 @callback. When the operation is finished, @callback will be called. You can then call webkit_web_page_send_message_to_view_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_view_future( &self, message: &UserMessage, ) -> Pin<Box_<dyn Future<Output = Result<UserMessage, Error>> + 'static>>

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

Emitted when a message is sent to the console. This can be a message produced by the use of JavaScript console API, a JavaScript exception, a security error or other errors, warnings, debug or log messages. The @console_message contains information of the message.

console_message

the #WebKitConsoleMessage

pub fn connect_context_menu<F: Fn(&Self, &ContextMenu, &WebHitTestResult) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process. This signal is useful when the information available in the UI Process is not enough to build or customize the context menu, for example, to add menu entries depending on the node at the coordinates of the @hit_test_result. Otherwise, it’s recommended to use #WebKitWebView::context-menu signal instead.

context_menu

the proposed #WebKitContextMenu

hit_test_result

a #WebKitWebHitTestResult

Returns

true if the proposed @context_menu has been modified, or false otherwise.

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

This signal is emitted when the DOM document of a #WebKitWebPage has been loaded.

You can wait for this signal to get the DOM document

pub fn connect_send_request<F: Fn(&Self, &URIRequest, &URIResponse) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when @request is about to be sent to the server. This signal can be used to modify the #WebKitURIRequest that will be sent to the server. You can also cancel the resource load operation by connecting to this signal and returning true.

In case of a server redirection this signal is emitted again with the @request argument containing the new request to be sent to the server due to the redirection and the @redirected_response parameter containing the response received by the server for the initial request.

Modifications to the #WebKitURIRequest and its associated #SoupMessageHeaders will be taken into account when the request is sent over the network.

request

a #WebKitURIRequest

redirected_response

a #WebKitURIResponse, or None

Returns

true to stop other handlers from being invoked for the event. false to continue emission of the event.

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

This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebView corresponding to @web_page. You can reply to the message using webkit_user_message_send_reply().

You can handle the user message asynchronously by calling g_object_ref() on @message and returning true. If the last reference of @message is removed and the message has been replied, the operation in the #WebKitWebView will finish with error UserMessageError::UserMessageUnhandledMessage.

message

the #WebKitUserMessage received

Returns

true if the message was handled, or false otherwise.

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

Trait Implementations

impl Clone for WebPage

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 WebPage

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

Formats the value using the given formatter.

impl HasParamSpec for WebPage

type ParamSpec = ParamSpecObject

type SetValue = WebPage

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WebPage

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 WebPage

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 WebPage

type Parent = Object

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

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 WebPage

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 WebPage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WebPage