| Top |  |
 |
 |
 |
Functions
| GQuark | ianjuta_symbol_error_quark () |
| gboolean | ianjuta_symbol_get_boolean () |
| GFile * | ianjuta_symbol_get_file () |
| const GdkPixbuf * | ianjuta_symbol_get_icon () |
| gint | ianjuta_symbol_get_int () |
| const gchar * | ianjuta_symbol_get_string () |
| IAnjutaSymbolType | ianjuta_symbol_get_sym_type () |
Description
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.
Functions
ianjuta_symbol_get_boolean ()
gboolean ianjuta_symbol_get_boolean (IAnjutaSymbol *obj,IAnjutaSymbolField field,GError **err);
Retreives the boolean value of a boolean field
.
ianjuta_symbol_get_file ()
GFile * ianjuta_symbol_get_file (IAnjutaSymbol *obj,GError **err);
A convenience method to get GFile object for IANJUTA_SYMBOL_FIELD_FILE_PATH field. The file where the symbol is declared. It contains the absolute path of the file unlike raw value of field IANJUTA_SYMBOL_FIELD_FILE_PATH.
ianjuta_symbol_get_icon ()
const GdkPixbuf * ianjuta_symbol_get_icon (IAnjutaSymbol *obj,GError **err);
A convenience method to get a small icon (16x16) representing the symbol kind. You *need* a query with fields IANJUTA_SYMBOL_FIELD_ACCESS and IANJUTA_SYMBOL_FIELD_KIND selected.
ianjuta_symbol_get_int ()
gint ianjuta_symbol_get_int (IAnjutaSymbol *obj,IAnjutaSymbolField field,GError **err);
Retreives the integer value of an integer field
.
ianjuta_symbol_get_string ()
const gchar * ianjuta_symbol_get_string (IAnjutaSymbol *obj,IAnjutaSymbolField field,GError **err);
Retreives the string value of a string field
.
ianjuta_symbol_get_sym_type ()
IAnjutaSymbolType ianjuta_symbol_get_sym_type (IAnjutaSymbol *obj,GError **err);
A convenience method to get value of IANJUTA_SYMBOL_FIELD_TYPE field typecasted to IAnjutaSymbolType. Numerical value is unchanged.
Types and Values
enum IAnjutaSymbolField
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 ianjuta_symbol_get_int(),
for string use ianjuta_symbol_get_string(), and for boolean use
ianjuta_symbol_get_boolean(). Some fields can be in both forms,
e.g. IANJUTA_SYMBOL_FIELD_TYPE.
Members
|
Integer. A unique ID of the symbol |
||
|
String. Name of the symbol |
||
|
Integer. The file line number where the symbol is found. |
||
|
Boolean: TRUE if symbol is within file scope, otherwise FALSE. |
||
|
String. Signature of a method, if symbol is a funtion. Namely, the arguments list of the funtion. |
||
|
String. Return type of a method, if symbol is a function. |
||
|
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. |
||
|
type_name attribute of a symbol. If a type could be "class" then its type_name may be "MyFooClass" etc. |
||
|
String. The relative path to the file where the symbol is found. |
||
|
String. The project name to which the symbol belongs to. |
||
|
String. The project version to which the symbol belongs to. |
||
|
String. Implementation attribute of a symbol. It may be "pure virtual", "virtual", etc. |
||
|
String. Access attribute of a symbol. It may be "public", "private" etc. |
||
|
Kind attribute of a symbol, such as "enumerator", "namespace", "class" etc. |
||
|
Boolean. TRUE if symbol is a scope container, such as namespace, class, struct etc., otherwise FALSE. |
||
|
The end marker. |
enum IAnjutaSymbolType
Members
|
None spedified. |
||
|
Unknown type. |
||
|
Class declaration |
||
|
Enum declaration |
||
|
Enumerator value |
||
|
Field (Java only) |
||
|
Function definition |
||
|
Interface (Java only) |
||
|
Member variable of class/struct |
||
|
Class method (Java only) |
||
|
Namespace declaration |
||
|
Package (Java only) |
||
|
Function prototype |
||
|
Struct declaration |
||
|
Typedef |
||
|
Union |
||
|
Variable |
||
|
Extern or forward declaration |
||
|
Macro (without arguments) |
||
|
Parameterized macro |
||
|
File (Pseudo tag) |
||
|
Other (non C/C++/Java tag) |
||
|
types which are subjected to create a scope. |
||
|
Maximum value, used as end marker. |