/usr/share/gtk-doc/html/libanjuta/libanjuta-IAnjutaSymbol.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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IAnjutaSymbol</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-IAnjutaStreamSavable.html" title="IAnjutaStreamSavable">
<link rel="next" href="libanjuta-IAnjutaSymbolQuery.html" title="IAnjutaSymbolQuery">
<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-IAnjutaStreamSavable.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-IAnjutaSymbolQuery.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-IAnjutaSymbol.synopsis" class="shortcut">Top</a>
|
<a href="#libanjuta-IAnjutaSymbol.description" class="shortcut">Description</a>
|
<a href="#libanjuta-IAnjutaSymbol.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="libanjuta-IAnjutaSymbol"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libanjuta-IAnjutaSymbol.top_of_page"></a>IAnjutaSymbol</span></h2>
<p>IAnjutaSymbol — Source code symbol interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbol.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libanjuta-IAnjutaSymbol.synopsis"></a><h2>Synopsis</h2>
<a name="IAnjutaSymbolField"></a><a name="IAnjutaSymbolType"></a><pre class="synopsis">
#include <libanjuta/interfaces/ianjuta-symbol.h>
#define <a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-ERROR:CAPS" title="IANJUTA_SYMBOL_ERROR">IANJUTA_SYMBOL_ERROR</a>
enum <a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolField-enum" title="enum IAnjutaSymbolField">IAnjutaSymbolField</a>;
enum <a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolType-enum" title="enum IAnjutaSymbolType">IAnjutaSymbolType</a>;
struct <a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolIface" title="struct IAnjutaSymbolIface">IAnjutaSymbolIface</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-IAnjutaSymbol.html#ianjuta-symbol-error-quark" title="ianjuta_symbol_error_quark ()">ianjuta_symbol_error_quark</a> (<em class="parameter"><code><span class="type">void</span></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-IAnjutaSymbol.html#ianjuta-symbol-get-boolean" title="ianjuta_symbol_get_boolean ()">ianjuta_symbol_get_boolean</a> (<em class="parameter"><code><span class="type">IAnjutaSymbol</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolField"><span class="type">IAnjutaSymbolField</span></a> field</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/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> * <a class="link" href="libanjuta-IAnjutaSymbol.html#ianjuta-symbol-get-file" title="ianjuta_symbol_get_file ()">ianjuta_symbol_get_file</a> (<em class="parameter"><code><span class="type">IAnjutaSymbol</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>);
const <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="libanjuta-IAnjutaSymbol.html#ianjuta-symbol-get-icon" title="ianjuta_symbol_get_icon ()">ianjuta_symbol_get_icon</a> (<em class="parameter"><code><span class="type">IAnjutaSymbol</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>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libanjuta-IAnjutaSymbol.html#ianjuta-symbol-get-int" title="ianjuta_symbol_get_int ()">ianjuta_symbol_get_int</a> (<em class="parameter"><code><span class="type">IAnjutaSymbol</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolField"><span class="type">IAnjutaSymbolField</span></a> field</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-IAnjutaSymbol.html#ianjuta-symbol-get-string" title="ianjuta_symbol_get_string ()">ianjuta_symbol_get_string</a> (<em class="parameter"><code><span class="type">IAnjutaSymbol</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolField"><span class="type">IAnjutaSymbolField</span></a> field</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 class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolType"><span class="returnvalue">IAnjutaSymbolType</span></a> <a class="link" href="libanjuta-IAnjutaSymbol.html#ianjuta-symbol-get-sym-type" title="ianjuta_symbol_get_sym_type ()">ianjuta_symbol_get_sym_type</a> (<em class="parameter"><code><span class="type">IAnjutaSymbol</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>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbol.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GEnum
+----IAnjutaSymbolField
</pre>
<pre class="synopsis">
GEnum
+----IAnjutaSymbolType
</pre>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbol.description"></a><h2>Description</h2>
<p>
This interface is used to define a symbol, normally got from symbol
queries. A symbol has various fields that can be retrieved by using
their get methods. A symbol will have only those fields which have
been selected to be included in their respective queries, so make sure
the needed fields are correctly specified during query creation.
</p>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbol.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IANJUTA-SYMBOL-ERROR:CAPS"></a><h3>IANJUTA_SYMBOL_ERROR</h3>
<pre class="programlisting">#define IANJUTA_SYMBOL_ERROR ianjuta_symbol_error_quark()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="IAnjutaSymbolField-enum"></a><h3>enum IAnjutaSymbolField</h3>
<pre class="programlisting">typedef enum {
IANJUTA_SYMBOL_FIELD_ID,
IANJUTA_SYMBOL_FIELD_NAME,
IANJUTA_SYMBOL_FIELD_FILE_POS,
IANJUTA_SYMBOL_FILED_SCOPE_DEF_ID,
IANJUTA_SYMBOL_FIELD_FILE_SCOPE,
IANJUTA_SYMBOL_FIELD_SIGNATURE,
IANJUTA_SYMBOL_FIELD_RETURNTYPE,
IANJUTA_SYMBOL_FIELD_TYPE,
IANJUTA_SYMBOL_FIELD_TYPE_NAME,
IANJUTA_SYMBOL_FIELD_FILE_PATH,
IANJUTA_SYMBOL_FIELD_PROJECT_NAME,
IANJUTA_SYMBOL_FIELD_PROJECT_VERSION,
IANJUTA_SYMBOL_FIELD_IMPLEMENTATION,
IANJUTA_SYMBOL_FIELD_ACCESS,
IANJUTA_SYMBOL_FIELD_KIND,
IANJUTA_SYMBOL_FIELD_IS_CONTAINER,
IANJUTA_SYMBOL_FIELD_END
} IAnjutaSymbolField;
</pre>
<p>
Symbol Fields. Used to define and retrieve results from query. Each of
these fields are either integer or string. Use the right method to
retrieve them. That is, for integer use <a class="link" href="libanjuta-IAnjutaSymbol.html#ianjuta-symbol-get-int" title="ianjuta_symbol_get_int ()"><code class="function">ianjuta_symbol_get_int()</code></a>,
for string use <a class="link" href="libanjuta-IAnjutaSymbol.html#ianjuta-symbol-get-string" title="ianjuta_symbol_get_string ()"><code class="function">ianjuta_symbol_get_string()</code></a>, and for boolean use
<a class="link" href="libanjuta-IAnjutaSymbol.html#ianjuta-symbol-get-boolean" title="ianjuta_symbol_get_boolean ()"><code class="function">ianjuta_symbol_get_boolean()</code></a>. Some fields can be in both forms,
e.g. <a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-TYPE:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_TYPE</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-ID:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_ID</code></span></p></td>
<td>Integer. A unique ID of the symbol
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-NAME:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_NAME</code></span></p></td>
<td>String. Name of the symbol
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-FILE-POS:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_FILE_POS</code></span></p></td>
<td>Integer. The file line number where the symbol is found.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FILED-SCOPE-DEF-ID:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FILED_SCOPE_DEF_ID</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-FILE-SCOPE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_FILE_SCOPE</code></span></p></td>
<td>Boolean: TRUE if symbol is within file scope,
otherwise FALSE.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-SIGNATURE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_SIGNATURE</code></span></p></td>
<td>String. Signature of a method, if symbol is a funtion.
Namely, the arguments list of the funtion.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-RETURNTYPE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_RETURNTYPE</code></span></p></td>
<td>String. Return type of a method, if symbol is a function.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-TYPE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_TYPE</code></span></p></td>
<td>Both string and Integer. Type attribute of a symbol.
In string form, it is name of the type in string form.
In integer form, it is IAnjutaSymbolType enumerator value.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-TYPE-NAME:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_TYPE_NAME</code></span></p></td>
<td>type_name attribute of a symbol.
If a type could be "class" then its type_name may be "MyFooClass" etc.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-FILE-PATH:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_FILE_PATH</code></span></p></td>
<td>String. The relative path to the file where the symbol is found.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-PROJECT-NAME:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_PROJECT_NAME</code></span></p></td>
<td>String. The project name to which the symbol belongs to.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-PROJECT-VERSION:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_PROJECT_VERSION</code></span></p></td>
<td>String. The project version to which the symbol belongs to.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-IMPLEMENTATION:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_IMPLEMENTATION</code></span></p></td>
<td>String. Implementation attribute of a symbol. It may be
"pure virtual", "virtual", etc.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-ACCESS:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_ACCESS</code></span></p></td>
<td>String. Access attribute of a symbol.
It may be "public", "private" etc.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-KIND:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_KIND</code></span></p></td>
<td>Kind attribute of a symbol, such as
"enumerator", "namespace", "class" etc.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-IS-CONTAINER:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_IS_CONTAINER</code></span></p></td>
<td>Boolean. TRUE if symbol is
a scope container, such as namespace, class, struct etc., otherwise
FALSE.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-FIELD-END:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_FIELD_END</code></span></p></td>
<td>The end marker.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="IAnjutaSymbolType-enum"></a><h3>enum IAnjutaSymbolType</h3>
<pre class="programlisting">typedef enum {
IANJUTA_SYMBOL_TYPE_NONE = 0,
IANJUTA_SYMBOL_TYPE_UNDEF = 1,
IANJUTA_SYMBOL_TYPE_CLASS = 2,
IANJUTA_SYMBOL_TYPE_ENUM = 4,
IANJUTA_SYMBOL_TYPE_ENUMERATOR = 8,
IANJUTA_SYMBOL_TYPE_FIELD = 16,
IANJUTA_SYMBOL_TYPE_FUNCTION = 32,
IANJUTA_SYMBOL_TYPE_INTERFACE = 64,
IANJUTA_SYMBOL_TYPE_MEMBER = 128,
IANJUTA_SYMBOL_TYPE_METHOD = 256,
IANJUTA_SYMBOL_TYPE_NAMESPACE = 512,
IANJUTA_SYMBOL_TYPE_PACKAGE = 1024,
IANJUTA_SYMBOL_TYPE_PROTOTYPE = 2048,
IANJUTA_SYMBOL_TYPE_STRUCT = 4096,
IANJUTA_SYMBOL_TYPE_TYPEDEF = 8192,
IANJUTA_SYMBOL_TYPE_UNION = 16384,
IANJUTA_SYMBOL_TYPE_VARIABLE = 32768,
IANJUTA_SYMBOL_TYPE_EXTERNVAR = 65536,
IANJUTA_SYMBOL_TYPE_MACRO = 131072,
IANJUTA_SYMBOL_TYPE_MACRO_WITH_ARG = 262144,
IANJUTA_SYMBOL_TYPE_FILE = 524288,
IANJUTA_SYMBOL_TYPE_OTHER = 1048576,
IANJUTA_SYMBOL_TYPE_SCOPE_CONTAINER = IANJUTA_SYMBOL_TYPE_CLASS | IANJUTA_SYMBOL_TYPE_ENUM | IANJUTA_SYMBOL_TYPE_INTERFACE | IANJUTA_SYMBOL_TYPE_NAMESPACE | IANJUTA_SYMBOL_TYPE_PACKAGE | IANJUTA_SYMBOL_TYPE_STRUCT | IANJUTA_SYMBOL_TYPE_UNION,
IANJUTA_SYMBOL_TYPE_MAX = 2097151
} IAnjutaSymbolType;
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-NONE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_NONE</code></span></p></td>
<td>None spedified.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-UNDEF:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_UNDEF</code></span></p></td>
<td>Unknown type.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-CLASS:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_CLASS</code></span></p></td>
<td>Class declaration
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-ENUM:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_ENUM</code></span></p></td>
<td>Enum declaration
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-ENUMERATOR:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_ENUMERATOR</code></span></p></td>
<td>Enumerator value
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-FIELD:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_FIELD</code></span></p></td>
<td>Field (Java only)
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-FUNCTION:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_FUNCTION</code></span></p></td>
<td>Function definition
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-INTERFACE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_INTERFACE</code></span></p></td>
<td>Interface (Java only)
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-MEMBER:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_MEMBER</code></span></p></td>
<td>Member variable of class/struct
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-METHOD:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_METHOD</code></span></p></td>
<td>Class method (Java only)
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-NAMESPACE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_NAMESPACE</code></span></p></td>
<td>Namespace declaration
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-PACKAGE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_PACKAGE</code></span></p></td>
<td>Package (Java only)
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-PROTOTYPE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_PROTOTYPE</code></span></p></td>
<td>Function prototype
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-STRUCT:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_STRUCT</code></span></p></td>
<td>Struct declaration
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-TYPEDEF:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_TYPEDEF</code></span></p></td>
<td>Typedef
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-UNION:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_UNION</code></span></p></td>
<td>Union
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-VARIABLE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_VARIABLE</code></span></p></td>
<td>Variable
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-EXTERNVAR:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_EXTERNVAR</code></span></p></td>
<td>Extern or forward declaration
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-MACRO:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_MACRO</code></span></p></td>
<td>Macro (without arguments)
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-MACRO-WITH-ARG:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_MACRO_WITH_ARG</code></span></p></td>
<td>Parameterized macro
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-FILE:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_FILE</code></span></p></td>
<td>File (Pseudo tag)
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-OTHER:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_OTHER</code></span></p></td>
<td>Other (non C/C++/Java tag)
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-SCOPE-CONTAINER:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_SCOPE_CONTAINER</code></span></p></td>
<td>types which are subjected to create a scope.
</td>
</tr>
<tr>
<td><p><a name="IANJUTA-SYMBOL-TYPE-MAX:CAPS"></a><span class="term"><code class="literal">IANJUTA_SYMBOL_TYPE_MAX</code></span></p></td>
<td>Maximum value, used as end marker.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="IAnjutaSymbolIface"></a><h3>struct IAnjutaSymbolIface</h3>
<pre class="programlisting">struct IAnjutaSymbolIface {
GTypeInterface g_iface;
gboolean (*get_boolean) (IAnjutaSymbol *obj, IAnjutaSymbolField field, GError **err);
GFile* (*get_file) (IAnjutaSymbol *obj, GError **err);
const GdkPixbuf * (*get_icon) (IAnjutaSymbol *obj, GError **err);
gint (*get_int) (IAnjutaSymbol *obj, IAnjutaSymbolField field, GError **err);
const gchar* (*get_string) (IAnjutaSymbol *obj, IAnjutaSymbolField field, GError **err);
IAnjutaSymbolType (*get_sym_type) (IAnjutaSymbol *obj, GError **err);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-error-quark"></a><h3>ianjuta_symbol_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_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-get-boolean"></a><h3>ianjuta_symbol_get_boolean ()</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_get_boolean (<em class="parameter"><code><span class="type">IAnjutaSymbol</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolField"><span class="type">IAnjutaSymbolField</span></a> field</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>
Retreives the boolean value of a boolean <em class="parameter"><code>field</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>field</code></em> :</span></p></td>
<td>The field to retrieve.</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 boolean</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-get-file"></a><h3>ianjuta_symbol_get_file ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> * ianjuta_symbol_get_file (<em class="parameter"><code><span class="type">IAnjutaSymbol</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>
A convenience method to get GFile object for
<a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-FILE-PATH:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_FILE_PATH</span></a> field. The file where the
symbol is declared. It contains the absolute path of the file
unlike raw value of field <a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-FILE-PATH:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_FILE_PATH</span></a>.
</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>A GFile object. It must be unrefed after use.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-get-icon"></a><h3>ianjuta_symbol_get_icon ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * ianjuta_symbol_get_icon (<em class="parameter"><code><span class="type">IAnjutaSymbol</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>
A convenience method to get a small icon (16x16) representing the symbol
kind. You *need* a query with fields <a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-ACCESS:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_ACCESS</span></a> and
<a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-KIND:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_KIND</span></a> selected.
</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>a Pixbuf icon representing the symbol. Ref the icon if you
need to keep it.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-get-int"></a><h3>ianjuta_symbol_get_int ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> ianjuta_symbol_get_int (<em class="parameter"><code><span class="type">IAnjutaSymbol</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolField"><span class="type">IAnjutaSymbolField</span></a> field</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>
Retreives the integer value of an integer <em class="parameter"><code>field</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>field</code></em> :</span></p></td>
<td>The field to retrieve.</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 integer</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-get-string"></a><h3>ianjuta_symbol_get_string ()</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_symbol_get_string (<em class="parameter"><code><span class="type">IAnjutaSymbol</span> *obj</code></em>,
<em class="parameter"><code><a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolField"><span class="type">IAnjutaSymbolField</span></a> field</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>
Retreives the string value of a string <em class="parameter"><code>field</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>field</code></em> :</span></p></td>
<td>The field to retrieve.</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 string</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ianjuta-symbol-get-sym-type"></a><h3>ianjuta_symbol_get_sym_type ()</h3>
<pre class="programlisting"><a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolType"><span class="returnvalue">IAnjutaSymbolType</span></a> ianjuta_symbol_get_sym_type (<em class="parameter"><code><span class="type">IAnjutaSymbol</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>
A convenience method to get value of <a class="link" href="libanjuta-IAnjutaSymbol.html#IANJUTA-SYMBOL-FIELD-TYPE:CAPS"><span class="type">IANJUTA_SYMBOL_FIELD_TYPE</span></a>
field typecasted to IAnjutaSymbolType. Numerical value is unchanged.
</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>a <a class="link" href="libanjuta-IAnjutaSymbol.html#IAnjutaSymbolType"><span class="type">IAnjutaSymbolType</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libanjuta-IAnjutaSymbol.see-also"></a><h2>See Also</h2>
<span class="type">IAnjutaSymbolQuery</span>, <span class="type">IAnjutaSymbolManager</span>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|