diff options
Diffstat (limited to 'Documentation/webkit2gtk-4.0/html/WebKitWebPage.html')
| -rw-r--r-- | Documentation/webkit2gtk-4.0/html/WebKitWebPage.html | 519 |
1 files changed, 519 insertions, 0 deletions
diff --git a/Documentation/webkit2gtk-4.0/html/WebKitWebPage.html b/Documentation/webkit2gtk-4.0/html/WebKitWebPage.html new file mode 100644 index 000000000..d9cb4122b --- /dev/null +++ b/Documentation/webkit2gtk-4.0/html/WebKitWebPage.html @@ -0,0 +1,519 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>WebKitWebPage: WebKit2GTK+ Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="WebKit2GTK+ Reference Manual"> +<link rel="up" href="ch02.html" title="Web Extensions"> +<link rel="prev" href="WebKitWebExtension.html" title="WebKitWebExtension"> +<link rel="next" href="WebKitFrame.html" title="WebKitFrame"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#WebKitWebPage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#WebKitWebPage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#WebKitWebPage.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#WebKitWebPage.signals" class="shortcut">Signals</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="WebKitWebExtension.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="WebKitFrame.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="WebKitWebPage"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="WebKitWebPage.top_of_page"></a>WebKitWebPage</span></h2> +<p>WebKitWebPage</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="WebKitWebPage.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a href="../html/WebKitDOMDocument.html#WebKitDOMDocument-struct"><span class="returnvalue">WebKitDOMDocument</span></a> * +</td> +<td class="function_name"> +<a class="link" href="WebKitWebPage.html#webkit-web-page-get-dom-document" title="webkit_web_page_get_dom_document ()">webkit_web_page_get_dom_document</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +</td> +<td class="function_name"> +<a class="link" href="WebKitWebPage.html#webkit-web-page-get-id" title="webkit_web_page_get_id ()">webkit_web_page_get_id</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="WebKitWebPage.html#webkit-web-page-get-uri" title="webkit_web_page_get_uri ()">webkit_web_page_get_uri</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="WebKitFrame.html" title="WebKitFrame"><span class="returnvalue">WebKitFrame</span></a> * +</td> +<td class="function_name"> +<a class="link" href="WebKitWebPage.html#webkit-web-page-get-main-frame" title="webkit_web_page_get_main_frame ()">webkit_web_page_get_main_frame</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="WebKitWebEditor.html" title="WebKitWebEditor"><span class="returnvalue">WebKitWebEditor</span></a> * +</td> +<td class="function_name"> +<a class="link" href="WebKitWebPage.html#webkit-web-page-get-editor" title="webkit_web_page_get_editor ()">webkit_web_page_get_editor</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="WebKitWebPage.html#WebKitWebPage--uri" title="The “uri” property">uri</a></td> +<td class="property_flags">Read</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.signals"></a><h2>Signals</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="WebKitWebPage.html#WebKitWebPage-console-message-sent" title="The “console-message-sent” signal">console-message-sent</a></td> +<td class="signal_flags">Run Last</td> +</tr> +<tr> +<td class="signal_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> +<td class="signal_name"><a class="link" href="WebKitWebPage.html#WebKitWebPage-context-menu" title="The “context-menu” signal">context-menu</a></td> +<td class="signal_flags">Run Last</td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="WebKitWebPage.html#WebKitWebPage-document-loaded" title="The “document-loaded” signal">document-loaded</a></td> +<td class="signal_flags">Run Last</td> +</tr> +<tr> +<td class="signal_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> +<td class="signal_name"><a class="link" href="WebKitWebPage.html#WebKitWebPage-send-request" title="The “send-request” signal">send-request</a></td> +<td class="signal_flags">Run Last</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="WebKitWebPage.html#WebKitWebPage-struct" title="WebKitWebPage">WebKitWebPage</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> WebKitWebPage +</pre> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="webkit-web-page-get-dom-document"></a><h3>webkit_web_page_get_dom_document ()</h3> +<pre class="programlisting"><a href="../html/WebKitDOMDocument.html#WebKitDOMDocument-struct"><span class="returnvalue">WebKitDOMDocument</span></a> * +webkit_web_page_get_dom_document (<em class="parameter"><code><a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page</code></em>);</pre> +<p>Get the <a href="../html/WebKitDOMDocument.html#WebKitDOMDocument-struct"><span class="type">WebKitDOMDocument</span></a> currently loaded in <em class="parameter"><code>web_page</code></em> +</p> +<div class="refsect3"> +<a name="webkit-web-page-get-dom-document.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-page-get-dom-document.returns"></a><h4>Returns</h4> +<p> the <a href="../html/WebKitDOMDocument.html#WebKitDOMDocument-struct"><span class="type">WebKitDOMDocument</span></a> currently loaded, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> +if no document is currently loaded. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-page-get-id"></a><h3>webkit_web_page_get_id ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +webkit_web_page_get_id (<em class="parameter"><code><a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page</code></em>);</pre> +<p>Get the identifier of the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a></p> +<div class="refsect3"> +<a name="webkit-web-page-get-id.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-page-get-id.returns"></a><h4>Returns</h4> +<p> the identifier of <em class="parameter"><code>web_page</code></em> +</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-page-get-uri"></a><h3>webkit_web_page_get_uri ()</h3> +<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +webkit_web_page_get_uri (<em class="parameter"><code><a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page</code></em>);</pre> +<p>Returns the current active URI of <em class="parameter"><code>web_page</code></em> +.</p> +<p>You can monitor the active URI by connecting to the notify::uri +signal of <em class="parameter"><code>web_page</code></em> +.</p> +<div class="refsect3"> +<a name="webkit-web-page-get-uri.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-page-get-uri.returns"></a><h4>Returns</h4> +<p> the current active URI of <em class="parameter"><code>web_view</code></em> +or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if nothing has been +loaded yet.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-page-get-main-frame"></a><h3>webkit_web_page_get_main_frame ()</h3> +<pre class="programlisting"><a class="link" href="WebKitFrame.html" title="WebKitFrame"><span class="returnvalue">WebKitFrame</span></a> * +webkit_web_page_get_main_frame (<em class="parameter"><code><a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page</code></em>);</pre> +<p>Returns the main frame of a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a>.</p> +<div class="refsect3"> +<a name="webkit-web-page-get-main-frame.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-page-get-main-frame.returns"></a><h4>Returns</h4> +<p> the <a class="link" href="WebKitFrame.html" title="WebKitFrame"><span class="type">WebKitFrame</span></a> that is the main frame of <em class="parameter"><code>web_page</code></em> +. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-page-get-editor"></a><h3>webkit_web_page_get_editor ()</h3> +<pre class="programlisting"><a class="link" href="WebKitWebEditor.html" title="WebKitWebEditor"><span class="returnvalue">WebKitWebEditor</span></a> * +webkit_web_page_get_editor (<em class="parameter"><code><a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page</code></em>);</pre> +<p>Gets the <a class="link" href="WebKitWebEditor.html" title="WebKitWebEditor"><span class="type">WebKitWebEditor</span></a> of a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a>.</p> +<div class="refsect3"> +<a name="webkit-web-page-get-editor.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-page-get-editor.returns"></a><h4>Returns</h4> +<p> the <a class="link" href="WebKitWebEditor.html" title="WebKitWebEditor"><span class="type">WebKitWebEditor</span></a>. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="WebKitWebPage-struct"></a><h3>WebKitWebPage</h3> +<pre class="programlisting">typedef struct _WebKitWebPage WebKitWebPage;</pre> +</div> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="WebKitWebPage--uri"></a><h3>The <code class="literal">“uri”</code> property</h3> +<pre class="programlisting"> “uri” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The current active URI of the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a>.</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +</div> +</div> +<div class="refsect1"> +<a name="WebKitWebPage.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="WebKitWebPage-console-message-sent"></a><h3>The <code class="literal">“console-message-sent”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page, + <a class="link" href="WebKitConsoleMessage.html" title="WebKitConsoleMessage"><span class="type">WebKitConsoleMessage</span></a> *console_message, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Emmited 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 <em class="parameter"><code>console_message</code></em> + contains information of the message.</p> +<div class="refsect3"> +<a name="WebKitWebPage-console-message-sent.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> on which the signal is emitted</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>console_message</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitConsoleMessage.html" title="WebKitConsoleMessage"><span class="type">WebKitConsoleMessage</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: Run Last</p> +<p class="since">Since: <a class="link" href="api-index-2-12.html#api-index-2.12">2.12</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebPage-context-menu"></a><h3>The <code class="literal">“context-menu”</code> signal</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +user_function (<a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page, + <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a> *context_menu, + <a class="link" href="WebKitWebHitTestResult.html" title="WebKitWebHitTestResult"><span class="type">WebKitWebHitTestResult</span></a> *hit_test_result, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Emmited 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 <a href="../html/WebKitDOMNode.html#WebKitDOMNode-struct"><span class="type">WebKitDOMNode</span></a> at the coordinates of the +<em class="parameter"><code>hit_test_result</code></em> +. Otherwise, it's recommened to use <a class="link" href="WebKitWebView.html#WebKitWebView-context-menu" title="The “context-menu” signal"><span class="type">“context-menu”</span></a> +signal instead.</p> +<div class="refsect3"> +<a name="WebKitWebPage-context-menu.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> on which the signal is emitted</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>context_menu</p></td> +<td class="parameter_description"><p>the proposed <a class="link" href="WebKitContextMenu.html" title="WebKitContextMenu"><span class="type">WebKitContextMenu</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>hit_test_result</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebHitTestResult.html" title="WebKitWebHitTestResult"><span class="type">WebKitWebHitTestResult</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="WebKitWebPage-context-menu.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the proposed <em class="parameter"><code>context_menu</code></em> +has been modified, or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p> +</div> +<p>Flags: Run Last</p> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebPage-document-loaded"></a><h3>The <code class="literal">“document-loaded”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted when the DOM document of a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> has been +loaded.</p> +<p>You can wait for this signal to get the DOM document with +<a class="link" href="WebKitWebPage.html#webkit-web-page-get-dom-document" title="webkit_web_page_get_dom_document ()"><code class="function">webkit_web_page_get_dom_document()</code></a>.</p> +<div class="refsect3"> +<a name="WebKitWebPage-document-loaded.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> on which the signal is emitted</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: Run Last</p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebPage-send-request"></a><h3>The <code class="literal">“send-request”</code> signal</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +user_function (<a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> *web_page, + <a class="link" href="WebKitURIRequest.html" title="WebKitURIRequest"><span class="type">WebKitURIRequest</span></a> *request, + <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a> *redirected_response, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted when <em class="parameter"><code>request</code></em> + is about to be sent to +the server. This signal can be used to modify the <a class="link" href="WebKitURIRequest.html" title="WebKitURIRequest"><span class="type">WebKitURIRequest</span></a> +that will be sent to the server. You can also cancel the resource load +operation by connecting to this signal and returning <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p> +<p>In case of a server redirection this signal is +emitted again with the <em class="parameter"><code>request</code></em> + argument containing the new +request to be sent to the server due to the redirection and the +<em class="parameter"><code>redirected_response</code></em> + parameter containing the response +received by the server for the initial request.</p> +<div class="refsect3"> +<a name="WebKitWebPage-send-request.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>web_page</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> on which the signal is emitted</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>request</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitURIRequest.html" title="WebKitURIRequest"><span class="type">WebKitURIRequest</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>redirected_response</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="WebKitWebPage-send-request.returns"></a><h4>Returns</h4> +<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked for the event. +<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to continue emission of the event.</p> +</div> +<p>Flags: Run Last</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file |