diff options
Diffstat (limited to 'Documentation/webkitgtk/html/WebKitFaviconDatabase.html')
| -rw-r--r-- | Documentation/webkitgtk/html/WebKitFaviconDatabase.html | 562 |
1 files changed, 0 insertions, 562 deletions
diff --git a/Documentation/webkitgtk/html/WebKitFaviconDatabase.html b/Documentation/webkitgtk/html/WebKitFaviconDatabase.html deleted file mode 100644 index 2003c8c94..000000000 --- a/Documentation/webkitgtk/html/WebKitFaviconDatabase.html +++ /dev/null @@ -1,562 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>WebKitFaviconDatabase: WebKitGTK+ Reference Manual</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> -<link rel="home" href="index.html" title="WebKitGTK+ Reference Manual"> -<link rel="up" href="ch02.html" title="Class Overview"> -<link rel="prev" href="WebKitSpellChecker.html" title="WebKitSpellChecker"> -<link rel="next" href="WebKitFileChooserRequest.html" title="WebKitFileChooserRequest"> -<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="#WebKitFaviconDatabase.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#WebKitFaviconDatabase.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#WebKitFaviconDatabase.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#WebKitFaviconDatabase.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="WebKitSpellChecker.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="WebKitFileChooserRequest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="WebKitFaviconDatabase"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="WebKitFaviconDatabase.top_of_page"></a>WebKitFaviconDatabase</span></h2> -<p>WebKitFaviconDatabase — A WebKit favicon database</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.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"> -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-clear" title="webkit_favicon_database_clear ()">webkit_favicon_database_clear</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-favicon-pixbuf" title="webkit_favicon_database_get_favicon_pixbuf ()">webkit_favicon_database_get_favicon_pixbuf</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="returnvalue">GdkPixbuf</span></a> * -</td> -<td class="function_name"> -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-favicon-pixbuf-finish" title="webkit_favicon_database_get_favicon_pixbuf_finish ()">webkit_favicon_database_get_favicon_pixbuf_finish</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * -</td> -<td class="function_name"> -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-favicon-uri" title="webkit_favicon_database_get_favicon_uri ()">webkit_favicon_database_get_favicon_uri</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="WebKitFaviconDatabase.html#webkit-favicon-database-get-path" title="webkit_favicon_database_get_path ()">webkit_favicon_database_get_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> -</td> -<td class="function_name"> -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-type" title="webkit_favicon_database_get_type ()">webkit_favicon_database_get_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-set-path" title="webkit_favicon_database_set_path ()">webkit_favicon_database_set_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="returnvalue">GdkPixbuf</span></a> * -</td> -<td class="function_name"> -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-try-get-favicon-pixbuf" title="webkit_favicon_database_try_get_favicon_pixbuf ()">webkit_favicon_database_try_get_favicon_pixbuf</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.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="WebKitFaviconDatabase.html#WebKitFaviconDatabase--path" title="The “path” property">path</a></td> -<td class="property_flags">Read / Write</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.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="WebKitFaviconDatabase.html#WebKitFaviconDatabase-icon-loaded" title="The “icon-loaded” signal">icon-loaded</a></td> -<td class="signal_flags">Run Last</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.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="WebKitFaviconDatabase.html#WebKitFaviconDatabase-struct" title="WebKitFaviconDatabase">WebKitFaviconDatabase</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.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> WebKitFaviconDatabase -</pre> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.description"></a><h2>Description</h2> -<p><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> provides access to the icons associated with -web sites.</p> -<p>WebKit will automatically look for available icons in link elements -on opened pages as well as an existing favicon.ico and load the -images found into a memory cache if possible. That cache is frozen -to an on-disk database for persistence.</p> -<p>The database is disabled by default. In order for icons to be -stored and accessed, you will need to set an icon database path -using <a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-set-path" title="webkit_favicon_database_set_path ()"><code class="function">webkit_favicon_database_set_path()</code></a>. Disable the database -again passing <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to the previous call.</p> -<p>If WebKitWebSettings::enable-private-browsing is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> new icons -won't be added to the on-disk database and no existing icons will -be deleted from it. Nevertheless, WebKit will still store them in -the in-memory cache during the current execution.</p> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="webkit-favicon-database-clear"></a><h3>webkit_favicon_database_clear ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_favicon_database_clear (<em class="parameter"><code><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database</code></em>);</pre> -<p>Clears all icons from the database.</p> -<div class="refsect3"> -<a name="webkit-favicon-database-clear.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>database</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 1.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-favicon-database-get-favicon-pixbuf"></a><h3>webkit_favicon_database_get_favicon_pixbuf ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_favicon_database_get_favicon_pixbuf - (<em class="parameter"><code><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *page_uri</code></em>, - <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>, - <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>, - <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, - <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>, - <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> -<p>Asynchronously obtains a <a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> of the favicon for the given -page URI. The advantage of this method over -<a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-try-get-favicon-pixbuf" title="webkit_favicon_database_try_get_favicon_pixbuf ()"><code class="function">webkit_favicon_database_try_get_favicon_pixbuf()</code></a> is that it always returns the -cached icon if it's in the database asynchronously waiting for the -icon to be read from the database.</p> -<p>This is an asynchronous method. When the operation is finished, callback will -be invoked. You can then call <a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-favicon-pixbuf-finish" title="webkit_favicon_database_get_favicon_pixbuf_finish ()"><code class="function">webkit_favicon_database_get_favicon_pixbuf_finish()</code></a> -to get the result of the operation. -See also <a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-try-get-favicon-pixbuf" title="webkit_favicon_database_try_get_favicon_pixbuf ()"><code class="function">webkit_favicon_database_try_get_favicon_pixbuf()</code></a>.</p> -<p>If <em class="parameter"><code>width</code></em> - and <em class="parameter"><code>height</code></em> - are both 0 then this method will return the -maximum available size for the icon. Note that if you specify a -different size the icon will be scaled each time you call this -function.</p> -<div class="refsect3"> -<a name="webkit-favicon-database-get-favicon-pixbuf.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>database</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>page_uri</p></td> -<td class="parameter_description"><p>URI of the page containing the icon</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>width</p></td> -<td class="parameter_description"><p>the desired width for the icon</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>height</p></td> -<td class="parameter_description"><p>the desired height for the icon</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p> A <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p> A <a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is -satisfied or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if you don't care about the result. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>The data to pass to <em class="parameter"><code>callback</code></em> -.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 1.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-favicon-database-get-favicon-pixbuf-finish"></a><h3>webkit_favicon_database_get_favicon_pixbuf_finish ()</h3> -<pre class="programlisting"><a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="returnvalue">GdkPixbuf</span></a> * -webkit_favicon_database_get_favicon_pixbuf_finish - (<em class="parameter"><code><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database</code></em>, - <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>, - <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> -<p>Finishes an operation started with <a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-favicon-pixbuf" title="webkit_favicon_database_get_favicon_pixbuf ()"><code class="function">webkit_favicon_database_get_favicon_pixbuf()</code></a>.</p> -<div class="refsect3"> -<a name="webkit-favicon-database-get-favicon-pixbuf-finish.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>database</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>result</p></td> -<td class="parameter_description"><p>A <a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> obtained from the <a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> passed to <a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-favicon-pixbuf" title="webkit_favicon_database_get_favicon_pixbuf ()"><code class="function">webkit_favicon_database_get_favicon_pixbuf()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p> Return location for error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="webkit-favicon-database-get-favicon-pixbuf-finish.returns"></a><h4>Returns</h4> -<p> a new reference to a <a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 1.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-favicon-database-get-favicon-uri"></a><h3>webkit_favicon_database_get_favicon_uri ()</h3> -<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * -webkit_favicon_database_get_favicon_uri - (<em class="parameter"><code><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *page_uri</code></em>);</pre> -<p>Obtains the URI for the favicon for the given page URI. -See also <a class="link" href="webkitgtk-webkitwebview.html#webkit-web-view-get-icon-uri" title="webkit_web_view_get_icon_uri ()"><code class="function">webkit_web_view_get_icon_uri()</code></a>.</p> -<div class="refsect3"> -<a name="webkit-favicon-database-get-favicon-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>database</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>page_uri</p></td> -<td class="parameter_description"><p>URI of the page containing the icon</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="webkit-favicon-database-get-favicon-uri.returns"></a><h4>Returns</h4> -<p> a newly allocated URI for the favicon, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> -</div> -<p class="since">Since: 1.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-favicon-database-get-path"></a><h3>webkit_favicon_database_get_path ()</h3> -<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * -webkit_favicon_database_get_path (<em class="parameter"><code><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database</code></em>);</pre> -<p>Determines the absolute path to the database folder on disk.</p> -<div class="refsect3"> -<a name="webkit-favicon-database-get-path.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>database</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="webkit-favicon-database-get-path.returns"></a><h4>Returns</h4> -<p> the absolute path of the database folder, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> -</div> -<p class="since">Since: 1.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-favicon-database-get-type"></a><h3>webkit_favicon_database_get_type ()</h3> -<pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> -webkit_favicon_database_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-favicon-database-set-path"></a><h3>webkit_favicon_database_set_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_favicon_database_set_path (<em class="parameter"><code><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre> -<p>Specifies the absolute path to the database folder on disk. The -icon database will only be enabled after a call to this method.</p> -<p>Passing <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or "" as path disables the icon database.</p> -<div class="refsect3"> -<a name="webkit-favicon-database-set-path.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>database</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p> an absolute path to the icon database folder -or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to disable the database. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 1.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-favicon-database-try-get-favicon-pixbuf"></a><h3>webkit_favicon_database_try_get_favicon_pixbuf ()</h3> -<pre class="programlisting"><a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="returnvalue">GdkPixbuf</span></a> * -webkit_favicon_database_try_get_favicon_pixbuf - (<em class="parameter"><code><a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *page_uri</code></em>, - <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>, - <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre> -<p>Obtains a <a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> of the favicon for the given page URI, or -<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no icon for the given page or it hasn't been -loaded from disk yet. Use <a class="link" href="WebKitFaviconDatabase.html#webkit-favicon-database-get-favicon-uri" title="webkit_favicon_database_get_favicon_uri ()"><code class="function">webkit_favicon_database_get_favicon_uri()</code></a> -if you need to distinguish these cases. To make sure this method -will return a valid icon when the given URI has one, you should -connect to <a class="link" href="WebKitFaviconDatabase.html#WebKitFaviconDatabase-icon-loaded" title="The “icon-loaded” signal"><span class="type">“icon-loaded”</span></a> and use this function -in the callback.</p> -<p>If <em class="parameter"><code>width</code></em> - and <em class="parameter"><code>height</code></em> - ar both 0 then this method will return the -maximum available size for the icon. Note that if you specify a -different size the icon will be scaled each time you call this -function.</p> -<div class="refsect3"> -<a name="webkit-favicon-database-try-get-favicon-pixbuf.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>database</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>page_uri</p></td> -<td class="parameter_description"><p>URI of the page containing the icon</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>width</p></td> -<td class="parameter_description"><p>the desired width for the icon</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>height</p></td> -<td class="parameter_description"><p>the desired height for the icon</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="webkit-favicon-database-try-get-favicon-pixbuf.returns"></a><h4>Returns</h4> -<p> a new reference to a <a href="../gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> -if the given URI doesn't have an icon or it hasn't been loaded yet. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 1.8</p> -</div> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="WebKitFaviconDatabase-struct"></a><h3>WebKitFaviconDatabase</h3> -<pre class="programlisting">typedef struct _WebKitFaviconDatabase WebKitFaviconDatabase;</pre> -<p> -</p> -</div> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="WebKitFaviconDatabase--path"></a><h3>The <code class="literal">“path”</code> property</h3> -<pre class="programlisting"> “path” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> -<p>The absolute path of the icon database folder.</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -<p class="since">Since: 1.8</p> -</div> -</div> -<div class="refsect1"> -<a name="WebKitFaviconDatabase.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="WebKitFaviconDatabase-icon-loaded"></a><h3>The <code class="literal">“icon-loaded”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"><span class="type">WebKitFaviconDatabase</span></a> *database, - <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *frame_uri, - <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> -<p>This signal is fired if an icon is loaded on any -<a class="link" href="webkitgtk-webkitwebview.html#WebKitWebView"><span class="type">WebKitWebView</span></a>. If you are only interested in a particular -<a class="link" href="webkitgtk-webkitwebview.html#WebKitWebView"><span class="type">WebKitWebView</span></a> see <a class="link" href="webkitgtk-webkitwebview.html#WebKitWebView-icon-loaded" title="The “icon-loaded” signal"><span class="type">“icon-loaded”</span></a>.</p> -<p>Note that this signal carries the URI of the frame that loads -the icon, while <a class="link" href="webkitgtk-webkitwebview.html#WebKitWebView-icon-loaded" title="The “icon-loaded” signal"><span class="type">“icon-loaded”</span></a> provides the URI -of the favicon.</p> -<div class="refsect3"> -<a name="WebKitFaviconDatabase-icon-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>database</p></td> -<td class="parameter_description"><p>the object on which the signal is emitted</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>frame_uri</p></td> -<td class="parameter_description"><p>the URI of the main frame of a Web page containing -the icon</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: 1.8</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.25.1</div> -</body> -</html>
\ No newline at end of file |