summaryrefslogtreecommitdiff
path: root/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp
diff options
context:
space:
mode:
authorAllan Sandfeld Jensen <allan.jensen@digia.com>2013-09-13 12:51:20 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-09-19 20:50:05 +0200
commitd441d6f39bb846989d95bcf5caf387b42414718d (patch)
treee367e64a75991c554930278175d403c072de6bb8 /Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp
parent0060b2994c07842f4c59de64b5e3e430525c4b90 (diff)
downloadqtwebkit-d441d6f39bb846989d95bcf5caf387b42414718d.tar.gz
Import Qt5x2 branch of QtWebkit for Qt 5.2
Importing a new snapshot of webkit. Change-Id: I2d01ad12cdc8af8cb015387641120a9d7ea5f10c Reviewed-by: Allan Sandfeld Jensen <allan.jensen@digia.com>
Diffstat (limited to 'Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp')
-rw-r--r--Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp29
1 files changed, 29 insertions, 0 deletions
diff --git a/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp b/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp
index 378a1f4c0..3839ad3e2 100644
--- a/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp
+++ b/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp
@@ -29,6 +29,35 @@
using namespace WebKit;
+/**
+ * SECTION: WebKitWebInspector
+ * @Short_description: Access to the WebKit inspector
+ * @Title: WebKitWebInspector
+ *
+ * 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.
+ *
+ * <informalexample><programlisting>
+ * /<!-- -->* Enable the developer extras *<!-- -->/
+ * WebKitSettings *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_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));
+ * </programlisting></informalexample>
+ *
+ */
+
enum {
OPEN_WINDOW,
BRING_TO_FRONT,