/usr/share/gtk-doc/html/libanjuta/AnjutaAsyncNotify.html is in libanjuta-dev 2:3.22.0-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Anjuta Developers Reference Manual: AnjutaAsyncNotify</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Anjuta Developers Reference Manual">
<link rel="up" href="libanjuta-api.html" title="libanjuta API">
<link rel="prev" href="AnjutaAsyncCommand.html" title="AnjutaAsyncCommand">
<link rel="next" href="AnjutaVcsStatusTreeView.html" title="AnjutaVcsStatusTreeView">
<meta name="generator" content="GTK-Doc V1.21 (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="#AnjutaAsyncNotify.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AnjutaAsyncNotify.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#AnjutaAsyncNotify.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="libanjuta-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AnjutaAsyncCommand.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AnjutaVcsStatusTreeView.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AnjutaAsyncNotify"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AnjutaAsyncNotify.top_of_page"></a>AnjutaAsyncNotify</span></h2>
<p>AnjutaAsyncNotify — Mechanism used by interfaces that run asynchronously to
notify clients of finished tasks and to report errors.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.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">
<a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="returnvalue">AnjutaAsyncNotify</span></a> *
</td>
<td class="function_name">
<a class="link" href="AnjutaAsyncNotify.html#anjuta-async-notify-new" title="anjuta_async_notify_new ()">anjuta_async_notify_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="AnjutaAsyncNotify.html#anjuta-async-notify-get-error" title="anjuta_async_notify_get_error ()">anjuta_async_notify_get_error</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="AnjutaAsyncNotify.html#anjuta-async-notify-notify-finished" title="anjuta_async_notify_notify_finished ()">anjuta_async_notify_notify_finished</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="AnjutaAsyncNotify.html#anjuta-async-notify-set-error" title="anjuta_async_notify_set_error ()">anjuta_async_notify_set_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.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"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AnjutaAsyncNotify.html#AnjutaAsyncNotify-finished" title="The “finished” signal">finished</a></td>
<td class="signal_flags"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.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"> </td>
<td class="function_name"><a class="link" href="AnjutaAsyncNotify.html#AnjutaAsyncNotifyPriv" title="AnjutaAsyncNotifyPriv">AnjutaAsyncNotifyPriv</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> AnjutaAsyncNotify
</pre>
</div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.description"></a><h2>Description</h2>
<p><a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> is a way to allow Anjuta interfaces that run
asynchronously, such as <span class="type">IAnjutaVCS</span>, to notify clients that a method has
completed. <a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> also reports errors to the user. </p>
<p>All clients need to do is create an instance of <a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a>, connect
to the finished signal, and pass it in to the interface method to be called.</p>
</div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="anjuta-async-notify-new"></a><h3>anjuta_async_notify_new ()</h3>
<pre class="programlisting"><a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="returnvalue">AnjutaAsyncNotify</span></a> *
anjuta_async_notify_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> object.</p>
<div class="refsect3">
<a name="id-1.6.24.8.2.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> instance</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-async-notify-get-error"></a><h3>anjuta_async_notify_get_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_async_notify_get_error (<em class="parameter"><code><a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> *self</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Gets the error set on <em class="parameter"><code>self</code></em>
.</p>
<div class="refsect3">
<a name="id-1.6.24.8.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>self</p></td>
<td class="parameter_description"><p>An <a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> object</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 the error set by the called interface to which
this object was passed. If no error is set, <em class="parameter"><code>error</code></em>
is set to NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-async-notify-notify-finished"></a><h3>anjuta_async_notify_notify_finished ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_async_notify_notify_finished (<em class="parameter"><code><a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> *self</code></em>);</pre>
<p>Emits the finished signal. This method should only be used by
interface methods themselves, not by clients.</p>
<div class="refsect3">
<a name="id-1.6.24.8.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>self</p></td>
<td class="parameter_description"><p>An <a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-async-notify-set-error"></a><h3>anjuta_async_notify_set_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_async_notify_set_error (<em class="parameter"><code><a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> *self</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
<p>Sets the error for an interface call. This method should only be used by
interface implementations themselves, not by clients.</p>
<div class="refsect3">
<a name="id-1.6.24.8.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>self</p></td>
<td class="parameter_description"><p>An <a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Error to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AnjutaAsyncNotifyPriv"></a><h3>AnjutaAsyncNotifyPriv</h3>
<pre class="programlisting">typedef struct _AnjutaAsyncNotifyPriv AnjutaAsyncNotifyPriv;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="AnjutaAsyncNotify.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="AnjutaAsyncNotify-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AnjutaAsyncNotify.html" title="AnjutaAsyncNotify"><span class="type">AnjutaAsyncNotify</span></a> *notify,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|