diff options
Diffstat (limited to 'Documentation/webkit2gtk-4.0/html/WebKitWebExtension.html')
| -rw-r--r-- | Documentation/webkit2gtk-4.0/html/WebKitWebExtension.html | 378 |
1 files changed, 378 insertions, 0 deletions
diff --git a/Documentation/webkit2gtk-4.0/html/WebKitWebExtension.html b/Documentation/webkit2gtk-4.0/html/WebKitWebExtension.html new file mode 100644 index 000000000..17b79f929 --- /dev/null +++ b/Documentation/webkit2gtk-4.0/html/WebKitWebExtension.html @@ -0,0 +1,378 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>WebKitWebExtension: 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="ch02.html" title="Web Extensions"> +<link rel="next" href="WebKitWebPage.html" title="WebKitWebPage"> +<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="#WebKitWebExtension.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#WebKitWebExtension.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#WebKitWebExtension.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="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="WebKitWebPage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="WebKitWebExtension"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="WebKitWebExtension.top_of_page"></a>WebKitWebExtension</span></h2> +<p>WebKitWebExtension — Represents a WebExtension of the WebProcess</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="WebKitWebExtension.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"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="WebKitWebExtension.html#WebKitWebExtensionInitializeFunction" title="WebKitWebExtensionInitializeFunction ()">*WebKitWebExtensionInitializeFunction</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="WebKitWebExtension.html#WebKitWebExtensionInitializeWithUserDataFunction" title="WebKitWebExtensionInitializeWithUserDataFunction ()">*WebKitWebExtensionInitializeWithUserDataFunction</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="returnvalue">WebKitWebPage</span></a> * +</td> +<td class="function_name"> +<a class="link" href="WebKitWebExtension.html#webkit-web-extension-get-page" title="webkit_web_extension_get_page ()">webkit_web_extension_get_page</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebExtension.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="WebKitWebExtension.html#WebKitWebExtension-page-created" title="The “page-created” signal">page-created</a></td> +<td class="signal_flags">Run Last</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebExtension.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">struct</td> +<td class="function_name"><a class="link" href="WebKitWebExtension.html#WebKitWebExtension-struct" title="struct WebKitWebExtension">WebKitWebExtension</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebExtension.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> WebKitWebExtension +</pre> +</div> +<div class="refsect1"> +<a name="WebKitWebExtension.description"></a><h2>Description</h2> +<p>WebKitWebExtension is a loadable module for the WebProcess. It allows you to execute code in the +WebProcess and being able to use the DOM API, to change any request or to inject custom +JavaScript code, for example.</p> +<p>To create a WebKitWebExtension you should write a module with an initialization function that could +be either <code class="function">webkit_web_extension_initialize()</code> with prototype <a class="link" href="WebKitWebExtension.html#WebKitWebExtensionInitializeFunction" title="WebKitWebExtensionInitializeFunction ()"><span class="type">WebKitWebExtensionInitializeFunction</span></a> or +<code class="function">webkit_web_extension_initialize_with_user_data()</code> with prototype <a class="link" href="WebKitWebExtension.html#WebKitWebExtensionInitializeWithUserDataFunction" title="WebKitWebExtensionInitializeWithUserDataFunction ()"><span class="type">WebKitWebExtensionInitializeWithUserDataFunction</span></a>. +This function has to be public and it has to use the <a href="../glib/glib-Dynamic-Loading-of-Modules.html#G-MODULE-EXPORT:CAPS"><span class="type">G_MODULE_EXPORT</span></a> macro. It is called when the +web process is initialized.</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="type">static</span> <span class="type">void</span> +web_page_created_callback (WebKitWebExtension *extension, + WebKitWebPage *web_page, + gpointer user_data) +{ + g_print (<span class="number">"Page </span><span class="symbol">%d</span><span class="number"> created for </span><span class="symbol">%s</span><span class="symbol">\n</span><span class="number">"</span>, + webkit_web_page_get_id (web_page), + webkit_web_page_get_uri (web_page)); +} + +G_MODULE_EXPORT <span class="type">void</span> +webkit_web_extension_initialize (WebKitWebExtension *extension) +{ + g_signal_connect (extension, <span class="number">"page-created"</span>, + G_CALLBACK (web_page_created_callback), + <span class="number">NULL</span>); +}</pre></td> + </tr> + </tbody> + </table> +</div> + +<p>The previous piece of code shows a trivial example of an extension that notifies when +a <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> is created.</p> +<p>WebKit has to know where it can find the created WebKitWebExtension. To do so you +should use the <a class="link" href="WebKitWebContext.html#webkit-web-context-set-web-extensions-directory" title="webkit_web_context_set_web_extensions_directory ()"><code class="function">webkit_web_context_set_web_extensions_directory()</code></a> function. The signal +<a class="link" href="WebKitWebContext.html#WebKitWebContext-initialize-web-extensions" title="The “initialize-web-extensions” signal"><span class="type">“initialize-web-extensions”</span></a> is the recommended place to call it.</p> +<p>To provide the initialization data used by the <code class="function">webkit_web_extension_initialize_with_user_data()</code> +function, you have to call <a class="link" href="WebKitWebContext.html#webkit-web-context-set-web-extensions-initialization-user-data" title="webkit_web_context_set_web_extensions_initialization_user_data ()"><code class="function">webkit_web_context_set_web_extensions_initialization_user_data()</code></a> with +the desired data as parameter. You can see an example of this in the following piece of code:</p> +<div class="informalexample"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="preproc">#define WEB_EXTENSIONS_DIRECTORY </span><span class="comment">/*</span><span class="comment"> ... </span><span class="comment">*/</span> + +<span class="type">static</span> <span class="type">void</span> +initialize_web_extensions (WebKitWebContext *context, + gpointer user_data) +{ + <span class="comment">/*</span><span class="comment"> Web Extensions get a different ID for each Web Process </span><span class="comment">*/</span> + <span class="type">static</span> guint32 unique_id = <span class="number">0</span>; + + webkit_web_context_set_web_extensions_directory ( + context, WEB_EXTENSIONS_DIRECTORY); + webkit_web_context_set_web_extensions_initialization_user_data ( + context, g_variant_new_uint32 (unique_id++)); +} + +<span class="type">int</span> main (<span class="type">int</span> argc, <span class="type">char</span> **argv) +{ + g_signal_connect (webkit_web_context_get_default (), + <span class="number">"initialize-web-extensions"</span>, + G_CALLBACK (initialize_web_extensions), + <span class="number">NULL</span>); + + GtkWidget *view = webkit_web_view_new (); + + <span class="comment">/*</span><span class="comment"> ... </span><span class="comment">*/</span> +}</pre></td> + </tr> + </tbody> + </table> +</div> + +</div> +<div class="refsect1"> +<a name="WebKitWebExtension.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="WebKitWebExtensionInitializeFunction"></a><h3>WebKitWebExtensionInitializeFunction ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*WebKitWebExtensionInitializeFunction<span class="c_punctuation">)</span> + (<em class="parameter"><code><a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</span></a> *extension</code></em>);</pre> +<p>Type definition for a function that will be called to initialize +the web extension when the web process starts.</p> +<div class="refsect3"> +<a name="WebKitWebExtensionInitializeFunction.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>extension</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebExtensionInitializeWithUserDataFunction"></a><h3>WebKitWebExtensionInitializeWithUserDataFunction ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*WebKitWebExtensionInitializeWithUserDataFunction<span class="c_punctuation">)</span> + (<em class="parameter"><code><a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</span></a> *extension</code></em>, + <em class="parameter"><code>const <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *user_data</code></em>);</pre> +<p>Type definition for a function that will be called to initialize +the web extensions when the web process starts, and which receives +as additional argument the user data set with +<a class="link" href="WebKitWebContext.html#webkit-web-context-set-web-extensions-initialization-user-data" title="webkit_web_context_set_web_extensions_initialization_user_data ()"><code class="function">webkit_web_context_set_web_extensions_initialization_user_data()</code></a>.</p> +<div class="refsect3"> +<a name="WebKitWebExtensionInitializeWithUserDataFunction.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>extension</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</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>a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-extension-get-page"></a><h3>webkit_web_extension_get_page ()</h3> +<pre class="programlisting"><a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="returnvalue">WebKitWebPage</span></a> * +webkit_web_extension_get_page (<em class="parameter"><code><a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</span></a> *extension</code></em>, + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> page_id</code></em>);</pre> +<p>Get the web page of the given <em class="parameter"><code>page_id</code></em> +.</p> +<div class="refsect3"> +<a name="webkit-web-extension-get-page.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>extension</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>page_id</p></td> +<td class="parameter_description"><p>the identifier of the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> to get</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-extension-get-page.returns"></a><h4>Returns</h4> +<p> the <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> for the given <em class="parameter"><code>page_id</code></em> +, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the +identifier doesn't correspond to an exsiting web page. </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> +</div> +<div class="refsect1"> +<a name="WebKitWebExtension.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="WebKitWebExtension-struct"></a><h3>struct WebKitWebExtension</h3> +<pre class="programlisting">struct WebKitWebExtension;</pre> +</div> +</div> +<div class="refsect1"> +<a name="WebKitWebExtension.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="WebKitWebExtension-page-created"></a><h3>The <code class="literal">“page-created”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</span></a> *extension, + <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 a new <a class="link" href="WebKitWebPage.html" title="WebKitWebPage"><span class="type">WebKitWebPage</span></a> is created in +the Web Process.</p> +<div class="refsect3"> +<a name="WebKitWebExtension-page-created.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>extension</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebExtension.html" title="WebKitWebExtension"><span class="type">WebKitWebExtension</span></a> on which the signal is emitted</p></td> +<td class="parameter_annotations"> </td> +</tr> +<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> created</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> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file |