/usr/share/gtk-doc/html/libanjuta/libanjuta-IAnjutaProvider.html is in libanjuta-dev 2:3.14.0-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IAnjutaProvider</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="plugin-interfaces.html" title="Plugin interfaces">
<link rel="prev" href="libanjuta-IAnjutaProjectBackend.html" title="IAnjutaProjectBackend">
<link rel="next" href="libanjuta-IAnjutaSnippetsManager.html" title="IAnjutaSnippetsManager">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libanjuta-IAnjutaProjectBackend.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="plugin-interfaces.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Anjuta Developers Reference Manual</th>
<td><a accesskey="n" href="libanjuta-IAnjutaSnippetsManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libanjuta-IAnjutaProvider.synopsis" class="shortcut">Top</a>
|
<a href="#libanjuta-IAnjutaProvider.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libanjuta-IAnjutaProvider"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libanjuta-IAnjutaProvider.top_of_page"></a>IAnjutaProvider</span></h2>
<p>IAnjutaProvider — Provider for autocompletion features</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libanjuta-IAnjutaProvider.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libanjuta-IAnjutaProvider.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libanjuta/interfaces/ianjuta-provider.h>
#define <a class="link" href="libanjuta-IAnjutaProvider.html#IANJUTA-PROVIDER-ERROR:CAPS" title="IANJUTA_PROVIDER_ERROR">IANJUTA_PROVIDER_ERROR</a>
struct <a class="link" href="libanjuta-IAnjutaProvider.html#IAnjutaProviderIface" title="struct IAnjutaProviderIface">IAnjutaProviderIface</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="libanjuta-IAnjutaProvider.html#ianjuta-provider-error-quark" title="ianjuta_provider_error_quark ()">ianjuta_provider_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libanjuta-IAnjutaProvider.html#ianjuta-provider-activate" title="ianjuta_provider_activate ()">ianjuta_provider_activate</a> (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><span class="type">IAnjutaIterable</span> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libanjuta-IAnjutaProvider.html#ianjuta-provider-get-name" title="ianjuta_provider_get_name ()">ianjuta_provider_get_name</a> (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
<span class="returnvalue">IAnjutaIterable</span> * <a class="link" href="libanjuta-IAnjutaProvider.html#ianjuta-provider-get-start-iter" title="ianjuta_provider_get_start_iter ()">ianjuta_provider_get_start_iter</a> (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libanjuta-IAnjutaProvider.html#ianjuta-provider-populate" title="ianjuta_provider_populate ()">ianjuta_provider_populate</a> (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><span class="type">IAnjutaIterable</span> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaProvider.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaProvider.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IANJUTA-PROVIDER-ERROR:CAPS"></a><h3>IANJUTA_PROVIDER_ERROR</h3>
<pre class="programlisting">#define IANJUTA_PROVIDER_ERROR ianjuta_provider_error_quark()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="IAnjutaProviderIface"></a><h3>struct IAnjutaProviderIface</h3>
<pre class="programlisting">struct IAnjutaProviderIface {
GTypeInterface g_iface;
void (*activate) (IAnjutaProvider *obj, IAnjutaIterable* iter, gpointer data, GError **err);
const gchar* (*get_name) (IAnjutaProvider *obj, GError **err);
IAnjutaIterable* (*get_start_iter) (IAnjutaProvider *obj, GError **err);
void (*populate) (IAnjutaProvider *obj, IAnjutaIterable* iter, GError **err);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-provider-error-quark"></a><h3>ianjuta_provider_error_quark ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> ianjuta_provider_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-provider-activate"></a><h3>ianjuta_provider_activate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ianjuta_provider_activate (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><span class="type">IAnjutaIterable</span> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>
Show completion for the context at position <em class="parameter"><code>iter</code></em>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>Self</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>position where the completion occurs</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>data assigned to the proposal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>Error propagation and reporting.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-provider-get-name"></a><h3>ianjuta_provider_get_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * ianjuta_provider_get_name (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>
Return a (translatable) name for the provider
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>Self</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-provider-get-start-iter"></a><h3>ianjuta_provider_get_start_iter ()</h3>
<pre class="programlisting"><span class="returnvalue">IAnjutaIterable</span> * ianjuta_provider_get_start_iter (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>
Get the iter where the current completion started
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>Self</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>Error propagation and reporting.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>current start iter. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-provider-populate"></a><h3>ianjuta_provider_populate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ianjuta_provider_populate (<em class="parameter"><code><span class="type">IAnjutaProvider</span> *obj</code></em>,
<em class="parameter"><code><span class="type">IAnjutaIterable</span> *iter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>
Show completion for the context at position <em class="parameter"><code>iter</code></em>. The provider should
call ianjuta_editor_assist_proposals here to add proposals to the list.
</p>
<p>
Note that this is called after every character typed and the list of proposals
has to be completely renewed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>Self</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>the text iter where the provider should be populated</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>Error propagation and reporting.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|