vala: Allow read-only properties
[vala-gnome.git] / vapi / gobject-introspection-1.0.vapi
blob8fe3ad0307bcb1b10ad78caa65386a76855e0266
1 /* gobject-introspection-1.0.vapi generated by vapigen, do not modify. */
3 [CCode (cprefix = "GI", gir_namespace = "GIRepository", gir_version = "2.0", lower_case_cprefix = "g_")]
4 namespace GI {
5         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
6         [Compact]
7         public class ArgInfo : GI.BaseInfo {
8                 public int get_closure ();
9                 public int get_destroy ();
10                 public GI.Direction get_direction ();
11                 public GI.Transfer get_ownership_transfer ();
12                 public GI.ScopeType get_scope ();
13                 public GI.TypeInfo get_type ();
14                 public bool is_caller_allocates ();
15                 public bool is_optional ();
16                 public bool is_return_value ();
17                 [Version (since = "1.29.0")]
18                 public bool is_skip ();
19                 public void load_type (out unowned GI.TypeInfo type);
20                 public bool may_be_null ();
21         }
22         [CCode (cheader_filename = "girepository.h", lower_case_cprefix = "g_base_info_", lower_case_csuffix = "base_info_gtype", ref_function = "g_base_info_ref", type_id = "g_base_info_gtype_get_type ()", unref_function = "g_base_info_unref")]
23         [Compact]
24         public class BaseInfo {
25                 [CCode (cname = "g_info_new")]
26                 public BaseInfo (GI.InfoType type, GI.BaseInfo container, GI.Typelib typelib, uint32 offset);
27                 public bool equal (GI.BaseInfo info2);
28                 public unowned string get_attribute (string name);
29                 public unowned GI.BaseInfo get_container ();
30                 public unowned string get_name ();
31                 public unowned string get_namespace ();
32                 public GI.InfoType get_type ();
33                 public unowned GI.Typelib get_typelib ();
34                 public bool is_deprecated ();
35                 public bool iterate_attributes (ref GI.AttributeIter iterator, out unowned string name, out unowned string value);
36         }
37         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
38         [Compact]
39         public class CallableInfo : GI.BaseInfo {
40                 [Version (since = "1.34")]
41                 public bool can_throw_gerror ();
42                 public GI.ArgInfo get_arg (int n);
43                 public GI.Transfer get_caller_owns ();
44                 public GI.Transfer get_instance_ownership_transfer ();
45                 public int get_n_args ();
46                 public unowned string get_return_attribute (string name);
47                 public GI.TypeInfo get_return_type ();
48                 public bool invoke (void* function, [CCode (array_length_cname = "n_in_args", array_length_pos = 2.5)] GI.Argument[] in_args, [CCode (array_length_cname = "n_out_args", array_length_pos = 3.5)] GI.Argument[] out_args, GI.Argument return_value, bool is_method, bool @throws) throws GI.InvokeError;
49                 [Version (since = "1.34")]
50                 public bool is_method ();
51                 public bool iterate_return_attributes (ref GI.AttributeIter iterator, out unowned string name, out unowned string value);
52                 public void load_arg (int n, out unowned GI.ArgInfo arg);
53                 public void load_return_type (out unowned GI.TypeInfo type);
54                 public bool may_return_null ();
55                 public bool skip_return ();
56         }
57         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
58         [Compact]
59         public class CallbackInfo : GI.CallableInfo {
60         }
61         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
62         [Compact]
63         public class ConstantInfo : GI.BaseInfo {
64                 [Version (since = "1.30.1")]
65                 public void free_value (GI.Argument value);
66                 public GI.TypeInfo get_type ();
67                 public int get_value (out GI.Argument value);
68         }
69         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
70         [Compact]
71         public class EnumInfo : GI.BaseInfo {
72                 [Version (since = "1.29.17")]
73                 public unowned string get_error_domain ();
74                 [Version (since = "1.29.17")]
75                 public GI.FunctionInfo get_method (int n);
76                 [Version (since = "1.29.17")]
77                 public int get_n_methods ();
78                 public int get_n_values ();
79                 public GI.TypeTag get_storage_type ();
80                 public GI.ValueInfo get_value (int n);
81         }
82         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
83         [Compact]
84         public class FieldInfo : GI.BaseInfo {
85                 public bool get_field (void* mem, GI.Argument value);
86                 public GI.FieldInfoFlags get_flags ();
87                 public int get_offset ();
88                 public int get_size ();
89                 public GI.TypeInfo get_type ();
90                 public bool set_field (void* mem, GI.Argument value);
91         }
92         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
93         [Compact]
94         public class FunctionInfo : GI.CallableInfo {
95                 public GI.FunctionInfoFlags get_flags ();
96                 public GI.PropertyInfo get_property ();
97                 public unowned string get_symbol ();
98                 public GI.VFuncInfo get_vfunc ();
99                 public bool invoke ([CCode (array_length_cname = "n_in_args", array_length_pos = 1.5)] GI.Argument[] in_args, [CCode (array_length_cname = "n_out_args", array_length_pos = 2.5)] GI.Argument[] out_args, GI.Argument return_value) throws GI.InvokeError;
100         }
101         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
102         [Compact]
103         public class InterfaceInfo : GI.BaseInfo {
104                 public GI.FunctionInfo find_method (string name);
105                 [Version (since = "1.34")]
106                 public GI.SignalInfo find_signal (string name);
107                 public GI.VFuncInfo find_vfunc (string name);
108                 public GI.ConstantInfo get_constant (int n);
109                 public GI.StructInfo get_iface_struct ();
110                 public GI.FunctionInfo get_method (int n);
111                 public int get_n_constants ();
112                 public int get_n_methods ();
113                 public int get_n_prerequisites ();
114                 public int get_n_properties ();
115                 public int get_n_signals ();
116                 public int get_n_vfuncs ();
117                 public GI.BaseInfo get_prerequisite (int n);
118                 public GI.PropertyInfo get_property (int n);
119                 public GI.SignalInfo get_signal (int n);
120                 public GI.VFuncInfo get_vfunc (int n);
121         }
122         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
123         [Compact]
124         public class ObjectInfo : GI.BaseInfo {
125                 public GI.FunctionInfo find_method (string name);
126                 public GI.FunctionInfo find_method_using_interfaces (string name, out GI.ObjectInfo implementor);
127                 public GI.SignalInfo find_signal (string name);
128                 public GI.VFuncInfo find_vfunc (string name);
129                 public GI.VFuncInfo find_vfunc_using_interfaces (string name, out GI.ObjectInfo implementor);
130                 public bool get_abstract ();
131                 public GI.StructInfo get_class_struct ();
132                 public GI.ConstantInfo get_constant (int n);
133                 public GI.FieldInfo get_field (int n);
134                 public bool get_fundamental ();
135                 public unowned string get_get_value_function ();
136                 public unowned GI.ObjectInfoGetValueFunction get_get_value_function_pointer ();
137                 public GI.InterfaceInfo get_interface (int n);
138                 public GI.FunctionInfo get_method (int n);
139                 public int get_n_constants ();
140                 public int get_n_fields ();
141                 public int get_n_interfaces ();
142                 public int get_n_methods ();
143                 public int get_n_properties ();
144                 public int get_n_signals ();
145                 public int get_n_vfuncs ();
146                 public GI.ObjectInfo get_parent ();
147                 public GI.PropertyInfo get_property (int n);
148                 public unowned string get_ref_function ();
149                 public unowned GI.ObjectInfoRefFunction get_ref_function_pointer ();
150                 public unowned string get_set_value_function ();
151                 public unowned GI.ObjectInfoSetValueFunction get_set_value_function_pointer ();
152                 public GI.SignalInfo get_signal (int n);
153                 public unowned string get_type_init ();
154                 public unowned string get_type_name ();
155                 public unowned string get_unref_function ();
156                 public unowned GI.ObjectInfoUnrefFunction get_unref_function_pointer ();
157                 public GI.VFuncInfo get_vfunc (int n);
158         }
159         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
160         [Compact]
161         public class PropertyInfo : GI.BaseInfo {
162                 public GLib.ParamFlags get_flags ();
163                 public GI.Transfer get_ownership_transfer ();
164                 public GI.TypeInfo get_type ();
165         }
166         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
167         [Compact]
168         public class RegisteredTypeInfo : GI.BaseInfo {
169                 public GLib.Type get_g_type ();
170                 public unowned string get_type_init ();
171                 public unowned string get_type_name ();
172         }
173         [CCode (cheader_filename = "girepository.h", lower_case_csuffix = "irepository", type_id = "g_irepository_get_type ()")]
174         public class Repository : GLib.Object {
175                 [CCode (has_construct_function = false)]
176                 protected Repository ();
177                 public static bool dump (string arg) throws GI.RepositoryError;
178                 public GLib.List<string> enumerate_versions (string namespace_);
179                 [Version (since = "1.29.17")]
180                 public GI.EnumInfo find_by_error_domain (GLib.Quark domain);
181                 public GI.BaseInfo find_by_gtype (GLib.Type gtype);
182                 public GI.BaseInfo find_by_name (string namespace_, string name);
183                 public unowned string get_c_prefix (string namespace_);
184                 public static unowned GI.Repository get_default ();
185                 [CCode (array_length = false, array_null_terminated = true)]
186                 public string[] get_dependencies (string namespace_);
187                 [CCode (array_length = false, array_null_terminated = true)]
188                 [Version (since = "1.44")]
189                 public string[] get_immediate_dependencies (string namespace_);
190                 public GI.BaseInfo get_info (string namespace_, int index);
191                 [CCode (array_length = false, array_null_terminated = true)]
192                 public string[] get_loaded_namespaces ();
193                 public int get_n_infos (string namespace_);
194                 public static GLib.OptionGroup get_option_group ();
195                 public static unowned GLib.SList<string> get_search_path ();
196                 public unowned string get_shared_library (string namespace_);
197                 public unowned string get_typelib_path (string namespace_);
198                 public unowned string get_version (string namespace_);
199                 public bool is_registered (string namespace_, string? version);
200                 public unowned string load_typelib (GI.Typelib typelib, GI.RepositoryLoadFlags flags) throws GI.RepositoryError;
201                 public static void prepend_library_path (string directory);
202                 public static void prepend_search_path (string directory);
203                 public unowned GI.Typelib require (string namespace_, string? version, GI.RepositoryLoadFlags flags) throws GI.RepositoryError;
204                 public unowned GI.Typelib require_private (string typelib_dir, string namespace_, string? version, GI.RepositoryLoadFlags flags) throws GLib.Error;
205         }
206         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
207         [Compact]
208         public class SignalInfo : GI.CallableInfo {
209                 public GI.VFuncInfo get_class_closure ();
210                 public GLib.SignalFlags get_flags ();
211                 public bool true_stops_emit ();
212         }
213         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
214         [Compact]
215         public class StructInfo : GI.BaseInfo {
216                 public GI.FieldInfo find_field (string name);
217                 public GI.FunctionInfo find_method (string name);
218                 public size_t get_alignment ();
219                 public GI.FieldInfo get_field (int n);
220                 public GI.FunctionInfo get_method (int n);
221                 public int get_n_fields ();
222                 public int get_n_methods ();
223                 public size_t get_size ();
224                 public bool is_foreign ();
225                 public bool is_gtype_struct ();
226         }
227         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
228         [Compact]
229         public class TypeInfo : GI.BaseInfo {
230                 public int get_array_fixed_size ();
231                 public int get_array_length ();
232                 public GI.ArrayType get_array_type ();
233                 public GI.BaseInfo get_interface ();
234                 public GI.TypeInfo get_param_type (int n);
235                 public GI.TypeTag get_tag ();
236                 public bool is_pointer ();
237                 public bool is_zero_terminated ();
238         }
239         [CCode (cheader_filename = "girepository.h", has_type_id = false)]
240         [Compact]
241         public class Typelib {
242                 public void free ();
243                 public unowned string get_namespace ();
244                 public bool symbol (string symbol_name, out void* symbol);
245         }
246         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
247         [Compact]
248         public class UnionInfo : GI.BaseInfo {
249                 public GI.FunctionInfo find_method (string name);
250                 public size_t get_alignment ();
251                 public GI.ConstantInfo get_discriminator (int n);
252                 public int get_discriminator_offset ();
253                 public GI.TypeInfo get_discriminator_type ();
254                 public GI.FieldInfo get_field (int n);
255                 public GI.FunctionInfo get_method (int n);
256                 public int get_n_fields ();
257                 public int get_n_methods ();
258                 public size_t get_size ();
259                 public bool is_discriminated ();
260         }
261         [CCode (cheader_filename = "girepository.h", has_type_id = false)]
262         [Compact]
263         public class UnresolvedInfo {
264         }
265         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
266         [Compact]
267         public class VFuncInfo : GI.CallableInfo {
268                 public void* get_address (GLib.Type implementor_gtype) throws GLib.Error;
269                 public GI.VFuncInfoFlags get_flags ();
270                 public GI.FunctionInfo get_invoker ();
271                 public int get_offset ();
272                 public GI.SignalInfo get_signal ();
273                 public bool invoke (GLib.Type implementor, [CCode (array_length_cname = "n_in_args", array_length_pos = 2.5)] GI.Argument[] in_args, [CCode (array_length_cname = "n_out_args", array_length_pos = 3.5)] GI.Argument[] out_args, GI.Argument return_value) throws GI.InvokeError;
274         }
275         [CCode (cheader_filename = "girepository.h", type_id = "g_base_info_gtype_get_type ()")]
276         [Compact]
277         public class ValueInfo : GI.BaseInfo {
278                 public int64 get_value ();
279         }
280         [CCode (cheader_filename = "girepository.h")]
281         public struct Argument {
282                 public bool v_boolean;
283                 public int8 v_int8;
284                 public uint8 v_uint8;
285                 public int16 v_int16;
286                 public uint16 v_uint16;
287                 public int32 v_int32;
288                 public uint32 v_uint32;
289                 public int64 v_int64;
290                 public uint64 v_uint64;
291                 public float v_float;
292                 public double v_double;
293                 public short v_short;
294                 public ushort v_ushort;
295                 public int v_int;
296                 public uint v_uint;
297                 public long v_long;
298                 public ulong v_ulong;
299                 public ssize_t v_ssize;
300                 public size_t v_size;
301                 public weak string v_string;
302                 public void* v_pointer;
303         }
304         [CCode (cheader_filename = "girepository.h", has_type_id = false)]
305         public struct AttributeIter {
306         }
307         [CCode (cheader_filename = "girepository.h", cprefix = "GI_ARRAY_TYPE_", has_type_id = false)]
308         public enum ArrayType {
309                 C,
310                 ARRAY,
311                 PTR_ARRAY,
312                 BYTE_ARRAY
313         }
314         [CCode (cheader_filename = "girepository.h", cprefix = "GI_DIRECTION_", has_type_id = false)]
315         public enum Direction {
316                 IN,
317                 OUT,
318                 INOUT
319         }
320         [CCode (cheader_filename = "girepository.h", cprefix = "GI_FIELD_IS_", has_type_id = false)]
321         [Flags]
322         public enum FieldInfoFlags {
323                 READABLE,
324                 WRITABLE
325         }
326         [CCode (cheader_filename = "girepository.h", cprefix = "GI_FUNCTION_", has_type_id = false)]
327         [Flags]
328         public enum FunctionInfoFlags {
329                 IS_METHOD,
330                 IS_CONSTRUCTOR,
331                 IS_GETTER,
332                 IS_SETTER,
333                 WRAPS_VFUNC,
334                 THROWS
335         }
336         [CCode (cheader_filename = "girepository.h", cprefix = "GI_INFO_TYPE_", has_type_id = false)]
337         public enum InfoType {
338                 INVALID,
339                 FUNCTION,
340                 CALLBACK,
341                 STRUCT,
342                 BOXED,
343                 ENUM,
344                 FLAGS,
345                 OBJECT,
346                 INTERFACE,
347                 CONSTANT,
348                 INVALID_0,
349                 UNION,
350                 VALUE,
351                 SIGNAL,
352                 VFUNC,
353                 PROPERTY,
354                 FIELD,
355                 ARG,
356                 TYPE,
357                 UNRESOLVED;
358                 public unowned string to_string ();
359         }
360         [CCode (cheader_filename = "girepository.h", cprefix = "G_IREPOSITORY_LOAD_FLAG_", has_type_id = false)]
361         [Flags]
362         public enum RepositoryLoadFlags {
363                 [CCode (cname = "G_IREPOSITORY_LOAD_FLAG_LAZY")]
364                 IREPOSITORY_LOAD_FLAG_LAZY
365         }
366         [CCode (cheader_filename = "girepository.h", cprefix = "GI_SCOPE_TYPE_", has_type_id = false)]
367         public enum ScopeType {
368                 INVALID,
369                 CALL,
370                 ASYNC,
371                 NOTIFIED
372         }
373         [CCode (cheader_filename = "girepository.h", cprefix = "GI_TRANSFER_", has_type_id = false)]
374         public enum Transfer {
375                 NOTHING,
376                 CONTAINER,
377                 EVERYTHING
378         }
379         [CCode (cheader_filename = "girepository.h", cprefix = "GI_TYPE_TAG_", has_type_id = false)]
380         public enum TypeTag {
381                 VOID,
382                 BOOLEAN,
383                 INT8,
384                 UINT8,
385                 INT16,
386                 UINT16,
387                 INT32,
388                 UINT32,
389                 INT64,
390                 UINT64,
391                 FLOAT,
392                 DOUBLE,
393                 GTYPE,
394                 UTF8,
395                 FILENAME,
396                 ARRAY,
397                 INTERFACE,
398                 GLIST,
399                 GSLIST,
400                 GHASH,
401                 ERROR,
402                 UNICHAR;
403                 public unowned string to_string ();
404         }
405         [CCode (cheader_filename = "girepository.h", cprefix = "GI_VFUNC_", has_type_id = false)]
406         [Flags]
407         public enum VFuncInfoFlags {
408                 MUST_CHAIN_UP,
409                 MUST_OVERRIDE,
410                 MUST_NOT_OVERRIDE,
411                 THROWS
412         }
413         [CCode (cheader_filename = "girepository.h", cname = "GInvokeError", cprefix = "G_INVOKE_ERROR_")]
414         [GIR (name = "nvokeError")]
415         public errordomain InvokeError {
416                 FAILED,
417                 SYMBOL_NOT_FOUND,
418                 ARGUMENT_MISMATCH;
419                 public static GLib.Quark quark ();
420         }
421         [CCode (cheader_filename = "girepository.h", cprefix = "G_IREPOSITORY_ERROR_")]
422         public errordomain RepositoryError {
423                 TYPELIB_NOT_FOUND,
424                 NAMESPACE_MISMATCH,
425                 NAMESPACE_VERSION_CONFLICT,
426                 LIBRARY_NOT_FOUND;
427                 [CCode (cname = "g_irepository_error_quark")]
428                 public static GLib.Quark quark ();
429         }
430         [CCode (cheader_filename = "girepository.h", has_target = false)]
431         public delegate void* ObjectInfoGetValueFunction (GLib.Value value);
432         [CCode (cheader_filename = "girepository.h", has_target = false)]
433         public delegate void* ObjectInfoRefFunction (void* object);
434         [CCode (cheader_filename = "girepository.h", has_target = false)]
435         public delegate void ObjectInfoSetValueFunction (GLib.Value value, void* object);
436         [CCode (cheader_filename = "girepository.h", has_target = false)]
437         public delegate void ObjectInfoUnrefFunction (void* object);