/usr/share/gtk-doc/html/libanjuta/libanjuta-IAnjutaLanguageProvider.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 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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IAnjutaLanguageProvider</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-IAnjutaLanguage.html" title="IAnjutaLanguage">
<link rel="next" href="libanjuta-IAnjutaLoader.html" title="IAnjutaLoader">
<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-IAnjutaLanguage.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-IAnjutaLoader.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-IAnjutaLanguageProvider.synopsis" class="shortcut">Top</a>
|
<a href="#libanjuta-IAnjutaLanguageProvider.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libanjuta-IAnjutaLanguageProvider"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libanjuta-IAnjutaLanguageProvider.top_of_page"></a>IAnjutaLanguageProvider</span></h2>
<p>IAnjutaLanguageProvider — Provider for autocompletion features</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libanjuta-IAnjutaLanguageProvider.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libanjuta-IAnjutaLanguageProvider.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libanjuta/interfaces/ianjuta-language-provider.h>
#define <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#IANJUTA-LANGUAGE-PROVIDER-ERROR:CAPS" title="IANJUTA_LANGUAGE_PROVIDER_ERROR">IANJUTA_LANGUAGE_PROVIDER_ERROR</a>
#define <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#IANJUTA-LANGUAGE-PROVIDER-PREF-CALLTIP-ENABLE:CAPS" title="IANJUTA_LANGUAGE_PROVIDER_PREF_CALLTIP_ENABLE">IANJUTA_LANGUAGE_PROVIDER_PREF_CALLTIP_ENABLE</a>
#define <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-ENABLE:CAPS" title="IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_ENABLE">IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_ENABLE</a>
#define <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-SPACE-AFTER-FUNC:CAPS" title="IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_SPACE_AFTER_FUNC">IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_SPACE_AFTER_FUNC</a>
#define <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-BRACE-AFTER-FUNC:CAPS" title="IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_BRACE_AFTER_FUNC">IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_BRACE_AFTER_FUNC</a>
#define <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-CLOSEBRACE-AFTER-FUNC:CAPS" title="IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_CLOSEBRACE_AFTER_FUNC">IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_CLOSEBRACE_AFTER_FUNC</a>
struct <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#IAnjutaLanguageProviderIface" title="struct IAnjutaLanguageProviderIface">IAnjutaLanguageProviderIface</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-IAnjutaLanguageProvider.html#ianjuta-language-provider-error-quark" title="ianjuta_language_provider_error_quark ()">ianjuta_language_provider_error_quark</a>
(<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#ianjuta-language-provider-get-calltip-cache" title="ianjuta_language_provider_get_calltip_cache ()">ianjuta_language_provider_get_calltip_cache</a>
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *call_context</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>);
<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-IAnjutaLanguageProvider.html#ianjuta-language-provider-get-calltip-context" title="ianjuta_language_provider_get_calltip_context ()">ianjuta_language_provider_get_calltip_context</a>
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</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>);
<span class="returnvalue">void</span> <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#ianjuta-language-provider-new-calltip" title="ianjuta_language_provider_new_calltip ()">ianjuta_language_provider_new_calltip</a>
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *call_context</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>);
<span class="returnvalue">IAnjutaIterable</span> * <a class="link" href="libanjuta-IAnjutaLanguageProvider.html#ianjuta-language-provider-populate-completions" title="ianjuta_language_provider_populate_completions ()">ianjuta_language_provider_populate_completions</a>
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</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-IAnjutaLanguageProvider.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaLanguageProvider.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IANJUTA-LANGUAGE-PROVIDER-ERROR:CAPS"></a><h3>IANJUTA_LANGUAGE_PROVIDER_ERROR</h3>
<pre class="programlisting">#define IANJUTA_LANGUAGE_PROVIDER_ERROR ianjuta_language_provider_error_quark()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="IANJUTA-LANGUAGE-PROVIDER-PREF-CALLTIP-ENABLE:CAPS"></a><h3>IANJUTA_LANGUAGE_PROVIDER_PREF_CALLTIP_ENABLE</h3>
<pre class="programlisting">#define IANJUTA_LANGUAGE_PROVIDER_PREF_CALLTIP_ENABLE "calltip-enable"
</pre>
<p>
Boolean key, true is calltips has to be shown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-ENABLE:CAPS"></a><h3>IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_ENABLE</h3>
<pre class="programlisting">#define IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_ENABLE "completion-enable"
</pre>
<p>
Boolean key, true is code completion is enable.
</p>
</div>
<hr>
<div class="refsect2">
<a name="IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-SPACE-AFTER-FUNC:CAPS"></a><h3>IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_SPACE_AFTER_FUNC</h3>
<pre class="programlisting">#define IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_SPACE_AFTER_FUNC "completion-space-after-func"
</pre>
<p>
Boolean key, true is adding a space after function call autocompletion
</p>
</div>
<hr>
<div class="refsect2">
<a name="IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-BRACE-AFTER-FUNC:CAPS"></a><h3>IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_BRACE_AFTER_FUNC</h3>
<pre class="programlisting">#define IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_BRACE_AFTER_FUNC "completion-brace-after-func"
</pre>
<p>
Boolean key, true is adding '(' after function call autocompletion
</p>
</div>
<hr>
<div class="refsect2">
<a name="IANJUTA-LANGUAGE-PROVIDER-PREF-AUTOCOMPLETE-CLOSEBRACE-AFTER-FUNC:CAPS"></a><h3>IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_CLOSEBRACE_AFTER_FUNC</h3>
<pre class="programlisting">#define IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_CLOSEBRACE_AFTER_FUNC "completion-closebrace-after-func"
</pre>
<p>
Boolean key, true is adding ')' after function call autocompletion
</p>
</div>
<hr>
<div class="refsect2">
<a name="IAnjutaLanguageProviderIface"></a><h3>struct IAnjutaLanguageProviderIface</h3>
<pre class="programlisting">struct IAnjutaLanguageProviderIface {
IAnjutaProviderIface g_iface;
GList* (*get_calltip_cache) (IAnjutaLanguageProvider *obj, gchar* call_context, GError **err);
gchar* (*get_calltip_context) (IAnjutaLanguageProvider *obj, IAnjutaIterable* iter, GError **err);
void (*new_calltip) (IAnjutaLanguageProvider *obj, gchar* call_context, IAnjutaIterable* iter, GError **err);
IAnjutaIterable* (*populate_completions) (IAnjutaLanguageProvider *obj, IAnjutaIterable* iter, GError **err);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-language-provider-error-quark"></a><h3>ianjuta_language_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_language_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-language-provider-get-calltip-cache"></a><h3>ianjuta_language_provider_get_calltip_cache ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * ianjuta_language_provider_get_calltip_cache
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *call_context</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>
Searches for a calltip in the cache
</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>call_context</code></em> :</span></p></td>
<td>name of the method to show a calltip</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>Error propagation</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>tips for the
searched name of the method from the cache,
NULL if nothing found. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8][<a href="http://foldoc.org/transfer%20container"><span class="acronym">transfer container</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-language-provider-get-calltip-context"></a><h3>ianjuta_language_provider_get_calltip_context ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * ianjuta_language_provider_get_calltip_context
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</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>
Searches for a calltip context
</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>current cursor position</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>Error propagation</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>name of the method to show a calltip for or NULL</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-language-provider-new-calltip"></a><h3>ianjuta_language_provider_new_calltip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ianjuta_language_provider_new_calltip
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</span> *obj</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *call_context</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>
Creates a new calltip
</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>call_context</code></em> :</span></p></td>
<td>name of the method to create a new calltip</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>current cursor position</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>Error propagation</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-language-provider-populate-completions"></a><h3>ianjuta_language_provider_populate_completions ()</h3>
<pre class="programlisting"><span class="returnvalue">IAnjutaIterable</span> * ianjuta_language_provider_populate_completions
(<em class="parameter"><code><span class="type">IAnjutaLanguageProvider</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>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the iter where the provider populated, NULL otherwise. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|