webkit/org.gtkkn.bindings.webkit/WebInspector

WebInspector

class WebInspector(pointer: <Error class: unknown class><<Error class: unknown class>>)

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.

// 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));

Constructors

WebInspector

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

attachedHeight

val attachedHeight: <Error class: unknown class>

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

canAttach

val canAttach: Boolean

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

inspectedUri

val inspectedUri: String

The URI that is currently being inspected.

webkitWebInspectorPointer

val webkitWebInspectorPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

attach

fun attach()

Request @inspector to be attached.

fun close()

Request @inspector to be closed.

connectAttach

fun connectAttach(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

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

connectBringToFront

fun connectBringToFront(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

Emitted when the inspector should be shown.

connectClosed

fun connectClosed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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.

connectDetach

fun connectDetach(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

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.

connectOpenWindow

fun connectOpenWindow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

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.

detach

fun detach()

Request @inspector to be detached.

getWebView

fun getWebView(): WebViewBase

Get the #WebKitWebViewBase used to display the inspector.

isAttached

fun isAttached(): Boolean

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

show

fun show()

Request @inspector to be shown.