Update docs to v1.0.0

This commit is contained in:
Will Thompson
2018-08-22 16:03:11 +01:00
committed by Alexander Larsson
parent bf8a33cda0
commit f5dec7c219
20 changed files with 4317 additions and 865 deletions

View File

@@ -0,0 +1,191 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FlatpakTransactionProgress: Flatpak Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Flatpak Library Reference Manual">
<link rel="up" href="ch01.html" title="Flatpak">
<link rel="prev" href="FlatpakTransactionOperation.html" title="FlatpakTransactionOperation">
<link rel="next" href="FlatpakTransaction.html" title="FlatpakTransaction">
<meta name="generator" content="GTK-Doc V1.28 (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="#FlatpakTransactionProgress.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#FlatpakTransactionProgress.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
<a href="#FlatpakTransactionProgress.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="FlatpakTransactionOperation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="FlatpakTransaction.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FlatpakTransactionProgress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FlatpakTransactionProgress.top_of_page"></a>FlatpakTransactionProgress</span></h2>
<p>FlatpakTransactionProgress</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="FlatpakTransactionProgress.html#flatpak-transaction-progress-get-is-estimating" title="flatpak_transaction_progress_get_is_estimating ()">flatpak_transaction_progress_get_is_estimating</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="FlatpakTransactionProgress.html#flatpak-transaction-progress-get-progress" title="flatpak_transaction_progress_get_progress ()">flatpak_transaction_progress_get_progress</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="FlatpakTransactionProgress.html#flatpak-transaction-progress-get-status" title="flatpak_transaction_progress_get_status ()">flatpak_transaction_progress_get_status</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="FlatpakTransactionProgress.html#flatpak-transaction-progress-set-update-frequency" title="flatpak_transaction_progress_set_update_frequency ()">flatpak_transaction_progress_set_update_frequency</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.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="FlatpakTransactionProgress.html#FlatpakTransactionProgress-changed" title="The “changed” signal">changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.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="FlatpakTransactionProgress.html#FlatpakTransactionProgress-struct" title="FlatpakTransactionProgress">FlatpakTransactionProgress</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> FlatpakTransactionProgress
</pre>
</div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="flatpak-transaction-progress-get-is-estimating"></a><h3>flatpak_transaction_progress_get_is_estimating ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
flatpak_transaction_progress_get_is_estimating
(<em class="parameter"><code><a class="link" href="FlatpakTransactionProgress.html" title="FlatpakTransactionProgress"><span class="type">FlatpakTransactionProgress</span></a> *self</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="flatpak-transaction-progress-get-progress"></a><h3>flatpak_transaction_progress_get_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
flatpak_transaction_progress_get_progress
(<em class="parameter"><code><a class="link" href="FlatpakTransactionProgress.html" title="FlatpakTransactionProgress"><span class="type">FlatpakTransactionProgress</span></a> *self</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="flatpak-transaction-progress-get-status"></a><h3>flatpak_transaction_progress_get_status ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
flatpak_transaction_progress_get_status
(<em class="parameter"><code><a class="link" href="FlatpakTransactionProgress.html" title="FlatpakTransactionProgress"><span class="type">FlatpakTransactionProgress</span></a> *self</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="flatpak-transaction-progress-set-update-frequency"></a><h3>flatpak_transaction_progress_set_update_frequency ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
flatpak_transaction_progress_set_update_frequency
(<em class="parameter"><code><a class="link" href="FlatpakTransactionProgress.html" title="FlatpakTransactionProgress"><span class="type">FlatpakTransactionProgress</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> update_frequency</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FlatpakTransactionProgress-struct"></a><h3>FlatpakTransactionProgress</h3>
<pre class="programlisting">typedef struct _FlatpakTransactionProgress FlatpakTransactionProgress;</pre>
</div>
</div>
<div class="refsect1">
<a name="FlatpakTransactionProgress.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="FlatpakTransactionProgress-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="FlatpakTransactionProgress.html" title="FlatpakTransactionProgress"><span class="type">FlatpakTransactionProgress</span></a> *object,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when some detail of the progress object changes, you can call the various methods to get the current status.</p>
<div class="refsect3">
<a name="FlatpakTransactionProgress-changed.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>object</p></td>
<td class="parameter_description"><p>A <a class="link" href="FlatpakTransactionProgress.html" title="FlatpakTransactionProgress"><span class="type">FlatpakTransactionProgress</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>