/usr/share/gtk-doc/html/libinfinity-0.6/InfcProgressRequest.html is in libinfinity-0.6-doc 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfcProgressRequest: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch04.html" title="Libinfinity client side API">
<link rel="prev" href="InfcRequest.html" title="InfcRequest">
<link rel="next" href="InfcRequestManager.html" title="InfcRequestManager">
<meta name="generator" content="GTK-Doc V1.24 (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="#InfcProgressRequest.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfcProgressRequest.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfcProgressRequest.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfcProgressRequest.properties" class="shortcut">Properties</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfcRequest.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfcRequestManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfcProgressRequest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfcProgressRequest.top_of_page"></a>InfcProgressRequest</span></h2>
<p>InfcProgressRequest — Asynchronous request with dynamic progress.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfcProgressRequest.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfcProgressRequest.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="InfcProgressRequest.html#infc-progress-request-initiated" title="infc_progress_request_initiated ()">infc_progress_request_initiated</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfcProgressRequest.html#infc-progress-request-get-initiated" title="infc_progress_request_get_initiated ()">infc_progress_request_get_initiated</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="InfcProgressRequest.html#infc-progress-request-progress" title="infc_progress_request_progress ()">infc_progress_request_progress</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.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"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfcProgressRequest.html#InfcProgressRequest--current" title="The “current” property">current</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfcProgressRequest.html#InfcProgressRequest--total" title="The “total” property">total</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.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="InfcProgressRequest.html#InfcProgressRequest-struct" title="struct InfcProgressRequest">InfcProgressRequest</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfcProgressRequest.html#InfcProgressRequestClass" title="struct InfcProgressRequestClass">InfcProgressRequestClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="InfcRequest.html" title="InfcRequest">InfcRequest</a>
<span class="lineart">╰──</span> InfcProgressRequest
</pre>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfcProgressRequest implements
<a class="link" href="InfRequest.html" title="InfRequest">InfRequest</a>.</p>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/client/infc-progress-request.h>
</pre>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.description"></a><h2>Description</h2>
<p>This class represents a request which consists of multiple steps and
for which progress on the overall operation is reported.</p>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="infc-progress-request-initiated"></a><h3>infc_progress_request_initiated ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infc_progress_request_initiated (<em class="parameter"><code><a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest"><span class="type">InfcProgressRequest</span></a> *request</code></em>,
<em class="parameter"><code><span class="type">guint</span> total</code></em>);</pre>
<p>Initiates the request. A progress request is considered initiated as soon
as the total number of items is known.</p>
<div class="refsect3">
<a name="id-1.5.6.11.2.5"></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>request</p></td>
<td class="parameter_description"><p>An <a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest"><span class="type">InfcProgressRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>total</p></td>
<td class="parameter_description"><p>The total number of items.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-progress-request-get-initiated"></a><h3>infc_progress_request_get_initiated ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infc_progress_request_get_initiated (<em class="parameter"><code><a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest"><span class="type">InfcProgressRequest</span></a> *request</code></em>);</pre>
<p>Returns whether the request was initiated, i.e. the total number of items
is known.</p>
<div class="refsect3">
<a name="id-1.5.6.11.3.5"></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>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest"><span class="type">InfcProgressRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.6.11.3.6"></a><h4>Returns</h4>
<p> Whether the request was initiated.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-progress-request-progress"></a><h3>infc_progress_request_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infc_progress_request_progress (<em class="parameter"><code><a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest"><span class="type">InfcProgressRequest</span></a> *request</code></em>);</pre>
<p>Indicates that one more operation has been performed and changes the
<a class="link" href="InfcProgressRequest.html#InfcProgressRequest--current" title="The “current” property"><span class="type">“current”</span></a> property accordingly. The request must be
initiated before this function can be called.</p>
<div class="refsect3">
<a name="id-1.5.6.11.4.5"></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>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest"><span class="type">InfcProgressRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfcProgressRequest-struct"></a><h3>struct InfcProgressRequest</h3>
<pre class="programlisting">struct InfcProgressRequest;</pre>
<p><a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest"><span class="type">InfcProgressRequest</span></a> is an opaque data type. You should only access it via
the public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcProgressRequestClass"></a><h3>struct InfcProgressRequestClass</h3>
<pre class="programlisting">struct InfcProgressRequestClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfcProgressRequest--current"></a><h3>The <code class="literal">“current”</code> property</h3>
<pre class="programlisting"> “current” <span class="type">guint</span></pre>
<p>The current number of finished operations.</p>
<p>Flags: Read</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcProgressRequest--total"></a><h3>The <code class="literal">“total”</code> property</h3>
<pre class="programlisting"> “total” <span class="type">guint</span></pre>
<p>The total number of operations.</p>
<p>Flags: Read</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="InfcProgressRequest.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>, <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|