Struct webkit6::WebInspector

pub struct WebInspector { /* private fields */ }

Access to the WebKit inspector.

The WebKit Inspector is a graphical tool to inspect and change the content of a #WebKitWebView. It also includes an interactive JavaScript debugger. Using this class one can get a #GtkWidget which can be embedded into an application to show the inspector.

The inspector is available when the #WebKitSettings of the #WebKitWebView has set the #WebKitSettings:enable-developer-extras to true, otherwise no inspector is available.

⚠️ The following code is in c ⚠️

// Enable the developer extras
WebKitSettings *settings = webkit_web_view_get_settings (WEBKIT_WEB_VIEW(my_webview));
g_object_set (G_OBJECT(settings), "enable-developer-extras", TRUE, NULL);

// Load some data or reload to be able to inspect the page
webkit_web_view_load_uri (WEBKIT_WEB_VIEW(my_webview), "http://www.gnome.org");

// Show the inspector
WebKitWebInspector *inspector = webkit_web_view_get_inspector (WEBKIT_WEB_VIEW(my_webview));
webkit_web_inspector_show (WEBKIT_WEB_INSPECTOR(inspector));

Properties

attached-height

The height that the inspector view should have when it is attached.

Readable

can-attach

Whether the @inspector can be attached to the same window that contains the inspected view.

Readable

inspected-uri

The URI that is currently being inspected.

Readable

Signals

attach

Emitted when the inspector is requested to be attached to the window where the inspected web view is. If this signal is not handled the inspector view will be automatically attached to the inspected view, so you only need to handle this signal if you want to attach the inspector view yourself (for example, to add the inspector view to a browser tab).

To prevent the inspector view from being attached you can connect to this signal and simply return true.

bring-to-front

Emitted when the inspector should be shown.

If the inspector is not attached the inspector window should be shown on top of any other windows. If the inspector is attached the inspector view should be made visible. For example, if the inspector view is attached using a tab in a browser window, the browser window should be raised and the tab containing the inspector view should be the active one. In both cases, if this signal is not handled, the default implementation calls gtk_window_present() on the current toplevel #GtkWindow of the inspector view.

closed

Emitted when the inspector page is closed. If you are using your own inspector window, you should connect to this signal and destroy your window.

detach

Emitted when the inspector is requested to be detached from the window it is currently attached to. The inspector is detached when the inspector page is about to be closed, and this signal is emitted right before #WebKitWebInspector::closed, or when the user clicks on the detach button in the inspector view to show the inspector in a separate window. In this case the signal #WebKitWebInspector::open-window is emitted after this one.

To prevent the inspector view from being detached you can connect to this signal and simply return true.

open-window

Emitted when the inspector is requested to open in a separate window. If this signal is not handled, a #GtkWindow with the inspector will be created and shown, so you only need to handle this signal if you want to use your own window. This signal is emitted after #WebKitWebInspector::detach to show the inspector in a separate window after being detached.

To prevent the inspector from being shown you can connect to this signal and simply return true

GLib type: GObject with reference counted clone semantics.

Implementations

impl WebInspector

pub fn attach(&self)

Request @self to be attached.

The signal #WebKitWebInspector::attach will be emitted. If the inspector is already attached it does nothing.

pub fn close(&self)

Request @self to be closed.

pub fn detach(&self)

Request @self to be detached.

The signal #WebKitWebInspector::detach will be emitted. If the inspector is already detached it does nothing.

pub fn attached_height(&self) -> u32

Get the height that the inspector view when attached.

Get the height that the inspector view should have when it’s attached. If the inspector view is not attached this returns 0.

Returns

the height of the inspector view when attached

pub fn can_attach(&self) -> bool

Whether the @self can be attached to the same window that contains the inspected view.

Returns

true if there is enough room for the inspector view inside the window that contains the inspected view, or false otherwise.

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

Get the URI that is currently being inspected.

This can be None if nothing has been loaded yet in the inspected view, if the inspector has been closed or when inspected view was loaded from a HTML string instead of a URI.

Returns

the URI that is currently being inspected or None

pub fn web_view(&self) -> Option<WebViewBase>

Get the #WebKitWebViewBase used to display the inspector.

This might be None if the inspector hasn’t been loaded yet, or it has been closed.

Returns

the #WebKitWebViewBase used to display the inspector or None

pub fn is_attached(&self) -> bool

Whether the @self view is currently attached to the same window that contains the inspected view.

Returns

true if @self is currently attached or false otherwise

pub fn show(&self)

Request @self to be shown.

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

Emitted when the inspector is requested to be attached to the window where the inspected web view is. If this signal is not handled the inspector view will be automatically attached to the inspected view, so you only need to handle this signal if you want to attach the inspector view yourself (for example, to add the inspector view to a browser tab).

To prevent the inspector view from being attached you can connect to this signal and simply return true.

Returns

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

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

Emitted when the inspector should be shown.

If the inspector is not attached the inspector window should be shown on top of any other windows. If the inspector is attached the inspector view should be made visible. For example, if the inspector view is attached using a tab in a browser window, the browser window should be raised and the tab containing the inspector view should be the active one. In both cases, if this signal is not handled, the default implementation calls gtk_window_present() on the current toplevel #GtkWindow of the inspector view.

Returns

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

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

Emitted when the inspector page is closed. If you are using your own inspector window, you should connect to this signal and destroy your window.

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

Emitted when the inspector is requested to be detached from the window it is currently attached to. The inspector is detached when the inspector page is about to be closed, and this signal is emitted right before #WebKitWebInspector::closed, or when the user clicks on the detach button in the inspector view to show the inspector in a separate window. In this case the signal #WebKitWebInspector::open-window is emitted after this one.

To prevent the inspector view from being detached you can connect to this signal and simply return true.

Returns

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

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

Emitted when the inspector is requested to open in a separate window. If this signal is not handled, a #GtkWindow with the inspector will be created and shown, so you only need to handle this signal if you want to use your own window. This signal is emitted after #WebKitWebInspector::detach to show the inspector in a separate window after being detached.

To prevent the inspector from being shown you can connect to this signal and simply return true

Returns

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

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

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

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

Trait Implementations

impl Clone for WebInspector

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 WebInspector

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

Formats the value using the given formatter.

impl HasParamSpec for WebInspector

type ParamSpec = ParamSpecObject

type SetValue = WebInspector

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WebInspector

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 WebInspector

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 WebInspector

type Parent = Object

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

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 WebInspector

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 WebInspector

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WebInspector