Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
The WebKit Inspector is a graphical tool to inspect and change
the content of a WebView
. It also includes an interactive
JavaScriptDebugger. 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 WebSettings
of the
WebView
has set the WebSettings
:enable-developer-extras
to true otherwise no inspector is available.
<informalexample><programlisting> /<!-- -->* Enable the developer extras *<!-- -->/ WebKitWebSettings *setting = 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_open (WEBKIT_WEB_VIEW(my_webview), "http://www.gnome.org");
/<!-- -->* Embed the inspector somewhere *<!-- -->/ WebKitWebInspector *inspector = webkit_web_view_get_inspector (WEBKIT_WEB_VIEW(my_webview)); g_signal_connect (G_OBJECT (inspector), "inspect-web-view", G_CALLBACK(create_gtk_window_around_it), NULL); g_signal_connect (G_OBJECT (inspector), "show-window", G_CALLBACK(show_inpector_window), NULL)); g_signal_connect (G_OBJECT (inspector), "notify::inspected-uri", G_CALLBACK(inspected_uri_changed_do_stuff), NULL); </programlisting></informalexample>
- newtype WebInspector = WebInspector (ManagedPtr WebInspector)
- class GObject o => IsWebInspector o
- toWebInspector :: IsWebInspector o => o -> IO WebInspector
- noWebInspector :: Maybe WebInspector
- data WebInspectorCloseMethodInfo
- webInspectorClose :: (HasCallStack, MonadIO m, IsWebInspector a) => a -> m ()
- data WebInspectorGetInspectedUriMethodInfo
- webInspectorGetInspectedUri :: (HasCallStack, MonadIO m, IsWebInspector a) => a -> m Text
- data WebInspectorGetWebViewMethodInfo
- webInspectorGetWebView :: (HasCallStack, MonadIO m, IsWebInspector a) => a -> m WebView
- data WebInspectorInspectCoordinatesMethodInfo
- webInspectorInspectCoordinates :: (HasCallStack, MonadIO m, IsWebInspector a) => a -> Double -> Double -> m ()
- data WebInspectorInspectNodeMethodInfo
- webInspectorInspectNode :: (HasCallStack, MonadIO m, IsWebInspector a, IsDOMNode b) => a -> b -> m ()
- data WebInspectorShowMethodInfo
- webInspectorShow :: (HasCallStack, MonadIO m, IsWebInspector a) => a -> m ()
- data WebInspectorInspectedUriPropertyInfo
- getWebInspectorInspectedUri :: (MonadIO m, IsWebInspector o) => o -> m Text
- webInspectorInspectedUri :: AttrLabelProxy "inspectedUri"
- data WebInspectorJavascriptProfilingEnabledPropertyInfo
- constructWebInspectorJavascriptProfilingEnabled :: IsWebInspector o => Bool -> IO (GValueConstruct o)
- getWebInspectorJavascriptProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> m Bool
- setWebInspectorJavascriptProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> Bool -> m ()
- webInspectorJavascriptProfilingEnabled :: AttrLabelProxy "javascriptProfilingEnabled"
- data WebInspectorTimelineProfilingEnabledPropertyInfo
- constructWebInspectorTimelineProfilingEnabled :: IsWebInspector o => Bool -> IO (GValueConstruct o)
- getWebInspectorTimelineProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> m Bool
- setWebInspectorTimelineProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> Bool -> m ()
- webInspectorTimelineProfilingEnabled :: AttrLabelProxy "timelineProfilingEnabled"
- data WebInspectorWebViewPropertyInfo
- getWebInspectorWebView :: (MonadIO m, IsWebInspector o) => o -> m WebView
- webInspectorWebView :: AttrLabelProxy "webView"
- type C_WebInspectorAttachWindowCallback = Ptr () -> Ptr () -> IO CInt
- type WebInspectorAttachWindowCallback = IO Bool
- data WebInspectorAttachWindowSignalInfo
- afterWebInspectorAttachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorAttachWindowCallback -> m SignalHandlerId
- genClosure_WebInspectorAttachWindow :: WebInspectorAttachWindowCallback -> IO Closure
- mk_WebInspectorAttachWindowCallback :: C_WebInspectorAttachWindowCallback -> IO (FunPtr C_WebInspectorAttachWindowCallback)
- noWebInspectorAttachWindowCallback :: Maybe WebInspectorAttachWindowCallback
- onWebInspectorAttachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorAttachWindowCallback -> m SignalHandlerId
- wrap_WebInspectorAttachWindowCallback :: WebInspectorAttachWindowCallback -> Ptr () -> Ptr () -> IO CInt
- type C_WebInspectorCloseWindowCallback = Ptr () -> Ptr () -> IO CInt
- type WebInspectorCloseWindowCallback = IO Bool
- data WebInspectorCloseWindowSignalInfo
- afterWebInspectorCloseWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorCloseWindowCallback -> m SignalHandlerId
- genClosure_WebInspectorCloseWindow :: WebInspectorCloseWindowCallback -> IO Closure
- mk_WebInspectorCloseWindowCallback :: C_WebInspectorCloseWindowCallback -> IO (FunPtr C_WebInspectorCloseWindowCallback)
- noWebInspectorCloseWindowCallback :: Maybe WebInspectorCloseWindowCallback
- onWebInspectorCloseWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorCloseWindowCallback -> m SignalHandlerId
- wrap_WebInspectorCloseWindowCallback :: WebInspectorCloseWindowCallback -> Ptr () -> Ptr () -> IO CInt
- type C_WebInspectorDetachWindowCallback = Ptr () -> Ptr () -> IO CInt
- type WebInspectorDetachWindowCallback = IO Bool
- data WebInspectorDetachWindowSignalInfo
- afterWebInspectorDetachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorDetachWindowCallback -> m SignalHandlerId
- genClosure_WebInspectorDetachWindow :: WebInspectorDetachWindowCallback -> IO Closure
- mk_WebInspectorDetachWindowCallback :: C_WebInspectorDetachWindowCallback -> IO (FunPtr C_WebInspectorDetachWindowCallback)
- noWebInspectorDetachWindowCallback :: Maybe WebInspectorDetachWindowCallback
- onWebInspectorDetachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorDetachWindowCallback -> m SignalHandlerId
- wrap_WebInspectorDetachWindowCallback :: WebInspectorDetachWindowCallback -> Ptr () -> Ptr () -> IO CInt
- type C_WebInspectorFinishedCallback = Ptr () -> Ptr () -> IO ()
- type WebInspectorFinishedCallback = IO ()
- data WebInspectorFinishedSignalInfo
- afterWebInspectorFinished :: (IsWebInspector a, MonadIO m) => a -> WebInspectorFinishedCallback -> m SignalHandlerId
- genClosure_WebInspectorFinished :: WebInspectorFinishedCallback -> IO Closure
- mk_WebInspectorFinishedCallback :: C_WebInspectorFinishedCallback -> IO (FunPtr C_WebInspectorFinishedCallback)
- noWebInspectorFinishedCallback :: Maybe WebInspectorFinishedCallback
- onWebInspectorFinished :: (IsWebInspector a, MonadIO m) => a -> WebInspectorFinishedCallback -> m SignalHandlerId
- wrap_WebInspectorFinishedCallback :: WebInspectorFinishedCallback -> Ptr () -> Ptr () -> IO ()
- type C_WebInspectorInspectWebViewCallback = Ptr () -> Ptr WebView -> Ptr () -> IO (Ptr WebView)
- type WebInspectorInspectWebViewCallback = WebView -> IO WebView
- data WebInspectorInspectWebViewSignalInfo
- afterWebInspectorInspectWebView :: (IsWebInspector a, MonadIO m) => a -> WebInspectorInspectWebViewCallback -> m SignalHandlerId
- genClosure_WebInspectorInspectWebView :: WebInspectorInspectWebViewCallback -> IO Closure
- mk_WebInspectorInspectWebViewCallback :: C_WebInspectorInspectWebViewCallback -> IO (FunPtr C_WebInspectorInspectWebViewCallback)
- noWebInspectorInspectWebViewCallback :: Maybe WebInspectorInspectWebViewCallback
- onWebInspectorInspectWebView :: (IsWebInspector a, MonadIO m) => a -> WebInspectorInspectWebViewCallback -> m SignalHandlerId
- wrap_WebInspectorInspectWebViewCallback :: WebInspectorInspectWebViewCallback -> Ptr () -> Ptr WebView -> Ptr () -> IO (Ptr WebView)
- type C_WebInspectorShowWindowCallback = Ptr () -> Ptr () -> IO CInt
- type WebInspectorShowWindowCallback = IO Bool
- data WebInspectorShowWindowSignalInfo
- afterWebInspectorShowWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorShowWindowCallback -> m SignalHandlerId
- genClosure_WebInspectorShowWindow :: WebInspectorShowWindowCallback -> IO Closure
- mk_WebInspectorShowWindowCallback :: C_WebInspectorShowWindowCallback -> IO (FunPtr C_WebInspectorShowWindowCallback)
- noWebInspectorShowWindowCallback :: Maybe WebInspectorShowWindowCallback
- onWebInspectorShowWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorShowWindowCallback -> m SignalHandlerId
- wrap_WebInspectorShowWindowCallback :: WebInspectorShowWindowCallback -> Ptr () -> Ptr () -> IO CInt
Exported types
newtype WebInspector Source #
GObject WebInspector Source # | |
IsObject WebInspector Source # | |
IsWebInspector WebInspector Source # | |
((~) * info (ResolveWebInspectorMethod t WebInspector), MethodInfo * info WebInspector p) => IsLabel t (WebInspector -> p) Source # | |
((~) * info (ResolveWebInspectorMethod t WebInspector), MethodInfo * info WebInspector p) => IsLabelProxy t (WebInspector -> p) Source # | |
HasAttributeList * WebInspector Source # | |
type AttributeList WebInspector Source # | |
type SignalList WebInspector Source # | |
class GObject o => IsWebInspector o Source #
toWebInspector :: IsWebInspector o => o -> IO WebInspector Source #
Methods
close
data WebInspectorCloseMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsWebInspector a) => MethodInfo * WebInspectorCloseMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsWebInspector a) | |
=> a |
|
-> m () |
Causes the Web Inspector to be closed.
Since: 1.1.17
getInspectedUri
data WebInspectorGetInspectedUriMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsWebInspector a) => MethodInfo * WebInspectorGetInspectedUriMethodInfo a signature Source # | |
webInspectorGetInspectedUri Source #
:: (HasCallStack, MonadIO m, IsWebInspector a) | |
=> a |
|
-> m Text | Returns: a pointer to the URI as an internally allocated string; it should not be freed, modified or stored. |
Obtains the URI that is currently being inspected.
Since: 1.0.3
getWebView
data WebInspectorGetWebViewMethodInfo Source #
((~) * signature (m WebView), MonadIO m, IsWebInspector a) => MethodInfo * WebInspectorGetWebViewMethodInfo a signature Source # | |
webInspectorGetWebView Source #
:: (HasCallStack, MonadIO m, IsWebInspector a) | |
=> a |
|
-> m WebView | Returns: the |
Obtains the WebView
that is used to render the
inspector. The WebView
instance is created by the
application, by handling the WebInspector
::inspect-web-view
signal. This means
that this method may return Nothing
if the user hasn't inspected
anything.
Since: 1.0.3
inspectCoordinates
data WebInspectorInspectCoordinatesMethodInfo Source #
((~) * signature (Double -> Double -> m ()), MonadIO m, IsWebInspector a) => MethodInfo * WebInspectorInspectCoordinatesMethodInfo a signature Source # | |
webInspectorInspectCoordinates Source #
:: (HasCallStack, MonadIO m, IsWebInspector a) | |
=> a |
|
-> Double |
|
-> Double |
|
-> m () |
Causes the Web Inspector to inspect the node that is located at the
given coordinates of the widget. The coordinates should be relative
to the WebView
widget, not to the scrollable content, and
may be obtained from a Event
directly.
This means x
, and y
being zero doesn't guarantee you will hit the
left-most top corner of the content, since the contents may have
been scrolled.
Since: 1.1.17
inspectNode
data WebInspectorInspectNodeMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsWebInspector a, IsDOMNode b) => MethodInfo * WebInspectorInspectNodeMethodInfo a signature Source # | |
webInspectorInspectNode Source #
:: (HasCallStack, MonadIO m, IsWebInspector a, IsDOMNode b) | |
=> a |
|
-> b |
|
-> m () |
Causes the Web Inspector to inspect the given node.
Since: 1.3.7
show
data WebInspectorShowMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsWebInspector a) => MethodInfo * WebInspectorShowMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsWebInspector a) | |
=> a |
|
-> m () |
Causes the Web Inspector to be shown.
Since: 1.1.17
Properties
inspectedUri
data WebInspectorInspectedUriPropertyInfo Source #
getWebInspectorInspectedUri :: (MonadIO m, IsWebInspector o) => o -> m Text Source #
webInspectorInspectedUri :: AttrLabelProxy "inspectedUri" Source #
javascriptProfilingEnabled
data WebInspectorJavascriptProfilingEnabledPropertyInfo Source #
constructWebInspectorJavascriptProfilingEnabled :: IsWebInspector o => Bool -> IO (GValueConstruct o) Source #
getWebInspectorJavascriptProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> m Bool Source #
setWebInspectorJavascriptProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> Bool -> m () Source #
webInspectorJavascriptProfilingEnabled :: AttrLabelProxy "javascriptProfilingEnabled" Source #
timelineProfilingEnabled
data WebInspectorTimelineProfilingEnabledPropertyInfo Source #
constructWebInspectorTimelineProfilingEnabled :: IsWebInspector o => Bool -> IO (GValueConstruct o) Source #
getWebInspectorTimelineProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> m Bool Source #
setWebInspectorTimelineProfilingEnabled :: (MonadIO m, IsWebInspector o) => o -> Bool -> m () Source #
webInspectorTimelineProfilingEnabled :: AttrLabelProxy "timelineProfilingEnabled" Source #
webView
data WebInspectorWebViewPropertyInfo Source #
getWebInspectorWebView :: (MonadIO m, IsWebInspector o) => o -> m WebView Source #
webInspectorWebView :: AttrLabelProxy "webView" Source #
Signals
attachWindow
afterWebInspectorAttachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorAttachWindowCallback -> m SignalHandlerId Source #
mk_WebInspectorAttachWindowCallback :: C_WebInspectorAttachWindowCallback -> IO (FunPtr C_WebInspectorAttachWindowCallback) Source #
onWebInspectorAttachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorAttachWindowCallback -> m SignalHandlerId Source #
wrap_WebInspectorAttachWindowCallback :: WebInspectorAttachWindowCallback -> Ptr () -> Ptr () -> IO CInt Source #
closeWindow
type WebInspectorCloseWindowCallback = IO Bool Source #
afterWebInspectorCloseWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorCloseWindowCallback -> m SignalHandlerId Source #
mk_WebInspectorCloseWindowCallback :: C_WebInspectorCloseWindowCallback -> IO (FunPtr C_WebInspectorCloseWindowCallback) Source #
onWebInspectorCloseWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorCloseWindowCallback -> m SignalHandlerId Source #
wrap_WebInspectorCloseWindowCallback :: WebInspectorCloseWindowCallback -> Ptr () -> Ptr () -> IO CInt Source #
detachWindow
afterWebInspectorDetachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorDetachWindowCallback -> m SignalHandlerId Source #
mk_WebInspectorDetachWindowCallback :: C_WebInspectorDetachWindowCallback -> IO (FunPtr C_WebInspectorDetachWindowCallback) Source #
onWebInspectorDetachWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorDetachWindowCallback -> m SignalHandlerId Source #
wrap_WebInspectorDetachWindowCallback :: WebInspectorDetachWindowCallback -> Ptr () -> Ptr () -> IO CInt Source #
finished
type WebInspectorFinishedCallback = IO () Source #
afterWebInspectorFinished :: (IsWebInspector a, MonadIO m) => a -> WebInspectorFinishedCallback -> m SignalHandlerId Source #
mk_WebInspectorFinishedCallback :: C_WebInspectorFinishedCallback -> IO (FunPtr C_WebInspectorFinishedCallback) Source #
onWebInspectorFinished :: (IsWebInspector a, MonadIO m) => a -> WebInspectorFinishedCallback -> m SignalHandlerId Source #
wrap_WebInspectorFinishedCallback :: WebInspectorFinishedCallback -> Ptr () -> Ptr () -> IO () Source #
inspectWebView
type C_WebInspectorInspectWebViewCallback = Ptr () -> Ptr WebView -> Ptr () -> IO (Ptr WebView) Source #
afterWebInspectorInspectWebView :: (IsWebInspector a, MonadIO m) => a -> WebInspectorInspectWebViewCallback -> m SignalHandlerId Source #
mk_WebInspectorInspectWebViewCallback :: C_WebInspectorInspectWebViewCallback -> IO (FunPtr C_WebInspectorInspectWebViewCallback) Source #
onWebInspectorInspectWebView :: (IsWebInspector a, MonadIO m) => a -> WebInspectorInspectWebViewCallback -> m SignalHandlerId Source #
wrap_WebInspectorInspectWebViewCallback :: WebInspectorInspectWebViewCallback -> Ptr () -> Ptr WebView -> Ptr () -> IO (Ptr WebView) Source #
showWindow
type WebInspectorShowWindowCallback = IO Bool Source #
afterWebInspectorShowWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorShowWindowCallback -> m SignalHandlerId Source #
mk_WebInspectorShowWindowCallback :: C_WebInspectorShowWindowCallback -> IO (FunPtr C_WebInspectorShowWindowCallback) Source #
onWebInspectorShowWindow :: (IsWebInspector a, MonadIO m) => a -> WebInspectorShowWindowCallback -> m SignalHandlerId Source #
wrap_WebInspectorShowWindowCallback :: WebInspectorShowWindowCallback -> Ptr () -> Ptr () -> IO CInt Source #