/usr/share/gtk-doc/html/libanjuta/libanjuta-IAnjutaSymbolManager.html is in libanjuta-dev 2:3.4.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IAnjutaSymbolManager</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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-IAnjutaSymbolQuery.html" title="IAnjutaSymbolQuery">
<link rel="next" href="libanjuta-IAnjutaTerminal.html" title="IAnjutaTerminal">
<meta name="generator" content="GTK-Doc V1.18 (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-IAnjutaSymbolQuery.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-IAnjutaTerminal.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-IAnjutaSymbolManager.synopsis" class="shortcut">Top</a>
|
<a href="#libanjuta-IAnjutaSymbolManager.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libanjuta-IAnjutaSymbolManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libanjuta-IAnjutaSymbolManager.top_of_page"></a>IAnjutaSymbolManager</span></h2>
<p>IAnjutaSymbolManager — Source code symbols manager inteface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbolManager.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libanjuta-IAnjutaSymbolManager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libanjuta/interfaces/ianjuta-symbol-manager.h>
#define <a class="link" href="libanjuta-IAnjutaSymbolManager.html#IANJUTA-SYMBOL-MANAGER-ERROR:CAPS" title="IANJUTA_SYMBOL_MANAGER_ERROR">IANJUTA_SYMBOL_MANAGER_ERROR</a>
struct <a class="link" href="libanjuta-IAnjutaSymbolManager.html#IAnjutaSymbolManagerIface" title="struct IAnjutaSymbolManagerIface">IAnjutaSymbolManagerIface</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libanjuta-IAnjutaSymbolManager.html#ianjuta-symbol-manager-activate-package" title="ianjuta_symbol_manager_activate_package ()">ianjuta_symbol_manager_activate_package</a>
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_version</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#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libanjuta-IAnjutaSymbolManager.html#ianjuta-symbol-manager-add-package" title="ianjuta_symbol_manager_add_package ()">ianjuta_symbol_manager_add_package</a> (<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_version</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</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">IAnjutaSymbolQuery</span> * <a class="link" href="libanjuta-IAnjutaSymbolManager.html#ianjuta-symbol-manager-create-query" title="ianjuta_symbol_manager_create_query ()">ianjuta_symbol_manager_create_query</a>
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbolQuery.html#IAnjutaSymbolQueryName"><span class="type">IAnjutaSymbolQueryName</span></a> name</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbolQuery.html#IAnjutaSymbolQueryDb"><span class="type">IAnjutaSymbolQueryDb</span></a> db</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-IAnjutaSymbolManager.html#ianjuta-symbol-manager-deactivate-all" title="ianjuta_symbol_manager_deactivate_all ()">ianjuta_symbol_manager_deactivate_all</a>
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</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-IAnjutaSymbolManager.html#ianjuta-symbol-manager-deactivate-package" title="ianjuta_symbol_manager_deactivate_package ()">ianjuta_symbol_manager_deactivate_package</a>
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_version</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-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="libanjuta-IAnjutaSymbolManager.html#ianjuta-symbol-manager-error-quark" title="ianjuta_symbol_manager_error_quark ()">ianjuta_symbol_manager_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbolManager.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbolManager.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IANJUTA-SYMBOL-MANAGER-ERROR:CAPS"></a><h3>IANJUTA_SYMBOL_MANAGER_ERROR</h3>
<pre class="programlisting">#define IANJUTA_SYMBOL_MANAGER_ERROR ianjuta_symbol_manager_error_quark()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="IAnjutaSymbolManagerIface"></a><h3>struct IAnjutaSymbolManagerIface</h3>
<pre class="programlisting">struct IAnjutaSymbolManagerIface {
GTypeInterface g_iface;
/* Signal */
void (*prj_scan_end) (IAnjutaSymbolManager *obj, gint process_id);
/* Signal */
void (*sys_scan_end) (IAnjutaSymbolManager *obj, gint process_id);
gboolean (*activate_package) (IAnjutaSymbolManager *obj, const gchar *pkg_name, const gchar* pkg_version, GError **err);
gboolean (*add_package) (IAnjutaSymbolManager *obj, const gchar* pkg_name, const gchar* pkg_version, GList* files, GError **err);
IAnjutaSymbolQuery* (*create_query) (IAnjutaSymbolManager *obj, IAnjutaSymbolQueryName name, IAnjutaSymbolQueryDb db, GError **err);
void (*deactivate_all) (IAnjutaSymbolManager *obj, GError **err);
void (*deactivate_package) (IAnjutaSymbolManager *obj, const gchar* pkg_name, const gchar* pkg_version, GError **err);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-manager-activate-package"></a><h3>ianjuta_symbol_manager_activate_package ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> ianjuta_symbol_manager_activate_package
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_version</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>
Activates the package for searches in the global symbol database.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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>pkg_name</code></em> :</span></p></td>
<td>Name of the package to activate. The colon char must be avoided.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pkg_version</code></em> :</span></p></td>
<td>Version of the package. The colon char must be avoided.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the package was loaded (or will be loaded once scanned).
FALSE if the version given was newer than the version in the database or the
package was not found. In this case, <code class="function">add_package()</code> should be called.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-manager-add-package"></a><h3>ianjuta_symbol_manager_add_package ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> ianjuta_symbol_manager_add_package (<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_version</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</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>
Reads the package files into the database asynchronously.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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>pkg_name</code></em> :</span></p></td>
<td>Name of the package to scan. Should be the name given by
pkg-config. The colon char must be avoided.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pkg_version</code></em> :</span></p></td>
<td>Version of the package. The colon char must be avoided.
or by the language implementation (Python, Javascript, etc.)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>files</code></em> :</span></p></td>
<td>A list of GFile's to scan for this package</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the package will be loaded into the db, FALSE if the package
already exists</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-manager-create-query"></a><h3>ianjuta_symbol_manager_create_query ()</h3>
<pre class="programlisting"><span class="returnvalue">IAnjutaSymbolQuery</span> * ianjuta_symbol_manager_create_query
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbolQuery.html#IAnjutaSymbolQueryName"><span class="type">IAnjutaSymbolQueryName</span></a> name</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbolQuery.html#IAnjutaSymbolQueryDb"><span class="type">IAnjutaSymbolQueryDb</span></a> db</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>
Create a query object. By default only <a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-ID:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_ID</span></a> and
and <a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-NAME:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_NAME</span></a> are selected, limit is set to infinity,
offset is set to 0, no filters are set and mode is set to
<a class="link" href="libanjuta-IAnjutaSymbolQuery.html#IANJUTA-SYMBOL-QUERY-MODE-SYNC:CAPS"><span class="type">IANJUTA_SYMBOL_QUERY_MODE_SYNC</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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>name</code></em> :</span></p></td>
<td>Name of the query. It decides what query type it is.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>db</code></em> :</span></p></td>
<td>The database to use.</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>A <span class="type">IAnjutaSymbolQuery</span> object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-manager-deactivate-all"></a><h3>ianjuta_symbol_manager_deactivate_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ianjuta_symbol_manager_deactivate_all
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</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>
Deactivates all activate packages
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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-symbol-manager-deactivate-package"></a><h3>ianjuta_symbol_manager_deactivate_package ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ianjuta_symbol_manager_deactivate_package
(<em class="parameter"><code><span class="type">IAnjutaSymbolManager</span> *obj</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pkg_version</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>
Deactivates the package if it was found. If package is NULL, deactivate all
packages.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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>pkg_name</code></em> :</span></p></td>
<td>name of the package. The colon char must be avoided.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pkg_version</code></em> :</span></p></td>
<td>Version of the package. The colon char must be avoided.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-manager-error-quark"></a><h3>ianjuta_symbol_manager_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_symbol_manager_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbolManager.see-also"></a><h2>See Also</h2>
<span class="type">IAnjutaSymbol</span>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|