diff options
Diffstat (limited to 'Documentation/webkitgtk/html/webkitgtk-webkitdownload.html')
| -rw-r--r-- | Documentation/webkitgtk/html/webkitgtk-webkitdownload.html | 910 |
1 files changed, 0 insertions, 910 deletions
diff --git a/Documentation/webkitgtk/html/webkitgtk-webkitdownload.html b/Documentation/webkitgtk/html/webkitgtk-webkitdownload.html deleted file mode 100644 index f4bfbe8a6..000000000 --- a/Documentation/webkitgtk/html/webkitgtk-webkitdownload.html +++ /dev/null @@ -1,910 +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>WebKitGTK+ Reference Manual: WebKitDownload</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="WebKitGTK+ Reference Manual"> -<link rel="up" href="ch02.html" title="Class Overview"> -<link rel="prev" href="WebKitWebResource.html" title="WebKitWebResource"> -<link rel="next" href="WebKitViewportAttributes.html" title="WebKitViewportAttributes"> -<meta name="generator" content="GTK-Doc V1.21.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="#webkitgtk-webkitdownload.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#webkitgtk-webkitdownload.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#webkitgtk-webkitdownload.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#webkitgtk-webkitdownload.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="WebKitWebResource.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="WebKitViewportAttributes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="webkitgtk-webkitdownload"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="webkitgtk-webkitdownload.top_of_page"></a>WebKitDownload</span></h2> -<p>WebKitDownload — Object used to communicate with the application when downloading.</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.functions"></a><h2>Functions</h2> -<div class="informaltable"><table 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="webkitgtk-webkitdownload.html#webkit-download-cancel" title="webkit_download_cancel ()">webkit_download_cancel</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="webkitgtk-webkitdownload.html#webkit-download-get-current-size" title="webkit_download_get_current_size ()">webkit_download_get_current_size</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="webkitgtk-webkitdownload.html#webkit-download-get-destination-uri" title="webkit_download_get_destination_uri ()">webkit_download_get_destination_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> -</td> -<td class="function_name"> -<a class="link" href="webkitgtk-webkitdownload.html#webkit-download-get-elapsed-time" title="webkit_download_get_elapsed_time ()">webkit_download_get_elapsed_time</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="returnvalue">WebKitNetworkRequest</span></a> * -</td> -<td class="function_name"> -<a class="link" href="webkitgtk-webkitdownload.html#webkit-download-get-network-request" title="webkit_download_get_network_request ()">webkit_download_get_network_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="WebKitNetworkResponse.html" title="WebKitNetworkResponse"><span class="returnvalue">WebKitNetworkResponse</span></a> * -</td> -<td class="function_name"> -<a class="link" href="webkitgtk-webkitdownload.html#webkit-download-get-network-response" title="webkit_download_get_network_response ()">webkit_download_get_network_response</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> -</td> -<td class="function_name"> -<a class="link" href="webkitgtk-webkitdownload.html#webkit-download-get-progress" title="webkit_download_get_progress ()">webkit_download_get_progress</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadStatus" title="enum WebKitDownloadStatus"><span class="returnvalue">WebKitDownloadStatus</span></a> -</td> -<td class="function_name"> -<a class="link" href="webkitgtk-webkitdownload.html#webkit-download-get-status" title="webkit_download_get_status ()">webkit_download_get_status</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="webkitgtk-webkitdownload.html#webkit-download-get-suggested-filename" title="webkit_download_get_suggested_filename ()">webkit_download_get_suggested_filename</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="webkitgtk-webkitdownload.html#webkit-download-get-total-size" title="webkit_download_get_total_size ()">webkit_download_get_total_size</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="webkitgtk-webkitdownload.html#webkit-download-get-uri" title="webkit_download_get_uri ()">webkit_download_get_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="returnvalue">WebKitDownload</span></a> * -</td> -<td class="function_name"> -<a class="link" href="webkitgtk-webkitdownload.html#webkit-download-new" title="webkit_download_new ()">webkit_download_new</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="webkitgtk-webkitdownload.html#webkit-download-set-destination-uri" title="webkit_download_set_destination_uri ()">webkit_download_set_destination_uri</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="webkitgtk-webkitdownload.html#webkit-download-start" title="webkit_download_start ()">webkit_download_start</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.properties"></a><h2>Properties</h2> -<div class="informaltable"><table 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#guint64"><span class="type">guint64</span></a></td> -<td class="property_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload--current-size" title="The “current-size” property">current-size</a></td> -<td class="property_flags">Read</td> -</tr> -<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="webkitgtk-webkitdownload.html#WebKitDownload--destination-uri" title="The “destination-uri” property">destination-uri</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> *</td> -<td class="property_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload--network-request" title="The “network-request” property">network-request</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="WebKitNetworkResponse.html" title="WebKitNetworkResponse"><span class="type">WebKitNetworkResponse</span></a> *</td> -<td class="property_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload--network-response" title="The “network-response” property">network-response</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> -<td class="property_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload--progress" title="The “progress” property">progress</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadStatus" title="enum WebKitDownloadStatus"><span class="type">WebKitDownloadStatus</span></a></td> -<td class="property_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload--status" title="The “status” property">status</a></td> -<td class="property_flags">Read</td> -</tr> -<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="webkitgtk-webkitdownload.html#WebKitDownload--suggested-filename" title="The “suggested-filename” property">suggested-filename</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> -<td class="property_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload--total-size" title="The “total-size” property">total-size</a></td> -<td class="property_flags">Read</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.signals"></a><h2>Signals</h2> -<div class="informaltable"><table 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"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> -<td class="signal_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload-error" title="The “error” signal">error</a></td> -<td class="signal_flags">Run Last</td> -</tr></tbody> -</table></div> -</div> -<a name="WebKitDownload"></a><div class="refsect1"> -<a name="webkitgtk-webkitdownload.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="150px" class="name"> -<col class="description"> -</colgroup> -<tbody> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadError" title="enum WebKitDownloadError">WebKitDownloadError</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadStatus" title="enum WebKitDownloadStatus">WebKitDownloadStatus</a></td> -</tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload-struct" title="WebKitDownload">WebKitDownload</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> - <span class="lineart">╰──</span> WebKitDownload -</pre> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.description"></a><h2>Description</h2> -<p><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> carries information about a download request, -including a <a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> object. The application may use -this object to control the download process, or to simply figure -out what is to be downloaded, and do it itself.</p> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="webkit-download-cancel"></a><h3>webkit_download_cancel ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_download_cancel (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Cancels the download. Calling this will not free the -<a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> object, so you still need to call -<a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> on it, if you are the owner of a reference. Notice -that cancelling the download provokes the emission of the -WebKitDownload::error signal, reporting that the download was -cancelled.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.2.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-current-size"></a><h3>webkit_download_get_current_size ()</h3> -<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> -webkit_download_get_current_size (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Current already downloaded size.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.3.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.3.6"></a><h4>Returns</h4> -<p> the already downloaded size</p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-destination-uri"></a><h3>webkit_download_get_destination_uri ()</h3> -<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * -webkit_download_get_destination_uri (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Obtains the URI to which the downloaded file will be written. This -must have been set by the application before calling -<a class="link" href="webkitgtk-webkitdownload.html#webkit-download-start" title="webkit_download_start ()"><code class="function">webkit_download_start()</code></a>, and may be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.4.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.4.6"></a><h4>Returns</h4> -<p> the destination URI or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-elapsed-time"></a><h3>webkit_download_get_elapsed_time ()</h3> -<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> -webkit_download_get_elapsed_time (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Elapsed time for the download in seconds, including any fractional -part. If the download is finished, had an error or was cancelled -this is the time between its start and the event.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.5.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>a <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.5.6"></a><h4>Returns</h4> -<p> seconds since the download was started, as a <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-network-request"></a><h3>webkit_download_get_network_request ()</h3> -<pre class="programlisting"><a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="returnvalue">WebKitNetworkRequest</span></a> * -webkit_download_get_network_request (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Retrieves the <a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> object that backs the download -process.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.6.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.6.6"></a><h4>Returns</h4> -<p> the <a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> instance. </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 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-network-response"></a><h3>webkit_download_get_network_response ()</h3> -<pre class="programlisting"><a class="link" href="WebKitNetworkResponse.html" title="WebKitNetworkResponse"><span class="returnvalue">WebKitNetworkResponse</span></a> * -webkit_download_get_network_response (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Retrieves the <a class="link" href="WebKitNetworkResponse.html" title="WebKitNetworkResponse"><span class="type">WebKitNetworkResponse</span></a> object that backs the download -process.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.7.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.7.6"></a><h4>Returns</h4> -<p> the <a class="link" href="WebKitNetworkResponse.html" title="WebKitNetworkResponse"><span class="type">WebKitNetworkResponse</span></a> instance. </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 1.1.16</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-progress"></a><h3>webkit_download_get_progress ()</h3> -<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> -webkit_download_get_progress (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Determines the current progress of the download.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.8.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>a <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.8.6"></a><h4>Returns</h4> -<p> a <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> ranging from 0.0 to 1.0.</p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-status"></a><h3>webkit_download_get_status ()</h3> -<pre class="programlisting"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadStatus" title="enum WebKitDownloadStatus"><span class="returnvalue">WebKitDownloadStatus</span></a> -webkit_download_get_status (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Obtains the current status of the download, as a -<a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadStatus" title="enum WebKitDownloadStatus"><span class="type">WebKitDownloadStatus</span></a>.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.9.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.9.6"></a><h4>Returns</h4> -<p> the current <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadStatus" title="enum WebKitDownloadStatus"><span class="type">WebKitDownloadStatus</span></a></p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-suggested-filename"></a><h3>webkit_download_get_suggested_filename ()</h3> -<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * -webkit_download_get_suggested_filename - (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Retrieves the filename that was suggested by the server, or the one -derived by WebKit from the URI.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.10.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.10.6"></a><h4>Returns</h4> -<p> the suggested filename</p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-total-size"></a><h3>webkit_download_get_total_size ()</h3> -<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> -webkit_download_get_total_size (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Returns the expected total size of the download. This is expected -because the server may provide incorrect or missing -Content-Length. Notice that this may grow over time, as it will be -always the same as current_size in the cases where current size -surpasses it.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.11.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.11.6"></a><h4>Returns</h4> -<p> the expected total size of the downloaded file</p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-get-uri"></a><h3>webkit_download_get_uri ()</h3> -<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * -webkit_download_get_uri (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Convenience method to retrieve the URI from the -<a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> which is being downloaded.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.12.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.12.6"></a><h4>Returns</h4> -<p> the URI</p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-new"></a><h3>webkit_download_new ()</h3> -<pre class="programlisting"><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="returnvalue">WebKitDownload</span></a> * -webkit_download_new (<em class="parameter"><code><a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> *request</code></em>);</pre> -<p>Creates a new <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> object for the given -<a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> object.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.13.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.16.10.13.6"></a><h4>Returns</h4> -<p> the new <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p> -<p></p> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-set-destination-uri"></a><h3>webkit_download_set_destination_uri ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_download_set_destination_uri (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>, - <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *destination_uri</code></em>);</pre> -<p>Defines the URI that should be used to save the downloaded file to.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.14.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destination_uri</p></td> -<td class="parameter_description"><p>the destination URI</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-download-start"></a><h3>webkit_download_start ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_download_start (<em class="parameter"><code><a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download</code></em>);</pre> -<p>Initiates the download. Notice that you must have set the -destination-uri property before calling this method.</p> -<div class="refsect3"> -<a name="id-1.3.16.10.15.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</p></td> -<td class="parameter_description"><p>the <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since 1.1.2</p> -</div> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="WebKitDownloadError"></a><h3>enum WebKitDownloadError</h3> -<p>Enum values used to denote the various download errors.</p> -<div class="refsect3"> -<a name="id-1.3.16.11.2.4"></a><h4>Members</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-ERROR-CANCELLED-BY-USER:CAPS"></a>WEBKIT_DOWNLOAD_ERROR_CANCELLED_BY_USER</p></td> -<td class="enum_member_description"> -<p>The download failed due to user cancellation.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-ERROR-DESTINATION:CAPS"></a>WEBKIT_DOWNLOAD_ERROR_DESTINATION</p></td> -<td class="enum_member_description"> -<p>The download failed due to disk write failure.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-ERROR-NETWORK:CAPS"></a>WEBKIT_DOWNLOAD_ERROR_NETWORK</p></td> -<td class="enum_member_description"> -<p>The download failed due to a network error.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownloadStatus"></a><h3>enum WebKitDownloadStatus</h3> -<p>Enum values used to denote the various states of a download.</p> -<div class="refsect3"> -<a name="id-1.3.16.11.3.4"></a><h4>Members</h4> -<div class="informaltable"><table width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-STATUS-ERROR:CAPS"></a>WEBKIT_DOWNLOAD_STATUS_ERROR</p></td> -<td class="enum_member_description"> -<p>The download failed because of an error other than user cancellation.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-STATUS-CREATED:CAPS"></a>WEBKIT_DOWNLOAD_STATUS_CREATED</p></td> -<td class="enum_member_description"> -<p>The download has not started yet.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-STATUS-STARTED:CAPS"></a>WEBKIT_DOWNLOAD_STATUS_STARTED</p></td> -<td class="enum_member_description"> -<p>The download has started, but has not completed yet.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-STATUS-CANCELLED:CAPS"></a>WEBKIT_DOWNLOAD_STATUS_CANCELLED</p></td> -<td class="enum_member_description"> -<p>The user canceled the download.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="WEBKIT-DOWNLOAD-STATUS-FINISHED:CAPS"></a>WEBKIT_DOWNLOAD_STATUS_FINISHED</p></td> -<td class="enum_member_description"> -<p>The download completed successfully.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload-struct"></a><h3>WebKitDownload</h3> -<pre class="programlisting">typedef struct _WebKitDownload WebKitDownload;</pre> -<p> -</p> -</div> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="WebKitDownload--current-size"></a><h3>The <code class="literal">“current-size”</code> property</h3> -<pre class="programlisting"> “current-size” <a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> -<p>The length of the data already downloaded</p> -<p>Flags: Read</p> -<p>Default value: 0</p> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload--destination-uri"></a><h3>The <code class="literal">“destination-uri”</code> property</h3> -<pre class="programlisting"> “destination-uri” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> -<p>The URI of the save location for this download.</p> -<p>Flags: Read / Write</p> -<p>Default value: ""</p> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload--network-request"></a><h3>The <code class="literal">“network-request”</code> property</h3> -<pre class="programlisting"> “network-request” <a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> *</pre> -<p>The <a class="link" href="WebKitNetworkRequest.html" title="WebKitNetworkRequest"><span class="type">WebKitNetworkRequest</span></a> instance associated with the download.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload--network-response"></a><h3>The <code class="literal">“network-response”</code> property</h3> -<pre class="programlisting"> “network-response” <a class="link" href="WebKitNetworkResponse.html" title="WebKitNetworkResponse"><span class="type">WebKitNetworkResponse</span></a> *</pre> -<p>The <a class="link" href="WebKitNetworkResponse.html" title="WebKitNetworkResponse"><span class="type">WebKitNetworkResponse</span></a> instance associated with the download.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since 1.1.16</p> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload--progress"></a><h3>The <code class="literal">“progress”</code> property</h3> -<pre class="programlisting"> “progress” <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> -<p>Determines the current progress of the download. Notice that, -although the progress changes are reported as soon as possible, -the emission of the notify signal for this property is -throttled, for the benefit of download managers. If you care -about every update, use WebKitDownload:current-size.</p> -<p>Flags: Read</p> -<p>Allowed values: [0,1]</p> -<p>Default value: 1</p> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload--status"></a><h3>The <code class="literal">“status”</code> property</h3> -<pre class="programlisting"> “status” <a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadStatus" title="enum WebKitDownloadStatus"><span class="type">WebKitDownloadStatus</span></a></pre> -<p>Determines the current status of the download.</p> -<p>Flags: Read</p> -<p>Default value: WEBKIT_DOWNLOAD_STATUS_CREATED</p> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload--suggested-filename"></a><h3>The <code class="literal">“suggested-filename”</code> property</h3> -<pre class="programlisting"> “suggested-filename” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> -<p>The file name suggested as default when saving</p> -<p>Flags: Read</p> -<p>Default value: ""</p> -<p class="since">Since 1.1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="WebKitDownload--total-size"></a><h3>The <code class="literal">“total-size”</code> property</h3> -<pre class="programlisting"> “total-size” <a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> -<p>The total size of the file</p> -<p>Flags: Read</p> -<p>Default value: 0</p> -<p class="since">Since 1.1.2</p> -</div> -</div> -<div class="refsect1"> -<a name="webkitgtk-webkitdownload.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="WebKitDownload-error"></a><h3>The <code class="literal">“error”</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="webkitgtk-webkitdownload.html#WebKitDownload"><span class="type">WebKitDownload</span></a> *download, - <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> error_code, - <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> error_detail, - <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *reason, - <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> -<p>Emitted when <em class="parameter"><code>download</code></em> - is interrupted either by user action or by -network errors, <em class="parameter"><code>error_detail</code></em> - will take any value of -<a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadError" title="enum WebKitDownloadError"><span class="type">WebKitDownloadError</span></a>.</p> -<div class="refsect3"> -<a name="id-1.3.16.13.2.5"></a><h4>Parameters</h4> -<div class="informaltable"><table 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>download</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>error_code</p></td> -<td class="parameter_description"><p>the corresponding error code</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error_detail</p></td> -<td class="parameter_description"><p>detailed error code for the error, see -<a class="link" href="webkitgtk-webkitdownload.html#WebKitDownloadError" title="enum WebKitDownloadError"><span class="type">WebKitDownloadError</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>reason</p></td> -<td class="parameter_description"><p>a string describing the error</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.1.2</p> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.21.1</div> -</body> -</html>
\ No newline at end of file |