2 <!-- This file was automatically generated from C sources - DO NOT EDIT!
3 To affect the contents of this file, edit the original C definitions,
4 and/or use gtk-doc annotations. -->
5 <repository version="1.2"
6 xmlns="http://www.gtk.org/introspection/core/1.0"
7 xmlns:c="http://www.gtk.org/introspection/c/1.0"
8 xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
9 <include name="GLib" version="2.0"/>
10 <include name="GObject" version="2.0"/>
11 <package name="gio-2.0"/>
12 <package name="gio-unix-2.0"/>
13 <c:include name="gio/gio.h"/>
16 shared-library="libgio-2.0.so.0"
17 c:identifier-prefixes="G"
18 c:symbol-prefixes="g">
19 <interface name="Action"
20 c:symbol-prefix="action"
22 glib:type-name="GAction"
23 glib:get-type="g_action_get_type"
24 glib:type-struct="ActionInterface">
25 <virtual-method name="activate" invoker="activate" version="2.26">
26 <doc xml:whitespace="preserve">Activates the action.
27 the parameter type given at construction time). If the parameter
28 type was %NULL then @parameter must also be %NULL.</doc>
29 <return-value transfer-ownership="none">
30 <type name="none" c:type="void"/>
33 <parameter name="parameter" transfer-ownership="none" allow-none="1">
34 <doc xml:whitespace="preserve">the parameter to the activation</doc>
35 <type name="GLib.Variant" c:type="GVariant*"/>
39 <virtual-method name="get_enabled" invoker="get_enabled" version="2.26">
40 <doc xml:whitespace="preserve">Checks if @action is currently enabled.
41 An action must be enabled in order to be activated or in order to
42 have its state changed from outside callers.</doc>
43 <return-value transfer-ownership="none">
44 <doc xml:whitespace="preserve">whether the action is enabled</doc>
45 <type name="gboolean" c:type="gboolean"/>
48 <virtual-method name="get_name" invoker="get_name" version="2.26">
49 <doc xml:whitespace="preserve">Queries the name of @action.</doc>
50 <return-value transfer-ownership="none">
51 <doc xml:whitespace="preserve">the name of the action</doc>
52 <type name="utf8" c:type="gchar*"/>
55 <virtual-method name="get_parameter_type"
56 invoker="get_parameter_type"
58 <doc xml:whitespace="preserve">Queries the type of the parameter that must be given when activating
59 When activating the action using g_action_activate(), the #GVariant
60 given to that function must be of the type returned by this function.
61 In the case that this function returns %NULL, you must not give any
62 #GVariant, but %NULL instead.</doc>
63 <return-value transfer-ownership="none">
64 <doc xml:whitespace="preserve">the parameter type</doc>
65 <type name="GLib.VariantType" c:type="GVariantType*"/>
68 <virtual-method name="get_state" invoker="get_state" version="2.26">
69 <doc xml:whitespace="preserve">Queries the current state of @action.
70 If the action is not stateful then %NULL will be returned. If the
71 action is stateful then the type of the return value is the type
72 given by g_action_get_state_type().
73 The return value (if non-%NULL) should be freed with
74 g_variant_unref() when it is no longer required.</doc>
75 <return-value transfer-ownership="full">
76 <doc xml:whitespace="preserve">the current state of the action</doc>
77 <type name="GLib.Variant" c:type="GVariant*"/>
80 <virtual-method name="get_state_hint"
81 invoker="get_state_hint"
83 <doc xml:whitespace="preserve">Requests a hint about the valid range of values for the state of
84 If %NULL is returned it either means that the action is not stateful
85 or that there is no hint about the valid range of values for the
87 If a #GVariant array is returned then each item in the array is a
88 returned then the tuple specifies the inclusive lower and upper bound
89 of valid values for the state.
90 In any case, the information is merely a hint. It may be possible to
91 have a state value outside of the hinted range and setting a value
92 within the range may fail.
93 The return value (if non-%NULL) should be freed with
94 g_variant_unref() when it is no longer required.</doc>
95 <return-value transfer-ownership="full">
96 <doc xml:whitespace="preserve">the state range hint</doc>
97 <type name="GLib.Variant" c:type="GVariant*"/>
100 <virtual-method name="get_state_type"
101 invoker="get_state_type"
103 <doc xml:whitespace="preserve">Queries the type of the state of @action.
104 g_action_new_stateful()) then this function returns the #GVariantType
105 of the state. This is the type of the initial value given as the
106 state. All calls to g_action_set_state() must give a #GVariant of
107 this type and g_action_get_state() will return a #GVariant of the
109 this function will return %NULL. In that case, g_action_get_state()
110 will return %NULL and you must not call g_action_set_state().</doc>
111 <return-value transfer-ownership="none">
112 <doc xml:whitespace="preserve">the state type, if the action is stateful</doc>
113 <type name="GLib.VariantType" c:type="GVariantType*"/>
116 <virtual-method name="set_state" invoker="set_state" version="2.26">
117 <doc xml:whitespace="preserve">Request for the state of @action to be changed to @value.
118 The action must be stateful and @value must be of the correct type.
119 See g_action_get_state_type().
120 This call merely requests a change. The action may refuse to change
121 its state or may change its state to something other than @value.
122 See g_action_get_state_hint().
123 If the @value GVariant is floating, it is consumed.</doc>
124 <return-value transfer-ownership="none">
125 <type name="none" c:type="void"/>
128 <parameter name="state" transfer-ownership="none">
129 <type name="GLib.Variant" c:type="GVariant*"/>
133 <method name="activate" c:identifier="g_action_activate" version="2.26">
134 <doc xml:whitespace="preserve">Activates the action.
135 the parameter type given at construction time). If the parameter
136 type was %NULL then @parameter must also be %NULL.</doc>
137 <return-value transfer-ownership="none">
138 <type name="none" c:type="void"/>
141 <parameter name="parameter" transfer-ownership="none" allow-none="1">
142 <doc xml:whitespace="preserve">the parameter to the activation</doc>
143 <type name="GLib.Variant" c:type="GVariant*"/>
147 <method name="get_enabled"
148 c:identifier="g_action_get_enabled"
150 <doc xml:whitespace="preserve">Checks if @action is currently enabled.
151 An action must be enabled in order to be activated or in order to
152 have its state changed from outside callers.</doc>
153 <return-value transfer-ownership="none">
154 <doc xml:whitespace="preserve">whether the action is enabled</doc>
155 <type name="gboolean" c:type="gboolean"/>
158 <method name="get_name" c:identifier="g_action_get_name" version="2.26">
159 <doc xml:whitespace="preserve">Queries the name of @action.</doc>
160 <return-value transfer-ownership="none">
161 <doc xml:whitespace="preserve">the name of the action</doc>
162 <type name="utf8" c:type="gchar*"/>
165 <method name="get_parameter_type"
166 c:identifier="g_action_get_parameter_type"
168 <doc xml:whitespace="preserve">Queries the type of the parameter that must be given when activating
169 When activating the action using g_action_activate(), the #GVariant
170 given to that function must be of the type returned by this function.
171 In the case that this function returns %NULL, you must not give any
172 #GVariant, but %NULL instead.</doc>
173 <return-value transfer-ownership="none">
174 <doc xml:whitespace="preserve">the parameter type</doc>
175 <type name="GLib.VariantType" c:type="GVariantType*"/>
178 <method name="get_state"
179 c:identifier="g_action_get_state"
181 <doc xml:whitespace="preserve">Queries the current state of @action.
182 If the action is not stateful then %NULL will be returned. If the
183 action is stateful then the type of the return value is the type
184 given by g_action_get_state_type().
185 The return value (if non-%NULL) should be freed with
186 g_variant_unref() when it is no longer required.</doc>
187 <return-value transfer-ownership="full">
188 <doc xml:whitespace="preserve">the current state of the action</doc>
189 <type name="GLib.Variant" c:type="GVariant*"/>
192 <method name="get_state_hint"
193 c:identifier="g_action_get_state_hint"
195 <doc xml:whitespace="preserve">Requests a hint about the valid range of values for the state of
196 If %NULL is returned it either means that the action is not stateful
197 or that there is no hint about the valid range of values for the
199 If a #GVariant array is returned then each item in the array is a
200 returned then the tuple specifies the inclusive lower and upper bound
201 of valid values for the state.
202 In any case, the information is merely a hint. It may be possible to
203 have a state value outside of the hinted range and setting a value
204 within the range may fail.
205 The return value (if non-%NULL) should be freed with
206 g_variant_unref() when it is no longer required.</doc>
207 <return-value transfer-ownership="full">
208 <doc xml:whitespace="preserve">the state range hint</doc>
209 <type name="GLib.Variant" c:type="GVariant*"/>
212 <method name="get_state_type"
213 c:identifier="g_action_get_state_type"
215 <doc xml:whitespace="preserve">Queries the type of the state of @action.
216 g_action_new_stateful()) then this function returns the #GVariantType
217 of the state. This is the type of the initial value given as the
218 state. All calls to g_action_set_state() must give a #GVariant of
219 this type and g_action_get_state() will return a #GVariant of the
221 this function will return %NULL. In that case, g_action_get_state()
222 will return %NULL and you must not call g_action_set_state().</doc>
223 <return-value transfer-ownership="none">
224 <doc xml:whitespace="preserve">the state type, if the action is stateful</doc>
225 <type name="GLib.VariantType" c:type="GVariantType*"/>
228 <method name="set_state"
229 c:identifier="g_action_set_state"
231 <doc xml:whitespace="preserve">Request for the state of @action to be changed to @value.
232 The action must be stateful and @value must be of the correct type.
233 See g_action_get_state_type().
234 This call merely requests a change. The action may refuse to change
235 its state or may change its state to something other than @value.
236 See g_action_get_state_hint().
237 If the @value GVariant is floating, it is consumed.</doc>
238 <return-value transfer-ownership="none">
239 <type name="none" c:type="void"/>
242 <parameter name="value" transfer-ownership="none">
243 <doc xml:whitespace="preserve">the new state</doc>
244 <type name="GLib.Variant" c:type="GVariant*"/>
248 <property name="enabled" version="2.26" transfer-ownership="none">
249 <doc xml:whitespace="preserve">If @action is currently enabled.
250 If the action is disabled then calls to g_action_activate() and
251 g_action_set_state() have no effect.</doc>
252 <type name="gboolean"/>
254 <property name="name" version="2.26" transfer-ownership="none">
255 <doc xml:whitespace="preserve">The name of the action. This is mostly meaningful for identifying
256 the action once it has been added to a #GActionGroup.</doc>
259 <property name="parameter-type"
262 transfer-ownership="none">
263 <doc xml:whitespace="preserve">The type of the parameter that must be given when activating the
267 <property name="state"
271 transfer-ownership="none">
272 <doc xml:whitespace="preserve">The state of the action, or %NULL if the action is stateless.</doc>
273 <type name="GLib.Variant"/>
275 <property name="state-type"
278 transfer-ownership="none">
279 <doc xml:whitespace="preserve">The #GVariantType of the state that the action has, or %NULL if the
280 action is stateless.</doc>
284 <interface name="ActionGroup"
285 c:symbol-prefix="action_group"
286 c:type="GActionGroup"
287 glib:type-name="GActionGroup"
288 glib:get-type="g_action_group_get_type"
289 glib:type-struct="ActionGroupInterface">
290 <virtual-method name="activate" invoker="activate" version="2.26">
291 <doc xml:whitespace="preserve">Activate the named action within @action_group.
292 If the action is expecting a parameter, then the correct type of
293 parameter must be given as @parameter. If the action is expecting no
294 parameters then @parameter must be %NULL. See
295 g_action_group_get_parameter_type().</doc>
296 <return-value transfer-ownership="none">
297 <type name="none" c:type="void"/>
300 <parameter name="action_name" transfer-ownership="none">
301 <doc xml:whitespace="preserve">the name of the action to activate</doc>
302 <type name="utf8" c:type="gchar*"/>
304 <parameter name="parameter" transfer-ownership="none" allow-none="1">
305 <doc xml:whitespace="preserve">parameters to the activation</doc>
306 <type name="GLib.Variant" c:type="GVariant*"/>
310 <virtual-method name="get_enabled" invoker="get_enabled" version="2.26">
311 <doc xml:whitespace="preserve">Checks if the named action within @action_group is currently enabled.
312 An action must be enabled in order to be activated or in order to
313 have its state changed from outside callers.</doc>
314 <return-value transfer-ownership="none">
315 <doc xml:whitespace="preserve">whether or not the action is currently enabled</doc>
316 <type name="gboolean" c:type="gboolean"/>
319 <parameter name="action_name" transfer-ownership="none">
320 <doc xml:whitespace="preserve">the name of the action to query</doc>
321 <type name="utf8" c:type="gchar*"/>
325 <virtual-method name="get_parameter_type"
326 invoker="get_parameter_type"
328 <doc xml:whitespace="preserve">Queries the type of the parameter that must be given when activating
329 the named action within @action_group.
330 When activating the action using g_action_group_activate(), the
331 #GVariant given to that function must be of the type returned by this
333 In the case that this function returns %NULL, you must not give any
334 #GVariant, but %NULL instead.
335 The parameter type of a particular action will never change but it is
336 possible for an action to be removed and for a new action to be added
337 with the same name but a different parameter type.</doc>
338 <return-value transfer-ownership="none">
339 <doc xml:whitespace="preserve">the parameter type</doc>
340 <type name="GLib.VariantType" c:type="GVariantType*"/>
343 <parameter name="action_name" transfer-ownership="none">
344 <doc xml:whitespace="preserve">the name of the action to query</doc>
345 <type name="utf8" c:type="gchar*"/>
349 <virtual-method name="get_state" invoker="get_state" version="2.26">
350 <doc xml:whitespace="preserve">Queries the current state of the named action within @action_group.
351 If the action is not stateful then %NULL will be returned. If the
352 action is stateful then the type of the return value is the type
353 given by g_action_group_get_state_type().
354 The return value (if non-%NULL) should be freed with
355 g_variant_unref() when it is no longer required.</doc>
356 <return-value transfer-ownership="full">
357 <doc xml:whitespace="preserve">the current state of the action</doc>
358 <type name="GLib.Variant" c:type="GVariant*"/>
361 <parameter name="action_name" transfer-ownership="none">
362 <doc xml:whitespace="preserve">the name of the action to query</doc>
363 <type name="utf8" c:type="gchar*"/>
367 <virtual-method name="get_state_hint"
368 invoker="get_state_hint"
370 <doc xml:whitespace="preserve">Requests a hint about the valid range of values for the state of the
371 named action within @action_group.
372 If %NULL is returned it either means that the action is not stateful
373 or that there is no hint about the valid range of values for the
375 If a #GVariant array is returned then each item in the array is a
376 returned then the tuple specifies the inclusive lower and upper bound
377 of valid values for the state.
378 In any case, the information is merely a hint. It may be possible to
379 have a state value outside of the hinted range and setting a value
380 within the range may fail.
381 The return value (if non-%NULL) should be freed with
382 g_variant_unref() when it is no longer required.</doc>
383 <return-value transfer-ownership="full">
384 <doc xml:whitespace="preserve">the state range hint</doc>
385 <type name="GLib.Variant" c:type="GVariant*"/>
388 <parameter name="action_name" transfer-ownership="none">
389 <doc xml:whitespace="preserve">the name of the action to query</doc>
390 <type name="utf8" c:type="gchar*"/>
394 <virtual-method name="get_state_type"
395 invoker="get_state_type"
398 <doc xml:whitespace="preserve">Queries the type of the state of the named action within
399 If the action is stateful then this function returns the
400 #GVariantType of the state. All calls to g_action_group_set_state()
401 must give a #GVariant of this type and g_action_group_get_state()
402 will return a #GVariant of the same type.
403 If the action is not stateful then this function will return %NULL.
404 In that case, g_action_group_get_state() will return %NULL and you
405 must not call g_action_group_set_state().
406 The state type of a particular action will never change but it is
407 possible for an action to be removed and for a new action to be added
408 with the same name but a different state type.</doc>
409 <return-value transfer-ownership="full">
410 <doc xml:whitespace="preserve">the state type, if the action is stateful</doc>
411 <type name="GLib.VariantType" c:type="GVariantType*"/>
414 <parameter name="action_name" transfer-ownership="none">
415 <doc xml:whitespace="preserve">the name of the action to query</doc>
416 <type name="utf8" c:type="gchar*"/>
420 <virtual-method name="has_action" invoker="has_action" version="2.26">
421 <doc xml:whitespace="preserve">Checks if the named action exists within @action_group.</doc>
422 <return-value transfer-ownership="none">
423 <doc xml:whitespace="preserve">whether the named action exists</doc>
424 <type name="gboolean" c:type="gboolean"/>
427 <parameter name="action_name" transfer-ownership="none">
428 <doc xml:whitespace="preserve">the name of the action to check for</doc>
429 <type name="utf8" c:type="gchar*"/>
433 <virtual-method name="list_actions"
434 invoker="list_actions"
436 <doc xml:whitespace="preserve">Lists the actions contained within @action_group.
437 The caller is responsible for freeing the list with g_strfreev() when
438 it is no longer required.
439 actions in the groupb</doc>
440 <return-value transfer-ownership="full">
441 <doc xml:whitespace="preserve">a %NULL-terminated array of the names of the</doc>
442 <array c:type="gchar**">
447 <virtual-method name="set_state" invoker="set_state" version="2.26">
448 <doc xml:whitespace="preserve">Request for the state of the named action within @action_group to be
450 The action must be stateful and @value must be of the correct type.
451 See g_action_group_get_state_type().
452 This call merely requests a change. The action may refuse to change
453 its state or may change its state to something other than @value.
454 See g_action_group_get_state_hint().
455 If the @value GVariant is floating, it is consumed.</doc>
456 <return-value transfer-ownership="none">
457 <type name="none" c:type="void"/>
460 <parameter name="action_name" transfer-ownership="none">
461 <doc xml:whitespace="preserve">the name of the action to request the change on</doc>
462 <type name="utf8" c:type="gchar*"/>
464 <parameter name="value" transfer-ownership="none">
465 <doc xml:whitespace="preserve">the new state</doc>
466 <type name="GLib.Variant" c:type="GVariant*"/>
470 <method name="action_added"
471 c:identifier="g_action_group_action_added"
473 <doc xml:whitespace="preserve">Emits the #GActionGroup::action-added signal on @action_group.
474 This function should only be called by #GActionGroup implementations.</doc>
475 <return-value transfer-ownership="none">
476 <type name="none" c:type="void"/>
479 <parameter name="action_name" transfer-ownership="none">
480 <doc xml:whitespace="preserve">the name of an action in the group</doc>
481 <type name="utf8" c:type="gchar*"/>
485 <method name="action_enabled_changed"
486 c:identifier="g_action_group_action_enabled_changed"
488 <doc xml:whitespace="preserve">Emits the #GActionGroup::action-enabled-changed signal on @action_group.
489 This function should only be called by #GActionGroup implementations.</doc>
490 <return-value transfer-ownership="none">
491 <type name="none" c:type="void"/>
494 <parameter name="action_name" transfer-ownership="none">
495 <doc xml:whitespace="preserve">the name of an action in the group</doc>
496 <type name="utf8" c:type="gchar*"/>
498 <parameter name="enabled" transfer-ownership="none">
499 <doc xml:whitespace="preserve">whether or not the action is now enabled</doc>
500 <type name="gboolean" c:type="gboolean"/>
504 <method name="action_removed"
505 c:identifier="g_action_group_action_removed"
507 <doc xml:whitespace="preserve">Emits the #GActionGroup::action-removed signal on @action_group.
508 This function should only be called by #GActionGroup implementations.</doc>
509 <return-value transfer-ownership="none">
510 <type name="none" c:type="void"/>
513 <parameter name="action_name" transfer-ownership="none">
514 <doc xml:whitespace="preserve">the name of an action in the group</doc>
515 <type name="utf8" c:type="gchar*"/>
519 <method name="action_state_changed"
520 c:identifier="g_action_group_action_state_changed"
522 <doc xml:whitespace="preserve">Emits the #GActionGroup::action-state-changed signal on @action_group.
523 This function should only be called by #GActionGroup implementations.</doc>
524 <return-value transfer-ownership="none">
525 <type name="none" c:type="void"/>
528 <parameter name="action_name" transfer-ownership="none">
529 <doc xml:whitespace="preserve">the name of an action in the group</doc>
530 <type name="utf8" c:type="gchar*"/>
532 <parameter name="state" transfer-ownership="none">
533 <doc xml:whitespace="preserve">the new state of the named action</doc>
534 <type name="GLib.Variant" c:type="GVariant*"/>
538 <method name="activate"
539 c:identifier="g_action_group_activate"
541 <doc xml:whitespace="preserve">Activate the named action within @action_group.
542 If the action is expecting a parameter, then the correct type of
543 parameter must be given as @parameter. If the action is expecting no
544 parameters then @parameter must be %NULL. See
545 g_action_group_get_parameter_type().</doc>
546 <return-value transfer-ownership="none">
547 <type name="none" c:type="void"/>
550 <parameter name="action_name" transfer-ownership="none">
551 <doc xml:whitespace="preserve">the name of the action to activate</doc>
552 <type name="utf8" c:type="gchar*"/>
554 <parameter name="parameter" transfer-ownership="none" allow-none="1">
555 <doc xml:whitespace="preserve">parameters to the activation</doc>
556 <type name="GLib.Variant" c:type="GVariant*"/>
560 <method name="get_enabled"
561 c:identifier="g_action_group_get_enabled"
563 <doc xml:whitespace="preserve">Checks if the named action within @action_group is currently enabled.
564 An action must be enabled in order to be activated or in order to
565 have its state changed from outside callers.</doc>
566 <return-value transfer-ownership="none">
567 <doc xml:whitespace="preserve">whether or not the action is currently enabled</doc>
568 <type name="gboolean" c:type="gboolean"/>
571 <parameter name="action_name" transfer-ownership="none">
572 <doc xml:whitespace="preserve">the name of the action to query</doc>
573 <type name="utf8" c:type="gchar*"/>
577 <method name="get_parameter_type"
578 c:identifier="g_action_group_get_parameter_type"
580 <doc xml:whitespace="preserve">Queries the type of the parameter that must be given when activating
581 the named action within @action_group.
582 When activating the action using g_action_group_activate(), the
583 #GVariant given to that function must be of the type returned by this
585 In the case that this function returns %NULL, you must not give any
586 #GVariant, but %NULL instead.
587 The parameter type of a particular action will never change but it is
588 possible for an action to be removed and for a new action to be added
589 with the same name but a different parameter type.</doc>
590 <return-value transfer-ownership="none">
591 <doc xml:whitespace="preserve">the parameter type</doc>
592 <type name="GLib.VariantType" c:type="GVariantType*"/>
595 <parameter name="action_name" transfer-ownership="none">
596 <doc xml:whitespace="preserve">the name of the action to query</doc>
597 <type name="utf8" c:type="gchar*"/>
601 <method name="get_state"
602 c:identifier="g_action_group_get_state"
604 <doc xml:whitespace="preserve">Queries the current state of the named action within @action_group.
605 If the action is not stateful then %NULL will be returned. If the
606 action is stateful then the type of the return value is the type
607 given by g_action_group_get_state_type().
608 The return value (if non-%NULL) should be freed with
609 g_variant_unref() when it is no longer required.</doc>
610 <return-value transfer-ownership="full">
611 <doc xml:whitespace="preserve">the current state of the action</doc>
612 <type name="GLib.Variant" c:type="GVariant*"/>
615 <parameter name="action_name" transfer-ownership="none">
616 <doc xml:whitespace="preserve">the name of the action to query</doc>
617 <type name="utf8" c:type="gchar*"/>
621 <method name="get_state_hint"
622 c:identifier="g_action_group_get_state_hint"
624 <doc xml:whitespace="preserve">Requests a hint about the valid range of values for the state of the
625 named action within @action_group.
626 If %NULL is returned it either means that the action is not stateful
627 or that there is no hint about the valid range of values for the
629 If a #GVariant array is returned then each item in the array is a
630 returned then the tuple specifies the inclusive lower and upper bound
631 of valid values for the state.
632 In any case, the information is merely a hint. It may be possible to
633 have a state value outside of the hinted range and setting a value
634 within the range may fail.
635 The return value (if non-%NULL) should be freed with
636 g_variant_unref() when it is no longer required.</doc>
637 <return-value transfer-ownership="full">
638 <doc xml:whitespace="preserve">the state range hint</doc>
639 <type name="GLib.Variant" c:type="GVariant*"/>
642 <parameter name="action_name" transfer-ownership="none">
643 <doc xml:whitespace="preserve">the name of the action to query</doc>
644 <type name="utf8" c:type="gchar*"/>
648 <method name="get_state_type"
649 c:identifier="g_action_group_get_state_type"
652 <doc xml:whitespace="preserve">Queries the type of the state of the named action within
653 If the action is stateful then this function returns the
654 #GVariantType of the state. All calls to g_action_group_set_state()
655 must give a #GVariant of this type and g_action_group_get_state()
656 will return a #GVariant of the same type.
657 If the action is not stateful then this function will return %NULL.
658 In that case, g_action_group_get_state() will return %NULL and you
659 must not call g_action_group_set_state().
660 The state type of a particular action will never change but it is
661 possible for an action to be removed and for a new action to be added
662 with the same name but a different state type.</doc>
663 <return-value transfer-ownership="full">
664 <doc xml:whitespace="preserve">the state type, if the action is stateful</doc>
665 <type name="GLib.VariantType" c:type="GVariantType*"/>
668 <parameter name="action_name" transfer-ownership="none">
669 <doc xml:whitespace="preserve">the name of the action to query</doc>
670 <type name="utf8" c:type="gchar*"/>
674 <method name="has_action"
675 c:identifier="g_action_group_has_action"
677 <doc xml:whitespace="preserve">Checks if the named action exists within @action_group.</doc>
678 <return-value transfer-ownership="none">
679 <doc xml:whitespace="preserve">whether the named action exists</doc>
680 <type name="gboolean" c:type="gboolean"/>
683 <parameter name="action_name" transfer-ownership="none">
684 <doc xml:whitespace="preserve">the name of the action to check for</doc>
685 <type name="utf8" c:type="gchar*"/>
689 <method name="list_actions"
690 c:identifier="g_action_group_list_actions"
692 <doc xml:whitespace="preserve">Lists the actions contained within @action_group.
693 The caller is responsible for freeing the list with g_strfreev() when
694 it is no longer required.
695 actions in the groupb</doc>
696 <return-value transfer-ownership="full">
697 <doc xml:whitespace="preserve">a %NULL-terminated array of the names of the</doc>
698 <array c:type="gchar**">
703 <method name="set_state"
704 c:identifier="g_action_group_set_state"
706 <doc xml:whitespace="preserve">Request for the state of the named action within @action_group to be
708 The action must be stateful and @value must be of the correct type.
709 See g_action_group_get_state_type().
710 This call merely requests a change. The action may refuse to change
711 its state or may change its state to something other than @value.
712 See g_action_group_get_state_hint().
713 If the @value GVariant is floating, it is consumed.</doc>
714 <return-value transfer-ownership="none">
715 <type name="none" c:type="void"/>
718 <parameter name="action_name" transfer-ownership="none">
719 <doc xml:whitespace="preserve">the name of the action to request the change on</doc>
720 <type name="utf8" c:type="gchar*"/>
722 <parameter name="value" transfer-ownership="none">
723 <doc xml:whitespace="preserve">the new state</doc>
724 <type name="GLib.Variant" c:type="GVariant*"/>
728 <glib:signal name="action-added" version="2.26">
729 <doc xml:whitespace="preserve">Signals that a new action was just added to the group. This signal
730 is emitted after the action has been added and is now visible.</doc>
731 <return-value transfer-ownership="none">
735 <parameter name="object" transfer-ownership="none">
736 <doc xml:whitespace="preserve">the name of the action in @action_group</doc>
741 <glib:signal name="action-enabled-changed" version="2.26">
742 <doc xml:whitespace="preserve">Signals that the enabled status of the named action has changed.</doc>
743 <return-value transfer-ownership="none">
747 <parameter name="object" transfer-ownership="none">
748 <doc xml:whitespace="preserve">the name of the action in @action_group</doc>
751 <parameter name="p0" transfer-ownership="none">
752 <doc xml:whitespace="preserve">whether the action is enabled or not</doc>
753 <type name="gboolean"/>
757 <glib:signal name="action-removed" version="2.26">
758 <doc xml:whitespace="preserve">Signals that an action is just about to be removed from the group.
759 This signal is emitted before the action is removed, so the action
760 is still visible and can be queried from the signal handler.</doc>
761 <return-value transfer-ownership="none">
765 <parameter name="object" transfer-ownership="none">
766 <doc xml:whitespace="preserve">the name of the action in @action_group</doc>
771 <glib:signal name="action-state-changed" version="2.26">
772 <doc xml:whitespace="preserve">Signals that the state of the named action has changed.</doc>
773 <return-value transfer-ownership="none">
777 <parameter name="object" transfer-ownership="none">
778 <doc xml:whitespace="preserve">the name of the action in @action_group</doc>
781 <parameter name="p0" transfer-ownership="none">
782 <doc xml:whitespace="preserve">the new value of the state</doc>
783 <type name="GLib.Variant"/>
788 <record name="ActionGroupInterface"
789 c:type="GActionGroupInterface"
790 glib:is-gtype-struct-for="ActionGroup"
792 <doc xml:whitespace="preserve">The virtual function table for #GActionGroup.</doc>
793 <field name="g_iface">
794 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
796 <field name="has_action">
797 <callback name="has_action">
798 <return-value transfer-ownership="none">
799 <doc xml:whitespace="preserve">whether the named action exists</doc>
800 <type name="gboolean" c:type="gboolean"/>
803 <parameter name="action_group" transfer-ownership="none">
804 <type name="ActionGroup" c:type="GActionGroup*"/>
806 <parameter name="action_name" transfer-ownership="none">
807 <doc xml:whitespace="preserve">the name of the action to check for</doc>
808 <type name="utf8" c:type="gchar*"/>
813 <field name="list_actions">
814 <callback name="list_actions">
815 <return-value transfer-ownership="full">
816 <doc xml:whitespace="preserve">a %NULL-terminated array of the names of the</doc>
817 <array c:type="gchar**">
822 <parameter name="action_group" transfer-ownership="none">
823 <type name="ActionGroup" c:type="GActionGroup*"/>
828 <field name="get_enabled">
829 <callback name="get_enabled">
830 <return-value transfer-ownership="none">
831 <doc xml:whitespace="preserve">whether or not the action is currently enabled</doc>
832 <type name="gboolean" c:type="gboolean"/>
835 <parameter name="action_group" transfer-ownership="none">
836 <type name="ActionGroup" c:type="GActionGroup*"/>
838 <parameter name="action_name" transfer-ownership="none">
839 <doc xml:whitespace="preserve">the name of the action to query</doc>
840 <type name="utf8" c:type="gchar*"/>
845 <field name="get_parameter_type">
846 <callback name="get_parameter_type">
847 <return-value transfer-ownership="none">
848 <doc xml:whitespace="preserve">the parameter type</doc>
849 <type name="GLib.VariantType" c:type="GVariantType*"/>
852 <parameter name="action_group" transfer-ownership="none">
853 <type name="ActionGroup" c:type="GActionGroup*"/>
855 <parameter name="action_name" transfer-ownership="none">
856 <doc xml:whitespace="preserve">the name of the action to query</doc>
857 <type name="utf8" c:type="gchar*"/>
862 <field name="get_state_type" introspectable="0">
863 <callback name="get_state_type" introspectable="0">
864 <return-value transfer-ownership="full">
865 <doc xml:whitespace="preserve">the state type, if the action is stateful</doc>
866 <type name="GLib.VariantType" c:type="GVariantType*"/>
869 <parameter name="action_group" transfer-ownership="none">
870 <type name="ActionGroup" c:type="GActionGroup*"/>
872 <parameter name="action_name" transfer-ownership="none">
873 <doc xml:whitespace="preserve">the name of the action to query</doc>
874 <type name="utf8" c:type="gchar*"/>
879 <field name="get_state_hint">
880 <callback name="get_state_hint">
881 <return-value transfer-ownership="full">
882 <doc xml:whitespace="preserve">the state range hint</doc>
883 <type name="GLib.Variant" c:type="GVariant*"/>
886 <parameter name="action_group" transfer-ownership="none">
887 <type name="ActionGroup" c:type="GActionGroup*"/>
889 <parameter name="action_name" transfer-ownership="none">
890 <doc xml:whitespace="preserve">the name of the action to query</doc>
891 <type name="utf8" c:type="gchar*"/>
896 <field name="get_state">
897 <callback name="get_state">
898 <return-value transfer-ownership="full">
899 <doc xml:whitespace="preserve">the current state of the action</doc>
900 <type name="GLib.Variant" c:type="GVariant*"/>
903 <parameter name="action_group" transfer-ownership="none">
904 <type name="ActionGroup" c:type="GActionGroup*"/>
906 <parameter name="action_name" transfer-ownership="none">
907 <doc xml:whitespace="preserve">the name of the action to query</doc>
908 <type name="utf8" c:type="gchar*"/>
913 <field name="set_state">
914 <callback name="set_state">
915 <return-value transfer-ownership="none">
916 <type name="none" c:type="void"/>
919 <parameter name="action_group" transfer-ownership="none">
920 <type name="ActionGroup" c:type="GActionGroup*"/>
922 <parameter name="action_name" transfer-ownership="none">
923 <doc xml:whitespace="preserve">the name of the action to request the change on</doc>
924 <type name="utf8" c:type="gchar*"/>
926 <parameter name="value" transfer-ownership="none">
927 <doc xml:whitespace="preserve">the new state</doc>
928 <type name="GLib.Variant" c:type="GVariant*"/>
933 <field name="activate">
934 <callback name="activate">
935 <return-value transfer-ownership="none">
936 <type name="none" c:type="void"/>
939 <parameter name="action_group" transfer-ownership="none">
940 <type name="ActionGroup" c:type="GActionGroup*"/>
942 <parameter name="action_name" transfer-ownership="none">
943 <doc xml:whitespace="preserve">the name of the action to activate</doc>
944 <type name="utf8" c:type="gchar*"/>
946 <parameter name="parameter"
947 transfer-ownership="none"
949 <doc xml:whitespace="preserve">parameters to the activation</doc>
950 <type name="GLib.Variant" c:type="GVariant*"/>
955 <field name="action_added">
956 <callback name="action_added">
957 <return-value transfer-ownership="none">
958 <type name="none" c:type="void"/>
961 <parameter name="action_group" transfer-ownership="none">
962 <type name="ActionGroup" c:type="GActionGroup*"/>
964 <parameter name="action_name" transfer-ownership="none">
965 <type name="utf8" c:type="gchar*"/>
970 <field name="action_removed">
971 <callback name="action_removed">
972 <return-value transfer-ownership="none">
973 <type name="none" c:type="void"/>
976 <parameter name="action_group" transfer-ownership="none">
977 <type name="ActionGroup" c:type="GActionGroup*"/>
979 <parameter name="action_name" transfer-ownership="none">
980 <type name="utf8" c:type="gchar*"/>
985 <field name="action_enabled_changed">
986 <callback name="action_enabled_changed">
987 <return-value transfer-ownership="none">
988 <type name="none" c:type="void"/>
991 <parameter name="action_group" transfer-ownership="none">
992 <type name="ActionGroup" c:type="GActionGroup*"/>
994 <parameter name="action_name" transfer-ownership="none">
995 <type name="utf8" c:type="gchar*"/>
997 <parameter name="enabled" transfer-ownership="none">
998 <type name="gboolean" c:type="gboolean"/>
1003 <field name="action_state_changed">
1004 <callback name="action_state_changed">
1005 <return-value transfer-ownership="none">
1006 <type name="none" c:type="void"/>
1009 <parameter name="action_group" transfer-ownership="none">
1010 <type name="ActionGroup" c:type="GActionGroup*"/>
1012 <parameter name="action_name" transfer-ownership="none">
1013 <type name="utf8" c:type="gchar*"/>
1015 <parameter name="value" transfer-ownership="none">
1016 <type name="GLib.Variant" c:type="GVariant*"/>
1022 <record name="ActionInterface"
1023 c:type="GActionInterface"
1024 glib:is-gtype-struct-for="Action"
1026 <field name="g_iface">
1027 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
1029 <field name="get_name">
1030 <callback name="get_name">
1031 <return-value transfer-ownership="none">
1032 <doc xml:whitespace="preserve">the name of the action</doc>
1033 <type name="utf8" c:type="gchar*"/>
1036 <parameter name="action" transfer-ownership="none">
1037 <type name="Action" c:type="GAction*"/>
1042 <field name="get_parameter_type">
1043 <callback name="get_parameter_type">
1044 <return-value transfer-ownership="none">
1045 <doc xml:whitespace="preserve">the parameter type</doc>
1046 <type name="GLib.VariantType" c:type="GVariantType*"/>
1049 <parameter name="action" transfer-ownership="none">
1050 <type name="Action" c:type="GAction*"/>
1055 <field name="get_state_type">
1056 <callback name="get_state_type">
1057 <return-value transfer-ownership="none">
1058 <doc xml:whitespace="preserve">the state type, if the action is stateful</doc>
1059 <type name="GLib.VariantType" c:type="GVariantType*"/>
1062 <parameter name="action" transfer-ownership="none">
1063 <type name="Action" c:type="GAction*"/>
1068 <field name="get_state_hint">
1069 <callback name="get_state_hint">
1070 <return-value transfer-ownership="full">
1071 <doc xml:whitespace="preserve">the state range hint</doc>
1072 <type name="GLib.Variant" c:type="GVariant*"/>
1075 <parameter name="action" transfer-ownership="none">
1076 <type name="Action" c:type="GAction*"/>
1081 <field name="get_enabled">
1082 <callback name="get_enabled">
1083 <return-value transfer-ownership="none">
1084 <doc xml:whitespace="preserve">whether the action is enabled</doc>
1085 <type name="gboolean" c:type="gboolean"/>
1088 <parameter name="action" transfer-ownership="none">
1089 <type name="Action" c:type="GAction*"/>
1094 <field name="get_state">
1095 <callback name="get_state">
1096 <return-value transfer-ownership="full">
1097 <doc xml:whitespace="preserve">the current state of the action</doc>
1098 <type name="GLib.Variant" c:type="GVariant*"/>
1101 <parameter name="action" transfer-ownership="none">
1102 <type name="Action" c:type="GAction*"/>
1107 <field name="set_state">
1108 <callback name="set_state">
1109 <return-value transfer-ownership="none">
1110 <type name="none" c:type="void"/>
1113 <parameter name="action" transfer-ownership="none">
1114 <type name="Action" c:type="GAction*"/>
1116 <parameter name="state" transfer-ownership="none">
1117 <type name="GLib.Variant" c:type="GVariant*"/>
1122 <field name="activate">
1123 <callback name="activate">
1124 <return-value transfer-ownership="none">
1125 <type name="none" c:type="void"/>
1128 <parameter name="action" transfer-ownership="none">
1129 <type name="Action" c:type="GAction*"/>
1131 <parameter name="parameter"
1132 transfer-ownership="none"
1134 <doc xml:whitespace="preserve">the parameter to the activation</doc>
1135 <type name="GLib.Variant" c:type="GVariant*"/>
1141 <interface name="AppInfo"
1142 c:symbol-prefix="app_info"
1144 glib:type-name="GAppInfo"
1145 glib:get-type="g_app_info_get_type"
1146 glib:type-struct="AppInfoIface">
1147 <doc xml:whitespace="preserve">Information about an installed application and methods to launch
1148 it (with file arguments).</doc>
1149 <virtual-method name="add_supports_type"
1150 invoker="add_supports_type"
1152 <doc xml:whitespace="preserve">Adds a content type to the application information to indicate the
1153 application is capable of opening files with the given content type.</doc>
1154 <return-value transfer-ownership="none">
1155 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1156 <type name="gboolean" c:type="gboolean"/>
1159 <parameter name="content_type" transfer-ownership="none">
1160 <doc xml:whitespace="preserve">a string.</doc>
1161 <type name="utf8" c:type="char*"/>
1165 <virtual-method name="can_delete" invoker="can_delete" version="2.20">
1166 <doc xml:whitespace="preserve">Obtains the information whether the #GAppInfo can be deleted.
1167 See g_app_info_delete().</doc>
1168 <return-value transfer-ownership="none">
1169 <doc xml:whitespace="preserve">%TRUE if @appinfo can be deleted</doc>
1170 <type name="gboolean" c:type="gboolean"/>
1173 <virtual-method name="can_remove_supports_type"
1174 invoker="can_remove_supports_type">
1175 <doc xml:whitespace="preserve">Checks if a supported content type can be removed from an application.
1176 content types from a given @appinfo, %FALSE if not.</doc>
1177 <return-value transfer-ownership="none">
1178 <doc xml:whitespace="preserve">%TRUE if it is possible to remove supported</doc>
1179 <type name="gboolean" c:type="gboolean"/>
1182 <virtual-method name="do_delete" invoker="delete" version="2.20">
1183 <doc xml:whitespace="preserve">Tries to delete a #GAppInfo.
1184 On some platforms, there may be a difference between user-defined
1185 #GAppInfo<!-- -->s which can be deleted, and system-wide ones which
1186 cannot. See g_app_info_can_delete().</doc>
1187 <return-value transfer-ownership="none">
1188 <doc xml:whitespace="preserve">%TRUE if @appinfo has been deleted</doc>
1189 <type name="gboolean" c:type="gboolean"/>
1192 <virtual-method name="dup" invoker="dup">
1193 <doc xml:whitespace="preserve">Creates a duplicate of a #GAppInfo.</doc>
1194 <return-value transfer-ownership="full">
1195 <doc xml:whitespace="preserve">a duplicate of @appinfo.</doc>
1196 <type name="AppInfo" c:type="GAppInfo*"/>
1199 <virtual-method name="equal" invoker="equal">
1200 <doc xml:whitespace="preserve">Checks if two #GAppInfo<!-- -->s are equal.</doc>
1201 <return-value transfer-ownership="none">
1202 <doc xml:whitespace="preserve">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise.</doc>
1203 <type name="gboolean" c:type="gboolean"/>
1206 <parameter name="appinfo2" transfer-ownership="none">
1207 <doc xml:whitespace="preserve">the second #GAppInfo.</doc>
1208 <type name="AppInfo" c:type="GAppInfo*"/>
1212 <virtual-method name="get_commandline"
1213 invoker="get_commandline"
1215 <doc xml:whitespace="preserve">Gets the commandline with which the application will be
1217 or %NULL if this information is not available</doc>
1218 <return-value transfer-ownership="none">
1219 <doc xml:whitespace="preserve">a string containing the @appinfo's commandline,</doc>
1220 <type name="utf8" c:type="char*"/>
1223 <virtual-method name="get_description" invoker="get_description">
1224 <doc xml:whitespace="preserve">Gets a human-readable description of an installed application.
1225 application @appinfo, or %NULL if none.</doc>
1226 <return-value transfer-ownership="none">
1227 <doc xml:whitespace="preserve">a string containing a description of the</doc>
1228 <type name="utf8" c:type="char*"/>
1231 <virtual-method name="get_display_name"
1232 invoker="get_display_name"
1234 <doc xml:whitespace="preserve">Gets the display name of the application. The display name is often more
1235 descriptive to the user than the name itself.
1236 no display name is available.</doc>
1237 <return-value transfer-ownership="none">
1238 <doc xml:whitespace="preserve">the display name of the application for @appinfo, or the name if</doc>
1239 <type name="utf8" c:type="char*"/>
1242 <virtual-method name="get_executable" invoker="get_executable">
1243 <doc xml:whitespace="preserve">Gets the executable's name for the installed application.
1245 <return-value transfer-ownership="none">
1246 <doc xml:whitespace="preserve">a string containing the @appinfo's application</doc>
1247 <type name="utf8" c:type="char*"/>
1250 <virtual-method name="get_icon" invoker="get_icon">
1251 <doc xml:whitespace="preserve">Gets the icon for the application.</doc>
1252 <return-value transfer-ownership="none">
1253 <doc xml:whitespace="preserve">the default #GIcon for @appinfo.</doc>
1254 <type name="Icon" c:type="GIcon*"/>
1257 <virtual-method name="get_id" invoker="get_id">
1258 <doc xml:whitespace="preserve">Gets the ID of an application. An id is a string that
1259 identifies the application. The exact format of the id is
1260 platform dependent. For instance, on Unix this is the
1261 desktop file id from the xdg menu specification.
1262 Note that the returned ID may be %NULL, depending on how
1263 the @appinfo has been constructed.</doc>
1264 <return-value transfer-ownership="none">
1265 <doc xml:whitespace="preserve">a string containing the application's ID.</doc>
1266 <type name="utf8" c:type="char*"/>
1269 <virtual-method name="get_name" invoker="get_name">
1270 <doc xml:whitespace="preserve">Gets the installed name of the application.</doc>
1271 <return-value transfer-ownership="none">
1272 <doc xml:whitespace="preserve">the name of the application for @appinfo.</doc>
1273 <type name="utf8" c:type="char*"/>
1276 <virtual-method name="launch" invoker="launch" throws="1">
1277 <doc xml:whitespace="preserve">Launches the application. Passes @files to the launched application
1278 as arguments, using the optional @launch_context to get information
1279 about the details of the launcher (like what screen it is on).
1280 On error, @error will be set accordingly.
1281 To launch the application without arguments pass a %NULL @files list.
1282 Note that even if the launch is successful the application launched
1283 can fail to start if it runs into problems during startup. There is
1284 no way to detect this.
1285 Some URIs can be changed when passed through a GFile (for instance
1286 unsupported uris with strange formats like mailto:), so if you have
1287 a textual uri you want to pass in as argument, consider using
1288 g_app_info_launch_uris() instead.
1289 On UNIX, this function sets the <envvar>GIO_LAUNCHED_DESKTOP_FILE</envvar>
1290 environment variable with the path of the launched desktop file and
1291 <envvar>GIO_LAUNCHED_DESKTOP_FILE_PID</envvar> to the process
1292 id of the launched process. This can be used to ignore
1293 <envvar>GIO_LAUNCHED_DESKTOP_FILE</envvar>, should it be inherited
1294 by further processes. The <envvar>DISPLAY</envvar> and
1295 <envvar>DESKTOP_STARTUP_ID</envvar> environment variables are also
1296 set, based on information provided in @launch_context.</doc>
1297 <return-value transfer-ownership="none">
1298 <doc xml:whitespace="preserve">%TRUE on successful launch, %FALSE otherwise.</doc>
1299 <type name="gboolean" c:type="gboolean"/>
1302 <parameter name="filenames" transfer-ownership="none">
1303 <type name="GLib.List" c:type="GList*">
1304 <type name="gpointer" c:type="gpointer"/>
1307 <parameter name="launch_context"
1308 transfer-ownership="none"
1310 <doc xml:whitespace="preserve">a #GAppLaunchContext or %NULL</doc>
1311 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
1315 <virtual-method name="launch_uris" invoker="launch_uris" throws="1">
1316 <doc xml:whitespace="preserve">Launches the application. Passes @uris to the launched application
1317 as arguments, using the optional @launch_context to get information
1318 about the details of the launcher (like what screen it is on).
1319 On error, @error will be set accordingly.
1320 To lauch the application without arguments pass a %NULL @uris list.
1321 Note that even if the launch is successful the application launched
1322 can fail to start if it runs into problems during startup. There is
1323 no way to detect this.</doc>
1324 <return-value transfer-ownership="none">
1325 <doc xml:whitespace="preserve">%TRUE on successful launch, %FALSE otherwise.</doc>
1326 <type name="gboolean" c:type="gboolean"/>
1329 <parameter name="uris" transfer-ownership="none">
1330 <doc xml:whitespace="preserve">a #GList containing URIs to launch.</doc>
1331 <type name="GLib.List" c:type="GList*">
1335 <parameter name="launch_context"
1336 transfer-ownership="none"
1338 <doc xml:whitespace="preserve">a #GAppLaunchContext or %NULL</doc>
1339 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
1343 <virtual-method name="remove_supports_type"
1344 invoker="remove_supports_type"
1346 <doc xml:whitespace="preserve">Removes a supported type from an application, if possible.</doc>
1347 <return-value transfer-ownership="none">
1348 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1349 <type name="gboolean" c:type="gboolean"/>
1352 <parameter name="content_type" transfer-ownership="none">
1353 <doc xml:whitespace="preserve">a string.</doc>
1354 <type name="utf8" c:type="char*"/>
1358 <virtual-method name="set_as_default_for_extension"
1359 invoker="set_as_default_for_extension"
1361 <doc xml:whitespace="preserve">Sets the application as the default handler for the given file extension.</doc>
1362 <return-value transfer-ownership="none">
1363 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1364 <type name="gboolean" c:type="gboolean"/>
1367 <parameter name="extension" transfer-ownership="none">
1368 <doc xml:whitespace="preserve">a string containing the file extension (without the dot).</doc>
1369 <type name="utf8" c:type="char*"/>
1373 <virtual-method name="set_as_default_for_type"
1374 invoker="set_as_default_for_type"
1376 <doc xml:whitespace="preserve">Sets the application as the default handler for a given type.</doc>
1377 <return-value transfer-ownership="none">
1378 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1379 <type name="gboolean" c:type="gboolean"/>
1382 <parameter name="content_type" transfer-ownership="none">
1383 <doc xml:whitespace="preserve">the content type.</doc>
1384 <type name="utf8" c:type="char*"/>
1388 <virtual-method name="should_show" invoker="should_show">
1389 <doc xml:whitespace="preserve">Checks if the application info should be shown in menus that
1390 list available applications.</doc>
1391 <return-value transfer-ownership="none">
1392 <doc xml:whitespace="preserve">%TRUE if the @appinfo should be shown, %FALSE otherwise.</doc>
1393 <type name="gboolean" c:type="gboolean"/>
1396 <virtual-method name="supports_files" invoker="supports_files">
1397 <doc xml:whitespace="preserve">Checks if the application accepts files as arguments.</doc>
1398 <return-value transfer-ownership="none">
1399 <doc xml:whitespace="preserve">%TRUE if the @appinfo supports files.</doc>
1400 <type name="gboolean" c:type="gboolean"/>
1403 <virtual-method name="supports_uris" invoker="supports_uris">
1404 <doc xml:whitespace="preserve">Checks if the application supports reading files and directories from URIs.</doc>
1405 <return-value transfer-ownership="none">
1406 <doc xml:whitespace="preserve">%TRUE if the @appinfo supports URIs.</doc>
1407 <type name="gboolean" c:type="gboolean"/>
1410 <method name="add_supports_type"
1411 c:identifier="g_app_info_add_supports_type"
1413 <doc xml:whitespace="preserve">Adds a content type to the application information to indicate the
1414 application is capable of opening files with the given content type.</doc>
1415 <return-value transfer-ownership="none">
1416 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1417 <type name="gboolean" c:type="gboolean"/>
1420 <parameter name="content_type" transfer-ownership="none">
1421 <doc xml:whitespace="preserve">a string.</doc>
1422 <type name="utf8" c:type="char*"/>
1426 <method name="can_delete"
1427 c:identifier="g_app_info_can_delete"
1429 <doc xml:whitespace="preserve">Obtains the information whether the #GAppInfo can be deleted.
1430 See g_app_info_delete().</doc>
1431 <return-value transfer-ownership="none">
1432 <doc xml:whitespace="preserve">%TRUE if @appinfo can be deleted</doc>
1433 <type name="gboolean" c:type="gboolean"/>
1436 <method name="can_remove_supports_type"
1437 c:identifier="g_app_info_can_remove_supports_type">
1438 <doc xml:whitespace="preserve">Checks if a supported content type can be removed from an application.
1439 content types from a given @appinfo, %FALSE if not.</doc>
1440 <return-value transfer-ownership="none">
1441 <doc xml:whitespace="preserve">%TRUE if it is possible to remove supported</doc>
1442 <type name="gboolean" c:type="gboolean"/>
1445 <method name="delete" c:identifier="g_app_info_delete" version="2.20">
1446 <doc xml:whitespace="preserve">Tries to delete a #GAppInfo.
1447 On some platforms, there may be a difference between user-defined
1448 #GAppInfo<!-- -->s which can be deleted, and system-wide ones which
1449 cannot. See g_app_info_can_delete().</doc>
1450 <return-value transfer-ownership="none">
1451 <doc xml:whitespace="preserve">%TRUE if @appinfo has been deleted</doc>
1452 <type name="gboolean" c:type="gboolean"/>
1455 <method name="dup" c:identifier="g_app_info_dup">
1456 <doc xml:whitespace="preserve">Creates a duplicate of a #GAppInfo.</doc>
1457 <return-value transfer-ownership="full">
1458 <doc xml:whitespace="preserve">a duplicate of @appinfo.</doc>
1459 <type name="AppInfo" c:type="GAppInfo*"/>
1462 <method name="equal" c:identifier="g_app_info_equal">
1463 <doc xml:whitespace="preserve">Checks if two #GAppInfo<!-- -->s are equal.</doc>
1464 <return-value transfer-ownership="none">
1465 <doc xml:whitespace="preserve">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise.</doc>
1466 <type name="gboolean" c:type="gboolean"/>
1469 <parameter name="appinfo2" transfer-ownership="none">
1470 <doc xml:whitespace="preserve">the second #GAppInfo.</doc>
1471 <type name="AppInfo" c:type="GAppInfo*"/>
1475 <method name="get_commandline"
1476 c:identifier="g_app_info_get_commandline"
1478 <doc xml:whitespace="preserve">Gets the commandline with which the application will be
1480 or %NULL if this information is not available</doc>
1481 <return-value transfer-ownership="none">
1482 <doc xml:whitespace="preserve">a string containing the @appinfo's commandline,</doc>
1483 <type name="utf8" c:type="char*"/>
1486 <method name="get_description" c:identifier="g_app_info_get_description">
1487 <doc xml:whitespace="preserve">Gets a human-readable description of an installed application.
1488 application @appinfo, or %NULL if none.</doc>
1489 <return-value transfer-ownership="none">
1490 <doc xml:whitespace="preserve">a string containing a description of the</doc>
1491 <type name="utf8" c:type="char*"/>
1494 <method name="get_display_name"
1495 c:identifier="g_app_info_get_display_name"
1497 <doc xml:whitespace="preserve">Gets the display name of the application. The display name is often more
1498 descriptive to the user than the name itself.
1499 no display name is available.</doc>
1500 <return-value transfer-ownership="none">
1501 <doc xml:whitespace="preserve">the display name of the application for @appinfo, or the name if</doc>
1502 <type name="utf8" c:type="char*"/>
1505 <method name="get_executable" c:identifier="g_app_info_get_executable">
1506 <doc xml:whitespace="preserve">Gets the executable's name for the installed application.
1508 <return-value transfer-ownership="none">
1509 <doc xml:whitespace="preserve">a string containing the @appinfo's application</doc>
1510 <type name="utf8" c:type="char*"/>
1513 <method name="get_icon" c:identifier="g_app_info_get_icon">
1514 <doc xml:whitespace="preserve">Gets the icon for the application.</doc>
1515 <return-value transfer-ownership="none">
1516 <doc xml:whitespace="preserve">the default #GIcon for @appinfo.</doc>
1517 <type name="Icon" c:type="GIcon*"/>
1520 <method name="get_id" c:identifier="g_app_info_get_id">
1521 <doc xml:whitespace="preserve">Gets the ID of an application. An id is a string that
1522 identifies the application. The exact format of the id is
1523 platform dependent. For instance, on Unix this is the
1524 desktop file id from the xdg menu specification.
1525 Note that the returned ID may be %NULL, depending on how
1526 the @appinfo has been constructed.</doc>
1527 <return-value transfer-ownership="none">
1528 <doc xml:whitespace="preserve">a string containing the application's ID.</doc>
1529 <type name="utf8" c:type="char*"/>
1532 <method name="get_name" c:identifier="g_app_info_get_name">
1533 <doc xml:whitespace="preserve">Gets the installed name of the application.</doc>
1534 <return-value transfer-ownership="none">
1535 <doc xml:whitespace="preserve">the name of the application for @appinfo.</doc>
1536 <type name="utf8" c:type="char*"/>
1539 <method name="launch" c:identifier="g_app_info_launch" throws="1">
1540 <doc xml:whitespace="preserve">Launches the application. Passes @files to the launched application
1541 as arguments, using the optional @launch_context to get information
1542 about the details of the launcher (like what screen it is on).
1543 On error, @error will be set accordingly.
1544 To launch the application without arguments pass a %NULL @files list.
1545 Note that even if the launch is successful the application launched
1546 can fail to start if it runs into problems during startup. There is
1547 no way to detect this.
1548 Some URIs can be changed when passed through a GFile (for instance
1549 unsupported uris with strange formats like mailto:), so if you have
1550 a textual uri you want to pass in as argument, consider using
1551 g_app_info_launch_uris() instead.
1552 On UNIX, this function sets the <envvar>GIO_LAUNCHED_DESKTOP_FILE</envvar>
1553 environment variable with the path of the launched desktop file and
1554 <envvar>GIO_LAUNCHED_DESKTOP_FILE_PID</envvar> to the process
1555 id of the launched process. This can be used to ignore
1556 <envvar>GIO_LAUNCHED_DESKTOP_FILE</envvar>, should it be inherited
1557 by further processes. The <envvar>DISPLAY</envvar> and
1558 <envvar>DESKTOP_STARTUP_ID</envvar> environment variables are also
1559 set, based on information provided in @launch_context.</doc>
1560 <return-value transfer-ownership="none">
1561 <doc xml:whitespace="preserve">%TRUE on successful launch, %FALSE otherwise.</doc>
1562 <type name="gboolean" c:type="gboolean"/>
1565 <parameter name="files" transfer-ownership="none">
1566 <doc xml:whitespace="preserve">a #GList of #GFile objects</doc>
1567 <type name="GLib.List" c:type="GList*">
1571 <parameter name="launch_context"
1572 transfer-ownership="none"
1574 <doc xml:whitespace="preserve">a #GAppLaunchContext or %NULL</doc>
1575 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
1579 <method name="launch_uris"
1580 c:identifier="g_app_info_launch_uris"
1582 <doc xml:whitespace="preserve">Launches the application. Passes @uris to the launched application
1583 as arguments, using the optional @launch_context to get information
1584 about the details of the launcher (like what screen it is on).
1585 On error, @error will be set accordingly.
1586 To lauch the application without arguments pass a %NULL @uris list.
1587 Note that even if the launch is successful the application launched
1588 can fail to start if it runs into problems during startup. There is
1589 no way to detect this.</doc>
1590 <return-value transfer-ownership="none">
1591 <doc xml:whitespace="preserve">%TRUE on successful launch, %FALSE otherwise.</doc>
1592 <type name="gboolean" c:type="gboolean"/>
1595 <parameter name="uris" transfer-ownership="none">
1596 <doc xml:whitespace="preserve">a #GList containing URIs to launch.</doc>
1597 <type name="GLib.List" c:type="GList*">
1601 <parameter name="launch_context"
1602 transfer-ownership="none"
1604 <doc xml:whitespace="preserve">a #GAppLaunchContext or %NULL</doc>
1605 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
1609 <method name="remove_supports_type"
1610 c:identifier="g_app_info_remove_supports_type"
1612 <doc xml:whitespace="preserve">Removes a supported type from an application, if possible.</doc>
1613 <return-value transfer-ownership="none">
1614 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1615 <type name="gboolean" c:type="gboolean"/>
1618 <parameter name="content_type" transfer-ownership="none">
1619 <doc xml:whitespace="preserve">a string.</doc>
1620 <type name="utf8" c:type="char*"/>
1624 <method name="set_as_default_for_extension"
1625 c:identifier="g_app_info_set_as_default_for_extension"
1627 <doc xml:whitespace="preserve">Sets the application as the default handler for the given file extension.</doc>
1628 <return-value transfer-ownership="none">
1629 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1630 <type name="gboolean" c:type="gboolean"/>
1633 <parameter name="extension" transfer-ownership="none">
1634 <doc xml:whitespace="preserve">a string containing the file extension (without the dot).</doc>
1635 <type name="utf8" c:type="char*"/>
1639 <method name="set_as_default_for_type"
1640 c:identifier="g_app_info_set_as_default_for_type"
1642 <doc xml:whitespace="preserve">Sets the application as the default handler for a given type.</doc>
1643 <return-value transfer-ownership="none">
1644 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1645 <type name="gboolean" c:type="gboolean"/>
1648 <parameter name="content_type" transfer-ownership="none">
1649 <doc xml:whitespace="preserve">the content type.</doc>
1650 <type name="utf8" c:type="char*"/>
1654 <method name="should_show" c:identifier="g_app_info_should_show">
1655 <doc xml:whitespace="preserve">Checks if the application info should be shown in menus that
1656 list available applications.</doc>
1657 <return-value transfer-ownership="none">
1658 <doc xml:whitespace="preserve">%TRUE if the @appinfo should be shown, %FALSE otherwise.</doc>
1659 <type name="gboolean" c:type="gboolean"/>
1662 <method name="supports_files" c:identifier="g_app_info_supports_files">
1663 <doc xml:whitespace="preserve">Checks if the application accepts files as arguments.</doc>
1664 <return-value transfer-ownership="none">
1665 <doc xml:whitespace="preserve">%TRUE if the @appinfo supports files.</doc>
1666 <type name="gboolean" c:type="gboolean"/>
1669 <method name="supports_uris" c:identifier="g_app_info_supports_uris">
1670 <doc xml:whitespace="preserve">Checks if the application supports reading files and directories from URIs.</doc>
1671 <return-value transfer-ownership="none">
1672 <doc xml:whitespace="preserve">%TRUE if the @appinfo supports URIs.</doc>
1673 <type name="gboolean" c:type="gboolean"/>
1677 <bitfield name="AppInfoCreateFlags"
1678 glib:type-name="GAppInfoCreateFlags"
1679 glib:get-type="g_app_info_create_flags_get_type"
1680 c:type="GAppInfoCreateFlags">
1681 <doc xml:whitespace="preserve">Flags used when creating a #GAppInfo.</doc>
1684 c:identifier="G_APP_INFO_CREATE_NONE"
1686 <member name="needs_terminal"
1688 c:identifier="G_APP_INFO_CREATE_NEEDS_TERMINAL"
1689 glib:nick="needs-terminal"/>
1690 <member name="supports_uris"
1692 c:identifier="G_APP_INFO_CREATE_SUPPORTS_URIS"
1693 glib:nick="supports-uris"/>
1694 <member name="supports_startup_notification"
1696 c:identifier="G_APP_INFO_CREATE_SUPPORTS_STARTUP_NOTIFICATION"
1697 glib:nick="supports-startup-notification"/>
1699 <record name="AppInfoIface"
1700 c:type="GAppInfoIface"
1701 glib:is-gtype-struct-for="AppInfo">
1702 <doc xml:whitespace="preserve">Application Information interface, for operating system portability.</doc>
1703 <field name="g_iface">
1704 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
1707 <callback name="dup">
1708 <return-value transfer-ownership="full">
1709 <doc xml:whitespace="preserve">a duplicate of @appinfo.</doc>
1710 <type name="AppInfo" c:type="GAppInfo*"/>
1713 <parameter name="appinfo" transfer-ownership="none">
1714 <type name="AppInfo" c:type="GAppInfo*"/>
1719 <field name="equal">
1720 <callback name="equal">
1721 <return-value transfer-ownership="none">
1722 <doc xml:whitespace="preserve">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise.</doc>
1723 <type name="gboolean" c:type="gboolean"/>
1726 <parameter name="appinfo1" transfer-ownership="none">
1727 <type name="AppInfo" c:type="GAppInfo*"/>
1729 <parameter name="appinfo2" transfer-ownership="none">
1730 <doc xml:whitespace="preserve">the second #GAppInfo.</doc>
1731 <type name="AppInfo" c:type="GAppInfo*"/>
1736 <field name="get_id">
1737 <callback name="get_id">
1738 <return-value transfer-ownership="none">
1739 <doc xml:whitespace="preserve">a string containing the application's ID.</doc>
1740 <type name="utf8" c:type="char*"/>
1743 <parameter name="appinfo" transfer-ownership="none">
1744 <type name="AppInfo" c:type="GAppInfo*"/>
1749 <field name="get_name">
1750 <callback name="get_name">
1751 <return-value transfer-ownership="none">
1752 <doc xml:whitespace="preserve">the name of the application for @appinfo.</doc>
1753 <type name="utf8" c:type="char*"/>
1756 <parameter name="appinfo" transfer-ownership="none">
1757 <type name="AppInfo" c:type="GAppInfo*"/>
1762 <field name="get_description">
1763 <callback name="get_description">
1764 <return-value transfer-ownership="none">
1765 <doc xml:whitespace="preserve">a string containing a description of the</doc>
1766 <type name="utf8" c:type="char*"/>
1769 <parameter name="appinfo" transfer-ownership="none">
1770 <type name="AppInfo" c:type="GAppInfo*"/>
1775 <field name="get_executable">
1776 <callback name="get_executable">
1777 <return-value transfer-ownership="none">
1778 <doc xml:whitespace="preserve">a string containing the @appinfo's application</doc>
1779 <type name="utf8" c:type="char*"/>
1782 <parameter name="appinfo" transfer-ownership="none">
1783 <type name="AppInfo" c:type="GAppInfo*"/>
1788 <field name="get_icon">
1789 <callback name="get_icon">
1790 <return-value transfer-ownership="none">
1791 <doc xml:whitespace="preserve">the default #GIcon for @appinfo.</doc>
1792 <type name="Icon" c:type="GIcon*"/>
1795 <parameter name="appinfo" transfer-ownership="none">
1796 <type name="AppInfo" c:type="GAppInfo*"/>
1801 <field name="launch">
1802 <callback name="launch" throws="1">
1803 <return-value transfer-ownership="none">
1804 <doc xml:whitespace="preserve">%TRUE on successful launch, %FALSE otherwise.</doc>
1805 <type name="gboolean" c:type="gboolean"/>
1808 <parameter name="appinfo" transfer-ownership="none">
1809 <type name="AppInfo" c:type="GAppInfo*"/>
1811 <parameter name="filenames" transfer-ownership="none">
1812 <type name="GLib.List" c:type="GList*">
1813 <type name="gpointer" c:type="gpointer"/>
1816 <parameter name="launch_context"
1817 transfer-ownership="none"
1819 <doc xml:whitespace="preserve">a #GAppLaunchContext or %NULL</doc>
1820 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
1825 <field name="supports_uris">
1826 <callback name="supports_uris">
1827 <return-value transfer-ownership="none">
1828 <doc xml:whitespace="preserve">%TRUE if the @appinfo supports URIs.</doc>
1829 <type name="gboolean" c:type="gboolean"/>
1832 <parameter name="appinfo" transfer-ownership="none">
1833 <type name="AppInfo" c:type="GAppInfo*"/>
1838 <field name="supports_files">
1839 <callback name="supports_files">
1840 <return-value transfer-ownership="none">
1841 <doc xml:whitespace="preserve">%TRUE if the @appinfo supports files.</doc>
1842 <type name="gboolean" c:type="gboolean"/>
1845 <parameter name="appinfo" transfer-ownership="none">
1846 <type name="AppInfo" c:type="GAppInfo*"/>
1851 <field name="launch_uris">
1852 <callback name="launch_uris" throws="1">
1853 <return-value transfer-ownership="none">
1854 <doc xml:whitespace="preserve">%TRUE on successful launch, %FALSE otherwise.</doc>
1855 <type name="gboolean" c:type="gboolean"/>
1858 <parameter name="appinfo" transfer-ownership="none">
1859 <type name="AppInfo" c:type="GAppInfo*"/>
1861 <parameter name="uris" transfer-ownership="none">
1862 <doc xml:whitespace="preserve">a #GList containing URIs to launch.</doc>
1863 <type name="GLib.List" c:type="GList*">
1867 <parameter name="launch_context"
1868 transfer-ownership="none"
1870 <doc xml:whitespace="preserve">a #GAppLaunchContext or %NULL</doc>
1871 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
1876 <field name="should_show">
1877 <callback name="should_show">
1878 <return-value transfer-ownership="none">
1879 <doc xml:whitespace="preserve">%TRUE if the @appinfo should be shown, %FALSE otherwise.</doc>
1880 <type name="gboolean" c:type="gboolean"/>
1883 <parameter name="appinfo" transfer-ownership="none">
1884 <type name="AppInfo" c:type="GAppInfo*"/>
1889 <field name="set_as_default_for_type">
1890 <callback name="set_as_default_for_type" throws="1">
1891 <return-value transfer-ownership="none">
1892 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1893 <type name="gboolean" c:type="gboolean"/>
1896 <parameter name="appinfo" transfer-ownership="none">
1897 <type name="AppInfo" c:type="GAppInfo*"/>
1899 <parameter name="content_type" transfer-ownership="none">
1900 <doc xml:whitespace="preserve">the content type.</doc>
1901 <type name="utf8" c:type="char*"/>
1906 <field name="set_as_default_for_extension">
1907 <callback name="set_as_default_for_extension" throws="1">
1908 <return-value transfer-ownership="none">
1909 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1910 <type name="gboolean" c:type="gboolean"/>
1913 <parameter name="appinfo" transfer-ownership="none">
1914 <type name="AppInfo" c:type="GAppInfo*"/>
1916 <parameter name="extension" transfer-ownership="none">
1917 <doc xml:whitespace="preserve">a string containing the file extension (without the dot).</doc>
1918 <type name="utf8" c:type="char*"/>
1923 <field name="add_supports_type">
1924 <callback name="add_supports_type" throws="1">
1925 <return-value transfer-ownership="none">
1926 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1927 <type name="gboolean" c:type="gboolean"/>
1930 <parameter name="appinfo" transfer-ownership="none">
1931 <type name="AppInfo" c:type="GAppInfo*"/>
1933 <parameter name="content_type" transfer-ownership="none">
1934 <doc xml:whitespace="preserve">a string.</doc>
1935 <type name="utf8" c:type="char*"/>
1940 <field name="can_remove_supports_type">
1941 <callback name="can_remove_supports_type">
1942 <return-value transfer-ownership="none">
1943 <doc xml:whitespace="preserve">%TRUE if it is possible to remove supported</doc>
1944 <type name="gboolean" c:type="gboolean"/>
1947 <parameter name="appinfo" transfer-ownership="none">
1948 <type name="AppInfo" c:type="GAppInfo*"/>
1953 <field name="remove_supports_type">
1954 <callback name="remove_supports_type" throws="1">
1955 <return-value transfer-ownership="none">
1956 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
1957 <type name="gboolean" c:type="gboolean"/>
1960 <parameter name="appinfo" transfer-ownership="none">
1961 <type name="AppInfo" c:type="GAppInfo*"/>
1963 <parameter name="content_type" transfer-ownership="none">
1964 <doc xml:whitespace="preserve">a string.</doc>
1965 <type name="utf8" c:type="char*"/>
1970 <field name="can_delete">
1971 <callback name="can_delete">
1972 <return-value transfer-ownership="none">
1973 <doc xml:whitespace="preserve">%TRUE if @appinfo can be deleted</doc>
1974 <type name="gboolean" c:type="gboolean"/>
1977 <parameter name="appinfo" transfer-ownership="none">
1978 <type name="AppInfo" c:type="GAppInfo*"/>
1983 <field name="do_delete">
1984 <callback name="do_delete">
1985 <return-value transfer-ownership="none">
1986 <doc xml:whitespace="preserve">%TRUE if @appinfo has been deleted</doc>
1987 <type name="gboolean" c:type="gboolean"/>
1990 <parameter name="appinfo" transfer-ownership="none">
1991 <type name="AppInfo" c:type="GAppInfo*"/>
1996 <field name="get_commandline">
1997 <callback name="get_commandline">
1998 <return-value transfer-ownership="none">
1999 <doc xml:whitespace="preserve">a string containing the @appinfo's commandline,</doc>
2000 <type name="utf8" c:type="char*"/>
2003 <parameter name="appinfo" transfer-ownership="none">
2004 <type name="AppInfo" c:type="GAppInfo*"/>
2009 <field name="get_display_name">
2010 <callback name="get_display_name">
2011 <return-value transfer-ownership="none">
2012 <doc xml:whitespace="preserve">the display name of the application for @appinfo, or the name if</doc>
2013 <type name="utf8" c:type="char*"/>
2016 <parameter name="appinfo" transfer-ownership="none">
2017 <type name="AppInfo" c:type="GAppInfo*"/>
2023 <class name="AppLaunchContext"
2024 c:symbol-prefix="app_launch_context"
2025 c:type="GAppLaunchContext"
2026 parent="GObject.Object"
2027 glib:type-name="GAppLaunchContext"
2028 glib:get-type="g_app_launch_context_get_type"
2029 glib:type-struct="AppLaunchContextClass">
2030 <doc xml:whitespace="preserve">Integrating the launch with the launching application. This is used to
2031 handle for instance startup notification and launching the new application
2032 on the same screen as the launching window.</doc>
2033 <constructor name="new" c:identifier="g_app_launch_context_new">
2034 <doc xml:whitespace="preserve">Creates a new application launch context. This is not normally used,
2035 instead you instantiate a subclass of this, such as #GdkAppLaunchContext.</doc>
2036 <return-value transfer-ownership="full">
2037 <doc xml:whitespace="preserve">a #GAppLaunchContext.</doc>
2038 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
2041 <virtual-method name="get_display" invoker="get_display">
2042 <doc xml:whitespace="preserve">Gets the display string for the @context. This is used to ensure new
2043 applications are started on the same display as the launching
2044 application, by setting the <envvar>DISPLAY</envvar> environment variable.</doc>
2045 <return-value transfer-ownership="full">
2046 <doc xml:whitespace="preserve">a display string for the display.</doc>
2047 <type name="utf8" c:type="char*"/>
2050 <parameter name="info" transfer-ownership="none">
2051 <doc xml:whitespace="preserve">a #GAppInfo</doc>
2052 <type name="AppInfo" c:type="GAppInfo*"/>
2054 <parameter name="files" transfer-ownership="none">
2055 <doc xml:whitespace="preserve">a #GList of #GFile objects</doc>
2056 <type name="GLib.List" c:type="GList*">
2062 <virtual-method name="get_startup_notify_id"
2063 invoker="get_startup_notify_id">
2064 <doc xml:whitespace="preserve">Initiates startup notification for the application and returns the
2065 <envvar>DESKTOP_STARTUP_ID</envvar> for the launched operation,
2067 Startup notification IDs are defined in the <ulink
2068 url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
2069 FreeDesktop.Org Startup Notifications standard</ulink>.
2070 not supported.</doc>
2071 <return-value transfer-ownership="full">
2072 <doc xml:whitespace="preserve">a startup notification ID for the application, or %NULL if</doc>
2073 <type name="utf8" c:type="char*"/>
2076 <parameter name="info" transfer-ownership="none">
2077 <doc xml:whitespace="preserve">a #GAppInfo</doc>
2078 <type name="AppInfo" c:type="GAppInfo*"/>
2080 <parameter name="files" transfer-ownership="none">
2081 <doc xml:whitespace="preserve">a #GList of of #GFile objects</doc>
2082 <type name="GLib.List" c:type="GList*">
2088 <virtual-method name="launch_failed" invoker="launch_failed">
2089 <doc xml:whitespace="preserve">Called when an application has failed to launch, so that it can cancel
2090 the application startup notification started in g_app_launch_context_get_startup_notify_id().</doc>
2091 <return-value transfer-ownership="none">
2092 <type name="none" c:type="void"/>
2095 <parameter name="startup_notify_id" transfer-ownership="none">
2096 <doc xml:whitespace="preserve">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id().</doc>
2097 <type name="utf8" c:type="char*"/>
2101 <method name="get_display"
2102 c:identifier="g_app_launch_context_get_display">
2103 <doc xml:whitespace="preserve">Gets the display string for the @context. This is used to ensure new
2104 applications are started on the same display as the launching
2105 application, by setting the <envvar>DISPLAY</envvar> environment variable.</doc>
2106 <return-value transfer-ownership="full">
2107 <doc xml:whitespace="preserve">a display string for the display.</doc>
2108 <type name="utf8" c:type="char*"/>
2111 <parameter name="info" transfer-ownership="none">
2112 <doc xml:whitespace="preserve">a #GAppInfo</doc>
2113 <type name="AppInfo" c:type="GAppInfo*"/>
2115 <parameter name="files" transfer-ownership="none">
2116 <doc xml:whitespace="preserve">a #GList of #GFile objects</doc>
2117 <type name="GLib.List" c:type="GList*">
2123 <method name="get_startup_notify_id"
2124 c:identifier="g_app_launch_context_get_startup_notify_id">
2125 <doc xml:whitespace="preserve">Initiates startup notification for the application and returns the
2126 <envvar>DESKTOP_STARTUP_ID</envvar> for the launched operation,
2128 Startup notification IDs are defined in the <ulink
2129 url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
2130 FreeDesktop.Org Startup Notifications standard</ulink>.
2131 not supported.</doc>
2132 <return-value transfer-ownership="full">
2133 <doc xml:whitespace="preserve">a startup notification ID for the application, or %NULL if</doc>
2134 <type name="utf8" c:type="char*"/>
2137 <parameter name="info" transfer-ownership="none">
2138 <doc xml:whitespace="preserve">a #GAppInfo</doc>
2139 <type name="AppInfo" c:type="GAppInfo*"/>
2141 <parameter name="files" transfer-ownership="none">
2142 <doc xml:whitespace="preserve">a #GList of of #GFile objects</doc>
2143 <type name="GLib.List" c:type="GList*">
2149 <method name="launch_failed"
2150 c:identifier="g_app_launch_context_launch_failed">
2151 <doc xml:whitespace="preserve">Called when an application has failed to launch, so that it can cancel
2152 the application startup notification started in g_app_launch_context_get_startup_notify_id().</doc>
2153 <return-value transfer-ownership="none">
2154 <type name="none" c:type="void"/>
2157 <parameter name="startup_notify_id" transfer-ownership="none">
2158 <doc xml:whitespace="preserve">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id().</doc>
2159 <type name="utf8" c:type="char*"/>
2163 <field name="parent_instance">
2164 <type name="GObject.Object" c:type="GObject"/>
2167 <type name="AppLaunchContextPrivate"
2168 c:type="GAppLaunchContextPrivate*"/>
2171 <record name="AppLaunchContextClass"
2172 c:type="GAppLaunchContextClass"
2173 glib:is-gtype-struct-for="AppLaunchContext">
2174 <field name="parent_class">
2175 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
2177 <field name="get_display">
2178 <callback name="get_display">
2179 <return-value transfer-ownership="full">
2180 <doc xml:whitespace="preserve">a display string for the display.</doc>
2181 <type name="utf8" c:type="char*"/>
2184 <parameter name="context" transfer-ownership="none">
2185 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
2187 <parameter name="info" transfer-ownership="none">
2188 <doc xml:whitespace="preserve">a #GAppInfo</doc>
2189 <type name="AppInfo" c:type="GAppInfo*"/>
2191 <parameter name="files" transfer-ownership="none">
2192 <doc xml:whitespace="preserve">a #GList of #GFile objects</doc>
2193 <type name="GLib.List" c:type="GList*">
2200 <field name="get_startup_notify_id">
2201 <callback name="get_startup_notify_id">
2202 <return-value transfer-ownership="full">
2203 <doc xml:whitespace="preserve">a startup notification ID for the application, or %NULL if</doc>
2204 <type name="utf8" c:type="char*"/>
2207 <parameter name="context" transfer-ownership="none">
2208 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
2210 <parameter name="info" transfer-ownership="none">
2211 <doc xml:whitespace="preserve">a #GAppInfo</doc>
2212 <type name="AppInfo" c:type="GAppInfo*"/>
2214 <parameter name="files" transfer-ownership="none">
2215 <doc xml:whitespace="preserve">a #GList of of #GFile objects</doc>
2216 <type name="GLib.List" c:type="GList*">
2223 <field name="launch_failed">
2224 <callback name="launch_failed">
2225 <return-value transfer-ownership="none">
2226 <type name="none" c:type="void"/>
2229 <parameter name="context" transfer-ownership="none">
2230 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
2232 <parameter name="startup_notify_id" transfer-ownership="none">
2233 <doc xml:whitespace="preserve">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id().</doc>
2234 <type name="utf8" c:type="char*"/>
2239 <field name="_g_reserved1" introspectable="0">
2240 <callback name="_g_reserved1">
2241 <return-value transfer-ownership="none">
2242 <type name="none" c:type="void"/>
2246 <field name="_g_reserved2" introspectable="0">
2247 <callback name="_g_reserved2">
2248 <return-value transfer-ownership="none">
2249 <type name="none" c:type="void"/>
2253 <field name="_g_reserved3" introspectable="0">
2254 <callback name="_g_reserved3">
2255 <return-value transfer-ownership="none">
2256 <type name="none" c:type="void"/>
2260 <field name="_g_reserved4" introspectable="0">
2261 <callback name="_g_reserved4">
2262 <return-value transfer-ownership="none">
2263 <type name="none" c:type="void"/>
2267 <field name="_g_reserved5" introspectable="0">
2268 <callback name="_g_reserved5">
2269 <return-value transfer-ownership="none">
2270 <type name="none" c:type="void"/>
2275 <record name="AppLaunchContextPrivate"
2276 c:type="GAppLaunchContextPrivate"
2279 <class name="Application"
2280 c:symbol-prefix="application"
2281 c:type="GApplication"
2283 parent="GObject.Object"
2284 glib:type-name="GApplication"
2285 glib:get-type="g_application_get_type"
2286 glib:type-struct="ApplicationClass">
2287 <doc xml:whitespace="preserve">The <structname>GApplication</structname> structure contains private
2288 data and should only be accessed using the provided API</doc>
2289 <implements name="Initable"/>
2290 <constructor name="new" c:identifier="g_application_new" version="2.26">
2291 <doc xml:whitespace="preserve">Create a new #GApplication. This uses a platform-specific
2292 mechanism to ensure the current process is the unique owner of the
2293 application (as defined by the @appid). If successful, the
2294 #GApplication:is-remote property will be %FALSE, and it is safe to
2295 continue creating other resources such as graphics windows.
2296 If the given @appid is already running in another process, the the
2297 GApplication::activate_with_data signal will be emitted in the
2298 remote process, with the data from @argv and other
2299 platform-specific data available. Subsequently the
2300 #GApplication:default-quit property will be evaluated. If it's
2301 %TRUE, then the current process will terminate. If %FALSE, then
2302 the application remains in the #GApplication:is-remote state, and
2303 you can e.g. call g_application_invoke_action(). Note that proxy
2304 instances should not call g_application_add_action().
2305 This function may do synchronous I/O to obtain unique ownership
2306 of the application id, and will block the calling thread in this
2308 If the environment does not support the basic functionality of
2309 #GApplication, this function will invoke g_error(), which by
2310 default is a fatal operation. This may arise for example on
2311 UNIX systems using D-Bus when the session bus is not available.
2312 As a convenience, this function is defined to call g_type_init() as
2313 its very first action.</doc>
2314 <return-value transfer-ownership="full">
2315 <doc xml:whitespace="preserve">An application instance</doc>
2316 <type name="Application" c:type="GApplication*"/>
2319 <parameter name="appid" transfer-ownership="none">
2320 <doc xml:whitespace="preserve">System-dependent application identifier</doc>
2321 <type name="utf8" c:type="gchar*"/>
2323 <parameter name="argc" transfer-ownership="none">
2324 <doc xml:whitespace="preserve">Number of arguments in @argv</doc>
2325 <type name="gint" c:type="int"/>
2327 <parameter name="argv" transfer-ownership="none" allow-none="1">
2328 <doc xml:whitespace="preserve">Argument vector, usually from the <parameter>argv</parameter> parameter of main()</doc>
2329 <array length="1" c:type="char**">
2335 <constructor name="try_new"
2336 c:identifier="g_application_try_new"
2339 <doc xml:whitespace="preserve">This function is similar to g_application_new(), but allows for
2340 more graceful fallback if the environment doesn't support the
2341 basic #GApplication functionality.</doc>
2342 <return-value transfer-ownership="full">
2343 <doc xml:whitespace="preserve">An application instance</doc>
2344 <type name="Application" c:type="GApplication*"/>
2347 <parameter name="appid" transfer-ownership="none">
2348 <doc xml:whitespace="preserve">System-dependent application identifier</doc>
2349 <type name="utf8" c:type="gchar*"/>
2351 <parameter name="argc" transfer-ownership="none">
2352 <doc xml:whitespace="preserve">Number of arguments in @argv</doc>
2353 <type name="gint" c:type="int"/>
2355 <parameter name="argv" transfer-ownership="none" allow-none="1">
2356 <doc xml:whitespace="preserve">Argument vector, usually from the <parameter>argv</parameter> parameter of main()</doc>
2357 <array length="1" c:type="char**">
2363 <constructor name="unregistered_try_new"
2364 c:identifier="g_application_unregistered_try_new"
2367 <doc xml:whitespace="preserve">This function is similar to g_application_try_new(), but also
2368 sets the GApplication:register property to %FALSE. You can later
2369 call g_application_register() to complete initialization.</doc>
2370 <return-value transfer-ownership="full">
2371 <doc xml:whitespace="preserve">An application instance</doc>
2372 <type name="Application" c:type="GApplication*"/>
2375 <parameter name="appid" transfer-ownership="none">
2376 <doc xml:whitespace="preserve">System-dependent application identifier</doc>
2377 <type name="utf8" c:type="gchar*"/>
2379 <parameter name="argc" transfer-ownership="none">
2380 <doc xml:whitespace="preserve">Number of arguments in @argv</doc>
2381 <type name="gint" c:type="int"/>
2383 <parameter name="argv" transfer-ownership="none" allow-none="1">
2384 <doc xml:whitespace="preserve">Argument vector, usually from the <parameter>argv</parameter> parameter of main()</doc>
2385 <array length="1" c:type="char**">
2391 <function name="get_instance"
2392 c:identifier="g_application_get_instance"
2394 <doc xml:whitespace="preserve">In the normal case where there is exactly one #GApplication instance
2395 in this process, return that instance. If there are multiple, the
2396 first one created will be returned. Otherwise, return %NULL.
2397 or %NULL if none is set</doc>
2398 <return-value transfer-ownership="none">
2399 <doc xml:whitespace="preserve">The primary instance of #GApplication,</doc>
2400 <type name="Application" c:type="GApplication*"/>
2403 <virtual-method name="run" invoker="run" version="2.26">
2404 <doc xml:whitespace="preserve">Starts the application.
2405 The default implementation of this virtual function will simply run
2407 It is an error to call this function if @application is a proxy for
2408 a remote application.</doc>
2409 <return-value transfer-ownership="none">
2410 <type name="none" c:type="void"/>
2413 <method name="add_action"
2414 c:identifier="g_application_add_action"
2416 <doc xml:whitespace="preserve">Adds an action @name to the list of exported actions of @application.
2417 It is an error to call this function if @application is a proxy for
2418 a remote application.
2419 You can invoke an action using g_application_invoke_action().
2420 The newly added action is enabled by default; you can call
2421 g_application_set_action_enabled() to disable it.</doc>
2422 <return-value transfer-ownership="none">
2423 <type name="none" c:type="void"/>
2426 <parameter name="name" transfer-ownership="none">
2427 <doc xml:whitespace="preserve">the action name</doc>
2428 <type name="utf8" c:type="gchar*"/>
2430 <parameter name="description" transfer-ownership="none">
2431 <doc xml:whitespace="preserve">the action description; can be a translatable string</doc>
2432 <type name="utf8" c:type="gchar*"/>
2436 <method name="get_action_description"
2437 c:identifier="g_application_get_action_description"
2439 <doc xml:whitespace="preserve">Gets the description of the action @name.
2440 It is an error to call this function if @application is a proxy for
2441 a remote application.</doc>
2442 <return-value transfer-ownership="none">
2443 <doc xml:whitespace="preserve">Description for the given action named @name</doc>
2444 <type name="utf8" c:type="gchar*"/>
2447 <parameter name="name" transfer-ownership="none">
2448 <doc xml:whitespace="preserve">Action name</doc>
2449 <type name="utf8" c:type="gchar*"/>
2453 <method name="get_action_enabled"
2454 c:identifier="g_application_get_action_enabled"
2456 <doc xml:whitespace="preserve">Retrieves whether the action @name is enabled or not.
2457 See g_application_set_action_enabled().
2458 It is an error to call this function if @application is a proxy for
2459 a remote application.</doc>
2460 <return-value transfer-ownership="none">
2461 <doc xml:whitespace="preserve">%TRUE if the action was enabled, and %FALSE otherwise</doc>
2462 <type name="gboolean" c:type="gboolean"/>
2465 <parameter name="name" transfer-ownership="none">
2466 <doc xml:whitespace="preserve">the name of the action</doc>
2467 <type name="utf8" c:type="gchar*"/>
2471 <method name="get_id" c:identifier="g_application_get_id" version="2.26">
2472 <doc xml:whitespace="preserve">Retrieves the platform-specific identifier for the #GApplication.
2473 is owned by the #GApplication instance and it should never be
2474 modified or freed</doc>
2475 <return-value transfer-ownership="none">
2476 <doc xml:whitespace="preserve">The platform-specific identifier. The returned string</doc>
2477 <type name="utf8" c:type="gchar*"/>
2480 <method name="invoke_action"
2481 c:identifier="g_application_invoke_action"
2483 <doc xml:whitespace="preserve">Invokes the action @name of the passed #GApplication.
2484 This function has different behavior depending on whether @application
2485 is acting as a proxy for another process. In the normal case where
2486 the current process is hosting the application, and the specified
2487 action exists and is enabled, the #GApplication::action signal will
2489 If @application is a proxy, then the specified action will be invoked
2490 in the remote process. It is not necessary to call
2491 g_application_add_action() in the current process in order to invoke
2493 <return-value transfer-ownership="none">
2494 <type name="none" c:type="void"/>
2497 <parameter name="name" transfer-ownership="none">
2498 <doc xml:whitespace="preserve">the name of the action to invoke</doc>
2499 <type name="utf8" c:type="gchar*"/>
2501 <parameter name="platform_data"
2502 transfer-ownership="none"
2504 <doc xml:whitespace="preserve">platform-specific event data</doc>
2505 <type name="GLib.Variant" c:type="GVariant*"/>
2509 <method name="is_remote" c:identifier="g_application_is_remote">
2510 <doc xml:whitespace="preserve">Returns whether the object represents a proxy for a remote application.</doc>
2511 <return-value transfer-ownership="none">
2512 <doc xml:whitespace="preserve">%TRUE if this object represents a proxy for a remote application.</doc>
2513 <type name="gboolean" c:type="gboolean"/>
2516 <method name="list_actions"
2517 c:identifier="g_application_list_actions"
2519 <doc xml:whitespace="preserve">Retrieves the list of action names currently exported by @application.
2520 It is an error to call this function if @application is a proxy for
2521 a remote application.
2522 of strings containing action names; use g_strfreev() to free the
2523 resources used by the returned array</doc>
2524 <return-value transfer-ownership="full">
2525 <doc xml:whitespace="preserve">a newly allocation, %NULL-terminated array</doc>
2526 <array c:type="gchar**">
2531 <method name="quit_with_data"
2532 c:identifier="g_application_quit_with_data"
2534 <doc xml:whitespace="preserve">Request that the application quits.
2535 This function has different behavior depending on whether @application
2536 is acting as a proxy for another process. In the normal case where
2537 the current process is hosting the application, the default
2538 implementation will quit the main loop created by g_application_run().
2539 If @application is a proxy, then the remote process will be asked
2541 <return-value transfer-ownership="none">
2542 <doc xml:whitespace="preserve">%TRUE if the application accepted the request, %FALSE otherwise</doc>
2543 <type name="gboolean" c:type="gboolean"/>
2546 <parameter name="platform_data"
2547 transfer-ownership="none"
2549 <doc xml:whitespace="preserve">platform-specific data</doc>
2550 <type name="GLib.Variant" c:type="GVariant*"/>
2554 <method name="register" c:identifier="g_application_register">
2555 <doc xml:whitespace="preserve">By default, #GApplication ensures process uniqueness when
2556 initialized, but this behavior is controlled by the
2557 GApplication:register property. If it was given as %FALSE at
2558 construction time, this function allows you to later attempt
2559 to ensure uniqueness. Note that the GApplication:default-quit
2560 property no longer applies at this point; if this function returns
2561 %FALSE, platform activation will occur, but the current process
2562 will not be terminated.
2563 It is an error to call this function more than once. It is
2564 also an error to call this function if the GApplication:register
2565 property was %TRUE at construction time.</doc>
2566 <return-value transfer-ownership="none">
2567 <doc xml:whitespace="preserve">%TRUE if registration was successful</doc>
2568 <type name="gboolean" c:type="gboolean"/>
2571 <method name="remove_action"
2572 c:identifier="g_application_remove_action"
2574 <doc xml:whitespace="preserve">Removes the action @name from the list of exported actions of @application.
2575 It is an error to call this function if @application is a proxy for
2576 a remote application.</doc>
2577 <return-value transfer-ownership="none">
2578 <type name="none" c:type="void"/>
2581 <parameter name="name" transfer-ownership="none">
2582 <doc xml:whitespace="preserve">the name of the action to remove</doc>
2583 <type name="utf8" c:type="gchar*"/>
2587 <method name="run" c:identifier="g_application_run" version="2.26">
2588 <doc xml:whitespace="preserve">Starts the application.
2589 The default implementation of this virtual function will simply run
2591 It is an error to call this function if @application is a proxy for
2592 a remote application.</doc>
2593 <return-value transfer-ownership="none">
2594 <type name="none" c:type="void"/>
2597 <method name="set_action_enabled"
2598 c:identifier="g_application_set_action_enabled"
2600 <doc xml:whitespace="preserve">Sets whether the action @name inside @application should be enabled
2602 It is an error to call this function if @application is a proxy for
2603 a remote application.
2604 Invoking a disabled action will not result in the #GApplication::action
2605 signal being emitted.</doc>
2606 <return-value transfer-ownership="none">
2607 <type name="none" c:type="void"/>
2610 <parameter name="name" transfer-ownership="none">
2611 <doc xml:whitespace="preserve">the name of the application</doc>
2612 <type name="utf8" c:type="gchar*"/>
2614 <parameter name="enabled" transfer-ownership="none">
2615 <doc xml:whitespace="preserve">whether to enable or disable the action @name</doc>
2616 <type name="gboolean" c:type="gboolean"/>
2620 <property name="application-id"
2623 transfer-ownership="none">
2624 <doc xml:whitespace="preserve">The unique identifier for this application. See the documentation for
2625 #GApplication for more information about this property.</doc>
2628 <property name="argv"
2631 transfer-ownership="none">
2632 <doc xml:whitespace="preserve">The argument vector given to this application. It must be a #GVariant
2633 with a type signature "aay".</doc>
2634 <type name="GLib.Variant"/>
2636 <property name="default-quit"
2639 transfer-ownership="none">
2640 <doc xml:whitespace="preserve">By default, if the GApplication:register property is %TRUE, and a
2641 different process is running this application, the process will
2642 be exited. Set this property to %FALSE to allow custom
2643 interaction with the remote process.</doc>
2644 <type name="gboolean"/>
2646 <property name="is-remote" transfer-ownership="none">
2647 <doc xml:whitespace="preserve">This property is %TRUE if this application instance represents a proxy
2648 to the instance of this application in another process.</doc>
2649 <type name="gboolean"/>
2651 <property name="platform-data"
2654 transfer-ownership="none">
2655 <doc xml:whitespace="preserve">Platform-specific data retrieved from the operating system
2656 environment. It must be a #GVariant with type signature "a{sv}".</doc>
2657 <type name="GLib.Variant"/>
2659 <property name="register"
2662 transfer-ownership="none">
2663 <doc xml:whitespace="preserve">If this property is %FALSE, the application construction will not attempt
2664 to ensure process uniqueness, and the application is guaranteed to be in the
2665 remote state. See GApplication:is-remote.</doc>
2666 <type name="gboolean"/>
2668 <field name="parent_instance">
2669 <type name="GObject.Object" c:type="GObject"/>
2672 <type name="ApplicationPrivate" c:type="GApplicationPrivate*"/>
2674 <glib:signal name="action-with-data">
2675 <doc xml:whitespace="preserve">This signal is emitted when an action is activated. The action name
2676 is passed as the first argument, but also as signal detail, so it
2677 is possible to connect to this signal for individual actions.
2678 The signal is never emitted for disabled actions.</doc>
2679 <return-value transfer-ownership="none">
2683 <parameter name="object" transfer-ownership="none">
2684 <doc xml:whitespace="preserve">The name of the activated action</doc>
2687 <parameter name="p0" transfer-ownership="none">
2688 <doc xml:whitespace="preserve">Platform-specific data, or %NULL</doc>
2689 <type name="GLib.Variant"/>
2693 <glib:signal name="prepare-activation">
2694 <doc xml:whitespace="preserve">This signal is emitted when a non-primary process for a given
2695 application is invoked while your application is running; for
2696 example, when a file browser launches your program to open a
2697 file. The raw operating system arguments are passed in the
2698 stored in @platform_data.</doc>
2699 <return-value transfer-ownership="none">
2703 <parameter name="object" transfer-ownership="none">
2704 <doc xml:whitespace="preserve">A #GVariant with the signature "aay"</doc>
2705 <type name="GLib.Variant"/>
2707 <parameter name="p0" transfer-ownership="none">
2708 <doc xml:whitespace="preserve">A #GVariant with the signature "a{sv}", or %NULL</doc>
2709 <type name="GLib.Variant"/>
2713 <glib:signal name="quit-with-data">
2714 <doc xml:whitespace="preserve">This signal is emitted when the Quit action is invoked on the
2716 The default handler for this signal exits the mainloop of the
2718 signal emission</doc>
2719 <return-value transfer-ownership="none">
2720 <doc xml:whitespace="preserve">%TRUE if the signal has been handled, %FALSE to continue</doc>
2721 <type name="gboolean"/>
2724 <parameter name="object" transfer-ownership="none">
2725 <doc xml:whitespace="preserve">Platform-specific data, or %NULL</doc>
2726 <type name="GLib.Variant"/>
2731 <record name="ApplicationClass"
2732 c:type="GApplicationClass"
2733 glib:is-gtype-struct-for="Application"
2735 <doc xml:whitespace="preserve">The <structname>GApplicationClass</structname> structure contains
2736 private data only</doc>
2737 <field name="parent_class">
2738 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
2740 <field name="action_with_data">
2741 <callback name="action_with_data">
2742 <return-value transfer-ownership="none">
2743 <type name="none" c:type="void"/>
2746 <parameter name="application" transfer-ownership="none">
2747 <type name="Application" c:type="GApplication*"/>
2749 <parameter name="action_name" transfer-ownership="none">
2750 <type name="utf8" c:type="gchar*"/>
2752 <parameter name="platform_data" transfer-ownership="none">
2753 <type name="GLib.Variant" c:type="GVariant*"/>
2758 <field name="quit_with_data">
2759 <callback name="quit_with_data">
2760 <return-value transfer-ownership="none">
2761 <type name="gboolean" c:type="gboolean"/>
2764 <parameter name="application" transfer-ownership="none">
2765 <type name="Application" c:type="GApplication*"/>
2767 <parameter name="platform_data" transfer-ownership="none">
2768 <type name="GLib.Variant" c:type="GVariant*"/>
2773 <field name="prepare_activation">
2774 <callback name="prepare_activation">
2775 <return-value transfer-ownership="none">
2776 <type name="none" c:type="void"/>
2779 <parameter name="application" transfer-ownership="none">
2780 <type name="Application" c:type="GApplication*"/>
2782 <parameter name="arguments" transfer-ownership="none">
2783 <type name="GLib.Variant" c:type="GVariant*"/>
2785 <parameter name="platform_data" transfer-ownership="none">
2786 <type name="GLib.Variant" c:type="GVariant*"/>
2792 <callback name="run">
2793 <return-value transfer-ownership="none">
2794 <type name="none" c:type="void"/>
2797 <parameter name="application" transfer-ownership="none">
2798 <type name="Application" c:type="GApplication*"/>
2803 <field name="_g_reserved1" introspectable="0">
2804 <callback name="_g_reserved1">
2805 <return-value transfer-ownership="none">
2806 <type name="none" c:type="void"/>
2810 <field name="_g_reserved2" introspectable="0">
2811 <callback name="_g_reserved2">
2812 <return-value transfer-ownership="none">
2813 <type name="none" c:type="void"/>
2817 <field name="_g_reserved3" introspectable="0">
2818 <callback name="_g_reserved3">
2819 <return-value transfer-ownership="none">
2820 <type name="none" c:type="void"/>
2824 <field name="_g_reserved4" introspectable="0">
2825 <callback name="_g_reserved4">
2826 <return-value transfer-ownership="none">
2827 <type name="none" c:type="void"/>
2831 <field name="_g_reserved5" introspectable="0">
2832 <callback name="_g_reserved5">
2833 <return-value transfer-ownership="none">
2834 <type name="none" c:type="void"/>
2838 <field name="_g_reserved6" introspectable="0">
2839 <callback name="_g_reserved6">
2840 <return-value transfer-ownership="none">
2841 <type name="none" c:type="void"/>
2846 <record name="ApplicationPrivate"
2847 c:type="GApplicationPrivate"
2850 <bitfield name="AskPasswordFlags"
2851 glib:type-name="GAskPasswordFlags"
2852 glib:get-type="g_ask_password_flags_get_type"
2853 c:type="GAskPasswordFlags">
2854 <doc xml:whitespace="preserve">#GAskPasswordFlags are used to request specific information from the
2855 user, or to notify the user of their choices in an authentication
2857 <member name="need_password"
2859 c:identifier="G_ASK_PASSWORD_NEED_PASSWORD"
2860 glib:nick="need-password"/>
2861 <member name="need_username"
2863 c:identifier="G_ASK_PASSWORD_NEED_USERNAME"
2864 glib:nick="need-username"/>
2865 <member name="need_domain"
2867 c:identifier="G_ASK_PASSWORD_NEED_DOMAIN"
2868 glib:nick="need-domain"/>
2869 <member name="saving_supported"
2871 c:identifier="G_ASK_PASSWORD_SAVING_SUPPORTED"
2872 glib:nick="saving-supported"/>
2873 <member name="anonymous_supported"
2875 c:identifier="G_ASK_PASSWORD_ANONYMOUS_SUPPORTED"
2876 glib:nick="anonymous-supported"/>
2878 <interface name="AsyncInitable"
2879 c:symbol-prefix="async_initable"
2880 c:type="GAsyncInitable"
2882 glib:type-name="GAsyncInitable"
2883 glib:get-type="g_async_initable_get_type"
2884 glib:type-struct="AsyncInitableIface">
2885 <doc xml:whitespace="preserve">Interface for asynchronously initializable objects.</doc>
2886 <virtual-method name="init_async" invoker="init_async" version="2.22">
2887 <doc xml:whitespace="preserve">Starts asynchronous initialization of the object implementing the
2888 interface. This must be done before any real use of the object after
2889 initial construction. If the object also implements #GInitable you can
2890 optionally call g_initable_init() instead.
2891 When the initialization is finished, @callback will be called. You can
2892 then call g_async_initable_init_finish() to get the result of the
2894 Implementations may also support cancellation. If @cancellable is not
2895 %NULL, then initialization can be cancelled by triggering the cancellable
2896 object from another thread. If the operation was cancelled, the error
2897 %G_IO_ERROR_CANCELLED will be returned. If @cancellable is not %NULL, and
2898 the object doesn't support cancellable initialization, the error
2899 %G_IO_ERROR_NOT_SUPPORTED will be returned.
2900 If this function is not called, or returns with an error, then all
2901 operations on the object should fail, generally returning the
2902 error %G_IO_ERROR_NOT_INITIALIZED.
2903 to this function with the same argument should return the same results.
2904 Only the first call initializes the object; further calls return the result
2905 of the first call. This is so that it's safe to implement the singleton
2906 pattern in the GObject constructor function.
2907 For classes that also support the #GInitable interface, the default
2908 implementation of this method will run the g_initable_init() function
2909 in a thread, so if you want to support asynchronous initialization via
2910 threads, just implement the #GAsyncInitable interface without overriding
2911 any interface methods.</doc>
2912 <return-value transfer-ownership="none">
2913 <type name="none" c:type="void"/>
2916 <parameter name="io_priority" transfer-ownership="none">
2917 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the operation.</doc>
2918 <type name="gint" c:type="int"/>
2920 <parameter name="cancellable"
2921 transfer-ownership="none"
2923 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
2924 <type name="Cancellable" c:type="GCancellable*"/>
2926 <parameter name="callback"
2927 transfer-ownership="none"
2930 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
2931 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
2933 <parameter name="user_data" transfer-ownership="none" closure="3">
2934 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
2935 <type name="gpointer" c:type="gpointer"/>
2939 <virtual-method name="init_finish"
2940 invoker="init_finish"
2943 <doc xml:whitespace="preserve">Finishes asynchronous initialization and returns the result.
2944 See g_async_initable_init_async().
2945 will return %FALSE and set @error appropriately if present.</doc>
2946 <return-value transfer-ownership="none">
2947 <doc xml:whitespace="preserve">%TRUE if successful. If an error has occurred, this function</doc>
2948 <type name="gboolean" c:type="gboolean"/>
2951 <parameter name="res" transfer-ownership="none">
2952 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
2953 <type name="AsyncResult" c:type="GAsyncResult*"/>
2957 <method name="init_async"
2958 c:identifier="g_async_initable_init_async"
2960 <doc xml:whitespace="preserve">Starts asynchronous initialization of the object implementing the
2961 interface. This must be done before any real use of the object after
2962 initial construction. If the object also implements #GInitable you can
2963 optionally call g_initable_init() instead.
2964 When the initialization is finished, @callback will be called. You can
2965 then call g_async_initable_init_finish() to get the result of the
2967 Implementations may also support cancellation. If @cancellable is not
2968 %NULL, then initialization can be cancelled by triggering the cancellable
2969 object from another thread. If the operation was cancelled, the error
2970 %G_IO_ERROR_CANCELLED will be returned. If @cancellable is not %NULL, and
2971 the object doesn't support cancellable initialization, the error
2972 %G_IO_ERROR_NOT_SUPPORTED will be returned.
2973 If this function is not called, or returns with an error, then all
2974 operations on the object should fail, generally returning the
2975 error %G_IO_ERROR_NOT_INITIALIZED.
2976 to this function with the same argument should return the same results.
2977 Only the first call initializes the object; further calls return the result
2978 of the first call. This is so that it's safe to implement the singleton
2979 pattern in the GObject constructor function.
2980 For classes that also support the #GInitable interface, the default
2981 implementation of this method will run the g_initable_init() function
2982 in a thread, so if you want to support asynchronous initialization via
2983 threads, just implement the #GAsyncInitable interface without overriding
2984 any interface methods.</doc>
2985 <return-value transfer-ownership="none">
2986 <type name="none" c:type="void"/>
2989 <parameter name="io_priority" transfer-ownership="none">
2990 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the operation.</doc>
2991 <type name="gint" c:type="int"/>
2993 <parameter name="cancellable"
2994 transfer-ownership="none"
2996 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
2997 <type name="Cancellable" c:type="GCancellable*"/>
2999 <parameter name="callback"
3000 transfer-ownership="none"
3003 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
3004 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
3006 <parameter name="user_data" transfer-ownership="none">
3007 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
3008 <type name="gpointer" c:type="gpointer"/>
3012 <method name="init_finish"
3013 c:identifier="g_async_initable_init_finish"
3016 <doc xml:whitespace="preserve">Finishes asynchronous initialization and returns the result.
3017 See g_async_initable_init_async().
3018 will return %FALSE and set @error appropriately if present.</doc>
3019 <return-value transfer-ownership="none">
3020 <doc xml:whitespace="preserve">%TRUE if successful. If an error has occurred, this function</doc>
3021 <type name="gboolean" c:type="gboolean"/>
3024 <parameter name="res" transfer-ownership="none">
3025 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
3026 <type name="AsyncResult" c:type="GAsyncResult*"/>
3030 <method name="new_finish"
3031 c:identifier="g_async_initable_new_finish"
3034 <doc xml:whitespace="preserve">Finishes the async construction for the various g_async_initable_new calls,
3035 returning the created object or %NULL on error.
3036 g_object_unref().</doc>
3037 <return-value transfer-ownership="full">
3038 <doc xml:whitespace="preserve">a newly created #GObject, or %NULL on error. Free with</doc>
3039 <type name="GObject.Object" c:type="GObject*"/>
3042 <parameter name="res" transfer-ownership="none">
3043 <doc xml:whitespace="preserve">the #GAsyncResult.from the callback</doc>
3044 <type name="AsyncResult" c:type="GAsyncResult*"/>
3049 <record name="AsyncInitableIface"
3050 c:type="GAsyncInitableIface"
3051 glib:is-gtype-struct-for="AsyncInitable"
3053 <doc xml:whitespace="preserve">Provides an interface for asynchronous initializing object such that
3054 initialization may fail.</doc>
3055 <field name="g_iface">
3056 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
3058 <field name="init_async">
3059 <callback name="init_async">
3060 <return-value transfer-ownership="none">
3061 <type name="none" c:type="void"/>
3064 <parameter name="initable" transfer-ownership="none">
3065 <type name="AsyncInitable" c:type="GAsyncInitable*"/>
3067 <parameter name="io_priority" transfer-ownership="none">
3068 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the operation.</doc>
3069 <type name="gint" c:type="int"/>
3071 <parameter name="cancellable"
3072 transfer-ownership="none"
3074 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
3075 <type name="Cancellable" c:type="GCancellable*"/>
3077 <parameter name="callback"
3078 transfer-ownership="none"
3081 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
3082 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
3084 <parameter name="user_data" transfer-ownership="none" closure="4">
3085 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
3086 <type name="gpointer" c:type="gpointer"/>
3091 <field name="init_finish">
3092 <callback name="init_finish" throws="1">
3093 <return-value transfer-ownership="none">
3094 <doc xml:whitespace="preserve">%TRUE if successful. If an error has occurred, this function</doc>
3095 <type name="gboolean" c:type="gboolean"/>
3098 <parameter name="initable" transfer-ownership="none">
3099 <type name="AsyncInitable" c:type="GAsyncInitable*"/>
3101 <parameter name="res" transfer-ownership="none">
3102 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
3103 <type name="AsyncResult" c:type="GAsyncResult*"/>
3109 <callback name="AsyncReadyCallback" c:type="GAsyncReadyCallback">
3110 <doc xml:whitespace="preserve">Type definition for a function that will be called back when an asynchronous
3111 operation within GIO has been completed.</doc>
3112 <return-value transfer-ownership="none">
3113 <type name="none" c:type="void"/>
3116 <parameter name="source_object" transfer-ownership="none">
3117 <doc xml:whitespace="preserve">the object the asynchronous operation was started with.</doc>
3118 <type name="GObject.Object" c:type="GObject*"/>
3120 <parameter name="res" transfer-ownership="none">
3121 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
3122 <type name="AsyncResult" c:type="GAsyncResult*"/>
3124 <parameter name="user_data" transfer-ownership="none" closure="2">
3125 <doc xml:whitespace="preserve">user data passed to the callback.</doc>
3126 <type name="gpointer" c:type="gpointer"/>
3130 <interface name="AsyncResult"
3131 c:symbol-prefix="async_result"
3132 c:type="GAsyncResult"
3133 glib:type-name="GAsyncResult"
3134 glib:get-type="g_async_result_get_type"
3135 glib:type-struct="AsyncResultIface">
3136 <doc xml:whitespace="preserve">Holds results information for an asynchronous operation,
3137 usually passed directly to a asynchronous _finish() operation.</doc>
3138 <virtual-method name="get_source_object" invoker="get_source_object">
3139 <doc xml:whitespace="preserve">Gets the source object from a #GAsyncResult.
3140 or %NULL if there is none.</doc>
3141 <return-value transfer-ownership="full">
3142 <doc xml:whitespace="preserve">a new reference to the source object for the @res,</doc>
3143 <type name="GObject.Object" c:type="GObject*"/>
3146 <virtual-method name="get_user_data" invoker="get_user_data">
3147 <doc xml:whitespace="preserve">Gets the user data from a #GAsyncResult.</doc>
3148 <return-value transfer-ownership="full">
3149 <doc xml:whitespace="preserve">the user data for @res.</doc>
3150 <type name="gpointer" c:type="gpointer"/>
3153 <method name="get_source_object"
3154 c:identifier="g_async_result_get_source_object">
3155 <doc xml:whitespace="preserve">Gets the source object from a #GAsyncResult.
3156 or %NULL if there is none.</doc>
3157 <return-value transfer-ownership="full">
3158 <doc xml:whitespace="preserve">a new reference to the source object for the @res,</doc>
3159 <type name="GObject.Object" c:type="GObject*"/>
3162 <method name="get_user_data" c:identifier="g_async_result_get_user_data">
3163 <doc xml:whitespace="preserve">Gets the user data from a #GAsyncResult.</doc>
3164 <return-value transfer-ownership="full">
3165 <doc xml:whitespace="preserve">the user data for @res.</doc>
3166 <type name="gpointer" c:type="gpointer"/>
3170 <record name="AsyncResultIface"
3171 c:type="GAsyncResultIface"
3172 glib:is-gtype-struct-for="AsyncResult">
3173 <doc xml:whitespace="preserve">Interface definition for #GAsyncResult.</doc>
3174 <field name="g_iface">
3175 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
3177 <field name="get_user_data">
3178 <callback name="get_user_data">
3179 <return-value transfer-ownership="full">
3180 <doc xml:whitespace="preserve">the user data for @res.</doc>
3181 <type name="gpointer" c:type="gpointer"/>
3184 <parameter name="async_result" transfer-ownership="none">
3185 <type name="AsyncResult" c:type="GAsyncResult*"/>
3190 <field name="get_source_object">
3191 <callback name="get_source_object">
3192 <return-value transfer-ownership="full">
3193 <doc xml:whitespace="preserve">a new reference to the source object for the @res,</doc>
3194 <type name="GObject.Object" c:type="GObject*"/>
3197 <parameter name="async_result" transfer-ownership="none">
3198 <type name="AsyncResult" c:type="GAsyncResult*"/>
3204 <class name="BufferedInputStream"
3205 c:symbol-prefix="buffered_input_stream"
3206 c:type="GBufferedInputStream"
3207 parent="FilterInputStream"
3208 glib:type-name="GBufferedInputStream"
3209 glib:get-type="g_buffered_input_stream_get_type"
3210 glib:type-struct="BufferedInputStreamClass">
3211 <doc xml:whitespace="preserve">Implements #GFilterInputStream with a sized input buffer.</doc>
3212 <constructor name="new" c:identifier="g_buffered_input_stream_new">
3213 <doc xml:whitespace="preserve">Creates a new #GInputStream from the given @base_stream, with
3214 a buffer set to the default size (4 kilobytes).</doc>
3215 <return-value transfer-ownership="full">
3216 <doc xml:whitespace="preserve">a #GInputStream for the given @base_stream.</doc>
3217 <type name="InputStream" c:type="GInputStream*"/>
3220 <parameter name="base_stream" transfer-ownership="none">
3221 <doc xml:whitespace="preserve">a #GInputStream</doc>
3222 <type name="InputStream" c:type="GInputStream*"/>
3226 <constructor name="new_sized"
3227 c:identifier="g_buffered_input_stream_new_sized">
3228 <doc xml:whitespace="preserve">Creates a new #GBufferedInputStream from the given @base_stream,
3229 with a buffer set to @size.</doc>
3230 <return-value transfer-ownership="full">
3231 <doc xml:whitespace="preserve">a #GInputStream.</doc>
3232 <type name="InputStream" c:type="GInputStream*"/>
3235 <parameter name="base_stream" transfer-ownership="none">
3236 <doc xml:whitespace="preserve">a #GInputStream</doc>
3237 <type name="InputStream" c:type="GInputStream*"/>
3239 <parameter name="size" transfer-ownership="none">
3240 <doc xml:whitespace="preserve">a #gsize</doc>
3241 <type name="gulong" c:type="gsize"/>
3245 <virtual-method name="fill" invoker="fill" throws="1">
3246 <doc xml:whitespace="preserve">Tries to read @count bytes from the stream into the buffer.
3247 Will block during this read.
3248 If @count is zero, returns zero and does nothing. A value of @count
3249 larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
3250 On success, the number of bytes read into the buffer is returned.
3251 It is not an error if this is not the same as the requested size, as it
3252 can happen e.g. near the end of a file. Zero is returned on end of file
3253 (or if @count is zero), but never otherwise.
3254 If @count is -1 then the attempted read size is equal to the number of
3255 bytes that are required to fill the buffer.
3256 If @cancellable is not %NULL, then the operation can be cancelled by
3257 triggering the cancellable object from another thread. If the operation
3258 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
3259 operation was partially finished when the operation was cancelled the
3260 partial result will be returned, without an error.
3261 On error -1 is returned and @error is set accordingly.
3262 For the asynchronous, non-blocking, version of this function, see
3263 g_buffered_input_stream_fill_async().
3264 or -1 on error.</doc>
3265 <return-value transfer-ownership="none">
3266 <doc xml:whitespace="preserve">the number of bytes read into @stream's buffer, up to @count,</doc>
3267 <type name="glong" c:type="gssize"/>
3270 <parameter name="count" transfer-ownership="none">
3271 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
3272 <type name="glong" c:type="gssize"/>
3274 <parameter name="cancellable"
3275 transfer-ownership="none"
3277 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
3278 <type name="Cancellable" c:type="GCancellable*"/>
3282 <virtual-method name="fill_async" invoker="fill_async">
3283 <doc xml:whitespace="preserve">Reads data into @stream's buffer asynchronously, up to @count size.
3284 version of this function, see g_buffered_input_stream_fill().
3285 If @count is -1 then the attempted read size is equal to the number
3286 of bytes that are required to fill the buffer.</doc>
3287 <return-value transfer-ownership="none">
3288 <type name="none" c:type="void"/>
3291 <parameter name="count" transfer-ownership="none">
3292 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
3293 <type name="glong" c:type="gssize"/>
3295 <parameter name="io_priority" transfer-ownership="none">
3296 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request</doc>
3297 <type name="gint" c:type="int"/>
3299 <parameter name="cancellable"
3300 transfer-ownership="none"
3302 <doc xml:whitespace="preserve">optional #GCancellable object</doc>
3303 <type name="Cancellable" c:type="GCancellable*"/>
3305 <parameter name="callback"
3306 transfer-ownership="none"
3309 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
3310 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
3312 <parameter name="user_data" transfer-ownership="none" closure="4">
3313 <doc xml:whitespace="preserve">a #gpointer</doc>
3314 <type name="gpointer" c:type="gpointer"/>
3318 <virtual-method name="fill_finish" invoker="fill_finish" throws="1">
3319 <doc xml:whitespace="preserve">Finishes an asynchronous read.</doc>
3320 <return-value transfer-ownership="none">
3321 <doc xml:whitespace="preserve">a #gssize of the read stream, or %-1 on an error.</doc>
3322 <type name="glong" c:type="gssize"/>
3325 <parameter name="result" transfer-ownership="none">
3326 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
3327 <type name="AsyncResult" c:type="GAsyncResult*"/>
3332 c:identifier="g_buffered_input_stream_fill"
3334 <doc xml:whitespace="preserve">Tries to read @count bytes from the stream into the buffer.
3335 Will block during this read.
3336 If @count is zero, returns zero and does nothing. A value of @count
3337 larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
3338 On success, the number of bytes read into the buffer is returned.
3339 It is not an error if this is not the same as the requested size, as it
3340 can happen e.g. near the end of a file. Zero is returned on end of file
3341 (or if @count is zero), but never otherwise.
3342 If @count is -1 then the attempted read size is equal to the number of
3343 bytes that are required to fill the buffer.
3344 If @cancellable is not %NULL, then the operation can be cancelled by
3345 triggering the cancellable object from another thread. If the operation
3346 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
3347 operation was partially finished when the operation was cancelled the
3348 partial result will be returned, without an error.
3349 On error -1 is returned and @error is set accordingly.
3350 For the asynchronous, non-blocking, version of this function, see
3351 g_buffered_input_stream_fill_async().
3352 or -1 on error.</doc>
3353 <return-value transfer-ownership="none">
3354 <doc xml:whitespace="preserve">the number of bytes read into @stream's buffer, up to @count,</doc>
3355 <type name="glong" c:type="gssize"/>
3358 <parameter name="count" transfer-ownership="none">
3359 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
3360 <type name="glong" c:type="gssize"/>
3362 <parameter name="cancellable"
3363 transfer-ownership="none"
3365 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
3366 <type name="Cancellable" c:type="GCancellable*"/>
3370 <method name="fill_async"
3371 c:identifier="g_buffered_input_stream_fill_async">
3372 <doc xml:whitespace="preserve">Reads data into @stream's buffer asynchronously, up to @count size.
3373 version of this function, see g_buffered_input_stream_fill().
3374 If @count is -1 then the attempted read size is equal to the number
3375 of bytes that are required to fill the buffer.</doc>
3376 <return-value transfer-ownership="none">
3377 <type name="none" c:type="void"/>
3380 <parameter name="count" transfer-ownership="none">
3381 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
3382 <type name="glong" c:type="gssize"/>
3384 <parameter name="io_priority" transfer-ownership="none">
3385 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request</doc>
3386 <type name="gint" c:type="int"/>
3388 <parameter name="cancellable"
3389 transfer-ownership="none"
3391 <doc xml:whitespace="preserve">optional #GCancellable object</doc>
3392 <type name="Cancellable" c:type="GCancellable*"/>
3394 <parameter name="callback"
3395 transfer-ownership="none"
3398 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
3399 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
3401 <parameter name="user_data" transfer-ownership="none">
3402 <doc xml:whitespace="preserve">a #gpointer</doc>
3403 <type name="gpointer" c:type="gpointer"/>
3407 <method name="fill_finish"
3408 c:identifier="g_buffered_input_stream_fill_finish"
3410 <doc xml:whitespace="preserve">Finishes an asynchronous read.</doc>
3411 <return-value transfer-ownership="none">
3412 <doc xml:whitespace="preserve">a #gssize of the read stream, or %-1 on an error.</doc>
3413 <type name="glong" c:type="gssize"/>
3416 <parameter name="result" transfer-ownership="none">
3417 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
3418 <type name="AsyncResult" c:type="GAsyncResult*"/>
3422 <method name="get_available"
3423 c:identifier="g_buffered_input_stream_get_available">
3424 <doc xml:whitespace="preserve">Gets the size of the available data within the stream.</doc>
3425 <return-value transfer-ownership="none">
3426 <doc xml:whitespace="preserve">size of the available stream.</doc>
3427 <type name="gulong" c:type="gsize"/>
3430 <method name="get_buffer_size"
3431 c:identifier="g_buffered_input_stream_get_buffer_size">
3432 <doc xml:whitespace="preserve">Gets the size of the input buffer.</doc>
3433 <return-value transfer-ownership="none">
3434 <doc xml:whitespace="preserve">the current buffer size.</doc>
3435 <type name="gulong" c:type="gsize"/>
3438 <method name="peek" c:identifier="g_buffered_input_stream_peek">
3439 <doc xml:whitespace="preserve">Peeks in the buffer, copying data of size @count into @buffer,
3440 offset @offset bytes.</doc>
3441 <return-value transfer-ownership="none">
3442 <doc xml:whitespace="preserve">a #gsize of the number of bytes peeked, or -1 on error.</doc>
3443 <type name="gulong" c:type="gsize"/>
3446 <parameter name="buffer" transfer-ownership="none">
3447 <doc xml:whitespace="preserve">a pointer to an allocated chunk of memory</doc>
3448 <type name="gpointer" c:type="void*"/>
3450 <parameter name="offset" transfer-ownership="none">
3451 <doc xml:whitespace="preserve">a #gsize</doc>
3452 <type name="gulong" c:type="gsize"/>
3454 <parameter name="count" transfer-ownership="none">
3455 <doc xml:whitespace="preserve">a #gsize</doc>
3456 <type name="gulong" c:type="gsize"/>
3460 <method name="peek_buffer"
3461 c:identifier="g_buffered_input_stream_peek_buffer">
3462 <doc xml:whitespace="preserve">Returns the buffer with the currently available bytes. The returned
3463 buffer must not be modified and will become invalid when reading from
3464 the stream or filling the buffer.</doc>
3465 <return-value transfer-ownership="none">
3466 <doc xml:whitespace="preserve">read-only buffer</doc>
3467 <type name="gpointer" c:type="void*"/>
3470 <parameter name="count" transfer-ownership="none">
3471 <doc xml:whitespace="preserve">a #gsize to get the number of bytes available in the buffer</doc>
3472 <type name="gulong" c:type="gsize*"/>
3476 <method name="read_byte"
3477 c:identifier="g_buffered_input_stream_read_byte"
3479 <doc xml:whitespace="preserve">Tries to read a single byte from the stream or the buffer. Will block
3481 On success, the byte read from the stream is returned. On end of stream
3482 -1 is returned but it's not an exceptional error and @error is not set.
3483 If @cancellable is not %NULL, then the operation can be cancelled by
3484 triggering the cancellable object from another thread. If the operation
3485 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
3486 operation was partially finished when the operation was cancelled the
3487 partial result will be returned, without an error.
3488 On error -1 is returned and @error is set accordingly.</doc>
3489 <return-value transfer-ownership="none">
3490 <doc xml:whitespace="preserve">the byte read from the @stream, or -1 on end of stream or error.</doc>
3491 <type name="gint" c:type="int"/>
3494 <parameter name="cancellable"
3495 transfer-ownership="none"
3497 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
3498 <type name="Cancellable" c:type="GCancellable*"/>
3502 <method name="set_buffer_size"
3503 c:identifier="g_buffered_input_stream_set_buffer_size">
3504 <doc xml:whitespace="preserve">Sets the size of the internal buffer of @stream to @size, or to the
3505 size of the contents of the buffer. The buffer can never be resized
3506 smaller than its current contents.</doc>
3507 <return-value transfer-ownership="none">
3508 <type name="none" c:type="void"/>
3511 <parameter name="size" transfer-ownership="none">
3512 <doc xml:whitespace="preserve">a #gsize</doc>
3513 <type name="gulong" c:type="gsize"/>
3517 <property name="buffer-size"
3520 transfer-ownership="none">
3521 <type name="guint"/>
3523 <field name="parent_instance">
3524 <type name="FilterInputStream" c:type="GFilterInputStream"/>
3527 <type name="BufferedInputStreamPrivate"
3528 c:type="GBufferedInputStreamPrivate*"/>
3531 <record name="BufferedInputStreamClass"
3532 c:type="GBufferedInputStreamClass"
3533 glib:is-gtype-struct-for="BufferedInputStream">
3534 <field name="parent_class">
3535 <type name="FilterInputStreamClass" c:type="GFilterInputStreamClass"/>
3538 <callback name="fill" throws="1">
3539 <return-value transfer-ownership="none">
3540 <doc xml:whitespace="preserve">the number of bytes read into @stream's buffer, up to @count,</doc>
3541 <type name="glong" c:type="gssize"/>
3544 <parameter name="stream" transfer-ownership="none">
3545 <type name="BufferedInputStream" c:type="GBufferedInputStream*"/>
3547 <parameter name="count" transfer-ownership="none">
3548 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
3549 <type name="glong" c:type="gssize"/>
3551 <parameter name="cancellable"
3552 transfer-ownership="none"
3554 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
3555 <type name="Cancellable" c:type="GCancellable*"/>
3560 <field name="fill_async">
3561 <callback name="fill_async">
3562 <return-value transfer-ownership="none">
3563 <type name="none" c:type="void"/>
3566 <parameter name="stream" transfer-ownership="none">
3567 <type name="BufferedInputStream" c:type="GBufferedInputStream*"/>
3569 <parameter name="count" transfer-ownership="none">
3570 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
3571 <type name="glong" c:type="gssize"/>
3573 <parameter name="io_priority" transfer-ownership="none">
3574 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request</doc>
3575 <type name="gint" c:type="int"/>
3577 <parameter name="cancellable"
3578 transfer-ownership="none"
3580 <doc xml:whitespace="preserve">optional #GCancellable object</doc>
3581 <type name="Cancellable" c:type="GCancellable*"/>
3583 <parameter name="callback"
3584 transfer-ownership="none"
3587 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
3588 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
3590 <parameter name="user_data" transfer-ownership="none" closure="5">
3591 <doc xml:whitespace="preserve">a #gpointer</doc>
3592 <type name="gpointer" c:type="gpointer"/>
3597 <field name="fill_finish">
3598 <callback name="fill_finish" throws="1">
3599 <return-value transfer-ownership="none">
3600 <doc xml:whitespace="preserve">a #gssize of the read stream, or %-1 on an error.</doc>
3601 <type name="glong" c:type="gssize"/>
3604 <parameter name="stream" transfer-ownership="none">
3605 <type name="BufferedInputStream" c:type="GBufferedInputStream*"/>
3607 <parameter name="result" transfer-ownership="none">
3608 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
3609 <type name="AsyncResult" c:type="GAsyncResult*"/>
3614 <field name="_g_reserved1" introspectable="0">
3615 <callback name="_g_reserved1">
3616 <return-value transfer-ownership="none">
3617 <type name="none" c:type="void"/>
3621 <field name="_g_reserved2" introspectable="0">
3622 <callback name="_g_reserved2">
3623 <return-value transfer-ownership="none">
3624 <type name="none" c:type="void"/>
3628 <field name="_g_reserved3" introspectable="0">
3629 <callback name="_g_reserved3">
3630 <return-value transfer-ownership="none">
3631 <type name="none" c:type="void"/>
3635 <field name="_g_reserved4" introspectable="0">
3636 <callback name="_g_reserved4">
3637 <return-value transfer-ownership="none">
3638 <type name="none" c:type="void"/>
3642 <field name="_g_reserved5" introspectable="0">
3643 <callback name="_g_reserved5">
3644 <return-value transfer-ownership="none">
3645 <type name="none" c:type="void"/>
3650 <record name="BufferedInputStreamPrivate"
3651 c:type="GBufferedInputStreamPrivate"
3654 <class name="BufferedOutputStream"
3655 c:symbol-prefix="buffered_output_stream"
3656 c:type="GBufferedOutputStream"
3657 parent="FilterOutputStream"
3658 glib:type-name="GBufferedOutputStream"
3659 glib:get-type="g_buffered_output_stream_get_type"
3660 glib:type-struct="BufferedOutputStreamClass">
3661 <doc xml:whitespace="preserve">An implementation of #GFilterOutputStream with a sized buffer.</doc>
3662 <constructor name="new" c:identifier="g_buffered_output_stream_new">
3663 <doc xml:whitespace="preserve">Creates a new buffered output stream for a base stream.</doc>
3664 <return-value transfer-ownership="full">
3665 <doc xml:whitespace="preserve">a #GOutputStream for the given @base_stream.</doc>
3666 <type name="OutputStream" c:type="GOutputStream*"/>
3669 <parameter name="base_stream" transfer-ownership="none">
3670 <doc xml:whitespace="preserve">a #GOutputStream.</doc>
3671 <type name="OutputStream" c:type="GOutputStream*"/>
3675 <constructor name="new_sized"
3676 c:identifier="g_buffered_output_stream_new_sized">
3677 <doc xml:whitespace="preserve">Creates a new buffered output stream with a given buffer size.</doc>
3678 <return-value transfer-ownership="full">
3679 <doc xml:whitespace="preserve">a #GOutputStream with an internal buffer set to @size.</doc>
3680 <type name="OutputStream" c:type="GOutputStream*"/>
3683 <parameter name="base_stream" transfer-ownership="none">
3684 <doc xml:whitespace="preserve">a #GOutputStream.</doc>
3685 <type name="OutputStream" c:type="GOutputStream*"/>
3687 <parameter name="size" transfer-ownership="none">
3688 <doc xml:whitespace="preserve">a #gsize.</doc>
3689 <type name="gulong" c:type="gsize"/>
3693 <method name="get_auto_grow"
3694 c:identifier="g_buffered_output_stream_get_auto_grow">
3695 <doc xml:whitespace="preserve">Checks if the buffer automatically grows as data is added.
3696 %FALSE otherwise.</doc>
3697 <return-value transfer-ownership="none">
3698 <doc xml:whitespace="preserve">%TRUE if the @stream's buffer automatically grows,</doc>
3699 <type name="gboolean" c:type="gboolean"/>
3702 <method name="get_buffer_size"
3703 c:identifier="g_buffered_output_stream_get_buffer_size">
3704 <doc xml:whitespace="preserve">Gets the size of the buffer in the @stream.</doc>
3705 <return-value transfer-ownership="none">
3706 <doc xml:whitespace="preserve">the current size of the buffer.</doc>
3707 <type name="gulong" c:type="gsize"/>
3710 <method name="set_auto_grow"
3711 c:identifier="g_buffered_output_stream_set_auto_grow">
3712 <doc xml:whitespace="preserve">Sets whether or not the @stream's buffer should automatically grow.
3713 If @auto_grow is true, then each write will just make the buffer
3714 larger, and you must manually flush the buffer to actually write out
3715 the data to the underlying stream.</doc>
3716 <return-value transfer-ownership="none">
3717 <type name="none" c:type="void"/>
3720 <parameter name="auto_grow" transfer-ownership="none">
3721 <doc xml:whitespace="preserve">a #gboolean.</doc>
3722 <type name="gboolean" c:type="gboolean"/>
3726 <method name="set_buffer_size"
3727 c:identifier="g_buffered_output_stream_set_buffer_size">
3728 <doc xml:whitespace="preserve">Sets the size of the internal buffer to @size.</doc>
3729 <return-value transfer-ownership="none">
3730 <type name="none" c:type="void"/>
3733 <parameter name="size" transfer-ownership="none">
3734 <doc xml:whitespace="preserve">a #gsize.</doc>
3735 <type name="gulong" c:type="gsize"/>
3739 <property name="auto-grow" writable="1" transfer-ownership="none">
3740 <type name="gboolean"/>
3742 <property name="buffer-size"
3745 transfer-ownership="none">
3746 <type name="guint"/>
3748 <field name="parent_instance">
3749 <type name="FilterOutputStream" c:type="GFilterOutputStream"/>
3752 <type name="BufferedOutputStreamPrivate"
3753 c:type="GBufferedOutputStreamPrivate*"/>
3756 <record name="BufferedOutputStreamClass"
3757 c:type="GBufferedOutputStreamClass"
3758 glib:is-gtype-struct-for="BufferedOutputStream">
3759 <field name="parent_class">
3760 <type name="FilterOutputStreamClass"
3761 c:type="GFilterOutputStreamClass"/>
3763 <field name="_g_reserved1" introspectable="0">
3764 <callback name="_g_reserved1">
3765 <return-value transfer-ownership="none">
3766 <type name="none" c:type="void"/>
3770 <field name="_g_reserved2" introspectable="0">
3771 <callback name="_g_reserved2">
3772 <return-value transfer-ownership="none">
3773 <type name="none" c:type="void"/>
3778 <record name="BufferedOutputStreamPrivate"
3779 c:type="GBufferedOutputStreamPrivate"
3782 <callback name="BusAcquiredCallback"
3783 c:type="GBusAcquiredCallback"
3785 <doc xml:whitespace="preserve">Invoked when a connection to a message bus has been obtained.</doc>
3786 <return-value transfer-ownership="none">
3787 <type name="none" c:type="void"/>
3790 <parameter name="connection" transfer-ownership="none">
3791 <doc xml:whitespace="preserve">The #GDBusConnection to a message bus.</doc>
3792 <type name="DBusConnection" c:type="GDBusConnection*"/>
3794 <parameter name="name" transfer-ownership="none">
3795 <doc xml:whitespace="preserve">The name that is requested to be owned.</doc>
3796 <type name="utf8" c:type="gchar*"/>
3798 <parameter name="user_data" transfer-ownership="none" closure="2">
3799 <doc xml:whitespace="preserve">User data passed to g_bus_own_name().</doc>
3800 <type name="gpointer" c:type="gpointer"/>
3804 <callback name="BusNameAcquiredCallback"
3805 c:type="GBusNameAcquiredCallback"
3807 <doc xml:whitespace="preserve">Invoked when the name is acquired.</doc>
3808 <return-value transfer-ownership="none">
3809 <type name="none" c:type="void"/>
3812 <parameter name="connection" transfer-ownership="none">
3813 <doc xml:whitespace="preserve">The #GDBusConnection on which to acquired the name.</doc>
3814 <type name="DBusConnection" c:type="GDBusConnection*"/>
3816 <parameter name="name" transfer-ownership="none">
3817 <doc xml:whitespace="preserve">The name being owned.</doc>
3818 <type name="utf8" c:type="gchar*"/>
3820 <parameter name="user_data" transfer-ownership="none" closure="2">
3821 <doc xml:whitespace="preserve">User data passed to g_bus_own_name() or g_bus_own_name_on_connection().</doc>
3822 <type name="gpointer" c:type="gpointer"/>
3826 <callback name="BusNameAppearedCallback"
3827 c:type="GBusNameAppearedCallback"
3829 <doc xml:whitespace="preserve">Invoked when the name being watched is known to have to have a owner.</doc>
3830 <return-value transfer-ownership="none">
3831 <type name="none" c:type="void"/>
3834 <parameter name="connection" transfer-ownership="none">
3835 <doc xml:whitespace="preserve">The #GDBusConnection the name is being watched on.</doc>
3836 <type name="DBusConnection" c:type="GDBusConnection*"/>
3838 <parameter name="name" transfer-ownership="none">
3839 <doc xml:whitespace="preserve">The name being watched.</doc>
3840 <type name="utf8" c:type="gchar*"/>
3842 <parameter name="name_owner" transfer-ownership="none">
3843 <doc xml:whitespace="preserve">Unique name of the owner of the name being watched.</doc>
3844 <type name="utf8" c:type="gchar*"/>
3846 <parameter name="user_data" transfer-ownership="none" closure="3">
3847 <doc xml:whitespace="preserve">User data passed to g_bus_watch_name().</doc>
3848 <type name="gpointer" c:type="gpointer"/>
3852 <callback name="BusNameLostCallback"
3853 c:type="GBusNameLostCallback"
3855 <doc xml:whitespace="preserve">Invoked when the name is lost or @connection has been closed.</doc>
3856 <return-value transfer-ownership="none">
3857 <type name="none" c:type="void"/>
3860 <parameter name="connection" transfer-ownership="none">
3861 <doc xml:whitespace="preserve">The #GDBusConnection on which to acquire the name or %NULL if the connection was disconnected.</doc>
3862 <type name="DBusConnection" c:type="GDBusConnection*"/>
3864 <parameter name="name" transfer-ownership="none">
3865 <doc xml:whitespace="preserve">The name being owned.</doc>
3866 <type name="utf8" c:type="gchar*"/>
3868 <parameter name="user_data" transfer-ownership="none" closure="2">
3869 <doc xml:whitespace="preserve">User data passed to g_bus_own_name() or g_bus_own_name_on_connection().</doc>
3870 <type name="gpointer" c:type="gpointer"/>
3874 <bitfield name="BusNameOwnerFlags"
3876 glib:type-name="GBusNameOwnerFlags"
3877 glib:get-type="g_bus_name_owner_flags_get_type"
3878 c:type="GBusNameOwnerFlags">
3879 <doc xml:whitespace="preserve">Flags used in g_bus_own_name().</doc>
3882 c:identifier="G_BUS_NAME_OWNER_FLAGS_NONE"
3884 <member name="allow_replacement"
3886 c:identifier="G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT"
3887 glib:nick="allow-replacement"/>
3888 <member name="replace"
3890 c:identifier="G_BUS_NAME_OWNER_FLAGS_REPLACE"
3891 glib:nick="replace"/>
3893 <callback name="BusNameVanishedCallback"
3894 c:type="GBusNameVanishedCallback"
3896 <doc xml:whitespace="preserve">Invoked when the name being watched is known not to have to have a owner.</doc>
3897 <return-value transfer-ownership="none">
3898 <type name="none" c:type="void"/>
3901 <parameter name="connection" transfer-ownership="none">
3902 <doc xml:whitespace="preserve">The #GDBusConnection the name is being watched on.</doc>
3903 <type name="DBusConnection" c:type="GDBusConnection*"/>
3905 <parameter name="name" transfer-ownership="none">
3906 <doc xml:whitespace="preserve">The name being watched.</doc>
3907 <type name="utf8" c:type="gchar*"/>
3909 <parameter name="user_data" transfer-ownership="none" closure="2">
3910 <doc xml:whitespace="preserve">User data passed to g_bus_watch_name().</doc>
3911 <type name="gpointer" c:type="gpointer"/>
3915 <bitfield name="BusNameWatcherFlags"
3917 glib:type-name="GBusNameWatcherFlags"
3918 glib:get-type="g_bus_name_watcher_flags_get_type"
3919 c:type="GBusNameWatcherFlags">
3920 <doc xml:whitespace="preserve">Flags used in g_bus_watch_name().</doc>
3923 c:identifier="G_BUS_NAME_WATCHER_FLAGS_NONE"
3925 <member name="auto_start"
3927 c:identifier="G_BUS_NAME_WATCHER_FLAGS_AUTO_START"
3928 glib:nick="auto-start"/>
3930 <enumeration name="BusType"
3932 glib:type-name="GBusType"
3933 glib:get-type="g_bus_type_get_type"
3935 <doc xml:whitespace="preserve">An enumeration for well-known message buses.</doc>
3936 <member name="starter"
3938 c:identifier="G_BUS_TYPE_STARTER"
3939 glib:nick="starter"/>
3942 c:identifier="G_BUS_TYPE_NONE"
3944 <member name="system"
3946 c:identifier="G_BUS_TYPE_SYSTEM"
3947 glib:nick="system"/>
3948 <member name="session"
3950 c:identifier="G_BUS_TYPE_SESSION"
3951 glib:nick="session"/>
3953 <class name="Cancellable"
3954 c:symbol-prefix="cancellable"
3955 c:type="GCancellable"
3956 parent="GObject.Object"
3957 glib:type-name="GCancellable"
3958 glib:get-type="g_cancellable_get_type"
3959 glib:type-struct="CancellableClass">
3960 <doc xml:whitespace="preserve">Allows actions to be cancelled.</doc>
3961 <constructor name="new" c:identifier="g_cancellable_new">
3962 <doc xml:whitespace="preserve">Creates a new #GCancellable object.
3963 Applications that want to start one or more operations
3964 that should be cancellable should create a #GCancellable
3965 and pass it to the operations.
3966 One #GCancellable can be used in multiple consecutive
3967 operations, but not in multiple concurrent operations.</doc>
3968 <return-value transfer-ownership="full">
3969 <doc xml:whitespace="preserve">a #GCancellable.</doc>
3970 <type name="Cancellable" c:type="GCancellable*"/>
3973 <function name="get_current" c:identifier="g_cancellable_get_current">
3974 <doc xml:whitespace="preserve">Gets the top cancellable from the stack.
3975 if the stack is empty.</doc>
3976 <return-value transfer-ownership="none">
3977 <doc xml:whitespace="preserve">a #GCancellable from the top of the stack, or %NULL</doc>
3978 <type name="Cancellable" c:type="GCancellable*"/>
3981 <method name="cancel" c:identifier="g_cancellable_cancel">
3982 <doc xml:whitespace="preserve">Will set @cancellable to cancelled, and will emit the
3983 #GCancellable::cancelled signal. (However, see the warning about
3984 race conditions in the documentation for that signal if you are
3985 planning to connect to it.)
3986 This function is thread-safe. In other words, you can safely call
3987 it from a thread other than the one running the operation that was
3988 passed the @cancellable.
3989 The convention within gio is that cancelling an asynchronous
3990 operation causes it to complete asynchronously. That is, if you
3991 cancel the operation from the same thread in which it is running,
3992 then the operation's #GAsyncReadyCallback will not be invoked until
3993 the application returns to the main loop.</doc>
3994 <return-value transfer-ownership="none">
3995 <type name="none" c:type="void"/>
3998 <method name="connect"
3999 c:identifier="g_cancellable_connect"
4001 <doc xml:whitespace="preserve">Convenience function to connect to the #GCancellable::cancelled
4002 signal. Also handles the race condition that may happen
4003 if the cancellable is cancelled right before connecting.
4004 time of the connect if @cancellable is already cancelled,
4005 or when @cancellable is cancelled in some thread.
4006 disconnected, or immediately if the cancellable is already
4008 See #GCancellable::cancelled for details on how to use this.
4009 been cancelled.</doc>
4010 <return-value transfer-ownership="none">
4011 <doc xml:whitespace="preserve">The id of the signal handler or 0 if @cancellable has already</doc>
4012 <type name="gulong" c:type="gulong"/>
4015 <parameter name="callback"
4016 transfer-ownership="none"
4020 <doc xml:whitespace="preserve">The #GCallback to connect.</doc>
4021 <type name="GObject.Callback" c:type="GCallback"/>
4023 <parameter name="data" transfer-ownership="none">
4024 <doc xml:whitespace="preserve">Data to pass to @callback.</doc>
4025 <type name="gpointer" c:type="gpointer"/>
4027 <parameter name="data_destroy_func"
4028 transfer-ownership="none"
4030 <doc xml:whitespace="preserve">Free function for @data or %NULL.</doc>
4031 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
4035 <method name="disconnect"
4036 c:identifier="g_cancellable_disconnect"
4038 <doc xml:whitespace="preserve">Disconnects a handler from a cancellable instance similar to
4039 g_signal_handler_disconnect(). Additionally, in the event that a
4040 signal handler is currently running, this call will block until the
4041 handler has finished. Calling this function from a
4042 #GCancellable::cancelled signal handler will therefore result in a
4044 This avoids a race condition where a thread cancels at the
4045 same time as the cancellable operation is finished and the
4046 signal handler is removed. See #GCancellable::cancelled for
4047 details on how to use this.
4048 If @cancellable is %NULL or @handler_id is %0 this function does
4050 <return-value transfer-ownership="none">
4051 <type name="none" c:type="void"/>
4054 <parameter name="handler_id" transfer-ownership="none">
4055 <doc xml:whitespace="preserve">Handler id of the handler to be disconnected, or %0.</doc>
4056 <type name="gulong" c:type="gulong"/>
4060 <method name="get_fd" c:identifier="g_cancellable_get_fd">
4061 <doc xml:whitespace="preserve">Gets the file descriptor for a cancellable job. This can be used to
4062 implement cancellable operations on Unix systems. The returned fd will
4063 turn readable when @cancellable is cancelled.
4064 You are not supposed to read from the fd yourself, just check for
4065 readable status. Reading to unset the readable status is done
4066 with g_cancellable_reset().
4067 After a successful return from this function, you should use
4068 g_cancellable_release_fd() to free up resources allocated for
4069 the returned file descriptor.
4070 See also g_cancellable_make_pollfd().
4071 is not supported, or on errors.</doc>
4072 <return-value transfer-ownership="none">
4073 <doc xml:whitespace="preserve">A valid file descriptor. %-1 if the file descriptor</doc>
4074 <type name="gint" c:type="int"/>
4077 <method name="is_cancelled" c:identifier="g_cancellable_is_cancelled">
4078 <doc xml:whitespace="preserve">Checks if a cancellable job has been cancelled.
4079 FALSE if called with %NULL or if item is not cancelled.</doc>
4080 <return-value transfer-ownership="none">
4081 <doc xml:whitespace="preserve">%TRUE if @cancellable is cancelled,</doc>
4082 <type name="gboolean" c:type="gboolean"/>
4085 <method name="make_pollfd"
4086 c:identifier="g_cancellable_make_pollfd"
4088 <doc xml:whitespace="preserve">Creates a #GPollFD corresponding to @cancellable; this can be passed
4089 to g_poll() and used to poll for cancellation. This is useful both
4090 for unix systems without a native poll and for portability to
4092 When this function returns %TRUE, you should use
4093 g_cancellable_release_fd() to free up resources allocated for the
4094 If this function returns %FALSE, either no @cancellable was given or
4095 resource limits prevent this function from allocating the necessary
4096 structures for polling. (On Linux, you will likely have reached
4097 the maximum number of file descriptors.) The suggested way to handle
4098 these cases is to ignore the @cancellable.
4099 You are not supposed to read from the fd yourself, just check for
4100 readable status. Reading to unset the readable status is done
4101 with g_cancellable_reset().
4102 failure to prepare the cancellable.</doc>
4103 <return-value transfer-ownership="none">
4104 <doc xml:whitespace="preserve">%TRUE if @pollfd was successfully initialized, %FALSE on</doc>
4105 <type name="gboolean" c:type="gboolean"/>
4108 <parameter name="pollfd" transfer-ownership="none">
4109 <doc xml:whitespace="preserve">a pointer to a #GPollFD</doc>
4110 <type name="GLib.PollFD" c:type="GPollFD*"/>
4114 <method name="pop_current" c:identifier="g_cancellable_pop_current">
4115 <doc xml:whitespace="preserve">Pops @cancellable off the cancellable stack (verifying that @cancellable
4116 is on the top of the stack).</doc>
4117 <return-value transfer-ownership="none">
4118 <type name="none" c:type="void"/>
4121 <method name="push_current" c:identifier="g_cancellable_push_current">
4122 <doc xml:whitespace="preserve">Pushes @cancellable onto the cancellable stack. The current
4123 cancllable can then be recieved using g_cancellable_get_current().
4124 This is useful when implementing cancellable operations in
4125 code that does not allow you to pass down the cancellable object.
4126 This is typically called automatically by e.g. #GFile operations,
4127 so you rarely have to call this yourself.</doc>
4128 <return-value transfer-ownership="none">
4129 <type name="none" c:type="void"/>
4132 <method name="release_fd"
4133 c:identifier="g_cancellable_release_fd"
4135 <doc xml:whitespace="preserve">Releases a resources previously allocated by g_cancellable_get_fd()
4136 or g_cancellable_make_pollfd().
4137 For compatibility reasons with older releases, calling this function
4138 is not strictly required, the resources will be automatically freed
4139 when the @cancellable is finalized. However, the @cancellable will
4140 block scarce file descriptors until it is finalized if this function
4141 is not called. This can cause the application to run out of file
4142 descriptors when many #GCancellables are used at the same time.</doc>
4143 <return-value transfer-ownership="none">
4144 <type name="none" c:type="void"/>
4147 <method name="reset" c:identifier="g_cancellable_reset">
4148 <doc xml:whitespace="preserve">Resets @cancellable to its uncancelled state.</doc>
4149 <return-value transfer-ownership="none">
4150 <type name="none" c:type="void"/>
4153 <method name="set_error_if_cancelled"
4154 c:identifier="g_cancellable_set_error_if_cancelled"
4156 <doc xml:whitespace="preserve">If the @cancellable is cancelled, sets the error to notify
4157 that the operation was cancelled.</doc>
4158 <return-value transfer-ownership="none">
4159 <doc xml:whitespace="preserve">%TRUE if @cancellable was cancelled, %FALSE if it was not.</doc>
4160 <type name="gboolean" c:type="gboolean"/>
4163 <field name="parent_instance">
4164 <type name="GObject.Object" c:type="GObject"/>
4167 <type name="CancellablePrivate" c:type="GCancellablePrivate*"/>
4169 <glib:signal name="cancelled">
4170 <doc xml:whitespace="preserve">Emitted when the operation has been cancelled.
4171 Can be used by implementations of cancellable operations. If the
4172 operation is cancelled from another thread, the signal will be
4173 emitted in the thread that cancelled the operation, not the
4174 thread that is running the operation.
4175 Note that disconnecting from this signal (or any signal) in a
4176 multi-threaded program is prone to race conditions. For instance
4177 it is possible that a signal handler may be invoked even
4178 <emphasis>after</emphasis> a call to
4179 g_signal_handler_disconnect() for that handler has already
4181 There is also a problem when cancellation happen
4182 right before connecting to the signal. If this happens the
4183 signal will unexpectedly not be emitted, and checking before
4184 connecting to the signal leaves a race condition where this is
4186 In order to make it safe and easy to connect handlers there
4187 g_cancellable_disconnect() which protect against problems
4189 An example of how to us this:
4191 /<!-- -->* Make sure we don't do any unnecessary work if already cancelled *<!-- -->/
4192 if (g_cancellable_set_error_if_cancelled (cancellable))
4194 /<!-- -->* Set up all the data needed to be able to
4195 * handle cancellation of the operation *<!-- -->/
4196 my_data = my_data_new (...);
4199 id = g_cancellable_connect (cancellable,
4200 G_CALLBACK (cancelled_handler)
4202 /<!-- -->* cancellable operation here... *<!-- -->/
4203 g_cancellable_disconnect (cancellable, id);
4204 /<!-- -->* cancelled_handler is never called after this, it
4205 * is now safe to free the data *<!-- -->/
4206 my_data_free (my_data);
4208 Note that the cancelled signal is emitted in the thread that
4209 the user cancelled from, which may be the main thread. So, the
4210 cancellable signal should not do something that can block.</doc>
4211 <return-value transfer-ownership="none">
4216 <record name="CancellableClass"
4217 c:type="GCancellableClass"
4218 glib:is-gtype-struct-for="Cancellable">
4219 <field name="parent_class">
4220 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
4222 <field name="cancelled">
4223 <callback name="cancelled">
4224 <return-value transfer-ownership="none">
4225 <type name="none" c:type="void"/>
4228 <parameter name="cancellable" transfer-ownership="none">
4229 <type name="Cancellable" c:type="GCancellable*"/>
4234 <field name="_g_reserved1" introspectable="0">
4235 <callback name="_g_reserved1">
4236 <return-value transfer-ownership="none">
4237 <type name="none" c:type="void"/>
4241 <field name="_g_reserved2" introspectable="0">
4242 <callback name="_g_reserved2">
4243 <return-value transfer-ownership="none">
4244 <type name="none" c:type="void"/>
4248 <field name="_g_reserved3" introspectable="0">
4249 <callback name="_g_reserved3">
4250 <return-value transfer-ownership="none">
4251 <type name="none" c:type="void"/>
4255 <field name="_g_reserved4" introspectable="0">
4256 <callback name="_g_reserved4">
4257 <return-value transfer-ownership="none">
4258 <type name="none" c:type="void"/>
4262 <field name="_g_reserved5" introspectable="0">
4263 <callback name="_g_reserved5">
4264 <return-value transfer-ownership="none">
4265 <type name="none" c:type="void"/>
4270 <record name="CancellablePrivate"
4271 c:type="GCancellablePrivate"
4274 <class name="CharsetConverter"
4275 c:symbol-prefix="charset_converter"
4276 c:type="GCharsetConverter"
4277 parent="GObject.Object"
4278 glib:type-name="GCharsetConverter"
4279 glib:get-type="g_charset_converter_get_type"
4280 glib:type-struct="CharsetConverterClass">
4281 <doc xml:whitespace="preserve">Conversions between character sets.</doc>
4282 <implements name="Converter"/>
4283 <implements name="Initable"/>
4284 <constructor name="new"
4285 c:identifier="g_charset_converter_new"
4288 <doc xml:whitespace="preserve">Creates a new #GCharsetConverter.</doc>
4289 <return-value transfer-ownership="full">
4290 <doc xml:whitespace="preserve">a new #GCharsetConverter or %NULL on error.</doc>
4291 <type name="CharsetConverter" c:type="GCharsetConverter*"/>
4294 <parameter name="to_charset" transfer-ownership="none">
4295 <doc xml:whitespace="preserve">destination charset</doc>
4296 <type name="utf8" c:type="gchar*"/>
4298 <parameter name="from_charset" transfer-ownership="none">
4299 <doc xml:whitespace="preserve">source charset</doc>
4300 <type name="utf8" c:type="gchar*"/>
4304 <method name="get_num_fallbacks"
4305 c:identifier="g_charset_converter_get_num_fallbacks"
4307 <doc xml:whitespace="preserve">Gets the number of fallbacks that @converter has applied so far.</doc>
4308 <return-value transfer-ownership="none">
4309 <doc xml:whitespace="preserve">the number of fallbacks that @converter has applied</doc>
4310 <type name="guint" c:type="guint"/>
4313 <method name="get_use_fallback"
4314 c:identifier="g_charset_converter_get_use_fallback"
4316 <doc xml:whitespace="preserve">Gets the #GCharsetConverter:use-fallback property.</doc>
4317 <return-value transfer-ownership="none">
4318 <doc xml:whitespace="preserve">%TRUE if fallbacks are used by @converter</doc>
4319 <type name="gboolean" c:type="gboolean"/>
4322 <method name="set_use_fallback"
4323 c:identifier="g_charset_converter_set_use_fallback"
4325 <doc xml:whitespace="preserve">Sets the #GCharsetConverter:use-fallback property.</doc>
4326 <return-value transfer-ownership="none">
4327 <type name="none" c:type="void"/>
4330 <parameter name="use_fallback" transfer-ownership="none">
4331 <doc xml:whitespace="preserve">%TRUE to use fallbacks</doc>
4332 <type name="gboolean" c:type="gboolean"/>
4336 <property name="from-charset"
4339 transfer-ownership="none">
4342 <property name="to-charset"
4345 transfer-ownership="none">
4348 <property name="use-fallback"
4351 transfer-ownership="none">
4352 <type name="gboolean"/>
4355 <record name="CharsetConverterClass"
4356 c:type="GCharsetConverterClass"
4357 glib:is-gtype-struct-for="CharsetConverter">
4358 <field name="parent_class">
4359 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
4362 <interface name="Converter"
4363 c:symbol-prefix="converter"
4366 glib:type-name="GConverter"
4367 glib:get-type="g_converter_get_type"
4368 glib:type-struct="ConverterIface">
4369 <doc xml:whitespace="preserve">Seek object for streaming operations.</doc>
4370 <virtual-method name="convert"
4374 <doc xml:whitespace="preserve">This is the main operation used when converting data. It is to be called
4375 multiple times in a loop, and each time it will do some work, i.e.
4376 producing some output (in @outbuf) or consuming some input (from @inbuf) or
4377 both. If its not possible to do any work an error is returned.
4378 Note that a single call may not consume all input (or any input at all).
4379 Also a call may produce output even if given no input, due to state stored
4380 in the converter producing output.
4381 If any data was either produced or consumed, and then an error happens, then
4382 only the successful conversion is reported and the error is returned on the
4384 A full conversion loop involves calling this method repeatedly, each time
4385 giving it new input and space output space. When there is no more input
4386 data after the data in @inbuf, the flag %G_CONVERTER_INPUT_AT_END must be set.
4387 The loop will be (unless some error happens) returning %G_CONVERTER_CONVERTED
4388 each time until all data is consumed and all output is produced, then
4389 %G_CONVERTER_FINISHED is returned instead. Note, that %G_CONVERTER_FINISHED
4390 may be returned even if %G_CONVERTER_INPUT_AT_END is not set, for instance
4391 in a decompression converter where the end of data is detectable from the
4392 data (and there might even be other data after the end of the compressed data).
4393 When some data has successfully been converted @bytes_read and is set to
4394 the number of bytes read from @inbuf, and @bytes_written is set to indicate
4395 how many bytes was written to @outbuf. If there are more data to output
4396 or consume (i.e. unless the G_CONVERTER_INPUT_AT_END is specified) then
4397 G_CONVERTER_CONVERTED is returned, and if no more data is to be output
4398 then G_CONVERTER_FINISHED is returned.
4399 On error %G_CONVERTER_ERROR is returned and @error is set accordingly.
4400 Some errors need special handling:
4401 %G_IO_ERROR_NO_SPACE is returned if there is not enough space
4402 to write the resulting converted data, the application should
4403 call the function again with a larger @outbuf to continue.
4404 %G_IO_ERROR_PARTIAL_INPUT is returned if there is not enough
4405 input to fully determine what the conversion should produce,
4406 and the %G_CONVERTER_INPUT_AT_END flag is not set. This happens for
4407 example with an incomplete multibyte sequence when converting text,
4408 or when a regexp matches up to the end of the input (and may match
4409 further input). It may also happen when @inbuf_size is zero and
4410 there is no more data to produce.
4411 When this happens the application should read more input and then
4412 call the function again. If further input shows that there is no
4413 more data call the function again with the same data but with
4414 the %G_CONVERTER_INPUT_AT_END flag set. This may cause the conversion
4415 to finish as e.g. in the regexp match case (or, to fail again with
4416 %G_IO_ERROR_PARTIAL_INPUT in e.g. a charset conversion where the
4417 input is actually partial).
4418 After g_converter_convert() has returned %G_CONVERTER_FINISHED the
4419 converter object is in an invalid state where its not allowed
4420 to call g_converter_convert() anymore. At this time you can only
4421 free the object or call g_converter_reset() to reset it to the
4423 If the flag %G_CONVERTER_FLUSH is set then conversion is modified
4424 to try to write out all internal state to the output. The application
4425 has to call the function multiple times with the flag set, and when
4426 the availible input has been consumed and all internal state has
4427 been produced then %G_CONVERTER_FLUSHED (or %G_CONVERTER_FINISHED if
4428 really at the end) is returned instead of %G_CONVERTER_CONVERTED.
4429 This is somewhat similar to what happens at the end of the input stream,
4430 but done in the middle of the data.
4431 This has different meanings for different conversions. For instance
4432 in a compression converter it would mean that we flush all the
4433 compression state into output such that if you uncompress the
4434 compressed data you get back all the input data. Doing this may
4435 make the final file larger due to padding though. Another example
4436 is a regexp conversion, where if you at the end of the flushed data
4437 have a match, but there is also a potential longer match. In the
4438 non-flushed case we would ask for more input, but when flushing we
4439 treat this as the end of input and do the match.
4440 Flushing is not always possible (like if a charset converter flushes
4441 at a partial multibyte sequence). Converters are supposed to try
4442 to produce as much output as possible and then return an error
4443 (typically %G_IO_ERROR_PARTIAL_INPUT).</doc>
4444 <return-value transfer-ownership="none">
4445 <doc xml:whitespace="preserve">a #GConverterResult, %G_CONVERTER_ERROR on error.</doc>
4446 <type name="ConverterResult" c:type="GConverterResult"/>
4449 <parameter name="inbuf" transfer-ownership="none">
4450 <doc xml:whitespace="preserve">the buffer containing the data to convert.</doc>
4451 <type name="gpointer" c:type="void*"/>
4453 <parameter name="inbuf_size" transfer-ownership="none">
4454 <doc xml:whitespace="preserve">the number of bytes in @inbuf</doc>
4455 <type name="gulong" c:type="gsize"/>
4457 <parameter name="outbuf" transfer-ownership="none">
4458 <doc xml:whitespace="preserve">a buffer to write converted data in.</doc>
4459 <type name="gpointer" c:type="void*"/>
4461 <parameter name="outbuf_size" transfer-ownership="none">
4462 <doc xml:whitespace="preserve">the number of bytes in @outbuf, must be at least one</doc>
4463 <type name="gulong" c:type="gsize"/>
4465 <parameter name="flags" transfer-ownership="none">
4466 <doc xml:whitespace="preserve">a #GConvertFlags controlling the conversion details</doc>
4467 <type name="ConverterFlags" c:type="GConverterFlags"/>
4469 <parameter name="bytes_read" transfer-ownership="none">
4470 <doc xml:whitespace="preserve">will be set to the number of bytes read from @inbuf on success</doc>
4471 <type name="gulong" c:type="gsize*"/>
4473 <parameter name="bytes_written" transfer-ownership="none">
4474 <doc xml:whitespace="preserve">will be set to the number of bytes written to @outbuf on success</doc>
4475 <type name="gulong" c:type="gsize*"/>
4479 <virtual-method name="reset" invoker="reset" version="2.24">
4480 <doc xml:whitespace="preserve">Resets all internal state in the converter, making it behave
4481 as if it was just created. If the converter has any internal
4482 state that would produce output then that output is lost.</doc>
4483 <return-value transfer-ownership="none">
4484 <type name="none" c:type="void"/>
4487 <method name="convert"
4488 c:identifier="g_converter_convert"
4491 <doc xml:whitespace="preserve">This is the main operation used when converting data. It is to be called
4492 multiple times in a loop, and each time it will do some work, i.e.
4493 producing some output (in @outbuf) or consuming some input (from @inbuf) or
4494 both. If its not possible to do any work an error is returned.
4495 Note that a single call may not consume all input (or any input at all).
4496 Also a call may produce output even if given no input, due to state stored
4497 in the converter producing output.
4498 If any data was either produced or consumed, and then an error happens, then
4499 only the successful conversion is reported and the error is returned on the
4501 A full conversion loop involves calling this method repeatedly, each time
4502 giving it new input and space output space. When there is no more input
4503 data after the data in @inbuf, the flag %G_CONVERTER_INPUT_AT_END must be set.
4504 The loop will be (unless some error happens) returning %G_CONVERTER_CONVERTED
4505 each time until all data is consumed and all output is produced, then
4506 %G_CONVERTER_FINISHED is returned instead. Note, that %G_CONVERTER_FINISHED
4507 may be returned even if %G_CONVERTER_INPUT_AT_END is not set, for instance
4508 in a decompression converter where the end of data is detectable from the
4509 data (and there might even be other data after the end of the compressed data).
4510 When some data has successfully been converted @bytes_read and is set to
4511 the number of bytes read from @inbuf, and @bytes_written is set to indicate
4512 how many bytes was written to @outbuf. If there are more data to output
4513 or consume (i.e. unless the G_CONVERTER_INPUT_AT_END is specified) then
4514 G_CONVERTER_CONVERTED is returned, and if no more data is to be output
4515 then G_CONVERTER_FINISHED is returned.
4516 On error %G_CONVERTER_ERROR is returned and @error is set accordingly.
4517 Some errors need special handling:
4518 %G_IO_ERROR_NO_SPACE is returned if there is not enough space
4519 to write the resulting converted data, the application should
4520 call the function again with a larger @outbuf to continue.
4521 %G_IO_ERROR_PARTIAL_INPUT is returned if there is not enough
4522 input to fully determine what the conversion should produce,
4523 and the %G_CONVERTER_INPUT_AT_END flag is not set. This happens for
4524 example with an incomplete multibyte sequence when converting text,
4525 or when a regexp matches up to the end of the input (and may match
4526 further input). It may also happen when @inbuf_size is zero and
4527 there is no more data to produce.
4528 When this happens the application should read more input and then
4529 call the function again. If further input shows that there is no
4530 more data call the function again with the same data but with
4531 the %G_CONVERTER_INPUT_AT_END flag set. This may cause the conversion
4532 to finish as e.g. in the regexp match case (or, to fail again with
4533 %G_IO_ERROR_PARTIAL_INPUT in e.g. a charset conversion where the
4534 input is actually partial).
4535 After g_converter_convert() has returned %G_CONVERTER_FINISHED the
4536 converter object is in an invalid state where its not allowed
4537 to call g_converter_convert() anymore. At this time you can only
4538 free the object or call g_converter_reset() to reset it to the
4540 If the flag %G_CONVERTER_FLUSH is set then conversion is modified
4541 to try to write out all internal state to the output. The application
4542 has to call the function multiple times with the flag set, and when
4543 the availible input has been consumed and all internal state has
4544 been produced then %G_CONVERTER_FLUSHED (or %G_CONVERTER_FINISHED if
4545 really at the end) is returned instead of %G_CONVERTER_CONVERTED.
4546 This is somewhat similar to what happens at the end of the input stream,
4547 but done in the middle of the data.
4548 This has different meanings for different conversions. For instance
4549 in a compression converter it would mean that we flush all the
4550 compression state into output such that if you uncompress the
4551 compressed data you get back all the input data. Doing this may
4552 make the final file larger due to padding though. Another example
4553 is a regexp conversion, where if you at the end of the flushed data
4554 have a match, but there is also a potential longer match. In the
4555 non-flushed case we would ask for more input, but when flushing we
4556 treat this as the end of input and do the match.
4557 Flushing is not always possible (like if a charset converter flushes
4558 at a partial multibyte sequence). Converters are supposed to try
4559 to produce as much output as possible and then return an error
4560 (typically %G_IO_ERROR_PARTIAL_INPUT).</doc>
4561 <return-value transfer-ownership="none">
4562 <doc xml:whitespace="preserve">a #GConverterResult, %G_CONVERTER_ERROR on error.</doc>
4563 <type name="ConverterResult" c:type="GConverterResult"/>
4566 <parameter name="inbuf" transfer-ownership="none">
4567 <doc xml:whitespace="preserve">the buffer containing the data to convert.</doc>
4568 <type name="gpointer" c:type="void*"/>
4570 <parameter name="inbuf_size" transfer-ownership="none">
4571 <doc xml:whitespace="preserve">the number of bytes in @inbuf</doc>
4572 <type name="gulong" c:type="gsize"/>
4574 <parameter name="outbuf" transfer-ownership="none">
4575 <doc xml:whitespace="preserve">a buffer to write converted data in.</doc>
4576 <type name="gpointer" c:type="void*"/>
4578 <parameter name="outbuf_size" transfer-ownership="none">
4579 <doc xml:whitespace="preserve">the number of bytes in @outbuf, must be at least one</doc>
4580 <type name="gulong" c:type="gsize"/>
4582 <parameter name="flags" transfer-ownership="none">
4583 <doc xml:whitespace="preserve">a #GConvertFlags controlling the conversion details</doc>
4584 <type name="ConverterFlags" c:type="GConverterFlags"/>
4586 <parameter name="bytes_read" transfer-ownership="none">
4587 <doc xml:whitespace="preserve">will be set to the number of bytes read from @inbuf on success</doc>
4588 <type name="gulong" c:type="gsize*"/>
4590 <parameter name="bytes_written" transfer-ownership="none">
4591 <doc xml:whitespace="preserve">will be set to the number of bytes written to @outbuf on success</doc>
4592 <type name="gulong" c:type="gsize*"/>
4596 <method name="reset" c:identifier="g_converter_reset" version="2.24">
4597 <doc xml:whitespace="preserve">Resets all internal state in the converter, making it behave
4598 as if it was just created. If the converter has any internal
4599 state that would produce output then that output is lost.</doc>
4600 <return-value transfer-ownership="none">
4601 <type name="none" c:type="void"/>
4605 <bitfield name="ConverterFlags"
4607 glib:type-name="GConverterFlags"
4608 glib:get-type="g_converter_flags_get_type"
4609 c:type="GConverterFlags">
4610 <doc xml:whitespace="preserve">Flags used when calling a g_converter_convert().</doc>
4613 c:identifier="G_CONVERTER_NO_FLAGS"
4615 <member name="input_at_end"
4617 c:identifier="G_CONVERTER_INPUT_AT_END"
4618 glib:nick="input-at-end"/>
4619 <member name="flush"
4621 c:identifier="G_CONVERTER_FLUSH"
4624 <record name="ConverterIface"
4625 c:type="GConverterIface"
4626 glib:is-gtype-struct-for="Converter"
4628 <doc xml:whitespace="preserve">Provides an interface for converting data from one type
4629 to another type. The conversion can be stateful
4630 and may fail at any place.</doc>
4631 <field name="g_iface">
4632 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
4634 <field name="convert">
4635 <callback name="convert" throws="1">
4636 <return-value transfer-ownership="none">
4637 <doc xml:whitespace="preserve">a #GConverterResult, %G_CONVERTER_ERROR on error.</doc>
4638 <type name="ConverterResult" c:type="GConverterResult"/>
4641 <parameter name="converter" transfer-ownership="none">
4642 <type name="Converter" c:type="GConverter*"/>
4644 <parameter name="inbuf" transfer-ownership="none">
4645 <doc xml:whitespace="preserve">the buffer containing the data to convert.</doc>
4646 <type name="gpointer" c:type="void*"/>
4648 <parameter name="inbuf_size" transfer-ownership="none">
4649 <doc xml:whitespace="preserve">the number of bytes in @inbuf</doc>
4650 <type name="gulong" c:type="gsize"/>
4652 <parameter name="outbuf" transfer-ownership="none">
4653 <doc xml:whitespace="preserve">a buffer to write converted data in.</doc>
4654 <type name="gpointer" c:type="void*"/>
4656 <parameter name="outbuf_size" transfer-ownership="none">
4657 <doc xml:whitespace="preserve">the number of bytes in @outbuf, must be at least one</doc>
4658 <type name="gulong" c:type="gsize"/>
4660 <parameter name="flags" transfer-ownership="none">
4661 <doc xml:whitespace="preserve">a #GConvertFlags controlling the conversion details</doc>
4662 <type name="ConverterFlags" c:type="GConverterFlags"/>
4664 <parameter name="bytes_read" transfer-ownership="none">
4665 <doc xml:whitespace="preserve">will be set to the number of bytes read from @inbuf on success</doc>
4666 <type name="gulong" c:type="gsize*"/>
4668 <parameter name="bytes_written" transfer-ownership="none">
4669 <doc xml:whitespace="preserve">will be set to the number of bytes written to @outbuf on success</doc>
4670 <type name="gulong" c:type="gsize*"/>
4675 <field name="reset">
4676 <callback name="reset">
4677 <return-value transfer-ownership="none">
4678 <type name="none" c:type="void"/>
4681 <parameter name="converter" transfer-ownership="none">
4682 <type name="Converter" c:type="GConverter*"/>
4688 <class name="ConverterInputStream"
4689 c:symbol-prefix="converter_input_stream"
4690 c:type="GConverterInputStream"
4691 parent="FilterInputStream"
4692 glib:type-name="GConverterInputStream"
4693 glib:get-type="g_converter_input_stream_get_type"
4694 glib:type-struct="ConverterInputStreamClass">
4695 <doc xml:whitespace="preserve">An implementation of #GFilterInputStream that allows data
4697 <constructor name="new" c:identifier="g_converter_input_stream_new">
4698 <doc xml:whitespace="preserve">Creates a new converter input stream for the @base_stream.</doc>
4699 <return-value transfer-ownership="full">
4700 <doc xml:whitespace="preserve">a new #GInputStream.</doc>
4701 <type name="InputStream" c:type="GInputStream*"/>
4704 <parameter name="base_stream" transfer-ownership="none">
4705 <doc xml:whitespace="preserve">a #GInputStream</doc>
4706 <type name="InputStream" c:type="GInputStream*"/>
4708 <parameter name="converter" transfer-ownership="none">
4709 <doc xml:whitespace="preserve">a #GConverter</doc>
4710 <type name="Converter" c:type="GConverter*"/>
4714 <method name="get_converter"
4715 c:identifier="g_converter_input_stream_get_converter"
4717 <doc xml:whitespace="preserve">Gets the #GConverter that is used by @converter_stream.</doc>
4718 <return-value transfer-ownership="none">
4719 <doc xml:whitespace="preserve">the converter of the converter input stream</doc>
4720 <type name="Converter" c:type="GConverter*"/>
4723 <property name="converter"
4726 transfer-ownership="none">
4727 <type name="Converter"/>
4729 <field name="parent_instance">
4730 <type name="FilterInputStream" c:type="GFilterInputStream"/>
4733 <type name="ConverterInputStreamPrivate"
4734 c:type="GConverterInputStreamPrivate*"/>
4737 <record name="ConverterInputStreamClass"
4738 c:type="GConverterInputStreamClass"
4739 glib:is-gtype-struct-for="ConverterInputStream">
4740 <field name="parent_class">
4741 <type name="FilterInputStreamClass" c:type="GFilterInputStreamClass"/>
4743 <field name="_g_reserved1" introspectable="0">
4744 <callback name="_g_reserved1">
4745 <return-value transfer-ownership="none">
4746 <type name="none" c:type="void"/>
4750 <field name="_g_reserved2" introspectable="0">
4751 <callback name="_g_reserved2">
4752 <return-value transfer-ownership="none">
4753 <type name="none" c:type="void"/>
4757 <field name="_g_reserved3" introspectable="0">
4758 <callback name="_g_reserved3">
4759 <return-value transfer-ownership="none">
4760 <type name="none" c:type="void"/>
4764 <field name="_g_reserved4" introspectable="0">
4765 <callback name="_g_reserved4">
4766 <return-value transfer-ownership="none">
4767 <type name="none" c:type="void"/>
4771 <field name="_g_reserved5" introspectable="0">
4772 <callback name="_g_reserved5">
4773 <return-value transfer-ownership="none">
4774 <type name="none" c:type="void"/>
4779 <record name="ConverterInputStreamPrivate"
4780 c:type="GConverterInputStreamPrivate"
4783 <class name="ConverterOutputStream"
4784 c:symbol-prefix="converter_output_stream"
4785 c:type="GConverterOutputStream"
4786 parent="FilterOutputStream"
4787 glib:type-name="GConverterOutputStream"
4788 glib:get-type="g_converter_output_stream_get_type"
4789 glib:type-struct="ConverterOutputStreamClass">
4790 <doc xml:whitespace="preserve">An implementation of #GFilterOutputStream that allows data
4792 <constructor name="new" c:identifier="g_converter_output_stream_new">
4793 <doc xml:whitespace="preserve">Creates a new converter output stream for the @base_stream.</doc>
4794 <return-value transfer-ownership="full">
4795 <doc xml:whitespace="preserve">a new #GOutputStream.</doc>
4796 <type name="OutputStream" c:type="GOutputStream*"/>
4799 <parameter name="base_stream" transfer-ownership="none">
4800 <doc xml:whitespace="preserve">a #GOutputStream</doc>
4801 <type name="OutputStream" c:type="GOutputStream*"/>
4803 <parameter name="converter" transfer-ownership="none">
4804 <doc xml:whitespace="preserve">a #GConverter</doc>
4805 <type name="Converter" c:type="GConverter*"/>
4809 <method name="get_converter"
4810 c:identifier="g_converter_output_stream_get_converter"
4812 <doc xml:whitespace="preserve">Gets the #GConverter that is used by @converter_stream.</doc>
4813 <return-value transfer-ownership="none">
4814 <doc xml:whitespace="preserve">the converter of the converter output stream</doc>
4815 <type name="Converter" c:type="GConverter*"/>
4818 <property name="converter"
4821 transfer-ownership="none">
4822 <type name="Converter"/>
4824 <field name="parent_instance">
4825 <type name="FilterOutputStream" c:type="GFilterOutputStream"/>
4828 <type name="ConverterOutputStreamPrivate"
4829 c:type="GConverterOutputStreamPrivate*"/>
4832 <record name="ConverterOutputStreamClass"
4833 c:type="GConverterOutputStreamClass"
4834 glib:is-gtype-struct-for="ConverterOutputStream">
4835 <field name="parent_class">
4836 <type name="FilterOutputStreamClass"
4837 c:type="GFilterOutputStreamClass"/>
4839 <field name="_g_reserved1" introspectable="0">
4840 <callback name="_g_reserved1">
4841 <return-value transfer-ownership="none">
4842 <type name="none" c:type="void"/>
4846 <field name="_g_reserved2" introspectable="0">
4847 <callback name="_g_reserved2">
4848 <return-value transfer-ownership="none">
4849 <type name="none" c:type="void"/>
4853 <field name="_g_reserved3" introspectable="0">
4854 <callback name="_g_reserved3">
4855 <return-value transfer-ownership="none">
4856 <type name="none" c:type="void"/>
4860 <field name="_g_reserved4" introspectable="0">
4861 <callback name="_g_reserved4">
4862 <return-value transfer-ownership="none">
4863 <type name="none" c:type="void"/>
4867 <field name="_g_reserved5" introspectable="0">
4868 <callback name="_g_reserved5">
4869 <return-value transfer-ownership="none">
4870 <type name="none" c:type="void"/>
4875 <record name="ConverterOutputStreamPrivate"
4876 c:type="GConverterOutputStreamPrivate"
4879 <enumeration name="ConverterResult"
4881 glib:type-name="GConverterResult"
4882 glib:get-type="g_converter_result_get_type"
4883 c:type="GConverterResult">
4884 <doc xml:whitespace="preserve">Results returned from g_converter_convert().</doc>
4885 <member name="error"
4887 c:identifier="G_CONVERTER_ERROR"
4889 <member name="converted"
4891 c:identifier="G_CONVERTER_CONVERTED"
4892 glib:nick="converted"/>
4893 <member name="finished"
4895 c:identifier="G_CONVERTER_FINISHED"
4896 glib:nick="finished"/>
4897 <member name="flushed"
4899 c:identifier="G_CONVERTER_FLUSHED"
4900 glib:nick="flushed"/>
4902 <class name="Credentials"
4903 c:symbol-prefix="credentials"
4904 c:type="GCredentials"
4906 parent="GObject.Object"
4907 glib:type-name="GCredentials"
4908 glib:get-type="g_credentials_get_type"
4909 glib:type-struct="CredentialsClass">
4910 <doc xml:whitespace="preserve">The #GCredentials structure contains only private data and
4911 should only be accessed using the provided API.</doc>
4912 <constructor name="new" c:identifier="g_credentials_new" version="2.26">
4913 <doc xml:whitespace="preserve">Creates a new #GCredentials object with credentials matching the
4914 the current process.</doc>
4915 <return-value transfer-ownership="full">
4916 <doc xml:whitespace="preserve">A #GCredentials. Free with g_object_unref().</doc>
4917 <type name="Credentials" c:type="GCredentials*"/>
4920 <method name="get_native"
4921 c:identifier="g_credentials_get_native"
4924 <doc xml:whitespace="preserve">Gets a pointer to native credentials of type @native_type from
4925 It is a programming error (which will cause an warning to be
4926 logged) to use this method if there is no #GCredentials support for
4927 the OS or if @native_type isn't supported by the OS.
4928 operation there is no #GCredentials support for the OS or if
4929 data, it is owned by @credentials.</doc>
4931 <doc xml:whitespace="preserve">The pointer to native credentials or %NULL if the</doc>
4932 <type name="gpointer" c:type="gpointer"/>
4935 <parameter name="native_type" transfer-ownership="none">
4936 <doc xml:whitespace="preserve">The type of native credentials to get.</doc>
4937 <type name="CredentialsType" c:type="GCredentialsType"/>
4941 <method name="get_unix_user"
4942 c:identifier="g_credentials_get_unix_user"
4945 <doc xml:whitespace="preserve">Tries to get the UNIX user identifier from @credentials. This
4946 method is only available on UNIX platforms.
4947 This operation can fail if #GCredentials is not supported on the
4948 OS or if the native credentials type does not contain information
4949 about the UNIX user.</doc>
4950 <return-value transfer-ownership="none">
4951 <doc xml:whitespace="preserve">The UNIX user identifier or -1 if @error is set.</doc>
4952 <type name="guint" c:type="uid_t"/>
4955 <method name="is_same_user"
4956 c:identifier="g_credentials_is_same_user"
4959 <doc xml:whitespace="preserve">Checks if @credentials and @other_credentials is the same user.
4960 This operation can fail if #GCredentials is not supported on the
4962 user, %FALSE otherwise or if @error is set.</doc>
4963 <return-value transfer-ownership="none">
4964 <doc xml:whitespace="preserve">%TRUE if @credentials and @other_credentials has the same</doc>
4965 <type name="gboolean" c:type="gboolean"/>
4968 <parameter name="other_credentials" transfer-ownership="none">
4969 <doc xml:whitespace="preserve">A #GCredentials.</doc>
4970 <type name="Credentials" c:type="GCredentials*"/>
4974 <method name="set_native"
4975 c:identifier="g_credentials_set_native"
4977 <doc xml:whitespace="preserve">Copies the native credentials of type @native_type from @native
4979 It is a programming error (which will cause an warning to be
4980 logged) to use this method if there is no #GCredentials support for
4981 the OS or if @native_type isn't supported by the OS.</doc>
4982 <return-value transfer-ownership="none">
4983 <type name="none" c:type="void"/>
4986 <parameter name="native_type" transfer-ownership="none">
4987 <doc xml:whitespace="preserve">The type of native credentials to set.</doc>
4988 <type name="CredentialsType" c:type="GCredentialsType"/>
4990 <parameter name="native" transfer-ownership="none">
4991 <doc xml:whitespace="preserve">A pointer to native credentials.</doc>
4992 <type name="gpointer" c:type="gpointer"/>
4996 <method name="set_unix_user"
4997 c:identifier="g_credentials_set_unix_user"
5000 <doc xml:whitespace="preserve">Tries to set the UNIX user identifier on @credentials. This method
5001 is only available on UNIX platforms.
5002 This operation can fail if #GCredentials is not supported on the
5003 OS or if the native credentials type does not contain information
5004 about the UNIX user.</doc>
5005 <return-value transfer-ownership="none">
5006 <doc xml:whitespace="preserve">%TRUE if @uid was set, %FALSE if error is set.</doc>
5007 <type name="gboolean" c:type="gboolean"/>
5010 <parameter name="uid" transfer-ownership="none">
5011 <doc xml:whitespace="preserve">The UNIX user identifier to set.</doc>
5012 <type name="guint" c:type="uid_t"/>
5016 <method name="to_string"
5017 c:identifier="g_credentials_to_string"
5019 <doc xml:whitespace="preserve">Creates a human-readable textual representation of @credentials
5020 that can be used in logging and debug messages. The format of the
5021 returned string may change in future GLib release.</doc>
5022 <return-value transfer-ownership="full">
5023 <doc xml:whitespace="preserve">A string that should be freed with g_free().</doc>
5024 <type name="utf8" c:type="gchar*"/>
5028 <record name="CredentialsClass"
5029 c:type="GCredentialsClass"
5031 glib:is-gtype-struct-for="Credentials"
5033 <doc xml:whitespace="preserve">Class structure for #GCredentials.</doc>
5035 <enumeration name="CredentialsType"
5037 glib:type-name="GCredentialsType"
5038 glib:get-type="g_credentials_type_get_type"
5039 c:type="GCredentialsType">
5040 <doc xml:whitespace="preserve">Enumeration describing different kinds of native credential types.</doc>
5041 <member name="invalid"
5043 c:identifier="G_CREDENTIALS_TYPE_INVALID"
5044 glib:nick="invalid"/>
5045 <member name="linux_ucred"
5047 c:identifier="G_CREDENTIALS_TYPE_LINUX_UCRED"
5048 glib:nick="linux-ucred"/>
5049 <member name="freebsd_cmsgcred"
5051 c:identifier="G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED"
5052 glib:nick="freebsd-cmsgcred"/>
5054 <record name="DBusAnnotationInfo"
5055 c:type="GDBusAnnotationInfo"
5057 glib:type-name="GDBusAnnotationInfo"
5058 glib:get-type="g_dbus_annotation_info_get_type"
5059 c:symbol-prefix="dbus_annotation_info">
5060 <doc xml:whitespace="preserve">Information about an annotation.</doc>
5061 <field name="ref_count" writable="1">
5062 <type name="gint" c:type="gint"/>
5064 <field name="key" writable="1">
5065 <type name="utf8" c:type="gchar*"/>
5067 <field name="value" writable="1">
5068 <type name="utf8" c:type="gchar*"/>
5070 <field name="annotations" writable="1">
5071 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
5074 c:identifier="g_dbus_annotation_info_ref"
5076 <doc xml:whitespace="preserve">If @info is statically allocated does nothing. Otherwise increases
5077 the reference count.</doc>
5078 <return-value transfer-ownership="full">
5079 <doc xml:whitespace="preserve">The same @info.</doc>
5080 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo*"/>
5083 <method name="unref"
5084 c:identifier="g_dbus_annotation_info_unref"
5086 <doc xml:whitespace="preserve">If @info is statically allocated, does nothing. Otherwise decreases
5087 the reference count of @info. When its reference count drops to 0,
5088 the memory used is freed.</doc>
5089 <return-value transfer-ownership="none">
5090 <type name="none" c:type="void"/>
5094 <record name="DBusArgInfo"
5095 c:type="GDBusArgInfo"
5097 glib:type-name="GDBusArgInfo"
5098 glib:get-type="g_dbus_arg_info_get_type"
5099 c:symbol-prefix="dbus_arg_info">
5100 <doc xml:whitespace="preserve">Information about an argument for a method or a signal.</doc>
5101 <field name="ref_count" writable="1">
5102 <type name="gint" c:type="gint"/>
5104 <field name="name" writable="1">
5105 <type name="utf8" c:type="gchar*"/>
5107 <field name="signature" writable="1">
5108 <type name="utf8" c:type="gchar*"/>
5110 <field name="annotations" writable="1">
5111 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
5113 <method name="ref" c:identifier="g_dbus_arg_info_ref" version="2.26">
5114 <doc xml:whitespace="preserve">If @info is statically allocated does nothing. Otherwise increases
5115 the reference count.</doc>
5116 <return-value transfer-ownership="full">
5117 <doc xml:whitespace="preserve">The same @info.</doc>
5118 <type name="DBusArgInfo" c:type="GDBusArgInfo*"/>
5121 <method name="unref" c:identifier="g_dbus_arg_info_unref" version="2.26">
5122 <doc xml:whitespace="preserve">If @info is statically allocated, does nothing. Otherwise decreases
5123 the reference count of @info. When its reference count drops to 0,
5124 the memory used is freed.</doc>
5125 <return-value transfer-ownership="none">
5126 <type name="none" c:type="void"/>
5130 <class name="DBusAuthObserver"
5131 c:symbol-prefix="dbus_auth_observer"
5132 c:type="GDBusAuthObserver"
5134 parent="GObject.Object"
5135 glib:type-name="GDBusAuthObserver"
5136 glib:get-type="g_dbus_auth_observer_get_type">
5137 <doc xml:whitespace="preserve">The #GDBusAuthObserver structure contains only private data and
5138 should only be accessed using the provided API.</doc>
5139 <constructor name="new"
5140 c:identifier="g_dbus_auth_observer_new"
5142 <doc xml:whitespace="preserve">Creates a new #GDBusAuthObserver object.</doc>
5143 <return-value transfer-ownership="full">
5144 <doc xml:whitespace="preserve">A #GDBusAuthObserver. Free with g_object_unref().</doc>
5145 <type name="DBusAuthObserver" c:type="GDBusAuthObserver*"/>
5148 <method name="authorize_authenticated_peer"
5149 c:identifier="g_dbus_auth_observer_authorize_authenticated_peer"
5151 <doc xml:whitespace="preserve">Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer.</doc>
5152 <return-value transfer-ownership="none">
5153 <doc xml:whitespace="preserve">%TRUE if the peer is authorized, %FALSE if not.</doc>
5154 <type name="gboolean" c:type="gboolean"/>
5157 <parameter name="stream" transfer-ownership="none">
5158 <doc xml:whitespace="preserve">A #GIOStream for the #GDBusConnection.</doc>
5159 <type name="IOStream" c:type="GIOStream*"/>
5161 <parameter name="credentials" transfer-ownership="none">
5162 <doc xml:whitespace="preserve">Credentials received from the peer or %NULL.</doc>
5163 <type name="Credentials" c:type="GCredentials*"/>
5167 <glib:signal name="authorize-authenticated-peer" version="2.26">
5168 <doc xml:whitespace="preserve">Emitted to check if a peer that is successfully authenticated
5169 is authorized.</doc>
5170 <return-value transfer-ownership="none">
5171 <doc xml:whitespace="preserve">%TRUE if the peer is authorized, %FALSE if not.</doc>
5172 <type name="gboolean"/>
5175 <parameter name="object" transfer-ownership="none">
5176 <doc xml:whitespace="preserve">A #GIOStream for the #GDBusConnection.</doc>
5177 <type name="IOStream"/>
5179 <parameter name="p0" transfer-ownership="none">
5180 <doc xml:whitespace="preserve">Credentials received from the peer or %NULL.</doc>
5181 <type name="Credentials"/>
5186 <bitfield name="DBusCallFlags"
5188 glib:type-name="GDBusCallFlags"
5189 glib:get-type="g_dbus_call_flags_get_type"
5190 c:type="GDBusCallFlags">
5191 <doc xml:whitespace="preserve">Flags used in g_dbus_connection_call() and similar APIs.</doc>
5194 c:identifier="G_DBUS_CALL_FLAGS_NONE"
5196 <member name="no_auto_start"
5198 c:identifier="G_DBUS_CALL_FLAGS_NO_AUTO_START"
5199 glib:nick="no-auto-start"/>
5201 <bitfield name="DBusCapabilityFlags"
5203 glib:type-name="GDBusCapabilityFlags"
5204 glib:get-type="g_dbus_capability_flags_get_type"
5205 c:type="GDBusCapabilityFlags">
5206 <doc xml:whitespace="preserve">Capabilities negotiated with the remote peer.</doc>
5209 c:identifier="G_DBUS_CAPABILITY_FLAGS_NONE"
5211 <member name="unix_fd_passing"
5213 c:identifier="G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING"
5214 glib:nick="unix-fd-passing"/>
5216 <class name="DBusConnection"
5217 c:symbol-prefix="dbus_connection"
5218 c:type="GDBusConnection"
5220 parent="GObject.Object"
5221 glib:type-name="GDBusConnection"
5222 glib:get-type="g_dbus_connection_get_type">
5223 <doc xml:whitespace="preserve">The #GDBusConnection structure contains only private data and
5224 should only be accessed using the provided API.</doc>
5225 <implements name="AsyncInitable"/>
5226 <implements name="Initable"/>
5227 <constructor name="new_finish"
5228 c:identifier="g_dbus_connection_new_finish"
5231 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_connection_new().</doc>
5232 <return-value transfer-ownership="full">
5233 <doc xml:whitespace="preserve">A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().</doc>
5234 <type name="DBusConnection" c:type="GDBusConnection*"/>
5237 <parameter name="res" transfer-ownership="none">
5238 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().</doc>
5239 <type name="AsyncResult" c:type="GAsyncResult*"/>
5243 <constructor name="new_for_address_finish"
5244 c:identifier="g_dbus_connection_new_for_address_finish"
5247 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_connection_new_for_address().</doc>
5248 <return-value transfer-ownership="full">
5249 <doc xml:whitespace="preserve">A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().</doc>
5250 <type name="DBusConnection" c:type="GDBusConnection*"/>
5253 <parameter name="res" transfer-ownership="none">
5254 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().</doc>
5255 <type name="AsyncResult" c:type="GAsyncResult*"/>
5259 <constructor name="new_for_address_sync"
5260 c:identifier="g_dbus_connection_new_for_address_sync"
5263 <doc xml:whitespace="preserve">Synchronously connects and sets up a D-Bus client connection for
5264 exchanging D-Bus messages with an endpoint specified by @address
5265 which must be in the D-Bus address format.
5266 This constructor can only be used to initiate client-side
5267 connections - use g_dbus_connection_new_sync() if you need to act
5268 as the server. In particular, @flags cannot contain the
5269 %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
5270 %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
5271 This is a synchronous failable constructor. See
5272 g_dbus_connection_new_for_address() for the asynchronous version.
5273 If @observer is not %NULL it may be used to control the
5274 authentication process.</doc>
5275 <return-value transfer-ownership="full">
5276 <doc xml:whitespace="preserve">A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().</doc>
5277 <type name="DBusConnection" c:type="GDBusConnection*"/>
5280 <parameter name="address" transfer-ownership="none">
5281 <doc xml:whitespace="preserve">A D-Bus address.</doc>
5282 <type name="utf8" c:type="gchar*"/>
5284 <parameter name="flags" transfer-ownership="none">
5285 <doc xml:whitespace="preserve">Flags describing how to make the connection.</doc>
5286 <type name="DBusConnectionFlags" c:type="GDBusConnectionFlags"/>
5288 <parameter name="observer" transfer-ownership="none">
5289 <doc xml:whitespace="preserve">A #GDBusAuthObserver or %NULL.</doc>
5290 <type name="DBusAuthObserver" c:type="GDBusAuthObserver*"/>
5292 <parameter name="cancellable"
5293 transfer-ownership="none"
5295 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5296 <type name="Cancellable" c:type="GCancellable*"/>
5300 <constructor name="new_sync"
5301 c:identifier="g_dbus_connection_new_sync"
5304 <doc xml:whitespace="preserve">Synchronously sets up a D-Bus connection for exchanging D-Bus messages
5305 with the end represented by @stream.
5306 If @observer is not %NULL it may be used to control the
5307 authentication process.
5308 This is a synchronous failable constructor. See
5309 g_dbus_connection_new() for the asynchronous version.</doc>
5310 <return-value transfer-ownership="full">
5311 <doc xml:whitespace="preserve">A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().</doc>
5312 <type name="DBusConnection" c:type="GDBusConnection*"/>
5315 <parameter name="stream" transfer-ownership="none">
5316 <doc xml:whitespace="preserve">A #GIOStream.</doc>
5317 <type name="IOStream" c:type="GIOStream*"/>
5319 <parameter name="guid" transfer-ownership="none">
5320 <doc xml:whitespace="preserve">The GUID to use if a authenticating as a server or %NULL.</doc>
5321 <type name="utf8" c:type="gchar*"/>
5323 <parameter name="flags" transfer-ownership="none">
5324 <doc xml:whitespace="preserve">Flags describing how to make the connection.</doc>
5325 <type name="DBusConnectionFlags" c:type="GDBusConnectionFlags"/>
5327 <parameter name="observer" transfer-ownership="none">
5328 <doc xml:whitespace="preserve">A #GDBusAuthObserver or %NULL.</doc>
5329 <type name="DBusAuthObserver" c:type="GDBusAuthObserver*"/>
5331 <parameter name="cancellable"
5332 transfer-ownership="none"
5334 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5335 <type name="Cancellable" c:type="GCancellable*"/>
5339 <function name="new" c:identifier="g_dbus_connection_new" version="2.26">
5340 <doc xml:whitespace="preserve">Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
5341 with the end represented by @stream.
5342 If @observer is not %NULL it may be used to control the
5343 authentication process.
5344 When the operation is finished, @callback will be invoked. You can
5345 then call g_dbus_connection_new_finish() to get the result of the
5347 This is a asynchronous failable constructor. See
5348 g_dbus_connection_new_sync() for the synchronous
5350 <return-value transfer-ownership="none">
5351 <type name="none" c:type="void"/>
5354 <parameter name="stream" transfer-ownership="none">
5355 <doc xml:whitespace="preserve">A #GIOStream.</doc>
5356 <type name="IOStream" c:type="GIOStream*"/>
5358 <parameter name="guid" transfer-ownership="none">
5359 <doc xml:whitespace="preserve">The GUID to use if a authenticating as a server or %NULL.</doc>
5360 <type name="utf8" c:type="gchar*"/>
5362 <parameter name="flags" transfer-ownership="none">
5363 <doc xml:whitespace="preserve">Flags describing how to make the connection.</doc>
5364 <type name="DBusConnectionFlags" c:type="GDBusConnectionFlags"/>
5366 <parameter name="observer" transfer-ownership="none">
5367 <doc xml:whitespace="preserve">A #GDBusAuthObserver or %NULL.</doc>
5368 <type name="DBusAuthObserver" c:type="GDBusAuthObserver*"/>
5370 <parameter name="cancellable"
5371 transfer-ownership="none"
5373 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5374 <type name="Cancellable" c:type="GCancellable*"/>
5376 <parameter name="callback"
5377 transfer-ownership="none"
5380 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied.</doc>
5381 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
5383 <parameter name="user_data" transfer-ownership="none">
5384 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
5385 <type name="gpointer" c:type="gpointer"/>
5389 <function name="new_for_address"
5390 c:identifier="g_dbus_connection_new_for_address"
5392 <doc xml:whitespace="preserve">Asynchronously connects and sets up a D-Bus client connection for
5393 exchanging D-Bus messages with an endpoint specified by @address
5394 which must be in the D-Bus address format.
5395 This constructor can only be used to initiate client-side
5396 connections - use g_dbus_connection_new() if you need to act as the
5397 server. In particular, @flags cannot contain the
5398 %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
5399 %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
5400 When the operation is finished, @callback will be invoked. You can
5401 then call g_dbus_connection_new_finish() to get the result of the
5403 If @observer is not %NULL it may be used to control the
5404 authentication process.
5405 This is a asynchronous failable constructor. See
5406 g_dbus_connection_new_for_address_sync() for the synchronous
5408 <return-value transfer-ownership="none">
5409 <type name="none" c:type="void"/>
5412 <parameter name="address" transfer-ownership="none">
5413 <doc xml:whitespace="preserve">A D-Bus address.</doc>
5414 <type name="utf8" c:type="gchar*"/>
5416 <parameter name="flags" transfer-ownership="none">
5417 <doc xml:whitespace="preserve">Flags describing how to make the connection.</doc>
5418 <type name="DBusConnectionFlags" c:type="GDBusConnectionFlags"/>
5420 <parameter name="observer" transfer-ownership="none">
5421 <doc xml:whitespace="preserve">A #GDBusAuthObserver or %NULL.</doc>
5422 <type name="DBusAuthObserver" c:type="GDBusAuthObserver*"/>
5424 <parameter name="cancellable"
5425 transfer-ownership="none"
5427 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5428 <type name="Cancellable" c:type="GCancellable*"/>
5430 <parameter name="callback"
5431 transfer-ownership="none"
5434 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied.</doc>
5435 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
5437 <parameter name="user_data" transfer-ownership="none">
5438 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
5439 <type name="gpointer" c:type="gpointer"/>
5443 <method name="add_filter"
5444 c:identifier="g_dbus_connection_add_filter"
5446 <doc xml:whitespace="preserve">Adds a message filter. Filters are handlers that are run on all
5447 incoming and outgoing messages, prior to standard dispatch. Filters
5448 are run in the order that they were added. The same handler can be
5449 added as a filter more than once, in which case it will be run more
5450 than once. Filters added during a filter callback won't be run on
5451 the message being processed. Filter functions are allowed to modify
5452 and even drop messages - see the #GDBusMessageFilterResult
5453 enumeration for details.
5454 Note that filters are run in a dedicated message handling thread so
5455 they can't block and, generally, can't do anything but signal a
5456 worker thread. Also note that filters are rarely needed - use API
5457 such as g_dbus_connection_send_message_with_reply(),
5458 g_dbus_connection_signal_subscribe() or
5459 g_dbus_connection_call() instead.
5460 If a filter consumes an incoming message the message is not
5461 dispatched anywhere else - not even the standard dispatch machinery
5462 (that API such as g_dbus_connection_signal_subscribe() and
5463 g_dbus_connection_send_message_with_reply() relies on) will see the
5464 message. Similary, if a filter consumes an outgoing message, the
5465 message will not be sent to the other peer.
5466 g_dbus_connection_remove_filter().</doc>
5467 <return-value transfer-ownership="none">
5468 <doc xml:whitespace="preserve">A filter identifier that can be used with</doc>
5469 <type name="guint" c:type="guint"/>
5472 <parameter name="filter_function"
5473 transfer-ownership="none"
5477 <doc xml:whitespace="preserve">A filter function.</doc>
5478 <type name="DBusMessageFilterFunction"
5479 c:type="GDBusMessageFilterFunction"/>
5481 <parameter name="user_data" transfer-ownership="none">
5482 <doc xml:whitespace="preserve">User data to pass to @filter_function.</doc>
5483 <type name="gpointer" c:type="gpointer"/>
5485 <parameter name="user_data_free_func"
5486 transfer-ownership="none"
5488 <doc xml:whitespace="preserve">Function to free @user_data with when filter is removed or %NULL.</doc>
5489 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
5493 <method name="call" c:identifier="g_dbus_connection_call" version="2.26">
5494 <doc xml:whitespace="preserve">Asynchronously invokes the @method_name method on the
5495 If @connection is closed then the operation will fail with
5496 %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
5497 fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
5498 not compatible with the D-Bus protocol, the operation fails with
5499 %G_IO_ERROR_INVALID_ARGUMENT.
5500 If @reply_type is non-%NULL then the reply will be checked for having this type and an
5501 error will be raised if it does not match. Said another way, if you give a @reply_type
5502 then any non-%NULL return value will be of this type.
5503 If the @parameters #GVariant is floating, it is consumed. This allows
5504 convenient 'inline' use of g_variant_new(), e.g.:
5506 g_dbus_connection_call (connection,
5507 "org.freedesktop.StringThings",
5508 "/org/freedesktop/StringThings",
5509 "org.freedesktop.StringThings",
5511 g_variant_new ("(ss)",
5515 G_DBUS_CALL_FLAGS_NONE,
5518 (GAsyncReadyCallback) two_strings_done,
5521 This is an asynchronous method. When the operation is finished, @callback will be invoked
5522 in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
5523 of the thread you are calling this method from. You can then call
5524 g_dbus_connection_call_finish() to get the result of the operation.
5525 See g_dbus_connection_call_sync() for the synchronous version of this
5527 <return-value transfer-ownership="none">
5528 <type name="none" c:type="void"/>
5531 <parameter name="bus_name" transfer-ownership="none">
5532 <doc xml:whitespace="preserve">A unique or well-known bus name or %NULL if @connection is not a message bus connection.</doc>
5533 <type name="utf8" c:type="gchar*"/>
5535 <parameter name="object_path" transfer-ownership="none">
5536 <doc xml:whitespace="preserve">Path of remote object.</doc>
5537 <type name="utf8" c:type="gchar*"/>
5539 <parameter name="interface_name" transfer-ownership="none">
5540 <doc xml:whitespace="preserve">D-Bus interface to invoke method on.</doc>
5541 <type name="utf8" c:type="gchar*"/>
5543 <parameter name="method_name" transfer-ownership="none">
5544 <doc xml:whitespace="preserve">The name of the method to invoke.</doc>
5545 <type name="utf8" c:type="gchar*"/>
5547 <parameter name="parameters" transfer-ownership="none">
5548 <doc xml:whitespace="preserve">A #GVariant tuple with parameters for the method or %NULL if not passing parameters.</doc>
5549 <type name="GLib.Variant" c:type="GVariant*"/>
5551 <parameter name="reply_type" transfer-ownership="none">
5552 <doc xml:whitespace="preserve">The expected type of the reply, or %NULL.</doc>
5553 <type name="GLib.VariantType" c:type="GVariantType*"/>
5555 <parameter name="flags" transfer-ownership="none">
5556 <doc xml:whitespace="preserve">Flags from the #GDBusCallFlags enumeration.</doc>
5557 <type name="DBusCallFlags" c:type="GDBusCallFlags"/>
5559 <parameter name="timeout_msec" transfer-ownership="none">
5560 <doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
5561 <type name="gint" c:type="gint"/>
5563 <parameter name="cancellable"
5564 transfer-ownership="none"
5566 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5567 <type name="Cancellable" c:type="GCancellable*"/>
5569 <parameter name="callback"
5570 transfer-ownership="none"
5573 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.</doc>
5574 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
5576 <parameter name="user_data" transfer-ownership="none">
5577 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
5578 <type name="gpointer" c:type="gpointer"/>
5582 <method name="call_finish"
5583 c:identifier="g_dbus_connection_call_finish"
5586 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_connection_call().
5587 return values. Free with g_variant_unref().</doc>
5588 <return-value transfer-ownership="full">
5589 <doc xml:whitespace="preserve">%NULL if @error is set. Otherwise a #GVariant tuple with</doc>
5590 <type name="GLib.Variant" c:type="GVariant*"/>
5593 <parameter name="res" transfer-ownership="none">
5594 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().</doc>
5595 <type name="AsyncResult" c:type="GAsyncResult*"/>
5599 <method name="call_sync"
5600 c:identifier="g_dbus_connection_call_sync"
5603 <doc xml:whitespace="preserve">Synchronously invokes the @method_name method on the
5604 If @connection is closed then the operation will fail with
5605 %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
5606 operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
5607 contains a value not compatible with the D-Bus protocol, the operation
5608 fails with %G_IO_ERROR_INVALID_ARGUMENT.
5609 If @reply_type is non-%NULL then the reply will be checked for having
5610 this type and an error will be raised if it does not match. Said
5611 another way, if you give a @reply_type then any non-%NULL return
5612 value will be of this type.
5613 If the @parameters #GVariant is floating, it is consumed.
5614 This allows convenient 'inline' use of g_variant_new(), e.g.:
5616 g_dbus_connection_call_sync (connection,
5617 "org.freedesktop.StringThings",
5618 "/org/freedesktop/StringThings",
5619 "org.freedesktop.StringThings",
5621 g_variant_new ("(ss)",
5625 G_DBUS_CALL_FLAGS_NONE,
5630 The calling thread is blocked until a reply is received. See
5631 g_dbus_connection_call() for the asynchronous version of
5633 return values. Free with g_variant_unref().</doc>
5634 <return-value transfer-ownership="full">
5635 <doc xml:whitespace="preserve">%NULL if @error is set. Otherwise a #GVariant tuple with</doc>
5636 <type name="GLib.Variant" c:type="GVariant*"/>
5639 <parameter name="bus_name" transfer-ownership="none">
5640 <doc xml:whitespace="preserve">A unique or well-known bus name.</doc>
5641 <type name="utf8" c:type="gchar*"/>
5643 <parameter name="object_path" transfer-ownership="none">
5644 <doc xml:whitespace="preserve">Path of remote object.</doc>
5645 <type name="utf8" c:type="gchar*"/>
5647 <parameter name="interface_name" transfer-ownership="none">
5648 <doc xml:whitespace="preserve">D-Bus interface to invoke method on.</doc>
5649 <type name="utf8" c:type="gchar*"/>
5651 <parameter name="method_name" transfer-ownership="none">
5652 <doc xml:whitespace="preserve">The name of the method to invoke.</doc>
5653 <type name="utf8" c:type="gchar*"/>
5655 <parameter name="parameters" transfer-ownership="none">
5656 <doc xml:whitespace="preserve">A #GVariant tuple with parameters for the method or %NULL if not passing parameters.</doc>
5657 <type name="GLib.Variant" c:type="GVariant*"/>
5659 <parameter name="reply_type" transfer-ownership="none">
5660 <doc xml:whitespace="preserve">The expected type of the reply, or %NULL.</doc>
5661 <type name="GLib.VariantType" c:type="GVariantType*"/>
5663 <parameter name="flags" transfer-ownership="none">
5664 <doc xml:whitespace="preserve">Flags from the #GDBusCallFlags enumeration.</doc>
5665 <type name="DBusCallFlags" c:type="GDBusCallFlags"/>
5667 <parameter name="timeout_msec" transfer-ownership="none">
5668 <doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
5669 <type name="gint" c:type="gint"/>
5671 <parameter name="cancellable"
5672 transfer-ownership="none"
5674 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5675 <type name="Cancellable" c:type="GCancellable*"/>
5679 <method name="close"
5680 c:identifier="g_dbus_connection_close"
5682 <doc xml:whitespace="preserve">Closes @connection. Note that this never causes the process to
5683 exit (this might only happen if the other end of a shared message
5684 bus connection disconnects, see #GDBusConnection:exit-on-close).
5685 Once the connection is closed, operations such as sending a message
5686 will return with the error %G_IO_ERROR_CLOSED. Closing a connection
5687 will not automatically flush the connection so queued messages may
5688 be lost. Use g_dbus_connection_flush() if you need such guarantees.
5689 If @connection is already closed, this method fails with
5691 When @connection has been closed, the #GDBusConnection::closed
5692 signal is emitted in the <link
5693 linkend="g-main-context-push-thread-default">thread-default main
5694 loop</link> of the thread that @connection was constructed in.
5695 This is an asynchronous method. When the operation is finished,
5696 linkend="g-main-context-push-thread-default">thread-default main
5697 loop</link> of the thread you are calling this method from. You can
5698 then call g_dbus_connection_close_finish() to get the result of the
5699 operation. See g_dbus_connection_close_sync() for the synchronous
5701 <return-value transfer-ownership="none">
5702 <type name="none" c:type="void"/>
5705 <parameter name="cancellable"
5706 transfer-ownership="none"
5708 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5709 <type name="Cancellable" c:type="GCancellable*"/>
5711 <parameter name="callback"
5712 transfer-ownership="none"
5715 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result.</doc>
5716 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
5718 <parameter name="user_data" transfer-ownership="none">
5719 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
5720 <type name="gpointer" c:type="gpointer"/>
5724 <method name="close_finish"
5725 c:identifier="g_dbus_connection_close_finish"
5728 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_connection_close().</doc>
5729 <return-value transfer-ownership="none">
5730 <doc xml:whitespace="preserve">%TRUE if the operation succeeded, %FALSE if @error is set.</doc>
5731 <type name="gboolean" c:type="gboolean"/>
5734 <parameter name="res" transfer-ownership="none">
5735 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close().</doc>
5736 <type name="AsyncResult" c:type="GAsyncResult*"/>
5740 <method name="close_sync"
5741 c:identifier="g_dbus_connection_close_sync"
5744 <doc xml:whitespace="preserve">Synchronously closees @connection. The calling thread is blocked
5745 until this is done. See g_dbus_connection_close() for the
5746 asynchronous version of this method and more details about what it
5748 <return-value transfer-ownership="none">
5749 <doc xml:whitespace="preserve">%TRUE if the operation succeeded, %FALSE if @error is set.</doc>
5750 <type name="gboolean" c:type="gboolean"/>
5753 <parameter name="cancellable"
5754 transfer-ownership="none"
5756 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5757 <type name="Cancellable" c:type="GCancellable*"/>
5761 <method name="emit_signal"
5762 c:identifier="g_dbus_connection_emit_signal"
5765 <doc xml:whitespace="preserve">Emits a signal.
5766 If the parameters GVariant is floating, it is consumed.
5767 This can only fail if @parameters is not compatible with the D-Bus protocol.</doc>
5768 <return-value transfer-ownership="none">
5769 <doc xml:whitespace="preserve">%TRUE unless @error is set.</doc>
5770 <type name="gboolean" c:type="gboolean"/>
5773 <parameter name="destination_bus_name" transfer-ownership="none">
5774 <doc xml:whitespace="preserve">The unique bus name for the destination for the signal or %NULL to emit to all listeners.</doc>
5775 <type name="utf8" c:type="gchar*"/>
5777 <parameter name="object_path" transfer-ownership="none">
5778 <doc xml:whitespace="preserve">Path of remote object.</doc>
5779 <type name="utf8" c:type="gchar*"/>
5781 <parameter name="interface_name" transfer-ownership="none">
5782 <doc xml:whitespace="preserve">D-Bus interface to emit a signal on.</doc>
5783 <type name="utf8" c:type="gchar*"/>
5785 <parameter name="signal_name" transfer-ownership="none">
5786 <doc xml:whitespace="preserve">The name of the signal to emit.</doc>
5787 <type name="utf8" c:type="gchar*"/>
5789 <parameter name="parameters" transfer-ownership="none">
5790 <doc xml:whitespace="preserve">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.</doc>
5791 <type name="GLib.Variant" c:type="GVariant*"/>
5795 <method name="flush"
5796 c:identifier="g_dbus_connection_flush"
5798 <doc xml:whitespace="preserve">Asynchronously flushes @connection, that is, writes all queued
5799 outgoing message to the transport and then flushes the transport
5800 (using g_output_stream_flush_async()). This is useful in programs
5801 that wants to emit a D-Bus signal and then exit
5802 immediately. Without flushing the connection, there is no guarantee
5803 that the message has been sent to the networking buffers in the OS
5805 This is an asynchronous method. When the operation is finished,
5806 linkend="g-main-context-push-thread-default">thread-default main
5807 loop</link> of the thread you are calling this method from. You can
5808 then call g_dbus_connection_flush_finish() to get the result of the
5809 operation. See g_dbus_connection_flush_sync() for the synchronous
5811 <return-value transfer-ownership="none">
5812 <type name="none" c:type="void"/>
5815 <parameter name="cancellable"
5816 transfer-ownership="none"
5818 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5819 <type name="Cancellable" c:type="GCancellable*"/>
5821 <parameter name="callback"
5822 transfer-ownership="none"
5825 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result.</doc>
5826 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
5828 <parameter name="user_data" transfer-ownership="none">
5829 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
5830 <type name="gpointer" c:type="gpointer"/>
5834 <method name="flush_finish"
5835 c:identifier="g_dbus_connection_flush_finish"
5838 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_connection_flush().</doc>
5839 <return-value transfer-ownership="none">
5840 <doc xml:whitespace="preserve">%TRUE if the operation succeeded, %FALSE if @error is set.</doc>
5841 <type name="gboolean" c:type="gboolean"/>
5844 <parameter name="res" transfer-ownership="none">
5845 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush().</doc>
5846 <type name="AsyncResult" c:type="GAsyncResult*"/>
5850 <method name="flush_sync"
5851 c:identifier="g_dbus_connection_flush_sync"
5854 <doc xml:whitespace="preserve">Synchronously flushes @connection. The calling thread is blocked
5855 until this is done. See g_dbus_connection_flush() for the
5856 asynchronous version of this method and more details about what it
5858 <return-value transfer-ownership="none">
5859 <doc xml:whitespace="preserve">%TRUE if the operation succeeded, %FALSE if @error is set.</doc>
5860 <type name="gboolean" c:type="gboolean"/>
5863 <parameter name="cancellable"
5864 transfer-ownership="none"
5866 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
5867 <type name="Cancellable" c:type="GCancellable*"/>
5871 <method name="get_capabilities"
5872 c:identifier="g_dbus_connection_get_capabilities"
5874 <doc xml:whitespace="preserve">Gets the capabilities negotiated with the remote peer</doc>
5875 <return-value transfer-ownership="none">
5876 <doc xml:whitespace="preserve">Zero or more flags from the #GDBusCapabilityFlags enumeration.</doc>
5877 <type name="DBusCapabilityFlags" c:type="GDBusCapabilityFlags"/>
5880 <method name="get_exit_on_close"
5881 c:identifier="g_dbus_connection_get_exit_on_close"
5883 <doc xml:whitespace="preserve">Gets whether the process is terminated when @connection is
5884 closed by the remote peer. See
5885 #GDBusConnection:exit-on-close for more details.
5886 closed by the remote peer.</doc>
5887 <return-value transfer-ownership="none">
5888 <doc xml:whitespace="preserve">Whether the process is terminated when @connection is</doc>
5889 <type name="gboolean" c:type="gboolean"/>
5892 <method name="get_guid"
5893 c:identifier="g_dbus_connection_get_guid"
5895 <doc xml:whitespace="preserve">The GUID of the peer performing the role of server when
5896 authenticating. See #GDBusConnection:guid for more details.</doc>
5897 <return-value transfer-ownership="none">
5898 <doc xml:whitespace="preserve">The GUID. Do not free this string, it is owned by</doc>
5899 <type name="utf8" c:type="gchar*"/>
5902 <method name="get_peer_credentials"
5903 c:identifier="g_dbus_connection_get_peer_credentials"
5905 <doc xml:whitespace="preserve">Gets the credentials of the authenticated peer. This will always
5906 return %NULL unless @connection acted as a server
5907 (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
5908 when set up and the client passed credentials as part of the
5909 authentication process.
5910 In a message bus setup, the message bus is always the server and
5911 each application is a client. So this method will always return
5912 %NULL for message bus clients.
5913 this object, it is owned by @connection.</doc>
5914 <return-value transfer-ownership="none">
5915 <doc xml:whitespace="preserve">A #GCredentials or %NULL if not available. Do not free</doc>
5916 <type name="Credentials" c:type="GCredentials*"/>
5919 <method name="get_stream"
5920 c:identifier="g_dbus_connection_get_stream"
5922 <doc xml:whitespace="preserve">Gets the underlying stream used for IO.</doc>
5923 <return-value transfer-ownership="none">
5924 <doc xml:whitespace="preserve">the stream used for IO</doc>
5925 <type name="IOStream" c:type="GIOStream*"/>
5928 <method name="get_unique_name"
5929 c:identifier="g_dbus_connection_get_unique_name"
5931 <doc xml:whitespace="preserve">Gets the unique name of @connection as assigned by the message
5932 bus. This can also be used to figure out if @connection is a
5933 message bus connection.
5934 bus connection. Do not free this string, it is owned by</doc>
5935 <return-value transfer-ownership="none">
5936 <doc xml:whitespace="preserve">The unique name or %NULL if @connection is not a message</doc>
5937 <type name="utf8" c:type="gchar*"/>
5940 <method name="is_closed"
5941 c:identifier="g_dbus_connection_is_closed"
5943 <doc xml:whitespace="preserve">Gets whether @connection is closed.</doc>
5944 <return-value transfer-ownership="none">
5945 <doc xml:whitespace="preserve">%TRUE if the connection is closed, %FALSE otherwise.</doc>
5946 <type name="gboolean" c:type="gboolean"/>
5949 <method name="register_object"
5950 c:identifier="g_dbus_connection_register_object"
5953 <doc xml:whitespace="preserve">Registers callbacks for exported objects at @object_path with the
5954 D-Bus interface that is described in @interface_info.
5955 Calls to functions in @vtable (and @user_data_free_func) will
5956 happen in the <link linkend="g-main-context-push-thread-default">thread-default main
5957 loop</link> of the thread you are calling this method from.
5958 Note that all #GVariant values passed to functions in @vtable will match
5959 the signature given in @interface_info - if a remote caller passes
5960 incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
5961 is returned to the remote caller.
5962 Additionally, if the remote caller attempts to invoke methods or
5963 access properties not mentioned in @interface_info the
5964 <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
5965 <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
5966 are returned to the caller.
5967 It is considered a programming error if the
5968 #GDBusInterfaceGetPropertyFunc function in @vtable returns a
5969 #GVariant of incorrect type.
5970 If an existing callback is already registered at @object_path and
5971 GDBus automatically implements the standard D-Bus interfaces
5972 org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
5973 and org.freedesktop.Peer, so you don't have to implement those for
5974 the objects you export. You <emphasis>can</emphasis> implement
5975 org.freedesktop.DBus.Properties yourself, e.g. to handle getting
5976 and setting of properties asynchronously.
5977 Note that the reference count on @interface_info will be
5978 incremented by 1 (unless allocated statically, e.g. if the
5979 reference count is -1, see g_dbus_interface_info_ref()) for as long
5980 as the object is exported. Also note that @vtable will be copied.
5981 See <xref linkend="gdbus-server"/> for an example of how to use this method.
5982 that can be used with g_dbus_connection_unregister_object() .</doc>
5983 <return-value transfer-ownership="none">
5984 <doc xml:whitespace="preserve">0 if @error is set, otherwise a registration id (never 0)</doc>
5985 <type name="guint" c:type="guint"/>
5988 <parameter name="object_path" transfer-ownership="none">
5989 <doc xml:whitespace="preserve">The object path to register at.</doc>
5990 <type name="utf8" c:type="gchar*"/>
5992 <parameter name="interface_info" transfer-ownership="none">
5993 <doc xml:whitespace="preserve">Introspection data for the interface.</doc>
5994 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
5996 <parameter name="vtable" transfer-ownership="none">
5997 <doc xml:whitespace="preserve">A #GDBusInterfaceVTable to call into or %NULL.</doc>
5998 <type name="DBusInterfaceVTable" c:type="GDBusInterfaceVTable*"/>
6000 <parameter name="user_data" transfer-ownership="none">
6001 <doc xml:whitespace="preserve">Data to pass to functions in @vtable.</doc>
6002 <type name="gpointer" c:type="gpointer"/>
6004 <parameter name="user_data_free_func"
6005 transfer-ownership="none"
6007 <doc xml:whitespace="preserve">Function to call when the object path is unregistered.</doc>
6008 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
6012 <method name="register_subtree"
6013 c:identifier="g_dbus_connection_register_subtree"
6016 <doc xml:whitespace="preserve">Registers a whole subtree of <quote>dynamic</quote> objects.
6017 The @enumerate and @introspection functions in @vtable are used to
6018 convey, to remote callers, what nodes exist in the subtree rooted
6020 When handling remote calls into any node in the subtree, first the
6021 or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
6022 the @introspection function is used to check if the node supports the
6023 requested method. If so, the @dispatch function is used to determine
6024 where to dispatch the call. The collected #GDBusInterfaceVTable and
6025 #gpointer will be used to call into the interface vtable for processing
6027 All calls into user-provided code will be invoked in the <link
6028 linkend="g-main-context-push-thread-default">thread-default main
6029 loop</link> of the thread you are calling this method from.
6030 If an existing subtree is already registered at @object_path or
6031 then @error is set to #G_IO_ERROR_EXISTS.
6032 Note that it is valid to register regular objects (using
6033 g_dbus_connection_register_object()) in a subtree registered with
6034 g_dbus_connection_register_subtree() - if so, the subtree handler
6035 is tried as the last resort. One way to think about a subtree
6036 handler is to consider it a <quote>fallback handler</quote>
6037 for object paths not registered via g_dbus_connection_register_object()
6039 Note that @vtable will be copied so you cannot change it after
6041 See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
6042 that can be used with g_dbus_connection_unregister_subtree() .</doc>
6043 <return-value transfer-ownership="none">
6044 <doc xml:whitespace="preserve">0 if @error is set, otherwise a subtree registration id (never 0)</doc>
6045 <type name="guint" c:type="guint"/>
6048 <parameter name="object_path" transfer-ownership="none">
6049 <doc xml:whitespace="preserve">The object path to register the subtree at.</doc>
6050 <type name="utf8" c:type="gchar*"/>
6052 <parameter name="vtable" transfer-ownership="none">
6053 <doc xml:whitespace="preserve">A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.</doc>
6054 <type name="DBusSubtreeVTable" c:type="GDBusSubtreeVTable*"/>
6056 <parameter name="flags" transfer-ownership="none">
6057 <doc xml:whitespace="preserve">Flags used to fine tune the behavior of the subtree.</doc>
6058 <type name="DBusSubtreeFlags" c:type="GDBusSubtreeFlags"/>
6060 <parameter name="user_data" transfer-ownership="none">
6061 <doc xml:whitespace="preserve">Data to pass to functions in @vtable.</doc>
6062 <type name="gpointer" c:type="gpointer"/>
6064 <parameter name="user_data_free_func"
6065 transfer-ownership="none"
6067 <doc xml:whitespace="preserve">Function to call when the subtree is unregistered.</doc>
6068 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
6072 <method name="remove_filter"
6073 c:identifier="g_dbus_connection_remove_filter"
6075 <doc xml:whitespace="preserve">Removes a filter.</doc>
6076 <return-value transfer-ownership="none">
6077 <type name="none" c:type="void"/>
6080 <parameter name="filter_id" transfer-ownership="none">
6081 <doc xml:whitespace="preserve">an identifier obtained from g_dbus_connection_add_filter()</doc>
6082 <type name="guint" c:type="guint"/>
6086 <method name="send_message"
6087 c:identifier="g_dbus_connection_send_message"
6090 <doc xml:whitespace="preserve">Asynchronously sends @message to the peer represented by @connection.
6091 Unless @flags contain the
6092 %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
6093 will be assigned by @connection and set on @message via
6094 g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
6095 serial number used will be written to this location prior to
6096 submitting the message to the underlying transport.
6097 If @connection is closed then the operation will fail with
6098 %G_IO_ERROR_CLOSED. If @message is not well-formed,
6099 the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
6100 See <xref linkend="gdbus-server"/> and <xref
6101 linkend="gdbus-unix-fd-client"/> for an example of how to use this
6102 low-level API to send and receive UNIX file descriptors.
6103 Note that @message must be unlocked, unless @flags contain the
6104 %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
6105 transmission, %FALSE if @error is set.</doc>
6106 <return-value transfer-ownership="none">
6107 <doc xml:whitespace="preserve">%TRUE if the message was well-formed and queued for</doc>
6108 <type name="gboolean" c:type="gboolean"/>
6111 <parameter name="message" transfer-ownership="none">
6112 <doc xml:whitespace="preserve">A #GDBusMessage</doc>
6113 <type name="DBusMessage" c:type="GDBusMessage*"/>
6115 <parameter name="flags" transfer-ownership="none">
6116 <doc xml:whitespace="preserve">Flags affecting how the message is sent.</doc>
6117 <type name="DBusSendMessageFlags" c:type="GDBusSendMessageFlags"/>
6119 <parameter name="out_serial" transfer-ownership="none">
6120 <doc xml:whitespace="preserve">Return location for serial number assigned to @message when sending it or %NULL.</doc>
6121 <type name="guint32" c:type="guint32*"/>
6125 <method name="send_message_with_reply"
6126 c:identifier="g_dbus_connection_send_message_with_reply"
6128 <doc xml:whitespace="preserve">Asynchronously sends @message to the peer represented by @connection.
6129 Unless @flags contain the
6130 %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
6131 will be assigned by @connection and set on @message via
6132 g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
6133 serial number used will be written to this location prior to
6134 submitting the message to the underlying transport.
6135 If @connection is closed then the operation will fail with
6136 %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
6137 fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
6138 the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
6139 This is an asynchronous method. When the operation is finished, @callback will be invoked
6140 in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
6141 of the thread you are calling this method from. You can then call
6142 g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
6143 See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
6144 Note that @message must be unlocked, unless @flags contain the
6145 %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
6146 See <xref linkend="gdbus-server"/> and <xref
6147 linkend="gdbus-unix-fd-client"/> for an example of how to use this
6148 low-level API to send and receive UNIX file descriptors.</doc>
6149 <return-value transfer-ownership="none">
6150 <type name="none" c:type="void"/>
6153 <parameter name="message" transfer-ownership="none">
6154 <doc xml:whitespace="preserve">A #GDBusMessage.</doc>
6155 <type name="DBusMessage" c:type="GDBusMessage*"/>
6157 <parameter name="flags" transfer-ownership="none">
6158 <doc xml:whitespace="preserve">Flags affecting how the message is sent.</doc>
6159 <type name="DBusSendMessageFlags" c:type="GDBusSendMessageFlags"/>
6161 <parameter name="timeout_msec" transfer-ownership="none">
6162 <doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
6163 <type name="gint" c:type="gint"/>
6165 <parameter name="out_serial" transfer-ownership="none">
6166 <doc xml:whitespace="preserve">Return location for serial number assigned to @message when sending it or %NULL.</doc>
6167 <type name="guint32" c:type="guint32*"/>
6169 <parameter name="cancellable"
6170 transfer-ownership="none"
6172 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
6173 <type name="Cancellable" c:type="GCancellable*"/>
6175 <parameter name="callback"
6176 transfer-ownership="none"
6179 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result.</doc>
6180 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
6182 <parameter name="user_data" transfer-ownership="none">
6183 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
6184 <type name="gpointer" c:type="gpointer"/>
6188 <method name="send_message_with_reply_finish"
6189 c:identifier="g_dbus_connection_send_message_with_reply_finish"
6192 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_connection_send_message_with_reply().
6193 Note that @error is only set if a local in-process error
6194 occured. That is to say that the returned #GDBusMessage object may
6195 be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
6196 g_dbus_message_to_gerror() to transcode this to a #GError.
6197 See <xref linkend="gdbus-server"/> and <xref
6198 linkend="gdbus-unix-fd-client"/> for an example of how to use this
6199 low-level API to send and receive UNIX file descriptors.</doc>
6200 <return-value transfer-ownership="full">
6201 <doc xml:whitespace="preserve">A locked #GDBusMessage or %NULL if @error is set.</doc>
6202 <type name="DBusMessage" c:type="GDBusMessage*"/>
6205 <parameter name="res" transfer-ownership="none">
6206 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().</doc>
6207 <type name="AsyncResult" c:type="GAsyncResult*"/>
6211 <method name="send_message_with_reply_sync"
6212 c:identifier="g_dbus_connection_send_message_with_reply_sync"
6215 <doc xml:whitespace="preserve">Synchronously sends @message to the peer represented by @connection
6216 and blocks the calling thread until a reply is received or the
6217 timeout is reached. See g_dbus_connection_send_message_with_reply()
6218 for the asynchronous version of this method.
6219 Unless @flags contain the
6220 %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
6221 will be assigned by @connection and set on @message via
6222 g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
6223 serial number used will be written to this location prior to
6224 submitting the message to the underlying transport.
6225 If @connection is closed then the operation will fail with
6226 %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
6227 fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
6228 the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
6229 Note that @error is only set if a local in-process error
6230 occured. That is to say that the returned #GDBusMessage object may
6231 be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
6232 g_dbus_message_to_gerror() to transcode this to a #GError.
6233 See <xref linkend="gdbus-server"/> and <xref
6234 linkend="gdbus-unix-fd-client"/> for an example of how to use this
6235 low-level API to send and receive UNIX file descriptors.
6236 Note that @message must be unlocked, unless @flags contain the
6237 %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.</doc>
6238 <return-value transfer-ownership="full">
6239 <doc xml:whitespace="preserve">A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.</doc>
6240 <type name="DBusMessage" c:type="GDBusMessage*"/>
6243 <parameter name="message" transfer-ownership="none">
6244 <doc xml:whitespace="preserve">A #GDBusMessage.</doc>
6245 <type name="DBusMessage" c:type="GDBusMessage*"/>
6247 <parameter name="flags" transfer-ownership="none">
6248 <doc xml:whitespace="preserve">Flags affecting how the message is sent.</doc>
6249 <type name="DBusSendMessageFlags" c:type="GDBusSendMessageFlags"/>
6251 <parameter name="timeout_msec" transfer-ownership="none">
6252 <doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
6253 <type name="gint" c:type="gint"/>
6255 <parameter name="out_serial" transfer-ownership="none">
6256 <doc xml:whitespace="preserve">Return location for serial number assigned to @message when sending it or %NULL.</doc>
6257 <type name="guint32" c:type="guint32*"/>
6259 <parameter name="cancellable"
6260 transfer-ownership="none"
6262 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
6263 <type name="Cancellable" c:type="GCancellable*"/>
6267 <method name="set_exit_on_close"
6268 c:identifier="g_dbus_connection_set_exit_on_close"
6270 <doc xml:whitespace="preserve">Sets whether the process should be terminated when @connection is
6271 closed by the remote peer. See #GDBusConnection:exit-on-close for
6273 <return-value transfer-ownership="none">
6274 <type name="none" c:type="void"/>
6277 <parameter name="exit_on_close" transfer-ownership="none">
6278 <doc xml:whitespace="preserve">Whether the process should be terminated when @connection is closed by the remote peer.</doc>
6279 <type name="gboolean" c:type="gboolean"/>
6283 <method name="signal_subscribe"
6284 c:identifier="g_dbus_connection_signal_subscribe"
6286 <doc xml:whitespace="preserve">Subscribes to signals on @connection and invokes @callback with a
6287 whenever the signal is received. Note that @callback
6288 will be invoked in the <link
6289 linkend="g-main-context-push-thread-default">thread-default main
6290 loop</link> of the thread you are calling this method from.
6291 If @connection is not a message bus connection, @sender must be
6293 If @sender is a well-known name note that @callback is invoked with
6294 the unique name for the owner of @sender, not the well-known name
6295 as one would expect. This is because the message bus rewrites the
6296 name. As such, to avoid certain race conditions, users should be
6297 tracking the name owner of the well-known name and use that when
6298 processing the received signal.</doc>
6299 <return-value transfer-ownership="none">
6300 <doc xml:whitespace="preserve">A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().</doc>
6301 <type name="guint" c:type="guint"/>
6304 <parameter name="sender" transfer-ownership="none">
6305 <doc xml:whitespace="preserve">Sender name to match on (unique or well-known name) or %NULL to listen from all senders.</doc>
6306 <type name="utf8" c:type="gchar*"/>
6308 <parameter name="interface_name" transfer-ownership="none">
6309 <doc xml:whitespace="preserve">D-Bus interface name to match on or %NULL to match on all interfaces.</doc>
6310 <type name="utf8" c:type="gchar*"/>
6312 <parameter name="member" transfer-ownership="none">
6313 <doc xml:whitespace="preserve">D-Bus signal name to match on or %NULL to match on all signals.</doc>
6314 <type name="utf8" c:type="gchar*"/>
6316 <parameter name="object_path" transfer-ownership="none">
6317 <doc xml:whitespace="preserve">Object path to match on or %NULL to match on all object paths.</doc>
6318 <type name="utf8" c:type="gchar*"/>
6320 <parameter name="arg0" transfer-ownership="none">
6321 <doc xml:whitespace="preserve">Contents of first string argument to match on or %NULL to match on all kinds of arguments.</doc>
6322 <type name="utf8" c:type="gchar*"/>
6324 <parameter name="flags" transfer-ownership="none">
6325 <doc xml:whitespace="preserve">Flags describing how to subscribe to the signal (currently unused).</doc>
6326 <type name="DBusSignalFlags" c:type="GDBusSignalFlags"/>
6328 <parameter name="callback"
6329 transfer-ownership="none"
6333 <doc xml:whitespace="preserve">Callback to invoke when there is a signal matching the requested data.</doc>
6334 <type name="DBusSignalCallback" c:type="GDBusSignalCallback"/>
6336 <parameter name="user_data" transfer-ownership="none">
6337 <doc xml:whitespace="preserve">User data to pass to @callback.</doc>
6338 <type name="gpointer" c:type="gpointer"/>
6340 <parameter name="user_data_free_func"
6341 transfer-ownership="none"
6343 <doc xml:whitespace="preserve">Function to free @user_data with when subscription is removed or %NULL.</doc>
6344 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
6348 <method name="signal_unsubscribe"
6349 c:identifier="g_dbus_connection_signal_unsubscribe"
6351 <doc xml:whitespace="preserve">Unsubscribes from signals.</doc>
6352 <return-value transfer-ownership="none">
6353 <type name="none" c:type="void"/>
6356 <parameter name="subscription_id" transfer-ownership="none">
6357 <doc xml:whitespace="preserve">A subscription id obtained from g_dbus_connection_signal_subscribe().</doc>
6358 <type name="guint" c:type="guint"/>
6362 <method name="start_message_processing"
6363 c:identifier="g_dbus_connection_start_message_processing"
6365 <doc xml:whitespace="preserve">If @connection was created with
6366 %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
6367 starts processing messages. Does nothing on if @connection wasn't
6368 created with this flag or if the method has already been called.</doc>
6369 <return-value transfer-ownership="none">
6370 <type name="none" c:type="void"/>
6373 <method name="unregister_object"
6374 c:identifier="g_dbus_connection_unregister_object"
6376 <doc xml:whitespace="preserve">Unregisters an object.</doc>
6377 <return-value transfer-ownership="none">
6378 <doc xml:whitespace="preserve">%TRUE if the object was unregistered, %FALSE otherwise.</doc>
6379 <type name="gboolean" c:type="gboolean"/>
6382 <parameter name="registration_id" transfer-ownership="none">
6383 <doc xml:whitespace="preserve">A registration id obtained from g_dbus_connection_register_object().</doc>
6384 <type name="guint" c:type="guint"/>
6388 <method name="unregister_subtree"
6389 c:identifier="g_dbus_connection_unregister_subtree"
6391 <doc xml:whitespace="preserve">Unregisters a subtree.</doc>
6392 <return-value transfer-ownership="none">
6393 <doc xml:whitespace="preserve">%TRUE if the subtree was unregistered, %FALSE otherwise.</doc>
6394 <type name="gboolean" c:type="gboolean"/>
6397 <parameter name="registration_id" transfer-ownership="none">
6398 <doc xml:whitespace="preserve">A subtree registration id obtained from g_dbus_connection_register_subtree().</doc>
6399 <type name="guint" c:type="guint"/>
6403 <property name="address"
6408 transfer-ownership="none">
6409 <doc xml:whitespace="preserve">A D-Bus address specifying potential endpoints that can be used
6410 when establishing the connection.</doc>
6413 <property name="authentication-observer"
6418 transfer-ownership="none">
6419 <doc xml:whitespace="preserve">A #GDBusAuthObserver object to assist in the authentication process or %NULL.</doc>
6420 <type name="DBusAuthObserver"/>
6422 <property name="capabilities" version="2.26" transfer-ownership="none">
6423 <doc xml:whitespace="preserve">Flags from the #GDBusCapabilityFlags enumeration
6424 representing connection features negotiated with the other peer.</doc>
6425 <type name="DBusCapabilityFlags"/>
6427 <property name="closed" version="2.26" transfer-ownership="none">
6428 <doc xml:whitespace="preserve">A boolean specifying whether the connection has been closed.</doc>
6429 <type name="gboolean"/>
6431 <property name="exit-on-close"
6434 transfer-ownership="none">
6435 <doc xml:whitespace="preserve">A boolean specifying whether the process will be terminated (by
6436 calling <literal>raise(SIGTERM)</literal>) if the connection
6437 is closed by the remote peer.</doc>
6438 <type name="gboolean"/>
6440 <property name="flags"
6445 transfer-ownership="none">
6446 <doc xml:whitespace="preserve">Flags from the #GDBusConnectionFlags enumeration.</doc>
6447 <type name="DBusConnectionFlags"/>
6449 <property name="guid"
6453 transfer-ownership="none">
6454 <doc xml:whitespace="preserve">The GUID of the peer performing the role of server when
6456 If you are constructing a #GDBusConnection and pass
6457 %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
6458 #GDBusConnection:flags property then you MUST also set this
6459 property to a valid guid.
6460 If you are constructing a #GDBusConnection and pass
6461 %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
6462 #GDBusConnection:flags property you will be able to read the GUID
6463 of the other peer here after the connection has been successfully
6467 <property name="stream"
6471 transfer-ownership="none">
6472 <doc xml:whitespace="preserve">The underlying #GIOStream used for I/O.</doc>
6473 <type name="IOStream"/>
6475 <property name="unique-name" version="2.26" transfer-ownership="none">
6476 <doc xml:whitespace="preserve">The unique name as assigned by the message bus or %NULL if the
6477 connection is not open or not a message bus connection.</doc>
6480 <glib:signal name="closed" version="2.26">
6481 <doc xml:whitespace="preserve">Emitted when the connection is closed.
6482 The cause of this event can be
6483 <itemizedlist>
6484 <listitem><para>
6485 If g_dbus_connection_close() is called. In this case
6486 </para></listitem>
6487 <listitem><para>
6488 If the remote peer closes the connection. In this case
6489 </para></listitem>
6490 <listitem><para>
6491 If the remote peer sends invalid or malformed data. In this
6492 case @remote_peer_vanished is set to %FALSE and @error
6494 </para></listitem>
6495 </itemizedlist>
6496 Upon receiving this signal, you should give up your reference to
6498 <return-value transfer-ownership="none">
6502 <parameter name="object" transfer-ownership="none">
6503 <doc xml:whitespace="preserve">%TRUE if @connection is closed because the remote peer closed its end of the connection.</doc>
6504 <type name="gboolean"/>
6506 <parameter name="p0" transfer-ownership="none">
6507 <doc xml:whitespace="preserve">A #GError with more details about the event or %NULL.</doc>
6508 <type name="GObject.Error"/>
6513 <bitfield name="DBusConnectionFlags"
6515 glib:type-name="GDBusConnectionFlags"
6516 glib:get-type="g_dbus_connection_flags_get_type"
6517 c:type="GDBusConnectionFlags">
6518 <doc xml:whitespace="preserve">Flags used when creating a new #GDBusConnection.</doc>
6521 c:identifier="G_DBUS_CONNECTION_FLAGS_NONE"
6523 <member name="authentication_client"
6525 c:identifier="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT"
6526 glib:nick="authentication-client"/>
6527 <member name="authentication_server"
6529 c:identifier="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER"
6530 glib:nick="authentication-server"/>
6531 <member name="authentication_allow_anonymous"
6533 c:identifier="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS"
6534 glib:nick="authentication-allow-anonymous"/>
6535 <member name="message_bus_connection"
6537 c:identifier="G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION"
6538 glib:nick="message-bus-connection"/>
6539 <member name="delay_message_processing"
6541 c:identifier="G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING"
6542 glib:nick="delay-message-processing"/>
6544 <enumeration name="DBusError"
6546 glib:type-name="GDBusError"
6547 glib:get-type="g_dbus_error_get_type"
6548 c:type="GDBusError">
6549 <doc xml:whitespace="preserve">A generic error; "something went wrong" - see the error message for
6551 There was not enough memory to complete an operation.
6552 The bus doesn't know how to launch a service to supply the bus name
6554 The bus name you referenced doesn't exist (i.e. no application owns
6556 No reply to a message expecting one, usually means a timeout occurred.
6557 Something went wrong reading or writing to a socket, for example.
6558 A D-Bus bus address was malformed.
6559 Requested operation isn't supported (like ENOSYS on UNIX).
6560 Some limited resource is exhausted.
6561 Security restrictions don't allow doing what you're trying to do.
6562 Authentication didn't work.
6563 Unable to connect to server (probably caused by ECONNREFUSED on a
6565 Certain timeout errors, possibly ETIMEDOUT on a socket. Note that
6566 %G_DBUS_ERROR_NO_REPLY is used for message reply timeouts. Warning:
6567 this is confusingly-named given that %G_DBUS_ERROR_TIMED_OUT also
6568 exists. We can't fix it for compatibility reasons so just be
6570 No network access (probably ENETUNREACH on a socket).
6571 Can't bind a socket since its address is in use (i.e. EADDRINUSE).
6572 The connection is disconnected and you're trying to use it.
6573 Invalid arguments passed to a method call.
6575 Existing file and the operation you're using does not silently overwrite.
6576 Method name you invoked isn't known by the object you invoked it on.
6577 confusingly-named given that %G_DBUS_ERROR_TIMEOUT also exists. We
6578 can't fix it for compatibility reasons so just be careful.
6579 Tried to remove or modify a match rule that didn't exist.
6580 The match rule isn't syntactically valid.
6581 While starting a new process, the exec() call failed.
6582 While starting a new process, the fork() call failed.
6583 While starting a new process, the child exited with a status code.
6584 While starting a new process, the child exited on a signal.
6585 While starting a new process, something went wrong.
6586 We failed to setup the environment correctly.
6587 We failed to setup the config parser correctly.
6588 Bus name was not valid.
6589 Service file not found in system-services directory.
6590 Permissions are incorrect on the setuid helper.
6591 Service file invalid (Name, User or Exec missing).
6592 Tried to get a UNIX process ID and it wasn't available.
6593 Tried to get a UNIX process ID and it wasn't available.
6594 A type signature is not valid.
6595 A file contains invalid syntax or is otherwise broken.
6596 Asked for SELinux security context and it wasn't available.
6597 Asked for ADT audit data and it wasn't available.
6598 There's already an object with the requested object path.
6599 Error codes for the %G_DBUS_ERROR error domain.</doc>
6600 <member name="failed"
6602 c:identifier="G_DBUS_ERROR_FAILED"
6603 glib:nick="failed"/>
6604 <member name="no_memory"
6606 c:identifier="G_DBUS_ERROR_NO_MEMORY"
6607 glib:nick="no-memory"/>
6608 <member name="service_unknown"
6610 c:identifier="G_DBUS_ERROR_SERVICE_UNKNOWN"
6611 glib:nick="service-unknown"/>
6612 <member name="name_has_no_owner"
6614 c:identifier="G_DBUS_ERROR_NAME_HAS_NO_OWNER"
6615 glib:nick="name-has-no-owner"/>
6616 <member name="no_reply"
6618 c:identifier="G_DBUS_ERROR_NO_REPLY"
6619 glib:nick="no-reply"/>
6620 <member name="io_error"
6622 c:identifier="G_DBUS_ERROR_IO_ERROR"
6623 glib:nick="io-error"/>
6624 <member name="bad_address"
6626 c:identifier="G_DBUS_ERROR_BAD_ADDRESS"
6627 glib:nick="bad-address"/>
6628 <member name="not_supported"
6630 c:identifier="G_DBUS_ERROR_NOT_SUPPORTED"
6631 glib:nick="not-supported"/>
6632 <member name="limits_exceeded"
6634 c:identifier="G_DBUS_ERROR_LIMITS_EXCEEDED"
6635 glib:nick="limits-exceeded"/>
6636 <member name="access_denied"
6638 c:identifier="G_DBUS_ERROR_ACCESS_DENIED"
6639 glib:nick="access-denied"/>
6640 <member name="auth_failed"
6642 c:identifier="G_DBUS_ERROR_AUTH_FAILED"
6643 glib:nick="auth-failed"/>
6644 <member name="no_server"
6646 c:identifier="G_DBUS_ERROR_NO_SERVER"
6647 glib:nick="no-server"/>
6648 <member name="timeout"
6650 c:identifier="G_DBUS_ERROR_TIMEOUT"
6651 glib:nick="timeout"/>
6652 <member name="no_network"
6654 c:identifier="G_DBUS_ERROR_NO_NETWORK"
6655 glib:nick="no-network"/>
6656 <member name="address_in_use"
6658 c:identifier="G_DBUS_ERROR_ADDRESS_IN_USE"
6659 glib:nick="address-in-use"/>
6660 <member name="disconnected"
6662 c:identifier="G_DBUS_ERROR_DISCONNECTED"
6663 glib:nick="disconnected"/>
6664 <member name="invalid_args"
6666 c:identifier="G_DBUS_ERROR_INVALID_ARGS"
6667 glib:nick="invalid-args"/>
6668 <member name="file_not_found"
6670 c:identifier="G_DBUS_ERROR_FILE_NOT_FOUND"
6671 glib:nick="file-not-found"/>
6672 <member name="file_exists"
6674 c:identifier="G_DBUS_ERROR_FILE_EXISTS"
6675 glib:nick="file-exists"/>
6676 <member name="unknown_method"
6678 c:identifier="G_DBUS_ERROR_UNKNOWN_METHOD"
6679 glib:nick="unknown-method"/>
6680 <member name="timed_out"
6682 c:identifier="G_DBUS_ERROR_TIMED_OUT"
6683 glib:nick="timed-out"/>
6684 <member name="match_rule_not_found"
6686 c:identifier="G_DBUS_ERROR_MATCH_RULE_NOT_FOUND"
6687 glib:nick="match-rule-not-found"/>
6688 <member name="match_rule_invalid"
6690 c:identifier="G_DBUS_ERROR_MATCH_RULE_INVALID"
6691 glib:nick="match-rule-invalid"/>
6692 <member name="spawn_exec_failed"
6694 c:identifier="G_DBUS_ERROR_SPAWN_EXEC_FAILED"
6695 glib:nick="spawn-exec-failed"/>
6696 <member name="spawn_fork_failed"
6698 c:identifier="G_DBUS_ERROR_SPAWN_FORK_FAILED"
6699 glib:nick="spawn-fork-failed"/>
6700 <member name="spawn_child_exited"
6702 c:identifier="G_DBUS_ERROR_SPAWN_CHILD_EXITED"
6703 glib:nick="spawn-child-exited"/>
6704 <member name="spawn_child_signaled"
6706 c:identifier="G_DBUS_ERROR_SPAWN_CHILD_SIGNALED"
6707 glib:nick="spawn-child-signaled"/>
6708 <member name="spawn_failed"
6710 c:identifier="G_DBUS_ERROR_SPAWN_FAILED"
6711 glib:nick="spawn-failed"/>
6712 <member name="spawn_setup_failed"
6714 c:identifier="G_DBUS_ERROR_SPAWN_SETUP_FAILED"
6715 glib:nick="spawn-setup-failed"/>
6716 <member name="spawn_config_invalid"
6718 c:identifier="G_DBUS_ERROR_SPAWN_CONFIG_INVALID"
6719 glib:nick="spawn-config-invalid"/>
6720 <member name="spawn_service_invalid"
6722 c:identifier="G_DBUS_ERROR_SPAWN_SERVICE_INVALID"
6723 glib:nick="spawn-service-invalid"/>
6724 <member name="spawn_service_not_found"
6726 c:identifier="G_DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND"
6727 glib:nick="spawn-service-not-found"/>
6728 <member name="spawn_permissions_invalid"
6730 c:identifier="G_DBUS_ERROR_SPAWN_PERMISSIONS_INVALID"
6731 glib:nick="spawn-permissions-invalid"/>
6732 <member name="spawn_file_invalid"
6734 c:identifier="G_DBUS_ERROR_SPAWN_FILE_INVALID"
6735 glib:nick="spawn-file-invalid"/>
6736 <member name="spawn_no_memory"
6738 c:identifier="G_DBUS_ERROR_SPAWN_NO_MEMORY"
6739 glib:nick="spawn-no-memory"/>
6740 <member name="unix_process_id_unknown"
6742 c:identifier="G_DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN"
6743 glib:nick="unix-process-id-unknown"/>
6744 <member name="invalid_signature"
6746 c:identifier="G_DBUS_ERROR_INVALID_SIGNATURE"
6747 glib:nick="invalid-signature"/>
6748 <member name="invalid_file_content"
6750 c:identifier="G_DBUS_ERROR_INVALID_FILE_CONTENT"
6751 glib:nick="invalid-file-content"/>
6752 <member name="selinux_security_context_unknown"
6754 c:identifier="G_DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN"
6755 glib:nick="selinux-security-context-unknown"/>
6756 <member name="adt_audit_data_unknown"
6758 c:identifier="G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN"
6759 glib:nick="adt-audit-data-unknown"/>
6760 <member name="object_path_in_use"
6762 c:identifier="G_DBUS_ERROR_OBJECT_PATH_IN_USE"
6763 glib:nick="object-path-in-use"/>
6765 <record name="DBusErrorEntry" c:type="GDBusErrorEntry" version="2.26">
6766 <doc xml:whitespace="preserve">Struct used in g_dbus_error_register_error_domain().</doc>
6767 <field name="error_code" writable="1">
6768 <type name="gint" c:type="gint"/>
6770 <field name="dbus_error_name" writable="1">
6771 <type name="utf8" c:type="gchar*"/>
6774 <callback name="DBusInterfaceGetPropertyFunc"
6775 c:type="GDBusInterfaceGetPropertyFunc"
6777 <doc xml:whitespace="preserve">The type of the @get_property function in #GDBusInterfaceVTable.
6778 consumed - otherwise its reference count is decreased by one.</doc>
6779 <return-value transfer-ownership="full">
6780 <doc xml:whitespace="preserve">A #GVariant with the value for @property_name or %NULL if</doc>
6781 <type name="GLib.Variant" c:type="GVariant*"/>
6784 <parameter name="connection" transfer-ownership="none">
6785 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
6786 <type name="DBusConnection" c:type="GDBusConnection*"/>
6788 <parameter name="sender" transfer-ownership="none">
6789 <doc xml:whitespace="preserve">The unique bus name of the remote caller.</doc>
6790 <type name="utf8" c:type="gchar*"/>
6792 <parameter name="object_path" transfer-ownership="none">
6793 <doc xml:whitespace="preserve">The object path that the method was invoked on.</doc>
6794 <type name="utf8" c:type="gchar*"/>
6796 <parameter name="interface_name" transfer-ownership="none">
6797 <doc xml:whitespace="preserve">The D-Bus interface name for the property.</doc>
6798 <type name="utf8" c:type="gchar*"/>
6800 <parameter name="property_name" transfer-ownership="none">
6801 <doc xml:whitespace="preserve">The name of the property to get the value of.</doc>
6802 <type name="utf8" c:type="gchar*"/>
6804 <parameter name="error" transfer-ownership="none">
6805 <doc xml:whitespace="preserve">Return location for error.</doc>
6806 <type name="GLib.Error" c:type="GError**"/>
6808 <parameter name="user_data" transfer-ownership="none" closure="6">
6809 <doc xml:whitespace="preserve">The @user_data #gpointer passed to g_dbus_connection_register_object().</doc>
6810 <type name="gpointer" c:type="gpointer"/>
6814 <record name="DBusInterfaceInfo"
6815 c:type="GDBusInterfaceInfo"
6817 glib:type-name="GDBusInterfaceInfo"
6818 glib:get-type="g_dbus_interface_info_get_type"
6819 c:symbol-prefix="dbus_interface_info">
6820 <doc xml:whitespace="preserve">Information about a D-Bus interface.</doc>
6821 <field name="ref_count" writable="1">
6822 <type name="gint" c:type="gint"/>
6824 <field name="name" writable="1">
6825 <type name="utf8" c:type="gchar*"/>
6827 <field name="methods" writable="1">
6828 <type name="DBusMethodInfo" c:type="GDBusMethodInfo**"/>
6830 <field name="signals" writable="1">
6831 <type name="DBusSignalInfo" c:type="GDBusSignalInfo**"/>
6833 <field name="properties" writable="1">
6834 <type name="DBusPropertyInfo" c:type="GDBusPropertyInfo**"/>
6836 <field name="annotations" writable="1">
6837 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
6839 <method name="generate_xml"
6840 c:identifier="g_dbus_interface_info_generate_xml"
6842 <doc xml:whitespace="preserve">Appends an XML representation of @info (and its children) to @string_builder.
6843 This function is typically used for generating introspection XML
6844 documents at run-time for handling the
6845 <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>
6847 <return-value transfer-ownership="none">
6848 <type name="none" c:type="void"/>
6851 <parameter name="indent" transfer-ownership="none">
6852 <doc xml:whitespace="preserve">Indentation level.</doc>
6853 <type name="guint" c:type="guint"/>
6855 <parameter name="string_builder" transfer-ownership="none">
6856 <doc xml:whitespace="preserve">A #GString to to append XML data to.</doc>
6857 <type name="GLib.String" c:type="GString*"/>
6861 <method name="lookup_method"
6862 c:identifier="g_dbus_interface_info_lookup_method"
6864 <doc xml:whitespace="preserve">Looks up information about a method.
6865 This cost of this function is O(n) in number of methods.</doc>
6866 <return-value transfer-ownership="full">
6867 <doc xml:whitespace="preserve">A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info.</doc>
6868 <type name="DBusMethodInfo" c:type="GDBusMethodInfo*"/>
6871 <parameter name="name" transfer-ownership="none">
6872 <doc xml:whitespace="preserve">A D-Bus method name (typically in CamelCase)</doc>
6873 <type name="utf8" c:type="gchar*"/>
6877 <method name="lookup_property"
6878 c:identifier="g_dbus_interface_info_lookup_property"
6880 <doc xml:whitespace="preserve">Looks up information about a property.
6881 This cost of this function is O(n) in number of properties.</doc>
6882 <return-value transfer-ownership="full">
6883 <doc xml:whitespace="preserve">A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info.</doc>
6884 <type name="DBusPropertyInfo" c:type="GDBusPropertyInfo*"/>
6887 <parameter name="name" transfer-ownership="none">
6888 <doc xml:whitespace="preserve">A D-Bus property name (typically in CamelCase).</doc>
6889 <type name="utf8" c:type="gchar*"/>
6893 <method name="lookup_signal"
6894 c:identifier="g_dbus_interface_info_lookup_signal"
6896 <doc xml:whitespace="preserve">Looks up information about a signal.
6897 This cost of this function is O(n) in number of signals.</doc>
6898 <return-value transfer-ownership="full">
6899 <doc xml:whitespace="preserve">A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info.</doc>
6900 <type name="DBusSignalInfo" c:type="GDBusSignalInfo*"/>
6903 <parameter name="name" transfer-ownership="none">
6904 <doc xml:whitespace="preserve">A D-Bus signal name (typically in CamelCase)</doc>
6905 <type name="utf8" c:type="gchar*"/>
6910 c:identifier="g_dbus_interface_info_ref"
6912 <doc xml:whitespace="preserve">If @info is statically allocated does nothing. Otherwise increases
6913 the reference count.</doc>
6914 <return-value transfer-ownership="full">
6915 <doc xml:whitespace="preserve">The same @info.</doc>
6916 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
6919 <method name="unref"
6920 c:identifier="g_dbus_interface_info_unref"
6922 <doc xml:whitespace="preserve">If @info is statically allocated, does nothing. Otherwise decreases
6923 the reference count of @info. When its reference count drops to 0,
6924 the memory used is freed.</doc>
6925 <return-value transfer-ownership="none">
6926 <type name="none" c:type="void"/>
6930 <callback name="DBusInterfaceMethodCallFunc"
6931 c:type="GDBusInterfaceMethodCallFunc"
6933 <doc xml:whitespace="preserve">The type of the @method_call function in #GDBusInterfaceVTable.</doc>
6934 <return-value transfer-ownership="none">
6935 <type name="none" c:type="void"/>
6938 <parameter name="connection" transfer-ownership="none">
6939 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
6940 <type name="DBusConnection" c:type="GDBusConnection*"/>
6942 <parameter name="sender" transfer-ownership="none">
6943 <doc xml:whitespace="preserve">The unique bus name of the remote caller.</doc>
6944 <type name="utf8" c:type="gchar*"/>
6946 <parameter name="object_path" transfer-ownership="none">
6947 <doc xml:whitespace="preserve">The object path that the method was invoked on.</doc>
6948 <type name="utf8" c:type="gchar*"/>
6950 <parameter name="interface_name" transfer-ownership="none">
6951 <doc xml:whitespace="preserve">The D-Bus interface name the method was invoked on.</doc>
6952 <type name="utf8" c:type="gchar*"/>
6954 <parameter name="method_name" transfer-ownership="none">
6955 <doc xml:whitespace="preserve">The name of the method that was invoked.</doc>
6956 <type name="utf8" c:type="gchar*"/>
6958 <parameter name="parameters" transfer-ownership="none">
6959 <doc xml:whitespace="preserve">A #GVariant tuple with parameters.</doc>
6960 <type name="GLib.Variant" c:type="GVariant*"/>
6962 <parameter name="invocation" transfer-ownership="none">
6963 <doc xml:whitespace="preserve">A #GDBusMethodInvocation object that can be used to return a value or error.</doc>
6964 <type name="DBusMethodInvocation" c:type="GDBusMethodInvocation*"/>
6966 <parameter name="user_data" transfer-ownership="none" closure="7">
6967 <doc xml:whitespace="preserve">The @user_data #gpointer passed to g_dbus_connection_register_object().</doc>
6968 <type name="gpointer" c:type="gpointer"/>
6972 <callback name="DBusInterfaceSetPropertyFunc"
6973 c:type="GDBusInterfaceSetPropertyFunc"
6975 <doc xml:whitespace="preserve">The type of the @set_property function in #GDBusInterfaceVTable.</doc>
6976 <return-value transfer-ownership="none">
6977 <doc xml:whitespace="preserve">%TRUE if the property was set to @value, %FALSE if @error is set.</doc>
6978 <type name="gboolean" c:type="gboolean"/>
6981 <parameter name="connection" transfer-ownership="none">
6982 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
6983 <type name="DBusConnection" c:type="GDBusConnection*"/>
6985 <parameter name="sender" transfer-ownership="none">
6986 <doc xml:whitespace="preserve">The unique bus name of the remote caller.</doc>
6987 <type name="utf8" c:type="gchar*"/>
6989 <parameter name="object_path" transfer-ownership="none">
6990 <doc xml:whitespace="preserve">The object path that the method was invoked on.</doc>
6991 <type name="utf8" c:type="gchar*"/>
6993 <parameter name="interface_name" transfer-ownership="none">
6994 <doc xml:whitespace="preserve">The D-Bus interface name for the property.</doc>
6995 <type name="utf8" c:type="gchar*"/>
6997 <parameter name="property_name" transfer-ownership="none">
6998 <doc xml:whitespace="preserve">The name of the property to get the value of.</doc>
6999 <type name="utf8" c:type="gchar*"/>
7001 <parameter name="value" transfer-ownership="none">
7002 <doc xml:whitespace="preserve">The value to set the property to.</doc>
7003 <type name="GLib.Variant" c:type="GVariant*"/>
7005 <parameter name="error" transfer-ownership="none">
7006 <doc xml:whitespace="preserve">Return location for error.</doc>
7007 <type name="GLib.Error" c:type="GError**"/>
7009 <parameter name="user_data" transfer-ownership="none" closure="7">
7010 <doc xml:whitespace="preserve">The @user_data #gpointer passed to g_dbus_connection_register_object().</doc>
7011 <type name="gpointer" c:type="gpointer"/>
7015 <record name="DBusInterfaceVTable"
7016 c:type="GDBusInterfaceVTable"
7018 <doc xml:whitespace="preserve">Virtual table for handling properties and method calls for a D-Bus
7020 If you want to handle getting/setting D-Bus properties asynchronously, simply
7021 register an object with the <literal>org.freedesktop.DBus.Properties</literal>
7022 D-Bus interface using g_dbus_connection_register_object().</doc>
7023 <field name="method_call" writable="1">
7024 <type name="DBusInterfaceMethodCallFunc"
7025 c:type="GDBusInterfaceMethodCallFunc"/>
7027 <field name="get_property" writable="1">
7028 <type name="DBusInterfaceGetPropertyFunc"
7029 c:type="GDBusInterfaceGetPropertyFunc"/>
7031 <field name="set_property" writable="1">
7032 <type name="DBusInterfaceSetPropertyFunc"
7033 c:type="GDBusInterfaceSetPropertyFunc"/>
7035 <field name="padding" writable="1">
7036 <array zero-terminated="0" c:type="gpointer" fixed-size="8">
7037 <type name="gpointer" c:type="gpointer"/>
7041 <class name="DBusMessage"
7042 c:symbol-prefix="dbus_message"
7043 c:type="GDBusMessage"
7045 parent="GObject.Object"
7046 glib:type-name="GDBusMessage"
7047 glib:get-type="g_dbus_message_get_type">
7048 <doc xml:whitespace="preserve">The #GDBusMessage structure contains only private data and should
7049 only be accessed using the provided API.</doc>
7050 <constructor name="new" c:identifier="g_dbus_message_new" version="2.26">
7051 <doc xml:whitespace="preserve">Creates a new empty #GDBusMessage.</doc>
7052 <return-value transfer-ownership="full">
7053 <doc xml:whitespace="preserve">A #GDBusMessage. Free with g_object_unref().</doc>
7054 <type name="DBusMessage" c:type="GDBusMessage*"/>
7057 <constructor name="new_from_blob"
7058 c:identifier="g_dbus_message_new_from_blob"
7061 <doc xml:whitespace="preserve">Creates a new #GDBusMessage from the data stored at @blob. The byte
7062 order that the message was in can be retrieved using
7063 g_dbus_message_get_byte_order().
7064 g_object_unref().</doc>
7065 <return-value transfer-ownership="full">
7066 <doc xml:whitespace="preserve">A new #GDBusMessage or %NULL if @error is set. Free with</doc>
7067 <type name="DBusMessage" c:type="GDBusMessage*"/>
7070 <parameter name="blob" transfer-ownership="none">
7071 <doc xml:whitespace="preserve">A blob represent a binary D-Bus message.</doc>
7072 <type name="guint8" c:type="guchar*"/>
7074 <parameter name="blob_len" transfer-ownership="none">
7075 <doc xml:whitespace="preserve">The length of @blob.</doc>
7076 <type name="gulong" c:type="gsize"/>
7078 <parameter name="capabilities" transfer-ownership="none">
7079 <doc xml:whitespace="preserve">A #GDBusCapabilityFlags describing what protocol features are supported.</doc>
7080 <type name="DBusCapabilityFlags" c:type="GDBusCapabilityFlags"/>
7084 <constructor name="new_method_call"
7085 c:identifier="g_dbus_message_new_method_call"
7087 <doc xml:whitespace="preserve">Creates a new #GDBusMessage for a method call.</doc>
7088 <return-value transfer-ownership="full">
7089 <doc xml:whitespace="preserve">A #GDBusMessage. Free with g_object_unref().</doc>
7090 <type name="DBusMessage" c:type="GDBusMessage*"/>
7093 <parameter name="name" transfer-ownership="none">
7094 <doc xml:whitespace="preserve">A valid D-Bus name or %NULL.</doc>
7095 <type name="utf8" c:type="gchar*"/>
7097 <parameter name="path" transfer-ownership="none">
7098 <doc xml:whitespace="preserve">A valid object path.</doc>
7099 <type name="utf8" c:type="gchar*"/>
7101 <parameter name="interface_" transfer-ownership="none">
7102 <doc xml:whitespace="preserve">A valid D-Bus interface name or %NULL.</doc>
7103 <type name="utf8" c:type="gchar*"/>
7105 <parameter name="method" transfer-ownership="none">
7106 <doc xml:whitespace="preserve">A valid method name.</doc>
7107 <type name="utf8" c:type="gchar*"/>
7111 <constructor name="new_signal"
7112 c:identifier="g_dbus_message_new_signal"
7114 <doc xml:whitespace="preserve">Creates a new #GDBusMessage for a signal emission.</doc>
7115 <return-value transfer-ownership="full">
7116 <doc xml:whitespace="preserve">A #GDBusMessage. Free with g_object_unref().</doc>
7117 <type name="DBusMessage" c:type="GDBusMessage*"/>
7120 <parameter name="path" transfer-ownership="none">
7121 <doc xml:whitespace="preserve">A valid object path.</doc>
7122 <type name="utf8" c:type="gchar*"/>
7124 <parameter name="interface_" transfer-ownership="none">
7125 <doc xml:whitespace="preserve">A valid D-Bus interface name.</doc>
7126 <type name="utf8" c:type="gchar*"/>
7128 <parameter name="signal" transfer-ownership="none">
7129 <doc xml:whitespace="preserve">A valid signal name.</doc>
7130 <type name="utf8" c:type="gchar*"/>
7134 <function name="bytes_needed"
7135 c:identifier="g_dbus_message_bytes_needed"
7138 <doc xml:whitespace="preserve">Utility function to calculate how many bytes are needed to
7139 completely deserialize the D-Bus message stored at @blob.
7140 determine the size).</doc>
7141 <return-value transfer-ownership="none">
7142 <doc xml:whitespace="preserve">Number of bytes needed or -1 if @error is set (e.g. if</doc>
7143 <type name="glong" c:type="gssize"/>
7146 <parameter name="blob" transfer-ownership="none">
7147 <doc xml:whitespace="preserve">A blob represent a binary D-Bus message.</doc>
7148 <type name="guint8" c:type="guchar*"/>
7150 <parameter name="blob_len" transfer-ownership="none">
7151 <doc xml:whitespace="preserve">The length of @blob (must be at least 16).</doc>
7152 <type name="gulong" c:type="gsize"/>
7157 c:identifier="g_dbus_message_copy"
7160 <doc xml:whitespace="preserve">Copies @message. The copy is a deep copy and the returned
7161 #GDBusMessage is completely identical except that it is guaranteed
7163 This operation can fail if e.g. @message contains file descriptors
7164 and the per-process or system-wide open files limit is reached.
7165 g_object_unref().</doc>
7166 <return-value transfer-ownership="full">
7167 <doc xml:whitespace="preserve">A new #GDBusMessage or %NULL if @error is set. Free with</doc>
7168 <type name="DBusMessage" c:type="GDBusMessage*"/>
7171 <method name="get_arg0"
7172 c:identifier="g_dbus_message_get_arg0"
7174 <doc xml:whitespace="preserve">Convenience to get the first item in the body of @message.</doc>
7175 <return-value transfer-ownership="none">
7176 <doc xml:whitespace="preserve">The string item or %NULL if the first item in the body of</doc>
7177 <type name="utf8" c:type="gchar*"/>
7180 <method name="get_body"
7181 c:identifier="g_dbus_message_get_body"
7183 <doc xml:whitespace="preserve">Gets the body of a message.</doc>
7184 <return-value transfer-ownership="full">
7185 <doc xml:whitespace="preserve">A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.</doc>
7186 <type name="GLib.Variant" c:type="GVariant*"/>
7189 <method name="get_byte_order"
7190 c:identifier="g_dbus_message_get_byte_order">
7191 <doc xml:whitespace="preserve">Gets the byte order of @message.</doc>
7192 <return-value transfer-ownership="none">
7193 <doc xml:whitespace="preserve">The byte order.</doc>
7194 <type name="DBusMessageByteOrder" c:type="GDBusMessageByteOrder"/>
7197 <method name="get_destination"
7198 c:identifier="g_dbus_message_get_destination"
7200 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.</doc>
7201 <return-value transfer-ownership="none">
7202 <doc xml:whitespace="preserve">The value.</doc>
7203 <type name="utf8" c:type="gchar*"/>
7206 <method name="get_error_name"
7207 c:identifier="g_dbus_message_get_error_name"
7209 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.</doc>
7210 <return-value transfer-ownership="none">
7211 <doc xml:whitespace="preserve">The value.</doc>
7212 <type name="utf8" c:type="gchar*"/>
7215 <method name="get_flags"
7216 c:identifier="g_dbus_message_get_flags"
7218 <doc xml:whitespace="preserve">Gets the flags for @message.</doc>
7219 <return-value transfer-ownership="none">
7220 <doc xml:whitespace="preserve">Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).</doc>
7221 <type name="DBusMessageFlags" c:type="GDBusMessageFlags"/>
7224 <method name="get_header"
7225 c:identifier="g_dbus_message_get_header"
7227 <doc xml:whitespace="preserve">Gets a header field on @message.
7228 otherwise. Do not free, it is owned by @message.</doc>
7229 <return-value transfer-ownership="full">
7230 <doc xml:whitespace="preserve">A #GVariant with the value if the header was found, %NULL</doc>
7231 <type name="GLib.Variant" c:type="GVariant*"/>
7234 <parameter name="header_field" transfer-ownership="none">
7235 <doc xml:whitespace="preserve">A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)</doc>
7236 <type name="DBusMessageHeaderField"
7237 c:type="GDBusMessageHeaderField"/>
7241 <method name="get_header_fields"
7242 c:identifier="g_dbus_message_get_header_fields"
7244 <doc xml:whitespace="preserve">Gets an array of all header fields on @message that are set.
7245 %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
7246 #guchar. Free with g_free().</doc>
7247 <return-value transfer-ownership="none">
7248 <doc xml:whitespace="preserve">An array of header fields terminated by</doc>
7249 <type name="guint8" c:type="guchar*"/>
7252 <method name="get_interface"
7253 c:identifier="g_dbus_message_get_interface"
7255 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.</doc>
7256 <return-value transfer-ownership="none">
7257 <doc xml:whitespace="preserve">The value.</doc>
7258 <type name="utf8" c:type="gchar*"/>
7261 <method name="get_locked"
7262 c:identifier="g_dbus_message_get_locked"
7264 <doc xml:whitespace="preserve">Checks whether @message is locked. To monitor changes to this
7265 value, conncet to the #GObject::notify signal to listen for changes
7266 on the #GDBusMessage:locked property.</doc>
7267 <return-value transfer-ownership="none">
7268 <doc xml:whitespace="preserve">%TRUE if @message is locked, %FALSE otherwise.</doc>
7269 <type name="gboolean" c:type="gboolean"/>
7272 <method name="get_member"
7273 c:identifier="g_dbus_message_get_member"
7275 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.</doc>
7276 <return-value transfer-ownership="none">
7277 <doc xml:whitespace="preserve">The value.</doc>
7278 <type name="utf8" c:type="gchar*"/>
7281 <method name="get_message_type"
7282 c:identifier="g_dbus_message_get_message_type"
7284 <doc xml:whitespace="preserve">Gets the type of @message.</doc>
7285 <return-value transfer-ownership="none">
7286 <doc xml:whitespace="preserve">A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).</doc>
7287 <type name="DBusMessageType" c:type="GDBusMessageType"/>
7290 <method name="get_num_unix_fds"
7291 c:identifier="g_dbus_message_get_num_unix_fds"
7293 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.</doc>
7294 <return-value transfer-ownership="none">
7295 <doc xml:whitespace="preserve">The value.</doc>
7296 <type name="guint32" c:type="guint32"/>
7299 <method name="get_path"
7300 c:identifier="g_dbus_message_get_path"
7302 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.</doc>
7303 <return-value transfer-ownership="none">
7304 <doc xml:whitespace="preserve">The value.</doc>
7305 <type name="utf8" c:type="gchar*"/>
7308 <method name="get_reply_serial"
7309 c:identifier="g_dbus_message_get_reply_serial"
7311 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.</doc>
7312 <return-value transfer-ownership="none">
7313 <doc xml:whitespace="preserve">The value.</doc>
7314 <type name="guint32" c:type="guint32"/>
7317 <method name="get_sender"
7318 c:identifier="g_dbus_message_get_sender"
7320 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.</doc>
7321 <return-value transfer-ownership="none">
7322 <doc xml:whitespace="preserve">The value.</doc>
7323 <type name="utf8" c:type="gchar*"/>
7326 <method name="get_serial"
7327 c:identifier="g_dbus_message_get_serial"
7329 <doc xml:whitespace="preserve">Gets the serial for @message.</doc>
7330 <return-value transfer-ownership="none">
7331 <doc xml:whitespace="preserve">A #guint32.</doc>
7332 <type name="guint32" c:type="guint32"/>
7335 <method name="get_signature"
7336 c:identifier="g_dbus_message_get_signature"
7338 <doc xml:whitespace="preserve">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.</doc>
7339 <return-value transfer-ownership="none">
7340 <doc xml:whitespace="preserve">The value.</doc>
7341 <type name="utf8" c:type="gchar*"/>
7344 <method name="get_unix_fd_list"
7345 c:identifier="g_dbus_message_get_unix_fd_list"
7347 <doc xml:whitespace="preserve">Gets the UNIX file descriptors associated with @message, if any.
7348 This method is only available on UNIX.
7349 associated. Do not free, this object is owned by @message.</doc>
7350 <return-value transfer-ownership="none">
7351 <doc xml:whitespace="preserve">A #GUnixFDList or %NULL if no file descriptors are</doc>
7352 <type name="UnixFDList" c:type="GUnixFDList*"/>
7355 <method name="lock" c:identifier="g_dbus_message_lock" version="2.26">
7356 <doc xml:whitespace="preserve">If @message is locked, does nothing. Otherwise locks the message.</doc>
7357 <return-value transfer-ownership="none">
7358 <type name="none" c:type="void"/>
7361 <method name="new_method_error"
7362 c:identifier="g_dbus_message_new_method_error"
7365 <doc xml:whitespace="preserve">Creates a new #GDBusMessage that is an error reply to @method_call_message.</doc>
7366 <return-value transfer-ownership="full">
7367 <doc xml:whitespace="preserve">A #GDBusMessage. Free with g_object_unref().</doc>
7368 <type name="DBusMessage" c:type="GDBusMessage*"/>
7371 <parameter name="error_name" transfer-ownership="none">
7372 <doc xml:whitespace="preserve">A valid D-Bus error name.</doc>
7373 <type name="utf8" c:type="gchar*"/>
7375 <parameter name="error_message_format" transfer-ownership="none">
7376 <doc xml:whitespace="preserve">The D-Bus error message in a printf() format.</doc>
7377 <type name="utf8" c:type="gchar*"/>
7379 <parameter transfer-ownership="none">
7385 <method name="new_method_error_literal"
7386 c:identifier="g_dbus_message_new_method_error_literal"
7388 <doc xml:whitespace="preserve">Creates a new #GDBusMessage that is an error reply to @method_call_message.</doc>
7389 <return-value transfer-ownership="full">
7390 <doc xml:whitespace="preserve">A #GDBusMessage. Free with g_object_unref().</doc>
7391 <type name="DBusMessage" c:type="GDBusMessage*"/>
7394 <parameter name="error_name" transfer-ownership="none">
7395 <doc xml:whitespace="preserve">A valid D-Bus error name.</doc>
7396 <type name="utf8" c:type="gchar*"/>
7398 <parameter name="error_message" transfer-ownership="none">
7399 <doc xml:whitespace="preserve">The D-Bus error message.</doc>
7400 <type name="utf8" c:type="gchar*"/>
7404 <method name="new_method_error_valist"
7405 c:identifier="g_dbus_message_new_method_error_valist"
7408 <doc xml:whitespace="preserve">Like g_dbus_message_new_method_error() but intended for language bindings.</doc>
7409 <return-value transfer-ownership="full">
7410 <doc xml:whitespace="preserve">A #GDBusMessage. Free with g_object_unref().</doc>
7411 <type name="DBusMessage" c:type="GDBusMessage*"/>
7414 <parameter name="error_name" transfer-ownership="none">
7415 <doc xml:whitespace="preserve">A valid D-Bus error name.</doc>
7416 <type name="utf8" c:type="gchar*"/>
7418 <parameter name="error_message_format" transfer-ownership="none">
7419 <doc xml:whitespace="preserve">The D-Bus error message in a printf() format.</doc>
7420 <type name="utf8" c:type="gchar*"/>
7422 <parameter name="var_args" transfer-ownership="none">
7423 <doc xml:whitespace="preserve">Arguments for @error_message_format.</doc>
7424 <type name="va_list" c:type="va_list"/>
7428 <method name="new_method_reply"
7429 c:identifier="g_dbus_message_new_method_reply"
7431 <doc xml:whitespace="preserve">Creates a new #GDBusMessage that is a reply to @method_call_message.</doc>
7432 <return-value transfer-ownership="full">
7433 <doc xml:whitespace="preserve">#GDBusMessage. Free with g_object_unref().</doc>
7434 <type name="DBusMessage" c:type="GDBusMessage*"/>
7437 <method name="print" c:identifier="g_dbus_message_print" version="2.26">
7438 <doc xml:whitespace="preserve">Produces a human-readable multi-line description of @message.
7439 The contents of the description has no ABI guarantees, the contents
7440 and formatting is subject to change at any time. Typical output
7441 looks something like this:
7442 <programlisting>
7444 path -> objectpath '/org/gtk/GDBus/TestObject'
7445 interface -> 'org.gtk.GDBus.TestInterface'
7446 member -> 'GimmeStdout'
7447 destination -> ':1.146'
7448 UNIX File Descriptors:
7450 </programlisting>
7452 <programlisting>
7454 reply-serial -> uint32 4
7455 destination -> ':1.159'
7456 sender -> ':1.146'
7457 num-unix-fds -> uint32 1
7458 UNIX File Descriptors:
7459 </programlisting></doc>
7460 <return-value transfer-ownership="full">
7461 <doc xml:whitespace="preserve">A string that should be freed with g_free().</doc>
7462 <type name="utf8" c:type="gchar*"/>
7465 <parameter name="indent" transfer-ownership="none">
7466 <doc xml:whitespace="preserve">Indentation level.</doc>
7467 <type name="guint" c:type="guint"/>
7471 <method name="set_body"
7472 c:identifier="g_dbus_message_set_body"
7474 <doc xml:whitespace="preserve">Sets the body @message. As a side-effect the
7475 %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
7476 type string of @body (or cleared if @body is %NULL).
7477 If @body is floating, @message assumes ownership of @body.</doc>
7478 <return-value transfer-ownership="none">
7479 <type name="none" c:type="void"/>
7482 <parameter name="body" transfer-ownership="none">
7483 <doc xml:whitespace="preserve">Either %NULL or a #GVariant that is a tuple.</doc>
7484 <type name="GLib.Variant" c:type="GVariant*"/>
7488 <method name="set_byte_order"
7489 c:identifier="g_dbus_message_set_byte_order">
7490 <doc xml:whitespace="preserve">Sets the byte order of @message.</doc>
7491 <return-value transfer-ownership="none">
7492 <type name="none" c:type="void"/>
7495 <parameter name="byte_order" transfer-ownership="none">
7496 <doc xml:whitespace="preserve">The byte order.</doc>
7497 <type name="DBusMessageByteOrder" c:type="GDBusMessageByteOrder"/>
7501 <method name="set_destination"
7502 c:identifier="g_dbus_message_set_destination"
7504 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.</doc>
7505 <return-value transfer-ownership="none">
7506 <type name="none" c:type="void"/>
7509 <parameter name="value" transfer-ownership="none">
7510 <doc xml:whitespace="preserve">The value to set.</doc>
7511 <type name="utf8" c:type="gchar*"/>
7515 <method name="set_error_name"
7516 c:identifier="g_dbus_message_set_error_name"
7518 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.</doc>
7519 <return-value transfer-ownership="none">
7520 <type name="none" c:type="void"/>
7523 <parameter name="value" transfer-ownership="none">
7524 <doc xml:whitespace="preserve">The value to set.</doc>
7525 <type name="utf8" c:type="gchar*"/>
7529 <method name="set_flags"
7530 c:identifier="g_dbus_message_set_flags"
7532 <doc xml:whitespace="preserve">Sets the flags to set on @message.</doc>
7533 <return-value transfer-ownership="none">
7534 <type name="none" c:type="void"/>
7537 <parameter name="flags" transfer-ownership="none">
7538 <doc xml:whitespace="preserve">Flags for @message that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).</doc>
7539 <type name="DBusMessageFlags" c:type="GDBusMessageFlags"/>
7543 <method name="set_header"
7544 c:identifier="g_dbus_message_set_header"
7546 <doc xml:whitespace="preserve">Sets a header field on @message.
7547 If @value is floating, @message assumes ownership of @value.</doc>
7548 <return-value transfer-ownership="none">
7549 <type name="none" c:type="void"/>
7552 <parameter name="header_field" transfer-ownership="none">
7553 <doc xml:whitespace="preserve">A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)</doc>
7554 <type name="DBusMessageHeaderField"
7555 c:type="GDBusMessageHeaderField"/>
7557 <parameter name="value" transfer-ownership="none">
7558 <doc xml:whitespace="preserve">A #GVariant to set the header field or %NULL to clear the header field.</doc>
7559 <type name="GLib.Variant" c:type="GVariant*"/>
7563 <method name="set_interface"
7564 c:identifier="g_dbus_message_set_interface"
7566 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.</doc>
7567 <return-value transfer-ownership="none">
7568 <type name="none" c:type="void"/>
7571 <parameter name="value" transfer-ownership="none">
7572 <doc xml:whitespace="preserve">The value to set.</doc>
7573 <type name="utf8" c:type="gchar*"/>
7577 <method name="set_member"
7578 c:identifier="g_dbus_message_set_member"
7580 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.</doc>
7581 <return-value transfer-ownership="none">
7582 <type name="none" c:type="void"/>
7585 <parameter name="value" transfer-ownership="none">
7586 <doc xml:whitespace="preserve">The value to set.</doc>
7587 <type name="utf8" c:type="gchar*"/>
7591 <method name="set_message_type"
7592 c:identifier="g_dbus_message_set_message_type"
7594 <doc xml:whitespace="preserve">Sets @message to be of @type.</doc>
7595 <return-value transfer-ownership="none">
7596 <type name="none" c:type="void"/>
7599 <parameter name="type" transfer-ownership="none">
7600 <doc xml:whitespace="preserve">A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).</doc>
7601 <type name="DBusMessageType" c:type="GDBusMessageType"/>
7605 <method name="set_num_unix_fds"
7606 c:identifier="g_dbus_message_set_num_unix_fds"
7608 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.</doc>
7609 <return-value transfer-ownership="none">
7610 <type name="none" c:type="void"/>
7613 <parameter name="value" transfer-ownership="none">
7614 <doc xml:whitespace="preserve">The value to set.</doc>
7615 <type name="guint32" c:type="guint32"/>
7619 <method name="set_path"
7620 c:identifier="g_dbus_message_set_path"
7622 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.</doc>
7623 <return-value transfer-ownership="none">
7624 <type name="none" c:type="void"/>
7627 <parameter name="value" transfer-ownership="none">
7628 <doc xml:whitespace="preserve">The value to set.</doc>
7629 <type name="utf8" c:type="gchar*"/>
7633 <method name="set_reply_serial"
7634 c:identifier="g_dbus_message_set_reply_serial"
7636 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.</doc>
7637 <return-value transfer-ownership="none">
7638 <type name="none" c:type="void"/>
7641 <parameter name="value" transfer-ownership="none">
7642 <doc xml:whitespace="preserve">The value to set.</doc>
7643 <type name="guint32" c:type="guint32"/>
7647 <method name="set_sender"
7648 c:identifier="g_dbus_message_set_sender"
7650 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.</doc>
7651 <return-value transfer-ownership="none">
7652 <type name="none" c:type="void"/>
7655 <parameter name="value" transfer-ownership="none">
7656 <doc xml:whitespace="preserve">The value to set.</doc>
7657 <type name="utf8" c:type="gchar*"/>
7661 <method name="set_serial"
7662 c:identifier="g_dbus_message_set_serial"
7664 <doc xml:whitespace="preserve">Sets the serial for @message.</doc>
7665 <return-value transfer-ownership="none">
7666 <type name="none" c:type="void"/>
7669 <parameter name="serial" transfer-ownership="none">
7670 <doc xml:whitespace="preserve">A #guint32.</doc>
7671 <type name="guint32" c:type="guint32"/>
7675 <method name="set_signature"
7676 c:identifier="g_dbus_message_set_signature"
7678 <doc xml:whitespace="preserve">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.</doc>
7679 <return-value transfer-ownership="none">
7680 <type name="none" c:type="void"/>
7683 <parameter name="value" transfer-ownership="none">
7684 <doc xml:whitespace="preserve">The value to set.</doc>
7685 <type name="utf8" c:type="gchar*"/>
7689 <method name="set_unix_fd_list"
7690 c:identifier="g_dbus_message_set_unix_fd_list"
7692 <doc xml:whitespace="preserve">Sets the UNIX file descriptors associated with @message. As a
7693 side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
7694 field is set to the number of fds in @fd_list (or cleared if
7695 This method is only available on UNIX.</doc>
7696 <return-value transfer-ownership="none">
7697 <type name="none" c:type="void"/>
7700 <parameter name="fd_list" transfer-ownership="none" allow-none="1">
7701 <doc xml:whitespace="preserve">A #GUnixFDList or %NULL.</doc>
7702 <type name="UnixFDList" c:type="GUnixFDList*"/>
7706 <method name="to_blob"
7707 c:identifier="g_dbus_message_to_blob"
7710 <doc xml:whitespace="preserve">Serializes @message to a blob. The byte order returned by
7711 g_dbus_message_get_byte_order() will be used.
7712 generated by @message or %NULL if @error is set. Free with g_free().</doc>
7713 <return-value transfer-ownership="none">
7714 <doc xml:whitespace="preserve">A pointer to a valid binary D-Bus message of @out_size bytes</doc>
7715 <type name="guint8" c:type="guchar*"/>
7718 <parameter name="out_size" transfer-ownership="none">
7719 <doc xml:whitespace="preserve">Return location for size of generated blob.</doc>
7720 <type name="gulong" c:type="gsize*"/>
7722 <parameter name="capabilities" transfer-ownership="none">
7723 <doc xml:whitespace="preserve">A #GDBusCapabilityFlags describing what protocol features are supported.</doc>
7724 <type name="DBusCapabilityFlags" c:type="GDBusCapabilityFlags"/>
7728 <method name="to_gerror"
7729 c:identifier="g_dbus_message_to_gerror"
7732 <doc xml:whitespace="preserve">If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
7733 nothing and returns %FALSE.
7734 Otherwise this method encodes the error in @message as a #GError
7735 using g_dbus_error_set_dbus_error() using the information in the
7736 %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
7737 well as the first string item in @message's body.</doc>
7738 <return-value transfer-ownership="none">
7739 <doc xml:whitespace="preserve">%TRUE if @error was set, %FALSE otherwise.</doc>
7740 <type name="gboolean" c:type="gboolean"/>
7743 <property name="locked" transfer-ownership="none">
7744 <type name="gboolean"/>
7747 <enumeration name="DBusMessageByteOrder"
7749 glib:type-name="GDBusMessageByteOrder"
7750 glib:get-type="g_dbus_message_byte_order_get_type"
7751 c:type="GDBusMessageByteOrder">
7752 <doc xml:whitespace="preserve">Enumeration used to describe the byte order of a D-Bus message.</doc>
7753 <member name="big_endian"
7755 c:identifier="G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN"
7756 glib:nick="big-endian"/>
7757 <member name="little_endian"
7759 c:identifier="G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN"
7760 glib:nick="little-endian"/>
7762 <callback name="DBusMessageFilterFunction"
7763 c:type="GDBusMessageFilterFunction"
7765 <doc xml:whitespace="preserve">Signature for function used in g_dbus_connection_add_filter().
7766 A filter function is passed a #GDBusMessage and expected to return
7767 a #GDBusMessage too. Passive filter functions that don't modify the
7768 message can simply return the @message object:
7770 static GDBusMessage *
7771 passive_filter (GDBusConnection *connection
7772 GDBusMessage *message,
7776 /<!-- -->* inspect @message *<!-- -->/
7780 Filter functions that wants to drop a message can simply return %NULL:
7782 static GDBusMessage *
7783 drop_filter (GDBusConnection *connection
7784 GDBusMessage *message,
7788 if (should_drop_message)
7790 g_object_unref (message);
7796 Finally, a filter function may modify a message by copying it:
7798 static GDBusMessage *
7799 modifying_filter (GDBusConnection *connection
7800 GDBusMessage *message,
7807 copy = g_dbus_message_copy (message, &error);
7808 /<!-- -->* handle @error being is set *<!-- -->/
7809 g_object_unref (message);
7810 /<!-- -->* modify @copy *<!-- -->/
7814 If the returned #GDBusMessage is different from @message and cannot
7815 be sent on @connection (it could use features, such as file
7816 descriptors, not compatible with @connection), then a warning is
7817 logged to <emphasis>standard error</emphasis>. Applications can
7818 check this ahead of time using g_dbus_message_to_blob() passing a
7819 #GDBusCapabilityFlags value obtained from @connection.
7820 g_object_unref() or %NULL to drop the message. Passive filter
7821 functions can simply return the passed @message object.</doc>
7822 <return-value transfer-ownership="full">
7823 <doc xml:whitespace="preserve">A #GDBusMessage that will be freed with</doc>
7824 <type name="DBusMessage" c:type="GDBusMessage*"/>
7827 <parameter name="connection" transfer-ownership="none">
7828 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
7829 <type name="DBusConnection" c:type="GDBusConnection*"/>
7831 <parameter name="message" transfer-ownership="full">
7832 <doc xml:whitespace="preserve">A locked #GDBusMessage that the filter function takes ownership of.</doc>
7833 <type name="DBusMessage" c:type="GDBusMessage*"/>
7835 <parameter name="incoming" transfer-ownership="none">
7836 <doc xml:whitespace="preserve">%TRUE if it is a message received from the other peer, %FALSE if it is a message to be sent to the other peer.</doc>
7837 <type name="gboolean" c:type="gboolean"/>
7839 <parameter name="user_data" transfer-ownership="none" closure="3">
7840 <doc xml:whitespace="preserve">User data passed when adding the filter.</doc>
7841 <type name="gpointer" c:type="gpointer"/>
7845 <bitfield name="DBusMessageFlags"
7847 glib:type-name="GDBusMessageFlags"
7848 glib:get-type="g_dbus_message_flags_get_type"
7849 c:type="GDBusMessageFlags">
7850 <doc xml:whitespace="preserve">Message flags used in #GDBusMessage.</doc>
7853 c:identifier="G_DBUS_MESSAGE_FLAGS_NONE"
7855 <member name="no_reply_expected"
7857 c:identifier="G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED"
7858 glib:nick="no-reply-expected"/>
7859 <member name="no_auto_start"
7861 c:identifier="G_DBUS_MESSAGE_FLAGS_NO_AUTO_START"
7862 glib:nick="no-auto-start"/>
7864 <enumeration name="DBusMessageHeaderField"
7866 glib:type-name="GDBusMessageHeaderField"
7867 glib:get-type="g_dbus_message_header_field_get_type"
7868 c:type="GDBusMessageHeaderField">
7869 <doc xml:whitespace="preserve">Header fields used in #GDBusMessage.</doc>
7870 <member name="invalid"
7872 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_INVALID"
7873 glib:nick="invalid"/>
7876 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_PATH"
7878 <member name="interface"
7880 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE"
7881 glib:nick="interface"/>
7882 <member name="member"
7884 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_MEMBER"
7885 glib:nick="member"/>
7886 <member name="error_name"
7888 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME"
7889 glib:nick="error-name"/>
7890 <member name="reply_serial"
7892 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL"
7893 glib:nick="reply-serial"/>
7894 <member name="destination"
7896 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION"
7897 glib:nick="destination"/>
7898 <member name="sender"
7900 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_SENDER"
7901 glib:nick="sender"/>
7902 <member name="signature"
7904 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE"
7905 glib:nick="signature"/>
7906 <member name="num_unix_fds"
7908 c:identifier="G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS"
7909 glib:nick="num-unix-fds"/>
7911 <enumeration name="DBusMessageType"
7913 glib:type-name="GDBusMessageType"
7914 glib:get-type="g_dbus_message_type_get_type"
7915 c:type="GDBusMessageType">
7916 <doc xml:whitespace="preserve">Message types used in #GDBusMessage.</doc>
7917 <member name="invalid"
7919 c:identifier="G_DBUS_MESSAGE_TYPE_INVALID"
7920 glib:nick="invalid"/>
7921 <member name="method_call"
7923 c:identifier="G_DBUS_MESSAGE_TYPE_METHOD_CALL"
7924 glib:nick="method-call"/>
7925 <member name="method_return"
7927 c:identifier="G_DBUS_MESSAGE_TYPE_METHOD_RETURN"
7928 glib:nick="method-return"/>
7929 <member name="error"
7931 c:identifier="G_DBUS_MESSAGE_TYPE_ERROR"
7933 <member name="signal"
7935 c:identifier="G_DBUS_MESSAGE_TYPE_SIGNAL"
7936 glib:nick="signal"/>
7938 <record name="DBusMethodInfo"
7939 c:type="GDBusMethodInfo"
7941 glib:type-name="GDBusMethodInfo"
7942 glib:get-type="g_dbus_method_info_get_type"
7943 c:symbol-prefix="dbus_method_info">
7944 <doc xml:whitespace="preserve">Information about a method on an D-Bus interface.</doc>
7945 <field name="ref_count" writable="1">
7946 <type name="gint" c:type="gint"/>
7948 <field name="name" writable="1">
7949 <type name="utf8" c:type="gchar*"/>
7951 <field name="in_args" writable="1">
7952 <type name="DBusArgInfo" c:type="GDBusArgInfo**"/>
7954 <field name="out_args" writable="1">
7955 <type name="DBusArgInfo" c:type="GDBusArgInfo**"/>
7957 <field name="annotations" writable="1">
7958 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
7960 <method name="ref" c:identifier="g_dbus_method_info_ref" version="2.26">
7961 <doc xml:whitespace="preserve">If @info is statically allocated does nothing. Otherwise increases
7962 the reference count.</doc>
7963 <return-value transfer-ownership="full">
7964 <doc xml:whitespace="preserve">The same @info.</doc>
7965 <type name="DBusMethodInfo" c:type="GDBusMethodInfo*"/>
7968 <method name="unref"
7969 c:identifier="g_dbus_method_info_unref"
7971 <doc xml:whitespace="preserve">If @info is statically allocated, does nothing. Otherwise decreases
7972 the reference count of @info. When its reference count drops to 0,
7973 the memory used is freed.</doc>
7974 <return-value transfer-ownership="none">
7975 <type name="none" c:type="void"/>
7979 <class name="DBusMethodInvocation"
7980 c:symbol-prefix="dbus_method_invocation"
7981 c:type="GDBusMethodInvocation"
7983 parent="GObject.Object"
7984 glib:type-name="GDBusMethodInvocation"
7985 glib:get-type="g_dbus_method_invocation_get_type">
7986 <doc xml:whitespace="preserve">The #GDBusMethodInvocation structure contains only private data and
7987 should only be accessed using the provided API.</doc>
7988 <method name="get_connection"
7989 c:identifier="g_dbus_method_invocation_get_connection"
7991 <doc xml:whitespace="preserve">Gets the #GDBusConnection the method was invoked on.</doc>
7992 <return-value transfer-ownership="none">
7993 <doc xml:whitespace="preserve">A #GDBusConnection. Do not free, it is owned by @invocation.</doc>
7994 <type name="DBusConnection" c:type="GDBusConnection*"/>
7997 <method name="get_interface_name"
7998 c:identifier="g_dbus_method_invocation_get_interface_name"
8000 <doc xml:whitespace="preserve">Gets the name of the D-Bus interface the method was invoked on.</doc>
8001 <return-value transfer-ownership="none">
8002 <doc xml:whitespace="preserve">A string. Do not free, it is owned by @invocation.</doc>
8003 <type name="utf8" c:type="gchar*"/>
8006 <method name="get_message"
8007 c:identifier="g_dbus_method_invocation_get_message"
8009 <doc xml:whitespace="preserve">Gets the #GDBusMessage for the method invocation. This is useful if
8010 you need to use low-level protocol features, such as UNIX file
8011 descriptor passing, that cannot be properly expressed in the
8013 See <xref linkend="gdbus-server"/> and <xref
8014 linkend="gdbus-unix-fd-client"/> for an example of how to use this
8015 low-level API to send and receive UNIX file descriptors.</doc>
8016 <return-value transfer-ownership="none">
8017 <doc xml:whitespace="preserve">#GDBusMessage. Do not free, it is owned by @invocation.</doc>
8018 <type name="DBusMessage" c:type="GDBusMessage*"/>
8021 <method name="get_method_info"
8022 c:identifier="g_dbus_method_invocation_get_method_info"
8024 <doc xml:whitespace="preserve">Gets information about the method call, if any.</doc>
8025 <return-value transfer-ownership="none">
8026 <doc xml:whitespace="preserve">A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation.</doc>
8027 <type name="DBusMethodInfo" c:type="GDBusMethodInfo*"/>
8030 <method name="get_method_name"
8031 c:identifier="g_dbus_method_invocation_get_method_name"
8033 <doc xml:whitespace="preserve">Gets the name of the method that was invoked.</doc>
8034 <return-value transfer-ownership="none">
8035 <doc xml:whitespace="preserve">A string. Do not free, it is owned by @invocation.</doc>
8036 <type name="utf8" c:type="gchar*"/>
8039 <method name="get_object_path"
8040 c:identifier="g_dbus_method_invocation_get_object_path"
8042 <doc xml:whitespace="preserve">Gets the object path the method was invoked on.</doc>
8043 <return-value transfer-ownership="none">
8044 <doc xml:whitespace="preserve">A string. Do not free, it is owned by @invocation.</doc>
8045 <type name="utf8" c:type="gchar*"/>
8048 <method name="get_parameters"
8049 c:identifier="g_dbus_method_invocation_get_parameters"
8051 <doc xml:whitespace="preserve">Gets the parameters of the method invocation.</doc>
8052 <return-value transfer-ownership="full">
8053 <doc xml:whitespace="preserve">A #GVariant. Do not free, it is owned by @invocation.</doc>
8054 <type name="GLib.Variant" c:type="GVariant*"/>
8057 <method name="get_sender"
8058 c:identifier="g_dbus_method_invocation_get_sender"
8060 <doc xml:whitespace="preserve">Gets the bus name that invoked the method.</doc>
8061 <return-value transfer-ownership="none">
8062 <doc xml:whitespace="preserve">A string. Do not free, it is owned by @invocation.</doc>
8063 <type name="utf8" c:type="gchar*"/>
8066 <method name="get_user_data"
8067 c:identifier="g_dbus_method_invocation_get_user_data"
8070 <doc xml:whitespace="preserve">Gets the @user_data #gpointer passed to g_dbus_connection_register_object().</doc>
8072 <doc xml:whitespace="preserve">A #gpointer.</doc>
8073 <type name="gpointer" c:type="gpointer"/>
8076 <method name="return_dbus_error"
8077 c:identifier="g_dbus_method_invocation_return_dbus_error"
8079 <doc xml:whitespace="preserve">Finishes handling a D-Bus method call by returning an error.
8080 This method will free @invocation, you cannot use it afterwards.</doc>
8081 <return-value transfer-ownership="none">
8082 <type name="none" c:type="void"/>
8085 <parameter name="error_name" transfer-ownership="none">
8086 <doc xml:whitespace="preserve">A valid D-Bus error name.</doc>
8087 <type name="utf8" c:type="gchar*"/>
8089 <parameter name="error_message" transfer-ownership="none">
8090 <doc xml:whitespace="preserve">A valid D-Bus error message.</doc>
8091 <type name="utf8" c:type="gchar*"/>
8095 <method name="return_error"
8096 c:identifier="g_dbus_method_invocation_return_error"
8099 <doc xml:whitespace="preserve">Finishes handling a D-Bus method call by returning an error.
8100 See g_dbus_error_encode_gerror() for details about what error name
8101 will be returned on the wire. In a nutshell, if the given error is
8102 registered using g_dbus_error_register_error() the name given
8103 during registration is used. Otherwise, a name of the form
8104 <literal>org.gtk.GDBus.UnmappedGError.Quark...</literal> is
8105 used. This provides transparent mapping of #GError between
8106 applications using GDBus.
8107 If you are writing an application intended to be portable,
8108 <emphasis>always</emphasis> register errors with g_dbus_error_register_error()
8109 or use g_dbus_method_invocation_return_dbus_error().
8110 This method will free @invocation, you cannot use it afterwards.</doc>
8111 <return-value transfer-ownership="none">
8112 <type name="none" c:type="void"/>
8115 <parameter name="domain" transfer-ownership="none">
8116 <doc xml:whitespace="preserve">A #GQuark for the #GError error domain.</doc>
8117 <type name="GLib.Quark" c:type="GQuark"/>
8119 <parameter name="code" transfer-ownership="none">
8120 <doc xml:whitespace="preserve">The error code.</doc>
8121 <type name="gint" c:type="gint"/>
8123 <parameter name="format" transfer-ownership="none">
8124 <doc xml:whitespace="preserve">printf()-style format.</doc>
8125 <type name="utf8" c:type="gchar*"/>
8127 <parameter transfer-ownership="none">
8133 <method name="return_error_literal"
8134 c:identifier="g_dbus_method_invocation_return_error_literal"
8136 <doc xml:whitespace="preserve">Like g_dbus_method_invocation_return_error() but without printf()-style formatting.
8137 This method will free @invocation, you cannot use it afterwards.</doc>
8138 <return-value transfer-ownership="none">
8139 <type name="none" c:type="void"/>
8142 <parameter name="domain" transfer-ownership="none">
8143 <doc xml:whitespace="preserve">A #GQuark for the #GError error domain.</doc>
8144 <type name="GLib.Quark" c:type="GQuark"/>
8146 <parameter name="code" transfer-ownership="none">
8147 <doc xml:whitespace="preserve">The error code.</doc>
8148 <type name="gint" c:type="gint"/>
8150 <parameter name="message" transfer-ownership="none">
8151 <doc xml:whitespace="preserve">The error message.</doc>
8152 <type name="utf8" c:type="gchar*"/>
8156 <method name="return_error_valist"
8157 c:identifier="g_dbus_method_invocation_return_error_valist"
8160 <doc xml:whitespace="preserve">Like g_dbus_method_invocation_return_error() but intended for
8162 This method will free @invocation, you cannot use it afterwards.</doc>
8163 <return-value transfer-ownership="none">
8164 <type name="none" c:type="void"/>
8167 <parameter name="domain" transfer-ownership="none">
8168 <doc xml:whitespace="preserve">A #GQuark for the #GError error domain.</doc>
8169 <type name="GLib.Quark" c:type="GQuark"/>
8171 <parameter name="code" transfer-ownership="none">
8172 <doc xml:whitespace="preserve">The error code.</doc>
8173 <type name="gint" c:type="gint"/>
8175 <parameter name="format" transfer-ownership="none">
8176 <doc xml:whitespace="preserve">printf()-style format.</doc>
8177 <type name="utf8" c:type="gchar*"/>
8179 <parameter name="var_args" transfer-ownership="none">
8180 <doc xml:whitespace="preserve">#va_list of parameters for @format.</doc>
8181 <type name="va_list" c:type="va_list"/>
8185 <method name="return_gerror"
8186 c:identifier="g_dbus_method_invocation_return_gerror"
8188 <doc xml:whitespace="preserve">Like g_dbus_method_invocation_return_error() but takes a #GError
8189 instead of the error domain, error code and message.
8190 This method will free @invocation, you cannot use it afterwards.</doc>
8191 <return-value transfer-ownership="none">
8192 <type name="none" c:type="void"/>
8195 <parameter name="error" transfer-ownership="none">
8196 <doc xml:whitespace="preserve">A #GError.</doc>
8197 <type name="GLib.Error" c:type="GError*"/>
8201 <method name="return_value"
8202 c:identifier="g_dbus_method_invocation_return_value"
8204 <doc xml:whitespace="preserve">Finishes handling a D-Bus method call by returning @parameters.
8205 If the @parameters GVariant is floating, it is consumed.
8206 It is an error if @parameters is not of the right format.
8207 This method will free @invocation, you cannot use it afterwards.</doc>
8208 <return-value transfer-ownership="none">
8209 <type name="none" c:type="void"/>
8212 <parameter name="parameters" transfer-ownership="none">
8213 <doc xml:whitespace="preserve">A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters.</doc>
8214 <type name="GLib.Variant" c:type="GVariant*"/>
8219 <record name="DBusNodeInfo"
8220 c:type="GDBusNodeInfo"
8222 glib:type-name="GDBusNodeInfo"
8223 glib:get-type="g_dbus_node_info_get_type"
8224 c:symbol-prefix="dbus_node_info">
8225 <doc xml:whitespace="preserve">Information about nodes in a remote object hierarchy.</doc>
8226 <field name="ref_count" writable="1">
8227 <type name="gint" c:type="gint"/>
8229 <field name="path" writable="1">
8230 <type name="utf8" c:type="gchar*"/>
8232 <field name="interfaces" writable="1">
8233 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo**"/>
8235 <field name="nodes" writable="1">
8236 <type name="DBusNodeInfo" c:type="GDBusNodeInfo**"/>
8238 <field name="annotations" writable="1">
8239 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
8241 <constructor name="new_for_xml"
8242 c:identifier="g_dbus_node_info_new_for_xml"
8245 <doc xml:whitespace="preserve">Parses @xml_data and returns a #GDBusNodeInfo representing the data.
8246 with g_dbus_node_info_unref().</doc>
8247 <return-value transfer-ownership="full">
8248 <doc xml:whitespace="preserve">A #GDBusNodeInfo structure or %NULL if @error is set. Free</doc>
8249 <type name="DBusNodeInfo" c:type="GDBusNodeInfo*"/>
8252 <parameter name="xml_data" transfer-ownership="none">
8253 <doc xml:whitespace="preserve">Valid D-Bus introspection XML.</doc>
8254 <type name="utf8" c:type="gchar*"/>
8258 <method name="generate_xml"
8259 c:identifier="g_dbus_node_info_generate_xml"
8261 <doc xml:whitespace="preserve">Appends an XML representation of @info (and its children) to @string_builder.
8262 This function is typically used for generating introspection XML documents at run-time for
8263 handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method.</doc>
8264 <return-value transfer-ownership="none">
8265 <type name="none" c:type="void"/>
8268 <parameter name="indent" transfer-ownership="none">
8269 <doc xml:whitespace="preserve">Indentation level.</doc>
8270 <type name="guint" c:type="guint"/>
8272 <parameter name="string_builder" transfer-ownership="none">
8273 <doc xml:whitespace="preserve">A #GString to to append XML data to.</doc>
8274 <type name="GLib.String" c:type="GString*"/>
8278 <method name="lookup_interface"
8279 c:identifier="g_dbus_node_info_lookup_interface"
8281 <doc xml:whitespace="preserve">Looks up information about an interface.
8282 This cost of this function is O(n) in number of interfaces.</doc>
8283 <return-value transfer-ownership="full">
8284 <doc xml:whitespace="preserve">A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info.</doc>
8285 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
8288 <parameter name="name" transfer-ownership="none">
8289 <doc xml:whitespace="preserve">A D-Bus interface name.</doc>
8290 <type name="utf8" c:type="gchar*"/>
8294 <method name="ref" c:identifier="g_dbus_node_info_ref" version="2.26">
8295 <doc xml:whitespace="preserve">If @info is statically allocated does nothing. Otherwise increases
8296 the reference count.</doc>
8297 <return-value transfer-ownership="full">
8298 <doc xml:whitespace="preserve">The same @info.</doc>
8299 <type name="DBusNodeInfo" c:type="GDBusNodeInfo*"/>
8302 <method name="unref"
8303 c:identifier="g_dbus_node_info_unref"
8305 <doc xml:whitespace="preserve">If @info is statically allocated, does nothing. Otherwise decreases
8306 the reference count of @info. When its reference count drops to 0,
8307 the memory used is freed.</doc>
8308 <return-value transfer-ownership="none">
8309 <type name="none" c:type="void"/>
8313 <record name="DBusPropertyInfo"
8314 c:type="GDBusPropertyInfo"
8316 glib:type-name="GDBusPropertyInfo"
8317 glib:get-type="g_dbus_property_info_get_type"
8318 c:symbol-prefix="dbus_property_info">
8319 <doc xml:whitespace="preserve">Information about a D-Bus property on a D-Bus interface.</doc>
8320 <field name="ref_count" writable="1">
8321 <type name="gint" c:type="gint"/>
8323 <field name="name" writable="1">
8324 <type name="utf8" c:type="gchar*"/>
8326 <field name="signature" writable="1">
8327 <type name="utf8" c:type="gchar*"/>
8329 <field name="flags" writable="1">
8330 <type name="DBusPropertyInfoFlags" c:type="GDBusPropertyInfoFlags"/>
8332 <field name="annotations" writable="1">
8333 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
8336 c:identifier="g_dbus_property_info_ref"
8338 <doc xml:whitespace="preserve">If @info is statically allocated does nothing. Otherwise increases
8339 the reference count.</doc>
8340 <return-value transfer-ownership="full">
8341 <doc xml:whitespace="preserve">The same @info.</doc>
8342 <type name="DBusPropertyInfo" c:type="GDBusPropertyInfo*"/>
8345 <method name="unref"
8346 c:identifier="g_dbus_property_info_unref"
8348 <doc xml:whitespace="preserve">If @info is statically allocated, does nothing. Otherwise decreases
8349 the reference count of @info. When its reference count drops to 0,
8350 the memory used is freed.</doc>
8351 <return-value transfer-ownership="none">
8352 <type name="none" c:type="void"/>
8356 <bitfield name="DBusPropertyInfoFlags"
8358 glib:type-name="GDBusPropertyInfoFlags"
8359 glib:get-type="g_dbus_property_info_flags_get_type"
8360 c:type="GDBusPropertyInfoFlags">
8361 <doc xml:whitespace="preserve">Flags describing the access control of a D-Bus property.</doc>
8364 c:identifier="G_DBUS_PROPERTY_INFO_FLAGS_NONE"
8366 <member name="readable"
8368 c:identifier="G_DBUS_PROPERTY_INFO_FLAGS_READABLE"
8369 glib:nick="readable"/>
8370 <member name="writable"
8372 c:identifier="G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE"
8373 glib:nick="writable"/>
8375 <class name="DBusProxy"
8376 c:symbol-prefix="dbus_proxy"
8379 parent="GObject.Object"
8380 glib:type-name="GDBusProxy"
8381 glib:get-type="g_dbus_proxy_get_type"
8382 glib:type-struct="DBusProxyClass">
8383 <doc xml:whitespace="preserve">The #GDBusProxy structure contains only private data and
8384 should only be accessed using the provided API.</doc>
8385 <implements name="AsyncInitable"/>
8386 <implements name="Initable"/>
8387 <constructor name="new_finish"
8388 c:identifier="g_dbus_proxy_new_finish"
8391 <doc xml:whitespace="preserve">Finishes creating a #GDBusProxy.</doc>
8392 <return-value transfer-ownership="full">
8393 <doc xml:whitespace="preserve">A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().</doc>
8394 <type name="DBusProxy" c:type="GDBusProxy*"/>
8397 <parameter name="res" transfer-ownership="none">
8398 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new().</doc>
8399 <type name="AsyncResult" c:type="GAsyncResult*"/>
8403 <constructor name="new_for_bus_finish"
8404 c:identifier="g_dbus_proxy_new_for_bus_finish"
8407 <doc xml:whitespace="preserve">Finishes creating a #GDBusProxy.</doc>
8408 <return-value transfer-ownership="full">
8409 <doc xml:whitespace="preserve">A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().</doc>
8410 <type name="DBusProxy" c:type="GDBusProxy*"/>
8413 <parameter name="res" transfer-ownership="none">
8414 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus().</doc>
8415 <type name="AsyncResult" c:type="GAsyncResult*"/>
8419 <constructor name="new_for_bus_sync"
8420 c:identifier="g_dbus_proxy_new_for_bus_sync"
8423 <doc xml:whitespace="preserve">Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
8424 See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.</doc>
8425 <return-value transfer-ownership="full">
8426 <doc xml:whitespace="preserve">A #GDBusProxy or %NULL if error is set. Free with g_object_unref().</doc>
8427 <type name="DBusProxy" c:type="GDBusProxy*"/>
8430 <parameter name="bus_type" transfer-ownership="none">
8431 <doc xml:whitespace="preserve">A #GBusType.</doc>
8432 <type name="BusType" c:type="GBusType"/>
8434 <parameter name="flags" transfer-ownership="none">
8435 <doc xml:whitespace="preserve">Flags used when constructing the proxy.</doc>
8436 <type name="DBusProxyFlags" c:type="GDBusProxyFlags"/>
8438 <parameter name="info" transfer-ownership="none">
8439 <doc xml:whitespace="preserve">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.</doc>
8440 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
8442 <parameter name="name" transfer-ownership="none">
8443 <doc xml:whitespace="preserve">A bus name (well-known or unique).</doc>
8444 <type name="utf8" c:type="gchar*"/>
8446 <parameter name="object_path" transfer-ownership="none">
8447 <doc xml:whitespace="preserve">An object path.</doc>
8448 <type name="utf8" c:type="gchar*"/>
8450 <parameter name="interface_name" transfer-ownership="none">
8451 <doc xml:whitespace="preserve">A D-Bus interface name.</doc>
8452 <type name="utf8" c:type="gchar*"/>
8454 <parameter name="cancellable"
8455 transfer-ownership="none"
8457 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
8458 <type name="Cancellable" c:type="GCancellable*"/>
8462 <constructor name="new_sync"
8463 c:identifier="g_dbus_proxy_new_sync"
8466 <doc xml:whitespace="preserve">Creates a proxy for accessing @interface_name on the remote object
8467 at @object_path owned by @name at @connection and synchronously
8468 loads D-Bus properties unless the
8469 %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
8470 If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
8471 match rules for signals. Connect to the #GDBusProxy::g-signal signal
8472 to handle signals from the remote object.
8473 If @name is a well-known name and the
8474 %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
8475 owner currently exists, the message bus will be requested to launch
8476 a name owner for the name.
8477 This is a synchronous failable constructor. See g_dbus_proxy_new()
8478 and g_dbus_proxy_new_finish() for the asynchronous version.
8479 See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.</doc>
8480 <return-value transfer-ownership="full">
8481 <doc xml:whitespace="preserve">A #GDBusProxy or %NULL if error is set. Free with g_object_unref().</doc>
8482 <type name="DBusProxy" c:type="GDBusProxy*"/>
8485 <parameter name="connection" transfer-ownership="none">
8486 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
8487 <type name="DBusConnection" c:type="GDBusConnection*"/>
8489 <parameter name="flags" transfer-ownership="none">
8490 <doc xml:whitespace="preserve">Flags used when constructing the proxy.</doc>
8491 <type name="DBusProxyFlags" c:type="GDBusProxyFlags"/>
8493 <parameter name="info" transfer-ownership="none" allow-none="1">
8494 <doc xml:whitespace="preserve">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.</doc>
8495 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
8497 <parameter name="name" transfer-ownership="none" allow-none="1">
8498 <doc xml:whitespace="preserve">A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.</doc>
8499 <type name="utf8" c:type="gchar*"/>
8501 <parameter name="object_path" transfer-ownership="none">
8502 <doc xml:whitespace="preserve">An object path.</doc>
8503 <type name="utf8" c:type="gchar*"/>
8505 <parameter name="interface_name" transfer-ownership="none">
8506 <doc xml:whitespace="preserve">A D-Bus interface name.</doc>
8507 <type name="utf8" c:type="gchar*"/>
8509 <parameter name="cancellable"
8510 transfer-ownership="none"
8512 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
8513 <type name="Cancellable" c:type="GCancellable*"/>
8517 <function name="new" c:identifier="g_dbus_proxy_new" version="2.26">
8518 <doc xml:whitespace="preserve">Creates a proxy for accessing @interface_name on the remote object
8519 at @object_path owned by @name at @connection and asynchronously
8520 loads D-Bus properties unless the
8521 %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to
8522 the #GDBusProxy::g-properties-changed signal to get notified about
8524 If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
8525 match rules for signals. Connect to the #GDBusProxy::g-signal signal
8526 to handle signals from the remote object.
8527 If @name is a well-known name and the
8528 %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
8529 owner currently exists, the message bus will be requested to launch
8530 a name owner for the name.
8531 This is a failable asynchronous constructor - when the proxy is
8532 ready, @callback will be invoked and you can use
8533 g_dbus_proxy_new_finish() to get the result.
8534 See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
8535 See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.</doc>
8536 <return-value transfer-ownership="none">
8537 <type name="none" c:type="void"/>
8540 <parameter name="connection" transfer-ownership="none">
8541 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
8542 <type name="DBusConnection" c:type="GDBusConnection*"/>
8544 <parameter name="flags" transfer-ownership="none">
8545 <doc xml:whitespace="preserve">Flags used when constructing the proxy.</doc>
8546 <type name="DBusProxyFlags" c:type="GDBusProxyFlags"/>
8548 <parameter name="info" transfer-ownership="none">
8549 <doc xml:whitespace="preserve">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.</doc>
8550 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
8552 <parameter name="name" transfer-ownership="none">
8553 <doc xml:whitespace="preserve">A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.</doc>
8554 <type name="utf8" c:type="gchar*"/>
8556 <parameter name="object_path" transfer-ownership="none">
8557 <doc xml:whitespace="preserve">An object path.</doc>
8558 <type name="utf8" c:type="gchar*"/>
8560 <parameter name="interface_name" transfer-ownership="none">
8561 <doc xml:whitespace="preserve">A D-Bus interface name.</doc>
8562 <type name="utf8" c:type="gchar*"/>
8564 <parameter name="cancellable"
8565 transfer-ownership="none"
8567 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
8568 <type name="Cancellable" c:type="GCancellable*"/>
8570 <parameter name="callback"
8571 transfer-ownership="none"
8574 <doc xml:whitespace="preserve">Callback function to invoke when the proxy is ready.</doc>
8575 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
8577 <parameter name="user_data" transfer-ownership="none">
8578 <doc xml:whitespace="preserve">User data to pass to @callback.</doc>
8579 <type name="gpointer" c:type="gpointer"/>
8583 <function name="new_for_bus"
8584 c:identifier="g_dbus_proxy_new_for_bus"
8586 <doc xml:whitespace="preserve">Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
8587 See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.</doc>
8588 <return-value transfer-ownership="none">
8589 <type name="none" c:type="void"/>
8592 <parameter name="bus_type" transfer-ownership="none">
8593 <doc xml:whitespace="preserve">A #GBusType.</doc>
8594 <type name="BusType" c:type="GBusType"/>
8596 <parameter name="flags" transfer-ownership="none">
8597 <doc xml:whitespace="preserve">Flags used when constructing the proxy.</doc>
8598 <type name="DBusProxyFlags" c:type="GDBusProxyFlags"/>
8600 <parameter name="info" transfer-ownership="none">
8601 <doc xml:whitespace="preserve">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.</doc>
8602 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
8604 <parameter name="name" transfer-ownership="none">
8605 <doc xml:whitespace="preserve">A bus name (well-known or unique).</doc>
8606 <type name="utf8" c:type="gchar*"/>
8608 <parameter name="object_path" transfer-ownership="none">
8609 <doc xml:whitespace="preserve">An object path.</doc>
8610 <type name="utf8" c:type="gchar*"/>
8612 <parameter name="interface_name" transfer-ownership="none">
8613 <doc xml:whitespace="preserve">A D-Bus interface name.</doc>
8614 <type name="utf8" c:type="gchar*"/>
8616 <parameter name="cancellable"
8617 transfer-ownership="none"
8619 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
8620 <type name="Cancellable" c:type="GCancellable*"/>
8622 <parameter name="callback"
8623 transfer-ownership="none"
8626 <doc xml:whitespace="preserve">Callback function to invoke when the proxy is ready.</doc>
8627 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
8629 <parameter name="user_data" transfer-ownership="none">
8630 <doc xml:whitespace="preserve">User data to pass to @callback.</doc>
8631 <type name="gpointer" c:type="gpointer"/>
8635 <method name="call" c:identifier="g_dbus_proxy_call" version="2.26">
8636 <doc xml:whitespace="preserve">Asynchronously invokes the @method_name method on @proxy.
8637 If @method_name contains any dots, then @name is split into interface and
8638 method name parts. This allows using @proxy for invoking methods on
8640 If the #GDBusConnection associated with @proxy is closed then
8641 the operation will fail with %G_IO_ERROR_CLOSED. If
8642 %G_IO_ERROR_CANCELLED. If @parameters contains a value not
8643 compatible with the D-Bus protocol, the operation fails with
8644 %G_IO_ERROR_INVALID_ARGUMENT.
8645 If the @parameters #GVariant is floating, it is consumed. This allows
8646 convenient 'inline' use of g_variant_new(), e.g.:
8648 g_dbus_proxy_call (proxy,
8650 g_variant_new ("(ss)",
8653 G_DBUS_CALL_FLAGS_NONE,
8656 (GAsyncReadyCallback) two_strings_done,
8659 This is an asynchronous method. When the operation is finished,
8660 <link linkend="g-main-context-push-thread-default">thread-default
8661 main loop</link> of the thread you are calling this method from.
8662 You can then call g_dbus_proxy_call_finish() to get the result of
8663 the operation. See g_dbus_proxy_call_sync() for the synchronous
8664 version of this method.</doc>
8665 <return-value transfer-ownership="none">
8666 <type name="none" c:type="void"/>
8669 <parameter name="method_name" transfer-ownership="none">
8670 <doc xml:whitespace="preserve">Name of method to invoke.</doc>
8671 <type name="utf8" c:type="gchar*"/>
8673 <parameter name="parameters" transfer-ownership="none">
8674 <doc xml:whitespace="preserve">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.</doc>
8675 <type name="GLib.Variant" c:type="GVariant*"/>
8677 <parameter name="flags" transfer-ownership="none">
8678 <doc xml:whitespace="preserve">Flags from the #GDBusCallFlags enumeration.</doc>
8679 <type name="DBusCallFlags" c:type="GDBusCallFlags"/>
8681 <parameter name="timeout_msec" transfer-ownership="none">
8682 <doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the proxy default timeout.</doc>
8683 <type name="gint" c:type="gint"/>
8685 <parameter name="cancellable"
8686 transfer-ownership="none"
8688 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
8689 <type name="Cancellable" c:type="GCancellable*"/>
8691 <parameter name="callback"
8692 transfer-ownership="none"
8695 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.</doc>
8696 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
8698 <parameter name="user_data" transfer-ownership="none">
8699 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
8700 <type name="gpointer" c:type="gpointer"/>
8704 <method name="call_finish"
8705 c:identifier="g_dbus_proxy_call_finish"
8708 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_proxy_call().
8709 return values. Free with g_variant_unref().</doc>
8710 <return-value transfer-ownership="full">
8711 <doc xml:whitespace="preserve">%NULL if @error is set. Otherwise a #GVariant tuple with</doc>
8712 <type name="GLib.Variant" c:type="GVariant*"/>
8715 <parameter name="res" transfer-ownership="none">
8716 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().</doc>
8717 <type name="AsyncResult" c:type="GAsyncResult*"/>
8721 <method name="call_sync"
8722 c:identifier="g_dbus_proxy_call_sync"
8725 <doc xml:whitespace="preserve">Synchronously invokes the @method_name method on @proxy.
8726 If @method_name contains any dots, then @name is split into interface and
8727 method name parts. This allows using @proxy for invoking methods on
8729 If the #GDBusConnection associated with @proxy is disconnected then
8730 the operation will fail with %G_IO_ERROR_CLOSED. If
8731 %G_IO_ERROR_CANCELLED. If @parameters contains a value not
8732 compatible with the D-Bus protocol, the operation fails with
8733 %G_IO_ERROR_INVALID_ARGUMENT.
8734 If the @parameters #GVariant is floating, it is consumed. This allows
8735 convenient 'inline' use of g_variant_new(), e.g.:
8737 g_dbus_proxy_call_sync (proxy,
8739 g_variant_new ("(ss)",
8742 G_DBUS_CALL_FLAGS_NONE,
8747 The calling thread is blocked until a reply is received. See
8748 g_dbus_proxy_call() for the asynchronous version of this
8750 return values. Free with g_variant_unref().</doc>
8751 <return-value transfer-ownership="full">
8752 <doc xml:whitespace="preserve">%NULL if @error is set. Otherwise a #GVariant tuple with</doc>
8753 <type name="GLib.Variant" c:type="GVariant*"/>
8756 <parameter name="method_name" transfer-ownership="none">
8757 <doc xml:whitespace="preserve">Name of method to invoke.</doc>
8758 <type name="utf8" c:type="gchar*"/>
8760 <parameter name="parameters" transfer-ownership="none">
8761 <doc xml:whitespace="preserve">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.</doc>
8762 <type name="GLib.Variant" c:type="GVariant*"/>
8764 <parameter name="flags" transfer-ownership="none">
8765 <doc xml:whitespace="preserve">Flags from the #GDBusCallFlags enumeration.</doc>
8766 <type name="DBusCallFlags" c:type="GDBusCallFlags"/>
8768 <parameter name="timeout_msec" transfer-ownership="none">
8769 <doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the proxy default timeout.</doc>
8770 <type name="gint" c:type="gint"/>
8772 <parameter name="cancellable"
8773 transfer-ownership="none"
8775 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
8776 <type name="Cancellable" c:type="GCancellable*"/>
8780 <method name="get_cached_property"
8781 c:identifier="g_dbus_proxy_get_cached_property"
8783 <doc xml:whitespace="preserve">Looks up the value for a property from the cache. This call does no
8785 If @proxy has an expected interface (see
8786 #GDBusProxy:g-interface-info), then @property_name (for existence)
8787 is checked against it.
8788 for @property_name or %NULL if the value is not in the cache. The
8789 returned reference must be freed with g_variant_unref().</doc>
8790 <return-value transfer-ownership="full">
8791 <doc xml:whitespace="preserve">A reference to the #GVariant instance that holds the value</doc>
8792 <type name="GLib.Variant" c:type="GVariant*"/>
8795 <parameter name="property_name" transfer-ownership="none">
8796 <doc xml:whitespace="preserve">Property name.</doc>
8797 <type name="utf8" c:type="gchar*"/>
8801 <method name="get_cached_property_names"
8802 c:identifier="g_dbus_proxy_get_cached_property_names"
8805 <doc xml:whitespace="preserve">Gets the names of all cached properties on @proxy.
8806 no cached properties. Free the returned array with g_strfreev().</doc>
8808 <doc xml:whitespace="preserve">A %NULL-terminated array of strings or %NULL if @proxy has</doc>
8809 <array c:type="gchar**">
8814 <method name="get_connection"
8815 c:identifier="g_dbus_proxy_get_connection"
8817 <doc xml:whitespace="preserve">Gets the connection @proxy is for.</doc>
8818 <return-value transfer-ownership="none">
8819 <doc xml:whitespace="preserve">A #GDBusConnection owned by @proxy. Do not free.</doc>
8820 <type name="DBusConnection" c:type="GDBusConnection*"/>
8823 <method name="get_default_timeout"
8824 c:identifier="g_dbus_proxy_get_default_timeout"
8826 <doc xml:whitespace="preserve">Gets the timeout to use if -1 (specifying default timeout) is
8827 passed as @timeout_msec in the g_dbus_proxy_call() and
8828 g_dbus_proxy_call_sync() functions.
8829 See the #GDBusProxy:g-default-timeout property for more details.</doc>
8830 <return-value transfer-ownership="none">
8831 <doc xml:whitespace="preserve">Timeout to use for @proxy.</doc>
8832 <type name="gint" c:type="gint"/>
8835 <method name="get_flags"
8836 c:identifier="g_dbus_proxy_get_flags"
8838 <doc xml:whitespace="preserve">Gets the flags that @proxy was constructed with.</doc>
8839 <return-value transfer-ownership="none">
8840 <doc xml:whitespace="preserve">Flags from the #GDBusProxyFlags enumeration.</doc>
8841 <type name="DBusProxyFlags" c:type="GDBusProxyFlags"/>
8844 <method name="get_interface_info"
8845 c:identifier="g_dbus_proxy_get_interface_info"
8847 <doc xml:whitespace="preserve">Returns the #GDBusInterfaceInfo, if any, specifying the minimal
8848 interface that @proxy conforms to.
8849 See the #GDBusProxy:g-interface-info property for more details.
8850 object, it is owned by @proxy.</doc>
8851 <return-value transfer-ownership="full">
8852 <doc xml:whitespace="preserve">A #GDBusInterfaceInfo or %NULL. Do not unref the returned</doc>
8853 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
8856 <method name="get_interface_name"
8857 c:identifier="g_dbus_proxy_get_interface_name"
8859 <doc xml:whitespace="preserve">Gets the D-Bus interface name @proxy is for.</doc>
8860 <return-value transfer-ownership="none">
8861 <doc xml:whitespace="preserve">A string owned by @proxy. Do not free.</doc>
8862 <type name="utf8" c:type="gchar*"/>
8865 <method name="get_name"
8866 c:identifier="g_dbus_proxy_get_name"
8868 <doc xml:whitespace="preserve">Gets the name that @proxy was constructed for.</doc>
8869 <return-value transfer-ownership="none">
8870 <doc xml:whitespace="preserve">A string owned by @proxy. Do not free.</doc>
8871 <type name="utf8" c:type="gchar*"/>
8874 <method name="get_name_owner"
8875 c:identifier="g_dbus_proxy_get_name_owner"
8877 <doc xml:whitespace="preserve">The unique name that owns the name that @proxy is for or %NULL if
8878 no-one currently owns that name. You may connect to the
8879 #GObject::notify signal to track changes to the
8880 #GDBusProxy:g-name-owner property.</doc>
8881 <return-value transfer-ownership="full">
8882 <doc xml:whitespace="preserve">The name owner or %NULL if no name owner exists. Free with g_free().</doc>
8883 <type name="utf8" c:type="gchar*"/>
8886 <method name="get_object_path"
8887 c:identifier="g_dbus_proxy_get_object_path"
8889 <doc xml:whitespace="preserve">Gets the object path @proxy is for.</doc>
8890 <return-value transfer-ownership="none">
8891 <doc xml:whitespace="preserve">A string owned by @proxy. Do not free.</doc>
8892 <type name="utf8" c:type="gchar*"/>
8895 <method name="set_cached_property"
8896 c:identifier="g_dbus_proxy_set_cached_property"
8898 <doc xml:whitespace="preserve">If @value is not %NULL, sets the cached value for the property with
8899 name @property_name to the value in @value.
8900 If @value is %NULL, then the cached value is removed from the
8902 If @proxy has an expected interface (see
8903 #GDBusProxy:g-interface-info), then @property_name (for existence)
8904 and @value (for the type) is checked against it.
8905 If the @value #GVariant is floating, it is consumed. This allows
8906 convenient 'inline' use of g_variant_new(), e.g.
8908 g_dbus_proxy_set_cached_property (proxy,
8910 g_variant_new ("(si)",
8914 Normally you will not need to use this method since @proxy is
8915 tracking changes using the
8916 <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
8917 D-Bus signal. However, for performance reasons an object may decide
8918 to not use this signal for some properties and instead use a
8919 proprietary out-of-band mechanism to transmit changes.
8920 As a concrete example, consider an object with a property
8921 <literal>ChatroomParticipants</literal> which is an array of
8922 strings. Instead of transmitting the same (long) array every time
8923 the property changes, it is more efficient to only transmit the
8924 delta using e.g. signals <literal>ChatroomParticipantJoined(String
8925 name)</literal> and <literal>ChatroomParticipantParted(String
8926 name)</literal>.</doc>
8927 <return-value transfer-ownership="none">
8928 <type name="none" c:type="void"/>
8931 <parameter name="property_name" transfer-ownership="none">
8932 <doc xml:whitespace="preserve">Property name.</doc>
8933 <type name="utf8" c:type="gchar*"/>
8935 <parameter name="value" transfer-ownership="none">
8936 <doc xml:whitespace="preserve">Value for the property or %NULL to remove it from the cache.</doc>
8937 <type name="GLib.Variant" c:type="GVariant*"/>
8941 <method name="set_default_timeout"
8942 c:identifier="g_dbus_proxy_set_default_timeout"
8944 <doc xml:whitespace="preserve">Sets the timeout to use if -1 (specifying default timeout) is
8945 passed as @timeout_msec in the g_dbus_proxy_call() and
8946 g_dbus_proxy_call_sync() functions.
8947 See the #GDBusProxy:g-default-timeout property for more details.</doc>
8948 <return-value transfer-ownership="none">
8949 <type name="none" c:type="void"/>
8952 <parameter name="timeout_msec" transfer-ownership="none">
8953 <doc xml:whitespace="preserve">Timeout in milliseconds.</doc>
8954 <type name="gint" c:type="gint"/>
8958 <method name="set_interface_info"
8959 c:identifier="g_dbus_proxy_set_interface_info"
8961 <doc xml:whitespace="preserve">Ensure that interactions with @proxy conform to the given
8962 interface. For example, when completing a method call, if the type
8963 signature of the message isn't what's expected, the given #GError
8964 is set. Signals that have a type signature mismatch are simply
8966 See the #GDBusProxy:g-interface-info property for more details.</doc>
8967 <return-value transfer-ownership="none">
8968 <type name="none" c:type="void"/>
8971 <parameter name="info" transfer-ownership="none">
8972 <doc xml:whitespace="preserve">Minimum interface this proxy conforms to or %NULL to unset.</doc>
8973 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo*"/>
8977 <property name="g-bus-type"
8982 transfer-ownership="none">
8983 <doc xml:whitespace="preserve">If this property is not %G_BUS_TYPE_NONE, then
8984 #GDBusProxy:g-connection must be %NULL and will be set to the
8985 #GDBusConnection obtained by calling g_bus_get() with the value
8986 of this property.</doc>
8987 <type name="BusType"/>
8989 <property name="g-connection"
8993 transfer-ownership="none">
8994 <doc xml:whitespace="preserve">The #GDBusConnection the proxy is for.</doc>
8995 <type name="DBusConnection"/>
8997 <property name="g-default-timeout"
9001 transfer-ownership="none">
9002 <doc xml:whitespace="preserve">The timeout to use if -1 (specifying default timeout) is passed
9003 as @timeout_msec in the g_dbus_proxy_call() and
9004 g_dbus_proxy_call_sync() functions.
9005 This allows applications to set a proxy-wide timeout for all
9006 remote method invocations on the proxy. If this property is -1,
9007 the default timeout (typically 25 seconds) is used. If set to
9008 %G_MAXINT, then no timeout is used.</doc>
9011 <property name="g-flags"
9015 transfer-ownership="none">
9016 <doc xml:whitespace="preserve">Flags from the #GDBusProxyFlags enumeration.</doc>
9017 <type name="DBusProxyFlags"/>
9019 <property name="g-interface-info"
9022 transfer-ownership="none">
9023 <doc xml:whitespace="preserve">Ensure that interactions with this proxy conform to the given
9024 interface. For example, when completing a method call, if the
9025 type signature of the message isn't what's expected, the given
9026 #GError is set. Signals that have a type signature mismatch are
9027 simply dropped.</doc>
9028 <type name="DBusInterfaceInfo"/>
9030 <property name="g-interface-name"
9034 transfer-ownership="none">
9035 <doc xml:whitespace="preserve">The D-Bus interface name the proxy is for.</doc>
9038 <property name="g-name"
9042 transfer-ownership="none">
9043 <doc xml:whitespace="preserve">The well-known or unique name that the proxy is for.</doc>
9046 <property name="g-name-owner" version="2.26" transfer-ownership="none">
9047 <doc xml:whitespace="preserve">The unique name that owns #GDBusProxy:name or %NULL if no-one
9048 currently owns that name. You may connect to #GObject::notify signal to
9049 track changes to this property.</doc>
9052 <property name="g-object-path"
9056 transfer-ownership="none">
9057 <doc xml:whitespace="preserve">The object path the proxy is for.</doc>
9060 <field name="parent_instance">
9061 <type name="GObject.Object" c:type="GObject"/>
9064 <type name="DBusProxyPrivate" c:type="GDBusProxyPrivate*"/>
9066 <glib:signal name="g-properties-changed"
9069 <doc xml:whitespace="preserve">Emitted when one or more D-Bus properties on @proxy changes. The
9070 local cache has already been updated when this signal fires. Note
9071 that both @changed_properties and @invalidated_properties are
9072 guaranteed to never be %NULL (either may be empty though).
9073 This signal corresponds to the
9074 <literal>PropertiesChanged</literal> D-Bus signal on the
9075 <literal>org.freedesktop.DBus.Properties</literal> interface.</doc>
9076 <return-value transfer-ownership="none">
9080 <parameter name="object" transfer-ownership="none">
9081 <doc xml:whitespace="preserve">A #GVariant containing the properties that changed</doc>
9082 <type name="GLib.Variant"/>
9084 <parameter name="p0" transfer-ownership="none">
9085 <doc xml:whitespace="preserve">A %NULL terminated array of properties that was invalidated</doc>
9090 <glib:signal name="g-signal" version="2.26">
9091 <doc xml:whitespace="preserve">Emitted when a signal from the remote object and interface that @proxy is for, has been received.</doc>
9092 <return-value transfer-ownership="none">
9096 <parameter name="object" transfer-ownership="none">
9097 <doc xml:whitespace="preserve">The sender of the signal or %NULL if the connection is not a bus connection.</doc>
9100 <parameter name="p0" transfer-ownership="none">
9101 <doc xml:whitespace="preserve">The name of the signal.</doc>
9104 <parameter name="p1" transfer-ownership="none">
9105 <doc xml:whitespace="preserve">A #GVariant tuple with parameters for the signal.</doc>
9106 <type name="GLib.Variant"/>
9111 <record name="DBusProxyClass"
9112 c:type="GDBusProxyClass"
9113 glib:is-gtype-struct-for="DBusProxy"
9115 <doc xml:whitespace="preserve">Class structure for #GDBusProxy.</doc>
9116 <field name="parent_class">
9117 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
9119 <field name="g_properties_changed">
9120 <callback name="g_properties_changed">
9121 <return-value transfer-ownership="none">
9122 <type name="none" c:type="void"/>
9125 <parameter name="proxy" transfer-ownership="none">
9126 <type name="DBusProxy" c:type="GDBusProxy*"/>
9128 <parameter name="changed_properties" transfer-ownership="none">
9129 <type name="GLib.Variant" c:type="GVariant*"/>
9131 <parameter name="invalidated_properties" transfer-ownership="none">
9132 <type name="utf8" c:type="gchar**"/>
9137 <field name="g_signal">
9138 <callback name="g_signal">
9139 <return-value transfer-ownership="none">
9140 <type name="none" c:type="void"/>
9143 <parameter name="proxy" transfer-ownership="none">
9144 <type name="DBusProxy" c:type="GDBusProxy*"/>
9146 <parameter name="sender_name" transfer-ownership="none">
9147 <type name="utf8" c:type="gchar*"/>
9149 <parameter name="signal_name" transfer-ownership="none">
9150 <type name="utf8" c:type="gchar*"/>
9152 <parameter name="parameters" transfer-ownership="none">
9153 <type name="GLib.Variant" c:type="GVariant*"/>
9158 <field name="padding">
9159 <array zero-terminated="0" c:type="gpointer" fixed-size="32">
9160 <type name="gpointer" c:type="gpointer"/>
9164 <bitfield name="DBusProxyFlags"
9166 glib:type-name="GDBusProxyFlags"
9167 glib:get-type="g_dbus_proxy_flags_get_type"
9168 c:type="GDBusProxyFlags">
9169 <doc xml:whitespace="preserve">Flags used when constructing an instance of a #GDBusProxy derived class.</doc>
9172 c:identifier="G_DBUS_PROXY_FLAGS_NONE"
9174 <member name="do_not_load_properties"
9176 c:identifier="G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES"
9177 glib:nick="do-not-load-properties"/>
9178 <member name="do_not_connect_signals"
9180 c:identifier="G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS"
9181 glib:nick="do-not-connect-signals"/>
9182 <member name="do_not_auto_start"
9184 c:identifier="G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START"
9185 glib:nick="do-not-auto-start"/>
9187 <record name="DBusProxyPrivate" c:type="GDBusProxyPrivate" disguised="1">
9189 <bitfield name="DBusSendMessageFlags"
9191 glib:type-name="GDBusSendMessageFlags"
9192 glib:get-type="g_dbus_send_message_flags_get_type"
9193 c:type="GDBusSendMessageFlags">
9194 <doc xml:whitespace="preserve">Flags used when sending #GDBusMessage<!-- -->s on a #GDBusConnection.</doc>
9197 c:identifier="G_DBUS_SEND_MESSAGE_FLAGS_NONE"
9199 <member name="preserve_serial"
9201 c:identifier="G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL"
9202 glib:nick="preserve-serial"/>
9204 <class name="DBusServer"
9205 c:symbol-prefix="dbus_server"
9206 c:type="GDBusServer"
9208 parent="GObject.Object"
9209 glib:type-name="GDBusServer"
9210 glib:get-type="g_dbus_server_get_type">
9211 <doc xml:whitespace="preserve">The #GDBusServer structure contains only private data and
9212 should only be accessed using the provided API.</doc>
9213 <implements name="Initable"/>
9214 <constructor name="new_sync"
9215 c:identifier="g_dbus_server_new_sync"
9218 <doc xml:whitespace="preserve">Creates a new D-Bus server that listens on the first address in
9219 Once constructed, you can use g_dbus_server_get_client_address() to
9220 get a D-Bus address string that clients can use to connect.
9221 Connect to the #GDBusServer::new-connection signal to handle
9222 incoming connections.
9223 The returned #GDBusServer isn't active - you have to start it with
9224 g_dbus_server_start().
9225 See <xref linkend="gdbus-peer-to-peer"/> for how #GDBusServer can
9227 This is a synchronous failable constructor. See
9228 g_dbus_server_new() for the asynchronous version.
9229 g_object_unref().</doc>
9230 <return-value transfer-ownership="full">
9231 <doc xml:whitespace="preserve">A #GDBusServer or %NULL if @error is set. Free with</doc>
9232 <type name="DBusServer" c:type="GDBusServer*"/>
9235 <parameter name="address" transfer-ownership="none">
9236 <doc xml:whitespace="preserve">A D-Bus address.</doc>
9237 <type name="utf8" c:type="gchar*"/>
9239 <parameter name="flags" transfer-ownership="none">
9240 <doc xml:whitespace="preserve">Flags from the #GDBusServerFlags enumeration.</doc>
9241 <type name="DBusServerFlags" c:type="GDBusServerFlags"/>
9243 <parameter name="guid" transfer-ownership="none">
9244 <doc xml:whitespace="preserve">A D-Bus GUID.</doc>
9245 <type name="utf8" c:type="gchar*"/>
9247 <parameter name="observer" transfer-ownership="none">
9248 <doc xml:whitespace="preserve">A #GDBusAuthObserver or %NULL.</doc>
9249 <type name="DBusAuthObserver" c:type="GDBusAuthObserver*"/>
9251 <parameter name="cancellable"
9252 transfer-ownership="none"
9254 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
9255 <type name="Cancellable" c:type="GCancellable*"/>
9259 <method name="get_client_address"
9260 c:identifier="g_dbus_server_get_client_address"
9262 <doc xml:whitespace="preserve">Gets a D-Bus address string that can be used by clients to connect
9265 <return-value transfer-ownership="none">
9266 <doc xml:whitespace="preserve">A D-Bus address string. Do not free, the string is owned</doc>
9267 <type name="utf8" c:type="gchar*"/>
9270 <method name="get_flags"
9271 c:identifier="g_dbus_server_get_flags"
9273 <doc xml:whitespace="preserve">Gets the flags for @server.</doc>
9274 <return-value transfer-ownership="none">
9275 <doc xml:whitespace="preserve">A set of flags from the #GDBusServerFlags enumeration.</doc>
9276 <type name="DBusServerFlags" c:type="GDBusServerFlags"/>
9279 <method name="get_guid"
9280 c:identifier="g_dbus_server_get_guid"
9282 <doc xml:whitespace="preserve">Gets the GUID for @server.</doc>
9283 <return-value transfer-ownership="none">
9284 <doc xml:whitespace="preserve">A D-Bus GUID. Do not free this string, it is owned by @server.</doc>
9285 <type name="utf8" c:type="gchar*"/>
9288 <method name="is_active"
9289 c:identifier="g_dbus_server_is_active"
9291 <doc xml:whitespace="preserve">Gets whether @server is active.</doc>
9292 <return-value transfer-ownership="none">
9293 <doc xml:whitespace="preserve">%TRUE if server is active, %FALSE otherwise.</doc>
9294 <type name="gboolean" c:type="gboolean"/>
9297 <method name="start" c:identifier="g_dbus_server_start" version="2.26">
9298 <doc xml:whitespace="preserve">Starts @server.</doc>
9299 <return-value transfer-ownership="none">
9300 <type name="none" c:type="void"/>
9303 <method name="stop" c:identifier="g_dbus_server_stop" version="2.26">
9304 <doc xml:whitespace="preserve">Stops @server.</doc>
9305 <return-value transfer-ownership="none">
9306 <type name="none" c:type="void"/>
9309 <property name="active" version="2.26" transfer-ownership="none">
9310 <doc xml:whitespace="preserve">Whether the server is currently active.</doc>
9311 <type name="gboolean"/>
9313 <property name="address"
9317 transfer-ownership="none">
9318 <doc xml:whitespace="preserve">The D-Bus address to listen on.</doc>
9321 <property name="authentication-observer"
9325 transfer-ownership="none">
9326 <doc xml:whitespace="preserve">A #GDBusAuthObserver object to assist in the authentication process or %NULL.</doc>
9327 <type name="DBusAuthObserver"/>
9329 <property name="client-address" version="2.26" transfer-ownership="none">
9330 <doc xml:whitespace="preserve">The D-Bus address that clients can use.</doc>
9333 <property name="flags"
9337 transfer-ownership="none">
9338 <doc xml:whitespace="preserve">Flags from the #GDBusServerFlags enumeration.</doc>
9339 <type name="DBusServerFlags"/>
9341 <property name="guid"
9345 transfer-ownership="none">
9346 <doc xml:whitespace="preserve">The guid of the server.</doc>
9349 <glib:signal name="new-connection" version="2.26">
9350 <doc xml:whitespace="preserve">Emitted when a new authenticated connection has been made. Use
9351 g_dbus_connection_get_peer_credentials() to figure out what
9352 identity (if any), was authenticated.
9353 If you want to accept the connection, take a reference to the
9354 connection call g_dbus_connection_close() and give up your
9355 reference. Note that the other peer may disconnect at any time -
9356 a typical thing to do when accepting a connection is to listen to
9357 the #GDBusConnection::closed signal.
9358 If #GDBusServer:flags contains %G_DBUS_SERVER_FLAGS_RUN_IN_THREAD
9359 then the signal is emitted in a new thread dedicated to the
9360 connection. Otherwise the signal is emitted in the <link
9361 linkend="g-main-context-push-thread-default">thread-default main
9362 loop</link> of the thread that @server was constructed in.
9363 You are guaranteed that signal handlers for this signal runs
9364 before incoming messages on @connection are processed. This means
9365 that it's suitable to call g_dbus_connection_register_object() or
9366 similar from the signal handler.
9368 <return-value transfer-ownership="none">
9369 <doc xml:whitespace="preserve">%TRUE to claim @connection, %FALSE to let other handlers</doc>
9370 <type name="gboolean"/>
9373 <parameter name="object" transfer-ownership="none">
9374 <doc xml:whitespace="preserve">A #GDBusConnection for the new connection.</doc>
9375 <type name="DBusConnection"/>
9380 <bitfield name="DBusServerFlags"
9382 glib:type-name="GDBusServerFlags"
9383 glib:get-type="g_dbus_server_flags_get_type"
9384 c:type="GDBusServerFlags">
9385 <doc xml:whitespace="preserve">Flags used when creating a #GDBusServer.</doc>
9388 c:identifier="G_DBUS_SERVER_FLAGS_NONE"
9390 <member name="run_in_thread"
9392 c:identifier="G_DBUS_SERVER_FLAGS_RUN_IN_THREAD"
9393 glib:nick="run-in-thread"/>
9394 <member name="authentication_allow_anonymous"
9396 c:identifier="G_DBUS_SERVER_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS"
9397 glib:nick="authentication-allow-anonymous"/>
9399 <callback name="DBusSignalCallback"
9400 c:type="GDBusSignalCallback"
9402 <doc xml:whitespace="preserve">Signature for callback function used in g_dbus_connection_signal_subscribe().</doc>
9403 <return-value transfer-ownership="none">
9404 <type name="none" c:type="void"/>
9407 <parameter name="connection" transfer-ownership="none">
9408 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
9409 <type name="DBusConnection" c:type="GDBusConnection*"/>
9411 <parameter name="sender_name" transfer-ownership="none">
9412 <doc xml:whitespace="preserve">The unique bus name of the sender of the signal.</doc>
9413 <type name="utf8" c:type="gchar*"/>
9415 <parameter name="object_path" transfer-ownership="none">
9416 <doc xml:whitespace="preserve">The object path that the signal was emitted on.</doc>
9417 <type name="utf8" c:type="gchar*"/>
9419 <parameter name="interface_name" transfer-ownership="none">
9420 <doc xml:whitespace="preserve">The name of the interface.</doc>
9421 <type name="utf8" c:type="gchar*"/>
9423 <parameter name="signal_name" transfer-ownership="none">
9424 <doc xml:whitespace="preserve">The name of the signal.</doc>
9425 <type name="utf8" c:type="gchar*"/>
9427 <parameter name="parameters" transfer-ownership="none">
9428 <doc xml:whitespace="preserve">A #GVariant tuple with parameters for the signal.</doc>
9429 <type name="GLib.Variant" c:type="GVariant*"/>
9431 <parameter name="user_data" transfer-ownership="none" closure="6">
9432 <doc xml:whitespace="preserve">User data passed when subscribing to the signal.</doc>
9433 <type name="gpointer" c:type="gpointer"/>
9437 <bitfield name="DBusSignalFlags"
9439 glib:type-name="GDBusSignalFlags"
9440 glib:get-type="g_dbus_signal_flags_get_type"
9441 c:type="GDBusSignalFlags">
9442 <doc xml:whitespace="preserve">Flags used when subscribing to signals via g_dbus_connection_signal_subscribe().</doc>
9445 c:identifier="G_DBUS_SIGNAL_FLAGS_NONE"
9448 <record name="DBusSignalInfo"
9449 c:type="GDBusSignalInfo"
9451 glib:type-name="GDBusSignalInfo"
9452 glib:get-type="g_dbus_signal_info_get_type"
9453 c:symbol-prefix="dbus_signal_info">
9454 <doc xml:whitespace="preserve">Information about a signal on a D-Bus interface.</doc>
9455 <field name="ref_count" writable="1">
9456 <type name="gint" c:type="gint"/>
9458 <field name="name" writable="1">
9459 <type name="utf8" c:type="gchar*"/>
9461 <field name="args" writable="1">
9462 <type name="DBusArgInfo" c:type="GDBusArgInfo**"/>
9464 <field name="annotations" writable="1">
9465 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
9467 <method name="ref" c:identifier="g_dbus_signal_info_ref" version="2.26">
9468 <doc xml:whitespace="preserve">If @info is statically allocated does nothing. Otherwise increases
9469 the reference count.</doc>
9470 <return-value transfer-ownership="full">
9471 <doc xml:whitespace="preserve">The same @info.</doc>
9472 <type name="DBusSignalInfo" c:type="GDBusSignalInfo*"/>
9475 <method name="unref"
9476 c:identifier="g_dbus_signal_info_unref"
9478 <doc xml:whitespace="preserve">If @info is statically allocated, does nothing. Otherwise decreases
9479 the reference count of @info. When its reference count drops to 0,
9480 the memory used is freed.</doc>
9481 <return-value transfer-ownership="none">
9482 <type name="none" c:type="void"/>
9486 <callback name="DBusSubtreeDispatchFunc"
9487 c:type="GDBusSubtreeDispatchFunc"
9489 <doc xml:whitespace="preserve">The type of the @dispatch function in #GDBusSubtreeVTable.
9490 Subtrees are flat. @node, if non-%NULL, is always exactly one</doc>
9491 <return-value transfer-ownership="none">
9492 <doc xml:whitespace="preserve">A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods.</doc>
9493 <type name="DBusInterfaceVTable" c:type="GDBusInterfaceVTable*"/>
9496 <parameter name="connection" transfer-ownership="none">
9497 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
9498 <type name="DBusConnection" c:type="GDBusConnection*"/>
9500 <parameter name="sender" transfer-ownership="none">
9501 <doc xml:whitespace="preserve">The unique bus name of the remote caller.</doc>
9502 <type name="utf8" c:type="gchar*"/>
9504 <parameter name="object_path" transfer-ownership="none">
9505 <doc xml:whitespace="preserve">The object path that was registered with g_dbus_connection_register_subtree().</doc>
9506 <type name="utf8" c:type="gchar*"/>
9508 <parameter name="interface_name" transfer-ownership="none">
9509 <doc xml:whitespace="preserve">The D-Bus interface name that the method call or property access is for.</doc>
9510 <type name="utf8" c:type="gchar*"/>
9512 <parameter name="node" transfer-ownership="none">
9513 <doc xml:whitespace="preserve">A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree.</doc>
9514 <type name="utf8" c:type="gchar*"/>
9516 <parameter name="out_user_data" transfer-ownership="none">
9517 <doc xml:whitespace="preserve">Return location for user data to pass to functions in the returned #GDBusInterfaceVTable (never %NULL).</doc>
9518 <type name="gpointer" c:type="gpointer*"/>
9520 <parameter name="user_data" transfer-ownership="none" closure="6">
9521 <doc xml:whitespace="preserve">The @user_data #gpointer passed to g_dbus_connection_register_subtree().</doc>
9522 <type name="gpointer" c:type="gpointer"/>
9526 <callback name="DBusSubtreeEnumerateFunc"
9527 c:type="GDBusSubtreeEnumerateFunc"
9530 <doc xml:whitespace="preserve">The type of the @enumerate function in #GDBusSubtreeVTable.
9531 This function is called when generating introspection data and also
9532 when preparing to dispatch incoming messages in the event that the
9533 %G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is not
9534 Hierarchies are not supported; the items that you return should not
9535 contain the '/' character.
9536 The return value will be freed with g_strfreev().</doc>
9538 <doc xml:whitespace="preserve">A newly allocated array of strings for node names that are children of @object_path.</doc>
9539 <array c:type="gchar**">
9544 <parameter name="connection" transfer-ownership="none">
9545 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
9546 <type name="DBusConnection" c:type="GDBusConnection*"/>
9548 <parameter name="sender" transfer-ownership="none">
9549 <doc xml:whitespace="preserve">The unique bus name of the remote caller.</doc>
9550 <type name="utf8" c:type="gchar*"/>
9552 <parameter name="object_path" transfer-ownership="none">
9553 <doc xml:whitespace="preserve">The object path that was registered with g_dbus_connection_register_subtree().</doc>
9554 <type name="utf8" c:type="gchar*"/>
9556 <parameter name="user_data" transfer-ownership="none" closure="3">
9557 <doc xml:whitespace="preserve">The @user_data #gpointer passed to g_dbus_connection_register_subtree().</doc>
9558 <type name="gpointer" c:type="gpointer"/>
9562 <bitfield name="DBusSubtreeFlags"
9564 glib:type-name="GDBusSubtreeFlags"
9565 glib:get-type="g_dbus_subtree_flags_get_type"
9566 c:type="GDBusSubtreeFlags">
9567 <doc xml:whitespace="preserve">Flags passed to g_dbus_connection_register_subtree().</doc>
9570 c:identifier="G_DBUS_SUBTREE_FLAGS_NONE"
9572 <member name="dispatch_to_unenumerated_nodes"
9574 c:identifier="G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES"
9575 glib:nick="dispatch-to-unenumerated-nodes"/>
9577 <callback name="DBusSubtreeIntrospectFunc"
9578 c:type="GDBusSubtreeIntrospectFunc"
9580 <doc xml:whitespace="preserve">The type of the @introspect function in #GDBusSubtreeVTable.
9581 Subtrees are flat. @node, if non-%NULL, is always exactly one
9582 This function should return %NULL to indicate that there is no object
9584 If this function returns non-%NULL, the return value is expected to
9585 be a %NULL-terminated array of pointers to #GDBusInterfaceInfo
9586 structures describing the interfaces implemented by @node. This
9587 array will have g_dbus_interface_info_unref() called on each item
9588 before being freed with g_free().
9589 The difference between returning %NULL and an array containing zero
9590 items is that the standard DBus interfaces will returned to the
9591 remote introspector in the empty array case, but not in the %NULL
9593 <return-value transfer-ownership="full">
9594 <doc xml:whitespace="preserve">A %NULL-terminated array of pointers to #GDBusInterfaceInfo, or %NULL.</doc>
9595 <type name="DBusInterfaceInfo" c:type="GDBusInterfaceInfo**"/>
9598 <parameter name="connection" transfer-ownership="none">
9599 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
9600 <type name="DBusConnection" c:type="GDBusConnection*"/>
9602 <parameter name="sender" transfer-ownership="none">
9603 <doc xml:whitespace="preserve">The unique bus name of the remote caller.</doc>
9604 <type name="utf8" c:type="gchar*"/>
9606 <parameter name="object_path" transfer-ownership="none">
9607 <doc xml:whitespace="preserve">The object path that was registered with g_dbus_connection_register_subtree().</doc>
9608 <type name="utf8" c:type="gchar*"/>
9610 <parameter name="node" transfer-ownership="none">
9611 <doc xml:whitespace="preserve">A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree.</doc>
9612 <type name="utf8" c:type="gchar*"/>
9614 <parameter name="user_data" transfer-ownership="none" closure="4">
9615 <doc xml:whitespace="preserve">The @user_data #gpointer passed to g_dbus_connection_register_subtree().</doc>
9616 <type name="gpointer" c:type="gpointer"/>
9620 <record name="DBusSubtreeVTable"
9621 c:type="GDBusSubtreeVTable"
9623 <doc xml:whitespace="preserve">Virtual table for handling subtrees registered with g_dbus_connection_register_subtree().</doc>
9624 <field name="enumerate" introspectable="0" writable="1">
9625 <type name="DBusSubtreeEnumerateFunc"
9626 c:type="GDBusSubtreeEnumerateFunc"/>
9628 <field name="introspect" writable="1">
9629 <type name="DBusSubtreeIntrospectFunc"
9630 c:type="GDBusSubtreeIntrospectFunc"/>
9632 <field name="dispatch" writable="1">
9633 <type name="DBusSubtreeDispatchFunc"
9634 c:type="GDBusSubtreeDispatchFunc"/>
9636 <field name="padding" writable="1">
9637 <array zero-terminated="0" c:type="gpointer" fixed-size="8">
9638 <type name="gpointer" c:type="gpointer"/>
9642 <constant name="DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME"
9643 value="gio-desktop-app-info-lookup">
9644 <type name="utf8" c:type="gchar*"/>
9646 <class name="DataInputStream"
9647 c:symbol-prefix="data_input_stream"
9648 c:type="GDataInputStream"
9649 parent="BufferedInputStream"
9650 glib:type-name="GDataInputStream"
9651 glib:get-type="g_data_input_stream_get_type"
9652 glib:type-struct="DataInputStreamClass">
9653 <doc xml:whitespace="preserve">An implementation of #GBufferedInputStream that allows for high-level
9654 data manipulation of arbitrary data (including binary operations).</doc>
9655 <constructor name="new" c:identifier="g_data_input_stream_new">
9656 <doc xml:whitespace="preserve">Creates a new data input stream for the @base_stream.</doc>
9657 <return-value transfer-ownership="full">
9658 <doc xml:whitespace="preserve">a new #GDataInputStream.</doc>
9659 <type name="DataInputStream" c:type="GDataInputStream*"/>
9662 <parameter name="base_stream" transfer-ownership="none">
9663 <doc xml:whitespace="preserve">a #GInputStream.</doc>
9664 <type name="InputStream" c:type="GInputStream*"/>
9668 <method name="get_byte_order"
9669 c:identifier="g_data_input_stream_get_byte_order">
9670 <doc xml:whitespace="preserve">Gets the byte order for the data input stream.</doc>
9671 <return-value transfer-ownership="none">
9672 <doc xml:whitespace="preserve">the @stream's current #GDataStreamByteOrder.</doc>
9673 <type name="DataStreamByteOrder" c:type="GDataStreamByteOrder"/>
9676 <method name="get_newline_type"
9677 c:identifier="g_data_input_stream_get_newline_type">
9678 <doc xml:whitespace="preserve">Gets the current newline type for the @stream.</doc>
9679 <return-value transfer-ownership="none">
9680 <doc xml:whitespace="preserve">#GDataStreamNewlineType for the given @stream.</doc>
9681 <type name="DataStreamNewlineType" c:type="GDataStreamNewlineType"/>
9684 <method name="read_byte"
9685 c:identifier="g_data_input_stream_read_byte"
9687 <doc xml:whitespace="preserve">Reads an unsigned 8-bit/1-byte value from @stream.
9688 if an error occurred.</doc>
9689 <return-value transfer-ownership="none">
9690 <doc xml:whitespace="preserve">an unsigned 8-bit/1-byte value read from the @stream or %0</doc>
9691 <type name="guint8" c:type="guchar"/>
9694 <parameter name="cancellable"
9695 transfer-ownership="none"
9697 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9698 <type name="Cancellable" c:type="GCancellable*"/>
9702 <method name="read_int16"
9703 c:identifier="g_data_input_stream_read_int16"
9705 <doc xml:whitespace="preserve">Reads a 16-bit/2-byte value from @stream.
9706 In order to get the correct byte order for this read operation,
9707 see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
9708 an error occurred.</doc>
9709 <return-value transfer-ownership="none">
9710 <doc xml:whitespace="preserve">a signed 16-bit/2-byte value read from @stream or %0 if</doc>
9711 <type name="gint16" c:type="gint16"/>
9714 <parameter name="cancellable"
9715 transfer-ownership="none"
9717 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9718 <type name="Cancellable" c:type="GCancellable*"/>
9722 <method name="read_int32"
9723 c:identifier="g_data_input_stream_read_int32"
9725 <doc xml:whitespace="preserve">Reads a signed 32-bit/4-byte value from @stream.
9726 In order to get the correct byte order for this read operation,
9727 see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
9728 If @cancellable is not %NULL, then the operation can be cancelled by
9729 triggering the cancellable object from another thread. If the operation
9730 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
9731 an error occurred.</doc>
9732 <return-value transfer-ownership="none">
9733 <doc xml:whitespace="preserve">a signed 32-bit/4-byte value read from the @stream or %0 if</doc>
9734 <type name="gint32" c:type="gint32"/>
9737 <parameter name="cancellable"
9738 transfer-ownership="none"
9740 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9741 <type name="Cancellable" c:type="GCancellable*"/>
9745 <method name="read_int64"
9746 c:identifier="g_data_input_stream_read_int64"
9748 <doc xml:whitespace="preserve">Reads a 64-bit/8-byte value from @stream.
9749 In order to get the correct byte order for this read operation,
9750 see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
9751 If @cancellable is not %NULL, then the operation can be cancelled by
9752 triggering the cancellable object from another thread. If the operation
9753 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
9754 an error occurred.</doc>
9755 <return-value transfer-ownership="none">
9756 <doc xml:whitespace="preserve">a signed 64-bit/8-byte value read from @stream or %0 if</doc>
9757 <type name="gint64" c:type="gint64"/>
9760 <parameter name="cancellable"
9761 transfer-ownership="none"
9763 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9764 <type name="Cancellable" c:type="GCancellable*"/>
9768 <method name="read_line"
9769 c:identifier="g_data_input_stream_read_line"
9771 <doc xml:whitespace="preserve">Reads a line from the data input stream.
9772 If @cancellable is not %NULL, then the operation can be cancelled by
9773 triggering the cancellable object from another thread. If the operation
9774 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
9775 Set @length to a #gsize to get the length of the read line.
9776 On an error, it will return %NULL and @error will be set. If there's no
9777 content to read, it will still return %NULL, but @error won't be set.</doc>
9778 <return-value transfer-ownership="full">
9779 <doc xml:whitespace="preserve">a string with the line that was read in (without the newlines).</doc>
9780 <type name="utf8" c:type="char*"/>
9783 <parameter name="length" transfer-ownership="none">
9784 <doc xml:whitespace="preserve">a #gsize to get the length of the data read in.</doc>
9785 <type name="gulong" c:type="gsize*"/>
9787 <parameter name="cancellable"
9788 transfer-ownership="none"
9790 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9791 <type name="Cancellable" c:type="GCancellable*"/>
9795 <method name="read_line_async"
9796 c:identifier="g_data_input_stream_read_line_async"
9798 <doc xml:whitespace="preserve">The asynchronous version of g_data_input_stream_read_line(). It is
9799 an error to have two outstanding calls to this function.
9800 When the operation is finished, @callback will be called. You
9801 can then call g_data_input_stream_read_line_finish() to get
9802 the result of the operation.</doc>
9803 <return-value transfer-ownership="none">
9804 <type name="none" c:type="void"/>
9807 <parameter name="io_priority" transfer-ownership="none">
9808 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
9809 <type name="gint" c:type="gint"/>
9811 <parameter name="cancellable"
9812 transfer-ownership="none"
9814 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9815 <type name="Cancellable" c:type="GCancellable*"/>
9817 <parameter name="callback"
9818 transfer-ownership="none"
9821 <doc xml:whitespace="preserve">callback to call when the request is satisfied.</doc>
9822 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
9824 <parameter name="user_data" transfer-ownership="none">
9825 <doc xml:whitespace="preserve">the data to pass to callback function.</doc>
9826 <type name="gpointer" c:type="gpointer"/>
9830 <method name="read_line_finish"
9831 c:identifier="g_data_input_stream_read_line_finish"
9834 <doc xml:whitespace="preserve">Finish an asynchronous call started by
9835 g_data_input_stream_read_line_async().
9836 Set @length to a #gsize to get the length of the read line.
9837 On an error, it will return %NULL and @error will be set. If there's no
9838 content to read, it will still return %NULL, but @error won't be set.</doc>
9839 <return-value transfer-ownership="full">
9840 <doc xml:whitespace="preserve">a string with the line that was read in (without the newlines).</doc>
9841 <type name="utf8" c:type="char*"/>
9844 <parameter name="result" transfer-ownership="none">
9845 <doc xml:whitespace="preserve">the #GAsyncResult that was provided to the callback.</doc>
9846 <type name="AsyncResult" c:type="GAsyncResult*"/>
9848 <parameter name="length" transfer-ownership="none">
9849 <doc xml:whitespace="preserve">a #gsize to get the length of the data read in.</doc>
9850 <type name="gulong" c:type="gsize*"/>
9854 <method name="read_uint16"
9855 c:identifier="g_data_input_stream_read_uint16"
9857 <doc xml:whitespace="preserve">Reads an unsigned 16-bit/2-byte value from @stream.
9858 In order to get the correct byte order for this read operation,
9859 see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
9860 an error occurred.</doc>
9861 <return-value transfer-ownership="none">
9862 <doc xml:whitespace="preserve">an unsigned 16-bit/2-byte value read from the @stream or %0 if</doc>
9863 <type name="guint16" c:type="guint16"/>
9866 <parameter name="cancellable"
9867 transfer-ownership="none"
9869 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9870 <type name="Cancellable" c:type="GCancellable*"/>
9874 <method name="read_uint32"
9875 c:identifier="g_data_input_stream_read_uint32"
9877 <doc xml:whitespace="preserve">Reads an unsigned 32-bit/4-byte value from @stream.
9878 In order to get the correct byte order for this read operation,
9879 see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
9880 If @cancellable is not %NULL, then the operation can be cancelled by
9881 triggering the cancellable object from another thread. If the operation
9882 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
9883 an error occurred.</doc>
9884 <return-value transfer-ownership="none">
9885 <doc xml:whitespace="preserve">an unsigned 32-bit/4-byte value read from the @stream or %0 if</doc>
9886 <type name="guint32" c:type="guint32"/>
9889 <parameter name="cancellable"
9890 transfer-ownership="none"
9892 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9893 <type name="Cancellable" c:type="GCancellable*"/>
9897 <method name="read_uint64"
9898 c:identifier="g_data_input_stream_read_uint64"
9900 <doc xml:whitespace="preserve">Reads an unsigned 64-bit/8-byte value from @stream.
9901 In order to get the correct byte order for this read operation,
9902 see g_data_input_stream_get_byte_order().
9903 If @cancellable is not %NULL, then the operation can be cancelled by
9904 triggering the cancellable object from another thread. If the operation
9905 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
9906 an error occurred.</doc>
9907 <return-value transfer-ownership="none">
9908 <doc xml:whitespace="preserve">an unsigned 64-bit/8-byte read from @stream or %0 if</doc>
9909 <type name="guint64" c:type="guint64"/>
9912 <parameter name="cancellable"
9913 transfer-ownership="none"
9915 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9916 <type name="Cancellable" c:type="GCancellable*"/>
9920 <method name="read_until"
9921 c:identifier="g_data_input_stream_read_until"
9923 <doc xml:whitespace="preserve">Reads a string from the data input stream, up to the first
9924 occurrence of any of the stop characters.
9925 Note that, in contrast to g_data_input_stream_read_until_async(),
9926 this function consumes the stop character that it finds.
9927 Don't use this function in new code. Its functionality is
9928 inconsistent with g_data_input_stream_read_until_async(). Both
9929 functions will be marked as deprecated in a future release. Use
9930 g_data_input_stream_read_upto() instead, but note that that function
9931 does not consume the stop character.
9932 any of the stop characters. Set @length to a #gsize to get the length
9933 of the string. This function will return %NULL on an error.</doc>
9934 <return-value transfer-ownership="full">
9935 <doc xml:whitespace="preserve">a string with the data that was read before encountering</doc>
9936 <type name="utf8" c:type="char*"/>
9939 <parameter name="stop_chars" transfer-ownership="none">
9940 <doc xml:whitespace="preserve">characters to terminate the read.</doc>
9941 <type name="utf8" c:type="gchar*"/>
9943 <parameter name="length" transfer-ownership="none">
9944 <doc xml:whitespace="preserve">a #gsize to get the length of the data read in.</doc>
9945 <type name="gulong" c:type="gsize*"/>
9947 <parameter name="cancellable"
9948 transfer-ownership="none"
9950 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9951 <type name="Cancellable" c:type="GCancellable*"/>
9955 <method name="read_until_async"
9956 c:identifier="g_data_input_stream_read_until_async"
9958 <doc xml:whitespace="preserve">The asynchronous version of g_data_input_stream_read_until().
9959 It is an error to have two outstanding calls to this function.
9960 Note that, in contrast to g_data_input_stream_read_until(),
9961 this function does not consume the stop character that it finds. You
9962 must read it for yourself.
9963 When the operation is finished, @callback will be called. You
9964 can then call g_data_input_stream_read_until_finish() to get
9965 the result of the operation.
9966 Don't use this function in new code. Its functionality is
9967 inconsistent with g_data_input_stream_read_until(). Both functions
9968 will be marked as deprecated in a future release. Use
9969 g_data_input_stream_read_upto_async() instead.</doc>
9970 <return-value transfer-ownership="none">
9971 <type name="none" c:type="void"/>
9974 <parameter name="stop_chars" transfer-ownership="none">
9975 <doc xml:whitespace="preserve">characters to terminate the read.</doc>
9976 <type name="utf8" c:type="gchar*"/>
9978 <parameter name="io_priority" transfer-ownership="none">
9979 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
9980 <type name="gint" c:type="gint"/>
9982 <parameter name="cancellable"
9983 transfer-ownership="none"
9985 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
9986 <type name="Cancellable" c:type="GCancellable*"/>
9988 <parameter name="callback"
9989 transfer-ownership="none"
9992 <doc xml:whitespace="preserve">callback to call when the request is satisfied.</doc>
9993 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
9995 <parameter name="user_data" transfer-ownership="none">
9996 <doc xml:whitespace="preserve">the data to pass to callback function.</doc>
9997 <type name="gpointer" c:type="gpointer"/>
10001 <method name="read_until_finish"
10002 c:identifier="g_data_input_stream_read_until_finish"
10005 <doc xml:whitespace="preserve">Finish an asynchronous call started by
10006 g_data_input_stream_read_until_async().
10007 any of the stop characters. Set @length to a #gsize to get the length
10008 of the string. This function will return %NULL on an error.</doc>
10009 <return-value transfer-ownership="full">
10010 <doc xml:whitespace="preserve">a string with the data that was read before encountering</doc>
10011 <type name="utf8" c:type="char*"/>
10014 <parameter name="result" transfer-ownership="none">
10015 <doc xml:whitespace="preserve">the #GAsyncResult that was provided to the callback.</doc>
10016 <type name="AsyncResult" c:type="GAsyncResult*"/>
10018 <parameter name="length" transfer-ownership="none">
10019 <doc xml:whitespace="preserve">a #gsize to get the length of the data read in.</doc>
10020 <type name="gulong" c:type="gsize*"/>
10024 <method name="read_upto"
10025 c:identifier="g_data_input_stream_read_upto"
10028 <doc xml:whitespace="preserve">Reads a string from the data input stream, up to the first
10029 occurrence of any of the stop characters.
10030 In contrast to g_data_input_stream_read_until(), this function
10031 does <emphasis>not</emphasis> consume the stop character. You have
10032 to use g_data_input_stream_read_byte() to get it before calling
10033 g_data_input_stream_read_upto() again.
10034 Note that @stop_chars may contain '\0' if @stop_chars_len is
10036 any of the stop characters. Set @length to a #gsize to get the length
10037 of the string. This function will return %NULL on an error</doc>
10038 <return-value transfer-ownership="full">
10039 <doc xml:whitespace="preserve">a string with the data that was read before encountering</doc>
10040 <type name="utf8" c:type="char*"/>
10043 <parameter name="stop_chars" transfer-ownership="none">
10044 <doc xml:whitespace="preserve">characters to terminate the read</doc>
10045 <type name="utf8" c:type="gchar*"/>
10047 <parameter name="stop_chars_len" transfer-ownership="none">
10048 <doc xml:whitespace="preserve">length of @stop_chars. May be -1 if @stop_chars is nul-terminated</doc>
10049 <type name="glong" c:type="gssize"/>
10051 <parameter name="length" transfer-ownership="none">
10052 <doc xml:whitespace="preserve">a #gsize to get the length of the data read in</doc>
10053 <type name="gulong" c:type="gsize*"/>
10055 <parameter name="cancellable"
10056 transfer-ownership="none"
10058 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
10059 <type name="Cancellable" c:type="GCancellable*"/>
10063 <method name="read_upto_async"
10064 c:identifier="g_data_input_stream_read_upto_async"
10066 <doc xml:whitespace="preserve">The asynchronous version of g_data_input_stream_read_upto().
10067 It is an error to have two outstanding calls to this function.
10068 In contrast to g_data_input_stream_read_until(), this function
10069 does <emphasis>not</emphasis> consume the stop character. You have
10070 to use g_data_input_stream_read_byte() to get it before calling
10071 g_data_input_stream_read_upto() again.
10072 Note that @stop_chars may contain '\0' if @stop_chars_len is
10074 When the operation is finished, @callback will be called. You
10075 can then call g_data_input_stream_read_upto_finish() to get
10076 the result of the operation.</doc>
10077 <return-value transfer-ownership="none">
10078 <type name="none" c:type="void"/>
10081 <parameter name="stop_chars" transfer-ownership="none">
10082 <doc xml:whitespace="preserve">characters to terminate the read</doc>
10083 <type name="utf8" c:type="gchar*"/>
10085 <parameter name="stop_chars_len" transfer-ownership="none">
10086 <doc xml:whitespace="preserve">length of @stop_chars. May be -1 if @stop_chars is nul-terminated</doc>
10087 <type name="glong" c:type="gssize"/>
10089 <parameter name="io_priority" transfer-ownership="none">
10090 <type name="gint" c:type="gint"/>
10092 <parameter name="cancellable"
10093 transfer-ownership="none"
10095 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
10096 <type name="Cancellable" c:type="GCancellable*"/>
10098 <parameter name="callback"
10099 transfer-ownership="none"
10102 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
10103 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
10105 <parameter name="user_data" transfer-ownership="none">
10106 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
10107 <type name="gpointer" c:type="gpointer"/>
10111 <method name="read_upto_finish"
10112 c:identifier="g_data_input_stream_read_upto_finish"
10115 <doc xml:whitespace="preserve">Finish an asynchronous call started by
10116 g_data_input_stream_read_upto_async().
10117 Note that this function does <emphasis>not</emphasis> consume the
10118 stop character. You have to use g_data_input_stream_read_byte() to
10119 get it before calling g_data_input_stream_read_upto_async() again.
10120 any of the stop characters. Set @length to a #gsize to get the length
10121 of the string. This function will return %NULL on an error.</doc>
10122 <return-value transfer-ownership="full">
10123 <doc xml:whitespace="preserve">a string with the data that was read before encountering</doc>
10124 <type name="utf8" c:type="char*"/>
10127 <parameter name="result" transfer-ownership="none">
10128 <doc xml:whitespace="preserve">the #GAsyncResult that was provided to the callback</doc>
10129 <type name="AsyncResult" c:type="GAsyncResult*"/>
10131 <parameter name="length" transfer-ownership="none">
10132 <doc xml:whitespace="preserve">a #gsize to get the length of the data read in</doc>
10133 <type name="gulong" c:type="gsize*"/>
10137 <method name="set_byte_order"
10138 c:identifier="g_data_input_stream_set_byte_order">
10139 <doc xml:whitespace="preserve">This function sets the byte order for the given @stream. All subsequent
10140 reads from the @stream will be read in the given @order.</doc>
10141 <return-value transfer-ownership="none">
10142 <type name="none" c:type="void"/>
10145 <parameter name="order" transfer-ownership="none">
10146 <doc xml:whitespace="preserve">a #GDataStreamByteOrder to set.</doc>
10147 <type name="DataStreamByteOrder" c:type="GDataStreamByteOrder"/>
10151 <method name="set_newline_type"
10152 c:identifier="g_data_input_stream_set_newline_type">
10153 <doc xml:whitespace="preserve">Sets the newline type for the @stream.
10154 Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read
10155 chunk ends in "CR" we must read an additional byte to know if this is "CR" or
10156 "CR LF", and this might block if there is no more data availible.</doc>
10157 <return-value transfer-ownership="none">
10158 <type name="none" c:type="void"/>
10161 <parameter name="type" transfer-ownership="none">
10162 <doc xml:whitespace="preserve">the type of new line return as #GDataStreamNewlineType.</doc>
10163 <type name="DataStreamNewlineType"
10164 c:type="GDataStreamNewlineType"/>
10168 <property name="byte-order" writable="1" transfer-ownership="none">
10169 <type name="DataStreamByteOrder"/>
10171 <property name="newline-type" writable="1" transfer-ownership="none">
10172 <type name="DataStreamNewlineType"/>
10174 <field name="parent_instance">
10175 <type name="BufferedInputStream" c:type="GBufferedInputStream"/>
10177 <field name="priv">
10178 <type name="DataInputStreamPrivate" c:type="GDataInputStreamPrivate*"/>
10181 <record name="DataInputStreamClass"
10182 c:type="GDataInputStreamClass"
10183 glib:is-gtype-struct-for="DataInputStream">
10184 <field name="parent_class">
10185 <type name="BufferedInputStreamClass"
10186 c:type="GBufferedInputStreamClass"/>
10188 <field name="_g_reserved1" introspectable="0">
10189 <callback name="_g_reserved1">
10190 <return-value transfer-ownership="none">
10191 <type name="none" c:type="void"/>
10195 <field name="_g_reserved2" introspectable="0">
10196 <callback name="_g_reserved2">
10197 <return-value transfer-ownership="none">
10198 <type name="none" c:type="void"/>
10202 <field name="_g_reserved3" introspectable="0">
10203 <callback name="_g_reserved3">
10204 <return-value transfer-ownership="none">
10205 <type name="none" c:type="void"/>
10209 <field name="_g_reserved4" introspectable="0">
10210 <callback name="_g_reserved4">
10211 <return-value transfer-ownership="none">
10212 <type name="none" c:type="void"/>
10216 <field name="_g_reserved5" introspectable="0">
10217 <callback name="_g_reserved5">
10218 <return-value transfer-ownership="none">
10219 <type name="none" c:type="void"/>
10224 <record name="DataInputStreamPrivate"
10225 c:type="GDataInputStreamPrivate"
10228 <class name="DataOutputStream"
10229 c:symbol-prefix="data_output_stream"
10230 c:type="GDataOutputStream"
10231 parent="FilterOutputStream"
10232 glib:type-name="GDataOutputStream"
10233 glib:get-type="g_data_output_stream_get_type"
10234 glib:type-struct="DataOutputStreamClass">
10235 <doc xml:whitespace="preserve">An implementation of #GBufferedOutputStream that allows for high-level
10236 data manipulation of arbitrary data (including binary operations).</doc>
10237 <constructor name="new" c:identifier="g_data_output_stream_new">
10238 <doc xml:whitespace="preserve">Creates a new data output stream for @base_stream.</doc>
10239 <return-value transfer-ownership="full">
10240 <doc xml:whitespace="preserve">#GDataOutputStream.</doc>
10241 <type name="DataOutputStream" c:type="GDataOutputStream*"/>
10244 <parameter name="base_stream" transfer-ownership="none">
10245 <doc xml:whitespace="preserve">a #GOutputStream.</doc>
10246 <type name="OutputStream" c:type="GOutputStream*"/>
10250 <method name="get_byte_order"
10251 c:identifier="g_data_output_stream_get_byte_order">
10252 <doc xml:whitespace="preserve">Gets the byte order for the stream.</doc>
10253 <return-value transfer-ownership="none">
10254 <doc xml:whitespace="preserve">the #GDataStreamByteOrder for the @stream.</doc>
10255 <type name="DataStreamByteOrder" c:type="GDataStreamByteOrder"/>
10258 <method name="put_byte"
10259 c:identifier="g_data_output_stream_put_byte"
10261 <doc xml:whitespace="preserve">Puts a byte into the output stream.</doc>
10262 <return-value transfer-ownership="none">
10263 <doc xml:whitespace="preserve">%TRUE if @data was successfully added to the @stream.</doc>
10264 <type name="gboolean" c:type="gboolean"/>
10267 <parameter name="data" transfer-ownership="none">
10268 <doc xml:whitespace="preserve">a #guchar.</doc>
10269 <type name="guint8" c:type="guchar"/>
10271 <parameter name="cancellable"
10272 transfer-ownership="none"
10274 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10275 <type name="Cancellable" c:type="GCancellable*"/>
10279 <method name="put_int16"
10280 c:identifier="g_data_output_stream_put_int16"
10282 <doc xml:whitespace="preserve">Puts a signed 16-bit integer into the output stream.</doc>
10283 <return-value transfer-ownership="none">
10284 <doc xml:whitespace="preserve">%TRUE if @data was successfully added to the @stream.</doc>
10285 <type name="gboolean" c:type="gboolean"/>
10288 <parameter name="data" transfer-ownership="none">
10289 <doc xml:whitespace="preserve">a #gint16.</doc>
10290 <type name="gint16" c:type="gint16"/>
10292 <parameter name="cancellable"
10293 transfer-ownership="none"
10295 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10296 <type name="Cancellable" c:type="GCancellable*"/>
10300 <method name="put_int32"
10301 c:identifier="g_data_output_stream_put_int32"
10303 <doc xml:whitespace="preserve">Puts a signed 32-bit integer into the output stream.</doc>
10304 <return-value transfer-ownership="none">
10305 <doc xml:whitespace="preserve">%TRUE if @data was successfully added to the @stream.</doc>
10306 <type name="gboolean" c:type="gboolean"/>
10309 <parameter name="data" transfer-ownership="none">
10310 <doc xml:whitespace="preserve">a #gint32.</doc>
10311 <type name="gint32" c:type="gint32"/>
10313 <parameter name="cancellable"
10314 transfer-ownership="none"
10316 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10317 <type name="Cancellable" c:type="GCancellable*"/>
10321 <method name="put_int64"
10322 c:identifier="g_data_output_stream_put_int64"
10324 <doc xml:whitespace="preserve">Puts a signed 64-bit integer into the stream.</doc>
10325 <return-value transfer-ownership="none">
10326 <doc xml:whitespace="preserve">%TRUE if @data was successfully added to the @stream.</doc>
10327 <type name="gboolean" c:type="gboolean"/>
10330 <parameter name="data" transfer-ownership="none">
10331 <doc xml:whitespace="preserve">a #gint64.</doc>
10332 <type name="gint64" c:type="gint64"/>
10334 <parameter name="cancellable"
10335 transfer-ownership="none"
10337 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10338 <type name="Cancellable" c:type="GCancellable*"/>
10342 <method name="put_string"
10343 c:identifier="g_data_output_stream_put_string"
10345 <doc xml:whitespace="preserve">Puts a string into the output stream.</doc>
10346 <return-value transfer-ownership="none">
10347 <doc xml:whitespace="preserve">%TRUE if @string was successfully added to the @stream.</doc>
10348 <type name="gboolean" c:type="gboolean"/>
10351 <parameter name="str" transfer-ownership="none">
10352 <doc xml:whitespace="preserve">a string.</doc>
10353 <type name="utf8" c:type="char*"/>
10355 <parameter name="cancellable"
10356 transfer-ownership="none"
10358 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10359 <type name="Cancellable" c:type="GCancellable*"/>
10363 <method name="put_uint16"
10364 c:identifier="g_data_output_stream_put_uint16"
10366 <doc xml:whitespace="preserve">Puts an unsigned 16-bit integer into the output stream.</doc>
10367 <return-value transfer-ownership="none">
10368 <doc xml:whitespace="preserve">%TRUE if @data was successfully added to the @stream.</doc>
10369 <type name="gboolean" c:type="gboolean"/>
10372 <parameter name="data" transfer-ownership="none">
10373 <doc xml:whitespace="preserve">a #guint16.</doc>
10374 <type name="guint16" c:type="guint16"/>
10376 <parameter name="cancellable"
10377 transfer-ownership="none"
10379 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10380 <type name="Cancellable" c:type="GCancellable*"/>
10384 <method name="put_uint32"
10385 c:identifier="g_data_output_stream_put_uint32"
10387 <doc xml:whitespace="preserve">Puts an unsigned 32-bit integer into the stream.</doc>
10388 <return-value transfer-ownership="none">
10389 <doc xml:whitespace="preserve">%TRUE if @data was successfully added to the @stream.</doc>
10390 <type name="gboolean" c:type="gboolean"/>
10393 <parameter name="data" transfer-ownership="none">
10394 <doc xml:whitespace="preserve">a #guint32.</doc>
10395 <type name="guint32" c:type="guint32"/>
10397 <parameter name="cancellable"
10398 transfer-ownership="none"
10400 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10401 <type name="Cancellable" c:type="GCancellable*"/>
10405 <method name="put_uint64"
10406 c:identifier="g_data_output_stream_put_uint64"
10408 <doc xml:whitespace="preserve">Puts an unsigned 64-bit integer into the stream.</doc>
10409 <return-value transfer-ownership="none">
10410 <doc xml:whitespace="preserve">%TRUE if @data was successfully added to the @stream.</doc>
10411 <type name="gboolean" c:type="gboolean"/>
10414 <parameter name="data" transfer-ownership="none">
10415 <doc xml:whitespace="preserve">a #guint64.</doc>
10416 <type name="guint64" c:type="guint64"/>
10418 <parameter name="cancellable"
10419 transfer-ownership="none"
10421 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10422 <type name="Cancellable" c:type="GCancellable*"/>
10426 <method name="set_byte_order"
10427 c:identifier="g_data_output_stream_set_byte_order">
10428 <doc xml:whitespace="preserve">Sets the byte order of the data output stream to @order.</doc>
10429 <return-value transfer-ownership="none">
10430 <type name="none" c:type="void"/>
10433 <parameter name="order" transfer-ownership="none">
10434 <doc xml:whitespace="preserve">a %GDataStreamByteOrder.</doc>
10435 <type name="DataStreamByteOrder" c:type="GDataStreamByteOrder"/>
10439 <property name="byte-order" writable="1" transfer-ownership="none">
10440 <doc xml:whitespace="preserve">Determines the byte ordering that is used when writing
10441 multi-byte entities (such as integers) to the stream.</doc>
10442 <type name="DataStreamByteOrder"/>
10444 <field name="parent_instance">
10445 <type name="FilterOutputStream" c:type="GFilterOutputStream"/>
10447 <field name="priv">
10448 <type name="DataOutputStreamPrivate"
10449 c:type="GDataOutputStreamPrivate*"/>
10452 <record name="DataOutputStreamClass"
10453 c:type="GDataOutputStreamClass"
10454 glib:is-gtype-struct-for="DataOutputStream">
10455 <field name="parent_class">
10456 <type name="FilterOutputStreamClass"
10457 c:type="GFilterOutputStreamClass"/>
10459 <field name="_g_reserved1" introspectable="0">
10460 <callback name="_g_reserved1">
10461 <return-value transfer-ownership="none">
10462 <type name="none" c:type="void"/>
10466 <field name="_g_reserved2" introspectable="0">
10467 <callback name="_g_reserved2">
10468 <return-value transfer-ownership="none">
10469 <type name="none" c:type="void"/>
10473 <field name="_g_reserved3" introspectable="0">
10474 <callback name="_g_reserved3">
10475 <return-value transfer-ownership="none">
10476 <type name="none" c:type="void"/>
10480 <field name="_g_reserved4" introspectable="0">
10481 <callback name="_g_reserved4">
10482 <return-value transfer-ownership="none">
10483 <type name="none" c:type="void"/>
10487 <field name="_g_reserved5" introspectable="0">
10488 <callback name="_g_reserved5">
10489 <return-value transfer-ownership="none">
10490 <type name="none" c:type="void"/>
10495 <record name="DataOutputStreamPrivate"
10496 c:type="GDataOutputStreamPrivate"
10499 <enumeration name="DataStreamByteOrder"
10500 glib:type-name="GDataStreamByteOrder"
10501 glib:get-type="g_data_stream_byte_order_get_type"
10502 c:type="GDataStreamByteOrder">
10503 <doc xml:whitespace="preserve">#GDataStreamByteOrder is used to ensure proper endianness of streaming data sources
10504 across various machine architectures.</doc>
10505 <member name="big_endian"
10507 c:identifier="G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN"
10508 glib:nick="big-endian"/>
10509 <member name="little_endian"
10511 c:identifier="G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN"
10512 glib:nick="little-endian"/>
10513 <member name="host_endian"
10515 c:identifier="G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN"
10516 glib:nick="host-endian"/>
10518 <enumeration name="DataStreamNewlineType"
10519 glib:type-name="GDataStreamNewlineType"
10520 glib:get-type="g_data_stream_newline_type_get_type"
10521 c:type="GDataStreamNewlineType">
10522 <doc xml:whitespace="preserve">#GDataStreamNewlineType is used when checking for or setting the line endings for a given file.</doc>
10525 c:identifier="G_DATA_STREAM_NEWLINE_TYPE_LF"
10529 c:identifier="G_DATA_STREAM_NEWLINE_TYPE_CR"
10531 <member name="cr_lf"
10533 c:identifier="G_DATA_STREAM_NEWLINE_TYPE_CR_LF"
10534 glib:nick="cr-lf"/>
10537 c:identifier="G_DATA_STREAM_NEWLINE_TYPE_ANY"
10540 <class name="DesktopAppInfo"
10541 c:symbol-prefix="desktop_app_info"
10542 c:type="GDesktopAppInfo"
10543 parent="GObject.Object"
10544 glib:type-name="GDesktopAppInfo"
10545 glib:get-type="g_desktop_app_info_get_type"
10546 glib:type-struct="DesktopAppInfoClass">
10547 <doc xml:whitespace="preserve">Information about an installed application from a desktop file.</doc>
10548 <implements name="AppInfo"/>
10549 <constructor name="new" c:identifier="g_desktop_app_info_new">
10550 <doc xml:whitespace="preserve">Creates a new #GDesktopAppInfo based on a desktop file id.
10551 A desktop file id is the basename of the desktop file, including the
10552 .desktop extension. GIO is looking for a desktop file with this name
10553 in the <filename>applications</filename> subdirectories of the XDG data
10554 directories (i.e. the directories specified in the
10555 <envar>XDG_DATA_HOME</envar> and <envar>XDG_DATA_DIRS</envar> environment
10556 variables). GIO also supports the prefix-to-subdirectory mapping that is
10557 described in the <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Menu Spec</ulink>
10558 (i.e. a desktop id of kde-foo.desktop will match
10559 <filename>/usr/share/applications/kde/foo.desktop</filename>).</doc>
10560 <return-value transfer-ownership="full">
10561 <doc xml:whitespace="preserve">a new #GDesktopAppInfo, or %NULL if no desktop file with that id</doc>
10562 <type name="DesktopAppInfo" c:type="GDesktopAppInfo*"/>
10565 <parameter name="desktop_id" transfer-ownership="none">
10566 <doc xml:whitespace="preserve">the desktop file id</doc>
10567 <type name="utf8" c:type="char*"/>
10571 <constructor name="new_from_filename"
10572 c:identifier="g_desktop_app_info_new_from_filename">
10573 <doc xml:whitespace="preserve">Creates a new #GDesktopAppInfo.</doc>
10574 <return-value transfer-ownership="full">
10575 <doc xml:whitespace="preserve">a new #GDesktopAppInfo or %NULL on error.</doc>
10576 <type name="DesktopAppInfo" c:type="GDesktopAppInfo*"/>
10579 <parameter name="filename" transfer-ownership="none">
10580 <doc xml:whitespace="preserve">the path of a desktop file, in the GLib filename encoding</doc>
10581 <type name="utf8" c:type="char*"/>
10585 <constructor name="new_from_keyfile"
10586 c:identifier="g_desktop_app_info_new_from_keyfile"
10588 <doc xml:whitespace="preserve">Creates a new #GDesktopAppInfo.</doc>
10589 <return-value transfer-ownership="full">
10590 <doc xml:whitespace="preserve">a new #GDesktopAppInfo or %NULL on error.</doc>
10591 <type name="DesktopAppInfo" c:type="GDesktopAppInfo*"/>
10594 <parameter name="key_file" transfer-ownership="none">
10595 <doc xml:whitespace="preserve">an opened #GKeyFile</doc>
10596 <type name="GLib.KeyFile" c:type="GKeyFile*"/>
10600 <function name="set_desktop_env"
10601 c:identifier="g_desktop_app_info_set_desktop_env">
10602 <doc xml:whitespace="preserve">Sets the name of the desktop that the application is running in.
10603 This is used by g_app_info_should_show() to evaluate the
10604 <literal>OnlyShowIn</literal> and <literal>NotShowIn</literal>
10605 desktop entry fields.
10606 The <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Desktop
10607 Menu specification</ulink> recognizes the following:
10609 <member>GNOME</member>
10610 <member>KDE</member>
10611 <member>ROX</member>
10612 <member>XFCE</member>
10613 <member>Old</member>
10614 </simplelist>
10615 Should be called only once; subsequent calls are ignored.</doc>
10616 <return-value transfer-ownership="none">
10617 <type name="none" c:type="void"/>
10620 <parameter name="desktop_env" transfer-ownership="none">
10621 <doc xml:whitespace="preserve">a string specifying what desktop this is</doc>
10622 <type name="utf8" c:type="char*"/>
10626 <method name="get_filename"
10627 c:identifier="g_desktop_app_info_get_filename"
10629 <doc xml:whitespace="preserve">When @info was created from a known filename, return it. In some
10630 situations such as the #GDesktopAppInfo returned from
10631 g_desktop_app_info_new_from_keyfile(), this function will return %NULL.</doc>
10632 <return-value transfer-ownership="none">
10633 <doc xml:whitespace="preserve">The full path to the file for @info, or %NULL if not known.</doc>
10634 <type name="utf8" c:type="char*"/>
10637 <method name="get_is_hidden"
10638 c:identifier="g_desktop_app_info_get_is_hidden">
10639 <doc xml:whitespace="preserve">A desktop file is hidden if the Hidden key in it is
10641 <return-value transfer-ownership="none">
10642 <doc xml:whitespace="preserve">%TRUE if hidden, %FALSE otherwise.</doc>
10643 <type name="gboolean" c:type="gboolean"/>
10647 <record name="DesktopAppInfoClass"
10648 c:type="GDesktopAppInfoClass"
10649 glib:is-gtype-struct-for="DesktopAppInfo">
10650 <field name="parent_class">
10651 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
10654 <interface name="DesktopAppInfoLookup"
10655 c:symbol-prefix="desktop_app_info_lookup"
10656 c:type="GDesktopAppInfoLookup"
10657 glib:type-name="GDesktopAppInfoLookup"
10658 glib:get-type="g_desktop_app_info_lookup_get_type"
10659 glib:type-struct="DesktopAppInfoLookupIface">
10660 <doc xml:whitespace="preserve">Interface that is used by backends to associate default
10661 handlers with URI schemes.</doc>
10662 <virtual-method name="get_default_for_uri_scheme"
10663 invoker="get_default_for_uri_scheme">
10664 <doc xml:whitespace="preserve">Gets the default application for launching applications
10665 using this URI scheme for a particular GDesktopAppInfoLookup
10667 The GDesktopAppInfoLookup interface and this function is used
10668 to implement g_app_info_get_default_for_uri_scheme() backends
10669 in a GIO module. There is no reason for applications to use it
10670 directly. Applications should use g_app_info_get_default_for_uri_scheme().</doc>
10671 <return-value transfer-ownership="full">
10672 <doc xml:whitespace="preserve">#GAppInfo for given @uri_scheme or %NULL on error.</doc>
10673 <type name="AppInfo" c:type="GAppInfo*"/>
10676 <parameter name="uri_scheme" transfer-ownership="none">
10677 <doc xml:whitespace="preserve">a string containing a URI scheme.</doc>
10678 <type name="utf8" c:type="char*"/>
10682 <method name="get_default_for_uri_scheme"
10683 c:identifier="g_desktop_app_info_lookup_get_default_for_uri_scheme">
10684 <doc xml:whitespace="preserve">Gets the default application for launching applications
10685 using this URI scheme for a particular GDesktopAppInfoLookup
10687 The GDesktopAppInfoLookup interface and this function is used
10688 to implement g_app_info_get_default_for_uri_scheme() backends
10689 in a GIO module. There is no reason for applications to use it
10690 directly. Applications should use g_app_info_get_default_for_uri_scheme().</doc>
10691 <return-value transfer-ownership="full">
10692 <doc xml:whitespace="preserve">#GAppInfo for given @uri_scheme or %NULL on error.</doc>
10693 <type name="AppInfo" c:type="GAppInfo*"/>
10696 <parameter name="uri_scheme" transfer-ownership="none">
10697 <doc xml:whitespace="preserve">a string containing a URI scheme.</doc>
10698 <type name="utf8" c:type="char*"/>
10703 <record name="DesktopAppInfoLookupIface"
10704 c:type="GDesktopAppInfoLookupIface"
10705 glib:is-gtype-struct-for="DesktopAppInfoLookup">
10706 <field name="g_iface">
10707 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
10709 <field name="get_default_for_uri_scheme">
10710 <callback name="get_default_for_uri_scheme">
10711 <return-value transfer-ownership="full">
10712 <doc xml:whitespace="preserve">#GAppInfo for given @uri_scheme or %NULL on error.</doc>
10713 <type name="AppInfo" c:type="GAppInfo*"/>
10716 <parameter name="lookup" transfer-ownership="none">
10717 <type name="DesktopAppInfoLookup"
10718 c:type="GDesktopAppInfoLookup*"/>
10720 <parameter name="uri_scheme" transfer-ownership="none">
10721 <doc xml:whitespace="preserve">a string containing a URI scheme.</doc>
10722 <type name="utf8" c:type="char*"/>
10728 <interface name="Drive"
10729 c:symbol-prefix="drive"
10731 glib:type-name="GDrive"
10732 glib:get-type="g_drive_get_type"
10733 glib:type-struct="DriveIface">
10734 <doc xml:whitespace="preserve">Opaque drive object.</doc>
10735 <virtual-method name="can_eject" invoker="can_eject">
10736 <doc xml:whitespace="preserve">Checks if a drive can be ejected.</doc>
10737 <return-value transfer-ownership="none">
10738 <doc xml:whitespace="preserve">%TRUE if the @drive can be ejected, %FALSE otherwise.</doc>
10739 <type name="gboolean" c:type="gboolean"/>
10742 <virtual-method name="can_poll_for_media" invoker="can_poll_for_media">
10743 <doc xml:whitespace="preserve">Checks if a drive can be polled for media changes.
10744 %FALSE otherwise.</doc>
10745 <return-value transfer-ownership="none">
10746 <doc xml:whitespace="preserve">%TRUE if the @drive can be polled for media changes,</doc>
10747 <type name="gboolean" c:type="gboolean"/>
10750 <virtual-method name="can_start" invoker="can_start" version="2.22">
10751 <doc xml:whitespace="preserve">Checks if a drive can be started.</doc>
10752 <return-value transfer-ownership="none">
10753 <doc xml:whitespace="preserve">%TRUE if the @drive can be started, %FALSE otherwise.</doc>
10754 <type name="gboolean" c:type="gboolean"/>
10757 <virtual-method name="can_start_degraded"
10758 invoker="can_start_degraded"
10760 <doc xml:whitespace="preserve">Checks if a drive can be started degraded.</doc>
10761 <return-value transfer-ownership="none">
10762 <doc xml:whitespace="preserve">%TRUE if the @drive can be started degraded, %FALSE otherwise.</doc>
10763 <type name="gboolean" c:type="gboolean"/>
10766 <virtual-method name="can_stop" invoker="can_stop" version="2.22">
10767 <doc xml:whitespace="preserve">Checks if a drive can be stopped.</doc>
10768 <return-value transfer-ownership="none">
10769 <doc xml:whitespace="preserve">%TRUE if the @drive can be stopped, %FALSE otherwise.</doc>
10770 <type name="gboolean" c:type="gboolean"/>
10773 <virtual-method name="eject"
10775 deprecated="Use g_drive_eject_with_operation() instead."
10776 deprecated-version="2.22">
10777 <doc xml:whitespace="preserve">Asynchronously ejects a drive.
10778 When the operation is finished, @callback will be called.
10779 You can then call g_drive_eject_finish() to obtain the
10780 result of the operation.</doc>
10781 <return-value transfer-ownership="none">
10782 <type name="none" c:type="void"/>
10785 <parameter name="flags" transfer-ownership="none">
10786 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
10787 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
10789 <parameter name="cancellable"
10790 transfer-ownership="none"
10792 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10793 <type name="Cancellable" c:type="GCancellable*"/>
10795 <parameter name="callback"
10796 transfer-ownership="none"
10799 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
10800 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
10802 <parameter name="user_data" transfer-ownership="none" closure="3">
10803 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
10804 <type name="gpointer" c:type="gpointer"/>
10808 <virtual-method name="eject_finish"
10809 invoker="eject_finish"
10810 deprecated="Use g_drive_eject_with_operation_finish() instead."
10811 deprecated-version="2.22"
10813 <doc xml:whitespace="preserve">Finishes ejecting a drive.
10814 %FALSE otherwise.</doc>
10815 <return-value transfer-ownership="none">
10816 <doc xml:whitespace="preserve">%TRUE if the drive has been ejected successfully,</doc>
10817 <type name="gboolean" c:type="gboolean"/>
10820 <parameter name="result" transfer-ownership="none">
10821 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
10822 <type name="AsyncResult" c:type="GAsyncResult*"/>
10826 <virtual-method name="eject_with_operation"
10827 invoker="eject_with_operation"
10829 <doc xml:whitespace="preserve">Ejects a drive. This is an asynchronous operation, and is
10830 finished by calling g_drive_eject_with_operation_finish() with the @drive
10831 and #GAsyncResult data returned in the @callback.</doc>
10832 <return-value transfer-ownership="none">
10833 <type name="none" c:type="void"/>
10836 <parameter name="flags" transfer-ownership="none">
10837 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
10838 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
10840 <parameter name="mount_operation" transfer-ownership="none">
10841 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
10842 <type name="MountOperation" c:type="GMountOperation*"/>
10844 <parameter name="cancellable"
10845 transfer-ownership="none"
10847 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10848 <type name="Cancellable" c:type="GCancellable*"/>
10850 <parameter name="callback"
10851 transfer-ownership="none"
10854 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
10855 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
10857 <parameter name="user_data" transfer-ownership="none" closure="4">
10858 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
10859 <type name="gpointer" c:type="gpointer"/>
10863 <virtual-method name="eject_with_operation_finish"
10864 invoker="eject_with_operation_finish"
10867 <doc xml:whitespace="preserve">Finishes ejecting a drive. If any errors occurred during the operation,</doc>
10868 <return-value transfer-ownership="none">
10869 <doc xml:whitespace="preserve">%TRUE if the drive was successfully ejected. %FALSE otherwise.</doc>
10870 <type name="gboolean" c:type="gboolean"/>
10873 <parameter name="result" transfer-ownership="none">
10874 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
10875 <type name="AsyncResult" c:type="GAsyncResult*"/>
10879 <virtual-method name="enumerate_identifiers"
10880 invoker="enumerate_identifiers">
10881 <doc xml:whitespace="preserve">Gets the kinds of identifiers that @drive has.
10882 Use g_drive_get_identifer() to obtain the identifiers
10884 kinds of identifiers. Use g_strfreev() to free.</doc>
10885 <return-value transfer-ownership="full">
10886 <doc xml:whitespace="preserve">a %NULL-terminated array of strings containing</doc>
10887 <array c:type="char**">
10888 <type name="utf8"/>
10892 <virtual-method name="get_icon" invoker="get_icon">
10893 <doc xml:whitespace="preserve">Gets the icon for @drive.
10894 Free the returned object with g_object_unref().</doc>
10895 <return-value transfer-ownership="full">
10896 <doc xml:whitespace="preserve">#GIcon for the @drive.</doc>
10897 <type name="Icon" c:type="GIcon*"/>
10900 <virtual-method name="get_identifier" invoker="get_identifier">
10901 <doc xml:whitespace="preserve">Gets the identifier of the given kind for @drive.
10902 requested identfier, or %NULL if the #GDrive
10903 doesn't have this kind of identifier.</doc>
10904 <return-value transfer-ownership="full">
10905 <doc xml:whitespace="preserve">a newly allocated string containing the</doc>
10906 <type name="utf8" c:type="char*"/>
10909 <parameter name="kind" transfer-ownership="none">
10910 <doc xml:whitespace="preserve">the kind of identifier to return</doc>
10911 <type name="utf8" c:type="char*"/>
10915 <virtual-method name="get_name" invoker="get_name">
10916 <doc xml:whitespace="preserve">Gets the name of @drive.
10917 string should be freed when no longer needed.</doc>
10918 <return-value transfer-ownership="full">
10919 <doc xml:whitespace="preserve">a string containing @drive's name. The returned</doc>
10920 <type name="utf8" c:type="char*"/>
10923 <virtual-method name="get_start_stop_type"
10924 invoker="get_start_stop_type"
10926 <doc xml:whitespace="preserve">Gets a hint about how a drive can be started/stopped.</doc>
10927 <return-value transfer-ownership="none">
10928 <doc xml:whitespace="preserve">A value from the #GDriveStartStopType enumeration.</doc>
10929 <type name="DriveStartStopType" c:type="GDriveStartStopType"/>
10932 <virtual-method name="get_volumes" invoker="get_volumes">
10933 <doc xml:whitespace="preserve">Get a list of mountable volumes for @drive.
10934 The returned list should be freed with g_list_free(), after
10935 its elements have been unreffed with g_object_unref().</doc>
10936 <return-value transfer-ownership="full">
10937 <doc xml:whitespace="preserve">#GList containing any #GVolume objects on the given @drive.</doc>
10938 <type name="GLib.List" c:type="GList*">
10939 <type name="Volume"/>
10943 <virtual-method name="has_media" invoker="has_media">
10944 <doc xml:whitespace="preserve">Checks if the @drive has media. Note that the OS may not be polling
10945 the drive for media changes; see g_drive_is_media_check_automatic()
10946 for more details.</doc>
10947 <return-value transfer-ownership="none">
10948 <doc xml:whitespace="preserve">%TRUE if @drive has media, %FALSE otherwise.</doc>
10949 <type name="gboolean" c:type="gboolean"/>
10952 <virtual-method name="has_volumes" invoker="has_volumes">
10953 <doc xml:whitespace="preserve">Check if @drive has any mountable volumes.</doc>
10954 <return-value transfer-ownership="none">
10955 <doc xml:whitespace="preserve">%TRUE if the @drive contains volumes, %FALSE otherwise.</doc>
10956 <type name="gboolean" c:type="gboolean"/>
10959 <virtual-method name="is_media_check_automatic"
10960 invoker="is_media_check_automatic">
10961 <doc xml:whitespace="preserve">Checks if @drive is capabable of automatically detecting media changes.
10962 media changes, %FALSE otherwise.</doc>
10963 <return-value transfer-ownership="none">
10964 <doc xml:whitespace="preserve">%TRUE if the @drive is capabable of automatically detecting</doc>
10965 <type name="gboolean" c:type="gboolean"/>
10968 <virtual-method name="is_media_removable" invoker="is_media_removable">
10969 <doc xml:whitespace="preserve">Checks if the @drive supports removable media.</doc>
10970 <return-value transfer-ownership="none">
10971 <doc xml:whitespace="preserve">%TRUE if @drive supports removable media, %FALSE otherwise.</doc>
10972 <type name="gboolean" c:type="gboolean"/>
10975 <virtual-method name="poll_for_media" invoker="poll_for_media">
10976 <doc xml:whitespace="preserve">Asynchronously polls @drive to see if media has been inserted or removed.
10977 When the operation is finished, @callback will be called.
10978 You can then call g_drive_poll_for_media_finish() to obtain the
10979 result of the operation.</doc>
10980 <return-value transfer-ownership="none">
10981 <type name="none" c:type="void"/>
10984 <parameter name="cancellable"
10985 transfer-ownership="none"
10987 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
10988 <type name="Cancellable" c:type="GCancellable*"/>
10990 <parameter name="callback"
10991 transfer-ownership="none"
10994 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
10995 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
10997 <parameter name="user_data" transfer-ownership="none" closure="2">
10998 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
10999 <type name="gpointer" c:type="gpointer"/>
11003 <virtual-method name="poll_for_media_finish"
11004 invoker="poll_for_media_finish"
11006 <doc xml:whitespace="preserve">Finishes an operation started with g_drive_poll_for_media() on a drive.
11007 %FALSE otherwise.</doc>
11008 <return-value transfer-ownership="none">
11009 <doc xml:whitespace="preserve">%TRUE if the drive has been poll_for_mediaed successfully,</doc>
11010 <type name="gboolean" c:type="gboolean"/>
11013 <parameter name="result" transfer-ownership="none">
11014 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11015 <type name="AsyncResult" c:type="GAsyncResult*"/>
11019 <virtual-method name="start" invoker="start" version="2.22">
11020 <doc xml:whitespace="preserve">Asynchronously starts a drive.
11021 When the operation is finished, @callback will be called.
11022 You can then call g_drive_start_finish() to obtain the
11023 result of the operation.</doc>
11024 <return-value transfer-ownership="none">
11025 <type name="none" c:type="void"/>
11028 <parameter name="flags" transfer-ownership="none">
11029 <doc xml:whitespace="preserve">flags affecting the start operation.</doc>
11030 <type name="DriveStartFlags" c:type="GDriveStartFlags"/>
11032 <parameter name="mount_operation" transfer-ownership="none">
11033 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
11034 <type name="MountOperation" c:type="GMountOperation*"/>
11036 <parameter name="cancellable"
11037 transfer-ownership="none"
11039 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11040 <type name="Cancellable" c:type="GCancellable*"/>
11042 <parameter name="callback"
11043 transfer-ownership="none"
11046 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11047 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11049 <parameter name="user_data" transfer-ownership="none" closure="4">
11050 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11051 <type name="gpointer" c:type="gpointer"/>
11055 <virtual-method name="start_finish"
11056 invoker="start_finish"
11059 <doc xml:whitespace="preserve">Finishes starting a drive.
11060 %FALSE otherwise.</doc>
11061 <return-value transfer-ownership="none">
11062 <doc xml:whitespace="preserve">%TRUE if the drive has been started successfully,</doc>
11063 <type name="gboolean" c:type="gboolean"/>
11066 <parameter name="result" transfer-ownership="none">
11067 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11068 <type name="AsyncResult" c:type="GAsyncResult*"/>
11072 <virtual-method name="stop" invoker="stop" version="2.22">
11073 <doc xml:whitespace="preserve">Asynchronously stops a drive.
11074 When the operation is finished, @callback will be called.
11075 You can then call g_drive_stop_finish() to obtain the
11076 result of the operation.</doc>
11077 <return-value transfer-ownership="none">
11078 <type name="none" c:type="void"/>
11081 <parameter name="flags" transfer-ownership="none">
11082 <doc xml:whitespace="preserve">flags affecting the unmount if required for stopping.</doc>
11083 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
11085 <parameter name="mount_operation" transfer-ownership="none">
11086 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
11087 <type name="MountOperation" c:type="GMountOperation*"/>
11089 <parameter name="cancellable"
11090 transfer-ownership="none"
11092 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11093 <type name="Cancellable" c:type="GCancellable*"/>
11095 <parameter name="callback"
11096 transfer-ownership="none"
11099 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11100 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11102 <parameter name="user_data" transfer-ownership="none" closure="4">
11103 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11104 <type name="gpointer" c:type="gpointer"/>
11108 <virtual-method name="stop_finish"
11109 invoker="stop_finish"
11112 <doc xml:whitespace="preserve">Finishes stopping a drive.
11113 %FALSE otherwise.</doc>
11114 <return-value transfer-ownership="none">
11115 <doc xml:whitespace="preserve">%TRUE if the drive has been stopped successfully,</doc>
11116 <type name="gboolean" c:type="gboolean"/>
11119 <parameter name="result" transfer-ownership="none">
11120 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11121 <type name="AsyncResult" c:type="GAsyncResult*"/>
11125 <method name="can_eject" c:identifier="g_drive_can_eject">
11126 <doc xml:whitespace="preserve">Checks if a drive can be ejected.</doc>
11127 <return-value transfer-ownership="none">
11128 <doc xml:whitespace="preserve">%TRUE if the @drive can be ejected, %FALSE otherwise.</doc>
11129 <type name="gboolean" c:type="gboolean"/>
11132 <method name="can_poll_for_media"
11133 c:identifier="g_drive_can_poll_for_media">
11134 <doc xml:whitespace="preserve">Checks if a drive can be polled for media changes.
11135 %FALSE otherwise.</doc>
11136 <return-value transfer-ownership="none">
11137 <doc xml:whitespace="preserve">%TRUE if the @drive can be polled for media changes,</doc>
11138 <type name="gboolean" c:type="gboolean"/>
11141 <method name="can_start" c:identifier="g_drive_can_start" version="2.22">
11142 <doc xml:whitespace="preserve">Checks if a drive can be started.</doc>
11143 <return-value transfer-ownership="none">
11144 <doc xml:whitespace="preserve">%TRUE if the @drive can be started, %FALSE otherwise.</doc>
11145 <type name="gboolean" c:type="gboolean"/>
11148 <method name="can_start_degraded"
11149 c:identifier="g_drive_can_start_degraded"
11151 <doc xml:whitespace="preserve">Checks if a drive can be started degraded.</doc>
11152 <return-value transfer-ownership="none">
11153 <doc xml:whitespace="preserve">%TRUE if the @drive can be started degraded, %FALSE otherwise.</doc>
11154 <type name="gboolean" c:type="gboolean"/>
11157 <method name="can_stop" c:identifier="g_drive_can_stop" version="2.22">
11158 <doc xml:whitespace="preserve">Checks if a drive can be stopped.</doc>
11159 <return-value transfer-ownership="none">
11160 <doc xml:whitespace="preserve">%TRUE if the @drive can be stopped, %FALSE otherwise.</doc>
11161 <type name="gboolean" c:type="gboolean"/>
11164 <method name="eject"
11165 c:identifier="g_drive_eject"
11166 deprecated="Use g_drive_eject_with_operation() instead."
11167 deprecated-version="2.22">
11168 <doc xml:whitespace="preserve">Asynchronously ejects a drive.
11169 When the operation is finished, @callback will be called.
11170 You can then call g_drive_eject_finish() to obtain the
11171 result of the operation.</doc>
11172 <return-value transfer-ownership="none">
11173 <type name="none" c:type="void"/>
11176 <parameter name="flags" transfer-ownership="none">
11177 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
11178 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
11180 <parameter name="cancellable"
11181 transfer-ownership="none"
11183 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11184 <type name="Cancellable" c:type="GCancellable*"/>
11186 <parameter name="callback"
11187 transfer-ownership="none"
11190 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11191 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11193 <parameter name="user_data" transfer-ownership="none">
11194 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11195 <type name="gpointer" c:type="gpointer"/>
11199 <method name="eject_finish"
11200 c:identifier="g_drive_eject_finish"
11201 deprecated="Use g_drive_eject_with_operation_finish() instead."
11202 deprecated-version="2.22"
11204 <doc xml:whitespace="preserve">Finishes ejecting a drive.
11205 %FALSE otherwise.</doc>
11206 <return-value transfer-ownership="none">
11207 <doc xml:whitespace="preserve">%TRUE if the drive has been ejected successfully,</doc>
11208 <type name="gboolean" c:type="gboolean"/>
11211 <parameter name="result" transfer-ownership="none">
11212 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11213 <type name="AsyncResult" c:type="GAsyncResult*"/>
11217 <method name="eject_with_operation"
11218 c:identifier="g_drive_eject_with_operation"
11220 <doc xml:whitespace="preserve">Ejects a drive. This is an asynchronous operation, and is
11221 finished by calling g_drive_eject_with_operation_finish() with the @drive
11222 and #GAsyncResult data returned in the @callback.</doc>
11223 <return-value transfer-ownership="none">
11224 <type name="none" c:type="void"/>
11227 <parameter name="flags" transfer-ownership="none">
11228 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
11229 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
11231 <parameter name="mount_operation" transfer-ownership="none">
11232 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
11233 <type name="MountOperation" c:type="GMountOperation*"/>
11235 <parameter name="cancellable"
11236 transfer-ownership="none"
11238 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11239 <type name="Cancellable" c:type="GCancellable*"/>
11241 <parameter name="callback"
11242 transfer-ownership="none"
11245 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11246 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11248 <parameter name="user_data" transfer-ownership="none">
11249 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
11250 <type name="gpointer" c:type="gpointer"/>
11254 <method name="eject_with_operation_finish"
11255 c:identifier="g_drive_eject_with_operation_finish"
11258 <doc xml:whitespace="preserve">Finishes ejecting a drive. If any errors occurred during the operation,</doc>
11259 <return-value transfer-ownership="none">
11260 <doc xml:whitespace="preserve">%TRUE if the drive was successfully ejected. %FALSE otherwise.</doc>
11261 <type name="gboolean" c:type="gboolean"/>
11264 <parameter name="result" transfer-ownership="none">
11265 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11266 <type name="AsyncResult" c:type="GAsyncResult*"/>
11270 <method name="enumerate_identifiers"
11271 c:identifier="g_drive_enumerate_identifiers">
11272 <doc xml:whitespace="preserve">Gets the kinds of identifiers that @drive has.
11273 Use g_drive_get_identifer() to obtain the identifiers
11275 kinds of identifiers. Use g_strfreev() to free.</doc>
11276 <return-value transfer-ownership="full">
11277 <doc xml:whitespace="preserve">a %NULL-terminated array of strings containing</doc>
11278 <array c:type="char**">
11279 <type name="utf8"/>
11283 <method name="get_icon" c:identifier="g_drive_get_icon">
11284 <doc xml:whitespace="preserve">Gets the icon for @drive.
11285 Free the returned object with g_object_unref().</doc>
11286 <return-value transfer-ownership="full">
11287 <doc xml:whitespace="preserve">#GIcon for the @drive.</doc>
11288 <type name="Icon" c:type="GIcon*"/>
11291 <method name="get_identifier" c:identifier="g_drive_get_identifier">
11292 <doc xml:whitespace="preserve">Gets the identifier of the given kind for @drive.
11293 requested identfier, or %NULL if the #GDrive
11294 doesn't have this kind of identifier.</doc>
11295 <return-value transfer-ownership="full">
11296 <doc xml:whitespace="preserve">a newly allocated string containing the</doc>
11297 <type name="utf8" c:type="char*"/>
11300 <parameter name="kind" transfer-ownership="none">
11301 <doc xml:whitespace="preserve">the kind of identifier to return</doc>
11302 <type name="utf8" c:type="char*"/>
11306 <method name="get_name" c:identifier="g_drive_get_name">
11307 <doc xml:whitespace="preserve">Gets the name of @drive.
11308 string should be freed when no longer needed.</doc>
11309 <return-value transfer-ownership="full">
11310 <doc xml:whitespace="preserve">a string containing @drive's name. The returned</doc>
11311 <type name="utf8" c:type="char*"/>
11314 <method name="get_start_stop_type"
11315 c:identifier="g_drive_get_start_stop_type"
11317 <doc xml:whitespace="preserve">Gets a hint about how a drive can be started/stopped.</doc>
11318 <return-value transfer-ownership="none">
11319 <doc xml:whitespace="preserve">A value from the #GDriveStartStopType enumeration.</doc>
11320 <type name="DriveStartStopType" c:type="GDriveStartStopType"/>
11323 <method name="get_volumes" c:identifier="g_drive_get_volumes">
11324 <doc xml:whitespace="preserve">Get a list of mountable volumes for @drive.
11325 The returned list should be freed with g_list_free(), after
11326 its elements have been unreffed with g_object_unref().</doc>
11327 <return-value transfer-ownership="full">
11328 <doc xml:whitespace="preserve">#GList containing any #GVolume objects on the given @drive.</doc>
11329 <type name="GLib.List" c:type="GList*">
11330 <type name="Volume"/>
11334 <method name="has_media" c:identifier="g_drive_has_media">
11335 <doc xml:whitespace="preserve">Checks if the @drive has media. Note that the OS may not be polling
11336 the drive for media changes; see g_drive_is_media_check_automatic()
11337 for more details.</doc>
11338 <return-value transfer-ownership="none">
11339 <doc xml:whitespace="preserve">%TRUE if @drive has media, %FALSE otherwise.</doc>
11340 <type name="gboolean" c:type="gboolean"/>
11343 <method name="has_volumes" c:identifier="g_drive_has_volumes">
11344 <doc xml:whitespace="preserve">Check if @drive has any mountable volumes.</doc>
11345 <return-value transfer-ownership="none">
11346 <doc xml:whitespace="preserve">%TRUE if the @drive contains volumes, %FALSE otherwise.</doc>
11347 <type name="gboolean" c:type="gboolean"/>
11350 <method name="is_media_check_automatic"
11351 c:identifier="g_drive_is_media_check_automatic">
11352 <doc xml:whitespace="preserve">Checks if @drive is capabable of automatically detecting media changes.
11353 media changes, %FALSE otherwise.</doc>
11354 <return-value transfer-ownership="none">
11355 <doc xml:whitespace="preserve">%TRUE if the @drive is capabable of automatically detecting</doc>
11356 <type name="gboolean" c:type="gboolean"/>
11359 <method name="is_media_removable"
11360 c:identifier="g_drive_is_media_removable">
11361 <doc xml:whitespace="preserve">Checks if the @drive supports removable media.</doc>
11362 <return-value transfer-ownership="none">
11363 <doc xml:whitespace="preserve">%TRUE if @drive supports removable media, %FALSE otherwise.</doc>
11364 <type name="gboolean" c:type="gboolean"/>
11367 <method name="poll_for_media" c:identifier="g_drive_poll_for_media">
11368 <doc xml:whitespace="preserve">Asynchronously polls @drive to see if media has been inserted or removed.
11369 When the operation is finished, @callback will be called.
11370 You can then call g_drive_poll_for_media_finish() to obtain the
11371 result of the operation.</doc>
11372 <return-value transfer-ownership="none">
11373 <type name="none" c:type="void"/>
11376 <parameter name="cancellable"
11377 transfer-ownership="none"
11379 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11380 <type name="Cancellable" c:type="GCancellable*"/>
11382 <parameter name="callback"
11383 transfer-ownership="none"
11386 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11387 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11389 <parameter name="user_data" transfer-ownership="none">
11390 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11391 <type name="gpointer" c:type="gpointer"/>
11395 <method name="poll_for_media_finish"
11396 c:identifier="g_drive_poll_for_media_finish"
11398 <doc xml:whitespace="preserve">Finishes an operation started with g_drive_poll_for_media() on a drive.
11399 %FALSE otherwise.</doc>
11400 <return-value transfer-ownership="none">
11401 <doc xml:whitespace="preserve">%TRUE if the drive has been poll_for_mediaed successfully,</doc>
11402 <type name="gboolean" c:type="gboolean"/>
11405 <parameter name="result" transfer-ownership="none">
11406 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11407 <type name="AsyncResult" c:type="GAsyncResult*"/>
11411 <method name="start" c:identifier="g_drive_start" version="2.22">
11412 <doc xml:whitespace="preserve">Asynchronously starts a drive.
11413 When the operation is finished, @callback will be called.
11414 You can then call g_drive_start_finish() to obtain the
11415 result of the operation.</doc>
11416 <return-value transfer-ownership="none">
11417 <type name="none" c:type="void"/>
11420 <parameter name="flags" transfer-ownership="none">
11421 <doc xml:whitespace="preserve">flags affecting the start operation.</doc>
11422 <type name="DriveStartFlags" c:type="GDriveStartFlags"/>
11424 <parameter name="mount_operation" transfer-ownership="none">
11425 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
11426 <type name="MountOperation" c:type="GMountOperation*"/>
11428 <parameter name="cancellable"
11429 transfer-ownership="none"
11431 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11432 <type name="Cancellable" c:type="GCancellable*"/>
11434 <parameter name="callback"
11435 transfer-ownership="none"
11438 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11439 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11441 <parameter name="user_data" transfer-ownership="none">
11442 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11443 <type name="gpointer" c:type="gpointer"/>
11447 <method name="start_finish"
11448 c:identifier="g_drive_start_finish"
11451 <doc xml:whitespace="preserve">Finishes starting a drive.
11452 %FALSE otherwise.</doc>
11453 <return-value transfer-ownership="none">
11454 <doc xml:whitespace="preserve">%TRUE if the drive has been started successfully,</doc>
11455 <type name="gboolean" c:type="gboolean"/>
11458 <parameter name="result" transfer-ownership="none">
11459 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11460 <type name="AsyncResult" c:type="GAsyncResult*"/>
11464 <method name="stop" c:identifier="g_drive_stop" version="2.22">
11465 <doc xml:whitespace="preserve">Asynchronously stops a drive.
11466 When the operation is finished, @callback will be called.
11467 You can then call g_drive_stop_finish() to obtain the
11468 result of the operation.</doc>
11469 <return-value transfer-ownership="none">
11470 <type name="none" c:type="void"/>
11473 <parameter name="flags" transfer-ownership="none">
11474 <doc xml:whitespace="preserve">flags affecting the unmount if required for stopping.</doc>
11475 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
11477 <parameter name="mount_operation" transfer-ownership="none">
11478 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
11479 <type name="MountOperation" c:type="GMountOperation*"/>
11481 <parameter name="cancellable"
11482 transfer-ownership="none"
11484 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11485 <type name="Cancellable" c:type="GCancellable*"/>
11487 <parameter name="callback"
11488 transfer-ownership="none"
11491 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11492 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11494 <parameter name="user_data" transfer-ownership="none">
11495 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11496 <type name="gpointer" c:type="gpointer"/>
11500 <method name="stop_finish"
11501 c:identifier="g_drive_stop_finish"
11504 <doc xml:whitespace="preserve">Finishes stopping a drive.
11505 %FALSE otherwise.</doc>
11506 <return-value transfer-ownership="none">
11507 <doc xml:whitespace="preserve">%TRUE if the drive has been stopped successfully,</doc>
11508 <type name="gboolean" c:type="gboolean"/>
11511 <parameter name="result" transfer-ownership="none">
11512 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11513 <type name="AsyncResult" c:type="GAsyncResult*"/>
11517 <glib:signal name="changed">
11518 <doc xml:whitespace="preserve">Emitted when the drive's state has changed.</doc>
11519 <return-value transfer-ownership="none">
11520 <type name="none"/>
11523 <glib:signal name="disconnected">
11524 <doc xml:whitespace="preserve">This signal is emitted when the #GDrive have been
11525 disconnected. If the recipient is holding references to the
11526 object they should release them so the object can be
11528 <return-value transfer-ownership="none">
11529 <type name="none"/>
11532 <glib:signal name="eject-button">
11533 <doc xml:whitespace="preserve">Emitted when the physical eject button (if any) of a drive has
11534 been pressed.</doc>
11535 <return-value transfer-ownership="none">
11536 <type name="none"/>
11539 <glib:signal name="stop-button" version="2.22">
11540 <doc xml:whitespace="preserve">Emitted when the physical stop button (if any) of a drive has
11541 been pressed.</doc>
11542 <return-value transfer-ownership="none">
11543 <type name="none"/>
11547 <record name="DriveIface"
11548 c:type="GDriveIface"
11549 glib:is-gtype-struct-for="Drive">
11550 <doc xml:whitespace="preserve">Interface for creating #GDrive implementations.</doc>
11551 <field name="g_iface">
11552 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
11554 <field name="changed">
11555 <callback name="changed">
11556 <return-value transfer-ownership="none">
11557 <type name="none" c:type="void"/>
11560 <parameter name="drive" transfer-ownership="none">
11561 <type name="Drive" c:type="GDrive*"/>
11566 <field name="disconnected">
11567 <callback name="disconnected">
11568 <return-value transfer-ownership="none">
11569 <type name="none" c:type="void"/>
11572 <parameter name="drive" transfer-ownership="none">
11573 <type name="Drive" c:type="GDrive*"/>
11578 <field name="eject_button">
11579 <callback name="eject_button">
11580 <return-value transfer-ownership="none">
11581 <type name="none" c:type="void"/>
11584 <parameter name="drive" transfer-ownership="none">
11585 <type name="Drive" c:type="GDrive*"/>
11590 <field name="get_name">
11591 <callback name="get_name">
11592 <return-value transfer-ownership="full">
11593 <doc xml:whitespace="preserve">a string containing @drive's name. The returned</doc>
11594 <type name="utf8" c:type="char*"/>
11597 <parameter name="drive" transfer-ownership="none">
11598 <type name="Drive" c:type="GDrive*"/>
11603 <field name="get_icon">
11604 <callback name="get_icon">
11605 <return-value transfer-ownership="full">
11606 <doc xml:whitespace="preserve">#GIcon for the @drive.</doc>
11607 <type name="Icon" c:type="GIcon*"/>
11610 <parameter name="drive" transfer-ownership="none">
11611 <type name="Drive" c:type="GDrive*"/>
11616 <field name="has_volumes">
11617 <callback name="has_volumes">
11618 <return-value transfer-ownership="none">
11619 <doc xml:whitespace="preserve">%TRUE if the @drive contains volumes, %FALSE otherwise.</doc>
11620 <type name="gboolean" c:type="gboolean"/>
11623 <parameter name="drive" transfer-ownership="none">
11624 <type name="Drive" c:type="GDrive*"/>
11629 <field name="get_volumes">
11630 <callback name="get_volumes">
11631 <return-value transfer-ownership="full">
11632 <doc xml:whitespace="preserve">#GList containing any #GVolume objects on the given @drive.</doc>
11633 <type name="GLib.List" c:type="GList*">
11634 <type name="Volume"/>
11638 <parameter name="drive" transfer-ownership="none">
11639 <type name="Drive" c:type="GDrive*"/>
11644 <field name="is_media_removable">
11645 <callback name="is_media_removable">
11646 <return-value transfer-ownership="none">
11647 <doc xml:whitespace="preserve">%TRUE if @drive supports removable media, %FALSE otherwise.</doc>
11648 <type name="gboolean" c:type="gboolean"/>
11651 <parameter name="drive" transfer-ownership="none">
11652 <type name="Drive" c:type="GDrive*"/>
11657 <field name="has_media">
11658 <callback name="has_media">
11659 <return-value transfer-ownership="none">
11660 <doc xml:whitespace="preserve">%TRUE if @drive has media, %FALSE otherwise.</doc>
11661 <type name="gboolean" c:type="gboolean"/>
11664 <parameter name="drive" transfer-ownership="none">
11665 <type name="Drive" c:type="GDrive*"/>
11670 <field name="is_media_check_automatic">
11671 <callback name="is_media_check_automatic">
11672 <return-value transfer-ownership="none">
11673 <doc xml:whitespace="preserve">%TRUE if the @drive is capabable of automatically detecting</doc>
11674 <type name="gboolean" c:type="gboolean"/>
11677 <parameter name="drive" transfer-ownership="none">
11678 <type name="Drive" c:type="GDrive*"/>
11683 <field name="can_eject">
11684 <callback name="can_eject">
11685 <return-value transfer-ownership="none">
11686 <doc xml:whitespace="preserve">%TRUE if the @drive can be ejected, %FALSE otherwise.</doc>
11687 <type name="gboolean" c:type="gboolean"/>
11690 <parameter name="drive" transfer-ownership="none">
11691 <type name="Drive" c:type="GDrive*"/>
11696 <field name="can_poll_for_media">
11697 <callback name="can_poll_for_media">
11698 <return-value transfer-ownership="none">
11699 <doc xml:whitespace="preserve">%TRUE if the @drive can be polled for media changes,</doc>
11700 <type name="gboolean" c:type="gboolean"/>
11703 <parameter name="drive" transfer-ownership="none">
11704 <type name="Drive" c:type="GDrive*"/>
11709 <field name="eject">
11710 <callback name="eject">
11711 <return-value transfer-ownership="none">
11712 <type name="none" c:type="void"/>
11715 <parameter name="drive" transfer-ownership="none">
11716 <type name="Drive" c:type="GDrive*"/>
11718 <parameter name="flags" transfer-ownership="none">
11719 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
11720 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
11722 <parameter name="cancellable"
11723 transfer-ownership="none"
11725 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11726 <type name="Cancellable" c:type="GCancellable*"/>
11728 <parameter name="callback"
11729 transfer-ownership="none"
11732 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11733 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11735 <parameter name="user_data" transfer-ownership="none" closure="4">
11736 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11737 <type name="gpointer" c:type="gpointer"/>
11742 <field name="eject_finish">
11743 <callback name="eject_finish" throws="1">
11744 <return-value transfer-ownership="none">
11745 <doc xml:whitespace="preserve">%TRUE if the drive has been ejected successfully,</doc>
11746 <type name="gboolean" c:type="gboolean"/>
11749 <parameter name="drive" transfer-ownership="none">
11750 <type name="Drive" c:type="GDrive*"/>
11752 <parameter name="result" transfer-ownership="none">
11753 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11754 <type name="AsyncResult" c:type="GAsyncResult*"/>
11759 <field name="poll_for_media">
11760 <callback name="poll_for_media">
11761 <return-value transfer-ownership="none">
11762 <type name="none" c:type="void"/>
11765 <parameter name="drive" transfer-ownership="none">
11766 <type name="Drive" c:type="GDrive*"/>
11768 <parameter name="cancellable"
11769 transfer-ownership="none"
11771 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11772 <type name="Cancellable" c:type="GCancellable*"/>
11774 <parameter name="callback"
11775 transfer-ownership="none"
11778 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11779 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11781 <parameter name="user_data" transfer-ownership="none" closure="3">
11782 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11783 <type name="gpointer" c:type="gpointer"/>
11788 <field name="poll_for_media_finish">
11789 <callback name="poll_for_media_finish" throws="1">
11790 <return-value transfer-ownership="none">
11791 <doc xml:whitespace="preserve">%TRUE if the drive has been poll_for_mediaed successfully,</doc>
11792 <type name="gboolean" c:type="gboolean"/>
11795 <parameter name="drive" transfer-ownership="none">
11796 <type name="Drive" c:type="GDrive*"/>
11798 <parameter name="result" transfer-ownership="none">
11799 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11800 <type name="AsyncResult" c:type="GAsyncResult*"/>
11805 <field name="get_identifier">
11806 <callback name="get_identifier">
11807 <return-value transfer-ownership="full">
11808 <doc xml:whitespace="preserve">a newly allocated string containing the</doc>
11809 <type name="utf8" c:type="char*"/>
11812 <parameter name="drive" transfer-ownership="none">
11813 <type name="Drive" c:type="GDrive*"/>
11815 <parameter name="kind" transfer-ownership="none">
11816 <doc xml:whitespace="preserve">the kind of identifier to return</doc>
11817 <type name="utf8" c:type="char*"/>
11822 <field name="enumerate_identifiers">
11823 <callback name="enumerate_identifiers">
11824 <return-value transfer-ownership="full">
11825 <doc xml:whitespace="preserve">a %NULL-terminated array of strings containing</doc>
11826 <array c:type="char**">
11827 <type name="utf8"/>
11831 <parameter name="drive" transfer-ownership="none">
11832 <type name="Drive" c:type="GDrive*"/>
11837 <field name="get_start_stop_type">
11838 <callback name="get_start_stop_type">
11839 <return-value transfer-ownership="none">
11840 <doc xml:whitespace="preserve">A value from the #GDriveStartStopType enumeration.</doc>
11841 <type name="DriveStartStopType" c:type="GDriveStartStopType"/>
11844 <parameter name="drive" transfer-ownership="none">
11845 <type name="Drive" c:type="GDrive*"/>
11850 <field name="can_start">
11851 <callback name="can_start">
11852 <return-value transfer-ownership="none">
11853 <doc xml:whitespace="preserve">%TRUE if the @drive can be started, %FALSE otherwise.</doc>
11854 <type name="gboolean" c:type="gboolean"/>
11857 <parameter name="drive" transfer-ownership="none">
11858 <type name="Drive" c:type="GDrive*"/>
11863 <field name="can_start_degraded">
11864 <callback name="can_start_degraded">
11865 <return-value transfer-ownership="none">
11866 <doc xml:whitespace="preserve">%TRUE if the @drive can be started degraded, %FALSE otherwise.</doc>
11867 <type name="gboolean" c:type="gboolean"/>
11870 <parameter name="drive" transfer-ownership="none">
11871 <type name="Drive" c:type="GDrive*"/>
11876 <field name="start">
11877 <callback name="start">
11878 <return-value transfer-ownership="none">
11879 <type name="none" c:type="void"/>
11882 <parameter name="drive" transfer-ownership="none">
11883 <type name="Drive" c:type="GDrive*"/>
11885 <parameter name="flags" transfer-ownership="none">
11886 <doc xml:whitespace="preserve">flags affecting the start operation.</doc>
11887 <type name="DriveStartFlags" c:type="GDriveStartFlags"/>
11889 <parameter name="mount_operation" transfer-ownership="none">
11890 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
11891 <type name="MountOperation" c:type="GMountOperation*"/>
11893 <parameter name="cancellable"
11894 transfer-ownership="none"
11896 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11897 <type name="Cancellable" c:type="GCancellable*"/>
11899 <parameter name="callback"
11900 transfer-ownership="none"
11903 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11904 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11906 <parameter name="user_data" transfer-ownership="none" closure="5">
11907 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11908 <type name="gpointer" c:type="gpointer"/>
11913 <field name="start_finish">
11914 <callback name="start_finish" throws="1">
11915 <return-value transfer-ownership="none">
11916 <doc xml:whitespace="preserve">%TRUE if the drive has been started successfully,</doc>
11917 <type name="gboolean" c:type="gboolean"/>
11920 <parameter name="drive" transfer-ownership="none">
11921 <type name="Drive" c:type="GDrive*"/>
11923 <parameter name="result" transfer-ownership="none">
11924 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11925 <type name="AsyncResult" c:type="GAsyncResult*"/>
11930 <field name="can_stop">
11931 <callback name="can_stop">
11932 <return-value transfer-ownership="none">
11933 <doc xml:whitespace="preserve">%TRUE if the @drive can be stopped, %FALSE otherwise.</doc>
11934 <type name="gboolean" c:type="gboolean"/>
11937 <parameter name="drive" transfer-ownership="none">
11938 <type name="Drive" c:type="GDrive*"/>
11943 <field name="stop">
11944 <callback name="stop">
11945 <return-value transfer-ownership="none">
11946 <type name="none" c:type="void"/>
11949 <parameter name="drive" transfer-ownership="none">
11950 <type name="Drive" c:type="GDrive*"/>
11952 <parameter name="flags" transfer-ownership="none">
11953 <doc xml:whitespace="preserve">flags affecting the unmount if required for stopping.</doc>
11954 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
11956 <parameter name="mount_operation" transfer-ownership="none">
11957 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
11958 <type name="MountOperation" c:type="GMountOperation*"/>
11960 <parameter name="cancellable"
11961 transfer-ownership="none"
11963 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
11964 <type name="Cancellable" c:type="GCancellable*"/>
11966 <parameter name="callback"
11967 transfer-ownership="none"
11970 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
11971 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
11973 <parameter name="user_data" transfer-ownership="none" closure="5">
11974 <doc xml:whitespace="preserve">user data to pass to @callback</doc>
11975 <type name="gpointer" c:type="gpointer"/>
11980 <field name="stop_finish">
11981 <callback name="stop_finish" throws="1">
11982 <return-value transfer-ownership="none">
11983 <doc xml:whitespace="preserve">%TRUE if the drive has been stopped successfully,</doc>
11984 <type name="gboolean" c:type="gboolean"/>
11987 <parameter name="drive" transfer-ownership="none">
11988 <type name="Drive" c:type="GDrive*"/>
11990 <parameter name="result" transfer-ownership="none">
11991 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
11992 <type name="AsyncResult" c:type="GAsyncResult*"/>
11997 <field name="stop_button">
11998 <callback name="stop_button">
11999 <return-value transfer-ownership="none">
12000 <type name="none" c:type="void"/>
12003 <parameter name="drive" transfer-ownership="none">
12004 <type name="Drive" c:type="GDrive*"/>
12009 <field name="eject_with_operation">
12010 <callback name="eject_with_operation">
12011 <return-value transfer-ownership="none">
12012 <type name="none" c:type="void"/>
12015 <parameter name="drive" transfer-ownership="none">
12016 <type name="Drive" c:type="GDrive*"/>
12018 <parameter name="flags" transfer-ownership="none">
12019 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
12020 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
12022 <parameter name="mount_operation" transfer-ownership="none">
12023 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
12024 <type name="MountOperation" c:type="GMountOperation*"/>
12026 <parameter name="cancellable"
12027 transfer-ownership="none"
12029 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12030 <type name="Cancellable" c:type="GCancellable*"/>
12032 <parameter name="callback"
12033 transfer-ownership="none"
12036 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
12037 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
12039 <parameter name="user_data" transfer-ownership="none" closure="5">
12040 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
12041 <type name="gpointer" c:type="gpointer"/>
12046 <field name="eject_with_operation_finish">
12047 <callback name="eject_with_operation_finish" throws="1">
12048 <return-value transfer-ownership="none">
12049 <doc xml:whitespace="preserve">%TRUE if the drive was successfully ejected. %FALSE otherwise.</doc>
12050 <type name="gboolean" c:type="gboolean"/>
12053 <parameter name="drive" transfer-ownership="none">
12054 <type name="Drive" c:type="GDrive*"/>
12056 <parameter name="result" transfer-ownership="none">
12057 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
12058 <type name="AsyncResult" c:type="GAsyncResult*"/>
12064 <enumeration name="DriveStartFlags"
12066 glib:type-name="GDriveStartFlags"
12067 glib:get-type="g_drive_start_flags_get_type"
12068 c:type="GDriveStartFlags">
12069 <doc xml:whitespace="preserve">Flags used when starting a drive.</doc>
12070 <member name="none"
12072 c:identifier="G_DRIVE_START_NONE"
12075 <enumeration name="DriveStartStopType"
12077 glib:type-name="GDriveStartStopType"
12078 glib:get-type="g_drive_start_stop_type_get_type"
12079 c:type="GDriveStartStopType">
12080 <doc xml:whitespace="preserve">Enumeration describing how a drive can be started/stopped.</doc>
12081 <member name="unknown"
12083 c:identifier="G_DRIVE_START_STOP_TYPE_UNKNOWN"
12084 glib:nick="unknown"/>
12085 <member name="shutdown"
12087 c:identifier="G_DRIVE_START_STOP_TYPE_SHUTDOWN"
12088 glib:nick="shutdown"/>
12089 <member name="network"
12091 c:identifier="G_DRIVE_START_STOP_TYPE_NETWORK"
12092 glib:nick="network"/>
12093 <member name="multidisk"
12095 c:identifier="G_DRIVE_START_STOP_TYPE_MULTIDISK"
12096 glib:nick="multidisk"/>
12097 <member name="password"
12099 c:identifier="G_DRIVE_START_STOP_TYPE_PASSWORD"
12100 glib:nick="password"/>
12102 <class name="Emblem"
12103 c:symbol-prefix="emblem"
12105 parent="GObject.Object"
12106 glib:type-name="GEmblem"
12107 glib:get-type="g_emblem_get_type"
12108 glib:type-struct="EmblemClass">
12109 <doc xml:whitespace="preserve">An object for Emblems</doc>
12110 <implements name="Icon"/>
12111 <constructor name="new" c:identifier="g_emblem_new" version="2.18">
12112 <doc xml:whitespace="preserve">Creates a new emblem for @icon.</doc>
12113 <return-value transfer-ownership="full">
12114 <doc xml:whitespace="preserve">a new #GEmblem.</doc>
12115 <type name="Emblem" c:type="GEmblem*"/>
12118 <parameter name="icon" transfer-ownership="none">
12119 <doc xml:whitespace="preserve">a GIcon containing the icon.</doc>
12120 <type name="Icon" c:type="GIcon*"/>
12124 <constructor name="new_with_origin"
12125 c:identifier="g_emblem_new_with_origin"
12127 <doc xml:whitespace="preserve">Creates a new emblem for @icon.</doc>
12128 <return-value transfer-ownership="full">
12129 <doc xml:whitespace="preserve">a new #GEmblem.</doc>
12130 <type name="Emblem" c:type="GEmblem*"/>
12133 <parameter name="icon" transfer-ownership="none">
12134 <doc xml:whitespace="preserve">a GIcon containing the icon.</doc>
12135 <type name="Icon" c:type="GIcon*"/>
12137 <parameter name="origin" transfer-ownership="none">
12138 <doc xml:whitespace="preserve">a GEmblemOrigin enum defining the emblem's origin</doc>
12139 <type name="EmblemOrigin" c:type="GEmblemOrigin"/>
12143 <method name="get_icon" c:identifier="g_emblem_get_icon" version="2.18">
12144 <doc xml:whitespace="preserve">Gives back the icon from @emblem.
12145 and should not be modified or freed.</doc>
12146 <return-value transfer-ownership="full">
12147 <doc xml:whitespace="preserve">a #GIcon. The returned object belongs to the emblem</doc>
12148 <type name="Icon" c:type="GIcon*"/>
12151 <method name="get_origin"
12152 c:identifier="g_emblem_get_origin"
12154 <doc xml:whitespace="preserve">Gets the origin of the emblem.</doc>
12155 <return-value transfer-ownership="none">
12156 <doc xml:whitespace="preserve">the origin of the emblem</doc>
12157 <type name="EmblemOrigin" c:type="GEmblemOrigin"/>
12160 <property name="icon"
12163 transfer-ownership="none">
12164 <type name="GObject.Object"/>
12166 <property name="origin"
12169 transfer-ownership="none">
12170 <type name="EmblemOrigin"/>
12173 <record name="EmblemClass"
12174 c:type="GEmblemClass"
12176 glib:is-gtype-struct-for="Emblem">
12178 <enumeration name="EmblemOrigin"
12180 glib:type-name="GEmblemOrigin"
12181 glib:get-type="g_emblem_origin_get_type"
12182 c:type="GEmblemOrigin">
12183 <doc xml:whitespace="preserve">GEmblemOrigin is used to add information about the origin of the emblem
12185 <member name="unknown"
12187 c:identifier="G_EMBLEM_ORIGIN_UNKNOWN"
12188 glib:nick="unknown"/>
12189 <member name="device"
12191 c:identifier="G_EMBLEM_ORIGIN_DEVICE"
12192 glib:nick="device"/>
12193 <member name="livemetadata"
12195 c:identifier="G_EMBLEM_ORIGIN_LIVEMETADATA"
12196 glib:nick="livemetadata"/>
12199 c:identifier="G_EMBLEM_ORIGIN_TAG"
12202 <class name="EmblemedIcon"
12203 c:symbol-prefix="emblemed_icon"
12204 c:type="GEmblemedIcon"
12205 parent="GObject.Object"
12206 glib:type-name="GEmblemedIcon"
12207 glib:get-type="g_emblemed_icon_get_type"
12208 glib:type-struct="EmblemedIconClass">
12209 <doc xml:whitespace="preserve">An implementation of #GIcon for icons with emblems.</doc>
12210 <implements name="Icon"/>
12211 <function name="new" c:identifier="g_emblemed_icon_new" version="2.18">
12212 <doc xml:whitespace="preserve">Creates a new emblemed icon for @icon with the emblem @emblem.</doc>
12213 <return-value transfer-ownership="full">
12214 <doc xml:whitespace="preserve">a new #GIcon</doc>
12215 <type name="Icon" c:type="GIcon*"/>
12218 <parameter name="icon" transfer-ownership="none">
12219 <doc xml:whitespace="preserve">a #GIcon</doc>
12220 <type name="Icon" c:type="GIcon*"/>
12222 <parameter name="emblem" transfer-ownership="none">
12223 <doc xml:whitespace="preserve">a #GEmblem</doc>
12224 <type name="Emblem" c:type="GEmblem*"/>
12228 <method name="add_emblem"
12229 c:identifier="g_emblemed_icon_add_emblem"
12231 <doc xml:whitespace="preserve">Adds @emblem to the #GList of #GEmblem <!-- -->s.</doc>
12232 <return-value transfer-ownership="none">
12233 <type name="none" c:type="void"/>
12236 <parameter name="emblem" transfer-ownership="none">
12237 <doc xml:whitespace="preserve">a #GEmblem</doc>
12238 <type name="Emblem" c:type="GEmblem*"/>
12242 <method name="get_emblems"
12243 c:identifier="g_emblemed_icon_get_emblems"
12245 <doc xml:whitespace="preserve">Gets the list of emblems for the @icon.
12246 is owned by @emblemed</doc>
12247 <return-value transfer-ownership="none">
12248 <doc xml:whitespace="preserve">a #GList of #GEmblem <!-- -->s that</doc>
12249 <type name="GLib.List" c:type="GList*">
12250 <type name="utf8"/>
12254 <method name="get_icon"
12255 c:identifier="g_emblemed_icon_get_icon"
12257 <doc xml:whitespace="preserve">Gets the main icon for @emblemed.</doc>
12258 <return-value transfer-ownership="full">
12259 <doc xml:whitespace="preserve">a #GIcon that is owned by @emblemed</doc>
12260 <type name="Icon" c:type="GIcon*"/>
12264 <record name="EmblemedIconClass"
12265 c:type="GEmblemedIconClass"
12267 glib:is-gtype-struct-for="EmblemedIcon">
12269 <constant name="FILE_ATTRIBUTE_ACCESS_CAN_DELETE"
12270 value="access::can-delete">
12271 <type name="utf8" c:type="gchar*"/>
12273 <constant name="FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE"
12274 value="access::can-execute">
12275 <type name="utf8" c:type="gchar*"/>
12277 <constant name="FILE_ATTRIBUTE_ACCESS_CAN_READ" value="access::can-read">
12278 <type name="utf8" c:type="gchar*"/>
12280 <constant name="FILE_ATTRIBUTE_ACCESS_CAN_RENAME"
12281 value="access::can-rename">
12282 <type name="utf8" c:type="gchar*"/>
12284 <constant name="FILE_ATTRIBUTE_ACCESS_CAN_TRASH" value="access::can-trash">
12285 <type name="utf8" c:type="gchar*"/>
12287 <constant name="FILE_ATTRIBUTE_ACCESS_CAN_WRITE" value="access::can-write">
12288 <type name="utf8" c:type="gchar*"/>
12290 <constant name="FILE_ATTRIBUTE_DOS_IS_ARCHIVE" value="dos::is-archive">
12291 <type name="utf8" c:type="gchar*"/>
12293 <constant name="FILE_ATTRIBUTE_DOS_IS_SYSTEM" value="dos::is-system">
12294 <type name="utf8" c:type="gchar*"/>
12296 <constant name="FILE_ATTRIBUTE_ETAG_VALUE" value="etag::value">
12297 <type name="utf8" c:type="gchar*"/>
12299 <constant name="FILE_ATTRIBUTE_FILESYSTEM_FREE" value="filesystem::free">
12300 <type name="utf8" c:type="gchar*"/>
12302 <constant name="FILE_ATTRIBUTE_FILESYSTEM_READONLY"
12303 value="filesystem::readonly">
12304 <type name="utf8" c:type="gchar*"/>
12306 <constant name="FILE_ATTRIBUTE_FILESYSTEM_SIZE" value="filesystem::size">
12307 <type name="utf8" c:type="gchar*"/>
12309 <constant name="FILE_ATTRIBUTE_FILESYSTEM_TYPE" value="filesystem::type">
12310 <type name="utf8" c:type="gchar*"/>
12312 <constant name="FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW"
12313 value="filesystem::use-preview">
12314 <type name="utf8" c:type="gchar*"/>
12316 <constant name="FILE_ATTRIBUTE_GVFS_BACKEND" value="gvfs::backend">
12317 <type name="utf8" c:type="gchar*"/>
12319 <constant name="FILE_ATTRIBUTE_ID_FILE" value="id::file">
12320 <type name="utf8" c:type="gchar*"/>
12322 <constant name="FILE_ATTRIBUTE_ID_FILESYSTEM" value="id::filesystem">
12323 <type name="utf8" c:type="gchar*"/>
12325 <constant name="FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT"
12326 value="mountable::can-eject">
12327 <type name="utf8" c:type="gchar*"/>
12329 <constant name="FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT"
12330 value="mountable::can-mount">
12331 <type name="utf8" c:type="gchar*"/>
12333 <constant name="FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL"
12334 value="mountable::can-poll">
12335 <type name="utf8" c:type="gchar*"/>
12337 <constant name="FILE_ATTRIBUTE_MOUNTABLE_CAN_START"
12338 value="mountable::can-start">
12339 <type name="utf8" c:type="gchar*"/>
12341 <constant name="FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED"
12342 value="mountable::can-start-degraded">
12343 <type name="utf8" c:type="gchar*"/>
12345 <constant name="FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP"
12346 value="mountable::can-stop">
12347 <type name="utf8" c:type="gchar*"/>
12349 <constant name="FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT"
12350 value="mountable::can-unmount">
12351 <type name="utf8" c:type="gchar*"/>
12353 <constant name="FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI"
12354 value="mountable::hal-udi">
12355 <type name="utf8" c:type="gchar*"/>
12357 <constant name="FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC"
12358 value="mountable::is-media-check-automatic">
12359 <type name="utf8" c:type="gchar*"/>
12361 <constant name="FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE"
12362 value="mountable::start-stop-type">
12363 <type name="utf8" c:type="gchar*"/>
12365 <constant name="FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE"
12366 value="mountable::unix-device">
12367 <type name="utf8" c:type="gchar*"/>
12369 <constant name="FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE"
12370 value="mountable::unix-device-file">
12371 <type name="utf8" c:type="gchar*"/>
12373 <constant name="FILE_ATTRIBUTE_OWNER_GROUP" value="owner::group">
12374 <type name="utf8" c:type="gchar*"/>
12376 <constant name="FILE_ATTRIBUTE_OWNER_USER" value="owner::user">
12377 <type name="utf8" c:type="gchar*"/>
12379 <constant name="FILE_ATTRIBUTE_OWNER_USER_REAL" value="owner::user-real">
12380 <type name="utf8" c:type="gchar*"/>
12382 <constant name="FILE_ATTRIBUTE_PREVIEW_ICON" value="preview::icon">
12383 <type name="utf8" c:type="gchar*"/>
12385 <constant name="FILE_ATTRIBUTE_SELINUX_CONTEXT" value="selinux::context">
12386 <type name="utf8" c:type="gchar*"/>
12388 <constant name="FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE"
12389 value="standard::allocated-size">
12390 <type name="utf8" c:type="gchar*"/>
12392 <constant name="FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE"
12393 value="standard::content-type">
12394 <type name="utf8" c:type="gchar*"/>
12396 <constant name="FILE_ATTRIBUTE_STANDARD_COPY_NAME"
12397 value="standard::copy-name">
12398 <type name="utf8" c:type="gchar*"/>
12400 <constant name="FILE_ATTRIBUTE_STANDARD_DESCRIPTION"
12401 value="standard::description">
12402 <type name="utf8" c:type="gchar*"/>
12404 <constant name="FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME"
12405 value="standard::display-name">
12406 <type name="utf8" c:type="gchar*"/>
12408 <constant name="FILE_ATTRIBUTE_STANDARD_EDIT_NAME"
12409 value="standard::edit-name">
12410 <type name="utf8" c:type="gchar*"/>
12412 <constant name="FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE"
12413 value="standard::fast-content-type">
12414 <type name="utf8" c:type="gchar*"/>
12416 <constant name="FILE_ATTRIBUTE_STANDARD_ICON" value="standard::icon">
12417 <type name="utf8" c:type="gchar*"/>
12419 <constant name="FILE_ATTRIBUTE_STANDARD_IS_BACKUP"
12420 value="standard::is-backup">
12421 <type name="utf8" c:type="gchar*"/>
12423 <constant name="FILE_ATTRIBUTE_STANDARD_IS_HIDDEN"
12424 value="standard::is-hidden">
12425 <type name="utf8" c:type="gchar*"/>
12427 <constant name="FILE_ATTRIBUTE_STANDARD_IS_SYMLINK"
12428 value="standard::is-symlink">
12429 <type name="utf8" c:type="gchar*"/>
12431 <constant name="FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL"
12432 value="standard::is-virtual">
12433 <type name="utf8" c:type="gchar*"/>
12435 <constant name="FILE_ATTRIBUTE_STANDARD_NAME" value="standard::name">
12436 <type name="utf8" c:type="gchar*"/>
12438 <constant name="FILE_ATTRIBUTE_STANDARD_SIZE" value="standard::size">
12439 <type name="utf8" c:type="gchar*"/>
12441 <constant name="FILE_ATTRIBUTE_STANDARD_SORT_ORDER"
12442 value="standard::sort-order">
12443 <type name="utf8" c:type="gchar*"/>
12445 <constant name="FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET"
12446 value="standard::symlink-target">
12447 <type name="utf8" c:type="gchar*"/>
12449 <constant name="FILE_ATTRIBUTE_STANDARD_TARGET_URI"
12450 value="standard::target-uri">
12451 <type name="utf8" c:type="gchar*"/>
12453 <constant name="FILE_ATTRIBUTE_STANDARD_TYPE" value="standard::type">
12454 <type name="utf8" c:type="gchar*"/>
12456 <constant name="FILE_ATTRIBUTE_THUMBNAILING_FAILED"
12457 value="thumbnail::failed">
12458 <type name="utf8" c:type="gchar*"/>
12460 <constant name="FILE_ATTRIBUTE_THUMBNAIL_PATH" value="thumbnail::path">
12461 <type name="utf8" c:type="gchar*"/>
12463 <constant name="FILE_ATTRIBUTE_TIME_ACCESS" value="time::access">
12464 <type name="utf8" c:type="gchar*"/>
12466 <constant name="FILE_ATTRIBUTE_TIME_ACCESS_USEC" value="time::access-usec">
12467 <type name="utf8" c:type="gchar*"/>
12469 <constant name="FILE_ATTRIBUTE_TIME_CHANGED" value="time::changed">
12470 <type name="utf8" c:type="gchar*"/>
12472 <constant name="FILE_ATTRIBUTE_TIME_CHANGED_USEC"
12473 value="time::changed-usec">
12474 <type name="utf8" c:type="gchar*"/>
12476 <constant name="FILE_ATTRIBUTE_TIME_CREATED" value="time::created">
12477 <type name="utf8" c:type="gchar*"/>
12479 <constant name="FILE_ATTRIBUTE_TIME_CREATED_USEC"
12480 value="time::created-usec">
12481 <type name="utf8" c:type="gchar*"/>
12483 <constant name="FILE_ATTRIBUTE_TIME_MODIFIED" value="time::modified">
12484 <type name="utf8" c:type="gchar*"/>
12486 <constant name="FILE_ATTRIBUTE_TIME_MODIFIED_USEC"
12487 value="time::modified-usec">
12488 <type name="utf8" c:type="gchar*"/>
12490 <constant name="FILE_ATTRIBUTE_TRASH_DELETION_DATE"
12491 value="trash::deletion-date">
12492 <type name="utf8" c:type="gchar*"/>
12494 <constant name="FILE_ATTRIBUTE_TRASH_ITEM_COUNT" value="trash::item-count">
12495 <type name="utf8" c:type="gchar*"/>
12497 <constant name="FILE_ATTRIBUTE_TRASH_ORIG_PATH" value="trash::orig-path">
12498 <type name="utf8" c:type="gchar*"/>
12500 <constant name="FILE_ATTRIBUTE_UNIX_BLOCKS" value="unix::blocks">
12501 <type name="utf8" c:type="gchar*"/>
12503 <constant name="FILE_ATTRIBUTE_UNIX_BLOCK_SIZE" value="unix::block-size">
12504 <type name="utf8" c:type="gchar*"/>
12506 <constant name="FILE_ATTRIBUTE_UNIX_DEVICE" value="unix::device">
12507 <type name="utf8" c:type="gchar*"/>
12509 <constant name="FILE_ATTRIBUTE_UNIX_GID" value="unix::gid">
12510 <type name="utf8" c:type="gchar*"/>
12512 <constant name="FILE_ATTRIBUTE_UNIX_INODE" value="unix::inode">
12513 <type name="utf8" c:type="gchar*"/>
12515 <constant name="FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT"
12516 value="unix::is-mountpoint">
12517 <type name="utf8" c:type="gchar*"/>
12519 <constant name="FILE_ATTRIBUTE_UNIX_MODE" value="unix::mode">
12520 <type name="utf8" c:type="gchar*"/>
12522 <constant name="FILE_ATTRIBUTE_UNIX_NLINK" value="unix::nlink">
12523 <type name="utf8" c:type="gchar*"/>
12525 <constant name="FILE_ATTRIBUTE_UNIX_RDEV" value="unix::rdev">
12526 <type name="utf8" c:type="gchar*"/>
12528 <constant name="FILE_ATTRIBUTE_UNIX_UID" value="unix::uid">
12529 <type name="utf8" c:type="gchar*"/>
12531 <interface name="File"
12532 c:symbol-prefix="file"
12534 glib:type-name="GFile"
12535 glib:get-type="g_file_get_type"
12536 glib:type-struct="FileIface">
12537 <doc xml:whitespace="preserve">A handle to an object implementing the #GFileIface interface.
12538 Generally stores a location within the file system. Handles do not
12539 necessarily represent files or directories that currently exist.</doc>
12540 <virtual-method name="append_to" invoker="append_to" throws="1">
12541 <doc xml:whitespace="preserve">Gets an output stream for appending data to the file. If
12542 the file doesn't already exist it is created.
12543 By default files created are generally readable by everyone,
12544 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
12545 will be made readable only to the current user, to the level that
12546 is supported on the target filesystem.
12547 If @cancellable is not %NULL, then the operation can be cancelled by
12548 triggering the cancellable object from another thread. If the operation
12549 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
12550 Some file systems don't allow all file names, and may
12551 return an %G_IO_ERROR_INVALID_FILENAME error.
12552 If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be
12553 returned. Other errors are possible too, and depend on what kind of
12554 filesystem the file is on.
12555 Free the returned object with g_object_unref().</doc>
12556 <return-value transfer-ownership="full">
12557 <doc xml:whitespace="preserve">a #GFileOutputStream, or %NULL on error.</doc>
12558 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
12561 <parameter name="flags" transfer-ownership="none">
12562 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
12563 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
12565 <parameter name="cancellable"
12566 transfer-ownership="none"
12568 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12569 <type name="Cancellable" c:type="GCancellable*"/>
12573 <virtual-method name="append_to_async" invoker="append_to_async">
12574 <doc xml:whitespace="preserve">Asynchronously opens @file for appending.
12575 For more details, see g_file_append_to() which is
12576 the synchronous version of this call.
12577 When the operation is finished, @callback will be called. You can then call
12578 g_file_append_to_finish() to get the result of the operation.</doc>
12579 <return-value transfer-ownership="none">
12580 <type name="none" c:type="void"/>
12583 <parameter name="flags" transfer-ownership="none">
12584 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
12585 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
12587 <parameter name="io_priority" transfer-ownership="none">
12588 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
12589 <type name="gint" c:type="int"/>
12591 <parameter name="cancellable"
12592 transfer-ownership="none"
12594 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12595 <type name="Cancellable" c:type="GCancellable*"/>
12597 <parameter name="callback"
12598 transfer-ownership="none"
12601 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
12602 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
12604 <parameter name="user_data" transfer-ownership="none" closure="4">
12605 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
12606 <type name="gpointer" c:type="gpointer"/>
12610 <virtual-method name="append_to_finish"
12611 invoker="append_to_finish"
12613 <doc xml:whitespace="preserve">Finishes an asynchronous file append operation started with
12614 g_file_append_to_async().
12615 Free the returned object with g_object_unref().</doc>
12616 <return-value transfer-ownership="full">
12617 <doc xml:whitespace="preserve">a valid #GFileOutputStream or %NULL on error.</doc>
12618 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
12621 <parameter name="res" transfer-ownership="none">
12622 <doc xml:whitespace="preserve">#GAsyncResult</doc>
12623 <type name="AsyncResult" c:type="GAsyncResult*"/>
12627 <virtual-method name="copy" invoker="copy" introspectable="0" throws="1">
12628 <doc xml:whitespace="preserve">Copies the file @source to the location specified by @destination.
12629 Can not handle recursive copies of directories.
12630 If the flag #G_FILE_COPY_OVERWRITE is specified an already
12631 existing @destination file is overwritten.
12632 If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
12633 will be copied as symlinks, otherwise the target of the
12634 If @cancellable is not %NULL, then the operation can be cancelled by
12635 triggering the cancellable object from another thread. If the operation
12636 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
12637 If @progress_callback is not %NULL, then the operation can be monitored by
12638 setting this to a #GFileProgressCallback function. @progress_callback_data
12639 will be passed to this function. It is guaranteed that this callback will
12640 be called after all data has been transferred with the total number of bytes
12641 copied during the operation.
12642 If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
12643 error is returned, independent on the status of the @destination.
12644 If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
12645 error G_IO_ERROR_EXISTS is returned.
12646 If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
12647 error is returned. If trying to overwrite a directory with a directory the
12648 G_IO_ERROR_WOULD_MERGE error is returned.
12649 If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
12650 specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
12652 If you are interested in copying the #GFile object itself (not the on-disk
12653 file), see g_file_dup().</doc>
12654 <return-value transfer-ownership="none">
12655 <doc xml:whitespace="preserve">%TRUE on success, %FALSE otherwise.</doc>
12656 <type name="gboolean" c:type="gboolean"/>
12659 <parameter name="destination" transfer-ownership="none">
12660 <doc xml:whitespace="preserve">destination #GFile</doc>
12661 <type name="File" c:type="GFile*"/>
12663 <parameter name="flags" transfer-ownership="none">
12664 <doc xml:whitespace="preserve">set of #GFileCopyFlags</doc>
12665 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
12667 <parameter name="cancellable"
12668 transfer-ownership="none"
12670 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12671 <type name="Cancellable" c:type="GCancellable*"/>
12673 <parameter name="progress_callback"
12674 transfer-ownership="none"
12676 <doc xml:whitespace="preserve">function to callback with progress information</doc>
12677 <type name="FileProgressCallback" c:type="GFileProgressCallback"/>
12679 <parameter name="progress_callback_data" transfer-ownership="none">
12680 <doc xml:whitespace="preserve">user data to pass to @progress_callback</doc>
12681 <type name="gpointer" c:type="gpointer"/>
12685 <virtual-method name="copy_async"
12686 invoker="copy_async"
12687 introspectable="0">
12688 <doc xml:whitespace="preserve">Copies the file @source to the location specified by @destination
12689 asynchronously. For details of the behaviour, see g_file_copy().
12690 If @progress_callback is not %NULL, then that function that will be called
12691 just like in g_file_copy(), however the callback will run in the main loop,
12692 not in the thread that is doing the I/O operation.
12693 When the operation is finished, @callback will be called. You can then call
12694 g_file_copy_finish() to get the result of the operation.</doc>
12695 <return-value transfer-ownership="none">
12696 <type name="none" c:type="void"/>
12699 <parameter name="destination" transfer-ownership="none">
12700 <doc xml:whitespace="preserve">destination #GFile</doc>
12701 <type name="File" c:type="GFile*"/>
12703 <parameter name="flags" transfer-ownership="none">
12704 <doc xml:whitespace="preserve">set of #GFileCopyFlags</doc>
12705 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
12707 <parameter name="io_priority" transfer-ownership="none">
12708 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
12709 <type name="gint" c:type="int"/>
12711 <parameter name="cancellable"
12712 transfer-ownership="none"
12714 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12715 <type name="Cancellable" c:type="GCancellable*"/>
12717 <parameter name="progress_callback"
12718 transfer-ownership="none"
12720 <doc xml:whitespace="preserve">function to callback with progress information</doc>
12721 <type name="FileProgressCallback" c:type="GFileProgressCallback"/>
12723 <parameter name="progress_callback_data" transfer-ownership="none">
12724 <doc xml:whitespace="preserve">user data to pass to @progress_callback</doc>
12725 <type name="gpointer" c:type="gpointer"/>
12727 <parameter name="callback"
12728 transfer-ownership="none"
12731 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
12732 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
12734 <parameter name="user_data" transfer-ownership="none" closure="7">
12735 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
12736 <type name="gpointer" c:type="gpointer"/>
12740 <virtual-method name="copy_finish" invoker="copy_finish" throws="1">
12741 <doc xml:whitespace="preserve">Finishes copying the file started with
12742 g_file_copy_async().</doc>
12743 <return-value transfer-ownership="none">
12744 <doc xml:whitespace="preserve">a %TRUE on success, %FALSE on error.</doc>
12745 <type name="gboolean" c:type="gboolean"/>
12748 <parameter name="res" transfer-ownership="none">
12749 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
12750 <type name="AsyncResult" c:type="GAsyncResult*"/>
12754 <virtual-method name="create" invoker="create" throws="1">
12755 <doc xml:whitespace="preserve">Creates a new file and returns an output stream for writing to it.
12756 The file must not already exist.
12757 By default files created are generally readable by everyone,
12758 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
12759 will be made readable only to the current user, to the level that
12760 is supported on the target filesystem.
12761 If @cancellable is not %NULL, then the operation can be cancelled by
12762 triggering the cancellable object from another thread. If the operation
12763 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
12764 If a file or directory with this name already exists the G_IO_ERROR_EXISTS
12765 error will be returned.
12766 Some file systems don't allow all file names, and may
12767 return an G_IO_ERROR_INVALID_FILENAME error, and if the name
12768 is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
12769 Other errors are possible too, and depend on what kind of
12770 filesystem the file is on.
12772 Free the returned object with g_object_unref().</doc>
12773 <return-value transfer-ownership="full">
12774 <doc xml:whitespace="preserve">a #GFileOutputStream for the newly created file, or</doc>
12775 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
12778 <parameter name="flags" transfer-ownership="none">
12779 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
12780 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
12782 <parameter name="cancellable"
12783 transfer-ownership="none"
12785 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12786 <type name="Cancellable" c:type="GCancellable*"/>
12790 <virtual-method name="create_async" invoker="create_async">
12791 <doc xml:whitespace="preserve">Asynchronously creates a new file and returns an output stream for writing to it.
12792 The file must not already exist.
12793 For more details, see g_file_create() which is
12794 the synchronous version of this call.
12795 When the operation is finished, @callback will be called. You can then call
12796 g_file_create_finish() to get the result of the operation.</doc>
12797 <return-value transfer-ownership="none">
12798 <type name="none" c:type="void"/>
12801 <parameter name="flags" transfer-ownership="none">
12802 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
12803 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
12805 <parameter name="io_priority" transfer-ownership="none">
12806 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
12807 <type name="gint" c:type="int"/>
12809 <parameter name="cancellable"
12810 transfer-ownership="none"
12812 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12813 <type name="Cancellable" c:type="GCancellable*"/>
12815 <parameter name="callback"
12816 transfer-ownership="none"
12819 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
12820 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
12822 <parameter name="user_data" transfer-ownership="none" closure="4">
12823 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
12824 <type name="gpointer" c:type="gpointer"/>
12828 <virtual-method name="create_finish" invoker="create_finish" throws="1">
12829 <doc xml:whitespace="preserve">Finishes an asynchronous file create operation started with
12830 g_file_create_async().
12831 Free the returned object with g_object_unref().</doc>
12832 <return-value transfer-ownership="full">
12833 <doc xml:whitespace="preserve">a #GFileOutputStream or %NULL on error.</doc>
12834 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
12837 <parameter name="res" transfer-ownership="none">
12838 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
12839 <type name="AsyncResult" c:type="GAsyncResult*"/>
12843 <virtual-method name="create_readwrite"
12844 invoker="create_readwrite"
12847 <doc xml:whitespace="preserve">Creates a new file and returns a stream for reading and writing to it.
12848 The file must not already exist.
12849 By default files created are generally readable by everyone,
12850 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
12851 will be made readable only to the current user, to the level that
12852 is supported on the target filesystem.
12853 If @cancellable is not %NULL, then the operation can be cancelled by
12854 triggering the cancellable object from another thread. If the operation
12855 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
12856 If a file or directory with this name already exists the %G_IO_ERROR_EXISTS
12857 error will be returned. Some file systems don't allow all file names,
12858 and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name
12859 is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors
12860 are possible too, and depend on what kind of filesystem the file is on.
12861 Note that in many non-local file cases read and write streams are not
12862 supported, so make sure you really need to do read and write streaming,
12863 rather than just opening for reading or writing.
12864 Free the returned object with g_object_unref().</doc>
12865 <return-value transfer-ownership="full">
12866 <doc xml:whitespace="preserve">a #GFileIOStream for the newly created file, or %NULL on error.</doc>
12867 <type name="FileIOStream" c:type="GFileIOStream*"/>
12870 <parameter name="flags" transfer-ownership="none">
12871 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
12872 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
12874 <parameter name="cancellable"
12875 transfer-ownership="none"
12877 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
12878 <type name="Cancellable" c:type="GCancellable*"/>
12882 <virtual-method name="create_readwrite_async"
12883 invoker="create_readwrite_async"
12885 <doc xml:whitespace="preserve">Asynchronously creates a new file and returns a stream for reading and
12886 writing to it. The file must not already exist.
12887 For more details, see g_file_create_readwrite() which is
12888 the synchronous version of this call.
12889 When the operation is finished, @callback will be called. You can then
12890 call g_file_create_readwrite_finish() to get the result of the operation.</doc>
12891 <return-value transfer-ownership="none">
12892 <type name="none" c:type="void"/>
12895 <parameter name="flags" transfer-ownership="none">
12896 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
12897 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
12899 <parameter name="io_priority" transfer-ownership="none">
12900 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request</doc>
12901 <type name="gint" c:type="int"/>
12903 <parameter name="cancellable"
12904 transfer-ownership="none"
12906 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
12907 <type name="Cancellable" c:type="GCancellable*"/>
12909 <parameter name="callback"
12910 transfer-ownership="none"
12913 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
12914 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
12916 <parameter name="user_data" transfer-ownership="none" closure="4">
12917 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
12918 <type name="gpointer" c:type="gpointer"/>
12922 <virtual-method name="create_readwrite_finish"
12923 invoker="create_readwrite_finish"
12926 <doc xml:whitespace="preserve">Finishes an asynchronous file create operation started with
12927 g_file_create_readwrite_async().
12928 Free the returned object with g_object_unref().</doc>
12929 <return-value transfer-ownership="full">
12930 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
12931 <type name="FileIOStream" c:type="GFileIOStream*"/>
12934 <parameter name="res" transfer-ownership="none">
12935 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
12936 <type name="AsyncResult" c:type="GAsyncResult*"/>
12940 <virtual-method name="delete_file" invoker="delete" throws="1">
12941 <doc xml:whitespace="preserve">Deletes a file. If the @file is a directory, it will only be deleted if it
12943 If @cancellable is not %NULL, then the operation can be cancelled by
12944 triggering the cancellable object from another thread. If the operation
12945 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
12946 <return-value transfer-ownership="none">
12947 <doc xml:whitespace="preserve">%TRUE if the file was deleted. %FALSE otherwise.</doc>
12948 <type name="gboolean" c:type="gboolean"/>
12951 <parameter name="cancellable"
12952 transfer-ownership="none"
12954 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12955 <type name="Cancellable" c:type="GCancellable*"/>
12959 <virtual-method name="dup" invoker="dup">
12960 <doc xml:whitespace="preserve">Duplicates a #GFile handle. This operation does not duplicate
12961 the actual file or directory represented by the #GFile; see
12962 g_file_copy() if attempting to copy a file.
12963 This call does no blocking i/o.</doc>
12964 <return-value transfer-ownership="full">
12965 <doc xml:whitespace="preserve">a new #GFile that is a duplicate of the given #GFile.</doc>
12966 <type name="File" c:type="GFile*"/>
12969 <virtual-method name="eject_mountable"
12970 invoker="eject_mountable"
12971 deprecated="Use g_file_eject_mountable_with_operation() instead."
12972 deprecated-version="2.22">
12973 <doc xml:whitespace="preserve">Starts an asynchronous eject on a mountable.
12974 When this operation has completed, @callback will be called with
12975 g_file_eject_mountable_finish().
12976 If @cancellable is not %NULL, then the operation can be cancelled by
12977 triggering the cancellable object from another thread. If the operation
12978 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
12979 <return-value transfer-ownership="none">
12980 <type name="none" c:type="void"/>
12983 <parameter name="flags" transfer-ownership="none">
12984 <doc xml:whitespace="preserve">flags affecting the operation</doc>
12985 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
12987 <parameter name="cancellable"
12988 transfer-ownership="none"
12990 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
12991 <type name="Cancellable" c:type="GCancellable*"/>
12993 <parameter name="callback"
12994 transfer-ownership="none"
12997 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
12998 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13000 <parameter name="user_data" transfer-ownership="none" closure="3">
13001 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13002 <type name="gpointer" c:type="gpointer"/>
13006 <virtual-method name="eject_mountable_finish"
13007 invoker="eject_mountable_finish"
13008 deprecated="Use g_file_eject_mountable_with_operation_finish() instead."
13009 deprecated-version="2.22"
13011 <doc xml:whitespace="preserve">Finishes an asynchronous eject operation started by
13012 g_file_eject_mountable().
13014 <return-value transfer-ownership="none">
13015 <doc xml:whitespace="preserve">%TRUE if the @file was ejected successfully. %FALSE</doc>
13016 <type name="gboolean" c:type="gboolean"/>
13019 <parameter name="result" transfer-ownership="none">
13020 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13021 <type name="AsyncResult" c:type="GAsyncResult*"/>
13025 <virtual-method name="eject_mountable_with_operation"
13026 invoker="eject_mountable_with_operation"
13028 <doc xml:whitespace="preserve">Starts an asynchronous eject on a mountable.
13029 When this operation has completed, @callback will be called with
13030 g_file_eject_mountable_with_operation_finish().
13031 If @cancellable is not %NULL, then the operation can be cancelled by
13032 triggering the cancellable object from another thread. If the operation
13033 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
13034 <return-value transfer-ownership="none">
13035 <type name="none" c:type="void"/>
13038 <parameter name="flags" transfer-ownership="none">
13039 <doc xml:whitespace="preserve">flags affecting the operation</doc>
13040 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
13042 <parameter name="mount_operation" transfer-ownership="none">
13043 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
13044 <type name="MountOperation" c:type="GMountOperation*"/>
13046 <parameter name="cancellable"
13047 transfer-ownership="none"
13049 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13050 <type name="Cancellable" c:type="GCancellable*"/>
13052 <parameter name="callback"
13053 transfer-ownership="none"
13056 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
13057 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13059 <parameter name="user_data" transfer-ownership="none" closure="4">
13060 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13061 <type name="gpointer" c:type="gpointer"/>
13065 <virtual-method name="eject_mountable_with_operation_finish"
13066 invoker="eject_mountable_with_operation_finish"
13069 <doc xml:whitespace="preserve">Finishes an asynchronous eject operation started by
13070 g_file_eject_mountable_with_operation().
13072 <return-value transfer-ownership="none">
13073 <doc xml:whitespace="preserve">%TRUE if the @file was ejected successfully. %FALSE</doc>
13074 <type name="gboolean" c:type="gboolean"/>
13077 <parameter name="result" transfer-ownership="none">
13078 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13079 <type name="AsyncResult" c:type="GAsyncResult*"/>
13083 <virtual-method name="enumerate_children"
13084 invoker="enumerate_children"
13086 <doc xml:whitespace="preserve">Gets the requested information about the files in a directory. The result
13087 is a #GFileEnumerator object that will give out #GFileInfo objects for
13088 all the files in the directory.
13089 The @attributes value is a string that specifies the file attributes that
13090 should be gathered. It is not an error if it's not possible to read a particular
13091 requested attribute from a file - it just won't be set. @attributes should
13092 be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
13093 means all attributes, and a wildcard like "standard::*" means all attributes in the standard
13094 namespace. An example attribute query be "standard::*,owner::user".
13095 The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
13096 If @cancellable is not %NULL, then the operation can be cancelled by
13097 triggering the cancellable object from another thread. If the operation
13098 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13099 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
13100 If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
13101 Other errors are possible too.
13102 Free the returned object with g_object_unref().</doc>
13103 <return-value transfer-ownership="full">
13104 <doc xml:whitespace="preserve">A #GFileEnumerator if successful, %NULL on error.</doc>
13105 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
13108 <parameter name="attributes" transfer-ownership="none">
13109 <doc xml:whitespace="preserve">an attribute query string.</doc>
13110 <type name="utf8" c:type="char*"/>
13112 <parameter name="flags" transfer-ownership="none">
13113 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
13114 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
13116 <parameter name="cancellable"
13117 transfer-ownership="none"
13119 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13120 <type name="Cancellable" c:type="GCancellable*"/>
13124 <virtual-method name="enumerate_children_async"
13125 invoker="enumerate_children_async">
13126 <doc xml:whitespace="preserve">Asynchronously gets the requested information about the files in a directory. The result
13127 is a #GFileEnumerator object that will give out #GFileInfo objects for
13128 all the files in the directory.
13129 For more details, see g_file_enumerate_children() which is
13130 the synchronous version of this call.
13131 When the operation is finished, @callback will be called. You can then call
13132 g_file_enumerate_children_finish() to get the result of the operation.</doc>
13133 <return-value transfer-ownership="none">
13134 <type name="none" c:type="void"/>
13137 <parameter name="attributes" transfer-ownership="none">
13138 <doc xml:whitespace="preserve">an attribute query string.</doc>
13139 <type name="utf8" c:type="char*"/>
13141 <parameter name="flags" transfer-ownership="none">
13142 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
13143 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
13145 <parameter name="io_priority" transfer-ownership="none">
13146 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
13147 <type name="gint" c:type="int"/>
13149 <parameter name="cancellable"
13150 transfer-ownership="none"
13152 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13153 <type name="Cancellable" c:type="GCancellable*"/>
13155 <parameter name="callback"
13156 transfer-ownership="none"
13159 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
13160 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13162 <parameter name="user_data" transfer-ownership="none" closure="5">
13163 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13164 <type name="gpointer" c:type="gpointer"/>
13168 <virtual-method name="enumerate_children_finish"
13169 invoker="enumerate_children_finish"
13171 <doc xml:whitespace="preserve">Finishes an async enumerate children operation.
13172 See g_file_enumerate_children_async().
13173 Free the returned object with g_object_unref().</doc>
13174 <return-value transfer-ownership="full">
13175 <doc xml:whitespace="preserve">a #GFileEnumerator or %NULL if an error occurred.</doc>
13176 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
13179 <parameter name="res" transfer-ownership="none">
13180 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13181 <type name="AsyncResult" c:type="GAsyncResult*"/>
13185 <virtual-method name="equal" invoker="equal">
13186 <doc xml:whitespace="preserve">Checks equality of two given #GFile<!-- -->s. Note that two
13187 #GFile<!-- -->s that differ can still refer to the same
13188 file on the filesystem due to various forms of filename
13190 This call does no blocking i/o.
13191 %FALSE if either is not a #GFile.</doc>
13192 <return-value transfer-ownership="none">
13193 <doc xml:whitespace="preserve">%TRUE if @file1 and @file2 are equal.</doc>
13194 <type name="gboolean" c:type="gboolean"/>
13197 <parameter name="file2" transfer-ownership="none">
13198 <doc xml:whitespace="preserve">the second #GFile.</doc>
13199 <type name="File" c:type="GFile*"/>
13203 <virtual-method name="find_enclosing_mount"
13204 invoker="find_enclosing_mount"
13206 <doc xml:whitespace="preserve">Gets a #GMount for the #GFile.
13207 If the #GFileIface for @file does not have a mount (e.g. possibly a
13208 remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
13210 If @cancellable is not %NULL, then the operation can be cancelled by
13211 triggering the cancellable object from another thread. If the operation
13212 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13213 Free the returned object with g_object_unref().</doc>
13214 <return-value transfer-ownership="full">
13215 <doc xml:whitespace="preserve">a #GMount where the @file is located or %NULL on error.</doc>
13216 <type name="Mount" c:type="GMount*"/>
13219 <parameter name="cancellable"
13220 transfer-ownership="none"
13222 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13223 <type name="Cancellable" c:type="GCancellable*"/>
13227 <virtual-method name="find_enclosing_mount_async"
13228 invoker="find_enclosing_mount_async">
13229 <doc xml:whitespace="preserve">Asynchronously gets the mount for the file.
13230 For more details, see g_file_find_enclosing_mount() which is
13231 the synchronous version of this call.
13232 When the operation is finished, @callback will be called. You can then call
13233 g_file_find_enclosing_mount_finish() to get the result of the operation.</doc>
13234 <return-value transfer-ownership="none">
13235 <type name="none" c:type="void"/>
13238 <parameter name="io_priority" transfer-ownership="none">
13239 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
13240 <type name="gint" c:type="int"/>
13242 <parameter name="cancellable"
13243 transfer-ownership="none"
13245 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13246 <type name="Cancellable" c:type="GCancellable*"/>
13248 <parameter name="callback"
13249 transfer-ownership="none"
13252 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
13253 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13255 <parameter name="user_data" transfer-ownership="none" closure="3">
13256 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13257 <type name="gpointer" c:type="gpointer"/>
13261 <virtual-method name="find_enclosing_mount_finish"
13262 invoker="find_enclosing_mount_finish"
13264 <doc xml:whitespace="preserve">Finishes an asynchronous find mount request.
13265 See g_file_find_enclosing_mount_async().
13266 Free the returned object with g_object_unref().</doc>
13267 <return-value transfer-ownership="full">
13268 <doc xml:whitespace="preserve">#GMount for given @file or %NULL on error.</doc>
13269 <type name="Mount" c:type="GMount*"/>
13272 <parameter name="res" transfer-ownership="none">
13273 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
13274 <type name="AsyncResult" c:type="GAsyncResult*"/>
13278 <virtual-method name="get_basename" invoker="get_basename">
13279 <doc xml:whitespace="preserve">Gets the base name (the last component of the path) for a given #GFile.
13280 If called for the top level of a system (such as the filesystem root
13281 or a uri like sftp://host/) it will return a single directory separator
13282 (and on Windows, possibly a drive letter).
13283 The base name is a byte string (*not* UTF-8). It has no defined encoding
13284 or rules other than it may not contain zero bytes. If you want to use
13285 filenames in a user interface you should use the display name that you
13286 can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
13287 attribute with g_file_query_info().
13288 This call does no blocking i/o.
13289 if given #GFile is invalid. The returned string should be
13290 freed with g_free() when no longer needed.</doc>
13291 <return-value transfer-ownership="full">
13292 <doc xml:whitespace="preserve">string containing the #GFile's base name, or %NULL</doc>
13293 <type name="utf8" c:type="char*"/>
13296 <virtual-method name="get_child_for_display_name"
13297 invoker="get_child_for_display_name"
13299 <doc xml:whitespace="preserve">Gets the child of @file for a given @display_name (i.e. a UTF8
13300 version of the name). If this function fails, it returns %NULL and @error will be
13301 set. This is very useful when constructing a GFile for a new file
13302 and the user entered the filename in the user interface, for instance
13303 when you select a directory and type a filename in the file selector.
13304 This call does no blocking i/o.
13305 %NULL if the display name couldn't be converted.
13306 Free the returned object with g_object_unref().</doc>
13307 <return-value transfer-ownership="full">
13308 <doc xml:whitespace="preserve">a #GFile to the specified child, or</doc>
13309 <type name="File" c:type="GFile*"/>
13312 <parameter name="display_name" transfer-ownership="none">
13313 <doc xml:whitespace="preserve">string to a possible child.</doc>
13314 <type name="utf8" c:type="char*"/>
13318 <virtual-method name="get_parent" invoker="get_parent">
13319 <doc xml:whitespace="preserve">Gets the parent directory for the @file.
13320 If the @file represents the root directory of the
13321 file system, then %NULL will be returned.
13322 This call does no blocking i/o.
13323 #GFile or %NULL if there is no parent.
13324 Free the returned object with g_object_unref().</doc>
13325 <return-value transfer-ownership="full">
13326 <doc xml:whitespace="preserve">a #GFile structure to the parent of the given</doc>
13327 <type name="File" c:type="GFile*"/>
13330 <virtual-method name="get_parse_name" invoker="get_parse_name">
13331 <doc xml:whitespace="preserve">Gets the parse name of the @file.
13332 A parse name is a UTF-8 string that describes the
13333 file such that one can get the #GFile back using
13334 g_file_parse_name().
13335 This is generally used to show the #GFile as a nice
13336 full-pathname kind of string in a user interface,
13337 like in a location entry.
13338 For local files with names that can safely be converted
13339 to UTF8 the pathname is used, otherwise the IRI is used
13340 (a form of URI that allows UTF8 characters unescaped).
13341 This call does no blocking i/o.
13342 string should be freed with g_free() when no longer needed.</doc>
13343 <return-value transfer-ownership="full">
13344 <doc xml:whitespace="preserve">a string containing the #GFile's parse name. The returned</doc>
13345 <type name="utf8" c:type="char*"/>
13348 <virtual-method name="get_path" invoker="get_path">
13349 <doc xml:whitespace="preserve">Gets the local pathname for #GFile, if one exists.
13350 This call does no blocking i/o.
13351 no such path exists. The returned string should be
13352 freed with g_free() when no longer needed.</doc>
13353 <return-value transfer-ownership="full">
13354 <doc xml:whitespace="preserve">string containing the #GFile's path, or %NULL if</doc>
13355 <type name="utf8" c:type="char*"/>
13358 <virtual-method name="get_relative_path" invoker="get_relative_path">
13359 <doc xml:whitespace="preserve">Gets the path for @descendant relative to @parent.
13360 This call does no blocking i/o.
13361 to @parent, or %NULL if @descendant doesn't have @parent as prefix.
13362 The returned string should be freed with g_free() when no longer needed.</doc>
13363 <return-value transfer-ownership="full">
13364 <doc xml:whitespace="preserve">string with the relative path from @descendant</doc>
13365 <type name="utf8" c:type="char*"/>
13368 <parameter name="descendant" transfer-ownership="none">
13369 <doc xml:whitespace="preserve">input #GFile.</doc>
13370 <type name="File" c:type="GFile*"/>
13374 <virtual-method name="get_uri" invoker="get_uri">
13375 <doc xml:whitespace="preserve">Gets the URI for the @file.
13376 This call does no blocking i/o.
13377 The returned string should be freed with g_free() when no longer needed.</doc>
13378 <return-value transfer-ownership="full">
13379 <doc xml:whitespace="preserve">a string containing the #GFile's URI.</doc>
13380 <type name="utf8" c:type="char*"/>
13383 <virtual-method name="get_uri_scheme" invoker="get_uri_scheme">
13384 <doc xml:whitespace="preserve">Gets the URI scheme for a #GFile.
13385 RFC 3986 decodes the scheme as:
13386 <programlisting>
13387 URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
13388 </programlisting>
13389 Common schemes include "file", "http", "ftp", etc.
13390 This call does no blocking i/o.
13391 #GFile. The returned string should be freed with g_free()
13392 when no longer needed.</doc>
13393 <return-value transfer-ownership="full">
13394 <doc xml:whitespace="preserve">a string containing the URI scheme for the given</doc>
13395 <type name="utf8" c:type="char*"/>
13398 <virtual-method name="has_uri_scheme" invoker="has_uri_scheme">
13399 <doc xml:whitespace="preserve">Checks to see if a #GFile has a given URI scheme.
13400 This call does no blocking i/o.
13401 given URI scheme, %FALSE if URI scheme is %NULL,
13402 not supported, or #GFile is invalid.</doc>
13403 <return-value transfer-ownership="none">
13404 <doc xml:whitespace="preserve">%TRUE if #GFile's backend supports the</doc>
13405 <type name="gboolean" c:type="gboolean"/>
13408 <parameter name="uri_scheme" transfer-ownership="none">
13409 <doc xml:whitespace="preserve">a string containing a URI scheme.</doc>
13410 <type name="utf8" c:type="char*"/>
13414 <virtual-method name="hash">
13415 <return-value transfer-ownership="none">
13416 <type name="guint" c:type="guint"/>
13419 <virtual-method name="is_native" invoker="is_native">
13420 <doc xml:whitespace="preserve">Checks to see if a file is native to the platform.
13421 A native file s one expressed in the platform-native filename format,
13422 e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
13423 as it might be on a locally mounted remote filesystem.
13424 On some systems non-native files may be available using
13425 the native filesystem via a userspace filesystem (FUSE), in
13426 these cases this call will return %FALSE, but g_file_get_path()
13427 will still return a native path.
13428 This call does no blocking i/o.</doc>
13429 <return-value transfer-ownership="none">
13430 <doc xml:whitespace="preserve">%TRUE if file is native.</doc>
13431 <type name="gboolean" c:type="gboolean"/>
13434 <virtual-method name="make_directory"
13435 invoker="make_directory"
13437 <return-value transfer-ownership="none">
13438 <type name="gboolean" c:type="gboolean"/>
13441 <parameter name="cancellable"
13442 transfer-ownership="none"
13444 <type name="Cancellable" c:type="GCancellable*"/>
13448 <virtual-method name="make_symbolic_link"
13449 invoker="make_symbolic_link"
13451 <doc xml:whitespace="preserve">Creates a symbolic link named @file which contains the string
13452 If @cancellable is not %NULL, then the operation can be cancelled by
13453 triggering the cancellable object from another thread. If the operation
13454 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
13455 <return-value transfer-ownership="none">
13456 <doc xml:whitespace="preserve">%TRUE on the creation of a new symlink, %FALSE otherwise.</doc>
13457 <type name="gboolean" c:type="gboolean"/>
13460 <parameter name="symlink_value" transfer-ownership="none">
13461 <doc xml:whitespace="preserve">a string with the path for the target of the new symlink</doc>
13462 <type name="utf8" c:type="char*"/>
13464 <parameter name="cancellable"
13465 transfer-ownership="none"
13467 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13468 <type name="Cancellable" c:type="GCancellable*"/>
13472 <virtual-method name="monitor_dir"
13473 invoker="monitor_directory"
13475 <doc xml:whitespace="preserve">Obtains a directory monitor for the given file.
13476 This may fail if directory monitoring is not supported.
13477 If @cancellable is not %NULL, then the operation can be cancelled by
13478 triggering the cancellable object from another thread. If the operation
13479 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13480 Free the returned object with g_object_unref().</doc>
13481 <return-value transfer-ownership="full">
13482 <doc xml:whitespace="preserve">a #GFileMonitor for the given @file, or %NULL on error.</doc>
13483 <type name="FileMonitor" c:type="GFileMonitor*"/>
13486 <parameter name="flags" transfer-ownership="none">
13487 <doc xml:whitespace="preserve">a set of #GFileMonitorFlags.</doc>
13488 <type name="FileMonitorFlags" c:type="GFileMonitorFlags"/>
13490 <parameter name="cancellable"
13491 transfer-ownership="none"
13493 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13494 <type name="Cancellable" c:type="GCancellable*"/>
13498 <virtual-method name="monitor_file" invoker="monitor_file" throws="1">
13499 <doc xml:whitespace="preserve">Obtains a file monitor for the given file. If no file notification
13500 mechanism exists, then regular polling of the file is used.
13501 If @cancellable is not %NULL, then the operation can be cancelled by
13502 triggering the cancellable object from another thread. If the operation
13503 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13504 Free the returned object with g_object_unref().</doc>
13505 <return-value transfer-ownership="full">
13506 <doc xml:whitespace="preserve">a #GFileMonitor for the given @file, or %NULL on error.</doc>
13507 <type name="FileMonitor" c:type="GFileMonitor*"/>
13510 <parameter name="flags" transfer-ownership="none">
13511 <doc xml:whitespace="preserve">a set of #GFileMonitorFlags.</doc>
13512 <type name="FileMonitorFlags" c:type="GFileMonitorFlags"/>
13514 <parameter name="cancellable"
13515 transfer-ownership="none"
13517 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13518 <type name="Cancellable" c:type="GCancellable*"/>
13522 <virtual-method name="mount_enclosing_volume"
13523 invoker="mount_enclosing_volume">
13524 <doc xml:whitespace="preserve">Starts a @mount_operation, mounting the volume that contains the file @location.
13525 When this operation has completed, @callback will be called with
13526 g_file_mount_enclosing_volume_finish().
13527 If @cancellable is not %NULL, then the operation can be cancelled by
13528 triggering the cancellable object from another thread. If the operation
13529 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
13530 <return-value transfer-ownership="none">
13531 <type name="none" c:type="void"/>
13534 <parameter name="flags" transfer-ownership="none">
13535 <doc xml:whitespace="preserve">flags affecting the operation</doc>
13536 <type name="MountMountFlags" c:type="GMountMountFlags"/>
13538 <parameter name="mount_operation" transfer-ownership="none">
13539 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
13540 <type name="MountOperation" c:type="GMountOperation*"/>
13542 <parameter name="cancellable"
13543 transfer-ownership="none"
13545 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13546 <type name="Cancellable" c:type="GCancellable*"/>
13548 <parameter name="callback"
13549 transfer-ownership="none"
13552 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
13553 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13555 <parameter name="user_data" transfer-ownership="none" closure="4">
13556 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13557 <type name="gpointer" c:type="gpointer"/>
13561 <virtual-method name="mount_enclosing_volume_finish"
13562 invoker="mount_enclosing_volume_finish"
13564 <doc xml:whitespace="preserve">Finishes a mount operation started by g_file_mount_enclosing_volume().
13565 has occurred, this function will return %FALSE and set @error
13566 appropriately if present.</doc>
13567 <return-value transfer-ownership="none">
13568 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
13569 <type name="gboolean" c:type="gboolean"/>
13572 <parameter name="result" transfer-ownership="none">
13573 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13574 <type name="AsyncResult" c:type="GAsyncResult*"/>
13578 <virtual-method name="mount_mountable" invoker="mount_mountable">
13579 <doc xml:whitespace="preserve">Mounts a file of type G_FILE_TYPE_MOUNTABLE.
13580 Using @mount_operation, you can request callbacks when, for instance,
13581 passwords are needed during authentication.
13582 If @cancellable is not %NULL, then the operation can be cancelled by
13583 triggering the cancellable object from another thread. If the operation
13584 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13585 When the operation is finished, @callback will be called. You can then call
13586 g_file_mount_mountable_finish() to get the result of the operation.</doc>
13587 <return-value transfer-ownership="none">
13588 <type name="none" c:type="void"/>
13591 <parameter name="flags" transfer-ownership="none">
13592 <doc xml:whitespace="preserve">flags affecting the operation</doc>
13593 <type name="MountMountFlags" c:type="GMountMountFlags"/>
13595 <parameter name="mount_operation" transfer-ownership="none">
13596 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
13597 <type name="MountOperation" c:type="GMountOperation*"/>
13599 <parameter name="cancellable"
13600 transfer-ownership="none"
13602 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13603 <type name="Cancellable" c:type="GCancellable*"/>
13605 <parameter name="callback"
13606 transfer-ownership="none"
13609 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
13610 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13612 <parameter name="user_data" transfer-ownership="none" closure="4">
13613 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13614 <type name="gpointer" c:type="gpointer"/>
13618 <virtual-method name="mount_mountable_finish"
13619 invoker="mount_mountable_finish"
13621 <doc xml:whitespace="preserve">Finishes a mount operation. See g_file_mount_mountable() for details.
13622 Finish an asynchronous mount operation that was started
13623 with g_file_mount_mountable().
13624 Free the returned object with g_object_unref().</doc>
13625 <return-value transfer-ownership="full">
13626 <doc xml:whitespace="preserve">a #GFile or %NULL on error.</doc>
13627 <type name="File" c:type="GFile*"/>
13630 <parameter name="result" transfer-ownership="none">
13631 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13632 <type name="AsyncResult" c:type="GAsyncResult*"/>
13636 <virtual-method name="move" invoker="move" introspectable="0" throws="1">
13637 <doc xml:whitespace="preserve">Tries to move the file or directory @source to the location specified by @destination.
13638 If native move operations are supported then this is used, otherwise a copy + delete
13639 fallback is used. The native implementation may support moving directories (for instance
13640 on moves inside the same filesystem), but the fallback code does not.
13641 If the flag #G_FILE_COPY_OVERWRITE is specified an already
13642 existing @destination file is overwritten.
13643 If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
13644 will be copied as symlinks, otherwise the target of the
13645 If @cancellable is not %NULL, then the operation can be cancelled by
13646 triggering the cancellable object from another thread. If the operation
13647 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13648 If @progress_callback is not %NULL, then the operation can be monitored by
13649 setting this to a #GFileProgressCallback function. @progress_callback_data
13650 will be passed to this function. It is guaranteed that this callback will
13651 be called after all data has been transferred with the total number of bytes
13652 copied during the operation.
13653 If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
13654 error is returned, independent on the status of the @destination.
13655 If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
13656 error G_IO_ERROR_EXISTS is returned.
13657 If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
13658 error is returned. If trying to overwrite a directory with a directory the
13659 G_IO_ERROR_WOULD_MERGE error is returned.
13660 If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
13661 specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
13662 may be returned (if the native move operation isn't available).</doc>
13663 <return-value transfer-ownership="none">
13664 <doc xml:whitespace="preserve">%TRUE on successful move, %FALSE otherwise.</doc>
13665 <type name="gboolean" c:type="gboolean"/>
13668 <parameter name="destination" transfer-ownership="none">
13669 <doc xml:whitespace="preserve">#GFile pointing to the destination location.</doc>
13670 <type name="File" c:type="GFile*"/>
13672 <parameter name="flags" transfer-ownership="none">
13673 <doc xml:whitespace="preserve">set of #GFileCopyFlags.</doc>
13674 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
13676 <parameter name="cancellable"
13677 transfer-ownership="none"
13679 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13680 <type name="Cancellable" c:type="GCancellable*"/>
13682 <parameter name="progress_callback"
13683 transfer-ownership="none"
13685 <doc xml:whitespace="preserve">#GFileProgressCallback function for updates.</doc>
13686 <type name="FileProgressCallback" c:type="GFileProgressCallback"/>
13688 <parameter name="progress_callback_data" transfer-ownership="none">
13689 <doc xml:whitespace="preserve">gpointer to user data for the callback function.</doc>
13690 <type name="gpointer" c:type="gpointer"/>
13694 <virtual-method name="open_readwrite"
13695 invoker="open_readwrite"
13698 <doc xml:whitespace="preserve">Opens an existing file for reading and writing. The result is
13699 a #GFileIOStream that can be used to read and write the contents of the file.
13700 If @cancellable is not %NULL, then the operation can be cancelled by
13701 triggering the cancellable object from another thread. If the operation
13702 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13703 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
13704 If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
13705 Other errors are possible too, and depend on what kind of filesystem the file is on.
13706 Note that in many non-local file cases read and write streams are not supported,
13707 so make sure you really need to do read and write streaming, rather than
13708 just opening for reading or writing.
13709 Free the returned object with g_object_unref().</doc>
13710 <return-value transfer-ownership="full">
13711 <doc xml:whitespace="preserve">#GFileIOStream or %NULL on error.</doc>
13712 <type name="FileIOStream" c:type="GFileIOStream*"/>
13715 <parameter name="cancellable"
13716 transfer-ownership="none"
13718 <doc xml:whitespace="preserve">a #GCancellable</doc>
13719 <type name="Cancellable" c:type="GCancellable*"/>
13723 <virtual-method name="open_readwrite_async"
13724 invoker="open_readwrite_async"
13726 <doc xml:whitespace="preserve">Asynchronously opens @file for reading and writing.
13727 For more details, see g_file_open_readwrite() which is
13728 the synchronous version of this call.
13729 When the operation is finished, @callback will be called. You can then call
13730 g_file_open_readwrite_finish() to get the result of the operation.</doc>
13731 <return-value transfer-ownership="none">
13732 <type name="none" c:type="void"/>
13735 <parameter name="io_priority" transfer-ownership="none">
13736 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
13737 <type name="gint" c:type="int"/>
13739 <parameter name="cancellable"
13740 transfer-ownership="none"
13742 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13743 <type name="Cancellable" c:type="GCancellable*"/>
13745 <parameter name="callback"
13746 transfer-ownership="none"
13749 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
13750 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13752 <parameter name="user_data" transfer-ownership="none" closure="3">
13753 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13754 <type name="gpointer" c:type="gpointer"/>
13758 <virtual-method name="open_readwrite_finish"
13759 invoker="open_readwrite_finish"
13762 <doc xml:whitespace="preserve">Finishes an asynchronous file read operation started with
13763 g_file_open_readwrite_async().
13764 Free the returned object with g_object_unref().</doc>
13765 <return-value transfer-ownership="full">
13766 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
13767 <type name="FileIOStream" c:type="GFileIOStream*"/>
13770 <parameter name="res" transfer-ownership="none">
13771 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13772 <type name="AsyncResult" c:type="GAsyncResult*"/>
13776 <virtual-method name="poll_mountable"
13777 invoker="poll_mountable"
13779 <doc xml:whitespace="preserve">Polls a file of type G_FILE_TYPE_MOUNTABLE.
13780 If @cancellable is not %NULL, then the operation can be cancelled by
13781 triggering the cancellable object from another thread. If the operation
13782 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13783 When the operation is finished, @callback will be called. You can then call
13784 g_file_mount_mountable_finish() to get the result of the operation.</doc>
13785 <return-value transfer-ownership="none">
13786 <type name="none" c:type="void"/>
13789 <parameter name="cancellable"
13790 transfer-ownership="none"
13792 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13793 <type name="Cancellable" c:type="GCancellable*"/>
13795 <parameter name="callback"
13796 transfer-ownership="none"
13799 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
13800 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13802 <parameter name="user_data" transfer-ownership="none" closure="2">
13803 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13804 <type name="gpointer" c:type="gpointer"/>
13808 <virtual-method name="poll_mountable_finish"
13809 invoker="poll_mountable_finish"
13812 <doc xml:whitespace="preserve">Finishes a poll operation. See g_file_poll_mountable() for details.
13813 Finish an asynchronous poll operation that was polled
13814 with g_file_poll_mountable().
13816 <return-value transfer-ownership="none">
13817 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
13818 <type name="gboolean" c:type="gboolean"/>
13821 <parameter name="result" transfer-ownership="none">
13822 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13823 <type name="AsyncResult" c:type="GAsyncResult*"/>
13827 <virtual-method name="prefix_matches" invoker="has_prefix">
13828 <doc xml:whitespace="preserve">Checks whether @file has the prefix specified by @prefix. In other word,
13829 if the names of inital elements of @file<!-- -->s pathname match @prefix.
13830 Only full pathname elements are matched, so a path like /foo is not
13831 considered a prefix of /foobar, only of /foo/bar.
13832 This call does no i/o, as it works purely on names. As such it can
13833 sometimes return %FALSE even if @file is inside a @prefix (from a
13834 filesystem point of view), because the prefix of @file is an alias
13836 %FALSE otherwise.</doc>
13837 <return-value transfer-ownership="none">
13838 <doc xml:whitespace="preserve">%TRUE if the @files's parent, grandparent, etc is @prefix.</doc>
13839 <type name="gboolean" c:type="gboolean"/>
13842 <parameter name="file" transfer-ownership="none">
13843 <doc xml:whitespace="preserve">input #GFile.</doc>
13844 <type name="File" c:type="GFile*"/>
13848 <virtual-method name="query_filesystem_info"
13849 invoker="query_filesystem_info"
13851 <doc xml:whitespace="preserve">Similar to g_file_query_info(), but obtains information
13852 about the filesystem the @file is on, rather than the file itself.
13853 For instance the amount of space available and the type of
13855 The @attributes value is a string that specifies the file attributes that
13856 should be gathered. It is not an error if it's not possible to read a particular
13857 requested attribute from a file - it just won't be set. @attributes should
13858 be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
13859 means all attributes, and a wildcard like "fs:*" means all attributes in the fs
13860 namespace. The standard namespace for filesystem attributes is "fs".
13861 Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
13862 (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
13863 bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
13864 If @cancellable is not %NULL, then the operation can be cancelled by
13865 triggering the cancellable object from another thread. If the operation
13866 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13867 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
13868 Other errors are possible too, and depend on what kind of filesystem the file is on.
13869 Free the returned object with g_object_unref().</doc>
13870 <return-value transfer-ownership="full">
13871 <doc xml:whitespace="preserve">a #GFileInfo or %NULL if there was an error.</doc>
13872 <type name="FileInfo" c:type="GFileInfo*"/>
13875 <parameter name="attributes" transfer-ownership="none">
13876 <doc xml:whitespace="preserve">an attribute query string.</doc>
13877 <type name="utf8" c:type="char*"/>
13879 <parameter name="cancellable"
13880 transfer-ownership="none"
13882 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13883 <type name="Cancellable" c:type="GCancellable*"/>
13887 <virtual-method name="query_filesystem_info_async"
13888 invoker="query_filesystem_info_async">
13889 <doc xml:whitespace="preserve">Asynchronously gets the requested information about the filesystem
13890 that the specified @file is on. The result is a #GFileInfo object
13891 that contains key-value attributes (such as type or size for the
13893 For more details, see g_file_query_filesystem_info() which is the
13894 synchronous version of this call.
13895 When the operation is finished, @callback will be called. You can
13896 then call g_file_query_info_finish() to get the result of the
13898 <return-value transfer-ownership="none">
13899 <type name="none" c:type="void"/>
13902 <parameter name="attributes" transfer-ownership="none">
13903 <doc xml:whitespace="preserve">an attribute query string.</doc>
13904 <type name="utf8" c:type="char*"/>
13906 <parameter name="io_priority" transfer-ownership="none">
13907 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
13908 <type name="gint" c:type="int"/>
13910 <parameter name="cancellable"
13911 transfer-ownership="none"
13913 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13914 <type name="Cancellable" c:type="GCancellable*"/>
13916 <parameter name="callback"
13917 transfer-ownership="none"
13920 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
13921 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
13923 <parameter name="user_data" transfer-ownership="none" closure="4">
13924 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
13925 <type name="gpointer" c:type="gpointer"/>
13929 <virtual-method name="query_filesystem_info_finish"
13930 invoker="query_filesystem_info_finish"
13932 <doc xml:whitespace="preserve">Finishes an asynchronous filesystem info query. See
13933 g_file_query_filesystem_info_async().
13934 Free the returned object with g_object_unref().</doc>
13935 <return-value transfer-ownership="full">
13936 <doc xml:whitespace="preserve">#GFileInfo for given @file or %NULL on error.</doc>
13937 <type name="FileInfo" c:type="GFileInfo*"/>
13940 <parameter name="res" transfer-ownership="none">
13941 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
13942 <type name="AsyncResult" c:type="GAsyncResult*"/>
13946 <virtual-method name="query_info" invoker="query_info" throws="1">
13947 <doc xml:whitespace="preserve">Gets the requested information about specified @file. The result
13948 is a #GFileInfo object that contains key-value attributes (such as
13949 the type or size of the file).
13950 The @attributes value is a string that specifies the file attributes that
13951 should be gathered. It is not an error if it's not possible to read a particular
13952 requested attribute from a file - it just won't be set. @attributes should
13953 be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
13954 means all attributes, and a wildcard like "standard::*" means all attributes in the standard
13955 namespace. An example attribute query be "standard::*,owner::user".
13956 The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
13957 If @cancellable is not %NULL, then the operation can be cancelled by
13958 triggering the cancellable object from another thread. If the operation
13959 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13960 For symlinks, normally the information about the target of the
13961 symlink is returned, rather than information about the symlink itself.
13962 However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
13963 information about the symlink itself will be returned. Also, for symlinks
13964 that point to non-existing files the information about the symlink itself
13966 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
13967 Other errors are possible too, and depend on what kind of filesystem the file is on.
13968 Free the returned object with g_object_unref().</doc>
13969 <return-value transfer-ownership="full">
13970 <doc xml:whitespace="preserve">a #GFileInfo for the given @file, or %NULL on error.</doc>
13971 <type name="FileInfo" c:type="GFileInfo*"/>
13974 <parameter name="attributes" transfer-ownership="none">
13975 <doc xml:whitespace="preserve">an attribute query string.</doc>
13976 <type name="utf8" c:type="char*"/>
13978 <parameter name="flags" transfer-ownership="none">
13979 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
13980 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
13982 <parameter name="cancellable"
13983 transfer-ownership="none"
13985 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
13986 <type name="Cancellable" c:type="GCancellable*"/>
13990 <virtual-method name="query_info_async" invoker="query_info_async">
13991 <doc xml:whitespace="preserve">Asynchronously gets the requested information about specified @file. The result
13992 is a #GFileInfo object that contains key-value attributes (such as type or size
13994 For more details, see g_file_query_info() which is
13995 the synchronous version of this call.
13996 When the operation is finished, @callback will be called. You can then call
13997 g_file_query_info_finish() to get the result of the operation.</doc>
13998 <return-value transfer-ownership="none">
13999 <type name="none" c:type="void"/>
14002 <parameter name="attributes" transfer-ownership="none">
14003 <doc xml:whitespace="preserve">an attribute query string.</doc>
14004 <type name="utf8" c:type="char*"/>
14006 <parameter name="flags" transfer-ownership="none">
14007 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
14008 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
14010 <parameter name="io_priority" transfer-ownership="none">
14011 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
14012 <type name="gint" c:type="int"/>
14014 <parameter name="cancellable"
14015 transfer-ownership="none"
14017 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14018 <type name="Cancellable" c:type="GCancellable*"/>
14020 <parameter name="callback"
14021 transfer-ownership="none"
14024 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
14025 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14027 <parameter name="user_data" transfer-ownership="none" closure="5">
14028 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14029 <type name="gpointer" c:type="gpointer"/>
14033 <virtual-method name="query_info_finish"
14034 invoker="query_info_finish"
14036 <doc xml:whitespace="preserve">Finishes an asynchronous file info query.
14037 See g_file_query_info_async().
14038 Free the returned object with g_object_unref().</doc>
14039 <return-value transfer-ownership="full">
14040 <doc xml:whitespace="preserve">#GFileInfo for given @file or %NULL on error.</doc>
14041 <type name="FileInfo" c:type="GFileInfo*"/>
14044 <parameter name="res" transfer-ownership="none">
14045 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14046 <type name="AsyncResult" c:type="GAsyncResult*"/>
14050 <virtual-method name="query_settable_attributes"
14051 invoker="query_settable_attributes"
14053 <doc xml:whitespace="preserve">Obtain the list of settable attributes for the file.
14054 Returns the type and full attribute name of all the attributes
14055 that can be set on this file. This doesn't mean setting it will always
14056 succeed though, you might get an access failure, or some specific
14057 file may not support a specific attribute.
14058 If @cancellable is not %NULL, then the operation can be cancelled by
14059 triggering the cancellable object from another thread. If the operation
14060 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14061 When you are done with it, release it with g_file_attribute_info_list_unref()</doc>
14062 <return-value transfer-ownership="full">
14063 <doc xml:whitespace="preserve">a #GFileAttributeInfoList describing the settable attributes.</doc>
14064 <type name="FileAttributeInfoList" c:type="GFileAttributeInfoList*"/>
14067 <parameter name="cancellable"
14068 transfer-ownership="none"
14070 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14071 <type name="Cancellable" c:type="GCancellable*"/>
14075 <virtual-method name="query_writable_namespaces"
14076 invoker="query_writable_namespaces"
14078 <doc xml:whitespace="preserve">Obtain the list of attribute namespaces where new attributes
14079 can be created by a user. An example of this is extended
14080 attributes (in the "xattr" namespace).
14081 If @cancellable is not %NULL, then the operation can be cancelled by
14082 triggering the cancellable object from another thread. If the operation
14083 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14084 When you are done with it, release it with g_file_attribute_info_list_unref()</doc>
14085 <return-value transfer-ownership="full">
14086 <doc xml:whitespace="preserve">a #GFileAttributeInfoList describing the writable namespaces.</doc>
14087 <type name="FileAttributeInfoList" c:type="GFileAttributeInfoList*"/>
14090 <parameter name="cancellable"
14091 transfer-ownership="none"
14093 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14094 <type name="Cancellable" c:type="GCancellable*"/>
14098 <virtual-method name="read_async" invoker="read_async">
14099 <doc xml:whitespace="preserve">Asynchronously opens @file for reading.
14100 For more details, see g_file_read() which is
14101 the synchronous version of this call.
14102 When the operation is finished, @callback will be called. You can then call
14103 g_file_read_finish() to get the result of the operation.</doc>
14104 <return-value transfer-ownership="none">
14105 <type name="none" c:type="void"/>
14108 <parameter name="io_priority" transfer-ownership="none">
14109 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
14110 <type name="gint" c:type="int"/>
14112 <parameter name="cancellable"
14113 transfer-ownership="none"
14115 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14116 <type name="Cancellable" c:type="GCancellable*"/>
14118 <parameter name="callback"
14119 transfer-ownership="none"
14122 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
14123 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14125 <parameter name="user_data" transfer-ownership="none" closure="3">
14126 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14127 <type name="gpointer" c:type="gpointer"/>
14131 <virtual-method name="read_finish" invoker="read_finish" throws="1">
14132 <doc xml:whitespace="preserve">Finishes an asynchronous file read operation started with
14133 g_file_read_async().
14134 Free the returned object with g_object_unref().</doc>
14135 <return-value transfer-ownership="full">
14136 <doc xml:whitespace="preserve">a #GFileInputStream or %NULL on error.</doc>
14137 <type name="FileInputStream" c:type="GFileInputStream*"/>
14140 <parameter name="res" transfer-ownership="none">
14141 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14142 <type name="AsyncResult" c:type="GAsyncResult*"/>
14146 <virtual-method name="read_fn" invoker="read" throws="1">
14147 <doc xml:whitespace="preserve">Opens a file for reading. The result is a #GFileInputStream that
14148 can be used to read the contents of the file.
14149 If @cancellable is not %NULL, then the operation can be cancelled by
14150 triggering the cancellable object from another thread. If the operation
14151 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14152 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
14153 If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
14154 Other errors are possible too, and depend on what kind of filesystem the file is on.
14155 Free the returned object with g_object_unref().</doc>
14156 <return-value transfer-ownership="full">
14157 <doc xml:whitespace="preserve">#GFileInputStream or %NULL on error.</doc>
14158 <type name="FileInputStream" c:type="GFileInputStream*"/>
14161 <parameter name="cancellable"
14162 transfer-ownership="none"
14164 <doc xml:whitespace="preserve">a #GCancellable</doc>
14165 <type name="Cancellable" c:type="GCancellable*"/>
14169 <virtual-method name="replace" invoker="replace" throws="1">
14170 <doc xml:whitespace="preserve">Returns an output stream for overwriting the file, possibly
14171 creating a backup copy of the file first. If the file doesn't exist,
14172 it will be created.
14173 This will try to replace the file in the safest way possible so
14174 that any errors during the writing will not affect an already
14175 existing copy of the file. For instance, for local files it
14176 may write to a temporary file and then atomically rename over
14177 the destination when the stream is closed.
14178 By default files created are generally readable by everyone,
14179 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
14180 will be made readable only to the current user, to the level that
14181 is supported on the target filesystem.
14182 If @cancellable is not %NULL, then the operation can be cancelled by
14183 triggering the cancellable object from another thread. If the operation
14184 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14185 If you pass in a non-#NULL @etag value, then this value is
14186 compared to the current entity tag of the file, and if they differ
14187 an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
14188 that the file has been changed since you last read it. You can get
14189 the new etag from g_file_output_stream_get_etag() after you've
14190 finished writing and closed the #GFileOutputStream. When you load
14191 a new file you can use g_file_input_stream_query_info() to get
14192 the etag of the file.
14193 If @make_backup is %TRUE, this function will attempt to make a backup
14194 of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
14195 error will be returned. If you want to replace anyway, try again with
14196 If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
14197 and if the file is some other form of non-regular file then a
14198 G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
14199 Some file systems don't allow all file names, and may
14200 return an G_IO_ERROR_INVALID_FILENAME error, and if the name
14201 is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
14202 Other errors are possible too, and depend on what kind of
14203 filesystem the file is on.
14204 Free the returned object with g_object_unref().</doc>
14205 <return-value transfer-ownership="full">
14206 <doc xml:whitespace="preserve">a #GFileOutputStream or %NULL on error.</doc>
14207 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
14210 <parameter name="etag" transfer-ownership="none" allow-none="1">
14211 <doc xml:whitespace="preserve">an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore.</doc>
14212 <type name="utf8" c:type="char*"/>
14214 <parameter name="make_backup" transfer-ownership="none">
14215 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
14216 <type name="gboolean" c:type="gboolean"/>
14218 <parameter name="flags" transfer-ownership="none">
14219 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
14220 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
14222 <parameter name="cancellable"
14223 transfer-ownership="none"
14225 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14226 <type name="Cancellable" c:type="GCancellable*"/>
14230 <virtual-method name="replace_async" invoker="replace_async">
14231 <doc xml:whitespace="preserve">Asynchronously overwrites the file, replacing the contents, possibly
14232 creating a backup copy of the file first.
14233 For more details, see g_file_replace() which is
14234 the synchronous version of this call.
14235 When the operation is finished, @callback will be called. You can then call
14236 g_file_replace_finish() to get the result of the operation.</doc>
14237 <return-value transfer-ownership="none">
14238 <type name="none" c:type="void"/>
14241 <parameter name="etag" transfer-ownership="none" allow-none="1">
14242 <doc xml:whitespace="preserve">an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.</doc>
14243 <type name="utf8" c:type="char*"/>
14245 <parameter name="make_backup" transfer-ownership="none">
14246 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
14247 <type name="gboolean" c:type="gboolean"/>
14249 <parameter name="flags" transfer-ownership="none">
14250 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
14251 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
14253 <parameter name="io_priority" transfer-ownership="none">
14254 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
14255 <type name="gint" c:type="int"/>
14257 <parameter name="cancellable"
14258 transfer-ownership="none"
14260 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14261 <type name="Cancellable" c:type="GCancellable*"/>
14263 <parameter name="callback"
14264 transfer-ownership="none"
14267 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
14268 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14270 <parameter name="user_data" transfer-ownership="none" closure="6">
14271 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14272 <type name="gpointer" c:type="gpointer"/>
14276 <virtual-method name="replace_finish"
14277 invoker="replace_finish"
14279 <doc xml:whitespace="preserve">Finishes an asynchronous file replace operation started with
14280 g_file_replace_async().
14281 Free the returned object with g_object_unref().</doc>
14282 <return-value transfer-ownership="full">
14283 <doc xml:whitespace="preserve">a #GFileOutputStream, or %NULL on error.</doc>
14284 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
14287 <parameter name="res" transfer-ownership="none">
14288 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14289 <type name="AsyncResult" c:type="GAsyncResult*"/>
14293 <virtual-method name="replace_readwrite"
14294 invoker="replace_readwrite"
14297 <doc xml:whitespace="preserve">Returns an output stream for overwriting the file in readwrite mode,
14298 possibly creating a backup copy of the file first. If the file doesn't
14299 exist, it will be created.
14300 For details about the behaviour, see g_file_replace() which does the same
14301 thing but returns an output stream only.
14302 Note that in many non-local file cases read and write streams are not
14303 supported, so make sure you really need to do read and write streaming,
14304 rather than just opening for reading or writing.
14305 Free the returned object with g_object_unref().</doc>
14306 <return-value transfer-ownership="full">
14307 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
14308 <type name="FileIOStream" c:type="GFileIOStream*"/>
14311 <parameter name="etag" transfer-ownership="none" allow-none="1">
14312 <doc xml:whitespace="preserve">an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore</doc>
14313 <type name="utf8" c:type="char*"/>
14315 <parameter name="make_backup" transfer-ownership="none">
14316 <doc xml:whitespace="preserve">%TRUE if a backup should be created</doc>
14317 <type name="gboolean" c:type="gboolean"/>
14319 <parameter name="flags" transfer-ownership="none">
14320 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
14321 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
14323 <parameter name="cancellable"
14324 transfer-ownership="none"
14326 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
14327 <type name="Cancellable" c:type="GCancellable*"/>
14331 <virtual-method name="replace_readwrite_async"
14332 invoker="replace_readwrite_async"
14334 <doc xml:whitespace="preserve">Asynchronously overwrites the file in read-write mode, replacing the
14335 contents, possibly creating a backup copy of the file first.
14336 For more details, see g_file_replace_readwrite() which is
14337 the synchronous version of this call.
14338 When the operation is finished, @callback will be called. You can then
14339 call g_file_replace_readwrite_finish() to get the result of the operation.</doc>
14340 <return-value transfer-ownership="none">
14341 <type name="none" c:type="void"/>
14344 <parameter name="etag" transfer-ownership="none" allow-none="1">
14345 <doc xml:whitespace="preserve">an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.</doc>
14346 <type name="utf8" c:type="char*"/>
14348 <parameter name="make_backup" transfer-ownership="none">
14349 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
14350 <type name="gboolean" c:type="gboolean"/>
14352 <parameter name="flags" transfer-ownership="none">
14353 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
14354 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
14356 <parameter name="io_priority" transfer-ownership="none">
14357 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
14358 <type name="gint" c:type="int"/>
14360 <parameter name="cancellable"
14361 transfer-ownership="none"
14363 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14364 <type name="Cancellable" c:type="GCancellable*"/>
14366 <parameter name="callback"
14367 transfer-ownership="none"
14370 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
14371 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14373 <parameter name="user_data" transfer-ownership="none" closure="6">
14374 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14375 <type name="gpointer" c:type="gpointer"/>
14379 <virtual-method name="replace_readwrite_finish"
14380 invoker="replace_readwrite_finish"
14383 <doc xml:whitespace="preserve">Finishes an asynchronous file replace operation started with
14384 g_file_replace_readwrite_async().
14385 Free the returned object with g_object_unref().</doc>
14386 <return-value transfer-ownership="full">
14387 <doc xml:whitespace="preserve">a #GFileIOStream, or %NULL on error.</doc>
14388 <type name="FileIOStream" c:type="GFileIOStream*"/>
14391 <parameter name="res" transfer-ownership="none">
14392 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14393 <type name="AsyncResult" c:type="GAsyncResult*"/>
14397 <virtual-method name="resolve_relative_path"
14398 invoker="resolve_relative_path">
14399 <doc xml:whitespace="preserve">Resolves a relative path for @file to an absolute path.
14400 This call does no blocking i/o.
14401 is %NULL or if @file is invalid.
14402 Free the returned object with g_object_unref().</doc>
14403 <return-value transfer-ownership="full">
14404 <doc xml:whitespace="preserve">#GFile to the resolved path. %NULL if @relative_path</doc>
14405 <type name="File" c:type="GFile*"/>
14408 <parameter name="relative_path" transfer-ownership="none">
14409 <doc xml:whitespace="preserve">a given relative path string.</doc>
14410 <type name="utf8" c:type="char*"/>
14414 <virtual-method name="set_attribute" invoker="set_attribute" throws="1">
14415 <doc xml:whitespace="preserve">Sets an attribute in the file with attribute name @attribute to @value.
14416 If @cancellable is not %NULL, then the operation can be cancelled by
14417 triggering the cancellable object from another thread. If the operation
14418 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
14419 <return-value transfer-ownership="none">
14420 <doc xml:whitespace="preserve">%TRUE if the attribute was set, %FALSE otherwise.</doc>
14421 <type name="gboolean" c:type="gboolean"/>
14424 <parameter name="attribute" transfer-ownership="none">
14425 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
14426 <type name="utf8" c:type="char*"/>
14428 <parameter name="type" transfer-ownership="none">
14429 <doc xml:whitespace="preserve">The type of the attribute</doc>
14430 <type name="FileAttributeType" c:type="GFileAttributeType"/>
14432 <parameter name="value_p" transfer-ownership="none">
14433 <doc xml:whitespace="preserve">a pointer to the value (or the pointer itself if the type is a pointer type)</doc>
14434 <type name="gpointer" c:type="gpointer"/>
14436 <parameter name="flags" transfer-ownership="none">
14437 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
14438 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
14440 <parameter name="cancellable"
14441 transfer-ownership="none"
14443 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14444 <type name="Cancellable" c:type="GCancellable*"/>
14448 <virtual-method name="set_attributes_async"
14449 invoker="set_attributes_async">
14450 <doc xml:whitespace="preserve">Asynchronously sets the attributes of @file with @info.
14451 For more details, see g_file_set_attributes_from_info() which is
14452 the synchronous version of this call.
14453 When the operation is finished, @callback will be called. You can then call
14454 g_file_set_attributes_finish() to get the result of the operation.</doc>
14455 <return-value transfer-ownership="none">
14456 <type name="none" c:type="void"/>
14459 <parameter name="info" transfer-ownership="none">
14460 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
14461 <type name="FileInfo" c:type="GFileInfo*"/>
14463 <parameter name="flags" transfer-ownership="none">
14464 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
14465 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
14467 <parameter name="io_priority" transfer-ownership="none">
14468 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
14469 <type name="gint" c:type="int"/>
14471 <parameter name="cancellable"
14472 transfer-ownership="none"
14474 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14475 <type name="Cancellable" c:type="GCancellable*"/>
14477 <parameter name="callback"
14478 transfer-ownership="none"
14481 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
14482 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14484 <parameter name="user_data" transfer-ownership="none" closure="5">
14485 <doc xml:whitespace="preserve">a #gpointer.</doc>
14486 <type name="gpointer" c:type="gpointer"/>
14490 <virtual-method name="set_attributes_finish"
14491 invoker="set_attributes_finish"
14493 <doc xml:whitespace="preserve">Finishes setting an attribute started in g_file_set_attributes_async().</doc>
14494 <return-value transfer-ownership="none">
14495 <doc xml:whitespace="preserve">%TRUE if the attributes were set correctly, %FALSE otherwise.</doc>
14496 <type name="gboolean" c:type="gboolean"/>
14499 <parameter name="result" transfer-ownership="none">
14500 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14501 <type name="AsyncResult" c:type="GAsyncResult*"/>
14503 <parameter name="info"
14505 caller-allocates="0"
14506 transfer-ownership="full">
14507 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
14508 <type name="FileInfo" c:type="GFileInfo**"/>
14512 <virtual-method name="set_attributes_from_info"
14513 invoker="set_attributes_from_info"
14515 <doc xml:whitespace="preserve">Tries to set all attributes in the #GFileInfo on the target values,
14516 not stopping on the first error.
14517 If there is any error during this operation then @error will be set to
14518 the first error. Error on particular fields are flagged by setting
14519 the "status" field in the attribute value to
14520 %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
14522 If @cancellable is not %NULL, then the operation can be cancelled by
14523 triggering the cancellable object from another thread. If the operation
14524 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
14525 <return-value transfer-ownership="none">
14526 <doc xml:whitespace="preserve">%TRUE if there was any error, %FALSE otherwise.</doc>
14527 <type name="gboolean" c:type="gboolean"/>
14530 <parameter name="info" transfer-ownership="none">
14531 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
14532 <type name="FileInfo" c:type="GFileInfo*"/>
14534 <parameter name="flags" transfer-ownership="none">
14535 <doc xml:whitespace="preserve">#GFileQueryInfoFlags</doc>
14536 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
14538 <parameter name="cancellable"
14539 transfer-ownership="none"
14541 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14542 <type name="Cancellable" c:type="GCancellable*"/>
14546 <virtual-method name="set_display_name"
14547 invoker="set_display_name"
14549 <doc xml:whitespace="preserve">Renames @file to the specified display name.
14550 The display name is converted from UTF8 to the correct encoding for the target
14551 filesystem if possible and the @file is renamed to this.
14552 If you want to implement a rename operation in the user interface the edit name
14553 (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
14554 widget, and then the result after editing should be passed to g_file_set_display_name().
14555 On success the resulting converted filename is returned.
14556 If @cancellable is not %NULL, then the operation can be cancelled by
14557 triggering the cancellable object from another thread. If the operation
14558 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14559 if there was an error.
14560 Free the returned object with g_object_unref().</doc>
14561 <return-value transfer-ownership="full">
14562 <doc xml:whitespace="preserve">a #GFile specifying what @file was renamed to, or %NULL</doc>
14563 <type name="File" c:type="GFile*"/>
14566 <parameter name="display_name" transfer-ownership="none">
14567 <doc xml:whitespace="preserve">a string.</doc>
14568 <type name="utf8" c:type="char*"/>
14570 <parameter name="cancellable"
14571 transfer-ownership="none"
14573 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14574 <type name="Cancellable" c:type="GCancellable*"/>
14578 <virtual-method name="set_display_name_async"
14579 invoker="set_display_name_async">
14580 <doc xml:whitespace="preserve">Asynchronously sets the display name for a given #GFile.
14581 For more details, see g_file_set_display_name() which is
14582 the synchronous version of this call.
14583 When the operation is finished, @callback will be called. You can then call
14584 g_file_set_display_name_finish() to get the result of the operation.</doc>
14585 <return-value transfer-ownership="none">
14586 <type name="none" c:type="void"/>
14589 <parameter name="display_name" transfer-ownership="none">
14590 <doc xml:whitespace="preserve">a string.</doc>
14591 <type name="utf8" c:type="char*"/>
14593 <parameter name="io_priority" transfer-ownership="none">
14594 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
14595 <type name="gint" c:type="int"/>
14597 <parameter name="cancellable"
14598 transfer-ownership="none"
14600 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14601 <type name="Cancellable" c:type="GCancellable*"/>
14603 <parameter name="callback"
14604 transfer-ownership="none"
14607 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
14608 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14610 <parameter name="user_data" transfer-ownership="none" closure="4">
14611 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14612 <type name="gpointer" c:type="gpointer"/>
14616 <virtual-method name="set_display_name_finish"
14617 invoker="set_display_name_finish"
14619 <doc xml:whitespace="preserve">Finishes setting a display name started with
14620 g_file_set_display_name_async().
14621 Free the returned object with g_object_unref().</doc>
14622 <return-value transfer-ownership="full">
14623 <doc xml:whitespace="preserve">a #GFile or %NULL on error.</doc>
14624 <type name="File" c:type="GFile*"/>
14627 <parameter name="res" transfer-ownership="none">
14628 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14629 <type name="AsyncResult" c:type="GAsyncResult*"/>
14633 <virtual-method name="start_mountable"
14634 invoker="start_mountable"
14636 <doc xml:whitespace="preserve">Starts a file of type G_FILE_TYPE_MOUNTABLE.
14637 Using @start_operation, you can request callbacks when, for instance,
14638 passwords are needed during authentication.
14639 If @cancellable is not %NULL, then the operation can be cancelled by
14640 triggering the cancellable object from another thread. If the operation
14641 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14642 When the operation is finished, @callback will be called. You can then call
14643 g_file_mount_mountable_finish() to get the result of the operation.</doc>
14644 <return-value transfer-ownership="none">
14645 <type name="none" c:type="void"/>
14648 <parameter name="flags" transfer-ownership="none">
14649 <doc xml:whitespace="preserve">flags affecting the operation</doc>
14650 <type name="DriveStartFlags" c:type="GDriveStartFlags"/>
14652 <parameter name="start_operation" transfer-ownership="none">
14653 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
14654 <type name="MountOperation" c:type="GMountOperation*"/>
14656 <parameter name="cancellable"
14657 transfer-ownership="none"
14659 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14660 <type name="Cancellable" c:type="GCancellable*"/>
14662 <parameter name="callback"
14663 transfer-ownership="none"
14666 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
14667 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14669 <parameter name="user_data" transfer-ownership="none" closure="4">
14670 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14671 <type name="gpointer" c:type="gpointer"/>
14675 <virtual-method name="start_mountable_finish"
14676 invoker="start_mountable_finish"
14679 <doc xml:whitespace="preserve">Finishes a start operation. See g_file_start_mountable() for details.
14680 Finish an asynchronous start operation that was started
14681 with g_file_start_mountable().
14683 <return-value transfer-ownership="none">
14684 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
14685 <type name="gboolean" c:type="gboolean"/>
14688 <parameter name="result" transfer-ownership="none">
14689 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14690 <type name="AsyncResult" c:type="GAsyncResult*"/>
14694 <virtual-method name="stop_mountable"
14695 invoker="stop_mountable"
14697 <doc xml:whitespace="preserve">Stops a file of type G_FILE_TYPE_MOUNTABLE.
14698 If @cancellable is not %NULL, then the operation can be cancelled by
14699 triggering the cancellable object from another thread. If the operation
14700 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14701 When the operation is finished, @callback will be called. You can then call
14702 g_file_stop_mountable_finish() to get the result of the operation.</doc>
14703 <return-value transfer-ownership="none">
14704 <type name="none" c:type="void"/>
14707 <parameter name="flags" transfer-ownership="none">
14708 <doc xml:whitespace="preserve">flags affecting the operation</doc>
14709 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
14711 <parameter name="mount_operation" transfer-ownership="none">
14712 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
14713 <type name="MountOperation" c:type="GMountOperation*"/>
14715 <parameter name="cancellable"
14716 transfer-ownership="none"
14718 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14719 <type name="Cancellable" c:type="GCancellable*"/>
14721 <parameter name="callback"
14722 transfer-ownership="none"
14725 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
14726 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14728 <parameter name="user_data" transfer-ownership="none" closure="4">
14729 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14730 <type name="gpointer" c:type="gpointer"/>
14734 <virtual-method name="stop_mountable_finish"
14735 invoker="stop_mountable_finish"
14738 <doc xml:whitespace="preserve">Finishes an stop operation, see g_file_stop_mountable() for details.
14739 Finish an asynchronous stop operation that was started
14740 with g_file_stop_mountable().
14742 <return-value transfer-ownership="none">
14743 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
14744 <type name="gboolean" c:type="gboolean"/>
14747 <parameter name="result" transfer-ownership="none">
14748 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14749 <type name="AsyncResult" c:type="GAsyncResult*"/>
14753 <virtual-method name="trash" invoker="trash" throws="1">
14754 <doc xml:whitespace="preserve">Sends @file to the "Trashcan", if possible. This is similar to
14755 deleting it, but the user can recover it before emptying the trashcan.
14756 Not all file systems support trashing, so this call can return the
14757 %G_IO_ERROR_NOT_SUPPORTED error.
14758 If @cancellable is not %NULL, then the operation can be cancelled by
14759 triggering the cancellable object from another thread. If the operation
14760 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
14761 <return-value transfer-ownership="none">
14762 <doc xml:whitespace="preserve">%TRUE on successful trash, %FALSE otherwise.</doc>
14763 <type name="gboolean" c:type="gboolean"/>
14766 <parameter name="cancellable"
14767 transfer-ownership="none"
14769 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14770 <type name="Cancellable" c:type="GCancellable*"/>
14774 <virtual-method name="unmount_mountable"
14775 invoker="unmount_mountable"
14776 deprecated="Use g_file_unmount_mountable_with_operation() instead."
14777 deprecated-version="2.22">
14778 <doc xml:whitespace="preserve">Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
14779 If @cancellable is not %NULL, then the operation can be cancelled by
14780 triggering the cancellable object from another thread. If the operation
14781 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14782 When the operation is finished, @callback will be called. You can then call
14783 g_file_unmount_mountable_finish() to get the result of the operation.</doc>
14784 <return-value transfer-ownership="none">
14785 <type name="none" c:type="void"/>
14788 <parameter name="flags" transfer-ownership="none">
14789 <doc xml:whitespace="preserve">flags affecting the operation</doc>
14790 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
14792 <parameter name="cancellable"
14793 transfer-ownership="none"
14795 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14796 <type name="Cancellable" c:type="GCancellable*"/>
14798 <parameter name="callback"
14799 transfer-ownership="none"
14802 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
14803 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14805 <parameter name="user_data" transfer-ownership="none" closure="3">
14806 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14807 <type name="gpointer" c:type="gpointer"/>
14811 <virtual-method name="unmount_mountable_finish"
14812 invoker="unmount_mountable_finish"
14813 deprecated="Use g_file_unmount_mountable_with_operation_finish() instead."
14814 deprecated-version="2.22"
14816 <doc xml:whitespace="preserve">Finishes an unmount operation, see g_file_unmount_mountable() for details.
14817 Finish an asynchronous unmount operation that was started
14818 with g_file_unmount_mountable().
14820 <return-value transfer-ownership="none">
14821 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
14822 <type name="gboolean" c:type="gboolean"/>
14825 <parameter name="result" transfer-ownership="none">
14826 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14827 <type name="AsyncResult" c:type="GAsyncResult*"/>
14831 <virtual-method name="unmount_mountable_with_operation"
14832 invoker="unmount_mountable_with_operation"
14834 <doc xml:whitespace="preserve">Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
14835 If @cancellable is not %NULL, then the operation can be cancelled by
14836 triggering the cancellable object from another thread. If the operation
14837 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14838 When the operation is finished, @callback will be called. You can then call
14839 g_file_unmount_mountable_finish() to get the result of the operation.</doc>
14840 <return-value transfer-ownership="none">
14841 <type name="none" c:type="void"/>
14844 <parameter name="flags" transfer-ownership="none">
14845 <doc xml:whitespace="preserve">flags affecting the operation</doc>
14846 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
14848 <parameter name="mount_operation" transfer-ownership="none">
14849 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
14850 <type name="MountOperation" c:type="GMountOperation*"/>
14852 <parameter name="cancellable"
14853 transfer-ownership="none"
14855 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14856 <type name="Cancellable" c:type="GCancellable*"/>
14858 <parameter name="callback"
14859 transfer-ownership="none"
14862 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
14863 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14865 <parameter name="user_data" transfer-ownership="none" closure="4">
14866 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14867 <type name="gpointer" c:type="gpointer"/>
14871 <virtual-method name="unmount_mountable_with_operation_finish"
14872 invoker="unmount_mountable_with_operation_finish"
14875 <doc xml:whitespace="preserve">Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
14876 Finish an asynchronous unmount operation that was started
14877 with g_file_unmount_mountable_with_operation().
14879 <return-value transfer-ownership="none">
14880 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
14881 <type name="gboolean" c:type="gboolean"/>
14884 <parameter name="result" transfer-ownership="none">
14885 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
14886 <type name="AsyncResult" c:type="GAsyncResult*"/>
14890 <method name="append_to" c:identifier="g_file_append_to" throws="1">
14891 <doc xml:whitespace="preserve">Gets an output stream for appending data to the file. If
14892 the file doesn't already exist it is created.
14893 By default files created are generally readable by everyone,
14894 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
14895 will be made readable only to the current user, to the level that
14896 is supported on the target filesystem.
14897 If @cancellable is not %NULL, then the operation can be cancelled by
14898 triggering the cancellable object from another thread. If the operation
14899 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14900 Some file systems don't allow all file names, and may
14901 return an %G_IO_ERROR_INVALID_FILENAME error.
14902 If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be
14903 returned. Other errors are possible too, and depend on what kind of
14904 filesystem the file is on.
14905 Free the returned object with g_object_unref().</doc>
14906 <return-value transfer-ownership="full">
14907 <doc xml:whitespace="preserve">a #GFileOutputStream, or %NULL on error.</doc>
14908 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
14911 <parameter name="flags" transfer-ownership="none">
14912 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
14913 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
14915 <parameter name="cancellable"
14916 transfer-ownership="none"
14918 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14919 <type name="Cancellable" c:type="GCancellable*"/>
14923 <method name="append_to_async" c:identifier="g_file_append_to_async">
14924 <doc xml:whitespace="preserve">Asynchronously opens @file for appending.
14925 For more details, see g_file_append_to() which is
14926 the synchronous version of this call.
14927 When the operation is finished, @callback will be called. You can then call
14928 g_file_append_to_finish() to get the result of the operation.</doc>
14929 <return-value transfer-ownership="none">
14930 <type name="none" c:type="void"/>
14933 <parameter name="flags" transfer-ownership="none">
14934 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
14935 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
14937 <parameter name="io_priority" transfer-ownership="none">
14938 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
14939 <type name="gint" c:type="int"/>
14941 <parameter name="cancellable"
14942 transfer-ownership="none"
14944 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
14945 <type name="Cancellable" c:type="GCancellable*"/>
14947 <parameter name="callback"
14948 transfer-ownership="none"
14951 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
14952 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
14954 <parameter name="user_data" transfer-ownership="none">
14955 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
14956 <type name="gpointer" c:type="gpointer"/>
14960 <method name="append_to_finish"
14961 c:identifier="g_file_append_to_finish"
14963 <doc xml:whitespace="preserve">Finishes an asynchronous file append operation started with
14964 g_file_append_to_async().
14965 Free the returned object with g_object_unref().</doc>
14966 <return-value transfer-ownership="full">
14967 <doc xml:whitespace="preserve">a valid #GFileOutputStream or %NULL on error.</doc>
14968 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
14971 <parameter name="res" transfer-ownership="none">
14972 <doc xml:whitespace="preserve">#GAsyncResult</doc>
14973 <type name="AsyncResult" c:type="GAsyncResult*"/>
14977 <method name="copy"
14978 c:identifier="g_file_copy"
14981 <doc xml:whitespace="preserve">Copies the file @source to the location specified by @destination.
14982 Can not handle recursive copies of directories.
14983 If the flag #G_FILE_COPY_OVERWRITE is specified an already
14984 existing @destination file is overwritten.
14985 If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
14986 will be copied as symlinks, otherwise the target of the
14987 If @cancellable is not %NULL, then the operation can be cancelled by
14988 triggering the cancellable object from another thread. If the operation
14989 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
14990 If @progress_callback is not %NULL, then the operation can be monitored by
14991 setting this to a #GFileProgressCallback function. @progress_callback_data
14992 will be passed to this function. It is guaranteed that this callback will
14993 be called after all data has been transferred with the total number of bytes
14994 copied during the operation.
14995 If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
14996 error is returned, independent on the status of the @destination.
14997 If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
14998 error G_IO_ERROR_EXISTS is returned.
14999 If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
15000 error is returned. If trying to overwrite a directory with a directory the
15001 G_IO_ERROR_WOULD_MERGE error is returned.
15002 If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
15003 specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
15005 If you are interested in copying the #GFile object itself (not the on-disk
15006 file), see g_file_dup().</doc>
15007 <return-value transfer-ownership="none">
15008 <doc xml:whitespace="preserve">%TRUE on success, %FALSE otherwise.</doc>
15009 <type name="gboolean" c:type="gboolean"/>
15012 <parameter name="destination" transfer-ownership="none">
15013 <doc xml:whitespace="preserve">destination #GFile</doc>
15014 <type name="File" c:type="GFile*"/>
15016 <parameter name="flags" transfer-ownership="none">
15017 <doc xml:whitespace="preserve">set of #GFileCopyFlags</doc>
15018 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
15020 <parameter name="cancellable"
15021 transfer-ownership="none"
15023 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15024 <type name="Cancellable" c:type="GCancellable*"/>
15026 <parameter name="progress_callback"
15027 transfer-ownership="none"
15029 <doc xml:whitespace="preserve">function to callback with progress information</doc>
15030 <type name="FileProgressCallback" c:type="GFileProgressCallback"/>
15032 <parameter name="progress_callback_data" transfer-ownership="none">
15033 <doc xml:whitespace="preserve">user data to pass to @progress_callback</doc>
15034 <type name="gpointer" c:type="gpointer"/>
15038 <method name="copy_async"
15039 c:identifier="g_file_copy_async"
15040 introspectable="0">
15041 <doc xml:whitespace="preserve">Copies the file @source to the location specified by @destination
15042 asynchronously. For details of the behaviour, see g_file_copy().
15043 If @progress_callback is not %NULL, then that function that will be called
15044 just like in g_file_copy(), however the callback will run in the main loop,
15045 not in the thread that is doing the I/O operation.
15046 When the operation is finished, @callback will be called. You can then call
15047 g_file_copy_finish() to get the result of the operation.</doc>
15048 <return-value transfer-ownership="none">
15049 <type name="none" c:type="void"/>
15052 <parameter name="destination" transfer-ownership="none">
15053 <doc xml:whitespace="preserve">destination #GFile</doc>
15054 <type name="File" c:type="GFile*"/>
15056 <parameter name="flags" transfer-ownership="none">
15057 <doc xml:whitespace="preserve">set of #GFileCopyFlags</doc>
15058 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
15060 <parameter name="io_priority" transfer-ownership="none">
15061 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
15062 <type name="gint" c:type="int"/>
15064 <parameter name="cancellable"
15065 transfer-ownership="none"
15067 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15068 <type name="Cancellable" c:type="GCancellable*"/>
15070 <parameter name="progress_callback"
15071 transfer-ownership="none"
15073 <doc xml:whitespace="preserve">function to callback with progress information</doc>
15074 <type name="FileProgressCallback" c:type="GFileProgressCallback"/>
15076 <parameter name="progress_callback_data" transfer-ownership="none">
15077 <doc xml:whitespace="preserve">user data to pass to @progress_callback</doc>
15078 <type name="gpointer" c:type="gpointer"/>
15080 <parameter name="callback"
15081 transfer-ownership="none"
15084 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
15085 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15087 <parameter name="user_data" transfer-ownership="none">
15088 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15089 <type name="gpointer" c:type="gpointer"/>
15093 <method name="copy_attributes"
15094 c:identifier="g_file_copy_attributes"
15096 <doc xml:whitespace="preserve">Copies the file attributes from @source to @destination.
15097 Normally only a subset of the file attributes are copied,
15098 those that are copies in a normal file copy operation
15099 (which for instance does not include e.g. owner). However
15100 if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
15101 all the metadata that is possible to copy is copied. This
15102 is useful when implementing move by copy + delete source.</doc>
15103 <return-value transfer-ownership="none">
15104 <doc xml:whitespace="preserve">%TRUE if the attributes were copied successfully, %FALSE otherwise.</doc>
15105 <type name="gboolean" c:type="gboolean"/>
15108 <parameter name="destination" transfer-ownership="none">
15109 <doc xml:whitespace="preserve">a #GFile to copy attributes to.</doc>
15110 <type name="File" c:type="GFile*"/>
15112 <parameter name="flags" transfer-ownership="none">
15113 <doc xml:whitespace="preserve">a set of #GFileCopyFlags.</doc>
15114 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
15116 <parameter name="cancellable"
15117 transfer-ownership="none"
15119 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15120 <type name="Cancellable" c:type="GCancellable*"/>
15124 <method name="copy_finish" c:identifier="g_file_copy_finish" throws="1">
15125 <doc xml:whitespace="preserve">Finishes copying the file started with
15126 g_file_copy_async().</doc>
15127 <return-value transfer-ownership="none">
15128 <doc xml:whitespace="preserve">a %TRUE on success, %FALSE on error.</doc>
15129 <type name="gboolean" c:type="gboolean"/>
15132 <parameter name="res" transfer-ownership="none">
15133 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
15134 <type name="AsyncResult" c:type="GAsyncResult*"/>
15138 <method name="create" c:identifier="g_file_create" throws="1">
15139 <doc xml:whitespace="preserve">Creates a new file and returns an output stream for writing to it.
15140 The file must not already exist.
15141 By default files created are generally readable by everyone,
15142 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
15143 will be made readable only to the current user, to the level that
15144 is supported on the target filesystem.
15145 If @cancellable is not %NULL, then the operation can be cancelled by
15146 triggering the cancellable object from another thread. If the operation
15147 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
15148 If a file or directory with this name already exists the G_IO_ERROR_EXISTS
15149 error will be returned.
15150 Some file systems don't allow all file names, and may
15151 return an G_IO_ERROR_INVALID_FILENAME error, and if the name
15152 is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
15153 Other errors are possible too, and depend on what kind of
15154 filesystem the file is on.
15156 Free the returned object with g_object_unref().</doc>
15157 <return-value transfer-ownership="full">
15158 <doc xml:whitespace="preserve">a #GFileOutputStream for the newly created file, or</doc>
15159 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
15162 <parameter name="flags" transfer-ownership="none">
15163 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
15164 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
15166 <parameter name="cancellable"
15167 transfer-ownership="none"
15169 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15170 <type name="Cancellable" c:type="GCancellable*"/>
15174 <method name="create_async" c:identifier="g_file_create_async">
15175 <doc xml:whitespace="preserve">Asynchronously creates a new file and returns an output stream for writing to it.
15176 The file must not already exist.
15177 For more details, see g_file_create() which is
15178 the synchronous version of this call.
15179 When the operation is finished, @callback will be called. You can then call
15180 g_file_create_finish() to get the result of the operation.</doc>
15181 <return-value transfer-ownership="none">
15182 <type name="none" c:type="void"/>
15185 <parameter name="flags" transfer-ownership="none">
15186 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
15187 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
15189 <parameter name="io_priority" transfer-ownership="none">
15190 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
15191 <type name="gint" c:type="int"/>
15193 <parameter name="cancellable"
15194 transfer-ownership="none"
15196 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15197 <type name="Cancellable" c:type="GCancellable*"/>
15199 <parameter name="callback"
15200 transfer-ownership="none"
15203 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
15204 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15206 <parameter name="user_data" transfer-ownership="none">
15207 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15208 <type name="gpointer" c:type="gpointer"/>
15212 <method name="create_finish"
15213 c:identifier="g_file_create_finish"
15215 <doc xml:whitespace="preserve">Finishes an asynchronous file create operation started with
15216 g_file_create_async().
15217 Free the returned object with g_object_unref().</doc>
15218 <return-value transfer-ownership="full">
15219 <doc xml:whitespace="preserve">a #GFileOutputStream or %NULL on error.</doc>
15220 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
15223 <parameter name="res" transfer-ownership="none">
15224 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
15225 <type name="AsyncResult" c:type="GAsyncResult*"/>
15229 <method name="create_readwrite"
15230 c:identifier="g_file_create_readwrite"
15233 <doc xml:whitespace="preserve">Creates a new file and returns a stream for reading and writing to it.
15234 The file must not already exist.
15235 By default files created are generally readable by everyone,
15236 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
15237 will be made readable only to the current user, to the level that
15238 is supported on the target filesystem.
15239 If @cancellable is not %NULL, then the operation can be cancelled by
15240 triggering the cancellable object from another thread. If the operation
15241 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
15242 If a file or directory with this name already exists the %G_IO_ERROR_EXISTS
15243 error will be returned. Some file systems don't allow all file names,
15244 and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name
15245 is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors
15246 are possible too, and depend on what kind of filesystem the file is on.
15247 Note that in many non-local file cases read and write streams are not
15248 supported, so make sure you really need to do read and write streaming,
15249 rather than just opening for reading or writing.
15250 Free the returned object with g_object_unref().</doc>
15251 <return-value transfer-ownership="full">
15252 <doc xml:whitespace="preserve">a #GFileIOStream for the newly created file, or %NULL on error.</doc>
15253 <type name="FileIOStream" c:type="GFileIOStream*"/>
15256 <parameter name="flags" transfer-ownership="none">
15257 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
15258 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
15260 <parameter name="cancellable"
15261 transfer-ownership="none"
15263 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
15264 <type name="Cancellable" c:type="GCancellable*"/>
15268 <method name="create_readwrite_async"
15269 c:identifier="g_file_create_readwrite_async"
15271 <doc xml:whitespace="preserve">Asynchronously creates a new file and returns a stream for reading and
15272 writing to it. The file must not already exist.
15273 For more details, see g_file_create_readwrite() which is
15274 the synchronous version of this call.
15275 When the operation is finished, @callback will be called. You can then
15276 call g_file_create_readwrite_finish() to get the result of the operation.</doc>
15277 <return-value transfer-ownership="none">
15278 <type name="none" c:type="void"/>
15281 <parameter name="flags" transfer-ownership="none">
15282 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
15283 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
15285 <parameter name="io_priority" transfer-ownership="none">
15286 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request</doc>
15287 <type name="gint" c:type="int"/>
15289 <parameter name="cancellable"
15290 transfer-ownership="none"
15292 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
15293 <type name="Cancellable" c:type="GCancellable*"/>
15295 <parameter name="callback"
15296 transfer-ownership="none"
15299 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
15300 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15302 <parameter name="user_data" transfer-ownership="none">
15303 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15304 <type name="gpointer" c:type="gpointer"/>
15308 <method name="create_readwrite_finish"
15309 c:identifier="g_file_create_readwrite_finish"
15312 <doc xml:whitespace="preserve">Finishes an asynchronous file create operation started with
15313 g_file_create_readwrite_async().
15314 Free the returned object with g_object_unref().</doc>
15315 <return-value transfer-ownership="full">
15316 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
15317 <type name="FileIOStream" c:type="GFileIOStream*"/>
15320 <parameter name="res" transfer-ownership="none">
15321 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
15322 <type name="AsyncResult" c:type="GAsyncResult*"/>
15326 <method name="delete" c:identifier="g_file_delete" throws="1">
15327 <doc xml:whitespace="preserve">Deletes a file. If the @file is a directory, it will only be deleted if it
15329 If @cancellable is not %NULL, then the operation can be cancelled by
15330 triggering the cancellable object from another thread. If the operation
15331 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
15332 <return-value transfer-ownership="none">
15333 <doc xml:whitespace="preserve">%TRUE if the file was deleted. %FALSE otherwise.</doc>
15334 <type name="gboolean" c:type="gboolean"/>
15337 <parameter name="cancellable"
15338 transfer-ownership="none"
15340 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15341 <type name="Cancellable" c:type="GCancellable*"/>
15345 <method name="dup" c:identifier="g_file_dup">
15346 <doc xml:whitespace="preserve">Duplicates a #GFile handle. This operation does not duplicate
15347 the actual file or directory represented by the #GFile; see
15348 g_file_copy() if attempting to copy a file.
15349 This call does no blocking i/o.</doc>
15350 <return-value transfer-ownership="full">
15351 <doc xml:whitespace="preserve">a new #GFile that is a duplicate of the given #GFile.</doc>
15352 <type name="File" c:type="GFile*"/>
15355 <method name="eject_mountable"
15356 c:identifier="g_file_eject_mountable"
15357 deprecated="Use g_file_eject_mountable_with_operation() instead."
15358 deprecated-version="2.22">
15359 <doc xml:whitespace="preserve">Starts an asynchronous eject on a mountable.
15360 When this operation has completed, @callback will be called with
15361 g_file_eject_mountable_finish().
15362 If @cancellable is not %NULL, then the operation can be cancelled by
15363 triggering the cancellable object from another thread. If the operation
15364 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
15365 <return-value transfer-ownership="none">
15366 <type name="none" c:type="void"/>
15369 <parameter name="flags" transfer-ownership="none">
15370 <doc xml:whitespace="preserve">flags affecting the operation</doc>
15371 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
15373 <parameter name="cancellable"
15374 transfer-ownership="none"
15376 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15377 <type name="Cancellable" c:type="GCancellable*"/>
15379 <parameter name="callback"
15380 transfer-ownership="none"
15383 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
15384 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15386 <parameter name="user_data" transfer-ownership="none">
15387 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15388 <type name="gpointer" c:type="gpointer"/>
15392 <method name="eject_mountable_finish"
15393 c:identifier="g_file_eject_mountable_finish"
15394 deprecated="Use g_file_eject_mountable_with_operation_finish() instead."
15395 deprecated-version="2.22"
15397 <doc xml:whitespace="preserve">Finishes an asynchronous eject operation started by
15398 g_file_eject_mountable().
15400 <return-value transfer-ownership="none">
15401 <doc xml:whitespace="preserve">%TRUE if the @file was ejected successfully. %FALSE</doc>
15402 <type name="gboolean" c:type="gboolean"/>
15405 <parameter name="result" transfer-ownership="none">
15406 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
15407 <type name="AsyncResult" c:type="GAsyncResult*"/>
15411 <method name="eject_mountable_with_operation"
15412 c:identifier="g_file_eject_mountable_with_operation"
15414 <doc xml:whitespace="preserve">Starts an asynchronous eject on a mountable.
15415 When this operation has completed, @callback will be called with
15416 g_file_eject_mountable_with_operation_finish().
15417 If @cancellable is not %NULL, then the operation can be cancelled by
15418 triggering the cancellable object from another thread. If the operation
15419 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
15420 <return-value transfer-ownership="none">
15421 <type name="none" c:type="void"/>
15424 <parameter name="flags" transfer-ownership="none">
15425 <doc xml:whitespace="preserve">flags affecting the operation</doc>
15426 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
15428 <parameter name="mount_operation" transfer-ownership="none">
15429 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
15430 <type name="MountOperation" c:type="GMountOperation*"/>
15432 <parameter name="cancellable"
15433 transfer-ownership="none"
15435 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15436 <type name="Cancellable" c:type="GCancellable*"/>
15438 <parameter name="callback"
15439 transfer-ownership="none"
15442 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
15443 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15445 <parameter name="user_data" transfer-ownership="none">
15446 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15447 <type name="gpointer" c:type="gpointer"/>
15451 <method name="eject_mountable_with_operation_finish"
15452 c:identifier="g_file_eject_mountable_with_operation_finish"
15455 <doc xml:whitespace="preserve">Finishes an asynchronous eject operation started by
15456 g_file_eject_mountable_with_operation().
15458 <return-value transfer-ownership="none">
15459 <doc xml:whitespace="preserve">%TRUE if the @file was ejected successfully. %FALSE</doc>
15460 <type name="gboolean" c:type="gboolean"/>
15463 <parameter name="result" transfer-ownership="none">
15464 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
15465 <type name="AsyncResult" c:type="GAsyncResult*"/>
15469 <method name="enumerate_children"
15470 c:identifier="g_file_enumerate_children"
15472 <doc xml:whitespace="preserve">Gets the requested information about the files in a directory. The result
15473 is a #GFileEnumerator object that will give out #GFileInfo objects for
15474 all the files in the directory.
15475 The @attributes value is a string that specifies the file attributes that
15476 should be gathered. It is not an error if it's not possible to read a particular
15477 requested attribute from a file - it just won't be set. @attributes should
15478 be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
15479 means all attributes, and a wildcard like "standard::*" means all attributes in the standard
15480 namespace. An example attribute query be "standard::*,owner::user".
15481 The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
15482 If @cancellable is not %NULL, then the operation can be cancelled by
15483 triggering the cancellable object from another thread. If the operation
15484 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
15485 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
15486 If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
15487 Other errors are possible too.
15488 Free the returned object with g_object_unref().</doc>
15489 <return-value transfer-ownership="full">
15490 <doc xml:whitespace="preserve">A #GFileEnumerator if successful, %NULL on error.</doc>
15491 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
15494 <parameter name="attributes" transfer-ownership="none">
15495 <doc xml:whitespace="preserve">an attribute query string.</doc>
15496 <type name="utf8" c:type="char*"/>
15498 <parameter name="flags" transfer-ownership="none">
15499 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
15500 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
15502 <parameter name="cancellable"
15503 transfer-ownership="none"
15505 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15506 <type name="Cancellable" c:type="GCancellable*"/>
15510 <method name="enumerate_children_async"
15511 c:identifier="g_file_enumerate_children_async">
15512 <doc xml:whitespace="preserve">Asynchronously gets the requested information about the files in a directory. The result
15513 is a #GFileEnumerator object that will give out #GFileInfo objects for
15514 all the files in the directory.
15515 For more details, see g_file_enumerate_children() which is
15516 the synchronous version of this call.
15517 When the operation is finished, @callback will be called. You can then call
15518 g_file_enumerate_children_finish() to get the result of the operation.</doc>
15519 <return-value transfer-ownership="none">
15520 <type name="none" c:type="void"/>
15523 <parameter name="attributes" transfer-ownership="none">
15524 <doc xml:whitespace="preserve">an attribute query string.</doc>
15525 <type name="utf8" c:type="char*"/>
15527 <parameter name="flags" transfer-ownership="none">
15528 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
15529 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
15531 <parameter name="io_priority" transfer-ownership="none">
15532 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
15533 <type name="gint" c:type="int"/>
15535 <parameter name="cancellable"
15536 transfer-ownership="none"
15538 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15539 <type name="Cancellable" c:type="GCancellable*"/>
15541 <parameter name="callback"
15542 transfer-ownership="none"
15545 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
15546 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15548 <parameter name="user_data" transfer-ownership="none">
15549 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15550 <type name="gpointer" c:type="gpointer"/>
15554 <method name="enumerate_children_finish"
15555 c:identifier="g_file_enumerate_children_finish"
15557 <doc xml:whitespace="preserve">Finishes an async enumerate children operation.
15558 See g_file_enumerate_children_async().
15559 Free the returned object with g_object_unref().</doc>
15560 <return-value transfer-ownership="full">
15561 <doc xml:whitespace="preserve">a #GFileEnumerator or %NULL if an error occurred.</doc>
15562 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
15565 <parameter name="res" transfer-ownership="none">
15566 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
15567 <type name="AsyncResult" c:type="GAsyncResult*"/>
15571 <method name="equal" c:identifier="g_file_equal">
15572 <doc xml:whitespace="preserve">Checks equality of two given #GFile<!-- -->s. Note that two
15573 #GFile<!-- -->s that differ can still refer to the same
15574 file on the filesystem due to various forms of filename
15576 This call does no blocking i/o.
15577 %FALSE if either is not a #GFile.</doc>
15578 <return-value transfer-ownership="none">
15579 <doc xml:whitespace="preserve">%TRUE if @file1 and @file2 are equal.</doc>
15580 <type name="gboolean" c:type="gboolean"/>
15583 <parameter name="file2" transfer-ownership="none">
15584 <doc xml:whitespace="preserve">the second #GFile.</doc>
15585 <type name="File" c:type="GFile*"/>
15589 <method name="find_enclosing_mount"
15590 c:identifier="g_file_find_enclosing_mount"
15592 <doc xml:whitespace="preserve">Gets a #GMount for the #GFile.
15593 If the #GFileIface for @file does not have a mount (e.g. possibly a
15594 remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
15596 If @cancellable is not %NULL, then the operation can be cancelled by
15597 triggering the cancellable object from another thread. If the operation
15598 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
15599 Free the returned object with g_object_unref().</doc>
15600 <return-value transfer-ownership="full">
15601 <doc xml:whitespace="preserve">a #GMount where the @file is located or %NULL on error.</doc>
15602 <type name="Mount" c:type="GMount*"/>
15605 <parameter name="cancellable"
15606 transfer-ownership="none"
15608 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15609 <type name="Cancellable" c:type="GCancellable*"/>
15613 <method name="find_enclosing_mount_async"
15614 c:identifier="g_file_find_enclosing_mount_async">
15615 <doc xml:whitespace="preserve">Asynchronously gets the mount for the file.
15616 For more details, see g_file_find_enclosing_mount() which is
15617 the synchronous version of this call.
15618 When the operation is finished, @callback will be called. You can then call
15619 g_file_find_enclosing_mount_finish() to get the result of the operation.</doc>
15620 <return-value transfer-ownership="none">
15621 <type name="none" c:type="void"/>
15624 <parameter name="io_priority" transfer-ownership="none">
15625 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
15626 <type name="gint" c:type="int"/>
15628 <parameter name="cancellable"
15629 transfer-ownership="none"
15631 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15632 <type name="Cancellable" c:type="GCancellable*"/>
15634 <parameter name="callback"
15635 transfer-ownership="none"
15638 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
15639 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15641 <parameter name="user_data" transfer-ownership="none">
15642 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15643 <type name="gpointer" c:type="gpointer"/>
15647 <method name="find_enclosing_mount_finish"
15648 c:identifier="g_file_find_enclosing_mount_finish"
15650 <doc xml:whitespace="preserve">Finishes an asynchronous find mount request.
15651 See g_file_find_enclosing_mount_async().
15652 Free the returned object with g_object_unref().</doc>
15653 <return-value transfer-ownership="full">
15654 <doc xml:whitespace="preserve">#GMount for given @file or %NULL on error.</doc>
15655 <type name="Mount" c:type="GMount*"/>
15658 <parameter name="res" transfer-ownership="none">
15659 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
15660 <type name="AsyncResult" c:type="GAsyncResult*"/>
15664 <method name="get_basename" c:identifier="g_file_get_basename">
15665 <doc xml:whitespace="preserve">Gets the base name (the last component of the path) for a given #GFile.
15666 If called for the top level of a system (such as the filesystem root
15667 or a uri like sftp://host/) it will return a single directory separator
15668 (and on Windows, possibly a drive letter).
15669 The base name is a byte string (*not* UTF-8). It has no defined encoding
15670 or rules other than it may not contain zero bytes. If you want to use
15671 filenames in a user interface you should use the display name that you
15672 can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
15673 attribute with g_file_query_info().
15674 This call does no blocking i/o.
15675 if given #GFile is invalid. The returned string should be
15676 freed with g_free() when no longer needed.</doc>
15677 <return-value transfer-ownership="full">
15678 <doc xml:whitespace="preserve">string containing the #GFile's base name, or %NULL</doc>
15679 <type name="utf8" c:type="char*"/>
15682 <method name="get_child" c:identifier="g_file_get_child">
15683 <doc xml:whitespace="preserve">Gets a child of @file with basename equal to @name.
15684 Note that the file with that specific name might not exist, but
15685 you can still have a #GFile that points to it. You can use this
15686 for instance to create that file.
15687 This call does no blocking i/o.
15688 Free the returned object with g_object_unref().</doc>
15689 <return-value transfer-ownership="full">
15690 <doc xml:whitespace="preserve">a #GFile to a child specified by @name.</doc>
15691 <type name="File" c:type="GFile*"/>
15694 <parameter name="name" transfer-ownership="none">
15695 <doc xml:whitespace="preserve">string containing the child's basename.</doc>
15696 <type name="utf8" c:type="char*"/>
15700 <method name="get_child_for_display_name"
15701 c:identifier="g_file_get_child_for_display_name"
15703 <doc xml:whitespace="preserve">Gets the child of @file for a given @display_name (i.e. a UTF8
15704 version of the name). If this function fails, it returns %NULL and @error will be
15705 set. This is very useful when constructing a GFile for a new file
15706 and the user entered the filename in the user interface, for instance
15707 when you select a directory and type a filename in the file selector.
15708 This call does no blocking i/o.
15709 %NULL if the display name couldn't be converted.
15710 Free the returned object with g_object_unref().</doc>
15711 <return-value transfer-ownership="full">
15712 <doc xml:whitespace="preserve">a #GFile to the specified child, or</doc>
15713 <type name="File" c:type="GFile*"/>
15716 <parameter name="display_name" transfer-ownership="none">
15717 <doc xml:whitespace="preserve">string to a possible child.</doc>
15718 <type name="utf8" c:type="char*"/>
15722 <method name="get_parent" c:identifier="g_file_get_parent">
15723 <doc xml:whitespace="preserve">Gets the parent directory for the @file.
15724 If the @file represents the root directory of the
15725 file system, then %NULL will be returned.
15726 This call does no blocking i/o.
15727 #GFile or %NULL if there is no parent.
15728 Free the returned object with g_object_unref().</doc>
15729 <return-value transfer-ownership="full">
15730 <doc xml:whitespace="preserve">a #GFile structure to the parent of the given</doc>
15731 <type name="File" c:type="GFile*"/>
15734 <method name="get_parse_name" c:identifier="g_file_get_parse_name">
15735 <doc xml:whitespace="preserve">Gets the parse name of the @file.
15736 A parse name is a UTF-8 string that describes the
15737 file such that one can get the #GFile back using
15738 g_file_parse_name().
15739 This is generally used to show the #GFile as a nice
15740 full-pathname kind of string in a user interface,
15741 like in a location entry.
15742 For local files with names that can safely be converted
15743 to UTF8 the pathname is used, otherwise the IRI is used
15744 (a form of URI that allows UTF8 characters unescaped).
15745 This call does no blocking i/o.
15746 string should be freed with g_free() when no longer needed.</doc>
15747 <return-value transfer-ownership="full">
15748 <doc xml:whitespace="preserve">a string containing the #GFile's parse name. The returned</doc>
15749 <type name="utf8" c:type="char*"/>
15752 <method name="get_path" c:identifier="g_file_get_path">
15753 <doc xml:whitespace="preserve">Gets the local pathname for #GFile, if one exists.
15754 This call does no blocking i/o.
15755 no such path exists. The returned string should be
15756 freed with g_free() when no longer needed.</doc>
15757 <return-value transfer-ownership="full">
15758 <doc xml:whitespace="preserve">string containing the #GFile's path, or %NULL if</doc>
15759 <type name="utf8" c:type="char*"/>
15762 <method name="get_relative_path" c:identifier="g_file_get_relative_path">
15763 <doc xml:whitespace="preserve">Gets the path for @descendant relative to @parent.
15764 This call does no blocking i/o.
15765 to @parent, or %NULL if @descendant doesn't have @parent as prefix.
15766 The returned string should be freed with g_free() when no longer needed.</doc>
15767 <return-value transfer-ownership="full">
15768 <doc xml:whitespace="preserve">string with the relative path from @descendant</doc>
15769 <type name="utf8" c:type="char*"/>
15772 <parameter name="descendant" transfer-ownership="none">
15773 <doc xml:whitespace="preserve">input #GFile.</doc>
15774 <type name="File" c:type="GFile*"/>
15778 <method name="get_uri" c:identifier="g_file_get_uri">
15779 <doc xml:whitespace="preserve">Gets the URI for the @file.
15780 This call does no blocking i/o.
15781 The returned string should be freed with g_free() when no longer needed.</doc>
15782 <return-value transfer-ownership="full">
15783 <doc xml:whitespace="preserve">a string containing the #GFile's URI.</doc>
15784 <type name="utf8" c:type="char*"/>
15787 <method name="get_uri_scheme" c:identifier="g_file_get_uri_scheme">
15788 <doc xml:whitespace="preserve">Gets the URI scheme for a #GFile.
15789 RFC 3986 decodes the scheme as:
15790 <programlisting>
15791 URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
15792 </programlisting>
15793 Common schemes include "file", "http", "ftp", etc.
15794 This call does no blocking i/o.
15795 #GFile. The returned string should be freed with g_free()
15796 when no longer needed.</doc>
15797 <return-value transfer-ownership="full">
15798 <doc xml:whitespace="preserve">a string containing the URI scheme for the given</doc>
15799 <type name="utf8" c:type="char*"/>
15802 <method name="has_parent"
15803 c:identifier="g_file_has_parent"
15805 <doc xml:whitespace="preserve">Checks if @file has a parent, and optionally, if it is @parent.
15806 If @parent is %NULL then this function returns %TRUE if @file has any
15807 parent at all. If @parent is non-%NULL then %TRUE is only returned
15808 if @file is a child of @parent.
15809 case that @parent is %NULL).</doc>
15810 <return-value transfer-ownership="none">
15811 <doc xml:whitespace="preserve">%TRUE if @file is a child of @parent (or any parent in the</doc>
15812 <type name="gboolean" c:type="gboolean"/>
15815 <parameter name="parent" transfer-ownership="none">
15816 <doc xml:whitespace="preserve">the parent to check for, or %NULL</doc>
15817 <type name="File" c:type="GFile*"/>
15821 <method name="has_prefix" c:identifier="g_file_has_prefix">
15822 <doc xml:whitespace="preserve">Checks whether @file has the prefix specified by @prefix. In other word,
15823 if the names of inital elements of @file<!-- -->s pathname match @prefix.
15824 Only full pathname elements are matched, so a path like /foo is not
15825 considered a prefix of /foobar, only of /foo/bar.
15826 This call does no i/o, as it works purely on names. As such it can
15827 sometimes return %FALSE even if @file is inside a @prefix (from a
15828 filesystem point of view), because the prefix of @file is an alias
15830 %FALSE otherwise.</doc>
15831 <return-value transfer-ownership="none">
15832 <doc xml:whitespace="preserve">%TRUE if the @files's parent, grandparent, etc is @prefix.</doc>
15833 <type name="gboolean" c:type="gboolean"/>
15836 <parameter name="prefix" transfer-ownership="none">
15837 <doc xml:whitespace="preserve">input #GFile.</doc>
15838 <type name="File" c:type="GFile*"/>
15842 <method name="has_uri_scheme" c:identifier="g_file_has_uri_scheme">
15843 <doc xml:whitespace="preserve">Checks to see if a #GFile has a given URI scheme.
15844 This call does no blocking i/o.
15845 given URI scheme, %FALSE if URI scheme is %NULL,
15846 not supported, or #GFile is invalid.</doc>
15847 <return-value transfer-ownership="none">
15848 <doc xml:whitespace="preserve">%TRUE if #GFile's backend supports the</doc>
15849 <type name="gboolean" c:type="gboolean"/>
15852 <parameter name="uri_scheme" transfer-ownership="none">
15853 <doc xml:whitespace="preserve">a string containing a URI scheme.</doc>
15854 <type name="utf8" c:type="char*"/>
15858 <method name="icon_new" c:identifier="g_file_icon_new">
15859 <doc xml:whitespace="preserve">Creates a new icon for a file.</doc>
15860 <return-value transfer-ownership="full">
15861 <doc xml:whitespace="preserve">a #GIcon for the given @file, or %NULL on error.</doc>
15862 <type name="Icon" c:type="GIcon*"/>
15865 <method name="is_native" c:identifier="g_file_is_native">
15866 <doc xml:whitespace="preserve">Checks to see if a file is native to the platform.
15867 A native file s one expressed in the platform-native filename format,
15868 e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
15869 as it might be on a locally mounted remote filesystem.
15870 On some systems non-native files may be available using
15871 the native filesystem via a userspace filesystem (FUSE), in
15872 these cases this call will return %FALSE, but g_file_get_path()
15873 will still return a native path.
15874 This call does no blocking i/o.</doc>
15875 <return-value transfer-ownership="none">
15876 <doc xml:whitespace="preserve">%TRUE if file is native.</doc>
15877 <type name="gboolean" c:type="gboolean"/>
15880 <method name="load_contents"
15881 c:identifier="g_file_load_contents"
15883 <doc xml:whitespace="preserve">Loads the content of the file into memory. The data is always
15884 zero-terminated, but this is not included in the resultant @length.
15885 The returned @content should be freed with g_free() when no longer
15887 If @cancellable is not %NULL, then the operation can be cancelled by
15888 triggering the cancellable object from another thread. If the operation
15889 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
15890 %FALSE if there were errors.</doc>
15891 <return-value transfer-ownership="none">
15892 <doc xml:whitespace="preserve">%TRUE if the @file's contents were successfully loaded.</doc>
15893 <type name="gboolean" c:type="gboolean"/>
15896 <parameter name="cancellable"
15897 transfer-ownership="none"
15899 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15900 <type name="Cancellable" c:type="GCancellable*"/>
15902 <parameter name="contents"
15904 caller-allocates="0"
15905 transfer-ownership="full">
15906 <doc xml:whitespace="preserve">a location to place the contents of the file.</doc>
15907 <type name="utf8" c:type="char**"/>
15909 <parameter name="length"
15911 caller-allocates="0"
15912 transfer-ownership="full"
15914 <doc xml:whitespace="preserve">a location to place the length of the contents of the file, or %NULL if the length is not needed</doc>
15915 <type name="gulong" c:type="gsize*"/>
15917 <parameter name="etag_out"
15919 caller-allocates="0"
15920 transfer-ownership="full"
15922 <doc xml:whitespace="preserve">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed</doc>
15923 <type name="utf8" c:type="char**"/>
15927 <method name="load_contents_async"
15928 c:identifier="g_file_load_contents_async">
15929 <doc xml:whitespace="preserve">Starts an asynchronous load of the @file's contents.
15930 For more details, see g_file_load_contents() which is
15931 the synchronous version of this call.
15932 When the load operation has completed, @callback will be called
15933 with @user data. To finish the operation, call
15934 g_file_load_contents_finish() with the #GAsyncResult returned by
15936 If @cancellable is not %NULL, then the operation can be cancelled by
15937 triggering the cancellable object from another thread. If the operation
15938 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
15939 <return-value transfer-ownership="none">
15940 <type name="none" c:type="void"/>
15943 <parameter name="cancellable"
15944 transfer-ownership="none"
15946 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
15947 <type name="Cancellable" c:type="GCancellable*"/>
15949 <parameter name="callback"
15950 transfer-ownership="none"
15953 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
15954 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
15956 <parameter name="user_data" transfer-ownership="none">
15957 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
15958 <type name="gpointer" c:type="gpointer"/>
15962 <method name="load_contents_finish"
15963 c:identifier="g_file_load_contents_finish"
15965 <doc xml:whitespace="preserve">Finishes an asynchronous load of the @file's contents.
15966 The contents are placed in @contents, and @length is set to the
15967 size of the @contents string. The @content should be freed with
15968 g_free() when no longer needed. If @etag_out is present, it will be
15969 set to the new entity tag for the @file.
15970 present, it will be set appropriately.</doc>
15971 <return-value transfer-ownership="none">
15972 <doc xml:whitespace="preserve">%TRUE if the load was successful. If %FALSE and @error is</doc>
15973 <type name="gboolean" c:type="gboolean"/>
15976 <parameter name="res" transfer-ownership="none">
15977 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
15978 <type name="AsyncResult" c:type="GAsyncResult*"/>
15980 <parameter name="contents"
15982 caller-allocates="0"
15983 transfer-ownership="full">
15984 <doc xml:whitespace="preserve">a location to place the contents of the file.</doc>
15985 <type name="utf8" c:type="char**"/>
15987 <parameter name="length"
15989 caller-allocates="0"
15990 transfer-ownership="full"
15992 <doc xml:whitespace="preserve">a location to place the length of the contents of the file, or %NULL if the length is not needed</doc>
15993 <type name="gulong" c:type="gsize*"/>
15995 <parameter name="etag_out"
15997 caller-allocates="0"
15998 transfer-ownership="full"
16000 <doc xml:whitespace="preserve">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed</doc>
16001 <type name="utf8" c:type="char**"/>
16005 <method name="load_partial_contents_async"
16006 c:identifier="g_file_load_partial_contents_async"
16007 introspectable="0">
16008 <doc xml:whitespace="preserve">Reads the partial contents of a file. A #GFileReadMoreCallback should be
16009 used to stop reading from the file when appropriate, else this function
16010 will behave exactly as g_file_load_contents_async(). This operation
16011 can be finished by g_file_load_partial_contents_finish().
16012 Users of this function should be aware that @user_data is passed to
16013 both the @read_more_callback and the @callback.
16014 If @cancellable is not %NULL, then the operation can be cancelled by
16015 triggering the cancellable object from another thread. If the operation
16016 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
16017 <return-value transfer-ownership="none">
16018 <type name="none" c:type="void"/>
16021 <parameter name="cancellable"
16022 transfer-ownership="none"
16024 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16025 <type name="Cancellable" c:type="GCancellable*"/>
16027 <parameter name="read_more_callback" transfer-ownership="none">
16028 <doc xml:whitespace="preserve">a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.</doc>
16029 <type name="FileReadMoreCallback" c:type="GFileReadMoreCallback"/>
16031 <parameter name="callback"
16032 transfer-ownership="none"
16035 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
16036 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16038 <parameter name="user_data" transfer-ownership="none">
16039 <doc xml:whitespace="preserve">the data to pass to the callback functions.</doc>
16040 <type name="gpointer" c:type="gpointer"/>
16044 <method name="load_partial_contents_finish"
16045 c:identifier="g_file_load_partial_contents_finish"
16047 <doc xml:whitespace="preserve">Finishes an asynchronous partial load operation that was started
16048 with g_file_load_partial_contents_async(). The data is always
16049 zero-terminated, but this is not included in the resultant @length.
16050 The returned @content should be freed with g_free() when no longer
16052 present, it will be set appropriately.</doc>
16053 <return-value transfer-ownership="none">
16054 <doc xml:whitespace="preserve">%TRUE if the load was successful. If %FALSE and @error is</doc>
16055 <type name="gboolean" c:type="gboolean"/>
16058 <parameter name="res" transfer-ownership="none">
16059 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16060 <type name="AsyncResult" c:type="GAsyncResult*"/>
16062 <parameter name="contents"
16064 caller-allocates="0"
16065 transfer-ownership="full">
16066 <doc xml:whitespace="preserve">a location to place the contents of the file.</doc>
16067 <type name="utf8" c:type="char**"/>
16069 <parameter name="length"
16071 caller-allocates="0"
16072 transfer-ownership="full"
16074 <doc xml:whitespace="preserve">a location to place the length of the contents of the file, or %NULL if the length is not needed</doc>
16075 <type name="gulong" c:type="gsize*"/>
16077 <parameter name="etag_out"
16079 caller-allocates="0"
16080 transfer-ownership="full"
16082 <doc xml:whitespace="preserve">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed</doc>
16083 <type name="utf8" c:type="char**"/>
16087 <method name="make_directory"
16088 c:identifier="g_file_make_directory"
16090 <return-value transfer-ownership="none">
16091 <type name="gboolean" c:type="gboolean"/>
16094 <parameter name="cancellable"
16095 transfer-ownership="none"
16097 <type name="Cancellable" c:type="GCancellable*"/>
16101 <method name="make_directory_with_parents"
16102 c:identifier="g_file_make_directory_with_parents"
16105 <doc xml:whitespace="preserve">Creates a directory and any parent directories that may not exist similar to
16106 'mkdir -p'. If the file system does not support creating directories, this
16107 function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED.
16108 For a local #GFile the newly created directories will have the default
16109 (current) ownership and permissions of the current process.
16110 If @cancellable is not %NULL, then the operation can be cancelled by
16111 triggering the cancellable object from another thread. If the operation
16112 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16114 <return-value transfer-ownership="none">
16115 <doc xml:whitespace="preserve">%TRUE if all directories have been successfully created, %FALSE</doc>
16116 <type name="gboolean" c:type="gboolean"/>
16119 <parameter name="cancellable"
16120 transfer-ownership="none"
16122 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16123 <type name="Cancellable" c:type="GCancellable*"/>
16127 <method name="make_symbolic_link"
16128 c:identifier="g_file_make_symbolic_link"
16130 <doc xml:whitespace="preserve">Creates a symbolic link named @file which contains the string
16131 If @cancellable is not %NULL, then the operation can be cancelled by
16132 triggering the cancellable object from another thread. If the operation
16133 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
16134 <return-value transfer-ownership="none">
16135 <doc xml:whitespace="preserve">%TRUE on the creation of a new symlink, %FALSE otherwise.</doc>
16136 <type name="gboolean" c:type="gboolean"/>
16139 <parameter name="symlink_value" transfer-ownership="none">
16140 <doc xml:whitespace="preserve">a string with the path for the target of the new symlink</doc>
16141 <type name="utf8" c:type="char*"/>
16143 <parameter name="cancellable"
16144 transfer-ownership="none"
16146 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16147 <type name="Cancellable" c:type="GCancellable*"/>
16151 <method name="monitor"
16152 c:identifier="g_file_monitor"
16155 <doc xml:whitespace="preserve">Obtains a file or directory monitor for the given file, depending
16156 on the type of the file.
16157 If @cancellable is not %NULL, then the operation can be cancelled by
16158 triggering the cancellable object from another thread. If the operation
16159 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16160 Free the returned object with g_object_unref().</doc>
16161 <return-value transfer-ownership="full">
16162 <doc xml:whitespace="preserve">a #GFileMonitor for the given @file, or %NULL on error.</doc>
16163 <type name="FileMonitor" c:type="GFileMonitor*"/>
16166 <parameter name="flags" transfer-ownership="none">
16167 <doc xml:whitespace="preserve">a set of #GFileMonitorFlags</doc>
16168 <type name="FileMonitorFlags" c:type="GFileMonitorFlags"/>
16170 <parameter name="cancellable"
16171 transfer-ownership="none"
16173 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
16174 <type name="Cancellable" c:type="GCancellable*"/>
16178 <method name="monitor_directory"
16179 c:identifier="g_file_monitor_directory"
16181 <doc xml:whitespace="preserve">Obtains a directory monitor for the given file.
16182 This may fail if directory monitoring is not supported.
16183 If @cancellable is not %NULL, then the operation can be cancelled by
16184 triggering the cancellable object from another thread. If the operation
16185 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16186 Free the returned object with g_object_unref().</doc>
16187 <return-value transfer-ownership="full">
16188 <doc xml:whitespace="preserve">a #GFileMonitor for the given @file, or %NULL on error.</doc>
16189 <type name="FileMonitor" c:type="GFileMonitor*"/>
16192 <parameter name="flags" transfer-ownership="none">
16193 <doc xml:whitespace="preserve">a set of #GFileMonitorFlags.</doc>
16194 <type name="FileMonitorFlags" c:type="GFileMonitorFlags"/>
16196 <parameter name="cancellable"
16197 transfer-ownership="none"
16199 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16200 <type name="Cancellable" c:type="GCancellable*"/>
16204 <method name="monitor_file"
16205 c:identifier="g_file_monitor_file"
16207 <doc xml:whitespace="preserve">Obtains a file monitor for the given file. If no file notification
16208 mechanism exists, then regular polling of the file is used.
16209 If @cancellable is not %NULL, then the operation can be cancelled by
16210 triggering the cancellable object from another thread. If the operation
16211 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16212 Free the returned object with g_object_unref().</doc>
16213 <return-value transfer-ownership="full">
16214 <doc xml:whitespace="preserve">a #GFileMonitor for the given @file, or %NULL on error.</doc>
16215 <type name="FileMonitor" c:type="GFileMonitor*"/>
16218 <parameter name="flags" transfer-ownership="none">
16219 <doc xml:whitespace="preserve">a set of #GFileMonitorFlags.</doc>
16220 <type name="FileMonitorFlags" c:type="GFileMonitorFlags"/>
16222 <parameter name="cancellable"
16223 transfer-ownership="none"
16225 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16226 <type name="Cancellable" c:type="GCancellable*"/>
16230 <method name="mount_enclosing_volume"
16231 c:identifier="g_file_mount_enclosing_volume">
16232 <doc xml:whitespace="preserve">Starts a @mount_operation, mounting the volume that contains the file @location.
16233 When this operation has completed, @callback will be called with
16234 g_file_mount_enclosing_volume_finish().
16235 If @cancellable is not %NULL, then the operation can be cancelled by
16236 triggering the cancellable object from another thread. If the operation
16237 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
16238 <return-value transfer-ownership="none">
16239 <type name="none" c:type="void"/>
16242 <parameter name="flags" transfer-ownership="none">
16243 <doc xml:whitespace="preserve">flags affecting the operation</doc>
16244 <type name="MountMountFlags" c:type="GMountMountFlags"/>
16246 <parameter name="mount_operation" transfer-ownership="none">
16247 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
16248 <type name="MountOperation" c:type="GMountOperation*"/>
16250 <parameter name="cancellable"
16251 transfer-ownership="none"
16253 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16254 <type name="Cancellable" c:type="GCancellable*"/>
16256 <parameter name="callback"
16257 transfer-ownership="none"
16260 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
16261 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16263 <parameter name="user_data" transfer-ownership="none">
16264 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
16265 <type name="gpointer" c:type="gpointer"/>
16269 <method name="mount_enclosing_volume_finish"
16270 c:identifier="g_file_mount_enclosing_volume_finish"
16272 <doc xml:whitespace="preserve">Finishes a mount operation started by g_file_mount_enclosing_volume().
16273 has occurred, this function will return %FALSE and set @error
16274 appropriately if present.</doc>
16275 <return-value transfer-ownership="none">
16276 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
16277 <type name="gboolean" c:type="gboolean"/>
16280 <parameter name="result" transfer-ownership="none">
16281 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16282 <type name="AsyncResult" c:type="GAsyncResult*"/>
16286 <method name="mount_mountable" c:identifier="g_file_mount_mountable">
16287 <doc xml:whitespace="preserve">Mounts a file of type G_FILE_TYPE_MOUNTABLE.
16288 Using @mount_operation, you can request callbacks when, for instance,
16289 passwords are needed during authentication.
16290 If @cancellable is not %NULL, then the operation can be cancelled by
16291 triggering the cancellable object from another thread. If the operation
16292 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16293 When the operation is finished, @callback will be called. You can then call
16294 g_file_mount_mountable_finish() to get the result of the operation.</doc>
16295 <return-value transfer-ownership="none">
16296 <type name="none" c:type="void"/>
16299 <parameter name="flags" transfer-ownership="none">
16300 <doc xml:whitespace="preserve">flags affecting the operation</doc>
16301 <type name="MountMountFlags" c:type="GMountMountFlags"/>
16303 <parameter name="mount_operation" transfer-ownership="none">
16304 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
16305 <type name="MountOperation" c:type="GMountOperation*"/>
16307 <parameter name="cancellable"
16308 transfer-ownership="none"
16310 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16311 <type name="Cancellable" c:type="GCancellable*"/>
16313 <parameter name="callback"
16314 transfer-ownership="none"
16317 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
16318 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16320 <parameter name="user_data" transfer-ownership="none">
16321 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
16322 <type name="gpointer" c:type="gpointer"/>
16326 <method name="mount_mountable_finish"
16327 c:identifier="g_file_mount_mountable_finish"
16329 <doc xml:whitespace="preserve">Finishes a mount operation. See g_file_mount_mountable() for details.
16330 Finish an asynchronous mount operation that was started
16331 with g_file_mount_mountable().
16332 Free the returned object with g_object_unref().</doc>
16333 <return-value transfer-ownership="full">
16334 <doc xml:whitespace="preserve">a #GFile or %NULL on error.</doc>
16335 <type name="File" c:type="GFile*"/>
16338 <parameter name="result" transfer-ownership="none">
16339 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16340 <type name="AsyncResult" c:type="GAsyncResult*"/>
16344 <method name="move"
16345 c:identifier="g_file_move"
16348 <doc xml:whitespace="preserve">Tries to move the file or directory @source to the location specified by @destination.
16349 If native move operations are supported then this is used, otherwise a copy + delete
16350 fallback is used. The native implementation may support moving directories (for instance
16351 on moves inside the same filesystem), but the fallback code does not.
16352 If the flag #G_FILE_COPY_OVERWRITE is specified an already
16353 existing @destination file is overwritten.
16354 If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
16355 will be copied as symlinks, otherwise the target of the
16356 If @cancellable is not %NULL, then the operation can be cancelled by
16357 triggering the cancellable object from another thread. If the operation
16358 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16359 If @progress_callback is not %NULL, then the operation can be monitored by
16360 setting this to a #GFileProgressCallback function. @progress_callback_data
16361 will be passed to this function. It is guaranteed that this callback will
16362 be called after all data has been transferred with the total number of bytes
16363 copied during the operation.
16364 If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
16365 error is returned, independent on the status of the @destination.
16366 If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
16367 error G_IO_ERROR_EXISTS is returned.
16368 If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
16369 error is returned. If trying to overwrite a directory with a directory the
16370 G_IO_ERROR_WOULD_MERGE error is returned.
16371 If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
16372 specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
16373 may be returned (if the native move operation isn't available).</doc>
16374 <return-value transfer-ownership="none">
16375 <doc xml:whitespace="preserve">%TRUE on successful move, %FALSE otherwise.</doc>
16376 <type name="gboolean" c:type="gboolean"/>
16379 <parameter name="destination" transfer-ownership="none">
16380 <doc xml:whitespace="preserve">#GFile pointing to the destination location.</doc>
16381 <type name="File" c:type="GFile*"/>
16383 <parameter name="flags" transfer-ownership="none">
16384 <doc xml:whitespace="preserve">set of #GFileCopyFlags.</doc>
16385 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
16387 <parameter name="cancellable"
16388 transfer-ownership="none"
16390 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16391 <type name="Cancellable" c:type="GCancellable*"/>
16393 <parameter name="progress_callback"
16394 transfer-ownership="none"
16396 <doc xml:whitespace="preserve">#GFileProgressCallback function for updates.</doc>
16397 <type name="FileProgressCallback" c:type="GFileProgressCallback"/>
16399 <parameter name="progress_callback_data" transfer-ownership="none">
16400 <doc xml:whitespace="preserve">gpointer to user data for the callback function.</doc>
16401 <type name="gpointer" c:type="gpointer"/>
16405 <method name="open_readwrite"
16406 c:identifier="g_file_open_readwrite"
16409 <doc xml:whitespace="preserve">Opens an existing file for reading and writing. The result is
16410 a #GFileIOStream that can be used to read and write the contents of the file.
16411 If @cancellable is not %NULL, then the operation can be cancelled by
16412 triggering the cancellable object from another thread. If the operation
16413 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16414 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
16415 If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
16416 Other errors are possible too, and depend on what kind of filesystem the file is on.
16417 Note that in many non-local file cases read and write streams are not supported,
16418 so make sure you really need to do read and write streaming, rather than
16419 just opening for reading or writing.
16420 Free the returned object with g_object_unref().</doc>
16421 <return-value transfer-ownership="full">
16422 <doc xml:whitespace="preserve">#GFileIOStream or %NULL on error.</doc>
16423 <type name="FileIOStream" c:type="GFileIOStream*"/>
16426 <parameter name="cancellable"
16427 transfer-ownership="none"
16429 <doc xml:whitespace="preserve">a #GCancellable</doc>
16430 <type name="Cancellable" c:type="GCancellable*"/>
16434 <method name="open_readwrite_async"
16435 c:identifier="g_file_open_readwrite_async"
16437 <doc xml:whitespace="preserve">Asynchronously opens @file for reading and writing.
16438 For more details, see g_file_open_readwrite() which is
16439 the synchronous version of this call.
16440 When the operation is finished, @callback will be called. You can then call
16441 g_file_open_readwrite_finish() to get the result of the operation.</doc>
16442 <return-value transfer-ownership="none">
16443 <type name="none" c:type="void"/>
16446 <parameter name="io_priority" transfer-ownership="none">
16447 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
16448 <type name="gint" c:type="int"/>
16450 <parameter name="cancellable"
16451 transfer-ownership="none"
16453 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16454 <type name="Cancellable" c:type="GCancellable*"/>
16456 <parameter name="callback"
16457 transfer-ownership="none"
16460 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
16461 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16463 <parameter name="user_data" transfer-ownership="none">
16464 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
16465 <type name="gpointer" c:type="gpointer"/>
16469 <method name="open_readwrite_finish"
16470 c:identifier="g_file_open_readwrite_finish"
16473 <doc xml:whitespace="preserve">Finishes an asynchronous file read operation started with
16474 g_file_open_readwrite_async().
16475 Free the returned object with g_object_unref().</doc>
16476 <return-value transfer-ownership="full">
16477 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
16478 <type name="FileIOStream" c:type="GFileIOStream*"/>
16481 <parameter name="res" transfer-ownership="none">
16482 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16483 <type name="AsyncResult" c:type="GAsyncResult*"/>
16487 <method name="poll_mountable"
16488 c:identifier="g_file_poll_mountable"
16490 <doc xml:whitespace="preserve">Polls a file of type G_FILE_TYPE_MOUNTABLE.
16491 If @cancellable is not %NULL, then the operation can be cancelled by
16492 triggering the cancellable object from another thread. If the operation
16493 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16494 When the operation is finished, @callback will be called. You can then call
16495 g_file_mount_mountable_finish() to get the result of the operation.</doc>
16496 <return-value transfer-ownership="none">
16497 <type name="none" c:type="void"/>
16500 <parameter name="cancellable"
16501 transfer-ownership="none"
16503 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16504 <type name="Cancellable" c:type="GCancellable*"/>
16506 <parameter name="callback"
16507 transfer-ownership="none"
16510 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
16511 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16513 <parameter name="user_data" transfer-ownership="none">
16514 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
16515 <type name="gpointer" c:type="gpointer"/>
16519 <method name="poll_mountable_finish"
16520 c:identifier="g_file_poll_mountable_finish"
16523 <doc xml:whitespace="preserve">Finishes a poll operation. See g_file_poll_mountable() for details.
16524 Finish an asynchronous poll operation that was polled
16525 with g_file_poll_mountable().
16527 <return-value transfer-ownership="none">
16528 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
16529 <type name="gboolean" c:type="gboolean"/>
16532 <parameter name="result" transfer-ownership="none">
16533 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16534 <type name="AsyncResult" c:type="GAsyncResult*"/>
16538 <method name="query_default_handler"
16539 c:identifier="g_file_query_default_handler"
16541 <doc xml:whitespace="preserve">Returns the #GAppInfo that is registered as the default
16542 application to handle the file specified by @file.
16543 If @cancellable is not %NULL, then the operation can be cancelled by
16544 triggering the cancellable object from another thread. If the operation
16545 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16546 When you are done with it, release it with g_object_unref()</doc>
16547 <return-value transfer-ownership="full">
16548 <doc xml:whitespace="preserve">a #GAppInfo if the handle was found, %NULL if there were errors.</doc>
16549 <type name="AppInfo" c:type="GAppInfo*"/>
16552 <parameter name="cancellable"
16553 transfer-ownership="none"
16555 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16556 <type name="Cancellable" c:type="GCancellable*"/>
16560 <method name="query_exists" c:identifier="g_file_query_exists">
16561 <doc xml:whitespace="preserve">Utility function to check if a particular file exists. This is
16562 implemented using g_file_query_info() and as such does blocking I/O.
16563 Note that in many cases it is racy to first check for file existence
16564 and then execute something based on the outcome of that, because the
16565 file might have been created or removed in between the operations. The
16566 general approach to handling that is to not check, but just do the
16567 operation and handle the errors as they come.
16568 As an example of race-free checking, take the case of reading a file, and
16569 can both result in two processes creating the file (with perhaps a partially
16570 written file as the result). The correct approach is to always try to create
16571 the file with g_file_create() which will either atomically create the file
16572 or fail with a G_IO_ERROR_EXISTS error.
16573 However, in many cases an existence check is useful in a user
16574 interface, for instance to make a menu item sensitive/insensitive, so that
16575 you don't have to fool users that something is possible and then just show
16576 and error dialog. If you do this, you should make sure to also handle the
16577 errors that can happen due to races when you execute the operation.</doc>
16578 <return-value transfer-ownership="none">
16579 <doc xml:whitespace="preserve">%TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).</doc>
16580 <type name="gboolean" c:type="gboolean"/>
16583 <parameter name="cancellable"
16584 transfer-ownership="none"
16586 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16587 <type name="Cancellable" c:type="GCancellable*"/>
16591 <method name="query_file_type"
16592 c:identifier="g_file_query_file_type"
16594 <doc xml:whitespace="preserve">Utility function to inspect the #GFileType of a file. This is
16595 implemented using g_file_query_info() and as such does blocking I/O.
16596 The primary use case of this method is to check if a file is a regular file,
16597 directory, or symlink.
16598 does not exist</doc>
16599 <return-value transfer-ownership="none">
16600 <doc xml:whitespace="preserve">The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file</doc>
16601 <type name="FileType" c:type="GFileType"/>
16604 <parameter name="flags" transfer-ownership="none">
16605 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags passed to g_file_query_info().</doc>
16606 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
16608 <parameter name="cancellable"
16609 transfer-ownership="none"
16611 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16612 <type name="Cancellable" c:type="GCancellable*"/>
16616 <method name="query_filesystem_info"
16617 c:identifier="g_file_query_filesystem_info"
16619 <doc xml:whitespace="preserve">Similar to g_file_query_info(), but obtains information
16620 about the filesystem the @file is on, rather than the file itself.
16621 For instance the amount of space available and the type of
16623 The @attributes value is a string that specifies the file attributes that
16624 should be gathered. It is not an error if it's not possible to read a particular
16625 requested attribute from a file - it just won't be set. @attributes should
16626 be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
16627 means all attributes, and a wildcard like "fs:*" means all attributes in the fs
16628 namespace. The standard namespace for filesystem attributes is "fs".
16629 Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
16630 (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
16631 bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
16632 If @cancellable is not %NULL, then the operation can be cancelled by
16633 triggering the cancellable object from another thread. If the operation
16634 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16635 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
16636 Other errors are possible too, and depend on what kind of filesystem the file is on.
16637 Free the returned object with g_object_unref().</doc>
16638 <return-value transfer-ownership="full">
16639 <doc xml:whitespace="preserve">a #GFileInfo or %NULL if there was an error.</doc>
16640 <type name="FileInfo" c:type="GFileInfo*"/>
16643 <parameter name="attributes" transfer-ownership="none">
16644 <doc xml:whitespace="preserve">an attribute query string.</doc>
16645 <type name="utf8" c:type="char*"/>
16647 <parameter name="cancellable"
16648 transfer-ownership="none"
16650 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16651 <type name="Cancellable" c:type="GCancellable*"/>
16655 <method name="query_filesystem_info_async"
16656 c:identifier="g_file_query_filesystem_info_async">
16657 <doc xml:whitespace="preserve">Asynchronously gets the requested information about the filesystem
16658 that the specified @file is on. The result is a #GFileInfo object
16659 that contains key-value attributes (such as type or size for the
16661 For more details, see g_file_query_filesystem_info() which is the
16662 synchronous version of this call.
16663 When the operation is finished, @callback will be called. You can
16664 then call g_file_query_info_finish() to get the result of the
16666 <return-value transfer-ownership="none">
16667 <type name="none" c:type="void"/>
16670 <parameter name="attributes" transfer-ownership="none">
16671 <doc xml:whitespace="preserve">an attribute query string.</doc>
16672 <type name="utf8" c:type="char*"/>
16674 <parameter name="io_priority" transfer-ownership="none">
16675 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
16676 <type name="gint" c:type="int"/>
16678 <parameter name="cancellable"
16679 transfer-ownership="none"
16681 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16682 <type name="Cancellable" c:type="GCancellable*"/>
16684 <parameter name="callback"
16685 transfer-ownership="none"
16688 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
16689 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16691 <parameter name="user_data" transfer-ownership="none">
16692 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
16693 <type name="gpointer" c:type="gpointer"/>
16697 <method name="query_filesystem_info_finish"
16698 c:identifier="g_file_query_filesystem_info_finish"
16700 <doc xml:whitespace="preserve">Finishes an asynchronous filesystem info query. See
16701 g_file_query_filesystem_info_async().
16702 Free the returned object with g_object_unref().</doc>
16703 <return-value transfer-ownership="full">
16704 <doc xml:whitespace="preserve">#GFileInfo for given @file or %NULL on error.</doc>
16705 <type name="FileInfo" c:type="GFileInfo*"/>
16708 <parameter name="res" transfer-ownership="none">
16709 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16710 <type name="AsyncResult" c:type="GAsyncResult*"/>
16714 <method name="query_info" c:identifier="g_file_query_info" throws="1">
16715 <doc xml:whitespace="preserve">Gets the requested information about specified @file. The result
16716 is a #GFileInfo object that contains key-value attributes (such as
16717 the type or size of the file).
16718 The @attributes value is a string that specifies the file attributes that
16719 should be gathered. It is not an error if it's not possible to read a particular
16720 requested attribute from a file - it just won't be set. @attributes should
16721 be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
16722 means all attributes, and a wildcard like "standard::*" means all attributes in the standard
16723 namespace. An example attribute query be "standard::*,owner::user".
16724 The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
16725 If @cancellable is not %NULL, then the operation can be cancelled by
16726 triggering the cancellable object from another thread. If the operation
16727 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16728 For symlinks, normally the information about the target of the
16729 symlink is returned, rather than information about the symlink itself.
16730 However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
16731 information about the symlink itself will be returned. Also, for symlinks
16732 that point to non-existing files the information about the symlink itself
16734 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
16735 Other errors are possible too, and depend on what kind of filesystem the file is on.
16736 Free the returned object with g_object_unref().</doc>
16737 <return-value transfer-ownership="full">
16738 <doc xml:whitespace="preserve">a #GFileInfo for the given @file, or %NULL on error.</doc>
16739 <type name="FileInfo" c:type="GFileInfo*"/>
16742 <parameter name="attributes" transfer-ownership="none">
16743 <doc xml:whitespace="preserve">an attribute query string.</doc>
16744 <type name="utf8" c:type="char*"/>
16746 <parameter name="flags" transfer-ownership="none">
16747 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
16748 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
16750 <parameter name="cancellable"
16751 transfer-ownership="none"
16753 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16754 <type name="Cancellable" c:type="GCancellable*"/>
16758 <method name="query_info_async" c:identifier="g_file_query_info_async">
16759 <doc xml:whitespace="preserve">Asynchronously gets the requested information about specified @file. The result
16760 is a #GFileInfo object that contains key-value attributes (such as type or size
16762 For more details, see g_file_query_info() which is
16763 the synchronous version of this call.
16764 When the operation is finished, @callback will be called. You can then call
16765 g_file_query_info_finish() to get the result of the operation.</doc>
16766 <return-value transfer-ownership="none">
16767 <type name="none" c:type="void"/>
16770 <parameter name="attributes" transfer-ownership="none">
16771 <doc xml:whitespace="preserve">an attribute query string.</doc>
16772 <type name="utf8" c:type="char*"/>
16774 <parameter name="flags" transfer-ownership="none">
16775 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
16776 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
16778 <parameter name="io_priority" transfer-ownership="none">
16779 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
16780 <type name="gint" c:type="int"/>
16782 <parameter name="cancellable"
16783 transfer-ownership="none"
16785 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16786 <type name="Cancellable" c:type="GCancellable*"/>
16788 <parameter name="callback"
16789 transfer-ownership="none"
16792 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
16793 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16795 <parameter name="user_data" transfer-ownership="none">
16796 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
16797 <type name="gpointer" c:type="gpointer"/>
16801 <method name="query_info_finish"
16802 c:identifier="g_file_query_info_finish"
16804 <doc xml:whitespace="preserve">Finishes an asynchronous file info query.
16805 See g_file_query_info_async().
16806 Free the returned object with g_object_unref().</doc>
16807 <return-value transfer-ownership="full">
16808 <doc xml:whitespace="preserve">#GFileInfo for given @file or %NULL on error.</doc>
16809 <type name="FileInfo" c:type="GFileInfo*"/>
16812 <parameter name="res" transfer-ownership="none">
16813 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16814 <type name="AsyncResult" c:type="GAsyncResult*"/>
16818 <method name="query_settable_attributes"
16819 c:identifier="g_file_query_settable_attributes"
16821 <doc xml:whitespace="preserve">Obtain the list of settable attributes for the file.
16822 Returns the type and full attribute name of all the attributes
16823 that can be set on this file. This doesn't mean setting it will always
16824 succeed though, you might get an access failure, or some specific
16825 file may not support a specific attribute.
16826 If @cancellable is not %NULL, then the operation can be cancelled by
16827 triggering the cancellable object from another thread. If the operation
16828 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16829 When you are done with it, release it with g_file_attribute_info_list_unref()</doc>
16830 <return-value transfer-ownership="full">
16831 <doc xml:whitespace="preserve">a #GFileAttributeInfoList describing the settable attributes.</doc>
16832 <type name="FileAttributeInfoList" c:type="GFileAttributeInfoList*"/>
16835 <parameter name="cancellable"
16836 transfer-ownership="none"
16838 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16839 <type name="Cancellable" c:type="GCancellable*"/>
16843 <method name="query_writable_namespaces"
16844 c:identifier="g_file_query_writable_namespaces"
16846 <doc xml:whitespace="preserve">Obtain the list of attribute namespaces where new attributes
16847 can be created by a user. An example of this is extended
16848 attributes (in the "xattr" namespace).
16849 If @cancellable is not %NULL, then the operation can be cancelled by
16850 triggering the cancellable object from another thread. If the operation
16851 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16852 When you are done with it, release it with g_file_attribute_info_list_unref()</doc>
16853 <return-value transfer-ownership="full">
16854 <doc xml:whitespace="preserve">a #GFileAttributeInfoList describing the writable namespaces.</doc>
16855 <type name="FileAttributeInfoList" c:type="GFileAttributeInfoList*"/>
16858 <parameter name="cancellable"
16859 transfer-ownership="none"
16861 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16862 <type name="Cancellable" c:type="GCancellable*"/>
16866 <method name="read" c:identifier="g_file_read" throws="1">
16867 <doc xml:whitespace="preserve">Opens a file for reading. The result is a #GFileInputStream that
16868 can be used to read the contents of the file.
16869 If @cancellable is not %NULL, then the operation can be cancelled by
16870 triggering the cancellable object from another thread. If the operation
16871 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16872 If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
16873 If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
16874 Other errors are possible too, and depend on what kind of filesystem the file is on.
16875 Free the returned object with g_object_unref().</doc>
16876 <return-value transfer-ownership="full">
16877 <doc xml:whitespace="preserve">#GFileInputStream or %NULL on error.</doc>
16878 <type name="FileInputStream" c:type="GFileInputStream*"/>
16881 <parameter name="cancellable"
16882 transfer-ownership="none"
16884 <doc xml:whitespace="preserve">a #GCancellable</doc>
16885 <type name="Cancellable" c:type="GCancellable*"/>
16889 <method name="read_async" c:identifier="g_file_read_async">
16890 <doc xml:whitespace="preserve">Asynchronously opens @file for reading.
16891 For more details, see g_file_read() which is
16892 the synchronous version of this call.
16893 When the operation is finished, @callback will be called. You can then call
16894 g_file_read_finish() to get the result of the operation.</doc>
16895 <return-value transfer-ownership="none">
16896 <type name="none" c:type="void"/>
16899 <parameter name="io_priority" transfer-ownership="none">
16900 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
16901 <type name="gint" c:type="int"/>
16903 <parameter name="cancellable"
16904 transfer-ownership="none"
16906 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16907 <type name="Cancellable" c:type="GCancellable*"/>
16909 <parameter name="callback"
16910 transfer-ownership="none"
16913 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
16914 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
16916 <parameter name="user_data" transfer-ownership="none">
16917 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
16918 <type name="gpointer" c:type="gpointer"/>
16922 <method name="read_finish" c:identifier="g_file_read_finish" throws="1">
16923 <doc xml:whitespace="preserve">Finishes an asynchronous file read operation started with
16924 g_file_read_async().
16925 Free the returned object with g_object_unref().</doc>
16926 <return-value transfer-ownership="full">
16927 <doc xml:whitespace="preserve">a #GFileInputStream or %NULL on error.</doc>
16928 <type name="FileInputStream" c:type="GFileInputStream*"/>
16931 <parameter name="res" transfer-ownership="none">
16932 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
16933 <type name="AsyncResult" c:type="GAsyncResult*"/>
16937 <method name="replace" c:identifier="g_file_replace" throws="1">
16938 <doc xml:whitespace="preserve">Returns an output stream for overwriting the file, possibly
16939 creating a backup copy of the file first. If the file doesn't exist,
16940 it will be created.
16941 This will try to replace the file in the safest way possible so
16942 that any errors during the writing will not affect an already
16943 existing copy of the file. For instance, for local files it
16944 may write to a temporary file and then atomically rename over
16945 the destination when the stream is closed.
16946 By default files created are generally readable by everyone,
16947 but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
16948 will be made readable only to the current user, to the level that
16949 is supported on the target filesystem.
16950 If @cancellable is not %NULL, then the operation can be cancelled by
16951 triggering the cancellable object from another thread. If the operation
16952 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
16953 If you pass in a non-#NULL @etag value, then this value is
16954 compared to the current entity tag of the file, and if they differ
16955 an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
16956 that the file has been changed since you last read it. You can get
16957 the new etag from g_file_output_stream_get_etag() after you've
16958 finished writing and closed the #GFileOutputStream. When you load
16959 a new file you can use g_file_input_stream_query_info() to get
16960 the etag of the file.
16961 If @make_backup is %TRUE, this function will attempt to make a backup
16962 of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
16963 error will be returned. If you want to replace anyway, try again with
16964 If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
16965 and if the file is some other form of non-regular file then a
16966 G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
16967 Some file systems don't allow all file names, and may
16968 return an G_IO_ERROR_INVALID_FILENAME error, and if the name
16969 is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
16970 Other errors are possible too, and depend on what kind of
16971 filesystem the file is on.
16972 Free the returned object with g_object_unref().</doc>
16973 <return-value transfer-ownership="full">
16974 <doc xml:whitespace="preserve">a #GFileOutputStream or %NULL on error.</doc>
16975 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
16978 <parameter name="etag" transfer-ownership="none" allow-none="1">
16979 <doc xml:whitespace="preserve">an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore.</doc>
16980 <type name="utf8" c:type="char*"/>
16982 <parameter name="make_backup" transfer-ownership="none">
16983 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
16984 <type name="gboolean" c:type="gboolean"/>
16986 <parameter name="flags" transfer-ownership="none">
16987 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
16988 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
16990 <parameter name="cancellable"
16991 transfer-ownership="none"
16993 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
16994 <type name="Cancellable" c:type="GCancellable*"/>
16998 <method name="replace_async" c:identifier="g_file_replace_async">
16999 <doc xml:whitespace="preserve">Asynchronously overwrites the file, replacing the contents, possibly
17000 creating a backup copy of the file first.
17001 For more details, see g_file_replace() which is
17002 the synchronous version of this call.
17003 When the operation is finished, @callback will be called. You can then call
17004 g_file_replace_finish() to get the result of the operation.</doc>
17005 <return-value transfer-ownership="none">
17006 <type name="none" c:type="void"/>
17009 <parameter name="etag" transfer-ownership="none" allow-none="1">
17010 <doc xml:whitespace="preserve">an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.</doc>
17011 <type name="utf8" c:type="char*"/>
17013 <parameter name="make_backup" transfer-ownership="none">
17014 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
17015 <type name="gboolean" c:type="gboolean"/>
17017 <parameter name="flags" transfer-ownership="none">
17018 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
17019 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
17021 <parameter name="io_priority" transfer-ownership="none">
17022 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
17023 <type name="gint" c:type="int"/>
17025 <parameter name="cancellable"
17026 transfer-ownership="none"
17028 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17029 <type name="Cancellable" c:type="GCancellable*"/>
17031 <parameter name="callback"
17032 transfer-ownership="none"
17035 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
17036 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17038 <parameter name="user_data" transfer-ownership="none">
17039 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17040 <type name="gpointer" c:type="gpointer"/>
17044 <method name="replace_contents"
17045 c:identifier="g_file_replace_contents"
17047 <doc xml:whitespace="preserve">Replaces the contents of @file with @contents of @length bytes.
17048 If @etag is specified (not %NULL) any existing file must have that etag, or
17049 the error %G_IO_ERROR_WRONG_ETAG will be returned.
17050 If @make_backup is %TRUE, this function will attempt to make a backup of @file.
17051 If @cancellable is not %NULL, then the operation can be cancelled by
17052 triggering the cancellable object from another thread. If the operation
17053 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17054 The returned @new_etag can be used to verify that the file hasn't changed the
17055 next time it is saved over.
17056 has occurred, this function will return %FALSE and set @error
17057 appropriately if present.</doc>
17058 <return-value transfer-ownership="none">
17059 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
17060 <type name="gboolean" c:type="gboolean"/>
17063 <parameter name="contents" transfer-ownership="none">
17064 <doc xml:whitespace="preserve">a string containing the new contents for @file.</doc>
17065 <type name="utf8" c:type="char*"/>
17067 <parameter name="length" transfer-ownership="none">
17068 <doc xml:whitespace="preserve">the length of @contents in bytes.</doc>
17069 <type name="gulong" c:type="gsize"/>
17071 <parameter name="etag" transfer-ownership="none" allow-none="1">
17072 <doc xml:whitespace="preserve">the old <link linkend="gfile-etag">entity tag</link> for the document, or %NULL</doc>
17073 <type name="utf8" c:type="char*"/>
17075 <parameter name="make_backup" transfer-ownership="none">
17076 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
17077 <type name="gboolean" c:type="gboolean"/>
17079 <parameter name="flags" transfer-ownership="none">
17080 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
17081 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
17083 <parameter name="new_etag"
17085 caller-allocates="0"
17086 transfer-ownership="full"
17088 <doc xml:whitespace="preserve">a location to a new <link linkend="gfile-etag">entity tag</link> for the document. This should be freed with g_free() when no longer needed, or %NULL</doc>
17089 <type name="utf8" c:type="char**"/>
17091 <parameter name="cancellable"
17092 transfer-ownership="none"
17094 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17095 <type name="Cancellable" c:type="GCancellable*"/>
17099 <method name="replace_contents_async"
17100 c:identifier="g_file_replace_contents_async">
17101 <doc xml:whitespace="preserve">Starts an asynchronous replacement of @file with the given
17102 current entity tag.
17103 When this operation has completed, @callback will be called with
17104 g_file_replace_contents_finish().
17105 If @cancellable is not %NULL, then the operation can be cancelled by
17106 triggering the cancellable object from another thread. If the operation
17107 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17108 If @make_backup is %TRUE, this function will attempt to
17109 make a backup of @file.</doc>
17110 <return-value transfer-ownership="none">
17111 <type name="none" c:type="void"/>
17114 <parameter name="contents" transfer-ownership="none">
17115 <doc xml:whitespace="preserve">string of contents to replace the file with.</doc>
17116 <type name="utf8" c:type="char*"/>
17118 <parameter name="length" transfer-ownership="none">
17119 <doc xml:whitespace="preserve">the length of @contents in bytes.</doc>
17120 <type name="gulong" c:type="gsize"/>
17122 <parameter name="etag" transfer-ownership="none" allow-none="1">
17123 <doc xml:whitespace="preserve">a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL</doc>
17124 <type name="utf8" c:type="char*"/>
17126 <parameter name="make_backup" transfer-ownership="none">
17127 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
17128 <type name="gboolean" c:type="gboolean"/>
17130 <parameter name="flags" transfer-ownership="none">
17131 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
17132 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
17134 <parameter name="cancellable"
17135 transfer-ownership="none"
17137 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17138 <type name="Cancellable" c:type="GCancellable*"/>
17140 <parameter name="callback"
17141 transfer-ownership="none"
17144 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
17145 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17147 <parameter name="user_data" transfer-ownership="none">
17148 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17149 <type name="gpointer" c:type="gpointer"/>
17153 <method name="replace_contents_finish"
17154 c:identifier="g_file_replace_contents_finish"
17156 <doc xml:whitespace="preserve">Finishes an asynchronous replace of the given @file. See
17157 g_file_replace_contents_async(). Sets @new_etag to the new entity
17158 tag for the document, if present.</doc>
17159 <return-value transfer-ownership="none">
17160 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure.</doc>
17161 <type name="gboolean" c:type="gboolean"/>
17164 <parameter name="res" transfer-ownership="none">
17165 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17166 <type name="AsyncResult" c:type="GAsyncResult*"/>
17168 <parameter name="new_etag"
17170 caller-allocates="0"
17171 transfer-ownership="full"
17173 <doc xml:whitespace="preserve">a location of a new <link linkend="gfile-etag">entity tag</link> for the document. This should be freed with g_free() when it is no longer needed, or %NULL</doc>
17174 <type name="utf8" c:type="char**"/>
17178 <method name="replace_finish"
17179 c:identifier="g_file_replace_finish"
17181 <doc xml:whitespace="preserve">Finishes an asynchronous file replace operation started with
17182 g_file_replace_async().
17183 Free the returned object with g_object_unref().</doc>
17184 <return-value transfer-ownership="full">
17185 <doc xml:whitespace="preserve">a #GFileOutputStream, or %NULL on error.</doc>
17186 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
17189 <parameter name="res" transfer-ownership="none">
17190 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17191 <type name="AsyncResult" c:type="GAsyncResult*"/>
17195 <method name="replace_readwrite"
17196 c:identifier="g_file_replace_readwrite"
17199 <doc xml:whitespace="preserve">Returns an output stream for overwriting the file in readwrite mode,
17200 possibly creating a backup copy of the file first. If the file doesn't
17201 exist, it will be created.
17202 For details about the behaviour, see g_file_replace() which does the same
17203 thing but returns an output stream only.
17204 Note that in many non-local file cases read and write streams are not
17205 supported, so make sure you really need to do read and write streaming,
17206 rather than just opening for reading or writing.
17207 Free the returned object with g_object_unref().</doc>
17208 <return-value transfer-ownership="full">
17209 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
17210 <type name="FileIOStream" c:type="GFileIOStream*"/>
17213 <parameter name="etag" transfer-ownership="none" allow-none="1">
17214 <doc xml:whitespace="preserve">an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore</doc>
17215 <type name="utf8" c:type="char*"/>
17217 <parameter name="make_backup" transfer-ownership="none">
17218 <doc xml:whitespace="preserve">%TRUE if a backup should be created</doc>
17219 <type name="gboolean" c:type="gboolean"/>
17221 <parameter name="flags" transfer-ownership="none">
17222 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
17223 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
17225 <parameter name="cancellable"
17226 transfer-ownership="none"
17228 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
17229 <type name="Cancellable" c:type="GCancellable*"/>
17233 <method name="replace_readwrite_async"
17234 c:identifier="g_file_replace_readwrite_async"
17236 <doc xml:whitespace="preserve">Asynchronously overwrites the file in read-write mode, replacing the
17237 contents, possibly creating a backup copy of the file first.
17238 For more details, see g_file_replace_readwrite() which is
17239 the synchronous version of this call.
17240 When the operation is finished, @callback will be called. You can then
17241 call g_file_replace_readwrite_finish() to get the result of the operation.</doc>
17242 <return-value transfer-ownership="none">
17243 <type name="none" c:type="void"/>
17246 <parameter name="etag" transfer-ownership="none" allow-none="1">
17247 <doc xml:whitespace="preserve">an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.</doc>
17248 <type name="utf8" c:type="char*"/>
17250 <parameter name="make_backup" transfer-ownership="none">
17251 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
17252 <type name="gboolean" c:type="gboolean"/>
17254 <parameter name="flags" transfer-ownership="none">
17255 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
17256 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
17258 <parameter name="io_priority" transfer-ownership="none">
17259 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
17260 <type name="gint" c:type="int"/>
17262 <parameter name="cancellable"
17263 transfer-ownership="none"
17265 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17266 <type name="Cancellable" c:type="GCancellable*"/>
17268 <parameter name="callback"
17269 transfer-ownership="none"
17272 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
17273 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17275 <parameter name="user_data" transfer-ownership="none">
17276 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17277 <type name="gpointer" c:type="gpointer"/>
17281 <method name="replace_readwrite_finish"
17282 c:identifier="g_file_replace_readwrite_finish"
17285 <doc xml:whitespace="preserve">Finishes an asynchronous file replace operation started with
17286 g_file_replace_readwrite_async().
17287 Free the returned object with g_object_unref().</doc>
17288 <return-value transfer-ownership="full">
17289 <doc xml:whitespace="preserve">a #GFileIOStream, or %NULL on error.</doc>
17290 <type name="FileIOStream" c:type="GFileIOStream*"/>
17293 <parameter name="res" transfer-ownership="none">
17294 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17295 <type name="AsyncResult" c:type="GAsyncResult*"/>
17299 <method name="resolve_relative_path"
17300 c:identifier="g_file_resolve_relative_path">
17301 <doc xml:whitespace="preserve">Resolves a relative path for @file to an absolute path.
17302 This call does no blocking i/o.
17303 is %NULL or if @file is invalid.
17304 Free the returned object with g_object_unref().</doc>
17305 <return-value transfer-ownership="full">
17306 <doc xml:whitespace="preserve">#GFile to the resolved path. %NULL if @relative_path</doc>
17307 <type name="File" c:type="GFile*"/>
17310 <parameter name="relative_path" transfer-ownership="none">
17311 <doc xml:whitespace="preserve">a given relative path string.</doc>
17312 <type name="utf8" c:type="char*"/>
17316 <method name="set_attribute"
17317 c:identifier="g_file_set_attribute"
17319 <doc xml:whitespace="preserve">Sets an attribute in the file with attribute name @attribute to @value.
17320 If @cancellable is not %NULL, then the operation can be cancelled by
17321 triggering the cancellable object from another thread. If the operation
17322 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
17323 <return-value transfer-ownership="none">
17324 <doc xml:whitespace="preserve">%TRUE if the attribute was set, %FALSE otherwise.</doc>
17325 <type name="gboolean" c:type="gboolean"/>
17328 <parameter name="attribute" transfer-ownership="none">
17329 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
17330 <type name="utf8" c:type="char*"/>
17332 <parameter name="type" transfer-ownership="none">
17333 <doc xml:whitespace="preserve">The type of the attribute</doc>
17334 <type name="FileAttributeType" c:type="GFileAttributeType"/>
17336 <parameter name="value_p" transfer-ownership="none">
17337 <doc xml:whitespace="preserve">a pointer to the value (or the pointer itself if the type is a pointer type)</doc>
17338 <type name="gpointer" c:type="gpointer"/>
17340 <parameter name="flags" transfer-ownership="none">
17341 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
17342 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17344 <parameter name="cancellable"
17345 transfer-ownership="none"
17347 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17348 <type name="Cancellable" c:type="GCancellable*"/>
17352 <method name="set_attribute_byte_string"
17353 c:identifier="g_file_set_attribute_byte_string"
17355 <doc xml:whitespace="preserve">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
17356 If @attribute is of a different type, this operation will fail,
17358 If @cancellable is not %NULL, then the operation can be cancelled by
17359 triggering the cancellable object from another thread. If the operation
17360 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17361 in the @file, %FALSE otherwise.</doc>
17362 <return-value transfer-ownership="none">
17363 <doc xml:whitespace="preserve">%TRUE if the @attribute was successfully set to @value</doc>
17364 <type name="gboolean" c:type="gboolean"/>
17367 <parameter name="attribute" transfer-ownership="none">
17368 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
17369 <type name="utf8" c:type="char*"/>
17371 <parameter name="value" transfer-ownership="none">
17372 <doc xml:whitespace="preserve">a string containing the attribute's new value.</doc>
17373 <type name="utf8" c:type="char*"/>
17375 <parameter name="flags" transfer-ownership="none">
17376 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
17377 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17379 <parameter name="cancellable"
17380 transfer-ownership="none"
17382 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17383 <type name="Cancellable" c:type="GCancellable*"/>
17387 <method name="set_attribute_int32"
17388 c:identifier="g_file_set_attribute_int32"
17390 <doc xml:whitespace="preserve">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
17391 If @attribute is of a different type, this operation will fail.
17392 If @cancellable is not %NULL, then the operation can be cancelled by
17393 triggering the cancellable object from another thread. If the operation
17394 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17395 in the @file, %FALSE otherwise.</doc>
17396 <return-value transfer-ownership="none">
17397 <doc xml:whitespace="preserve">%TRUE if the @attribute was successfully set to @value</doc>
17398 <type name="gboolean" c:type="gboolean"/>
17401 <parameter name="attribute" transfer-ownership="none">
17402 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
17403 <type name="utf8" c:type="char*"/>
17405 <parameter name="value" transfer-ownership="none">
17406 <doc xml:whitespace="preserve">a #gint32 containing the attribute's new value.</doc>
17407 <type name="gint32" c:type="gint32"/>
17409 <parameter name="flags" transfer-ownership="none">
17410 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
17411 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17413 <parameter name="cancellable"
17414 transfer-ownership="none"
17416 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17417 <type name="Cancellable" c:type="GCancellable*"/>
17421 <method name="set_attribute_int64"
17422 c:identifier="g_file_set_attribute_int64"
17424 <doc xml:whitespace="preserve">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
17425 If @attribute is of a different type, this operation will fail.
17426 If @cancellable is not %NULL, then the operation can be cancelled by
17427 triggering the cancellable object from another thread. If the operation
17428 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
17429 <return-value transfer-ownership="none">
17430 <doc xml:whitespace="preserve">%TRUE if the @attribute was successfully set, %FALSE otherwise.</doc>
17431 <type name="gboolean" c:type="gboolean"/>
17434 <parameter name="attribute" transfer-ownership="none">
17435 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
17436 <type name="utf8" c:type="char*"/>
17438 <parameter name="value" transfer-ownership="none">
17439 <doc xml:whitespace="preserve">a #guint64 containing the attribute's new value.</doc>
17440 <type name="gint64" c:type="gint64"/>
17442 <parameter name="flags" transfer-ownership="none">
17443 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
17444 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17446 <parameter name="cancellable"
17447 transfer-ownership="none"
17449 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17450 <type name="Cancellable" c:type="GCancellable*"/>
17454 <method name="set_attribute_string"
17455 c:identifier="g_file_set_attribute_string"
17457 <doc xml:whitespace="preserve">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
17458 If @attribute is of a different type, this operation will fail.
17459 If @cancellable is not %NULL, then the operation can be cancelled by
17460 triggering the cancellable object from another thread. If the operation
17461 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
17462 <return-value transfer-ownership="none">
17463 <doc xml:whitespace="preserve">%TRUE if the @attribute was successfully set, %FALSE otherwise.</doc>
17464 <type name="gboolean" c:type="gboolean"/>
17467 <parameter name="attribute" transfer-ownership="none">
17468 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
17469 <type name="utf8" c:type="char*"/>
17471 <parameter name="value" transfer-ownership="none">
17472 <doc xml:whitespace="preserve">a string containing the attribute's value.</doc>
17473 <type name="utf8" c:type="char*"/>
17475 <parameter name="flags" transfer-ownership="none">
17476 <doc xml:whitespace="preserve">#GFileQueryInfoFlags.</doc>
17477 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17479 <parameter name="cancellable"
17480 transfer-ownership="none"
17482 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17483 <type name="Cancellable" c:type="GCancellable*"/>
17487 <method name="set_attribute_uint32"
17488 c:identifier="g_file_set_attribute_uint32"
17490 <doc xml:whitespace="preserve">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
17491 If @attribute is of a different type, this operation will fail.
17492 If @cancellable is not %NULL, then the operation can be cancelled by
17493 triggering the cancellable object from another thread. If the operation
17494 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17495 in the @file, %FALSE otherwise.</doc>
17496 <return-value transfer-ownership="none">
17497 <doc xml:whitespace="preserve">%TRUE if the @attribute was successfully set to @value</doc>
17498 <type name="gboolean" c:type="gboolean"/>
17501 <parameter name="attribute" transfer-ownership="none">
17502 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
17503 <type name="utf8" c:type="char*"/>
17505 <parameter name="value" transfer-ownership="none">
17506 <doc xml:whitespace="preserve">a #guint32 containing the attribute's new value.</doc>
17507 <type name="guint32" c:type="guint32"/>
17509 <parameter name="flags" transfer-ownership="none">
17510 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
17511 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17513 <parameter name="cancellable"
17514 transfer-ownership="none"
17516 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17517 <type name="Cancellable" c:type="GCancellable*"/>
17521 <method name="set_attribute_uint64"
17522 c:identifier="g_file_set_attribute_uint64"
17524 <doc xml:whitespace="preserve">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
17525 If @attribute is of a different type, this operation will fail.
17526 If @cancellable is not %NULL, then the operation can be cancelled by
17527 triggering the cancellable object from another thread. If the operation
17528 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17529 in the @file, %FALSE otherwise.</doc>
17530 <return-value transfer-ownership="none">
17531 <doc xml:whitespace="preserve">%TRUE if the @attribute was successfully set to @value</doc>
17532 <type name="gboolean" c:type="gboolean"/>
17535 <parameter name="attribute" transfer-ownership="none">
17536 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
17537 <type name="utf8" c:type="char*"/>
17539 <parameter name="value" transfer-ownership="none">
17540 <doc xml:whitespace="preserve">a #guint64 containing the attribute's new value.</doc>
17541 <type name="guint64" c:type="guint64"/>
17543 <parameter name="flags" transfer-ownership="none">
17544 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
17545 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17547 <parameter name="cancellable"
17548 transfer-ownership="none"
17550 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17551 <type name="Cancellable" c:type="GCancellable*"/>
17555 <method name="set_attributes_async"
17556 c:identifier="g_file_set_attributes_async">
17557 <doc xml:whitespace="preserve">Asynchronously sets the attributes of @file with @info.
17558 For more details, see g_file_set_attributes_from_info() which is
17559 the synchronous version of this call.
17560 When the operation is finished, @callback will be called. You can then call
17561 g_file_set_attributes_finish() to get the result of the operation.</doc>
17562 <return-value transfer-ownership="none">
17563 <type name="none" c:type="void"/>
17566 <parameter name="info" transfer-ownership="none">
17567 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
17568 <type name="FileInfo" c:type="GFileInfo*"/>
17570 <parameter name="flags" transfer-ownership="none">
17571 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
17572 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17574 <parameter name="io_priority" transfer-ownership="none">
17575 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
17576 <type name="gint" c:type="int"/>
17578 <parameter name="cancellable"
17579 transfer-ownership="none"
17581 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17582 <type name="Cancellable" c:type="GCancellable*"/>
17584 <parameter name="callback"
17585 transfer-ownership="none"
17588 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
17589 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17591 <parameter name="user_data" transfer-ownership="none">
17592 <doc xml:whitespace="preserve">a #gpointer.</doc>
17593 <type name="gpointer" c:type="gpointer"/>
17597 <method name="set_attributes_finish"
17598 c:identifier="g_file_set_attributes_finish"
17600 <doc xml:whitespace="preserve">Finishes setting an attribute started in g_file_set_attributes_async().</doc>
17601 <return-value transfer-ownership="none">
17602 <doc xml:whitespace="preserve">%TRUE if the attributes were set correctly, %FALSE otherwise.</doc>
17603 <type name="gboolean" c:type="gboolean"/>
17606 <parameter name="result" transfer-ownership="none">
17607 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17608 <type name="AsyncResult" c:type="GAsyncResult*"/>
17610 <parameter name="info"
17612 caller-allocates="0"
17613 transfer-ownership="full">
17614 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
17615 <type name="FileInfo" c:type="GFileInfo**"/>
17619 <method name="set_attributes_from_info"
17620 c:identifier="g_file_set_attributes_from_info"
17622 <doc xml:whitespace="preserve">Tries to set all attributes in the #GFileInfo on the target values,
17623 not stopping on the first error.
17624 If there is any error during this operation then @error will be set to
17625 the first error. Error on particular fields are flagged by setting
17626 the "status" field in the attribute value to
17627 %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
17629 If @cancellable is not %NULL, then the operation can be cancelled by
17630 triggering the cancellable object from another thread. If the operation
17631 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
17632 <return-value transfer-ownership="none">
17633 <doc xml:whitespace="preserve">%TRUE if there was any error, %FALSE otherwise.</doc>
17634 <type name="gboolean" c:type="gboolean"/>
17637 <parameter name="info" transfer-ownership="none">
17638 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
17639 <type name="FileInfo" c:type="GFileInfo*"/>
17641 <parameter name="flags" transfer-ownership="none">
17642 <doc xml:whitespace="preserve">#GFileQueryInfoFlags</doc>
17643 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
17645 <parameter name="cancellable"
17646 transfer-ownership="none"
17648 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17649 <type name="Cancellable" c:type="GCancellable*"/>
17653 <method name="set_display_name"
17654 c:identifier="g_file_set_display_name"
17656 <doc xml:whitespace="preserve">Renames @file to the specified display name.
17657 The display name is converted from UTF8 to the correct encoding for the target
17658 filesystem if possible and the @file is renamed to this.
17659 If you want to implement a rename operation in the user interface the edit name
17660 (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
17661 widget, and then the result after editing should be passed to g_file_set_display_name().
17662 On success the resulting converted filename is returned.
17663 If @cancellable is not %NULL, then the operation can be cancelled by
17664 triggering the cancellable object from another thread. If the operation
17665 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17666 if there was an error.
17667 Free the returned object with g_object_unref().</doc>
17668 <return-value transfer-ownership="full">
17669 <doc xml:whitespace="preserve">a #GFile specifying what @file was renamed to, or %NULL</doc>
17670 <type name="File" c:type="GFile*"/>
17673 <parameter name="display_name" transfer-ownership="none">
17674 <doc xml:whitespace="preserve">a string.</doc>
17675 <type name="utf8" c:type="char*"/>
17677 <parameter name="cancellable"
17678 transfer-ownership="none"
17680 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17681 <type name="Cancellable" c:type="GCancellable*"/>
17685 <method name="set_display_name_async"
17686 c:identifier="g_file_set_display_name_async">
17687 <doc xml:whitespace="preserve">Asynchronously sets the display name for a given #GFile.
17688 For more details, see g_file_set_display_name() which is
17689 the synchronous version of this call.
17690 When the operation is finished, @callback will be called. You can then call
17691 g_file_set_display_name_finish() to get the result of the operation.</doc>
17692 <return-value transfer-ownership="none">
17693 <type name="none" c:type="void"/>
17696 <parameter name="display_name" transfer-ownership="none">
17697 <doc xml:whitespace="preserve">a string.</doc>
17698 <type name="utf8" c:type="char*"/>
17700 <parameter name="io_priority" transfer-ownership="none">
17701 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
17702 <type name="gint" c:type="int"/>
17704 <parameter name="cancellable"
17705 transfer-ownership="none"
17707 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17708 <type name="Cancellable" c:type="GCancellable*"/>
17710 <parameter name="callback"
17711 transfer-ownership="none"
17714 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
17715 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17717 <parameter name="user_data" transfer-ownership="none">
17718 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17719 <type name="gpointer" c:type="gpointer"/>
17723 <method name="set_display_name_finish"
17724 c:identifier="g_file_set_display_name_finish"
17726 <doc xml:whitespace="preserve">Finishes setting a display name started with
17727 g_file_set_display_name_async().
17728 Free the returned object with g_object_unref().</doc>
17729 <return-value transfer-ownership="full">
17730 <doc xml:whitespace="preserve">a #GFile or %NULL on error.</doc>
17731 <type name="File" c:type="GFile*"/>
17734 <parameter name="res" transfer-ownership="none">
17735 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17736 <type name="AsyncResult" c:type="GAsyncResult*"/>
17740 <method name="start_mountable"
17741 c:identifier="g_file_start_mountable"
17743 <doc xml:whitespace="preserve">Starts a file of type G_FILE_TYPE_MOUNTABLE.
17744 Using @start_operation, you can request callbacks when, for instance,
17745 passwords are needed during authentication.
17746 If @cancellable is not %NULL, then the operation can be cancelled by
17747 triggering the cancellable object from another thread. If the operation
17748 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17749 When the operation is finished, @callback will be called. You can then call
17750 g_file_mount_mountable_finish() to get the result of the operation.</doc>
17751 <return-value transfer-ownership="none">
17752 <type name="none" c:type="void"/>
17755 <parameter name="flags" transfer-ownership="none">
17756 <doc xml:whitespace="preserve">flags affecting the operation</doc>
17757 <type name="DriveStartFlags" c:type="GDriveStartFlags"/>
17759 <parameter name="start_operation" transfer-ownership="none">
17760 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
17761 <type name="MountOperation" c:type="GMountOperation*"/>
17763 <parameter name="cancellable"
17764 transfer-ownership="none"
17766 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17767 <type name="Cancellable" c:type="GCancellable*"/>
17769 <parameter name="callback"
17770 transfer-ownership="none"
17773 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
17774 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17776 <parameter name="user_data" transfer-ownership="none">
17777 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17778 <type name="gpointer" c:type="gpointer"/>
17782 <method name="start_mountable_finish"
17783 c:identifier="g_file_start_mountable_finish"
17786 <doc xml:whitespace="preserve">Finishes a start operation. See g_file_start_mountable() for details.
17787 Finish an asynchronous start operation that was started
17788 with g_file_start_mountable().
17790 <return-value transfer-ownership="none">
17791 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
17792 <type name="gboolean" c:type="gboolean"/>
17795 <parameter name="result" transfer-ownership="none">
17796 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17797 <type name="AsyncResult" c:type="GAsyncResult*"/>
17801 <method name="stop_mountable"
17802 c:identifier="g_file_stop_mountable"
17804 <doc xml:whitespace="preserve">Stops a file of type G_FILE_TYPE_MOUNTABLE.
17805 If @cancellable is not %NULL, then the operation can be cancelled by
17806 triggering the cancellable object from another thread. If the operation
17807 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17808 When the operation is finished, @callback will be called. You can then call
17809 g_file_stop_mountable_finish() to get the result of the operation.</doc>
17810 <return-value transfer-ownership="none">
17811 <type name="none" c:type="void"/>
17814 <parameter name="flags" transfer-ownership="none">
17815 <doc xml:whitespace="preserve">flags affecting the operation</doc>
17816 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
17818 <parameter name="mount_operation" transfer-ownership="none">
17819 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
17820 <type name="MountOperation" c:type="GMountOperation*"/>
17822 <parameter name="cancellable"
17823 transfer-ownership="none"
17825 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17826 <type name="Cancellable" c:type="GCancellable*"/>
17828 <parameter name="callback"
17829 transfer-ownership="none"
17832 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
17833 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17835 <parameter name="user_data" transfer-ownership="none">
17836 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17837 <type name="gpointer" c:type="gpointer"/>
17841 <method name="stop_mountable_finish"
17842 c:identifier="g_file_stop_mountable_finish"
17845 <doc xml:whitespace="preserve">Finishes an stop operation, see g_file_stop_mountable() for details.
17846 Finish an asynchronous stop operation that was started
17847 with g_file_stop_mountable().
17849 <return-value transfer-ownership="none">
17850 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
17851 <type name="gboolean" c:type="gboolean"/>
17854 <parameter name="result" transfer-ownership="none">
17855 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17856 <type name="AsyncResult" c:type="GAsyncResult*"/>
17860 <method name="supports_thread_contexts"
17861 c:identifier="g_file_supports_thread_contexts"
17863 <doc xml:whitespace="preserve">Checks if @file supports <link
17864 linkend="g-main-context-push-thread-default-context">thread-default
17865 contexts</link>. If this returns %FALSE, you cannot perform
17866 asynchronous operations on @file in a thread that has a
17867 thread-default context.</doc>
17868 <return-value transfer-ownership="none">
17869 <doc xml:whitespace="preserve">Whether or not @file supports thread-default contexts.</doc>
17870 <type name="gboolean" c:type="gboolean"/>
17873 <method name="trash" c:identifier="g_file_trash" throws="1">
17874 <doc xml:whitespace="preserve">Sends @file to the "Trashcan", if possible. This is similar to
17875 deleting it, but the user can recover it before emptying the trashcan.
17876 Not all file systems support trashing, so this call can return the
17877 %G_IO_ERROR_NOT_SUPPORTED error.
17878 If @cancellable is not %NULL, then the operation can be cancelled by
17879 triggering the cancellable object from another thread. If the operation
17880 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
17881 <return-value transfer-ownership="none">
17882 <doc xml:whitespace="preserve">%TRUE on successful trash, %FALSE otherwise.</doc>
17883 <type name="gboolean" c:type="gboolean"/>
17886 <parameter name="cancellable"
17887 transfer-ownership="none"
17889 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17890 <type name="Cancellable" c:type="GCancellable*"/>
17894 <method name="unmount_mountable"
17895 c:identifier="g_file_unmount_mountable"
17896 deprecated="Use g_file_unmount_mountable_with_operation() instead."
17897 deprecated-version="2.22">
17898 <doc xml:whitespace="preserve">Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
17899 If @cancellable is not %NULL, then the operation can be cancelled by
17900 triggering the cancellable object from another thread. If the operation
17901 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17902 When the operation is finished, @callback will be called. You can then call
17903 g_file_unmount_mountable_finish() to get the result of the operation.</doc>
17904 <return-value transfer-ownership="none">
17905 <type name="none" c:type="void"/>
17908 <parameter name="flags" transfer-ownership="none">
17909 <doc xml:whitespace="preserve">flags affecting the operation</doc>
17910 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
17912 <parameter name="cancellable"
17913 transfer-ownership="none"
17915 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17916 <type name="Cancellable" c:type="GCancellable*"/>
17918 <parameter name="callback"
17919 transfer-ownership="none"
17922 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
17923 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17925 <parameter name="user_data" transfer-ownership="none">
17926 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17927 <type name="gpointer" c:type="gpointer"/>
17931 <method name="unmount_mountable_finish"
17932 c:identifier="g_file_unmount_mountable_finish"
17933 deprecated="Use g_file_unmount_mountable_with_operation_finish() instead."
17934 deprecated-version="2.22"
17936 <doc xml:whitespace="preserve">Finishes an unmount operation, see g_file_unmount_mountable() for details.
17937 Finish an asynchronous unmount operation that was started
17938 with g_file_unmount_mountable().
17940 <return-value transfer-ownership="none">
17941 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
17942 <type name="gboolean" c:type="gboolean"/>
17945 <parameter name="result" transfer-ownership="none">
17946 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
17947 <type name="AsyncResult" c:type="GAsyncResult*"/>
17951 <method name="unmount_mountable_with_operation"
17952 c:identifier="g_file_unmount_mountable_with_operation"
17954 <doc xml:whitespace="preserve">Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
17955 If @cancellable is not %NULL, then the operation can be cancelled by
17956 triggering the cancellable object from another thread. If the operation
17957 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17958 When the operation is finished, @callback will be called. You can then call
17959 g_file_unmount_mountable_finish() to get the result of the operation.</doc>
17960 <return-value transfer-ownership="none">
17961 <type name="none" c:type="void"/>
17964 <parameter name="flags" transfer-ownership="none">
17965 <doc xml:whitespace="preserve">flags affecting the operation</doc>
17966 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
17968 <parameter name="mount_operation" transfer-ownership="none">
17969 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
17970 <type name="MountOperation" c:type="GMountOperation*"/>
17972 <parameter name="cancellable"
17973 transfer-ownership="none"
17975 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
17976 <type name="Cancellable" c:type="GCancellable*"/>
17978 <parameter name="callback"
17979 transfer-ownership="none"
17982 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
17983 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
17985 <parameter name="user_data" transfer-ownership="none">
17986 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
17987 <type name="gpointer" c:type="gpointer"/>
17991 <method name="unmount_mountable_with_operation_finish"
17992 c:identifier="g_file_unmount_mountable_with_operation_finish"
17995 <doc xml:whitespace="preserve">Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
17996 Finish an asynchronous unmount operation that was started
17997 with g_file_unmount_mountable_with_operation().
17999 <return-value transfer-ownership="none">
18000 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
18001 <type name="gboolean" c:type="gboolean"/>
18004 <parameter name="result" transfer-ownership="none">
18005 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
18006 <type name="AsyncResult" c:type="GAsyncResult*"/>
18011 <record name="FileAttributeInfo" c:type="GFileAttributeInfo">
18012 <doc xml:whitespace="preserve">Information about a specific attribute.</doc>
18013 <field name="name" writable="1">
18014 <type name="utf8" c:type="char*"/>
18016 <field name="type" writable="1">
18017 <type name="FileAttributeType" c:type="GFileAttributeType"/>
18019 <field name="flags" writable="1">
18020 <type name="FileAttributeInfoFlags" c:type="GFileAttributeInfoFlags"/>
18023 <bitfield name="FileAttributeInfoFlags"
18024 glib:type-name="GFileAttributeInfoFlags"
18025 glib:get-type="g_file_attribute_info_flags_get_type"
18026 c:type="GFileAttributeInfoFlags">
18027 <doc xml:whitespace="preserve">Flags specifying the behaviour of an attribute.</doc>
18028 <member name="none"
18030 c:identifier="G_FILE_ATTRIBUTE_INFO_NONE"
18032 <member name="copy_with_file"
18034 c:identifier="G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE"
18035 glib:nick="copy-with-file"/>
18036 <member name="copy_when_moved"
18038 c:identifier="G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED"
18039 glib:nick="copy-when-moved"/>
18041 <record name="FileAttributeInfoList"
18042 c:type="GFileAttributeInfoList"
18043 glib:type-name="GFileAttributeInfoList"
18044 glib:get-type="g_file_attribute_info_list_get_type"
18045 c:symbol-prefix="file_attribute_info_list">
18046 <doc xml:whitespace="preserve">Acts as a lightweight registry for possible valid file attributes.
18047 The registry stores Key-Value pair formats as #GFileAttributeInfo<!-- -->s.</doc>
18048 <field name="infos" writable="1">
18049 <type name="FileAttributeInfo" c:type="GFileAttributeInfo*"/>
18051 <field name="n_infos" writable="1">
18052 <type name="gint" c:type="int"/>
18054 <constructor name="new" c:identifier="g_file_attribute_info_list_new">
18055 <doc xml:whitespace="preserve">Creates a new file attribute info list.</doc>
18056 <return-value transfer-ownership="full">
18057 <doc xml:whitespace="preserve">a #GFileAttributeInfoList.</doc>
18058 <type name="FileAttributeInfoList" c:type="GFileAttributeInfoList*"/>
18061 <method name="add" c:identifier="g_file_attribute_info_list_add">
18062 <doc xml:whitespace="preserve">Adds a new attribute with @name to the @list, setting
18063 its @type and @flags.</doc>
18064 <return-value transfer-ownership="none">
18065 <type name="none" c:type="void"/>
18068 <parameter name="name" transfer-ownership="none">
18069 <doc xml:whitespace="preserve">the name of the attribute to add.</doc>
18070 <type name="utf8" c:type="char*"/>
18072 <parameter name="type" transfer-ownership="none">
18073 <doc xml:whitespace="preserve">the #GFileAttributeType for the attribute.</doc>
18074 <type name="FileAttributeType" c:type="GFileAttributeType"/>
18076 <parameter name="flags" transfer-ownership="none">
18077 <doc xml:whitespace="preserve">#GFileAttributeInfoFlags for the attribute.</doc>
18078 <type name="FileAttributeInfoFlags"
18079 c:type="GFileAttributeInfoFlags"/>
18083 <method name="dup" c:identifier="g_file_attribute_info_list_dup">
18084 <doc xml:whitespace="preserve">Makes a duplicate of a file attribute info list.</doc>
18085 <return-value transfer-ownership="full">
18086 <doc xml:whitespace="preserve">a copy of the given @list.</doc>
18087 <type name="FileAttributeInfoList" c:type="GFileAttributeInfoList*"/>
18090 <method name="lookup" c:identifier="g_file_attribute_info_list_lookup">
18091 <doc xml:whitespace="preserve">Gets the file attribute with the name @name from @list.
18092 attribute isn't found.</doc>
18093 <return-value transfer-ownership="none">
18094 <doc xml:whitespace="preserve">a #GFileAttributeInfo for the @name, or %NULL if an</doc>
18095 <type name="FileAttributeInfo" c:type="GFileAttributeInfo*"/>
18098 <parameter name="name" transfer-ownership="none">
18099 <doc xml:whitespace="preserve">the name of the attribute to lookup.</doc>
18100 <type name="utf8" c:type="char*"/>
18104 <method name="ref" c:identifier="g_file_attribute_info_list_ref">
18105 <doc xml:whitespace="preserve">References a file attribute info list.</doc>
18106 <return-value transfer-ownership="full">
18107 <doc xml:whitespace="preserve">#GFileAttributeInfoList or %NULL on error.</doc>
18108 <type name="FileAttributeInfoList" c:type="GFileAttributeInfoList*"/>
18111 <method name="unref" c:identifier="g_file_attribute_info_list_unref">
18112 <doc xml:whitespace="preserve">Removes a reference from the given @list. If the reference count
18113 falls to zero, the @list is deleted.</doc>
18114 <return-value transfer-ownership="none">
18115 <type name="none" c:type="void"/>
18119 <record name="FileAttributeMatcher"
18120 c:type="GFileAttributeMatcher"
18121 glib:type-name="GFileAttributeMatcher"
18122 glib:get-type="g_file_attribute_matcher_get_type"
18123 c:symbol-prefix="file_attribute_matcher">
18124 <doc xml:whitespace="preserve">Determines if a string matches a file attribute.</doc>
18125 <constructor name="new" c:identifier="g_file_attribute_matcher_new">
18126 <doc xml:whitespace="preserve">Creates a new file attribute matcher, which matches attributes
18127 against a given string. #GFileAttributeMatcher<!-- -->s are reference
18128 counted structures, and are created with a reference count of 1. If
18129 the number of references falls to 0, the #GFileAttributeMatcher is
18130 automatically destroyed.
18131 The @attribute string should be formatted with specific keys separated
18132 from namespaces with a double colon. Several "namespace::key" strings may be
18133 concatenated with a single comma (e.g. "standard::type,standard::is-hidden").
18134 The wildcard "*" may be used to match all keys and namespaces, or
18135 "namespace::*" will match all keys in a given namespace.
18136 Examples of strings to use:
18138 <title>File Attribute Matcher strings and results</title>
18139 <tgroup cols='2' align='left'><thead>
18140 <row><entry> Matcher String </entry><entry> Matches </entry></row></thead>
18142 <row><entry>"*"</entry><entry>matches all attributes.</entry></row>
18143 <row><entry>"standard::is-hidden"</entry><entry>matches only the key is-hidden in the standard namespace.</entry></row>
18144 <row><entry>"standard::type,unix::*"</entry><entry>matches the type key in the standard namespace and
18145 all keys in the unix namespace.</entry></row>
18146 </tbody></tgroup>
18147 </table></doc>
18148 <return-value transfer-ownership="full">
18149 <doc xml:whitespace="preserve">a #GFileAttributeMatcher.</doc>
18150 <type name="FileAttributeMatcher" c:type="GFileAttributeMatcher*"/>
18153 <parameter name="attributes" transfer-ownership="none">
18154 <doc xml:whitespace="preserve">an attribute string to match.</doc>
18155 <type name="utf8" c:type="char*"/>
18159 <method name="enumerate_namespace"
18160 c:identifier="g_file_attribute_matcher_enumerate_namespace">
18161 <doc xml:whitespace="preserve">Checks if the matcher will match all of the keys in a given namespace.
18162 This will always return %TRUE if a wildcard character is in use (e.g. if
18163 matcher was created with "standard::*" and @ns is "standard", or if matcher was created
18164 using "*" and namespace is anything.)
18165 in the given @ns, %FALSE otherwise.</doc>
18166 <return-value transfer-ownership="none">
18167 <doc xml:whitespace="preserve">%TRUE if the matcher matches all of the entries</doc>
18168 <type name="gboolean" c:type="gboolean"/>
18171 <parameter name="ns" transfer-ownership="none">
18172 <doc xml:whitespace="preserve">a string containing a file attribute namespace.</doc>
18173 <type name="utf8" c:type="char*"/>
18177 <method name="enumerate_next"
18178 c:identifier="g_file_attribute_matcher_enumerate_next">
18179 <doc xml:whitespace="preserve">Gets the next matched attribute from a #GFileAttributeMatcher.
18180 no more attribute exist.</doc>
18181 <return-value transfer-ownership="none">
18182 <doc xml:whitespace="preserve">a string containing the next attribute or %NULL if</doc>
18183 <type name="utf8" c:type="char*"/>
18186 <method name="matches" c:identifier="g_file_attribute_matcher_matches">
18187 <doc xml:whitespace="preserve">Checks if an attribute will be matched by an attribute matcher. If
18188 the matcher was created with the "*" matching string, this function
18189 will always return %TRUE.</doc>
18190 <return-value transfer-ownership="none">
18191 <doc xml:whitespace="preserve">%TRUE if @attribute matches @matcher. %FALSE otherwise.</doc>
18192 <type name="gboolean" c:type="gboolean"/>
18195 <parameter name="attribute" transfer-ownership="none">
18196 <doc xml:whitespace="preserve">a file attribute key.</doc>
18197 <type name="utf8" c:type="char*"/>
18201 <method name="matches_only"
18202 c:identifier="g_file_attribute_matcher_matches_only">
18203 <doc xml:whitespace="preserve">Checks if a attribute matcher only matches a given attribute. Always
18204 returns %FALSE if "*" was used when creating the matcher.</doc>
18205 <return-value transfer-ownership="none">
18206 <doc xml:whitespace="preserve">%TRUE if the matcher only matches @attribute. %FALSE otherwise.</doc>
18207 <type name="gboolean" c:type="gboolean"/>
18210 <parameter name="attribute" transfer-ownership="none">
18211 <doc xml:whitespace="preserve">a file attribute key.</doc>
18212 <type name="utf8" c:type="char*"/>
18216 <method name="ref" c:identifier="g_file_attribute_matcher_ref">
18217 <doc xml:whitespace="preserve">References a file attribute matcher.</doc>
18218 <return-value transfer-ownership="full">
18219 <doc xml:whitespace="preserve">a #GFileAttributeMatcher.</doc>
18220 <type name="FileAttributeMatcher" c:type="GFileAttributeMatcher*"/>
18223 <method name="unref" c:identifier="g_file_attribute_matcher_unref">
18224 <doc xml:whitespace="preserve">Unreferences @matcher. If the reference count falls below 1,
18225 the @matcher is automatically freed.</doc>
18226 <return-value transfer-ownership="none">
18227 <type name="none" c:type="void"/>
18231 <enumeration name="FileAttributeStatus"
18232 glib:type-name="GFileAttributeStatus"
18233 glib:get-type="g_file_attribute_status_get_type"
18234 c:type="GFileAttributeStatus">
18235 <doc xml:whitespace="preserve">Used by g_file_set_attributes_from_info() when setting file attributes.</doc>
18236 <member name="unset"
18238 c:identifier="G_FILE_ATTRIBUTE_STATUS_UNSET"
18239 glib:nick="unset"/>
18242 c:identifier="G_FILE_ATTRIBUTE_STATUS_SET"
18244 <member name="error_setting"
18246 c:identifier="G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING"
18247 glib:nick="error-setting"/>
18249 <enumeration name="FileAttributeType"
18250 glib:type-name="GFileAttributeType"
18251 glib:get-type="g_file_attribute_type_get_type"
18252 c:type="GFileAttributeType">
18253 <doc xml:whitespace="preserve">The data types for file attributes.</doc>
18254 <member name="invalid"
18256 c:identifier="G_FILE_ATTRIBUTE_TYPE_INVALID"
18257 glib:nick="invalid"/>
18258 <member name="string"
18260 c:identifier="G_FILE_ATTRIBUTE_TYPE_STRING"
18261 glib:nick="string"/>
18262 <member name="byte_string"
18264 c:identifier="G_FILE_ATTRIBUTE_TYPE_BYTE_STRING"
18265 glib:nick="byte-string"/>
18266 <member name="boolean"
18268 c:identifier="G_FILE_ATTRIBUTE_TYPE_BOOLEAN"
18269 glib:nick="boolean"/>
18270 <member name="uint32"
18272 c:identifier="G_FILE_ATTRIBUTE_TYPE_UINT32"
18273 glib:nick="uint32"/>
18274 <member name="int32"
18276 c:identifier="G_FILE_ATTRIBUTE_TYPE_INT32"
18277 glib:nick="int32"/>
18278 <member name="uint64"
18280 c:identifier="G_FILE_ATTRIBUTE_TYPE_UINT64"
18281 glib:nick="uint64"/>
18282 <member name="int64"
18284 c:identifier="G_FILE_ATTRIBUTE_TYPE_INT64"
18285 glib:nick="int64"/>
18286 <member name="object"
18288 c:identifier="G_FILE_ATTRIBUTE_TYPE_OBJECT"
18289 glib:nick="object"/>
18290 <member name="stringv"
18292 c:identifier="G_FILE_ATTRIBUTE_TYPE_STRINGV"
18293 glib:nick="stringv"/>
18295 <bitfield name="FileCopyFlags"
18296 glib:type-name="GFileCopyFlags"
18297 glib:get-type="g_file_copy_flags_get_type"
18298 c:type="GFileCopyFlags">
18299 <doc xml:whitespace="preserve">Flags used when copying or moving files.</doc>
18300 <member name="none"
18302 c:identifier="G_FILE_COPY_NONE"
18304 <member name="overwrite"
18306 c:identifier="G_FILE_COPY_OVERWRITE"
18307 glib:nick="overwrite"/>
18308 <member name="backup"
18310 c:identifier="G_FILE_COPY_BACKUP"
18311 glib:nick="backup"/>
18312 <member name="nofollow_symlinks"
18314 c:identifier="G_FILE_COPY_NOFOLLOW_SYMLINKS"
18315 glib:nick="nofollow-symlinks"/>
18316 <member name="all_metadata"
18318 c:identifier="G_FILE_COPY_ALL_METADATA"
18319 glib:nick="all-metadata"/>
18320 <member name="no_fallback_for_move"
18322 c:identifier="G_FILE_COPY_NO_FALLBACK_FOR_MOVE"
18323 glib:nick="no-fallback-for-move"/>
18324 <member name="target_default_perms"
18326 c:identifier="G_FILE_COPY_TARGET_DEFAULT_PERMS"
18327 glib:nick="target-default-perms"/>
18329 <bitfield name="FileCreateFlags"
18330 glib:type-name="GFileCreateFlags"
18331 glib:get-type="g_file_create_flags_get_type"
18332 c:type="GFileCreateFlags">
18333 <doc xml:whitespace="preserve">Flags used when an operation may create a file.</doc>
18334 <member name="none"
18336 c:identifier="G_FILE_CREATE_NONE"
18338 <member name="private"
18340 c:identifier="G_FILE_CREATE_PRIVATE"
18341 glib:nick="private"/>
18342 <member name="replace_destination"
18344 c:identifier="G_FILE_CREATE_REPLACE_DESTINATION"
18345 glib:nick="replace-destination"/>
18347 <interface name="FileDescriptorBased"
18348 c:symbol-prefix="file_descriptor_based"
18349 c:type="GFileDescriptorBased"
18350 glib:type-name="GFileDescriptorBased"
18351 glib:get-type="g_file_descriptor_based_get_type"
18352 glib:type-struct="FileDescriptorBasedIface">
18353 <doc xml:whitespace="preserve">An interface for file descriptor based io objects.</doc>
18354 <virtual-method name="get_fd" invoker="get_fd" version="2.24">
18355 <doc xml:whitespace="preserve">Gets the underlying file descriptor.</doc>
18356 <return-value transfer-ownership="none">
18357 <doc xml:whitespace="preserve">The file descriptor</doc>
18358 <type name="gint" c:type="int"/>
18361 <method name="get_fd"
18362 c:identifier="g_file_descriptor_based_get_fd"
18364 <doc xml:whitespace="preserve">Gets the underlying file descriptor.</doc>
18365 <return-value transfer-ownership="none">
18366 <doc xml:whitespace="preserve">The file descriptor</doc>
18367 <type name="gint" c:type="int"/>
18371 <record name="FileDescriptorBasedIface"
18372 c:type="GFileDescriptorBasedIface"
18373 glib:is-gtype-struct-for="FileDescriptorBased">
18374 <field name="g_iface">
18375 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
18377 <field name="get_fd">
18378 <callback name="get_fd">
18379 <return-value transfer-ownership="none">
18380 <doc xml:whitespace="preserve">The file descriptor</doc>
18381 <type name="gint" c:type="int"/>
18384 <parameter name="fd_based" transfer-ownership="none">
18385 <type name="FileDescriptorBased" c:type="GFileDescriptorBased*"/>
18391 <class name="FileEnumerator"
18392 c:symbol-prefix="file_enumerator"
18393 c:type="GFileEnumerator"
18394 parent="GObject.Object"
18395 glib:type-name="GFileEnumerator"
18396 glib:get-type="g_file_enumerator_get_type"
18397 glib:type-struct="FileEnumeratorClass">
18398 <doc xml:whitespace="preserve">A per matched file iterator.</doc>
18399 <virtual-method name="close_async" invoker="close_async">
18400 <doc xml:whitespace="preserve">Asynchronously closes the file enumerator.
18401 If @cancellable is not %NULL, then the operation can be cancelled by
18402 triggering the cancellable object from another thread. If the operation
18403 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned in
18404 g_file_enumerator_close_finish().</doc>
18405 <return-value transfer-ownership="none">
18406 <type name="none" c:type="void"/>
18409 <parameter name="io_priority" transfer-ownership="none">
18410 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
18411 <type name="gint" c:type="int"/>
18413 <parameter name="cancellable"
18414 transfer-ownership="none"
18416 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18417 <type name="Cancellable" c:type="GCancellable*"/>
18419 <parameter name="callback"
18420 transfer-ownership="none"
18423 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
18424 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
18426 <parameter name="user_data" transfer-ownership="none" closure="3">
18427 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
18428 <type name="gpointer" c:type="gpointer"/>
18432 <virtual-method name="close_finish" invoker="close_finish" throws="1">
18433 <doc xml:whitespace="preserve">Finishes closing a file enumerator, started from g_file_enumerator_close_async().
18434 If the file enumerator was already closed when g_file_enumerator_close_async()
18435 was called, then this function will report %G_IO_ERROR_CLOSED in @error, and
18436 return %FALSE. If the file enumerator had pending operation when the close
18437 operation was started, then this function will report %G_IO_ERROR_PENDING, and
18438 return %FALSE. If @cancellable was not %NULL, then the operation may have been
18439 cancelled by triggering the cancellable object from another thread. If the operation
18440 was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %FALSE will be
18442 <return-value transfer-ownership="none">
18443 <doc xml:whitespace="preserve">%TRUE if the close operation has finished successfully.</doc>
18444 <type name="gboolean" c:type="gboolean"/>
18447 <parameter name="res" transfer-ownership="none">
18448 <type name="AsyncResult" c:type="GAsyncResult*"/>
18452 <virtual-method name="close_fn" throws="1">
18453 <return-value transfer-ownership="none">
18454 <type name="gboolean" c:type="gboolean"/>
18457 <parameter name="cancellable" transfer-ownership="none">
18458 <type name="Cancellable" c:type="GCancellable*"/>
18462 <virtual-method name="next_file" invoker="next_file" throws="1">
18463 <doc xml:whitespace="preserve">Returns information for the next file in the enumerated object.
18464 Will block until the information is available. The #GFileInfo
18465 returned from this function will contain attributes that match the
18466 attribute string that was passed when the #GFileEnumerator was created.
18467 On error, returns %NULL and sets @error to the error. If the
18468 enumerator is at the end, %NULL will be returned and @error will
18470 Free the returned object with g_object_unref() when no longer needed.</doc>
18471 <return-value transfer-ownership="full">
18472 <doc xml:whitespace="preserve">A #GFileInfo or %NULL on error or end of enumerator.</doc>
18473 <type name="FileInfo" c:type="GFileInfo*"/>
18476 <parameter name="cancellable"
18477 transfer-ownership="none"
18479 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18480 <type name="Cancellable" c:type="GCancellable*"/>
18484 <virtual-method name="next_files_async" invoker="next_files_async">
18485 <doc xml:whitespace="preserve">Request information for a number of files from the enumerator asynchronously.
18486 When all i/o for the operation is finished the @callback will be called with
18487 the requested information.
18488 The callback can be called with less than @num_files files in case of error
18489 or at the end of the enumerator. In case of a partial error the callback will
18490 be called with any succeeding items and no error, and on the next request the
18491 error will be reported. If a request is cancelled the callback will be called
18492 with %G_IO_ERROR_CANCELLED.
18493 During an async request no other sync and async calls are allowed, and will
18494 result in %G_IO_ERROR_PENDING errors.
18495 Any outstanding i/o request with higher priority (lower numerical value) will
18496 be executed before an outstanding request with lower priority. Default
18497 priority is %G_PRIORITY_DEFAULT.</doc>
18498 <return-value transfer-ownership="none">
18499 <type name="none" c:type="void"/>
18502 <parameter name="num_files" transfer-ownership="none">
18503 <doc xml:whitespace="preserve">the number of file info objects to request</doc>
18504 <type name="gint" c:type="int"/>
18506 <parameter name="io_priority" transfer-ownership="none">
18507 <doc xml:whitespace="preserve">the <link linkend="gioscheduler">io priority</link> of the request.</doc>
18508 <type name="gint" c:type="int"/>
18510 <parameter name="cancellable"
18511 transfer-ownership="none"
18513 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18514 <type name="Cancellable" c:type="GCancellable*"/>
18516 <parameter name="callback"
18517 transfer-ownership="none"
18520 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
18521 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
18523 <parameter name="user_data" transfer-ownership="none" closure="4">
18524 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
18525 <type name="gpointer" c:type="gpointer"/>
18529 <virtual-method name="next_files_finish"
18530 invoker="next_files_finish"
18532 <doc xml:whitespace="preserve">Finishes the asynchronous operation started with g_file_enumerator_next_files_async().
18533 g_list_free() and unref the infos with g_object_unref() when you're
18534 done with them.</doc>
18535 <return-value transfer-ownership="full">
18536 <doc xml:whitespace="preserve">a #GList of #GFileInfo<!---->s. You must free the list with</doc>
18537 <type name="GLib.List" c:type="GList*">
18538 <type name="FileInfo"/>
18542 <parameter name="res" transfer-ownership="none">
18543 <type name="AsyncResult" c:type="GAsyncResult*"/>
18547 <method name="close" c:identifier="g_file_enumerator_close" throws="1">
18548 <doc xml:whitespace="preserve">Releases all resources used by this enumerator, making the
18549 enumerator return %G_IO_ERROR_CLOSED on all calls.
18550 This will be automatically called when the last reference
18551 is dropped, but you might want to call this function to make
18552 sure resources are released as early as possible.</doc>
18553 <return-value transfer-ownership="none">
18554 <doc xml:whitespace="preserve">#TRUE on success or #FALSE on error.</doc>
18555 <type name="gboolean" c:type="gboolean"/>
18558 <parameter name="cancellable"
18559 transfer-ownership="none"
18561 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18562 <type name="Cancellable" c:type="GCancellable*"/>
18566 <method name="close_async" c:identifier="g_file_enumerator_close_async">
18567 <doc xml:whitespace="preserve">Asynchronously closes the file enumerator.
18568 If @cancellable is not %NULL, then the operation can be cancelled by
18569 triggering the cancellable object from another thread. If the operation
18570 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned in
18571 g_file_enumerator_close_finish().</doc>
18572 <return-value transfer-ownership="none">
18573 <type name="none" c:type="void"/>
18576 <parameter name="io_priority" transfer-ownership="none">
18577 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
18578 <type name="gint" c:type="int"/>
18580 <parameter name="cancellable"
18581 transfer-ownership="none"
18583 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18584 <type name="Cancellable" c:type="GCancellable*"/>
18586 <parameter name="callback"
18587 transfer-ownership="none"
18590 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
18591 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
18593 <parameter name="user_data" transfer-ownership="none">
18594 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
18595 <type name="gpointer" c:type="gpointer"/>
18599 <method name="close_finish"
18600 c:identifier="g_file_enumerator_close_finish"
18602 <doc xml:whitespace="preserve">Finishes closing a file enumerator, started from g_file_enumerator_close_async().
18603 If the file enumerator was already closed when g_file_enumerator_close_async()
18604 was called, then this function will report %G_IO_ERROR_CLOSED in @error, and
18605 return %FALSE. If the file enumerator had pending operation when the close
18606 operation was started, then this function will report %G_IO_ERROR_PENDING, and
18607 return %FALSE. If @cancellable was not %NULL, then the operation may have been
18608 cancelled by triggering the cancellable object from another thread. If the operation
18609 was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %FALSE will be
18611 <return-value transfer-ownership="none">
18612 <doc xml:whitespace="preserve">%TRUE if the close operation has finished successfully.</doc>
18613 <type name="gboolean" c:type="gboolean"/>
18616 <parameter name="result" transfer-ownership="none">
18617 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
18618 <type name="AsyncResult" c:type="GAsyncResult*"/>
18622 <method name="get_container"
18623 c:identifier="g_file_enumerator_get_container"
18625 <doc xml:whitespace="preserve">Get the #GFile container which is being enumerated.</doc>
18626 <return-value transfer-ownership="full">
18627 <doc xml:whitespace="preserve">the #GFile which is being enumerated.</doc>
18628 <type name="File" c:type="GFile*"/>
18631 <method name="has_pending" c:identifier="g_file_enumerator_has_pending">
18632 <doc xml:whitespace="preserve">Checks if the file enumerator has pending operations.</doc>
18633 <return-value transfer-ownership="none">
18634 <doc xml:whitespace="preserve">%TRUE if the @enumerator has pending operations.</doc>
18635 <type name="gboolean" c:type="gboolean"/>
18638 <method name="is_closed" c:identifier="g_file_enumerator_is_closed">
18639 <doc xml:whitespace="preserve">Checks if the file enumerator has been closed.</doc>
18640 <return-value transfer-ownership="none">
18641 <doc xml:whitespace="preserve">%TRUE if the @enumerator is closed.</doc>
18642 <type name="gboolean" c:type="gboolean"/>
18645 <method name="next_file"
18646 c:identifier="g_file_enumerator_next_file"
18648 <doc xml:whitespace="preserve">Returns information for the next file in the enumerated object.
18649 Will block until the information is available. The #GFileInfo
18650 returned from this function will contain attributes that match the
18651 attribute string that was passed when the #GFileEnumerator was created.
18652 On error, returns %NULL and sets @error to the error. If the
18653 enumerator is at the end, %NULL will be returned and @error will
18655 Free the returned object with g_object_unref() when no longer needed.</doc>
18656 <return-value transfer-ownership="full">
18657 <doc xml:whitespace="preserve">A #GFileInfo or %NULL on error or end of enumerator.</doc>
18658 <type name="FileInfo" c:type="GFileInfo*"/>
18661 <parameter name="cancellable"
18662 transfer-ownership="none"
18664 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18665 <type name="Cancellable" c:type="GCancellable*"/>
18669 <method name="next_files_async"
18670 c:identifier="g_file_enumerator_next_files_async">
18671 <doc xml:whitespace="preserve">Request information for a number of files from the enumerator asynchronously.
18672 When all i/o for the operation is finished the @callback will be called with
18673 the requested information.
18674 The callback can be called with less than @num_files files in case of error
18675 or at the end of the enumerator. In case of a partial error the callback will
18676 be called with any succeeding items and no error, and on the next request the
18677 error will be reported. If a request is cancelled the callback will be called
18678 with %G_IO_ERROR_CANCELLED.
18679 During an async request no other sync and async calls are allowed, and will
18680 result in %G_IO_ERROR_PENDING errors.
18681 Any outstanding i/o request with higher priority (lower numerical value) will
18682 be executed before an outstanding request with lower priority. Default
18683 priority is %G_PRIORITY_DEFAULT.</doc>
18684 <return-value transfer-ownership="none">
18685 <type name="none" c:type="void"/>
18688 <parameter name="num_files" transfer-ownership="none">
18689 <doc xml:whitespace="preserve">the number of file info objects to request</doc>
18690 <type name="gint" c:type="int"/>
18692 <parameter name="io_priority" transfer-ownership="none">
18693 <doc xml:whitespace="preserve">the <link linkend="gioscheduler">io priority</link> of the request.</doc>
18694 <type name="gint" c:type="int"/>
18696 <parameter name="cancellable"
18697 transfer-ownership="none"
18699 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18700 <type name="Cancellable" c:type="GCancellable*"/>
18702 <parameter name="callback"
18703 transfer-ownership="none"
18706 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
18707 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
18709 <parameter name="user_data" transfer-ownership="none">
18710 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
18711 <type name="gpointer" c:type="gpointer"/>
18715 <method name="next_files_finish"
18716 c:identifier="g_file_enumerator_next_files_finish"
18718 <doc xml:whitespace="preserve">Finishes the asynchronous operation started with g_file_enumerator_next_files_async().
18719 g_list_free() and unref the infos with g_object_unref() when you're
18720 done with them.</doc>
18721 <return-value transfer-ownership="full">
18722 <doc xml:whitespace="preserve">a #GList of #GFileInfo<!---->s. You must free the list with</doc>
18723 <type name="GLib.List" c:type="GList*">
18724 <type name="FileInfo"/>
18728 <parameter name="result" transfer-ownership="none">
18729 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
18730 <type name="AsyncResult" c:type="GAsyncResult*"/>
18734 <method name="set_pending" c:identifier="g_file_enumerator_set_pending">
18735 <doc xml:whitespace="preserve">Sets the file enumerator as having pending operations.</doc>
18736 <return-value transfer-ownership="none">
18737 <type name="none" c:type="void"/>
18740 <parameter name="pending" transfer-ownership="none">
18741 <doc xml:whitespace="preserve">a boolean value.</doc>
18742 <type name="gboolean" c:type="gboolean"/>
18746 <property name="container"
18750 transfer-ownership="none">
18751 <type name="File"/>
18753 <field name="parent_instance">
18754 <type name="GObject.Object" c:type="GObject"/>
18756 <field name="priv">
18757 <type name="FileEnumeratorPrivate" c:type="GFileEnumeratorPrivate*"/>
18760 <record name="FileEnumeratorClass"
18761 c:type="GFileEnumeratorClass"
18762 glib:is-gtype-struct-for="FileEnumerator">
18763 <field name="parent_class">
18764 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
18766 <field name="next_file">
18767 <callback name="next_file" throws="1">
18768 <return-value transfer-ownership="full">
18769 <doc xml:whitespace="preserve">A #GFileInfo or %NULL on error or end of enumerator.</doc>
18770 <type name="FileInfo" c:type="GFileInfo*"/>
18773 <parameter name="enumerator" transfer-ownership="none">
18774 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
18776 <parameter name="cancellable"
18777 transfer-ownership="none"
18779 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18780 <type name="Cancellable" c:type="GCancellable*"/>
18785 <field name="close_fn">
18786 <callback name="close_fn" throws="1">
18787 <return-value transfer-ownership="none">
18788 <type name="gboolean" c:type="gboolean"/>
18791 <parameter name="enumerator" transfer-ownership="none">
18792 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
18794 <parameter name="cancellable" transfer-ownership="none">
18795 <type name="Cancellable" c:type="GCancellable*"/>
18800 <field name="next_files_async">
18801 <callback name="next_files_async">
18802 <return-value transfer-ownership="none">
18803 <type name="none" c:type="void"/>
18806 <parameter name="enumerator" transfer-ownership="none">
18807 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
18809 <parameter name="num_files" transfer-ownership="none">
18810 <doc xml:whitespace="preserve">the number of file info objects to request</doc>
18811 <type name="gint" c:type="int"/>
18813 <parameter name="io_priority" transfer-ownership="none">
18814 <doc xml:whitespace="preserve">the <link linkend="gioscheduler">io priority</link> of the request.</doc>
18815 <type name="gint" c:type="int"/>
18817 <parameter name="cancellable"
18818 transfer-ownership="none"
18820 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18821 <type name="Cancellable" c:type="GCancellable*"/>
18823 <parameter name="callback"
18824 transfer-ownership="none"
18827 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
18828 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
18830 <parameter name="user_data" transfer-ownership="none" closure="5">
18831 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
18832 <type name="gpointer" c:type="gpointer"/>
18837 <field name="next_files_finish">
18838 <callback name="next_files_finish" throws="1">
18839 <return-value transfer-ownership="full">
18840 <doc xml:whitespace="preserve">a #GList of #GFileInfo<!---->s. You must free the list with</doc>
18841 <type name="GLib.List" c:type="GList*">
18842 <type name="FileInfo"/>
18846 <parameter name="enumerator" transfer-ownership="none">
18847 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
18849 <parameter name="res" transfer-ownership="none">
18850 <type name="AsyncResult" c:type="GAsyncResult*"/>
18855 <field name="close_async">
18856 <callback name="close_async">
18857 <return-value transfer-ownership="none">
18858 <type name="none" c:type="void"/>
18861 <parameter name="enumerator" transfer-ownership="none">
18862 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
18864 <parameter name="io_priority" transfer-ownership="none">
18865 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
18866 <type name="gint" c:type="int"/>
18868 <parameter name="cancellable"
18869 transfer-ownership="none"
18871 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
18872 <type name="Cancellable" c:type="GCancellable*"/>
18874 <parameter name="callback"
18875 transfer-ownership="none"
18878 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
18879 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
18881 <parameter name="user_data" transfer-ownership="none" closure="4">
18882 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
18883 <type name="gpointer" c:type="gpointer"/>
18888 <field name="close_finish">
18889 <callback name="close_finish" throws="1">
18890 <return-value transfer-ownership="none">
18891 <doc xml:whitespace="preserve">%TRUE if the close operation has finished successfully.</doc>
18892 <type name="gboolean" c:type="gboolean"/>
18895 <parameter name="enumerator" transfer-ownership="none">
18896 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
18898 <parameter name="res" transfer-ownership="none">
18899 <type name="AsyncResult" c:type="GAsyncResult*"/>
18904 <field name="_g_reserved1" introspectable="0">
18905 <callback name="_g_reserved1">
18906 <return-value transfer-ownership="none">
18907 <type name="none" c:type="void"/>
18911 <field name="_g_reserved2" introspectable="0">
18912 <callback name="_g_reserved2">
18913 <return-value transfer-ownership="none">
18914 <type name="none" c:type="void"/>
18918 <field name="_g_reserved3" introspectable="0">
18919 <callback name="_g_reserved3">
18920 <return-value transfer-ownership="none">
18921 <type name="none" c:type="void"/>
18925 <field name="_g_reserved4" introspectable="0">
18926 <callback name="_g_reserved4">
18927 <return-value transfer-ownership="none">
18928 <type name="none" c:type="void"/>
18932 <field name="_g_reserved5" introspectable="0">
18933 <callback name="_g_reserved5">
18934 <return-value transfer-ownership="none">
18935 <type name="none" c:type="void"/>
18939 <field name="_g_reserved6" introspectable="0">
18940 <callback name="_g_reserved6">
18941 <return-value transfer-ownership="none">
18942 <type name="none" c:type="void"/>
18946 <field name="_g_reserved7" introspectable="0">
18947 <callback name="_g_reserved7">
18948 <return-value transfer-ownership="none">
18949 <type name="none" c:type="void"/>
18954 <record name="FileEnumeratorPrivate"
18955 c:type="GFileEnumeratorPrivate"
18958 <class name="FileIOStream"
18959 c:symbol-prefix="file_io_stream"
18960 c:type="GFileIOStream"
18962 glib:type-name="GFileIOStream"
18963 glib:get-type="g_file_io_stream_get_type"
18964 glib:type-struct="FileIOStreamClass">
18965 <doc xml:whitespace="preserve">A subclass of GIOStream for opened files. This adds
18966 a few file-specific operations and seeking and truncating.
18967 #GFileIOStream implements GSeekable.</doc>
18968 <implements name="Seekable"/>
18969 <virtual-method name="can_seek">
18970 <return-value transfer-ownership="none">
18971 <type name="gboolean" c:type="gboolean"/>
18974 <virtual-method name="can_truncate">
18975 <return-value transfer-ownership="none">
18976 <type name="gboolean" c:type="gboolean"/>
18979 <virtual-method name="get_etag" invoker="get_etag" version="2.22">
18980 <doc xml:whitespace="preserve">Gets the entity tag for the file when it has been written.
18981 This must be called after the stream has been written
18982 and closed, as the etag can change while writing.</doc>
18983 <return-value transfer-ownership="full">
18984 <doc xml:whitespace="preserve">the entity tag for the stream.</doc>
18985 <type name="utf8" c:type="char*"/>
18988 <virtual-method name="query_info"
18989 invoker="query_info"
18992 <doc xml:whitespace="preserve">Queries a file io stream for the given @attributes.
18993 This function blocks while querying the stream. For the asynchronous
18994 version of this function, see g_file_io_stream_query_info_async().
18995 While the stream is blocked, the stream will set the pending flag
18996 internally, and any other operations on the stream will fail with
18997 %G_IO_ERROR_PENDING.
18998 Can fail if the stream was already closed (with @error being set to
18999 %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being
19000 set to %G_IO_ERROR_PENDING), or if querying info is not supported for
19001 the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). I
19002 all cases of failure, %NULL will be returned.
19003 If @cancellable is not %NULL, then the operation can be cancelled by
19004 triggering the cancellable object from another thread. If the operation
19005 was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
19007 <return-value transfer-ownership="full">
19008 <doc xml:whitespace="preserve">a #GFileInfo for the @stream, or %NULL on error.</doc>
19009 <type name="FileInfo" c:type="GFileInfo*"/>
19012 <parameter name="attributes" transfer-ownership="none">
19013 <doc xml:whitespace="preserve">a file attribute query string.</doc>
19014 <type name="utf8" c:type="char*"/>
19016 <parameter name="cancellable"
19017 transfer-ownership="none"
19019 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19020 <type name="Cancellable" c:type="GCancellable*"/>
19024 <virtual-method name="query_info_async"
19025 invoker="query_info_async"
19027 <doc xml:whitespace="preserve">Asynchronously queries the @stream for a #GFileInfo. When completed,
19028 finish the operation with g_file_io_stream_query_info_finish().
19029 For the synchronous version of this function, see
19030 g_file_io_stream_query_info().</doc>
19031 <return-value transfer-ownership="none">
19032 <type name="none" c:type="void"/>
19035 <parameter name="attributes" transfer-ownership="none">
19036 <doc xml:whitespace="preserve">a file attribute query string.</doc>
19037 <type name="utf8" c:type="char*"/>
19039 <parameter name="io_priority" transfer-ownership="none">
19040 <doc xml:whitespace="preserve">the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.</doc>
19041 <type name="gint" c:type="int"/>
19043 <parameter name="cancellable"
19044 transfer-ownership="none"
19046 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19047 <type name="Cancellable" c:type="GCancellable*"/>
19049 <parameter name="callback"
19050 transfer-ownership="none"
19053 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
19054 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
19056 <parameter name="user_data" transfer-ownership="none" closure="4">
19057 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
19058 <type name="gpointer" c:type="gpointer"/>
19062 <virtual-method name="query_info_finish"
19063 invoker="query_info_finish"
19066 <doc xml:whitespace="preserve">Finalizes the asynchronous query started
19067 by g_file_io_stream_query_info_async().</doc>
19068 <return-value transfer-ownership="full">
19069 <doc xml:whitespace="preserve">A #GFileInfo for the finished query.</doc>
19070 <type name="FileInfo" c:type="GFileInfo*"/>
19073 <parameter name="res" transfer-ownership="none">
19074 <type name="AsyncResult" c:type="GAsyncResult*"/>
19078 <virtual-method name="seek" throws="1">
19079 <return-value transfer-ownership="none">
19080 <type name="gboolean" c:type="gboolean"/>
19083 <parameter name="offset" transfer-ownership="none">
19084 <type name="gint64" c:type="goffset"/>
19086 <parameter name="type" transfer-ownership="none">
19087 <type name="GLib.SeekType" c:type="GSeekType"/>
19089 <parameter name="cancellable" transfer-ownership="none">
19090 <type name="Cancellable" c:type="GCancellable*"/>
19094 <virtual-method name="tell">
19095 <return-value transfer-ownership="none">
19096 <type name="gint64" c:type="goffset"/>
19099 <virtual-method name="truncate_fn" throws="1">
19100 <return-value transfer-ownership="none">
19101 <type name="gboolean" c:type="gboolean"/>
19104 <parameter name="size" transfer-ownership="none">
19105 <type name="gint64" c:type="goffset"/>
19107 <parameter name="cancellable" transfer-ownership="none">
19108 <type name="Cancellable" c:type="GCancellable*"/>
19112 <method name="get_etag"
19113 c:identifier="g_file_io_stream_get_etag"
19115 <doc xml:whitespace="preserve">Gets the entity tag for the file when it has been written.
19116 This must be called after the stream has been written
19117 and closed, as the etag can change while writing.</doc>
19118 <return-value transfer-ownership="full">
19119 <doc xml:whitespace="preserve">the entity tag for the stream.</doc>
19120 <type name="utf8" c:type="char*"/>
19123 <method name="query_info"
19124 c:identifier="g_file_io_stream_query_info"
19127 <doc xml:whitespace="preserve">Queries a file io stream for the given @attributes.
19128 This function blocks while querying the stream. For the asynchronous
19129 version of this function, see g_file_io_stream_query_info_async().
19130 While the stream is blocked, the stream will set the pending flag
19131 internally, and any other operations on the stream will fail with
19132 %G_IO_ERROR_PENDING.
19133 Can fail if the stream was already closed (with @error being set to
19134 %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being
19135 set to %G_IO_ERROR_PENDING), or if querying info is not supported for
19136 the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). I
19137 all cases of failure, %NULL will be returned.
19138 If @cancellable is not %NULL, then the operation can be cancelled by
19139 triggering the cancellable object from another thread. If the operation
19140 was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
19142 <return-value transfer-ownership="full">
19143 <doc xml:whitespace="preserve">a #GFileInfo for the @stream, or %NULL on error.</doc>
19144 <type name="FileInfo" c:type="GFileInfo*"/>
19147 <parameter name="attributes" transfer-ownership="none">
19148 <doc xml:whitespace="preserve">a file attribute query string.</doc>
19149 <type name="utf8" c:type="char*"/>
19151 <parameter name="cancellable"
19152 transfer-ownership="none"
19154 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19155 <type name="Cancellable" c:type="GCancellable*"/>
19159 <method name="query_info_async"
19160 c:identifier="g_file_io_stream_query_info_async"
19162 <doc xml:whitespace="preserve">Asynchronously queries the @stream for a #GFileInfo. When completed,
19163 finish the operation with g_file_io_stream_query_info_finish().
19164 For the synchronous version of this function, see
19165 g_file_io_stream_query_info().</doc>
19166 <return-value transfer-ownership="none">
19167 <type name="none" c:type="void"/>
19170 <parameter name="attributes" transfer-ownership="none">
19171 <doc xml:whitespace="preserve">a file attribute query string.</doc>
19172 <type name="utf8" c:type="char*"/>
19174 <parameter name="io_priority" transfer-ownership="none">
19175 <doc xml:whitespace="preserve">the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.</doc>
19176 <type name="gint" c:type="int"/>
19178 <parameter name="cancellable"
19179 transfer-ownership="none"
19181 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19182 <type name="Cancellable" c:type="GCancellable*"/>
19184 <parameter name="callback"
19185 transfer-ownership="none"
19188 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
19189 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
19191 <parameter name="user_data" transfer-ownership="none">
19192 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
19193 <type name="gpointer" c:type="gpointer"/>
19197 <method name="query_info_finish"
19198 c:identifier="g_file_io_stream_query_info_finish"
19201 <doc xml:whitespace="preserve">Finalizes the asynchronous query started
19202 by g_file_io_stream_query_info_async().</doc>
19203 <return-value transfer-ownership="full">
19204 <doc xml:whitespace="preserve">A #GFileInfo for the finished query.</doc>
19205 <type name="FileInfo" c:type="GFileInfo*"/>
19208 <parameter name="result" transfer-ownership="none">
19209 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
19210 <type name="AsyncResult" c:type="GAsyncResult*"/>
19214 <field name="parent_instance">
19215 <type name="IOStream" c:type="GIOStream"/>
19217 <field name="priv">
19218 <type name="FileIOStreamPrivate" c:type="GFileIOStreamPrivate*"/>
19221 <record name="FileIOStreamClass"
19222 c:type="GFileIOStreamClass"
19223 glib:is-gtype-struct-for="FileIOStream">
19224 <field name="parent_class">
19225 <type name="IOStreamClass" c:type="GIOStreamClass"/>
19227 <field name="tell">
19228 <callback name="tell">
19229 <return-value transfer-ownership="none">
19230 <type name="gint64" c:type="goffset"/>
19233 <parameter name="stream" transfer-ownership="none">
19234 <type name="FileIOStream" c:type="GFileIOStream*"/>
19239 <field name="can_seek">
19240 <callback name="can_seek">
19241 <return-value transfer-ownership="none">
19242 <type name="gboolean" c:type="gboolean"/>
19245 <parameter name="stream" transfer-ownership="none">
19246 <type name="FileIOStream" c:type="GFileIOStream*"/>
19251 <field name="seek">
19252 <callback name="seek" throws="1">
19253 <return-value transfer-ownership="none">
19254 <type name="gboolean" c:type="gboolean"/>
19257 <parameter name="stream" transfer-ownership="none">
19258 <type name="FileIOStream" c:type="GFileIOStream*"/>
19260 <parameter name="offset" transfer-ownership="none">
19261 <type name="gint64" c:type="goffset"/>
19263 <parameter name="type" transfer-ownership="none">
19264 <type name="GLib.SeekType" c:type="GSeekType"/>
19266 <parameter name="cancellable" transfer-ownership="none">
19267 <type name="Cancellable" c:type="GCancellable*"/>
19272 <field name="can_truncate">
19273 <callback name="can_truncate">
19274 <return-value transfer-ownership="none">
19275 <type name="gboolean" c:type="gboolean"/>
19278 <parameter name="stream" transfer-ownership="none">
19279 <type name="FileIOStream" c:type="GFileIOStream*"/>
19284 <field name="truncate_fn">
19285 <callback name="truncate_fn" throws="1">
19286 <return-value transfer-ownership="none">
19287 <type name="gboolean" c:type="gboolean"/>
19290 <parameter name="stream" transfer-ownership="none">
19291 <type name="FileIOStream" c:type="GFileIOStream*"/>
19293 <parameter name="size" transfer-ownership="none">
19294 <type name="gint64" c:type="goffset"/>
19296 <parameter name="cancellable" transfer-ownership="none">
19297 <type name="Cancellable" c:type="GCancellable*"/>
19302 <field name="query_info">
19303 <callback name="query_info" throws="1">
19304 <return-value transfer-ownership="full">
19305 <doc xml:whitespace="preserve">a #GFileInfo for the @stream, or %NULL on error.</doc>
19306 <type name="FileInfo" c:type="GFileInfo*"/>
19309 <parameter name="stream" transfer-ownership="none">
19310 <type name="FileIOStream" c:type="GFileIOStream*"/>
19312 <parameter name="attributes" transfer-ownership="none">
19313 <doc xml:whitespace="preserve">a file attribute query string.</doc>
19314 <type name="utf8" c:type="char*"/>
19316 <parameter name="cancellable"
19317 transfer-ownership="none"
19319 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19320 <type name="Cancellable" c:type="GCancellable*"/>
19325 <field name="query_info_async">
19326 <callback name="query_info_async">
19327 <return-value transfer-ownership="none">
19328 <type name="none" c:type="void"/>
19331 <parameter name="stream" transfer-ownership="none">
19332 <type name="FileIOStream" c:type="GFileIOStream*"/>
19334 <parameter name="attributes" transfer-ownership="none">
19335 <doc xml:whitespace="preserve">a file attribute query string.</doc>
19336 <type name="utf8" c:type="char*"/>
19338 <parameter name="io_priority" transfer-ownership="none">
19339 <doc xml:whitespace="preserve">the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.</doc>
19340 <type name="gint" c:type="int"/>
19342 <parameter name="cancellable"
19343 transfer-ownership="none"
19345 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19346 <type name="Cancellable" c:type="GCancellable*"/>
19348 <parameter name="callback"
19349 transfer-ownership="none"
19352 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
19353 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
19355 <parameter name="user_data" transfer-ownership="none" closure="5">
19356 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
19357 <type name="gpointer" c:type="gpointer"/>
19362 <field name="query_info_finish">
19363 <callback name="query_info_finish" throws="1">
19364 <return-value transfer-ownership="full">
19365 <doc xml:whitespace="preserve">A #GFileInfo for the finished query.</doc>
19366 <type name="FileInfo" c:type="GFileInfo*"/>
19369 <parameter name="stream" transfer-ownership="none">
19370 <type name="FileIOStream" c:type="GFileIOStream*"/>
19372 <parameter name="res" transfer-ownership="none">
19373 <type name="AsyncResult" c:type="GAsyncResult*"/>
19378 <field name="get_etag">
19379 <callback name="get_etag">
19380 <return-value transfer-ownership="full">
19381 <doc xml:whitespace="preserve">the entity tag for the stream.</doc>
19382 <type name="utf8" c:type="char*"/>
19385 <parameter name="stream" transfer-ownership="none">
19386 <type name="FileIOStream" c:type="GFileIOStream*"/>
19391 <field name="_g_reserved1" introspectable="0">
19392 <callback name="_g_reserved1">
19393 <return-value transfer-ownership="none">
19394 <type name="none" c:type="void"/>
19398 <field name="_g_reserved2" introspectable="0">
19399 <callback name="_g_reserved2">
19400 <return-value transfer-ownership="none">
19401 <type name="none" c:type="void"/>
19405 <field name="_g_reserved3" introspectable="0">
19406 <callback name="_g_reserved3">
19407 <return-value transfer-ownership="none">
19408 <type name="none" c:type="void"/>
19412 <field name="_g_reserved4" introspectable="0">
19413 <callback name="_g_reserved4">
19414 <return-value transfer-ownership="none">
19415 <type name="none" c:type="void"/>
19419 <field name="_g_reserved5" introspectable="0">
19420 <callback name="_g_reserved5">
19421 <return-value transfer-ownership="none">
19422 <type name="none" c:type="void"/>
19427 <record name="FileIOStreamPrivate"
19428 c:type="GFileIOStreamPrivate"
19431 <class name="FileIcon"
19432 c:symbol-prefix="file_icon"
19434 parent="GObject.Object"
19435 glib:type-name="GFileIcon"
19436 glib:get-type="g_file_icon_get_type"
19437 glib:type-struct="FileIconClass">
19438 <doc xml:whitespace="preserve">Gets an icon for a #GFile. Implements #GLoadableIcon.</doc>
19439 <implements name="Icon"/>
19440 <implements name="LoadableIcon"/>
19441 <method name="get_file" c:identifier="g_file_icon_get_file">
19442 <doc xml:whitespace="preserve">Gets the #GFile associated with the given @icon.</doc>
19443 <return-value transfer-ownership="none">
19444 <doc xml:whitespace="preserve">a #GFile, or %NULL.</doc>
19445 <type name="File" c:type="GFile*"/>
19448 <property name="file"
19451 transfer-ownership="none">
19452 <doc xml:whitespace="preserve">The file containing the icon.</doc>
19453 <type name="File"/>
19456 <record name="FileIconClass"
19457 c:type="GFileIconClass"
19459 glib:is-gtype-struct-for="FileIcon">
19461 <record name="FileIface"
19462 c:type="GFileIface"
19463 glib:is-gtype-struct-for="File">
19464 <doc xml:whitespace="preserve">An interface for writing VFS file handles.</doc>
19465 <field name="g_iface">
19466 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
19469 <callback name="dup">
19470 <return-value transfer-ownership="full">
19471 <doc xml:whitespace="preserve">a new #GFile that is a duplicate of the given #GFile.</doc>
19472 <type name="File" c:type="GFile*"/>
19475 <parameter name="file" transfer-ownership="none">
19476 <type name="File" c:type="GFile*"/>
19481 <field name="hash">
19482 <callback name="hash">
19483 <return-value transfer-ownership="none">
19484 <type name="guint" c:type="guint"/>
19487 <parameter name="file" transfer-ownership="none">
19488 <type name="File" c:type="GFile*"/>
19493 <field name="equal">
19494 <callback name="equal">
19495 <return-value transfer-ownership="none">
19496 <doc xml:whitespace="preserve">%TRUE if @file1 and @file2 are equal.</doc>
19497 <type name="gboolean" c:type="gboolean"/>
19500 <parameter name="file1" transfer-ownership="none">
19501 <type name="File" c:type="GFile*"/>
19503 <parameter name="file2" transfer-ownership="none">
19504 <doc xml:whitespace="preserve">the second #GFile.</doc>
19505 <type name="File" c:type="GFile*"/>
19510 <field name="is_native">
19511 <callback name="is_native">
19512 <return-value transfer-ownership="none">
19513 <doc xml:whitespace="preserve">%TRUE if file is native.</doc>
19514 <type name="gboolean" c:type="gboolean"/>
19517 <parameter name="file" transfer-ownership="none">
19518 <type name="File" c:type="GFile*"/>
19523 <field name="has_uri_scheme">
19524 <callback name="has_uri_scheme">
19525 <return-value transfer-ownership="none">
19526 <doc xml:whitespace="preserve">%TRUE if #GFile's backend supports the</doc>
19527 <type name="gboolean" c:type="gboolean"/>
19530 <parameter name="file" transfer-ownership="none">
19531 <type name="File" c:type="GFile*"/>
19533 <parameter name="uri_scheme" transfer-ownership="none">
19534 <doc xml:whitespace="preserve">a string containing a URI scheme.</doc>
19535 <type name="utf8" c:type="char*"/>
19540 <field name="get_uri_scheme">
19541 <callback name="get_uri_scheme">
19542 <return-value transfer-ownership="full">
19543 <doc xml:whitespace="preserve">a string containing the URI scheme for the given</doc>
19544 <type name="utf8" c:type="char*"/>
19547 <parameter name="file" transfer-ownership="none">
19548 <type name="File" c:type="GFile*"/>
19553 <field name="get_basename">
19554 <callback name="get_basename">
19555 <return-value transfer-ownership="full">
19556 <doc xml:whitespace="preserve">string containing the #GFile's base name, or %NULL</doc>
19557 <type name="utf8" c:type="char*"/>
19560 <parameter name="file" transfer-ownership="none">
19561 <type name="File" c:type="GFile*"/>
19566 <field name="get_path">
19567 <callback name="get_path">
19568 <return-value transfer-ownership="full">
19569 <doc xml:whitespace="preserve">string containing the #GFile's path, or %NULL if</doc>
19570 <type name="utf8" c:type="char*"/>
19573 <parameter name="file" transfer-ownership="none">
19574 <type name="File" c:type="GFile*"/>
19579 <field name="get_uri">
19580 <callback name="get_uri">
19581 <return-value transfer-ownership="full">
19582 <doc xml:whitespace="preserve">a string containing the #GFile's URI.</doc>
19583 <type name="utf8" c:type="char*"/>
19586 <parameter name="file" transfer-ownership="none">
19587 <type name="File" c:type="GFile*"/>
19592 <field name="get_parse_name">
19593 <callback name="get_parse_name">
19594 <return-value transfer-ownership="full">
19595 <doc xml:whitespace="preserve">a string containing the #GFile's parse name. The returned</doc>
19596 <type name="utf8" c:type="char*"/>
19599 <parameter name="file" transfer-ownership="none">
19600 <type name="File" c:type="GFile*"/>
19605 <field name="get_parent">
19606 <callback name="get_parent">
19607 <return-value transfer-ownership="full">
19608 <doc xml:whitespace="preserve">a #GFile structure to the parent of the given</doc>
19609 <type name="File" c:type="GFile*"/>
19612 <parameter name="file" transfer-ownership="none">
19613 <type name="File" c:type="GFile*"/>
19618 <field name="prefix_matches">
19619 <callback name="prefix_matches">
19620 <return-value transfer-ownership="none">
19621 <doc xml:whitespace="preserve">%TRUE if the @files's parent, grandparent, etc is @prefix.</doc>
19622 <type name="gboolean" c:type="gboolean"/>
19625 <parameter name="prefix" transfer-ownership="none">
19626 <type name="File" c:type="GFile*"/>
19628 <parameter name="file" transfer-ownership="none">
19629 <doc xml:whitespace="preserve">input #GFile.</doc>
19630 <type name="File" c:type="GFile*"/>
19635 <field name="get_relative_path">
19636 <callback name="get_relative_path">
19637 <return-value transfer-ownership="full">
19638 <doc xml:whitespace="preserve">string with the relative path from @descendant</doc>
19639 <type name="utf8" c:type="char*"/>
19642 <parameter name="parent" transfer-ownership="none">
19643 <type name="File" c:type="GFile*"/>
19645 <parameter name="descendant" transfer-ownership="none">
19646 <doc xml:whitespace="preserve">input #GFile.</doc>
19647 <type name="File" c:type="GFile*"/>
19652 <field name="resolve_relative_path">
19653 <callback name="resolve_relative_path">
19654 <return-value transfer-ownership="full">
19655 <doc xml:whitespace="preserve">#GFile to the resolved path. %NULL if @relative_path</doc>
19656 <type name="File" c:type="GFile*"/>
19659 <parameter name="file" transfer-ownership="none">
19660 <type name="File" c:type="GFile*"/>
19662 <parameter name="relative_path" transfer-ownership="none">
19663 <doc xml:whitespace="preserve">a given relative path string.</doc>
19664 <type name="utf8" c:type="char*"/>
19669 <field name="get_child_for_display_name">
19670 <callback name="get_child_for_display_name" throws="1">
19671 <return-value transfer-ownership="full">
19672 <doc xml:whitespace="preserve">a #GFile to the specified child, or</doc>
19673 <type name="File" c:type="GFile*"/>
19676 <parameter name="file" transfer-ownership="none">
19677 <type name="File" c:type="GFile*"/>
19679 <parameter name="display_name" transfer-ownership="none">
19680 <doc xml:whitespace="preserve">string to a possible child.</doc>
19681 <type name="utf8" c:type="char*"/>
19686 <field name="enumerate_children">
19687 <callback name="enumerate_children" throws="1">
19688 <return-value transfer-ownership="full">
19689 <doc xml:whitespace="preserve">A #GFileEnumerator if successful, %NULL on error.</doc>
19690 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
19693 <parameter name="file" transfer-ownership="none">
19694 <type name="File" c:type="GFile*"/>
19696 <parameter name="attributes" transfer-ownership="none">
19697 <doc xml:whitespace="preserve">an attribute query string.</doc>
19698 <type name="utf8" c:type="char*"/>
19700 <parameter name="flags" transfer-ownership="none">
19701 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
19702 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
19704 <parameter name="cancellable"
19705 transfer-ownership="none"
19707 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19708 <type name="Cancellable" c:type="GCancellable*"/>
19713 <field name="enumerate_children_async">
19714 <callback name="enumerate_children_async">
19715 <return-value transfer-ownership="none">
19716 <type name="none" c:type="void"/>
19719 <parameter name="file" transfer-ownership="none">
19720 <type name="File" c:type="GFile*"/>
19722 <parameter name="attributes" transfer-ownership="none">
19723 <doc xml:whitespace="preserve">an attribute query string.</doc>
19724 <type name="utf8" c:type="char*"/>
19726 <parameter name="flags" transfer-ownership="none">
19727 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
19728 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
19730 <parameter name="io_priority" transfer-ownership="none">
19731 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
19732 <type name="gint" c:type="int"/>
19734 <parameter name="cancellable"
19735 transfer-ownership="none"
19737 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19738 <type name="Cancellable" c:type="GCancellable*"/>
19740 <parameter name="callback"
19741 transfer-ownership="none"
19744 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
19745 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
19747 <parameter name="user_data" transfer-ownership="none" closure="6">
19748 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
19749 <type name="gpointer" c:type="gpointer"/>
19754 <field name="enumerate_children_finish">
19755 <callback name="enumerate_children_finish" throws="1">
19756 <return-value transfer-ownership="full">
19757 <doc xml:whitespace="preserve">a #GFileEnumerator or %NULL if an error occurred.</doc>
19758 <type name="FileEnumerator" c:type="GFileEnumerator*"/>
19761 <parameter name="file" transfer-ownership="none">
19762 <type name="File" c:type="GFile*"/>
19764 <parameter name="res" transfer-ownership="none">
19765 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
19766 <type name="AsyncResult" c:type="GAsyncResult*"/>
19771 <field name="query_info">
19772 <callback name="query_info" throws="1">
19773 <return-value transfer-ownership="full">
19774 <doc xml:whitespace="preserve">a #GFileInfo for the given @file, or %NULL on error.</doc>
19775 <type name="FileInfo" c:type="GFileInfo*"/>
19778 <parameter name="file" transfer-ownership="none">
19779 <type name="File" c:type="GFile*"/>
19781 <parameter name="attributes" transfer-ownership="none">
19782 <doc xml:whitespace="preserve">an attribute query string.</doc>
19783 <type name="utf8" c:type="char*"/>
19785 <parameter name="flags" transfer-ownership="none">
19786 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
19787 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
19789 <parameter name="cancellable"
19790 transfer-ownership="none"
19792 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19793 <type name="Cancellable" c:type="GCancellable*"/>
19798 <field name="query_info_async">
19799 <callback name="query_info_async">
19800 <return-value transfer-ownership="none">
19801 <type name="none" c:type="void"/>
19804 <parameter name="file" transfer-ownership="none">
19805 <type name="File" c:type="GFile*"/>
19807 <parameter name="attributes" transfer-ownership="none">
19808 <doc xml:whitespace="preserve">an attribute query string.</doc>
19809 <type name="utf8" c:type="char*"/>
19811 <parameter name="flags" transfer-ownership="none">
19812 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
19813 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
19815 <parameter name="io_priority" transfer-ownership="none">
19816 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
19817 <type name="gint" c:type="int"/>
19819 <parameter name="cancellable"
19820 transfer-ownership="none"
19822 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19823 <type name="Cancellable" c:type="GCancellable*"/>
19825 <parameter name="callback"
19826 transfer-ownership="none"
19829 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
19830 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
19832 <parameter name="user_data" transfer-ownership="none" closure="6">
19833 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
19834 <type name="gpointer" c:type="gpointer"/>
19839 <field name="query_info_finish">
19840 <callback name="query_info_finish" throws="1">
19841 <return-value transfer-ownership="full">
19842 <doc xml:whitespace="preserve">#GFileInfo for given @file or %NULL on error.</doc>
19843 <type name="FileInfo" c:type="GFileInfo*"/>
19846 <parameter name="file" transfer-ownership="none">
19847 <type name="File" c:type="GFile*"/>
19849 <parameter name="res" transfer-ownership="none">
19850 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
19851 <type name="AsyncResult" c:type="GAsyncResult*"/>
19856 <field name="query_filesystem_info">
19857 <callback name="query_filesystem_info" throws="1">
19858 <return-value transfer-ownership="full">
19859 <doc xml:whitespace="preserve">a #GFileInfo or %NULL if there was an error.</doc>
19860 <type name="FileInfo" c:type="GFileInfo*"/>
19863 <parameter name="file" transfer-ownership="none">
19864 <type name="File" c:type="GFile*"/>
19866 <parameter name="attributes" transfer-ownership="none">
19867 <doc xml:whitespace="preserve">an attribute query string.</doc>
19868 <type name="utf8" c:type="char*"/>
19870 <parameter name="cancellable"
19871 transfer-ownership="none"
19873 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19874 <type name="Cancellable" c:type="GCancellable*"/>
19879 <field name="query_filesystem_info_async">
19880 <callback name="query_filesystem_info_async">
19881 <return-value transfer-ownership="none">
19882 <type name="none" c:type="void"/>
19885 <parameter name="file" transfer-ownership="none">
19886 <type name="File" c:type="GFile*"/>
19888 <parameter name="attributes" transfer-ownership="none">
19889 <doc xml:whitespace="preserve">an attribute query string.</doc>
19890 <type name="utf8" c:type="char*"/>
19892 <parameter name="io_priority" transfer-ownership="none">
19893 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
19894 <type name="gint" c:type="int"/>
19896 <parameter name="cancellable"
19897 transfer-ownership="none"
19899 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19900 <type name="Cancellable" c:type="GCancellable*"/>
19902 <parameter name="callback"
19903 transfer-ownership="none"
19906 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
19907 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
19909 <parameter name="user_data" transfer-ownership="none" closure="5">
19910 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
19911 <type name="gpointer" c:type="gpointer"/>
19916 <field name="query_filesystem_info_finish">
19917 <callback name="query_filesystem_info_finish" throws="1">
19918 <return-value transfer-ownership="full">
19919 <doc xml:whitespace="preserve">#GFileInfo for given @file or %NULL on error.</doc>
19920 <type name="FileInfo" c:type="GFileInfo*"/>
19923 <parameter name="file" transfer-ownership="none">
19924 <type name="File" c:type="GFile*"/>
19926 <parameter name="res" transfer-ownership="none">
19927 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
19928 <type name="AsyncResult" c:type="GAsyncResult*"/>
19933 <field name="find_enclosing_mount">
19934 <callback name="find_enclosing_mount" throws="1">
19935 <return-value transfer-ownership="full">
19936 <doc xml:whitespace="preserve">a #GMount where the @file is located or %NULL on error.</doc>
19937 <type name="Mount" c:type="GMount*"/>
19940 <parameter name="file" transfer-ownership="none">
19941 <type name="File" c:type="GFile*"/>
19943 <parameter name="cancellable"
19944 transfer-ownership="none"
19946 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19947 <type name="Cancellable" c:type="GCancellable*"/>
19952 <field name="find_enclosing_mount_async">
19953 <callback name="find_enclosing_mount_async">
19954 <return-value transfer-ownership="none">
19955 <type name="none" c:type="void"/>
19958 <parameter name="file" transfer-ownership="none">
19959 <type name="File" c:type="GFile*"/>
19961 <parameter name="io_priority" transfer-ownership="none">
19962 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
19963 <type name="gint" c:type="int"/>
19965 <parameter name="cancellable"
19966 transfer-ownership="none"
19968 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
19969 <type name="Cancellable" c:type="GCancellable*"/>
19971 <parameter name="callback"
19972 transfer-ownership="none"
19975 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
19976 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
19978 <parameter name="user_data" transfer-ownership="none" closure="4">
19979 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
19980 <type name="gpointer" c:type="gpointer"/>
19985 <field name="find_enclosing_mount_finish">
19986 <callback name="find_enclosing_mount_finish" throws="1">
19987 <return-value transfer-ownership="full">
19988 <doc xml:whitespace="preserve">#GMount for given @file or %NULL on error.</doc>
19989 <type name="Mount" c:type="GMount*"/>
19992 <parameter name="file" transfer-ownership="none">
19993 <type name="File" c:type="GFile*"/>
19995 <parameter name="res" transfer-ownership="none">
19996 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
19997 <type name="AsyncResult" c:type="GAsyncResult*"/>
20002 <field name="set_display_name">
20003 <callback name="set_display_name" throws="1">
20004 <return-value transfer-ownership="full">
20005 <doc xml:whitespace="preserve">a #GFile specifying what @file was renamed to, or %NULL</doc>
20006 <type name="File" c:type="GFile*"/>
20009 <parameter name="file" transfer-ownership="none">
20010 <type name="File" c:type="GFile*"/>
20012 <parameter name="display_name" transfer-ownership="none">
20013 <doc xml:whitespace="preserve">a string.</doc>
20014 <type name="utf8" c:type="char*"/>
20016 <parameter name="cancellable"
20017 transfer-ownership="none"
20019 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20020 <type name="Cancellable" c:type="GCancellable*"/>
20025 <field name="set_display_name_async">
20026 <callback name="set_display_name_async">
20027 <return-value transfer-ownership="none">
20028 <type name="none" c:type="void"/>
20031 <parameter name="file" transfer-ownership="none">
20032 <type name="File" c:type="GFile*"/>
20034 <parameter name="display_name" transfer-ownership="none">
20035 <doc xml:whitespace="preserve">a string.</doc>
20036 <type name="utf8" c:type="char*"/>
20038 <parameter name="io_priority" transfer-ownership="none">
20039 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
20040 <type name="gint" c:type="int"/>
20042 <parameter name="cancellable"
20043 transfer-ownership="none"
20045 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20046 <type name="Cancellable" c:type="GCancellable*"/>
20048 <parameter name="callback"
20049 transfer-ownership="none"
20052 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
20053 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20055 <parameter name="user_data" transfer-ownership="none" closure="5">
20056 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20057 <type name="gpointer" c:type="gpointer"/>
20062 <field name="set_display_name_finish">
20063 <callback name="set_display_name_finish" throws="1">
20064 <return-value transfer-ownership="full">
20065 <doc xml:whitespace="preserve">a #GFile or %NULL on error.</doc>
20066 <type name="File" c:type="GFile*"/>
20069 <parameter name="file" transfer-ownership="none">
20070 <type name="File" c:type="GFile*"/>
20072 <parameter name="res" transfer-ownership="none">
20073 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20074 <type name="AsyncResult" c:type="GAsyncResult*"/>
20079 <field name="query_settable_attributes">
20080 <callback name="query_settable_attributes" throws="1">
20081 <return-value transfer-ownership="full">
20082 <doc xml:whitespace="preserve">a #GFileAttributeInfoList describing the settable attributes.</doc>
20083 <type name="FileAttributeInfoList"
20084 c:type="GFileAttributeInfoList*"/>
20087 <parameter name="file" transfer-ownership="none">
20088 <type name="File" c:type="GFile*"/>
20090 <parameter name="cancellable"
20091 transfer-ownership="none"
20093 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20094 <type name="Cancellable" c:type="GCancellable*"/>
20099 <field name="_query_settable_attributes_async" introspectable="0">
20100 <callback name="_query_settable_attributes_async">
20101 <return-value transfer-ownership="none">
20102 <type name="none" c:type="void"/>
20106 <field name="_query_settable_attributes_finish" introspectable="0">
20107 <callback name="_query_settable_attributes_finish">
20108 <return-value transfer-ownership="none">
20109 <type name="none" c:type="void"/>
20113 <field name="query_writable_namespaces">
20114 <callback name="query_writable_namespaces" throws="1">
20115 <return-value transfer-ownership="full">
20116 <doc xml:whitespace="preserve">a #GFileAttributeInfoList describing the writable namespaces.</doc>
20117 <type name="FileAttributeInfoList"
20118 c:type="GFileAttributeInfoList*"/>
20121 <parameter name="file" transfer-ownership="none">
20122 <type name="File" c:type="GFile*"/>
20124 <parameter name="cancellable"
20125 transfer-ownership="none"
20127 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20128 <type name="Cancellable" c:type="GCancellable*"/>
20133 <field name="_query_writable_namespaces_async" introspectable="0">
20134 <callback name="_query_writable_namespaces_async">
20135 <return-value transfer-ownership="none">
20136 <type name="none" c:type="void"/>
20140 <field name="_query_writable_namespaces_finish" introspectable="0">
20141 <callback name="_query_writable_namespaces_finish">
20142 <return-value transfer-ownership="none">
20143 <type name="none" c:type="void"/>
20147 <field name="set_attribute">
20148 <callback name="set_attribute" throws="1">
20149 <return-value transfer-ownership="none">
20150 <doc xml:whitespace="preserve">%TRUE if the attribute was set, %FALSE otherwise.</doc>
20151 <type name="gboolean" c:type="gboolean"/>
20154 <parameter name="file" transfer-ownership="none">
20155 <type name="File" c:type="GFile*"/>
20157 <parameter name="attribute" transfer-ownership="none">
20158 <doc xml:whitespace="preserve">a string containing the attribute's name.</doc>
20159 <type name="utf8" c:type="char*"/>
20161 <parameter name="type" transfer-ownership="none">
20162 <doc xml:whitespace="preserve">The type of the attribute</doc>
20163 <type name="FileAttributeType" c:type="GFileAttributeType"/>
20165 <parameter name="value_p" transfer-ownership="none">
20166 <doc xml:whitespace="preserve">a pointer to the value (or the pointer itself if the type is a pointer type)</doc>
20167 <type name="gpointer" c:type="gpointer"/>
20169 <parameter name="flags" transfer-ownership="none">
20170 <doc xml:whitespace="preserve">a set of #GFileQueryInfoFlags.</doc>
20171 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
20173 <parameter name="cancellable"
20174 transfer-ownership="none"
20176 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20177 <type name="Cancellable" c:type="GCancellable*"/>
20182 <field name="set_attributes_from_info">
20183 <callback name="set_attributes_from_info" throws="1">
20184 <return-value transfer-ownership="none">
20185 <doc xml:whitespace="preserve">%TRUE if there was any error, %FALSE otherwise.</doc>
20186 <type name="gboolean" c:type="gboolean"/>
20189 <parameter name="file" transfer-ownership="none">
20190 <type name="File" c:type="GFile*"/>
20192 <parameter name="info" transfer-ownership="none">
20193 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
20194 <type name="FileInfo" c:type="GFileInfo*"/>
20196 <parameter name="flags" transfer-ownership="none">
20197 <doc xml:whitespace="preserve">#GFileQueryInfoFlags</doc>
20198 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
20200 <parameter name="cancellable"
20201 transfer-ownership="none"
20203 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20204 <type name="Cancellable" c:type="GCancellable*"/>
20209 <field name="set_attributes_async">
20210 <callback name="set_attributes_async">
20211 <return-value transfer-ownership="none">
20212 <type name="none" c:type="void"/>
20215 <parameter name="file" transfer-ownership="none">
20216 <type name="File" c:type="GFile*"/>
20218 <parameter name="info" transfer-ownership="none">
20219 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
20220 <type name="FileInfo" c:type="GFileInfo*"/>
20222 <parameter name="flags" transfer-ownership="none">
20223 <doc xml:whitespace="preserve">a #GFileQueryInfoFlags.</doc>
20224 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
20226 <parameter name="io_priority" transfer-ownership="none">
20227 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
20228 <type name="gint" c:type="int"/>
20230 <parameter name="cancellable"
20231 transfer-ownership="none"
20233 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20234 <type name="Cancellable" c:type="GCancellable*"/>
20236 <parameter name="callback"
20237 transfer-ownership="none"
20240 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
20241 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20243 <parameter name="user_data" transfer-ownership="none" closure="6">
20244 <doc xml:whitespace="preserve">a #gpointer.</doc>
20245 <type name="gpointer" c:type="gpointer"/>
20250 <field name="set_attributes_finish">
20251 <callback name="set_attributes_finish" throws="1">
20252 <return-value transfer-ownership="none">
20253 <doc xml:whitespace="preserve">%TRUE if the attributes were set correctly, %FALSE otherwise.</doc>
20254 <type name="gboolean" c:type="gboolean"/>
20257 <parameter name="file" transfer-ownership="none">
20258 <type name="File" c:type="GFile*"/>
20260 <parameter name="result" transfer-ownership="none">
20261 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20262 <type name="AsyncResult" c:type="GAsyncResult*"/>
20264 <parameter name="info"
20266 caller-allocates="0"
20267 transfer-ownership="full">
20268 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
20269 <type name="FileInfo" c:type="GFileInfo**"/>
20274 <field name="read_fn">
20275 <callback name="read_fn" throws="1">
20276 <return-value transfer-ownership="full">
20277 <doc xml:whitespace="preserve">#GFileInputStream or %NULL on error.</doc>
20278 <type name="FileInputStream" c:type="GFileInputStream*"/>
20281 <parameter name="file" transfer-ownership="none">
20282 <type name="File" c:type="GFile*"/>
20284 <parameter name="cancellable"
20285 transfer-ownership="none"
20287 <doc xml:whitespace="preserve">a #GCancellable</doc>
20288 <type name="Cancellable" c:type="GCancellable*"/>
20293 <field name="read_async">
20294 <callback name="read_async">
20295 <return-value transfer-ownership="none">
20296 <type name="none" c:type="void"/>
20299 <parameter name="file" transfer-ownership="none">
20300 <type name="File" c:type="GFile*"/>
20302 <parameter name="io_priority" transfer-ownership="none">
20303 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
20304 <type name="gint" c:type="int"/>
20306 <parameter name="cancellable"
20307 transfer-ownership="none"
20309 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20310 <type name="Cancellable" c:type="GCancellable*"/>
20312 <parameter name="callback"
20313 transfer-ownership="none"
20316 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
20317 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20319 <parameter name="user_data" transfer-ownership="none" closure="4">
20320 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20321 <type name="gpointer" c:type="gpointer"/>
20326 <field name="read_finish">
20327 <callback name="read_finish" throws="1">
20328 <return-value transfer-ownership="full">
20329 <doc xml:whitespace="preserve">a #GFileInputStream or %NULL on error.</doc>
20330 <type name="FileInputStream" c:type="GFileInputStream*"/>
20333 <parameter name="file" transfer-ownership="none">
20334 <type name="File" c:type="GFile*"/>
20336 <parameter name="res" transfer-ownership="none">
20337 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20338 <type name="AsyncResult" c:type="GAsyncResult*"/>
20343 <field name="append_to">
20344 <callback name="append_to" throws="1">
20345 <return-value transfer-ownership="full">
20346 <doc xml:whitespace="preserve">a #GFileOutputStream, or %NULL on error.</doc>
20347 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
20350 <parameter name="file" transfer-ownership="none">
20351 <type name="File" c:type="GFile*"/>
20353 <parameter name="flags" transfer-ownership="none">
20354 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
20355 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
20357 <parameter name="cancellable"
20358 transfer-ownership="none"
20360 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20361 <type name="Cancellable" c:type="GCancellable*"/>
20366 <field name="append_to_async">
20367 <callback name="append_to_async">
20368 <return-value transfer-ownership="none">
20369 <type name="none" c:type="void"/>
20372 <parameter name="file" transfer-ownership="none">
20373 <type name="File" c:type="GFile*"/>
20375 <parameter name="flags" transfer-ownership="none">
20376 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
20377 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
20379 <parameter name="io_priority" transfer-ownership="none">
20380 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
20381 <type name="gint" c:type="int"/>
20383 <parameter name="cancellable"
20384 transfer-ownership="none"
20386 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20387 <type name="Cancellable" c:type="GCancellable*"/>
20389 <parameter name="callback"
20390 transfer-ownership="none"
20393 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
20394 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20396 <parameter name="user_data" transfer-ownership="none" closure="5">
20397 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20398 <type name="gpointer" c:type="gpointer"/>
20403 <field name="append_to_finish">
20404 <callback name="append_to_finish" throws="1">
20405 <return-value transfer-ownership="full">
20406 <doc xml:whitespace="preserve">a valid #GFileOutputStream or %NULL on error.</doc>
20407 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
20410 <parameter name="file" transfer-ownership="none">
20411 <type name="File" c:type="GFile*"/>
20413 <parameter name="res" transfer-ownership="none">
20414 <doc xml:whitespace="preserve">#GAsyncResult</doc>
20415 <type name="AsyncResult" c:type="GAsyncResult*"/>
20420 <field name="create">
20421 <callback name="create" throws="1">
20422 <return-value transfer-ownership="full">
20423 <doc xml:whitespace="preserve">a #GFileOutputStream for the newly created file, or</doc>
20424 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
20427 <parameter name="file" transfer-ownership="none">
20428 <type name="File" c:type="GFile*"/>
20430 <parameter name="flags" transfer-ownership="none">
20431 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
20432 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
20434 <parameter name="cancellable"
20435 transfer-ownership="none"
20437 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20438 <type name="Cancellable" c:type="GCancellable*"/>
20443 <field name="create_async">
20444 <callback name="create_async">
20445 <return-value transfer-ownership="none">
20446 <type name="none" c:type="void"/>
20449 <parameter name="file" transfer-ownership="none">
20450 <type name="File" c:type="GFile*"/>
20452 <parameter name="flags" transfer-ownership="none">
20453 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
20454 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
20456 <parameter name="io_priority" transfer-ownership="none">
20457 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
20458 <type name="gint" c:type="int"/>
20460 <parameter name="cancellable"
20461 transfer-ownership="none"
20463 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20464 <type name="Cancellable" c:type="GCancellable*"/>
20466 <parameter name="callback"
20467 transfer-ownership="none"
20470 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
20471 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20473 <parameter name="user_data" transfer-ownership="none" closure="5">
20474 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20475 <type name="gpointer" c:type="gpointer"/>
20480 <field name="create_finish">
20481 <callback name="create_finish" throws="1">
20482 <return-value transfer-ownership="full">
20483 <doc xml:whitespace="preserve">a #GFileOutputStream or %NULL on error.</doc>
20484 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
20487 <parameter name="file" transfer-ownership="none">
20488 <type name="File" c:type="GFile*"/>
20490 <parameter name="res" transfer-ownership="none">
20491 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20492 <type name="AsyncResult" c:type="GAsyncResult*"/>
20497 <field name="replace">
20498 <callback name="replace" throws="1">
20499 <return-value transfer-ownership="full">
20500 <doc xml:whitespace="preserve">a #GFileOutputStream or %NULL on error.</doc>
20501 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
20504 <parameter name="file" transfer-ownership="none">
20505 <type name="File" c:type="GFile*"/>
20507 <parameter name="etag" transfer-ownership="none" allow-none="1">
20508 <doc xml:whitespace="preserve">an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore.</doc>
20509 <type name="utf8" c:type="char*"/>
20511 <parameter name="make_backup" transfer-ownership="none">
20512 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
20513 <type name="gboolean" c:type="gboolean"/>
20515 <parameter name="flags" transfer-ownership="none">
20516 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
20517 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
20519 <parameter name="cancellable"
20520 transfer-ownership="none"
20522 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20523 <type name="Cancellable" c:type="GCancellable*"/>
20528 <field name="replace_async">
20529 <callback name="replace_async">
20530 <return-value transfer-ownership="none">
20531 <type name="none" c:type="void"/>
20534 <parameter name="file" transfer-ownership="none">
20535 <type name="File" c:type="GFile*"/>
20537 <parameter name="etag" transfer-ownership="none" allow-none="1">
20538 <doc xml:whitespace="preserve">an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.</doc>
20539 <type name="utf8" c:type="char*"/>
20541 <parameter name="make_backup" transfer-ownership="none">
20542 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
20543 <type name="gboolean" c:type="gboolean"/>
20545 <parameter name="flags" transfer-ownership="none">
20546 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
20547 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
20549 <parameter name="io_priority" transfer-ownership="none">
20550 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
20551 <type name="gint" c:type="int"/>
20553 <parameter name="cancellable"
20554 transfer-ownership="none"
20556 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20557 <type name="Cancellable" c:type="GCancellable*"/>
20559 <parameter name="callback"
20560 transfer-ownership="none"
20563 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
20564 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20566 <parameter name="user_data" transfer-ownership="none" closure="7">
20567 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20568 <type name="gpointer" c:type="gpointer"/>
20573 <field name="replace_finish">
20574 <callback name="replace_finish" throws="1">
20575 <return-value transfer-ownership="full">
20576 <doc xml:whitespace="preserve">a #GFileOutputStream, or %NULL on error.</doc>
20577 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
20580 <parameter name="file" transfer-ownership="none">
20581 <type name="File" c:type="GFile*"/>
20583 <parameter name="res" transfer-ownership="none">
20584 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20585 <type name="AsyncResult" c:type="GAsyncResult*"/>
20590 <field name="delete_file">
20591 <callback name="delete_file" throws="1">
20592 <return-value transfer-ownership="none">
20593 <doc xml:whitespace="preserve">%TRUE if the file was deleted. %FALSE otherwise.</doc>
20594 <type name="gboolean" c:type="gboolean"/>
20597 <parameter name="file" transfer-ownership="none">
20598 <type name="File" c:type="GFile*"/>
20600 <parameter name="cancellable"
20601 transfer-ownership="none"
20603 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20604 <type name="Cancellable" c:type="GCancellable*"/>
20609 <field name="_delete_file_async" introspectable="0">
20610 <callback name="_delete_file_async">
20611 <return-value transfer-ownership="none">
20612 <type name="none" c:type="void"/>
20616 <field name="_delete_file_finish" introspectable="0">
20617 <callback name="_delete_file_finish">
20618 <return-value transfer-ownership="none">
20619 <type name="none" c:type="void"/>
20623 <field name="trash">
20624 <callback name="trash" throws="1">
20625 <return-value transfer-ownership="none">
20626 <doc xml:whitespace="preserve">%TRUE on successful trash, %FALSE otherwise.</doc>
20627 <type name="gboolean" c:type="gboolean"/>
20630 <parameter name="file" transfer-ownership="none">
20631 <type name="File" c:type="GFile*"/>
20633 <parameter name="cancellable"
20634 transfer-ownership="none"
20636 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20637 <type name="Cancellable" c:type="GCancellable*"/>
20642 <field name="_trash_async" introspectable="0">
20643 <callback name="_trash_async">
20644 <return-value transfer-ownership="none">
20645 <type name="none" c:type="void"/>
20649 <field name="_trash_finish" introspectable="0">
20650 <callback name="_trash_finish">
20651 <return-value transfer-ownership="none">
20652 <type name="none" c:type="void"/>
20656 <field name="make_directory">
20657 <callback name="make_directory" throws="1">
20658 <return-value transfer-ownership="none">
20659 <type name="gboolean" c:type="gboolean"/>
20662 <parameter name="file" transfer-ownership="none">
20663 <type name="File" c:type="GFile*"/>
20665 <parameter name="cancellable"
20666 transfer-ownership="none"
20668 <type name="Cancellable" c:type="GCancellable*"/>
20673 <field name="_make_directory_async" introspectable="0">
20674 <callback name="_make_directory_async">
20675 <return-value transfer-ownership="none">
20676 <type name="none" c:type="void"/>
20680 <field name="_make_directory_finish" introspectable="0">
20681 <callback name="_make_directory_finish">
20682 <return-value transfer-ownership="none">
20683 <type name="none" c:type="void"/>
20687 <field name="make_symbolic_link">
20688 <callback name="make_symbolic_link" throws="1">
20689 <return-value transfer-ownership="none">
20690 <doc xml:whitespace="preserve">%TRUE on the creation of a new symlink, %FALSE otherwise.</doc>
20691 <type name="gboolean" c:type="gboolean"/>
20694 <parameter name="file" transfer-ownership="none">
20695 <type name="File" c:type="GFile*"/>
20697 <parameter name="symlink_value" transfer-ownership="none">
20698 <doc xml:whitespace="preserve">a string with the path for the target of the new symlink</doc>
20699 <type name="utf8" c:type="char*"/>
20701 <parameter name="cancellable"
20702 transfer-ownership="none"
20704 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20705 <type name="Cancellable" c:type="GCancellable*"/>
20710 <field name="_make_symbolic_link_async" introspectable="0">
20711 <callback name="_make_symbolic_link_async">
20712 <return-value transfer-ownership="none">
20713 <type name="none" c:type="void"/>
20717 <field name="_make_symbolic_link_finish" introspectable="0">
20718 <callback name="_make_symbolic_link_finish">
20719 <return-value transfer-ownership="none">
20720 <type name="none" c:type="void"/>
20724 <field name="copy" introspectable="0">
20725 <callback name="copy" introspectable="0" throws="1">
20726 <return-value transfer-ownership="none">
20727 <doc xml:whitespace="preserve">%TRUE on success, %FALSE otherwise.</doc>
20728 <type name="gboolean" c:type="gboolean"/>
20731 <parameter name="source" transfer-ownership="none">
20732 <type name="File" c:type="GFile*"/>
20734 <parameter name="destination" transfer-ownership="none">
20735 <doc xml:whitespace="preserve">destination #GFile</doc>
20736 <type name="File" c:type="GFile*"/>
20738 <parameter name="flags" transfer-ownership="none">
20739 <doc xml:whitespace="preserve">set of #GFileCopyFlags</doc>
20740 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
20742 <parameter name="cancellable"
20743 transfer-ownership="none"
20745 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20746 <type name="Cancellable" c:type="GCancellable*"/>
20748 <parameter name="progress_callback"
20749 transfer-ownership="none"
20751 <doc xml:whitespace="preserve">function to callback with progress information</doc>
20752 <type name="FileProgressCallback"
20753 c:type="GFileProgressCallback"/>
20755 <parameter name="progress_callback_data" transfer-ownership="none">
20756 <doc xml:whitespace="preserve">user data to pass to @progress_callback</doc>
20757 <type name="gpointer" c:type="gpointer"/>
20762 <field name="copy_async" introspectable="0">
20763 <callback name="copy_async" introspectable="0">
20764 <return-value transfer-ownership="none">
20765 <type name="none" c:type="void"/>
20768 <parameter name="source" transfer-ownership="none">
20769 <type name="File" c:type="GFile*"/>
20771 <parameter name="destination" transfer-ownership="none">
20772 <doc xml:whitespace="preserve">destination #GFile</doc>
20773 <type name="File" c:type="GFile*"/>
20775 <parameter name="flags" transfer-ownership="none">
20776 <doc xml:whitespace="preserve">set of #GFileCopyFlags</doc>
20777 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
20779 <parameter name="io_priority" transfer-ownership="none">
20780 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
20781 <type name="gint" c:type="int"/>
20783 <parameter name="cancellable"
20784 transfer-ownership="none"
20786 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20787 <type name="Cancellable" c:type="GCancellable*"/>
20789 <parameter name="progress_callback"
20790 transfer-ownership="none"
20792 <doc xml:whitespace="preserve">function to callback with progress information</doc>
20793 <type name="FileProgressCallback"
20794 c:type="GFileProgressCallback"/>
20796 <parameter name="progress_callback_data" transfer-ownership="none">
20797 <doc xml:whitespace="preserve">user data to pass to @progress_callback</doc>
20798 <type name="gpointer" c:type="gpointer"/>
20800 <parameter name="callback"
20801 transfer-ownership="none"
20804 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
20805 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20807 <parameter name="user_data" transfer-ownership="none" closure="8">
20808 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20809 <type name="gpointer" c:type="gpointer"/>
20814 <field name="copy_finish">
20815 <callback name="copy_finish" throws="1">
20816 <return-value transfer-ownership="none">
20817 <doc xml:whitespace="preserve">a %TRUE on success, %FALSE on error.</doc>
20818 <type name="gboolean" c:type="gboolean"/>
20821 <parameter name="file" transfer-ownership="none">
20822 <type name="File" c:type="GFile*"/>
20824 <parameter name="res" transfer-ownership="none">
20825 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20826 <type name="AsyncResult" c:type="GAsyncResult*"/>
20831 <field name="move" introspectable="0">
20832 <callback name="move" introspectable="0" throws="1">
20833 <return-value transfer-ownership="none">
20834 <doc xml:whitespace="preserve">%TRUE on successful move, %FALSE otherwise.</doc>
20835 <type name="gboolean" c:type="gboolean"/>
20838 <parameter name="source" transfer-ownership="none">
20839 <type name="File" c:type="GFile*"/>
20841 <parameter name="destination" transfer-ownership="none">
20842 <doc xml:whitespace="preserve">#GFile pointing to the destination location.</doc>
20843 <type name="File" c:type="GFile*"/>
20845 <parameter name="flags" transfer-ownership="none">
20846 <doc xml:whitespace="preserve">set of #GFileCopyFlags.</doc>
20847 <type name="FileCopyFlags" c:type="GFileCopyFlags"/>
20849 <parameter name="cancellable"
20850 transfer-ownership="none"
20852 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20853 <type name="Cancellable" c:type="GCancellable*"/>
20855 <parameter name="progress_callback"
20856 transfer-ownership="none"
20858 <doc xml:whitespace="preserve">#GFileProgressCallback function for updates.</doc>
20859 <type name="FileProgressCallback"
20860 c:type="GFileProgressCallback"/>
20862 <parameter name="progress_callback_data" transfer-ownership="none">
20863 <doc xml:whitespace="preserve">gpointer to user data for the callback function.</doc>
20864 <type name="gpointer" c:type="gpointer"/>
20869 <field name="_move_async" introspectable="0">
20870 <callback name="_move_async">
20871 <return-value transfer-ownership="none">
20872 <type name="none" c:type="void"/>
20876 <field name="_move_finish" introspectable="0">
20877 <callback name="_move_finish">
20878 <return-value transfer-ownership="none">
20879 <type name="none" c:type="void"/>
20883 <field name="mount_mountable">
20884 <callback name="mount_mountable">
20885 <return-value transfer-ownership="none">
20886 <type name="none" c:type="void"/>
20889 <parameter name="file" transfer-ownership="none">
20890 <type name="File" c:type="GFile*"/>
20892 <parameter name="flags" transfer-ownership="none">
20893 <doc xml:whitespace="preserve">flags affecting the operation</doc>
20894 <type name="MountMountFlags" c:type="GMountMountFlags"/>
20896 <parameter name="mount_operation" transfer-ownership="none">
20897 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
20898 <type name="MountOperation" c:type="GMountOperation*"/>
20900 <parameter name="cancellable"
20901 transfer-ownership="none"
20903 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20904 <type name="Cancellable" c:type="GCancellable*"/>
20906 <parameter name="callback"
20907 transfer-ownership="none"
20910 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
20911 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20913 <parameter name="user_data" transfer-ownership="none" closure="5">
20914 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20915 <type name="gpointer" c:type="gpointer"/>
20920 <field name="mount_mountable_finish">
20921 <callback name="mount_mountable_finish" throws="1">
20922 <return-value transfer-ownership="full">
20923 <doc xml:whitespace="preserve">a #GFile or %NULL on error.</doc>
20924 <type name="File" c:type="GFile*"/>
20927 <parameter name="file" transfer-ownership="none">
20928 <type name="File" c:type="GFile*"/>
20930 <parameter name="result" transfer-ownership="none">
20931 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20932 <type name="AsyncResult" c:type="GAsyncResult*"/>
20937 <field name="unmount_mountable">
20938 <callback name="unmount_mountable">
20939 <return-value transfer-ownership="none">
20940 <type name="none" c:type="void"/>
20943 <parameter name="file" transfer-ownership="none">
20944 <type name="File" c:type="GFile*"/>
20946 <parameter name="flags" transfer-ownership="none">
20947 <doc xml:whitespace="preserve">flags affecting the operation</doc>
20948 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
20950 <parameter name="cancellable"
20951 transfer-ownership="none"
20953 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
20954 <type name="Cancellable" c:type="GCancellable*"/>
20956 <parameter name="callback"
20957 transfer-ownership="none"
20960 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
20961 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
20963 <parameter name="user_data" transfer-ownership="none" closure="4">
20964 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
20965 <type name="gpointer" c:type="gpointer"/>
20970 <field name="unmount_mountable_finish">
20971 <callback name="unmount_mountable_finish" throws="1">
20972 <return-value transfer-ownership="none">
20973 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
20974 <type name="gboolean" c:type="gboolean"/>
20977 <parameter name="file" transfer-ownership="none">
20978 <type name="File" c:type="GFile*"/>
20980 <parameter name="result" transfer-ownership="none">
20981 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
20982 <type name="AsyncResult" c:type="GAsyncResult*"/>
20987 <field name="eject_mountable">
20988 <callback name="eject_mountable">
20989 <return-value transfer-ownership="none">
20990 <type name="none" c:type="void"/>
20993 <parameter name="file" transfer-ownership="none">
20994 <type name="File" c:type="GFile*"/>
20996 <parameter name="flags" transfer-ownership="none">
20997 <doc xml:whitespace="preserve">flags affecting the operation</doc>
20998 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
21000 <parameter name="cancellable"
21001 transfer-ownership="none"
21003 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21004 <type name="Cancellable" c:type="GCancellable*"/>
21006 <parameter name="callback"
21007 transfer-ownership="none"
21010 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
21011 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21013 <parameter name="user_data" transfer-ownership="none" closure="4">
21014 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21015 <type name="gpointer" c:type="gpointer"/>
21020 <field name="eject_mountable_finish">
21021 <callback name="eject_mountable_finish" throws="1">
21022 <return-value transfer-ownership="none">
21023 <doc xml:whitespace="preserve">%TRUE if the @file was ejected successfully. %FALSE</doc>
21024 <type name="gboolean" c:type="gboolean"/>
21027 <parameter name="file" transfer-ownership="none">
21028 <type name="File" c:type="GFile*"/>
21030 <parameter name="result" transfer-ownership="none">
21031 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21032 <type name="AsyncResult" c:type="GAsyncResult*"/>
21037 <field name="mount_enclosing_volume">
21038 <callback name="mount_enclosing_volume">
21039 <return-value transfer-ownership="none">
21040 <type name="none" c:type="void"/>
21043 <parameter name="location" transfer-ownership="none">
21044 <type name="File" c:type="GFile*"/>
21046 <parameter name="flags" transfer-ownership="none">
21047 <doc xml:whitespace="preserve">flags affecting the operation</doc>
21048 <type name="MountMountFlags" c:type="GMountMountFlags"/>
21050 <parameter name="mount_operation" transfer-ownership="none">
21051 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
21052 <type name="MountOperation" c:type="GMountOperation*"/>
21054 <parameter name="cancellable"
21055 transfer-ownership="none"
21057 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21058 <type name="Cancellable" c:type="GCancellable*"/>
21060 <parameter name="callback"
21061 transfer-ownership="none"
21064 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
21065 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21067 <parameter name="user_data" transfer-ownership="none" closure="5">
21068 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21069 <type name="gpointer" c:type="gpointer"/>
21074 <field name="mount_enclosing_volume_finish">
21075 <callback name="mount_enclosing_volume_finish" throws="1">
21076 <return-value transfer-ownership="none">
21077 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
21078 <type name="gboolean" c:type="gboolean"/>
21081 <parameter name="location" transfer-ownership="none">
21082 <type name="File" c:type="GFile*"/>
21084 <parameter name="result" transfer-ownership="none">
21085 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21086 <type name="AsyncResult" c:type="GAsyncResult*"/>
21091 <field name="monitor_dir">
21092 <callback name="monitor_dir" throws="1">
21093 <return-value transfer-ownership="full">
21094 <doc xml:whitespace="preserve">a #GFileMonitor for the given @file, or %NULL on error.</doc>
21095 <type name="FileMonitor" c:type="GFileMonitor*"/>
21098 <parameter name="file" transfer-ownership="none">
21099 <type name="File" c:type="GFile*"/>
21101 <parameter name="flags" transfer-ownership="none">
21102 <doc xml:whitespace="preserve">a set of #GFileMonitorFlags.</doc>
21103 <type name="FileMonitorFlags" c:type="GFileMonitorFlags"/>
21105 <parameter name="cancellable"
21106 transfer-ownership="none"
21108 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21109 <type name="Cancellable" c:type="GCancellable*"/>
21114 <field name="monitor_file">
21115 <callback name="monitor_file" throws="1">
21116 <return-value transfer-ownership="full">
21117 <doc xml:whitespace="preserve">a #GFileMonitor for the given @file, or %NULL on error.</doc>
21118 <type name="FileMonitor" c:type="GFileMonitor*"/>
21121 <parameter name="file" transfer-ownership="none">
21122 <type name="File" c:type="GFile*"/>
21124 <parameter name="flags" transfer-ownership="none">
21125 <doc xml:whitespace="preserve">a set of #GFileMonitorFlags.</doc>
21126 <type name="FileMonitorFlags" c:type="GFileMonitorFlags"/>
21128 <parameter name="cancellable"
21129 transfer-ownership="none"
21131 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21132 <type name="Cancellable" c:type="GCancellable*"/>
21137 <field name="open_readwrite">
21138 <callback name="open_readwrite" throws="1">
21139 <return-value transfer-ownership="full">
21140 <doc xml:whitespace="preserve">#GFileIOStream or %NULL on error.</doc>
21141 <type name="FileIOStream" c:type="GFileIOStream*"/>
21144 <parameter name="file" transfer-ownership="none">
21145 <type name="File" c:type="GFile*"/>
21147 <parameter name="cancellable"
21148 transfer-ownership="none"
21150 <doc xml:whitespace="preserve">a #GCancellable</doc>
21151 <type name="Cancellable" c:type="GCancellable*"/>
21156 <field name="open_readwrite_async">
21157 <callback name="open_readwrite_async">
21158 <return-value transfer-ownership="none">
21159 <type name="none" c:type="void"/>
21162 <parameter name="file" transfer-ownership="none">
21163 <type name="File" c:type="GFile*"/>
21165 <parameter name="io_priority" transfer-ownership="none">
21166 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
21167 <type name="gint" c:type="int"/>
21169 <parameter name="cancellable"
21170 transfer-ownership="none"
21172 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21173 <type name="Cancellable" c:type="GCancellable*"/>
21175 <parameter name="callback"
21176 transfer-ownership="none"
21179 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
21180 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21182 <parameter name="user_data" transfer-ownership="none" closure="4">
21183 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21184 <type name="gpointer" c:type="gpointer"/>
21189 <field name="open_readwrite_finish">
21190 <callback name="open_readwrite_finish" throws="1">
21191 <return-value transfer-ownership="full">
21192 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
21193 <type name="FileIOStream" c:type="GFileIOStream*"/>
21196 <parameter name="file" transfer-ownership="none">
21197 <type name="File" c:type="GFile*"/>
21199 <parameter name="res" transfer-ownership="none">
21200 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21201 <type name="AsyncResult" c:type="GAsyncResult*"/>
21206 <field name="create_readwrite">
21207 <callback name="create_readwrite" throws="1">
21208 <return-value transfer-ownership="full">
21209 <doc xml:whitespace="preserve">a #GFileIOStream for the newly created file, or %NULL on error.</doc>
21210 <type name="FileIOStream" c:type="GFileIOStream*"/>
21213 <parameter name="file" transfer-ownership="none">
21214 <type name="File" c:type="GFile*"/>
21216 <parameter name="flags" transfer-ownership="none">
21217 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
21218 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
21220 <parameter name="cancellable"
21221 transfer-ownership="none"
21223 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
21224 <type name="Cancellable" c:type="GCancellable*"/>
21229 <field name="create_readwrite_async">
21230 <callback name="create_readwrite_async">
21231 <return-value transfer-ownership="none">
21232 <type name="none" c:type="void"/>
21235 <parameter name="file" transfer-ownership="none">
21236 <type name="File" c:type="GFile*"/>
21238 <parameter name="flags" transfer-ownership="none">
21239 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
21240 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
21242 <parameter name="io_priority" transfer-ownership="none">
21243 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request</doc>
21244 <type name="gint" c:type="int"/>
21246 <parameter name="cancellable"
21247 transfer-ownership="none"
21249 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
21250 <type name="Cancellable" c:type="GCancellable*"/>
21252 <parameter name="callback"
21253 transfer-ownership="none"
21256 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
21257 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21259 <parameter name="user_data" transfer-ownership="none" closure="5">
21260 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21261 <type name="gpointer" c:type="gpointer"/>
21266 <field name="create_readwrite_finish">
21267 <callback name="create_readwrite_finish" throws="1">
21268 <return-value transfer-ownership="full">
21269 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
21270 <type name="FileIOStream" c:type="GFileIOStream*"/>
21273 <parameter name="file" transfer-ownership="none">
21274 <type name="File" c:type="GFile*"/>
21276 <parameter name="res" transfer-ownership="none">
21277 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
21278 <type name="AsyncResult" c:type="GAsyncResult*"/>
21283 <field name="replace_readwrite">
21284 <callback name="replace_readwrite" throws="1">
21285 <return-value transfer-ownership="full">
21286 <doc xml:whitespace="preserve">a #GFileIOStream or %NULL on error.</doc>
21287 <type name="FileIOStream" c:type="GFileIOStream*"/>
21290 <parameter name="file" transfer-ownership="none">
21291 <type name="File" c:type="GFile*"/>
21293 <parameter name="etag" transfer-ownership="none" allow-none="1">
21294 <doc xml:whitespace="preserve">an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore</doc>
21295 <type name="utf8" c:type="char*"/>
21297 <parameter name="make_backup" transfer-ownership="none">
21298 <doc xml:whitespace="preserve">%TRUE if a backup should be created</doc>
21299 <type name="gboolean" c:type="gboolean"/>
21301 <parameter name="flags" transfer-ownership="none">
21302 <doc xml:whitespace="preserve">a set of #GFileCreateFlags</doc>
21303 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
21305 <parameter name="cancellable"
21306 transfer-ownership="none"
21308 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
21309 <type name="Cancellable" c:type="GCancellable*"/>
21314 <field name="replace_readwrite_async">
21315 <callback name="replace_readwrite_async">
21316 <return-value transfer-ownership="none">
21317 <type name="none" c:type="void"/>
21320 <parameter name="file" transfer-ownership="none">
21321 <type name="File" c:type="GFile*"/>
21323 <parameter name="etag" transfer-ownership="none" allow-none="1">
21324 <doc xml:whitespace="preserve">an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.</doc>
21325 <type name="utf8" c:type="char*"/>
21327 <parameter name="make_backup" transfer-ownership="none">
21328 <doc xml:whitespace="preserve">%TRUE if a backup should be created.</doc>
21329 <type name="gboolean" c:type="gboolean"/>
21331 <parameter name="flags" transfer-ownership="none">
21332 <doc xml:whitespace="preserve">a set of #GFileCreateFlags.</doc>
21333 <type name="FileCreateFlags" c:type="GFileCreateFlags"/>
21335 <parameter name="io_priority" transfer-ownership="none">
21336 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
21337 <type name="gint" c:type="int"/>
21339 <parameter name="cancellable"
21340 transfer-ownership="none"
21342 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21343 <type name="Cancellable" c:type="GCancellable*"/>
21345 <parameter name="callback"
21346 transfer-ownership="none"
21349 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
21350 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21352 <parameter name="user_data" transfer-ownership="none" closure="7">
21353 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21354 <type name="gpointer" c:type="gpointer"/>
21359 <field name="replace_readwrite_finish">
21360 <callback name="replace_readwrite_finish" throws="1">
21361 <return-value transfer-ownership="full">
21362 <doc xml:whitespace="preserve">a #GFileIOStream, or %NULL on error.</doc>
21363 <type name="FileIOStream" c:type="GFileIOStream*"/>
21366 <parameter name="file" transfer-ownership="none">
21367 <type name="File" c:type="GFile*"/>
21369 <parameter name="res" transfer-ownership="none">
21370 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21371 <type name="AsyncResult" c:type="GAsyncResult*"/>
21376 <field name="start_mountable">
21377 <callback name="start_mountable">
21378 <return-value transfer-ownership="none">
21379 <type name="none" c:type="void"/>
21382 <parameter name="file" transfer-ownership="none">
21383 <type name="File" c:type="GFile*"/>
21385 <parameter name="flags" transfer-ownership="none">
21386 <doc xml:whitespace="preserve">flags affecting the operation</doc>
21387 <type name="DriveStartFlags" c:type="GDriveStartFlags"/>
21389 <parameter name="start_operation" transfer-ownership="none">
21390 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
21391 <type name="MountOperation" c:type="GMountOperation*"/>
21393 <parameter name="cancellable"
21394 transfer-ownership="none"
21396 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21397 <type name="Cancellable" c:type="GCancellable*"/>
21399 <parameter name="callback"
21400 transfer-ownership="none"
21403 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
21404 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21406 <parameter name="user_data" transfer-ownership="none" closure="5">
21407 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21408 <type name="gpointer" c:type="gpointer"/>
21413 <field name="start_mountable_finish">
21414 <callback name="start_mountable_finish" throws="1">
21415 <return-value transfer-ownership="none">
21416 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
21417 <type name="gboolean" c:type="gboolean"/>
21420 <parameter name="file" transfer-ownership="none">
21421 <type name="File" c:type="GFile*"/>
21423 <parameter name="result" transfer-ownership="none">
21424 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21425 <type name="AsyncResult" c:type="GAsyncResult*"/>
21430 <field name="stop_mountable">
21431 <callback name="stop_mountable">
21432 <return-value transfer-ownership="none">
21433 <type name="none" c:type="void"/>
21436 <parameter name="file" transfer-ownership="none">
21437 <type name="File" c:type="GFile*"/>
21439 <parameter name="flags" transfer-ownership="none">
21440 <doc xml:whitespace="preserve">flags affecting the operation</doc>
21441 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
21443 <parameter name="mount_operation" transfer-ownership="none">
21444 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
21445 <type name="MountOperation" c:type="GMountOperation*"/>
21447 <parameter name="cancellable"
21448 transfer-ownership="none"
21450 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21451 <type name="Cancellable" c:type="GCancellable*"/>
21453 <parameter name="callback"
21454 transfer-ownership="none"
21457 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
21458 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21460 <parameter name="user_data" transfer-ownership="none" closure="5">
21461 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21462 <type name="gpointer" c:type="gpointer"/>
21467 <field name="stop_mountable_finish">
21468 <callback name="stop_mountable_finish" throws="1">
21469 <return-value transfer-ownership="none">
21470 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
21471 <type name="gboolean" c:type="gboolean"/>
21474 <parameter name="file" transfer-ownership="none">
21475 <type name="File" c:type="GFile*"/>
21477 <parameter name="result" transfer-ownership="none">
21478 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21479 <type name="AsyncResult" c:type="GAsyncResult*"/>
21484 <field name="supports_thread_contexts">
21485 <type name="gboolean" c:type="gboolean"/>
21487 <field name="unmount_mountable_with_operation">
21488 <callback name="unmount_mountable_with_operation">
21489 <return-value transfer-ownership="none">
21490 <type name="none" c:type="void"/>
21493 <parameter name="file" transfer-ownership="none">
21494 <type name="File" c:type="GFile*"/>
21496 <parameter name="flags" transfer-ownership="none">
21497 <doc xml:whitespace="preserve">flags affecting the operation</doc>
21498 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
21500 <parameter name="mount_operation" transfer-ownership="none">
21501 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
21502 <type name="MountOperation" c:type="GMountOperation*"/>
21504 <parameter name="cancellable"
21505 transfer-ownership="none"
21507 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21508 <type name="Cancellable" c:type="GCancellable*"/>
21510 <parameter name="callback"
21511 transfer-ownership="none"
21514 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
21515 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21517 <parameter name="user_data" transfer-ownership="none" closure="5">
21518 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21519 <type name="gpointer" c:type="gpointer"/>
21524 <field name="unmount_mountable_with_operation_finish">
21525 <callback name="unmount_mountable_with_operation_finish" throws="1">
21526 <return-value transfer-ownership="none">
21527 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
21528 <type name="gboolean" c:type="gboolean"/>
21531 <parameter name="file" transfer-ownership="none">
21532 <type name="File" c:type="GFile*"/>
21534 <parameter name="result" transfer-ownership="none">
21535 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21536 <type name="AsyncResult" c:type="GAsyncResult*"/>
21541 <field name="eject_mountable_with_operation">
21542 <callback name="eject_mountable_with_operation">
21543 <return-value transfer-ownership="none">
21544 <type name="none" c:type="void"/>
21547 <parameter name="file" transfer-ownership="none">
21548 <type name="File" c:type="GFile*"/>
21550 <parameter name="flags" transfer-ownership="none">
21551 <doc xml:whitespace="preserve">flags affecting the operation</doc>
21552 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
21554 <parameter name="mount_operation" transfer-ownership="none">
21555 <doc xml:whitespace="preserve">a #GMountOperation, or %NULL to avoid user interaction.</doc>
21556 <type name="MountOperation" c:type="GMountOperation*"/>
21558 <parameter name="cancellable"
21559 transfer-ownership="none"
21561 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21562 <type name="Cancellable" c:type="GCancellable*"/>
21564 <parameter name="callback"
21565 transfer-ownership="none"
21568 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
21569 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21571 <parameter name="user_data" transfer-ownership="none" closure="5">
21572 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21573 <type name="gpointer" c:type="gpointer"/>
21578 <field name="eject_mountable_with_operation_finish">
21579 <callback name="eject_mountable_with_operation_finish" throws="1">
21580 <return-value transfer-ownership="none">
21581 <doc xml:whitespace="preserve">%TRUE if the @file was ejected successfully. %FALSE</doc>
21582 <type name="gboolean" c:type="gboolean"/>
21585 <parameter name="file" transfer-ownership="none">
21586 <type name="File" c:type="GFile*"/>
21588 <parameter name="result" transfer-ownership="none">
21589 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21590 <type name="AsyncResult" c:type="GAsyncResult*"/>
21595 <field name="poll_mountable">
21596 <callback name="poll_mountable">
21597 <return-value transfer-ownership="none">
21598 <type name="none" c:type="void"/>
21601 <parameter name="file" transfer-ownership="none">
21602 <type name="File" c:type="GFile*"/>
21604 <parameter name="cancellable"
21605 transfer-ownership="none"
21607 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
21608 <type name="Cancellable" c:type="GCancellable*"/>
21610 <parameter name="callback"
21611 transfer-ownership="none"
21614 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.</doc>
21615 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
21617 <parameter name="user_data" transfer-ownership="none" closure="3">
21618 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
21619 <type name="gpointer" c:type="gpointer"/>
21624 <field name="poll_mountable_finish">
21625 <callback name="poll_mountable_finish" throws="1">
21626 <return-value transfer-ownership="none">
21627 <doc xml:whitespace="preserve">%TRUE if the operation finished successfully. %FALSE</doc>
21628 <type name="gboolean" c:type="gboolean"/>
21631 <parameter name="file" transfer-ownership="none">
21632 <type name="File" c:type="GFile*"/>
21634 <parameter name="result" transfer-ownership="none">
21635 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
21636 <type name="AsyncResult" c:type="GAsyncResult*"/>
21642 <class name="FileInfo"
21643 c:symbol-prefix="file_info"
21645 parent="GObject.Object"
21646 glib:type-name="GFileInfo"
21647 glib:get-type="g_file_info_get_type"
21648 glib:type-struct="FileInfoClass">
21649 <doc xml:whitespace="preserve">Stores information about a file system object referenced by a #GFile.</doc>
21650 <constructor name="new" c:identifier="g_file_info_new">
21651 <doc xml:whitespace="preserve">Creates a new file info structure.</doc>
21652 <return-value transfer-ownership="full">
21653 <doc xml:whitespace="preserve">a #GFileInfo.</doc>
21654 <type name="FileInfo" c:type="GFileInfo*"/>
21657 <method name="clear_status" c:identifier="g_file_info_clear_status">
21658 <doc xml:whitespace="preserve">Clears the status information from @info.</doc>
21659 <return-value transfer-ownership="none">
21660 <type name="none" c:type="void"/>
21663 <method name="copy_into" c:identifier="g_file_info_copy_into">
21664 <doc xml:whitespace="preserve">Copies all of the #GFileAttribute<!-- -->s from @src_info to @dest_info.</doc>
21665 <return-value transfer-ownership="none">
21666 <type name="none" c:type="void"/>
21669 <parameter name="dest_info" transfer-ownership="none">
21670 <doc xml:whitespace="preserve">destination to copy attributes to.</doc>
21671 <type name="FileInfo" c:type="GFileInfo*"/>
21675 <method name="dup" c:identifier="g_file_info_dup">
21676 <doc xml:whitespace="preserve">Duplicates a file info structure.</doc>
21677 <return-value transfer-ownership="full">
21678 <doc xml:whitespace="preserve">a duplicate #GFileInfo of @other.</doc>
21679 <type name="FileInfo" c:type="GFileInfo*"/>
21682 <method name="get_attribute_as_string"
21683 c:identifier="g_file_info_get_attribute_as_string">
21684 <doc xml:whitespace="preserve">Gets the value of a attribute, formated as a string.
21685 This escapes things as needed to make the string valid
21687 When you're done with the string it must be freed with g_free().</doc>
21688 <return-value transfer-ownership="full">
21689 <doc xml:whitespace="preserve">a UTF-8 string associated with the given @attribute.</doc>
21690 <type name="utf8" c:type="char*"/>
21693 <parameter name="attribute" transfer-ownership="none">
21694 <doc xml:whitespace="preserve">a file attribute key.</doc>
21695 <type name="utf8" c:type="char*"/>
21699 <method name="get_attribute_boolean"
21700 c:identifier="g_file_info_get_attribute_boolean">
21701 <doc xml:whitespace="preserve">Gets the value of a boolean attribute. If the attribute does not
21702 contain a boolean value, %FALSE will be returned.</doc>
21703 <return-value transfer-ownership="none">
21704 <doc xml:whitespace="preserve">the boolean value contained within the attribute.</doc>
21705 <type name="gboolean" c:type="gboolean"/>
21708 <parameter name="attribute" transfer-ownership="none">
21709 <doc xml:whitespace="preserve">a file attribute key.</doc>
21710 <type name="utf8" c:type="char*"/>
21714 <method name="get_attribute_byte_string"
21715 c:identifier="g_file_info_get_attribute_byte_string">
21716 <doc xml:whitespace="preserve">Gets the value of a byte string attribute. If the attribute does
21717 not contain a byte string, %NULL will be returned.
21718 %NULL otherwise.</doc>
21719 <return-value transfer-ownership="none">
21720 <doc xml:whitespace="preserve">the contents of the @attribute value as a byte string, or</doc>
21721 <type name="utf8" c:type="char*"/>
21724 <parameter name="attribute" transfer-ownership="none">
21725 <doc xml:whitespace="preserve">a file attribute key.</doc>
21726 <type name="utf8" c:type="char*"/>
21730 <method name="get_attribute_data"
21731 c:identifier="g_file_info_get_attribute_data">
21732 <doc xml:whitespace="preserve">Gets the attribute type, value and status for an attribute key.
21733 %FALSE otherwise.</doc>
21734 <return-value transfer-ownership="none">
21735 <doc xml:whitespace="preserve">%TRUE if @info has an attribute named @attribute,</doc>
21736 <type name="gboolean" c:type="gboolean"/>
21739 <parameter name="attribute" transfer-ownership="none">
21740 <doc xml:whitespace="preserve">a file attribute key</doc>
21741 <type name="utf8" c:type="char*"/>
21743 <parameter name="type"
21745 caller-allocates="1"
21746 transfer-ownership="none"
21748 <doc xml:whitespace="preserve">return location for the attribute type, or %NULL</doc>
21749 <type name="FileAttributeType" c:type="GFileAttributeType*"/>
21751 <parameter name="value_pp"
21753 caller-allocates="0"
21754 transfer-ownership="full"
21756 <doc xml:whitespace="preserve">return location for the attribute value, or %NULL</doc>
21757 <type name="gpointer" c:type="gpointer*"/>
21759 <parameter name="status"
21761 caller-allocates="1"
21762 transfer-ownership="none"
21764 <doc xml:whitespace="preserve">return location for the attribute status, or %NULL</doc>
21765 <type name="FileAttributeStatus" c:type="GFileAttributeStatus*"/>
21769 <method name="get_attribute_int32"
21770 c:identifier="g_file_info_get_attribute_int32">
21771 <doc xml:whitespace="preserve">Gets a signed 32-bit integer contained within the attribute. If the
21772 attribute does not contain a signed 32-bit integer, or is invalid,
21773 0 will be returned.</doc>
21774 <return-value transfer-ownership="none">
21775 <doc xml:whitespace="preserve">a signed 32-bit integer from the attribute.</doc>
21776 <type name="gint32" c:type="gint32"/>
21779 <parameter name="attribute" transfer-ownership="none">
21780 <doc xml:whitespace="preserve">a file attribute key.</doc>
21781 <type name="utf8" c:type="char*"/>
21785 <method name="get_attribute_int64"
21786 c:identifier="g_file_info_get_attribute_int64">
21787 <doc xml:whitespace="preserve">Gets a signed 64-bit integer contained within the attribute. If the
21788 attribute does not contain an signed 64-bit integer, or is invalid,
21789 0 will be returned.</doc>
21790 <return-value transfer-ownership="none">
21791 <doc xml:whitespace="preserve">a signed 64-bit integer from the attribute.</doc>
21792 <type name="gint64" c:type="gint64"/>
21795 <parameter name="attribute" transfer-ownership="none">
21796 <doc xml:whitespace="preserve">a file attribute key.</doc>
21797 <type name="utf8" c:type="char*"/>
21801 <method name="get_attribute_object"
21802 c:identifier="g_file_info_get_attribute_object">
21803 <doc xml:whitespace="preserve">Gets the value of a #GObject attribute. If the attribute does
21804 not contain a #GObject, %NULL will be returned.
21805 %NULL otherwise.</doc>
21806 <return-value transfer-ownership="none">
21807 <doc xml:whitespace="preserve">a #GObject associated with the given @attribute, or</doc>
21808 <type name="GObject.Object" c:type="GObject*"/>
21811 <parameter name="attribute" transfer-ownership="none">
21812 <doc xml:whitespace="preserve">a file attribute key.</doc>
21813 <type name="utf8" c:type="char*"/>
21817 <method name="get_attribute_status"
21818 c:identifier="g_file_info_get_attribute_status">
21819 <return-value transfer-ownership="none">
21820 <type name="FileAttributeStatus" c:type="GFileAttributeStatus"/>
21823 <parameter name="attribute" transfer-ownership="none">
21824 <type name="utf8" c:type="char*"/>
21828 <method name="get_attribute_string"
21829 c:identifier="g_file_info_get_attribute_string">
21830 <doc xml:whitespace="preserve">Gets the value of a string attribute. If the attribute does
21831 not contain a string, %NULL will be returned.
21832 %NULL otherwise.</doc>
21833 <return-value transfer-ownership="none">
21834 <doc xml:whitespace="preserve">the contents of the @attribute value as a string, or</doc>
21835 <type name="utf8" c:type="char*"/>
21838 <parameter name="attribute" transfer-ownership="none">
21839 <doc xml:whitespace="preserve">a file attribute key.</doc>
21840 <type name="utf8" c:type="char*"/>
21844 <method name="get_attribute_stringv"
21845 c:identifier="g_file_info_get_attribute_stringv"
21847 <doc xml:whitespace="preserve">Gets the value of a stringv attribute. If the attribute does
21848 not contain a stringv, %NULL will be returned.
21849 %NULL otherwise. Do not free.</doc>
21850 <return-value transfer-ownership="none">
21851 <doc xml:whitespace="preserve">the contents of the @attribute value as a stringv, or</doc>
21852 <array c:type="char**">
21853 <type name="utf8"/>
21857 <parameter name="attribute" transfer-ownership="none">
21858 <doc xml:whitespace="preserve">a file attribute key.</doc>
21859 <type name="utf8" c:type="char*"/>
21863 <method name="get_attribute_type"
21864 c:identifier="g_file_info_get_attribute_type">
21865 <doc xml:whitespace="preserve">Gets the attribute type for an attribute key.
21866 %G_FILE_ATTRIBUTE_TYPE_INVALID if the key is not set.</doc>
21867 <return-value transfer-ownership="none">
21868 <doc xml:whitespace="preserve">a #GFileAttributeType for the given @attribute, or</doc>
21869 <type name="FileAttributeType" c:type="GFileAttributeType"/>
21872 <parameter name="attribute" transfer-ownership="none">
21873 <doc xml:whitespace="preserve">a file attribute key.</doc>
21874 <type name="utf8" c:type="char*"/>
21878 <method name="get_attribute_uint32"
21879 c:identifier="g_file_info_get_attribute_uint32">
21880 <doc xml:whitespace="preserve">Gets an unsigned 32-bit integer contained within the attribute. If the
21881 attribute does not contain an unsigned 32-bit integer, or is invalid,
21882 0 will be returned.</doc>
21883 <return-value transfer-ownership="none">
21884 <doc xml:whitespace="preserve">an unsigned 32-bit integer from the attribute.</doc>
21885 <type name="guint32" c:type="guint32"/>
21888 <parameter name="attribute" transfer-ownership="none">
21889 <doc xml:whitespace="preserve">a file attribute key.</doc>
21890 <type name="utf8" c:type="char*"/>
21894 <method name="get_attribute_uint64"
21895 c:identifier="g_file_info_get_attribute_uint64">
21896 <doc xml:whitespace="preserve">Gets a unsigned 64-bit integer contained within the attribute. If the
21897 attribute does not contain an unsigned 64-bit integer, or is invalid,
21898 0 will be returned.</doc>
21899 <return-value transfer-ownership="none">
21900 <doc xml:whitespace="preserve">a unsigned 64-bit integer from the attribute.</doc>
21901 <type name="guint64" c:type="guint64"/>
21904 <parameter name="attribute" transfer-ownership="none">
21905 <doc xml:whitespace="preserve">a file attribute key.</doc>
21906 <type name="utf8" c:type="char*"/>
21910 <method name="get_content_type"
21911 c:identifier="g_file_info_get_content_type">
21912 <doc xml:whitespace="preserve">Gets the file's content type.</doc>
21913 <return-value transfer-ownership="none">
21914 <doc xml:whitespace="preserve">a string containing the file's content type.</doc>
21915 <type name="utf8" c:type="char*"/>
21918 <method name="get_display_name"
21919 c:identifier="g_file_info_get_display_name">
21920 <doc xml:whitespace="preserve">Gets a display name for a file.</doc>
21921 <return-value transfer-ownership="none">
21922 <doc xml:whitespace="preserve">a string containing the display name.</doc>
21923 <type name="utf8" c:type="char*"/>
21926 <method name="get_edit_name" c:identifier="g_file_info_get_edit_name">
21927 <doc xml:whitespace="preserve">Gets the edit name for a file.</doc>
21928 <return-value transfer-ownership="none">
21929 <doc xml:whitespace="preserve">a string containing the edit name.</doc>
21930 <type name="utf8" c:type="char*"/>
21933 <method name="get_etag" c:identifier="g_file_info_get_etag">
21934 <doc xml:whitespace="preserve">Gets the <link linkend="gfile-etag">entity tag</link> for a given
21935 #GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE.</doc>
21936 <return-value transfer-ownership="none">
21937 <doc xml:whitespace="preserve">a string containing the value of the "etag:value" attribute.</doc>
21938 <type name="utf8" c:type="char*"/>
21941 <method name="get_file_type" c:identifier="g_file_info_get_file_type">
21942 <doc xml:whitespace="preserve">Gets a file's type (whether it is a regular file, symlink, etc).
21943 This is different from the file's content type, see g_file_info_get_content_type().</doc>
21944 <return-value transfer-ownership="none">
21945 <doc xml:whitespace="preserve">a #GFileType for the given file.</doc>
21946 <type name="FileType" c:type="GFileType"/>
21949 <method name="get_icon" c:identifier="g_file_info_get_icon">
21950 <doc xml:whitespace="preserve">Gets the icon for a file.</doc>
21951 <return-value transfer-ownership="none">
21952 <doc xml:whitespace="preserve">#GIcon for the given @info.</doc>
21953 <type name="Icon" c:type="GIcon*"/>
21956 <method name="get_is_backup" c:identifier="g_file_info_get_is_backup">
21957 <doc xml:whitespace="preserve">Checks if a file is a backup file.</doc>
21958 <return-value transfer-ownership="none">
21959 <doc xml:whitespace="preserve">%TRUE if file is a backup file, %FALSE otherwise.</doc>
21960 <type name="gboolean" c:type="gboolean"/>
21963 <method name="get_is_hidden" c:identifier="g_file_info_get_is_hidden">
21964 <doc xml:whitespace="preserve">Checks if a file is hidden.</doc>
21965 <return-value transfer-ownership="none">
21966 <doc xml:whitespace="preserve">%TRUE if the file is a hidden file, %FALSE otherwise.</doc>
21967 <type name="gboolean" c:type="gboolean"/>
21970 <method name="get_is_symlink" c:identifier="g_file_info_get_is_symlink">
21971 <doc xml:whitespace="preserve">Checks if a file is a symlink.</doc>
21972 <return-value transfer-ownership="none">
21973 <doc xml:whitespace="preserve">%TRUE if the given @info is a symlink.</doc>
21974 <type name="gboolean" c:type="gboolean"/>
21977 <method name="get_modification_time"
21978 c:identifier="g_file_info_get_modification_time">
21979 <doc xml:whitespace="preserve">Gets the modification time of the current @info and sets it
21981 <return-value transfer-ownership="none">
21982 <type name="none" c:type="void"/>
21985 <parameter name="result" transfer-ownership="none">
21986 <doc xml:whitespace="preserve">a #GTimeVal.</doc>
21987 <type name="GLib.TimeVal" c:type="GTimeVal*"/>
21991 <method name="get_name" c:identifier="g_file_info_get_name">
21992 <doc xml:whitespace="preserve">Gets the name for a file.</doc>
21993 <return-value transfer-ownership="none">
21994 <doc xml:whitespace="preserve">a string containing the file name.</doc>
21995 <type name="utf8" c:type="char*"/>
21998 <method name="get_size" c:identifier="g_file_info_get_size">
21999 <doc xml:whitespace="preserve">Gets the file's size.</doc>
22000 <return-value transfer-ownership="none">
22001 <doc xml:whitespace="preserve">a #goffset containing the file's size.</doc>
22002 <type name="gint64" c:type="goffset"/>
22005 <method name="get_sort_order" c:identifier="g_file_info_get_sort_order">
22006 <doc xml:whitespace="preserve">Gets the value of the sort_order attribute from the #GFileInfo.
22007 See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.</doc>
22008 <return-value transfer-ownership="none">
22009 <doc xml:whitespace="preserve">a #gint32 containing the value of the "standard::sort_order" attribute.</doc>
22010 <type name="gint32" c:type="gint32"/>
22013 <method name="get_symlink_target"
22014 c:identifier="g_file_info_get_symlink_target">
22015 <doc xml:whitespace="preserve">Gets the symlink target for a given #GFileInfo.</doc>
22016 <return-value transfer-ownership="none">
22017 <doc xml:whitespace="preserve">a string containing the symlink target.</doc>
22018 <type name="utf8" c:type="char*"/>
22021 <method name="has_attribute" c:identifier="g_file_info_has_attribute">
22022 <doc xml:whitespace="preserve">Checks if a file info structure has an attribute named @attribute.
22023 %FALSE otherwise.</doc>
22024 <return-value transfer-ownership="none">
22025 <doc xml:whitespace="preserve">%TRUE if @Ginfo has an attribute named @attribute,</doc>
22026 <type name="gboolean" c:type="gboolean"/>
22029 <parameter name="attribute" transfer-ownership="none">
22030 <doc xml:whitespace="preserve">a file attribute key.</doc>
22031 <type name="utf8" c:type="char*"/>
22035 <method name="has_namespace"
22036 c:identifier="g_file_info_has_namespace"
22038 <doc xml:whitespace="preserve">Checks if a file info structure has an attribute in the
22039 specified @name_space.
22040 %FALSE otherwise.</doc>
22041 <return-value transfer-ownership="none">
22042 <doc xml:whitespace="preserve">%TRUE if @Ginfo has an attribute in @name_space,</doc>
22043 <type name="gboolean" c:type="gboolean"/>
22046 <parameter name="name_space" transfer-ownership="none">
22047 <doc xml:whitespace="preserve">a file attribute namespace.</doc>
22048 <type name="utf8" c:type="char*"/>
22052 <method name="list_attributes"
22053 c:identifier="g_file_info_list_attributes">
22054 <doc xml:whitespace="preserve">Lists the file info structure's attributes.
22055 possible attribute types for the given @name_space, or
22056 %NULL on error.</doc>
22057 <return-value transfer-ownership="full">
22058 <doc xml:whitespace="preserve">a null-terminated array of strings of all of the</doc>
22059 <array c:type="char**">
22060 <type name="utf8"/>
22064 <parameter name="name_space" transfer-ownership="none">
22065 <doc xml:whitespace="preserve">a file attribute key's namespace.</doc>
22066 <type name="utf8" c:type="char*"/>
22070 <method name="remove_attribute"
22071 c:identifier="g_file_info_remove_attribute">
22072 <doc xml:whitespace="preserve">Removes all cases of @attribute from @info if it exists.</doc>
22073 <return-value transfer-ownership="none">
22074 <type name="none" c:type="void"/>
22077 <parameter name="attribute" transfer-ownership="none">
22078 <doc xml:whitespace="preserve">a file attribute key.</doc>
22079 <type name="utf8" c:type="char*"/>
22083 <method name="set_attribute" c:identifier="g_file_info_set_attribute">
22084 <doc xml:whitespace="preserve">Sets the @attribute to contain the given value, if possible.</doc>
22085 <return-value transfer-ownership="none">
22086 <type name="none" c:type="void"/>
22089 <parameter name="attribute" transfer-ownership="none">
22090 <doc xml:whitespace="preserve">a file attribute key.</doc>
22091 <type name="utf8" c:type="char*"/>
22093 <parameter name="type" transfer-ownership="none">
22094 <doc xml:whitespace="preserve">a #GFileAttributeType</doc>
22095 <type name="FileAttributeType" c:type="GFileAttributeType"/>
22097 <parameter name="value_p" transfer-ownership="none">
22098 <doc xml:whitespace="preserve">pointer to the value</doc>
22099 <type name="gpointer" c:type="gpointer"/>
22103 <method name="set_attribute_boolean"
22104 c:identifier="g_file_info_set_attribute_boolean">
22105 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22107 <return-value transfer-ownership="none">
22108 <type name="none" c:type="void"/>
22111 <parameter name="attribute" transfer-ownership="none">
22112 <doc xml:whitespace="preserve">a file attribute key.</doc>
22113 <type name="utf8" c:type="char*"/>
22115 <parameter name="attr_value" transfer-ownership="none">
22116 <doc xml:whitespace="preserve">a boolean value.</doc>
22117 <type name="gboolean" c:type="gboolean"/>
22121 <method name="set_attribute_byte_string"
22122 c:identifier="g_file_info_set_attribute_byte_string">
22123 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22125 <return-value transfer-ownership="none">
22126 <type name="none" c:type="void"/>
22129 <parameter name="attribute" transfer-ownership="none">
22130 <doc xml:whitespace="preserve">a file attribute key.</doc>
22131 <type name="utf8" c:type="char*"/>
22133 <parameter name="attr_value" transfer-ownership="none">
22134 <doc xml:whitespace="preserve">a byte string.</doc>
22135 <type name="utf8" c:type="char*"/>
22139 <method name="set_attribute_int32"
22140 c:identifier="g_file_info_set_attribute_int32">
22141 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22143 <return-value transfer-ownership="none">
22144 <type name="none" c:type="void"/>
22147 <parameter name="attribute" transfer-ownership="none">
22148 <doc xml:whitespace="preserve">a file attribute key.</doc>
22149 <type name="utf8" c:type="char*"/>
22151 <parameter name="attr_value" transfer-ownership="none">
22152 <doc xml:whitespace="preserve">a signed 32-bit integer</doc>
22153 <type name="gint32" c:type="gint32"/>
22157 <method name="set_attribute_int64"
22158 c:identifier="g_file_info_set_attribute_int64">
22159 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22161 <return-value transfer-ownership="none">
22162 <type name="none" c:type="void"/>
22165 <parameter name="attribute" transfer-ownership="none">
22166 <doc xml:whitespace="preserve">attribute name to set.</doc>
22167 <type name="utf8" c:type="char*"/>
22169 <parameter name="attr_value" transfer-ownership="none">
22170 <doc xml:whitespace="preserve">int64 value to set attribute to.</doc>
22171 <type name="gint64" c:type="gint64"/>
22175 <method name="set_attribute_mask"
22176 c:identifier="g_file_info_set_attribute_mask">
22177 <doc xml:whitespace="preserve">Sets @mask on @info to match specific attribute types.</doc>
22178 <return-value transfer-ownership="none">
22179 <type name="none" c:type="void"/>
22182 <parameter name="mask" transfer-ownership="none">
22183 <doc xml:whitespace="preserve">a #GFileAttributeMatcher.</doc>
22184 <type name="FileAttributeMatcher" c:type="GFileAttributeMatcher*"/>
22188 <method name="set_attribute_object"
22189 c:identifier="g_file_info_set_attribute_object">
22190 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22192 <return-value transfer-ownership="none">
22193 <type name="none" c:type="void"/>
22196 <parameter name="attribute" transfer-ownership="none">
22197 <doc xml:whitespace="preserve">a file attribute key.</doc>
22198 <type name="utf8" c:type="char*"/>
22200 <parameter name="attr_value" transfer-ownership="none">
22201 <doc xml:whitespace="preserve">a #GObject.</doc>
22202 <type name="GObject.Object" c:type="GObject*"/>
22206 <method name="set_attribute_status"
22207 c:identifier="g_file_info_set_attribute_status"
22209 <doc xml:whitespace="preserve">Sets the attribute status for an attribute key. This is only
22210 needed by external code that implement g_file_set_attributes_from_info()
22211 or similar functions.
22212 The attribute must exist in @info for this to work. Otherwise %FALSE
22213 is returned and @info is unchanged.</doc>
22214 <return-value transfer-ownership="none">
22215 <doc xml:whitespace="preserve">%TRUE if the status was changed, %FALSE if the key was not set.</doc>
22216 <type name="gboolean" c:type="gboolean"/>
22219 <parameter name="attribute" transfer-ownership="none">
22220 <doc xml:whitespace="preserve">a file attribute key</doc>
22221 <type name="utf8" c:type="char*"/>
22223 <parameter name="status" transfer-ownership="none">
22224 <doc xml:whitespace="preserve">a #GFileAttributeStatus</doc>
22225 <type name="FileAttributeStatus" c:type="GFileAttributeStatus"/>
22229 <method name="set_attribute_string"
22230 c:identifier="g_file_info_set_attribute_string">
22231 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22233 <return-value transfer-ownership="none">
22234 <type name="none" c:type="void"/>
22237 <parameter name="attribute" transfer-ownership="none">
22238 <doc xml:whitespace="preserve">a file attribute key.</doc>
22239 <type name="utf8" c:type="char*"/>
22241 <parameter name="attr_value" transfer-ownership="none">
22242 <doc xml:whitespace="preserve">a string.</doc>
22243 <type name="utf8" c:type="char*"/>
22247 <method name="set_attribute_stringv"
22248 c:identifier="g_file_info_set_attribute_stringv">
22249 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22251 <return-value transfer-ownership="none">
22252 <type name="none" c:type="void"/>
22255 <parameter name="attribute" transfer-ownership="none">
22256 <doc xml:whitespace="preserve">a file attribute key.</doc>
22257 <type name="utf8" c:type="char*"/>
22259 <parameter name="attr_value" transfer-ownership="none">
22260 <doc xml:whitespace="preserve">a %NULL terminated string array</doc>
22261 <type name="utf8" c:type="char**"/>
22265 <method name="set_attribute_uint32"
22266 c:identifier="g_file_info_set_attribute_uint32">
22267 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22269 <return-value transfer-ownership="none">
22270 <type name="none" c:type="void"/>
22273 <parameter name="attribute" transfer-ownership="none">
22274 <doc xml:whitespace="preserve">a file attribute key.</doc>
22275 <type name="utf8" c:type="char*"/>
22277 <parameter name="attr_value" transfer-ownership="none">
22278 <doc xml:whitespace="preserve">an unsigned 32-bit integer.</doc>
22279 <type name="guint32" c:type="guint32"/>
22283 <method name="set_attribute_uint64"
22284 c:identifier="g_file_info_set_attribute_uint64">
22285 <doc xml:whitespace="preserve">Sets the @attribute to contain the given @attr_value,
22287 <return-value transfer-ownership="none">
22288 <type name="none" c:type="void"/>
22291 <parameter name="attribute" transfer-ownership="none">
22292 <doc xml:whitespace="preserve">a file attribute key.</doc>
22293 <type name="utf8" c:type="char*"/>
22295 <parameter name="attr_value" transfer-ownership="none">
22296 <doc xml:whitespace="preserve">an unsigned 64-bit integer.</doc>
22297 <type name="guint64" c:type="guint64"/>
22301 <method name="set_content_type"
22302 c:identifier="g_file_info_set_content_type">
22303 <doc xml:whitespace="preserve">Sets the content type attribute for a given #GFileInfo.
22304 See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE.</doc>
22305 <return-value transfer-ownership="none">
22306 <type name="none" c:type="void"/>
22309 <parameter name="content_type" transfer-ownership="none">
22310 <doc xml:whitespace="preserve">a content type. See #GContentType.</doc>
22311 <type name="utf8" c:type="char*"/>
22315 <method name="set_display_name"
22316 c:identifier="g_file_info_set_display_name">
22317 <doc xml:whitespace="preserve">Sets the display name for the current #GFileInfo.
22318 See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME.</doc>
22319 <return-value transfer-ownership="none">
22320 <type name="none" c:type="void"/>
22323 <parameter name="display_name" transfer-ownership="none">
22324 <doc xml:whitespace="preserve">a string containing a display name.</doc>
22325 <type name="utf8" c:type="char*"/>
22329 <method name="set_edit_name" c:identifier="g_file_info_set_edit_name">
22330 <doc xml:whitespace="preserve">Sets the edit name for the current file.
22331 See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME.</doc>
22332 <return-value transfer-ownership="none">
22333 <type name="none" c:type="void"/>
22336 <parameter name="edit_name" transfer-ownership="none">
22337 <doc xml:whitespace="preserve">a string containing an edit name.</doc>
22338 <type name="utf8" c:type="char*"/>
22342 <method name="set_file_type" c:identifier="g_file_info_set_file_type">
22343 <doc xml:whitespace="preserve">Sets the file type in a #GFileInfo to @type.
22344 See %G_FILE_ATTRIBUTE_STANDARD_TYPE.</doc>
22345 <return-value transfer-ownership="none">
22346 <type name="none" c:type="void"/>
22349 <parameter name="type" transfer-ownership="none">
22350 <doc xml:whitespace="preserve">a #GFileType.</doc>
22351 <type name="FileType" c:type="GFileType"/>
22355 <method name="set_icon" c:identifier="g_file_info_set_icon">
22356 <doc xml:whitespace="preserve">Sets the icon for a given #GFileInfo.
22357 See %G_FILE_ATTRIBUTE_STANDARD_ICON.</doc>
22358 <return-value transfer-ownership="none">
22359 <type name="none" c:type="void"/>
22362 <parameter name="icon" transfer-ownership="none">
22363 <doc xml:whitespace="preserve">a #GIcon.</doc>
22364 <type name="Icon" c:type="GIcon*"/>
22368 <method name="set_is_hidden" c:identifier="g_file_info_set_is_hidden">
22369 <doc xml:whitespace="preserve">Sets the "is_hidden" attribute in a #GFileInfo according to @is_symlink.
22370 See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN.</doc>
22371 <return-value transfer-ownership="none">
22372 <type name="none" c:type="void"/>
22375 <parameter name="is_hidden" transfer-ownership="none">
22376 <doc xml:whitespace="preserve">a #gboolean.</doc>
22377 <type name="gboolean" c:type="gboolean"/>
22381 <method name="set_is_symlink" c:identifier="g_file_info_set_is_symlink">
22382 <doc xml:whitespace="preserve">Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink.
22383 See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK.</doc>
22384 <return-value transfer-ownership="none">
22385 <type name="none" c:type="void"/>
22388 <parameter name="is_symlink" transfer-ownership="none">
22389 <doc xml:whitespace="preserve">a #gboolean.</doc>
22390 <type name="gboolean" c:type="gboolean"/>
22394 <method name="set_modification_time"
22395 c:identifier="g_file_info_set_modification_time">
22396 <return-value transfer-ownership="none">
22397 <type name="none" c:type="void"/>
22400 <parameter name="mtime" transfer-ownership="none">
22401 <type name="GLib.TimeVal" c:type="GTimeVal*"/>
22405 <method name="set_name" c:identifier="g_file_info_set_name">
22406 <doc xml:whitespace="preserve">Sets the name attribute for the current #GFileInfo.
22407 See %G_FILE_ATTRIBUTE_STANDARD_NAME.</doc>
22408 <return-value transfer-ownership="none">
22409 <type name="none" c:type="void"/>
22412 <parameter name="name" transfer-ownership="none">
22413 <doc xml:whitespace="preserve">a string containing a name.</doc>
22414 <type name="utf8" c:type="char*"/>
22418 <method name="set_size" c:identifier="g_file_info_set_size">
22419 <doc xml:whitespace="preserve">Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info
22420 to the given size.</doc>
22421 <return-value transfer-ownership="none">
22422 <type name="none" c:type="void"/>
22425 <parameter name="size" transfer-ownership="none">
22426 <doc xml:whitespace="preserve">a #goffset containing the file's size.</doc>
22427 <type name="gint64" c:type="goffset"/>
22431 <method name="set_sort_order" c:identifier="g_file_info_set_sort_order">
22432 <doc xml:whitespace="preserve">Sets the sort order attribute in the file info structure. See
22433 %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.</doc>
22434 <return-value transfer-ownership="none">
22435 <type name="none" c:type="void"/>
22438 <parameter name="sort_order" transfer-ownership="none">
22439 <doc xml:whitespace="preserve">a sort order integer.</doc>
22440 <type name="gint32" c:type="gint32"/>
22444 <method name="set_symlink_target"
22445 c:identifier="g_file_info_set_symlink_target">
22446 <doc xml:whitespace="preserve">Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info
22447 to the given symlink target.</doc>
22448 <return-value transfer-ownership="none">
22449 <type name="none" c:type="void"/>
22452 <parameter name="symlink_target" transfer-ownership="none">
22453 <doc xml:whitespace="preserve">a static string containing a path to a symlink target.</doc>
22454 <type name="utf8" c:type="char*"/>
22458 <method name="unset_attribute_mask"
22459 c:identifier="g_file_info_unset_attribute_mask">
22460 <doc xml:whitespace="preserve">Unsets a mask set by g_file_info_set_attribute_mask(), if one
22462 <return-value transfer-ownership="none">
22463 <type name="none" c:type="void"/>
22467 <record name="FileInfoClass"
22468 c:type="GFileInfoClass"
22470 glib:is-gtype-struct-for="FileInfo">
22472 <class name="FileInputStream"
22473 c:symbol-prefix="file_input_stream"
22474 c:type="GFileInputStream"
22475 parent="InputStream"
22476 glib:type-name="GFileInputStream"
22477 glib:get-type="g_file_input_stream_get_type"
22478 glib:type-struct="FileInputStreamClass">
22479 <doc xml:whitespace="preserve">A subclass of GInputStream for opened files. This adds
22480 a few file-specific operations and seeking.
22481 #GFileInputStream implements #GSeekable.</doc>
22482 <implements name="Seekable"/>
22483 <virtual-method name="can_seek">
22484 <return-value transfer-ownership="none">
22485 <type name="gboolean" c:type="gboolean"/>
22488 <virtual-method name="query_info" invoker="query_info" throws="1">
22489 <doc xml:whitespace="preserve">Queries a file input stream the given @attributes. This function blocks
22490 while querying the stream. For the asynchronous (non-blocking) version
22491 of this function, see g_file_input_stream_query_info_async(). While the
22492 stream is blocked, the stream will set the pending flag internally, and
22493 any other operations on the stream will fail with %G_IO_ERROR_PENDING.</doc>
22494 <return-value transfer-ownership="full">
22495 <doc xml:whitespace="preserve">a #GFileInfo, or %NULL on error.</doc>
22496 <type name="FileInfo" c:type="GFileInfo*"/>
22499 <parameter name="attributes" transfer-ownership="none">
22500 <doc xml:whitespace="preserve">a file attribute query string.</doc>
22501 <type name="utf8" c:type="char*"/>
22503 <parameter name="cancellable"
22504 transfer-ownership="none"
22506 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
22507 <type name="Cancellable" c:type="GCancellable*"/>
22511 <virtual-method name="query_info_async" invoker="query_info_async">
22512 <doc xml:whitespace="preserve">Queries the stream information asynchronously.
22513 When the operation is finished @callback will be called.
22514 You can then call g_file_input_stream_query_info_finish()
22515 to get the result of the operation.
22516 For the synchronous version of this function,
22517 see g_file_input_stream_query_info().
22518 If @cancellable is not %NULL, then the operation can be cancelled by
22519 triggering the cancellable object from another thread. If the operation
22520 was cancelled, the error %G_IO_ERROR_CANCELLED will be set</doc>
22521 <return-value transfer-ownership="none">
22522 <type name="none" c:type="void"/>
22525 <parameter name="attributes" transfer-ownership="none">
22526 <doc xml:whitespace="preserve">a file attribute query string.</doc>
22527 <type name="utf8" c:type="char*"/>
22529 <parameter name="io_priority" transfer-ownership="none">
22530 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
22531 <type name="gint" c:type="int"/>
22533 <parameter name="cancellable"
22534 transfer-ownership="none"
22536 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
22537 <type name="Cancellable" c:type="GCancellable*"/>
22539 <parameter name="callback"
22540 transfer-ownership="none"
22543 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
22544 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
22546 <parameter name="user_data" transfer-ownership="none" closure="4">
22547 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
22548 <type name="gpointer" c:type="gpointer"/>
22552 <virtual-method name="query_info_finish"
22553 invoker="query_info_finish"
22555 <doc xml:whitespace="preserve">Finishes an asynchronous info query operation.</doc>
22556 <return-value transfer-ownership="full">
22557 <doc xml:whitespace="preserve">#GFileInfo.</doc>
22558 <type name="FileInfo" c:type="GFileInfo*"/>
22561 <parameter name="res" transfer-ownership="none">
22562 <type name="AsyncResult" c:type="GAsyncResult*"/>
22566 <virtual-method name="seek" throws="1">
22567 <return-value transfer-ownership="none">
22568 <type name="gboolean" c:type="gboolean"/>
22571 <parameter name="offset" transfer-ownership="none">
22572 <type name="gint64" c:type="goffset"/>
22574 <parameter name="type" transfer-ownership="none">
22575 <type name="GLib.SeekType" c:type="GSeekType"/>
22577 <parameter name="cancellable" transfer-ownership="none">
22578 <type name="Cancellable" c:type="GCancellable*"/>
22582 <virtual-method name="tell">
22583 <return-value transfer-ownership="none">
22584 <type name="gint64" c:type="goffset"/>
22587 <method name="query_info"
22588 c:identifier="g_file_input_stream_query_info"
22590 <doc xml:whitespace="preserve">Queries a file input stream the given @attributes. This function blocks
22591 while querying the stream. For the asynchronous (non-blocking) version
22592 of this function, see g_file_input_stream_query_info_async(). While the
22593 stream is blocked, the stream will set the pending flag internally, and
22594 any other operations on the stream will fail with %G_IO_ERROR_PENDING.</doc>
22595 <return-value transfer-ownership="full">
22596 <doc xml:whitespace="preserve">a #GFileInfo, or %NULL on error.</doc>
22597 <type name="FileInfo" c:type="GFileInfo*"/>
22600 <parameter name="attributes" transfer-ownership="none">
22601 <doc xml:whitespace="preserve">a file attribute query string.</doc>
22602 <type name="utf8" c:type="char*"/>
22604 <parameter name="cancellable"
22605 transfer-ownership="none"
22607 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
22608 <type name="Cancellable" c:type="GCancellable*"/>
22612 <method name="query_info_async"
22613 c:identifier="g_file_input_stream_query_info_async">
22614 <doc xml:whitespace="preserve">Queries the stream information asynchronously.
22615 When the operation is finished @callback will be called.
22616 You can then call g_file_input_stream_query_info_finish()
22617 to get the result of the operation.
22618 For the synchronous version of this function,
22619 see g_file_input_stream_query_info().
22620 If @cancellable is not %NULL, then the operation can be cancelled by
22621 triggering the cancellable object from another thread. If the operation
22622 was cancelled, the error %G_IO_ERROR_CANCELLED will be set</doc>
22623 <return-value transfer-ownership="none">
22624 <type name="none" c:type="void"/>
22627 <parameter name="attributes" transfer-ownership="none">
22628 <doc xml:whitespace="preserve">a file attribute query string.</doc>
22629 <type name="utf8" c:type="char*"/>
22631 <parameter name="io_priority" transfer-ownership="none">
22632 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
22633 <type name="gint" c:type="int"/>
22635 <parameter name="cancellable"
22636 transfer-ownership="none"
22638 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
22639 <type name="Cancellable" c:type="GCancellable*"/>
22641 <parameter name="callback"
22642 transfer-ownership="none"
22645 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
22646 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
22648 <parameter name="user_data" transfer-ownership="none">
22649 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
22650 <type name="gpointer" c:type="gpointer"/>
22654 <method name="query_info_finish"
22655 c:identifier="g_file_input_stream_query_info_finish"
22657 <doc xml:whitespace="preserve">Finishes an asynchronous info query operation.</doc>
22658 <return-value transfer-ownership="full">
22659 <doc xml:whitespace="preserve">#GFileInfo.</doc>
22660 <type name="FileInfo" c:type="GFileInfo*"/>
22663 <parameter name="result" transfer-ownership="none">
22664 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
22665 <type name="AsyncResult" c:type="GAsyncResult*"/>
22669 <field name="parent_instance">
22670 <type name="InputStream" c:type="GInputStream"/>
22672 <field name="priv">
22673 <type name="FileInputStreamPrivate" c:type="GFileInputStreamPrivate*"/>
22676 <record name="FileInputStreamClass"
22677 c:type="GFileInputStreamClass"
22678 glib:is-gtype-struct-for="FileInputStream">
22679 <field name="parent_class">
22680 <type name="InputStreamClass" c:type="GInputStreamClass"/>
22682 <field name="tell">
22683 <callback name="tell">
22684 <return-value transfer-ownership="none">
22685 <type name="gint64" c:type="goffset"/>
22688 <parameter name="stream" transfer-ownership="none">
22689 <type name="FileInputStream" c:type="GFileInputStream*"/>
22694 <field name="can_seek">
22695 <callback name="can_seek">
22696 <return-value transfer-ownership="none">
22697 <type name="gboolean" c:type="gboolean"/>
22700 <parameter name="stream" transfer-ownership="none">
22701 <type name="FileInputStream" c:type="GFileInputStream*"/>
22706 <field name="seek">
22707 <callback name="seek" throws="1">
22708 <return-value transfer-ownership="none">
22709 <type name="gboolean" c:type="gboolean"/>
22712 <parameter name="stream" transfer-ownership="none">
22713 <type name="FileInputStream" c:type="GFileInputStream*"/>
22715 <parameter name="offset" transfer-ownership="none">
22716 <type name="gint64" c:type="goffset"/>
22718 <parameter name="type" transfer-ownership="none">
22719 <type name="GLib.SeekType" c:type="GSeekType"/>
22721 <parameter name="cancellable" transfer-ownership="none">
22722 <type name="Cancellable" c:type="GCancellable*"/>
22727 <field name="query_info">
22728 <callback name="query_info" throws="1">
22729 <return-value transfer-ownership="full">
22730 <doc xml:whitespace="preserve">a #GFileInfo, or %NULL on error.</doc>
22731 <type name="FileInfo" c:type="GFileInfo*"/>
22734 <parameter name="stream" transfer-ownership="none">
22735 <type name="FileInputStream" c:type="GFileInputStream*"/>
22737 <parameter name="attributes" transfer-ownership="none">
22738 <doc xml:whitespace="preserve">a file attribute query string.</doc>
22739 <type name="utf8" c:type="char*"/>
22741 <parameter name="cancellable"
22742 transfer-ownership="none"
22744 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
22745 <type name="Cancellable" c:type="GCancellable*"/>
22750 <field name="query_info_async">
22751 <callback name="query_info_async">
22752 <return-value transfer-ownership="none">
22753 <type name="none" c:type="void"/>
22756 <parameter name="stream" transfer-ownership="none">
22757 <type name="FileInputStream" c:type="GFileInputStream*"/>
22759 <parameter name="attributes" transfer-ownership="none">
22760 <doc xml:whitespace="preserve">a file attribute query string.</doc>
22761 <type name="utf8" c:type="char*"/>
22763 <parameter name="io_priority" transfer-ownership="none">
22764 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
22765 <type name="gint" c:type="int"/>
22767 <parameter name="cancellable"
22768 transfer-ownership="none"
22770 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
22771 <type name="Cancellable" c:type="GCancellable*"/>
22773 <parameter name="callback"
22774 transfer-ownership="none"
22777 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
22778 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
22780 <parameter name="user_data" transfer-ownership="none" closure="5">
22781 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
22782 <type name="gpointer" c:type="gpointer"/>
22787 <field name="query_info_finish">
22788 <callback name="query_info_finish" throws="1">
22789 <return-value transfer-ownership="full">
22790 <doc xml:whitespace="preserve">#GFileInfo.</doc>
22791 <type name="FileInfo" c:type="GFileInfo*"/>
22794 <parameter name="stream" transfer-ownership="none">
22795 <type name="FileInputStream" c:type="GFileInputStream*"/>
22797 <parameter name="res" transfer-ownership="none">
22798 <type name="AsyncResult" c:type="GAsyncResult*"/>
22803 <field name="_g_reserved1" introspectable="0">
22804 <callback name="_g_reserved1">
22805 <return-value transfer-ownership="none">
22806 <type name="none" c:type="void"/>
22810 <field name="_g_reserved2" introspectable="0">
22811 <callback name="_g_reserved2">
22812 <return-value transfer-ownership="none">
22813 <type name="none" c:type="void"/>
22817 <field name="_g_reserved3" introspectable="0">
22818 <callback name="_g_reserved3">
22819 <return-value transfer-ownership="none">
22820 <type name="none" c:type="void"/>
22824 <field name="_g_reserved4" introspectable="0">
22825 <callback name="_g_reserved4">
22826 <return-value transfer-ownership="none">
22827 <type name="none" c:type="void"/>
22831 <field name="_g_reserved5" introspectable="0">
22832 <callback name="_g_reserved5">
22833 <return-value transfer-ownership="none">
22834 <type name="none" c:type="void"/>
22839 <record name="FileInputStreamPrivate"
22840 c:type="GFileInputStreamPrivate"
22843 <class name="FileMonitor"
22844 c:symbol-prefix="file_monitor"
22845 c:type="GFileMonitor"
22846 parent="GObject.Object"
22848 glib:type-name="GFileMonitor"
22849 glib:get-type="g_file_monitor_get_type"
22850 glib:type-struct="FileMonitorClass">
22851 <doc xml:whitespace="preserve">Watches for changes to a file.</doc>
22852 <virtual-method name="cancel" invoker="cancel">
22853 <doc xml:whitespace="preserve">Cancels a file monitor.</doc>
22854 <return-value transfer-ownership="none">
22855 <doc xml:whitespace="preserve">%TRUE if monitor was cancelled.</doc>
22856 <type name="gboolean" c:type="gboolean"/>
22859 <method name="cancel" c:identifier="g_file_monitor_cancel">
22860 <doc xml:whitespace="preserve">Cancels a file monitor.</doc>
22861 <return-value transfer-ownership="none">
22862 <doc xml:whitespace="preserve">%TRUE if monitor was cancelled.</doc>
22863 <type name="gboolean" c:type="gboolean"/>
22866 <method name="emit_event" c:identifier="g_file_monitor_emit_event">
22867 <doc xml:whitespace="preserve">Emits the #GFileMonitor::changed signal if a change
22868 has taken place. Should be called from file monitor
22869 implementations only.
22870 The signal will be emitted from an idle handler (in the <link
22871 linkend="g-main-context-push-thread-default">thread-default main
22872 context</link>).</doc>
22873 <return-value transfer-ownership="none">
22874 <type name="none" c:type="void"/>
22877 <parameter name="child" transfer-ownership="none">
22878 <doc xml:whitespace="preserve">a #GFile.</doc>
22879 <type name="File" c:type="GFile*"/>
22881 <parameter name="other_file" transfer-ownership="none">
22882 <doc xml:whitespace="preserve">a #GFile.</doc>
22883 <type name="File" c:type="GFile*"/>
22885 <parameter name="event_type" transfer-ownership="none">
22886 <doc xml:whitespace="preserve">a set of #GFileMonitorEvent flags.</doc>
22887 <type name="FileMonitorEvent" c:type="GFileMonitorEvent"/>
22891 <method name="is_cancelled" c:identifier="g_file_monitor_is_cancelled">
22892 <doc xml:whitespace="preserve">Returns whether the monitor is canceled.</doc>
22893 <return-value transfer-ownership="none">
22894 <doc xml:whitespace="preserve">%TRUE if monitor is canceled. %FALSE otherwise.</doc>
22895 <type name="gboolean" c:type="gboolean"/>
22898 <method name="set_rate_limit"
22899 c:identifier="g_file_monitor_set_rate_limit">
22900 <doc xml:whitespace="preserve">Sets the rate limit to which the @monitor will report
22901 consecutive change events to the same file.</doc>
22902 <return-value transfer-ownership="none">
22903 <type name="none" c:type="void"/>
22906 <parameter name="limit_msecs" transfer-ownership="none">
22907 <doc xml:whitespace="preserve">a integer with the limit in milliseconds to poll for changes.</doc>
22908 <type name="gint" c:type="int"/>
22912 <property name="cancelled" transfer-ownership="none">
22913 <type name="gboolean"/>
22915 <property name="rate-limit" writable="1" transfer-ownership="none">
22916 <type name="gint"/>
22918 <field name="parent_instance">
22919 <type name="GObject.Object" c:type="GObject"/>
22921 <field name="priv">
22922 <type name="FileMonitorPrivate" c:type="GFileMonitorPrivate*"/>
22924 <glib:signal name="changed">
22925 <doc xml:whitespace="preserve">Emitted when a file has been changed.</doc>
22926 <return-value transfer-ownership="none">
22927 <type name="none"/>
22930 <parameter name="object" transfer-ownership="none">
22931 <doc xml:whitespace="preserve">a #GFile.</doc>
22932 <type name="File"/>
22934 <parameter name="p0" transfer-ownership="none">
22935 <doc xml:whitespace="preserve">a #GFile.</doc>
22936 <type name="File"/>
22938 <parameter name="p1" transfer-ownership="none">
22939 <doc xml:whitespace="preserve">a #GFileMonitorEvent.</doc>
22940 <type name="FileMonitorEvent"/>
22945 <record name="FileMonitorClass"
22946 c:type="GFileMonitorClass"
22947 glib:is-gtype-struct-for="FileMonitor">
22948 <field name="parent_class">
22949 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
22951 <field name="changed">
22952 <callback name="changed">
22953 <return-value transfer-ownership="none">
22954 <type name="none" c:type="void"/>
22957 <parameter name="monitor" transfer-ownership="none">
22958 <type name="FileMonitor" c:type="GFileMonitor*"/>
22960 <parameter name="file" transfer-ownership="none">
22961 <type name="File" c:type="GFile*"/>
22963 <parameter name="other_file" transfer-ownership="none">
22964 <type name="File" c:type="GFile*"/>
22966 <parameter name="event_type" transfer-ownership="none">
22967 <type name="FileMonitorEvent" c:type="GFileMonitorEvent"/>
22972 <field name="cancel">
22973 <callback name="cancel">
22974 <return-value transfer-ownership="none">
22975 <doc xml:whitespace="preserve">%TRUE if monitor was cancelled.</doc>
22976 <type name="gboolean" c:type="gboolean"/>
22979 <parameter name="monitor" transfer-ownership="none">
22980 <type name="FileMonitor" c:type="GFileMonitor*"/>
22985 <field name="_g_reserved1" introspectable="0">
22986 <callback name="_g_reserved1">
22987 <return-value transfer-ownership="none">
22988 <type name="none" c:type="void"/>
22992 <field name="_g_reserved2" introspectable="0">
22993 <callback name="_g_reserved2">
22994 <return-value transfer-ownership="none">
22995 <type name="none" c:type="void"/>
22999 <field name="_g_reserved3" introspectable="0">
23000 <callback name="_g_reserved3">
23001 <return-value transfer-ownership="none">
23002 <type name="none" c:type="void"/>
23006 <field name="_g_reserved4" introspectable="0">
23007 <callback name="_g_reserved4">
23008 <return-value transfer-ownership="none">
23009 <type name="none" c:type="void"/>
23013 <field name="_g_reserved5" introspectable="0">
23014 <callback name="_g_reserved5">
23015 <return-value transfer-ownership="none">
23016 <type name="none" c:type="void"/>
23021 <enumeration name="FileMonitorEvent"
23022 glib:type-name="GFileMonitorEvent"
23023 glib:get-type="g_file_monitor_event_get_type"
23024 c:type="GFileMonitorEvent">
23025 <doc xml:whitespace="preserve">Specifies what type of event a monitor event is.</doc>
23026 <member name="changed"
23028 c:identifier="G_FILE_MONITOR_EVENT_CHANGED"
23029 glib:nick="changed"/>
23030 <member name="changes_done_hint"
23032 c:identifier="G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT"
23033 glib:nick="changes-done-hint"/>
23034 <member name="deleted"
23036 c:identifier="G_FILE_MONITOR_EVENT_DELETED"
23037 glib:nick="deleted"/>
23038 <member name="created"
23040 c:identifier="G_FILE_MONITOR_EVENT_CREATED"
23041 glib:nick="created"/>
23042 <member name="attribute_changed"
23044 c:identifier="G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED"
23045 glib:nick="attribute-changed"/>
23046 <member name="pre_unmount"
23048 c:identifier="G_FILE_MONITOR_EVENT_PRE_UNMOUNT"
23049 glib:nick="pre-unmount"/>
23050 <member name="unmounted"
23052 c:identifier="G_FILE_MONITOR_EVENT_UNMOUNTED"
23053 glib:nick="unmounted"/>
23054 <member name="moved"
23056 c:identifier="G_FILE_MONITOR_EVENT_MOVED"
23057 glib:nick="moved"/>
23059 <bitfield name="FileMonitorFlags"
23060 glib:type-name="GFileMonitorFlags"
23061 glib:get-type="g_file_monitor_flags_get_type"
23062 c:type="GFileMonitorFlags">
23063 <doc xml:whitespace="preserve">Flags used to set what a #GFileMonitor will watch for.</doc>
23064 <member name="none"
23066 c:identifier="G_FILE_MONITOR_NONE"
23068 <member name="watch_mounts"
23070 c:identifier="G_FILE_MONITOR_WATCH_MOUNTS"
23071 glib:nick="watch-mounts"/>
23072 <member name="send_moved"
23074 c:identifier="G_FILE_MONITOR_SEND_MOVED"
23075 glib:nick="send-moved"/>
23077 <record name="FileMonitorPrivate"
23078 c:type="GFileMonitorPrivate"
23081 <class name="FileOutputStream"
23082 c:symbol-prefix="file_output_stream"
23083 c:type="GFileOutputStream"
23084 parent="OutputStream"
23085 glib:type-name="GFileOutputStream"
23086 glib:get-type="g_file_output_stream_get_type"
23087 glib:type-struct="FileOutputStreamClass">
23088 <doc xml:whitespace="preserve">A subclass of GOutputStream for opened files. This adds
23089 a few file-specific operations and seeking and truncating.
23090 #GFileOutputStream implements GSeekable.</doc>
23091 <implements name="Seekable"/>
23092 <virtual-method name="can_seek">
23093 <return-value transfer-ownership="none">
23094 <type name="gboolean" c:type="gboolean"/>
23097 <virtual-method name="can_truncate">
23098 <return-value transfer-ownership="none">
23099 <type name="gboolean" c:type="gboolean"/>
23102 <virtual-method name="get_etag" invoker="get_etag">
23103 <doc xml:whitespace="preserve">Gets the entity tag for the file when it has been written.
23104 This must be called after the stream has been written
23105 and closed, as the etag can change while writing.</doc>
23106 <return-value transfer-ownership="full">
23107 <doc xml:whitespace="preserve">the entity tag for the stream.</doc>
23108 <type name="utf8" c:type="char*"/>
23111 <virtual-method name="query_info" invoker="query_info" throws="1">
23112 <doc xml:whitespace="preserve">Queries a file output stream for the given @attributes.
23113 This function blocks while querying the stream. For the asynchronous
23114 version of this function, see g_file_output_stream_query_info_async().
23115 While the stream is blocked, the stream will set the pending flag
23116 internally, and any other operations on the stream will fail with
23117 %G_IO_ERROR_PENDING.
23118 Can fail if the stream was already closed (with @error being set to
23119 %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being
23120 set to %G_IO_ERROR_PENDING), or if querying info is not supported for
23121 the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). In
23122 all cases of failure, %NULL will be returned.
23123 If @cancellable is not %NULL, then the operation can be cancelled by
23124 triggering the cancellable object from another thread. If the operation
23125 was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
23127 <return-value transfer-ownership="full">
23128 <doc xml:whitespace="preserve">a #GFileInfo for the @stream, or %NULL on error.</doc>
23129 <type name="FileInfo" c:type="GFileInfo*"/>
23132 <parameter name="attributes" transfer-ownership="none">
23133 <doc xml:whitespace="preserve">a file attribute query string.</doc>
23134 <type name="utf8" c:type="char*"/>
23136 <parameter name="cancellable"
23137 transfer-ownership="none"
23139 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
23140 <type name="Cancellable" c:type="GCancellable*"/>
23144 <virtual-method name="query_info_async" invoker="query_info_async">
23145 <doc xml:whitespace="preserve">Asynchronously queries the @stream for a #GFileInfo. When completed,
23146 finish the operation with g_file_output_stream_query_info_finish().
23147 For the synchronous version of this function, see
23148 g_file_output_stream_query_info().</doc>
23149 <return-value transfer-ownership="none">
23150 <type name="none" c:type="void"/>
23153 <parameter name="attributes" transfer-ownership="none">
23154 <doc xml:whitespace="preserve">a file attribute query string.</doc>
23155 <type name="utf8" c:type="char*"/>
23157 <parameter name="io_priority" transfer-ownership="none">
23158 <doc xml:whitespace="preserve">the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.</doc>
23159 <type name="gint" c:type="int"/>
23161 <parameter name="cancellable"
23162 transfer-ownership="none"
23164 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
23165 <type name="Cancellable" c:type="GCancellable*"/>
23167 <parameter name="callback"
23168 transfer-ownership="none"
23171 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
23172 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
23174 <parameter name="user_data" transfer-ownership="none" closure="4">
23175 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
23176 <type name="gpointer" c:type="gpointer"/>
23180 <virtual-method name="query_info_finish"
23181 invoker="query_info_finish"
23183 <doc xml:whitespace="preserve">Finalizes the asynchronous query started
23184 by g_file_output_stream_query_info_async().</doc>
23185 <return-value transfer-ownership="full">
23186 <doc xml:whitespace="preserve">A #GFileInfo for the finished query.</doc>
23187 <type name="FileInfo" c:type="GFileInfo*"/>
23190 <parameter name="res" transfer-ownership="none">
23191 <type name="AsyncResult" c:type="GAsyncResult*"/>
23195 <virtual-method name="seek" throws="1">
23196 <return-value transfer-ownership="none">
23197 <type name="gboolean" c:type="gboolean"/>
23200 <parameter name="offset" transfer-ownership="none">
23201 <type name="gint64" c:type="goffset"/>
23203 <parameter name="type" transfer-ownership="none">
23204 <type name="GLib.SeekType" c:type="GSeekType"/>
23206 <parameter name="cancellable" transfer-ownership="none">
23207 <type name="Cancellable" c:type="GCancellable*"/>
23211 <virtual-method name="tell">
23212 <return-value transfer-ownership="none">
23213 <type name="gint64" c:type="goffset"/>
23216 <virtual-method name="truncate_fn" throws="1">
23217 <return-value transfer-ownership="none">
23218 <type name="gboolean" c:type="gboolean"/>
23221 <parameter name="size" transfer-ownership="none">
23222 <type name="gint64" c:type="goffset"/>
23224 <parameter name="cancellable" transfer-ownership="none">
23225 <type name="Cancellable" c:type="GCancellable*"/>
23229 <method name="get_etag" c:identifier="g_file_output_stream_get_etag">
23230 <doc xml:whitespace="preserve">Gets the entity tag for the file when it has been written.
23231 This must be called after the stream has been written
23232 and closed, as the etag can change while writing.</doc>
23233 <return-value transfer-ownership="full">
23234 <doc xml:whitespace="preserve">the entity tag for the stream.</doc>
23235 <type name="utf8" c:type="char*"/>
23238 <method name="query_info"
23239 c:identifier="g_file_output_stream_query_info"
23241 <doc xml:whitespace="preserve">Queries a file output stream for the given @attributes.
23242 This function blocks while querying the stream. For the asynchronous
23243 version of this function, see g_file_output_stream_query_info_async().
23244 While the stream is blocked, the stream will set the pending flag
23245 internally, and any other operations on the stream will fail with
23246 %G_IO_ERROR_PENDING.
23247 Can fail if the stream was already closed (with @error being set to
23248 %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being
23249 set to %G_IO_ERROR_PENDING), or if querying info is not supported for
23250 the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). In
23251 all cases of failure, %NULL will be returned.
23252 If @cancellable is not %NULL, then the operation can be cancelled by
23253 triggering the cancellable object from another thread. If the operation
23254 was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
23256 <return-value transfer-ownership="full">
23257 <doc xml:whitespace="preserve">a #GFileInfo for the @stream, or %NULL on error.</doc>
23258 <type name="FileInfo" c:type="GFileInfo*"/>
23261 <parameter name="attributes" transfer-ownership="none">
23262 <doc xml:whitespace="preserve">a file attribute query string.</doc>
23263 <type name="utf8" c:type="char*"/>
23265 <parameter name="cancellable"
23266 transfer-ownership="none"
23268 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
23269 <type name="Cancellable" c:type="GCancellable*"/>
23273 <method name="query_info_async"
23274 c:identifier="g_file_output_stream_query_info_async">
23275 <doc xml:whitespace="preserve">Asynchronously queries the @stream for a #GFileInfo. When completed,
23276 finish the operation with g_file_output_stream_query_info_finish().
23277 For the synchronous version of this function, see
23278 g_file_output_stream_query_info().</doc>
23279 <return-value transfer-ownership="none">
23280 <type name="none" c:type="void"/>
23283 <parameter name="attributes" transfer-ownership="none">
23284 <doc xml:whitespace="preserve">a file attribute query string.</doc>
23285 <type name="utf8" c:type="char*"/>
23287 <parameter name="io_priority" transfer-ownership="none">
23288 <doc xml:whitespace="preserve">the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.</doc>
23289 <type name="gint" c:type="int"/>
23291 <parameter name="cancellable"
23292 transfer-ownership="none"
23294 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
23295 <type name="Cancellable" c:type="GCancellable*"/>
23297 <parameter name="callback"
23298 transfer-ownership="none"
23301 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
23302 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
23304 <parameter name="user_data" transfer-ownership="none">
23305 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
23306 <type name="gpointer" c:type="gpointer"/>
23310 <method name="query_info_finish"
23311 c:identifier="g_file_output_stream_query_info_finish"
23313 <doc xml:whitespace="preserve">Finalizes the asynchronous query started
23314 by g_file_output_stream_query_info_async().</doc>
23315 <return-value transfer-ownership="full">
23316 <doc xml:whitespace="preserve">A #GFileInfo for the finished query.</doc>
23317 <type name="FileInfo" c:type="GFileInfo*"/>
23320 <parameter name="result" transfer-ownership="none">
23321 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
23322 <type name="AsyncResult" c:type="GAsyncResult*"/>
23326 <field name="parent_instance">
23327 <type name="OutputStream" c:type="GOutputStream"/>
23329 <field name="priv">
23330 <type name="FileOutputStreamPrivate"
23331 c:type="GFileOutputStreamPrivate*"/>
23334 <record name="FileOutputStreamClass"
23335 c:type="GFileOutputStreamClass"
23336 glib:is-gtype-struct-for="FileOutputStream">
23337 <field name="parent_class">
23338 <type name="OutputStreamClass" c:type="GOutputStreamClass"/>
23340 <field name="tell">
23341 <callback name="tell">
23342 <return-value transfer-ownership="none">
23343 <type name="gint64" c:type="goffset"/>
23346 <parameter name="stream" transfer-ownership="none">
23347 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23352 <field name="can_seek">
23353 <callback name="can_seek">
23354 <return-value transfer-ownership="none">
23355 <type name="gboolean" c:type="gboolean"/>
23358 <parameter name="stream" transfer-ownership="none">
23359 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23364 <field name="seek">
23365 <callback name="seek" throws="1">
23366 <return-value transfer-ownership="none">
23367 <type name="gboolean" c:type="gboolean"/>
23370 <parameter name="stream" transfer-ownership="none">
23371 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23373 <parameter name="offset" transfer-ownership="none">
23374 <type name="gint64" c:type="goffset"/>
23376 <parameter name="type" transfer-ownership="none">
23377 <type name="GLib.SeekType" c:type="GSeekType"/>
23379 <parameter name="cancellable" transfer-ownership="none">
23380 <type name="Cancellable" c:type="GCancellable*"/>
23385 <field name="can_truncate">
23386 <callback name="can_truncate">
23387 <return-value transfer-ownership="none">
23388 <type name="gboolean" c:type="gboolean"/>
23391 <parameter name="stream" transfer-ownership="none">
23392 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23397 <field name="truncate_fn">
23398 <callback name="truncate_fn" throws="1">
23399 <return-value transfer-ownership="none">
23400 <type name="gboolean" c:type="gboolean"/>
23403 <parameter name="stream" transfer-ownership="none">
23404 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23406 <parameter name="size" transfer-ownership="none">
23407 <type name="gint64" c:type="goffset"/>
23409 <parameter name="cancellable" transfer-ownership="none">
23410 <type name="Cancellable" c:type="GCancellable*"/>
23415 <field name="query_info">
23416 <callback name="query_info" throws="1">
23417 <return-value transfer-ownership="full">
23418 <doc xml:whitespace="preserve">a #GFileInfo for the @stream, or %NULL on error.</doc>
23419 <type name="FileInfo" c:type="GFileInfo*"/>
23422 <parameter name="stream" transfer-ownership="none">
23423 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23425 <parameter name="attributes" transfer-ownership="none">
23426 <doc xml:whitespace="preserve">a file attribute query string.</doc>
23427 <type name="utf8" c:type="char*"/>
23429 <parameter name="cancellable"
23430 transfer-ownership="none"
23432 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
23433 <type name="Cancellable" c:type="GCancellable*"/>
23438 <field name="query_info_async">
23439 <callback name="query_info_async">
23440 <return-value transfer-ownership="none">
23441 <type name="none" c:type="void"/>
23444 <parameter name="stream" transfer-ownership="none">
23445 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23447 <parameter name="attributes" transfer-ownership="none">
23448 <doc xml:whitespace="preserve">a file attribute query string.</doc>
23449 <type name="utf8" c:type="char*"/>
23451 <parameter name="io_priority" transfer-ownership="none">
23452 <doc xml:whitespace="preserve">the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.</doc>
23453 <type name="gint" c:type="int"/>
23455 <parameter name="cancellable"
23456 transfer-ownership="none"
23458 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
23459 <type name="Cancellable" c:type="GCancellable*"/>
23461 <parameter name="callback"
23462 transfer-ownership="none"
23465 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
23466 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
23468 <parameter name="user_data" transfer-ownership="none" closure="5">
23469 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
23470 <type name="gpointer" c:type="gpointer"/>
23475 <field name="query_info_finish">
23476 <callback name="query_info_finish" throws="1">
23477 <return-value transfer-ownership="full">
23478 <doc xml:whitespace="preserve">A #GFileInfo for the finished query.</doc>
23479 <type name="FileInfo" c:type="GFileInfo*"/>
23482 <parameter name="stream" transfer-ownership="none">
23483 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23485 <parameter name="res" transfer-ownership="none">
23486 <type name="AsyncResult" c:type="GAsyncResult*"/>
23491 <field name="get_etag">
23492 <callback name="get_etag">
23493 <return-value transfer-ownership="full">
23494 <doc xml:whitespace="preserve">the entity tag for the stream.</doc>
23495 <type name="utf8" c:type="char*"/>
23498 <parameter name="stream" transfer-ownership="none">
23499 <type name="FileOutputStream" c:type="GFileOutputStream*"/>
23504 <field name="_g_reserved1" introspectable="0">
23505 <callback name="_g_reserved1">
23506 <return-value transfer-ownership="none">
23507 <type name="none" c:type="void"/>
23511 <field name="_g_reserved2" introspectable="0">
23512 <callback name="_g_reserved2">
23513 <return-value transfer-ownership="none">
23514 <type name="none" c:type="void"/>
23518 <field name="_g_reserved3" introspectable="0">
23519 <callback name="_g_reserved3">
23520 <return-value transfer-ownership="none">
23521 <type name="none" c:type="void"/>
23525 <field name="_g_reserved4" introspectable="0">
23526 <callback name="_g_reserved4">
23527 <return-value transfer-ownership="none">
23528 <type name="none" c:type="void"/>
23532 <field name="_g_reserved5" introspectable="0">
23533 <callback name="_g_reserved5">
23534 <return-value transfer-ownership="none">
23535 <type name="none" c:type="void"/>
23540 <record name="FileOutputStreamPrivate"
23541 c:type="GFileOutputStreamPrivate"
23544 <callback name="FileProgressCallback" c:type="GFileProgressCallback">
23545 <doc xml:whitespace="preserve">When doing file operations that may take a while, such as moving
23546 a file or copying a file, a progress callback is used to pass how
23547 far along that operation is to the application.</doc>
23548 <return-value transfer-ownership="none">
23549 <type name="none" c:type="void"/>
23552 <parameter name="current_num_bytes" transfer-ownership="none">
23553 <doc xml:whitespace="preserve">the current number of bytes in the operation.</doc>
23554 <type name="gint64" c:type="goffset"/>
23556 <parameter name="total_num_bytes" transfer-ownership="none">
23557 <doc xml:whitespace="preserve">the total number of bytes in the operation.</doc>
23558 <type name="gint64" c:type="goffset"/>
23560 <parameter name="user_data" transfer-ownership="none" closure="2">
23561 <doc xml:whitespace="preserve">user data passed to the callback.</doc>
23562 <type name="gpointer" c:type="gpointer"/>
23566 <bitfield name="FileQueryInfoFlags"
23567 glib:type-name="GFileQueryInfoFlags"
23568 glib:get-type="g_file_query_info_flags_get_type"
23569 c:type="GFileQueryInfoFlags">
23570 <doc xml:whitespace="preserve">Flags used when querying a #GFileInfo.</doc>
23571 <member name="none"
23573 c:identifier="G_FILE_QUERY_INFO_NONE"
23575 <member name="nofollow_symlinks"
23577 c:identifier="G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS"
23578 glib:nick="nofollow-symlinks"/>
23580 <callback name="FileReadMoreCallback" c:type="GFileReadMoreCallback">
23581 <doc xml:whitespace="preserve">When loading the partial contents of a file with g_file_load_partial_contents_async(),
23582 it may become necessary to determine if any more data from the file should be loaded.
23583 A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
23584 should be read, or %FALSE otherwise.</doc>
23585 <return-value transfer-ownership="none">
23586 <doc xml:whitespace="preserve">%TRUE if more data should be read back. %FALSE otherwise.</doc>
23587 <type name="gboolean" c:type="gboolean"/>
23590 <parameter name="file_contents" transfer-ownership="none">
23591 <doc xml:whitespace="preserve">the data as currently read.</doc>
23592 <type name="utf8" c:type="char*"/>
23594 <parameter name="file_size" transfer-ownership="none">
23595 <doc xml:whitespace="preserve">the size of the data currently read.</doc>
23596 <type name="gint64" c:type="goffset"/>
23598 <parameter name="callback_data" transfer-ownership="none">
23599 <doc xml:whitespace="preserve">data passed to the callback.</doc>
23600 <type name="gpointer" c:type="gpointer"/>
23604 <enumeration name="FileType"
23605 glib:type-name="GFileType"
23606 glib:get-type="g_file_type_get_type"
23607 c:type="GFileType">
23608 <doc xml:whitespace="preserve">Indicates the file's on-disk type.</doc>
23609 <member name="unknown"
23611 c:identifier="G_FILE_TYPE_UNKNOWN"
23612 glib:nick="unknown"/>
23613 <member name="regular"
23615 c:identifier="G_FILE_TYPE_REGULAR"
23616 glib:nick="regular"/>
23617 <member name="directory"
23619 c:identifier="G_FILE_TYPE_DIRECTORY"
23620 glib:nick="directory"/>
23621 <member name="symbolic_link"
23623 c:identifier="G_FILE_TYPE_SYMBOLIC_LINK"
23624 glib:nick="symbolic-link"/>
23625 <member name="special"
23627 c:identifier="G_FILE_TYPE_SPECIAL"
23628 glib:nick="special"/>
23629 <member name="shortcut"
23631 c:identifier="G_FILE_TYPE_SHORTCUT"
23632 glib:nick="shortcut"/>
23633 <member name="mountable"
23635 c:identifier="G_FILE_TYPE_MOUNTABLE"
23636 glib:nick="mountable"/>
23638 <class name="FilenameCompleter"
23639 c:symbol-prefix="filename_completer"
23640 c:type="GFilenameCompleter"
23641 parent="GObject.Object"
23642 glib:type-name="GFilenameCompleter"
23643 glib:get-type="g_filename_completer_get_type"
23644 glib:type-struct="FilenameCompleterClass">
23645 <doc xml:whitespace="preserve">Completes filenames based on files that exist within the file system.</doc>
23646 <constructor name="new" c:identifier="g_filename_completer_new">
23647 <doc xml:whitespace="preserve">Creates a new filename completer.</doc>
23648 <return-value transfer-ownership="full">
23649 <doc xml:whitespace="preserve">a #GFilenameCompleter.</doc>
23650 <type name="FilenameCompleter" c:type="GFilenameCompleter*"/>
23653 <method name="get_completion_suffix"
23654 c:identifier="g_filename_completer_get_completion_suffix">
23655 <doc xml:whitespace="preserve">Obtains a completion for @initial_text from @completer.
23656 This string is not owned by GIO, so remember to g_free() it
23657 when finished.</doc>
23658 <return-value transfer-ownership="full">
23659 <doc xml:whitespace="preserve">a completed string, or %NULL if no completion exists.</doc>
23660 <type name="utf8" c:type="char*"/>
23663 <parameter name="initial_text" transfer-ownership="none">
23664 <doc xml:whitespace="preserve">text to be completed.</doc>
23665 <type name="utf8" c:type="char*"/>
23669 <method name="get_completions"
23670 c:identifier="g_filename_completer_get_completions">
23671 <doc xml:whitespace="preserve">Gets an array of completion strings for a given initial text.
23672 This array must be freed by g_strfreev() when finished.</doc>
23673 <return-value transfer-ownership="full">
23674 <doc xml:whitespace="preserve">array of strings with possible completions for @initial_text.</doc>
23675 <array c:type="char**">
23676 <type name="utf8"/>
23680 <parameter name="initial_text" transfer-ownership="none">
23681 <doc xml:whitespace="preserve">text to be completed.</doc>
23682 <type name="utf8" c:type="char*"/>
23686 <method name="set_dirs_only"
23687 c:identifier="g_filename_completer_set_dirs_only">
23688 <doc xml:whitespace="preserve">If @dirs_only is %TRUE, @completer will only
23689 complete directory names, and not file names.</doc>
23690 <return-value transfer-ownership="none">
23691 <type name="none" c:type="void"/>
23694 <parameter name="dirs_only" transfer-ownership="none">
23695 <doc xml:whitespace="preserve">a #gboolean.</doc>
23696 <type name="gboolean" c:type="gboolean"/>
23700 <glib:signal name="got-completion-data">
23701 <doc xml:whitespace="preserve">Emitted when the file name completion information comes available.</doc>
23702 <return-value transfer-ownership="none">
23703 <type name="none"/>
23707 <record name="FilenameCompleterClass"
23708 c:type="GFilenameCompleterClass"
23709 glib:is-gtype-struct-for="FilenameCompleter">
23710 <field name="parent_class">
23711 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
23713 <field name="got_completion_data">
23714 <callback name="got_completion_data">
23715 <return-value transfer-ownership="none">
23716 <type name="none" c:type="void"/>
23719 <parameter name="filename_completer" transfer-ownership="none">
23720 <type name="FilenameCompleter" c:type="GFilenameCompleter*"/>
23725 <field name="_g_reserved1" introspectable="0">
23726 <callback name="_g_reserved1">
23727 <return-value transfer-ownership="none">
23728 <type name="none" c:type="void"/>
23732 <field name="_g_reserved2" introspectable="0">
23733 <callback name="_g_reserved2">
23734 <return-value transfer-ownership="none">
23735 <type name="none" c:type="void"/>
23739 <field name="_g_reserved3" introspectable="0">
23740 <callback name="_g_reserved3">
23741 <return-value transfer-ownership="none">
23742 <type name="none" c:type="void"/>
23747 <enumeration name="FilesystemPreviewType"
23748 glib:type-name="GFilesystemPreviewType"
23749 glib:get-type="g_filesystem_preview_type_get_type"
23750 c:type="GFilesystemPreviewType">
23751 <doc xml:whitespace="preserve">Indicates a hint from the file system whether files should be
23752 previewed in a file manager. Returned as the value of the key
23753 #G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW.</doc>
23754 <member name="if_always"
23756 c:identifier="G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS"
23757 glib:nick="if-always"/>
23758 <member name="if_local"
23760 c:identifier="G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL"
23761 glib:nick="if-local"/>
23762 <member name="never"
23764 c:identifier="G_FILESYSTEM_PREVIEW_TYPE_NEVER"
23765 glib:nick="never"/>
23767 <class name="FilterInputStream"
23768 c:symbol-prefix="filter_input_stream"
23769 c:type="GFilterInputStream"
23770 parent="InputStream"
23772 glib:type-name="GFilterInputStream"
23773 glib:get-type="g_filter_input_stream_get_type"
23774 glib:type-struct="FilterInputStreamClass">
23775 <doc xml:whitespace="preserve">A base class for all input streams that work on an underlying stream.</doc>
23776 <method name="get_base_stream"
23777 c:identifier="g_filter_input_stream_get_base_stream">
23778 <doc xml:whitespace="preserve">Gets the base stream for the filter stream.</doc>
23779 <return-value transfer-ownership="none">
23780 <doc xml:whitespace="preserve">a #GInputStream.</doc>
23781 <type name="InputStream" c:type="GInputStream*"/>
23784 <method name="get_close_base_stream"
23785 c:identifier="g_filter_input_stream_get_close_base_stream">
23786 <doc xml:whitespace="preserve">Returns whether the base stream will be closed when @stream is
23788 <return-value transfer-ownership="none">
23789 <doc xml:whitespace="preserve">%TRUE if the base stream will be closed.</doc>
23790 <type name="gboolean" c:type="gboolean"/>
23793 <method name="set_close_base_stream"
23794 c:identifier="g_filter_input_stream_set_close_base_stream">
23795 <doc xml:whitespace="preserve">Sets whether the base stream will be closed when @stream is closed.</doc>
23796 <return-value transfer-ownership="none">
23797 <type name="none" c:type="void"/>
23800 <parameter name="close_base" transfer-ownership="none">
23801 <doc xml:whitespace="preserve">%TRUE to close the base stream.</doc>
23802 <type name="gboolean" c:type="gboolean"/>
23806 <property name="base-stream"
23809 transfer-ownership="none">
23810 <type name="InputStream"/>
23812 <property name="close-base-stream"
23815 transfer-ownership="none">
23816 <type name="gboolean"/>
23818 <field name="parent_instance">
23819 <type name="InputStream" c:type="GInputStream"/>
23821 <field name="base_stream">
23822 <type name="InputStream" c:type="GInputStream*"/>
23825 <record name="FilterInputStreamClass"
23826 c:type="GFilterInputStreamClass"
23827 glib:is-gtype-struct-for="FilterInputStream">
23828 <field name="parent_class">
23829 <type name="InputStreamClass" c:type="GInputStreamClass"/>
23831 <field name="_g_reserved1" introspectable="0">
23832 <callback name="_g_reserved1">
23833 <return-value transfer-ownership="none">
23834 <type name="none" c:type="void"/>
23838 <field name="_g_reserved2" introspectable="0">
23839 <callback name="_g_reserved2">
23840 <return-value transfer-ownership="none">
23841 <type name="none" c:type="void"/>
23845 <field name="_g_reserved3" introspectable="0">
23846 <callback name="_g_reserved3">
23847 <return-value transfer-ownership="none">
23848 <type name="none" c:type="void"/>
23853 <class name="FilterOutputStream"
23854 c:symbol-prefix="filter_output_stream"
23855 c:type="GFilterOutputStream"
23856 parent="OutputStream"
23858 glib:type-name="GFilterOutputStream"
23859 glib:get-type="g_filter_output_stream_get_type"
23860 glib:type-struct="FilterOutputStreamClass">
23861 <doc xml:whitespace="preserve">A base class for all output streams that work on an underlying stream.</doc>
23862 <method name="get_base_stream"
23863 c:identifier="g_filter_output_stream_get_base_stream">
23864 <doc xml:whitespace="preserve">Gets the base stream for the filter stream.</doc>
23865 <return-value transfer-ownership="none">
23866 <doc xml:whitespace="preserve">a #GOutputStream.</doc>
23867 <type name="OutputStream" c:type="GOutputStream*"/>
23870 <method name="get_close_base_stream"
23871 c:identifier="g_filter_output_stream_get_close_base_stream">
23872 <doc xml:whitespace="preserve">Returns whether the base stream will be closed when @stream is
23874 <return-value transfer-ownership="none">
23875 <doc xml:whitespace="preserve">%TRUE if the base stream will be closed.</doc>
23876 <type name="gboolean" c:type="gboolean"/>
23879 <method name="set_close_base_stream"
23880 c:identifier="g_filter_output_stream_set_close_base_stream">
23881 <doc xml:whitespace="preserve">Sets whether the base stream will be closed when @stream is closed.</doc>
23882 <return-value transfer-ownership="none">
23883 <type name="none" c:type="void"/>
23886 <parameter name="close_base" transfer-ownership="none">
23887 <doc xml:whitespace="preserve">%TRUE to close the base stream.</doc>
23888 <type name="gboolean" c:type="gboolean"/>
23892 <property name="base-stream"
23895 transfer-ownership="none">
23896 <type name="OutputStream"/>
23898 <property name="close-base-stream"
23901 transfer-ownership="none">
23902 <type name="gboolean"/>
23904 <field name="parent_instance">
23905 <type name="OutputStream" c:type="GOutputStream"/>
23907 <field name="base_stream">
23908 <type name="OutputStream" c:type="GOutputStream*"/>
23911 <record name="FilterOutputStreamClass"
23912 c:type="GFilterOutputStreamClass"
23913 glib:is-gtype-struct-for="FilterOutputStream">
23914 <field name="parent_class">
23915 <type name="OutputStreamClass" c:type="GOutputStreamClass"/>
23917 <field name="_g_reserved1" introspectable="0">
23918 <callback name="_g_reserved1">
23919 <return-value transfer-ownership="none">
23920 <type name="none" c:type="void"/>
23924 <field name="_g_reserved2" introspectable="0">
23925 <callback name="_g_reserved2">
23926 <return-value transfer-ownership="none">
23927 <type name="none" c:type="void"/>
23931 <field name="_g_reserved3" introspectable="0">
23932 <callback name="_g_reserved3">
23933 <return-value transfer-ownership="none">
23934 <type name="none" c:type="void"/>
23939 <enumeration name="IOErrorEnum"
23940 glib:type-name="GIOErrorEnum"
23941 glib:get-type="g_io_error_enum_get_type"
23942 c:type="GIOErrorEnum"
23943 glib:error-quark="g_io_error_quark">
23944 <doc xml:whitespace="preserve">Error codes returned by GIO functions.</doc>
23945 <member name="failed"
23947 c:identifier="G_IO_ERROR_FAILED"
23948 glib:nick="failed"/>
23949 <member name="not_found"
23951 c:identifier="G_IO_ERROR_NOT_FOUND"
23952 glib:nick="not-found"/>
23953 <member name="exists"
23955 c:identifier="G_IO_ERROR_EXISTS"
23956 glib:nick="exists"/>
23957 <member name="is_directory"
23959 c:identifier="G_IO_ERROR_IS_DIRECTORY"
23960 glib:nick="is-directory"/>
23961 <member name="not_directory"
23963 c:identifier="G_IO_ERROR_NOT_DIRECTORY"
23964 glib:nick="not-directory"/>
23965 <member name="not_empty"
23967 c:identifier="G_IO_ERROR_NOT_EMPTY"
23968 glib:nick="not-empty"/>
23969 <member name="not_regular_file"
23971 c:identifier="G_IO_ERROR_NOT_REGULAR_FILE"
23972 glib:nick="not-regular-file"/>
23973 <member name="not_symbolic_link"
23975 c:identifier="G_IO_ERROR_NOT_SYMBOLIC_LINK"
23976 glib:nick="not-symbolic-link"/>
23977 <member name="not_mountable_file"
23979 c:identifier="G_IO_ERROR_NOT_MOUNTABLE_FILE"
23980 glib:nick="not-mountable-file"/>
23981 <member name="filename_too_long"
23983 c:identifier="G_IO_ERROR_FILENAME_TOO_LONG"
23984 glib:nick="filename-too-long"/>
23985 <member name="invalid_filename"
23987 c:identifier="G_IO_ERROR_INVALID_FILENAME"
23988 glib:nick="invalid-filename"/>
23989 <member name="too_many_links"
23991 c:identifier="G_IO_ERROR_TOO_MANY_LINKS"
23992 glib:nick="too-many-links"/>
23993 <member name="no_space"
23995 c:identifier="G_IO_ERROR_NO_SPACE"
23996 glib:nick="no-space"/>
23997 <member name="invalid_argument"
23999 c:identifier="G_IO_ERROR_INVALID_ARGUMENT"
24000 glib:nick="invalid-argument"/>
24001 <member name="permission_denied"
24003 c:identifier="G_IO_ERROR_PERMISSION_DENIED"
24004 glib:nick="permission-denied"/>
24005 <member name="not_supported"
24007 c:identifier="G_IO_ERROR_NOT_SUPPORTED"
24008 glib:nick="not-supported"/>
24009 <member name="not_mounted"
24011 c:identifier="G_IO_ERROR_NOT_MOUNTED"
24012 glib:nick="not-mounted"/>
24013 <member name="already_mounted"
24015 c:identifier="G_IO_ERROR_ALREADY_MOUNTED"
24016 glib:nick="already-mounted"/>
24017 <member name="closed"
24019 c:identifier="G_IO_ERROR_CLOSED"
24020 glib:nick="closed"/>
24021 <member name="cancelled"
24023 c:identifier="G_IO_ERROR_CANCELLED"
24024 glib:nick="cancelled"/>
24025 <member name="pending"
24027 c:identifier="G_IO_ERROR_PENDING"
24028 glib:nick="pending"/>
24029 <member name="read_only"
24031 c:identifier="G_IO_ERROR_READ_ONLY"
24032 glib:nick="read-only"/>
24033 <member name="cant_create_backup"
24035 c:identifier="G_IO_ERROR_CANT_CREATE_BACKUP"
24036 glib:nick="cant-create-backup"/>
24037 <member name="wrong_etag"
24039 c:identifier="G_IO_ERROR_WRONG_ETAG"
24040 glib:nick="wrong-etag"/>
24041 <member name="timed_out"
24043 c:identifier="G_IO_ERROR_TIMED_OUT"
24044 glib:nick="timed-out"/>
24045 <member name="would_recurse"
24047 c:identifier="G_IO_ERROR_WOULD_RECURSE"
24048 glib:nick="would-recurse"/>
24049 <member name="busy"
24051 c:identifier="G_IO_ERROR_BUSY"
24053 <member name="would_block"
24055 c:identifier="G_IO_ERROR_WOULD_BLOCK"
24056 glib:nick="would-block"/>
24057 <member name="host_not_found"
24059 c:identifier="G_IO_ERROR_HOST_NOT_FOUND"
24060 glib:nick="host-not-found"/>
24061 <member name="would_merge"
24063 c:identifier="G_IO_ERROR_WOULD_MERGE"
24064 glib:nick="would-merge"/>
24065 <member name="failed_handled"
24067 c:identifier="G_IO_ERROR_FAILED_HANDLED"
24068 glib:nick="failed-handled"/>
24069 <member name="too_many_open_files"
24071 c:identifier="G_IO_ERROR_TOO_MANY_OPEN_FILES"
24072 glib:nick="too-many-open-files"/>
24073 <member name="not_initialized"
24075 c:identifier="G_IO_ERROR_NOT_INITIALIZED"
24076 glib:nick="not-initialized"/>
24077 <member name="address_in_use"
24079 c:identifier="G_IO_ERROR_ADDRESS_IN_USE"
24080 glib:nick="address-in-use"/>
24081 <member name="partial_input"
24083 c:identifier="G_IO_ERROR_PARTIAL_INPUT"
24084 glib:nick="partial-input"/>
24085 <member name="invalid_data"
24087 c:identifier="G_IO_ERROR_INVALID_DATA"
24088 glib:nick="invalid-data"/>
24089 <member name="dbus_error"
24091 c:identifier="G_IO_ERROR_DBUS_ERROR"
24092 glib:nick="dbus-error"/>
24093 <member name="host_unreachable"
24095 c:identifier="G_IO_ERROR_HOST_UNREACHABLE"
24096 glib:nick="host-unreachable"/>
24097 <member name="network_unreachable"
24099 c:identifier="G_IO_ERROR_NETWORK_UNREACHABLE"
24100 glib:nick="network-unreachable"/>
24101 <member name="connection_refused"
24103 c:identifier="G_IO_ERROR_CONNECTION_REFUSED"
24104 glib:nick="connection-refused"/>
24105 <member name="proxy_failed"
24107 c:identifier="G_IO_ERROR_PROXY_FAILED"
24108 glib:nick="proxy-failed"/>
24109 <member name="proxy_auth_failed"
24111 c:identifier="G_IO_ERROR_PROXY_AUTH_FAILED"
24112 glib:nick="proxy-auth-failed"/>
24113 <member name="proxy_need_auth"
24115 c:identifier="G_IO_ERROR_PROXY_NEED_AUTH"
24116 glib:nick="proxy-need-auth"/>
24117 <member name="proxy_not_allowed"
24119 c:identifier="G_IO_ERROR_PROXY_NOT_ALLOWED"
24120 glib:nick="proxy-not-allowed"/>
24122 <record name="IOExtension" c:type="GIOExtension" disguised="1">
24123 <method name="get_name" c:identifier="g_io_extension_get_name">
24124 <doc xml:whitespace="preserve">Gets the name under which @extension was registered.
24125 Note that the same type may be registered as extension
24126 for multiple extension points, under different names.</doc>
24127 <return-value transfer-ownership="none">
24128 <doc xml:whitespace="preserve">the name of @extension.</doc>
24129 <type name="utf8" c:type="char*"/>
24132 <method name="get_priority" c:identifier="g_io_extension_get_priority">
24133 <doc xml:whitespace="preserve">Gets the priority with which @extension was registered.</doc>
24134 <return-value transfer-ownership="none">
24135 <doc xml:whitespace="preserve">the priority of @extension</doc>
24136 <type name="gint" c:type="gint"/>
24139 <method name="ref_class"
24140 c:identifier="g_io_extension_ref_class"
24141 introspectable="0">
24142 <doc xml:whitespace="preserve">Gets a reference to the class for the type that is
24143 associated with @extension.</doc>
24144 <return-value transfer-ownership="full">
24145 <doc xml:whitespace="preserve">the #GTypeClass for the type of @extension</doc>
24146 <type name="GObject.TypeClass" c:type="GTypeClass*"/>
24150 <record name="IOExtensionPoint" c:type="GIOExtensionPoint" disguised="1">
24151 <method name="get_extension_by_name"
24152 c:identifier="g_io_extension_point_get_extension_by_name">
24153 <doc xml:whitespace="preserve">Finds a #GIOExtension for an extension point by name.
24154 given name, or %NULL if there is no extension with that name</doc>
24155 <return-value transfer-ownership="none">
24156 <doc xml:whitespace="preserve">the #GIOExtension for @extension_point that has the</doc>
24157 <type name="IOExtension" c:type="GIOExtension*"/>
24160 <parameter name="name" transfer-ownership="none">
24161 <doc xml:whitespace="preserve">the name of the extension to get</doc>
24162 <type name="utf8" c:type="char*"/>
24166 <method name="get_extensions"
24167 c:identifier="g_io_extension_point_get_extensions">
24168 <doc xml:whitespace="preserve">Gets a list of all extensions that implement this extension point.
24169 The list is sorted by priority, beginning with the highest priority.
24170 #GIOExtension<!-- -->s. The list is owned by GIO and should not be
24172 <return-value transfer-ownership="none">
24173 <doc xml:whitespace="preserve">a #GList of</doc>
24174 <type name="GLib.List" c:type="GList*">
24175 <type name="IOExtension"/>
24179 <method name="get_required_type"
24180 c:identifier="g_io_extension_point_get_required_type">
24181 <doc xml:whitespace="preserve">Gets the required type for @extension_point.
24182 or #G_TYPE_INVALID if the extension point has no required type</doc>
24183 <return-value transfer-ownership="none">
24184 <doc xml:whitespace="preserve">the #GType that all implementations must have,</doc>
24185 <type name="GType" c:type="GType"/>
24188 <method name="set_required_type"
24189 c:identifier="g_io_extension_point_set_required_type">
24190 <doc xml:whitespace="preserve">Sets the required type for @extension_point to @type.
24191 All implementations must henceforth have this type.</doc>
24192 <return-value transfer-ownership="none">
24193 <type name="none" c:type="void"/>
24196 <parameter name="type" transfer-ownership="none">
24197 <doc xml:whitespace="preserve">the #GType to require</doc>
24198 <type name="GType" c:type="GType"/>
24203 <class name="IOModule"
24204 c:symbol-prefix="io_module"
24206 parent="GObject.TypeModule"
24207 glib:type-name="GIOModule"
24208 glib:get-type="g_io_module_get_type"
24209 glib:type-struct="IOModuleClass">
24210 <doc xml:whitespace="preserve">Opaque module base class for extending GIO.</doc>
24211 <implements name="GObject.TypePlugin"/>
24212 <constructor name="new" c:identifier="g_io_module_new">
24213 <doc xml:whitespace="preserve">Creates a new GIOModule that will load the specific
24214 shared library when in use.
24215 or %NULL on error.</doc>
24216 <return-value transfer-ownership="full">
24217 <doc xml:whitespace="preserve">a #GIOModule from given @filename,</doc>
24218 <type name="IOModule" c:type="GIOModule*"/>
24221 <parameter name="filename" transfer-ownership="none">
24222 <doc xml:whitespace="preserve">filename of the shared library module.</doc>
24223 <type name="utf8" c:type="gchar*"/>
24227 <function name="query"
24228 c:identifier="g_io_module_query"
24230 introspectable="0">
24231 <doc xml:whitespace="preserve">Optional API for GIO modules to implement.
24232 Should return a list of all the extension points that may be
24233 implemented in this module.
24234 This method will not be called in normal use, however it may be
24235 called when probing existing modules and recording which extension
24236 points that this modle is used for. This means we won't have to
24237 load and initialze this module unless its needed.
24238 If this function is not implemented by the module the module will
24239 always be loaded, initialized and then unloaded on application startup
24240 so that it can register its extension points during init.
24241 Note that a module need not actually implement all the extension points
24242 that g_io_module_query returns, since the exact list of extension may
24243 depend on runtime issues. However all extension points actually implemented
24244 must be returned by g_io_module_query() (if defined).
24245 When installing a module that implements g_io_module_query you must
24246 run gio-querymodules in order to build the cache files required for
24248 extension points of the module. The array must be suitable for
24249 freeing with g_strfreev().</doc>
24251 <doc xml:whitespace="preserve">A %NULL-terminated array of strings, listing the supported</doc>
24252 <array c:type="char**">
24253 <type name="utf8"/>
24257 <method name="load" c:identifier="g_io_module_load">
24258 <doc xml:whitespace="preserve">Required API for GIO modules to implement.
24259 This function is ran after the module has been loaded into GIO,
24260 to initialize the module.</doc>
24261 <return-value transfer-ownership="none">
24262 <type name="none" c:type="void"/>
24265 <method name="unload" c:identifier="g_io_module_unload">
24266 <doc xml:whitespace="preserve">Required API for GIO modules to implement.
24267 This function is ran when the module is being unloaded from GIO,
24268 to finalize the module.</doc>
24269 <return-value transfer-ownership="none">
24270 <type name="none" c:type="void"/>
24274 <record name="IOModuleClass"
24275 c:type="GIOModuleClass"
24277 glib:is-gtype-struct-for="IOModule">
24279 <record name="IOSchedulerJob" c:type="GIOSchedulerJob" disguised="1">
24280 <doc xml:whitespace="preserve">Opaque class for definining and scheduling IO jobs.</doc>
24281 <method name="send_to_mainloop"
24282 c:identifier="g_io_scheduler_job_send_to_mainloop">
24283 <doc xml:whitespace="preserve">Used from an I/O job to send a callback to be run in the thread
24284 that the job was started from, waiting for the result (and thus
24285 blocking the I/O job).</doc>
24286 <return-value transfer-ownership="none">
24287 <doc xml:whitespace="preserve">The return value of @func</doc>
24288 <type name="gboolean" c:type="gboolean"/>
24291 <parameter name="func"
24292 transfer-ownership="none"
24296 <doc xml:whitespace="preserve">a #GSourceFunc callback that will be called in the original thread</doc>
24297 <type name="GLib.SourceFunc" c:type="GSourceFunc"/>
24299 <parameter name="user_data" transfer-ownership="none">
24300 <doc xml:whitespace="preserve">data to pass to @func</doc>
24301 <type name="gpointer" c:type="gpointer"/>
24303 <parameter name="notify" transfer-ownership="none" scope="async">
24304 <doc xml:whitespace="preserve">a #GDestroyNotify for @user_data, or %NULL</doc>
24305 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
24309 <method name="send_to_mainloop_async"
24310 c:identifier="g_io_scheduler_job_send_to_mainloop_async">
24311 <doc xml:whitespace="preserve">Used from an I/O job to send a callback to be run asynchronously in
24312 the thread that the job was started from. The callback will be run
24313 when the main loop is available, but at that time the I/O job might
24314 have finished. The return value from the callback is ignored.
24315 Note that if you are passing the @user_data from g_io_scheduler_push_job()
24316 on to this function you have to ensure that it is not freed before
24317 g_io_scheduler_push_job() or by using refcounting for @user_data.</doc>
24318 <return-value transfer-ownership="none">
24319 <type name="none" c:type="void"/>
24322 <parameter name="func"
24323 transfer-ownership="none"
24327 <doc xml:whitespace="preserve">a #GSourceFunc callback that will be called in the original thread</doc>
24328 <type name="GLib.SourceFunc" c:type="GSourceFunc"/>
24330 <parameter name="user_data" transfer-ownership="none">
24331 <doc xml:whitespace="preserve">data to pass to @func</doc>
24332 <type name="gpointer" c:type="gpointer"/>
24334 <parameter name="notify" transfer-ownership="none" scope="async">
24335 <doc xml:whitespace="preserve">a #GDestroyNotify for @user_data, or %NULL</doc>
24336 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
24341 <callback name="IOSchedulerJobFunc" c:type="GIOSchedulerJobFunc">
24342 <doc xml:whitespace="preserve">I/O Job function.
24343 Note that depending on whether threads are available, the
24344 #GIOScheduler may run jobs in separate threads or in an idle
24346 Long-running jobs should periodically check the @cancellable
24347 to see if they have been cancelled.
24348 complete the job, %FALSE if the job is complete (or cancelled)</doc>
24349 <return-value transfer-ownership="none">
24350 <doc xml:whitespace="preserve">%TRUE if this function should be called again to</doc>
24351 <type name="gboolean" c:type="gboolean"/>
24354 <parameter name="job" transfer-ownership="none">
24355 <doc xml:whitespace="preserve">a #GIOSchedulerJob.</doc>
24356 <type name="IOSchedulerJob" c:type="GIOSchedulerJob*"/>
24358 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
24359 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
24360 <type name="Cancellable" c:type="GCancellable*"/>
24362 <parameter name="user_data" transfer-ownership="none" closure="2">
24363 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
24364 <type name="gpointer" c:type="gpointer"/>
24368 <class name="IOStream"
24369 c:symbol-prefix="io_stream"
24371 parent="GObject.Object"
24373 glib:type-name="GIOStream"
24374 glib:get-type="g_io_stream_get_type"
24375 glib:type-struct="IOStreamClass">
24376 <doc xml:whitespace="preserve">Base class for read-write streams.</doc>
24377 <virtual-method name="close_async" invoker="close_async" version="2.22">
24378 <doc xml:whitespace="preserve">Requests an asynchronous close of the stream, releasing resources
24379 related to it. When the operation is finished @callback will be
24380 called. You can then call g_io_stream_close_finish() to get
24381 the result of the operation.
24382 For behaviour details see g_io_stream_close().
24383 The asynchronous methods have a default fallback that uses threads
24384 to implement asynchronicity, so they are optional for inheriting
24385 classes. However, if you override one you must override all.</doc>
24386 <return-value transfer-ownership="none">
24387 <type name="none" c:type="void"/>
24390 <parameter name="io_priority" transfer-ownership="none">
24391 <doc xml:whitespace="preserve">the io priority of the request</doc>
24392 <type name="gint" c:type="int"/>
24394 <parameter name="cancellable"
24395 transfer-ownership="none"
24397 <doc xml:whitespace="preserve">optional cancellable object</doc>
24398 <type name="Cancellable" c:type="GCancellable*"/>
24400 <parameter name="callback"
24401 transfer-ownership="none"
24404 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
24405 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
24407 <parameter name="user_data" transfer-ownership="none" closure="3">
24408 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
24409 <type name="gpointer" c:type="gpointer"/>
24413 <virtual-method name="close_finish"
24414 invoker="close_finish"
24417 <doc xml:whitespace="preserve">Closes a stream.</doc>
24418 <return-value transfer-ownership="none">
24419 <doc xml:whitespace="preserve">%TRUE if stream was successfully closed, %FALSE otherwise.</doc>
24420 <type name="gboolean" c:type="gboolean"/>
24423 <parameter name="result" transfer-ownership="none">
24424 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
24425 <type name="AsyncResult" c:type="GAsyncResult*"/>
24429 <virtual-method name="close_fn" throws="1">
24430 <return-value transfer-ownership="none">
24431 <type name="gboolean" c:type="gboolean"/>
24434 <parameter name="cancellable" transfer-ownership="none">
24435 <type name="Cancellable" c:type="GCancellable*"/>
24439 <virtual-method name="get_input_stream"
24440 invoker="get_input_stream"
24442 <doc xml:whitespace="preserve">Gets the input stream for this object. This is used
24445 <return-value transfer-ownership="none">
24446 <doc xml:whitespace="preserve">a #GInputStream, owned by the #GIOStream.</doc>
24447 <type name="InputStream" c:type="GInputStream*"/>
24450 <virtual-method name="get_output_stream"
24451 invoker="get_output_stream"
24453 <doc xml:whitespace="preserve">Gets the output stream for this object. This is used for
24456 <return-value transfer-ownership="none">
24457 <doc xml:whitespace="preserve">a #GOutputStream, owned by the #GIOStream.</doc>
24458 <type name="OutputStream" c:type="GOutputStream*"/>
24461 <method name="clear_pending"
24462 c:identifier="g_io_stream_clear_pending"
24464 <doc xml:whitespace="preserve">Clears the pending flag on @stream.</doc>
24465 <return-value transfer-ownership="none">
24466 <type name="none" c:type="void"/>
24469 <method name="close"
24470 c:identifier="g_io_stream_close"
24473 <doc xml:whitespace="preserve">Closes the stream, releasing resources related to it. This will also
24474 closes the individual input and output streams, if they are not already
24476 Once the stream is closed, all other operations will return
24477 %G_IO_ERROR_CLOSED. Closing a stream multiple times will not
24479 Closing a stream will automatically flush any outstanding buffers
24481 Streams will be automatically closed when the last reference
24482 is dropped, but you might want to call this function to make sure
24483 resources are released as early as possible.
24484 Some streams might keep the backing store of the stream (e.g. a file
24485 descriptor) open after the stream is closed. See the documentation for
24486 the individual stream for details.
24487 On failure the first error that happened will be reported, but the
24488 close operation will finish as much as possible. A stream that failed
24489 to close will still return %G_IO_ERROR_CLOSED for all operations.
24490 Still, it is important to check and report the error to the user,
24491 otherwise there might be a loss of data as all data might not be written.
24492 If @cancellable is not NULL, then the operation can be cancelled by
24493 triggering the cancellable object from another thread. If the operation
24494 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
24495 Cancelling a close will still leave the stream closed, but some streams
24496 can use a faster close that doesn't block to e.g. check errors.
24497 The default implementation of this method just calls close on the
24498 individual input/output streams.</doc>
24499 <return-value transfer-ownership="none">
24500 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure</doc>
24501 <type name="gboolean" c:type="gboolean"/>
24504 <parameter name="cancellable"
24505 transfer-ownership="none"
24507 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
24508 <type name="Cancellable" c:type="GCancellable*"/>
24512 <method name="close_async"
24513 c:identifier="g_io_stream_close_async"
24515 <doc xml:whitespace="preserve">Requests an asynchronous close of the stream, releasing resources
24516 related to it. When the operation is finished @callback will be
24517 called. You can then call g_io_stream_close_finish() to get
24518 the result of the operation.
24519 For behaviour details see g_io_stream_close().
24520 The asynchronous methods have a default fallback that uses threads
24521 to implement asynchronicity, so they are optional for inheriting
24522 classes. However, if you override one you must override all.</doc>
24523 <return-value transfer-ownership="none">
24524 <type name="none" c:type="void"/>
24527 <parameter name="io_priority" transfer-ownership="none">
24528 <doc xml:whitespace="preserve">the io priority of the request</doc>
24529 <type name="gint" c:type="int"/>
24531 <parameter name="cancellable"
24532 transfer-ownership="none"
24534 <doc xml:whitespace="preserve">optional cancellable object</doc>
24535 <type name="Cancellable" c:type="GCancellable*"/>
24537 <parameter name="callback"
24538 transfer-ownership="none"
24541 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
24542 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
24544 <parameter name="user_data" transfer-ownership="none">
24545 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
24546 <type name="gpointer" c:type="gpointer"/>
24550 <method name="close_finish"
24551 c:identifier="g_io_stream_close_finish"
24554 <doc xml:whitespace="preserve">Closes a stream.</doc>
24555 <return-value transfer-ownership="none">
24556 <doc xml:whitespace="preserve">%TRUE if stream was successfully closed, %FALSE otherwise.</doc>
24557 <type name="gboolean" c:type="gboolean"/>
24560 <parameter name="result" transfer-ownership="none">
24561 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
24562 <type name="AsyncResult" c:type="GAsyncResult*"/>
24566 <method name="get_input_stream"
24567 c:identifier="g_io_stream_get_input_stream"
24569 <doc xml:whitespace="preserve">Gets the input stream for this object. This is used
24572 <return-value transfer-ownership="none">
24573 <doc xml:whitespace="preserve">a #GInputStream, owned by the #GIOStream.</doc>
24574 <type name="InputStream" c:type="GInputStream*"/>
24577 <method name="get_output_stream"
24578 c:identifier="g_io_stream_get_output_stream"
24580 <doc xml:whitespace="preserve">Gets the output stream for this object. This is used for
24583 <return-value transfer-ownership="none">
24584 <doc xml:whitespace="preserve">a #GOutputStream, owned by the #GIOStream.</doc>
24585 <type name="OutputStream" c:type="GOutputStream*"/>
24588 <method name="has_pending"
24589 c:identifier="g_io_stream_has_pending"
24591 <doc xml:whitespace="preserve">Checks if a stream has pending actions.</doc>
24592 <return-value transfer-ownership="none">
24593 <doc xml:whitespace="preserve">%TRUE if @stream has pending actions.</doc>
24594 <type name="gboolean" c:type="gboolean"/>
24597 <method name="is_closed"
24598 c:identifier="g_io_stream_is_closed"
24600 <doc xml:whitespace="preserve">Checks if a stream is closed.</doc>
24601 <return-value transfer-ownership="none">
24602 <doc xml:whitespace="preserve">%TRUE if the stream is closed.</doc>
24603 <type name="gboolean" c:type="gboolean"/>
24606 <method name="set_pending"
24607 c:identifier="g_io_stream_set_pending"
24610 <doc xml:whitespace="preserve">Sets @stream to have actions pending. If the pending flag is
24611 already set or @stream is closed, it will return %FALSE and set</doc>
24612 <return-value transfer-ownership="none">
24613 <doc xml:whitespace="preserve">%TRUE if pending was previously unset and is now set.</doc>
24614 <type name="gboolean" c:type="gboolean"/>
24617 <property name="closed" writable="1" transfer-ownership="none">
24618 <type name="gboolean"/>
24620 <property name="input-stream" transfer-ownership="none">
24621 <type name="InputStream"/>
24623 <property name="output-stream" transfer-ownership="none">
24624 <type name="OutputStream"/>
24626 <field name="parent_instance">
24627 <type name="GObject.Object" c:type="GObject"/>
24629 <field name="priv">
24630 <type name="IOStreamPrivate" c:type="GIOStreamPrivate*"/>
24633 <record name="IOStreamClass"
24634 c:type="GIOStreamClass"
24635 glib:is-gtype-struct-for="IOStream">
24636 <field name="parent_class">
24637 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
24639 <field name="get_input_stream">
24640 <callback name="get_input_stream">
24641 <return-value transfer-ownership="none">
24642 <doc xml:whitespace="preserve">a #GInputStream, owned by the #GIOStream.</doc>
24643 <type name="InputStream" c:type="GInputStream*"/>
24646 <parameter name="stream" transfer-ownership="none">
24647 <type name="IOStream" c:type="GIOStream*"/>
24652 <field name="get_output_stream">
24653 <callback name="get_output_stream">
24654 <return-value transfer-ownership="none">
24655 <doc xml:whitespace="preserve">a #GOutputStream, owned by the #GIOStream.</doc>
24656 <type name="OutputStream" c:type="GOutputStream*"/>
24659 <parameter name="stream" transfer-ownership="none">
24660 <type name="IOStream" c:type="GIOStream*"/>
24665 <field name="close_fn">
24666 <callback name="close_fn" throws="1">
24667 <return-value transfer-ownership="none">
24668 <type name="gboolean" c:type="gboolean"/>
24671 <parameter name="stream" transfer-ownership="none">
24672 <type name="IOStream" c:type="GIOStream*"/>
24674 <parameter name="cancellable" transfer-ownership="none">
24675 <type name="Cancellable" c:type="GCancellable*"/>
24680 <field name="close_async">
24681 <callback name="close_async">
24682 <return-value transfer-ownership="none">
24683 <type name="none" c:type="void"/>
24686 <parameter name="stream" transfer-ownership="none">
24687 <type name="IOStream" c:type="GIOStream*"/>
24689 <parameter name="io_priority" transfer-ownership="none">
24690 <doc xml:whitespace="preserve">the io priority of the request</doc>
24691 <type name="gint" c:type="int"/>
24693 <parameter name="cancellable"
24694 transfer-ownership="none"
24696 <doc xml:whitespace="preserve">optional cancellable object</doc>
24697 <type name="Cancellable" c:type="GCancellable*"/>
24699 <parameter name="callback"
24700 transfer-ownership="none"
24703 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
24704 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
24706 <parameter name="user_data" transfer-ownership="none" closure="4">
24707 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
24708 <type name="gpointer" c:type="gpointer"/>
24713 <field name="close_finish">
24714 <callback name="close_finish" throws="1">
24715 <return-value transfer-ownership="none">
24716 <doc xml:whitespace="preserve">%TRUE if stream was successfully closed, %FALSE otherwise.</doc>
24717 <type name="gboolean" c:type="gboolean"/>
24720 <parameter name="stream" transfer-ownership="none">
24721 <type name="IOStream" c:type="GIOStream*"/>
24723 <parameter name="result" transfer-ownership="none">
24724 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
24725 <type name="AsyncResult" c:type="GAsyncResult*"/>
24730 <field name="_g_reserved1" introspectable="0">
24731 <callback name="_g_reserved1">
24732 <return-value transfer-ownership="none">
24733 <type name="none" c:type="void"/>
24737 <field name="_g_reserved2" introspectable="0">
24738 <callback name="_g_reserved2">
24739 <return-value transfer-ownership="none">
24740 <type name="none" c:type="void"/>
24744 <field name="_g_reserved3" introspectable="0">
24745 <callback name="_g_reserved3">
24746 <return-value transfer-ownership="none">
24747 <type name="none" c:type="void"/>
24751 <field name="_g_reserved4" introspectable="0">
24752 <callback name="_g_reserved4">
24753 <return-value transfer-ownership="none">
24754 <type name="none" c:type="void"/>
24758 <field name="_g_reserved5" introspectable="0">
24759 <callback name="_g_reserved5">
24760 <return-value transfer-ownership="none">
24761 <type name="none" c:type="void"/>
24765 <field name="_g_reserved6" introspectable="0">
24766 <callback name="_g_reserved6">
24767 <return-value transfer-ownership="none">
24768 <type name="none" c:type="void"/>
24772 <field name="_g_reserved7" introspectable="0">
24773 <callback name="_g_reserved7">
24774 <return-value transfer-ownership="none">
24775 <type name="none" c:type="void"/>
24779 <field name="_g_reserved8" introspectable="0">
24780 <callback name="_g_reserved8">
24781 <return-value transfer-ownership="none">
24782 <type name="none" c:type="void"/>
24786 <field name="_g_reserved9" introspectable="0">
24787 <callback name="_g_reserved9">
24788 <return-value transfer-ownership="none">
24789 <type name="none" c:type="void"/>
24793 <field name="_g_reserved10" introspectable="0">
24794 <callback name="_g_reserved10">
24795 <return-value transfer-ownership="none">
24796 <type name="none" c:type="void"/>
24801 <record name="IOStreamPrivate" c:type="GIOStreamPrivate" disguised="1">
24803 <interface name="Icon"
24804 c:symbol-prefix="icon"
24806 glib:type-name="GIcon"
24807 glib:get-type="g_icon_get_type"
24808 glib:type-struct="IconIface">
24809 <doc xml:whitespace="preserve">An abstract type that specifies an icon.</doc>
24810 <virtual-method name="equal" invoker="equal">
24811 <doc xml:whitespace="preserve">Checks if two icons are equal.</doc>
24812 <return-value transfer-ownership="none">
24813 <doc xml:whitespace="preserve">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise.</doc>
24814 <type name="gboolean" c:type="gboolean"/>
24817 <parameter name="icon2" transfer-ownership="none">
24818 <doc xml:whitespace="preserve">pointer to the second #GIcon.</doc>
24819 <type name="Icon" c:type="GIcon*"/>
24823 <virtual-method name="hash">
24824 <return-value transfer-ownership="none">
24825 <type name="guint" c:type="guint"/>
24828 <virtual-method name="to_tokens" invoker="to_string" version="2.20">
24829 <doc xml:whitespace="preserve">Generates a textual representation of @icon that can be used for
24830 serialization such as when passing @icon to a different process or
24831 saving it to persistent storage. Use g_icon_new_for_string() to
24832 get @icon back from the returned string.
24833 The encoding of the returned string is proprietary to #GIcon except
24834 in the following two cases
24835 <itemizedlist>
24836 <listitem><para>
24837 If @icon is a #GFileIcon, the returned string is a native path
24838 (such as <literal>/path/to/my icon.png</literal>) without escaping
24839 if the #GFile for @icon is a native file. If the file is not
24840 native, the returned string is the result of g_file_get_uri()
24841 (such as <literal>sftp://path/to/my%%20icon.png</literal>).
24842 </para></listitem>
24843 <listitem><para>
24844 If @icon is a #GThemedIcon with exactly one name, the encoding is
24845 simply the name (such as <literal>network-server</literal>).
24846 </para></listitem>
24847 </itemizedlist>
24848 be serialized. Use g_free() to free.</doc>
24849 <return-value transfer-ownership="none">
24850 <doc xml:whitespace="preserve">An allocated NUL-terminated UTF8 string or %NULL if @icon can't</doc>
24851 <type name="gboolean" c:type="gboolean"/>
24854 <parameter name="tokens" transfer-ownership="none">
24855 <array name="GLib.PtrArray" c:type="GPtrArray*">
24856 <type name="gpointer" c:type="gpointer"/>
24859 <parameter name="out_version" transfer-ownership="none">
24860 <type name="gint" c:type="gint*"/>
24864 <method name="equal" c:identifier="g_icon_equal">
24865 <doc xml:whitespace="preserve">Checks if two icons are equal.</doc>
24866 <return-value transfer-ownership="none">
24867 <doc xml:whitespace="preserve">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise.</doc>
24868 <type name="gboolean" c:type="gboolean"/>
24871 <parameter name="icon2" transfer-ownership="none">
24872 <doc xml:whitespace="preserve">pointer to the second #GIcon.</doc>
24873 <type name="Icon" c:type="GIcon*"/>
24877 <method name="to_string" c:identifier="g_icon_to_string" version="2.20">
24878 <doc xml:whitespace="preserve">Generates a textual representation of @icon that can be used for
24879 serialization such as when passing @icon to a different process or
24880 saving it to persistent storage. Use g_icon_new_for_string() to
24881 get @icon back from the returned string.
24882 The encoding of the returned string is proprietary to #GIcon except
24883 in the following two cases
24884 <itemizedlist>
24885 <listitem><para>
24886 If @icon is a #GFileIcon, the returned string is a native path
24887 (such as <literal>/path/to/my icon.png</literal>) without escaping
24888 if the #GFile for @icon is a native file. If the file is not
24889 native, the returned string is the result of g_file_get_uri()
24890 (such as <literal>sftp://path/to/my%%20icon.png</literal>).
24891 </para></listitem>
24892 <listitem><para>
24893 If @icon is a #GThemedIcon with exactly one name, the encoding is
24894 simply the name (such as <literal>network-server</literal>).
24895 </para></listitem>
24896 </itemizedlist>
24897 be serialized. Use g_free() to free.</doc>
24898 <return-value transfer-ownership="full">
24899 <doc xml:whitespace="preserve">An allocated NUL-terminated UTF8 string or %NULL if @icon can't</doc>
24900 <type name="utf8" c:type="gchar*"/>
24904 <record name="IconIface"
24905 c:type="GIconIface"
24906 glib:is-gtype-struct-for="Icon">
24907 <doc xml:whitespace="preserve">GIconIface is used to implement GIcon types for various
24908 different systems. See #GThemedIcon and #GLoadableIcon for
24909 examples of how to implement this interface.</doc>
24910 <field name="g_iface">
24911 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
24913 <field name="hash">
24914 <callback name="hash">
24915 <return-value transfer-ownership="none">
24916 <type name="guint" c:type="guint"/>
24919 <parameter name="icon" transfer-ownership="none">
24920 <type name="Icon" c:type="GIcon*"/>
24925 <field name="equal">
24926 <callback name="equal">
24927 <return-value transfer-ownership="none">
24928 <doc xml:whitespace="preserve">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise.</doc>
24929 <type name="gboolean" c:type="gboolean"/>
24932 <parameter name="icon1" transfer-ownership="none">
24933 <type name="Icon" c:type="GIcon*"/>
24935 <parameter name="icon2" transfer-ownership="none">
24936 <doc xml:whitespace="preserve">pointer to the second #GIcon.</doc>
24937 <type name="Icon" c:type="GIcon*"/>
24942 <field name="to_tokens">
24943 <callback name="to_tokens">
24944 <return-value transfer-ownership="none">
24945 <doc xml:whitespace="preserve">An allocated NUL-terminated UTF8 string or %NULL if @icon can't</doc>
24946 <type name="gboolean" c:type="gboolean"/>
24949 <parameter name="icon" transfer-ownership="none">
24950 <type name="Icon" c:type="GIcon*"/>
24952 <parameter name="tokens" transfer-ownership="none">
24953 <array name="GLib.PtrArray" c:type="GPtrArray*">
24954 <type name="gpointer" c:type="gpointer"/>
24957 <parameter name="out_version" transfer-ownership="none">
24958 <type name="gint" c:type="gint*"/>
24963 <field name="from_tokens" introspectable="0">
24964 <callback name="from_tokens" introspectable="0" throws="1">
24966 <type name="Icon" c:type="GIcon*"/>
24969 <parameter name="tokens" transfer-ownership="none">
24970 <type name="utf8" c:type="gchar**"/>
24972 <parameter name="num_tokens" transfer-ownership="none">
24973 <type name="gint" c:type="gint"/>
24975 <parameter name="version" transfer-ownership="none">
24976 <type name="gint" c:type="gint"/>
24982 <class name="InetAddress"
24983 c:symbol-prefix="inet_address"
24984 c:type="GInetAddress"
24985 parent="GObject.Object"
24986 glib:type-name="GInetAddress"
24987 glib:get-type="g_inet_address_get_type"
24988 glib:type-struct="InetAddressClass">
24989 <doc xml:whitespace="preserve">An IPv4 or IPv6 internet address.</doc>
24990 <constructor name="new_any"
24991 c:identifier="g_inet_address_new_any"
24993 <doc xml:whitespace="preserve">Creates a #GInetAddress for the "any" address (unassigned/"don't
24994 care") for @family.
24996 <return-value transfer-ownership="full">
24997 <doc xml:whitespace="preserve">a new #GInetAddress corresponding to the "any" address</doc>
24998 <type name="InetAddress" c:type="GInetAddress*"/>
25001 <parameter name="family" transfer-ownership="none">
25002 <doc xml:whitespace="preserve">the address family</doc>
25003 <type name="SocketFamily" c:type="GSocketFamily"/>
25007 <constructor name="new_from_bytes"
25008 c:identifier="g_inet_address_new_from_bytes"
25010 <doc xml:whitespace="preserve">Creates a new #GInetAddress from the given @family and @bytes.
25011 %G_INET_ADDRESS_IPV6.</doc>
25012 <return-value transfer-ownership="full">
25013 <doc xml:whitespace="preserve">a new #GInetAddress corresponding to @family and @bytes.</doc>
25014 <type name="InetAddress" c:type="GInetAddress*"/>
25017 <parameter name="bytes" transfer-ownership="none">
25018 <doc xml:whitespace="preserve">raw address data</doc>
25019 <type name="guint8" c:type="guint8*"/>
25021 <parameter name="family" transfer-ownership="none">
25022 <doc xml:whitespace="preserve">the address family of @bytes</doc>
25023 <type name="SocketFamily" c:type="GSocketFamily"/>
25027 <constructor name="new_from_string"
25028 c:identifier="g_inet_address_new_from_string"
25030 <doc xml:whitespace="preserve">Parses @string as an IP address and creates a new #GInetAddress.</doc>
25031 <return-value transfer-ownership="full">
25032 <doc xml:whitespace="preserve">a new #GInetAddress corresponding to @string, or %NULL if</doc>
25033 <type name="InetAddress" c:type="GInetAddress*"/>
25036 <parameter name="string" transfer-ownership="none">
25037 <doc xml:whitespace="preserve">a string representation of an IP address</doc>
25038 <type name="utf8" c:type="gchar*"/>
25042 <constructor name="new_loopback"
25043 c:identifier="g_inet_address_new_loopback"
25045 <doc xml:whitespace="preserve">Creates a #GInetAddress for the loopback address for @family.
25047 <return-value transfer-ownership="full">
25048 <doc xml:whitespace="preserve">a new #GInetAddress corresponding to the loopback address</doc>
25049 <type name="InetAddress" c:type="GInetAddress*"/>
25052 <parameter name="family" transfer-ownership="none">
25053 <doc xml:whitespace="preserve">the address family</doc>
25054 <type name="SocketFamily" c:type="GSocketFamily"/>
25058 <virtual-method name="to_bytes" invoker="to_bytes" version="2.22">
25059 <doc xml:whitespace="preserve">Gets the raw binary address data from @address.
25060 which should not be modified, stored, or freed. The size of this
25061 array can be gotten with g_inet_address_get_native_size().</doc>
25062 <return-value transfer-ownership="none">
25063 <doc xml:whitespace="preserve">a pointer to an internal array of the bytes in @address,</doc>
25064 <type name="guint8" c:type="guint8*"/>
25067 <virtual-method name="to_string" invoker="to_string" version="2.22">
25068 <doc xml:whitespace="preserve">Converts @address to string form.
25069 freed after use.</doc>
25070 <return-value transfer-ownership="full">
25071 <doc xml:whitespace="preserve">a representation of @address as a string, which should be</doc>
25072 <type name="utf8" c:type="gchar*"/>
25075 <method name="get_family"
25076 c:identifier="g_inet_address_get_family"
25078 <doc xml:whitespace="preserve">Gets @address's family</doc>
25079 <return-value transfer-ownership="none">
25080 <doc xml:whitespace="preserve">@address's family</doc>
25081 <type name="SocketFamily" c:type="GSocketFamily"/>
25084 <method name="get_is_any"
25085 c:identifier="g_inet_address_get_is_any"
25087 <doc xml:whitespace="preserve">Tests whether @address is the "any" address for its family.</doc>
25088 <return-value transfer-ownership="none">
25089 <doc xml:whitespace="preserve">%TRUE if @address is the "any" address for its family.</doc>
25090 <type name="gboolean" c:type="gboolean"/>
25093 <method name="get_is_link_local"
25094 c:identifier="g_inet_address_get_is_link_local"
25096 <doc xml:whitespace="preserve">Tests whether @address is a link-local address (that is, if it
25097 identifies a host on a local network that is not connected to the
25099 <return-value transfer-ownership="none">
25100 <doc xml:whitespace="preserve">%TRUE if @address is a link-local address.</doc>
25101 <type name="gboolean" c:type="gboolean"/>
25104 <method name="get_is_loopback"
25105 c:identifier="g_inet_address_get_is_loopback"
25107 <doc xml:whitespace="preserve">Tests whether @address is the loopback address for its family.</doc>
25108 <return-value transfer-ownership="none">
25109 <doc xml:whitespace="preserve">%TRUE if @address is the loopback address for its family.</doc>
25110 <type name="gboolean" c:type="gboolean"/>
25113 <method name="get_is_mc_global"
25114 c:identifier="g_inet_address_get_is_mc_global"
25116 <doc xml:whitespace="preserve">Tests whether @address is a global multicast address.</doc>
25117 <return-value transfer-ownership="none">
25118 <doc xml:whitespace="preserve">%TRUE if @address is a global multicast address.</doc>
25119 <type name="gboolean" c:type="gboolean"/>
25122 <method name="get_is_mc_link_local"
25123 c:identifier="g_inet_address_get_is_mc_link_local"
25125 <doc xml:whitespace="preserve">Tests whether @address is a link-local multicast address.</doc>
25126 <return-value transfer-ownership="none">
25127 <doc xml:whitespace="preserve">%TRUE if @address is a link-local multicast address.</doc>
25128 <type name="gboolean" c:type="gboolean"/>
25131 <method name="get_is_mc_node_local"
25132 c:identifier="g_inet_address_get_is_mc_node_local"
25134 <doc xml:whitespace="preserve">Tests whether @address is a node-local multicast address.</doc>
25135 <return-value transfer-ownership="none">
25136 <doc xml:whitespace="preserve">%TRUE if @address is a node-local multicast address.</doc>
25137 <type name="gboolean" c:type="gboolean"/>
25140 <method name="get_is_mc_org_local"
25141 c:identifier="g_inet_address_get_is_mc_org_local"
25143 <doc xml:whitespace="preserve">Tests whether @address is an organization-local multicast address.</doc>
25144 <return-value transfer-ownership="none">
25145 <doc xml:whitespace="preserve">%TRUE if @address is an organization-local multicast address.</doc>
25146 <type name="gboolean" c:type="gboolean"/>
25149 <method name="get_is_mc_site_local"
25150 c:identifier="g_inet_address_get_is_mc_site_local"
25152 <doc xml:whitespace="preserve">Tests whether @address is a site-local multicast address.</doc>
25153 <return-value transfer-ownership="none">
25154 <doc xml:whitespace="preserve">%TRUE if @address is a site-local multicast address.</doc>
25155 <type name="gboolean" c:type="gboolean"/>
25158 <method name="get_is_multicast"
25159 c:identifier="g_inet_address_get_is_multicast"
25161 <doc xml:whitespace="preserve">Tests whether @address is a multicast address.</doc>
25162 <return-value transfer-ownership="none">
25163 <doc xml:whitespace="preserve">%TRUE if @address is a multicast address.</doc>
25164 <type name="gboolean" c:type="gboolean"/>
25167 <method name="get_is_site_local"
25168 c:identifier="g_inet_address_get_is_site_local"
25170 <doc xml:whitespace="preserve">Tests whether @address is a site-local address such as 10.0.0.1
25171 (that is, the address identifies a host on a local network that can
25172 not be reached directly from the Internet, but which may have
25173 outgoing Internet connectivity via a NAT or firewall).</doc>
25174 <return-value transfer-ownership="none">
25175 <doc xml:whitespace="preserve">%TRUE if @address is a site-local address.</doc>
25176 <type name="gboolean" c:type="gboolean"/>
25179 <method name="get_native_size"
25180 c:identifier="g_inet_address_get_native_size"
25182 <doc xml:whitespace="preserve">Gets the size of the native raw binary address for @address. This
25183 is the size of the data that you get from g_inet_address_to_bytes().</doc>
25184 <return-value transfer-ownership="none">
25185 <doc xml:whitespace="preserve">the number of bytes used for the native version of @address.</doc>
25186 <type name="gulong" c:type="gsize"/>
25189 <method name="to_bytes"
25190 c:identifier="g_inet_address_to_bytes"
25192 <doc xml:whitespace="preserve">Gets the raw binary address data from @address.
25193 which should not be modified, stored, or freed. The size of this
25194 array can be gotten with g_inet_address_get_native_size().</doc>
25195 <return-value transfer-ownership="none">
25196 <doc xml:whitespace="preserve">a pointer to an internal array of the bytes in @address,</doc>
25197 <type name="guint8" c:type="guint8*"/>
25200 <method name="to_string"
25201 c:identifier="g_inet_address_to_string"
25203 <doc xml:whitespace="preserve">Converts @address to string form.
25204 freed after use.</doc>
25205 <return-value transfer-ownership="full">
25206 <doc xml:whitespace="preserve">a representation of @address as a string, which should be</doc>
25207 <type name="utf8" c:type="gchar*"/>
25210 <property name="bytes"
25213 transfer-ownership="none">
25214 <type name="gpointer"/>
25216 <property name="family"
25219 transfer-ownership="none">
25220 <type name="SocketFamily"/>
25222 <property name="is-any" version="2.22" transfer-ownership="none">
25223 <doc xml:whitespace="preserve">Whether this is the "any" address for its family.
25224 See g_inet_address_get_is_any().</doc>
25225 <type name="gboolean"/>
25227 <property name="is-link-local" version="2.22" transfer-ownership="none">
25228 <doc xml:whitespace="preserve">Whether this is a link-local address.
25229 See g_inet_address_get_is_link_local().</doc>
25230 <type name="gboolean"/>
25232 <property name="is-loopback" version="2.22" transfer-ownership="none">
25233 <doc xml:whitespace="preserve">Whether this is the loopback address for its family.
25234 See g_inet_address_get_is_loopback().</doc>
25235 <type name="gboolean"/>
25237 <property name="is-mc-global" version="2.22" transfer-ownership="none">
25238 <doc xml:whitespace="preserve">Whether this is a global multicast address.
25239 See g_inet_address_get_is_mc_global().</doc>
25240 <type name="gboolean"/>
25242 <property name="is-mc-link-local"
25244 transfer-ownership="none">
25245 <doc xml:whitespace="preserve">Whether this is a link-local multicast address.
25246 See g_inet_address_get_is_mc_link_local().</doc>
25247 <type name="gboolean"/>
25249 <property name="is-mc-node-local"
25251 transfer-ownership="none">
25252 <doc xml:whitespace="preserve">Whether this is a node-local multicast address.
25253 See g_inet_address_get_is_mc_node_local().</doc>
25254 <type name="gboolean"/>
25256 <property name="is-mc-org-local"
25258 transfer-ownership="none">
25259 <doc xml:whitespace="preserve">Whether this is an organization-local multicast address.
25260 See g_inet_address_get_is_mc_org_local().</doc>
25261 <type name="gboolean"/>
25263 <property name="is-mc-site-local"
25265 transfer-ownership="none">
25266 <doc xml:whitespace="preserve">Whether this is a site-local multicast address.
25267 See g_inet_address_get_is_mc_site_local().</doc>
25268 <type name="gboolean"/>
25270 <property name="is-multicast" version="2.22" transfer-ownership="none">
25271 <doc xml:whitespace="preserve">Whether this is a multicast address.
25272 See g_inet_address_get_is_multicast().</doc>
25273 <type name="gboolean"/>
25275 <property name="is-site-local" version="2.22" transfer-ownership="none">
25276 <doc xml:whitespace="preserve">Whether this is a site-local address.
25277 See g_inet_address_get_is_loopback().</doc>
25278 <type name="gboolean"/>
25280 <field name="parent_instance">
25281 <type name="GObject.Object" c:type="GObject"/>
25283 <field name="priv">
25284 <type name="InetAddressPrivate" c:type="GInetAddressPrivate*"/>
25287 <record name="InetAddressClass"
25288 c:type="GInetAddressClass"
25289 glib:is-gtype-struct-for="InetAddress">
25290 <field name="parent_class">
25291 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
25293 <field name="to_string">
25294 <callback name="to_string">
25295 <return-value transfer-ownership="full">
25296 <doc xml:whitespace="preserve">a representation of @address as a string, which should be</doc>
25297 <type name="utf8" c:type="gchar*"/>
25300 <parameter name="address" transfer-ownership="none">
25301 <type name="InetAddress" c:type="GInetAddress*"/>
25306 <field name="to_bytes">
25307 <callback name="to_bytes">
25308 <return-value transfer-ownership="none">
25309 <doc xml:whitespace="preserve">a pointer to an internal array of the bytes in @address,</doc>
25310 <type name="guint8" c:type="guint8*"/>
25313 <parameter name="address" transfer-ownership="none">
25314 <type name="InetAddress" c:type="GInetAddress*"/>
25320 <record name="InetAddressPrivate"
25321 c:type="GInetAddressPrivate"
25324 <class name="InetSocketAddress"
25325 c:symbol-prefix="inet_socket_address"
25326 c:type="GInetSocketAddress"
25327 parent="SocketAddress"
25328 glib:type-name="GInetSocketAddress"
25329 glib:get-type="g_inet_socket_address_get_type"
25330 glib:type-struct="InetSocketAddressClass">
25331 <doc xml:whitespace="preserve">An IPv4 or IPv6 socket address, corresponding to a <type>struct
25332 sockaddr_in</type> or <type>struct sockaddr_in6</type>.</doc>
25333 <implements name="SocketConnectable"/>
25334 <constructor name="new"
25335 c:identifier="g_inet_socket_address_new"
25337 <doc xml:whitespace="preserve">Creates a new #GInetSocketAddress for @address and @port.</doc>
25338 <return-value transfer-ownership="full">
25339 <doc xml:whitespace="preserve">a new #GInetSocketAddress</doc>
25340 <type name="SocketAddress" c:type="GSocketAddress*"/>
25343 <parameter name="address" transfer-ownership="none">
25344 <doc xml:whitespace="preserve">a #GInetAddress</doc>
25345 <type name="InetAddress" c:type="GInetAddress*"/>
25347 <parameter name="port" transfer-ownership="none">
25348 <doc xml:whitespace="preserve">a port number</doc>
25349 <type name="guint16" c:type="guint16"/>
25353 <method name="get_address"
25354 c:identifier="g_inet_socket_address_get_address"
25356 <doc xml:whitespace="preserve">Gets @address's #GInetAddress.
25357 g_object_ref()'d if it will be stored</doc>
25358 <return-value transfer-ownership="full">
25359 <doc xml:whitespace="preserve">the #GInetAddress for @address, which must be</doc>
25360 <type name="InetAddress" c:type="GInetAddress*"/>
25363 <method name="get_port"
25364 c:identifier="g_inet_socket_address_get_port"
25366 <doc xml:whitespace="preserve">Gets @address's port.</doc>
25367 <return-value transfer-ownership="none">
25368 <doc xml:whitespace="preserve">the port for @address</doc>
25369 <type name="guint16" c:type="guint16"/>
25372 <property name="address"
25375 transfer-ownership="none">
25376 <type name="InetAddress"/>
25378 <property name="port"
25381 transfer-ownership="none">
25382 <type name="guint"/>
25384 <field name="parent_instance">
25385 <type name="SocketAddress" c:type="GSocketAddress"/>
25387 <field name="priv">
25388 <type name="InetSocketAddressPrivate"
25389 c:type="GInetSocketAddressPrivate*"/>
25392 <record name="InetSocketAddressClass"
25393 c:type="GInetSocketAddressClass"
25394 glib:is-gtype-struct-for="InetSocketAddress">
25395 <field name="parent_class">
25396 <type name="SocketAddressClass" c:type="GSocketAddressClass"/>
25399 <record name="InetSocketAddressPrivate"
25400 c:type="GInetSocketAddressPrivate"
25403 <interface name="Initable"
25404 c:symbol-prefix="initable"
25407 glib:type-name="GInitable"
25408 glib:get-type="g_initable_get_type"
25409 glib:type-struct="InitableIface">
25410 <doc xml:whitespace="preserve">Interface for initializable objects.</doc>
25411 <virtual-method name="init" invoker="init" version="2.22" throws="1">
25412 <doc xml:whitespace="preserve">Initializes the object implementing the interface. This must be
25413 done before any real use of the object after initial construction.
25414 Implementations may also support cancellation. If @cancellable is not %NULL,
25415 then initialization can be cancelled by triggering the cancellable object
25416 from another thread. If the operation was cancelled, the error
25417 %G_IO_ERROR_CANCELLED will be returned. If @cancellable is not %NULL and
25418 the object doesn't support cancellable initialization the error
25419 %G_IO_ERROR_NOT_SUPPORTED will be returned.
25420 If this function is not called, or returns with an error then all
25421 operations on the object should fail, generally returning the
25422 error %G_IO_ERROR_NOT_INITIALIZED.
25423 Implementations of this method must be idempotent, i.e. multiple calls
25424 to this function with the same argument should return the same results.
25425 Only the first call initializes the object, further calls return the result
25426 of the first call. This is so that its safe to implement the singleton
25427 pattern in the GObject constructor function.
25428 return %FALSE and set @error appropriately if present.</doc>
25429 <return-value transfer-ownership="none">
25430 <doc xml:whitespace="preserve">%TRUE if successful. If an error has occurred, this function will</doc>
25431 <type name="gboolean" c:type="gboolean"/>
25434 <parameter name="cancellable"
25435 transfer-ownership="none"
25437 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25438 <type name="Cancellable" c:type="GCancellable*"/>
25442 <method name="init"
25443 c:identifier="g_initable_init"
25446 <doc xml:whitespace="preserve">Initializes the object implementing the interface. This must be
25447 done before any real use of the object after initial construction.
25448 Implementations may also support cancellation. If @cancellable is not %NULL,
25449 then initialization can be cancelled by triggering the cancellable object
25450 from another thread. If the operation was cancelled, the error
25451 %G_IO_ERROR_CANCELLED will be returned. If @cancellable is not %NULL and
25452 the object doesn't support cancellable initialization the error
25453 %G_IO_ERROR_NOT_SUPPORTED will be returned.
25454 If this function is not called, or returns with an error then all
25455 operations on the object should fail, generally returning the
25456 error %G_IO_ERROR_NOT_INITIALIZED.
25457 Implementations of this method must be idempotent, i.e. multiple calls
25458 to this function with the same argument should return the same results.
25459 Only the first call initializes the object, further calls return the result
25460 of the first call. This is so that its safe to implement the singleton
25461 pattern in the GObject constructor function.
25462 return %FALSE and set @error appropriately if present.</doc>
25463 <return-value transfer-ownership="none">
25464 <doc xml:whitespace="preserve">%TRUE if successful. If an error has occurred, this function will</doc>
25465 <type name="gboolean" c:type="gboolean"/>
25468 <parameter name="cancellable"
25469 transfer-ownership="none"
25471 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25472 <type name="Cancellable" c:type="GCancellable*"/>
25477 <record name="InitableIface"
25478 c:type="GInitableIface"
25479 glib:is-gtype-struct-for="Initable"
25481 <doc xml:whitespace="preserve">Provides an interface for initializing object such that initialization
25483 <field name="g_iface">
25484 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
25486 <field name="init">
25487 <callback name="init" throws="1">
25488 <return-value transfer-ownership="none">
25489 <doc xml:whitespace="preserve">%TRUE if successful. If an error has occurred, this function will</doc>
25490 <type name="gboolean" c:type="gboolean"/>
25493 <parameter name="initable" transfer-ownership="none">
25494 <type name="Initable" c:type="GInitable*"/>
25496 <parameter name="cancellable"
25497 transfer-ownership="none"
25499 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25500 <type name="Cancellable" c:type="GCancellable*"/>
25506 <class name="InputStream"
25507 c:symbol-prefix="input_stream"
25508 c:type="GInputStream"
25509 parent="GObject.Object"
25511 glib:type-name="GInputStream"
25512 glib:get-type="g_input_stream_get_type"
25513 glib:type-struct="InputStreamClass">
25514 <doc xml:whitespace="preserve">Base class for streaming input operations.</doc>
25515 <virtual-method name="close_async" invoker="close_async">
25516 <doc xml:whitespace="preserve">Requests an asynchronous closes of the stream, releasing resources related to it.
25517 When the operation is finished @callback will be called.
25518 You can then call g_input_stream_close_finish() to get the result of the
25520 For behaviour details see g_input_stream_close().
25521 The asyncronous methods have a default fallback that uses threads to implement
25522 asynchronicity, so they are optional for inheriting classes. However, if you
25523 override one you must override all.</doc>
25524 <return-value transfer-ownership="none">
25525 <type name="none" c:type="void"/>
25528 <parameter name="io_priority" transfer-ownership="none">
25529 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
25530 <type name="gint" c:type="int"/>
25532 <parameter name="cancellable"
25533 transfer-ownership="none"
25535 <doc xml:whitespace="preserve">optional cancellable object</doc>
25536 <type name="Cancellable" c:type="GCancellable*"/>
25538 <parameter name="callback"
25539 transfer-ownership="none"
25542 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
25543 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
25545 <parameter name="user_data" transfer-ownership="none" closure="3">
25546 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
25547 <type name="gpointer" c:type="gpointer"/>
25551 <virtual-method name="close_finish" invoker="close_finish" throws="1">
25552 <doc xml:whitespace="preserve">Finishes closing a stream asynchronously, started from g_input_stream_close_async().</doc>
25553 <return-value transfer-ownership="none">
25554 <doc xml:whitespace="preserve">%TRUE if the stream was closed successfully.</doc>
25555 <type name="gboolean" c:type="gboolean"/>
25558 <parameter name="result" transfer-ownership="none">
25559 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
25560 <type name="AsyncResult" c:type="GAsyncResult*"/>
25564 <virtual-method name="close_fn" throws="1">
25565 <return-value transfer-ownership="none">
25566 <type name="gboolean" c:type="gboolean"/>
25569 <parameter name="cancellable" transfer-ownership="none">
25570 <type name="Cancellable" c:type="GCancellable*"/>
25574 <virtual-method name="read_async" invoker="read_async">
25575 <doc xml:whitespace="preserve">Request an asynchronous read of @count bytes from the stream into the buffer
25576 starting at @buffer. When the operation is finished @callback will be called.
25577 You can then call g_input_stream_read_finish() to get the result of the
25579 During an async request no other sync and async calls are allowed on @stream, and will
25580 result in %G_IO_ERROR_PENDING errors.
25581 A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
25582 On success, the number of bytes read into the buffer will be passed to the
25583 callback. It is not an error if this is not the same as the requested size, as it
25584 can happen e.g. near the end of a file, but generally we try to read
25585 as many bytes as requested. Zero is returned on end of file
25586 (or if @count is zero), but never otherwise.
25587 Any outstanding i/o request with higher priority (lower numerical value) will
25588 be executed before an outstanding request with lower priority. Default
25589 priority is %G_PRIORITY_DEFAULT.
25590 The asyncronous methods have a default fallback that uses threads to implement
25591 asynchronicity, so they are optional for inheriting classes. However, if you
25592 override one you must override all.</doc>
25593 <return-value transfer-ownership="none">
25594 <type name="none" c:type="void"/>
25597 <parameter name="buffer" transfer-ownership="none">
25598 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least count bytes long).</doc>
25599 <type name="gpointer" c:type="void*"/>
25601 <parameter name="count" transfer-ownership="none">
25602 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
25603 <type name="gulong" c:type="gsize"/>
25605 <parameter name="io_priority" transfer-ownership="none">
25606 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
25607 <type name="gint" c:type="int"/>
25609 <parameter name="cancellable"
25610 transfer-ownership="none"
25612 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25613 <type name="Cancellable" c:type="GCancellable*"/>
25615 <parameter name="callback"
25616 transfer-ownership="none"
25619 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
25620 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
25622 <parameter name="user_data" transfer-ownership="none" closure="5">
25623 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
25624 <type name="gpointer" c:type="gpointer"/>
25628 <virtual-method name="read_finish" invoker="read_finish" throws="1">
25629 <doc xml:whitespace="preserve">Finishes an asynchronous stream read operation.</doc>
25630 <return-value transfer-ownership="none">
25631 <doc xml:whitespace="preserve">number of bytes read in, or -1 on error.</doc>
25632 <type name="glong" c:type="gssize"/>
25635 <parameter name="result" transfer-ownership="none">
25636 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
25637 <type name="AsyncResult" c:type="GAsyncResult*"/>
25641 <virtual-method name="read_fn" throws="1">
25642 <return-value transfer-ownership="none">
25643 <type name="glong" c:type="gssize"/>
25646 <parameter name="buffer" transfer-ownership="none">
25647 <type name="gpointer" c:type="void*"/>
25649 <parameter name="count" transfer-ownership="none">
25650 <type name="gulong" c:type="gsize"/>
25652 <parameter name="cancellable" transfer-ownership="none">
25653 <type name="Cancellable" c:type="GCancellable*"/>
25657 <virtual-method name="skip" invoker="skip" throws="1">
25658 <doc xml:whitespace="preserve">Tries to skip @count bytes from the stream. Will block during the operation.
25659 This is identical to g_input_stream_read(), from a behaviour standpoint,
25660 but the bytes that are skipped are not returned to the user. Some
25661 streams have an implementation that is more efficient than reading the data.
25662 This function is optional for inherited classes, as the default implementation
25663 emulates it using read.
25664 If @cancellable is not %NULL, then the operation can be cancelled by
25665 triggering the cancellable object from another thread. If the operation
25666 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
25667 operation was partially finished when the operation was cancelled the
25668 partial result will be returned, without an error.</doc>
25669 <return-value transfer-ownership="none">
25670 <doc xml:whitespace="preserve">Number of bytes skipped, or -1 on error</doc>
25671 <type name="glong" c:type="gssize"/>
25674 <parameter name="count" transfer-ownership="none">
25675 <doc xml:whitespace="preserve">the number of bytes that will be skipped from the stream</doc>
25676 <type name="gulong" c:type="gsize"/>
25678 <parameter name="cancellable"
25679 transfer-ownership="none"
25681 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25682 <type name="Cancellable" c:type="GCancellable*"/>
25686 <virtual-method name="skip_async" invoker="skip_async">
25687 <doc xml:whitespace="preserve">Request an asynchronous skip of @count bytes from the stream.
25688 When the operation is finished @callback will be called.
25689 You can then call g_input_stream_skip_finish() to get the result
25691 During an async request no other sync and async calls are allowed,
25692 and will result in %G_IO_ERROR_PENDING errors.
25693 A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
25694 On success, the number of bytes skipped will be passed to the callback.
25695 It is not an error if this is not the same as the requested size, as it
25696 can happen e.g. near the end of a file, but generally we try to skip
25697 as many bytes as requested. Zero is returned on end of file
25698 (or if @count is zero), but never otherwise.
25699 Any outstanding i/o request with higher priority (lower numerical value)
25700 will be executed before an outstanding request with lower priority.
25701 Default priority is %G_PRIORITY_DEFAULT.
25702 The asynchronous methods have a default fallback that uses threads to
25703 implement asynchronicity, so they are optional for inheriting classes.
25704 However, if you override one, you must override all.</doc>
25705 <return-value transfer-ownership="none">
25706 <type name="none" c:type="void"/>
25709 <parameter name="count" transfer-ownership="none">
25710 <doc xml:whitespace="preserve">the number of bytes that will be skipped from the stream</doc>
25711 <type name="gulong" c:type="gsize"/>
25713 <parameter name="io_priority" transfer-ownership="none">
25714 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
25715 <type name="gint" c:type="int"/>
25717 <parameter name="cancellable"
25718 transfer-ownership="none"
25720 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25721 <type name="Cancellable" c:type="GCancellable*"/>
25723 <parameter name="callback"
25724 transfer-ownership="none"
25727 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
25728 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
25730 <parameter name="user_data" transfer-ownership="none" closure="4">
25731 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
25732 <type name="gpointer" c:type="gpointer"/>
25736 <virtual-method name="skip_finish" invoker="skip_finish" throws="1">
25737 <doc xml:whitespace="preserve">Finishes a stream skip operation.</doc>
25738 <return-value transfer-ownership="none">
25739 <doc xml:whitespace="preserve">the size of the bytes skipped, or %-1 on error.</doc>
25740 <type name="glong" c:type="gssize"/>
25743 <parameter name="result" transfer-ownership="none">
25744 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
25745 <type name="AsyncResult" c:type="GAsyncResult*"/>
25749 <method name="clear_pending" c:identifier="g_input_stream_clear_pending">
25750 <doc xml:whitespace="preserve">Clears the pending flag on @stream.</doc>
25751 <return-value transfer-ownership="none">
25752 <type name="none" c:type="void"/>
25755 <method name="close" c:identifier="g_input_stream_close" throws="1">
25756 <doc xml:whitespace="preserve">Closes the stream, releasing resources related to it.
25757 Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
25758 Closing a stream multiple times will not return an error.
25759 Streams will be automatically closed when the last reference
25760 is dropped, but you might want to call this function to make sure
25761 resources are released as early as possible.
25762 Some streams might keep the backing store of the stream (e.g. a file descriptor)
25763 open after the stream is closed. See the documentation for the individual
25764 stream for details.
25765 On failure the first error that happened will be reported, but the close
25766 operation will finish as much as possible. A stream that failed to
25767 close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
25768 is important to check and report the error to the user.
25769 If @cancellable is not NULL, then the operation can be cancelled by
25770 triggering the cancellable object from another thread. If the operation
25771 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
25772 Cancelling a close will still leave the stream closed, but some streams
25773 can use a faster close that doesn't block to e.g. check errors.</doc>
25774 <return-value transfer-ownership="none">
25775 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure</doc>
25776 <type name="gboolean" c:type="gboolean"/>
25779 <parameter name="cancellable"
25780 transfer-ownership="none"
25782 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25783 <type name="Cancellable" c:type="GCancellable*"/>
25787 <method name="close_async" c:identifier="g_input_stream_close_async">
25788 <doc xml:whitespace="preserve">Requests an asynchronous closes of the stream, releasing resources related to it.
25789 When the operation is finished @callback will be called.
25790 You can then call g_input_stream_close_finish() to get the result of the
25792 For behaviour details see g_input_stream_close().
25793 The asyncronous methods have a default fallback that uses threads to implement
25794 asynchronicity, so they are optional for inheriting classes. However, if you
25795 override one you must override all.</doc>
25796 <return-value transfer-ownership="none">
25797 <type name="none" c:type="void"/>
25800 <parameter name="io_priority" transfer-ownership="none">
25801 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
25802 <type name="gint" c:type="int"/>
25804 <parameter name="cancellable"
25805 transfer-ownership="none"
25807 <doc xml:whitespace="preserve">optional cancellable object</doc>
25808 <type name="Cancellable" c:type="GCancellable*"/>
25810 <parameter name="callback"
25811 transfer-ownership="none"
25814 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
25815 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
25817 <parameter name="user_data" transfer-ownership="none">
25818 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
25819 <type name="gpointer" c:type="gpointer"/>
25823 <method name="close_finish"
25824 c:identifier="g_input_stream_close_finish"
25826 <doc xml:whitespace="preserve">Finishes closing a stream asynchronously, started from g_input_stream_close_async().</doc>
25827 <return-value transfer-ownership="none">
25828 <doc xml:whitespace="preserve">%TRUE if the stream was closed successfully.</doc>
25829 <type name="gboolean" c:type="gboolean"/>
25832 <parameter name="result" transfer-ownership="none">
25833 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
25834 <type name="AsyncResult" c:type="GAsyncResult*"/>
25838 <method name="has_pending" c:identifier="g_input_stream_has_pending">
25839 <doc xml:whitespace="preserve">Checks if an input stream has pending actions.</doc>
25840 <return-value transfer-ownership="none">
25841 <doc xml:whitespace="preserve">%TRUE if @stream has pending actions.</doc>
25842 <type name="gboolean" c:type="gboolean"/>
25845 <method name="is_closed" c:identifier="g_input_stream_is_closed">
25846 <doc xml:whitespace="preserve">Checks if an input stream is closed.</doc>
25847 <return-value transfer-ownership="none">
25848 <doc xml:whitespace="preserve">%TRUE if the stream is closed.</doc>
25849 <type name="gboolean" c:type="gboolean"/>
25852 <method name="read" c:identifier="g_input_stream_read" throws="1">
25853 <doc xml:whitespace="preserve">Tries to read @count bytes from the stream into the buffer starting at
25854 If count is zero returns zero and does nothing. A value of @count
25855 larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
25856 On success, the number of bytes read into the buffer is returned.
25857 It is not an error if this is not the same as the requested size, as it
25858 can happen e.g. near the end of a file. Zero is returned on end of file
25859 (or if @count is zero), but never otherwise.
25860 If @cancellable is not NULL, then the operation can be cancelled by
25861 triggering the cancellable object from another thread. If the operation
25862 was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an
25863 operation was partially finished when the operation was cancelled the
25864 partial result will be returned, without an error.
25865 On error -1 is returned and @error is set accordingly.</doc>
25866 <return-value transfer-ownership="none">
25867 <doc xml:whitespace="preserve">Number of bytes read, or -1 on error</doc>
25868 <type name="glong" c:type="gssize"/>
25871 <parameter name="buffer" transfer-ownership="none">
25872 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least count bytes long).</doc>
25873 <type name="gpointer" c:type="void*"/>
25875 <parameter name="count" transfer-ownership="none">
25876 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
25877 <type name="gulong" c:type="gsize"/>
25879 <parameter name="cancellable"
25880 transfer-ownership="none"
25882 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25883 <type name="Cancellable" c:type="GCancellable*"/>
25887 <method name="read_all"
25888 c:identifier="g_input_stream_read_all"
25890 <doc xml:whitespace="preserve">Tries to read @count bytes from the stream into the buffer starting at
25891 This function is similar to g_input_stream_read(), except it tries to
25892 read as many bytes as requested, only stopping on an error or end of stream.
25893 On a successful read of @count bytes, or if we reached the end of the
25894 stream, %TRUE is returned, and @bytes_read is set to the number of bytes
25896 If there is an error during the operation %FALSE is returned and @error
25897 is set to indicate the error status, @bytes_read is updated to contain
25898 the number of bytes read into @buffer before the error occurred.</doc>
25899 <return-value transfer-ownership="none">
25900 <doc xml:whitespace="preserve">%TRUE on success, %FALSE if there was an error</doc>
25901 <type name="gboolean" c:type="gboolean"/>
25904 <parameter name="buffer" transfer-ownership="none">
25905 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least count bytes long).</doc>
25906 <type name="gpointer" c:type="void*"/>
25908 <parameter name="count" transfer-ownership="none">
25909 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
25910 <type name="gulong" c:type="gsize"/>
25912 <parameter name="bytes_read" transfer-ownership="none">
25913 <doc xml:whitespace="preserve">location to store the number of bytes that was read from the stream</doc>
25914 <type name="gulong" c:type="gsize*"/>
25916 <parameter name="cancellable"
25917 transfer-ownership="none"
25919 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25920 <type name="Cancellable" c:type="GCancellable*"/>
25924 <method name="read_async" c:identifier="g_input_stream_read_async">
25925 <doc xml:whitespace="preserve">Request an asynchronous read of @count bytes from the stream into the buffer
25926 starting at @buffer. When the operation is finished @callback will be called.
25927 You can then call g_input_stream_read_finish() to get the result of the
25929 During an async request no other sync and async calls are allowed on @stream, and will
25930 result in %G_IO_ERROR_PENDING errors.
25931 A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
25932 On success, the number of bytes read into the buffer will be passed to the
25933 callback. It is not an error if this is not the same as the requested size, as it
25934 can happen e.g. near the end of a file, but generally we try to read
25935 as many bytes as requested. Zero is returned on end of file
25936 (or if @count is zero), but never otherwise.
25937 Any outstanding i/o request with higher priority (lower numerical value) will
25938 be executed before an outstanding request with lower priority. Default
25939 priority is %G_PRIORITY_DEFAULT.
25940 The asyncronous methods have a default fallback that uses threads to implement
25941 asynchronicity, so they are optional for inheriting classes. However, if you
25942 override one you must override all.</doc>
25943 <return-value transfer-ownership="none">
25944 <type name="none" c:type="void"/>
25947 <parameter name="buffer" transfer-ownership="none">
25948 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least count bytes long).</doc>
25949 <type name="gpointer" c:type="void*"/>
25951 <parameter name="count" transfer-ownership="none">
25952 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
25953 <type name="gulong" c:type="gsize"/>
25955 <parameter name="io_priority" transfer-ownership="none">
25956 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
25957 <type name="gint" c:type="int"/>
25959 <parameter name="cancellable"
25960 transfer-ownership="none"
25962 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
25963 <type name="Cancellable" c:type="GCancellable*"/>
25965 <parameter name="callback"
25966 transfer-ownership="none"
25969 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
25970 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
25972 <parameter name="user_data" transfer-ownership="none">
25973 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
25974 <type name="gpointer" c:type="gpointer"/>
25978 <method name="read_finish"
25979 c:identifier="g_input_stream_read_finish"
25981 <doc xml:whitespace="preserve">Finishes an asynchronous stream read operation.</doc>
25982 <return-value transfer-ownership="none">
25983 <doc xml:whitespace="preserve">number of bytes read in, or -1 on error.</doc>
25984 <type name="glong" c:type="gssize"/>
25987 <parameter name="result" transfer-ownership="none">
25988 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
25989 <type name="AsyncResult" c:type="GAsyncResult*"/>
25993 <method name="set_pending"
25994 c:identifier="g_input_stream_set_pending"
25996 <doc xml:whitespace="preserve">Sets @stream to have actions pending. If the pending flag is
25997 already set or @stream is closed, it will return %FALSE and set</doc>
25998 <return-value transfer-ownership="none">
25999 <doc xml:whitespace="preserve">%TRUE if pending was previously unset and is now set.</doc>
26000 <type name="gboolean" c:type="gboolean"/>
26003 <method name="skip" c:identifier="g_input_stream_skip" throws="1">
26004 <doc xml:whitespace="preserve">Tries to skip @count bytes from the stream. Will block during the operation.
26005 This is identical to g_input_stream_read(), from a behaviour standpoint,
26006 but the bytes that are skipped are not returned to the user. Some
26007 streams have an implementation that is more efficient than reading the data.
26008 This function is optional for inherited classes, as the default implementation
26009 emulates it using read.
26010 If @cancellable is not %NULL, then the operation can be cancelled by
26011 triggering the cancellable object from another thread. If the operation
26012 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
26013 operation was partially finished when the operation was cancelled the
26014 partial result will be returned, without an error.</doc>
26015 <return-value transfer-ownership="none">
26016 <doc xml:whitespace="preserve">Number of bytes skipped, or -1 on error</doc>
26017 <type name="glong" c:type="gssize"/>
26020 <parameter name="count" transfer-ownership="none">
26021 <doc xml:whitespace="preserve">the number of bytes that will be skipped from the stream</doc>
26022 <type name="gulong" c:type="gsize"/>
26024 <parameter name="cancellable"
26025 transfer-ownership="none"
26027 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26028 <type name="Cancellable" c:type="GCancellable*"/>
26032 <method name="skip_async" c:identifier="g_input_stream_skip_async">
26033 <doc xml:whitespace="preserve">Request an asynchronous skip of @count bytes from the stream.
26034 When the operation is finished @callback will be called.
26035 You can then call g_input_stream_skip_finish() to get the result
26037 During an async request no other sync and async calls are allowed,
26038 and will result in %G_IO_ERROR_PENDING errors.
26039 A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
26040 On success, the number of bytes skipped will be passed to the callback.
26041 It is not an error if this is not the same as the requested size, as it
26042 can happen e.g. near the end of a file, but generally we try to skip
26043 as many bytes as requested. Zero is returned on end of file
26044 (or if @count is zero), but never otherwise.
26045 Any outstanding i/o request with higher priority (lower numerical value)
26046 will be executed before an outstanding request with lower priority.
26047 Default priority is %G_PRIORITY_DEFAULT.
26048 The asynchronous methods have a default fallback that uses threads to
26049 implement asynchronicity, so they are optional for inheriting classes.
26050 However, if you override one, you must override all.</doc>
26051 <return-value transfer-ownership="none">
26052 <type name="none" c:type="void"/>
26055 <parameter name="count" transfer-ownership="none">
26056 <doc xml:whitespace="preserve">the number of bytes that will be skipped from the stream</doc>
26057 <type name="gulong" c:type="gsize"/>
26059 <parameter name="io_priority" transfer-ownership="none">
26060 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
26061 <type name="gint" c:type="int"/>
26063 <parameter name="cancellable"
26064 transfer-ownership="none"
26066 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26067 <type name="Cancellable" c:type="GCancellable*"/>
26069 <parameter name="callback"
26070 transfer-ownership="none"
26073 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
26074 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26076 <parameter name="user_data" transfer-ownership="none">
26077 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
26078 <type name="gpointer" c:type="gpointer"/>
26082 <method name="skip_finish"
26083 c:identifier="g_input_stream_skip_finish"
26085 <doc xml:whitespace="preserve">Finishes a stream skip operation.</doc>
26086 <return-value transfer-ownership="none">
26087 <doc xml:whitespace="preserve">the size of the bytes skipped, or %-1 on error.</doc>
26088 <type name="glong" c:type="gssize"/>
26091 <parameter name="result" transfer-ownership="none">
26092 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
26093 <type name="AsyncResult" c:type="GAsyncResult*"/>
26097 <field name="parent_instance">
26098 <type name="GObject.Object" c:type="GObject"/>
26100 <field name="priv">
26101 <type name="InputStreamPrivate" c:type="GInputStreamPrivate*"/>
26104 <record name="InputStreamClass"
26105 c:type="GInputStreamClass"
26106 glib:is-gtype-struct-for="InputStream">
26107 <field name="parent_class">
26108 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
26110 <field name="read_fn">
26111 <callback name="read_fn" throws="1">
26112 <return-value transfer-ownership="none">
26113 <type name="glong" c:type="gssize"/>
26116 <parameter name="stream" transfer-ownership="none">
26117 <type name="InputStream" c:type="GInputStream*"/>
26119 <parameter name="buffer" transfer-ownership="none">
26120 <type name="gpointer" c:type="void*"/>
26122 <parameter name="count" transfer-ownership="none">
26123 <type name="gulong" c:type="gsize"/>
26125 <parameter name="cancellable" transfer-ownership="none">
26126 <type name="Cancellable" c:type="GCancellable*"/>
26131 <field name="skip">
26132 <callback name="skip" throws="1">
26133 <return-value transfer-ownership="none">
26134 <doc xml:whitespace="preserve">Number of bytes skipped, or -1 on error</doc>
26135 <type name="glong" c:type="gssize"/>
26138 <parameter name="stream" transfer-ownership="none">
26139 <type name="InputStream" c:type="GInputStream*"/>
26141 <parameter name="count" transfer-ownership="none">
26142 <doc xml:whitespace="preserve">the number of bytes that will be skipped from the stream</doc>
26143 <type name="gulong" c:type="gsize"/>
26145 <parameter name="cancellable"
26146 transfer-ownership="none"
26148 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26149 <type name="Cancellable" c:type="GCancellable*"/>
26154 <field name="close_fn">
26155 <callback name="close_fn" throws="1">
26156 <return-value transfer-ownership="none">
26157 <type name="gboolean" c:type="gboolean"/>
26160 <parameter name="stream" transfer-ownership="none">
26161 <type name="InputStream" c:type="GInputStream*"/>
26163 <parameter name="cancellable" transfer-ownership="none">
26164 <type name="Cancellable" c:type="GCancellable*"/>
26169 <field name="read_async">
26170 <callback name="read_async">
26171 <return-value transfer-ownership="none">
26172 <type name="none" c:type="void"/>
26175 <parameter name="stream" transfer-ownership="none">
26176 <type name="InputStream" c:type="GInputStream*"/>
26178 <parameter name="buffer" transfer-ownership="none">
26179 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least count bytes long).</doc>
26180 <type name="gpointer" c:type="void*"/>
26182 <parameter name="count" transfer-ownership="none">
26183 <doc xml:whitespace="preserve">the number of bytes that will be read from the stream</doc>
26184 <type name="gulong" c:type="gsize"/>
26186 <parameter name="io_priority" transfer-ownership="none">
26187 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
26188 <type name="gint" c:type="int"/>
26190 <parameter name="cancellable"
26191 transfer-ownership="none"
26193 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26194 <type name="Cancellable" c:type="GCancellable*"/>
26196 <parameter name="callback"
26197 transfer-ownership="none"
26200 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
26201 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26203 <parameter name="user_data" transfer-ownership="none" closure="6">
26204 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
26205 <type name="gpointer" c:type="gpointer"/>
26210 <field name="read_finish">
26211 <callback name="read_finish" throws="1">
26212 <return-value transfer-ownership="none">
26213 <doc xml:whitespace="preserve">number of bytes read in, or -1 on error.</doc>
26214 <type name="glong" c:type="gssize"/>
26217 <parameter name="stream" transfer-ownership="none">
26218 <type name="InputStream" c:type="GInputStream*"/>
26220 <parameter name="result" transfer-ownership="none">
26221 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
26222 <type name="AsyncResult" c:type="GAsyncResult*"/>
26227 <field name="skip_async">
26228 <callback name="skip_async">
26229 <return-value transfer-ownership="none">
26230 <type name="none" c:type="void"/>
26233 <parameter name="stream" transfer-ownership="none">
26234 <type name="InputStream" c:type="GInputStream*"/>
26236 <parameter name="count" transfer-ownership="none">
26237 <doc xml:whitespace="preserve">the number of bytes that will be skipped from the stream</doc>
26238 <type name="gulong" c:type="gsize"/>
26240 <parameter name="io_priority" transfer-ownership="none">
26241 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
26242 <type name="gint" c:type="int"/>
26244 <parameter name="cancellable"
26245 transfer-ownership="none"
26247 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26248 <type name="Cancellable" c:type="GCancellable*"/>
26250 <parameter name="callback"
26251 transfer-ownership="none"
26254 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
26255 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26257 <parameter name="user_data" transfer-ownership="none" closure="5">
26258 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
26259 <type name="gpointer" c:type="gpointer"/>
26264 <field name="skip_finish">
26265 <callback name="skip_finish" throws="1">
26266 <return-value transfer-ownership="none">
26267 <doc xml:whitespace="preserve">the size of the bytes skipped, or %-1 on error.</doc>
26268 <type name="glong" c:type="gssize"/>
26271 <parameter name="stream" transfer-ownership="none">
26272 <type name="InputStream" c:type="GInputStream*"/>
26274 <parameter name="result" transfer-ownership="none">
26275 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
26276 <type name="AsyncResult" c:type="GAsyncResult*"/>
26281 <field name="close_async">
26282 <callback name="close_async">
26283 <return-value transfer-ownership="none">
26284 <type name="none" c:type="void"/>
26287 <parameter name="stream" transfer-ownership="none">
26288 <type name="InputStream" c:type="GInputStream*"/>
26290 <parameter name="io_priority" transfer-ownership="none">
26291 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the request.</doc>
26292 <type name="gint" c:type="int"/>
26294 <parameter name="cancellable"
26295 transfer-ownership="none"
26297 <doc xml:whitespace="preserve">optional cancellable object</doc>
26298 <type name="Cancellable" c:type="GCancellable*"/>
26300 <parameter name="callback"
26301 transfer-ownership="none"
26304 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
26305 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26307 <parameter name="user_data" transfer-ownership="none" closure="4">
26308 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
26309 <type name="gpointer" c:type="gpointer"/>
26314 <field name="close_finish">
26315 <callback name="close_finish" throws="1">
26316 <return-value transfer-ownership="none">
26317 <doc xml:whitespace="preserve">%TRUE if the stream was closed successfully.</doc>
26318 <type name="gboolean" c:type="gboolean"/>
26321 <parameter name="stream" transfer-ownership="none">
26322 <type name="InputStream" c:type="GInputStream*"/>
26324 <parameter name="result" transfer-ownership="none">
26325 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
26326 <type name="AsyncResult" c:type="GAsyncResult*"/>
26331 <field name="_g_reserved1" introspectable="0">
26332 <callback name="_g_reserved1">
26333 <return-value transfer-ownership="none">
26334 <type name="none" c:type="void"/>
26338 <field name="_g_reserved2" introspectable="0">
26339 <callback name="_g_reserved2">
26340 <return-value transfer-ownership="none">
26341 <type name="none" c:type="void"/>
26345 <field name="_g_reserved3" introspectable="0">
26346 <callback name="_g_reserved3">
26347 <return-value transfer-ownership="none">
26348 <type name="none" c:type="void"/>
26352 <field name="_g_reserved4" introspectable="0">
26353 <callback name="_g_reserved4">
26354 <return-value transfer-ownership="none">
26355 <type name="none" c:type="void"/>
26359 <field name="_g_reserved5" introspectable="0">
26360 <callback name="_g_reserved5">
26361 <return-value transfer-ownership="none">
26362 <type name="none" c:type="void"/>
26367 <record name="InputStreamPrivate"
26368 c:type="GInputStreamPrivate"
26371 <record name="InputVector" c:type="GInputVector" version="2.22">
26372 <doc xml:whitespace="preserve">Structure used for scatter/gather data input.
26373 You generally pass in an array of #GInputVector<!-- -->s
26374 and the operation will store the read data starting in the
26375 first buffer, switching to the next as needed.</doc>
26376 <field name="buffer" writable="1">
26377 <type name="gpointer" c:type="gpointer"/>
26379 <field name="size" writable="1">
26380 <type name="gulong" c:type="gsize"/>
26383 <interface name="LoadableIcon"
26384 c:symbol-prefix="loadable_icon"
26385 c:type="GLoadableIcon"
26386 glib:type-name="GLoadableIcon"
26387 glib:get-type="g_loadable_icon_get_type"
26388 glib:type-struct="LoadableIconIface">
26389 <doc xml:whitespace="preserve">Generic type for all kinds of icons that can be loaded
26391 <prerequisite name="Icon"/>
26392 <virtual-method name="load" invoker="load" throws="1">
26393 <doc xml:whitespace="preserve">Loads a loadable icon. For the asynchronous version of this function,
26394 see g_loadable_icon_load_async().</doc>
26395 <return-value transfer-ownership="full">
26396 <doc xml:whitespace="preserve">a #GInputStream to read the icon from.</doc>
26397 <type name="InputStream" c:type="GInputStream*"/>
26400 <parameter name="size" transfer-ownership="none">
26401 <doc xml:whitespace="preserve">an integer.</doc>
26402 <type name="gint" c:type="int"/>
26404 <parameter name="type" transfer-ownership="none">
26405 <doc xml:whitespace="preserve">a location to store the type of the loaded icon, %NULL to ignore.</doc>
26406 <type name="utf8" c:type="char**"/>
26408 <parameter name="cancellable"
26409 transfer-ownership="none"
26411 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26412 <type name="Cancellable" c:type="GCancellable*"/>
26416 <virtual-method name="load_async" invoker="load_async">
26417 <doc xml:whitespace="preserve">Loads an icon asynchronously. To finish this function, see
26418 g_loadable_icon_load_finish(). For the synchronous, blocking
26419 version of this function, see g_loadable_icon_load().</doc>
26420 <return-value transfer-ownership="none">
26421 <type name="none" c:type="void"/>
26424 <parameter name="size" transfer-ownership="none">
26425 <doc xml:whitespace="preserve">an integer.</doc>
26426 <type name="gint" c:type="int"/>
26428 <parameter name="cancellable"
26429 transfer-ownership="none"
26431 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26432 <type name="Cancellable" c:type="GCancellable*"/>
26434 <parameter name="callback"
26435 transfer-ownership="none"
26438 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
26439 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26441 <parameter name="user_data" transfer-ownership="none" closure="3">
26442 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
26443 <type name="gpointer" c:type="gpointer"/>
26447 <virtual-method name="load_finish" invoker="load_finish" throws="1">
26448 <doc xml:whitespace="preserve">Finishes an asynchronous icon load started in g_loadable_icon_load_async().</doc>
26449 <return-value transfer-ownership="full">
26450 <doc xml:whitespace="preserve">a #GInputStream to read the icon from.</doc>
26451 <type name="InputStream" c:type="GInputStream*"/>
26454 <parameter name="res" transfer-ownership="none">
26455 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
26456 <type name="AsyncResult" c:type="GAsyncResult*"/>
26458 <parameter name="type" transfer-ownership="none">
26459 <doc xml:whitespace="preserve">a location to store the type of the loaded icon, %NULL to ignore.</doc>
26460 <type name="utf8" c:type="char**"/>
26464 <method name="load" c:identifier="g_loadable_icon_load" throws="1">
26465 <doc xml:whitespace="preserve">Loads a loadable icon. For the asynchronous version of this function,
26466 see g_loadable_icon_load_async().</doc>
26467 <return-value transfer-ownership="full">
26468 <doc xml:whitespace="preserve">a #GInputStream to read the icon from.</doc>
26469 <type name="InputStream" c:type="GInputStream*"/>
26472 <parameter name="size" transfer-ownership="none">
26473 <doc xml:whitespace="preserve">an integer.</doc>
26474 <type name="gint" c:type="int"/>
26476 <parameter name="type" transfer-ownership="none">
26477 <doc xml:whitespace="preserve">a location to store the type of the loaded icon, %NULL to ignore.</doc>
26478 <type name="utf8" c:type="char**"/>
26480 <parameter name="cancellable"
26481 transfer-ownership="none"
26483 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26484 <type name="Cancellable" c:type="GCancellable*"/>
26488 <method name="load_async" c:identifier="g_loadable_icon_load_async">
26489 <doc xml:whitespace="preserve">Loads an icon asynchronously. To finish this function, see
26490 g_loadable_icon_load_finish(). For the synchronous, blocking
26491 version of this function, see g_loadable_icon_load().</doc>
26492 <return-value transfer-ownership="none">
26493 <type name="none" c:type="void"/>
26496 <parameter name="size" transfer-ownership="none">
26497 <doc xml:whitespace="preserve">an integer.</doc>
26498 <type name="gint" c:type="int"/>
26500 <parameter name="cancellable"
26501 transfer-ownership="none"
26503 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26504 <type name="Cancellable" c:type="GCancellable*"/>
26506 <parameter name="callback"
26507 transfer-ownership="none"
26510 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
26511 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26513 <parameter name="user_data" transfer-ownership="none">
26514 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
26515 <type name="gpointer" c:type="gpointer"/>
26519 <method name="load_finish"
26520 c:identifier="g_loadable_icon_load_finish"
26522 <doc xml:whitespace="preserve">Finishes an asynchronous icon load started in g_loadable_icon_load_async().</doc>
26523 <return-value transfer-ownership="full">
26524 <doc xml:whitespace="preserve">a #GInputStream to read the icon from.</doc>
26525 <type name="InputStream" c:type="GInputStream*"/>
26528 <parameter name="res" transfer-ownership="none">
26529 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
26530 <type name="AsyncResult" c:type="GAsyncResult*"/>
26532 <parameter name="type" transfer-ownership="none">
26533 <doc xml:whitespace="preserve">a location to store the type of the loaded icon, %NULL to ignore.</doc>
26534 <type name="utf8" c:type="char**"/>
26539 <record name="LoadableIconIface"
26540 c:type="GLoadableIconIface"
26541 glib:is-gtype-struct-for="LoadableIcon">
26542 <doc xml:whitespace="preserve">Interface for icons that can be loaded as a stream.</doc>
26543 <field name="g_iface">
26544 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
26546 <field name="load">
26547 <callback name="load" throws="1">
26548 <return-value transfer-ownership="full">
26549 <doc xml:whitespace="preserve">a #GInputStream to read the icon from.</doc>
26550 <type name="InputStream" c:type="GInputStream*"/>
26553 <parameter name="icon" transfer-ownership="none">
26554 <type name="LoadableIcon" c:type="GLoadableIcon*"/>
26556 <parameter name="size" transfer-ownership="none">
26557 <doc xml:whitespace="preserve">an integer.</doc>
26558 <type name="gint" c:type="int"/>
26560 <parameter name="type" transfer-ownership="none">
26561 <doc xml:whitespace="preserve">a location to store the type of the loaded icon, %NULL to ignore.</doc>
26562 <type name="utf8" c:type="char**"/>
26564 <parameter name="cancellable"
26565 transfer-ownership="none"
26567 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26568 <type name="Cancellable" c:type="GCancellable*"/>
26573 <field name="load_async">
26574 <callback name="load_async">
26575 <return-value transfer-ownership="none">
26576 <type name="none" c:type="void"/>
26579 <parameter name="icon" transfer-ownership="none">
26580 <type name="LoadableIcon" c:type="GLoadableIcon*"/>
26582 <parameter name="size" transfer-ownership="none">
26583 <doc xml:whitespace="preserve">an integer.</doc>
26584 <type name="gint" c:type="int"/>
26586 <parameter name="cancellable"
26587 transfer-ownership="none"
26589 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26590 <type name="Cancellable" c:type="GCancellable*"/>
26592 <parameter name="callback"
26593 transfer-ownership="none"
26596 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
26597 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26599 <parameter name="user_data" transfer-ownership="none" closure="4">
26600 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
26601 <type name="gpointer" c:type="gpointer"/>
26606 <field name="load_finish">
26607 <callback name="load_finish" throws="1">
26608 <return-value transfer-ownership="full">
26609 <doc xml:whitespace="preserve">a #GInputStream to read the icon from.</doc>
26610 <type name="InputStream" c:type="GInputStream*"/>
26613 <parameter name="icon" transfer-ownership="none">
26614 <type name="LoadableIcon" c:type="GLoadableIcon*"/>
26616 <parameter name="res" transfer-ownership="none">
26617 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
26618 <type name="AsyncResult" c:type="GAsyncResult*"/>
26620 <parameter name="type" transfer-ownership="none">
26621 <doc xml:whitespace="preserve">a location to store the type of the loaded icon, %NULL to ignore.</doc>
26622 <type name="utf8" c:type="char**"/>
26628 <class name="MemoryInputStream"
26629 c:symbol-prefix="memory_input_stream"
26630 c:type="GMemoryInputStream"
26631 parent="InputStream"
26632 glib:type-name="GMemoryInputStream"
26633 glib:get-type="g_memory_input_stream_get_type"
26634 glib:type-struct="MemoryInputStreamClass">
26635 <doc xml:whitespace="preserve">Implements #GInputStream for arbitrary memory chunks.</doc>
26636 <implements name="Seekable"/>
26637 <constructor name="new" c:identifier="g_memory_input_stream_new">
26638 <doc xml:whitespace="preserve">Creates a new empty #GMemoryInputStream.</doc>
26639 <return-value transfer-ownership="full">
26640 <doc xml:whitespace="preserve">a new #GInputStream</doc>
26641 <type name="InputStream" c:type="GInputStream*"/>
26644 <constructor name="new_from_data"
26645 c:identifier="g_memory_input_stream_new_from_data">
26646 <doc xml:whitespace="preserve">Creates a new #GMemoryInputStream with data in memory of a given size.</doc>
26647 <return-value transfer-ownership="full">
26648 <doc xml:whitespace="preserve">new #GInputStream read from @data of @len bytes.</doc>
26649 <type name="InputStream" c:type="GInputStream*"/>
26652 <parameter name="data" transfer-ownership="none">
26653 <doc xml:whitespace="preserve">input data</doc>
26654 <type name="gpointer" c:type="void*"/>
26656 <parameter name="len" transfer-ownership="none">
26657 <doc xml:whitespace="preserve">length of the data, may be -1 if @data is a nul-terminated string</doc>
26658 <type name="glong" c:type="gssize"/>
26660 <parameter name="destroy" transfer-ownership="none" scope="async">
26661 <doc xml:whitespace="preserve">function that is called to free @data, or %NULL</doc>
26662 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
26666 <method name="add_data" c:identifier="g_memory_input_stream_add_data">
26667 <doc xml:whitespace="preserve">Appends @data to data that can be read from the input stream</doc>
26668 <return-value transfer-ownership="none">
26669 <type name="none" c:type="void"/>
26672 <parameter name="data" transfer-ownership="none">
26673 <doc xml:whitespace="preserve">input data</doc>
26674 <type name="gpointer" c:type="void*"/>
26676 <parameter name="len" transfer-ownership="none">
26677 <doc xml:whitespace="preserve">length of the data, may be -1 if @data is a nul-terminated string</doc>
26678 <type name="glong" c:type="gssize"/>
26680 <parameter name="destroy" transfer-ownership="none" scope="async">
26681 <doc xml:whitespace="preserve">function that is called to free @data, or %NULL</doc>
26682 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
26686 <field name="parent_instance">
26687 <type name="InputStream" c:type="GInputStream"/>
26689 <field name="priv">
26690 <type name="MemoryInputStreamPrivate"
26691 c:type="GMemoryInputStreamPrivate*"/>
26694 <record name="MemoryInputStreamClass"
26695 c:type="GMemoryInputStreamClass"
26696 glib:is-gtype-struct-for="MemoryInputStream">
26697 <field name="parent_class">
26698 <type name="InputStreamClass" c:type="GInputStreamClass"/>
26700 <field name="_g_reserved1" introspectable="0">
26701 <callback name="_g_reserved1">
26702 <return-value transfer-ownership="none">
26703 <type name="none" c:type="void"/>
26707 <field name="_g_reserved2" introspectable="0">
26708 <callback name="_g_reserved2">
26709 <return-value transfer-ownership="none">
26710 <type name="none" c:type="void"/>
26714 <field name="_g_reserved3" introspectable="0">
26715 <callback name="_g_reserved3">
26716 <return-value transfer-ownership="none">
26717 <type name="none" c:type="void"/>
26721 <field name="_g_reserved4" introspectable="0">
26722 <callback name="_g_reserved4">
26723 <return-value transfer-ownership="none">
26724 <type name="none" c:type="void"/>
26728 <field name="_g_reserved5" introspectable="0">
26729 <callback name="_g_reserved5">
26730 <return-value transfer-ownership="none">
26731 <type name="none" c:type="void"/>
26736 <record name="MemoryInputStreamPrivate"
26737 c:type="GMemoryInputStreamPrivate"
26740 <class name="MemoryOutputStream"
26741 c:symbol-prefix="memory_output_stream"
26742 c:type="GMemoryOutputStream"
26743 parent="OutputStream"
26744 glib:type-name="GMemoryOutputStream"
26745 glib:get-type="g_memory_output_stream_get_type"
26746 glib:type-struct="MemoryOutputStreamClass">
26747 <doc xml:whitespace="preserve">Implements #GOutputStream for arbitrary memory chunks.</doc>
26748 <implements name="Seekable"/>
26749 <constructor name="new"
26750 c:identifier="g_memory_output_stream_new"
26751 introspectable="0">
26752 <doc xml:whitespace="preserve">Creates a new #GMemoryOutputStream.
26753 If @data is non-%NULL, the stream will use that for its internal storage.
26754 If @realloc_fn is non-%NULL, it will be used for resizing the internal
26755 storage when necessary. To construct a fixed-size output stream,
26756 pass %NULL as @realloc_fn.
26758 /&ast; a stream that can grow &ast;/
26759 stream = g_memory_output_stream_new (NULL, 0, realloc, free);
26760 /&ast; another stream that can grow &ast;/
26761 stream2 = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
26762 /&ast; a fixed-size stream &ast;/
26763 data = malloc (200);
26764 stream3 = g_memory_output_stream_new (data, 200, NULL, free);
26766 <return-value transfer-ownership="full">
26767 <doc xml:whitespace="preserve">A newly created #GMemoryOutputStream object.</doc>
26768 <type name="OutputStream" c:type="GOutputStream*"/>
26771 <parameter name="data" transfer-ownership="none">
26772 <doc xml:whitespace="preserve">pointer to a chunk of memory to use, or %NULL</doc>
26773 <type name="gpointer" c:type="gpointer"/>
26775 <parameter name="size" transfer-ownership="none">
26776 <doc xml:whitespace="preserve">the size of @data</doc>
26777 <type name="gulong" c:type="gsize"/>
26779 <parameter name="realloc_function"
26780 transfer-ownership="none"
26783 <doc xml:whitespace="preserve">a function with realloc() semantics (like g_realloc()) to be called when @data needs to be grown, or %NULL</doc>
26784 <type name="ReallocFunc" c:type="GReallocFunc"/>
26786 <parameter name="destroy_function"
26787 transfer-ownership="none"
26789 <doc xml:whitespace="preserve">a function to be called on @data when the stream is finalized, or %NULL</doc>
26790 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
26794 <method name="get_data"
26795 c:identifier="g_memory_output_stream_get_data"
26796 introspectable="0">
26797 <doc xml:whitespace="preserve">Gets any loaded data from the @ostream.
26798 Note that the returned pointer may become invalid on the next
26799 write or truncate operation on the stream.</doc>
26801 <doc xml:whitespace="preserve">pointer to the stream's data</doc>
26802 <type name="gpointer" c:type="gpointer"/>
26805 <method name="get_data_size"
26806 c:identifier="g_memory_output_stream_get_data_size"
26808 <doc xml:whitespace="preserve">Returns the number of bytes from the start up
26809 to including the last byte written in the stream
26810 that has not been truncated away.</doc>
26811 <return-value transfer-ownership="none">
26812 <doc xml:whitespace="preserve">the number of bytes written to the stream</doc>
26813 <type name="gulong" c:type="gsize"/>
26816 <method name="get_size" c:identifier="g_memory_output_stream_get_size">
26817 <doc xml:whitespace="preserve">Gets the size of the currently allocated data area (availible from
26818 g_memory_output_stream_get_data()). If the stream isn't
26819 growable (no realloc was passed to g_memory_output_stream_new()) then
26820 this is the maximum size of the stream and further writes
26821 will return %G_IO_ERROR_NO_SPACE.
26822 Note that for growable streams the returned size may become invalid on
26823 the next write or truncate operation on the stream.
26824 If you want the number of bytes currently written to the stream, use
26825 g_memory_output_stream_get_data_size().</doc>
26826 <return-value transfer-ownership="none">
26827 <doc xml:whitespace="preserve">the number of bytes allocated for the data buffer</doc>
26828 <type name="gulong" c:type="gsize"/>
26831 <method name="steal_data"
26832 c:identifier="g_memory_output_stream_steal_data"
26834 <doc xml:whitespace="preserve">Gets any loaded data from the @ostream. Ownership of the data
26835 is transferred to the caller; when no longer needed it must be
26836 freed using the free function set in @ostream's
26837 #GMemoryOutputStream:destroy-function property.</doc>
26838 <return-value transfer-ownership="full">
26839 <doc xml:whitespace="preserve">the stream's data</doc>
26840 <type name="gpointer" c:type="gpointer"/>
26843 <property name="data"
26847 transfer-ownership="none">
26848 <doc xml:whitespace="preserve">Pointer to buffer where data will be written.</doc>
26849 <type name="gpointer"/>
26851 <property name="data-size" version="2.24" transfer-ownership="none">
26852 <doc xml:whitespace="preserve">Size of data written to the buffer.</doc>
26853 <type name="gulong"/>
26855 <property name="destroy-function"
26859 transfer-ownership="none">
26860 <doc xml:whitespace="preserve">Function called with the buffer as argument when the stream is destroyed.</doc>
26861 <type name="gpointer"/>
26863 <property name="realloc-function"
26867 transfer-ownership="none">
26868 <doc xml:whitespace="preserve">Function with realloc semantics called to enlarge the buffer.</doc>
26869 <type name="gpointer"/>
26871 <property name="size"
26875 transfer-ownership="none">
26876 <doc xml:whitespace="preserve">Current size of the data buffer.</doc>
26877 <type name="gulong"/>
26879 <field name="parent_instance">
26880 <type name="OutputStream" c:type="GOutputStream"/>
26882 <field name="priv">
26883 <type name="MemoryOutputStreamPrivate"
26884 c:type="GMemoryOutputStreamPrivate*"/>
26887 <record name="MemoryOutputStreamClass"
26888 c:type="GMemoryOutputStreamClass"
26889 glib:is-gtype-struct-for="MemoryOutputStream">
26890 <field name="parent_class">
26891 <type name="OutputStreamClass" c:type="GOutputStreamClass"/>
26893 <field name="_g_reserved1" introspectable="0">
26894 <callback name="_g_reserved1">
26895 <return-value transfer-ownership="none">
26896 <type name="none" c:type="void"/>
26900 <field name="_g_reserved2" introspectable="0">
26901 <callback name="_g_reserved2">
26902 <return-value transfer-ownership="none">
26903 <type name="none" c:type="void"/>
26907 <field name="_g_reserved3" introspectable="0">
26908 <callback name="_g_reserved3">
26909 <return-value transfer-ownership="none">
26910 <type name="none" c:type="void"/>
26914 <field name="_g_reserved4" introspectable="0">
26915 <callback name="_g_reserved4">
26916 <return-value transfer-ownership="none">
26917 <type name="none" c:type="void"/>
26921 <field name="_g_reserved5" introspectable="0">
26922 <callback name="_g_reserved5">
26923 <return-value transfer-ownership="none">
26924 <type name="none" c:type="void"/>
26929 <record name="MemoryOutputStreamPrivate"
26930 c:type="GMemoryOutputStreamPrivate"
26933 <interface name="Mount"
26934 c:symbol-prefix="mount"
26936 glib:type-name="GMount"
26937 glib:get-type="g_mount_get_type"
26938 glib:type-struct="MountIface">
26939 <doc xml:whitespace="preserve">A handle to an object implementing the #GMountIface interface.</doc>
26940 <virtual-method name="can_eject" invoker="can_eject">
26941 <doc xml:whitespace="preserve">Checks if @mount can be eject.</doc>
26942 <return-value transfer-ownership="none">
26943 <doc xml:whitespace="preserve">%TRUE if the @mount can be ejected.</doc>
26944 <type name="gboolean" c:type="gboolean"/>
26947 <virtual-method name="can_unmount" invoker="can_unmount">
26948 <doc xml:whitespace="preserve">Checks if @mount can be mounted.</doc>
26949 <return-value transfer-ownership="none">
26950 <doc xml:whitespace="preserve">%TRUE if the @mount can be unmounted.</doc>
26951 <type name="gboolean" c:type="gboolean"/>
26954 <virtual-method name="eject"
26956 deprecated="Use g_mount_eject_with_operation() instead."
26957 deprecated-version="2.22">
26958 <doc xml:whitespace="preserve">Ejects a mount. This is an asynchronous operation, and is
26959 finished by calling g_mount_eject_finish() with the @mount
26960 and #GAsyncResult data returned in the @callback.</doc>
26961 <return-value transfer-ownership="none">
26962 <type name="none" c:type="void"/>
26965 <parameter name="flags" transfer-ownership="none">
26966 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
26967 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
26969 <parameter name="cancellable"
26970 transfer-ownership="none"
26972 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
26973 <type name="Cancellable" c:type="GCancellable*"/>
26975 <parameter name="callback"
26976 transfer-ownership="none"
26979 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
26980 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
26982 <parameter name="user_data" transfer-ownership="none" closure="3">
26983 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
26984 <type name="gpointer" c:type="gpointer"/>
26988 <virtual-method name="eject_finish"
26989 invoker="eject_finish"
26990 deprecated="Use g_mount_eject_with_operation_finish() instead."
26991 deprecated-version="2.22"
26993 <doc xml:whitespace="preserve">Finishes ejecting a mount. If any errors occurred during the operation,</doc>
26994 <return-value transfer-ownership="none">
26995 <doc xml:whitespace="preserve">%TRUE if the mount was successfully ejected. %FALSE otherwise.</doc>
26996 <type name="gboolean" c:type="gboolean"/>
26999 <parameter name="result" transfer-ownership="none">
27000 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27001 <type name="AsyncResult" c:type="GAsyncResult*"/>
27005 <virtual-method name="eject_with_operation"
27006 invoker="eject_with_operation"
27008 <doc xml:whitespace="preserve">Ejects a mount. This is an asynchronous operation, and is
27009 finished by calling g_mount_eject_with_operation_finish() with the @mount
27010 and #GAsyncResult data returned in the @callback.</doc>
27011 <return-value transfer-ownership="none">
27012 <type name="none" c:type="void"/>
27015 <parameter name="flags" transfer-ownership="none">
27016 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
27017 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
27019 <parameter name="mount_operation" transfer-ownership="none">
27020 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
27021 <type name="MountOperation" c:type="GMountOperation*"/>
27023 <parameter name="cancellable"
27024 transfer-ownership="none"
27026 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27027 <type name="Cancellable" c:type="GCancellable*"/>
27029 <parameter name="callback"
27030 transfer-ownership="none"
27033 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27034 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27036 <parameter name="user_data" transfer-ownership="none" closure="4">
27037 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27038 <type name="gpointer" c:type="gpointer"/>
27042 <virtual-method name="eject_with_operation_finish"
27043 invoker="eject_with_operation_finish"
27046 <doc xml:whitespace="preserve">Finishes ejecting a mount. If any errors occurred during the operation,</doc>
27047 <return-value transfer-ownership="none">
27048 <doc xml:whitespace="preserve">%TRUE if the mount was successfully ejected. %FALSE otherwise.</doc>
27049 <type name="gboolean" c:type="gboolean"/>
27052 <parameter name="result" transfer-ownership="none">
27053 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27054 <type name="AsyncResult" c:type="GAsyncResult*"/>
27058 <virtual-method name="get_default_location"
27059 invoker="get_default_location">
27060 <doc xml:whitespace="preserve">Gets the default location of @mount. The default location of the given
27061 the home directory, or the root of the volume).
27062 The returned object should be unreffed with
27063 g_object_unref() when no longer needed.</doc>
27064 <return-value transfer-ownership="full">
27065 <doc xml:whitespace="preserve">a #GFile.</doc>
27066 <type name="File" c:type="GFile*"/>
27069 <virtual-method name="get_drive" invoker="get_drive">
27070 <doc xml:whitespace="preserve">Gets the drive for the @mount.
27071 This is a convenience method for getting the #GVolume and then
27072 using that object to get the #GDrive.
27073 The returned object should be unreffed with
27074 g_object_unref() when no longer needed.</doc>
27075 <return-value transfer-ownership="full">
27076 <doc xml:whitespace="preserve">a #GDrive or %NULL if @mount is not associated with a volume or a drive.</doc>
27077 <type name="Drive" c:type="GDrive*"/>
27080 <virtual-method name="get_icon" invoker="get_icon">
27081 <doc xml:whitespace="preserve">Gets the icon for @mount.
27082 The returned object should be unreffed with
27083 g_object_unref() when no longer needed.</doc>
27084 <return-value transfer-ownership="full">
27085 <doc xml:whitespace="preserve">a #GIcon.</doc>
27086 <type name="Icon" c:type="GIcon*"/>
27089 <virtual-method name="get_name" invoker="get_name">
27090 <doc xml:whitespace="preserve">Gets the name of @mount.
27091 The returned string should be freed with g_free()
27092 when no longer needed.</doc>
27093 <return-value transfer-ownership="full">
27094 <doc xml:whitespace="preserve">the name for the given @mount.</doc>
27095 <type name="utf8" c:type="char*"/>
27098 <virtual-method name="get_root" invoker="get_root">
27099 <doc xml:whitespace="preserve">Gets the root directory on @mount.
27100 The returned object should be unreffed with
27101 g_object_unref() when no longer needed.</doc>
27102 <return-value transfer-ownership="full">
27103 <doc xml:whitespace="preserve">a #GFile.</doc>
27104 <type name="File" c:type="GFile*"/>
27107 <virtual-method name="get_uuid" invoker="get_uuid">
27108 <doc xml:whitespace="preserve">Gets the UUID for the @mount. The reference is typically based on
27109 the file system UUID for the mount in question and should be
27110 considered an opaque string. Returns %NULL if there is no UUID
27112 The returned string should be freed with g_free()
27113 when no longer needed.</doc>
27114 <return-value transfer-ownership="full">
27115 <doc xml:whitespace="preserve">the UUID for @mount or %NULL if no UUID can be computed.</doc>
27116 <type name="utf8" c:type="char*"/>
27119 <virtual-method name="get_volume" invoker="get_volume">
27120 <doc xml:whitespace="preserve">Gets the volume for the @mount.
27121 The returned object should be unreffed with
27122 g_object_unref() when no longer needed.</doc>
27123 <return-value transfer-ownership="full">
27124 <doc xml:whitespace="preserve">a #GVolume or %NULL if @mount is not associated with a volume.</doc>
27125 <type name="Volume" c:type="GVolume*"/>
27128 <virtual-method name="guess_content_type"
27129 invoker="guess_content_type"
27131 <doc xml:whitespace="preserve">Tries to guess the type of content stored on @mount. Returns one or
27132 more textual identifiers of well-known content types (typically
27133 prefixed with "x-content/"), e.g. x-content/image-dcf for camera
27134 memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
27135 specification for more on x-content types.
27136 This is an asynchronous operation (see
27137 g_mount_guess_content_type_sync() for the synchronous version), and
27138 is finished by calling g_mount_guess_content_type_finish() with the</doc>
27139 <return-value transfer-ownership="none">
27140 <type name="none" c:type="void"/>
27143 <parameter name="force_rescan" transfer-ownership="none">
27144 <doc xml:whitespace="preserve">Whether to force a rescan of the content. Otherwise a cached result will be used if available</doc>
27145 <type name="gboolean" c:type="gboolean"/>
27147 <parameter name="cancellable"
27148 transfer-ownership="none"
27150 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
27151 <type name="Cancellable" c:type="GCancellable*"/>
27153 <parameter name="callback"
27154 transfer-ownership="none"
27157 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
27158 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27160 <parameter name="user_data" transfer-ownership="none" closure="3">
27161 <doc xml:whitespace="preserve">user data passed to @callback</doc>
27162 <type name="gpointer" c:type="gpointer"/>
27166 <virtual-method name="guess_content_type_finish"
27167 invoker="guess_content_type_finish"
27170 <doc xml:whitespace="preserve">Finishes guessing content types of @mount. If any errors occured
27171 during the operation, @error will be set to contain the errors and
27172 %FALSE will be returned. In particular, you may get an
27173 %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content
27175 Caller should free this array with g_strfreev() when done with it.</doc>
27176 <return-value transfer-ownership="full">
27177 <doc xml:whitespace="preserve">a %NULL-terminated array of content types or %NULL on error.</doc>
27178 <array c:type="gchar**">
27179 <type name="utf8"/>
27183 <parameter name="result" transfer-ownership="none">
27184 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
27185 <type name="AsyncResult" c:type="GAsyncResult*"/>
27189 <virtual-method name="guess_content_type_sync"
27190 invoker="guess_content_type_sync"
27193 <doc xml:whitespace="preserve">Tries to guess the type of content stored on @mount. Returns one or
27194 more textual identifiers of well-known content types (typically
27195 prefixed with "x-content/"), e.g. x-content/image-dcf for camera
27196 memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
27197 specification for more on x-content types.
27198 This is an synchronous operation and as such may block doing IO;
27199 see g_mount_guess_content_type() for the asynchronous version.
27200 Caller should free this array with g_strfreev() when done with it.</doc>
27201 <return-value transfer-ownership="full">
27202 <doc xml:whitespace="preserve">a %NULL-terminated array of content types or %NULL on error.</doc>
27203 <array c:type="gchar**">
27204 <type name="utf8"/>
27208 <parameter name="force_rescan" transfer-ownership="none">
27209 <doc xml:whitespace="preserve">Whether to force a rescan of the content. Otherwise a cached result will be used if available</doc>
27210 <type name="gboolean" c:type="gboolean"/>
27212 <parameter name="cancellable"
27213 transfer-ownership="none"
27215 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
27216 <type name="Cancellable" c:type="GCancellable*"/>
27220 <virtual-method name="remount" invoker="remount">
27221 <doc xml:whitespace="preserve">Remounts a mount. This is an asynchronous operation, and is
27222 finished by calling g_mount_remount_finish() with the @mount
27223 and #GAsyncResults data returned in the @callback.
27224 Remounting is useful when some setting affecting the operation
27225 of the volume has been changed, as these may need a remount to
27226 take affect. While this is semantically equivalent with unmounting
27227 and then remounting not all backends might need to actually be
27229 <return-value transfer-ownership="none">
27230 <type name="none" c:type="void"/>
27233 <parameter name="flags" transfer-ownership="none">
27234 <doc xml:whitespace="preserve">flags affecting the operation</doc>
27235 <type name="MountMountFlags" c:type="GMountMountFlags"/>
27237 <parameter name="mount_operation" transfer-ownership="none">
27238 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
27239 <type name="MountOperation" c:type="GMountOperation*"/>
27241 <parameter name="cancellable"
27242 transfer-ownership="none"
27244 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27245 <type name="Cancellable" c:type="GCancellable*"/>
27247 <parameter name="callback"
27248 transfer-ownership="none"
27251 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27252 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27254 <parameter name="user_data" transfer-ownership="none" closure="4">
27255 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27256 <type name="gpointer" c:type="gpointer"/>
27260 <virtual-method name="remount_finish"
27261 invoker="remount_finish"
27263 <doc xml:whitespace="preserve">Finishes remounting a mount. If any errors occurred during the operation,</doc>
27264 <return-value transfer-ownership="none">
27265 <doc xml:whitespace="preserve">%TRUE if the mount was successfully remounted. %FALSE otherwise.</doc>
27266 <type name="gboolean" c:type="gboolean"/>
27269 <parameter name="result" transfer-ownership="none">
27270 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27271 <type name="AsyncResult" c:type="GAsyncResult*"/>
27275 <virtual-method name="unmount"
27277 deprecated="Use g_mount_unmount_with_operation() instead."
27278 deprecated-version="2.22">
27279 <doc xml:whitespace="preserve">Unmounts a mount. This is an asynchronous operation, and is
27280 finished by calling g_mount_unmount_finish() with the @mount
27281 and #GAsyncResult data returned in the @callback.</doc>
27282 <return-value transfer-ownership="none">
27283 <type name="none" c:type="void"/>
27286 <parameter name="flags" transfer-ownership="none">
27287 <doc xml:whitespace="preserve">flags affecting the operation</doc>
27288 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
27290 <parameter name="cancellable"
27291 transfer-ownership="none"
27293 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27294 <type name="Cancellable" c:type="GCancellable*"/>
27296 <parameter name="callback"
27297 transfer-ownership="none"
27300 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27301 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27303 <parameter name="user_data" transfer-ownership="none" closure="3">
27304 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27305 <type name="gpointer" c:type="gpointer"/>
27309 <virtual-method name="unmount_finish"
27310 invoker="unmount_finish"
27311 deprecated="Use g_mount_unmount_with_operation_finish() instead."
27312 deprecated-version="2.22"
27314 <doc xml:whitespace="preserve">Finishes unmounting a mount. If any errors occurred during the operation,</doc>
27315 <return-value transfer-ownership="none">
27316 <doc xml:whitespace="preserve">%TRUE if the mount was successfully unmounted. %FALSE otherwise.</doc>
27317 <type name="gboolean" c:type="gboolean"/>
27320 <parameter name="result" transfer-ownership="none">
27321 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27322 <type name="AsyncResult" c:type="GAsyncResult*"/>
27326 <virtual-method name="unmount_with_operation"
27327 invoker="unmount_with_operation"
27329 <doc xml:whitespace="preserve">Unmounts a mount. This is an asynchronous operation, and is
27330 finished by calling g_mount_unmount_with_operation_finish() with the @mount
27331 and #GAsyncResult data returned in the @callback.</doc>
27332 <return-value transfer-ownership="none">
27333 <type name="none" c:type="void"/>
27336 <parameter name="flags" transfer-ownership="none">
27337 <doc xml:whitespace="preserve">flags affecting the operation</doc>
27338 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
27340 <parameter name="mount_operation" transfer-ownership="none">
27341 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
27342 <type name="MountOperation" c:type="GMountOperation*"/>
27344 <parameter name="cancellable"
27345 transfer-ownership="none"
27347 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27348 <type name="Cancellable" c:type="GCancellable*"/>
27350 <parameter name="callback"
27351 transfer-ownership="none"
27354 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27355 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27357 <parameter name="user_data" transfer-ownership="none" closure="4">
27358 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27359 <type name="gpointer" c:type="gpointer"/>
27363 <virtual-method name="unmount_with_operation_finish"
27364 invoker="unmount_with_operation_finish"
27367 <doc xml:whitespace="preserve">Finishes unmounting a mount. If any errors occurred during the operation,</doc>
27368 <return-value transfer-ownership="none">
27369 <doc xml:whitespace="preserve">%TRUE if the mount was successfully unmounted. %FALSE otherwise.</doc>
27370 <type name="gboolean" c:type="gboolean"/>
27373 <parameter name="result" transfer-ownership="none">
27374 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27375 <type name="AsyncResult" c:type="GAsyncResult*"/>
27379 <method name="can_eject" c:identifier="g_mount_can_eject">
27380 <doc xml:whitespace="preserve">Checks if @mount can be eject.</doc>
27381 <return-value transfer-ownership="none">
27382 <doc xml:whitespace="preserve">%TRUE if the @mount can be ejected.</doc>
27383 <type name="gboolean" c:type="gboolean"/>
27386 <method name="can_unmount" c:identifier="g_mount_can_unmount">
27387 <doc xml:whitespace="preserve">Checks if @mount can be mounted.</doc>
27388 <return-value transfer-ownership="none">
27389 <doc xml:whitespace="preserve">%TRUE if the @mount can be unmounted.</doc>
27390 <type name="gboolean" c:type="gboolean"/>
27393 <method name="eject"
27394 c:identifier="g_mount_eject"
27395 deprecated="Use g_mount_eject_with_operation() instead."
27396 deprecated-version="2.22">
27397 <doc xml:whitespace="preserve">Ejects a mount. This is an asynchronous operation, and is
27398 finished by calling g_mount_eject_finish() with the @mount
27399 and #GAsyncResult data returned in the @callback.</doc>
27400 <return-value transfer-ownership="none">
27401 <type name="none" c:type="void"/>
27404 <parameter name="flags" transfer-ownership="none">
27405 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
27406 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
27408 <parameter name="cancellable"
27409 transfer-ownership="none"
27411 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27412 <type name="Cancellable" c:type="GCancellable*"/>
27414 <parameter name="callback"
27415 transfer-ownership="none"
27418 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27419 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27421 <parameter name="user_data" transfer-ownership="none">
27422 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27423 <type name="gpointer" c:type="gpointer"/>
27427 <method name="eject_finish"
27428 c:identifier="g_mount_eject_finish"
27429 deprecated="Use g_mount_eject_with_operation_finish() instead."
27430 deprecated-version="2.22"
27432 <doc xml:whitespace="preserve">Finishes ejecting a mount. If any errors occurred during the operation,</doc>
27433 <return-value transfer-ownership="none">
27434 <doc xml:whitespace="preserve">%TRUE if the mount was successfully ejected. %FALSE otherwise.</doc>
27435 <type name="gboolean" c:type="gboolean"/>
27438 <parameter name="result" transfer-ownership="none">
27439 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27440 <type name="AsyncResult" c:type="GAsyncResult*"/>
27444 <method name="eject_with_operation"
27445 c:identifier="g_mount_eject_with_operation"
27447 <doc xml:whitespace="preserve">Ejects a mount. This is an asynchronous operation, and is
27448 finished by calling g_mount_eject_with_operation_finish() with the @mount
27449 and #GAsyncResult data returned in the @callback.</doc>
27450 <return-value transfer-ownership="none">
27451 <type name="none" c:type="void"/>
27454 <parameter name="flags" transfer-ownership="none">
27455 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
27456 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
27458 <parameter name="mount_operation" transfer-ownership="none">
27459 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
27460 <type name="MountOperation" c:type="GMountOperation*"/>
27462 <parameter name="cancellable"
27463 transfer-ownership="none"
27465 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27466 <type name="Cancellable" c:type="GCancellable*"/>
27468 <parameter name="callback"
27469 transfer-ownership="none"
27472 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27473 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27475 <parameter name="user_data" transfer-ownership="none">
27476 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27477 <type name="gpointer" c:type="gpointer"/>
27481 <method name="eject_with_operation_finish"
27482 c:identifier="g_mount_eject_with_operation_finish"
27485 <doc xml:whitespace="preserve">Finishes ejecting a mount. If any errors occurred during the operation,</doc>
27486 <return-value transfer-ownership="none">
27487 <doc xml:whitespace="preserve">%TRUE if the mount was successfully ejected. %FALSE otherwise.</doc>
27488 <type name="gboolean" c:type="gboolean"/>
27491 <parameter name="result" transfer-ownership="none">
27492 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27493 <type name="AsyncResult" c:type="GAsyncResult*"/>
27497 <method name="get_default_location"
27498 c:identifier="g_mount_get_default_location">
27499 <doc xml:whitespace="preserve">Gets the default location of @mount. The default location of the given
27500 the home directory, or the root of the volume).
27501 The returned object should be unreffed with
27502 g_object_unref() when no longer needed.</doc>
27503 <return-value transfer-ownership="full">
27504 <doc xml:whitespace="preserve">a #GFile.</doc>
27505 <type name="File" c:type="GFile*"/>
27508 <method name="get_drive" c:identifier="g_mount_get_drive">
27509 <doc xml:whitespace="preserve">Gets the drive for the @mount.
27510 This is a convenience method for getting the #GVolume and then
27511 using that object to get the #GDrive.
27512 The returned object should be unreffed with
27513 g_object_unref() when no longer needed.</doc>
27514 <return-value transfer-ownership="full">
27515 <doc xml:whitespace="preserve">a #GDrive or %NULL if @mount is not associated with a volume or a drive.</doc>
27516 <type name="Drive" c:type="GDrive*"/>
27519 <method name="get_icon" c:identifier="g_mount_get_icon">
27520 <doc xml:whitespace="preserve">Gets the icon for @mount.
27521 The returned object should be unreffed with
27522 g_object_unref() when no longer needed.</doc>
27523 <return-value transfer-ownership="full">
27524 <doc xml:whitespace="preserve">a #GIcon.</doc>
27525 <type name="Icon" c:type="GIcon*"/>
27528 <method name="get_name" c:identifier="g_mount_get_name">
27529 <doc xml:whitespace="preserve">Gets the name of @mount.
27530 The returned string should be freed with g_free()
27531 when no longer needed.</doc>
27532 <return-value transfer-ownership="full">
27533 <doc xml:whitespace="preserve">the name for the given @mount.</doc>
27534 <type name="utf8" c:type="char*"/>
27537 <method name="get_root" c:identifier="g_mount_get_root">
27538 <doc xml:whitespace="preserve">Gets the root directory on @mount.
27539 The returned object should be unreffed with
27540 g_object_unref() when no longer needed.</doc>
27541 <return-value transfer-ownership="full">
27542 <doc xml:whitespace="preserve">a #GFile.</doc>
27543 <type name="File" c:type="GFile*"/>
27546 <method name="get_uuid" c:identifier="g_mount_get_uuid">
27547 <doc xml:whitespace="preserve">Gets the UUID for the @mount. The reference is typically based on
27548 the file system UUID for the mount in question and should be
27549 considered an opaque string. Returns %NULL if there is no UUID
27551 The returned string should be freed with g_free()
27552 when no longer needed.</doc>
27553 <return-value transfer-ownership="full">
27554 <doc xml:whitespace="preserve">the UUID for @mount or %NULL if no UUID can be computed.</doc>
27555 <type name="utf8" c:type="char*"/>
27558 <method name="get_volume" c:identifier="g_mount_get_volume">
27559 <doc xml:whitespace="preserve">Gets the volume for the @mount.
27560 The returned object should be unreffed with
27561 g_object_unref() when no longer needed.</doc>
27562 <return-value transfer-ownership="full">
27563 <doc xml:whitespace="preserve">a #GVolume or %NULL if @mount is not associated with a volume.</doc>
27564 <type name="Volume" c:type="GVolume*"/>
27567 <method name="guess_content_type"
27568 c:identifier="g_mount_guess_content_type"
27570 <doc xml:whitespace="preserve">Tries to guess the type of content stored on @mount. Returns one or
27571 more textual identifiers of well-known content types (typically
27572 prefixed with "x-content/"), e.g. x-content/image-dcf for camera
27573 memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
27574 specification for more on x-content types.
27575 This is an asynchronous operation (see
27576 g_mount_guess_content_type_sync() for the synchronous version), and
27577 is finished by calling g_mount_guess_content_type_finish() with the</doc>
27578 <return-value transfer-ownership="none">
27579 <type name="none" c:type="void"/>
27582 <parameter name="force_rescan" transfer-ownership="none">
27583 <doc xml:whitespace="preserve">Whether to force a rescan of the content. Otherwise a cached result will be used if available</doc>
27584 <type name="gboolean" c:type="gboolean"/>
27586 <parameter name="cancellable"
27587 transfer-ownership="none"
27589 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
27590 <type name="Cancellable" c:type="GCancellable*"/>
27592 <parameter name="callback"
27593 transfer-ownership="none"
27596 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
27597 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27599 <parameter name="user_data" transfer-ownership="none">
27600 <doc xml:whitespace="preserve">user data passed to @callback</doc>
27601 <type name="gpointer" c:type="gpointer"/>
27605 <method name="guess_content_type_finish"
27606 c:identifier="g_mount_guess_content_type_finish"
27609 <doc xml:whitespace="preserve">Finishes guessing content types of @mount. If any errors occured
27610 during the operation, @error will be set to contain the errors and
27611 %FALSE will be returned. In particular, you may get an
27612 %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content
27614 Caller should free this array with g_strfreev() when done with it.</doc>
27615 <return-value transfer-ownership="full">
27616 <doc xml:whitespace="preserve">a %NULL-terminated array of content types or %NULL on error.</doc>
27617 <array c:type="gchar**">
27618 <type name="utf8"/>
27622 <parameter name="result" transfer-ownership="none">
27623 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
27624 <type name="AsyncResult" c:type="GAsyncResult*"/>
27628 <method name="guess_content_type_sync"
27629 c:identifier="g_mount_guess_content_type_sync"
27632 <doc xml:whitespace="preserve">Tries to guess the type of content stored on @mount. Returns one or
27633 more textual identifiers of well-known content types (typically
27634 prefixed with "x-content/"), e.g. x-content/image-dcf for camera
27635 memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
27636 specification for more on x-content types.
27637 This is an synchronous operation and as such may block doing IO;
27638 see g_mount_guess_content_type() for the asynchronous version.
27639 Caller should free this array with g_strfreev() when done with it.</doc>
27640 <return-value transfer-ownership="full">
27641 <doc xml:whitespace="preserve">a %NULL-terminated array of content types or %NULL on error.</doc>
27642 <array c:type="gchar**">
27643 <type name="utf8"/>
27647 <parameter name="force_rescan" transfer-ownership="none">
27648 <doc xml:whitespace="preserve">Whether to force a rescan of the content. Otherwise a cached result will be used if available</doc>
27649 <type name="gboolean" c:type="gboolean"/>
27651 <parameter name="cancellable"
27652 transfer-ownership="none"
27654 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
27655 <type name="Cancellable" c:type="GCancellable*"/>
27659 <method name="is_shadowed"
27660 c:identifier="g_mount_is_shadowed"
27662 <doc xml:whitespace="preserve">Determines if @mount is shadowed. Applications or libraries should
27663 avoid displaying @mount in the user interface if it is shadowed.
27664 A mount is said to be shadowed if there exists one or more user
27665 visible objects (currently #GMount objects) with a root that is
27666 inside the root of @mount.
27667 One application of shadow mounts is when exposing a single file
27668 system that is used to address several logical volumes. In this
27669 situation, a #GVolumeMonitor implementation would create two
27670 #GVolume objects (for example, one for the camera functionality of
27671 the device and one for a SD card reader on the device) with
27672 activation URIs <literal>gphoto2://[usb:001,002]/store1/</literal>
27673 and <literal>gphoto2://[usb:001,002]/store2/</literal>. When the
27674 underlying mount (with root
27675 <literal>gphoto2://[usb:001,002]/</literal>) is mounted, said
27676 #GVolumeMonitor implementation would create two #GMount objects
27677 (each with their root matching the corresponding volume activation
27678 root) that would shadow the original mount.
27679 The proxy monitor in GVfs 2.26 and later, automatically creates and
27680 manage shadow mounts (and shadows the underlying mount) if the
27681 activation root on a #GVolume is set.</doc>
27682 <return-value transfer-ownership="none">
27683 <doc xml:whitespace="preserve">%TRUE if @mount is shadowed.</doc>
27684 <type name="gboolean" c:type="gboolean"/>
27687 <method name="remount" c:identifier="g_mount_remount">
27688 <doc xml:whitespace="preserve">Remounts a mount. This is an asynchronous operation, and is
27689 finished by calling g_mount_remount_finish() with the @mount
27690 and #GAsyncResults data returned in the @callback.
27691 Remounting is useful when some setting affecting the operation
27692 of the volume has been changed, as these may need a remount to
27693 take affect. While this is semantically equivalent with unmounting
27694 and then remounting not all backends might need to actually be
27696 <return-value transfer-ownership="none">
27697 <type name="none" c:type="void"/>
27700 <parameter name="flags" transfer-ownership="none">
27701 <doc xml:whitespace="preserve">flags affecting the operation</doc>
27702 <type name="MountMountFlags" c:type="GMountMountFlags"/>
27704 <parameter name="mount_operation" transfer-ownership="none">
27705 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
27706 <type name="MountOperation" c:type="GMountOperation*"/>
27708 <parameter name="cancellable"
27709 transfer-ownership="none"
27711 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27712 <type name="Cancellable" c:type="GCancellable*"/>
27714 <parameter name="callback"
27715 transfer-ownership="none"
27718 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27719 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27721 <parameter name="user_data" transfer-ownership="none">
27722 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27723 <type name="gpointer" c:type="gpointer"/>
27727 <method name="remount_finish"
27728 c:identifier="g_mount_remount_finish"
27730 <doc xml:whitespace="preserve">Finishes remounting a mount. If any errors occurred during the operation,</doc>
27731 <return-value transfer-ownership="none">
27732 <doc xml:whitespace="preserve">%TRUE if the mount was successfully remounted. %FALSE otherwise.</doc>
27733 <type name="gboolean" c:type="gboolean"/>
27736 <parameter name="result" transfer-ownership="none">
27737 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27738 <type name="AsyncResult" c:type="GAsyncResult*"/>
27742 <method name="shadow" c:identifier="g_mount_shadow" version="2.20">
27743 <doc xml:whitespace="preserve">Increments the shadow count on @mount. Usually used by
27744 #GVolumeMonitor implementations when creating a shadow mount for
27745 will need to emit the #GMount::changed signal on @mount manually.</doc>
27746 <return-value transfer-ownership="none">
27747 <type name="none" c:type="void"/>
27750 <method name="unmount"
27751 c:identifier="g_mount_unmount"
27752 deprecated="Use g_mount_unmount_with_operation() instead."
27753 deprecated-version="2.22">
27754 <doc xml:whitespace="preserve">Unmounts a mount. This is an asynchronous operation, and is
27755 finished by calling g_mount_unmount_finish() with the @mount
27756 and #GAsyncResult data returned in the @callback.</doc>
27757 <return-value transfer-ownership="none">
27758 <type name="none" c:type="void"/>
27761 <parameter name="flags" transfer-ownership="none">
27762 <doc xml:whitespace="preserve">flags affecting the operation</doc>
27763 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
27765 <parameter name="cancellable"
27766 transfer-ownership="none"
27768 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27769 <type name="Cancellable" c:type="GCancellable*"/>
27771 <parameter name="callback"
27772 transfer-ownership="none"
27775 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27776 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27778 <parameter name="user_data" transfer-ownership="none">
27779 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27780 <type name="gpointer" c:type="gpointer"/>
27784 <method name="unmount_finish"
27785 c:identifier="g_mount_unmount_finish"
27786 deprecated="Use g_mount_unmount_with_operation_finish() instead."
27787 deprecated-version="2.22"
27789 <doc xml:whitespace="preserve">Finishes unmounting a mount. If any errors occurred during the operation,</doc>
27790 <return-value transfer-ownership="none">
27791 <doc xml:whitespace="preserve">%TRUE if the mount was successfully unmounted. %FALSE otherwise.</doc>
27792 <type name="gboolean" c:type="gboolean"/>
27795 <parameter name="result" transfer-ownership="none">
27796 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27797 <type name="AsyncResult" c:type="GAsyncResult*"/>
27801 <method name="unmount_with_operation"
27802 c:identifier="g_mount_unmount_with_operation"
27804 <doc xml:whitespace="preserve">Unmounts a mount. This is an asynchronous operation, and is
27805 finished by calling g_mount_unmount_with_operation_finish() with the @mount
27806 and #GAsyncResult data returned in the @callback.</doc>
27807 <return-value transfer-ownership="none">
27808 <type name="none" c:type="void"/>
27811 <parameter name="flags" transfer-ownership="none">
27812 <doc xml:whitespace="preserve">flags affecting the operation</doc>
27813 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
27815 <parameter name="mount_operation" transfer-ownership="none">
27816 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
27817 <type name="MountOperation" c:type="GMountOperation*"/>
27819 <parameter name="cancellable"
27820 transfer-ownership="none"
27822 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
27823 <type name="Cancellable" c:type="GCancellable*"/>
27825 <parameter name="callback"
27826 transfer-ownership="none"
27829 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
27830 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
27832 <parameter name="user_data" transfer-ownership="none">
27833 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
27834 <type name="gpointer" c:type="gpointer"/>
27838 <method name="unmount_with_operation_finish"
27839 c:identifier="g_mount_unmount_with_operation_finish"
27842 <doc xml:whitespace="preserve">Finishes unmounting a mount. If any errors occurred during the operation,</doc>
27843 <return-value transfer-ownership="none">
27844 <doc xml:whitespace="preserve">%TRUE if the mount was successfully unmounted. %FALSE otherwise.</doc>
27845 <type name="gboolean" c:type="gboolean"/>
27848 <parameter name="result" transfer-ownership="none">
27849 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
27850 <type name="AsyncResult" c:type="GAsyncResult*"/>
27854 <method name="unshadow" c:identifier="g_mount_unshadow" version="2.20">
27855 <doc xml:whitespace="preserve">Decrements the shadow count on @mount. Usually used by
27856 #GVolumeMonitor implementations when destroying a shadow mount for
27857 will need to emit the #GMount::changed signal on @mount manually.</doc>
27858 <return-value transfer-ownership="none">
27859 <type name="none" c:type="void"/>
27862 <glib:signal name="changed">
27863 <doc xml:whitespace="preserve">Emitted when the mount has been changed.</doc>
27864 <return-value transfer-ownership="none">
27865 <type name="none"/>
27868 <glib:signal name="pre-unmount" version="2.22">
27869 <doc xml:whitespace="preserve">This signal is emitted when the #GMount is about to be
27871 <return-value transfer-ownership="none">
27872 <type name="none"/>
27875 <glib:signal name="unmounted">
27876 <doc xml:whitespace="preserve">This signal is emitted when the #GMount have been
27877 unmounted. If the recipient is holding references to the
27878 object they should release them so the object can be
27880 <return-value transfer-ownership="none">
27881 <type name="none"/>
27885 <record name="MountIface"
27886 c:type="GMountIface"
27887 glib:is-gtype-struct-for="Mount">
27888 <doc xml:whitespace="preserve">Interface for implementing operations for mounts.</doc>
27889 <field name="g_iface">
27890 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
27892 <field name="changed">
27893 <callback name="changed">
27894 <return-value transfer-ownership="none">
27895 <type name="none" c:type="void"/>
27898 <parameter name="mount" transfer-ownership="none">
27899 <type name="Mount" c:type="GMount*"/>
27904 <field name="unmounted">
27905 <callback name="unmounted">
27906 <return-value transfer-ownership="none">
27907 <type name="none" c:type="void"/>
27910 <parameter name="mount" transfer-ownership="none">
27911 <type name="Mount" c:type="GMount*"/>
27916 <field name="get_root">
27917 <callback name="get_root">
27918 <return-value transfer-ownership="full">
27919 <doc xml:whitespace="preserve">a #GFile.</doc>
27920 <type name="File" c:type="GFile*"/>
27923 <parameter name="mount" transfer-ownership="none">
27924 <type name="Mount" c:type="GMount*"/>
27929 <field name="get_name">
27930 <callback name="get_name">
27931 <return-value transfer-ownership="full">
27932 <doc xml:whitespace="preserve">the name for the given @mount.</doc>
27933 <type name="utf8" c:type="char*"/>
27936 <parameter name="mount" transfer-ownership="none">
27937 <type name="Mount" c:type="GMount*"/>
27942 <field name="get_icon">
27943 <callback name="get_icon">
27944 <return-value transfer-ownership="full">
27945 <doc xml:whitespace="preserve">a #GIcon.</doc>
27946 <type name="Icon" c:type="GIcon*"/>
27949 <parameter name="mount" transfer-ownership="none">
27950 <type name="Mount" c:type="GMount*"/>
27955 <field name="get_uuid">
27956 <callback name="get_uuid">
27957 <return-value transfer-ownership="full">
27958 <doc xml:whitespace="preserve">the UUID for @mount or %NULL if no UUID can be computed.</doc>
27959 <type name="utf8" c:type="char*"/>
27962 <parameter name="mount" transfer-ownership="none">
27963 <type name="Mount" c:type="GMount*"/>
27968 <field name="get_volume">
27969 <callback name="get_volume">
27970 <return-value transfer-ownership="full">
27971 <doc xml:whitespace="preserve">a #GVolume or %NULL if @mount is not associated with a volume.</doc>
27972 <type name="Volume" c:type="GVolume*"/>
27975 <parameter name="mount" transfer-ownership="none">
27976 <type name="Mount" c:type="GMount*"/>
27981 <field name="get_drive">
27982 <callback name="get_drive">
27983 <return-value transfer-ownership="full">
27984 <doc xml:whitespace="preserve">a #GDrive or %NULL if @mount is not associated with a volume or a drive.</doc>
27985 <type name="Drive" c:type="GDrive*"/>
27988 <parameter name="mount" transfer-ownership="none">
27989 <type name="Mount" c:type="GMount*"/>
27994 <field name="can_unmount">
27995 <callback name="can_unmount">
27996 <return-value transfer-ownership="none">
27997 <doc xml:whitespace="preserve">%TRUE if the @mount can be unmounted.</doc>
27998 <type name="gboolean" c:type="gboolean"/>
28001 <parameter name="mount" transfer-ownership="none">
28002 <type name="Mount" c:type="GMount*"/>
28007 <field name="can_eject">
28008 <callback name="can_eject">
28009 <return-value transfer-ownership="none">
28010 <doc xml:whitespace="preserve">%TRUE if the @mount can be ejected.</doc>
28011 <type name="gboolean" c:type="gboolean"/>
28014 <parameter name="mount" transfer-ownership="none">
28015 <type name="Mount" c:type="GMount*"/>
28020 <field name="unmount">
28021 <callback name="unmount">
28022 <return-value transfer-ownership="none">
28023 <type name="none" c:type="void"/>
28026 <parameter name="mount" transfer-ownership="none">
28027 <type name="Mount" c:type="GMount*"/>
28029 <parameter name="flags" transfer-ownership="none">
28030 <doc xml:whitespace="preserve">flags affecting the operation</doc>
28031 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
28033 <parameter name="cancellable"
28034 transfer-ownership="none"
28036 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
28037 <type name="Cancellable" c:type="GCancellable*"/>
28039 <parameter name="callback"
28040 transfer-ownership="none"
28043 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
28044 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
28046 <parameter name="user_data" transfer-ownership="none" closure="4">
28047 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
28048 <type name="gpointer" c:type="gpointer"/>
28053 <field name="unmount_finish">
28054 <callback name="unmount_finish" throws="1">
28055 <return-value transfer-ownership="none">
28056 <doc xml:whitespace="preserve">%TRUE if the mount was successfully unmounted. %FALSE otherwise.</doc>
28057 <type name="gboolean" c:type="gboolean"/>
28060 <parameter name="mount" transfer-ownership="none">
28061 <type name="Mount" c:type="GMount*"/>
28063 <parameter name="result" transfer-ownership="none">
28064 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
28065 <type name="AsyncResult" c:type="GAsyncResult*"/>
28070 <field name="eject">
28071 <callback name="eject">
28072 <return-value transfer-ownership="none">
28073 <type name="none" c:type="void"/>
28076 <parameter name="mount" transfer-ownership="none">
28077 <type name="Mount" c:type="GMount*"/>
28079 <parameter name="flags" transfer-ownership="none">
28080 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
28081 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
28083 <parameter name="cancellable"
28084 transfer-ownership="none"
28086 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
28087 <type name="Cancellable" c:type="GCancellable*"/>
28089 <parameter name="callback"
28090 transfer-ownership="none"
28093 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
28094 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
28096 <parameter name="user_data" transfer-ownership="none" closure="4">
28097 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
28098 <type name="gpointer" c:type="gpointer"/>
28103 <field name="eject_finish">
28104 <callback name="eject_finish" throws="1">
28105 <return-value transfer-ownership="none">
28106 <doc xml:whitespace="preserve">%TRUE if the mount was successfully ejected. %FALSE otherwise.</doc>
28107 <type name="gboolean" c:type="gboolean"/>
28110 <parameter name="mount" transfer-ownership="none">
28111 <type name="Mount" c:type="GMount*"/>
28113 <parameter name="result" transfer-ownership="none">
28114 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
28115 <type name="AsyncResult" c:type="GAsyncResult*"/>
28120 <field name="remount">
28121 <callback name="remount">
28122 <return-value transfer-ownership="none">
28123 <type name="none" c:type="void"/>
28126 <parameter name="mount" transfer-ownership="none">
28127 <type name="Mount" c:type="GMount*"/>
28129 <parameter name="flags" transfer-ownership="none">
28130 <doc xml:whitespace="preserve">flags affecting the operation</doc>
28131 <type name="MountMountFlags" c:type="GMountMountFlags"/>
28133 <parameter name="mount_operation" transfer-ownership="none">
28134 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
28135 <type name="MountOperation" c:type="GMountOperation*"/>
28137 <parameter name="cancellable"
28138 transfer-ownership="none"
28140 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
28141 <type name="Cancellable" c:type="GCancellable*"/>
28143 <parameter name="callback"
28144 transfer-ownership="none"
28147 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
28148 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
28150 <parameter name="user_data" transfer-ownership="none" closure="5">
28151 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
28152 <type name="gpointer" c:type="gpointer"/>
28157 <field name="remount_finish">
28158 <callback name="remount_finish" throws="1">
28159 <return-value transfer-ownership="none">
28160 <doc xml:whitespace="preserve">%TRUE if the mount was successfully remounted. %FALSE otherwise.</doc>
28161 <type name="gboolean" c:type="gboolean"/>
28164 <parameter name="mount" transfer-ownership="none">
28165 <type name="Mount" c:type="GMount*"/>
28167 <parameter name="result" transfer-ownership="none">
28168 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
28169 <type name="AsyncResult" c:type="GAsyncResult*"/>
28174 <field name="guess_content_type">
28175 <callback name="guess_content_type">
28176 <return-value transfer-ownership="none">
28177 <type name="none" c:type="void"/>
28180 <parameter name="mount" transfer-ownership="none">
28181 <type name="Mount" c:type="GMount*"/>
28183 <parameter name="force_rescan" transfer-ownership="none">
28184 <doc xml:whitespace="preserve">Whether to force a rescan of the content. Otherwise a cached result will be used if available</doc>
28185 <type name="gboolean" c:type="gboolean"/>
28187 <parameter name="cancellable"
28188 transfer-ownership="none"
28190 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
28191 <type name="Cancellable" c:type="GCancellable*"/>
28193 <parameter name="callback"
28194 transfer-ownership="none"
28197 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
28198 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
28200 <parameter name="user_data" transfer-ownership="none" closure="4">
28201 <doc xml:whitespace="preserve">user data passed to @callback</doc>
28202 <type name="gpointer" c:type="gpointer"/>
28207 <field name="guess_content_type_finish">
28208 <callback name="guess_content_type_finish" throws="1">
28209 <return-value transfer-ownership="full">
28210 <doc xml:whitespace="preserve">a %NULL-terminated array of content types or %NULL on error.</doc>
28211 <array c:type="gchar**">
28212 <type name="utf8"/>
28216 <parameter name="mount" transfer-ownership="none">
28217 <type name="Mount" c:type="GMount*"/>
28219 <parameter name="result" transfer-ownership="none">
28220 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
28221 <type name="AsyncResult" c:type="GAsyncResult*"/>
28226 <field name="guess_content_type_sync">
28227 <callback name="guess_content_type_sync" throws="1">
28228 <return-value transfer-ownership="full">
28229 <doc xml:whitespace="preserve">a %NULL-terminated array of content types or %NULL on error.</doc>
28230 <array c:type="gchar**">
28231 <type name="utf8"/>
28235 <parameter name="mount" transfer-ownership="none">
28236 <type name="Mount" c:type="GMount*"/>
28238 <parameter name="force_rescan" transfer-ownership="none">
28239 <doc xml:whitespace="preserve">Whether to force a rescan of the content. Otherwise a cached result will be used if available</doc>
28240 <type name="gboolean" c:type="gboolean"/>
28242 <parameter name="cancellable"
28243 transfer-ownership="none"
28245 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
28246 <type name="Cancellable" c:type="GCancellable*"/>
28251 <field name="pre_unmount">
28252 <callback name="pre_unmount">
28253 <return-value transfer-ownership="none">
28254 <type name="none" c:type="void"/>
28257 <parameter name="mount" transfer-ownership="none">
28258 <type name="Mount" c:type="GMount*"/>
28263 <field name="unmount_with_operation">
28264 <callback name="unmount_with_operation">
28265 <return-value transfer-ownership="none">
28266 <type name="none" c:type="void"/>
28269 <parameter name="mount" transfer-ownership="none">
28270 <type name="Mount" c:type="GMount*"/>
28272 <parameter name="flags" transfer-ownership="none">
28273 <doc xml:whitespace="preserve">flags affecting the operation</doc>
28274 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
28276 <parameter name="mount_operation" transfer-ownership="none">
28277 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
28278 <type name="MountOperation" c:type="GMountOperation*"/>
28280 <parameter name="cancellable"
28281 transfer-ownership="none"
28283 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
28284 <type name="Cancellable" c:type="GCancellable*"/>
28286 <parameter name="callback"
28287 transfer-ownership="none"
28290 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
28291 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
28293 <parameter name="user_data" transfer-ownership="none" closure="5">
28294 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
28295 <type name="gpointer" c:type="gpointer"/>
28300 <field name="unmount_with_operation_finish">
28301 <callback name="unmount_with_operation_finish" throws="1">
28302 <return-value transfer-ownership="none">
28303 <doc xml:whitespace="preserve">%TRUE if the mount was successfully unmounted. %FALSE otherwise.</doc>
28304 <type name="gboolean" c:type="gboolean"/>
28307 <parameter name="mount" transfer-ownership="none">
28308 <type name="Mount" c:type="GMount*"/>
28310 <parameter name="result" transfer-ownership="none">
28311 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
28312 <type name="AsyncResult" c:type="GAsyncResult*"/>
28317 <field name="eject_with_operation">
28318 <callback name="eject_with_operation">
28319 <return-value transfer-ownership="none">
28320 <type name="none" c:type="void"/>
28323 <parameter name="mount" transfer-ownership="none">
28324 <type name="Mount" c:type="GMount*"/>
28326 <parameter name="flags" transfer-ownership="none">
28327 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
28328 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
28330 <parameter name="mount_operation" transfer-ownership="none">
28331 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
28332 <type name="MountOperation" c:type="GMountOperation*"/>
28334 <parameter name="cancellable"
28335 transfer-ownership="none"
28337 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
28338 <type name="Cancellable" c:type="GCancellable*"/>
28340 <parameter name="callback"
28341 transfer-ownership="none"
28344 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
28345 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
28347 <parameter name="user_data" transfer-ownership="none" closure="5">
28348 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
28349 <type name="gpointer" c:type="gpointer"/>
28354 <field name="eject_with_operation_finish">
28355 <callback name="eject_with_operation_finish" throws="1">
28356 <return-value transfer-ownership="none">
28357 <doc xml:whitespace="preserve">%TRUE if the mount was successfully ejected. %FALSE otherwise.</doc>
28358 <type name="gboolean" c:type="gboolean"/>
28361 <parameter name="mount" transfer-ownership="none">
28362 <type name="Mount" c:type="GMount*"/>
28364 <parameter name="result" transfer-ownership="none">
28365 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
28366 <type name="AsyncResult" c:type="GAsyncResult*"/>
28371 <field name="get_default_location">
28372 <callback name="get_default_location">
28373 <return-value transfer-ownership="full">
28374 <doc xml:whitespace="preserve">a #GFile.</doc>
28375 <type name="File" c:type="GFile*"/>
28378 <parameter name="mount" transfer-ownership="none">
28379 <type name="Mount" c:type="GMount*"/>
28385 <enumeration name="MountMountFlags"
28386 glib:type-name="GMountMountFlags"
28387 glib:get-type="g_mount_mount_flags_get_type"
28388 c:type="GMountMountFlags">
28389 <doc xml:whitespace="preserve">Flags used when mounting a mount.</doc>
28390 <member name="none"
28392 c:identifier="G_MOUNT_MOUNT_NONE"
28395 <class name="MountOperation"
28396 c:symbol-prefix="mount_operation"
28397 c:type="GMountOperation"
28398 parent="GObject.Object"
28399 glib:type-name="GMountOperation"
28400 glib:get-type="g_mount_operation_get_type"
28401 glib:type-struct="MountOperationClass">
28402 <doc xml:whitespace="preserve">Class for providing authentication methods for mounting operations,
28403 such as mounting a file locally, or authenticating with a server.</doc>
28404 <constructor name="new" c:identifier="g_mount_operation_new">
28405 <doc xml:whitespace="preserve">Creates a new mount operation.</doc>
28406 <return-value transfer-ownership="full">
28407 <doc xml:whitespace="preserve">a #GMountOperation.</doc>
28408 <type name="MountOperation" c:type="GMountOperation*"/>
28411 <method name="get_anonymous"
28412 c:identifier="g_mount_operation_get_anonymous">
28413 <doc xml:whitespace="preserve">Check to see whether the mount operation is being used
28414 for an anonymous user.</doc>
28415 <return-value transfer-ownership="none">
28416 <doc xml:whitespace="preserve">%TRUE if mount operation is anonymous.</doc>
28417 <type name="gboolean" c:type="gboolean"/>
28420 <method name="get_choice" c:identifier="g_mount_operation_get_choice">
28421 <doc xml:whitespace="preserve">Gets a choice from the mount operation.
28422 the choice's list, or %0.</doc>
28423 <return-value transfer-ownership="none">
28424 <doc xml:whitespace="preserve">an integer containing an index of the user's choice from</doc>
28425 <type name="gint" c:type="int"/>
28428 <method name="get_domain" c:identifier="g_mount_operation_get_domain">
28429 <doc xml:whitespace="preserve">Gets the domain of the mount operation.</doc>
28430 <return-value transfer-ownership="none">
28431 <doc xml:whitespace="preserve">a string set to the domain.</doc>
28432 <type name="utf8" c:type="char*"/>
28435 <method name="get_password"
28436 c:identifier="g_mount_operation_get_password">
28437 <doc xml:whitespace="preserve">Gets a password from the mount operation.</doc>
28438 <return-value transfer-ownership="none">
28439 <doc xml:whitespace="preserve">a string containing the password within @op.</doc>
28440 <type name="utf8" c:type="char*"/>
28443 <method name="get_password_save"
28444 c:identifier="g_mount_operation_get_password_save">
28445 <doc xml:whitespace="preserve">Gets the state of saving passwords for the mount operation.</doc>
28446 <return-value transfer-ownership="none">
28447 <doc xml:whitespace="preserve">a #GPasswordSave flag.</doc>
28448 <type name="PasswordSave" c:type="GPasswordSave"/>
28451 <method name="get_username"
28452 c:identifier="g_mount_operation_get_username">
28453 <return-value transfer-ownership="none">
28454 <type name="utf8" c:type="char*"/>
28457 <method name="reply" c:identifier="g_mount_operation_reply">
28458 <doc xml:whitespace="preserve">Emits the #GMountOperation::reply signal.</doc>
28459 <return-value transfer-ownership="none">
28460 <type name="none" c:type="void"/>
28463 <parameter name="result" transfer-ownership="none">
28464 <doc xml:whitespace="preserve">a #GMountOperationResult</doc>
28465 <type name="MountOperationResult" c:type="GMountOperationResult"/>
28469 <method name="set_anonymous"
28470 c:identifier="g_mount_operation_set_anonymous">
28471 <doc xml:whitespace="preserve">Sets the mount operation to use an anonymous user if @anonymous is %TRUE.</doc>
28472 <return-value transfer-ownership="none">
28473 <type name="none" c:type="void"/>
28476 <parameter name="anonymous" transfer-ownership="none">
28477 <doc xml:whitespace="preserve">boolean value.</doc>
28478 <type name="gboolean" c:type="gboolean"/>
28482 <method name="set_choice" c:identifier="g_mount_operation_set_choice">
28483 <doc xml:whitespace="preserve">Sets a default choice for the mount operation.</doc>
28484 <return-value transfer-ownership="none">
28485 <type name="none" c:type="void"/>
28488 <parameter name="choice" transfer-ownership="none">
28489 <doc xml:whitespace="preserve">an integer.</doc>
28490 <type name="gint" c:type="int"/>
28494 <method name="set_domain" c:identifier="g_mount_operation_set_domain">
28495 <doc xml:whitespace="preserve">Sets the mount operation's domain.</doc>
28496 <return-value transfer-ownership="none">
28497 <type name="none" c:type="void"/>
28500 <parameter name="domain" transfer-ownership="none">
28501 <doc xml:whitespace="preserve">the domain to set.</doc>
28502 <type name="utf8" c:type="char*"/>
28506 <method name="set_password"
28507 c:identifier="g_mount_operation_set_password">
28508 <doc xml:whitespace="preserve">Sets the mount operation's password to @password.</doc>
28509 <return-value transfer-ownership="none">
28510 <type name="none" c:type="void"/>
28513 <parameter name="password" transfer-ownership="none">
28514 <doc xml:whitespace="preserve">password to set.</doc>
28515 <type name="utf8" c:type="char*"/>
28519 <method name="set_password_save"
28520 c:identifier="g_mount_operation_set_password_save">
28521 <doc xml:whitespace="preserve">Sets the state of saving passwords for the mount operation.</doc>
28522 <return-value transfer-ownership="none">
28523 <type name="none" c:type="void"/>
28526 <parameter name="save" transfer-ownership="none">
28527 <doc xml:whitespace="preserve">a set of #GPasswordSave flags.</doc>
28528 <type name="PasswordSave" c:type="GPasswordSave"/>
28532 <method name="set_username"
28533 c:identifier="g_mount_operation_set_username">
28534 <doc xml:whitespace="preserve">Sets the user name within @op to @username.</doc>
28535 <return-value transfer-ownership="none">
28536 <type name="none" c:type="void"/>
28539 <parameter name="username" transfer-ownership="none">
28540 <doc xml:whitespace="preserve">input username.</doc>
28541 <type name="utf8" c:type="char*"/>
28545 <property name="anonymous" writable="1" transfer-ownership="none">
28546 <doc xml:whitespace="preserve">Whether to use an anonymous user when authenticating.</doc>
28547 <type name="gboolean"/>
28549 <property name="choice" writable="1" transfer-ownership="none">
28550 <doc xml:whitespace="preserve">The index of the user's choice when a question is asked during the
28551 mount operation. See the #GMountOperation::ask-question signal.</doc>
28552 <type name="gint"/>
28554 <property name="domain" writable="1" transfer-ownership="none">
28555 <doc xml:whitespace="preserve">The domain to use for the mount operation.</doc>
28556 <type name="utf8"/>
28558 <property name="password" writable="1" transfer-ownership="none">
28559 <doc xml:whitespace="preserve">The password that is used for authentication when carrying out
28560 the mount operation.</doc>
28561 <type name="utf8"/>
28563 <property name="password-save" writable="1" transfer-ownership="none">
28564 <doc xml:whitespace="preserve">Determines if and how the password information should be saved.</doc>
28565 <type name="PasswordSave"/>
28567 <property name="username" writable="1" transfer-ownership="none">
28568 <doc xml:whitespace="preserve">The user name that is used for authentication when carrying out
28569 the mount operation.</doc>
28570 <type name="utf8"/>
28572 <field name="parent_instance">
28573 <type name="GObject.Object" c:type="GObject"/>
28575 <field name="priv">
28576 <type name="MountOperationPrivate" c:type="GMountOperationPrivate*"/>
28578 <glib:signal name="aborted" version="2.20">
28579 <doc xml:whitespace="preserve">Emitted by the backend when e.g. a device becomes unavailable
28580 while a mount operation is in progress.
28581 Implementations of GMountOperation should handle this signal
28582 by dismissing open password dialogs.</doc>
28583 <return-value transfer-ownership="none">
28584 <type name="none"/>
28587 <glib:signal name="ask-password">
28588 <doc xml:whitespace="preserve">Emitted when a mount operation asks the user for a password.
28589 If the message contains a line break, the first line should be
28590 presented as a heading. For example, it may be used as the
28591 primary text in a #GtkMessageDialog.</doc>
28592 <return-value transfer-ownership="none">
28593 <type name="none"/>
28596 <parameter name="object" transfer-ownership="none">
28597 <doc xml:whitespace="preserve">string containing a message to display to the user.</doc>
28598 <type name="utf8"/>
28600 <parameter name="p0" transfer-ownership="none">
28601 <doc xml:whitespace="preserve">string containing the default user name.</doc>
28602 <type name="utf8"/>
28604 <parameter name="p1" transfer-ownership="none">
28605 <doc xml:whitespace="preserve">string containing the default domain.</doc>
28606 <type name="utf8"/>
28608 <parameter name="p2" transfer-ownership="none">
28609 <doc xml:whitespace="preserve">a set of #GAskPasswordFlags.</doc>
28610 <type name="AskPasswordFlags"/>
28614 <glib:signal name="ask-question" introspectable="0">
28615 <doc xml:whitespace="preserve">Emitted when asking the user a question and gives a list of
28616 choices for the user to choose from.
28617 If the message contains a line break, the first line should be
28618 presented as a heading. For example, it may be used as the
28619 primary text in a #GtkMessageDialog.</doc>
28620 <return-value transfer-ownership="none">
28621 <type name="none"/>
28624 <parameter name="object" transfer-ownership="none">
28625 <doc xml:whitespace="preserve">string containing a message to display to the user.</doc>
28626 <type name="utf8"/>
28628 <parameter name="p0" transfer-ownership="none">
28629 <doc xml:whitespace="preserve">an array of strings for each possible choice.</doc>
28634 <glib:signal name="reply">
28635 <doc xml:whitespace="preserve">Emitted when the user has replied to the mount operation.</doc>
28636 <return-value transfer-ownership="none">
28637 <type name="none"/>
28640 <parameter name="object" transfer-ownership="none">
28641 <doc xml:whitespace="preserve">a #GMountOperationResult indicating how the request was handled</doc>
28642 <type name="MountOperationResult"/>
28646 <glib:signal name="show-processes" version="2.22" introspectable="0">
28647 <doc xml:whitespace="preserve">Emitted when one or more processes are blocking an operation
28648 e.g. unmounting/ejecting a #GMount or stopping a #GDrive.
28649 Note that this signal may be emitted several times to update the
28650 list of blocking processes as processes close files. The
28651 application should only respond with g_mount_operation_reply() to
28652 the latest signal (setting #GMountOperation:choice to the choice
28654 If the message contains a line break, the first line should be
28655 presented as a heading. For example, it may be used as the
28656 primary text in a #GtkMessageDialog.</doc>
28657 <return-value transfer-ownership="none">
28658 <type name="none"/>
28661 <parameter name="object" transfer-ownership="none">
28662 <doc xml:whitespace="preserve">string containing a message to display to the user.</doc>
28663 <type name="utf8"/>
28665 <parameter name="p0" transfer-ownership="none">
28666 <doc xml:whitespace="preserve">an array of #GPid for processes blocking the operation.</doc>
28667 <array name="GLib.Array">
28668 <type name="gpointer" c:type="gpointer"/>
28671 <parameter name="p1" transfer-ownership="none">
28672 <doc xml:whitespace="preserve">an array of strings for each possible choice.</doc>
28678 <record name="MountOperationClass"
28679 c:type="GMountOperationClass"
28680 glib:is-gtype-struct-for="MountOperation">
28681 <field name="parent_class">
28682 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
28684 <field name="ask_password">
28685 <callback name="ask_password">
28686 <return-value transfer-ownership="none">
28687 <type name="none" c:type="void"/>
28690 <parameter name="op" transfer-ownership="none">
28691 <type name="MountOperation" c:type="GMountOperation*"/>
28693 <parameter name="message" transfer-ownership="none">
28694 <type name="utf8" c:type="char*"/>
28696 <parameter name="default_user" transfer-ownership="none">
28697 <type name="utf8" c:type="char*"/>
28699 <parameter name="default_domain" transfer-ownership="none">
28700 <type name="utf8" c:type="char*"/>
28702 <parameter name="flags" transfer-ownership="none">
28703 <type name="AskPasswordFlags" c:type="GAskPasswordFlags"/>
28708 <field name="ask_question">
28709 <callback name="ask_question">
28710 <return-value transfer-ownership="none">
28711 <type name="none" c:type="void"/>
28714 <parameter name="op" transfer-ownership="none">
28715 <type name="MountOperation" c:type="GMountOperation*"/>
28717 <parameter name="message" transfer-ownership="none">
28718 <type name="utf8" c:type="char*"/>
28720 <parameter name="choices" transfer-ownership="none">
28721 <type name="utf8" c:type="char*"/>
28726 <field name="reply">
28727 <callback name="reply">
28728 <return-value transfer-ownership="none">
28729 <type name="none" c:type="void"/>
28732 <parameter name="op" transfer-ownership="none">
28733 <type name="MountOperation" c:type="GMountOperation*"/>
28735 <parameter name="result" transfer-ownership="none">
28736 <type name="MountOperationResult"
28737 c:type="GMountOperationResult"/>
28742 <field name="aborted">
28743 <callback name="aborted">
28744 <return-value transfer-ownership="none">
28745 <type name="none" c:type="void"/>
28748 <parameter name="op" transfer-ownership="none">
28749 <type name="MountOperation" c:type="GMountOperation*"/>
28754 <field name="show_processes">
28755 <callback name="show_processes">
28756 <return-value transfer-ownership="none">
28757 <type name="none" c:type="void"/>
28760 <parameter name="op" transfer-ownership="none">
28761 <type name="MountOperation" c:type="GMountOperation*"/>
28763 <parameter name="message" transfer-ownership="none">
28764 <type name="utf8" c:type="gchar*"/>
28766 <parameter name="processes" transfer-ownership="none">
28767 <array name="GLib.Array" c:type="GArray*">
28768 <type name="gpointer" c:type="gpointer"/>
28771 <parameter name="choices" transfer-ownership="none">
28772 <type name="utf8" c:type="gchar*"/>
28777 <field name="_g_reserved1" introspectable="0">
28778 <callback name="_g_reserved1">
28779 <return-value transfer-ownership="none">
28780 <type name="none" c:type="void"/>
28784 <field name="_g_reserved2" introspectable="0">
28785 <callback name="_g_reserved2">
28786 <return-value transfer-ownership="none">
28787 <type name="none" c:type="void"/>
28791 <field name="_g_reserved3" introspectable="0">
28792 <callback name="_g_reserved3">
28793 <return-value transfer-ownership="none">
28794 <type name="none" c:type="void"/>
28798 <field name="_g_reserved4" introspectable="0">
28799 <callback name="_g_reserved4">
28800 <return-value transfer-ownership="none">
28801 <type name="none" c:type="void"/>
28805 <field name="_g_reserved5" introspectable="0">
28806 <callback name="_g_reserved5">
28807 <return-value transfer-ownership="none">
28808 <type name="none" c:type="void"/>
28812 <field name="_g_reserved6" introspectable="0">
28813 <callback name="_g_reserved6">
28814 <return-value transfer-ownership="none">
28815 <type name="none" c:type="void"/>
28819 <field name="_g_reserved7" introspectable="0">
28820 <callback name="_g_reserved7">
28821 <return-value transfer-ownership="none">
28822 <type name="none" c:type="void"/>
28826 <field name="_g_reserved8" introspectable="0">
28827 <callback name="_g_reserved8">
28828 <return-value transfer-ownership="none">
28829 <type name="none" c:type="void"/>
28833 <field name="_g_reserved9" introspectable="0">
28834 <callback name="_g_reserved9">
28835 <return-value transfer-ownership="none">
28836 <type name="none" c:type="void"/>
28840 <field name="_g_reserved10" introspectable="0">
28841 <callback name="_g_reserved10">
28842 <return-value transfer-ownership="none">
28843 <type name="none" c:type="void"/>
28848 <record name="MountOperationPrivate"
28849 c:type="GMountOperationPrivate"
28852 <enumeration name="MountOperationResult"
28853 glib:type-name="GMountOperationResult"
28854 glib:get-type="g_mount_operation_result_get_type"
28855 c:type="GMountOperationResult">
28856 <doc xml:whitespace="preserve">#GMountOperationResult is returned as a result when a request for
28857 information is send by the mounting operation.</doc>
28858 <member name="handled"
28860 c:identifier="G_MOUNT_OPERATION_HANDLED"
28861 glib:nick="handled"/>
28862 <member name="aborted"
28864 c:identifier="G_MOUNT_OPERATION_ABORTED"
28865 glib:nick="aborted"/>
28866 <member name="unhandled"
28868 c:identifier="G_MOUNT_OPERATION_UNHANDLED"
28869 glib:nick="unhandled"/>
28871 <bitfield name="MountUnmountFlags"
28872 glib:type-name="GMountUnmountFlags"
28873 glib:get-type="g_mount_unmount_flags_get_type"
28874 c:type="GMountUnmountFlags">
28875 <doc xml:whitespace="preserve">Flags used when an unmounting a mount.</doc>
28876 <member name="none"
28878 c:identifier="G_MOUNT_UNMOUNT_NONE"
28880 <member name="force"
28882 c:identifier="G_MOUNT_UNMOUNT_FORCE"
28883 glib:nick="force"/>
28885 <constant name="NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME"
28886 value="gio-native-volume-monitor">
28887 <type name="utf8" c:type="gchar*"/>
28889 <class name="NativeVolumeMonitor"
28890 c:symbol-prefix="native_volume_monitor"
28891 c:type="GNativeVolumeMonitor"
28892 parent="VolumeMonitor"
28894 glib:type-name="GNativeVolumeMonitor"
28895 glib:get-type="g_native_volume_monitor_get_type"
28896 glib:type-struct="NativeVolumeMonitorClass">
28897 <field name="parent_instance">
28898 <type name="VolumeMonitor" c:type="GVolumeMonitor"/>
28901 <record name="NativeVolumeMonitorClass"
28902 c:type="GNativeVolumeMonitorClass"
28903 glib:is-gtype-struct-for="NativeVolumeMonitor">
28904 <field name="parent_class">
28905 <type name="VolumeMonitorClass" c:type="GVolumeMonitorClass"/>
28907 <field name="get_mount_for_mount_path" introspectable="0">
28908 <callback name="get_mount_for_mount_path" introspectable="0">
28910 <type name="Mount" c:type="GMount*"/>
28913 <parameter name="mount_path" transfer-ownership="none">
28914 <type name="utf8" c:type="char*"/>
28916 <parameter name="cancellable" transfer-ownership="none">
28917 <type name="Cancellable" c:type="GCancellable*"/>
28923 <class name="NetworkAddress"
28924 c:symbol-prefix="network_address"
28925 c:type="GNetworkAddress"
28926 parent="GObject.Object"
28927 glib:type-name="GNetworkAddress"
28928 glib:get-type="g_network_address_get_type"
28929 glib:type-struct="NetworkAddressClass">
28930 <doc xml:whitespace="preserve">A #GSocketConnectable for resolving a hostname and connecting to
28932 <implements name="SocketConnectable"/>
28933 <function name="new" c:identifier="g_network_address_new" version="2.22">
28934 <doc xml:whitespace="preserve">Creates a new #GSocketConnectable for connecting to the given</doc>
28935 <return-value transfer-ownership="full">
28936 <doc xml:whitespace="preserve">the new #GNetworkAddress</doc>
28937 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
28940 <parameter name="hostname" transfer-ownership="none">
28941 <doc xml:whitespace="preserve">the hostname</doc>
28942 <type name="utf8" c:type="gchar*"/>
28944 <parameter name="port" transfer-ownership="none">
28945 <doc xml:whitespace="preserve">the port</doc>
28946 <type name="guint16" c:type="guint16"/>
28950 <function name="parse"
28951 c:identifier="g_network_address_parse"
28954 <doc xml:whitespace="preserve">Creates a new #GSocketConnectable for connecting to the given
28955 parsing @host_and_port fails.
28956 address, an IPv4 address, or a domain name (in which case a DNS
28957 lookup is performed). Quoting with [] is supported for all address
28958 types. A port override may be specified in the usual way with a
28959 colon. Ports may be given as decimal numbers or symbolic names (in
28960 which case an /etc/services lookup is performed).
28961 If no port is specified in @host_and_port then @default_port will be
28962 used as the port number to connect to.
28963 In general, @host_and_port is expected to be provided by the user
28964 (allowing them to give the hostname, and a port overide if necessary)
28965 and @default_port is expected to be provided by the application.</doc>
28966 <return-value transfer-ownership="full">
28967 <doc xml:whitespace="preserve">the new #GNetworkAddress, or %NULL on error</doc>
28968 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
28971 <parameter name="host_and_port" transfer-ownership="none">
28972 <doc xml:whitespace="preserve">the hostname and optionally a port</doc>
28973 <type name="utf8" c:type="gchar*"/>
28975 <parameter name="default_port" transfer-ownership="none">
28976 <doc xml:whitespace="preserve">the default port if not in @host_and_port</doc>
28977 <type name="guint16" c:type="guint16"/>
28981 <function name="parse_uri"
28982 c:identifier="g_network_address_parse_uri"
28985 <doc xml:whitespace="preserve">Creates a new #GSocketConnectable for connecting to the given
28986 Using this rather than g_network_address_new() or
28987 g_network_address_parse_host() allows #GSocketClient to determine
28988 when to use application-specific proxy protocols.</doc>
28989 <return-value transfer-ownership="full">
28990 <doc xml:whitespace="preserve">the new #GNetworkAddress, or %NULL on error</doc>
28991 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
28994 <parameter name="uri" transfer-ownership="none">
28995 <doc xml:whitespace="preserve">the hostname and optionally a port</doc>
28996 <type name="utf8" c:type="gchar*"/>
28998 <parameter name="default_port" transfer-ownership="none">
28999 <doc xml:whitespace="preserve">The default port if none is found in the URI</doc>
29000 <type name="guint16" c:type="guint16"/>
29004 <method name="get_hostname"
29005 c:identifier="g_network_address_get_hostname"
29007 <doc xml:whitespace="preserve">Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
29008 depending on what @addr was created with.</doc>
29009 <return-value transfer-ownership="none">
29010 <doc xml:whitespace="preserve">@addr's hostname</doc>
29011 <type name="utf8" c:type="gchar*"/>
29014 <method name="get_port"
29015 c:identifier="g_network_address_get_port"
29017 <doc xml:whitespace="preserve">Gets @addr's port number</doc>
29018 <return-value transfer-ownership="none">
29019 <doc xml:whitespace="preserve">@addr's port (which may be 0)</doc>
29020 <type name="guint16" c:type="guint16"/>
29023 <method name="get_scheme"
29024 c:identifier="g_network_address_get_scheme"
29026 <doc xml:whitespace="preserve">Gets @addr's scheme</doc>
29027 <return-value transfer-ownership="none">
29028 <doc xml:whitespace="preserve">@addr's scheme (%NULL if not built from URI)</doc>
29029 <type name="utf8" c:type="gchar*"/>
29032 <property name="hostname"
29035 transfer-ownership="none">
29036 <type name="utf8"/>
29038 <property name="port"
29041 transfer-ownership="none">
29042 <type name="guint"/>
29044 <property name="scheme"
29047 transfer-ownership="none">
29048 <type name="utf8"/>
29050 <field name="parent_instance">
29051 <type name="GObject.Object" c:type="GObject"/>
29053 <field name="priv">
29054 <type name="NetworkAddressPrivate" c:type="GNetworkAddressPrivate*"/>
29057 <record name="NetworkAddressClass"
29058 c:type="GNetworkAddressClass"
29059 glib:is-gtype-struct-for="NetworkAddress">
29060 <field name="parent_class">
29061 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
29064 <record name="NetworkAddressPrivate"
29065 c:type="GNetworkAddressPrivate"
29068 <class name="NetworkService"
29069 c:symbol-prefix="network_service"
29070 c:type="GNetworkService"
29071 parent="GObject.Object"
29072 glib:type-name="GNetworkService"
29073 glib:get-type="g_network_service_get_type"
29074 glib:type-struct="NetworkServiceClass">
29075 <doc xml:whitespace="preserve">A #GSocketConnectable for resolving a SRV record and connecting to
29076 that service.</doc>
29077 <implements name="SocketConnectable"/>
29078 <function name="new" c:identifier="g_network_service_new" version="2.22">
29079 <doc xml:whitespace="preserve">Creates a new #GNetworkService representing the given @service,
29080 #GSocketConnectable interface to resolve it.</doc>
29081 <return-value transfer-ownership="full">
29082 <doc xml:whitespace="preserve">a new #GNetworkService</doc>
29083 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
29086 <parameter name="service" transfer-ownership="none">
29087 <doc xml:whitespace="preserve">the service type to look up (eg, "ldap")</doc>
29088 <type name="utf8" c:type="gchar*"/>
29090 <parameter name="protocol" transfer-ownership="none">
29091 <doc xml:whitespace="preserve">the networking protocol to use for @service (eg, "tcp")</doc>
29092 <type name="utf8" c:type="gchar*"/>
29094 <parameter name="domain" transfer-ownership="none">
29095 <doc xml:whitespace="preserve">the DNS domain to look up the service in</doc>
29096 <type name="utf8" c:type="gchar*"/>
29100 <method name="get_domain"
29101 c:identifier="g_network_service_get_domain"
29103 <doc xml:whitespace="preserve">Gets the domain that @srv serves. This might be either UTF-8 or
29104 ASCII-encoded, depending on what @srv was created with.</doc>
29105 <return-value transfer-ownership="none">
29106 <doc xml:whitespace="preserve">@srv's domain name</doc>
29107 <type name="utf8" c:type="gchar*"/>
29110 <method name="get_protocol"
29111 c:identifier="g_network_service_get_protocol"
29113 <doc xml:whitespace="preserve">Gets @srv's protocol name (eg, "tcp").</doc>
29114 <return-value transfer-ownership="none">
29115 <doc xml:whitespace="preserve">@srv's protocol name</doc>
29116 <type name="utf8" c:type="gchar*"/>
29119 <method name="get_scheme"
29120 c:identifier="g_network_service_get_scheme"
29122 <doc xml:whitespace="preserve">Get's the URI scheme used to resolve proxies. By default, the service name
29123 is used as scheme.</doc>
29124 <return-value transfer-ownership="none">
29125 <doc xml:whitespace="preserve">@srv's scheme name</doc>
29126 <type name="utf8" c:type="gchar*"/>
29129 <method name="get_service"
29130 c:identifier="g_network_service_get_service"
29132 <doc xml:whitespace="preserve">Gets @srv's service name (eg, "ldap").</doc>
29133 <return-value transfer-ownership="none">
29134 <doc xml:whitespace="preserve">@srv's service name</doc>
29135 <type name="utf8" c:type="gchar*"/>
29138 <method name="set_scheme"
29139 c:identifier="g_network_service_set_scheme"
29141 <doc xml:whitespace="preserve">Set's the URI scheme used to resolve proxies. By default, the service name
29142 is used as scheme.</doc>
29143 <return-value transfer-ownership="none">
29144 <type name="none" c:type="void"/>
29147 <parameter name="scheme" transfer-ownership="none">
29148 <doc xml:whitespace="preserve">a URI scheme</doc>
29149 <type name="utf8" c:type="gchar*"/>
29153 <property name="domain"
29156 transfer-ownership="none">
29157 <type name="utf8"/>
29159 <property name="protocol"
29162 transfer-ownership="none">
29163 <type name="utf8"/>
29165 <property name="scheme" writable="1" transfer-ownership="none">
29166 <type name="utf8"/>
29168 <property name="service"
29171 transfer-ownership="none">
29172 <type name="utf8"/>
29174 <field name="parent_instance">
29175 <type name="GObject.Object" c:type="GObject"/>
29177 <field name="priv">
29178 <type name="NetworkServicePrivate" c:type="GNetworkServicePrivate*"/>
29181 <record name="NetworkServiceClass"
29182 c:type="GNetworkServiceClass"
29183 glib:is-gtype-struct-for="NetworkService">
29184 <field name="parent_class">
29185 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
29188 <record name="NetworkServicePrivate"
29189 c:type="GNetworkServicePrivate"
29192 <class name="OutputStream"
29193 c:symbol-prefix="output_stream"
29194 c:type="GOutputStream"
29195 parent="GObject.Object"
29197 glib:type-name="GOutputStream"
29198 glib:get-type="g_output_stream_get_type"
29199 glib:type-struct="OutputStreamClass">
29200 <doc xml:whitespace="preserve">Base class for writing output.
29201 All classes derived from GOutputStream should implement synchronous
29202 writing, splicing, flushing and closing streams, but may implement
29203 asynchronous versions.</doc>
29204 <virtual-method name="close_async" invoker="close_async">
29205 <doc xml:whitespace="preserve">Requests an asynchronous close of the stream, releasing resources
29206 related to it. When the operation is finished @callback will be
29207 called. You can then call g_output_stream_close_finish() to get
29208 the result of the operation.
29209 For behaviour details see g_output_stream_close().
29210 The asyncronous methods have a default fallback that uses threads
29211 to implement asynchronicity, so they are optional for inheriting
29212 classes. However, if you override one you must override all.</doc>
29213 <return-value transfer-ownership="none">
29214 <type name="none" c:type="void"/>
29217 <parameter name="io_priority" transfer-ownership="none">
29218 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29219 <type name="gint" c:type="int"/>
29221 <parameter name="cancellable"
29222 transfer-ownership="none"
29224 <doc xml:whitespace="preserve">optional cancellable object</doc>
29225 <type name="Cancellable" c:type="GCancellable*"/>
29227 <parameter name="callback"
29228 transfer-ownership="none"
29231 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
29232 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29234 <parameter name="user_data" transfer-ownership="none" closure="3">
29235 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
29236 <type name="gpointer" c:type="gpointer"/>
29240 <virtual-method name="close_finish" invoker="close_finish" throws="1">
29241 <doc xml:whitespace="preserve">Closes an output stream.</doc>
29242 <return-value transfer-ownership="none">
29243 <doc xml:whitespace="preserve">%TRUE if stream was successfully closed, %FALSE otherwise.</doc>
29244 <type name="gboolean" c:type="gboolean"/>
29247 <parameter name="result" transfer-ownership="none">
29248 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
29249 <type name="AsyncResult" c:type="GAsyncResult*"/>
29253 <virtual-method name="close_fn" throws="1">
29254 <return-value transfer-ownership="none">
29255 <type name="gboolean" c:type="gboolean"/>
29258 <parameter name="cancellable" transfer-ownership="none">
29259 <type name="Cancellable" c:type="GCancellable*"/>
29263 <virtual-method name="flush" invoker="flush" throws="1">
29264 <doc xml:whitespace="preserve">Flushed any outstanding buffers in the stream. Will block during
29265 the operation. Closing the stream will implicitly cause a flush.
29266 This function is optional for inherited classes.
29267 If @cancellable is not %NULL, then the operation can be cancelled by
29268 triggering the cancellable object from another thread. If the operation
29269 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
29270 <return-value transfer-ownership="none">
29271 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error</doc>
29272 <type name="gboolean" c:type="gboolean"/>
29275 <parameter name="cancellable"
29276 transfer-ownership="none"
29278 <doc xml:whitespace="preserve">optional cancellable object</doc>
29279 <type name="Cancellable" c:type="GCancellable*"/>
29283 <virtual-method name="flush_async" invoker="flush_async">
29284 <doc xml:whitespace="preserve">Flushes a stream asynchronously.
29285 For behaviour details see g_output_stream_flush().
29286 When the operation is finished @callback will be
29287 called. You can then call g_output_stream_flush_finish() to get the
29288 result of the operation.</doc>
29289 <return-value transfer-ownership="none">
29290 <type name="none" c:type="void"/>
29293 <parameter name="io_priority" transfer-ownership="none">
29294 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29295 <type name="gint" c:type="int"/>
29297 <parameter name="cancellable"
29298 transfer-ownership="none"
29300 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29301 <type name="Cancellable" c:type="GCancellable*"/>
29303 <parameter name="callback"
29304 transfer-ownership="none"
29307 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
29308 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29310 <parameter name="user_data" transfer-ownership="none" closure="3">
29311 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
29312 <type name="gpointer" c:type="gpointer"/>
29316 <virtual-method name="flush_finish" invoker="flush_finish" throws="1">
29317 <doc xml:whitespace="preserve">Finishes flushing an output stream.</doc>
29318 <return-value transfer-ownership="none">
29319 <doc xml:whitespace="preserve">%TRUE if flush operation suceeded, %FALSE otherwise.</doc>
29320 <type name="gboolean" c:type="gboolean"/>
29323 <parameter name="result" transfer-ownership="none">
29324 <doc xml:whitespace="preserve">a GAsyncResult.</doc>
29325 <type name="AsyncResult" c:type="GAsyncResult*"/>
29329 <virtual-method name="splice" invoker="splice" throws="1">
29330 <doc xml:whitespace="preserve">Splices an input stream into an output stream.
29331 -1 if an error occurred.</doc>
29332 <return-value transfer-ownership="none">
29333 <doc xml:whitespace="preserve">a #gssize containing the size of the data spliced, or</doc>
29334 <type name="glong" c:type="gssize"/>
29337 <parameter name="source" transfer-ownership="none">
29338 <doc xml:whitespace="preserve">a #GInputStream.</doc>
29339 <type name="InputStream" c:type="GInputStream*"/>
29341 <parameter name="flags" transfer-ownership="none">
29342 <doc xml:whitespace="preserve">a set of #GOutputStreamSpliceFlags.</doc>
29343 <type name="OutputStreamSpliceFlags"
29344 c:type="GOutputStreamSpliceFlags"/>
29346 <parameter name="cancellable"
29347 transfer-ownership="none"
29349 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29350 <type name="Cancellable" c:type="GCancellable*"/>
29354 <virtual-method name="splice_async" invoker="splice_async">
29355 <doc xml:whitespace="preserve">Splices a stream asynchronously.
29356 When the operation is finished @callback will be called.
29357 You can then call g_output_stream_splice_finish() to get the
29358 result of the operation.
29359 For the synchronous, blocking version of this function, see
29360 g_output_stream_splice().</doc>
29361 <return-value transfer-ownership="none">
29362 <type name="none" c:type="void"/>
29365 <parameter name="source" transfer-ownership="none">
29366 <doc xml:whitespace="preserve">a #GInputStream.</doc>
29367 <type name="InputStream" c:type="GInputStream*"/>
29369 <parameter name="flags" transfer-ownership="none">
29370 <doc xml:whitespace="preserve">a set of #GOutputStreamSpliceFlags.</doc>
29371 <type name="OutputStreamSpliceFlags"
29372 c:type="GOutputStreamSpliceFlags"/>
29374 <parameter name="io_priority" transfer-ownership="none">
29375 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29376 <type name="gint" c:type="int"/>
29378 <parameter name="cancellable"
29379 transfer-ownership="none"
29381 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29382 <type name="Cancellable" c:type="GCancellable*"/>
29384 <parameter name="callback"
29385 transfer-ownership="none"
29388 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
29389 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29391 <parameter name="data" transfer-ownership="none">
29392 <type name="gpointer" c:type="gpointer"/>
29396 <virtual-method name="splice_finish" invoker="splice_finish" throws="1">
29397 <doc xml:whitespace="preserve">Finishes an asynchronous stream splice operation.</doc>
29398 <return-value transfer-ownership="none">
29399 <doc xml:whitespace="preserve">a #gssize of the number of bytes spliced.</doc>
29400 <type name="glong" c:type="gssize"/>
29403 <parameter name="result" transfer-ownership="none">
29404 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
29405 <type name="AsyncResult" c:type="GAsyncResult*"/>
29409 <virtual-method name="write_async" invoker="write_async">
29410 <doc xml:whitespace="preserve">Request an asynchronous write of @count bytes from @buffer into
29411 the stream. When the operation is finished @callback will be called.
29412 You can then call g_output_stream_write_finish() to get the result of the
29414 During an async request no other sync and async calls are allowed,
29415 and will result in %G_IO_ERROR_PENDING errors.
29416 A value of @count larger than %G_MAXSSIZE will cause a
29417 %G_IO_ERROR_INVALID_ARGUMENT error.
29418 On success, the number of bytes written will be passed to the
29419 requested size, as it can happen e.g. on a partial I/O error,
29420 but generally we try to write as many bytes as requested.
29421 You are guaranteed that this method will never fail with
29422 %G_IO_ERROR_WOULD_BLOCK - if @stream can't accept more data, the
29423 method will just wait until this changes.
29424 Any outstanding I/O request with higher priority (lower numerical
29425 value) will be executed before an outstanding request with lower
29426 priority. Default priority is %G_PRIORITY_DEFAULT.
29427 The asyncronous methods have a default fallback that uses threads
29428 to implement asynchronicity, so they are optional for inheriting
29429 classes. However, if you override one you must override all.
29430 For the synchronous, blocking version of this function, see
29431 g_output_stream_write().</doc>
29432 <return-value transfer-ownership="none">
29433 <type name="none" c:type="void"/>
29436 <parameter name="buffer" transfer-ownership="none">
29437 <doc xml:whitespace="preserve">the buffer containing the data to write.</doc>
29438 <array length="1" c:type="void*">
29439 <type name="guint8"/>
29442 <parameter name="count" transfer-ownership="none">
29443 <doc xml:whitespace="preserve">the number of bytes to write</doc>
29444 <type name="gulong" c:type="gsize"/>
29446 <parameter name="io_priority" transfer-ownership="none">
29447 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29448 <type name="gint" c:type="int"/>
29450 <parameter name="cancellable"
29451 transfer-ownership="none"
29453 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29454 <type name="Cancellable" c:type="GCancellable*"/>
29456 <parameter name="callback"
29457 transfer-ownership="none"
29460 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
29461 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29463 <parameter name="user_data" transfer-ownership="none" closure="5">
29464 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
29465 <type name="gpointer" c:type="gpointer"/>
29469 <virtual-method name="write_finish" invoker="write_finish" throws="1">
29470 <doc xml:whitespace="preserve">Finishes a stream write operation.</doc>
29471 <return-value transfer-ownership="none">
29472 <doc xml:whitespace="preserve">a #gssize containing the number of bytes written to the stream.</doc>
29473 <type name="glong" c:type="gssize"/>
29476 <parameter name="result" transfer-ownership="none">
29477 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
29478 <type name="AsyncResult" c:type="GAsyncResult*"/>
29482 <virtual-method name="write_fn" throws="1">
29483 <return-value transfer-ownership="none">
29484 <type name="glong" c:type="gssize"/>
29487 <parameter name="buffer" transfer-ownership="none">
29488 <type name="gpointer" c:type="void*"/>
29490 <parameter name="count" transfer-ownership="none">
29491 <type name="gulong" c:type="gsize"/>
29493 <parameter name="cancellable" transfer-ownership="none">
29494 <type name="Cancellable" c:type="GCancellable*"/>
29498 <method name="clear_pending"
29499 c:identifier="g_output_stream_clear_pending">
29500 <doc xml:whitespace="preserve">Clears the pending flag on @stream.</doc>
29501 <return-value transfer-ownership="none">
29502 <type name="none" c:type="void"/>
29505 <method name="close" c:identifier="g_output_stream_close" throws="1">
29506 <doc xml:whitespace="preserve">Closes the stream, releasing resources related to it.
29507 Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
29508 Closing a stream multiple times will not return an error.
29509 Closing a stream will automatically flush any outstanding buffers in the
29511 Streams will be automatically closed when the last reference
29512 is dropped, but you might want to call this function to make sure
29513 resources are released as early as possible.
29514 Some streams might keep the backing store of the stream (e.g. a file descriptor)
29515 open after the stream is closed. See the documentation for the individual
29516 stream for details.
29517 On failure the first error that happened will be reported, but the close
29518 operation will finish as much as possible. A stream that failed to
29519 close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
29520 is important to check and report the error to the user, otherwise
29521 there might be a loss of data as all data might not be written.
29522 If @cancellable is not NULL, then the operation can be cancelled by
29523 triggering the cancellable object from another thread. If the operation
29524 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
29525 Cancelling a close will still leave the stream closed, but there some streams
29526 can use a faster close that doesn't block to e.g. check errors. On
29527 cancellation (as with any error) there is no guarantee that all written
29528 data will reach the target.</doc>
29529 <return-value transfer-ownership="none">
29530 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure</doc>
29531 <type name="gboolean" c:type="gboolean"/>
29534 <parameter name="cancellable"
29535 transfer-ownership="none"
29537 <doc xml:whitespace="preserve">optional cancellable object</doc>
29538 <type name="Cancellable" c:type="GCancellable*"/>
29542 <method name="close_async" c:identifier="g_output_stream_close_async">
29543 <doc xml:whitespace="preserve">Requests an asynchronous close of the stream, releasing resources
29544 related to it. When the operation is finished @callback will be
29545 called. You can then call g_output_stream_close_finish() to get
29546 the result of the operation.
29547 For behaviour details see g_output_stream_close().
29548 The asyncronous methods have a default fallback that uses threads
29549 to implement asynchronicity, so they are optional for inheriting
29550 classes. However, if you override one you must override all.</doc>
29551 <return-value transfer-ownership="none">
29552 <type name="none" c:type="void"/>
29555 <parameter name="io_priority" transfer-ownership="none">
29556 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29557 <type name="gint" c:type="int"/>
29559 <parameter name="cancellable"
29560 transfer-ownership="none"
29562 <doc xml:whitespace="preserve">optional cancellable object</doc>
29563 <type name="Cancellable" c:type="GCancellable*"/>
29565 <parameter name="callback"
29566 transfer-ownership="none"
29569 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
29570 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29572 <parameter name="user_data" transfer-ownership="none">
29573 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
29574 <type name="gpointer" c:type="gpointer"/>
29578 <method name="close_finish"
29579 c:identifier="g_output_stream_close_finish"
29581 <doc xml:whitespace="preserve">Closes an output stream.</doc>
29582 <return-value transfer-ownership="none">
29583 <doc xml:whitespace="preserve">%TRUE if stream was successfully closed, %FALSE otherwise.</doc>
29584 <type name="gboolean" c:type="gboolean"/>
29587 <parameter name="result" transfer-ownership="none">
29588 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
29589 <type name="AsyncResult" c:type="GAsyncResult*"/>
29593 <method name="flush" c:identifier="g_output_stream_flush" throws="1">
29594 <doc xml:whitespace="preserve">Flushed any outstanding buffers in the stream. Will block during
29595 the operation. Closing the stream will implicitly cause a flush.
29596 This function is optional for inherited classes.
29597 If @cancellable is not %NULL, then the operation can be cancelled by
29598 triggering the cancellable object from another thread. If the operation
29599 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
29600 <return-value transfer-ownership="none">
29601 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error</doc>
29602 <type name="gboolean" c:type="gboolean"/>
29605 <parameter name="cancellable"
29606 transfer-ownership="none"
29608 <doc xml:whitespace="preserve">optional cancellable object</doc>
29609 <type name="Cancellable" c:type="GCancellable*"/>
29613 <method name="flush_async" c:identifier="g_output_stream_flush_async">
29614 <doc xml:whitespace="preserve">Flushes a stream asynchronously.
29615 For behaviour details see g_output_stream_flush().
29616 When the operation is finished @callback will be
29617 called. You can then call g_output_stream_flush_finish() to get the
29618 result of the operation.</doc>
29619 <return-value transfer-ownership="none">
29620 <type name="none" c:type="void"/>
29623 <parameter name="io_priority" transfer-ownership="none">
29624 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29625 <type name="gint" c:type="int"/>
29627 <parameter name="cancellable"
29628 transfer-ownership="none"
29630 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29631 <type name="Cancellable" c:type="GCancellable*"/>
29633 <parameter name="callback"
29634 transfer-ownership="none"
29637 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
29638 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29640 <parameter name="user_data" transfer-ownership="none">
29641 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
29642 <type name="gpointer" c:type="gpointer"/>
29646 <method name="flush_finish"
29647 c:identifier="g_output_stream_flush_finish"
29649 <doc xml:whitespace="preserve">Finishes flushing an output stream.</doc>
29650 <return-value transfer-ownership="none">
29651 <doc xml:whitespace="preserve">%TRUE if flush operation suceeded, %FALSE otherwise.</doc>
29652 <type name="gboolean" c:type="gboolean"/>
29655 <parameter name="result" transfer-ownership="none">
29656 <doc xml:whitespace="preserve">a GAsyncResult.</doc>
29657 <type name="AsyncResult" c:type="GAsyncResult*"/>
29661 <method name="has_pending" c:identifier="g_output_stream_has_pending">
29662 <doc xml:whitespace="preserve">Checks if an ouput stream has pending actions.</doc>
29663 <return-value transfer-ownership="none">
29664 <doc xml:whitespace="preserve">%TRUE if @stream has pending actions.</doc>
29665 <type name="gboolean" c:type="gboolean"/>
29668 <method name="is_closed" c:identifier="g_output_stream_is_closed">
29669 <doc xml:whitespace="preserve">Checks if an output stream has already been closed.</doc>
29670 <return-value transfer-ownership="none">
29671 <doc xml:whitespace="preserve">%TRUE if @stream is closed. %FALSE otherwise.</doc>
29672 <type name="gboolean" c:type="gboolean"/>
29675 <method name="is_closing"
29676 c:identifier="g_output_stream_is_closing"
29678 <doc xml:whitespace="preserve">Checks if an output stream is being closed. This can be
29679 used inside e.g. a flush implementation to see if the
29680 flush (or other i/o operation) is called from within
29681 the closing operation.</doc>
29682 <return-value transfer-ownership="none">
29683 <doc xml:whitespace="preserve">%TRUE if @stream is being closed. %FALSE otherwise.</doc>
29684 <type name="gboolean" c:type="gboolean"/>
29687 <method name="set_pending"
29688 c:identifier="g_output_stream_set_pending"
29690 <doc xml:whitespace="preserve">Sets @stream to have actions pending. If the pending flag is
29691 already set or @stream is closed, it will return %FALSE and set</doc>
29692 <return-value transfer-ownership="none">
29693 <doc xml:whitespace="preserve">%TRUE if pending was previously unset and is now set.</doc>
29694 <type name="gboolean" c:type="gboolean"/>
29697 <method name="splice" c:identifier="g_output_stream_splice" throws="1">
29698 <doc xml:whitespace="preserve">Splices an input stream into an output stream.
29699 -1 if an error occurred.</doc>
29700 <return-value transfer-ownership="none">
29701 <doc xml:whitespace="preserve">a #gssize containing the size of the data spliced, or</doc>
29702 <type name="glong" c:type="gssize"/>
29705 <parameter name="source" transfer-ownership="none">
29706 <doc xml:whitespace="preserve">a #GInputStream.</doc>
29707 <type name="InputStream" c:type="GInputStream*"/>
29709 <parameter name="flags" transfer-ownership="none">
29710 <doc xml:whitespace="preserve">a set of #GOutputStreamSpliceFlags.</doc>
29711 <type name="OutputStreamSpliceFlags"
29712 c:type="GOutputStreamSpliceFlags"/>
29714 <parameter name="cancellable"
29715 transfer-ownership="none"
29717 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29718 <type name="Cancellable" c:type="GCancellable*"/>
29722 <method name="splice_async" c:identifier="g_output_stream_splice_async">
29723 <doc xml:whitespace="preserve">Splices a stream asynchronously.
29724 When the operation is finished @callback will be called.
29725 You can then call g_output_stream_splice_finish() to get the
29726 result of the operation.
29727 For the synchronous, blocking version of this function, see
29728 g_output_stream_splice().</doc>
29729 <return-value transfer-ownership="none">
29730 <type name="none" c:type="void"/>
29733 <parameter name="source" transfer-ownership="none">
29734 <doc xml:whitespace="preserve">a #GInputStream.</doc>
29735 <type name="InputStream" c:type="GInputStream*"/>
29737 <parameter name="flags" transfer-ownership="none">
29738 <doc xml:whitespace="preserve">a set of #GOutputStreamSpliceFlags.</doc>
29739 <type name="OutputStreamSpliceFlags"
29740 c:type="GOutputStreamSpliceFlags"/>
29742 <parameter name="io_priority" transfer-ownership="none">
29743 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29744 <type name="gint" c:type="int"/>
29746 <parameter name="cancellable"
29747 transfer-ownership="none"
29749 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29750 <type name="Cancellable" c:type="GCancellable*"/>
29752 <parameter name="callback"
29753 transfer-ownership="none"
29756 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
29757 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29759 <parameter name="user_data" transfer-ownership="none">
29760 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
29761 <type name="gpointer" c:type="gpointer"/>
29765 <method name="splice_finish"
29766 c:identifier="g_output_stream_splice_finish"
29768 <doc xml:whitespace="preserve">Finishes an asynchronous stream splice operation.</doc>
29769 <return-value transfer-ownership="none">
29770 <doc xml:whitespace="preserve">a #gssize of the number of bytes spliced.</doc>
29771 <type name="glong" c:type="gssize"/>
29774 <parameter name="result" transfer-ownership="none">
29775 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
29776 <type name="AsyncResult" c:type="GAsyncResult*"/>
29780 <method name="write" c:identifier="g_output_stream_write" throws="1">
29781 <doc xml:whitespace="preserve">Tries to write @count bytes from @buffer into the stream. Will block
29782 during the operation.
29783 If count is 0, returns 0 and does nothing. A value of @count
29784 larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
29785 On success, the number of bytes written to the stream is returned.
29786 It is not an error if this is not the same as the requested size, as it
29787 can happen e.g. on a partial I/O error, or if there is not enough
29788 storage in the stream. All writes block until at least one byte
29789 is written or an error occurs; 0 is never returned (unless
29790 If @cancellable is not NULL, then the operation can be cancelled by
29791 triggering the cancellable object from another thread. If the operation
29792 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
29793 operation was partially finished when the operation was cancelled the
29794 partial result will be returned, without an error.
29795 On error -1 is returned and @error is set accordingly.</doc>
29796 <return-value transfer-ownership="none">
29797 <doc xml:whitespace="preserve">Number of bytes written, or -1 on error</doc>
29798 <type name="glong" c:type="gssize"/>
29801 <parameter name="buffer" transfer-ownership="none">
29802 <doc xml:whitespace="preserve">the buffer containing the data to write.</doc>
29803 <array length="1" c:type="void*">
29804 <type name="guint8"/>
29807 <parameter name="count" transfer-ownership="none">
29808 <doc xml:whitespace="preserve">the number of bytes to write</doc>
29809 <type name="gulong" c:type="gsize"/>
29811 <parameter name="cancellable"
29812 transfer-ownership="none"
29814 <doc xml:whitespace="preserve">optional cancellable object</doc>
29815 <type name="Cancellable" c:type="GCancellable*"/>
29819 <method name="write_all"
29820 c:identifier="g_output_stream_write_all"
29822 <doc xml:whitespace="preserve">Tries to write @count bytes from @buffer into the stream. Will block
29823 during the operation.
29824 This function is similar to g_output_stream_write(), except it tries to
29825 write as many bytes as requested, only stopping on an error.
29826 On a successful write of @count bytes, %TRUE is returned, and @bytes_written
29828 If there is an error during the operation FALSE is returned and @error
29829 is set to indicate the error status, @bytes_written is updated to contain
29830 the number of bytes written into the stream before the error occurred.</doc>
29831 <return-value transfer-ownership="none">
29832 <doc xml:whitespace="preserve">%TRUE on success, %FALSE if there was an error</doc>
29833 <type name="gboolean" c:type="gboolean"/>
29836 <parameter name="buffer" transfer-ownership="none">
29837 <doc xml:whitespace="preserve">the buffer containing the data to write.</doc>
29838 <array length="1" c:type="void*">
29839 <type name="guint8"/>
29842 <parameter name="count" transfer-ownership="none">
29843 <doc xml:whitespace="preserve">the number of bytes to write</doc>
29844 <type name="gulong" c:type="gsize"/>
29846 <parameter name="bytes_written" transfer-ownership="none">
29847 <doc xml:whitespace="preserve">location to store the number of bytes that was written to the stream</doc>
29848 <type name="gulong" c:type="gsize*"/>
29850 <parameter name="cancellable"
29851 transfer-ownership="none"
29853 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29854 <type name="Cancellable" c:type="GCancellable*"/>
29858 <method name="write_async" c:identifier="g_output_stream_write_async">
29859 <doc xml:whitespace="preserve">Request an asynchronous write of @count bytes from @buffer into
29860 the stream. When the operation is finished @callback will be called.
29861 You can then call g_output_stream_write_finish() to get the result of the
29863 During an async request no other sync and async calls are allowed,
29864 and will result in %G_IO_ERROR_PENDING errors.
29865 A value of @count larger than %G_MAXSSIZE will cause a
29866 %G_IO_ERROR_INVALID_ARGUMENT error.
29867 On success, the number of bytes written will be passed to the
29868 requested size, as it can happen e.g. on a partial I/O error,
29869 but generally we try to write as many bytes as requested.
29870 You are guaranteed that this method will never fail with
29871 %G_IO_ERROR_WOULD_BLOCK - if @stream can't accept more data, the
29872 method will just wait until this changes.
29873 Any outstanding I/O request with higher priority (lower numerical
29874 value) will be executed before an outstanding request with lower
29875 priority. Default priority is %G_PRIORITY_DEFAULT.
29876 The asyncronous methods have a default fallback that uses threads
29877 to implement asynchronicity, so they are optional for inheriting
29878 classes. However, if you override one you must override all.
29879 For the synchronous, blocking version of this function, see
29880 g_output_stream_write().</doc>
29881 <return-value transfer-ownership="none">
29882 <type name="none" c:type="void"/>
29885 <parameter name="buffer" transfer-ownership="none">
29886 <doc xml:whitespace="preserve">the buffer containing the data to write.</doc>
29887 <array length="1" c:type="void*">
29888 <type name="guint8"/>
29891 <parameter name="count" transfer-ownership="none">
29892 <doc xml:whitespace="preserve">the number of bytes to write</doc>
29893 <type name="gulong" c:type="gsize"/>
29895 <parameter name="io_priority" transfer-ownership="none">
29896 <doc xml:whitespace="preserve">the io priority of the request.</doc>
29897 <type name="gint" c:type="int"/>
29899 <parameter name="cancellable"
29900 transfer-ownership="none"
29902 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29903 <type name="Cancellable" c:type="GCancellable*"/>
29905 <parameter name="callback"
29906 transfer-ownership="none"
29909 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
29910 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
29912 <parameter name="user_data" transfer-ownership="none">
29913 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
29914 <type name="gpointer" c:type="gpointer"/>
29918 <method name="write_finish"
29919 c:identifier="g_output_stream_write_finish"
29921 <doc xml:whitespace="preserve">Finishes a stream write operation.</doc>
29922 <return-value transfer-ownership="none">
29923 <doc xml:whitespace="preserve">a #gssize containing the number of bytes written to the stream.</doc>
29924 <type name="glong" c:type="gssize"/>
29927 <parameter name="result" transfer-ownership="none">
29928 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
29929 <type name="AsyncResult" c:type="GAsyncResult*"/>
29933 <field name="parent_instance">
29934 <type name="GObject.Object" c:type="GObject"/>
29936 <field name="priv">
29937 <type name="OutputStreamPrivate" c:type="GOutputStreamPrivate*"/>
29940 <record name="OutputStreamClass"
29941 c:type="GOutputStreamClass"
29942 glib:is-gtype-struct-for="OutputStream">
29943 <field name="parent_class">
29944 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
29946 <field name="write_fn">
29947 <callback name="write_fn" throws="1">
29948 <return-value transfer-ownership="none">
29949 <type name="glong" c:type="gssize"/>
29952 <parameter name="stream" transfer-ownership="none">
29953 <type name="OutputStream" c:type="GOutputStream*"/>
29955 <parameter name="buffer" transfer-ownership="none">
29956 <type name="gpointer" c:type="void*"/>
29958 <parameter name="count" transfer-ownership="none">
29959 <type name="gulong" c:type="gsize"/>
29961 <parameter name="cancellable" transfer-ownership="none">
29962 <type name="Cancellable" c:type="GCancellable*"/>
29967 <field name="splice">
29968 <callback name="splice" throws="1">
29969 <return-value transfer-ownership="none">
29970 <doc xml:whitespace="preserve">a #gssize containing the size of the data spliced, or</doc>
29971 <type name="glong" c:type="gssize"/>
29974 <parameter name="stream" transfer-ownership="none">
29975 <type name="OutputStream" c:type="GOutputStream*"/>
29977 <parameter name="source" transfer-ownership="none">
29978 <doc xml:whitespace="preserve">a #GInputStream.</doc>
29979 <type name="InputStream" c:type="GInputStream*"/>
29981 <parameter name="flags" transfer-ownership="none">
29982 <doc xml:whitespace="preserve">a set of #GOutputStreamSpliceFlags.</doc>
29983 <type name="OutputStreamSpliceFlags"
29984 c:type="GOutputStreamSpliceFlags"/>
29986 <parameter name="cancellable"
29987 transfer-ownership="none"
29989 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
29990 <type name="Cancellable" c:type="GCancellable*"/>
29995 <field name="flush">
29996 <callback name="flush" throws="1">
29997 <return-value transfer-ownership="none">
29998 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error</doc>
29999 <type name="gboolean" c:type="gboolean"/>
30002 <parameter name="stream" transfer-ownership="none">
30003 <type name="OutputStream" c:type="GOutputStream*"/>
30005 <parameter name="cancellable"
30006 transfer-ownership="none"
30008 <doc xml:whitespace="preserve">optional cancellable object</doc>
30009 <type name="Cancellable" c:type="GCancellable*"/>
30014 <field name="close_fn">
30015 <callback name="close_fn" throws="1">
30016 <return-value transfer-ownership="none">
30017 <type name="gboolean" c:type="gboolean"/>
30020 <parameter name="stream" transfer-ownership="none">
30021 <type name="OutputStream" c:type="GOutputStream*"/>
30023 <parameter name="cancellable" transfer-ownership="none">
30024 <type name="Cancellable" c:type="GCancellable*"/>
30029 <field name="write_async">
30030 <callback name="write_async">
30031 <return-value transfer-ownership="none">
30032 <type name="none" c:type="void"/>
30035 <parameter name="stream" transfer-ownership="none">
30036 <type name="OutputStream" c:type="GOutputStream*"/>
30038 <parameter name="buffer" transfer-ownership="none">
30039 <doc xml:whitespace="preserve">the buffer containing the data to write.</doc>
30040 <array length="2" c:type="void*">
30041 <type name="guint8"/>
30044 <parameter name="count" transfer-ownership="none">
30045 <doc xml:whitespace="preserve">the number of bytes to write</doc>
30046 <type name="gulong" c:type="gsize"/>
30048 <parameter name="io_priority" transfer-ownership="none">
30049 <doc xml:whitespace="preserve">the io priority of the request.</doc>
30050 <type name="gint" c:type="int"/>
30052 <parameter name="cancellable"
30053 transfer-ownership="none"
30055 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
30056 <type name="Cancellable" c:type="GCancellable*"/>
30058 <parameter name="callback"
30059 transfer-ownership="none"
30062 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
30063 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30065 <parameter name="user_data" transfer-ownership="none" closure="6">
30066 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
30067 <type name="gpointer" c:type="gpointer"/>
30072 <field name="write_finish">
30073 <callback name="write_finish" throws="1">
30074 <return-value transfer-ownership="none">
30075 <doc xml:whitespace="preserve">a #gssize containing the number of bytes written to the stream.</doc>
30076 <type name="glong" c:type="gssize"/>
30079 <parameter name="stream" transfer-ownership="none">
30080 <type name="OutputStream" c:type="GOutputStream*"/>
30082 <parameter name="result" transfer-ownership="none">
30083 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
30084 <type name="AsyncResult" c:type="GAsyncResult*"/>
30089 <field name="splice_async">
30090 <callback name="splice_async">
30091 <return-value transfer-ownership="none">
30092 <type name="none" c:type="void"/>
30095 <parameter name="stream" transfer-ownership="none">
30096 <type name="OutputStream" c:type="GOutputStream*"/>
30098 <parameter name="source" transfer-ownership="none">
30099 <doc xml:whitespace="preserve">a #GInputStream.</doc>
30100 <type name="InputStream" c:type="GInputStream*"/>
30102 <parameter name="flags" transfer-ownership="none">
30103 <doc xml:whitespace="preserve">a set of #GOutputStreamSpliceFlags.</doc>
30104 <type name="OutputStreamSpliceFlags"
30105 c:type="GOutputStreamSpliceFlags"/>
30107 <parameter name="io_priority" transfer-ownership="none">
30108 <doc xml:whitespace="preserve">the io priority of the request.</doc>
30109 <type name="gint" c:type="int"/>
30111 <parameter name="cancellable"
30112 transfer-ownership="none"
30114 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
30115 <type name="Cancellable" c:type="GCancellable*"/>
30117 <parameter name="callback"
30118 transfer-ownership="none"
30121 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
30122 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30124 <parameter name="data" transfer-ownership="none">
30125 <type name="gpointer" c:type="gpointer"/>
30130 <field name="splice_finish">
30131 <callback name="splice_finish" throws="1">
30132 <return-value transfer-ownership="none">
30133 <doc xml:whitespace="preserve">a #gssize of the number of bytes spliced.</doc>
30134 <type name="glong" c:type="gssize"/>
30137 <parameter name="stream" transfer-ownership="none">
30138 <type name="OutputStream" c:type="GOutputStream*"/>
30140 <parameter name="result" transfer-ownership="none">
30141 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
30142 <type name="AsyncResult" c:type="GAsyncResult*"/>
30147 <field name="flush_async">
30148 <callback name="flush_async">
30149 <return-value transfer-ownership="none">
30150 <type name="none" c:type="void"/>
30153 <parameter name="stream" transfer-ownership="none">
30154 <type name="OutputStream" c:type="GOutputStream*"/>
30156 <parameter name="io_priority" transfer-ownership="none">
30157 <doc xml:whitespace="preserve">the io priority of the request.</doc>
30158 <type name="gint" c:type="int"/>
30160 <parameter name="cancellable"
30161 transfer-ownership="none"
30163 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
30164 <type name="Cancellable" c:type="GCancellable*"/>
30166 <parameter name="callback"
30167 transfer-ownership="none"
30170 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
30171 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30173 <parameter name="user_data" transfer-ownership="none" closure="4">
30174 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
30175 <type name="gpointer" c:type="gpointer"/>
30180 <field name="flush_finish">
30181 <callback name="flush_finish" throws="1">
30182 <return-value transfer-ownership="none">
30183 <doc xml:whitespace="preserve">%TRUE if flush operation suceeded, %FALSE otherwise.</doc>
30184 <type name="gboolean" c:type="gboolean"/>
30187 <parameter name="stream" transfer-ownership="none">
30188 <type name="OutputStream" c:type="GOutputStream*"/>
30190 <parameter name="result" transfer-ownership="none">
30191 <doc xml:whitespace="preserve">a GAsyncResult.</doc>
30192 <type name="AsyncResult" c:type="GAsyncResult*"/>
30197 <field name="close_async">
30198 <callback name="close_async">
30199 <return-value transfer-ownership="none">
30200 <type name="none" c:type="void"/>
30203 <parameter name="stream" transfer-ownership="none">
30204 <type name="OutputStream" c:type="GOutputStream*"/>
30206 <parameter name="io_priority" transfer-ownership="none">
30207 <doc xml:whitespace="preserve">the io priority of the request.</doc>
30208 <type name="gint" c:type="int"/>
30210 <parameter name="cancellable"
30211 transfer-ownership="none"
30213 <doc xml:whitespace="preserve">optional cancellable object</doc>
30214 <type name="Cancellable" c:type="GCancellable*"/>
30216 <parameter name="callback"
30217 transfer-ownership="none"
30220 <doc xml:whitespace="preserve">callback to call when the request is satisfied</doc>
30221 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30223 <parameter name="user_data" transfer-ownership="none" closure="4">
30224 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
30225 <type name="gpointer" c:type="gpointer"/>
30230 <field name="close_finish">
30231 <callback name="close_finish" throws="1">
30232 <return-value transfer-ownership="none">
30233 <doc xml:whitespace="preserve">%TRUE if stream was successfully closed, %FALSE otherwise.</doc>
30234 <type name="gboolean" c:type="gboolean"/>
30237 <parameter name="stream" transfer-ownership="none">
30238 <type name="OutputStream" c:type="GOutputStream*"/>
30240 <parameter name="result" transfer-ownership="none">
30241 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
30242 <type name="AsyncResult" c:type="GAsyncResult*"/>
30247 <field name="_g_reserved1" introspectable="0">
30248 <callback name="_g_reserved1">
30249 <return-value transfer-ownership="none">
30250 <type name="none" c:type="void"/>
30254 <field name="_g_reserved2" introspectable="0">
30255 <callback name="_g_reserved2">
30256 <return-value transfer-ownership="none">
30257 <type name="none" c:type="void"/>
30261 <field name="_g_reserved3" introspectable="0">
30262 <callback name="_g_reserved3">
30263 <return-value transfer-ownership="none">
30264 <type name="none" c:type="void"/>
30268 <field name="_g_reserved4" introspectable="0">
30269 <callback name="_g_reserved4">
30270 <return-value transfer-ownership="none">
30271 <type name="none" c:type="void"/>
30275 <field name="_g_reserved5" introspectable="0">
30276 <callback name="_g_reserved5">
30277 <return-value transfer-ownership="none">
30278 <type name="none" c:type="void"/>
30282 <field name="_g_reserved6" introspectable="0">
30283 <callback name="_g_reserved6">
30284 <return-value transfer-ownership="none">
30285 <type name="none" c:type="void"/>
30289 <field name="_g_reserved7" introspectable="0">
30290 <callback name="_g_reserved7">
30291 <return-value transfer-ownership="none">
30292 <type name="none" c:type="void"/>
30296 <field name="_g_reserved8" introspectable="0">
30297 <callback name="_g_reserved8">
30298 <return-value transfer-ownership="none">
30299 <type name="none" c:type="void"/>
30304 <record name="OutputStreamPrivate"
30305 c:type="GOutputStreamPrivate"
30308 <bitfield name="OutputStreamSpliceFlags"
30309 glib:type-name="GOutputStreamSpliceFlags"
30310 glib:get-type="g_output_stream_splice_flags_get_type"
30311 c:type="GOutputStreamSpliceFlags">
30312 <doc xml:whitespace="preserve">GOutputStreamSpliceFlags determine how streams should be spliced.</doc>
30313 <member name="none"
30315 c:identifier="G_OUTPUT_STREAM_SPLICE_NONE"
30317 <member name="close_source"
30319 c:identifier="G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE"
30320 glib:nick="close-source"/>
30321 <member name="close_target"
30323 c:identifier="G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET"
30324 glib:nick="close-target"/>
30326 <record name="OutputVector" c:type="GOutputVector" version="2.22">
30327 <doc xml:whitespace="preserve">Structure used for scatter/gather data output.
30328 You generally pass in an array of #GOutputVector<!-- -->s
30329 and the operation will use all the buffers as if they were
30331 <field name="buffer" writable="1">
30332 <type name="gpointer" c:type="gconstpointer"/>
30334 <field name="size" writable="1">
30335 <type name="gulong" c:type="gsize"/>
30338 <constant name="PROXY_EXTENSION_POINT_NAME" value="gio-proxy">
30339 <type name="utf8" c:type="gchar*"/>
30341 <constant name="PROXY_RESOLVER_EXTENSION_POINT_NAME"
30342 value="gio-proxy-resolver">
30343 <type name="utf8" c:type="gchar*"/>
30345 <enumeration name="PasswordSave"
30346 glib:type-name="GPasswordSave"
30347 glib:get-type="g_password_save_get_type"
30348 c:type="GPasswordSave">
30349 <doc xml:whitespace="preserve">#GPasswordSave is used to indicate the lifespan of a saved password.
30350 #Gvfs stores passwords in the Gnome keyring when this flag allows it
30351 to, and later retrieves it again from there.</doc>
30352 <member name="never"
30354 c:identifier="G_PASSWORD_SAVE_NEVER"
30355 glib:nick="never"/>
30356 <member name="for_session"
30358 c:identifier="G_PASSWORD_SAVE_FOR_SESSION"
30359 glib:nick="for-session"/>
30360 <member name="permanently"
30362 c:identifier="G_PASSWORD_SAVE_PERMANENTLY"
30363 glib:nick="permanently"/>
30365 <class name="Permission"
30366 c:symbol-prefix="permission"
30367 c:type="GPermission"
30368 parent="GObject.Object"
30370 glib:type-name="GPermission"
30371 glib:get-type="g_permission_get_type"
30372 glib:type-struct="PermissionClass">
30373 <doc xml:whitespace="preserve">#GPermission is an opaque data structure and can only be accessed
30374 using the following functions.</doc>
30375 <virtual-method name="acquire"
30379 <doc xml:whitespace="preserve">Attempts to acquire the permission represented by @permission.
30380 The precise method by which this happens depends on the permission
30381 and the underlying authentication mechanism. A simple example is
30382 that a dialog may appear asking the user to enter their password.
30383 You should check with g_permission_get_can_acquire() before calling
30385 If the permission is acquired then %TRUE is returned. Otherwise,
30386 %FALSE is returned and @error is set appropriately.
30387 This call is blocking, likely for a very long time (in the case that
30388 user interaction is required). See g_permission_acquire_async() for
30389 the non-blocking version.</doc>
30390 <return-value transfer-ownership="none">
30391 <doc xml:whitespace="preserve">%TRUE if the permission was successfully acquired</doc>
30392 <type name="gboolean" c:type="gboolean"/>
30395 <parameter name="cancellable"
30396 transfer-ownership="none"
30398 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30399 <type name="Cancellable" c:type="GCancellable*"/>
30403 <virtual-method name="acquire_async"
30404 invoker="acquire_async"
30406 <doc xml:whitespace="preserve">Attempts to acquire the permission represented by @permission.
30407 This is the first half of the asynchronous version of
30408 g_permission_acquire().</doc>
30409 <return-value transfer-ownership="none">
30410 <type name="none" c:type="void"/>
30413 <parameter name="cancellable"
30414 transfer-ownership="none"
30416 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30417 <type name="Cancellable" c:type="GCancellable*"/>
30419 <parameter name="callback"
30420 transfer-ownership="none"
30423 <doc xml:whitespace="preserve">the #GAsyncReadyCallback to call when done</doc>
30424 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30426 <parameter name="user_data" transfer-ownership="none" closure="2">
30427 <doc xml:whitespace="preserve">the user data to pass to @callback</doc>
30428 <type name="gpointer" c:type="gpointer"/>
30432 <virtual-method name="acquire_finish"
30433 invoker="acquire_finish"
30436 <doc xml:whitespace="preserve">Collects the result of attempting to acquire the permission
30437 represented by @permission.
30438 This is the second half of the asynchronous version of
30439 g_permission_acquire().</doc>
30440 <return-value transfer-ownership="none">
30441 <doc xml:whitespace="preserve">%TRUE if the permission was successfully acquired</doc>
30442 <type name="gboolean" c:type="gboolean"/>
30445 <parameter name="result" transfer-ownership="none">
30446 <doc xml:whitespace="preserve">the #GAsyncResult given to the #GAsyncReadyCallback</doc>
30447 <type name="AsyncResult" c:type="GAsyncResult*"/>
30451 <virtual-method name="release"
30455 <doc xml:whitespace="preserve">Attempts to release the permission represented by @permission.
30456 The precise method by which this happens depends on the permission
30457 and the underlying authentication mechanism. In most cases the
30458 permission will be dropped immediately without further action.
30459 You should check with g_permission_get_can_release() before calling
30461 If the permission is released then %TRUE is returned. Otherwise,
30462 %FALSE is returned and @error is set appropriately.
30463 This call is blocking, likely for a very long time (in the case that
30464 user interaction is required). See g_permission_release_async() for
30465 the non-blocking version.</doc>
30466 <return-value transfer-ownership="none">
30467 <doc xml:whitespace="preserve">%TRUE if the permission was successfully released</doc>
30468 <type name="gboolean" c:type="gboolean"/>
30471 <parameter name="cancellable"
30472 transfer-ownership="none"
30474 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30475 <type name="Cancellable" c:type="GCancellable*"/>
30479 <virtual-method name="release_async"
30480 invoker="release_async"
30482 <doc xml:whitespace="preserve">Attempts to release the permission represented by @permission.
30483 This is the first half of the asynchronous version of
30484 g_permission_release().</doc>
30485 <return-value transfer-ownership="none">
30486 <type name="none" c:type="void"/>
30489 <parameter name="cancellable"
30490 transfer-ownership="none"
30492 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30493 <type name="Cancellable" c:type="GCancellable*"/>
30495 <parameter name="callback"
30496 transfer-ownership="none"
30499 <doc xml:whitespace="preserve">the #GAsyncReadyCallback to call when done</doc>
30500 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30502 <parameter name="user_data" transfer-ownership="none" closure="2">
30503 <doc xml:whitespace="preserve">the user data to pass to @callback</doc>
30504 <type name="gpointer" c:type="gpointer"/>
30508 <virtual-method name="release_finish"
30509 invoker="release_finish"
30512 <doc xml:whitespace="preserve">Collects the result of attempting to release the permission
30513 represented by @permission.
30514 This is the second half of the asynchronous version of
30515 g_permission_release().</doc>
30516 <return-value transfer-ownership="none">
30517 <doc xml:whitespace="preserve">%TRUE if the permission was successfully released</doc>
30518 <type name="gboolean" c:type="gboolean"/>
30521 <parameter name="result" transfer-ownership="none">
30522 <doc xml:whitespace="preserve">the #GAsyncResult given to the #GAsyncReadyCallback</doc>
30523 <type name="AsyncResult" c:type="GAsyncResult*"/>
30527 <method name="acquire"
30528 c:identifier="g_permission_acquire"
30531 <doc xml:whitespace="preserve">Attempts to acquire the permission represented by @permission.
30532 The precise method by which this happens depends on the permission
30533 and the underlying authentication mechanism. A simple example is
30534 that a dialog may appear asking the user to enter their password.
30535 You should check with g_permission_get_can_acquire() before calling
30537 If the permission is acquired then %TRUE is returned. Otherwise,
30538 %FALSE is returned and @error is set appropriately.
30539 This call is blocking, likely for a very long time (in the case that
30540 user interaction is required). See g_permission_acquire_async() for
30541 the non-blocking version.</doc>
30542 <return-value transfer-ownership="none">
30543 <doc xml:whitespace="preserve">%TRUE if the permission was successfully acquired</doc>
30544 <type name="gboolean" c:type="gboolean"/>
30547 <parameter name="cancellable"
30548 transfer-ownership="none"
30550 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30551 <type name="Cancellable" c:type="GCancellable*"/>
30555 <method name="acquire_async"
30556 c:identifier="g_permission_acquire_async"
30558 <doc xml:whitespace="preserve">Attempts to acquire the permission represented by @permission.
30559 This is the first half of the asynchronous version of
30560 g_permission_acquire().</doc>
30561 <return-value transfer-ownership="none">
30562 <type name="none" c:type="void"/>
30565 <parameter name="cancellable"
30566 transfer-ownership="none"
30568 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30569 <type name="Cancellable" c:type="GCancellable*"/>
30571 <parameter name="callback"
30572 transfer-ownership="none"
30575 <doc xml:whitespace="preserve">the #GAsyncReadyCallback to call when done</doc>
30576 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30578 <parameter name="user_data" transfer-ownership="none">
30579 <doc xml:whitespace="preserve">the user data to pass to @callback</doc>
30580 <type name="gpointer" c:type="gpointer"/>
30584 <method name="acquire_finish"
30585 c:identifier="g_permission_acquire_finish"
30588 <doc xml:whitespace="preserve">Collects the result of attempting to acquire the permission
30589 represented by @permission.
30590 This is the second half of the asynchronous version of
30591 g_permission_acquire().</doc>
30592 <return-value transfer-ownership="none">
30593 <doc xml:whitespace="preserve">%TRUE if the permission was successfully acquired</doc>
30594 <type name="gboolean" c:type="gboolean"/>
30597 <parameter name="result" transfer-ownership="none">
30598 <doc xml:whitespace="preserve">the #GAsyncResult given to the #GAsyncReadyCallback</doc>
30599 <type name="AsyncResult" c:type="GAsyncResult*"/>
30603 <method name="get_allowed"
30604 c:identifier="g_permission_get_allowed"
30606 <doc xml:whitespace="preserve">Gets the value of the 'allowed' property. This property is %TRUE if
30607 the caller currently has permission to perform the action that</doc>
30608 <return-value transfer-ownership="none">
30609 <doc xml:whitespace="preserve">the value of the 'allowed' property</doc>
30610 <type name="gboolean" c:type="gboolean"/>
30613 <method name="get_can_acquire"
30614 c:identifier="g_permission_get_can_acquire"
30616 <doc xml:whitespace="preserve">Gets the value of the 'can-acquire' property. This property is %TRUE
30617 if it is generally possible to acquire the permission by calling
30618 g_permission_acquire().</doc>
30619 <return-value transfer-ownership="none">
30620 <doc xml:whitespace="preserve">the value of the 'can-acquire' property</doc>
30621 <type name="gboolean" c:type="gboolean"/>
30624 <method name="get_can_release"
30625 c:identifier="g_permission_get_can_release"
30627 <doc xml:whitespace="preserve">Gets the value of the 'can-release' property. This property is %TRUE
30628 if it is generally possible to release the permission by calling
30629 g_permission_release().</doc>
30630 <return-value transfer-ownership="none">
30631 <doc xml:whitespace="preserve">the value of the 'can-release' property</doc>
30632 <type name="gboolean" c:type="gboolean"/>
30635 <method name="impl_update"
30636 c:identifier="g_permission_impl_update"
30638 <doc xml:whitespace="preserve">This function is called by the #GPermission implementation to update
30639 the properties of the permission. You should never call this
30640 function except from a #GPermission implementation.
30641 GObject notify signals are generated, as appropriate.</doc>
30642 <return-value transfer-ownership="none">
30643 <type name="none" c:type="void"/>
30646 <parameter name="allowed" transfer-ownership="none">
30647 <doc xml:whitespace="preserve">the new value for the 'allowed' property</doc>
30648 <type name="gboolean" c:type="gboolean"/>
30650 <parameter name="can_acquire" transfer-ownership="none">
30651 <doc xml:whitespace="preserve">the new value for the 'can-acquire' property</doc>
30652 <type name="gboolean" c:type="gboolean"/>
30654 <parameter name="can_release" transfer-ownership="none">
30655 <doc xml:whitespace="preserve">the new value for the 'can-release' property</doc>
30656 <type name="gboolean" c:type="gboolean"/>
30660 <method name="release"
30661 c:identifier="g_permission_release"
30664 <doc xml:whitespace="preserve">Attempts to release the permission represented by @permission.
30665 The precise method by which this happens depends on the permission
30666 and the underlying authentication mechanism. In most cases the
30667 permission will be dropped immediately without further action.
30668 You should check with g_permission_get_can_release() before calling
30670 If the permission is released then %TRUE is returned. Otherwise,
30671 %FALSE is returned and @error is set appropriately.
30672 This call is blocking, likely for a very long time (in the case that
30673 user interaction is required). See g_permission_release_async() for
30674 the non-blocking version.</doc>
30675 <return-value transfer-ownership="none">
30676 <doc xml:whitespace="preserve">%TRUE if the permission was successfully released</doc>
30677 <type name="gboolean" c:type="gboolean"/>
30680 <parameter name="cancellable"
30681 transfer-ownership="none"
30683 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30684 <type name="Cancellable" c:type="GCancellable*"/>
30688 <method name="release_async"
30689 c:identifier="g_permission_release_async"
30691 <doc xml:whitespace="preserve">Attempts to release the permission represented by @permission.
30692 This is the first half of the asynchronous version of
30693 g_permission_release().</doc>
30694 <return-value transfer-ownership="none">
30695 <type name="none" c:type="void"/>
30698 <parameter name="cancellable"
30699 transfer-ownership="none"
30701 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30702 <type name="Cancellable" c:type="GCancellable*"/>
30704 <parameter name="callback"
30705 transfer-ownership="none"
30708 <doc xml:whitespace="preserve">the #GAsyncReadyCallback to call when done</doc>
30709 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30711 <parameter name="user_data" transfer-ownership="none">
30712 <doc xml:whitespace="preserve">the user data to pass to @callback</doc>
30713 <type name="gpointer" c:type="gpointer"/>
30717 <method name="release_finish"
30718 c:identifier="g_permission_release_finish"
30721 <doc xml:whitespace="preserve">Collects the result of attempting to release the permission
30722 represented by @permission.
30723 This is the second half of the asynchronous version of
30724 g_permission_release().</doc>
30725 <return-value transfer-ownership="none">
30726 <doc xml:whitespace="preserve">%TRUE if the permission was successfully released</doc>
30727 <type name="gboolean" c:type="gboolean"/>
30730 <parameter name="result" transfer-ownership="none">
30731 <doc xml:whitespace="preserve">the #GAsyncResult given to the #GAsyncReadyCallback</doc>
30732 <type name="AsyncResult" c:type="GAsyncResult*"/>
30736 <property name="allowed" transfer-ownership="none">
30737 <doc xml:whitespace="preserve">%TRUE if the caller currently has permission to perform the action that</doc>
30738 <type name="gboolean"/>
30740 <property name="can-acquire" transfer-ownership="none">
30741 <doc xml:whitespace="preserve">%TRUE if it is generally possible to acquire the permission by calling
30742 g_permission_acquire().</doc>
30743 <type name="gboolean"/>
30745 <property name="can-release" transfer-ownership="none">
30746 <doc xml:whitespace="preserve">%TRUE if it is generally possible to release the permission by calling
30747 g_permission_release().</doc>
30748 <type name="gboolean"/>
30750 <field name="parent_instance">
30751 <type name="GObject.Object" c:type="GObject"/>
30753 <field name="priv">
30754 <type name="PermissionPrivate" c:type="GPermissionPrivate*"/>
30757 <record name="PermissionClass"
30758 c:type="GPermissionClass"
30759 glib:is-gtype-struct-for="Permission">
30760 <field name="parent_class">
30761 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
30763 <field name="acquire">
30764 <callback name="acquire" throws="1">
30765 <return-value transfer-ownership="none">
30766 <doc xml:whitespace="preserve">%TRUE if the permission was successfully acquired</doc>
30767 <type name="gboolean" c:type="gboolean"/>
30770 <parameter name="permission" transfer-ownership="none">
30771 <type name="Permission" c:type="GPermission*"/>
30773 <parameter name="cancellable"
30774 transfer-ownership="none"
30776 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30777 <type name="Cancellable" c:type="GCancellable*"/>
30782 <field name="acquire_async">
30783 <callback name="acquire_async">
30784 <return-value transfer-ownership="none">
30785 <type name="none" c:type="void"/>
30788 <parameter name="permission" transfer-ownership="none">
30789 <type name="Permission" c:type="GPermission*"/>
30791 <parameter name="cancellable"
30792 transfer-ownership="none"
30794 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30795 <type name="Cancellable" c:type="GCancellable*"/>
30797 <parameter name="callback"
30798 transfer-ownership="none"
30801 <doc xml:whitespace="preserve">the #GAsyncReadyCallback to call when done</doc>
30802 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30804 <parameter name="user_data" transfer-ownership="none" closure="3">
30805 <doc xml:whitespace="preserve">the user data to pass to @callback</doc>
30806 <type name="gpointer" c:type="gpointer"/>
30811 <field name="acquire_finish">
30812 <callback name="acquire_finish" throws="1">
30813 <return-value transfer-ownership="none">
30814 <doc xml:whitespace="preserve">%TRUE if the permission was successfully acquired</doc>
30815 <type name="gboolean" c:type="gboolean"/>
30818 <parameter name="permission" transfer-ownership="none">
30819 <type name="Permission" c:type="GPermission*"/>
30821 <parameter name="result" transfer-ownership="none">
30822 <doc xml:whitespace="preserve">the #GAsyncResult given to the #GAsyncReadyCallback</doc>
30823 <type name="AsyncResult" c:type="GAsyncResult*"/>
30828 <field name="release">
30829 <callback name="release" throws="1">
30830 <return-value transfer-ownership="none">
30831 <doc xml:whitespace="preserve">%TRUE if the permission was successfully released</doc>
30832 <type name="gboolean" c:type="gboolean"/>
30835 <parameter name="permission" transfer-ownership="none">
30836 <type name="Permission" c:type="GPermission*"/>
30838 <parameter name="cancellable"
30839 transfer-ownership="none"
30841 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30842 <type name="Cancellable" c:type="GCancellable*"/>
30847 <field name="release_async">
30848 <callback name="release_async">
30849 <return-value transfer-ownership="none">
30850 <type name="none" c:type="void"/>
30853 <parameter name="permission" transfer-ownership="none">
30854 <type name="Permission" c:type="GPermission*"/>
30856 <parameter name="cancellable"
30857 transfer-ownership="none"
30859 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
30860 <type name="Cancellable" c:type="GCancellable*"/>
30862 <parameter name="callback"
30863 transfer-ownership="none"
30866 <doc xml:whitespace="preserve">the #GAsyncReadyCallback to call when done</doc>
30867 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30869 <parameter name="user_data" transfer-ownership="none" closure="3">
30870 <doc xml:whitespace="preserve">the user data to pass to @callback</doc>
30871 <type name="gpointer" c:type="gpointer"/>
30876 <field name="release_finish">
30877 <callback name="release_finish" throws="1">
30878 <return-value transfer-ownership="none">
30879 <doc xml:whitespace="preserve">%TRUE if the permission was successfully released</doc>
30880 <type name="gboolean" c:type="gboolean"/>
30883 <parameter name="permission" transfer-ownership="none">
30884 <type name="Permission" c:type="GPermission*"/>
30886 <parameter name="result" transfer-ownership="none">
30887 <doc xml:whitespace="preserve">the #GAsyncResult given to the #GAsyncReadyCallback</doc>
30888 <type name="AsyncResult" c:type="GAsyncResult*"/>
30893 <field name="reserved">
30894 <array zero-terminated="0" c:type="gpointer" fixed-size="16">
30895 <type name="gpointer" c:type="gpointer"/>
30899 <record name="PermissionPrivate" c:type="GPermissionPrivate" disguised="1">
30901 <interface name="Proxy"
30902 c:symbol-prefix="proxy"
30905 glib:type-name="GProxy"
30906 glib:get-type="g_proxy_get_type"
30907 glib:type-struct="ProxyInterface">
30908 <doc xml:whitespace="preserve">Interface that handles proxy connection and payload.</doc>
30909 <virtual-method name="connect"
30913 <doc xml:whitespace="preserve">Given @connection to communicate with a proxy (eg, a
30914 #GSocketConnection that is connected to the proxy server), this
30915 does the necessary handshake to connect to @proxy_address, and if
30916 required, wraps the #GIOStream to handle proxy payload.
30917 be the same as @connection, in which case a reference
30918 will be added.</doc>
30919 <return-value transfer-ownership="full">
30920 <doc xml:whitespace="preserve">a #GIOStream that will replace @connection. This might</doc>
30921 <type name="IOStream" c:type="GIOStream*"/>
30924 <parameter name="connection" transfer-ownership="none">
30925 <doc xml:whitespace="preserve">a #GIOStream</doc>
30926 <type name="IOStream" c:type="GIOStream*"/>
30928 <parameter name="proxy_address" transfer-ownership="none">
30929 <doc xml:whitespace="preserve">a #GProxyAddress</doc>
30930 <type name="ProxyAddress" c:type="GProxyAddress*"/>
30932 <parameter name="cancellable"
30933 transfer-ownership="none"
30935 <doc xml:whitespace="preserve">a #GCancellable</doc>
30936 <type name="Cancellable" c:type="GCancellable*"/>
30940 <virtual-method name="connect_async"
30941 invoker="connect_async"
30943 <doc xml:whitespace="preserve">Asynchronous version of g_proxy_connect().</doc>
30944 <return-value transfer-ownership="none">
30945 <type name="none" c:type="void"/>
30948 <parameter name="connection" transfer-ownership="none">
30949 <doc xml:whitespace="preserve">a #GIOStream</doc>
30950 <type name="IOStream" c:type="GIOStream*"/>
30952 <parameter name="proxy_address" transfer-ownership="none">
30953 <doc xml:whitespace="preserve">a #GProxyAddress</doc>
30954 <type name="ProxyAddress" c:type="GProxyAddress*"/>
30956 <parameter name="cancellable"
30957 transfer-ownership="none"
30959 <doc xml:whitespace="preserve">a #GCancellable</doc>
30960 <type name="Cancellable" c:type="GCancellable*"/>
30962 <parameter name="callback"
30963 transfer-ownership="none"
30966 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
30967 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
30969 <parameter name="user_data" transfer-ownership="none" closure="4">
30970 <doc xml:whitespace="preserve">callback data</doc>
30971 <type name="gpointer" c:type="gpointer"/>
30975 <virtual-method name="connect_finish"
30976 invoker="connect_finish"
30979 <doc xml:whitespace="preserve">See g_proxy_connect().</doc>
30980 <return-value transfer-ownership="full">
30981 <doc xml:whitespace="preserve">a #GIOStream.</doc>
30982 <type name="IOStream" c:type="GIOStream*"/>
30985 <parameter name="result" transfer-ownership="none">
30986 <doc xml:whitespace="preserve">a #GAsyncRetult</doc>
30987 <type name="AsyncResult" c:type="GAsyncResult*"/>
30991 <virtual-method name="supports_hostname"
30992 invoker="supports_hostname"
30994 <doc xml:whitespace="preserve">Some proxy protocols expect to be passed a hostname, which they
30995 will resolve to an IP address themselves. Others, like SOCKS4, do
30996 not allow this. This function will return %FALSE if @proxy is
30997 implementing such a protocol. When %FALSE is returned, the caller
30998 should resolve the destination hostname first, and then pass a
30999 #GProxyAddress containing the stringified IP address to
31000 g_proxy_connect() or g_proxy_connect_async().</doc>
31001 <return-value transfer-ownership="none">
31002 <doc xml:whitespace="preserve">%TRUE if hostname resolution is supported.</doc>
31003 <type name="gboolean" c:type="gboolean"/>
31006 <method name="connect"
31007 c:identifier="g_proxy_connect"
31010 <doc xml:whitespace="preserve">Given @connection to communicate with a proxy (eg, a
31011 #GSocketConnection that is connected to the proxy server), this
31012 does the necessary handshake to connect to @proxy_address, and if
31013 required, wraps the #GIOStream to handle proxy payload.
31014 be the same as @connection, in which case a reference
31015 will be added.</doc>
31016 <return-value transfer-ownership="full">
31017 <doc xml:whitespace="preserve">a #GIOStream that will replace @connection. This might</doc>
31018 <type name="IOStream" c:type="GIOStream*"/>
31021 <parameter name="connection" transfer-ownership="none">
31022 <doc xml:whitespace="preserve">a #GIOStream</doc>
31023 <type name="IOStream" c:type="GIOStream*"/>
31025 <parameter name="proxy_address" transfer-ownership="none">
31026 <doc xml:whitespace="preserve">a #GProxyAddress</doc>
31027 <type name="ProxyAddress" c:type="GProxyAddress*"/>
31029 <parameter name="cancellable"
31030 transfer-ownership="none"
31032 <doc xml:whitespace="preserve">a #GCancellable</doc>
31033 <type name="Cancellable" c:type="GCancellable*"/>
31037 <method name="connect_async"
31038 c:identifier="g_proxy_connect_async"
31040 <doc xml:whitespace="preserve">Asynchronous version of g_proxy_connect().</doc>
31041 <return-value transfer-ownership="none">
31042 <type name="none" c:type="void"/>
31045 <parameter name="connection" transfer-ownership="none">
31046 <doc xml:whitespace="preserve">a #GIOStream</doc>
31047 <type name="IOStream" c:type="GIOStream*"/>
31049 <parameter name="proxy_address" transfer-ownership="none">
31050 <doc xml:whitespace="preserve">a #GProxyAddress</doc>
31051 <type name="ProxyAddress" c:type="GProxyAddress*"/>
31053 <parameter name="cancellable"
31054 transfer-ownership="none"
31056 <doc xml:whitespace="preserve">a #GCancellable</doc>
31057 <type name="Cancellable" c:type="GCancellable*"/>
31059 <parameter name="callback"
31060 transfer-ownership="none"
31063 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
31064 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
31066 <parameter name="user_data" transfer-ownership="none">
31067 <doc xml:whitespace="preserve">callback data</doc>
31068 <type name="gpointer" c:type="gpointer"/>
31072 <method name="connect_finish"
31073 c:identifier="g_proxy_connect_finish"
31076 <doc xml:whitespace="preserve">See g_proxy_connect().</doc>
31077 <return-value transfer-ownership="full">
31078 <doc xml:whitespace="preserve">a #GIOStream.</doc>
31079 <type name="IOStream" c:type="GIOStream*"/>
31082 <parameter name="result" transfer-ownership="none">
31083 <doc xml:whitespace="preserve">a #GAsyncRetult</doc>
31084 <type name="AsyncResult" c:type="GAsyncResult*"/>
31088 <method name="supports_hostname"
31089 c:identifier="g_proxy_supports_hostname"
31091 <doc xml:whitespace="preserve">Some proxy protocols expect to be passed a hostname, which they
31092 will resolve to an IP address themselves. Others, like SOCKS4, do
31093 not allow this. This function will return %FALSE if @proxy is
31094 implementing such a protocol. When %FALSE is returned, the caller
31095 should resolve the destination hostname first, and then pass a
31096 #GProxyAddress containing the stringified IP address to
31097 g_proxy_connect() or g_proxy_connect_async().</doc>
31098 <return-value transfer-ownership="none">
31099 <doc xml:whitespace="preserve">%TRUE if hostname resolution is supported.</doc>
31100 <type name="gboolean" c:type="gboolean"/>
31104 <class name="ProxyAddress"
31105 c:symbol-prefix="proxy_address"
31106 c:type="GProxyAddress"
31108 parent="InetSocketAddress"
31109 glib:type-name="GProxyAddress"
31110 glib:get-type="g_proxy_address_get_type"
31111 glib:type-struct="ProxyAddressClass">
31112 <doc xml:whitespace="preserve">A #GInetSocketAddress representing a connection via a proxy server</doc>
31113 <implements name="SocketConnectable"/>
31114 <constructor name="new"
31115 c:identifier="g_proxy_address_new"
31117 <doc xml:whitespace="preserve">Creates a new #GProxyAddress for @inetaddr with @protocol that should
31118 tunnel through @dest_hostname and @dest_port.</doc>
31119 <return-value transfer-ownership="full">
31120 <doc xml:whitespace="preserve">a new #GProxyAddress</doc>
31121 <type name="SocketAddress" c:type="GSocketAddress*"/>
31124 <parameter name="inetaddr" transfer-ownership="none">
31125 <doc xml:whitespace="preserve">The proxy server #GInetAddress.</doc>
31126 <type name="InetAddress" c:type="GInetAddress*"/>
31128 <parameter name="port" transfer-ownership="none">
31129 <doc xml:whitespace="preserve">The proxy server port.</doc>
31130 <type name="guint16" c:type="guint16"/>
31132 <parameter name="protocol" transfer-ownership="none">
31133 <doc xml:whitespace="preserve">The proxy protocol to support, in lower case (e.g. socks, http).</doc>
31134 <type name="utf8" c:type="gchar*"/>
31136 <parameter name="dest_hostname" transfer-ownership="none">
31137 <doc xml:whitespace="preserve">The destination hostname the the proxy should tunnel to.</doc>
31138 <type name="utf8" c:type="gchar*"/>
31140 <parameter name="dest_port" transfer-ownership="none">
31141 <doc xml:whitespace="preserve">The destination port to tunnel to.</doc>
31142 <type name="guint16" c:type="guint16"/>
31144 <parameter name="username" transfer-ownership="none">
31145 <doc xml:whitespace="preserve">The username to authenticate to the proxy server (or %NULL).</doc>
31146 <type name="utf8" c:type="gchar*"/>
31148 <parameter name="password" transfer-ownership="none">
31149 <doc xml:whitespace="preserve">The password to authenticate to the proxy server (or %NULL).</doc>
31150 <type name="utf8" c:type="gchar*"/>
31154 <method name="get_destination_hostname"
31155 c:identifier="g_proxy_address_get_destination_hostname">
31156 <return-value transfer-ownership="none">
31157 <type name="utf8" c:type="gchar*"/>
31160 <method name="get_destination_port"
31161 c:identifier="g_proxy_address_get_destination_port">
31162 <return-value transfer-ownership="none">
31163 <type name="guint16" c:type="guint16"/>
31166 <method name="get_password" c:identifier="g_proxy_address_get_password">
31167 <return-value transfer-ownership="none">
31168 <type name="utf8" c:type="gchar*"/>
31171 <method name="get_protocol"
31172 c:identifier="g_proxy_address_get_protocol"
31174 <doc xml:whitespace="preserve">Gets @proxy's protocol.</doc>
31175 <return-value transfer-ownership="none">
31176 <doc xml:whitespace="preserve">the @proxy's protocol</doc>
31177 <type name="utf8" c:type="gchar*"/>
31180 <method name="get_username" c:identifier="g_proxy_address_get_username">
31181 <return-value transfer-ownership="none">
31182 <type name="utf8" c:type="gchar*"/>
31185 <property name="destination-hostname"
31188 transfer-ownership="none">
31189 <type name="utf8"/>
31191 <property name="destination-port"
31194 transfer-ownership="none">
31195 <type name="guint"/>
31197 <property name="password"
31200 transfer-ownership="none">
31201 <type name="utf8"/>
31203 <property name="protocol"
31206 transfer-ownership="none">
31207 <type name="utf8"/>
31209 <property name="username"
31212 transfer-ownership="none">
31213 <type name="utf8"/>
31215 <field name="parent_instance">
31216 <type name="InetSocketAddress" c:type="GInetSocketAddress"/>
31218 <field name="priv">
31219 <type name="ProxyAddressPrivate" c:type="GProxyAddressPrivate*"/>
31222 <record name="ProxyAddressClass"
31223 c:type="GProxyAddressClass"
31224 glib:is-gtype-struct-for="ProxyAddress">
31225 <field name="parent_class">
31226 <type name="InetSocketAddressClass" c:type="GInetSocketAddressClass"/>
31229 <class name="ProxyAddressEnumerator"
31230 c:symbol-prefix="proxy_address_enumerator"
31231 c:type="GProxyAddressEnumerator"
31232 parent="SocketAddressEnumerator"
31233 glib:type-name="GProxyAddressEnumerator"
31234 glib:get-type="g_proxy_address_enumerator_get_type"
31235 glib:type-struct="ProxyAddressEnumeratorClass">
31236 <doc xml:whitespace="preserve">A subclass of #GSocketAddressEnumerator that takes another address
31237 enumerator and wraps its results in #GProxyAddress<!-- -->es as
31238 directed by the default #GProxyResolver.</doc>
31239 <property name="connectable"
31242 transfer-ownership="none">
31243 <type name="SocketConnectable"/>
31245 <property name="uri"
31248 transfer-ownership="none">
31249 <type name="utf8"/>
31251 <field name="parent_instance">
31252 <type name="SocketAddressEnumerator"
31253 c:type="GSocketAddressEnumerator"/>
31255 <field name="priv">
31256 <type name="ProxyAddressEnumeratorPrivate"
31257 c:type="GProxyAddressEnumeratorPrivate*"/>
31260 <record name="ProxyAddressEnumeratorClass"
31261 c:type="GProxyAddressEnumeratorClass"
31262 glib:is-gtype-struct-for="ProxyAddressEnumerator">
31263 <field name="parent_class">
31264 <type name="SocketAddressEnumeratorClass"
31265 c:type="GSocketAddressEnumeratorClass"/>
31267 <field name="_g_reserved1" introspectable="0">
31268 <callback name="_g_reserved1">
31269 <return-value transfer-ownership="none">
31270 <type name="none" c:type="void"/>
31274 <field name="_g_reserved2" introspectable="0">
31275 <callback name="_g_reserved2">
31276 <return-value transfer-ownership="none">
31277 <type name="none" c:type="void"/>
31281 <field name="_g_reserved3" introspectable="0">
31282 <callback name="_g_reserved3">
31283 <return-value transfer-ownership="none">
31284 <type name="none" c:type="void"/>
31288 <field name="_g_reserved4" introspectable="0">
31289 <callback name="_g_reserved4">
31290 <return-value transfer-ownership="none">
31291 <type name="none" c:type="void"/>
31295 <field name="_g_reserved5" introspectable="0">
31296 <callback name="_g_reserved5">
31297 <return-value transfer-ownership="none">
31298 <type name="none" c:type="void"/>
31302 <field name="_g_reserved6" introspectable="0">
31303 <callback name="_g_reserved6">
31304 <return-value transfer-ownership="none">
31305 <type name="none" c:type="void"/>
31309 <field name="_g_reserved7" introspectable="0">
31310 <callback name="_g_reserved7">
31311 <return-value transfer-ownership="none">
31312 <type name="none" c:type="void"/>
31317 <record name="ProxyAddressEnumeratorPrivate"
31318 c:type="GProxyAddressEnumeratorPrivate"
31321 <record name="ProxyAddressPrivate"
31322 c:type="GProxyAddressPrivate"
31325 <record name="ProxyInterface"
31326 c:type="GProxyInterface"
31327 glib:is-gtype-struct-for="Proxy"
31329 <doc xml:whitespace="preserve">Provides an interface for handling proxy connection and payload.</doc>
31330 <field name="g_iface">
31331 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
31333 <field name="connect">
31334 <callback name="connect" throws="1">
31335 <return-value transfer-ownership="full">
31336 <doc xml:whitespace="preserve">a #GIOStream that will replace @connection. This might</doc>
31337 <type name="IOStream" c:type="GIOStream*"/>
31340 <parameter name="proxy" transfer-ownership="none">
31341 <type name="Proxy" c:type="GProxy*"/>
31343 <parameter name="connection" transfer-ownership="none">
31344 <doc xml:whitespace="preserve">a #GIOStream</doc>
31345 <type name="IOStream" c:type="GIOStream*"/>
31347 <parameter name="proxy_address" transfer-ownership="none">
31348 <doc xml:whitespace="preserve">a #GProxyAddress</doc>
31349 <type name="ProxyAddress" c:type="GProxyAddress*"/>
31351 <parameter name="cancellable"
31352 transfer-ownership="none"
31354 <doc xml:whitespace="preserve">a #GCancellable</doc>
31355 <type name="Cancellable" c:type="GCancellable*"/>
31360 <field name="connect_async">
31361 <callback name="connect_async">
31362 <return-value transfer-ownership="none">
31363 <type name="none" c:type="void"/>
31366 <parameter name="proxy" transfer-ownership="none">
31367 <type name="Proxy" c:type="GProxy*"/>
31369 <parameter name="connection" transfer-ownership="none">
31370 <doc xml:whitespace="preserve">a #GIOStream</doc>
31371 <type name="IOStream" c:type="GIOStream*"/>
31373 <parameter name="proxy_address" transfer-ownership="none">
31374 <doc xml:whitespace="preserve">a #GProxyAddress</doc>
31375 <type name="ProxyAddress" c:type="GProxyAddress*"/>
31377 <parameter name="cancellable"
31378 transfer-ownership="none"
31380 <doc xml:whitespace="preserve">a #GCancellable</doc>
31381 <type name="Cancellable" c:type="GCancellable*"/>
31383 <parameter name="callback"
31384 transfer-ownership="none"
31387 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
31388 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
31390 <parameter name="user_data" transfer-ownership="none" closure="5">
31391 <doc xml:whitespace="preserve">callback data</doc>
31392 <type name="gpointer" c:type="gpointer"/>
31397 <field name="connect_finish">
31398 <callback name="connect_finish" throws="1">
31399 <return-value transfer-ownership="full">
31400 <doc xml:whitespace="preserve">a #GIOStream.</doc>
31401 <type name="IOStream" c:type="GIOStream*"/>
31404 <parameter name="proxy" transfer-ownership="none">
31405 <type name="Proxy" c:type="GProxy*"/>
31407 <parameter name="result" transfer-ownership="none">
31408 <doc xml:whitespace="preserve">a #GAsyncRetult</doc>
31409 <type name="AsyncResult" c:type="GAsyncResult*"/>
31414 <field name="supports_hostname">
31415 <callback name="supports_hostname">
31416 <return-value transfer-ownership="none">
31417 <doc xml:whitespace="preserve">%TRUE if hostname resolution is supported.</doc>
31418 <type name="gboolean" c:type="gboolean"/>
31421 <parameter name="proxy" transfer-ownership="none">
31422 <type name="Proxy" c:type="GProxy*"/>
31428 <interface name="ProxyResolver"
31429 c:symbol-prefix="proxy_resolver"
31430 c:type="GProxyResolver"
31431 glib:type-name="GProxyResolver"
31432 glib:get-type="g_proxy_resolver_get_type"
31433 glib:type-struct="ProxyResolverInterface">
31434 <doc xml:whitespace="preserve">Interface that can be used to resolve proxy address.</doc>
31435 <virtual-method name="is_supported"
31436 invoker="is_supported"
31438 <doc xml:whitespace="preserve">Checks if @resolver can be used on this system. (This is used
31439 internally; g_proxy_resolver_get_default() will only return a proxy
31440 resolver that returns %TRUE for this method.)</doc>
31441 <return-value transfer-ownership="none">
31442 <doc xml:whitespace="preserve">%TRUE if @resolver is supported.</doc>
31443 <type name="gboolean" c:type="gboolean"/>
31446 <virtual-method name="lookup" invoker="lookup" version="2.26" throws="1">
31447 <doc xml:whitespace="preserve">Looks into the system proxy configuration to determine what proxy,
31448 if any, to use to connect to @uri. The returned proxy URIs are of the
31449 form <literal>&lt;protocol&gt;://[user[:password]@]host:port</literal>
31450 or <literal>direct://</literal>, where &lt;protocol&gt; could be
31451 http, rtsp, socks or other proxying protocol.
31452 If you don't know what network protocol is being used on the
31453 socket, you should use <literal>none</literal> as the URI protocol.
31454 In this case, the resolver might still return a generic proxy type
31455 (such as SOCKS), but would not return protocol-specific proxy types
31457 <literal>direct://</literal> is used when no proxy is needed.
31458 Direct connection should not be attempted unless it is part of the
31459 returned array of proxies.
31460 g_strfreev().</doc>
31461 <return-value transfer-ownership="full">
31462 <doc xml:whitespace="preserve">A NULL-terminated array of proxy URIs. Must be freed with</doc>
31463 <array c:type="gchar**">
31464 <type name="utf8"/>
31468 <parameter name="uri" transfer-ownership="none">
31469 <doc xml:whitespace="preserve">a URI representing the destination to connect to</doc>
31470 <type name="utf8" c:type="gchar*"/>
31472 <parameter name="cancellable"
31473 transfer-ownership="none"
31475 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31476 <type name="Cancellable" c:type="GCancellable*"/>
31480 <virtual-method name="lookup_async"
31481 invoker="lookup_async"
31483 <doc xml:whitespace="preserve">Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more
31485 <return-value transfer-ownership="none">
31486 <type name="none" c:type="void"/>
31489 <parameter name="uri" transfer-ownership="none">
31490 <doc xml:whitespace="preserve">a URI representing the destination to connect to</doc>
31491 <type name="utf8" c:type="gchar*"/>
31493 <parameter name="cancellable"
31494 transfer-ownership="none"
31496 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31497 <type name="Cancellable" c:type="GCancellable*"/>
31499 <parameter name="callback"
31500 transfer-ownership="none"
31503 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
31504 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
31506 <parameter name="user_data" transfer-ownership="none" closure="3">
31507 <doc xml:whitespace="preserve">data for @callback</doc>
31508 <type name="gpointer" c:type="gpointer"/>
31512 <virtual-method name="lookup_finish"
31513 invoker="lookup_finish"
31516 <doc xml:whitespace="preserve">Call this function to obtain the array of proxy URIs when
31517 g_proxy_resolver_lookup_async() is complete. See
31518 g_proxy_resolver_lookup() for more details.
31519 g_strfreev().</doc>
31520 <return-value transfer-ownership="full">
31521 <doc xml:whitespace="preserve">A NULL-terminated array of proxy URIs. Must be freed with</doc>
31522 <array c:type="gchar**">
31523 <type name="utf8"/>
31527 <parameter name="result" transfer-ownership="none">
31528 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
31529 <type name="AsyncResult" c:type="GAsyncResult*"/>
31533 <method name="is_supported"
31534 c:identifier="g_proxy_resolver_is_supported"
31536 <doc xml:whitespace="preserve">Checks if @resolver can be used on this system. (This is used
31537 internally; g_proxy_resolver_get_default() will only return a proxy
31538 resolver that returns %TRUE for this method.)</doc>
31539 <return-value transfer-ownership="none">
31540 <doc xml:whitespace="preserve">%TRUE if @resolver is supported.</doc>
31541 <type name="gboolean" c:type="gboolean"/>
31544 <method name="lookup"
31545 c:identifier="g_proxy_resolver_lookup"
31548 <doc xml:whitespace="preserve">Looks into the system proxy configuration to determine what proxy,
31549 if any, to use to connect to @uri. The returned proxy URIs are of the
31550 form <literal>&lt;protocol&gt;://[user[:password]@]host:port</literal>
31551 or <literal>direct://</literal>, where &lt;protocol&gt; could be
31552 http, rtsp, socks or other proxying protocol.
31553 If you don't know what network protocol is being used on the
31554 socket, you should use <literal>none</literal> as the URI protocol.
31555 In this case, the resolver might still return a generic proxy type
31556 (such as SOCKS), but would not return protocol-specific proxy types
31558 <literal>direct://</literal> is used when no proxy is needed.
31559 Direct connection should not be attempted unless it is part of the
31560 returned array of proxies.
31561 g_strfreev().</doc>
31562 <return-value transfer-ownership="full">
31563 <doc xml:whitespace="preserve">A NULL-terminated array of proxy URIs. Must be freed with</doc>
31564 <array c:type="gchar**">
31565 <type name="utf8"/>
31569 <parameter name="uri" transfer-ownership="none">
31570 <doc xml:whitespace="preserve">a URI representing the destination to connect to</doc>
31571 <type name="utf8" c:type="gchar*"/>
31573 <parameter name="cancellable"
31574 transfer-ownership="none"
31576 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31577 <type name="Cancellable" c:type="GCancellable*"/>
31581 <method name="lookup_async"
31582 c:identifier="g_proxy_resolver_lookup_async"
31584 <doc xml:whitespace="preserve">Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more
31586 <return-value transfer-ownership="none">
31587 <type name="none" c:type="void"/>
31590 <parameter name="uri" transfer-ownership="none">
31591 <doc xml:whitespace="preserve">a URI representing the destination to connect to</doc>
31592 <type name="utf8" c:type="gchar*"/>
31594 <parameter name="cancellable"
31595 transfer-ownership="none"
31597 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31598 <type name="Cancellable" c:type="GCancellable*"/>
31600 <parameter name="callback"
31601 transfer-ownership="none"
31604 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
31605 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
31607 <parameter name="user_data" transfer-ownership="none">
31608 <doc xml:whitespace="preserve">data for @callback</doc>
31609 <type name="gpointer" c:type="gpointer"/>
31613 <method name="lookup_finish"
31614 c:identifier="g_proxy_resolver_lookup_finish"
31617 <doc xml:whitespace="preserve">Call this function to obtain the array of proxy URIs when
31618 g_proxy_resolver_lookup_async() is complete. See
31619 g_proxy_resolver_lookup() for more details.
31620 g_strfreev().</doc>
31621 <return-value transfer-ownership="full">
31622 <doc xml:whitespace="preserve">A NULL-terminated array of proxy URIs. Must be freed with</doc>
31623 <array c:type="gchar**">
31624 <type name="utf8"/>
31628 <parameter name="result" transfer-ownership="none">
31629 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
31630 <type name="AsyncResult" c:type="GAsyncResult*"/>
31635 <record name="ProxyResolverInterface"
31636 c:type="GProxyResolverInterface"
31637 glib:is-gtype-struct-for="ProxyResolver">
31638 <field name="g_iface">
31639 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
31641 <field name="is_supported">
31642 <callback name="is_supported">
31643 <return-value transfer-ownership="none">
31644 <doc xml:whitespace="preserve">%TRUE if @resolver is supported.</doc>
31645 <type name="gboolean" c:type="gboolean"/>
31648 <parameter name="resolver" transfer-ownership="none">
31649 <type name="ProxyResolver" c:type="GProxyResolver*"/>
31654 <field name="lookup">
31655 <callback name="lookup" throws="1">
31656 <return-value transfer-ownership="full">
31657 <doc xml:whitespace="preserve">A NULL-terminated array of proxy URIs. Must be freed with</doc>
31658 <array c:type="gchar**">
31659 <type name="utf8"/>
31663 <parameter name="resolver" transfer-ownership="none">
31664 <type name="ProxyResolver" c:type="GProxyResolver*"/>
31666 <parameter name="uri" transfer-ownership="none">
31667 <doc xml:whitespace="preserve">a URI representing the destination to connect to</doc>
31668 <type name="utf8" c:type="gchar*"/>
31670 <parameter name="cancellable"
31671 transfer-ownership="none"
31673 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31674 <type name="Cancellable" c:type="GCancellable*"/>
31679 <field name="lookup_async">
31680 <callback name="lookup_async">
31681 <return-value transfer-ownership="none">
31682 <type name="none" c:type="void"/>
31685 <parameter name="resolver" transfer-ownership="none">
31686 <type name="ProxyResolver" c:type="GProxyResolver*"/>
31688 <parameter name="uri" transfer-ownership="none">
31689 <doc xml:whitespace="preserve">a URI representing the destination to connect to</doc>
31690 <type name="utf8" c:type="gchar*"/>
31692 <parameter name="cancellable"
31693 transfer-ownership="none"
31695 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31696 <type name="Cancellable" c:type="GCancellable*"/>
31698 <parameter name="callback"
31699 transfer-ownership="none"
31702 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
31703 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
31705 <parameter name="user_data" transfer-ownership="none" closure="4">
31706 <doc xml:whitespace="preserve">data for @callback</doc>
31707 <type name="gpointer" c:type="gpointer"/>
31712 <field name="lookup_finish">
31713 <callback name="lookup_finish" throws="1">
31714 <return-value transfer-ownership="full">
31715 <doc xml:whitespace="preserve">A NULL-terminated array of proxy URIs. Must be freed with</doc>
31716 <array c:type="gchar**">
31717 <type name="utf8"/>
31721 <parameter name="resolver" transfer-ownership="none">
31722 <type name="ProxyResolver" c:type="GProxyResolver*"/>
31724 <parameter name="result" transfer-ownership="none">
31725 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
31726 <type name="AsyncResult" c:type="GAsyncResult*"/>
31732 <callback name="ReallocFunc" c:type="GReallocFunc" introspectable="0">
31733 <doc xml:whitespace="preserve">Changes the size of the memory block pointed to by @data to
31734 The function should have the same semantics as realloc().</doc>
31736 <doc xml:whitespace="preserve">a pointer to the reallocated memory</doc>
31737 <type name="gpointer" c:type="gpointer"/>
31740 <parameter name="data" transfer-ownership="none">
31741 <doc xml:whitespace="preserve">memory block to reallocate</doc>
31742 <type name="gpointer" c:type="gpointer"/>
31744 <parameter name="size" transfer-ownership="none">
31745 <doc xml:whitespace="preserve">size to reallocate @data to</doc>
31746 <type name="gulong" c:type="gsize"/>
31750 <class name="Resolver"
31751 c:symbol-prefix="resolver"
31753 parent="GObject.Object"
31754 glib:type-name="GResolver"
31755 glib:get-type="g_resolver_get_type"
31756 glib:type-struct="ResolverClass">
31757 <doc xml:whitespace="preserve">The object that handles DNS resolution. Use g_resolver_get_default()
31758 to get the default resolver.</doc>
31759 <function name="free_addresses"
31760 c:identifier="g_resolver_free_addresses"
31762 <doc xml:whitespace="preserve">Frees @addresses (which should be the return value from
31763 g_resolver_lookup_by_name() or g_resolver_lookup_by_name_finish()).
31764 (This is a convenience method; you can also simply free the results
31766 <return-value transfer-ownership="none">
31767 <type name="none" c:type="void"/>
31770 <parameter name="addresses" transfer-ownership="none">
31771 <doc xml:whitespace="preserve">a #GList of #GInetAddress</doc>
31772 <type name="GLib.List" c:type="GList*">
31773 <type name="gpointer" c:type="gpointer"/>
31778 <function name="free_targets"
31779 c:identifier="g_resolver_free_targets"
31781 <doc xml:whitespace="preserve">Frees @targets (which should be the return value from
31782 g_resolver_lookup_service() or g_resolver_lookup_service_finish()).
31783 (This is a convenience method; you can also simply free the
31784 results by hand.)</doc>
31785 <return-value transfer-ownership="none">
31786 <type name="none" c:type="void"/>
31789 <parameter name="targets" transfer-ownership="none">
31790 <doc xml:whitespace="preserve">a #GList of #GSrvTarget</doc>
31791 <type name="GLib.List" c:type="GList*">
31792 <type name="gpointer" c:type="gpointer"/>
31797 <function name="get_default"
31798 c:identifier="g_resolver_get_default"
31800 <doc xml:whitespace="preserve">Gets the default #GResolver. You should unref it when you are done
31801 with it. #GResolver may use its reference count as a hint about how
31802 many threads/processes, etc it should allocate for concurrent DNS
31804 <return-value transfer-ownership="full">
31805 <doc xml:whitespace="preserve">the default #GResolver.</doc>
31806 <type name="Resolver" c:type="GResolver*"/>
31809 <virtual-method name="lookup_by_address"
31810 invoker="lookup_by_address"
31813 <doc xml:whitespace="preserve">Synchronously reverse-resolves @address to determine its
31814 associated hostname.
31815 If the DNS resolution fails, @error (if non-%NULL) will be set to
31816 a value from #GResolverError.
31817 If @cancellable is non-%NULL, it can be used to cancel the
31818 operation, in which case @error (if non-%NULL) will be set to
31819 %G_IO_ERROR_CANCELLED.
31820 form), or %NULL on error.</doc>
31821 <return-value transfer-ownership="full">
31822 <doc xml:whitespace="preserve">a hostname (either ASCII-only, or in ASCII-encoded</doc>
31823 <type name="utf8" c:type="gchar*"/>
31826 <parameter name="address" transfer-ownership="none">
31827 <doc xml:whitespace="preserve">the address to reverse-resolve</doc>
31828 <type name="InetAddress" c:type="GInetAddress*"/>
31830 <parameter name="cancellable"
31831 transfer-ownership="none"
31833 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31834 <type name="Cancellable" c:type="GCancellable*"/>
31838 <virtual-method name="lookup_by_address_async"
31839 invoker="lookup_by_address_async"
31841 <doc xml:whitespace="preserve">Begins asynchronously reverse-resolving @address to determine its
31842 associated hostname, and eventually calls @callback, which must
31843 call g_resolver_lookup_by_address_finish() to get the final result.</doc>
31844 <return-value transfer-ownership="none">
31845 <type name="none" c:type="void"/>
31848 <parameter name="address" transfer-ownership="none">
31849 <doc xml:whitespace="preserve">the address to reverse-resolve</doc>
31850 <type name="InetAddress" c:type="GInetAddress*"/>
31852 <parameter name="cancellable"
31853 transfer-ownership="none"
31855 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31856 <type name="Cancellable" c:type="GCancellable*"/>
31858 <parameter name="callback"
31859 transfer-ownership="none"
31862 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
31863 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
31865 <parameter name="user_data" transfer-ownership="none" closure="3">
31866 <doc xml:whitespace="preserve">data for @callback</doc>
31867 <type name="gpointer" c:type="gpointer"/>
31871 <virtual-method name="lookup_by_address_finish"
31872 invoker="lookup_by_address_finish"
31875 <doc xml:whitespace="preserve">Retrieves the result of a previous call to
31876 g_resolver_lookup_by_address_async().
31877 If the DNS resolution failed, @error (if non-%NULL) will be set to
31878 a value from #GResolverError. If the operation was cancelled,
31879 form), or %NULL on error.</doc>
31880 <return-value transfer-ownership="full">
31881 <doc xml:whitespace="preserve">a hostname (either ASCII-only, or in ASCII-encoded</doc>
31882 <type name="utf8" c:type="gchar*"/>
31885 <parameter name="result" transfer-ownership="none">
31886 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
31887 <type name="AsyncResult" c:type="GAsyncResult*"/>
31891 <virtual-method name="lookup_by_name"
31892 invoker="lookup_by_name"
31895 <doc xml:whitespace="preserve">Synchronously resolves @hostname to determine its associated IP
31896 address(es). @hostname may be an ASCII-only or UTF-8 hostname, or
31897 the textual form of an IP address (in which case this just becomes
31898 a wrapper around g_inet_address_new_from_string()).
31899 On success, g_resolver_lookup_by_name() will return a #GList of
31900 #GInetAddress, sorted in order of preference. (That is, you should
31901 attempt to connect to the first address first, then the second if
31902 the first fails, etc.)
31903 If the DNS resolution fails, @error (if non-%NULL) will be set to a
31904 value from #GResolverError.
31905 If @cancellable is non-%NULL, it can be used to cancel the
31906 operation, in which case @error (if non-%NULL) will be set to
31907 %G_IO_ERROR_CANCELLED.
31908 If you are planning to connect to a socket on the resolved IP
31909 address, it may be easier to create a #GNetworkAddress and use its
31910 #GSocketConnectable interface.
31911 of #GInetAddress, or %NULL on error. You
31912 must unref each of the addresses and free the list when you are
31913 done with it. (You can use g_resolver_free_addresses() to do this.)</doc>
31914 <return-value transfer-ownership="full">
31915 <doc xml:whitespace="preserve">a #GList</doc>
31916 <type name="GLib.List" c:type="GList*">
31917 <type name="InetAddress"/>
31921 <parameter name="hostname" transfer-ownership="none">
31922 <doc xml:whitespace="preserve">the hostname to look up</doc>
31923 <type name="utf8" c:type="gchar*"/>
31925 <parameter name="cancellable"
31926 transfer-ownership="none"
31928 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31929 <type name="Cancellable" c:type="GCancellable*"/>
31933 <virtual-method name="lookup_by_name_async"
31934 invoker="lookup_by_name_async"
31936 <doc xml:whitespace="preserve">Begins asynchronously resolving @hostname to determine its
31937 associated IP address(es), and eventually calls @callback, which
31938 must call g_resolver_lookup_by_name_finish() to get the result.
31939 See g_resolver_lookup_by_name() for more details.</doc>
31940 <return-value transfer-ownership="none">
31941 <type name="none" c:type="void"/>
31944 <parameter name="hostname" transfer-ownership="none">
31945 <doc xml:whitespace="preserve">the hostname to look up the address of</doc>
31946 <type name="utf8" c:type="gchar*"/>
31948 <parameter name="cancellable"
31949 transfer-ownership="none"
31951 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
31952 <type name="Cancellable" c:type="GCancellable*"/>
31954 <parameter name="callback"
31955 transfer-ownership="none"
31958 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
31959 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
31961 <parameter name="user_data" transfer-ownership="none" closure="3">
31962 <doc xml:whitespace="preserve">data for @callback</doc>
31963 <type name="gpointer" c:type="gpointer"/>
31967 <virtual-method name="lookup_by_name_finish"
31968 invoker="lookup_by_name_finish"
31971 <doc xml:whitespace="preserve">Retrieves the result of a call to
31972 g_resolver_lookup_by_name_async().
31973 If the DNS resolution failed, @error (if non-%NULL) will be set to
31974 a value from #GResolverError. If the operation was cancelled,
31975 of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name()
31976 for more details.</doc>
31977 <return-value transfer-ownership="full">
31978 <doc xml:whitespace="preserve">a #GList</doc>
31979 <type name="GLib.List" c:type="GList*">
31980 <type name="InetAddress"/>
31984 <parameter name="result" transfer-ownership="none">
31985 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
31986 <type name="AsyncResult" c:type="GAsyncResult*"/>
31990 <virtual-method name="lookup_service" introspectable="0" throws="1">
31992 <type name="GLib.List" c:type="GList*">
31993 <type name="gpointer" c:type="gpointer"/>
31997 <parameter name="rrname" transfer-ownership="none">
31998 <type name="utf8" c:type="gchar*"/>
32000 <parameter name="cancellable" transfer-ownership="none">
32001 <type name="Cancellable" c:type="GCancellable*"/>
32005 <virtual-method name="lookup_service_async">
32006 <return-value transfer-ownership="none">
32007 <type name="none" c:type="void"/>
32010 <parameter name="rrname" transfer-ownership="none">
32011 <type name="utf8" c:type="gchar*"/>
32013 <parameter name="cancellable" transfer-ownership="none">
32014 <type name="Cancellable" c:type="GCancellable*"/>
32016 <parameter name="callback"
32017 transfer-ownership="none"
32020 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
32022 <parameter name="user_data" transfer-ownership="none" closure="3">
32023 <type name="gpointer" c:type="gpointer"/>
32027 <virtual-method name="lookup_service_finish"
32028 invoker="lookup_service_finish"
32031 <doc xml:whitespace="preserve">Retrieves the result of a previous call to
32032 g_resolver_lookup_service_async().
32033 If the DNS resolution failed, @error (if non-%NULL) will be set to
32034 a value from #GResolverError. If the operation was cancelled,
32035 or %NULL on error. See g_resolver_lookup_service() for more details.</doc>
32036 <return-value transfer-ownership="full">
32037 <doc xml:whitespace="preserve">a #GList of #GSrvTarget,</doc>
32038 <type name="GLib.List" c:type="GList*">
32039 <type name="SrvTarget"/>
32043 <parameter name="result" transfer-ownership="none">
32044 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
32045 <type name="AsyncResult" c:type="GAsyncResult*"/>
32049 <method name="lookup_by_address"
32050 c:identifier="g_resolver_lookup_by_address"
32053 <doc xml:whitespace="preserve">Synchronously reverse-resolves @address to determine its
32054 associated hostname.
32055 If the DNS resolution fails, @error (if non-%NULL) will be set to
32056 a value from #GResolverError.
32057 If @cancellable is non-%NULL, it can be used to cancel the
32058 operation, in which case @error (if non-%NULL) will be set to
32059 %G_IO_ERROR_CANCELLED.
32060 form), or %NULL on error.</doc>
32061 <return-value transfer-ownership="full">
32062 <doc xml:whitespace="preserve">a hostname (either ASCII-only, or in ASCII-encoded</doc>
32063 <type name="utf8" c:type="gchar*"/>
32066 <parameter name="address" transfer-ownership="none">
32067 <doc xml:whitespace="preserve">the address to reverse-resolve</doc>
32068 <type name="InetAddress" c:type="GInetAddress*"/>
32070 <parameter name="cancellable"
32071 transfer-ownership="none"
32073 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32074 <type name="Cancellable" c:type="GCancellable*"/>
32078 <method name="lookup_by_address_async"
32079 c:identifier="g_resolver_lookup_by_address_async"
32081 <doc xml:whitespace="preserve">Begins asynchronously reverse-resolving @address to determine its
32082 associated hostname, and eventually calls @callback, which must
32083 call g_resolver_lookup_by_address_finish() to get the final result.</doc>
32084 <return-value transfer-ownership="none">
32085 <type name="none" c:type="void"/>
32088 <parameter name="address" transfer-ownership="none">
32089 <doc xml:whitespace="preserve">the address to reverse-resolve</doc>
32090 <type name="InetAddress" c:type="GInetAddress*"/>
32092 <parameter name="cancellable"
32093 transfer-ownership="none"
32095 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32096 <type name="Cancellable" c:type="GCancellable*"/>
32098 <parameter name="callback"
32099 transfer-ownership="none"
32102 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
32103 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
32105 <parameter name="user_data" transfer-ownership="none">
32106 <doc xml:whitespace="preserve">data for @callback</doc>
32107 <type name="gpointer" c:type="gpointer"/>
32111 <method name="lookup_by_address_finish"
32112 c:identifier="g_resolver_lookup_by_address_finish"
32115 <doc xml:whitespace="preserve">Retrieves the result of a previous call to
32116 g_resolver_lookup_by_address_async().
32117 If the DNS resolution failed, @error (if non-%NULL) will be set to
32118 a value from #GResolverError. If the operation was cancelled,
32119 form), or %NULL on error.</doc>
32120 <return-value transfer-ownership="full">
32121 <doc xml:whitespace="preserve">a hostname (either ASCII-only, or in ASCII-encoded</doc>
32122 <type name="utf8" c:type="gchar*"/>
32125 <parameter name="result" transfer-ownership="none">
32126 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
32127 <type name="AsyncResult" c:type="GAsyncResult*"/>
32131 <method name="lookup_by_name"
32132 c:identifier="g_resolver_lookup_by_name"
32135 <doc xml:whitespace="preserve">Synchronously resolves @hostname to determine its associated IP
32136 address(es). @hostname may be an ASCII-only or UTF-8 hostname, or
32137 the textual form of an IP address (in which case this just becomes
32138 a wrapper around g_inet_address_new_from_string()).
32139 On success, g_resolver_lookup_by_name() will return a #GList of
32140 #GInetAddress, sorted in order of preference. (That is, you should
32141 attempt to connect to the first address first, then the second if
32142 the first fails, etc.)
32143 If the DNS resolution fails, @error (if non-%NULL) will be set to a
32144 value from #GResolverError.
32145 If @cancellable is non-%NULL, it can be used to cancel the
32146 operation, in which case @error (if non-%NULL) will be set to
32147 %G_IO_ERROR_CANCELLED.
32148 If you are planning to connect to a socket on the resolved IP
32149 address, it may be easier to create a #GNetworkAddress and use its
32150 #GSocketConnectable interface.
32151 of #GInetAddress, or %NULL on error. You
32152 must unref each of the addresses and free the list when you are
32153 done with it. (You can use g_resolver_free_addresses() to do this.)</doc>
32154 <return-value transfer-ownership="full">
32155 <doc xml:whitespace="preserve">a #GList</doc>
32156 <type name="GLib.List" c:type="GList*">
32157 <type name="InetAddress"/>
32161 <parameter name="hostname" transfer-ownership="none">
32162 <doc xml:whitespace="preserve">the hostname to look up</doc>
32163 <type name="utf8" c:type="gchar*"/>
32165 <parameter name="cancellable"
32166 transfer-ownership="none"
32168 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32169 <type name="Cancellable" c:type="GCancellable*"/>
32173 <method name="lookup_by_name_async"
32174 c:identifier="g_resolver_lookup_by_name_async"
32176 <doc xml:whitespace="preserve">Begins asynchronously resolving @hostname to determine its
32177 associated IP address(es), and eventually calls @callback, which
32178 must call g_resolver_lookup_by_name_finish() to get the result.
32179 See g_resolver_lookup_by_name() for more details.</doc>
32180 <return-value transfer-ownership="none">
32181 <type name="none" c:type="void"/>
32184 <parameter name="hostname" transfer-ownership="none">
32185 <doc xml:whitespace="preserve">the hostname to look up the address of</doc>
32186 <type name="utf8" c:type="gchar*"/>
32188 <parameter name="cancellable"
32189 transfer-ownership="none"
32191 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32192 <type name="Cancellable" c:type="GCancellable*"/>
32194 <parameter name="callback"
32195 transfer-ownership="none"
32198 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
32199 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
32201 <parameter name="user_data" transfer-ownership="none">
32202 <doc xml:whitespace="preserve">data for @callback</doc>
32203 <type name="gpointer" c:type="gpointer"/>
32207 <method name="lookup_by_name_finish"
32208 c:identifier="g_resolver_lookup_by_name_finish"
32211 <doc xml:whitespace="preserve">Retrieves the result of a call to
32212 g_resolver_lookup_by_name_async().
32213 If the DNS resolution failed, @error (if non-%NULL) will be set to
32214 a value from #GResolverError. If the operation was cancelled,
32215 of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name()
32216 for more details.</doc>
32217 <return-value transfer-ownership="full">
32218 <doc xml:whitespace="preserve">a #GList</doc>
32219 <type name="GLib.List" c:type="GList*">
32220 <type name="InetAddress"/>
32224 <parameter name="result" transfer-ownership="none">
32225 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
32226 <type name="AsyncResult" c:type="GAsyncResult*"/>
32230 <method name="lookup_service"
32231 c:identifier="g_resolver_lookup_service"
32234 <doc xml:whitespace="preserve">Synchronously performs a DNS SRV lookup for the given @service and
32235 include the leading underscore that appears in the actual DNS
32237 On success, g_resolver_lookup_service() will return a #GList of
32238 #GSrvTarget, sorted in order of preference. (That is, you should
32239 attempt to connect to the first target first, then the second if
32240 the first fails, etc.)
32241 If the DNS resolution fails, @error (if non-%NULL) will be set to
32242 a value from #GResolverError.
32243 If @cancellable is non-%NULL, it can be used to cancel the
32244 operation, in which case @error (if non-%NULL) will be set to
32245 %G_IO_ERROR_CANCELLED.
32246 If you are planning to connect to the service, it is usually easier
32247 to create a #GNetworkService and use its #GSocketConnectable
32249 or %NULL on error. You must free each of the targets and the list when you are
32250 done with it. (You can use g_resolver_free_targets() to do this.)</doc>
32251 <return-value transfer-ownership="full">
32252 <doc xml:whitespace="preserve">a #GList of #GSrvTarget,</doc>
32253 <type name="GLib.List" c:type="GList*">
32254 <type name="SrvTarget"/>
32258 <parameter name="service" transfer-ownership="none">
32259 <doc xml:whitespace="preserve">the service type to look up (eg, "ldap")</doc>
32260 <type name="utf8" c:type="gchar*"/>
32262 <parameter name="protocol" transfer-ownership="none">
32263 <doc xml:whitespace="preserve">the networking protocol to use for @service (eg, "tcp")</doc>
32264 <type name="utf8" c:type="gchar*"/>
32266 <parameter name="domain" transfer-ownership="none">
32267 <doc xml:whitespace="preserve">the DNS domain to look up the service in</doc>
32268 <type name="utf8" c:type="gchar*"/>
32270 <parameter name="cancellable"
32271 transfer-ownership="none"
32273 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32274 <type name="Cancellable" c:type="GCancellable*"/>
32278 <method name="lookup_service_async"
32279 c:identifier="g_resolver_lookup_service_async"
32281 <doc xml:whitespace="preserve">Begins asynchronously performing a DNS SRV lookup for the given
32282 get the final result. See g_resolver_lookup_service() for more
32284 <return-value transfer-ownership="none">
32285 <type name="none" c:type="void"/>
32288 <parameter name="service" transfer-ownership="none">
32289 <doc xml:whitespace="preserve">the service type to look up (eg, "ldap")</doc>
32290 <type name="utf8" c:type="gchar*"/>
32292 <parameter name="protocol" transfer-ownership="none">
32293 <doc xml:whitespace="preserve">the networking protocol to use for @service (eg, "tcp")</doc>
32294 <type name="utf8" c:type="gchar*"/>
32296 <parameter name="domain" transfer-ownership="none">
32297 <doc xml:whitespace="preserve">the DNS domain to look up the service in</doc>
32298 <type name="utf8" c:type="gchar*"/>
32300 <parameter name="cancellable"
32301 transfer-ownership="none"
32303 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32304 <type name="Cancellable" c:type="GCancellable*"/>
32306 <parameter name="callback"
32307 transfer-ownership="none"
32310 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
32311 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
32313 <parameter name="user_data" transfer-ownership="none">
32314 <doc xml:whitespace="preserve">data for @callback</doc>
32315 <type name="gpointer" c:type="gpointer"/>
32319 <method name="lookup_service_finish"
32320 c:identifier="g_resolver_lookup_service_finish"
32323 <doc xml:whitespace="preserve">Retrieves the result of a previous call to
32324 g_resolver_lookup_service_async().
32325 If the DNS resolution failed, @error (if non-%NULL) will be set to
32326 a value from #GResolverError. If the operation was cancelled,
32327 or %NULL on error. See g_resolver_lookup_service() for more details.</doc>
32328 <return-value transfer-ownership="full">
32329 <doc xml:whitespace="preserve">a #GList of #GSrvTarget,</doc>
32330 <type name="GLib.List" c:type="GList*">
32331 <type name="SrvTarget"/>
32335 <parameter name="result" transfer-ownership="none">
32336 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
32337 <type name="AsyncResult" c:type="GAsyncResult*"/>
32341 <method name="set_default"
32342 c:identifier="g_resolver_set_default"
32344 <doc xml:whitespace="preserve">Sets @resolver to be the application's default resolver (reffing
32345 Future calls to g_resolver_get_default() will return this resolver.
32346 This can be used if an application wants to perform any sort of DNS
32347 caching or "pinning"; it can implement its own #GResolver that
32348 calls the original default resolver for DNS operations, and
32349 implements its own cache policies on top of that, and then set
32350 itself as the default resolver for all later code to use.</doc>
32351 <return-value transfer-ownership="none">
32352 <type name="none" c:type="void"/>
32355 <field name="parent_instance">
32356 <type name="GObject.Object" c:type="GObject"/>
32358 <field name="priv">
32359 <type name="ResolverPrivate" c:type="GResolverPrivate*"/>
32361 <glib:signal name="reload">
32362 <doc xml:whitespace="preserve">Emitted when the resolver notices that the system resolver
32363 configuration has changed.</doc>
32364 <return-value transfer-ownership="none">
32365 <type name="none"/>
32369 <record name="ResolverClass"
32370 c:type="GResolverClass"
32371 glib:is-gtype-struct-for="Resolver">
32372 <field name="parent_class">
32373 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
32375 <field name="reload">
32376 <callback name="reload">
32377 <return-value transfer-ownership="none">
32378 <type name="none" c:type="void"/>
32381 <parameter name="resolver" transfer-ownership="none">
32382 <type name="Resolver" c:type="GResolver*"/>
32387 <field name="lookup_by_name">
32388 <callback name="lookup_by_name" throws="1">
32389 <return-value transfer-ownership="full">
32390 <doc xml:whitespace="preserve">a #GList</doc>
32391 <type name="GLib.List" c:type="GList*">
32392 <type name="InetAddress"/>
32396 <parameter name="resolver" transfer-ownership="none">
32397 <type name="Resolver" c:type="GResolver*"/>
32399 <parameter name="hostname" transfer-ownership="none">
32400 <doc xml:whitespace="preserve">the hostname to look up</doc>
32401 <type name="utf8" c:type="gchar*"/>
32403 <parameter name="cancellable"
32404 transfer-ownership="none"
32406 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32407 <type name="Cancellable" c:type="GCancellable*"/>
32412 <field name="lookup_by_name_async">
32413 <callback name="lookup_by_name_async">
32414 <return-value transfer-ownership="none">
32415 <type name="none" c:type="void"/>
32418 <parameter name="resolver" transfer-ownership="none">
32419 <type name="Resolver" c:type="GResolver*"/>
32421 <parameter name="hostname" transfer-ownership="none">
32422 <doc xml:whitespace="preserve">the hostname to look up the address of</doc>
32423 <type name="utf8" c:type="gchar*"/>
32425 <parameter name="cancellable"
32426 transfer-ownership="none"
32428 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32429 <type name="Cancellable" c:type="GCancellable*"/>
32431 <parameter name="callback"
32432 transfer-ownership="none"
32435 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
32436 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
32438 <parameter name="user_data" transfer-ownership="none" closure="4">
32439 <doc xml:whitespace="preserve">data for @callback</doc>
32440 <type name="gpointer" c:type="gpointer"/>
32445 <field name="lookup_by_name_finish">
32446 <callback name="lookup_by_name_finish" throws="1">
32447 <return-value transfer-ownership="full">
32448 <doc xml:whitespace="preserve">a #GList</doc>
32449 <type name="GLib.List" c:type="GList*">
32450 <type name="InetAddress"/>
32454 <parameter name="resolver" transfer-ownership="none">
32455 <type name="Resolver" c:type="GResolver*"/>
32457 <parameter name="result" transfer-ownership="none">
32458 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
32459 <type name="AsyncResult" c:type="GAsyncResult*"/>
32464 <field name="lookup_by_address">
32465 <callback name="lookup_by_address" throws="1">
32466 <return-value transfer-ownership="full">
32467 <doc xml:whitespace="preserve">a hostname (either ASCII-only, or in ASCII-encoded</doc>
32468 <type name="utf8" c:type="gchar*"/>
32471 <parameter name="resolver" transfer-ownership="none">
32472 <type name="Resolver" c:type="GResolver*"/>
32474 <parameter name="address" transfer-ownership="none">
32475 <doc xml:whitespace="preserve">the address to reverse-resolve</doc>
32476 <type name="InetAddress" c:type="GInetAddress*"/>
32478 <parameter name="cancellable"
32479 transfer-ownership="none"
32481 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32482 <type name="Cancellable" c:type="GCancellable*"/>
32487 <field name="lookup_by_address_async">
32488 <callback name="lookup_by_address_async">
32489 <return-value transfer-ownership="none">
32490 <type name="none" c:type="void"/>
32493 <parameter name="resolver" transfer-ownership="none">
32494 <type name="Resolver" c:type="GResolver*"/>
32496 <parameter name="address" transfer-ownership="none">
32497 <doc xml:whitespace="preserve">the address to reverse-resolve</doc>
32498 <type name="InetAddress" c:type="GInetAddress*"/>
32500 <parameter name="cancellable"
32501 transfer-ownership="none"
32503 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
32504 <type name="Cancellable" c:type="GCancellable*"/>
32506 <parameter name="callback"
32507 transfer-ownership="none"
32510 <doc xml:whitespace="preserve">callback to call after resolution completes</doc>
32511 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
32513 <parameter name="user_data" transfer-ownership="none" closure="4">
32514 <doc xml:whitespace="preserve">data for @callback</doc>
32515 <type name="gpointer" c:type="gpointer"/>
32520 <field name="lookup_by_address_finish">
32521 <callback name="lookup_by_address_finish" throws="1">
32522 <return-value transfer-ownership="full">
32523 <doc xml:whitespace="preserve">a hostname (either ASCII-only, or in ASCII-encoded</doc>
32524 <type name="utf8" c:type="gchar*"/>
32527 <parameter name="resolver" transfer-ownership="none">
32528 <type name="Resolver" c:type="GResolver*"/>
32530 <parameter name="result" transfer-ownership="none">
32531 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
32532 <type name="AsyncResult" c:type="GAsyncResult*"/>
32537 <field name="lookup_service" introspectable="0">
32538 <callback name="lookup_service" introspectable="0" throws="1">
32540 <type name="GLib.List" c:type="GList*">
32541 <type name="gpointer" c:type="gpointer"/>
32545 <parameter name="resolver" transfer-ownership="none">
32546 <type name="Resolver" c:type="GResolver*"/>
32548 <parameter name="rrname" transfer-ownership="none">
32549 <type name="utf8" c:type="gchar*"/>
32551 <parameter name="cancellable" transfer-ownership="none">
32552 <type name="Cancellable" c:type="GCancellable*"/>
32557 <field name="lookup_service_async">
32558 <callback name="lookup_service_async">
32559 <return-value transfer-ownership="none">
32560 <type name="none" c:type="void"/>
32563 <parameter name="resolver" transfer-ownership="none">
32564 <type name="Resolver" c:type="GResolver*"/>
32566 <parameter name="rrname" transfer-ownership="none">
32567 <type name="utf8" c:type="gchar*"/>
32569 <parameter name="cancellable" transfer-ownership="none">
32570 <type name="Cancellable" c:type="GCancellable*"/>
32572 <parameter name="callback"
32573 transfer-ownership="none"
32576 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
32578 <parameter name="user_data" transfer-ownership="none" closure="4">
32579 <type name="gpointer" c:type="gpointer"/>
32584 <field name="lookup_service_finish">
32585 <callback name="lookup_service_finish" throws="1">
32586 <return-value transfer-ownership="full">
32587 <doc xml:whitespace="preserve">a #GList of #GSrvTarget,</doc>
32588 <type name="GLib.List" c:type="GList*">
32589 <type name="SrvTarget"/>
32593 <parameter name="resolver" transfer-ownership="none">
32594 <type name="Resolver" c:type="GResolver*"/>
32596 <parameter name="result" transfer-ownership="none">
32597 <doc xml:whitespace="preserve">the result passed to your #GAsyncReadyCallback</doc>
32598 <type name="AsyncResult" c:type="GAsyncResult*"/>
32603 <field name="_g_reserved1" introspectable="0">
32604 <callback name="_g_reserved1">
32605 <return-value transfer-ownership="none">
32606 <type name="none" c:type="void"/>
32610 <field name="_g_reserved2" introspectable="0">
32611 <callback name="_g_reserved2">
32612 <return-value transfer-ownership="none">
32613 <type name="none" c:type="void"/>
32617 <field name="_g_reserved3" introspectable="0">
32618 <callback name="_g_reserved3">
32619 <return-value transfer-ownership="none">
32620 <type name="none" c:type="void"/>
32624 <field name="_g_reserved4" introspectable="0">
32625 <callback name="_g_reserved4">
32626 <return-value transfer-ownership="none">
32627 <type name="none" c:type="void"/>
32631 <field name="_g_reserved5" introspectable="0">
32632 <callback name="_g_reserved5">
32633 <return-value transfer-ownership="none">
32634 <type name="none" c:type="void"/>
32638 <field name="_g_reserved6" introspectable="0">
32639 <callback name="_g_reserved6">
32640 <return-value transfer-ownership="none">
32641 <type name="none" c:type="void"/>
32646 <enumeration name="ResolverError"
32648 glib:type-name="GResolverError"
32649 glib:get-type="g_resolver_error_get_type"
32650 c:type="GResolverError"
32651 glib:error-quark="g_resolver_error_quark">
32652 <doc xml:whitespace="preserve">An error code used with %G_RESOLVER_ERROR in a #GError returned
32653 from a #GResolver routine.</doc>
32654 <member name="not_found"
32656 c:identifier="G_RESOLVER_ERROR_NOT_FOUND"
32657 glib:nick="not-found"/>
32658 <member name="temporary_failure"
32660 c:identifier="G_RESOLVER_ERROR_TEMPORARY_FAILURE"
32661 glib:nick="temporary-failure"/>
32662 <member name="internal"
32664 c:identifier="G_RESOLVER_ERROR_INTERNAL"
32665 glib:nick="internal"/>
32667 <record name="ResolverPrivate" c:type="GResolverPrivate" disguised="1">
32669 <constant name="SETTINGS_BACKEND_EXTENSION_POINT_NAME"
32670 value="gsettings-backend">
32671 <type name="utf8" c:type="gchar*"/>
32673 <interface name="Seekable"
32674 c:symbol-prefix="seekable"
32676 glib:type-name="GSeekable"
32677 glib:get-type="g_seekable_get_type"
32678 glib:type-struct="SeekableIface">
32679 <doc xml:whitespace="preserve">Seek object for streaming operations.</doc>
32680 <virtual-method name="can_seek" invoker="can_seek">
32681 <doc xml:whitespace="preserve">Tests if the stream supports the #GSeekableIface.</doc>
32682 <return-value transfer-ownership="none">
32683 <doc xml:whitespace="preserve">%TRUE if @seekable can be seeked. %FALSE otherwise.</doc>
32684 <type name="gboolean" c:type="gboolean"/>
32687 <virtual-method name="can_truncate" invoker="can_truncate">
32688 <doc xml:whitespace="preserve">Tests if the stream can be truncated.</doc>
32689 <return-value transfer-ownership="none">
32690 <doc xml:whitespace="preserve">%TRUE if the stream can be truncated, %FALSE otherwise.</doc>
32691 <type name="gboolean" c:type="gboolean"/>
32694 <virtual-method name="seek" invoker="seek" throws="1">
32695 <doc xml:whitespace="preserve">Seeks in the stream by the given @offset, modified by @type.
32696 If @cancellable is not %NULL, then the operation can be cancelled by
32697 triggering the cancellable object from another thread. If the operation
32698 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
32699 has occurred, this function will return %FALSE and set @error
32700 appropriately if present.</doc>
32701 <return-value transfer-ownership="none">
32702 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
32703 <type name="gboolean" c:type="gboolean"/>
32706 <parameter name="offset" transfer-ownership="none">
32707 <doc xml:whitespace="preserve">a #goffset.</doc>
32708 <type name="gint64" c:type="goffset"/>
32710 <parameter name="type" transfer-ownership="none">
32711 <doc xml:whitespace="preserve">a #GSeekType.</doc>
32712 <type name="GLib.SeekType" c:type="GSeekType"/>
32714 <parameter name="cancellable"
32715 transfer-ownership="none"
32717 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
32718 <type name="Cancellable" c:type="GCancellable*"/>
32722 <virtual-method name="tell" invoker="tell">
32723 <doc xml:whitespace="preserve">Tells the current position within the stream.</doc>
32724 <return-value transfer-ownership="none">
32725 <doc xml:whitespace="preserve">the offset from the beginning of the buffer.</doc>
32726 <type name="gint64" c:type="goffset"/>
32729 <virtual-method name="truncate_fn" invoker="truncate" throws="1">
32730 <doc xml:whitespace="preserve">Truncates a stream with a given #offset.
32731 If @cancellable is not %NULL, then the operation can be cancelled by
32732 triggering the cancellable object from another thread. If the operation
32733 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
32734 operation was partially finished when the operation was cancelled the
32735 partial result will be returned, without an error.
32736 has occurred, this function will return %FALSE and set @error
32737 appropriately if present.</doc>
32738 <return-value transfer-ownership="none">
32739 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
32740 <type name="gboolean" c:type="gboolean"/>
32743 <parameter name="offset" transfer-ownership="none">
32744 <doc xml:whitespace="preserve">a #goffset.</doc>
32745 <type name="gint64" c:type="goffset"/>
32747 <parameter name="cancellable"
32748 transfer-ownership="none"
32750 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
32751 <type name="Cancellable" c:type="GCancellable*"/>
32755 <method name="can_seek" c:identifier="g_seekable_can_seek">
32756 <doc xml:whitespace="preserve">Tests if the stream supports the #GSeekableIface.</doc>
32757 <return-value transfer-ownership="none">
32758 <doc xml:whitespace="preserve">%TRUE if @seekable can be seeked. %FALSE otherwise.</doc>
32759 <type name="gboolean" c:type="gboolean"/>
32762 <method name="can_truncate" c:identifier="g_seekable_can_truncate">
32763 <doc xml:whitespace="preserve">Tests if the stream can be truncated.</doc>
32764 <return-value transfer-ownership="none">
32765 <doc xml:whitespace="preserve">%TRUE if the stream can be truncated, %FALSE otherwise.</doc>
32766 <type name="gboolean" c:type="gboolean"/>
32769 <method name="seek" c:identifier="g_seekable_seek" throws="1">
32770 <doc xml:whitespace="preserve">Seeks in the stream by the given @offset, modified by @type.
32771 If @cancellable is not %NULL, then the operation can be cancelled by
32772 triggering the cancellable object from another thread. If the operation
32773 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
32774 has occurred, this function will return %FALSE and set @error
32775 appropriately if present.</doc>
32776 <return-value transfer-ownership="none">
32777 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
32778 <type name="gboolean" c:type="gboolean"/>
32781 <parameter name="offset" transfer-ownership="none">
32782 <doc xml:whitespace="preserve">a #goffset.</doc>
32783 <type name="gint64" c:type="goffset"/>
32785 <parameter name="type" transfer-ownership="none">
32786 <doc xml:whitespace="preserve">a #GSeekType.</doc>
32787 <type name="GLib.SeekType" c:type="GSeekType"/>
32789 <parameter name="cancellable"
32790 transfer-ownership="none"
32792 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
32793 <type name="Cancellable" c:type="GCancellable*"/>
32797 <method name="tell" c:identifier="g_seekable_tell">
32798 <doc xml:whitespace="preserve">Tells the current position within the stream.</doc>
32799 <return-value transfer-ownership="none">
32800 <doc xml:whitespace="preserve">the offset from the beginning of the buffer.</doc>
32801 <type name="gint64" c:type="goffset"/>
32804 <method name="truncate" c:identifier="g_seekable_truncate" throws="1">
32805 <doc xml:whitespace="preserve">Truncates a stream with a given #offset.
32806 If @cancellable is not %NULL, then the operation can be cancelled by
32807 triggering the cancellable object from another thread. If the operation
32808 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
32809 operation was partially finished when the operation was cancelled the
32810 partial result will be returned, without an error.
32811 has occurred, this function will return %FALSE and set @error
32812 appropriately if present.</doc>
32813 <return-value transfer-ownership="none">
32814 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
32815 <type name="gboolean" c:type="gboolean"/>
32818 <parameter name="offset" transfer-ownership="none">
32819 <doc xml:whitespace="preserve">a #goffset.</doc>
32820 <type name="gint64" c:type="goffset"/>
32822 <parameter name="cancellable"
32823 transfer-ownership="none"
32825 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
32826 <type name="Cancellable" c:type="GCancellable*"/>
32831 <record name="SeekableIface"
32832 c:type="GSeekableIface"
32833 glib:is-gtype-struct-for="Seekable">
32834 <doc xml:whitespace="preserve">Provides an interface for implementing seekable functionality on I/O Streams.</doc>
32835 <field name="g_iface">
32836 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
32838 <field name="tell">
32839 <callback name="tell">
32840 <return-value transfer-ownership="none">
32841 <doc xml:whitespace="preserve">the offset from the beginning of the buffer.</doc>
32842 <type name="gint64" c:type="goffset"/>
32845 <parameter name="seekable" transfer-ownership="none">
32846 <type name="Seekable" c:type="GSeekable*"/>
32851 <field name="can_seek">
32852 <callback name="can_seek">
32853 <return-value transfer-ownership="none">
32854 <doc xml:whitespace="preserve">%TRUE if @seekable can be seeked. %FALSE otherwise.</doc>
32855 <type name="gboolean" c:type="gboolean"/>
32858 <parameter name="seekable" transfer-ownership="none">
32859 <type name="Seekable" c:type="GSeekable*"/>
32864 <field name="seek">
32865 <callback name="seek" throws="1">
32866 <return-value transfer-ownership="none">
32867 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
32868 <type name="gboolean" c:type="gboolean"/>
32871 <parameter name="seekable" transfer-ownership="none">
32872 <type name="Seekable" c:type="GSeekable*"/>
32874 <parameter name="offset" transfer-ownership="none">
32875 <doc xml:whitespace="preserve">a #goffset.</doc>
32876 <type name="gint64" c:type="goffset"/>
32878 <parameter name="type" transfer-ownership="none">
32879 <doc xml:whitespace="preserve">a #GSeekType.</doc>
32880 <type name="GLib.SeekType" c:type="GSeekType"/>
32882 <parameter name="cancellable"
32883 transfer-ownership="none"
32885 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
32886 <type name="Cancellable" c:type="GCancellable*"/>
32891 <field name="can_truncate">
32892 <callback name="can_truncate">
32893 <return-value transfer-ownership="none">
32894 <doc xml:whitespace="preserve">%TRUE if the stream can be truncated, %FALSE otherwise.</doc>
32895 <type name="gboolean" c:type="gboolean"/>
32898 <parameter name="seekable" transfer-ownership="none">
32899 <type name="Seekable" c:type="GSeekable*"/>
32904 <field name="truncate_fn">
32905 <callback name="truncate_fn" throws="1">
32906 <return-value transfer-ownership="none">
32907 <doc xml:whitespace="preserve">%TRUE if successful. If an error</doc>
32908 <type name="gboolean" c:type="gboolean"/>
32911 <parameter name="seekable" transfer-ownership="none">
32912 <type name="Seekable" c:type="GSeekable*"/>
32914 <parameter name="offset" transfer-ownership="none">
32915 <doc xml:whitespace="preserve">a #goffset.</doc>
32916 <type name="gint64" c:type="goffset"/>
32918 <parameter name="cancellable"
32919 transfer-ownership="none"
32921 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
32922 <type name="Cancellable" c:type="GCancellable*"/>
32928 <class name="Settings"
32929 c:symbol-prefix="settings"
32931 parent="GObject.Object"
32932 glib:type-name="GSettings"
32933 glib:get-type="g_settings_get_type"
32934 glib:type-struct="SettingsClass">
32935 <constructor name="new" c:identifier="g_settings_new" version="2.26">
32936 <doc xml:whitespace="preserve">Creates a new #GSettings object with a given schema.
32937 Signals on the newly created #GSettings object will be dispatched
32938 via the thread-default #GMainContext in effect at the time of the
32939 call to g_settings_new(). The new #GSettings will hold a reference
32940 on the context. See g_main_context_push_thread_default().</doc>
32941 <return-value transfer-ownership="full">
32942 <doc xml:whitespace="preserve">a new #GSettings object</doc>
32943 <type name="Settings" c:type="GSettings*"/>
32946 <parameter name="schema" transfer-ownership="none">
32947 <doc xml:whitespace="preserve">the name of the schema</doc>
32948 <type name="utf8" c:type="gchar*"/>
32952 <constructor name="new_with_backend"
32953 c:identifier="g_settings_new_with_backend"
32955 <doc xml:whitespace="preserve">Creates a new #GSettings object with a given schema and backend.
32956 Creating settings objects with an different backend allows accessing settings
32957 from a database other than the usual one. For example, it may make
32958 sense to pass a backend corresponding to the "defaults" settings database on
32959 the system to get a settings object that modifies the system default
32960 settings instead of the settings for this user.</doc>
32961 <return-value transfer-ownership="full">
32962 <doc xml:whitespace="preserve">a new #GSettings object</doc>
32963 <type name="Settings" c:type="GSettings*"/>
32966 <parameter name="schema" transfer-ownership="none">
32967 <doc xml:whitespace="preserve">the name of the schema</doc>
32968 <type name="utf8" c:type="gchar*"/>
32970 <parameter name="backend" transfer-ownership="none">
32971 <doc xml:whitespace="preserve">the #GSettingsBackend to use</doc>
32972 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
32976 <constructor name="new_with_backend_and_path"
32977 c:identifier="g_settings_new_with_backend_and_path"
32979 <doc xml:whitespace="preserve">Creates a new #GSettings object with a given schema, backend and
32981 This is a mix of g_settings_new_with_backend() and
32982 g_settings_new_with_path().</doc>
32983 <return-value transfer-ownership="full">
32984 <doc xml:whitespace="preserve">a new #GSettings object</doc>
32985 <type name="Settings" c:type="GSettings*"/>
32988 <parameter name="schema" transfer-ownership="none">
32989 <doc xml:whitespace="preserve">the name of the schema</doc>
32990 <type name="utf8" c:type="gchar*"/>
32992 <parameter name="backend" transfer-ownership="none">
32993 <doc xml:whitespace="preserve">the #GSettingsBackend to use</doc>
32994 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
32996 <parameter name="path" transfer-ownership="none">
32997 <doc xml:whitespace="preserve">the path to use</doc>
32998 <type name="utf8" c:type="gchar*"/>
33002 <constructor name="new_with_path"
33003 c:identifier="g_settings_new_with_path"
33005 <doc xml:whitespace="preserve">Creates a new #GSettings object with a given schema and path.
33006 You only need to do this if you want to directly create a settings
33007 object with a schema that doesn't have a specified path of its own.
33009 It is a programmer error to call this function for a schema that
33010 has an explicitly specified path.</doc>
33011 <return-value transfer-ownership="full">
33012 <doc xml:whitespace="preserve">a new #GSettings object</doc>
33013 <type name="Settings" c:type="GSettings*"/>
33016 <parameter name="schema" transfer-ownership="none">
33017 <doc xml:whitespace="preserve">the name of the schema</doc>
33018 <type name="utf8" c:type="gchar*"/>
33020 <parameter name="path" transfer-ownership="none">
33021 <doc xml:whitespace="preserve">the path to use</doc>
33022 <type name="utf8" c:type="gchar*"/>
33026 <function name="list_schemas" c:identifier="g_settings_list_schemas">
33027 <doc xml:whitespace="preserve">must not be modified or freed.</doc>
33028 <return-value transfer-ownership="none">
33029 <doc xml:whitespace="preserve">a list of GSettings schemas that are available. The list</doc>
33030 <array c:type="gchar**">
33031 <type name="utf8"/>
33035 <function name="sync" c:identifier="g_settings_sync">
33036 <doc xml:whitespace="preserve">Ensures that all pending operations for the given are complete for
33037 the default backend.
33038 Writes made to a #GSettings are handled asynchronously. For this
33039 reason, it is very unlikely that the changes have it to disk by the
33040 time g_settings_set() returns.
33041 This call will block until all of the writes have made it to the
33042 backend. Since the mainloop is not running, no change notifications
33043 will be dispatched during this call (but some may be queued by the
33044 time the call is done).</doc>
33045 <return-value transfer-ownership="none">
33046 <type name="none" c:type="void"/>
33049 <function name="unbind" c:identifier="g_settings_unbind" version="2.26">
33050 <doc xml:whitespace="preserve">Removes an existing binding for @property on @object.
33051 Note that bindings are automatically removed when the
33052 object is finalized, so it is rarely necessary to call this
33054 <return-value transfer-ownership="none">
33055 <type name="none" c:type="void"/>
33058 <parameter name="object" transfer-ownership="none">
33059 <doc xml:whitespace="preserve">the object</doc>
33060 <type name="gpointer" c:type="gpointer"/>
33062 <parameter name="property" transfer-ownership="none">
33063 <doc xml:whitespace="preserve">the property whose binding is removed</doc>
33064 <type name="utf8" c:type="gchar*"/>
33068 <method name="apply" c:identifier="g_settings_apply">
33069 <doc xml:whitespace="preserve">Applies any changes that have been made to the settings. This
33070 function does nothing unless @settings is in 'delay-apply' mode;
33071 see g_settings_delay(). In the normal case settings are always
33072 applied immediately.</doc>
33073 <return-value transfer-ownership="none">
33074 <type name="none" c:type="void"/>
33077 <method name="bind" c:identifier="g_settings_bind" version="2.26">
33078 <doc xml:whitespace="preserve">Create a binding between the @key in the @settings object
33079 and the property @property of @object.
33080 The binding uses the default GIO mapping functions to map
33081 between the settings and property values. These functions
33082 handle booleans, numeric types and string types in a
33083 straightforward way. Use g_settings_bind_with_mapping() if
33084 you need a custom mapping, or map between types that are not
33085 supported by the default mapping functions.
33086 Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
33087 function also establishes a binding between the writability of
33088 a boolean property by that name). See g_settings_bind_writable()
33089 for more details about writable bindings.
33090 Note that the lifecycle of the binding is tied to the object,
33091 and that you can have only one binding per object property.
33092 If you bind the same property twice on the same object, the second
33093 binding overrides the first one.</doc>
33094 <return-value transfer-ownership="none">
33095 <type name="none" c:type="void"/>
33098 <parameter name="key" transfer-ownership="none">
33099 <doc xml:whitespace="preserve">the key to bind</doc>
33100 <type name="utf8" c:type="gchar*"/>
33102 <parameter name="object" transfer-ownership="none">
33103 <doc xml:whitespace="preserve">a #GObject</doc>
33104 <type name="gpointer" c:type="gpointer"/>
33106 <parameter name="property" transfer-ownership="none">
33107 <doc xml:whitespace="preserve">the name of the property to bind</doc>
33108 <type name="utf8" c:type="gchar*"/>
33110 <parameter name="flags" transfer-ownership="none">
33111 <doc xml:whitespace="preserve">flags for the binding</doc>
33112 <type name="SettingsBindFlags" c:type="GSettingsBindFlags"/>
33116 <method name="bind_with_mapping"
33117 c:identifier="g_settings_bind_with_mapping"
33119 introspectable="0">
33120 <doc xml:whitespace="preserve">Create a binding between the @key in the @settings object
33121 and the property @property of @object.
33122 The binding uses the provided mapping functions to map between
33123 settings and property values.
33124 Note that the lifecycle of the binding is tied to the object,
33125 and that you can have only one binding per object property.
33126 If you bind the same property twice on the same object, the second
33127 binding overrides the first one.</doc>
33128 <return-value transfer-ownership="none">
33129 <type name="none" c:type="void"/>
33132 <parameter name="key" transfer-ownership="none">
33133 <doc xml:whitespace="preserve">the key to bind</doc>
33134 <type name="utf8" c:type="gchar*"/>
33136 <parameter name="object" transfer-ownership="none">
33137 <doc xml:whitespace="preserve">a #GObject</doc>
33138 <type name="gpointer" c:type="gpointer"/>
33140 <parameter name="property" transfer-ownership="none">
33141 <doc xml:whitespace="preserve">the name of the property to bind</doc>
33142 <type name="utf8" c:type="gchar*"/>
33144 <parameter name="flags" transfer-ownership="none">
33145 <doc xml:whitespace="preserve">flags for the binding</doc>
33146 <type name="SettingsBindFlags" c:type="GSettingsBindFlags"/>
33148 <parameter name="get_mapping" transfer-ownership="none">
33149 <doc xml:whitespace="preserve">a function that gets called to convert values from @settings to @object, or %NULL to use the default GIO mapping</doc>
33150 <type name="SettingsBindGetMapping"
33151 c:type="GSettingsBindGetMapping"/>
33153 <parameter name="set_mapping"
33154 transfer-ownership="none"
33158 <doc xml:whitespace="preserve">a function that gets called to convert values from @object to @settings, or %NULL to use the default GIO mapping</doc>
33159 <type name="SettingsBindSetMapping"
33160 c:type="GSettingsBindSetMapping"/>
33162 <parameter name="user_data" transfer-ownership="none">
33163 <doc xml:whitespace="preserve">data that gets passed to @get_mapping and @set_mapping</doc>
33164 <type name="gpointer" c:type="gpointer"/>
33166 <parameter name="destroy" transfer-ownership="none" scope="async">
33167 <doc xml:whitespace="preserve">#GDestroyNotify function for @user_data</doc>
33168 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
33172 <method name="bind_writable"
33173 c:identifier="g_settings_bind_writable"
33175 <doc xml:whitespace="preserve">Create a binding between the writability of @key in the
33176 The property must be boolean; "sensitive" or "visible"
33177 properties of widgets are the most likely candidates.
33178 Writable bindings are always uni-directional; changes of the
33179 writability of the setting will be propagated to the object
33180 property, not the other way.
33181 When the @inverted argument is %TRUE, the binding inverts the
33182 value as it passes from the setting to the object, i.e. @property
33183 will be set to %TRUE if the key is <emphasis>not</emphasis>
33185 Note that the lifecycle of the binding is tied to the object,
33186 and that you can have only one binding per object property.
33187 If you bind the same property twice on the same object, the second
33188 binding overrides the first one.</doc>
33189 <return-value transfer-ownership="none">
33190 <type name="none" c:type="void"/>
33193 <parameter name="key" transfer-ownership="none">
33194 <doc xml:whitespace="preserve">the key to bind</doc>
33195 <type name="utf8" c:type="gchar*"/>
33197 <parameter name="object" transfer-ownership="none">
33198 <doc xml:whitespace="preserve">a #GObject</doc>
33199 <type name="gpointer" c:type="gpointer"/>
33201 <parameter name="property" transfer-ownership="none">
33202 <doc xml:whitespace="preserve">the name of a boolean property to bind</doc>
33203 <type name="utf8" c:type="gchar*"/>
33205 <parameter name="inverted" transfer-ownership="none">
33206 <doc xml:whitespace="preserve">whether to 'invert' the value</doc>
33207 <type name="gboolean" c:type="gboolean"/>
33211 <method name="delay" c:identifier="g_settings_delay" version="2.26">
33212 <doc xml:whitespace="preserve">Changes the #GSettings object into 'delay-apply' mode. In this
33213 mode, changes to @settings are not immediately propagated to the
33214 backend, but kept locally until g_settings_apply() is called.</doc>
33215 <return-value transfer-ownership="none">
33216 <type name="none" c:type="void"/>
33220 c:identifier="g_settings_get"
33222 introspectable="0">
33223 <doc xml:whitespace="preserve">Gets the value that is stored at @key in @settings.
33224 A convenience function that combines g_settings_get_value() with
33226 It is a programmer error to give a @key that isn't contained in the
33227 schema for @settings or for the #GVariantType of @format to mismatch
33228 the type given in the schema.</doc>
33229 <return-value transfer-ownership="none">
33230 <type name="none" c:type="void"/>
33233 <parameter name="key" transfer-ownership="none">
33234 <doc xml:whitespace="preserve">the key to get the value for</doc>
33235 <type name="utf8" c:type="gchar*"/>
33237 <parameter name="format" transfer-ownership="none">
33238 <doc xml:whitespace="preserve">a #GVariant format string</doc>
33239 <type name="utf8" c:type="gchar*"/>
33241 <parameter transfer-ownership="none">
33247 <method name="get_boolean"
33248 c:identifier="g_settings_get_boolean"
33250 <doc xml:whitespace="preserve">Gets the value that is stored at @key in @settings.
33251 A convenience variant of g_settings_get() for booleans.
33252 It is a programmer error to give a @key that isn't specified as
33253 having a boolean type in the schema for @settings.</doc>
33254 <return-value transfer-ownership="none">
33255 <doc xml:whitespace="preserve">a boolean</doc>
33256 <type name="gboolean" c:type="gboolean"/>
33259 <parameter name="key" transfer-ownership="none">
33260 <doc xml:whitespace="preserve">the key to get the value for</doc>
33261 <type name="utf8" c:type="gchar*"/>
33265 <method name="get_child"
33266 c:identifier="g_settings_get_child"
33268 <doc xml:whitespace="preserve">Creates a 'child' settings object which has a base path of
33269 <replaceable>base-path</replaceable>/@name", where
33270 <replaceable>base-path</replaceable> is the base path of @settings.
33271 The schema for the child settings object must have been declared
33272 in the schema of @settings using a <tag class="starttag">child</tag> element.</doc>
33273 <return-value transfer-ownership="full">
33274 <doc xml:whitespace="preserve">a 'child' settings object</doc>
33275 <type name="Settings" c:type="GSettings*"/>
33278 <parameter name="name" transfer-ownership="none">
33279 <doc xml:whitespace="preserve">the name of the 'child' schema</doc>
33280 <type name="utf8" c:type="gchar*"/>
33284 <method name="get_double"
33285 c:identifier="g_settings_get_double"
33287 <doc xml:whitespace="preserve">Gets the value that is stored at @key in @settings.
33288 A convenience variant of g_settings_get() for doubles.
33289 It is a programmer error to give a @key that isn't specified as
33290 having a 'double' type in the schema for @settings.</doc>
33291 <return-value transfer-ownership="none">
33292 <doc xml:whitespace="preserve">a double</doc>
33293 <type name="gdouble" c:type="gdouble"/>
33296 <parameter name="key" transfer-ownership="none">
33297 <doc xml:whitespace="preserve">the key to get the value for</doc>
33298 <type name="utf8" c:type="gchar*"/>
33302 <method name="get_enum"
33303 c:identifier="g_settings_get_enum"
33305 <doc xml:whitespace="preserve">Gets the value that is stored in @settings for @key and converts it
33306 to the enum value that it represents.
33307 In order to use this function the type of the value must be a string
33308 and it must be marked in the schema file as an enumerated type.
33309 It is a programmer error to give a @key that isn't contained in the
33310 schema for @settings or is not marked as an enumerated type.
33311 If the value stored in the configuration database is not a valid
33312 value for the enumerated type then this function will return the
33313 default value.</doc>
33314 <return-value transfer-ownership="none">
33315 <doc xml:whitespace="preserve">the enum value</doc>
33316 <type name="gint" c:type="gint"/>
33319 <parameter name="key" transfer-ownership="none">
33320 <doc xml:whitespace="preserve">the key to get the value for</doc>
33321 <type name="utf8" c:type="gchar*"/>
33325 <method name="get_flags"
33326 c:identifier="g_settings_get_flags"
33328 <doc xml:whitespace="preserve">Gets the value that is stored in @settings for @key and converts it
33329 to the flags value that it represents.
33330 In order to use this function the type of the value must be an array
33331 of strings and it must be marked in the schema file as an flags type.
33332 It is a programmer error to give a @key that isn't contained in the
33333 schema for @settings or is not marked as a flags type.
33334 If the value stored in the configuration database is not a valid
33335 value for the flags type then this function will return the default
33337 <return-value transfer-ownership="none">
33338 <doc xml:whitespace="preserve">the flags value</doc>
33339 <type name="guint" c:type="guint"/>
33342 <parameter name="key" transfer-ownership="none">
33343 <doc xml:whitespace="preserve">the key to get the value for</doc>
33344 <type name="utf8" c:type="gchar*"/>
33348 <method name="get_has_unapplied"
33349 c:identifier="g_settings_get_has_unapplied"
33351 <doc xml:whitespace="preserve">Returns whether the #GSettings object has any unapplied
33352 changes. This can only be the case if it is in 'delayed-apply' mode.</doc>
33353 <return-value transfer-ownership="none">
33354 <doc xml:whitespace="preserve">%TRUE if @settings has unapplied changes</doc>
33355 <type name="gboolean" c:type="gboolean"/>
33358 <method name="get_int" c:identifier="g_settings_get_int" version="2.26">
33359 <doc xml:whitespace="preserve">Gets the value that is stored at @key in @settings.
33360 A convenience variant of g_settings_get() for 32-bit integers.
33361 It is a programmer error to give a @key that isn't specified as
33362 having a int32 type in the schema for @settings.</doc>
33363 <return-value transfer-ownership="none">
33364 <doc xml:whitespace="preserve">an integer</doc>
33365 <type name="gint" c:type="gint"/>
33368 <parameter name="key" transfer-ownership="none">
33369 <doc xml:whitespace="preserve">the key to get the value for</doc>
33370 <type name="utf8" c:type="gchar*"/>
33374 <method name="get_mapped"
33375 c:identifier="g_settings_get_mapped"
33376 introspectable="0">
33377 <doc xml:whitespace="preserve">Gets the value that is stored at @key in @settings, subject to
33378 application-level validation/mapping.
33379 You should use this function when the application needs to perform
33380 some processing on the value of the key (for example, parsing). The
33381 indicates that the processing was unsuccessful (due to a parse error,
33382 for example) then the mapping is tried again with another value.
33383 This allows a robust 'fall back to defaults' behaviour to be
33384 implemented somewhat automatically.
33385 The first value that is tried is the user's setting for the key. If
33386 the mapping function fails to map this value, other values may be
33387 tried in an unspecified order (system or site defaults, translated
33388 schema default values, untranslated schema default values, etc).
33389 If the mapping function fails for all possible values, one additional
33390 If the mapping function still indicates failure at this point then
33391 the application will be aborted.
33392 The result parameter for the @mapping function is pointed to a
33393 #gpointer which is initially set to %NULL. The same pointer is given
33394 to each invocation of @mapping. The final value of that #gpointer is
33395 what is returned by this function. %NULL is valid; it is returned
33396 just as any other value would be.</doc>
33397 <return-value transfer-ownership="full">
33398 <doc xml:whitespace="preserve">the result, which may be %NULL</doc>
33399 <type name="gpointer" c:type="gpointer"/>
33402 <parameter name="key" transfer-ownership="none">
33403 <doc xml:whitespace="preserve">the key to get the value for</doc>
33404 <type name="utf8" c:type="gchar*"/>
33406 <parameter name="mapping" transfer-ownership="none" closure="2">
33407 <doc xml:whitespace="preserve">the function to map the value in the settings database to the value used by the application</doc>
33408 <type name="SettingsGetMapping" c:type="GSettingsGetMapping"/>
33410 <parameter name="user_data" transfer-ownership="none">
33411 <doc xml:whitespace="preserve">user data for @mapping</doc>
33412 <type name="gpointer" c:type="gpointer"/>
33416 <method name="get_string"
33417 c:identifier="g_settings_get_string"
33419 <doc xml:whitespace="preserve">Gets the value that is stored at @key in @settings.
33420 A convenience variant of g_settings_get() for strings.
33421 It is a programmer error to give a @key that isn't specified as
33422 having a string type in the schema for @settings.</doc>
33423 <return-value transfer-ownership="full">
33424 <doc xml:whitespace="preserve">a newly-allocated string</doc>
33425 <type name="utf8" c:type="gchar*"/>
33428 <parameter name="key" transfer-ownership="none">
33429 <doc xml:whitespace="preserve">the key to get the value for</doc>
33430 <type name="utf8" c:type="gchar*"/>
33434 <method name="get_strv"
33435 c:identifier="g_settings_get_strv"
33437 <doc xml:whitespace="preserve">A convenience variant of g_settings_get() for string arrays.
33438 It is a programmer error to give a @key that isn't specified as
33439 having an array of strings type in the schema for @settings.
33440 stored at @key in @settings.</doc>
33441 <return-value transfer-ownership="full">
33442 <doc xml:whitespace="preserve">the value that is</doc>
33443 <array c:type="gchar**">
33444 <type name="utf8"/>
33448 <parameter name="key" transfer-ownership="none">
33449 <doc xml:whitespace="preserve">the key to get the value for</doc>
33450 <type name="utf8" c:type="gchar*"/>
33454 <method name="get_value"
33455 c:identifier="g_settings_get_value"
33457 <doc xml:whitespace="preserve">Gets the value that is stored in @settings for @key.
33458 It is a programmer error to give a @key that isn't contained in the
33459 schema for @settings.</doc>
33460 <return-value transfer-ownership="full">
33461 <doc xml:whitespace="preserve">a new #GVariant</doc>
33462 <type name="GLib.Variant" c:type="GVariant*"/>
33465 <parameter name="key" transfer-ownership="none">
33466 <doc xml:whitespace="preserve">the key to get the value for</doc>
33467 <type name="utf8" c:type="gchar*"/>
33471 <method name="is_writable"
33472 c:identifier="g_settings_is_writable"
33474 <doc xml:whitespace="preserve">Finds out if a key can be written or not</doc>
33475 <return-value transfer-ownership="none">
33476 <doc xml:whitespace="preserve">%TRUE if the key @name is writable</doc>
33477 <type name="gboolean" c:type="gboolean"/>
33480 <parameter name="name" transfer-ownership="none">
33481 <doc xml:whitespace="preserve">the name of a key</doc>
33482 <type name="utf8" c:type="gchar*"/>
33486 <method name="list_children" c:identifier="g_settings_list_children">
33487 <doc xml:whitespace="preserve">Gets the list of children on @settings.
33488 The list is exactly the list of strings for which it is not an error
33489 to call g_settings_get_child().
33490 For GSettings objects that are lists, this value can change at any
33491 time and you should connect to the "children-changed" signal to watch
33492 request a child after listing it only for it to have been destroyed
33493 in the meantime. For this reason, g_settings_get_chuld() may return
33494 %NULL even for a child that was listed by this function.
33495 For GSettings objects that are not lists, you should probably not be
33496 calling this function from "normal" code (since you should already
33497 know what children are in your schema). This function may still be
33498 useful there for introspection reasons, however.
33499 You should free the return value with g_strfreev() when you are done
33501 <return-value transfer-ownership="full">
33502 <doc xml:whitespace="preserve">a list of the children on @settings</doc>
33503 <array c:type="gchar**">
33504 <type name="utf8"/>
33508 <method name="list_keys" c:identifier="g_settings_list_keys">
33509 <doc xml:whitespace="preserve">Introspects the list of keys on @settings.
33510 You should probably not be calling this function from "normal" code
33511 (since you should already know what keys are in your schema). This
33512 function is intended for introspection reasons.
33513 You should free the return value with g_strfreev() when you are done
33515 <return-value transfer-ownership="full">
33516 <doc xml:whitespace="preserve">a list of the keys on @settings</doc>
33517 <array c:type="gchar**">
33518 <type name="utf8"/>
33522 <method name="reset" c:identifier="g_settings_reset">
33523 <doc xml:whitespace="preserve">Resets @key to its default value.
33524 This call resets the key, as much as possible, to its default value.
33525 That might the value specified in the schema or the one set by the
33526 administrator.</doc>
33527 <return-value transfer-ownership="none">
33528 <type name="none" c:type="void"/>
33531 <parameter name="key" transfer-ownership="none">
33532 <doc xml:whitespace="preserve">the name of a key</doc>
33533 <type name="utf8" c:type="gchar*"/>
33537 <method name="revert" c:identifier="g_settings_revert">
33538 <doc xml:whitespace="preserve">Reverts all non-applied changes to the settings. This function
33539 does nothing unless @settings is in 'delay-apply' mode; see
33540 g_settings_delay(). In the normal case settings are always applied
33542 Change notifications will be emitted for affected keys.</doc>
33543 <return-value transfer-ownership="none">
33544 <type name="none" c:type="void"/>
33548 c:identifier="g_settings_set"
33550 introspectable="0">
33551 <doc xml:whitespace="preserve">Sets @key in @settings to @value.
33552 A convenience function that combines g_settings_set_value() with
33554 It is a programmer error to give a @key that isn't contained in the
33555 schema for @settings or for the #GVariantType of @format to mismatch
33556 the type given in the schema.</doc>
33557 <return-value transfer-ownership="none">
33558 <doc xml:whitespace="preserve">%TRUE if setting the key succeeded, %FALSE if the key was not writable</doc>
33559 <type name="gboolean" c:type="gboolean"/>
33562 <parameter name="key" transfer-ownership="none">
33563 <doc xml:whitespace="preserve">the name of the key to set</doc>
33564 <type name="utf8" c:type="gchar*"/>
33566 <parameter name="format" transfer-ownership="none">
33567 <doc xml:whitespace="preserve">a #GVariant format string</doc>
33568 <type name="utf8" c:type="gchar*"/>
33570 <parameter transfer-ownership="none">
33576 <method name="set_boolean"
33577 c:identifier="g_settings_set_boolean"
33579 <doc xml:whitespace="preserve">Sets @key in @settings to @value.
33580 A convenience variant of g_settings_set() for booleans.
33581 It is a programmer error to give a @key that isn't specified as
33582 having a boolean type in the schema for @settings.</doc>
33583 <return-value transfer-ownership="none">
33584 <doc xml:whitespace="preserve">%TRUE if setting the key succeeded, %FALSE if the key was not writable</doc>
33585 <type name="gboolean" c:type="gboolean"/>
33588 <parameter name="key" transfer-ownership="none">
33589 <doc xml:whitespace="preserve">the name of the key to set</doc>
33590 <type name="utf8" c:type="gchar*"/>
33592 <parameter name="value" transfer-ownership="none">
33593 <doc xml:whitespace="preserve">the value to set it to</doc>
33594 <type name="gboolean" c:type="gboolean"/>
33598 <method name="set_double"
33599 c:identifier="g_settings_set_double"
33601 <doc xml:whitespace="preserve">Sets @key in @settings to @value.
33602 A convenience variant of g_settings_set() for doubles.
33603 It is a programmer error to give a @key that isn't specified as
33604 having a 'double' type in the schema for @settings.</doc>
33605 <return-value transfer-ownership="none">
33606 <doc xml:whitespace="preserve">%TRUE if setting the key succeeded, %FALSE if the key was not writable</doc>
33607 <type name="gboolean" c:type="gboolean"/>
33610 <parameter name="key" transfer-ownership="none">
33611 <doc xml:whitespace="preserve">the name of the key to set</doc>
33612 <type name="utf8" c:type="gchar*"/>
33614 <parameter name="value" transfer-ownership="none">
33615 <doc xml:whitespace="preserve">the value to set it to</doc>
33616 <type name="gdouble" c:type="gdouble"/>
33620 <method name="set_enum" c:identifier="g_settings_set_enum">
33621 <doc xml:whitespace="preserve">Looks up the enumerated type nick for @value and writes it to @key,
33623 It is a programmer error to give a @key that isn't contained in the
33624 schema for @settings or is not marked as an enumerated type, or for
33625 After performing the write, accessing @key directly with
33626 g_settings_get_string() will return the 'nick' associated with</doc>
33627 <return-value transfer-ownership="none">
33628 <doc xml:whitespace="preserve">%TRUE, if the set succeeds</doc>
33629 <type name="gboolean" c:type="gboolean"/>
33632 <parameter name="key" transfer-ownership="none">
33633 <doc xml:whitespace="preserve">a key, within @settings</doc>
33634 <type name="utf8" c:type="gchar*"/>
33636 <parameter name="value" transfer-ownership="none">
33637 <doc xml:whitespace="preserve">an enumerated value</doc>
33638 <type name="gint" c:type="gint"/>
33642 <method name="set_flags" c:identifier="g_settings_set_flags">
33643 <doc xml:whitespace="preserve">Looks up the flags type nicks for the bits specified by @value, puts
33644 them in an array of strings and writes the array to @key, withing
33645 It is a programmer error to give a @key that isn't contained in the
33646 schema for @settings or is not marked as a flags type, or for @value
33647 to contain any bits that are not value for the named type.
33648 After performing the write, accessing @key directly with
33649 g_settings_get_strv() will return an array of 'nicks'; one for each
33650 bit in @value.</doc>
33651 <return-value transfer-ownership="none">
33652 <doc xml:whitespace="preserve">%TRUE, if the set succeeds</doc>
33653 <type name="gboolean" c:type="gboolean"/>
33656 <parameter name="key" transfer-ownership="none">
33657 <doc xml:whitespace="preserve">a key, within @settings</doc>
33658 <type name="utf8" c:type="gchar*"/>
33660 <parameter name="value" transfer-ownership="none">
33661 <doc xml:whitespace="preserve">a flags value</doc>
33662 <type name="guint" c:type="guint"/>
33666 <method name="set_int" c:identifier="g_settings_set_int" version="2.26">
33667 <doc xml:whitespace="preserve">Sets @key in @settings to @value.
33668 A convenience variant of g_settings_set() for 32-bit integers.
33669 It is a programmer error to give a @key that isn't specified as
33670 having a int32 type in the schema for @settings.</doc>
33671 <return-value transfer-ownership="none">
33672 <doc xml:whitespace="preserve">%TRUE if setting the key succeeded, %FALSE if the key was not writable</doc>
33673 <type name="gboolean" c:type="gboolean"/>
33676 <parameter name="key" transfer-ownership="none">
33677 <doc xml:whitespace="preserve">the name of the key to set</doc>
33678 <type name="utf8" c:type="gchar*"/>
33680 <parameter name="value" transfer-ownership="none">
33681 <doc xml:whitespace="preserve">the value to set it to</doc>
33682 <type name="gint" c:type="gint"/>
33686 <method name="set_string"
33687 c:identifier="g_settings_set_string"
33689 <doc xml:whitespace="preserve">Sets @key in @settings to @value.
33690 A convenience variant of g_settings_set() for strings.
33691 It is a programmer error to give a @key that isn't specified as
33692 having a string type in the schema for @settings.</doc>
33693 <return-value transfer-ownership="none">
33694 <doc xml:whitespace="preserve">%TRUE if setting the key succeeded, %FALSE if the key was not writable</doc>
33695 <type name="gboolean" c:type="gboolean"/>
33698 <parameter name="key" transfer-ownership="none">
33699 <doc xml:whitespace="preserve">the name of the key to set</doc>
33700 <type name="utf8" c:type="gchar*"/>
33702 <parameter name="value" transfer-ownership="none">
33703 <doc xml:whitespace="preserve">the value to set it to</doc>
33704 <type name="utf8" c:type="gchar*"/>
33708 <method name="set_strv"
33709 c:identifier="g_settings_set_strv"
33711 <doc xml:whitespace="preserve">Sets @key in @settings to @value.
33712 A convenience variant of g_settings_set() for string arrays. If
33713 It is a programmer error to give a @key that isn't specified as
33714 having an array of strings type in the schema for @settings.</doc>
33715 <return-value transfer-ownership="none">
33716 <doc xml:whitespace="preserve">%TRUE if setting the key succeeded, %FALSE if the key was not writable</doc>
33717 <type name="gboolean" c:type="gboolean"/>
33720 <parameter name="key" transfer-ownership="none">
33721 <doc xml:whitespace="preserve">the name of the key to set</doc>
33722 <type name="utf8" c:type="gchar*"/>
33724 <parameter name="value" transfer-ownership="none" allow-none="1">
33725 <doc xml:whitespace="preserve">the value to set it to, or %NULL</doc>
33726 <array c:type="gchar**">
33727 <type name="utf8"/>
33732 <method name="set_value"
33733 c:identifier="g_settings_set_value"
33735 <doc xml:whitespace="preserve">Sets @key in @settings to @value.
33736 It is a programmer error to give a @key that isn't contained in the
33737 schema for @settings or for @value to have the incorrect type, per
33739 If @value is floating then this function consumes the reference.</doc>
33740 <return-value transfer-ownership="none">
33741 <doc xml:whitespace="preserve">%TRUE if setting the key succeeded, %FALSE if the key was not writable</doc>
33742 <type name="gboolean" c:type="gboolean"/>
33745 <parameter name="key" transfer-ownership="none">
33746 <doc xml:whitespace="preserve">the name of the key to set</doc>
33747 <type name="utf8" c:type="gchar*"/>
33749 <parameter name="value" transfer-ownership="none">
33750 <doc xml:whitespace="preserve">a #GVariant of the correct type</doc>
33751 <type name="GLib.Variant" c:type="GVariant*"/>
33755 <property name="backend"
33758 transfer-ownership="none">
33759 <type name="SettingsBackend"/>
33761 <property name="has-unapplied" transfer-ownership="none">
33762 <doc xml:whitespace="preserve">If this property is %TRUE, the #GSettings object has outstanding
33763 changes that will be applied when g_settings_apply() is called.</doc>
33764 <type name="gboolean"/>
33766 <property name="path"
33769 transfer-ownership="none">
33770 <doc xml:whitespace="preserve">The path within the backend where the settings are stored.</doc>
33771 <type name="utf8"/>
33773 <property name="schema"
33776 transfer-ownership="none">
33777 <doc xml:whitespace="preserve">The name of the schema that describes the types of keys
33778 for this #GSettings object.</doc>
33779 <type name="utf8"/>
33781 <field name="parent_instance">
33782 <type name="GObject.Object" c:type="GObject"/>
33784 <field name="priv">
33785 <type name="SettingsPrivate" c:type="GSettingsPrivate*"/>
33787 <glib:signal name="change-event">
33788 <doc xml:whitespace="preserve">The "change-event" signal is emitted once per change event that
33789 affects this settings object. You should connect to this signal
33790 only if you are interested in viewing groups of changes before they
33791 are split out into multiple emissions of the "changed" signal.
33792 For most use cases it is more appropriate to use the "changed" signal.
33793 In the event that the change event applies to one or more specified
33794 keys, @keys will be an array of #GQuark of length @n_keys. In the
33795 event that the change event applies to the #GSettings object as a
33796 be %NULL and @n_keys will be 0.
33797 The default handler for this signal invokes the "changed" signal
33798 for each affected key. If any other connected handler returns
33799 %TRUE then this default functionality will be supressed.</doc>
33800 <return-value transfer-ownership="none">
33801 <doc xml:whitespace="preserve">%TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.</doc>
33802 <type name="gboolean"/>
33805 <parameter name="object" transfer-ownership="none">
33806 <doc xml:whitespace="preserve">an array of #GQuark<!-- -->s for the changed keys, or %NULL</doc>
33807 <type name="gpointer"/>
33809 <parameter name="p0" transfer-ownership="none">
33810 <doc xml:whitespace="preserve">the length of the @keys array, or 0</doc>
33811 <type name="gint"/>
33815 <glib:signal name="changed">
33816 <doc xml:whitespace="preserve">The "changed" signal is emitted when a key has potentially changed.
33817 You should call one of the g_settings_get() calls to check the new
33819 This signal supports detailed connections. You can connect to the
33820 detailed signal "changed::x" in order to only receive callbacks
33821 when key "x" changes.</doc>
33822 <return-value transfer-ownership="none">
33823 <type name="none"/>
33826 <parameter name="object" transfer-ownership="none">
33827 <doc xml:whitespace="preserve">the name of the key that changed</doc>
33828 <type name="utf8"/>
33832 <glib:signal name="writable-change-event">
33833 <doc xml:whitespace="preserve">The "writable-change-event" signal is emitted once per writability
33834 change event that affects this settings object. You should connect
33835 to this signal if you are interested in viewing groups of changes
33836 before they are split out into multiple emissions of the
33837 "writable-changed" signal. For most use cases it is more
33838 appropriate to use the "writable-changed" signal.
33839 In the event that the writability change applies only to a single
33840 key, @key will be set to the #GQuark for that key. In the event
33841 that the writability change affects the entire settings object,
33842 The default handler for this signal invokes the "writable-changed"
33843 and "changed" signals for each affected key. This is done because
33844 changes in writability might also imply changes in value (if for
33845 example, a new mandatory setting is introduced). If any other
33846 connected handler returns %TRUE then this default functionality
33847 will be supressed.</doc>
33848 <return-value transfer-ownership="none">
33849 <doc xml:whitespace="preserve">%TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.</doc>
33850 <type name="gboolean"/>
33853 <parameter name="object" transfer-ownership="none">
33854 <doc xml:whitespace="preserve">the quark of the key, or 0</doc>
33855 <type name="guint"/>
33859 <glib:signal name="writable-changed">
33860 <doc xml:whitespace="preserve">The "writable-changed" signal is emitted when the writability of a
33861 key has potentially changed. You should call
33862 g_settings_is_writable() in order to determine the new status.
33863 This signal supports detailed connections. You can connect to the
33864 detailed signal "writable-changed::x" in order to only receive
33865 callbacks when the writability of "x" changes.</doc>
33866 <return-value transfer-ownership="none">
33867 <type name="none"/>
33870 <parameter name="object" transfer-ownership="none">
33871 <doc xml:whitespace="preserve">the key</doc>
33872 <type name="utf8"/>
33877 <class name="SettingsBackend"
33878 c:symbol-prefix="settings_backend"
33879 c:type="GSettingsBackend"
33880 parent="GObject.Object"
33882 glib:type-name="GSettingsBackend"
33883 glib:get-type="g_settings_backend_get_type"
33884 glib:type-struct="SettingsBackendClass">
33885 <doc xml:whitespace="preserve">An implementation of a settings storage repository.</doc>
33886 <function name="flatten_tree"
33887 c:identifier="g_settings_backend_flatten_tree"
33889 <doc xml:whitespace="preserve">Calculate the longest common prefix of all keys in a tree and write
33890 out an array of the key names relative to that prefix and,
33891 optionally, the value to store at each of those keys.
33892 You must free the value returned in @path, @keys and @values using
33893 g_free(). You should not attempt to free or unref the contents of</doc>
33894 <return-value transfer-ownership="none">
33895 <type name="none" c:type="void"/>
33898 <parameter name="tree" transfer-ownership="none">
33899 <doc xml:whitespace="preserve">a #GTree containing the changes</doc>
33900 <type name="GLib.Tree" c:type="GTree*"/>
33902 <parameter name="path" transfer-ownership="none">
33903 <doc xml:whitespace="preserve">the location to save the path</doc>
33904 <type name="utf8" c:type="gchar**"/>
33906 <parameter name="keys" transfer-ownership="none">
33907 <doc xml:whitespace="preserve">the location to save the relative keys</doc>
33908 <type name="utf8" c:type="gchar***"/>
33910 <parameter name="values" transfer-ownership="none">
33911 <doc xml:whitespace="preserve">the location to save the values, or %NULL</doc>
33912 <type name="GLib.Variant" c:type="GVariant***"/>
33916 <virtual-method name="get_permission" introspectable="0">
33918 <type name="Permission" c:type="GPermission*"/>
33921 <parameter name="path" transfer-ownership="none">
33922 <type name="utf8" c:type="gchar*"/>
33926 <virtual-method name="get_writable">
33927 <return-value transfer-ownership="none">
33928 <type name="gboolean" c:type="gboolean"/>
33931 <parameter name="key" transfer-ownership="none">
33932 <type name="utf8" c:type="gchar*"/>
33936 <virtual-method name="read">
33937 <return-value transfer-ownership="full">
33938 <type name="GLib.Variant" c:type="GVariant*"/>
33941 <parameter name="key" transfer-ownership="none">
33942 <type name="utf8" c:type="gchar*"/>
33944 <parameter name="expected_type" transfer-ownership="none">
33945 <type name="GLib.VariantType" c:type="GVariantType*"/>
33947 <parameter name="default_value" transfer-ownership="none">
33948 <type name="gboolean" c:type="gboolean"/>
33952 <virtual-method name="reset">
33953 <return-value transfer-ownership="none">
33954 <type name="none" c:type="void"/>
33957 <parameter name="key" transfer-ownership="none">
33958 <type name="utf8" c:type="gchar*"/>
33960 <parameter name="origin_tag" transfer-ownership="none">
33961 <type name="gpointer" c:type="gpointer"/>
33965 <virtual-method name="subscribe">
33966 <return-value transfer-ownership="none">
33967 <type name="none" c:type="void"/>
33970 <parameter name="name" transfer-ownership="none">
33971 <type name="utf8" c:type="gchar*"/>
33975 <virtual-method name="sync">
33976 <return-value transfer-ownership="none">
33977 <type name="none" c:type="void"/>
33980 <virtual-method name="unsubscribe">
33981 <return-value transfer-ownership="none">
33982 <type name="none" c:type="void"/>
33985 <parameter name="name" transfer-ownership="none">
33986 <type name="utf8" c:type="gchar*"/>
33990 <virtual-method name="write">
33991 <return-value transfer-ownership="none">
33992 <type name="gboolean" c:type="gboolean"/>
33995 <parameter name="key" transfer-ownership="none">
33996 <type name="utf8" c:type="gchar*"/>
33998 <parameter name="value" transfer-ownership="none">
33999 <type name="GLib.Variant" c:type="GVariant*"/>
34001 <parameter name="origin_tag" transfer-ownership="none">
34002 <type name="gpointer" c:type="gpointer"/>
34006 <virtual-method name="write_tree">
34007 <return-value transfer-ownership="none">
34008 <type name="gboolean" c:type="gboolean"/>
34011 <parameter name="tree" transfer-ownership="none">
34012 <type name="GLib.Tree" c:type="GTree*"/>
34014 <parameter name="origin_tag" transfer-ownership="none">
34015 <type name="gpointer" c:type="gpointer"/>
34019 <method name="changed"
34020 c:identifier="g_settings_backend_changed"
34022 <doc xml:whitespace="preserve">Signals that a single key has possibly changed. Backend
34023 implementations should call this if a key has possibly changed its
34025 '//', and not ending with a slash).
34026 The implementation must call this function during any call to
34027 g_settings_backend_write(), before the call returns (except in the
34028 case that no keys are actually changed and it cares to detect this
34029 fact). It may not rely on the existence of a mainloop for
34030 dispatching the signal later.
34031 The implementation may call this function at any other time it likes
34032 in response to other events (such as changes occuring outside of the
34033 program). These calls may originate from a mainloop or may originate
34034 in response to any other action (including from calls to
34035 g_settings_backend_write()).
34036 In the case that this call is in response to a call to
34037 g_settings_backend_write() then @origin_tag must be set to the same
34038 value that was passed to that call.</doc>
34039 <return-value transfer-ownership="none">
34040 <type name="none" c:type="void"/>
34043 <parameter name="key" transfer-ownership="none">
34044 <doc xml:whitespace="preserve">the name of the key</doc>
34045 <type name="utf8" c:type="gchar*"/>
34047 <parameter name="origin_tag" transfer-ownership="none">
34048 <doc xml:whitespace="preserve">the origin tag</doc>
34049 <type name="gpointer" c:type="gpointer"/>
34053 <method name="changed_tree"
34054 c:identifier="g_settings_backend_changed_tree"
34056 <doc xml:whitespace="preserve">This call is a convenience wrapper. It gets the list of changes from
34057 g_settings_backend_changed().</doc>
34058 <return-value transfer-ownership="none">
34059 <type name="none" c:type="void"/>
34062 <parameter name="tree" transfer-ownership="none">
34063 <doc xml:whitespace="preserve">a #GTree containing the changes</doc>
34064 <type name="GLib.Tree" c:type="GTree*"/>
34066 <parameter name="origin_tag" transfer-ownership="none">
34067 <doc xml:whitespace="preserve">the origin tag</doc>
34068 <type name="gpointer" c:type="gpointer"/>
34072 <method name="keys_changed"
34073 c:identifier="g_settings_backend_keys_changed"
34075 <doc xml:whitespace="preserve">Signals that a list of keys have possibly changed. Backend
34076 implementations should call this if keys have possibly changed their
34078 not containing '//'). Each string in @items must form a valid key
34079 end with '/' and must not contain '//').
34080 The meaning of this signal is that any of the key names resulting
34081 from the contatenation of @path with each item in @items may have
34083 The same rules for when notifications must occur apply as per
34084 g_settings_backend_changed(). These two calls can be used
34085 interchangeably if exactly one item has changed (although in that
34086 case g_settings_backend_changed() is definitely preferred).
34087 For efficiency reasons, the implementation should strive for @path to
34088 keys that were changed) but this is not strictly required.</doc>
34089 <return-value transfer-ownership="none">
34090 <type name="none" c:type="void"/>
34093 <parameter name="path" transfer-ownership="none">
34094 <doc xml:whitespace="preserve">the path containing the changes</doc>
34095 <type name="utf8" c:type="gchar*"/>
34097 <parameter name="items" transfer-ownership="none">
34098 <doc xml:whitespace="preserve">the %NULL-terminated list of changed keys</doc>
34099 <type name="utf8" c:type="gchar**"/>
34101 <parameter name="origin_tag" transfer-ownership="none">
34102 <doc xml:whitespace="preserve">the origin tag</doc>
34103 <type name="gpointer" c:type="gpointer"/>
34107 <method name="path_changed"
34108 c:identifier="g_settings_backend_path_changed"
34110 <doc xml:whitespace="preserve">Signals that all keys below a given path may have possibly changed.
34111 Backend implementations should call this if an entire path of keys
34112 have possibly changed their values.
34113 not containing '//').
34114 The meaning of this signal is that any of the key which has a name
34115 starting with @path may have changed.
34116 The same rules for when notifications must occur apply as per
34117 g_settings_backend_changed(). This call might be an appropriate
34118 reasponse to a 'reset' call but implementations are also free to
34119 explicitly list the keys that were affected by that call if they can
34121 For efficiency reasons, the implementation should strive for @path to
34122 keys that were changed) but this is not strictly required. As an
34123 example, if this function is called with the path of "/" then every
34124 single key in the application will be notified of a possible change.</doc>
34125 <return-value transfer-ownership="none">
34126 <type name="none" c:type="void"/>
34129 <parameter name="path" transfer-ownership="none">
34130 <doc xml:whitespace="preserve">the path containing the changes</doc>
34131 <type name="utf8" c:type="gchar*"/>
34133 <parameter name="origin_tag" transfer-ownership="none">
34134 <doc xml:whitespace="preserve">the origin tag</doc>
34135 <type name="gpointer" c:type="gpointer"/>
34139 <method name="path_writable_changed"
34140 c:identifier="g_settings_backend_path_writable_changed"
34142 <doc xml:whitespace="preserve">Signals that the writability of all keys below a given path may have
34144 Since GSettings performs no locking operations for itself, this call
34145 will always be made in response to external events.</doc>
34146 <return-value transfer-ownership="none">
34147 <type name="none" c:type="void"/>
34150 <parameter name="path" transfer-ownership="none">
34151 <doc xml:whitespace="preserve">the name of the path</doc>
34152 <type name="utf8" c:type="gchar*"/>
34156 <method name="writable_changed"
34157 c:identifier="g_settings_backend_writable_changed"
34159 <doc xml:whitespace="preserve">Signals that the writability of a single key has possibly changed.
34160 Since GSettings performs no locking operations for itself, this call
34161 will always be made in response to external events.</doc>
34162 <return-value transfer-ownership="none">
34163 <type name="none" c:type="void"/>
34166 <parameter name="key" transfer-ownership="none">
34167 <doc xml:whitespace="preserve">the name of the key</doc>
34168 <type name="utf8" c:type="gchar*"/>
34172 <field name="parent_instance">
34173 <type name="GObject.Object" c:type="GObject"/>
34175 <field name="priv">
34176 <type name="SettingsBackendPrivate" c:type="GSettingsBackendPrivate*"/>
34179 <record name="SettingsBackendClass"
34180 c:type="GSettingsBackendClass"
34181 glib:is-gtype-struct-for="SettingsBackend">
34182 <field name="parent_class">
34183 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
34185 <field name="read">
34186 <callback name="read">
34187 <return-value transfer-ownership="full">
34188 <type name="GLib.Variant" c:type="GVariant*"/>
34191 <parameter name="backend" transfer-ownership="none">
34192 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34194 <parameter name="key" transfer-ownership="none">
34195 <type name="utf8" c:type="gchar*"/>
34197 <parameter name="expected_type" transfer-ownership="none">
34198 <type name="GLib.VariantType" c:type="GVariantType*"/>
34200 <parameter name="default_value" transfer-ownership="none">
34201 <type name="gboolean" c:type="gboolean"/>
34206 <field name="get_writable">
34207 <callback name="get_writable">
34208 <return-value transfer-ownership="none">
34209 <type name="gboolean" c:type="gboolean"/>
34212 <parameter name="backend" transfer-ownership="none">
34213 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34215 <parameter name="key" transfer-ownership="none">
34216 <type name="utf8" c:type="gchar*"/>
34221 <field name="write">
34222 <callback name="write">
34223 <return-value transfer-ownership="none">
34224 <type name="gboolean" c:type="gboolean"/>
34227 <parameter name="backend" transfer-ownership="none">
34228 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34230 <parameter name="key" transfer-ownership="none">
34231 <type name="utf8" c:type="gchar*"/>
34233 <parameter name="value" transfer-ownership="none">
34234 <type name="GLib.Variant" c:type="GVariant*"/>
34236 <parameter name="origin_tag" transfer-ownership="none">
34237 <type name="gpointer" c:type="gpointer"/>
34242 <field name="write_tree">
34243 <callback name="write_tree">
34244 <return-value transfer-ownership="none">
34245 <type name="gboolean" c:type="gboolean"/>
34248 <parameter name="backend" transfer-ownership="none">
34249 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34251 <parameter name="tree" transfer-ownership="none">
34252 <type name="GLib.Tree" c:type="GTree*"/>
34254 <parameter name="origin_tag" transfer-ownership="none">
34255 <type name="gpointer" c:type="gpointer"/>
34260 <field name="reset">
34261 <callback name="reset">
34262 <return-value transfer-ownership="none">
34263 <type name="none" c:type="void"/>
34266 <parameter name="backend" transfer-ownership="none">
34267 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34269 <parameter name="key" transfer-ownership="none">
34270 <type name="utf8" c:type="gchar*"/>
34272 <parameter name="origin_tag" transfer-ownership="none">
34273 <type name="gpointer" c:type="gpointer"/>
34278 <field name="subscribe">
34279 <callback name="subscribe">
34280 <return-value transfer-ownership="none">
34281 <type name="none" c:type="void"/>
34284 <parameter name="backend" transfer-ownership="none">
34285 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34287 <parameter name="name" transfer-ownership="none">
34288 <type name="utf8" c:type="gchar*"/>
34293 <field name="unsubscribe">
34294 <callback name="unsubscribe">
34295 <return-value transfer-ownership="none">
34296 <type name="none" c:type="void"/>
34299 <parameter name="backend" transfer-ownership="none">
34300 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34302 <parameter name="name" transfer-ownership="none">
34303 <type name="utf8" c:type="gchar*"/>
34308 <field name="sync">
34309 <callback name="sync">
34310 <return-value transfer-ownership="none">
34311 <type name="none" c:type="void"/>
34314 <parameter name="backend" transfer-ownership="none">
34315 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34320 <field name="get_permission" introspectable="0">
34321 <callback name="get_permission" introspectable="0">
34323 <type name="Permission" c:type="GPermission*"/>
34326 <parameter name="backend" transfer-ownership="none">
34327 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
34329 <parameter name="path" transfer-ownership="none">
34330 <type name="utf8" c:type="gchar*"/>
34335 <field name="padding">
34336 <array zero-terminated="0" c:type="gpointer" fixed-size="24">
34337 <type name="gpointer" c:type="gpointer"/>
34341 <record name="SettingsBackendPrivate"
34342 c:type="GSettingsBackendPrivate"
34345 <bitfield name="SettingsBindFlags"
34346 glib:type-name="GSettingsBindFlags"
34347 glib:get-type="g_settings_bind_flags_get_type"
34348 c:type="GSettingsBindFlags">
34349 <doc xml:whitespace="preserve">Flags used when creating a binding. These flags determine in which
34350 direction the binding works. The default is to synchronize in both
34352 <member name="default"
34354 c:identifier="G_SETTINGS_BIND_DEFAULT"
34355 glib:nick="default"/>
34358 c:identifier="G_SETTINGS_BIND_GET"
34362 c:identifier="G_SETTINGS_BIND_SET"
34364 <member name="no_sensitivity"
34366 c:identifier="G_SETTINGS_BIND_NO_SENSITIVITY"
34367 glib:nick="no-sensitivity"/>
34368 <member name="get_no_changes"
34370 c:identifier="G_SETTINGS_BIND_GET_NO_CHANGES"
34371 glib:nick="get-no-changes"/>
34372 <member name="invert_boolean"
34374 c:identifier="G_SETTINGS_BIND_INVERT_BOOLEAN"
34375 glib:nick="invert-boolean"/>
34377 <callback name="SettingsBindGetMapping" c:type="GSettingsBindGetMapping">
34378 <doc xml:whitespace="preserve">The type for the function that is used to convert from #GSettings to
34379 an object property. The @value is already initialized to hold values
34380 of the appropriate type.</doc>
34381 <return-value transfer-ownership="none">
34382 <doc xml:whitespace="preserve">%TRUE if the conversion succeeded, %FALSE in case of an error</doc>
34383 <type name="gboolean" c:type="gboolean"/>
34386 <parameter name="value" transfer-ownership="none">
34387 <doc xml:whitespace="preserve">return location for the property value</doc>
34388 <type name="GObject.Value" c:type="GValue*"/>
34390 <parameter name="variant" transfer-ownership="none">
34391 <doc xml:whitespace="preserve">the #GVariant</doc>
34392 <type name="GLib.Variant" c:type="GVariant*"/>
34394 <parameter name="user_data" transfer-ownership="none" closure="2">
34395 <doc xml:whitespace="preserve">user data that was specified when the binding was created</doc>
34396 <type name="gpointer" c:type="gpointer"/>
34400 <callback name="SettingsBindSetMapping" c:type="GSettingsBindSetMapping">
34401 <doc xml:whitespace="preserve">The type for the function that is used to convert an object property
34402 value to a #GVariant for storing it in #GSettings.</doc>
34403 <return-value transfer-ownership="full">
34404 <doc xml:whitespace="preserve">a new #GVariant holding the data from @value, or %NULL in case of an error</doc>
34405 <type name="GLib.Variant" c:type="GVariant*"/>
34408 <parameter name="value" transfer-ownership="none">
34409 <doc xml:whitespace="preserve">a #GValue containing the property value to map</doc>
34410 <type name="GObject.Value" c:type="GValue*"/>
34412 <parameter name="expected_type" transfer-ownership="none">
34413 <doc xml:whitespace="preserve">the #GVariantType to create</doc>
34414 <type name="GLib.VariantType" c:type="GVariantType*"/>
34416 <parameter name="user_data" transfer-ownership="none" closure="2">
34417 <doc xml:whitespace="preserve">user data that was specified when the binding was created</doc>
34418 <type name="gpointer" c:type="gpointer"/>
34422 <record name="SettingsClass"
34423 c:type="GSettingsClass"
34424 glib:is-gtype-struct-for="Settings">
34425 <field name="parent_class">
34426 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
34428 <field name="writable_changed">
34429 <callback name="writable_changed">
34430 <return-value transfer-ownership="none">
34431 <type name="none" c:type="void"/>
34434 <parameter name="settings" transfer-ownership="none">
34435 <type name="Settings" c:type="GSettings*"/>
34437 <parameter name="key" transfer-ownership="none">
34438 <type name="utf8" c:type="gchar*"/>
34443 <field name="changed">
34444 <callback name="changed">
34445 <return-value transfer-ownership="none">
34446 <type name="none" c:type="void"/>
34449 <parameter name="settings" transfer-ownership="none">
34450 <type name="Settings" c:type="GSettings*"/>
34452 <parameter name="key" transfer-ownership="none">
34453 <type name="utf8" c:type="gchar*"/>
34458 <field name="writable_change_event">
34459 <callback name="writable_change_event">
34460 <return-value transfer-ownership="none">
34461 <type name="gboolean" c:type="gboolean"/>
34464 <parameter name="settings" transfer-ownership="none">
34465 <type name="Settings" c:type="GSettings*"/>
34467 <parameter name="key" transfer-ownership="none">
34468 <type name="GLib.Quark" c:type="GQuark"/>
34473 <field name="change_event">
34474 <callback name="change_event">
34475 <return-value transfer-ownership="none">
34476 <type name="gboolean" c:type="gboolean"/>
34479 <parameter name="settings" transfer-ownership="none">
34480 <type name="Settings" c:type="GSettings*"/>
34482 <parameter name="keys" transfer-ownership="none">
34483 <type name="GLib.Quark" c:type="GQuark*"/>
34485 <parameter name="n_keys" transfer-ownership="none">
34486 <type name="gint" c:type="gint"/>
34491 <field name="padding">
34492 <array zero-terminated="0" c:type="gpointer" fixed-size="20">
34493 <type name="gpointer" c:type="gpointer"/>
34497 <callback name="SettingsGetMapping" c:type="GSettingsGetMapping">
34498 <doc xml:whitespace="preserve">The type of the function that is used to convert from a value stored
34499 in a #GSettings to a value that is useful to the application.
34500 If the value is successfully mapped, the result should be stored at
34501 is not in the right format) then %FALSE should be returned.
34502 If @value is %NULL then it means that the mapping function is being
34503 given a "last chance" to successfully return a valid value. %TRUE
34504 must be returned in this case.</doc>
34505 <return-value transfer-ownership="none">
34506 <doc xml:whitespace="preserve">%TRUE if the conversion succeeded, %FALSE in case of an error</doc>
34507 <type name="gboolean" c:type="gboolean"/>
34510 <parameter name="value" transfer-ownership="none">
34511 <doc xml:whitespace="preserve">the #GVariant to map, or %NULL</doc>
34512 <type name="GLib.Variant" c:type="GVariant*"/>
34514 <parameter name="result" transfer-ownership="none">
34515 <doc xml:whitespace="preserve">the result of the mapping</doc>
34516 <type name="gpointer" c:type="gpointer*"/>
34518 <parameter name="user_data" transfer-ownership="none" closure="2">
34519 <doc xml:whitespace="preserve">the user data that was passed to g_settings_get_mapped()</doc>
34520 <type name="gpointer" c:type="gpointer"/>
34524 <record name="SettingsPrivate" c:type="GSettingsPrivate" disguised="1">
34526 <class name="SimpleAction"
34527 c:symbol-prefix="simple_action"
34528 c:type="GSimpleAction"
34530 parent="GObject.Object"
34531 glib:type-name="GSimpleAction"
34532 glib:get-type="g_simple_action_get_type"
34533 glib:type-struct="SimpleActionClass">
34534 <doc xml:whitespace="preserve">The <structname>GSimpleAction</structname> structure contains private
34535 data and should only be accessed using the provided API</doc>
34536 <implements name="Action"/>
34537 <constructor name="new"
34538 c:identifier="g_simple_action_new"
34540 <doc xml:whitespace="preserve">Creates a new action.
34541 The created action is stateless. See g_simple_action_new_stateful().</doc>
34542 <return-value transfer-ownership="full">
34543 <doc xml:whitespace="preserve">a new #GSimpleAction</doc>
34544 <type name="SimpleAction" c:type="GSimpleAction*"/>
34547 <parameter name="name" transfer-ownership="none">
34548 <doc xml:whitespace="preserve">the name of the action</doc>
34549 <type name="utf8" c:type="gchar*"/>
34551 <parameter name="parameter_type"
34552 transfer-ownership="none"
34554 <doc xml:whitespace="preserve">the type of parameter to the activate function</doc>
34555 <type name="GLib.VariantType" c:type="GVariantType*"/>
34559 <constructor name="new_stateful"
34560 c:identifier="g_simple_action_new_stateful"
34562 <doc xml:whitespace="preserve">Creates a new stateful action.
34563 must have the same #GVariantType as the initial state.
34564 If the @state GVariant is floating, it is consumed.</doc>
34565 <return-value transfer-ownership="full">
34566 <doc xml:whitespace="preserve">a new #GSimpleAction</doc>
34567 <type name="SimpleAction" c:type="GSimpleAction*"/>
34570 <parameter name="name" transfer-ownership="none">
34571 <doc xml:whitespace="preserve">the name of the action</doc>
34572 <type name="utf8" c:type="gchar*"/>
34574 <parameter name="parameter_type"
34575 transfer-ownership="none"
34577 <doc xml:whitespace="preserve">the type of the parameter to the activate function</doc>
34578 <type name="GLib.VariantType" c:type="GVariantType*"/>
34580 <parameter name="state" transfer-ownership="none">
34581 <doc xml:whitespace="preserve">the initial state of the action</doc>
34582 <type name="GLib.Variant" c:type="GVariant*"/>
34586 <method name="set_enabled"
34587 c:identifier="g_simple_action_set_enabled"
34589 <doc xml:whitespace="preserve">Sets the action as enabled or not.
34590 An action must be enabled in order to be activated or in order to
34591 have its state changed from outside callers.</doc>
34592 <return-value transfer-ownership="none">
34593 <type name="none" c:type="void"/>
34596 <parameter name="enabled" transfer-ownership="none">
34597 <doc xml:whitespace="preserve">whether the action is enabled</doc>
34598 <type name="gboolean" c:type="gboolean"/>
34602 <property name="enabled"
34606 transfer-ownership="none">
34607 <doc xml:whitespace="preserve">If @action is currently enabled.
34608 If the action is disabled then calls to g_simple_action_activate() and
34609 g_simple_action_set_state() have no effect.</doc>
34610 <type name="gboolean"/>
34612 <property name="name"
34616 transfer-ownership="none">
34617 <doc xml:whitespace="preserve">The name of the action. This is mostly meaningful for identifying
34618 the action once it has been added to a #GSimpleActionGroup.</doc>
34619 <type name="utf8"/>
34621 <property name="parameter-type"
34626 transfer-ownership="none">
34627 <doc xml:whitespace="preserve">The type of the parameter that must be given when activating the
34631 <property name="state"
34635 transfer-ownership="none">
34636 <doc xml:whitespace="preserve">The state of the action, or %NULL if the action is stateless.</doc>
34637 <type name="GLib.Variant"/>
34639 <property name="state-type"
34642 transfer-ownership="none">
34643 <doc xml:whitespace="preserve">The #GVariantType of the state that the action has, or %NULL if the
34644 action is stateless.</doc>
34647 <field name="parent_instance">
34648 <type name="GObject.Object" c:type="GObject"/>
34650 <field name="priv">
34651 <type name="SimpleActionPrivate" c:type="GSimpleActionPrivate*"/>
34653 <glib:signal name="activate" version="2.26">
34654 <doc xml:whitespace="preserve">Indicates that the action was just activated.
34655 an incorrect type was given, no signal will be emitted.</doc>
34656 <return-value transfer-ownership="none">
34657 <type name="none"/>
34660 <parameter name="object" transfer-ownership="none" allow-none="1">
34661 <doc xml:whitespace="preserve">the parameter to the activation</doc>
34662 <type name="GLib.Variant"/>
34667 <record name="SimpleActionClass"
34668 c:type="GSimpleActionClass"
34669 glib:is-gtype-struct-for="SimpleAction"
34671 <field name="parent_class">
34672 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
34674 <field name="activate">
34675 <callback name="activate">
34676 <return-value transfer-ownership="none">
34677 <type name="none" c:type="void"/>
34680 <parameter name="simple" transfer-ownership="none">
34681 <type name="SimpleAction" c:type="GSimpleAction*"/>
34683 <parameter name="parameter" transfer-ownership="none">
34684 <type name="GLib.Variant" c:type="GVariant*"/>
34689 <field name="padding">
34690 <array zero-terminated="0" c:type="gpointer" fixed-size="6">
34691 <type name="gpointer" c:type="gpointer"/>
34695 <class name="SimpleActionGroup"
34696 c:symbol-prefix="simple_action_group"
34697 c:type="GSimpleActionGroup"
34699 parent="GObject.Object"
34700 glib:type-name="GSimpleActionGroup"
34701 glib:get-type="g_simple_action_group_get_type"
34702 glib:type-struct="SimpleActionGroupClass">
34703 <doc xml:whitespace="preserve">The #GSimpleActionGroup structure contains private data and should only be accessed using the provided API.</doc>
34704 <implements name="ActionGroup"/>
34705 <constructor name="new"
34706 c:identifier="g_simple_action_group_new"
34708 <doc xml:whitespace="preserve">Creates a new, empty, #GSimpleActionGroup.</doc>
34709 <return-value transfer-ownership="full">
34710 <doc xml:whitespace="preserve">a new #GSimpleActionGroup</doc>
34711 <type name="SimpleActionGroup" c:type="GSimpleActionGroup*"/>
34714 <method name="insert"
34715 c:identifier="g_simple_action_group_insert"
34717 <doc xml:whitespace="preserve">Adds an action to the action group.
34718 If the action group already contains an action with the same name as
34719 The action group takes its own reference on @action.</doc>
34720 <return-value transfer-ownership="none">
34721 <type name="none" c:type="void"/>
34724 <parameter name="action" transfer-ownership="none">
34725 <doc xml:whitespace="preserve">a #GAction</doc>
34726 <type name="Action" c:type="GAction*"/>
34730 <method name="lookup"
34731 c:identifier="g_simple_action_group_lookup"
34733 <doc xml:whitespace="preserve">Looks up the action with the name @action_name in the group.
34734 If no such action exists, returns %NULL.</doc>
34735 <return-value transfer-ownership="none">
34736 <doc xml:whitespace="preserve">a #GAction, or %NULL</doc>
34737 <type name="Action" c:type="GAction*"/>
34740 <parameter name="action_name" transfer-ownership="none">
34741 <doc xml:whitespace="preserve">the name of an action</doc>
34742 <type name="utf8" c:type="gchar*"/>
34746 <method name="remove"
34747 c:identifier="g_simple_action_group_remove"
34749 <doc xml:whitespace="preserve">Removes the named action from the action group.
34750 If no action of this name is in the group then nothing happens.</doc>
34751 <return-value transfer-ownership="none">
34752 <type name="none" c:type="void"/>
34755 <parameter name="action_name" transfer-ownership="none">
34756 <doc xml:whitespace="preserve">the name of the action</doc>
34757 <type name="utf8" c:type="gchar*"/>
34761 <field name="parent_instance">
34762 <type name="GObject.Object" c:type="GObject"/>
34764 <field name="priv">
34765 <type name="SimpleActionGroupPrivate"
34766 c:type="GSimpleActionGroupPrivate*"/>
34769 <record name="SimpleActionGroupClass"
34770 c:type="GSimpleActionGroupClass"
34771 glib:is-gtype-struct-for="SimpleActionGroup">
34772 <field name="parent_class">
34773 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
34775 <field name="padding">
34776 <array zero-terminated="0" c:type="gpointer" fixed-size="12">
34777 <type name="gpointer" c:type="gpointer"/>
34781 <record name="SimpleActionGroupPrivate"
34782 c:type="GSimpleActionGroupPrivate"
34785 <record name="SimpleActionPrivate"
34786 c:type="GSimpleActionPrivate"
34789 <class name="SimpleAsyncResult"
34790 c:symbol-prefix="simple_async_result"
34791 c:type="GSimpleAsyncResult"
34792 parent="GObject.Object"
34793 glib:type-name="GSimpleAsyncResult"
34794 glib:get-type="g_simple_async_result_get_type"
34795 glib:type-struct="SimpleAsyncResultClass">
34796 <doc xml:whitespace="preserve">A simple implementation of #GAsyncResult.</doc>
34797 <implements name="AsyncResult"/>
34798 <constructor name="new" c:identifier="g_simple_async_result_new">
34799 <doc xml:whitespace="preserve">Creates a #GSimpleAsyncResult.</doc>
34800 <return-value transfer-ownership="full">
34801 <doc xml:whitespace="preserve">a #GSimpleAsyncResult.</doc>
34802 <type name="SimpleAsyncResult" c:type="GSimpleAsyncResult*"/>
34805 <parameter name="source_object" transfer-ownership="none">
34806 <doc xml:whitespace="preserve">a #GObject the asynchronous function was called with, or %NULL.</doc>
34807 <type name="GObject.Object" c:type="GObject*"/>
34809 <parameter name="callback"
34810 transfer-ownership="none"
34813 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
34814 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
34816 <parameter name="user_data" transfer-ownership="none">
34817 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
34818 <type name="gpointer" c:type="gpointer"/>
34820 <parameter name="source_tag" transfer-ownership="none">
34821 <doc xml:whitespace="preserve">the asynchronous function.</doc>
34822 <type name="gpointer" c:type="gpointer"/>
34826 <constructor name="new_error"
34827 c:identifier="g_simple_async_result_new_error"
34828 introspectable="0">
34829 <doc xml:whitespace="preserve">Creates a new #GSimpleAsyncResult with a set error.</doc>
34830 <return-value transfer-ownership="full">
34831 <doc xml:whitespace="preserve">a #GSimpleAsyncResult.</doc>
34832 <type name="SimpleAsyncResult" c:type="GSimpleAsyncResult*"/>
34835 <parameter name="source_object" transfer-ownership="none">
34836 <doc xml:whitespace="preserve">a #GObject, or %NULL.</doc>
34837 <type name="GObject.Object" c:type="GObject*"/>
34839 <parameter name="callback"
34840 transfer-ownership="none"
34843 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
34844 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
34846 <parameter name="user_data" transfer-ownership="none">
34847 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
34848 <type name="gpointer" c:type="gpointer"/>
34850 <parameter name="domain" transfer-ownership="none">
34851 <doc xml:whitespace="preserve">a #GQuark.</doc>
34852 <type name="GLib.Quark" c:type="GQuark"/>
34854 <parameter name="code" transfer-ownership="none">
34855 <doc xml:whitespace="preserve">an error code.</doc>
34856 <type name="gint" c:type="gint"/>
34858 <parameter name="format" transfer-ownership="none">
34859 <doc xml:whitespace="preserve">a string with format characters.</doc>
34860 <type name="utf8" c:type="char*"/>
34862 <parameter transfer-ownership="none">
34868 <constructor name="new_from_error"
34869 c:identifier="g_simple_async_result_new_from_error">
34870 <doc xml:whitespace="preserve">Creates a #GSimpleAsyncResult from an error condition.</doc>
34871 <return-value transfer-ownership="full">
34872 <doc xml:whitespace="preserve">a #GSimpleAsyncResult.</doc>
34873 <type name="SimpleAsyncResult" c:type="GSimpleAsyncResult*"/>
34876 <parameter name="source_object" transfer-ownership="none">
34877 <doc xml:whitespace="preserve">a #GObject, or %NULL.</doc>
34878 <type name="GObject.Object" c:type="GObject*"/>
34880 <parameter name="callback"
34881 transfer-ownership="none"
34884 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
34885 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
34887 <parameter name="user_data" transfer-ownership="none">
34888 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
34889 <type name="gpointer" c:type="gpointer"/>
34891 <parameter name="error" transfer-ownership="none">
34892 <doc xml:whitespace="preserve">a #GError location.</doc>
34893 <type name="GLib.Error" c:type="GError*"/>
34897 <function name="is_valid" c:identifier="g_simple_async_result_is_valid">
34898 <doc xml:whitespace="preserve">Ensures that the data passed to the _finish function of an async
34899 operation is consistent. Three checks are performed.
34900 First, @result is checked to ensure that it is really a
34901 #GSimpleAsyncResult. Second, @source is checked to ensure that it
34902 matches the source object of @result. Third, @source_tag is
34903 checked to ensure that it is either %NULL (as it is when the result was
34904 created by g_simple_async_report_error_in_idle() or
34905 g_simple_async_report_gerror_in_idle()) or equal to the
34906 convention, is a pointer to the _async function corresponding to the
34907 _finish function from which this function is called).</doc>
34908 <return-value transfer-ownership="none">
34909 <doc xml:whitespace="preserve">#TRUE if all checks passed or #FALSE if any failed.</doc>
34910 <type name="gboolean" c:type="gboolean"/>
34913 <parameter name="result" transfer-ownership="none">
34914 <doc xml:whitespace="preserve">the #GAsyncResult passed to the _finish function.</doc>
34915 <type name="AsyncResult" c:type="GAsyncResult*"/>
34917 <parameter name="source" transfer-ownership="none">
34918 <doc xml:whitespace="preserve">the #GObject passed to the _finish function.</doc>
34919 <type name="GObject.Object" c:type="GObject*"/>
34921 <parameter name="source_tag" transfer-ownership="none">
34922 <doc xml:whitespace="preserve">the asynchronous function.</doc>
34923 <type name="gpointer" c:type="gpointer"/>
34927 <method name="complete" c:identifier="g_simple_async_result_complete">
34928 <doc xml:whitespace="preserve">Completes an asynchronous I/O job immediately. Must be called in
34929 the thread where the asynchronous result was to be delivered, as it
34930 invokes the callback directly. If you are in a different thread use
34931 g_simple_async_result_complete_in_idle().
34932 Calling this function takes a reference to @simple for as long as
34933 is needed to complete the call.</doc>
34934 <return-value transfer-ownership="none">
34935 <type name="none" c:type="void"/>
34938 <method name="complete_in_idle"
34939 c:identifier="g_simple_async_result_complete_in_idle">
34940 <doc xml:whitespace="preserve">Completes an asynchronous function in an idle handler in the <link
34941 linkend="g-main-context-push-thread-default">thread-default main
34942 loop</link> of the thread that @simple was initially created in.
34943 Calling this function takes a reference to @simple for as long as
34944 is needed to complete the call.</doc>
34945 <return-value transfer-ownership="none">
34946 <type name="none" c:type="void"/>
34949 <method name="get_op_res_gboolean"
34950 c:identifier="g_simple_async_result_get_op_res_gboolean">
34951 <doc xml:whitespace="preserve">Gets the operation result boolean from within the asynchronous result.
34952 if the operation's result was %FALSE.</doc>
34953 <return-value transfer-ownership="none">
34954 <doc xml:whitespace="preserve">%TRUE if the operation's result was %TRUE, %FALSE</doc>
34955 <type name="gboolean" c:type="gboolean"/>
34958 <method name="get_op_res_gpointer"
34959 c:identifier="g_simple_async_result_get_op_res_gpointer"
34960 introspectable="0">
34961 <doc xml:whitespace="preserve">Gets a pointer result as returned by the asynchronous function.</doc>
34963 <doc xml:whitespace="preserve">a pointer from the result.</doc>
34964 <type name="gpointer" c:type="gpointer"/>
34967 <method name="get_op_res_gssize"
34968 c:identifier="g_simple_async_result_get_op_res_gssize">
34969 <doc xml:whitespace="preserve">Gets a gssize from the asynchronous result.</doc>
34970 <return-value transfer-ownership="none">
34971 <doc xml:whitespace="preserve">a gssize returned from the asynchronous function.</doc>
34972 <type name="glong" c:type="gssize"/>
34975 <method name="get_source_tag"
34976 c:identifier="g_simple_async_result_get_source_tag"
34977 introspectable="0">
34978 <doc xml:whitespace="preserve">Gets the source tag for the #GSimpleAsyncResult.</doc>
34980 <doc xml:whitespace="preserve">a #gpointer to the source object for the #GSimpleAsyncResult.</doc>
34981 <type name="gpointer" c:type="gpointer"/>
34984 <method name="propagate_error"
34985 c:identifier="g_simple_async_result_propagate_error"
34987 <doc xml:whitespace="preserve">Propagates an error from within the simple asynchronous result to
34988 a given destination.</doc>
34989 <return-value transfer-ownership="none">
34990 <doc xml:whitespace="preserve">%TRUE if the error was propagated to @dest. %FALSE otherwise.</doc>
34991 <type name="gboolean" c:type="gboolean"/>
34994 <method name="run_in_thread"
34995 c:identifier="g_simple_async_result_run_in_thread"
34996 introspectable="0">
34997 <doc xml:whitespace="preserve">Runs the asynchronous job in a separate thread and then calls
34998 g_simple_async_result_complete_in_idle() on @simple to return
34999 the result to the appropriate main loop.
35000 Calling this function takes a reference to @simple for as long as
35001 is needed to run the job and report its completion.</doc>
35002 <return-value transfer-ownership="none">
35003 <type name="none" c:type="void"/>
35006 <parameter name="func" transfer-ownership="none">
35007 <doc xml:whitespace="preserve">a #GSimpleAsyncThreadFunc.</doc>
35008 <type name="SimpleAsyncThreadFunc"
35009 c:type="GSimpleAsyncThreadFunc"/>
35011 <parameter name="io_priority" transfer-ownership="none">
35012 <doc xml:whitespace="preserve">the io priority of the request.</doc>
35013 <type name="gint" c:type="int"/>
35015 <parameter name="cancellable"
35016 transfer-ownership="none"
35018 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
35019 <type name="Cancellable" c:type="GCancellable*"/>
35023 <method name="set_error"
35024 c:identifier="g_simple_async_result_set_error"
35025 introspectable="0">
35026 <doc xml:whitespace="preserve">Sets an error within the asynchronous result without a #GError.</doc>
35027 <return-value transfer-ownership="none">
35028 <type name="none" c:type="void"/>
35031 <parameter name="domain" transfer-ownership="none">
35032 <doc xml:whitespace="preserve">a #GQuark (usually #G_IO_ERROR).</doc>
35033 <type name="GLib.Quark" c:type="GQuark"/>
35035 <parameter name="code" transfer-ownership="none">
35036 <doc xml:whitespace="preserve">an error code.</doc>
35037 <type name="gint" c:type="gint"/>
35039 <parameter name="format" transfer-ownership="none">
35040 <doc xml:whitespace="preserve">a formatted error reporting string.</doc>
35041 <type name="utf8" c:type="char*"/>
35043 <parameter transfer-ownership="none">
35049 <method name="set_error_va"
35050 c:identifier="g_simple_async_result_set_error_va"
35051 introspectable="0">
35052 <doc xml:whitespace="preserve">Sets an error within the asynchronous result without a #GError.
35053 Unless writing a binding, see g_simple_async_result_set_error().</doc>
35054 <return-value transfer-ownership="none">
35055 <type name="none" c:type="void"/>
35058 <parameter name="domain" transfer-ownership="none">
35059 <doc xml:whitespace="preserve">a #GQuark (usually #G_IO_ERROR).</doc>
35060 <type name="GLib.Quark" c:type="GQuark"/>
35062 <parameter name="code" transfer-ownership="none">
35063 <doc xml:whitespace="preserve">an error code.</doc>
35064 <type name="gint" c:type="gint"/>
35066 <parameter name="format" transfer-ownership="none">
35067 <doc xml:whitespace="preserve">a formatted error reporting string.</doc>
35068 <type name="utf8" c:type="char*"/>
35070 <parameter name="args" transfer-ownership="none">
35071 <doc xml:whitespace="preserve">va_list of arguments.</doc>
35072 <type name="va_list" c:type="va_list"/>
35076 <method name="set_from_error"
35077 c:identifier="g_simple_async_result_set_from_error">
35078 <doc xml:whitespace="preserve">Sets the result from a #GError.</doc>
35079 <return-value transfer-ownership="none">
35080 <type name="none" c:type="void"/>
35083 <parameter name="error" transfer-ownership="none">
35084 <doc xml:whitespace="preserve">#GError.</doc>
35085 <type name="GLib.Error" c:type="GError*"/>
35089 <method name="set_handle_cancellation"
35090 c:identifier="g_simple_async_result_set_handle_cancellation">
35091 <doc xml:whitespace="preserve">Sets whether to handle cancellation within the asynchronous operation.</doc>
35092 <return-value transfer-ownership="none">
35093 <type name="none" c:type="void"/>
35096 <parameter name="handle_cancellation" transfer-ownership="none">
35097 <doc xml:whitespace="preserve">a #gboolean.</doc>
35098 <type name="gboolean" c:type="gboolean"/>
35102 <method name="set_op_res_gboolean"
35103 c:identifier="g_simple_async_result_set_op_res_gboolean">
35104 <doc xml:whitespace="preserve">Sets the operation result to a boolean within the asynchronous result.</doc>
35105 <return-value transfer-ownership="none">
35106 <type name="none" c:type="void"/>
35109 <parameter name="op_res" transfer-ownership="none">
35110 <doc xml:whitespace="preserve">a #gboolean.</doc>
35111 <type name="gboolean" c:type="gboolean"/>
35115 <method name="set_op_res_gpointer"
35116 c:identifier="g_simple_async_result_set_op_res_gpointer">
35117 <doc xml:whitespace="preserve">Sets the operation result within the asynchronous result to a pointer.</doc>
35118 <return-value transfer-ownership="none">
35119 <type name="none" c:type="void"/>
35122 <parameter name="op_res" transfer-ownership="none">
35123 <doc xml:whitespace="preserve">a pointer result from an asynchronous function.</doc>
35124 <type name="gpointer" c:type="gpointer"/>
35126 <parameter name="destroy_op_res"
35127 transfer-ownership="none"
35129 <doc xml:whitespace="preserve">a #GDestroyNotify function.</doc>
35130 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
35134 <method name="set_op_res_gssize"
35135 c:identifier="g_simple_async_result_set_op_res_gssize">
35136 <doc xml:whitespace="preserve">Sets the operation result within the asynchronous result to
35137 the given @op_res.</doc>
35138 <return-value transfer-ownership="none">
35139 <type name="none" c:type="void"/>
35142 <parameter name="op_res" transfer-ownership="none">
35143 <doc xml:whitespace="preserve">a #gssize.</doc>
35144 <type name="glong" c:type="gssize"/>
35149 <record name="SimpleAsyncResultClass"
35150 c:type="GSimpleAsyncResultClass"
35152 glib:is-gtype-struct-for="SimpleAsyncResult">
35154 <callback name="SimpleAsyncThreadFunc" c:type="GSimpleAsyncThreadFunc">
35155 <doc xml:whitespace="preserve">Simple thread function that runs an asynchronous operation and
35156 checks for cancellation.</doc>
35157 <return-value transfer-ownership="none">
35158 <type name="none" c:type="void"/>
35161 <parameter name="res" transfer-ownership="none">
35162 <doc xml:whitespace="preserve">a #GSimpleAsyncResult.</doc>
35163 <type name="SimpleAsyncResult" c:type="GSimpleAsyncResult*"/>
35165 <parameter name="object" transfer-ownership="none">
35166 <doc xml:whitespace="preserve">a #GObject.</doc>
35167 <type name="GObject.Object" c:type="GObject*"/>
35169 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
35170 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
35171 <type name="Cancellable" c:type="GCancellable*"/>
35175 <class name="SimplePermission"
35176 c:symbol-prefix="simple_permission"
35177 c:type="GSimplePermission"
35178 parent="Permission"
35179 glib:type-name="GSimplePermission"
35180 glib:get-type="g_simple_permission_get_type">
35181 <doc xml:whitespace="preserve">#GSimplePermission is an opaque data structure. There are no methods
35182 except for those defined by #GPermission.</doc>
35183 <constructor name="new"
35184 c:identifier="g_simple_permission_new"
35186 <doc xml:whitespace="preserve">Creates a new #GPermission instance that represents an action that is
35187 either always or never allowed.</doc>
35188 <return-value transfer-ownership="full">
35189 <doc xml:whitespace="preserve">the #GSimplePermission, as a #GPermission</doc>
35190 <type name="Permission" c:type="GPermission*"/>
35193 <parameter name="allowed" transfer-ownership="none">
35194 <doc xml:whitespace="preserve">%TRUE if the action is allowed</doc>
35195 <type name="gboolean" c:type="gboolean"/>
35200 <class name="Socket"
35201 c:symbol-prefix="socket"
35204 parent="GObject.Object"
35205 glib:type-name="GSocket"
35206 glib:get-type="g_socket_get_type"
35207 glib:type-struct="SocketClass">
35208 <doc xml:whitespace="preserve">A lowlevel network socket object.</doc>
35209 <implements name="Initable"/>
35210 <constructor name="new"
35211 c:identifier="g_socket_new"
35214 <doc xml:whitespace="preserve">Creates a new #GSocket with the defined family, type and protocol.
35215 If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type
35216 for the family and type is used.
35217 The @protocol is a family and type specific int that specifies what
35218 kind of protocol to use. #GSocketProtocol lists several common ones.
35219 Many families only support one protocol, and use 0 for this, others
35220 support several and using 0 means to use the default protocol for
35221 the family and type.
35222 The protocol id is passed directly to the operating
35223 system, so you can use protocols not listed in #GSocketProtocol if you
35224 know the protocol number used for it.
35225 Free the returned object with g_object_unref().</doc>
35226 <return-value transfer-ownership="full">
35227 <doc xml:whitespace="preserve">a #GSocket or %NULL on error.</doc>
35228 <type name="Socket" c:type="GSocket*"/>
35231 <parameter name="family" transfer-ownership="none">
35232 <doc xml:whitespace="preserve">the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.</doc>
35233 <type name="SocketFamily" c:type="GSocketFamily"/>
35235 <parameter name="type" transfer-ownership="none">
35236 <doc xml:whitespace="preserve">the socket type to use.</doc>
35237 <type name="SocketType" c:type="GSocketType"/>
35239 <parameter name="protocol" transfer-ownership="none">
35240 <doc xml:whitespace="preserve">the id of the protocol to use, or 0 for default.</doc>
35241 <type name="SocketProtocol" c:type="GSocketProtocol"/>
35245 <constructor name="new_from_fd"
35246 c:identifier="g_socket_new_from_fd"
35249 <doc xml:whitespace="preserve">Creates a new #GSocket from a native file descriptor
35250 or winsock SOCKET handle.
35251 This reads all the settings from the file descriptor so that
35252 all properties should work. Note that the file descriptor
35253 will be set to non-blocking mode, independent on the blocking
35254 mode of the #GSocket.
35255 Free the returned object with g_object_unref().</doc>
35256 <return-value transfer-ownership="full">
35257 <doc xml:whitespace="preserve">a #GSocket or %NULL on error.</doc>
35258 <type name="Socket" c:type="GSocket*"/>
35261 <parameter name="fd" transfer-ownership="none">
35262 <doc xml:whitespace="preserve">a native socket file descriptor.</doc>
35263 <type name="gint" c:type="gint"/>
35267 <method name="accept"
35268 c:identifier="g_socket_accept"
35271 <doc xml:whitespace="preserve">Accept incoming connections on a connection-based socket. This removes
35272 the first outstanding connection request from the listening socket and
35273 creates a #GSocket object for it.
35274 The @socket must be bound to a local address with g_socket_bind() and
35275 must be listening for incoming connections (g_socket_listen()).
35276 If there are no outstanding connections then the operation will block
35277 or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled.
35278 To be notified of an incoming connection, wait for the %G_IO_IN condition.
35279 Free the returned object with g_object_unref().</doc>
35280 <return-value transfer-ownership="full">
35281 <doc xml:whitespace="preserve">a new #GSocket, or %NULL on error.</doc>
35282 <type name="Socket" c:type="GSocket*"/>
35285 <parameter name="cancellable"
35286 transfer-ownership="none"
35288 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35289 <type name="Cancellable" c:type="GCancellable*"/>
35293 <method name="bind"
35294 c:identifier="g_socket_bind"
35297 <doc xml:whitespace="preserve">When a socket is created it is attached to an address family, but it
35298 doesn't have an address in this family. g_socket_bind() assigns the
35299 address (sometimes called name) of the socket.
35300 It is generally required to bind to a local address before you can
35301 receive connections. (See g_socket_listen() and g_socket_accept() ).
35302 In certain situations, you may also want to bind a socket that will be
35303 used to initiate connections, though this is not normally required.
35304 eventually call g_socket_accept() on), and %FALSE for client sockets.
35305 (Specifically, if it is %TRUE, then g_socket_bind() will set the
35306 %SO_REUSEADDR flag on the socket, allowing it to bind @address even if
35307 that address was previously used by another socket that has not yet been
35308 fully cleaned-up by the kernel. Failing to set this flag on a server
35309 socket may cause the bind call to return %G_IO_ERROR_ADDRESS_IN_USE if
35310 the server program is stopped and then immediately restarted.)</doc>
35311 <return-value transfer-ownership="none">
35312 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
35313 <type name="gboolean" c:type="gboolean"/>
35316 <parameter name="address" transfer-ownership="none">
35317 <doc xml:whitespace="preserve">a #GSocketAddress specifying the local address.</doc>
35318 <type name="SocketAddress" c:type="GSocketAddress*"/>
35320 <parameter name="allow_reuse" transfer-ownership="none">
35321 <doc xml:whitespace="preserve">whether to allow reusing this address</doc>
35322 <type name="gboolean" c:type="gboolean"/>
35326 <method name="check_connect_result"
35327 c:identifier="g_socket_check_connect_result"
35330 <doc xml:whitespace="preserve">Checks and resets the pending connect error for the socket.
35331 This is used to check for errors when g_socket_connect() is
35332 used in non-blocking mode.</doc>
35333 <return-value transfer-ownership="none">
35334 <doc xml:whitespace="preserve">%TRUE if no error, %FALSE otherwise, setting @error to the error</doc>
35335 <type name="gboolean" c:type="gboolean"/>
35338 <method name="close"
35339 c:identifier="g_socket_close"
35342 <doc xml:whitespace="preserve">Closes the socket, shutting down any active connection.
35343 Closing a socket does not wait for all outstanding I/O operations
35344 to finish, so the caller should not rely on them to be guaranteed
35345 to complete even if the close returns with no error.
35346 Once the socket is closed, all other operations will return
35347 %G_IO_ERROR_CLOSED. Closing a socket multiple times will not
35349 Sockets will be automatically closed when the last reference
35350 is dropped, but you might want to call this function to make sure
35351 resources are released as early as possible.
35352 Beware that due to the way that TCP works, it is possible for
35353 recently-sent data to be lost if either you close a socket while the
35354 %G_IO_IN condition is set, or else if the remote connection tries to
35355 send something to you after you close the socket but before it has
35356 finished reading all of the data you sent. There is no easy generic
35357 way to avoid this problem; the easiest fix is to design the network
35358 protocol such that the client will never send data "out of turn".
35359 Another solution is for the server to half-close the connection by
35360 calling g_socket_shutdown() with only the @shutdown_write flag set,
35361 and then wait for the client to notice this and close its side of the
35362 connection, after which the server can safely call g_socket_close().
35363 (This is what #GTcpConnection does if you call
35364 g_tcp_connection_set_graceful_disconnect(). But of course, this
35365 only works if the client will close its connection after the server
35367 <return-value transfer-ownership="none">
35368 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error</doc>
35369 <type name="gboolean" c:type="gboolean"/>
35372 <method name="condition_check"
35373 c:identifier="g_socket_condition_check"
35375 <doc xml:whitespace="preserve">Checks on the readiness of @socket to perform operations.
35376 The operations specified in @condition are checked for and masked
35377 against the currently-satisfied conditions on @socket. The result
35379 Note that on Windows, it is possible for an operation to return
35380 %G_IO_ERROR_WOULD_BLOCK even immediately after
35381 g_socket_condition_check() has claimed that the socket is ready for
35382 writing. Rather than calling g_socket_condition_check() and then
35383 writing to the socket if it succeeds, it is generally better to
35384 simply try writing to the socket right away, and try again later if
35385 the initial attempt returns %G_IO_ERROR_WOULD_BLOCK.
35386 It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition;
35387 these conditions will always be set in the output if they are true.
35388 This call never blocks.</doc>
35389 <return-value transfer-ownership="none">
35390 <doc xml:whitespace="preserve">the @GIOCondition mask of the current state</doc>
35391 <type name="GLib.IOCondition" c:type="GIOCondition"/>
35394 <parameter name="condition" transfer-ownership="none">
35395 <doc xml:whitespace="preserve">a #GIOCondition mask to check</doc>
35396 <type name="GLib.IOCondition" c:type="GIOCondition"/>
35400 <method name="condition_wait"
35401 c:identifier="g_socket_condition_wait"
35404 <doc xml:whitespace="preserve">Waits for @condition to become true on @socket. When the condition
35405 is met, %TRUE is returned.
35406 If @cancellable is cancelled before the condition is met, or if the
35407 socket has a timeout set and it is reached before the condition is
35408 met, then %FALSE is returned and @error, if non-%NULL, is set to
35409 the appropriate value (%G_IO_ERROR_CANCELLED or
35410 %G_IO_ERROR_TIMED_OUT).</doc>
35411 <return-value transfer-ownership="none">
35412 <doc xml:whitespace="preserve">%TRUE if the condition was met, %FALSE otherwise</doc>
35413 <type name="gboolean" c:type="gboolean"/>
35416 <parameter name="condition" transfer-ownership="none">
35417 <doc xml:whitespace="preserve">a #GIOCondition mask to wait for</doc>
35418 <type name="GLib.IOCondition" c:type="GIOCondition"/>
35420 <parameter name="cancellable"
35421 transfer-ownership="none"
35423 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
35424 <type name="Cancellable" c:type="GCancellable*"/>
35428 <method name="connect"
35429 c:identifier="g_socket_connect"
35432 <doc xml:whitespace="preserve">Connect the socket to the specified remote address.
35433 For connection oriented socket this generally means we attempt to make
35434 a connection to the @address. For a connection-less socket it sets
35435 the default address for g_socket_send() and discards all incoming datagrams
35436 from other sources.
35437 Generally connection oriented sockets can only connect once, but
35438 connection-less sockets can connect multiple times to change the
35440 If the connect call needs to do network I/O it will block, unless
35441 non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned
35442 and the user can be notified of the connection finishing by waiting
35443 for the G_IO_OUT condition. The result of the connection can then be
35444 checked with g_socket_check_connect_result().</doc>
35445 <return-value transfer-ownership="none">
35446 <doc xml:whitespace="preserve">%TRUE if connected, %FALSE on error.</doc>
35447 <type name="gboolean" c:type="gboolean"/>
35450 <parameter name="address" transfer-ownership="none">
35451 <doc xml:whitespace="preserve">a #GSocketAddress specifying the remote address.</doc>
35452 <type name="SocketAddress" c:type="GSocketAddress*"/>
35454 <parameter name="cancellable"
35455 transfer-ownership="none"
35457 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35458 <type name="Cancellable" c:type="GCancellable*"/>
35462 <method name="connection_factory_create_connection"
35463 c:identifier="g_socket_connection_factory_create_connection"
35465 <doc xml:whitespace="preserve">Creates a #GSocketConnection subclass of the right type for</doc>
35466 <return-value transfer-ownership="full">
35467 <doc xml:whitespace="preserve">a #GSocketConnection</doc>
35468 <type name="SocketConnection" c:type="GSocketConnection*"/>
35471 <method name="create_source"
35472 c:identifier="g_socket_create_source"
35474 introspectable="0">
35475 <doc xml:whitespace="preserve">Creates a %GSource that can be attached to a %GMainContext to monitor
35476 for the availibility of the specified @condition on the socket.
35477 The callback on the source is of the #GSocketSourceFunc type.
35478 It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition;
35479 these conditions will always be reported output if they are true.
35480 cause the source to trigger, reporting the current condition (which
35481 is likely 0 unless cancellation happened at the same time as a
35482 condition change). You can check for this in the callback using
35483 g_cancellable_is_cancelled().
35484 If @socket has a timeout set, and it is reached before @condition
35485 occurs, the source will then trigger anyway, reporting %G_IO_IN or
35486 %G_IO_OUT depending on @condition. However, @socket will have been
35487 marked as having had a timeout, and so the next #GSocket I/O method
35488 you call will then fail with a %G_IO_ERROR_TIMED_OUT.</doc>
35489 <return-value transfer-ownership="full">
35490 <doc xml:whitespace="preserve">a newly allocated %GSource, free with g_source_unref().</doc>
35491 <type name="GLib.Source" c:type="GSource*"/>
35494 <parameter name="condition" transfer-ownership="none">
35495 <doc xml:whitespace="preserve">a #GIOCondition mask to monitor</doc>
35496 <type name="GLib.IOCondition" c:type="GIOCondition"/>
35498 <parameter name="cancellable"
35499 transfer-ownership="none"
35501 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35502 <type name="Cancellable" c:type="GCancellable*"/>
35506 <method name="get_blocking"
35507 c:identifier="g_socket_get_blocking"
35509 <doc xml:whitespace="preserve">Gets the blocking mode of the socket. For details on blocking I/O,
35510 see g_socket_set_blocking().</doc>
35511 <return-value transfer-ownership="none">
35512 <doc xml:whitespace="preserve">%TRUE if blocking I/O is used, %FALSE otherwise.</doc>
35513 <type name="gboolean" c:type="gboolean"/>
35516 <method name="get_credentials"
35517 c:identifier="g_socket_get_credentials"
35520 <doc xml:whitespace="preserve">Returns the credentials of the foreign process connected to this
35521 socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX
35523 If this operation isn't supported on the OS, the method fails with
35524 the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented
35525 by reading the %SO_PEERCRED option on the underlying socket.
35526 Other ways to obtain credentials from a foreign peer includes the
35527 #GUnixCredentialsMessage type and
35528 g_unix_connection_send_credentials() /
35529 g_unix_connection_receive_credentials() functions.
35530 that must be freed with g_object_unref().</doc>
35531 <return-value transfer-ownership="full">
35532 <doc xml:whitespace="preserve">%NULL if @error is set, otherwise a #GCredentials object</doc>
35533 <type name="Credentials" c:type="GCredentials*"/>
35536 <method name="get_family"
35537 c:identifier="g_socket_get_family"
35539 <doc xml:whitespace="preserve">Gets the socket family of the socket.</doc>
35540 <return-value transfer-ownership="none">
35541 <doc xml:whitespace="preserve">a #GSocketFamily</doc>
35542 <type name="SocketFamily" c:type="GSocketFamily"/>
35545 <method name="get_fd" c:identifier="g_socket_get_fd" version="2.22">
35546 <doc xml:whitespace="preserve">Returns the underlying OS socket object. On unix this
35547 is a socket file descriptor, and on windows this is
35548 a Winsock2 SOCKET handle. This may be useful for
35549 doing platform specific or otherwise unusual operations
35550 on the socket.</doc>
35551 <return-value transfer-ownership="none">
35552 <doc xml:whitespace="preserve">the file descriptor of the socket.</doc>
35553 <type name="gint" c:type="int"/>
35556 <method name="get_keepalive"
35557 c:identifier="g_socket_get_keepalive"
35559 <doc xml:whitespace="preserve">Gets the keepalive mode of the socket. For details on this,
35560 see g_socket_set_keepalive().</doc>
35561 <return-value transfer-ownership="none">
35562 <doc xml:whitespace="preserve">%TRUE if keepalive is active, %FALSE otherwise.</doc>
35563 <type name="gboolean" c:type="gboolean"/>
35566 <method name="get_listen_backlog"
35567 c:identifier="g_socket_get_listen_backlog"
35569 <doc xml:whitespace="preserve">Gets the listen backlog setting of the socket. For details on this,
35570 see g_socket_set_listen_backlog().</doc>
35571 <return-value transfer-ownership="none">
35572 <doc xml:whitespace="preserve">the maximum number of pending connections.</doc>
35573 <type name="gint" c:type="gint"/>
35576 <method name="get_local_address"
35577 c:identifier="g_socket_get_local_address"
35580 <doc xml:whitespace="preserve">Try to get the local address of a bound socket. This is only
35581 useful if the socket has been bound to a local address,
35582 either explicitly or implicitly when connecting.
35583 Free the returned object with g_object_unref().</doc>
35584 <return-value transfer-ownership="full">
35585 <doc xml:whitespace="preserve">a #GSocketAddress or %NULL on error.</doc>
35586 <type name="SocketAddress" c:type="GSocketAddress*"/>
35589 <method name="get_protocol"
35590 c:identifier="g_socket_get_protocol"
35592 <doc xml:whitespace="preserve">Gets the socket protocol id the socket was created with.
35593 In case the protocol is unknown, -1 is returned.</doc>
35594 <return-value transfer-ownership="none">
35595 <doc xml:whitespace="preserve">a protocol id, or -1 if unknown</doc>
35596 <type name="SocketProtocol" c:type="GSocketProtocol"/>
35599 <method name="get_remote_address"
35600 c:identifier="g_socket_get_remote_address"
35603 <doc xml:whitespace="preserve">Try to get the remove address of a connected socket. This is only
35604 useful for connection oriented sockets that have been connected.
35605 Free the returned object with g_object_unref().</doc>
35606 <return-value transfer-ownership="full">
35607 <doc xml:whitespace="preserve">a #GSocketAddress or %NULL on error.</doc>
35608 <type name="SocketAddress" c:type="GSocketAddress*"/>
35611 <method name="get_socket_type"
35612 c:identifier="g_socket_get_socket_type"
35614 <doc xml:whitespace="preserve">Gets the socket type of the socket.</doc>
35615 <return-value transfer-ownership="none">
35616 <doc xml:whitespace="preserve">a #GSocketType</doc>
35617 <type name="SocketType" c:type="GSocketType"/>
35620 <method name="get_timeout"
35621 c:identifier="g_socket_get_timeout"
35623 <doc xml:whitespace="preserve">Gets the timeout setting of the socket. For details on this, see
35624 g_socket_set_timeout().</doc>
35625 <return-value transfer-ownership="none">
35626 <doc xml:whitespace="preserve">the timeout in seconds</doc>
35627 <type name="guint" c:type="guint"/>
35630 <method name="is_closed"
35631 c:identifier="g_socket_is_closed"
35633 <doc xml:whitespace="preserve">Checks whether a socket is closed.</doc>
35634 <return-value transfer-ownership="none">
35635 <doc xml:whitespace="preserve">%TRUE if socket is closed, %FALSE otherwise</doc>
35636 <type name="gboolean" c:type="gboolean"/>
35639 <method name="is_connected"
35640 c:identifier="g_socket_is_connected"
35642 <doc xml:whitespace="preserve">Check whether the socket is connected. This is only useful for
35643 connection-oriented sockets.</doc>
35644 <return-value transfer-ownership="none">
35645 <doc xml:whitespace="preserve">%TRUE if socket is connected, %FALSE otherwise.</doc>
35646 <type name="gboolean" c:type="gboolean"/>
35649 <method name="listen"
35650 c:identifier="g_socket_listen"
35653 <doc xml:whitespace="preserve">Marks the socket as a server socket, i.e. a socket that is used
35654 to accept incoming requests using g_socket_accept().
35655 Before calling this the socket must be bound to a local address using
35657 To set the maximum amount of outstanding clients, use
35658 g_socket_set_listen_backlog().</doc>
35659 <return-value transfer-ownership="none">
35660 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
35661 <type name="gboolean" c:type="gboolean"/>
35664 <method name="receive"
35665 c:identifier="g_socket_receive"
35668 <doc xml:whitespace="preserve">Receive data (up to @size bytes) from a socket. This is mainly used by
35669 connection-oriented sockets; it is identical to g_socket_receive_from()
35670 with @address set to %NULL.
35671 For %G_SOCKET_TYPE_DATAGRAM and %G_SOCKET_TYPE_SEQPACKET sockets,
35672 g_socket_receive() will always read either 0 or 1 complete messages from
35673 the socket. If the received message is too large to fit in @buffer, then
35674 the data beyond @size bytes will be discarded, without any explicit
35675 indication that this has occurred.
35676 For %G_SOCKET_TYPE_STREAM sockets, g_socket_receive() can return any
35677 number of bytes, up to @size. If more than @size bytes have been
35678 received, the additional data will be returned in future calls to
35679 g_socket_receive().
35680 If the socket is in blocking mode the call will block until there is
35681 some data to receive or there is an error. If there is no data available
35682 and the socket is in non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error
35683 will be returned. To be notified when data is available, wait for the
35684 %G_IO_IN condition.
35685 On error -1 is returned and @error is set accordingly.</doc>
35686 <return-value transfer-ownership="none">
35687 <doc xml:whitespace="preserve">Number of bytes read, or -1 on error</doc>
35688 <type name="glong" c:type="gssize"/>
35691 <parameter name="buffer" transfer-ownership="none">
35692 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least @size bytes long).</doc>
35693 <type name="utf8" c:type="gchar*"/>
35695 <parameter name="size" transfer-ownership="none">
35696 <doc xml:whitespace="preserve">the number of bytes you want to read from the socket</doc>
35697 <type name="gulong" c:type="gsize"/>
35699 <parameter name="cancellable"
35700 transfer-ownership="none"
35702 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35703 <type name="Cancellable" c:type="GCancellable*"/>
35707 <method name="receive_from"
35708 c:identifier="g_socket_receive_from"
35711 <doc xml:whitespace="preserve">Receive data (up to @size bytes) from a socket.
35712 If @address is non-%NULL then @address will be set equal to the
35713 source address of the received packet.
35714 See g_socket_receive() for additional information.</doc>
35715 <return-value transfer-ownership="none">
35716 <doc xml:whitespace="preserve">Number of bytes read, or -1 on error</doc>
35717 <type name="glong" c:type="gssize"/>
35720 <parameter name="address" transfer-ownership="none">
35721 <doc xml:whitespace="preserve">a pointer to a #GSocketAddress pointer, or %NULL</doc>
35722 <type name="SocketAddress" c:type="GSocketAddress**"/>
35724 <parameter name="buffer" transfer-ownership="none">
35725 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least @size bytes long).</doc>
35726 <type name="utf8" c:type="gchar*"/>
35728 <parameter name="size" transfer-ownership="none">
35729 <doc xml:whitespace="preserve">the number of bytes you want to read from the socket</doc>
35730 <type name="gulong" c:type="gsize"/>
35732 <parameter name="cancellable"
35733 transfer-ownership="none"
35735 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35736 <type name="Cancellable" c:type="GCancellable*"/>
35740 <method name="receive_message"
35741 c:identifier="g_socket_receive_message"
35744 <doc xml:whitespace="preserve">Receive data from a socket. This is the most complicated and
35745 fully-featured version of this call. For easier use, see
35746 g_socket_receive() and g_socket_receive_from().
35747 If @address is non-%NULL then @address will be set equal to the
35748 source address of the received packet.
35749 describe the buffers that received data will be scattered into.
35750 If @num_vectors is -1, then @vectors is assumed to be terminated
35751 by a #GInputVector with a %NULL buffer pointer.
35752 As a special case, if @num_vectors is 0 (in which case, @vectors
35753 may of course be %NULL), then a single byte is received and
35754 discarded. This is to facilitate the common practice of sending a
35755 single '\0' byte for the purposes of transferring ancillary data.
35756 array of #GSocketControlMessage instances or %NULL if no such
35757 messages was received. These correspond to the control messages
35758 received from the kernel, one #GSocketControlMessage per message
35759 from the kernel. This array is %NULL-terminated and must be freed
35760 by the caller using g_free() after calling g_object_unref() on each
35761 element. If @messages is %NULL, any control messages received will
35764 If both @messages and @num_messages are non-%NULL, then
35765 for this are available in the #GSocketMsgFlags enum, but the
35766 values there are the same as the system values, and the flags
35767 are passed in as-is, so you can pass in system-specific flags too
35768 (and g_socket_receive_message() may pass system-specific flags out).
35769 As with g_socket_receive(), data may be discarded if @socket is
35770 %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not
35771 provide enough buffer space to read a complete message. You can pass
35772 %G_SOCKET_MSG_PEEK in @flags to peek at the current message without
35773 removing it from the receive queue, but there is no portable way to find
35774 out the length of the message other than by reading it into a
35775 sufficiently-large buffer.
35776 If the socket is in blocking mode the call will block until there
35777 is some data to receive or there is an error. If there is no data
35778 available and the socket is in non-blocking mode, a
35779 %G_IO_ERROR_WOULD_BLOCK error will be returned. To be notified when
35780 data is available, wait for the %G_IO_IN condition.
35781 On error -1 is returned and @error is set accordingly.</doc>
35782 <return-value transfer-ownership="none">
35783 <doc xml:whitespace="preserve">Number of bytes read, or -1 on error</doc>
35784 <type name="glong" c:type="gssize"/>
35787 <parameter name="address" transfer-ownership="none">
35788 <doc xml:whitespace="preserve">a pointer to a #GSocketAddress pointer, or %NULL</doc>
35789 <type name="SocketAddress" c:type="GSocketAddress**"/>
35791 <parameter name="vectors" transfer-ownership="none">
35792 <doc xml:whitespace="preserve">an array of #GInputVector structs</doc>
35793 <type name="InputVector" c:type="GInputVector*"/>
35795 <parameter name="num_vectors" transfer-ownership="none">
35796 <doc xml:whitespace="preserve">the number of elements in @vectors, or -1</doc>
35797 <type name="gint" c:type="gint"/>
35799 <parameter name="messages" transfer-ownership="none">
35800 <doc xml:whitespace="preserve">a pointer which may be filled with an array of #GSocketControlMessages, or %NULL</doc>
35801 <type name="SocketControlMessage"
35802 c:type="GSocketControlMessage***"/>
35804 <parameter name="num_messages" transfer-ownership="none">
35805 <doc xml:whitespace="preserve">a pointer which will be filled with the number of elements in @messages, or %NULL</doc>
35806 <type name="gint" c:type="gint*"/>
35808 <parameter name="flags" transfer-ownership="none">
35809 <doc xml:whitespace="preserve">a pointer to an int containing #GSocketMsgFlags flags</doc>
35810 <type name="gint" c:type="gint*"/>
35812 <parameter name="cancellable"
35813 transfer-ownership="none"
35815 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35816 <type name="Cancellable" c:type="GCancellable*"/>
35820 <method name="receive_with_blocking"
35821 c:identifier="g_socket_receive_with_blocking"
35824 <doc xml:whitespace="preserve">This behaves exactly the same as g_socket_receive(), except that
35825 the choice of blocking or non-blocking behavior is determined by
35826 the @blocking argument rather than by @socket's properties.</doc>
35827 <return-value transfer-ownership="none">
35828 <doc xml:whitespace="preserve">Number of bytes read, or -1 on error</doc>
35829 <type name="glong" c:type="gssize"/>
35832 <parameter name="buffer" transfer-ownership="none">
35833 <doc xml:whitespace="preserve">a buffer to read data into (which should be at least @size bytes long).</doc>
35834 <type name="utf8" c:type="gchar*"/>
35836 <parameter name="size" transfer-ownership="none">
35837 <doc xml:whitespace="preserve">the number of bytes you want to read from the socket</doc>
35838 <type name="gulong" c:type="gsize"/>
35840 <parameter name="blocking" transfer-ownership="none">
35841 <doc xml:whitespace="preserve">whether to do blocking or non-blocking I/O</doc>
35842 <type name="gboolean" c:type="gboolean"/>
35844 <parameter name="cancellable"
35845 transfer-ownership="none"
35847 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35848 <type name="Cancellable" c:type="GCancellable*"/>
35852 <method name="send"
35853 c:identifier="g_socket_send"
35856 <doc xml:whitespace="preserve">Tries to send @size bytes from @buffer on the socket. This is
35857 mainly used by connection-oriented sockets; it is identical to
35858 g_socket_send_to() with @address set to %NULL.
35859 If the socket is in blocking mode the call will block until there is
35860 space for the data in the socket queue. If there is no space available
35861 and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
35862 will be returned. To be notified when space is available, wait for the
35863 %G_IO_OUT condition. Note though that you may still receive
35864 %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
35865 notified of a %G_IO_OUT condition. (On Windows in particular, this is
35866 very common due to the way the underlying APIs work.)
35867 On error -1 is returned and @error is set accordingly.
35869 <return-value transfer-ownership="none">
35870 <doc xml:whitespace="preserve">Number of bytes written (which may be less than @size), or -1</doc>
35871 <type name="glong" c:type="gssize"/>
35874 <parameter name="buffer" transfer-ownership="none">
35875 <doc xml:whitespace="preserve">the buffer containing the data to send.</doc>
35876 <type name="utf8" c:type="gchar*"/>
35878 <parameter name="size" transfer-ownership="none">
35879 <doc xml:whitespace="preserve">the number of bytes to send</doc>
35880 <type name="gulong" c:type="gsize"/>
35882 <parameter name="cancellable"
35883 transfer-ownership="none"
35885 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35886 <type name="Cancellable" c:type="GCancellable*"/>
35890 <method name="send_message"
35891 c:identifier="g_socket_send_message"
35894 <doc xml:whitespace="preserve">Send data to @address on @socket. This is the most complicated and
35895 fully-featured version of this call. For easier use, see
35896 g_socket_send() and g_socket_send_to().
35897 If @address is %NULL then the message is sent to the default receiver
35898 (set by g_socket_connect()).
35899 then @vectors is assumed to be terminated by a #GOutputVector with a
35900 %NULL buffer pointer.) The #GOutputVector structs describe the buffers
35901 that the sent data will be gathered from. Using multiple
35902 #GOutputVector<!-- -->s is more memory-efficient than manually copying
35903 data from multiple sources into a single buffer, and more
35904 network-efficient than making multiple calls to g_socket_send().
35905 #GSocketControlMessage instances. These correspond to the control
35906 messages to be sent on the socket.
35907 If @num_messages is -1 then @messages is treated as a %NULL-terminated
35909 for this are available in the #GSocketMsgFlags enum, but the
35910 values there are the same as the system values, and the flags
35911 are passed in as-is, so you can pass in system-specific flags too.
35912 If the socket is in blocking mode the call will block until there is
35913 space for the data in the socket queue. If there is no space available
35914 and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
35915 will be returned. To be notified when space is available, wait for the
35916 %G_IO_OUT condition. Note though that you may still receive
35917 %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
35918 notified of a %G_IO_OUT condition. (On Windows in particular, this is
35919 very common due to the way the underlying APIs work.)
35920 On error -1 is returned and @error is set accordingly.
35922 <return-value transfer-ownership="none">
35923 <doc xml:whitespace="preserve">Number of bytes written (which may be less than @size), or -1</doc>
35924 <type name="glong" c:type="gssize"/>
35927 <parameter name="address" transfer-ownership="none">
35928 <doc xml:whitespace="preserve">a #GSocketAddress, or %NULL</doc>
35929 <type name="SocketAddress" c:type="GSocketAddress*"/>
35931 <parameter name="vectors" transfer-ownership="none">
35932 <doc xml:whitespace="preserve">an array of #GOutputVector structs</doc>
35933 <type name="OutputVector" c:type="GOutputVector*"/>
35935 <parameter name="num_vectors" transfer-ownership="none">
35936 <doc xml:whitespace="preserve">the number of elements in @vectors, or -1</doc>
35937 <type name="gint" c:type="gint"/>
35939 <parameter name="messages" transfer-ownership="none">
35940 <doc xml:whitespace="preserve">a pointer to an array of #GSocketControlMessages, or %NULL.</doc>
35941 <type name="SocketControlMessage"
35942 c:type="GSocketControlMessage**"/>
35944 <parameter name="num_messages" transfer-ownership="none">
35945 <doc xml:whitespace="preserve">number of elements in @messages, or -1.</doc>
35946 <type name="gint" c:type="gint"/>
35948 <parameter name="flags" transfer-ownership="none">
35949 <doc xml:whitespace="preserve">an int containing #GSocketMsgFlags flags</doc>
35950 <type name="gint" c:type="gint"/>
35952 <parameter name="cancellable"
35953 transfer-ownership="none"
35955 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35956 <type name="Cancellable" c:type="GCancellable*"/>
35960 <method name="send_to"
35961 c:identifier="g_socket_send_to"
35964 <doc xml:whitespace="preserve">Tries to send @size bytes from @buffer to @address. If @address is
35965 %NULL then the message is sent to the default receiver (set by
35966 g_socket_connect()).
35967 See g_socket_send() for additional information.
35969 <return-value transfer-ownership="none">
35970 <doc xml:whitespace="preserve">Number of bytes written (which may be less than @size), or -1</doc>
35971 <type name="glong" c:type="gssize"/>
35974 <parameter name="address" transfer-ownership="none">
35975 <doc xml:whitespace="preserve">a #GSocketAddress, or %NULL</doc>
35976 <type name="SocketAddress" c:type="GSocketAddress*"/>
35978 <parameter name="buffer" transfer-ownership="none">
35979 <doc xml:whitespace="preserve">the buffer containing the data to send.</doc>
35980 <type name="utf8" c:type="gchar*"/>
35982 <parameter name="size" transfer-ownership="none">
35983 <doc xml:whitespace="preserve">the number of bytes to send</doc>
35984 <type name="gulong" c:type="gsize"/>
35986 <parameter name="cancellable"
35987 transfer-ownership="none"
35989 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
35990 <type name="Cancellable" c:type="GCancellable*"/>
35994 <method name="send_with_blocking"
35995 c:identifier="g_socket_send_with_blocking"
35998 <doc xml:whitespace="preserve">This behaves exactly the same as g_socket_send(), except that
35999 the choice of blocking or non-blocking behavior is determined by
36000 the @blocking argument rather than by @socket's properties.
36002 <return-value transfer-ownership="none">
36003 <doc xml:whitespace="preserve">Number of bytes written (which may be less than @size), or -1</doc>
36004 <type name="glong" c:type="gssize"/>
36007 <parameter name="buffer" transfer-ownership="none">
36008 <doc xml:whitespace="preserve">the buffer containing the data to send.</doc>
36009 <type name="utf8" c:type="gchar*"/>
36011 <parameter name="size" transfer-ownership="none">
36012 <doc xml:whitespace="preserve">the number of bytes to send</doc>
36013 <type name="gulong" c:type="gsize"/>
36015 <parameter name="blocking" transfer-ownership="none">
36016 <doc xml:whitespace="preserve">whether to do blocking or non-blocking I/O</doc>
36017 <type name="gboolean" c:type="gboolean"/>
36019 <parameter name="cancellable"
36020 transfer-ownership="none"
36022 <doc xml:whitespace="preserve">a %GCancellable or %NULL</doc>
36023 <type name="Cancellable" c:type="GCancellable*"/>
36027 <method name="set_blocking"
36028 c:identifier="g_socket_set_blocking"
36030 <doc xml:whitespace="preserve">Sets the blocking mode of the socket. In blocking mode
36031 all operations block until they succeed or there is an error. In
36032 non-blocking mode all functions return results immediately or
36033 with a %G_IO_ERROR_WOULD_BLOCK error.
36034 All sockets are created in blocking mode. However, note that the
36035 platform level socket is always non-blocking, and blocking mode
36036 is a GSocket level feature.</doc>
36037 <return-value transfer-ownership="none">
36038 <type name="none" c:type="void"/>
36041 <parameter name="blocking" transfer-ownership="none">
36042 <doc xml:whitespace="preserve">Whether to use blocking I/O or not.</doc>
36043 <type name="gboolean" c:type="gboolean"/>
36047 <method name="set_keepalive"
36048 c:identifier="g_socket_set_keepalive"
36050 <doc xml:whitespace="preserve">Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When
36051 this flag is set on a socket, the system will attempt to verify that the
36052 remote socket endpoint is still present if a sufficiently long period of
36053 time passes with no data being exchanged. If the system is unable to
36054 verify the presence of the remote endpoint, it will automatically close
36056 This option is only functional on certain kinds of sockets. (Notably,
36057 %G_SOCKET_PROTOCOL_TCP sockets.)
36058 The exact time between pings is system- and protocol-dependent, but will
36059 normally be at least two hours. Most commonly, you would set this flag
36060 on a server socket if you want to allow clients to remain idle for long
36061 periods of time, but also want to ensure that connections are eventually
36062 garbage-collected if clients crash or become unreachable.</doc>
36063 <return-value transfer-ownership="none">
36064 <type name="none" c:type="void"/>
36067 <parameter name="keepalive" transfer-ownership="none">
36068 <doc xml:whitespace="preserve">Value for the keepalive flag</doc>
36069 <type name="gboolean" c:type="gboolean"/>
36073 <method name="set_listen_backlog"
36074 c:identifier="g_socket_set_listen_backlog"
36076 <doc xml:whitespace="preserve">Sets the maximum number of outstanding connections allowed
36077 when listening on this socket. If more clients than this are
36078 connecting to the socket and the application is not handling them
36079 on time then the new connections will be refused.
36080 Note that this must be called before g_socket_listen() and has no
36081 effect if called after that.</doc>
36082 <return-value transfer-ownership="none">
36083 <type name="none" c:type="void"/>
36086 <parameter name="backlog" transfer-ownership="none">
36087 <doc xml:whitespace="preserve">the maximum number of pending connections.</doc>
36088 <type name="gint" c:type="gint"/>
36092 <method name="set_timeout"
36093 c:identifier="g_socket_set_timeout"
36095 <doc xml:whitespace="preserve">Sets the time in seconds after which I/O operations on @socket will
36096 time out if they have not yet completed.
36097 On a blocking socket, this means that any blocking #GSocket
36098 operation will time out after @timeout seconds of inactivity,
36099 returning %G_IO_ERROR_TIMED_OUT.
36100 On a non-blocking socket, calls to g_socket_condition_wait() will
36101 also fail with %G_IO_ERROR_TIMED_OUT after the given time. Sources
36102 created with g_socket_create_source() will trigger after
36103 set, at which point calling g_socket_receive(), g_socket_send(),
36104 g_socket_check_connect_result(), etc, will fail with
36105 %G_IO_ERROR_TIMED_OUT.
36106 If @timeout is 0 (the default), operations will never time out
36108 Note that if an I/O operation is interrupted by a signal, this may
36109 cause the timeout to be reset.</doc>
36110 <return-value transfer-ownership="none">
36111 <type name="none" c:type="void"/>
36114 <parameter name="timeout" transfer-ownership="none">
36115 <doc xml:whitespace="preserve">the timeout for @socket, in seconds, or 0 for none</doc>
36116 <type name="guint" c:type="guint"/>
36120 <method name="shutdown"
36121 c:identifier="g_socket_shutdown"
36124 <doc xml:whitespace="preserve">Shut down part of a full-duplex connection.
36125 If @shutdown_read is %TRUE then the recieving side of the connection
36126 is shut down, and further reading is disallowed.
36127 If @shutdown_write is %TRUE then the sending side of the connection
36128 is shut down, and further writing is disallowed.
36129 It is allowed for both @shutdown_read and @shutdown_write to be %TRUE.
36130 One example where this is used is graceful disconnect for TCP connections
36131 where you close the sending side, then wait for the other side to close
36132 the connection, thus ensuring that the other side saw all sent data.</doc>
36133 <return-value transfer-ownership="none">
36134 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error</doc>
36135 <type name="gboolean" c:type="gboolean"/>
36138 <parameter name="shutdown_read" transfer-ownership="none">
36139 <doc xml:whitespace="preserve">whether to shut down the read side</doc>
36140 <type name="gboolean" c:type="gboolean"/>
36142 <parameter name="shutdown_write" transfer-ownership="none">
36143 <doc xml:whitespace="preserve">whether to shut down the write side</doc>
36144 <type name="gboolean" c:type="gboolean"/>
36148 <method name="speaks_ipv4"
36149 c:identifier="g_socket_speaks_ipv4"
36151 <doc xml:whitespace="preserve">Checks if a socket is capable of speaking IPv4.
36152 IPv4 sockets are capable of speaking IPv4. On some operating systems
36153 and under some combinations of circumstances IPv6 sockets are also
36154 capable of speaking IPv4. See RFC 3493 section 3.7 for more
36156 No other types of sockets are currently considered as being capable
36157 of speaking IPv4.</doc>
36158 <return-value transfer-ownership="none">
36159 <doc xml:whitespace="preserve">%TRUE if this socket can be used with IPv4.</doc>
36160 <type name="gboolean" c:type="gboolean"/>
36163 <property name="blocking" writable="1" transfer-ownership="none">
36164 <type name="gboolean"/>
36166 <property name="family"
36169 transfer-ownership="none">
36170 <type name="SocketFamily"/>
36172 <property name="fd"
36175 transfer-ownership="none">
36176 <type name="gint"/>
36178 <property name="keepalive" writable="1" transfer-ownership="none">
36179 <type name="gboolean"/>
36181 <property name="listen-backlog" writable="1" transfer-ownership="none">
36182 <type name="gint"/>
36184 <property name="local-address" transfer-ownership="none">
36185 <type name="SocketAddress"/>
36187 <property name="protocol"
36190 transfer-ownership="none">
36191 <type name="SocketProtocol"/>
36193 <property name="remote-address" transfer-ownership="none">
36194 <type name="SocketAddress"/>
36196 <property name="timeout"
36199 transfer-ownership="none">
36200 <doc xml:whitespace="preserve">The timeout in seconds on socket I/O</doc>
36201 <type name="guint"/>
36203 <property name="type"
36206 transfer-ownership="none">
36207 <type name="SocketType"/>
36209 <field name="parent_instance">
36210 <type name="GObject.Object" c:type="GObject"/>
36212 <field name="priv">
36213 <type name="SocketPrivate" c:type="GSocketPrivate*"/>
36216 <class name="SocketAddress"
36217 c:symbol-prefix="socket_address"
36218 c:type="GSocketAddress"
36219 parent="GObject.Object"
36221 glib:type-name="GSocketAddress"
36222 glib:get-type="g_socket_address_get_type"
36223 glib:type-struct="SocketAddressClass">
36224 <doc xml:whitespace="preserve">A socket endpoint address, corresponding to <type>struct sockaddr</type>
36225 or one of its subtypes.</doc>
36226 <implements name="SocketConnectable"/>
36227 <constructor name="new_from_native"
36228 c:identifier="g_socket_address_new_from_native"
36230 <doc xml:whitespace="preserve">Creates a #GSocketAddress subclass corresponding to the native
36231 <type>struct sockaddr</type> @native.
36232 otherwise %NULL.</doc>
36233 <return-value transfer-ownership="full">
36234 <doc xml:whitespace="preserve">a new #GSocketAddress if @native could successfully be converted,</doc>
36235 <type name="SocketAddress" c:type="GSocketAddress*"/>
36238 <parameter name="native" transfer-ownership="none">
36239 <doc xml:whitespace="preserve">a pointer to a <type>struct sockaddr</type></doc>
36240 <type name="gpointer" c:type="gpointer"/>
36242 <parameter name="len" transfer-ownership="none">
36243 <doc xml:whitespace="preserve">the size of the memory location pointed to by @native</doc>
36244 <type name="gulong" c:type="gsize"/>
36248 <virtual-method name="get_family" invoker="get_family" version="2.22">
36249 <doc xml:whitespace="preserve">Gets the socket family type of @address.</doc>
36250 <return-value transfer-ownership="none">
36251 <doc xml:whitespace="preserve">the socket family type of @address.</doc>
36252 <type name="SocketFamily" c:type="GSocketFamily"/>
36255 <virtual-method name="get_native_size"
36256 invoker="get_native_size"
36258 <doc xml:whitespace="preserve">Gets the size of @address's native <type>struct sockaddr</type>.
36259 You can use this to allocate memory to pass to
36260 g_socket_address_to_native().</doc>
36261 <return-value transfer-ownership="none">
36262 <doc xml:whitespace="preserve">the size of the native <type>struct sockaddr</type> that</doc>
36263 <type name="glong" c:type="gssize"/>
36266 <virtual-method name="to_native"
36267 invoker="to_native"
36270 <doc xml:whitespace="preserve">Converts a #GSocketAddress to a native <type>struct
36271 sockaddr</type>, which can be passed to low-level functions like
36272 connect() or bind().
36273 If not enough space is availible, a %G_IO_ERROR_NO_SPACE error is
36274 returned. If the address type is not known on the system
36275 then a %G_IO_ERROR_NOT_SUPPORTED error is returned.</doc>
36276 <return-value transfer-ownership="none">
36277 <doc xml:whitespace="preserve">%TRUE if @dest was filled in, %FALSE on error</doc>
36278 <type name="gboolean" c:type="gboolean"/>
36281 <parameter name="dest" transfer-ownership="none">
36282 <doc xml:whitespace="preserve">a pointer to a memory location that will contain the native <type>struct sockaddr</type>.</doc>
36283 <type name="gpointer" c:type="gpointer"/>
36285 <parameter name="destlen" transfer-ownership="none">
36286 <doc xml:whitespace="preserve">the size of @dest. Must be at least as large as g_socket_address_get_native_size().</doc>
36287 <type name="gulong" c:type="gsize"/>
36291 <method name="get_family"
36292 c:identifier="g_socket_address_get_family"
36294 <doc xml:whitespace="preserve">Gets the socket family type of @address.</doc>
36295 <return-value transfer-ownership="none">
36296 <doc xml:whitespace="preserve">the socket family type of @address.</doc>
36297 <type name="SocketFamily" c:type="GSocketFamily"/>
36300 <method name="get_native_size"
36301 c:identifier="g_socket_address_get_native_size"
36303 <doc xml:whitespace="preserve">Gets the size of @address's native <type>struct sockaddr</type>.
36304 You can use this to allocate memory to pass to
36305 g_socket_address_to_native().</doc>
36306 <return-value transfer-ownership="none">
36307 <doc xml:whitespace="preserve">the size of the native <type>struct sockaddr</type> that</doc>
36308 <type name="glong" c:type="gssize"/>
36311 <method name="to_native"
36312 c:identifier="g_socket_address_to_native"
36315 <doc xml:whitespace="preserve">Converts a #GSocketAddress to a native <type>struct
36316 sockaddr</type>, which can be passed to low-level functions like
36317 connect() or bind().
36318 If not enough space is availible, a %G_IO_ERROR_NO_SPACE error is
36319 returned. If the address type is not known on the system
36320 then a %G_IO_ERROR_NOT_SUPPORTED error is returned.</doc>
36321 <return-value transfer-ownership="none">
36322 <doc xml:whitespace="preserve">%TRUE if @dest was filled in, %FALSE on error</doc>
36323 <type name="gboolean" c:type="gboolean"/>
36326 <parameter name="dest" transfer-ownership="none">
36327 <doc xml:whitespace="preserve">a pointer to a memory location that will contain the native <type>struct sockaddr</type>.</doc>
36328 <type name="gpointer" c:type="gpointer"/>
36330 <parameter name="destlen" transfer-ownership="none">
36331 <doc xml:whitespace="preserve">the size of @dest. Must be at least as large as g_socket_address_get_native_size().</doc>
36332 <type name="gulong" c:type="gsize"/>
36336 <property name="family" transfer-ownership="none">
36337 <type name="SocketFamily"/>
36339 <field name="parent_instance">
36340 <type name="GObject.Object" c:type="GObject"/>
36343 <record name="SocketAddressClass"
36344 c:type="GSocketAddressClass"
36345 glib:is-gtype-struct-for="SocketAddress">
36346 <field name="parent_class">
36347 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
36349 <field name="get_family">
36350 <callback name="get_family">
36351 <return-value transfer-ownership="none">
36352 <doc xml:whitespace="preserve">the socket family type of @address.</doc>
36353 <type name="SocketFamily" c:type="GSocketFamily"/>
36356 <parameter name="address" transfer-ownership="none">
36357 <type name="SocketAddress" c:type="GSocketAddress*"/>
36362 <field name="get_native_size">
36363 <callback name="get_native_size">
36364 <return-value transfer-ownership="none">
36365 <doc xml:whitespace="preserve">the size of the native <type>struct sockaddr</type> that</doc>
36366 <type name="glong" c:type="gssize"/>
36369 <parameter name="address" transfer-ownership="none">
36370 <type name="SocketAddress" c:type="GSocketAddress*"/>
36375 <field name="to_native">
36376 <callback name="to_native" throws="1">
36377 <return-value transfer-ownership="none">
36378 <doc xml:whitespace="preserve">%TRUE if @dest was filled in, %FALSE on error</doc>
36379 <type name="gboolean" c:type="gboolean"/>
36382 <parameter name="address" transfer-ownership="none">
36383 <type name="SocketAddress" c:type="GSocketAddress*"/>
36385 <parameter name="dest" transfer-ownership="none">
36386 <doc xml:whitespace="preserve">a pointer to a memory location that will contain the native <type>struct sockaddr</type>.</doc>
36387 <type name="gpointer" c:type="gpointer"/>
36389 <parameter name="destlen" transfer-ownership="none">
36390 <doc xml:whitespace="preserve">the size of @dest. Must be at least as large as g_socket_address_get_native_size().</doc>
36391 <type name="gulong" c:type="gsize"/>
36397 <class name="SocketAddressEnumerator"
36398 c:symbol-prefix="socket_address_enumerator"
36399 c:type="GSocketAddressEnumerator"
36400 parent="GObject.Object"
36402 glib:type-name="GSocketAddressEnumerator"
36403 glib:get-type="g_socket_address_enumerator_get_type"
36404 glib:type-struct="SocketAddressEnumeratorClass">
36405 <doc xml:whitespace="preserve">Enumerator type for objects that contain or generate
36406 #GSocketAddress<!-- -->es.</doc>
36407 <virtual-method name="next" invoker="next" throws="1">
36408 <doc xml:whitespace="preserve">Retrieves the next #GSocketAddress from @enumerator. Note that this
36409 may block for some amount of time. (Eg, a #GNetworkAddress may need
36410 to do a DNS lookup before it can return an address.) Use
36411 g_socket_address_enumerator_next_async() if you need to avoid
36413 If @enumerator is expected to yield addresses, but for some reason
36414 is unable to (eg, because of a DNS error), then the first call to
36415 g_socket_address_enumerator_next() will return an appropriate error
36416 in *@error. However, if the first call to
36417 g_socket_address_enumerator_next() succeeds, then any further
36418 internal errors (other than @cancellable being triggered) will be
36420 error (in which case *@error will be set) or if there are no
36421 more addresses.</doc>
36422 <return-value transfer-ownership="full">
36423 <doc xml:whitespace="preserve">a #GSocketAddress (owned by the caller), or %NULL on</doc>
36424 <type name="SocketAddress" c:type="GSocketAddress*"/>
36427 <parameter name="cancellable"
36428 transfer-ownership="none"
36430 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
36431 <type name="Cancellable" c:type="GCancellable*"/>
36435 <virtual-method name="next_async" invoker="next_async">
36436 <doc xml:whitespace="preserve">Asynchronously retrieves the next #GSocketAddress from @enumerator
36437 and then calls @callback, which must call
36438 g_socket_address_enumerator_next_finish() to get the result.</doc>
36439 <return-value transfer-ownership="none">
36440 <type name="none" c:type="void"/>
36443 <parameter name="cancellable"
36444 transfer-ownership="none"
36446 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
36447 <type name="Cancellable" c:type="GCancellable*"/>
36449 <parameter name="callback"
36450 transfer-ownership="none"
36453 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
36454 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
36456 <parameter name="user_data" transfer-ownership="none" closure="2">
36457 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
36458 <type name="gpointer" c:type="gpointer"/>
36462 <virtual-method name="next_finish" invoker="next_finish" throws="1">
36463 <doc xml:whitespace="preserve">Retrieves the result of a completed call to
36464 g_socket_address_enumerator_next_async(). See
36465 g_socket_address_enumerator_next() for more information about
36467 error (in which case *@error will be set) or if there are no
36468 more addresses.</doc>
36469 <return-value transfer-ownership="full">
36470 <doc xml:whitespace="preserve">a #GSocketAddress (owned by the caller), or %NULL on</doc>
36471 <type name="SocketAddress" c:type="GSocketAddress*"/>
36474 <parameter name="result" transfer-ownership="none">
36475 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
36476 <type name="AsyncResult" c:type="GAsyncResult*"/>
36480 <method name="next"
36481 c:identifier="g_socket_address_enumerator_next"
36483 <doc xml:whitespace="preserve">Retrieves the next #GSocketAddress from @enumerator. Note that this
36484 may block for some amount of time. (Eg, a #GNetworkAddress may need
36485 to do a DNS lookup before it can return an address.) Use
36486 g_socket_address_enumerator_next_async() if you need to avoid
36488 If @enumerator is expected to yield addresses, but for some reason
36489 is unable to (eg, because of a DNS error), then the first call to
36490 g_socket_address_enumerator_next() will return an appropriate error
36491 in *@error. However, if the first call to
36492 g_socket_address_enumerator_next() succeeds, then any further
36493 internal errors (other than @cancellable being triggered) will be
36495 error (in which case *@error will be set) or if there are no
36496 more addresses.</doc>
36497 <return-value transfer-ownership="full">
36498 <doc xml:whitespace="preserve">a #GSocketAddress (owned by the caller), or %NULL on</doc>
36499 <type name="SocketAddress" c:type="GSocketAddress*"/>
36502 <parameter name="cancellable"
36503 transfer-ownership="none"
36505 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
36506 <type name="Cancellable" c:type="GCancellable*"/>
36510 <method name="next_async"
36511 c:identifier="g_socket_address_enumerator_next_async">
36512 <doc xml:whitespace="preserve">Asynchronously retrieves the next #GSocketAddress from @enumerator
36513 and then calls @callback, which must call
36514 g_socket_address_enumerator_next_finish() to get the result.</doc>
36515 <return-value transfer-ownership="none">
36516 <type name="none" c:type="void"/>
36519 <parameter name="cancellable"
36520 transfer-ownership="none"
36522 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
36523 <type name="Cancellable" c:type="GCancellable*"/>
36525 <parameter name="callback"
36526 transfer-ownership="none"
36529 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
36530 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
36532 <parameter name="user_data" transfer-ownership="none">
36533 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
36534 <type name="gpointer" c:type="gpointer"/>
36538 <method name="next_finish"
36539 c:identifier="g_socket_address_enumerator_next_finish"
36541 <doc xml:whitespace="preserve">Retrieves the result of a completed call to
36542 g_socket_address_enumerator_next_async(). See
36543 g_socket_address_enumerator_next() for more information about
36545 error (in which case *@error will be set) or if there are no
36546 more addresses.</doc>
36547 <return-value transfer-ownership="full">
36548 <doc xml:whitespace="preserve">a #GSocketAddress (owned by the caller), or %NULL on</doc>
36549 <type name="SocketAddress" c:type="GSocketAddress*"/>
36552 <parameter name="result" transfer-ownership="none">
36553 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
36554 <type name="AsyncResult" c:type="GAsyncResult*"/>
36558 <field name="parent_instance">
36559 <type name="GObject.Object" c:type="GObject"/>
36562 <record name="SocketAddressEnumeratorClass"
36563 c:type="GSocketAddressEnumeratorClass"
36564 glib:is-gtype-struct-for="SocketAddressEnumerator">
36565 <field name="parent_class">
36566 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
36568 <field name="next">
36569 <callback name="next" throws="1">
36570 <return-value transfer-ownership="full">
36571 <doc xml:whitespace="preserve">a #GSocketAddress (owned by the caller), or %NULL on</doc>
36572 <type name="SocketAddress" c:type="GSocketAddress*"/>
36575 <parameter name="enumerator" transfer-ownership="none">
36576 <type name="SocketAddressEnumerator"
36577 c:type="GSocketAddressEnumerator*"/>
36579 <parameter name="cancellable"
36580 transfer-ownership="none"
36582 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
36583 <type name="Cancellable" c:type="GCancellable*"/>
36588 <field name="next_async">
36589 <callback name="next_async">
36590 <return-value transfer-ownership="none">
36591 <type name="none" c:type="void"/>
36594 <parameter name="enumerator" transfer-ownership="none">
36595 <type name="SocketAddressEnumerator"
36596 c:type="GSocketAddressEnumerator*"/>
36598 <parameter name="cancellable"
36599 transfer-ownership="none"
36601 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
36602 <type name="Cancellable" c:type="GCancellable*"/>
36604 <parameter name="callback"
36605 transfer-ownership="none"
36608 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the request is satisfied</doc>
36609 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
36611 <parameter name="user_data" transfer-ownership="none" closure="3">
36612 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
36613 <type name="gpointer" c:type="gpointer"/>
36618 <field name="next_finish">
36619 <callback name="next_finish" throws="1">
36620 <return-value transfer-ownership="full">
36621 <doc xml:whitespace="preserve">a #GSocketAddress (owned by the caller), or %NULL on</doc>
36622 <type name="SocketAddress" c:type="GSocketAddress*"/>
36625 <parameter name="enumerator" transfer-ownership="none">
36626 <type name="SocketAddressEnumerator"
36627 c:type="GSocketAddressEnumerator*"/>
36629 <parameter name="result" transfer-ownership="none">
36630 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
36631 <type name="AsyncResult" c:type="GAsyncResult*"/>
36637 <record name="SocketClass"
36638 c:type="GSocketClass"
36639 glib:is-gtype-struct-for="Socket">
36640 <field name="parent_class">
36641 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
36643 <field name="_g_reserved1" introspectable="0">
36644 <callback name="_g_reserved1">
36645 <return-value transfer-ownership="none">
36646 <type name="none" c:type="void"/>
36650 <field name="_g_reserved2" introspectable="0">
36651 <callback name="_g_reserved2">
36652 <return-value transfer-ownership="none">
36653 <type name="none" c:type="void"/>
36657 <field name="_g_reserved3" introspectable="0">
36658 <callback name="_g_reserved3">
36659 <return-value transfer-ownership="none">
36660 <type name="none" c:type="void"/>
36664 <field name="_g_reserved4" introspectable="0">
36665 <callback name="_g_reserved4">
36666 <return-value transfer-ownership="none">
36667 <type name="none" c:type="void"/>
36671 <field name="_g_reserved5" introspectable="0">
36672 <callback name="_g_reserved5">
36673 <return-value transfer-ownership="none">
36674 <type name="none" c:type="void"/>
36678 <field name="_g_reserved6" introspectable="0">
36679 <callback name="_g_reserved6">
36680 <return-value transfer-ownership="none">
36681 <type name="none" c:type="void"/>
36685 <field name="_g_reserved7" introspectable="0">
36686 <callback name="_g_reserved7">
36687 <return-value transfer-ownership="none">
36688 <type name="none" c:type="void"/>
36692 <field name="_g_reserved8" introspectable="0">
36693 <callback name="_g_reserved8">
36694 <return-value transfer-ownership="none">
36695 <type name="none" c:type="void"/>
36699 <field name="_g_reserved9" introspectable="0">
36700 <callback name="_g_reserved9">
36701 <return-value transfer-ownership="none">
36702 <type name="none" c:type="void"/>
36706 <field name="_g_reserved10" introspectable="0">
36707 <callback name="_g_reserved10">
36708 <return-value transfer-ownership="none">
36709 <type name="none" c:type="void"/>
36714 <class name="SocketClient"
36715 c:symbol-prefix="socket_client"
36716 c:type="GSocketClient"
36718 parent="GObject.Object"
36719 glib:type-name="GSocketClient"
36720 glib:get-type="g_socket_client_get_type"
36721 glib:type-struct="SocketClientClass">
36722 <doc xml:whitespace="preserve">A helper class for network servers to listen for and accept connections.</doc>
36723 <constructor name="new"
36724 c:identifier="g_socket_client_new"
36726 <doc xml:whitespace="preserve">Creates a new #GSocketClient with the default options.
36727 Free the returned object with g_object_unref().</doc>
36728 <return-value transfer-ownership="full">
36729 <doc xml:whitespace="preserve">a #GSocketClient.</doc>
36730 <type name="SocketClient" c:type="GSocketClient*"/>
36733 <method name="add_application_proxy"
36734 c:identifier="g_socket_client_add_application_proxy">
36735 <doc xml:whitespace="preserve">Enable proxy protocols to be handled by the application. When the
36736 indicated proxy protocol is returned by the #GProxyResolver,
36737 #GSocketClient will consider this protocol as supported but will
36738 not try find a #GProxy instance to handle handshaking. The
36739 application must check for this case by calling
36740 g_socket_connection_get_remote_address() on the returned
36741 #GSocketConnection, and seeing if it's a #GProxyAddress of the
36742 appropriate type, to determine whether or not it needs to handle
36743 the proxy handshaking itself.
36744 This should be used for proxy protocols that are dialects of
36745 another protocol such as HTTP proxy. It also allows cohabitation of
36746 proxy protocols that are reused between protocols. A good example
36747 is HTTP. It can be used to proxy HTTP, FTP and Gopher and can also
36748 be use as generic socket proxy through the HTTP CONNECT method.</doc>
36749 <return-value transfer-ownership="none">
36750 <type name="none" c:type="void"/>
36753 <parameter name="protocol" transfer-ownership="none">
36754 <doc xml:whitespace="preserve">The proxy protocol</doc>
36755 <type name="utf8" c:type="gchar*"/>
36759 <method name="connect"
36760 c:identifier="g_socket_client_connect"
36763 <doc xml:whitespace="preserve">Tries to resolve the @connectable and make a network connection to it..
36764 Upon a successful connection, a new #GSocketConnection is constructed
36765 and returned. The caller owns this new object and must drop their
36766 reference to it when finished with it.
36767 The type of the #GSocketConnection object returned depends on the type of
36768 the underlying socket that is used. For instance, for a TCP/IP connection
36769 it will be a #GTcpConnection.
36770 The socket created will be the same family as the the address that the
36771 or indirectly via g_socket_client_set_local_address(). The socket type
36772 defaults to %G_SOCKET_TYPE_STREAM but can be set with
36773 g_socket_client_set_socket_type().
36774 If a local address is specified with g_socket_client_set_local_address() the
36775 socket will be bound to this address before connecting.</doc>
36776 <return-value transfer-ownership="full">
36777 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
36778 <type name="SocketConnection" c:type="GSocketConnection*"/>
36781 <parameter name="connectable" transfer-ownership="none">
36782 <doc xml:whitespace="preserve">a #GSocketConnectable specifying the remote address.</doc>
36783 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
36785 <parameter name="cancellable"
36786 transfer-ownership="none"
36788 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
36789 <type name="Cancellable" c:type="GCancellable*"/>
36793 <method name="connect_async"
36794 c:identifier="g_socket_client_connect_async"
36796 <doc xml:whitespace="preserve">This is the asynchronous version of g_socket_client_connect().
36797 When the operation is finished @callback will be
36798 called. You can then call g_socket_client_connect_finish() to get
36799 the result of the operation.</doc>
36800 <return-value transfer-ownership="none">
36801 <type name="none" c:type="void"/>
36804 <parameter name="connectable" transfer-ownership="none">
36805 <doc xml:whitespace="preserve">a #GSocketConnectable specifying the remote address.</doc>
36806 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
36808 <parameter name="cancellable"
36809 transfer-ownership="none"
36811 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
36812 <type name="Cancellable" c:type="GCancellable*"/>
36814 <parameter name="callback"
36815 transfer-ownership="none"
36818 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
36819 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
36821 <parameter name="user_data" transfer-ownership="none">
36822 <doc xml:whitespace="preserve">user data for the callback</doc>
36823 <type name="gpointer" c:type="gpointer"/>
36827 <method name="connect_finish"
36828 c:identifier="g_socket_client_connect_finish"
36831 <doc xml:whitespace="preserve">Finishes an async connect operation. See g_socket_client_connect_async()</doc>
36832 <return-value transfer-ownership="full">
36833 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
36834 <type name="SocketConnection" c:type="GSocketConnection*"/>
36837 <parameter name="result" transfer-ownership="none">
36838 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
36839 <type name="AsyncResult" c:type="GAsyncResult*"/>
36843 <method name="connect_to_host"
36844 c:identifier="g_socket_client_connect_to_host"
36847 <doc xml:whitespace="preserve">This is a helper function for g_socket_client_connect().
36848 Attempts to create a TCP connection to the named host.
36849 address, an IPv4 address, or a domain name (in which case a DNS
36850 lookup is performed). Quoting with [] is supported for all address
36851 types. A port override may be specified in the usual way with a
36852 colon. Ports may be given as decimal numbers or symbolic names (in
36853 which case an /etc/services lookup is performed).
36854 If no port override is given in @host_and_port then @default_port will be
36855 used as the port number to connect to.
36856 In general, @host_and_port is expected to be provided by the user (allowing
36857 them to give the hostname, and a port overide if necessary) and
36858 In the case that an IP address is given, a single connection
36859 attempt is made. In the case that a name is given, multiple
36860 connection attempts may be made, in turn and according to the
36861 number of address records in DNS, until a connection succeeds.
36862 Upon a successful connection, a new #GSocketConnection is constructed
36863 and returned. The caller owns this new object and must drop their
36864 reference to it when finished with it.
36865 In the event of any failure (DNS error, service not found, no hosts
36866 connectable) %NULL is returned and @error (if non-%NULL) is set
36868 <return-value transfer-ownership="full">
36869 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
36870 <type name="SocketConnection" c:type="GSocketConnection*"/>
36873 <parameter name="host_and_port" transfer-ownership="none">
36874 <doc xml:whitespace="preserve">the name and optionally port of the host to connect to</doc>
36875 <type name="utf8" c:type="gchar*"/>
36877 <parameter name="default_port" transfer-ownership="none">
36878 <doc xml:whitespace="preserve">the default port to connect to</doc>
36879 <type name="guint16" c:type="guint16"/>
36881 <parameter name="cancellable"
36882 transfer-ownership="none"
36884 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
36885 <type name="Cancellable" c:type="GCancellable*"/>
36889 <method name="connect_to_host_async"
36890 c:identifier="g_socket_client_connect_to_host_async"
36892 <doc xml:whitespace="preserve">This is the asynchronous version of g_socket_client_connect_to_host().
36893 When the operation is finished @callback will be
36894 called. You can then call g_socket_client_connect_to_host_finish() to get
36895 the result of the operation.</doc>
36896 <return-value transfer-ownership="none">
36897 <type name="none" c:type="void"/>
36900 <parameter name="host_and_port" transfer-ownership="none">
36901 <doc xml:whitespace="preserve">the name and optionally the port of the host to connect to</doc>
36902 <type name="utf8" c:type="gchar*"/>
36904 <parameter name="default_port" transfer-ownership="none">
36905 <doc xml:whitespace="preserve">the default port to connect to</doc>
36906 <type name="guint16" c:type="guint16"/>
36908 <parameter name="cancellable"
36909 transfer-ownership="none"
36911 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
36912 <type name="Cancellable" c:type="GCancellable*"/>
36914 <parameter name="callback"
36915 transfer-ownership="none"
36918 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
36919 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
36921 <parameter name="user_data" transfer-ownership="none">
36922 <doc xml:whitespace="preserve">user data for the callback</doc>
36923 <type name="gpointer" c:type="gpointer"/>
36927 <method name="connect_to_host_finish"
36928 c:identifier="g_socket_client_connect_to_host_finish"
36931 <doc xml:whitespace="preserve">Finishes an async connect operation. See g_socket_client_connect_to_host_async()</doc>
36932 <return-value transfer-ownership="full">
36933 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
36934 <type name="SocketConnection" c:type="GSocketConnection*"/>
36937 <parameter name="result" transfer-ownership="none">
36938 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
36939 <type name="AsyncResult" c:type="GAsyncResult*"/>
36943 <method name="connect_to_service"
36944 c:identifier="g_socket_client_connect_to_service"
36946 <doc xml:whitespace="preserve">Attempts to create a TCP connection to a service.
36947 This call looks up the SRV record for @service at @domain for the
36948 "tcp" protocol. It then attempts to connect, in turn, to each of
36949 the hosts providing the service until either a connection succeeds
36950 or there are no hosts remaining.
36951 Upon a successful connection, a new #GSocketConnection is constructed
36952 and returned. The caller owns this new object and must drop their
36953 reference to it when finished with it.
36954 In the event of any failure (DNS error, service not found, no hosts
36955 connectable) %NULL is returned and @error (if non-%NULL) is set
36957 <return-value transfer-ownership="full">
36958 <doc xml:whitespace="preserve">a #GSocketConnection if successful, or %NULL on error</doc>
36959 <type name="SocketConnection" c:type="GSocketConnection*"/>
36962 <parameter name="domain" transfer-ownership="none">
36963 <doc xml:whitespace="preserve">a domain name</doc>
36964 <type name="utf8" c:type="gchar*"/>
36966 <parameter name="service" transfer-ownership="none">
36967 <doc xml:whitespace="preserve">the name of the service to connect to</doc>
36968 <type name="utf8" c:type="gchar*"/>
36970 <parameter name="cancellable"
36971 transfer-ownership="none"
36973 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
36974 <type name="Cancellable" c:type="GCancellable*"/>
36978 <method name="connect_to_service_async"
36979 c:identifier="g_socket_client_connect_to_service_async"
36981 <doc xml:whitespace="preserve">This is the asynchronous version of
36982 g_socket_client_connect_to_service().</doc>
36983 <return-value transfer-ownership="none">
36984 <type name="none" c:type="void"/>
36987 <parameter name="domain" transfer-ownership="none">
36988 <doc xml:whitespace="preserve">a domain name</doc>
36989 <type name="utf8" c:type="gchar*"/>
36991 <parameter name="service" transfer-ownership="none">
36992 <doc xml:whitespace="preserve">the name of the service to connect to</doc>
36993 <type name="utf8" c:type="gchar*"/>
36995 <parameter name="cancellable"
36996 transfer-ownership="none"
36998 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
36999 <type name="Cancellable" c:type="GCancellable*"/>
37001 <parameter name="callback"
37002 transfer-ownership="none"
37005 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
37006 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
37008 <parameter name="user_data" transfer-ownership="none">
37009 <doc xml:whitespace="preserve">user data for the callback</doc>
37010 <type name="gpointer" c:type="gpointer"/>
37014 <method name="connect_to_service_finish"
37015 c:identifier="g_socket_client_connect_to_service_finish"
37018 <doc xml:whitespace="preserve">Finishes an async connect operation. See g_socket_client_connect_to_service_async()</doc>
37019 <return-value transfer-ownership="full">
37020 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
37021 <type name="SocketConnection" c:type="GSocketConnection*"/>
37024 <parameter name="result" transfer-ownership="none">
37025 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
37026 <type name="AsyncResult" c:type="GAsyncResult*"/>
37030 <method name="connect_to_uri"
37031 c:identifier="g_socket_client_connect_to_uri"
37034 <doc xml:whitespace="preserve">This is a helper function for g_socket_client_connect().
37035 Attempts to create a TCP connection with a network URI.
37036 component. If a port is not specified in the URI, @default_port
37038 Using this rather than g_socket_client_connect() or
37039 g_socket_client_connect_to_host() allows #GSocketClient to
37040 determine when to use application-specific proxy protocols.
37041 Upon a successful connection, a new #GSocketConnection is constructed
37042 and returned. The caller owns this new object and must drop their
37043 reference to it when finished with it.
37044 In the event of any failure (DNS error, service not found, no hosts
37045 connectable) %NULL is returned and @error (if non-%NULL) is set
37047 <return-value transfer-ownership="full">
37048 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
37049 <type name="SocketConnection" c:type="GSocketConnection*"/>
37052 <parameter name="uri" transfer-ownership="none">
37053 <doc xml:whitespace="preserve">A network URI</doc>
37054 <type name="utf8" c:type="gchar*"/>
37056 <parameter name="default_port" transfer-ownership="none">
37057 <doc xml:whitespace="preserve">the default port to connect to</doc>
37058 <type name="guint16" c:type="guint16"/>
37060 <parameter name="cancellable"
37061 transfer-ownership="none"
37063 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
37064 <type name="Cancellable" c:type="GCancellable*"/>
37068 <method name="connect_to_uri_async"
37069 c:identifier="g_socket_client_connect_to_uri_async"
37071 <doc xml:whitespace="preserve">This is the asynchronous version of g_socket_client_connect_to_uri().
37072 When the operation is finished @callback will be
37073 called. You can then call g_socket_client_connect_to_uri_finish() to get
37074 the result of the operation.</doc>
37075 <return-value transfer-ownership="none">
37076 <type name="none" c:type="void"/>
37079 <parameter name="uri" transfer-ownership="none">
37080 <doc xml:whitespace="preserve">a network uri</doc>
37081 <type name="utf8" c:type="gchar*"/>
37083 <parameter name="default_port" transfer-ownership="none">
37084 <doc xml:whitespace="preserve">the default port to connect to</doc>
37085 <type name="guint16" c:type="guint16"/>
37087 <parameter name="cancellable"
37088 transfer-ownership="none"
37090 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
37091 <type name="Cancellable" c:type="GCancellable*"/>
37093 <parameter name="callback"
37094 transfer-ownership="none"
37097 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
37098 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
37100 <parameter name="user_data" transfer-ownership="none">
37101 <doc xml:whitespace="preserve">user data for the callback</doc>
37102 <type name="gpointer" c:type="gpointer"/>
37106 <method name="connect_to_uri_finish"
37107 c:identifier="g_socket_client_connect_to_uri_finish"
37110 <doc xml:whitespace="preserve">Finishes an async connect operation. See g_socket_client_connect_to_uri_async()</doc>
37111 <return-value transfer-ownership="full">
37112 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
37113 <type name="SocketConnection" c:type="GSocketConnection*"/>
37116 <parameter name="result" transfer-ownership="none">
37117 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
37118 <type name="AsyncResult" c:type="GAsyncResult*"/>
37122 <method name="get_enable_proxy"
37123 c:identifier="g_socket_client_get_enable_proxy"
37125 <doc xml:whitespace="preserve">Gets the proxy enable state; see g_socket_client_set_enable_proxy()</doc>
37126 <return-value transfer-ownership="none">
37127 <doc xml:whitespace="preserve">whether proxying is enabled</doc>
37128 <type name="gboolean" c:type="gboolean"/>
37131 <method name="get_family"
37132 c:identifier="g_socket_client_get_family"
37134 <doc xml:whitespace="preserve">Gets the socket family of the socket client.
37135 See g_socket_client_set_family() for details.</doc>
37136 <return-value transfer-ownership="none">
37137 <doc xml:whitespace="preserve">a #GSocketFamily</doc>
37138 <type name="SocketFamily" c:type="GSocketFamily"/>
37141 <method name="get_local_address"
37142 c:identifier="g_socket_client_get_local_address"
37144 <doc xml:whitespace="preserve">Gets the local address of the socket client.
37145 See g_socket_client_set_local_address() for details.</doc>
37146 <return-value transfer-ownership="none">
37147 <doc xml:whitespace="preserve">a #GSocketAddres or %NULL. don't free</doc>
37148 <type name="SocketAddress" c:type="GSocketAddress*"/>
37151 <method name="get_protocol"
37152 c:identifier="g_socket_client_get_protocol"
37154 <doc xml:whitespace="preserve">Gets the protocol name type of the socket client.
37155 See g_socket_client_set_protocol() for details.</doc>
37156 <return-value transfer-ownership="none">
37157 <doc xml:whitespace="preserve">a #GSocketProtocol</doc>
37158 <type name="SocketProtocol" c:type="GSocketProtocol"/>
37161 <method name="get_socket_type"
37162 c:identifier="g_socket_client_get_socket_type"
37164 <doc xml:whitespace="preserve">Gets the socket type of the socket client.
37165 See g_socket_client_set_socket_type() for details.</doc>
37166 <return-value transfer-ownership="none">
37167 <doc xml:whitespace="preserve">a #GSocketFamily</doc>
37168 <type name="SocketType" c:type="GSocketType"/>
37171 <method name="get_timeout"
37172 c:identifier="g_socket_client_get_timeout"
37174 <doc xml:whitespace="preserve">Gets the I/O timeout time for sockets created by @client.
37175 See g_socket_client_set_timeout() for details.</doc>
37176 <return-value transfer-ownership="none">
37177 <doc xml:whitespace="preserve">the timeout in seconds</doc>
37178 <type name="guint" c:type="guint"/>
37181 <method name="set_enable_proxy"
37182 c:identifier="g_socket_client_set_enable_proxy"
37184 <doc xml:whitespace="preserve">Sets whether or not @client attempts to make connections via a
37185 proxy server. When enabled (the default), #GSocketClient will use a
37186 #GProxyResolver to determine if a proxy protocol such as SOCKS is
37187 needed, and automatically do the necessary proxy negotiation.</doc>
37188 <return-value transfer-ownership="none">
37189 <type name="none" c:type="void"/>
37192 <parameter name="enable" transfer-ownership="none">
37193 <doc xml:whitespace="preserve">whether to enable proxies</doc>
37194 <type name="gboolean" c:type="gboolean"/>
37198 <method name="set_family"
37199 c:identifier="g_socket_client_set_family"
37201 <doc xml:whitespace="preserve">Sets the socket family of the socket client.
37202 If this is set to something other than %G_SOCKET_FAMILY_INVALID
37203 then the sockets created by this object will be of the specified
37205 This might be useful for instance if you want to force the local
37206 connection to be an ipv4 socket, even though the address might
37207 be an ipv6 mapped to ipv4 address.</doc>
37208 <return-value transfer-ownership="none">
37209 <type name="none" c:type="void"/>
37212 <parameter name="family" transfer-ownership="none">
37213 <doc xml:whitespace="preserve">a #GSocketFamily</doc>
37214 <type name="SocketFamily" c:type="GSocketFamily"/>
37218 <method name="set_local_address"
37219 c:identifier="g_socket_client_set_local_address"
37221 <doc xml:whitespace="preserve">Sets the local address of the socket client.
37222 The sockets created by this object will bound to the
37223 specified address (if not %NULL) before connecting.
37224 This is useful if you want to ensure the the local
37225 side of the connection is on a specific port, or on
37226 a specific interface.</doc>
37227 <return-value transfer-ownership="none">
37228 <type name="none" c:type="void"/>
37231 <parameter name="address" transfer-ownership="none">
37232 <doc xml:whitespace="preserve">a #GSocketAddress, or %NULL</doc>
37233 <type name="SocketAddress" c:type="GSocketAddress*"/>
37237 <method name="set_protocol"
37238 c:identifier="g_socket_client_set_protocol"
37240 <doc xml:whitespace="preserve">Sets the protocol of the socket client.
37241 The sockets created by this object will use of the specified
37243 If @protocol is %0 that means to use the default
37244 protocol for the socket family and type.</doc>
37245 <return-value transfer-ownership="none">
37246 <type name="none" c:type="void"/>
37249 <parameter name="protocol" transfer-ownership="none">
37250 <doc xml:whitespace="preserve">a #GSocketProtocol</doc>
37251 <type name="SocketProtocol" c:type="GSocketProtocol"/>
37255 <method name="set_socket_type"
37256 c:identifier="g_socket_client_set_socket_type"
37258 <doc xml:whitespace="preserve">Sets the socket type of the socket client.
37259 The sockets created by this object will be of the specified
37261 It doesn't make sense to specify a type of %G_SOCKET_TYPE_DATAGRAM,
37262 as GSocketClient is used for connection oriented services.</doc>
37263 <return-value transfer-ownership="none">
37264 <type name="none" c:type="void"/>
37267 <parameter name="type" transfer-ownership="none">
37268 <doc xml:whitespace="preserve">a #GSocketType</doc>
37269 <type name="SocketType" c:type="GSocketType"/>
37273 <method name="set_timeout"
37274 c:identifier="g_socket_client_set_timeout"
37276 <doc xml:whitespace="preserve">Sets the I/O timeout for sockets created by @client. @timeout is a
37277 time in seconds, or 0 for no timeout (the default).
37278 The timeout value affects the initial connection attempt as well,
37279 so setting this may cause calls to g_socket_client_connect(), etc,
37280 to fail with %G_IO_ERROR_TIMED_OUT.</doc>
37281 <return-value transfer-ownership="none">
37282 <type name="none" c:type="void"/>
37285 <parameter name="timeout" transfer-ownership="none">
37286 <doc xml:whitespace="preserve">the timeout</doc>
37287 <type name="guint" c:type="guint"/>
37291 <property name="enable-proxy"
37294 transfer-ownership="none">
37295 <type name="gboolean"/>
37297 <property name="family"
37300 transfer-ownership="none">
37301 <type name="SocketFamily"/>
37303 <property name="local-address"
37306 transfer-ownership="none">
37307 <type name="SocketAddress"/>
37309 <property name="protocol"
37312 transfer-ownership="none">
37313 <type name="SocketProtocol"/>
37315 <property name="timeout"
37318 transfer-ownership="none">
37319 <type name="guint"/>
37321 <property name="type"
37324 transfer-ownership="none">
37325 <type name="SocketType"/>
37327 <field name="parent_instance">
37328 <type name="GObject.Object" c:type="GObject"/>
37330 <field name="priv">
37331 <type name="SocketClientPrivate" c:type="GSocketClientPrivate*"/>
37334 <record name="SocketClientClass"
37335 c:type="GSocketClientClass"
37336 glib:is-gtype-struct-for="SocketClient">
37337 <field name="parent_class">
37338 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
37340 <field name="_g_reserved1" introspectable="0">
37341 <callback name="_g_reserved1">
37342 <return-value transfer-ownership="none">
37343 <type name="none" c:type="void"/>
37347 <field name="_g_reserved2" introspectable="0">
37348 <callback name="_g_reserved2">
37349 <return-value transfer-ownership="none">
37350 <type name="none" c:type="void"/>
37354 <field name="_g_reserved3" introspectable="0">
37355 <callback name="_g_reserved3">
37356 <return-value transfer-ownership="none">
37357 <type name="none" c:type="void"/>
37361 <field name="_g_reserved4" introspectable="0">
37362 <callback name="_g_reserved4">
37363 <return-value transfer-ownership="none">
37364 <type name="none" c:type="void"/>
37368 <field name="_g_reserved5" introspectable="0">
37369 <callback name="_g_reserved5">
37370 <return-value transfer-ownership="none">
37371 <type name="none" c:type="void"/>
37376 <record name="SocketClientPrivate"
37377 c:type="GSocketClientPrivate"
37380 <interface name="SocketConnectable"
37381 c:symbol-prefix="socket_connectable"
37382 c:type="GSocketConnectable"
37383 glib:type-name="GSocketConnectable"
37384 glib:get-type="g_socket_connectable_get_type"
37385 glib:type-struct="SocketConnectableIface">
37386 <doc xml:whitespace="preserve">Interface for objects that contain or generate #GSocketAddress<!-- -->es.</doc>
37387 <virtual-method name="enumerate" invoker="enumerate" version="2.22">
37388 <doc xml:whitespace="preserve">Creates a #GSocketAddressEnumerator for @connectable.</doc>
37389 <return-value transfer-ownership="full">
37390 <doc xml:whitespace="preserve">a new #GSocketAddressEnumerator.</doc>
37391 <type name="SocketAddressEnumerator"
37392 c:type="GSocketAddressEnumerator*"/>
37395 <virtual-method name="proxy_enumerate"
37396 invoker="proxy_enumerate"
37398 <doc xml:whitespace="preserve">Creates a #GSocketAddressEnumerator for @connectable that will
37399 return #GProxyAddress<!-- -->es for addresses that you must connect
37401 If @connectable does not implement
37402 g_socket_connectable_proxy_enumerate(), this will fall back to
37403 calling g_socket_connectable_enumerate().</doc>
37404 <return-value transfer-ownership="full">
37405 <doc xml:whitespace="preserve">a new #GSocketAddressEnumerator.</doc>
37406 <type name="SocketAddressEnumerator"
37407 c:type="GSocketAddressEnumerator*"/>
37410 <method name="enumerate"
37411 c:identifier="g_socket_connectable_enumerate"
37413 <doc xml:whitespace="preserve">Creates a #GSocketAddressEnumerator for @connectable.</doc>
37414 <return-value transfer-ownership="full">
37415 <doc xml:whitespace="preserve">a new #GSocketAddressEnumerator.</doc>
37416 <type name="SocketAddressEnumerator"
37417 c:type="GSocketAddressEnumerator*"/>
37420 <method name="proxy_enumerate"
37421 c:identifier="g_socket_connectable_proxy_enumerate"
37423 <doc xml:whitespace="preserve">Creates a #GSocketAddressEnumerator for @connectable that will
37424 return #GProxyAddress<!-- -->es for addresses that you must connect
37426 If @connectable does not implement
37427 g_socket_connectable_proxy_enumerate(), this will fall back to
37428 calling g_socket_connectable_enumerate().</doc>
37429 <return-value transfer-ownership="full">
37430 <doc xml:whitespace="preserve">a new #GSocketAddressEnumerator.</doc>
37431 <type name="SocketAddressEnumerator"
37432 c:type="GSocketAddressEnumerator*"/>
37436 <record name="SocketConnectableIface"
37437 c:type="GSocketConnectableIface"
37438 glib:is-gtype-struct-for="SocketConnectable">
37439 <doc xml:whitespace="preserve">Provides an interface for returning a #GSocketAddressEnumerator
37440 and #GProxyAddressEnumerator</doc>
37441 <field name="g_iface">
37442 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
37444 <field name="enumerate">
37445 <callback name="enumerate">
37446 <return-value transfer-ownership="full">
37447 <doc xml:whitespace="preserve">a new #GSocketAddressEnumerator.</doc>
37448 <type name="SocketAddressEnumerator"
37449 c:type="GSocketAddressEnumerator*"/>
37452 <parameter name="connectable" transfer-ownership="none">
37453 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
37458 <field name="proxy_enumerate">
37459 <callback name="proxy_enumerate">
37460 <return-value transfer-ownership="full">
37461 <doc xml:whitespace="preserve">a new #GSocketAddressEnumerator.</doc>
37462 <type name="SocketAddressEnumerator"
37463 c:type="GSocketAddressEnumerator*"/>
37466 <parameter name="connectable" transfer-ownership="none">
37467 <type name="SocketConnectable" c:type="GSocketConnectable*"/>
37473 <class name="SocketConnection"
37474 c:symbol-prefix="socket_connection"
37475 c:type="GSocketConnection"
37478 glib:type-name="GSocketConnection"
37479 glib:get-type="g_socket_connection_get_type"
37480 glib:type-struct="SocketConnectionClass">
37481 <doc xml:whitespace="preserve">A socket connection GIOStream object for connection-oriented sockets.</doc>
37482 <function name="factory_lookup_type"
37483 c:identifier="g_socket_connection_factory_lookup_type"
37485 <doc xml:whitespace="preserve">Looks up the #GType to be used when creating socket connections on
37486 sockets with the specified @family,@type and @protocol_id.
37487 If no type is registered, the #GSocketConnection base type is returned.</doc>
37488 <return-value transfer-ownership="none">
37489 <doc xml:whitespace="preserve">a #GType</doc>
37490 <type name="GType" c:type="GType"/>
37493 <parameter name="family" transfer-ownership="none">
37494 <doc xml:whitespace="preserve">a #GSocketFamily</doc>
37495 <type name="SocketFamily" c:type="GSocketFamily"/>
37497 <parameter name="type" transfer-ownership="none">
37498 <doc xml:whitespace="preserve">a #GSocketType</doc>
37499 <type name="SocketType" c:type="GSocketType"/>
37501 <parameter name="protocol_id" transfer-ownership="none">
37502 <doc xml:whitespace="preserve">a protocol id</doc>
37503 <type name="gint" c:type="gint"/>
37507 <function name="factory_register_type"
37508 c:identifier="g_socket_connection_factory_register_type"
37510 <doc xml:whitespace="preserve">Looks up the #GType to be used when creating socket connections on
37511 sockets with the specified @family,@type and @protocol.
37512 If no type is registered, the #GSocketConnection base type is returned.</doc>
37513 <return-value transfer-ownership="none">
37514 <type name="none" c:type="void"/>
37517 <parameter name="g_type" transfer-ownership="none">
37518 <doc xml:whitespace="preserve">a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION</doc>
37519 <type name="GType" c:type="GType"/>
37521 <parameter name="family" transfer-ownership="none">
37522 <doc xml:whitespace="preserve">a #GSocketFamily</doc>
37523 <type name="SocketFamily" c:type="GSocketFamily"/>
37525 <parameter name="type" transfer-ownership="none">
37526 <doc xml:whitespace="preserve">a #GSocketType</doc>
37527 <type name="SocketType" c:type="GSocketType"/>
37529 <parameter name="protocol" transfer-ownership="none">
37530 <doc xml:whitespace="preserve">a protocol id</doc>
37531 <type name="gint" c:type="gint"/>
37535 <method name="get_local_address"
37536 c:identifier="g_socket_connection_get_local_address"
37539 <doc xml:whitespace="preserve">Try to get the local address of a socket connection.
37540 Free the returned object with g_object_unref().</doc>
37541 <return-value transfer-ownership="full">
37542 <doc xml:whitespace="preserve">a #GSocketAddress or %NULL on error.</doc>
37543 <type name="SocketAddress" c:type="GSocketAddress*"/>
37546 <method name="get_remote_address"
37547 c:identifier="g_socket_connection_get_remote_address"
37550 <doc xml:whitespace="preserve">Try to get the remote address of a socket connection.
37551 Free the returned object with g_object_unref().</doc>
37552 <return-value transfer-ownership="full">
37553 <doc xml:whitespace="preserve">a #GSocketAddress or %NULL on error.</doc>
37554 <type name="SocketAddress" c:type="GSocketAddress*"/>
37557 <method name="get_socket"
37558 c:identifier="g_socket_connection_get_socket"
37560 <doc xml:whitespace="preserve">Gets the underlying #GSocket object of the connection.
37561 This can be useful if you want to do something unusual on it
37562 not supported by the #GSocketConnection APIs.</doc>
37563 <return-value transfer-ownership="none">
37564 <doc xml:whitespace="preserve">a #GSocketAddress or %NULL on error.</doc>
37565 <type name="Socket" c:type="GSocket*"/>
37568 <property name="socket"
37571 transfer-ownership="none">
37572 <type name="Socket"/>
37574 <field name="parent_instance">
37575 <type name="IOStream" c:type="GIOStream"/>
37577 <field name="priv">
37578 <type name="SocketConnectionPrivate"
37579 c:type="GSocketConnectionPrivate*"/>
37582 <record name="SocketConnectionClass"
37583 c:type="GSocketConnectionClass"
37584 glib:is-gtype-struct-for="SocketConnection">
37585 <field name="parent_class">
37586 <type name="IOStreamClass" c:type="GIOStreamClass"/>
37588 <field name="_g_reserved1" introspectable="0">
37589 <callback name="_g_reserved1">
37590 <return-value transfer-ownership="none">
37591 <type name="none" c:type="void"/>
37595 <field name="_g_reserved2" introspectable="0">
37596 <callback name="_g_reserved2">
37597 <return-value transfer-ownership="none">
37598 <type name="none" c:type="void"/>
37602 <field name="_g_reserved3" introspectable="0">
37603 <callback name="_g_reserved3">
37604 <return-value transfer-ownership="none">
37605 <type name="none" c:type="void"/>
37609 <field name="_g_reserved4" introspectable="0">
37610 <callback name="_g_reserved4">
37611 <return-value transfer-ownership="none">
37612 <type name="none" c:type="void"/>
37616 <field name="_g_reserved5" introspectable="0">
37617 <callback name="_g_reserved5">
37618 <return-value transfer-ownership="none">
37619 <type name="none" c:type="void"/>
37623 <field name="_g_reserved6" introspectable="0">
37624 <callback name="_g_reserved6">
37625 <return-value transfer-ownership="none">
37626 <type name="none" c:type="void"/>
37631 <record name="SocketConnectionPrivate"
37632 c:type="GSocketConnectionPrivate"
37635 <class name="SocketControlMessage"
37636 c:symbol-prefix="socket_control_message"
37637 c:type="GSocketControlMessage"
37638 parent="GObject.Object"
37640 glib:type-name="GSocketControlMessage"
37641 glib:get-type="g_socket_control_message_get_type"
37642 glib:type-struct="SocketControlMessageClass">
37643 <doc xml:whitespace="preserve">Base class for socket-type specific control messages that can be sent and
37644 received over #GSocket.</doc>
37645 <function name="deserialize"
37646 c:identifier="g_socket_control_message_deserialize"
37648 <doc xml:whitespace="preserve">Tries to deserialize a socket control message of a given
37649 of #GSocketControlMessage if they can understand this kind
37650 of message and if so deserialize it into a #GSocketControlMessage.
37651 If there is no implementation for this kind of control message, %NULL
37652 will be returned.</doc>
37653 <return-value transfer-ownership="full">
37654 <doc xml:whitespace="preserve">the deserialized message or %NULL</doc>
37655 <type name="SocketControlMessage" c:type="GSocketControlMessage*"/>
37658 <parameter name="level" transfer-ownership="none">
37659 <doc xml:whitespace="preserve">a socket level</doc>
37660 <type name="gint" c:type="int"/>
37662 <parameter name="type" transfer-ownership="none">
37663 <doc xml:whitespace="preserve">a socket control message type for the given @level</doc>
37664 <type name="gint" c:type="int"/>
37666 <parameter name="size" transfer-ownership="none">
37667 <doc xml:whitespace="preserve">the size of the data in bytes</doc>
37668 <type name="gulong" c:type="gsize"/>
37670 <parameter name="data" transfer-ownership="none">
37671 <doc xml:whitespace="preserve">pointer to the message data</doc>
37672 <type name="gpointer" c:type="gpointer"/>
37676 <virtual-method name="get_level" invoker="get_level" version="2.22">
37677 <doc xml:whitespace="preserve">Returns the "level" (i.e. the originating protocol) of the control message.
37678 This is often SOL_SOCKET.</doc>
37679 <return-value transfer-ownership="none">
37680 <doc xml:whitespace="preserve">an integer describing the level</doc>
37681 <type name="gint" c:type="int"/>
37684 <virtual-method name="get_size" invoker="get_size" version="2.22">
37685 <doc xml:whitespace="preserve">Returns the space required for the control message, not including
37686 headers or alignment.</doc>
37687 <return-value transfer-ownership="none">
37688 <doc xml:whitespace="preserve">The number of bytes required.</doc>
37689 <type name="gulong" c:type="gsize"/>
37692 <virtual-method name="get_type">
37693 <return-value transfer-ownership="none">
37694 <type name="gint" c:type="int"/>
37697 <virtual-method name="serialize" invoker="serialize" version="2.22">
37698 <doc xml:whitespace="preserve">Converts the data in the message to bytes placed in the
37700 returned by g_socket_control_message_get_size() on this
37702 <return-value transfer-ownership="none">
37703 <type name="none" c:type="void"/>
37706 <parameter name="data" transfer-ownership="none">
37707 <doc xml:whitespace="preserve">A buffer to write data to</doc>
37708 <type name="gpointer" c:type="gpointer"/>
37712 <method name="get_level"
37713 c:identifier="g_socket_control_message_get_level"
37715 <doc xml:whitespace="preserve">Returns the "level" (i.e. the originating protocol) of the control message.
37716 This is often SOL_SOCKET.</doc>
37717 <return-value transfer-ownership="none">
37718 <doc xml:whitespace="preserve">an integer describing the level</doc>
37719 <type name="gint" c:type="int"/>
37722 <method name="get_msg_type"
37723 c:identifier="g_socket_control_message_get_msg_type"
37725 <doc xml:whitespace="preserve">Returns the protocol specific type of the control message.
37726 For instance, for UNIX fd passing this would be SCM_RIGHTS.</doc>
37727 <return-value transfer-ownership="none">
37728 <doc xml:whitespace="preserve">an integer describing the type of control message</doc>
37729 <type name="gint" c:type="int"/>
37732 <method name="get_size"
37733 c:identifier="g_socket_control_message_get_size"
37735 <doc xml:whitespace="preserve">Returns the space required for the control message, not including
37736 headers or alignment.</doc>
37737 <return-value transfer-ownership="none">
37738 <doc xml:whitespace="preserve">The number of bytes required.</doc>
37739 <type name="gulong" c:type="gsize"/>
37742 <method name="serialize"
37743 c:identifier="g_socket_control_message_serialize"
37745 <doc xml:whitespace="preserve">Converts the data in the message to bytes placed in the
37747 returned by g_socket_control_message_get_size() on this
37749 <return-value transfer-ownership="none">
37750 <type name="none" c:type="void"/>
37753 <parameter name="data" transfer-ownership="none">
37754 <doc xml:whitespace="preserve">A buffer to write data to</doc>
37755 <type name="gpointer" c:type="gpointer"/>
37759 <field name="parent_instance">
37760 <type name="GObject.Object" c:type="GObject"/>
37762 <field name="priv">
37763 <type name="SocketControlMessagePrivate"
37764 c:type="GSocketControlMessagePrivate*"/>
37767 <record name="SocketControlMessageClass"
37768 c:type="GSocketControlMessageClass"
37769 glib:is-gtype-struct-for="SocketControlMessage">
37770 <field name="parent_class">
37771 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
37773 <field name="get_size">
37774 <callback name="get_size">
37775 <return-value transfer-ownership="none">
37776 <doc xml:whitespace="preserve">The number of bytes required.</doc>
37777 <type name="gulong" c:type="gsize"/>
37780 <parameter name="message" transfer-ownership="none">
37781 <type name="SocketControlMessage"
37782 c:type="GSocketControlMessage*"/>
37787 <field name="get_level">
37788 <callback name="get_level">
37789 <return-value transfer-ownership="none">
37790 <doc xml:whitespace="preserve">an integer describing the level</doc>
37791 <type name="gint" c:type="int"/>
37794 <parameter name="message" transfer-ownership="none">
37795 <type name="SocketControlMessage"
37796 c:type="GSocketControlMessage*"/>
37801 <field name="get_type">
37802 <callback name="get_type">
37803 <return-value transfer-ownership="none">
37804 <type name="gint" c:type="int"/>
37807 <parameter name="message" transfer-ownership="none">
37808 <type name="SocketControlMessage"
37809 c:type="GSocketControlMessage*"/>
37814 <field name="serialize">
37815 <callback name="serialize">
37816 <return-value transfer-ownership="none">
37817 <type name="none" c:type="void"/>
37820 <parameter name="message" transfer-ownership="none">
37821 <type name="SocketControlMessage"
37822 c:type="GSocketControlMessage*"/>
37824 <parameter name="data" transfer-ownership="none">
37825 <doc xml:whitespace="preserve">A buffer to write data to</doc>
37826 <type name="gpointer" c:type="gpointer"/>
37831 <field name="deserialize" introspectable="0">
37832 <callback name="deserialize" introspectable="0">
37834 <type name="SocketControlMessage" c:type="GSocketControlMessage*"/>
37837 <parameter name="level" transfer-ownership="none">
37838 <type name="gint" c:type="int"/>
37840 <parameter name="type" transfer-ownership="none">
37841 <type name="gint" c:type="int"/>
37843 <parameter name="size" transfer-ownership="none">
37844 <type name="gulong" c:type="gsize"/>
37846 <parameter name="data" transfer-ownership="none">
37847 <type name="gpointer" c:type="gpointer"/>
37852 <field name="_g_reserved1" introspectable="0">
37853 <callback name="_g_reserved1">
37854 <return-value transfer-ownership="none">
37855 <type name="none" c:type="void"/>
37859 <field name="_g_reserved2" introspectable="0">
37860 <callback name="_g_reserved2">
37861 <return-value transfer-ownership="none">
37862 <type name="none" c:type="void"/>
37866 <field name="_g_reserved3" introspectable="0">
37867 <callback name="_g_reserved3">
37868 <return-value transfer-ownership="none">
37869 <type name="none" c:type="void"/>
37873 <field name="_g_reserved4" introspectable="0">
37874 <callback name="_g_reserved4">
37875 <return-value transfer-ownership="none">
37876 <type name="none" c:type="void"/>
37880 <field name="_g_reserved5" introspectable="0">
37881 <callback name="_g_reserved5">
37882 <return-value transfer-ownership="none">
37883 <type name="none" c:type="void"/>
37888 <record name="SocketControlMessagePrivate"
37889 c:type="GSocketControlMessagePrivate"
37892 <enumeration name="SocketFamily"
37894 glib:type-name="GSocketFamily"
37895 glib:get-type="g_socket_family_get_type"
37896 c:type="GSocketFamily">
37897 <doc xml:whitespace="preserve">The protocol family of a #GSocketAddress. (These values are
37898 identical to the system defines %AF_INET, %AF_INET6 and %AF_UNIX,
37899 if available.)</doc>
37900 <member name="invalid"
37902 c:identifier="G_SOCKET_FAMILY_INVALID"
37903 glib:nick="invalid"/>
37904 <member name="unix"
37906 c:identifier="G_SOCKET_FAMILY_UNIX"
37908 <member name="ipv4"
37910 c:identifier="G_SOCKET_FAMILY_IPV4"
37912 <member name="ipv6"
37914 c:identifier="G_SOCKET_FAMILY_IPV6"
37917 <class name="SocketListener"
37918 c:symbol-prefix="socket_listener"
37919 c:type="GSocketListener"
37920 parent="GObject.Object"
37921 glib:type-name="GSocketListener"
37922 glib:get-type="g_socket_listener_get_type"
37923 glib:type-struct="SocketListenerClass">
37924 <constructor name="new"
37925 c:identifier="g_socket_listener_new"
37927 <doc xml:whitespace="preserve">Creates a new #GSocketListener with no sockets to listen for.
37928 New listeners can be added with e.g. g_socket_listener_add_address()
37929 or g_socket_listener_add_inet_port().</doc>
37930 <return-value transfer-ownership="full">
37931 <doc xml:whitespace="preserve">a new #GSocketListener.</doc>
37932 <type name="SocketListener" c:type="GSocketListener*"/>
37935 <virtual-method name="changed">
37936 <return-value transfer-ownership="none">
37937 <type name="none" c:type="void"/>
37940 <method name="accept"
37941 c:identifier="g_socket_listener_accept"
37944 <doc xml:whitespace="preserve">Blocks waiting for a client to connect to any of the sockets added
37945 to the listener. Returns a #GSocketConnection for the socket that was
37947 If @source_object is not %NULL it will be filled out with the source
37948 object specified when the corresponding socket or address was added
37950 If @cancellable is not %NULL, then the operation can be cancelled by
37951 triggering the cancellable object from another thread. If the operation
37952 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
37953 <return-value transfer-ownership="full">
37954 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
37955 <type name="SocketConnection" c:type="GSocketConnection*"/>
37958 <parameter name="source_object"
37960 caller-allocates="0"
37961 transfer-ownership="none"
37963 <doc xml:whitespace="preserve">location where #GObject pointer will be stored, or %NULL</doc>
37964 <type name="GObject.Object" c:type="GObject**"/>
37966 <parameter name="cancellable"
37967 transfer-ownership="none"
37969 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
37970 <type name="Cancellable" c:type="GCancellable*"/>
37974 <method name="accept_async"
37975 c:identifier="g_socket_listener_accept_async"
37977 <doc xml:whitespace="preserve">This is the asynchronous version of g_socket_listener_accept().
37978 When the operation is finished @callback will be
37979 called. You can then call g_socket_listener_accept_socket()
37980 to get the result of the operation.</doc>
37981 <return-value transfer-ownership="none">
37982 <type name="none" c:type="void"/>
37985 <parameter name="cancellable"
37986 transfer-ownership="none"
37988 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
37989 <type name="Cancellable" c:type="GCancellable*"/>
37991 <parameter name="callback"
37992 transfer-ownership="none"
37995 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
37996 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
37998 <parameter name="user_data" transfer-ownership="none">
37999 <doc xml:whitespace="preserve">user data for the callback</doc>
38000 <type name="gpointer" c:type="gpointer"/>
38004 <method name="accept_finish"
38005 c:identifier="g_socket_listener_accept_finish"
38008 <doc xml:whitespace="preserve">Finishes an async accept operation. See g_socket_listener_accept_async()</doc>
38009 <return-value transfer-ownership="full">
38010 <doc xml:whitespace="preserve">a #GSocketConnection on success, %NULL on error.</doc>
38011 <type name="SocketConnection" c:type="GSocketConnection*"/>
38014 <parameter name="result" transfer-ownership="none">
38015 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
38016 <type name="AsyncResult" c:type="GAsyncResult*"/>
38018 <parameter name="source_object" transfer-ownership="none">
38019 <doc xml:whitespace="preserve">Optional #GObject identifying this source</doc>
38020 <type name="GObject.Object" c:type="GObject**"/>
38024 <method name="accept_socket"
38025 c:identifier="g_socket_listener_accept_socket"
38028 <doc xml:whitespace="preserve">Blocks waiting for a client to connect to any of the sockets added
38029 to the listener. Returns the #GSocket that was accepted.
38030 If you want to accept the high-level #GSocketConnection, not a #GSocket,
38031 which is often the case, then you should use g_socket_listener_accept()
38033 If @source_object is not %NULL it will be filled out with the source
38034 object specified when the corresponding socket or address was added
38036 If @cancellable is not %NULL, then the operation can be cancelled by
38037 triggering the cancellable object from another thread. If the operation
38038 was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.</doc>
38039 <return-value transfer-ownership="full">
38040 <doc xml:whitespace="preserve">a #GSocket on success, %NULL on error.</doc>
38041 <type name="Socket" c:type="GSocket*"/>
38044 <parameter name="source_object"
38046 caller-allocates="0"
38047 transfer-ownership="none"
38049 <doc xml:whitespace="preserve">location where #GObject pointer will be stored, or %NULL.</doc>
38050 <type name="GObject.Object" c:type="GObject**"/>
38052 <parameter name="cancellable"
38053 transfer-ownership="none"
38055 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
38056 <type name="Cancellable" c:type="GCancellable*"/>
38060 <method name="accept_socket_async"
38061 c:identifier="g_socket_listener_accept_socket_async"
38063 <doc xml:whitespace="preserve">This is the asynchronous version of g_socket_listener_accept_socket().
38064 When the operation is finished @callback will be
38065 called. You can then call g_socket_listener_accept_socket_finish()
38066 to get the result of the operation.</doc>
38067 <return-value transfer-ownership="none">
38068 <type name="none" c:type="void"/>
38071 <parameter name="cancellable"
38072 transfer-ownership="none"
38074 <doc xml:whitespace="preserve">a #GCancellable, or %NULL</doc>
38075 <type name="Cancellable" c:type="GCancellable*"/>
38077 <parameter name="callback"
38078 transfer-ownership="none"
38081 <doc xml:whitespace="preserve">a #GAsyncReadyCallback</doc>
38082 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
38084 <parameter name="user_data" transfer-ownership="none">
38085 <doc xml:whitespace="preserve">user data for the callback</doc>
38086 <type name="gpointer" c:type="gpointer"/>
38090 <method name="accept_socket_finish"
38091 c:identifier="g_socket_listener_accept_socket_finish"
38094 <doc xml:whitespace="preserve">Finishes an async accept operation. See g_socket_listener_accept_socket_async()</doc>
38095 <return-value transfer-ownership="full">
38096 <doc xml:whitespace="preserve">a #GSocket on success, %NULL on error.</doc>
38097 <type name="Socket" c:type="GSocket*"/>
38100 <parameter name="result" transfer-ownership="none">
38101 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
38102 <type name="AsyncResult" c:type="GAsyncResult*"/>
38104 <parameter name="source_object" transfer-ownership="none">
38105 <doc xml:whitespace="preserve">Optional #GObject identifying this source</doc>
38106 <type name="GObject.Object" c:type="GObject**"/>
38110 <method name="add_address"
38111 c:identifier="g_socket_listener_add_address"
38114 <doc xml:whitespace="preserve">Creates a socket of type @type and protocol @protocol, binds
38115 it to @address and adds it to the set of sockets we're accepting
38117 Note that adding an IPv6 address, depending on the platform,
38118 may or may not result in a listener that also accepts IPv4
38119 connections. For more determinstic behaviour, see
38120 g_socket_listener_add_inet_port().
38121 to accept to identify this particular source, which is
38122 useful if you're listening on multiple addresses and do
38123 different things depending on what address is connected to.
38124 If successful and @effective_address is non-%NULL then it will
38125 be set to the address that the binding actually occured at. This
38126 is helpful for determining the port number that was used for when
38127 requested, belongs to the caller and must be freed.</doc>
38128 <return-value transfer-ownership="none">
38129 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
38130 <type name="gboolean" c:type="gboolean"/>
38133 <parameter name="address" transfer-ownership="none">
38134 <doc xml:whitespace="preserve">a #GSocketAddress</doc>
38135 <type name="SocketAddress" c:type="GSocketAddress*"/>
38137 <parameter name="type" transfer-ownership="none">
38138 <doc xml:whitespace="preserve">a #GSocketType</doc>
38139 <type name="SocketType" c:type="GSocketType"/>
38141 <parameter name="protocol" transfer-ownership="none">
38142 <doc xml:whitespace="preserve">a #GSocketProtocol</doc>
38143 <type name="SocketProtocol" c:type="GSocketProtocol"/>
38145 <parameter name="source_object" transfer-ownership="none">
38146 <doc xml:whitespace="preserve">Optional #GObject identifying this source</doc>
38147 <type name="GObject.Object" c:type="GObject*"/>
38149 <parameter name="effective_address"
38151 caller-allocates="0"
38152 transfer-ownership="full"
38154 <doc xml:whitespace="preserve">location to store the address that was bound to, or %NULL.</doc>
38155 <type name="SocketAddress" c:type="GSocketAddress**"/>
38159 <method name="add_any_inet_port"
38160 c:identifier="g_socket_listener_add_any_inet_port"
38163 <doc xml:whitespace="preserve">Listens for TCP connections on any available port number for both
38164 IPv6 and IPv4 (if each are available).
38165 This is useful if you need to have a socket for incoming connections
38166 but don't care about the specific port number.
38167 to accept to identify this particular source, which is
38168 useful if you're listening on multiple addresses and do
38169 different things depending on what address is connected to.</doc>
38170 <return-value transfer-ownership="none">
38171 <doc xml:whitespace="preserve">the port number, or 0 in case of failure.</doc>
38172 <type name="guint16" c:type="guint16"/>
38175 <parameter name="source_object" transfer-ownership="none">
38176 <doc xml:whitespace="preserve">Optional #GObject identifying this source</doc>
38177 <type name="GObject.Object" c:type="GObject*"/>
38181 <method name="add_inet_port"
38182 c:identifier="g_socket_listener_add_inet_port"
38185 <doc xml:whitespace="preserve">Helper function for g_socket_listener_add_address() that
38186 creates a TCP/IP socket listening on IPv4 and IPv6 (if
38187 supported) on the specified port on all interfaces.
38188 to accept to identify this particular source, which is
38189 useful if you're listening on multiple addresses and do
38190 different things depending on what address is connected to.</doc>
38191 <return-value transfer-ownership="none">
38192 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
38193 <type name="gboolean" c:type="gboolean"/>
38196 <parameter name="port" transfer-ownership="none">
38197 <doc xml:whitespace="preserve">an IP port number (non-zero)</doc>
38198 <type name="guint16" c:type="guint16"/>
38200 <parameter name="source_object" transfer-ownership="none">
38201 <doc xml:whitespace="preserve">Optional #GObject identifying this source</doc>
38202 <type name="GObject.Object" c:type="GObject*"/>
38206 <method name="add_socket"
38207 c:identifier="g_socket_listener_add_socket"
38210 <doc xml:whitespace="preserve">Adds @socket to the set of sockets that we try to accept
38211 new clients from. The socket must be bound to a local
38212 address and listened to.
38213 to accept to identify this particular source, which is
38214 useful if you're listening on multiple addresses and do
38215 different things depending on what address is connected to.</doc>
38216 <return-value transfer-ownership="none">
38217 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
38218 <type name="gboolean" c:type="gboolean"/>
38221 <parameter name="socket" transfer-ownership="none">
38222 <doc xml:whitespace="preserve">a listening #GSocket</doc>
38223 <type name="Socket" c:type="GSocket*"/>
38225 <parameter name="source_object" transfer-ownership="none">
38226 <doc xml:whitespace="preserve">Optional #GObject identifying this source</doc>
38227 <type name="GObject.Object" c:type="GObject*"/>
38231 <method name="close"
38232 c:identifier="g_socket_listener_close"
38234 <doc xml:whitespace="preserve">Closes all the sockets in the listener.</doc>
38235 <return-value transfer-ownership="none">
38236 <type name="none" c:type="void"/>
38239 <method name="set_backlog"
38240 c:identifier="g_socket_listener_set_backlog"
38242 <doc xml:whitespace="preserve">Sets the listen backlog on the sockets in the listener.
38243 See g_socket_set_listen_backlog() for details</doc>
38244 <return-value transfer-ownership="none">
38245 <type name="none" c:type="void"/>
38248 <parameter name="listen_backlog" transfer-ownership="none">
38249 <doc xml:whitespace="preserve">an integer</doc>
38250 <type name="gint" c:type="int"/>
38254 <property name="listen-backlog"
38257 transfer-ownership="none">
38258 <type name="gint"/>
38260 <field name="parent_instance">
38261 <type name="GObject.Object" c:type="GObject"/>
38263 <field name="priv">
38264 <type name="SocketListenerPrivate" c:type="GSocketListenerPrivate*"/>
38267 <record name="SocketListenerClass"
38268 c:type="GSocketListenerClass"
38269 glib:is-gtype-struct-for="SocketListener">
38270 <field name="parent_class">
38271 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
38273 <field name="changed">
38274 <callback name="changed">
38275 <return-value transfer-ownership="none">
38276 <type name="none" c:type="void"/>
38279 <parameter name="listener" transfer-ownership="none">
38280 <type name="SocketListener" c:type="GSocketListener*"/>
38285 <field name="_g_reserved1" introspectable="0">
38286 <callback name="_g_reserved1">
38287 <return-value transfer-ownership="none">
38288 <type name="none" c:type="void"/>
38292 <field name="_g_reserved2" introspectable="0">
38293 <callback name="_g_reserved2">
38294 <return-value transfer-ownership="none">
38295 <type name="none" c:type="void"/>
38299 <field name="_g_reserved3" introspectable="0">
38300 <callback name="_g_reserved3">
38301 <return-value transfer-ownership="none">
38302 <type name="none" c:type="void"/>
38306 <field name="_g_reserved4" introspectable="0">
38307 <callback name="_g_reserved4">
38308 <return-value transfer-ownership="none">
38309 <type name="none" c:type="void"/>
38313 <field name="_g_reserved5" introspectable="0">
38314 <callback name="_g_reserved5">
38315 <return-value transfer-ownership="none">
38316 <type name="none" c:type="void"/>
38320 <field name="_g_reserved6" introspectable="0">
38321 <callback name="_g_reserved6">
38322 <return-value transfer-ownership="none">
38323 <type name="none" c:type="void"/>
38328 <record name="SocketListenerPrivate"
38329 c:type="GSocketListenerPrivate"
38332 <enumeration name="SocketMsgFlags"
38334 glib:type-name="GSocketMsgFlags"
38335 glib:get-type="g_socket_msg_flags_get_type"
38336 c:type="GSocketMsgFlags">
38337 <doc xml:whitespace="preserve">Flags used in g_socket_receive_message() and g_socket_send_message().
38338 The flags listed in the enum are some commonly available flags, but the
38339 values used for them are the same as on the platform, and any other flags
38340 are passed in/out as is. So to use a platform specific flag, just include
38341 the right system header and pass in the flag.</doc>
38342 <member name="none"
38344 c:identifier="G_SOCKET_MSG_NONE"
38348 c:identifier="G_SOCKET_MSG_OOB"
38350 <member name="peek"
38352 c:identifier="G_SOCKET_MSG_PEEK"
38354 <member name="dontroute"
38356 c:identifier="G_SOCKET_MSG_DONTROUTE"
38357 glib:nick="dontroute"/>
38359 <record name="SocketPrivate" c:type="GSocketPrivate" disguised="1">
38361 <enumeration name="SocketProtocol"
38363 glib:type-name="GSocketProtocol"
38364 glib:get-type="g_socket_protocol_get_type"
38365 c:type="GSocketProtocol">
38366 <doc xml:whitespace="preserve">A protocol identifier is specified when creating a #GSocket, which is a
38367 family/type specific identifier, where 0 means the default protocol for
38368 the particular family/type.
38369 This enum contains a set of commonly available and used protocols. You
38370 can also pass any other identifiers handled by the platform in order to
38371 use protocols not listed here.</doc>
38372 <member name="unknown"
38374 c:identifier="G_SOCKET_PROTOCOL_UNKNOWN"
38375 glib:nick="unknown"/>
38376 <member name="default"
38378 c:identifier="G_SOCKET_PROTOCOL_DEFAULT"
38379 glib:nick="default"/>
38382 c:identifier="G_SOCKET_PROTOCOL_TCP"
38386 c:identifier="G_SOCKET_PROTOCOL_UDP"
38388 <member name="sctp"
38390 c:identifier="G_SOCKET_PROTOCOL_SCTP"
38393 <class name="SocketService"
38394 c:symbol-prefix="socket_service"
38395 c:type="GSocketService"
38397 parent="SocketListener"
38398 glib:type-name="GSocketService"
38399 glib:get-type="g_socket_service_get_type"
38400 glib:type-struct="SocketServiceClass">
38401 <doc xml:whitespace="preserve">A helper class for handling accepting incomming connections in the
38402 glib mainloop.</doc>
38403 <constructor name="new"
38404 c:identifier="g_socket_service_new"
38406 <doc xml:whitespace="preserve">Creates a new #GSocketService with no sockets to listen for.
38407 New listeners can be added with e.g. g_socket_listener_add_address()
38408 or g_socket_listener_add_inet_port().</doc>
38409 <return-value transfer-ownership="full">
38410 <doc xml:whitespace="preserve">a new #GSocketService.</doc>
38411 <type name="SocketService" c:type="GSocketService*"/>
38414 <method name="is_active"
38415 c:identifier="g_socket_service_is_active"
38417 <doc xml:whitespace="preserve">Check whether the service is active or not. An active
38418 service will accept new clients that connect, while
38419 a non-active service will let connecting clients queue
38420 up until the service is started.</doc>
38421 <return-value transfer-ownership="none">
38422 <doc xml:whitespace="preserve">%TRUE if the service is active, %FALSE otherwise</doc>
38423 <type name="gboolean" c:type="gboolean"/>
38426 <method name="start"
38427 c:identifier="g_socket_service_start"
38429 <doc xml:whitespace="preserve">Starts the service, i.e. start accepting connections
38430 from the added sockets when the mainloop runs.
38431 This call is threadsafe, so it may be called from a thread
38432 handling an incomming client request.</doc>
38433 <return-value transfer-ownership="none">
38434 <type name="none" c:type="void"/>
38437 <method name="stop" c:identifier="g_socket_service_stop" version="2.22">
38438 <doc xml:whitespace="preserve">Stops the service, i.e. stops accepting connections
38439 from the added sockets when the mainloop runs.
38440 This call is threadsafe, so it may be called from a thread
38441 handling an incomming client request.</doc>
38442 <return-value transfer-ownership="none">
38443 <type name="none" c:type="void"/>
38446 <field name="parent_instance">
38447 <type name="SocketListener" c:type="GSocketListener"/>
38449 <field name="priv">
38450 <type name="SocketServicePrivate" c:type="GSocketServicePrivate*"/>
38452 <glib:signal name="incoming" version="2.22">
38453 <doc xml:whitespace="preserve">The ::incoming signal is emitted when a new incoming connection
38454 to @service needs to be handled. The handler must initiate the
38455 handling of @connection, but may not block; in essence,
38456 asynchronous operations must be used.</doc>
38457 <return-value transfer-ownership="none">
38458 <doc xml:whitespace="preserve">%TRUE to stop other handlers from being called</doc>
38459 <type name="gboolean"/>
38462 <parameter name="object" transfer-ownership="none">
38463 <doc xml:whitespace="preserve">a new #GSocketConnection object.</doc>
38464 <type name="SocketConnection"/>
38466 <parameter name="p0" transfer-ownership="none">
38467 <doc xml:whitespace="preserve">the source_object passed to g_socket_listener_add_address().</doc>
38468 <type name="GObject.Object"/>
38473 <record name="SocketServiceClass"
38474 c:type="GSocketServiceClass"
38475 glib:is-gtype-struct-for="SocketService">
38476 <field name="parent_class">
38477 <type name="SocketListenerClass" c:type="GSocketListenerClass"/>
38479 <field name="incoming">
38480 <callback name="incoming">
38481 <return-value transfer-ownership="none">
38482 <type name="gboolean" c:type="gboolean"/>
38485 <parameter name="service" transfer-ownership="none">
38486 <type name="SocketService" c:type="GSocketService*"/>
38488 <parameter name="connection" transfer-ownership="none">
38489 <type name="SocketConnection" c:type="GSocketConnection*"/>
38491 <parameter name="source_object" transfer-ownership="none">
38492 <type name="GObject.Object" c:type="GObject*"/>
38497 <field name="_g_reserved1" introspectable="0">
38498 <callback name="_g_reserved1">
38499 <return-value transfer-ownership="none">
38500 <type name="none" c:type="void"/>
38504 <field name="_g_reserved2" introspectable="0">
38505 <callback name="_g_reserved2">
38506 <return-value transfer-ownership="none">
38507 <type name="none" c:type="void"/>
38511 <field name="_g_reserved3" introspectable="0">
38512 <callback name="_g_reserved3">
38513 <return-value transfer-ownership="none">
38514 <type name="none" c:type="void"/>
38518 <field name="_g_reserved4" introspectable="0">
38519 <callback name="_g_reserved4">
38520 <return-value transfer-ownership="none">
38521 <type name="none" c:type="void"/>
38525 <field name="_g_reserved5" introspectable="0">
38526 <callback name="_g_reserved5">
38527 <return-value transfer-ownership="none">
38528 <type name="none" c:type="void"/>
38532 <field name="_g_reserved6" introspectable="0">
38533 <callback name="_g_reserved6">
38534 <return-value transfer-ownership="none">
38535 <type name="none" c:type="void"/>
38540 <record name="SocketServicePrivate"
38541 c:type="GSocketServicePrivate"
38544 <callback name="SocketSourceFunc"
38545 c:type="GSocketSourceFunc"
38547 <doc xml:whitespace="preserve">This is the function type of the callback used for the #GSource
38548 returned by g_socket_create_source().</doc>
38549 <return-value transfer-ownership="none">
38550 <doc xml:whitespace="preserve">it should return %FALSE if the source should be removed.</doc>
38551 <type name="gboolean" c:type="gboolean"/>
38554 <parameter name="socket" transfer-ownership="none">
38555 <doc xml:whitespace="preserve">the #GSocket</doc>
38556 <type name="Socket" c:type="GSocket*"/>
38558 <parameter name="condition" transfer-ownership="none">
38559 <doc xml:whitespace="preserve">the current condition at the source fired.</doc>
38560 <type name="GLib.IOCondition" c:type="GIOCondition"/>
38562 <parameter name="user_data" transfer-ownership="none" closure="2">
38563 <doc xml:whitespace="preserve">data passed in by the user.</doc>
38564 <type name="gpointer" c:type="gpointer"/>
38568 <enumeration name="SocketType"
38570 glib:type-name="GSocketType"
38571 glib:get-type="g_socket_type_get_type"
38572 c:type="GSocketType">
38573 <doc xml:whitespace="preserve">Flags used when creating a #GSocket. Some protocols may not implement
38574 all the socket types.</doc>
38575 <member name="invalid"
38577 c:identifier="G_SOCKET_TYPE_INVALID"
38578 glib:nick="invalid"/>
38579 <member name="stream"
38581 c:identifier="G_SOCKET_TYPE_STREAM"
38582 glib:nick="stream"/>
38583 <member name="datagram"
38585 c:identifier="G_SOCKET_TYPE_DATAGRAM"
38586 glib:nick="datagram"/>
38587 <member name="seqpacket"
38589 c:identifier="G_SOCKET_TYPE_SEQPACKET"
38590 glib:nick="seqpacket"/>
38592 <record name="SrvTarget"
38593 c:type="GSrvTarget"
38594 glib:type-name="GSrvTarget"
38595 glib:get-type="g_srv_target_get_type"
38596 c:symbol-prefix="srv_target">
38597 <doc xml:whitespace="preserve">A single target host/port that a network service is running on.</doc>
38598 <constructor name="new" c:identifier="g_srv_target_new" version="2.22">
38599 <doc xml:whitespace="preserve">Creates a new #GSrvTarget with the given parameters.
38600 You should not need to use this; normally #GSrvTarget<!-- -->s are
38601 created by #GResolver.</doc>
38602 <return-value transfer-ownership="full">
38603 <doc xml:whitespace="preserve">a new #GSrvTarget.</doc>
38604 <type name="SrvTarget" c:type="GSrvTarget*"/>
38607 <parameter name="hostname" transfer-ownership="none">
38608 <doc xml:whitespace="preserve">the host that the service is running on</doc>
38609 <type name="utf8" c:type="gchar*"/>
38611 <parameter name="port" transfer-ownership="none">
38612 <doc xml:whitespace="preserve">the port that the service is running on</doc>
38613 <type name="guint16" c:type="guint16"/>
38615 <parameter name="priority" transfer-ownership="none">
38616 <doc xml:whitespace="preserve">the target's priority</doc>
38617 <type name="guint16" c:type="guint16"/>
38619 <parameter name="weight" transfer-ownership="none">
38620 <doc xml:whitespace="preserve">the target's weight</doc>
38621 <type name="guint16" c:type="guint16"/>
38625 <method name="copy" c:identifier="g_srv_target_copy" version="2.22">
38626 <doc xml:whitespace="preserve">Copies @target</doc>
38627 <return-value transfer-ownership="full">
38628 <doc xml:whitespace="preserve">a copy of @target</doc>
38629 <type name="SrvTarget" c:type="GSrvTarget*"/>
38632 <method name="free" c:identifier="g_srv_target_free" version="2.22">
38633 <doc xml:whitespace="preserve">Frees @target</doc>
38634 <return-value transfer-ownership="none">
38635 <type name="none" c:type="void"/>
38638 <method name="get_hostname"
38639 c:identifier="g_srv_target_get_hostname"
38641 <doc xml:whitespace="preserve">Gets @target's hostname (in ASCII form; if you are going to present
38642 this to the user, you should use g_hostname_is_ascii_encoded() to
38643 check if it contains encoded Unicode segments, and use
38644 g_hostname_to_unicode() to convert it if it does.)</doc>
38645 <return-value transfer-ownership="none">
38646 <doc xml:whitespace="preserve">@target's hostname</doc>
38647 <type name="utf8" c:type="gchar*"/>
38650 <method name="get_port"
38651 c:identifier="g_srv_target_get_port"
38653 <doc xml:whitespace="preserve">Gets @target's port</doc>
38654 <return-value transfer-ownership="none">
38655 <doc xml:whitespace="preserve">@target's port</doc>
38656 <type name="guint16" c:type="guint16"/>
38659 <method name="get_priority"
38660 c:identifier="g_srv_target_get_priority"
38662 <doc xml:whitespace="preserve">Gets @target's priority. You should not need to look at this;
38663 #GResolver already sorts the targets according to the algorithm in
38665 <return-value transfer-ownership="none">
38666 <doc xml:whitespace="preserve">@target's priority</doc>
38667 <type name="guint16" c:type="guint16"/>
38670 <method name="get_weight"
38671 c:identifier="g_srv_target_get_weight"
38673 <doc xml:whitespace="preserve">Gets @target's weight. You should not need to look at this;
38674 #GResolver already sorts the targets according to the algorithm in
38676 <return-value transfer-ownership="none">
38677 <doc xml:whitespace="preserve">@target's weight</doc>
38678 <type name="guint16" c:type="guint16"/>
38682 <class name="TcpConnection"
38683 c:symbol-prefix="tcp_connection"
38684 c:type="GTcpConnection"
38686 parent="SocketConnection"
38687 glib:type-name="GTcpConnection"
38688 glib:get-type="g_tcp_connection_get_type"
38689 glib:type-struct="TcpConnectionClass">
38690 <doc xml:whitespace="preserve">A #GSocketConnection for UNIX domain socket connections.</doc>
38691 <method name="get_graceful_disconnect"
38692 c:identifier="g_tcp_connection_get_graceful_disconnect"
38694 <doc xml:whitespace="preserve">Checks if graceful disconnects are used. See
38695 g_tcp_connection_set_graceful_disconnect().</doc>
38696 <return-value transfer-ownership="none">
38697 <doc xml:whitespace="preserve">%TRUE if graceful disconnect is used on close, %FALSE otherwise</doc>
38698 <type name="gboolean" c:type="gboolean"/>
38701 <method name="set_graceful_disconnect"
38702 c:identifier="g_tcp_connection_set_graceful_disconnect"
38704 <doc xml:whitespace="preserve">This enabled graceful disconnects on close. A graceful disconnect
38705 means that we signal the recieving end that the connection is terminated
38706 and wait for it to close the connection before closing the connection.
38707 A graceful disconnect means that we can be sure that we successfully sent
38708 all the outstanding data to the other end, or get an error reported.
38709 However, it also means we have to wait for all the data to reach the
38710 other side and for it to acknowledge this by closing the socket, which may
38711 take a while. For this reason it is disabled by default.</doc>
38712 <return-value transfer-ownership="none">
38713 <type name="none" c:type="void"/>
38716 <parameter name="graceful_disconnect" transfer-ownership="none">
38717 <doc xml:whitespace="preserve">Whether to do graceful disconnects or not</doc>
38718 <type name="gboolean" c:type="gboolean"/>
38722 <property name="graceful-disconnect"
38724 transfer-ownership="none">
38725 <type name="gboolean"/>
38727 <field name="parent_instance">
38728 <type name="SocketConnection" c:type="GSocketConnection"/>
38730 <field name="priv">
38731 <type name="TcpConnectionPrivate" c:type="GTcpConnectionPrivate*"/>
38734 <record name="TcpConnectionClass"
38735 c:type="GTcpConnectionClass"
38736 glib:is-gtype-struct-for="TcpConnection">
38737 <field name="parent_class">
38738 <type name="SocketConnectionClass" c:type="GSocketConnectionClass"/>
38741 <record name="TcpConnectionPrivate"
38742 c:type="GTcpConnectionPrivate"
38745 <class name="ThemedIcon"
38746 c:symbol-prefix="themed_icon"
38747 c:type="GThemedIcon"
38748 parent="GObject.Object"
38749 glib:type-name="GThemedIcon"
38750 glib:get-type="g_themed_icon_get_type"
38751 glib:type-struct="ThemedIconClass">
38752 <doc xml:whitespace="preserve">An implementation of #GIcon for themed icons.</doc>
38753 <implements name="Icon"/>
38754 <function name="new" c:identifier="g_themed_icon_new">
38755 <doc xml:whitespace="preserve">Creates a new themed icon for @iconname.</doc>
38756 <return-value transfer-ownership="full">
38757 <doc xml:whitespace="preserve">a new #GThemedIcon.</doc>
38758 <type name="Icon" c:type="GIcon*"/>
38761 <parameter name="iconname" transfer-ownership="none">
38762 <doc xml:whitespace="preserve">a string containing an icon name.</doc>
38763 <type name="utf8" c:type="char*"/>
38767 <function name="new_from_names"
38768 c:identifier="g_themed_icon_new_from_names">
38769 <doc xml:whitespace="preserve">Creates a new themed icon for @iconnames.</doc>
38770 <return-value transfer-ownership="full">
38771 <doc xml:whitespace="preserve">a new #GThemedIcon</doc>
38772 <type name="Icon" c:type="GIcon*"/>
38775 <parameter name="iconnames" transfer-ownership="none">
38776 <doc xml:whitespace="preserve">an array of strings containing icon names.</doc>
38777 <type name="utf8" c:type="char**"/>
38779 <parameter name="len" transfer-ownership="none">
38780 <doc xml:whitespace="preserve">the length of the @iconnames array, or -1 if @iconnames is %NULL-terminated</doc>
38781 <type name="gint" c:type="int"/>
38785 <function name="new_with_default_fallbacks"
38786 c:identifier="g_themed_icon_new_with_default_fallbacks">
38787 <doc xml:whitespace="preserve">Creates a new themed icon for @iconname, and all the names
38788 that can be created by shortening @iconname at '-' characters.
38789 In the following example, @icon1 and @icon2 are equivalent:
38791 const char *names[] = {
38792 "gnome-dev-cdrom-audio",
38797 icon1 = g_themed_icon_new_from_names (names, 4);
38798 icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
38800 <return-value transfer-ownership="full">
38801 <doc xml:whitespace="preserve">a new #GThemedIcon.</doc>
38802 <type name="Icon" c:type="GIcon*"/>
38805 <parameter name="iconname" transfer-ownership="none">
38806 <doc xml:whitespace="preserve">a string containing an icon name</doc>
38807 <type name="utf8" c:type="char*"/>
38811 <method name="append_name" c:identifier="g_themed_icon_append_name">
38812 <doc xml:whitespace="preserve">Append a name to the list of icons from within @icon.
38813 <note><para>
38814 Note that doing so invalidates the hash computed by prior calls
38816 </para></note></doc>
38817 <return-value transfer-ownership="none">
38818 <type name="none" c:type="void"/>
38821 <parameter name="iconname" transfer-ownership="none">
38822 <doc xml:whitespace="preserve">name of icon to append to list of icons from within @icon.</doc>
38823 <type name="utf8" c:type="char*"/>
38827 <method name="get_names" c:identifier="g_themed_icon_get_names">
38828 <doc xml:whitespace="preserve">Gets the names of icons from within @icon.</doc>
38829 <return-value transfer-ownership="full">
38830 <doc xml:whitespace="preserve">a list of icon names.</doc>
38831 <array c:type="gchar**">
38832 <type name="utf8"/>
38836 <method name="prepend_name"
38837 c:identifier="g_themed_icon_prepend_name"
38839 <doc xml:whitespace="preserve">Prepend a name to the list of icons from within @icon.
38840 <note><para>
38841 Note that doing so invalidates the hash computed by prior calls
38843 </para></note></doc>
38844 <return-value transfer-ownership="none">
38845 <type name="none" c:type="void"/>
38848 <parameter name="iconname" transfer-ownership="none">
38849 <doc xml:whitespace="preserve">name of icon to prepend to list of icons from within @icon.</doc>
38850 <type name="utf8" c:type="char*"/>
38854 <property name="name"
38858 transfer-ownership="none">
38859 <doc xml:whitespace="preserve">The icon name.</doc>
38860 <type name="utf8"/>
38862 <property name="names"
38866 transfer-ownership="none">
38867 <doc xml:whitespace="preserve">A %NULL-terminated array of icon names.</doc>
38870 <property name="use-default-fallbacks"
38873 transfer-ownership="none">
38874 <doc xml:whitespace="preserve">Whether to use the default fallbacks found by shortening the icon name
38875 at '-' characters. If the "names" array has more than one element,
38876 ignores any past the first.
38877 For example, if the icon name was "gnome-dev-cdrom-audio", the array
38881 "gnome-dev-cdrom-audio",
38888 <type name="gboolean"/>
38891 <record name="ThemedIconClass"
38892 c:type="GThemedIconClass"
38894 glib:is-gtype-struct-for="ThemedIcon">
38896 <class name="ThreadedSocketService"
38897 c:symbol-prefix="threaded_socket_service"
38898 c:type="GThreadedSocketService"
38900 parent="SocketService"
38901 glib:type-name="GThreadedSocketService"
38902 glib:get-type="g_threaded_socket_service_get_type"
38903 glib:type-struct="ThreadedSocketServiceClass">
38904 <doc xml:whitespace="preserve">A helper class for handling accepting incomming connections in the
38905 glib mainloop and handling them in a thread.</doc>
38906 <constructor name="new"
38907 c:identifier="g_threaded_socket_service_new"
38909 <doc xml:whitespace="preserve">Creates a new #GThreadedSocketService with no listeners. Listeners
38910 must be added with g_socket_service_add_listeners().</doc>
38911 <return-value transfer-ownership="full">
38912 <doc xml:whitespace="preserve">a new #GSocketService.</doc>
38913 <type name="SocketService" c:type="GSocketService*"/>
38916 <parameter name="max_threads" transfer-ownership="none">
38917 <doc xml:whitespace="preserve">the maximal number of threads to execute concurrently handling incoming clients, -1 means no limit</doc>
38918 <type name="gint" c:type="int"/>
38922 <property name="max-threads"
38925 transfer-ownership="none">
38926 <type name="gint"/>
38928 <field name="parent_instance">
38929 <type name="SocketService" c:type="GSocketService"/>
38931 <field name="priv">
38932 <type name="ThreadedSocketServicePrivate"
38933 c:type="GThreadedSocketServicePrivate*"/>
38935 <glib:signal name="run">
38936 <doc xml:whitespace="preserve">The ::run signal is emitted in a worker thread in response to an
38937 incoming connection. This thread is dedicated to handling
38938 not return until the connection is closed.</doc>
38939 <return-value transfer-ownership="none">
38940 <doc xml:whitespace="preserve">%TRUE to stope further signal handlers from being called</doc>
38941 <type name="gboolean"/>
38944 <parameter name="object" transfer-ownership="none">
38945 <doc xml:whitespace="preserve">a new #GSocketConnection object.</doc>
38946 <type name="SocketConnection"/>
38948 <parameter name="p0" transfer-ownership="none">
38949 <doc xml:whitespace="preserve">the source_object passed to g_socket_listener_add_address().</doc>
38950 <type name="GObject.Object"/>
38955 <record name="ThreadedSocketServiceClass"
38956 c:type="GThreadedSocketServiceClass"
38957 glib:is-gtype-struct-for="ThreadedSocketService">
38958 <field name="parent_class">
38959 <type name="SocketServiceClass" c:type="GSocketServiceClass"/>
38962 <callback name="run">
38963 <return-value transfer-ownership="none">
38964 <type name="gboolean" c:type="gboolean"/>
38967 <parameter name="service" transfer-ownership="none">
38968 <type name="ThreadedSocketService"
38969 c:type="GThreadedSocketService*"/>
38971 <parameter name="connection" transfer-ownership="none">
38972 <type name="SocketConnection" c:type="GSocketConnection*"/>
38974 <parameter name="source_object" transfer-ownership="none">
38975 <type name="GObject.Object" c:type="GObject*"/>
38980 <field name="_g_reserved1" introspectable="0">
38981 <callback name="_g_reserved1">
38982 <return-value transfer-ownership="none">
38983 <type name="none" c:type="void"/>
38987 <field name="_g_reserved2" introspectable="0">
38988 <callback name="_g_reserved2">
38989 <return-value transfer-ownership="none">
38990 <type name="none" c:type="void"/>
38994 <field name="_g_reserved3" introspectable="0">
38995 <callback name="_g_reserved3">
38996 <return-value transfer-ownership="none">
38997 <type name="none" c:type="void"/>
39001 <field name="_g_reserved4" introspectable="0">
39002 <callback name="_g_reserved4">
39003 <return-value transfer-ownership="none">
39004 <type name="none" c:type="void"/>
39008 <field name="_g_reserved5" introspectable="0">
39009 <callback name="_g_reserved5">
39010 <return-value transfer-ownership="none">
39011 <type name="none" c:type="void"/>
39016 <record name="ThreadedSocketServicePrivate"
39017 c:type="GThreadedSocketServicePrivate"
39020 <class name="UnixConnection"
39021 c:symbol-prefix="unix_connection"
39022 c:type="GUnixConnection"
39023 parent="SocketConnection"
39024 glib:type-name="GUnixConnection"
39025 glib:get-type="g_unix_connection_get_type"
39026 glib:type-struct="UnixConnectionClass">
39027 <method name="receive_credentials"
39028 c:identifier="g_unix_connection_receive_credentials"
39031 <doc xml:whitespace="preserve">Receives credentials from the sending end of the connection. The
39032 sending end has to call g_unix_connection_send_credentials() (or
39033 similar) for this to work.
39034 As well as reading the credentials this also reads (and discards) a
39035 single byte from the stream, as this is required for credentials
39036 passing to work on some implementations.
39037 Other ways to exchange credentials with a foreign peer includes the
39038 #GUnixCredentialsMessage type and g_socket_get_credentials() function.
39039 g_object_unref()), %NULL if @error is set.</doc>
39040 <return-value transfer-ownership="full">
39041 <doc xml:whitespace="preserve">Received credentials on success (free with</doc>
39042 <type name="Credentials" c:type="GCredentials*"/>
39045 <parameter name="cancellable"
39046 transfer-ownership="none"
39048 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
39049 <type name="Cancellable" c:type="GCancellable*"/>
39053 <method name="receive_fd"
39054 c:identifier="g_unix_connection_receive_fd"
39057 <doc xml:whitespace="preserve">Receives a file descriptor from the sending end of the connection.
39058 The sending end has to call g_unix_connection_send_fd() for this
39060 As well as reading the fd this also reads a single byte from the
39061 stream, as this is required for fd passing to work on some
39062 implementations.</doc>
39063 <return-value transfer-ownership="none">
39064 <doc xml:whitespace="preserve">a file descriptor on success, -1 on error.</doc>
39065 <type name="gint" c:type="gint"/>
39068 <parameter name="cancellable"
39069 transfer-ownership="none"
39071 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore</doc>
39072 <type name="Cancellable" c:type="GCancellable*"/>
39076 <method name="send_credentials"
39077 c:identifier="g_unix_connection_send_credentials"
39080 <doc xml:whitespace="preserve">Passes the credentials of the current user the receiving side
39081 of the connection. The recieving end has to call
39082 g_unix_connection_receive_credentials() (or similar) to accept the
39084 As well as sending the credentials this also writes a single NUL
39085 byte to the stream, as this is required for credentials passing to
39086 work on some implementations.
39087 Other ways to exchange credentials with a foreign peer includes the
39088 #GUnixCredentialsMessage type and g_socket_get_credentials() function.</doc>
39089 <return-value transfer-ownership="none">
39090 <doc xml:whitespace="preserve">%TRUE on success, %FALSE if @error is set.</doc>
39091 <type name="gboolean" c:type="gboolean"/>
39094 <parameter name="cancellable"
39095 transfer-ownership="none"
39097 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
39098 <type name="Cancellable" c:type="GCancellable*"/>
39102 <method name="send_fd"
39103 c:identifier="g_unix_connection_send_fd"
39106 <doc xml:whitespace="preserve">Passes a file descriptor to the recieving side of the
39107 connection. The recieving end has to call g_unix_connection_receive_fd()
39108 to accept the file descriptor.
39109 As well as sending the fd this also writes a single byte to the
39110 stream, as this is required for fd passing to work on some
39111 implementations.</doc>
39112 <return-value transfer-ownership="none">
39113 <doc xml:whitespace="preserve">a %TRUE on success, %NULL on error.</doc>
39114 <type name="gboolean" c:type="gboolean"/>
39117 <parameter name="fd" transfer-ownership="none">
39118 <doc xml:whitespace="preserve">a file descriptor</doc>
39119 <type name="gint" c:type="gint"/>
39121 <parameter name="cancellable"
39122 transfer-ownership="none"
39124 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
39125 <type name="Cancellable" c:type="GCancellable*"/>
39129 <field name="parent_instance">
39130 <type name="SocketConnection" c:type="GSocketConnection"/>
39132 <field name="priv">
39133 <type name="UnixConnectionPrivate" c:type="GUnixConnectionPrivate*"/>
39136 <record name="UnixConnectionClass"
39137 c:type="GUnixConnectionClass"
39138 glib:is-gtype-struct-for="UnixConnection">
39139 <field name="parent_class">
39140 <type name="SocketConnectionClass" c:type="GSocketConnectionClass"/>
39143 <record name="UnixConnectionPrivate"
39144 c:type="GUnixConnectionPrivate"
39147 <class name="UnixCredentialsMessage"
39148 c:symbol-prefix="unix_credentials_message"
39149 c:type="GUnixCredentialsMessage"
39151 parent="SocketControlMessage"
39152 glib:type-name="GUnixCredentialsMessage"
39153 glib:get-type="g_unix_credentials_message_get_type"
39154 glib:type-struct="UnixCredentialsMessageClass">
39155 <doc xml:whitespace="preserve">The #GUnixCredentialsMessage structure contains only private data
39156 and should only be accessed using the provided API.</doc>
39157 <constructor name="new"
39158 c:identifier="g_unix_credentials_message_new"
39160 <doc xml:whitespace="preserve">Creates a new #GUnixCredentialsMessage with credentials matching the current processes.</doc>
39161 <return-value transfer-ownership="full">
39162 <doc xml:whitespace="preserve">a new #GUnixCredentialsMessage</doc>
39163 <type name="SocketControlMessage" c:type="GSocketControlMessage*"/>
39166 <constructor name="new_with_credentials"
39167 c:identifier="g_unix_credentials_message_new_with_credentials"
39169 <doc xml:whitespace="preserve">Creates a new #GUnixCredentialsMessage holding @credentials.</doc>
39170 <return-value transfer-ownership="full">
39171 <doc xml:whitespace="preserve">a new #GUnixCredentialsMessage</doc>
39172 <type name="SocketControlMessage" c:type="GSocketControlMessage*"/>
39175 <parameter name="credentials" transfer-ownership="none">
39176 <doc xml:whitespace="preserve">A #GCredentials object.</doc>
39177 <type name="Credentials" c:type="GCredentials*"/>
39181 <function name="is_supported"
39182 c:identifier="g_unix_credentials_message_is_supported"
39184 <doc xml:whitespace="preserve">Checks if passing a #GCredential on a #GSocket is supported on this platform.</doc>
39185 <return-value transfer-ownership="none">
39186 <doc xml:whitespace="preserve">%TRUE if supported, %FALSE otherwise</doc>
39187 <type name="gboolean" c:type="gboolean"/>
39190 <method name="get_credentials"
39191 c:identifier="g_unix_credentials_message_get_credentials"
39193 <doc xml:whitespace="preserve">Gets the credentials stored in @message.</doc>
39194 <return-value transfer-ownership="none">
39195 <doc xml:whitespace="preserve">A #GCredentials instance. Do not free, it is owned by @message.</doc>
39196 <type name="Credentials" c:type="GCredentials*"/>
39199 <property name="credentials"
39203 transfer-ownership="none">
39204 <doc xml:whitespace="preserve">The credentials stored in the message.</doc>
39205 <type name="Credentials"/>
39207 <field name="parent_instance">
39208 <type name="SocketControlMessage" c:type="GSocketControlMessage"/>
39210 <field name="priv">
39211 <type name="UnixCredentialsMessagePrivate"
39212 c:type="GUnixCredentialsMessagePrivate*"/>
39215 <record name="UnixCredentialsMessageClass"
39216 c:type="GUnixCredentialsMessageClass"
39217 glib:is-gtype-struct-for="UnixCredentialsMessage"
39219 <doc xml:whitespace="preserve">Class structure for #GUnixCredentialsMessage.</doc>
39220 <field name="parent_class">
39221 <type name="SocketControlMessageClass"
39222 c:type="GSocketControlMessageClass"/>
39224 <field name="_g_reserved1" introspectable="0">
39225 <callback name="_g_reserved1">
39226 <return-value transfer-ownership="none">
39227 <type name="none" c:type="void"/>
39231 <field name="_g_reserved2" introspectable="0">
39232 <callback name="_g_reserved2">
39233 <return-value transfer-ownership="none">
39234 <type name="none" c:type="void"/>
39239 <record name="UnixCredentialsMessagePrivate"
39240 c:type="GUnixCredentialsMessagePrivate"
39243 <class name="UnixFDList"
39244 c:symbol-prefix="unix_fd_list"
39245 c:type="GUnixFDList"
39246 parent="GObject.Object"
39247 glib:type-name="GUnixFDList"
39248 glib:get-type="g_unix_fd_list_get_type"
39249 glib:type-struct="UnixFDListClass">
39250 <constructor name="new" c:identifier="g_unix_fd_list_new" version="2.24">
39251 <doc xml:whitespace="preserve">Creates a new #GUnixFDList containing no file descriptors.</doc>
39252 <return-value transfer-ownership="full">
39253 <doc xml:whitespace="preserve">a new #GUnixFDList</doc>
39254 <type name="UnixFDList" c:type="GUnixFDList*"/>
39257 <constructor name="new_from_array"
39258 c:identifier="g_unix_fd_list_new_from_array"
39260 <doc xml:whitespace="preserve">Creates a new #GUnixFDList containing the file descriptors given in
39261 may no longer be used by the caller. The array itself is owned by
39263 Each file descriptor in the array should be set to close-on-exec.
39264 If @n_fds is -1 then @fds must be terminated with -1.</doc>
39265 <return-value transfer-ownership="full">
39266 <doc xml:whitespace="preserve">a new #GUnixFDList</doc>
39267 <type name="UnixFDList" c:type="GUnixFDList*"/>
39270 <parameter name="fds" transfer-ownership="none">
39271 <doc xml:whitespace="preserve">the initial list of file descriptors</doc>
39272 <type name="gint" c:type="gint*"/>
39274 <parameter name="n_fds" transfer-ownership="none">
39275 <doc xml:whitespace="preserve">the length of #fds, or -1</doc>
39276 <type name="gint" c:type="gint"/>
39280 <method name="append"
39281 c:identifier="g_unix_fd_list_append"
39284 <doc xml:whitespace="preserve">Adds a file descriptor to @list.
39285 The file descriptor is duplicated using dup(). You keep your copy
39286 of the descriptor and the copy contained in @list will be closed
39287 when @list is finalized.
39288 A possible cause of failure is exceeding the per-process or
39289 system-wide file descriptor limit.
39290 The index of the file descriptor in the list is returned. If you use
39291 this index with g_unix_fd_list_get() then you will receive back a
39292 duplicated copy of the same file descriptor.
39293 (and @error is set)</doc>
39294 <return-value transfer-ownership="none">
39295 <doc xml:whitespace="preserve">the index of the appended fd in case of success, else -1</doc>
39296 <type name="gint" c:type="gint"/>
39299 <parameter name="fd" transfer-ownership="none">
39300 <doc xml:whitespace="preserve">a valid open file descriptor</doc>
39301 <type name="gint" c:type="gint"/>
39306 c:identifier="g_unix_fd_list_get"
39309 <doc xml:whitespace="preserve">Gets a file descriptor out of @list.
39310 programmer error for @index_ to be out of range; see
39311 g_unix_fd_list_get_length().
39312 The file descriptor is duplicated using dup() and set as
39313 close-on-exec before being returned. You must call close() on it
39315 A possible cause of failure is exceeding the per-process or
39316 system-wide file descriptor limit.</doc>
39317 <return-value transfer-ownership="none">
39318 <doc xml:whitespace="preserve">the file descriptor, or -1 in case of error</doc>
39319 <type name="gint" c:type="gint"/>
39322 <parameter name="index_" transfer-ownership="none">
39323 <doc xml:whitespace="preserve">the index into the list</doc>
39324 <type name="gint" c:type="gint"/>
39328 <method name="get_length"
39329 c:identifier="g_unix_fd_list_get_length"
39331 <doc xml:whitespace="preserve">contained within).</doc>
39332 <return-value transfer-ownership="none">
39333 <doc xml:whitespace="preserve">the length of @list</doc>
39334 <type name="gint" c:type="gint"/>
39337 <method name="peek_fds"
39338 c:identifier="g_unix_fd_list_peek_fds"
39340 <doc xml:whitespace="preserve">Returns the array of file descriptors that is contained in this
39342 After this call, the descriptors remain the property of @list. The
39343 caller must not close them and must not free the array. The array is
39344 valid only until @list is changed in any way.
39345 If @length is non-%NULL then it is set to the number of file
39346 descriptors in the returned array. The returned array is also
39347 terminated with -1.
39348 This function never returns %NULL. In case there are no file
39349 descriptors contained in @list, an empty array is returned.</doc>
39350 <return-value transfer-ownership="none">
39351 <doc xml:whitespace="preserve">an array of file descriptors</doc>
39352 <type name="gint" c:type="gint*"/>
39355 <parameter name="length" transfer-ownership="none">
39356 <doc xml:whitespace="preserve">pointer to the length of the returned array, or %NULL</doc>
39357 <type name="gint" c:type="gint*"/>
39361 <method name="steal_fds"
39362 c:identifier="g_unix_fd_list_steal_fds"
39364 <doc xml:whitespace="preserve">Returns the array of file descriptors that is contained in this
39366 After this call, the descriptors are no longer contained in
39367 descriptors have been added).
39368 The return result of this function must be freed with g_free().
39369 The caller is also responsible for closing all of the file
39370 descriptors. The file descriptors in the array are set to
39372 If @length is non-%NULL then it is set to the number of file
39373 descriptors in the returned array. The returned array is also
39374 terminated with -1.
39375 This function never returns %NULL. In case there are no file
39376 descriptors contained in @list, an empty array is returned.</doc>
39377 <return-value transfer-ownership="none">
39378 <doc xml:whitespace="preserve">an array of file descriptors</doc>
39379 <type name="gint" c:type="gint*"/>
39382 <parameter name="length" transfer-ownership="none">
39383 <doc xml:whitespace="preserve">pointer to the length of the returned array, or %NULL</doc>
39384 <type name="gint" c:type="gint*"/>
39388 <field name="parent_instance">
39389 <type name="GObject.Object" c:type="GObject"/>
39391 <field name="priv">
39392 <type name="UnixFDListPrivate" c:type="GUnixFDListPrivate*"/>
39395 <record name="UnixFDListClass"
39396 c:type="GUnixFDListClass"
39397 glib:is-gtype-struct-for="UnixFDList">
39398 <field name="parent_class">
39399 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
39401 <field name="_g_reserved1" introspectable="0">
39402 <callback name="_g_reserved1">
39403 <return-value transfer-ownership="none">
39404 <type name="none" c:type="void"/>
39408 <field name="_g_reserved2" introspectable="0">
39409 <callback name="_g_reserved2">
39410 <return-value transfer-ownership="none">
39411 <type name="none" c:type="void"/>
39415 <field name="_g_reserved3" introspectable="0">
39416 <callback name="_g_reserved3">
39417 <return-value transfer-ownership="none">
39418 <type name="none" c:type="void"/>
39422 <field name="_g_reserved4" introspectable="0">
39423 <callback name="_g_reserved4">
39424 <return-value transfer-ownership="none">
39425 <type name="none" c:type="void"/>
39429 <field name="_g_reserved5" introspectable="0">
39430 <callback name="_g_reserved5">
39431 <return-value transfer-ownership="none">
39432 <type name="none" c:type="void"/>
39437 <record name="UnixFDListPrivate" c:type="GUnixFDListPrivate" disguised="1">
39439 <class name="UnixFDMessage"
39440 c:symbol-prefix="unix_fd_message"
39441 c:type="GUnixFDMessage"
39442 parent="SocketControlMessage"
39443 glib:type-name="GUnixFDMessage"
39444 glib:get-type="g_unix_fd_message_get_type"
39445 glib:type-struct="UnixFDMessageClass">
39446 <constructor name="new"
39447 c:identifier="g_unix_fd_message_new"
39449 <doc xml:whitespace="preserve">Creates a new #GUnixFDMessage containing an empty file descriptor
39451 <return-value transfer-ownership="full">
39452 <doc xml:whitespace="preserve">a new #GUnixFDMessage</doc>
39453 <type name="SocketControlMessage" c:type="GSocketControlMessage*"/>
39456 <constructor name="new_with_fd_list"
39457 c:identifier="g_unix_fd_message_new_with_fd_list"
39459 <doc xml:whitespace="preserve">Creates a new #GUnixFDMessage containing @list.</doc>
39460 <return-value transfer-ownership="full">
39461 <doc xml:whitespace="preserve">a new #GUnixFDMessage</doc>
39462 <type name="SocketControlMessage" c:type="GSocketControlMessage*"/>
39465 <parameter name="fd_list" transfer-ownership="none">
39466 <doc xml:whitespace="preserve">a #GUnixFDList</doc>
39467 <type name="UnixFDList" c:type="GUnixFDList*"/>
39471 <method name="append_fd"
39472 c:identifier="g_unix_fd_message_append_fd"
39475 <doc xml:whitespace="preserve">Adds a file descriptor to @message.
39476 The file descriptor is duplicated using dup(). You keep your copy
39477 of the descriptor and the copy contained in @message will be closed
39478 when @message is finalized.
39479 A possible cause of failure is exceeding the per-process or
39480 system-wide file descriptor limit.</doc>
39481 <return-value transfer-ownership="none">
39482 <doc xml:whitespace="preserve">%TRUE in case of success, else %FALSE (and @error is set)</doc>
39483 <type name="gboolean" c:type="gboolean"/>
39486 <parameter name="fd" transfer-ownership="none">
39487 <doc xml:whitespace="preserve">a valid open file descriptor</doc>
39488 <type name="gint" c:type="gint"/>
39492 <method name="get_fd_list"
39493 c:identifier="g_unix_fd_message_get_fd_list"
39495 <doc xml:whitespace="preserve">Gets the #GUnixFDList contained in @message. This function does not
39496 return a reference to the caller, but the returned list is valid for
39497 the lifetime of @message.</doc>
39498 <return-value transfer-ownership="none">
39499 <doc xml:whitespace="preserve">the #GUnixFDList from @message</doc>
39500 <type name="UnixFDList" c:type="GUnixFDList*"/>
39503 <method name="steal_fds"
39504 c:identifier="g_unix_fd_message_steal_fds"
39506 <doc xml:whitespace="preserve">Returns the array of file descriptors that is contained in this
39508 After this call, the descriptors are no longer contained in
39509 descriptors have been added).
39510 The return result of this function must be freed with g_free().
39511 The caller is also responsible for closing all of the file
39513 If @length is non-%NULL then it is set to the number of file
39514 descriptors in the returned array. The returned array is also
39515 terminated with -1.
39516 This function never returns %NULL. In case there are no file
39517 descriptors contained in @message, an empty array is returned.</doc>
39518 <return-value transfer-ownership="none">
39519 <doc xml:whitespace="preserve">an array of file descriptors</doc>
39520 <type name="gint" c:type="gint*"/>
39523 <parameter name="length" transfer-ownership="none">
39524 <doc xml:whitespace="preserve">pointer to the length of the returned array, or %NULL</doc>
39525 <type name="gint" c:type="gint*"/>
39529 <property name="fd-list"
39532 transfer-ownership="none">
39533 <type name="UnixFDList"/>
39535 <field name="parent_instance">
39536 <type name="SocketControlMessage" c:type="GSocketControlMessage"/>
39538 <field name="priv">
39539 <type name="UnixFDMessagePrivate" c:type="GUnixFDMessagePrivate*"/>
39542 <record name="UnixFDMessageClass"
39543 c:type="GUnixFDMessageClass"
39544 glib:is-gtype-struct-for="UnixFDMessage">
39545 <field name="parent_class">
39546 <type name="SocketControlMessageClass"
39547 c:type="GSocketControlMessageClass"/>
39549 <field name="_g_reserved1" introspectable="0">
39550 <callback name="_g_reserved1">
39551 <return-value transfer-ownership="none">
39552 <type name="none" c:type="void"/>
39556 <field name="_g_reserved2" introspectable="0">
39557 <callback name="_g_reserved2">
39558 <return-value transfer-ownership="none">
39559 <type name="none" c:type="void"/>
39564 <record name="UnixFDMessagePrivate"
39565 c:type="GUnixFDMessagePrivate"
39568 <class name="UnixInputStream"
39569 c:symbol-prefix="unix_input_stream"
39570 c:type="GUnixInputStream"
39571 parent="InputStream"
39572 glib:type-name="GUnixInputStream"
39573 glib:get-type="g_unix_input_stream_get_type"
39574 glib:type-struct="UnixInputStreamClass">
39575 <doc xml:whitespace="preserve">Implements #GInputStream for reading from selectable unix file descriptors</doc>
39576 <constructor name="new" c:identifier="g_unix_input_stream_new">
39577 <doc xml:whitespace="preserve">Creates a new #GUnixInputStream for the given @fd.
39578 If @close_fd is %TRUE, the file descriptor will be closed
39579 when the stream is closed.</doc>
39580 <return-value transfer-ownership="full">
39581 <doc xml:whitespace="preserve">a new #GUnixInputStream</doc>
39582 <type name="InputStream" c:type="GInputStream*"/>
39585 <parameter name="fd" transfer-ownership="none">
39586 <doc xml:whitespace="preserve">a UNIX file descriptor</doc>
39587 <type name="gint" c:type="gint"/>
39589 <parameter name="close_fd" transfer-ownership="none">
39590 <doc xml:whitespace="preserve">%TRUE to close the file descriptor when done</doc>
39591 <type name="gboolean" c:type="gboolean"/>
39595 <method name="get_close_fd"
39596 c:identifier="g_unix_input_stream_get_close_fd"
39598 <doc xml:whitespace="preserve">Returns whether the file descriptor of @stream will be
39599 closed when the stream is closed.</doc>
39600 <return-value transfer-ownership="none">
39601 <doc xml:whitespace="preserve">%TRUE if the file descriptor is closed when done</doc>
39602 <type name="gboolean" c:type="gboolean"/>
39605 <method name="get_fd"
39606 c:identifier="g_unix_input_stream_get_fd"
39608 <doc xml:whitespace="preserve">Return the UNIX file descriptor that the stream reads from.</doc>
39609 <return-value transfer-ownership="none">
39610 <doc xml:whitespace="preserve">The file descriptor of @stream</doc>
39611 <type name="gint" c:type="gint"/>
39614 <method name="set_close_fd"
39615 c:identifier="g_unix_input_stream_set_close_fd"
39617 <doc xml:whitespace="preserve">Sets whether the file descriptor of @stream shall be closed
39618 when the stream is closed.</doc>
39619 <return-value transfer-ownership="none">
39620 <type name="none" c:type="void"/>
39623 <parameter name="close_fd" transfer-ownership="none">
39624 <doc xml:whitespace="preserve">%TRUE to close the file descriptor when done</doc>
39625 <type name="gboolean" c:type="gboolean"/>
39629 <property name="close-fd"
39632 transfer-ownership="none">
39633 <doc xml:whitespace="preserve">Whether to close the file descriptor when the stream is closed.</doc>
39634 <type name="gboolean"/>
39636 <property name="fd"
39640 transfer-ownership="none">
39641 <doc xml:whitespace="preserve">The file descriptor that the stream reads from.</doc>
39642 <type name="gint"/>
39644 <field name="parent_instance">
39645 <type name="InputStream" c:type="GInputStream"/>
39647 <field name="priv">
39648 <type name="UnixInputStreamPrivate" c:type="GUnixInputStreamPrivate*"/>
39651 <record name="UnixInputStreamClass"
39652 c:type="GUnixInputStreamClass"
39653 glib:is-gtype-struct-for="UnixInputStream">
39654 <field name="parent_class">
39655 <type name="InputStreamClass" c:type="GInputStreamClass"/>
39657 <field name="_g_reserved1" introspectable="0">
39658 <callback name="_g_reserved1">
39659 <return-value transfer-ownership="none">
39660 <type name="none" c:type="void"/>
39664 <field name="_g_reserved2" introspectable="0">
39665 <callback name="_g_reserved2">
39666 <return-value transfer-ownership="none">
39667 <type name="none" c:type="void"/>
39671 <field name="_g_reserved3" introspectable="0">
39672 <callback name="_g_reserved3">
39673 <return-value transfer-ownership="none">
39674 <type name="none" c:type="void"/>
39678 <field name="_g_reserved4" introspectable="0">
39679 <callback name="_g_reserved4">
39680 <return-value transfer-ownership="none">
39681 <type name="none" c:type="void"/>
39685 <field name="_g_reserved5" introspectable="0">
39686 <callback name="_g_reserved5">
39687 <return-value transfer-ownership="none">
39688 <type name="none" c:type="void"/>
39693 <record name="UnixInputStreamPrivate"
39694 c:type="GUnixInputStreamPrivate"
39697 <record name="UnixMountEntry" c:type="GUnixMountEntry" disguised="1">
39698 <doc xml:whitespace="preserve">Defines a Unix mount entry (e.g. <filename>/media/cdrom</filename>).
39699 This corresponds roughly to a mtab entry.</doc>
39701 <class name="UnixMountMonitor"
39702 c:symbol-prefix="unix_mount_monitor"
39703 c:type="GUnixMountMonitor"
39704 parent="GObject.Object"
39705 glib:type-name="GUnixMountMonitor"
39706 glib:get-type="g_unix_mount_monitor_get_type"
39707 glib:type-struct="UnixMountMonitorClass">
39708 <doc xml:whitespace="preserve">Watches #GUnixMount<!-- -->s for changes.</doc>
39709 <constructor name="new" c:identifier="g_unix_mount_monitor_new">
39710 <doc xml:whitespace="preserve">Gets a new #GUnixMountMonitor. The default rate limit for which the
39711 monitor will report consecutive changes for the mount and mount
39712 point entry files is the default for a #GFileMonitor. Use
39713 g_unix_mount_monitor_set_rate_limit() to change this.</doc>
39714 <return-value transfer-ownership="full">
39715 <doc xml:whitespace="preserve">a #GUnixMountMonitor.</doc>
39716 <type name="UnixMountMonitor" c:type="GUnixMountMonitor*"/>
39719 <method name="set_rate_limit"
39720 c:identifier="g_unix_mount_monitor_set_rate_limit"
39722 <doc xml:whitespace="preserve">Sets the rate limit to which the @mount_monitor will report
39723 consecutive change events to the mount and mount point entry files.</doc>
39724 <return-value transfer-ownership="none">
39725 <type name="none" c:type="void"/>
39728 <parameter name="limit_msec" transfer-ownership="none">
39729 <doc xml:whitespace="preserve">a integer with the limit in milliseconds to poll for changes.</doc>
39730 <type name="gint" c:type="int"/>
39734 <glib:signal name="mountpoints-changed">
39735 <doc xml:whitespace="preserve">Emitted when the unix mount points have changed.</doc>
39736 <return-value transfer-ownership="none">
39737 <type name="none"/>
39740 <glib:signal name="mounts-changed">
39741 <doc xml:whitespace="preserve">Emitted when the unix mounts have changed.</doc>
39742 <return-value transfer-ownership="none">
39743 <type name="none"/>
39747 <record name="UnixMountMonitorClass"
39748 c:type="GUnixMountMonitorClass"
39750 glib:is-gtype-struct-for="UnixMountMonitor">
39752 <record name="UnixMountPoint" c:type="GUnixMountPoint" disguised="1">
39753 <doc xml:whitespace="preserve">Defines a Unix mount point (e.g. <filename>/dev</filename>).
39754 This corresponds roughly to a fstab entry.</doc>
39755 <method name="compare" c:identifier="g_unix_mount_point_compare">
39756 <doc xml:whitespace="preserve">Compares two unix mount points.
39757 or less than @mount2, respectively.</doc>
39758 <return-value transfer-ownership="none">
39759 <doc xml:whitespace="preserve">1, 0 or -1 if @mount1 is greater than, equal to,</doc>
39760 <type name="gint" c:type="gint"/>
39763 <parameter name="mount2" transfer-ownership="none">
39764 <doc xml:whitespace="preserve">a #GUnixMount.</doc>
39765 <type name="UnixMountPoint" c:type="GUnixMountPoint*"/>
39769 <method name="free" c:identifier="g_unix_mount_point_free">
39770 <doc xml:whitespace="preserve">Frees a unix mount point.</doc>
39771 <return-value transfer-ownership="none">
39772 <type name="none" c:type="void"/>
39775 <method name="get_device_path"
39776 c:identifier="g_unix_mount_point_get_device_path">
39777 <doc xml:whitespace="preserve">Gets the device path for a unix mount point.</doc>
39778 <return-value transfer-ownership="none">
39779 <doc xml:whitespace="preserve">a string containing the device path.</doc>
39780 <type name="utf8" c:type="char*"/>
39783 <method name="get_fs_type" c:identifier="g_unix_mount_point_get_fs_type">
39784 <doc xml:whitespace="preserve">Gets the file system type for the mount point.</doc>
39785 <return-value transfer-ownership="none">
39786 <doc xml:whitespace="preserve">a string containing the file system type.</doc>
39787 <type name="utf8" c:type="char*"/>
39790 <method name="get_mount_path"
39791 c:identifier="g_unix_mount_point_get_mount_path">
39792 <doc xml:whitespace="preserve">Gets the mount path for a unix mount point.</doc>
39793 <return-value transfer-ownership="none">
39794 <doc xml:whitespace="preserve">a string containing the mount path.</doc>
39795 <type name="utf8" c:type="char*"/>
39798 <method name="guess_can_eject"
39799 c:identifier="g_unix_mount_point_guess_can_eject">
39800 <doc xml:whitespace="preserve">Guesses whether a Unix mount point can be ejected.</doc>
39801 <return-value transfer-ownership="none">
39802 <doc xml:whitespace="preserve">%TRUE if @mount_point is deemed to be ejectable.</doc>
39803 <type name="gboolean" c:type="gboolean"/>
39806 <method name="guess_icon" c:identifier="g_unix_mount_point_guess_icon">
39807 <doc xml:whitespace="preserve">Guesses the icon of a Unix mount point.</doc>
39808 <return-value transfer-ownership="full">
39809 <doc xml:whitespace="preserve">a #GIcon</doc>
39810 <type name="Icon" c:type="GIcon*"/>
39813 <method name="guess_name" c:identifier="g_unix_mount_point_guess_name">
39814 <doc xml:whitespace="preserve">Guesses the name of a Unix mount point.
39815 The result is a translated string.
39816 be freed with g_free()</doc>
39817 <return-value transfer-ownership="full">
39818 <doc xml:whitespace="preserve">A newly allocated string that must</doc>
39819 <type name="utf8" c:type="char*"/>
39822 <method name="is_loopback" c:identifier="g_unix_mount_point_is_loopback">
39823 <doc xml:whitespace="preserve">Checks if a unix mount point is a loopback device.</doc>
39824 <return-value transfer-ownership="none">
39825 <doc xml:whitespace="preserve">%TRUE if the mount point is a loopback. %FALSE otherwise.</doc>
39826 <type name="gboolean" c:type="gboolean"/>
39829 <method name="is_readonly" c:identifier="g_unix_mount_point_is_readonly">
39830 <doc xml:whitespace="preserve">Checks if a unix mount point is read only.</doc>
39831 <return-value transfer-ownership="none">
39832 <doc xml:whitespace="preserve">%TRUE if a mount point is read only.</doc>
39833 <type name="gboolean" c:type="gboolean"/>
39836 <method name="is_user_mountable"
39837 c:identifier="g_unix_mount_point_is_user_mountable">
39838 <doc xml:whitespace="preserve">Checks if a unix mount point is mountable by the user.</doc>
39839 <return-value transfer-ownership="none">
39840 <doc xml:whitespace="preserve">%TRUE if the mount point is user mountable.</doc>
39841 <type name="gboolean" c:type="gboolean"/>
39845 <class name="UnixOutputStream"
39846 c:symbol-prefix="unix_output_stream"
39847 c:type="GUnixOutputStream"
39848 parent="OutputStream"
39849 glib:type-name="GUnixOutputStream"
39850 glib:get-type="g_unix_output_stream_get_type"
39851 glib:type-struct="UnixOutputStreamClass">
39852 <doc xml:whitespace="preserve">Implements #GOutputStream for outputting to selectable unix file descriptors</doc>
39853 <constructor name="new" c:identifier="g_unix_output_stream_new">
39854 <doc xml:whitespace="preserve">Creates a new #GUnixOutputStream for the given @fd.
39855 If @close_fd, is %TRUE, the file descriptor will be closed when
39856 the output stream is destroyed.</doc>
39857 <return-value transfer-ownership="full">
39858 <doc xml:whitespace="preserve">a new #GOutputStream</doc>
39859 <type name="OutputStream" c:type="GOutputStream*"/>
39862 <parameter name="fd" transfer-ownership="none">
39863 <doc xml:whitespace="preserve">a UNIX file descriptor</doc>
39864 <type name="gint" c:type="gint"/>
39866 <parameter name="close_fd" transfer-ownership="none">
39867 <doc xml:whitespace="preserve">%TRUE to close the file descriptor when done</doc>
39868 <type name="gboolean" c:type="gboolean"/>
39872 <method name="get_close_fd"
39873 c:identifier="g_unix_output_stream_get_close_fd"
39875 <doc xml:whitespace="preserve">Returns whether the file descriptor of @stream will be
39876 closed when the stream is closed.</doc>
39877 <return-value transfer-ownership="none">
39878 <doc xml:whitespace="preserve">%TRUE if the file descriptor is closed when done</doc>
39879 <type name="gboolean" c:type="gboolean"/>
39882 <method name="get_fd"
39883 c:identifier="g_unix_output_stream_get_fd"
39885 <doc xml:whitespace="preserve">Return the UNIX file descriptor that the stream writes to.</doc>
39886 <return-value transfer-ownership="none">
39887 <doc xml:whitespace="preserve">The file descriptor of @stream</doc>
39888 <type name="gint" c:type="gint"/>
39891 <method name="set_close_fd"
39892 c:identifier="g_unix_output_stream_set_close_fd"
39894 <doc xml:whitespace="preserve">Sets whether the file descriptor of @stream shall be closed
39895 when the stream is closed.</doc>
39896 <return-value transfer-ownership="none">
39897 <type name="none" c:type="void"/>
39900 <parameter name="close_fd" transfer-ownership="none">
39901 <doc xml:whitespace="preserve">%TRUE to close the file descriptor when done</doc>
39902 <type name="gboolean" c:type="gboolean"/>
39906 <property name="close-fd"
39909 transfer-ownership="none">
39910 <doc xml:whitespace="preserve">Whether to close the file descriptor when the stream is closed.</doc>
39911 <type name="gboolean"/>
39913 <property name="fd"
39917 transfer-ownership="none">
39918 <doc xml:whitespace="preserve">The file descriptor that the stream writes to.</doc>
39919 <type name="gint"/>
39921 <field name="parent_instance">
39922 <type name="OutputStream" c:type="GOutputStream"/>
39924 <field name="priv">
39925 <type name="UnixOutputStreamPrivate"
39926 c:type="GUnixOutputStreamPrivate*"/>
39929 <record name="UnixOutputStreamClass"
39930 c:type="GUnixOutputStreamClass"
39931 glib:is-gtype-struct-for="UnixOutputStream">
39932 <field name="parent_class">
39933 <type name="OutputStreamClass" c:type="GOutputStreamClass"/>
39935 <field name="_g_reserved1" introspectable="0">
39936 <callback name="_g_reserved1">
39937 <return-value transfer-ownership="none">
39938 <type name="none" c:type="void"/>
39942 <field name="_g_reserved2" introspectable="0">
39943 <callback name="_g_reserved2">
39944 <return-value transfer-ownership="none">
39945 <type name="none" c:type="void"/>
39949 <field name="_g_reserved3" introspectable="0">
39950 <callback name="_g_reserved3">
39951 <return-value transfer-ownership="none">
39952 <type name="none" c:type="void"/>
39956 <field name="_g_reserved4" introspectable="0">
39957 <callback name="_g_reserved4">
39958 <return-value transfer-ownership="none">
39959 <type name="none" c:type="void"/>
39963 <field name="_g_reserved5" introspectable="0">
39964 <callback name="_g_reserved5">
39965 <return-value transfer-ownership="none">
39966 <type name="none" c:type="void"/>
39971 <record name="UnixOutputStreamPrivate"
39972 c:type="GUnixOutputStreamPrivate"
39975 <class name="UnixSocketAddress"
39976 c:symbol-prefix="unix_socket_address"
39977 c:type="GUnixSocketAddress"
39978 parent="SocketAddress"
39979 glib:type-name="GUnixSocketAddress"
39980 glib:get-type="g_unix_socket_address_get_type"
39981 glib:type-struct="UnixSocketAddressClass">
39982 <doc xml:whitespace="preserve">A UNIX-domain (local) socket address, corresponding to a
39983 <type>struct sockaddr_un</type>.</doc>
39984 <implements name="SocketConnectable"/>
39985 <constructor name="new"
39986 c:identifier="g_unix_socket_address_new"
39988 <doc xml:whitespace="preserve">Creates a new #GUnixSocketAddress for @path.
39989 To create abstract socket addresses, on systems that support that,
39990 use g_unix_socket_address_new_abstract().</doc>
39991 <return-value transfer-ownership="full">
39992 <doc xml:whitespace="preserve">a new #GUnixSocketAddress</doc>
39993 <type name="SocketAddress" c:type="GSocketAddress*"/>
39996 <parameter name="path" transfer-ownership="none">
39997 <doc xml:whitespace="preserve">the socket path</doc>
39998 <type name="utf8" c:type="gchar*"/>
40002 <constructor name="new_abstract"
40003 c:identifier="g_unix_socket_address_new_abstract"
40004 deprecated="Use g_unix_socket_address_new_with_type().">
40005 <doc xml:whitespace="preserve">Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
40006 #GUnixSocketAddress for @path.</doc>
40007 <return-value transfer-ownership="full">
40008 <doc xml:whitespace="preserve">a new #GUnixSocketAddress</doc>
40009 <type name="SocketAddress" c:type="GSocketAddress*"/>
40012 <parameter name="path" transfer-ownership="none">
40013 <doc xml:whitespace="preserve">the abstract name</doc>
40014 <type name="utf8" c:type="gchar*"/>
40016 <parameter name="path_len" transfer-ownership="none">
40017 <doc xml:whitespace="preserve">the length of @path, or -1</doc>
40018 <type name="gint" c:type="gint"/>
40022 <constructor name="new_with_type"
40023 c:identifier="g_unix_socket_address_new_with_type"
40025 <doc xml:whitespace="preserve">Creates a new #GUnixSocketAddress of type @type with name @path.
40026 If @type is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to
40027 calling g_unix_socket_address_new().
40028 If @path_type is %G_UNIX_SOCKET_ADDRESS_ABSTRACT, then @path_len
40029 bytes of @path will be copied to the socket's path, and only those
40030 bytes will be considered part of the name. (If @path_len is -1,
40031 then @path is assumed to be NUL-terminated.) For example, if @path
40032 was "test", then calling g_socket_address_get_native_size() on the
40033 returned socket would return 7 (2 bytes of overhead, 1 byte for the
40034 abstract-socket indicator byte, and 4 bytes for the name "test").
40035 If @path_type is %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED, then
40036 rest of the path will be padded with 0 bytes, and the entire
40037 zero-padded buffer will be considered the name. (As above, if
40038 this case, g_socket_address_get_native_size() will always return
40039 the full size of a <literal>struct sockaddr_un</literal>, although
40040 g_unix_socket_address_get_path_len() will still return just the
40042 %G_UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over
40043 %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED for new programs. Of course,
40044 when connecting to a server created by another process, you must
40045 use the appropriate type corresponding to how that process created
40046 its listening socket.</doc>
40047 <return-value transfer-ownership="full">
40048 <doc xml:whitespace="preserve">a new #GUnixSocketAddress</doc>
40049 <type name="SocketAddress" c:type="GSocketAddress*"/>
40052 <parameter name="path" transfer-ownership="none">
40053 <doc xml:whitespace="preserve">the name</doc>
40054 <type name="utf8" c:type="gchar*"/>
40056 <parameter name="path_len" transfer-ownership="none">
40057 <doc xml:whitespace="preserve">the length of @path, or -1</doc>
40058 <type name="gint" c:type="gint"/>
40060 <parameter name="type" transfer-ownership="none">
40061 <doc xml:whitespace="preserve">a #GUnixSocketAddressType</doc>
40062 <type name="UnixSocketAddressType"
40063 c:type="GUnixSocketAddressType"/>
40067 <function name="abstract_names_supported"
40068 c:identifier="g_unix_socket_address_abstract_names_supported"
40070 <doc xml:whitespace="preserve">Checks if abstract unix domain socket names are supported.</doc>
40071 <return-value transfer-ownership="none">
40072 <doc xml:whitespace="preserve">%TRUE if supported, %FALSE otherwise</doc>
40073 <type name="gboolean" c:type="gboolean"/>
40076 <method name="get_address_type"
40077 c:identifier="g_unix_socket_address_get_address_type"
40079 <doc xml:whitespace="preserve">Gets @address's type.</doc>
40080 <return-value transfer-ownership="none">
40081 <doc xml:whitespace="preserve">a #GUnixSocketAddressType</doc>
40082 <type name="UnixSocketAddressType" c:type="GUnixSocketAddressType"/>
40085 <method name="get_is_abstract"
40086 c:identifier="g_unix_socket_address_get_is_abstract"
40088 deprecated="Use g_unix_socket_address_get_address_type()">
40089 <doc xml:whitespace="preserve">Tests if @address is abstract.</doc>
40090 <return-value transfer-ownership="none">
40091 <doc xml:whitespace="preserve">%TRUE if the address is abstract, %FALSE otherwise</doc>
40092 <type name="gboolean" c:type="gboolean"/>
40095 <method name="get_path"
40096 c:identifier="g_unix_socket_address_get_path"
40098 <doc xml:whitespace="preserve">Gets @address's path, or for abstract sockets the "name".
40099 Guaranteed to be zero-terminated, but an abstract socket
40100 may contain embedded zeros, and thus you should use
40101 g_unix_socket_address_get_path_len() to get the true length
40102 of this string.</doc>
40103 <return-value transfer-ownership="none">
40104 <doc xml:whitespace="preserve">the path for @address</doc>
40105 <type name="utf8" c:type="char*"/>
40108 <method name="get_path_len"
40109 c:identifier="g_unix_socket_address_get_path_len"
40111 <doc xml:whitespace="preserve">Gets the length of @address's path.
40112 For details, see g_unix_socket_address_get_path().</doc>
40113 <return-value transfer-ownership="none">
40114 <doc xml:whitespace="preserve">the length of the path</doc>
40115 <type name="gulong" c:type="gsize"/>
40118 <property name="abstract"
40119 deprecated="Use #GUnixSocketAddress:address-type, which"
40122 transfer-ownership="none">
40123 <doc xml:whitespace="preserve">Whether or not this is an abstract address
40124 distinguishes between zero-padded and non-zero-padded
40125 abstract addresses.</doc>
40126 <type name="gboolean"/>
40128 <property name="address-type"
40131 transfer-ownership="none">
40132 <type name="UnixSocketAddressType"/>
40134 <property name="path"
40137 transfer-ownership="none">
40138 <type name="utf8"/>
40140 <property name="path-as-array"
40143 transfer-ownership="none">
40144 <array name="GLib.ByteArray">
40145 <type name="gpointer" c:type="gpointer"/>
40148 <field name="parent_instance">
40149 <type name="SocketAddress" c:type="GSocketAddress"/>
40151 <field name="priv">
40152 <type name="UnixSocketAddressPrivate"
40153 c:type="GUnixSocketAddressPrivate*"/>
40156 <record name="UnixSocketAddressClass"
40157 c:type="GUnixSocketAddressClass"
40158 glib:is-gtype-struct-for="UnixSocketAddress">
40159 <field name="parent_class">
40160 <type name="SocketAddressClass" c:type="GSocketAddressClass"/>
40163 <record name="UnixSocketAddressPrivate"
40164 c:type="GUnixSocketAddressPrivate"
40167 <enumeration name="UnixSocketAddressType"
40169 glib:type-name="GUnixSocketAddressType"
40170 glib:get-type="g_unix_socket_address_type_get_type"
40171 c:type="GUnixSocketAddressType">
40172 <doc xml:whitespace="preserve">The type of name used by a #GUnixSocketAddress.
40173 %G_UNIX_SOCKET_ADDRESS_PATH indicates a traditional unix domain
40174 socket bound to a filesystem path. %G_UNIX_SOCKET_ADDRESS_ANONYMOUS
40175 indicates a socket not bound to any name (eg, a client-side socket,
40176 or a socket created with socketpair()).
40177 For abstract sockets, there are two incompatible ways of naming
40178 sockaddr_un</literal> as the name, padding the unused parts of the
40179 %sun_path field with zeroes; this corresponds to
40180 %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED. However, many programs
40181 instead just use a portion of %sun_path, and pass an appropriate
40182 smaller length to bind() or connect(). This is
40183 %G_UNIX_SOCKET_ADDRESS_ABSTRACT.</doc>
40184 <member name="invalid"
40186 c:identifier="G_UNIX_SOCKET_ADDRESS_INVALID"
40187 glib:nick="invalid"/>
40188 <member name="anonymous"
40190 c:identifier="G_UNIX_SOCKET_ADDRESS_ANONYMOUS"
40191 glib:nick="anonymous"/>
40192 <member name="path"
40194 c:identifier="G_UNIX_SOCKET_ADDRESS_PATH"
40196 <member name="abstract"
40198 c:identifier="G_UNIX_SOCKET_ADDRESS_ABSTRACT"
40199 glib:nick="abstract"/>
40200 <member name="abstract_padded"
40202 c:identifier="G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED"
40203 glib:nick="abstract-padded"/>
40205 <constant name="VFS_EXTENSION_POINT_NAME" value="gio-vfs">
40206 <type name="utf8" c:type="gchar*"/>
40208 <constant name="VOLUME_IDENTIFIER_KIND_HAL_UDI" value="hal-udi">
40209 <type name="utf8" c:type="gchar*"/>
40211 <constant name="VOLUME_IDENTIFIER_KIND_LABEL" value="label">
40212 <type name="utf8" c:type="gchar*"/>
40214 <constant name="VOLUME_IDENTIFIER_KIND_NFS_MOUNT" value="nfs-mount">
40215 <type name="utf8" c:type="gchar*"/>
40217 <constant name="VOLUME_IDENTIFIER_KIND_UNIX_DEVICE" value="unix-device">
40218 <type name="utf8" c:type="gchar*"/>
40220 <constant name="VOLUME_IDENTIFIER_KIND_UUID" value="uuid">
40221 <type name="utf8" c:type="gchar*"/>
40223 <constant name="VOLUME_MONITOR_EXTENSION_POINT_NAME"
40224 value="gio-volume-monitor">
40225 <type name="utf8" c:type="gchar*"/>
40228 c:symbol-prefix="vfs"
40230 parent="GObject.Object"
40231 glib:type-name="GVfs"
40232 glib:get-type="g_vfs_get_type"
40233 glib:type-struct="VfsClass">
40234 <doc xml:whitespace="preserve">Virtual File System object.</doc>
40235 <function name="get_default" c:identifier="g_vfs_get_default">
40236 <doc xml:whitespace="preserve">Gets the default #GVfs for the system.</doc>
40237 <return-value transfer-ownership="none">
40238 <doc xml:whitespace="preserve">a #GVfs.</doc>
40239 <type name="Vfs" c:type="GVfs*"/>
40242 <function name="get_local" c:identifier="g_vfs_get_local">
40243 <doc xml:whitespace="preserve">Gets the local #GVfs for the system.</doc>
40244 <return-value transfer-ownership="none">
40245 <doc xml:whitespace="preserve">a #GVfs.</doc>
40246 <type name="Vfs" c:type="GVfs*"/>
40249 <virtual-method name="add_writable_namespaces">
40250 <return-value transfer-ownership="none">
40251 <type name="none" c:type="void"/>
40254 <parameter name="list" transfer-ownership="none">
40255 <type name="FileAttributeInfoList"
40256 c:type="GFileAttributeInfoList*"/>
40260 <virtual-method name="get_file_for_path" invoker="get_file_for_path">
40261 <doc xml:whitespace="preserve">Gets a #GFile for @path.
40262 Free the returned object with g_object_unref().</doc>
40263 <return-value transfer-ownership="full">
40264 <doc xml:whitespace="preserve">a #GFile.</doc>
40265 <type name="File" c:type="GFile*"/>
40268 <parameter name="path" transfer-ownership="none">
40269 <doc xml:whitespace="preserve">a string containing a VFS path.</doc>
40270 <type name="utf8" c:type="char*"/>
40274 <virtual-method name="get_file_for_uri" invoker="get_file_for_uri">
40275 <doc xml:whitespace="preserve">Gets a #GFile for @uri.
40276 This operation never fails, but the returned object
40277 might not support any I/O operation if the URI
40278 is malformed or if the URI scheme is not supported.
40279 Free the returned object with g_object_unref().</doc>
40280 <return-value transfer-ownership="full">
40281 <doc xml:whitespace="preserve">a #GFile.</doc>
40282 <type name="File" c:type="GFile*"/>
40285 <parameter name="uri" transfer-ownership="none">
40286 <doc xml:whitespace="preserve">a string containing a URI</doc>
40287 <type name="utf8" c:type="char*"/>
40291 <virtual-method name="get_supported_uri_schemes"
40292 invoker="get_supported_uri_schemes">
40293 <doc xml:whitespace="preserve">Gets a list of URI schemes supported by @vfs.
40294 The returned array belongs to GIO and must
40295 not be freed or modified.</doc>
40296 <return-value transfer-ownership="none">
40297 <doc xml:whitespace="preserve">a %NULL-terminated array of strings.</doc>
40298 <array c:type="gchar**">
40299 <type name="utf8"/>
40303 <virtual-method name="is_active" invoker="is_active">
40304 <doc xml:whitespace="preserve">Checks if the VFS is active.</doc>
40305 <return-value transfer-ownership="none">
40306 <doc xml:whitespace="preserve">%TRUE if construction of the @vfs was successful and it is now active.</doc>
40307 <type name="gboolean" c:type="gboolean"/>
40310 <virtual-method name="local_file_add_info">
40311 <return-value transfer-ownership="none">
40312 <type name="none" c:type="void"/>
40315 <parameter name="filename" transfer-ownership="none">
40316 <type name="utf8" c:type="char*"/>
40318 <parameter name="device" transfer-ownership="none">
40319 <type name="guint64" c:type="guint64"/>
40321 <parameter name="attribute_matcher" transfer-ownership="none">
40322 <type name="FileAttributeMatcher" c:type="GFileAttributeMatcher*"/>
40324 <parameter name="info" transfer-ownership="none">
40325 <type name="FileInfo" c:type="GFileInfo*"/>
40327 <parameter name="cancellable" transfer-ownership="none">
40328 <type name="Cancellable" c:type="GCancellable*"/>
40330 <parameter name="extra_data" transfer-ownership="none">
40331 <type name="gpointer" c:type="gpointer*"/>
40333 <parameter name="free_extra_data"
40334 transfer-ownership="none"
40336 <type name="GLib.DestroyNotify" c:type="GDestroyNotify*"/>
40340 <virtual-method name="local_file_moved">
40341 <return-value transfer-ownership="none">
40342 <type name="none" c:type="void"/>
40345 <parameter name="source" transfer-ownership="none">
40346 <type name="utf8" c:type="char*"/>
40348 <parameter name="dest" transfer-ownership="none">
40349 <type name="utf8" c:type="char*"/>
40353 <virtual-method name="local_file_removed">
40354 <return-value transfer-ownership="none">
40355 <type name="none" c:type="void"/>
40358 <parameter name="filename" transfer-ownership="none">
40359 <type name="utf8" c:type="char*"/>
40363 <virtual-method name="local_file_set_attributes" throws="1">
40364 <return-value transfer-ownership="none">
40365 <type name="gboolean" c:type="gboolean"/>
40368 <parameter name="filename" transfer-ownership="none">
40369 <type name="utf8" c:type="char*"/>
40371 <parameter name="info" transfer-ownership="none">
40372 <type name="FileInfo" c:type="GFileInfo*"/>
40374 <parameter name="flags" transfer-ownership="none">
40375 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
40377 <parameter name="cancellable" transfer-ownership="none">
40378 <type name="Cancellable" c:type="GCancellable*"/>
40382 <virtual-method name="parse_name" invoker="parse_name">
40383 <doc xml:whitespace="preserve">This operation never fails, but the returned object might
40384 not support any I/O operations if the @parse_name cannot
40385 be parsed by the #GVfs module.
40386 Free the returned object with g_object_unref().</doc>
40387 <return-value transfer-ownership="full">
40388 <doc xml:whitespace="preserve">a #GFile for the given @parse_name.</doc>
40389 <type name="File" c:type="GFile*"/>
40392 <parameter name="parse_name" transfer-ownership="none">
40393 <doc xml:whitespace="preserve">a string to be parsed by the VFS module.</doc>
40394 <type name="utf8" c:type="char*"/>
40398 <method name="get_file_for_path" c:identifier="g_vfs_get_file_for_path">
40399 <doc xml:whitespace="preserve">Gets a #GFile for @path.
40400 Free the returned object with g_object_unref().</doc>
40401 <return-value transfer-ownership="full">
40402 <doc xml:whitespace="preserve">a #GFile.</doc>
40403 <type name="File" c:type="GFile*"/>
40406 <parameter name="path" transfer-ownership="none">
40407 <doc xml:whitespace="preserve">a string containing a VFS path.</doc>
40408 <type name="utf8" c:type="char*"/>
40412 <method name="get_file_for_uri" c:identifier="g_vfs_get_file_for_uri">
40413 <doc xml:whitespace="preserve">Gets a #GFile for @uri.
40414 This operation never fails, but the returned object
40415 might not support any I/O operation if the URI
40416 is malformed or if the URI scheme is not supported.
40417 Free the returned object with g_object_unref().</doc>
40418 <return-value transfer-ownership="full">
40419 <doc xml:whitespace="preserve">a #GFile.</doc>
40420 <type name="File" c:type="GFile*"/>
40423 <parameter name="uri" transfer-ownership="none">
40424 <doc xml:whitespace="preserve">a string containing a URI</doc>
40425 <type name="utf8" c:type="char*"/>
40429 <method name="get_supported_uri_schemes"
40430 c:identifier="g_vfs_get_supported_uri_schemes">
40431 <doc xml:whitespace="preserve">Gets a list of URI schemes supported by @vfs.
40432 The returned array belongs to GIO and must
40433 not be freed or modified.</doc>
40434 <return-value transfer-ownership="none">
40435 <doc xml:whitespace="preserve">a %NULL-terminated array of strings.</doc>
40436 <array c:type="gchar**">
40437 <type name="utf8"/>
40441 <method name="is_active" c:identifier="g_vfs_is_active">
40442 <doc xml:whitespace="preserve">Checks if the VFS is active.</doc>
40443 <return-value transfer-ownership="none">
40444 <doc xml:whitespace="preserve">%TRUE if construction of the @vfs was successful and it is now active.</doc>
40445 <type name="gboolean" c:type="gboolean"/>
40448 <method name="parse_name" c:identifier="g_vfs_parse_name">
40449 <doc xml:whitespace="preserve">This operation never fails, but the returned object might
40450 not support any I/O operations if the @parse_name cannot
40451 be parsed by the #GVfs module.
40452 Free the returned object with g_object_unref().</doc>
40453 <return-value transfer-ownership="full">
40454 <doc xml:whitespace="preserve">a #GFile for the given @parse_name.</doc>
40455 <type name="File" c:type="GFile*"/>
40458 <parameter name="parse_name" transfer-ownership="none">
40459 <doc xml:whitespace="preserve">a string to be parsed by the VFS module.</doc>
40460 <type name="utf8" c:type="char*"/>
40464 <field name="parent_instance">
40465 <type name="GObject.Object" c:type="GObject"/>
40468 <record name="VfsClass" c:type="GVfsClass" glib:is-gtype-struct-for="Vfs">
40469 <field name="parent_class">
40470 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
40472 <field name="is_active">
40473 <callback name="is_active">
40474 <return-value transfer-ownership="none">
40475 <doc xml:whitespace="preserve">%TRUE if construction of the @vfs was successful and it is now active.</doc>
40476 <type name="gboolean" c:type="gboolean"/>
40479 <parameter name="vfs" transfer-ownership="none">
40480 <type name="Vfs" c:type="GVfs*"/>
40485 <field name="get_file_for_path">
40486 <callback name="get_file_for_path">
40487 <return-value transfer-ownership="full">
40488 <doc xml:whitespace="preserve">a #GFile.</doc>
40489 <type name="File" c:type="GFile*"/>
40492 <parameter name="vfs" transfer-ownership="none">
40493 <type name="Vfs" c:type="GVfs*"/>
40495 <parameter name="path" transfer-ownership="none">
40496 <doc xml:whitespace="preserve">a string containing a VFS path.</doc>
40497 <type name="utf8" c:type="char*"/>
40502 <field name="get_file_for_uri">
40503 <callback name="get_file_for_uri">
40504 <return-value transfer-ownership="full">
40505 <doc xml:whitespace="preserve">a #GFile.</doc>
40506 <type name="File" c:type="GFile*"/>
40509 <parameter name="vfs" transfer-ownership="none">
40510 <type name="Vfs" c:type="GVfs*"/>
40512 <parameter name="uri" transfer-ownership="none">
40513 <doc xml:whitespace="preserve">a string containing a URI</doc>
40514 <type name="utf8" c:type="char*"/>
40519 <field name="get_supported_uri_schemes">
40520 <callback name="get_supported_uri_schemes">
40521 <return-value transfer-ownership="none">
40522 <doc xml:whitespace="preserve">a %NULL-terminated array of strings.</doc>
40523 <array c:type="gchar**">
40524 <type name="utf8"/>
40528 <parameter name="vfs" transfer-ownership="none">
40529 <type name="Vfs" c:type="GVfs*"/>
40534 <field name="parse_name">
40535 <callback name="parse_name">
40536 <return-value transfer-ownership="full">
40537 <doc xml:whitespace="preserve">a #GFile for the given @parse_name.</doc>
40538 <type name="File" c:type="GFile*"/>
40541 <parameter name="vfs" transfer-ownership="none">
40542 <type name="Vfs" c:type="GVfs*"/>
40544 <parameter name="parse_name" transfer-ownership="none">
40545 <doc xml:whitespace="preserve">a string to be parsed by the VFS module.</doc>
40546 <type name="utf8" c:type="char*"/>
40551 <field name="local_file_add_info">
40552 <callback name="local_file_add_info">
40553 <return-value transfer-ownership="none">
40554 <type name="none" c:type="void"/>
40557 <parameter name="vfs" transfer-ownership="none">
40558 <type name="Vfs" c:type="GVfs*"/>
40560 <parameter name="filename" transfer-ownership="none">
40561 <type name="utf8" c:type="char*"/>
40563 <parameter name="device" transfer-ownership="none">
40564 <type name="guint64" c:type="guint64"/>
40566 <parameter name="attribute_matcher" transfer-ownership="none">
40567 <type name="FileAttributeMatcher"
40568 c:type="GFileAttributeMatcher*"/>
40570 <parameter name="info" transfer-ownership="none">
40571 <type name="FileInfo" c:type="GFileInfo*"/>
40573 <parameter name="cancellable" transfer-ownership="none">
40574 <type name="Cancellable" c:type="GCancellable*"/>
40576 <parameter name="extra_data" transfer-ownership="none">
40577 <type name="gpointer" c:type="gpointer*"/>
40579 <parameter name="free_extra_data"
40580 transfer-ownership="none"
40582 <type name="GLib.DestroyNotify" c:type="GDestroyNotify*"/>
40587 <field name="add_writable_namespaces">
40588 <callback name="add_writable_namespaces">
40589 <return-value transfer-ownership="none">
40590 <type name="none" c:type="void"/>
40593 <parameter name="vfs" transfer-ownership="none">
40594 <type name="Vfs" c:type="GVfs*"/>
40596 <parameter name="list" transfer-ownership="none">
40597 <type name="FileAttributeInfoList"
40598 c:type="GFileAttributeInfoList*"/>
40603 <field name="local_file_set_attributes">
40604 <callback name="local_file_set_attributes" throws="1">
40605 <return-value transfer-ownership="none">
40606 <type name="gboolean" c:type="gboolean"/>
40609 <parameter name="vfs" transfer-ownership="none">
40610 <type name="Vfs" c:type="GVfs*"/>
40612 <parameter name="filename" transfer-ownership="none">
40613 <type name="utf8" c:type="char*"/>
40615 <parameter name="info" transfer-ownership="none">
40616 <type name="FileInfo" c:type="GFileInfo*"/>
40618 <parameter name="flags" transfer-ownership="none">
40619 <type name="FileQueryInfoFlags" c:type="GFileQueryInfoFlags"/>
40621 <parameter name="cancellable" transfer-ownership="none">
40622 <type name="Cancellable" c:type="GCancellable*"/>
40627 <field name="local_file_removed">
40628 <callback name="local_file_removed">
40629 <return-value transfer-ownership="none">
40630 <type name="none" c:type="void"/>
40633 <parameter name="vfs" transfer-ownership="none">
40634 <type name="Vfs" c:type="GVfs*"/>
40636 <parameter name="filename" transfer-ownership="none">
40637 <type name="utf8" c:type="char*"/>
40642 <field name="local_file_moved">
40643 <callback name="local_file_moved">
40644 <return-value transfer-ownership="none">
40645 <type name="none" c:type="void"/>
40648 <parameter name="vfs" transfer-ownership="none">
40649 <type name="Vfs" c:type="GVfs*"/>
40651 <parameter name="source" transfer-ownership="none">
40652 <type name="utf8" c:type="char*"/>
40654 <parameter name="dest" transfer-ownership="none">
40655 <type name="utf8" c:type="char*"/>
40660 <field name="_g_reserved1" introspectable="0">
40661 <callback name="_g_reserved1">
40662 <return-value transfer-ownership="none">
40663 <type name="none" c:type="void"/>
40667 <field name="_g_reserved2" introspectable="0">
40668 <callback name="_g_reserved2">
40669 <return-value transfer-ownership="none">
40670 <type name="none" c:type="void"/>
40674 <field name="_g_reserved3" introspectable="0">
40675 <callback name="_g_reserved3">
40676 <return-value transfer-ownership="none">
40677 <type name="none" c:type="void"/>
40681 <field name="_g_reserved4" introspectable="0">
40682 <callback name="_g_reserved4">
40683 <return-value transfer-ownership="none">
40684 <type name="none" c:type="void"/>
40688 <field name="_g_reserved5" introspectable="0">
40689 <callback name="_g_reserved5">
40690 <return-value transfer-ownership="none">
40691 <type name="none" c:type="void"/>
40695 <field name="_g_reserved6" introspectable="0">
40696 <callback name="_g_reserved6">
40697 <return-value transfer-ownership="none">
40698 <type name="none" c:type="void"/>
40702 <field name="_g_reserved7" introspectable="0">
40703 <callback name="_g_reserved7">
40704 <return-value transfer-ownership="none">
40705 <type name="none" c:type="void"/>
40710 <interface name="Volume"
40711 c:symbol-prefix="volume"
40713 glib:type-name="GVolume"
40714 glib:get-type="g_volume_get_type"
40715 glib:type-struct="VolumeIface">
40716 <doc xml:whitespace="preserve">Opaque mountable volume object.</doc>
40717 <virtual-method name="can_eject" invoker="can_eject">
40718 <doc xml:whitespace="preserve">Checks if a volume can be ejected.</doc>
40719 <return-value transfer-ownership="none">
40720 <doc xml:whitespace="preserve">%TRUE if the @volume can be ejected. %FALSE otherwise.</doc>
40721 <type name="gboolean" c:type="gboolean"/>
40724 <virtual-method name="can_mount" invoker="can_mount">
40725 <doc xml:whitespace="preserve">Checks if a volume can be mounted.</doc>
40726 <return-value transfer-ownership="none">
40727 <doc xml:whitespace="preserve">%TRUE if the @volume can be mounted. %FALSE otherwise.</doc>
40728 <type name="gboolean" c:type="gboolean"/>
40731 <virtual-method name="eject"
40733 deprecated="Use g_volume_eject_with_operation() instead."
40734 deprecated-version="2.22">
40735 <doc xml:whitespace="preserve">Ejects a volume. This is an asynchronous operation, and is
40736 finished by calling g_volume_eject_finish() with the @volume
40737 and #GAsyncResult returned in the @callback.</doc>
40738 <return-value transfer-ownership="none">
40739 <type name="none" c:type="void"/>
40742 <parameter name="flags" transfer-ownership="none">
40743 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
40744 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
40746 <parameter name="cancellable"
40747 transfer-ownership="none"
40749 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
40750 <type name="Cancellable" c:type="GCancellable*"/>
40752 <parameter name="callback"
40753 transfer-ownership="none"
40756 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
40757 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
40759 <parameter name="user_data" transfer-ownership="none" closure="3">
40760 <doc xml:whitespace="preserve">user data that gets passed to @callback</doc>
40761 <type name="gpointer" c:type="gpointer"/>
40765 <virtual-method name="eject_finish"
40766 invoker="eject_finish"
40767 deprecated="Use g_volume_eject_with_operation_finish() instead."
40768 deprecated-version="2.22"
40770 <doc xml:whitespace="preserve">Finishes ejecting a volume. If any errors occured during the operation,</doc>
40771 <return-value transfer-ownership="none">
40772 <doc xml:whitespace="preserve">%TRUE, %FALSE if operation failed.</doc>
40773 <type name="gboolean" c:type="gboolean"/>
40776 <parameter name="result" transfer-ownership="none">
40777 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
40778 <type name="AsyncResult" c:type="GAsyncResult*"/>
40782 <virtual-method name="eject_with_operation"
40783 invoker="eject_with_operation"
40785 <doc xml:whitespace="preserve">Ejects a volume. This is an asynchronous operation, and is
40786 finished by calling g_volume_eject_with_operation_finish() with the @volume
40787 and #GAsyncResult data returned in the @callback.</doc>
40788 <return-value transfer-ownership="none">
40789 <type name="none" c:type="void"/>
40792 <parameter name="flags" transfer-ownership="none">
40793 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
40794 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
40796 <parameter name="mount_operation" transfer-ownership="none">
40797 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
40798 <type name="MountOperation" c:type="GMountOperation*"/>
40800 <parameter name="cancellable"
40801 transfer-ownership="none"
40803 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
40804 <type name="Cancellable" c:type="GCancellable*"/>
40806 <parameter name="callback"
40807 transfer-ownership="none"
40810 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
40811 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
40813 <parameter name="user_data" transfer-ownership="none" closure="4">
40814 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
40815 <type name="gpointer" c:type="gpointer"/>
40819 <virtual-method name="eject_with_operation_finish"
40820 invoker="eject_with_operation_finish"
40823 <doc xml:whitespace="preserve">Finishes ejecting a volume. If any errors occurred during the operation,</doc>
40824 <return-value transfer-ownership="none">
40825 <doc xml:whitespace="preserve">%TRUE if the volume was successfully ejected. %FALSE otherwise.</doc>
40826 <type name="gboolean" c:type="gboolean"/>
40829 <parameter name="result" transfer-ownership="none">
40830 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
40831 <type name="AsyncResult" c:type="GAsyncResult*"/>
40835 <virtual-method name="enumerate_identifiers"
40836 invoker="enumerate_identifiers">
40837 <doc xml:whitespace="preserve">Gets the kinds of <link linkend="volume-identifier">identifiers</link>
40838 that @volume has. Use g_volume_get_identifer() to obtain
40839 the identifiers themselves.
40840 of strings containing kinds of identifiers. Use g_strfreev() to free.</doc>
40841 <return-value transfer-ownership="full">
40842 <doc xml:whitespace="preserve">a %NULL-terminated array</doc>
40843 <array c:type="char**">
40844 <type name="utf8"/>
40848 <virtual-method name="get_activation_root"
40849 invoker="get_activation_root"
40851 <doc xml:whitespace="preserve">Gets the activation root for a #GVolume if it is known ahead of
40852 mount time. Returns %NULL otherwise. If not %NULL and if @volume
40853 is mounted, then the result of g_mount_get_root() on the
40854 #GMount object obtained from g_volume_get_mount() will always
40855 either be equal or a prefix of what this function returns. In
40856 other words, in code
40857 <programlisting>
40860 GFile *volume_activation_root;
40861 mount = g_volume_get_mount (volume); /&ast; mounted, so never NULL &ast;/
40862 mount_root = g_mount_get_root (mount);
40863 volume_activation_root = g_volume_get_activation_root(volume); /&ast; assume not NULL &ast;/
40864 </programlisting>
40865 then the expression
40866 <programlisting>
40867 (g_file_has_prefix (volume_activation_root, mount_root) ||
40868 </programlisting>
40869 will always be %TRUE.
40870 Activation roots are typically used in #GVolumeMonitor
40871 implementations to find the underlying mount to shadow, see
40872 g_mount_is_shadowed() for more details.
40873 g_object_unref() to free.</doc>
40874 <return-value transfer-ownership="full">
40875 <doc xml:whitespace="preserve">the activation root of @volume or %NULL. Use</doc>
40876 <type name="File" c:type="GFile*"/>
40879 <virtual-method name="get_drive" invoker="get_drive">
40880 <doc xml:whitespace="preserve">Gets the drive for the @volume.
40881 The returned object should be unreffed with g_object_unref()
40882 when no longer needed.</doc>
40883 <return-value transfer-ownership="full">
40884 <doc xml:whitespace="preserve">a #GDrive or %NULL if @volume is not associated with a drive.</doc>
40885 <type name="Drive" c:type="GDrive*"/>
40888 <virtual-method name="get_icon" invoker="get_icon">
40889 <doc xml:whitespace="preserve">Gets the icon for @volume.
40890 The returned object should be unreffed with g_object_unref()
40891 when no longer needed.</doc>
40892 <return-value transfer-ownership="full">
40893 <doc xml:whitespace="preserve">a #GIcon.</doc>
40894 <type name="Icon" c:type="GIcon*"/>
40897 <virtual-method name="get_identifier" invoker="get_identifier">
40898 <doc xml:whitespace="preserve">Gets the identifier of the given kind for @volume.
40899 See the <link linkend="volume-identifier">introduction</link>
40900 for more information about volume identifiers.
40901 requested identfier, or %NULL if the #GVolume
40902 doesn't have this kind of identifier</doc>
40903 <return-value transfer-ownership="full">
40904 <doc xml:whitespace="preserve">a newly allocated string containing the</doc>
40905 <type name="utf8" c:type="char*"/>
40908 <parameter name="kind" transfer-ownership="none">
40909 <doc xml:whitespace="preserve">the kind of identifier to return</doc>
40910 <type name="utf8" c:type="char*"/>
40914 <virtual-method name="get_mount" invoker="get_mount">
40915 <doc xml:whitespace="preserve">Gets the mount for the @volume.
40916 The returned object should be unreffed with g_object_unref()
40917 when no longer needed.</doc>
40918 <return-value transfer-ownership="full">
40919 <doc xml:whitespace="preserve">a #GMount or %NULL if @volume isn't mounted.</doc>
40920 <type name="Mount" c:type="GMount*"/>
40923 <virtual-method name="get_name" invoker="get_name">
40924 <doc xml:whitespace="preserve">Gets the name of @volume.
40925 be freed with g_free() when no longer needed.</doc>
40926 <return-value transfer-ownership="full">
40927 <doc xml:whitespace="preserve">the name for the given @volume. The returned string should</doc>
40928 <type name="utf8" c:type="char*"/>
40931 <virtual-method name="get_uuid" invoker="get_uuid">
40932 <doc xml:whitespace="preserve">Gets the UUID for the @volume. The reference is typically based on
40933 the file system UUID for the volume in question and should be
40934 considered an opaque string. Returns %NULL if there is no UUID
40936 The returned string should be freed with g_free()
40937 when no longer needed.</doc>
40938 <return-value transfer-ownership="full">
40939 <doc xml:whitespace="preserve">the UUID for @volume or %NULL if no UUID can be computed.</doc>
40940 <type name="utf8" c:type="char*"/>
40943 <virtual-method name="mount_finish" invoker="mount_finish" throws="1">
40944 <doc xml:whitespace="preserve">Finishes mounting a volume. If any errors occured during the operation,
40945 If the mount operation succeeded, g_volume_get_mount() on @volume
40946 is guaranteed to return the mount right after calling this
40947 function; there's no need to listen for the 'mount-added' signal on
40948 #GVolumeMonitor.</doc>
40949 <return-value transfer-ownership="none">
40950 <doc xml:whitespace="preserve">%TRUE, %FALSE if operation failed.</doc>
40951 <type name="gboolean" c:type="gboolean"/>
40954 <parameter name="result" transfer-ownership="none">
40955 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
40956 <type name="AsyncResult" c:type="GAsyncResult*"/>
40960 <virtual-method name="mount_fn" invoker="mount">
40961 <doc xml:whitespace="preserve">Mounts a volume. This is an asynchronous operation, and is
40962 finished by calling g_volume_mount_finish() with the @volume
40963 and #GAsyncResult returned in the @callback.</doc>
40964 <return-value transfer-ownership="none">
40965 <type name="none" c:type="void"/>
40968 <parameter name="flags" transfer-ownership="none">
40969 <doc xml:whitespace="preserve">flags affecting the operation</doc>
40970 <type name="MountMountFlags" c:type="GMountMountFlags"/>
40972 <parameter name="mount_operation"
40973 transfer-ownership="none"
40975 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
40976 <type name="MountOperation" c:type="GMountOperation*"/>
40978 <parameter name="cancellable"
40979 transfer-ownership="none"
40981 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
40982 <type name="Cancellable" c:type="GCancellable*"/>
40984 <parameter name="callback"
40985 transfer-ownership="none"
40988 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
40989 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
40991 <parameter name="user_data" transfer-ownership="none" closure="4">
40992 <doc xml:whitespace="preserve">user data that gets passed to @callback</doc>
40993 <type name="gpointer" c:type="gpointer"/>
40997 <virtual-method name="should_automount" invoker="should_automount">
40998 <doc xml:whitespace="preserve">Returns whether the volume should be automatically mounted.</doc>
40999 <return-value transfer-ownership="none">
41000 <doc xml:whitespace="preserve">%TRUE if the volume should be automatically mounted.</doc>
41001 <type name="gboolean" c:type="gboolean"/>
41004 <method name="can_eject" c:identifier="g_volume_can_eject">
41005 <doc xml:whitespace="preserve">Checks if a volume can be ejected.</doc>
41006 <return-value transfer-ownership="none">
41007 <doc xml:whitespace="preserve">%TRUE if the @volume can be ejected. %FALSE otherwise.</doc>
41008 <type name="gboolean" c:type="gboolean"/>
41011 <method name="can_mount" c:identifier="g_volume_can_mount">
41012 <doc xml:whitespace="preserve">Checks if a volume can be mounted.</doc>
41013 <return-value transfer-ownership="none">
41014 <doc xml:whitespace="preserve">%TRUE if the @volume can be mounted. %FALSE otherwise.</doc>
41015 <type name="gboolean" c:type="gboolean"/>
41018 <method name="eject"
41019 c:identifier="g_volume_eject"
41020 deprecated="Use g_volume_eject_with_operation() instead."
41021 deprecated-version="2.22">
41022 <doc xml:whitespace="preserve">Ejects a volume. This is an asynchronous operation, and is
41023 finished by calling g_volume_eject_finish() with the @volume
41024 and #GAsyncResult returned in the @callback.</doc>
41025 <return-value transfer-ownership="none">
41026 <type name="none" c:type="void"/>
41029 <parameter name="flags" transfer-ownership="none">
41030 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
41031 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
41033 <parameter name="cancellable"
41034 transfer-ownership="none"
41036 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
41037 <type name="Cancellable" c:type="GCancellable*"/>
41039 <parameter name="callback"
41040 transfer-ownership="none"
41043 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
41044 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
41046 <parameter name="user_data" transfer-ownership="none">
41047 <doc xml:whitespace="preserve">user data that gets passed to @callback</doc>
41048 <type name="gpointer" c:type="gpointer"/>
41052 <method name="eject_finish"
41053 c:identifier="g_volume_eject_finish"
41054 deprecated="Use g_volume_eject_with_operation_finish() instead."
41055 deprecated-version="2.22"
41057 <doc xml:whitespace="preserve">Finishes ejecting a volume. If any errors occured during the operation,</doc>
41058 <return-value transfer-ownership="none">
41059 <doc xml:whitespace="preserve">%TRUE, %FALSE if operation failed.</doc>
41060 <type name="gboolean" c:type="gboolean"/>
41063 <parameter name="result" transfer-ownership="none">
41064 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
41065 <type name="AsyncResult" c:type="GAsyncResult*"/>
41069 <method name="eject_with_operation"
41070 c:identifier="g_volume_eject_with_operation"
41072 <doc xml:whitespace="preserve">Ejects a volume. This is an asynchronous operation, and is
41073 finished by calling g_volume_eject_with_operation_finish() with the @volume
41074 and #GAsyncResult data returned in the @callback.</doc>
41075 <return-value transfer-ownership="none">
41076 <type name="none" c:type="void"/>
41079 <parameter name="flags" transfer-ownership="none">
41080 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
41081 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
41083 <parameter name="mount_operation" transfer-ownership="none">
41084 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
41085 <type name="MountOperation" c:type="GMountOperation*"/>
41087 <parameter name="cancellable"
41088 transfer-ownership="none"
41090 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
41091 <type name="Cancellable" c:type="GCancellable*"/>
41093 <parameter name="callback"
41094 transfer-ownership="none"
41097 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
41098 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
41100 <parameter name="user_data" transfer-ownership="none">
41101 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
41102 <type name="gpointer" c:type="gpointer"/>
41106 <method name="eject_with_operation_finish"
41107 c:identifier="g_volume_eject_with_operation_finish"
41110 <doc xml:whitespace="preserve">Finishes ejecting a volume. If any errors occurred during the operation,</doc>
41111 <return-value transfer-ownership="none">
41112 <doc xml:whitespace="preserve">%TRUE if the volume was successfully ejected. %FALSE otherwise.</doc>
41113 <type name="gboolean" c:type="gboolean"/>
41116 <parameter name="result" transfer-ownership="none">
41117 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
41118 <type name="AsyncResult" c:type="GAsyncResult*"/>
41122 <method name="enumerate_identifiers"
41123 c:identifier="g_volume_enumerate_identifiers">
41124 <doc xml:whitespace="preserve">Gets the kinds of <link linkend="volume-identifier">identifiers</link>
41125 that @volume has. Use g_volume_get_identifer() to obtain
41126 the identifiers themselves.
41127 of strings containing kinds of identifiers. Use g_strfreev() to free.</doc>
41128 <return-value transfer-ownership="full">
41129 <doc xml:whitespace="preserve">a %NULL-terminated array</doc>
41130 <array c:type="char**">
41131 <type name="utf8"/>
41135 <method name="get_activation_root"
41136 c:identifier="g_volume_get_activation_root"
41138 <doc xml:whitespace="preserve">Gets the activation root for a #GVolume if it is known ahead of
41139 mount time. Returns %NULL otherwise. If not %NULL and if @volume
41140 is mounted, then the result of g_mount_get_root() on the
41141 #GMount object obtained from g_volume_get_mount() will always
41142 either be equal or a prefix of what this function returns. In
41143 other words, in code
41144 <programlisting>
41147 GFile *volume_activation_root;
41148 mount = g_volume_get_mount (volume); /&ast; mounted, so never NULL &ast;/
41149 mount_root = g_mount_get_root (mount);
41150 volume_activation_root = g_volume_get_activation_root(volume); /&ast; assume not NULL &ast;/
41151 </programlisting>
41152 then the expression
41153 <programlisting>
41154 (g_file_has_prefix (volume_activation_root, mount_root) ||
41155 </programlisting>
41156 will always be %TRUE.
41157 Activation roots are typically used in #GVolumeMonitor
41158 implementations to find the underlying mount to shadow, see
41159 g_mount_is_shadowed() for more details.
41160 g_object_unref() to free.</doc>
41161 <return-value transfer-ownership="full">
41162 <doc xml:whitespace="preserve">the activation root of @volume or %NULL. Use</doc>
41163 <type name="File" c:type="GFile*"/>
41166 <method name="get_drive" c:identifier="g_volume_get_drive">
41167 <doc xml:whitespace="preserve">Gets the drive for the @volume.
41168 The returned object should be unreffed with g_object_unref()
41169 when no longer needed.</doc>
41170 <return-value transfer-ownership="full">
41171 <doc xml:whitespace="preserve">a #GDrive or %NULL if @volume is not associated with a drive.</doc>
41172 <type name="Drive" c:type="GDrive*"/>
41175 <method name="get_icon" c:identifier="g_volume_get_icon">
41176 <doc xml:whitespace="preserve">Gets the icon for @volume.
41177 The returned object should be unreffed with g_object_unref()
41178 when no longer needed.</doc>
41179 <return-value transfer-ownership="full">
41180 <doc xml:whitespace="preserve">a #GIcon.</doc>
41181 <type name="Icon" c:type="GIcon*"/>
41184 <method name="get_identifier" c:identifier="g_volume_get_identifier">
41185 <doc xml:whitespace="preserve">Gets the identifier of the given kind for @volume.
41186 See the <link linkend="volume-identifier">introduction</link>
41187 for more information about volume identifiers.
41188 requested identfier, or %NULL if the #GVolume
41189 doesn't have this kind of identifier</doc>
41190 <return-value transfer-ownership="full">
41191 <doc xml:whitespace="preserve">a newly allocated string containing the</doc>
41192 <type name="utf8" c:type="char*"/>
41195 <parameter name="kind" transfer-ownership="none">
41196 <doc xml:whitespace="preserve">the kind of identifier to return</doc>
41197 <type name="utf8" c:type="char*"/>
41201 <method name="get_mount" c:identifier="g_volume_get_mount">
41202 <doc xml:whitespace="preserve">Gets the mount for the @volume.
41203 The returned object should be unreffed with g_object_unref()
41204 when no longer needed.</doc>
41205 <return-value transfer-ownership="full">
41206 <doc xml:whitespace="preserve">a #GMount or %NULL if @volume isn't mounted.</doc>
41207 <type name="Mount" c:type="GMount*"/>
41210 <method name="get_name" c:identifier="g_volume_get_name">
41211 <doc xml:whitespace="preserve">Gets the name of @volume.
41212 be freed with g_free() when no longer needed.</doc>
41213 <return-value transfer-ownership="full">
41214 <doc xml:whitespace="preserve">the name for the given @volume. The returned string should</doc>
41215 <type name="utf8" c:type="char*"/>
41218 <method name="get_uuid" c:identifier="g_volume_get_uuid">
41219 <doc xml:whitespace="preserve">Gets the UUID for the @volume. The reference is typically based on
41220 the file system UUID for the volume in question and should be
41221 considered an opaque string. Returns %NULL if there is no UUID
41223 The returned string should be freed with g_free()
41224 when no longer needed.</doc>
41225 <return-value transfer-ownership="full">
41226 <doc xml:whitespace="preserve">the UUID for @volume or %NULL if no UUID can be computed.</doc>
41227 <type name="utf8" c:type="char*"/>
41230 <method name="mount" c:identifier="g_volume_mount">
41231 <doc xml:whitespace="preserve">Mounts a volume. This is an asynchronous operation, and is
41232 finished by calling g_volume_mount_finish() with the @volume
41233 and #GAsyncResult returned in the @callback.</doc>
41234 <return-value transfer-ownership="none">
41235 <type name="none" c:type="void"/>
41238 <parameter name="flags" transfer-ownership="none">
41239 <doc xml:whitespace="preserve">flags affecting the operation</doc>
41240 <type name="MountMountFlags" c:type="GMountMountFlags"/>
41242 <parameter name="mount_operation"
41243 transfer-ownership="none"
41245 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
41246 <type name="MountOperation" c:type="GMountOperation*"/>
41248 <parameter name="cancellable"
41249 transfer-ownership="none"
41251 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
41252 <type name="Cancellable" c:type="GCancellable*"/>
41254 <parameter name="callback"
41255 transfer-ownership="none"
41258 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
41259 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
41261 <parameter name="user_data" transfer-ownership="none">
41262 <doc xml:whitespace="preserve">user data that gets passed to @callback</doc>
41263 <type name="gpointer" c:type="gpointer"/>
41267 <method name="mount_finish"
41268 c:identifier="g_volume_mount_finish"
41270 <doc xml:whitespace="preserve">Finishes mounting a volume. If any errors occured during the operation,
41271 If the mount operation succeeded, g_volume_get_mount() on @volume
41272 is guaranteed to return the mount right after calling this
41273 function; there's no need to listen for the 'mount-added' signal on
41274 #GVolumeMonitor.</doc>
41275 <return-value transfer-ownership="none">
41276 <doc xml:whitespace="preserve">%TRUE, %FALSE if operation failed.</doc>
41277 <type name="gboolean" c:type="gboolean"/>
41280 <parameter name="result" transfer-ownership="none">
41281 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
41282 <type name="AsyncResult" c:type="GAsyncResult*"/>
41286 <method name="should_automount" c:identifier="g_volume_should_automount">
41287 <doc xml:whitespace="preserve">Returns whether the volume should be automatically mounted.</doc>
41288 <return-value transfer-ownership="none">
41289 <doc xml:whitespace="preserve">%TRUE if the volume should be automatically mounted.</doc>
41290 <type name="gboolean" c:type="gboolean"/>
41293 <glib:signal name="changed">
41294 <doc xml:whitespace="preserve">Emitted when the volume has been changed.</doc>
41295 <return-value transfer-ownership="none">
41296 <type name="none"/>
41299 <glib:signal name="removed">
41300 <doc xml:whitespace="preserve">This signal is emitted when the #GVolume have been removed. If
41301 the recipient is holding references to the object they should
41302 release them so the object can be finalized.</doc>
41303 <return-value transfer-ownership="none">
41304 <type name="none"/>
41308 <record name="VolumeIface"
41309 c:type="GVolumeIface"
41310 glib:is-gtype-struct-for="Volume">
41311 <doc xml:whitespace="preserve">Interface for implementing operations for mountable volumes.</doc>
41312 <field name="g_iface">
41313 <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
41315 <field name="changed">
41316 <callback name="changed">
41317 <return-value transfer-ownership="none">
41318 <type name="none" c:type="void"/>
41321 <parameter name="volume" transfer-ownership="none">
41322 <type name="Volume" c:type="GVolume*"/>
41327 <field name="removed">
41328 <callback name="removed">
41329 <return-value transfer-ownership="none">
41330 <type name="none" c:type="void"/>
41333 <parameter name="volume" transfer-ownership="none">
41334 <type name="Volume" c:type="GVolume*"/>
41339 <field name="get_name">
41340 <callback name="get_name">
41341 <return-value transfer-ownership="full">
41342 <doc xml:whitespace="preserve">the name for the given @volume. The returned string should</doc>
41343 <type name="utf8" c:type="char*"/>
41346 <parameter name="volume" transfer-ownership="none">
41347 <type name="Volume" c:type="GVolume*"/>
41352 <field name="get_icon">
41353 <callback name="get_icon">
41354 <return-value transfer-ownership="full">
41355 <doc xml:whitespace="preserve">a #GIcon.</doc>
41356 <type name="Icon" c:type="GIcon*"/>
41359 <parameter name="volume" transfer-ownership="none">
41360 <type name="Volume" c:type="GVolume*"/>
41365 <field name="get_uuid">
41366 <callback name="get_uuid">
41367 <return-value transfer-ownership="full">
41368 <doc xml:whitespace="preserve">the UUID for @volume or %NULL if no UUID can be computed.</doc>
41369 <type name="utf8" c:type="char*"/>
41372 <parameter name="volume" transfer-ownership="none">
41373 <type name="Volume" c:type="GVolume*"/>
41378 <field name="get_drive">
41379 <callback name="get_drive">
41380 <return-value transfer-ownership="full">
41381 <doc xml:whitespace="preserve">a #GDrive or %NULL if @volume is not associated with a drive.</doc>
41382 <type name="Drive" c:type="GDrive*"/>
41385 <parameter name="volume" transfer-ownership="none">
41386 <type name="Volume" c:type="GVolume*"/>
41391 <field name="get_mount">
41392 <callback name="get_mount">
41393 <return-value transfer-ownership="full">
41394 <doc xml:whitespace="preserve">a #GMount or %NULL if @volume isn't mounted.</doc>
41395 <type name="Mount" c:type="GMount*"/>
41398 <parameter name="volume" transfer-ownership="none">
41399 <type name="Volume" c:type="GVolume*"/>
41404 <field name="can_mount">
41405 <callback name="can_mount">
41406 <return-value transfer-ownership="none">
41407 <doc xml:whitespace="preserve">%TRUE if the @volume can be mounted. %FALSE otherwise.</doc>
41408 <type name="gboolean" c:type="gboolean"/>
41411 <parameter name="volume" transfer-ownership="none">
41412 <type name="Volume" c:type="GVolume*"/>
41417 <field name="can_eject">
41418 <callback name="can_eject">
41419 <return-value transfer-ownership="none">
41420 <doc xml:whitespace="preserve">%TRUE if the @volume can be ejected. %FALSE otherwise.</doc>
41421 <type name="gboolean" c:type="gboolean"/>
41424 <parameter name="volume" transfer-ownership="none">
41425 <type name="Volume" c:type="GVolume*"/>
41430 <field name="mount_fn">
41431 <callback name="mount_fn">
41432 <return-value transfer-ownership="none">
41433 <type name="none" c:type="void"/>
41436 <parameter name="volume" transfer-ownership="none">
41437 <type name="Volume" c:type="GVolume*"/>
41439 <parameter name="flags" transfer-ownership="none">
41440 <doc xml:whitespace="preserve">flags affecting the operation</doc>
41441 <type name="MountMountFlags" c:type="GMountMountFlags"/>
41443 <parameter name="mount_operation"
41444 transfer-ownership="none"
41446 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
41447 <type name="MountOperation" c:type="GMountOperation*"/>
41449 <parameter name="cancellable"
41450 transfer-ownership="none"
41452 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
41453 <type name="Cancellable" c:type="GCancellable*"/>
41455 <parameter name="callback"
41456 transfer-ownership="none"
41459 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
41460 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
41462 <parameter name="user_data" transfer-ownership="none" closure="5">
41463 <doc xml:whitespace="preserve">user data that gets passed to @callback</doc>
41464 <type name="gpointer" c:type="gpointer"/>
41469 <field name="mount_finish">
41470 <callback name="mount_finish" throws="1">
41471 <return-value transfer-ownership="none">
41472 <doc xml:whitespace="preserve">%TRUE, %FALSE if operation failed.</doc>
41473 <type name="gboolean" c:type="gboolean"/>
41476 <parameter name="volume" transfer-ownership="none">
41477 <type name="Volume" c:type="GVolume*"/>
41479 <parameter name="result" transfer-ownership="none">
41480 <doc xml:whitespace="preserve">a #GAsyncResult</doc>
41481 <type name="AsyncResult" c:type="GAsyncResult*"/>
41486 <field name="eject">
41487 <callback name="eject">
41488 <return-value transfer-ownership="none">
41489 <type name="none" c:type="void"/>
41492 <parameter name="volume" transfer-ownership="none">
41493 <type name="Volume" c:type="GVolume*"/>
41495 <parameter name="flags" transfer-ownership="none">
41496 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
41497 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
41499 <parameter name="cancellable"
41500 transfer-ownership="none"
41502 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
41503 <type name="Cancellable" c:type="GCancellable*"/>
41505 <parameter name="callback"
41506 transfer-ownership="none"
41509 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
41510 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
41512 <parameter name="user_data" transfer-ownership="none" closure="4">
41513 <doc xml:whitespace="preserve">user data that gets passed to @callback</doc>
41514 <type name="gpointer" c:type="gpointer"/>
41519 <field name="eject_finish">
41520 <callback name="eject_finish" throws="1">
41521 <return-value transfer-ownership="none">
41522 <doc xml:whitespace="preserve">%TRUE, %FALSE if operation failed.</doc>
41523 <type name="gboolean" c:type="gboolean"/>
41526 <parameter name="volume" transfer-ownership="none">
41527 <type name="Volume" c:type="GVolume*"/>
41529 <parameter name="result" transfer-ownership="none">
41530 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
41531 <type name="AsyncResult" c:type="GAsyncResult*"/>
41536 <field name="get_identifier">
41537 <callback name="get_identifier">
41538 <return-value transfer-ownership="full">
41539 <doc xml:whitespace="preserve">a newly allocated string containing the</doc>
41540 <type name="utf8" c:type="char*"/>
41543 <parameter name="volume" transfer-ownership="none">
41544 <type name="Volume" c:type="GVolume*"/>
41546 <parameter name="kind" transfer-ownership="none">
41547 <doc xml:whitespace="preserve">the kind of identifier to return</doc>
41548 <type name="utf8" c:type="char*"/>
41553 <field name="enumerate_identifiers">
41554 <callback name="enumerate_identifiers">
41555 <return-value transfer-ownership="full">
41556 <doc xml:whitespace="preserve">a %NULL-terminated array</doc>
41557 <array c:type="char**">
41558 <type name="utf8"/>
41562 <parameter name="volume" transfer-ownership="none">
41563 <type name="Volume" c:type="GVolume*"/>
41568 <field name="should_automount">
41569 <callback name="should_automount">
41570 <return-value transfer-ownership="none">
41571 <doc xml:whitespace="preserve">%TRUE if the volume should be automatically mounted.</doc>
41572 <type name="gboolean" c:type="gboolean"/>
41575 <parameter name="volume" transfer-ownership="none">
41576 <type name="Volume" c:type="GVolume*"/>
41581 <field name="get_activation_root">
41582 <callback name="get_activation_root">
41583 <return-value transfer-ownership="full">
41584 <doc xml:whitespace="preserve">the activation root of @volume or %NULL. Use</doc>
41585 <type name="File" c:type="GFile*"/>
41588 <parameter name="volume" transfer-ownership="none">
41589 <type name="Volume" c:type="GVolume*"/>
41594 <field name="eject_with_operation">
41595 <callback name="eject_with_operation">
41596 <return-value transfer-ownership="none">
41597 <type name="none" c:type="void"/>
41600 <parameter name="volume" transfer-ownership="none">
41601 <type name="Volume" c:type="GVolume*"/>
41603 <parameter name="flags" transfer-ownership="none">
41604 <doc xml:whitespace="preserve">flags affecting the unmount if required for eject</doc>
41605 <type name="MountUnmountFlags" c:type="GMountUnmountFlags"/>
41607 <parameter name="mount_operation" transfer-ownership="none">
41608 <doc xml:whitespace="preserve">a #GMountOperation or %NULL to avoid user interaction.</doc>
41609 <type name="MountOperation" c:type="GMountOperation*"/>
41611 <parameter name="cancellable"
41612 transfer-ownership="none"
41614 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
41615 <type name="Cancellable" c:type="GCancellable*"/>
41617 <parameter name="callback"
41618 transfer-ownership="none"
41621 <doc xml:whitespace="preserve">a #GAsyncReadyCallback, or %NULL.</doc>
41622 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
41624 <parameter name="user_data" transfer-ownership="none" closure="5">
41625 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
41626 <type name="gpointer" c:type="gpointer"/>
41631 <field name="eject_with_operation_finish">
41632 <callback name="eject_with_operation_finish" throws="1">
41633 <return-value transfer-ownership="none">
41634 <doc xml:whitespace="preserve">%TRUE if the volume was successfully ejected. %FALSE otherwise.</doc>
41635 <type name="gboolean" c:type="gboolean"/>
41638 <parameter name="volume" transfer-ownership="none">
41639 <type name="Volume" c:type="GVolume*"/>
41641 <parameter name="result" transfer-ownership="none">
41642 <doc xml:whitespace="preserve">a #GAsyncResult.</doc>
41643 <type name="AsyncResult" c:type="GAsyncResult*"/>
41649 <class name="VolumeMonitor"
41650 c:symbol-prefix="volume_monitor"
41651 c:type="GVolumeMonitor"
41652 parent="GObject.Object"
41653 glib:type-name="GVolumeMonitor"
41654 glib:get-type="g_volume_monitor_get_type"
41655 glib:type-struct="VolumeMonitorClass">
41656 <doc xml:whitespace="preserve">A Volume Monitor that watches for volume events.</doc>
41657 <function name="adopt_orphan_mount"
41658 c:identifier="g_volume_monitor_adopt_orphan_mount"
41659 deprecated="Instead of using this function, #GVolumeMonitor"
41660 deprecated-version="2.20">
41661 <doc xml:whitespace="preserve">This function should be called by any #GVolumeMonitor
41662 implementation when a new #GMount object is created that is not
41663 associated with a #GVolume object. It must be called just before
41664 emitting the @mount_added signal.
41665 If the return value is not %NULL, the caller must associate the
41666 returned #GVolume object with the #GMount. This involves returning
41667 it in its g_mount_get_volume() implementation. The caller must
41668 also listen for the "removed" signal on the returned object
41669 and give up its reference when handling that signal
41670 Similary, if implementing g_volume_monitor_adopt_orphan_mount(),
41671 the implementor must take a reference to @mount and return it in
41672 its g_volume_get_mount() implemented. Also, the implementor must
41673 listen for the "unmounted" signal on @mount and give up its
41674 reference upon handling that signal.
41675 There are two main use cases for this function.
41676 One is when implementing a user space file system driver that reads
41677 blocks of a block device that is already represented by the native
41678 volume monitor (for example a CD Audio file system driver). Such
41679 a driver will generate its own #GMount object that needs to be
41680 assoicated with the #GVolume object that represents the volume.
41681 The other is for implementing a #GVolumeMonitor whose sole purpose
41682 is to return #GVolume objects representing entries in the users
41683 "favorite servers" list or similar.
41684 if no wants to adopt the #GMount.
41685 implementations should instead create shadow mounts with the URI of
41686 the mount they intend to adopt. See the proxy volume monitor in
41687 gvfs for an example of this. Also see g_mount_is_shadowed(),
41688 g_mount_shadow() and g_mount_unshadow() functions.</doc>
41689 <return-value transfer-ownership="full">
41690 <doc xml:whitespace="preserve">the #GVolume object that is the parent for @mount or %NULL</doc>
41691 <type name="Volume" c:type="GVolume*"/>
41694 <parameter name="mount" transfer-ownership="none">
41695 <doc xml:whitespace="preserve">a #GMount object to find a parent for</doc>
41696 <type name="Mount" c:type="GMount*"/>
41700 <function name="get" c:identifier="g_volume_monitor_get">
41701 <doc xml:whitespace="preserve">Gets the volume monitor used by gio.
41702 g_object_unref() when done with it.</doc>
41703 <return-value transfer-ownership="full">
41704 <doc xml:whitespace="preserve">a reference to the #GVolumeMonitor used by gio. Call</doc>
41705 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
41708 <virtual-method name="get_connected_drives"
41709 invoker="get_connected_drives">
41710 <doc xml:whitespace="preserve">Gets a list of drives connected to the system.
41711 The returned list should be freed with g_list_free(), after
41712 its elements have been unreffed with g_object_unref().</doc>
41713 <return-value transfer-ownership="full">
41714 <doc xml:whitespace="preserve">a #GList of connected #GDrive objects.</doc>
41715 <type name="GLib.List" c:type="GList*">
41716 <type name="Drive"/>
41720 <virtual-method name="get_mount_for_uuid" invoker="get_mount_for_uuid">
41721 <doc xml:whitespace="preserve">Finds a #GMount object by its UUID (see g_mount_get_uuid())
41722 Free the returned object with g_object_unref().</doc>
41723 <return-value transfer-ownership="full">
41724 <doc xml:whitespace="preserve">a #GMount or %NULL if no such mount is available.</doc>
41725 <type name="Mount" c:type="GMount*"/>
41728 <parameter name="uuid" transfer-ownership="none">
41729 <doc xml:whitespace="preserve">the UUID to look for</doc>
41730 <type name="utf8" c:type="char*"/>
41734 <virtual-method name="get_mounts" invoker="get_mounts">
41735 <doc xml:whitespace="preserve">Gets a list of the mounts on the system.
41736 The returned list should be freed with g_list_free(), after
41737 its elements have been unreffed with g_object_unref().</doc>
41738 <return-value transfer-ownership="full">
41739 <doc xml:whitespace="preserve">a #GList of #GMount objects.</doc>
41740 <type name="GLib.List" c:type="GList*">
41741 <type name="Mount"/>
41745 <virtual-method name="get_volume_for_uuid" invoker="get_volume_for_uuid">
41746 <doc xml:whitespace="preserve">Finds a #GVolume object by its UUID (see g_volume_get_uuid())
41747 Free the returned object with g_object_unref().</doc>
41748 <return-value transfer-ownership="full">
41749 <doc xml:whitespace="preserve">a #GVolume or %NULL if no such volume is available.</doc>
41750 <type name="Volume" c:type="GVolume*"/>
41753 <parameter name="uuid" transfer-ownership="none">
41754 <doc xml:whitespace="preserve">the UUID to look for</doc>
41755 <type name="utf8" c:type="char*"/>
41759 <virtual-method name="get_volumes" invoker="get_volumes">
41760 <doc xml:whitespace="preserve">Gets a list of the volumes on the system.
41761 The returned list should be freed with g_list_free(), after
41762 its elements have been unreffed with g_object_unref().</doc>
41763 <return-value transfer-ownership="full">
41764 <doc xml:whitespace="preserve">a #GList of #GVolume objects.</doc>
41765 <type name="GLib.List" c:type="GList*">
41766 <type name="Volume"/>
41770 <method name="get_connected_drives"
41771 c:identifier="g_volume_monitor_get_connected_drives">
41772 <doc xml:whitespace="preserve">Gets a list of drives connected to the system.
41773 The returned list should be freed with g_list_free(), after
41774 its elements have been unreffed with g_object_unref().</doc>
41775 <return-value transfer-ownership="full">
41776 <doc xml:whitespace="preserve">a #GList of connected #GDrive objects.</doc>
41777 <type name="GLib.List" c:type="GList*">
41778 <type name="Drive"/>
41782 <method name="get_mount_for_uuid"
41783 c:identifier="g_volume_monitor_get_mount_for_uuid">
41784 <doc xml:whitespace="preserve">Finds a #GMount object by its UUID (see g_mount_get_uuid())
41785 Free the returned object with g_object_unref().</doc>
41786 <return-value transfer-ownership="full">
41787 <doc xml:whitespace="preserve">a #GMount or %NULL if no such mount is available.</doc>
41788 <type name="Mount" c:type="GMount*"/>
41791 <parameter name="uuid" transfer-ownership="none">
41792 <doc xml:whitespace="preserve">the UUID to look for</doc>
41793 <type name="utf8" c:type="char*"/>
41797 <method name="get_mounts" c:identifier="g_volume_monitor_get_mounts">
41798 <doc xml:whitespace="preserve">Gets a list of the mounts on the system.
41799 The returned list should be freed with g_list_free(), after
41800 its elements have been unreffed with g_object_unref().</doc>
41801 <return-value transfer-ownership="full">
41802 <doc xml:whitespace="preserve">a #GList of #GMount objects.</doc>
41803 <type name="GLib.List" c:type="GList*">
41804 <type name="Mount"/>
41808 <method name="get_volume_for_uuid"
41809 c:identifier="g_volume_monitor_get_volume_for_uuid">
41810 <doc xml:whitespace="preserve">Finds a #GVolume object by its UUID (see g_volume_get_uuid())
41811 Free the returned object with g_object_unref().</doc>
41812 <return-value transfer-ownership="full">
41813 <doc xml:whitespace="preserve">a #GVolume or %NULL if no such volume is available.</doc>
41814 <type name="Volume" c:type="GVolume*"/>
41817 <parameter name="uuid" transfer-ownership="none">
41818 <doc xml:whitespace="preserve">the UUID to look for</doc>
41819 <type name="utf8" c:type="char*"/>
41823 <method name="get_volumes" c:identifier="g_volume_monitor_get_volumes">
41824 <doc xml:whitespace="preserve">Gets a list of the volumes on the system.
41825 The returned list should be freed with g_list_free(), after
41826 its elements have been unreffed with g_object_unref().</doc>
41827 <return-value transfer-ownership="full">
41828 <doc xml:whitespace="preserve">a #GList of #GVolume objects.</doc>
41829 <type name="GLib.List" c:type="GList*">
41830 <type name="Volume"/>
41834 <field name="parent_instance">
41835 <type name="GObject.Object" c:type="GObject"/>
41837 <field name="priv">
41838 <type name="gpointer" c:type="gpointer"/>
41840 <glib:signal name="drive-changed">
41841 <doc xml:whitespace="preserve">Emitted when a drive changes.</doc>
41842 <return-value transfer-ownership="none">
41843 <type name="none"/>
41846 <parameter name="object" transfer-ownership="none">
41847 <doc xml:whitespace="preserve">the drive that changed</doc>
41848 <type name="Drive"/>
41852 <glib:signal name="drive-connected">
41853 <doc xml:whitespace="preserve">Emitted when a drive is connected to the system.</doc>
41854 <return-value transfer-ownership="none">
41855 <type name="none"/>
41858 <parameter name="object" transfer-ownership="none">
41859 <doc xml:whitespace="preserve">a #GDrive that was connected.</doc>
41860 <type name="Drive"/>
41864 <glib:signal name="drive-disconnected">
41865 <doc xml:whitespace="preserve">Emitted when a drive is disconnected from the system.</doc>
41866 <return-value transfer-ownership="none">
41867 <type name="none"/>
41870 <parameter name="object" transfer-ownership="none">
41871 <doc xml:whitespace="preserve">a #GDrive that was disconnected.</doc>
41872 <type name="Drive"/>
41876 <glib:signal name="drive-eject-button" version="2.18">
41877 <doc xml:whitespace="preserve">Emitted when the eject button is pressed on @drive.</doc>
41878 <return-value transfer-ownership="none">
41879 <type name="none"/>
41882 <parameter name="object" transfer-ownership="none">
41883 <doc xml:whitespace="preserve">the drive where the eject button was pressed</doc>
41884 <type name="Drive"/>
41888 <glib:signal name="drive-stop-button" version="2.22">
41889 <doc xml:whitespace="preserve">Emitted when the stop button is pressed on @drive.</doc>
41890 <return-value transfer-ownership="none">
41891 <type name="none"/>
41894 <parameter name="object" transfer-ownership="none">
41895 <doc xml:whitespace="preserve">the drive where the stop button was pressed</doc>
41896 <type name="Drive"/>
41900 <glib:signal name="mount-added">
41901 <doc xml:whitespace="preserve">Emitted when a mount is added.</doc>
41902 <return-value transfer-ownership="none">
41903 <type name="none"/>
41906 <parameter name="object" transfer-ownership="none">
41907 <doc xml:whitespace="preserve">a #GMount that was added.</doc>
41908 <type name="Mount"/>
41912 <glib:signal name="mount-changed">
41913 <doc xml:whitespace="preserve">Emitted when a mount changes.</doc>
41914 <return-value transfer-ownership="none">
41915 <type name="none"/>
41918 <parameter name="object" transfer-ownership="none">
41919 <doc xml:whitespace="preserve">a #GMount that changed.</doc>
41920 <type name="Mount"/>
41924 <glib:signal name="mount-pre-unmount">
41925 <doc xml:whitespace="preserve">Emitted when a mount is about to be removed.</doc>
41926 <return-value transfer-ownership="none">
41927 <type name="none"/>
41930 <parameter name="object" transfer-ownership="none">
41931 <doc xml:whitespace="preserve">a #GMount that is being unmounted.</doc>
41932 <type name="Mount"/>
41936 <glib:signal name="mount-removed">
41937 <doc xml:whitespace="preserve">Emitted when a mount is removed.</doc>
41938 <return-value transfer-ownership="none">
41939 <type name="none"/>
41942 <parameter name="object" transfer-ownership="none">
41943 <doc xml:whitespace="preserve">a #GMount that was removed.</doc>
41944 <type name="Mount"/>
41948 <glib:signal name="volume-added">
41949 <doc xml:whitespace="preserve">Emitted when a mountable volume is added to the system.</doc>
41950 <return-value transfer-ownership="none">
41951 <type name="none"/>
41954 <parameter name="object" transfer-ownership="none">
41955 <doc xml:whitespace="preserve">a #GVolume that was added.</doc>
41956 <type name="Volume"/>
41960 <glib:signal name="volume-changed">
41961 <doc xml:whitespace="preserve">Emitted when mountable volume is changed.</doc>
41962 <return-value transfer-ownership="none">
41963 <type name="none"/>
41966 <parameter name="object" transfer-ownership="none">
41967 <doc xml:whitespace="preserve">a #GVolume that changed.</doc>
41968 <type name="Volume"/>
41972 <glib:signal name="volume-removed">
41973 <doc xml:whitespace="preserve">Emitted when a mountable volume is removed from the system.</doc>
41974 <return-value transfer-ownership="none">
41975 <type name="none"/>
41978 <parameter name="object" transfer-ownership="none">
41979 <doc xml:whitespace="preserve">a #GVolume that was removed.</doc>
41980 <type name="Volume"/>
41985 <record name="VolumeMonitorClass"
41986 c:type="GVolumeMonitorClass"
41987 glib:is-gtype-struct-for="VolumeMonitor">
41988 <field name="parent_class">
41989 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
41991 <field name="volume_added">
41992 <callback name="volume_added">
41993 <return-value transfer-ownership="none">
41994 <type name="none" c:type="void"/>
41997 <parameter name="volume_monitor" transfer-ownership="none">
41998 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42000 <parameter name="volume" transfer-ownership="none">
42001 <type name="Volume" c:type="GVolume*"/>
42006 <field name="volume_removed">
42007 <callback name="volume_removed">
42008 <return-value transfer-ownership="none">
42009 <type name="none" c:type="void"/>
42012 <parameter name="volume_monitor" transfer-ownership="none">
42013 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42015 <parameter name="volume" transfer-ownership="none">
42016 <type name="Volume" c:type="GVolume*"/>
42021 <field name="volume_changed">
42022 <callback name="volume_changed">
42023 <return-value transfer-ownership="none">
42024 <type name="none" c:type="void"/>
42027 <parameter name="volume_monitor" transfer-ownership="none">
42028 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42030 <parameter name="volume" transfer-ownership="none">
42031 <type name="Volume" c:type="GVolume*"/>
42036 <field name="mount_added">
42037 <callback name="mount_added">
42038 <return-value transfer-ownership="none">
42039 <type name="none" c:type="void"/>
42042 <parameter name="volume_monitor" transfer-ownership="none">
42043 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42045 <parameter name="mount" transfer-ownership="none">
42046 <type name="Mount" c:type="GMount*"/>
42051 <field name="mount_removed">
42052 <callback name="mount_removed">
42053 <return-value transfer-ownership="none">
42054 <type name="none" c:type="void"/>
42057 <parameter name="volume_monitor" transfer-ownership="none">
42058 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42060 <parameter name="mount" transfer-ownership="none">
42061 <type name="Mount" c:type="GMount*"/>
42066 <field name="mount_pre_unmount">
42067 <callback name="mount_pre_unmount">
42068 <return-value transfer-ownership="none">
42069 <type name="none" c:type="void"/>
42072 <parameter name="volume_monitor" transfer-ownership="none">
42073 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42075 <parameter name="mount" transfer-ownership="none">
42076 <type name="Mount" c:type="GMount*"/>
42081 <field name="mount_changed">
42082 <callback name="mount_changed">
42083 <return-value transfer-ownership="none">
42084 <type name="none" c:type="void"/>
42087 <parameter name="volume_monitor" transfer-ownership="none">
42088 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42090 <parameter name="mount" transfer-ownership="none">
42091 <type name="Mount" c:type="GMount*"/>
42096 <field name="drive_connected">
42097 <callback name="drive_connected">
42098 <return-value transfer-ownership="none">
42099 <type name="none" c:type="void"/>
42102 <parameter name="volume_monitor" transfer-ownership="none">
42103 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42105 <parameter name="drive" transfer-ownership="none">
42106 <type name="Drive" c:type="GDrive*"/>
42111 <field name="drive_disconnected">
42112 <callback name="drive_disconnected">
42113 <return-value transfer-ownership="none">
42114 <type name="none" c:type="void"/>
42117 <parameter name="volume_monitor" transfer-ownership="none">
42118 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42120 <parameter name="drive" transfer-ownership="none">
42121 <type name="Drive" c:type="GDrive*"/>
42126 <field name="drive_changed">
42127 <callback name="drive_changed">
42128 <return-value transfer-ownership="none">
42129 <type name="none" c:type="void"/>
42132 <parameter name="volume_monitor" transfer-ownership="none">
42133 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42135 <parameter name="drive" transfer-ownership="none">
42136 <type name="Drive" c:type="GDrive*"/>
42141 <field name="is_supported">
42142 <callback name="is_supported">
42143 <return-value transfer-ownership="none">
42144 <type name="gboolean" c:type="gboolean"/>
42148 <field name="get_connected_drives">
42149 <callback name="get_connected_drives">
42150 <return-value transfer-ownership="full">
42151 <doc xml:whitespace="preserve">a #GList of connected #GDrive objects.</doc>
42152 <type name="GLib.List" c:type="GList*">
42153 <type name="Drive"/>
42157 <parameter name="volume_monitor" transfer-ownership="none">
42158 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42163 <field name="get_volumes">
42164 <callback name="get_volumes">
42165 <return-value transfer-ownership="full">
42166 <doc xml:whitespace="preserve">a #GList of #GVolume objects.</doc>
42167 <type name="GLib.List" c:type="GList*">
42168 <type name="Volume"/>
42172 <parameter name="volume_monitor" transfer-ownership="none">
42173 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42178 <field name="get_mounts">
42179 <callback name="get_mounts">
42180 <return-value transfer-ownership="full">
42181 <doc xml:whitespace="preserve">a #GList of #GMount objects.</doc>
42182 <type name="GLib.List" c:type="GList*">
42183 <type name="Mount"/>
42187 <parameter name="volume_monitor" transfer-ownership="none">
42188 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42193 <field name="get_volume_for_uuid">
42194 <callback name="get_volume_for_uuid">
42195 <return-value transfer-ownership="full">
42196 <doc xml:whitespace="preserve">a #GVolume or %NULL if no such volume is available.</doc>
42197 <type name="Volume" c:type="GVolume*"/>
42200 <parameter name="volume_monitor" transfer-ownership="none">
42201 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42203 <parameter name="uuid" transfer-ownership="none">
42204 <doc xml:whitespace="preserve">the UUID to look for</doc>
42205 <type name="utf8" c:type="char*"/>
42210 <field name="get_mount_for_uuid">
42211 <callback name="get_mount_for_uuid">
42212 <return-value transfer-ownership="full">
42213 <doc xml:whitespace="preserve">a #GMount or %NULL if no such mount is available.</doc>
42214 <type name="Mount" c:type="GMount*"/>
42217 <parameter name="volume_monitor" transfer-ownership="none">
42218 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42220 <parameter name="uuid" transfer-ownership="none">
42221 <doc xml:whitespace="preserve">the UUID to look for</doc>
42222 <type name="utf8" c:type="char*"/>
42227 <field name="adopt_orphan_mount" introspectable="0">
42228 <callback name="adopt_orphan_mount" introspectable="0">
42230 <type name="Volume" c:type="GVolume*"/>
42233 <parameter name="mount" transfer-ownership="none">
42234 <type name="Mount" c:type="GMount*"/>
42236 <parameter name="volume_monitor" transfer-ownership="none">
42237 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42242 <field name="drive_eject_button">
42243 <callback name="drive_eject_button">
42244 <return-value transfer-ownership="none">
42245 <type name="none" c:type="void"/>
42248 <parameter name="volume_monitor" transfer-ownership="none">
42249 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42251 <parameter name="drive" transfer-ownership="none">
42252 <type name="Drive" c:type="GDrive*"/>
42257 <field name="drive_stop_button">
42258 <callback name="drive_stop_button">
42259 <return-value transfer-ownership="none">
42260 <type name="none" c:type="void"/>
42263 <parameter name="volume_monitor" transfer-ownership="none">
42264 <type name="VolumeMonitor" c:type="GVolumeMonitor*"/>
42266 <parameter name="drive" transfer-ownership="none">
42267 <type name="Drive" c:type="GDrive*"/>
42272 <field name="_g_reserved1" introspectable="0">
42273 <callback name="_g_reserved1">
42274 <return-value transfer-ownership="none">
42275 <type name="none" c:type="void"/>
42279 <field name="_g_reserved2" introspectable="0">
42280 <callback name="_g_reserved2">
42281 <return-value transfer-ownership="none">
42282 <type name="none" c:type="void"/>
42286 <field name="_g_reserved3" introspectable="0">
42287 <callback name="_g_reserved3">
42288 <return-value transfer-ownership="none">
42289 <type name="none" c:type="void"/>
42293 <field name="_g_reserved4" introspectable="0">
42294 <callback name="_g_reserved4">
42295 <return-value transfer-ownership="none">
42296 <type name="none" c:type="void"/>
42300 <field name="_g_reserved5" introspectable="0">
42301 <callback name="_g_reserved5">
42302 <return-value transfer-ownership="none">
42303 <type name="none" c:type="void"/>
42307 <field name="_g_reserved6" introspectable="0">
42308 <callback name="_g_reserved6">
42309 <return-value transfer-ownership="none">
42310 <type name="none" c:type="void"/>
42315 <class name="ZlibCompressor"
42316 c:symbol-prefix="zlib_compressor"
42317 c:type="GZlibCompressor"
42318 parent="GObject.Object"
42319 glib:type-name="GZlibCompressor"
42320 glib:get-type="g_zlib_compressor_get_type"
42321 glib:type-struct="ZlibCompressorClass">
42322 <doc xml:whitespace="preserve">Zlib decompression</doc>
42323 <implements name="Converter"/>
42324 <constructor name="new"
42325 c:identifier="g_zlib_compressor_new"
42327 <doc xml:whitespace="preserve">Creates a new #GZlibCompressor.</doc>
42328 <return-value transfer-ownership="full">
42329 <doc xml:whitespace="preserve">a new #GZlibCompressor</doc>
42330 <type name="ZlibCompressor" c:type="GZlibCompressor*"/>
42333 <parameter name="format" transfer-ownership="none">
42334 <doc xml:whitespace="preserve">The format to use for the compressed data</doc>
42335 <type name="ZlibCompressorFormat" c:type="GZlibCompressorFormat"/>
42337 <parameter name="level" transfer-ownership="none">
42338 <doc xml:whitespace="preserve">compression level (0-9), -1 for default</doc>
42339 <type name="gint" c:type="int"/>
42343 <method name="get_file_info"
42344 c:identifier="g_zlib_compressor_get_file_info"
42346 <doc xml:whitespace="preserve">Returns the #GZlibCompressor:file-info property.</doc>
42347 <return-value transfer-ownership="none">
42348 <doc xml:whitespace="preserve">a #GFileInfo, or %NULL</doc>
42349 <type name="FileInfo" c:type="GFileInfo*"/>
42352 <method name="set_file_info"
42353 c:identifier="g_zlib_compressor_set_file_info"
42355 <doc xml:whitespace="preserve">Sets @file_info in @compressor. If non-%NULL, and @compressor's
42356 #GZlibCompressor:format property is %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
42357 it will be used to set the file name and modification time in
42358 the GZIP header of the compressed data.
42359 progress; it may only be called immediately after creation of @compressor,
42360 or after resetting it with g_converter_reset().</doc>
42361 <return-value transfer-ownership="none">
42362 <type name="none" c:type="void"/>
42365 <parameter name="file_info" transfer-ownership="none" allow-none="1">
42366 <doc xml:whitespace="preserve">a #GFileInfo</doc>
42367 <type name="FileInfo" c:type="GFileInfo*"/>
42371 <property name="file-info"
42374 transfer-ownership="none">
42375 <doc xml:whitespace="preserve">If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is
42376 %G_ZLIB_COMPRESSOR_FORMAT_GZIP, the compressor will write the file name
42377 and modification time from the file info to the the GZIP header.</doc>
42378 <type name="FileInfo"/>
42380 <property name="format"
42383 transfer-ownership="none">
42384 <type name="ZlibCompressorFormat"/>
42386 <property name="level"
42389 transfer-ownership="none">
42390 <type name="gint"/>
42393 <record name="ZlibCompressorClass"
42394 c:type="GZlibCompressorClass"
42395 glib:is-gtype-struct-for="ZlibCompressor">
42396 <field name="parent_class">
42397 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
42400 <enumeration name="ZlibCompressorFormat"
42402 glib:type-name="GZlibCompressorFormat"
42403 glib:get-type="g_zlib_compressor_format_get_type"
42404 c:type="GZlibCompressorFormat">
42405 <doc xml:whitespace="preserve">Used to select the type of data format to use for #GZlibDecompressor
42406 and #GZlibCompressor.</doc>
42407 <member name="zlib"
42409 c:identifier="G_ZLIB_COMPRESSOR_FORMAT_ZLIB"
42411 <member name="gzip"
42413 c:identifier="G_ZLIB_COMPRESSOR_FORMAT_GZIP"
42417 c:identifier="G_ZLIB_COMPRESSOR_FORMAT_RAW"
42420 <class name="ZlibDecompressor"
42421 c:symbol-prefix="zlib_decompressor"
42422 c:type="GZlibDecompressor"
42423 parent="GObject.Object"
42424 glib:type-name="GZlibDecompressor"
42425 glib:get-type="g_zlib_decompressor_get_type"
42426 glib:type-struct="ZlibDecompressorClass">
42427 <doc xml:whitespace="preserve">Zlib decompression</doc>
42428 <implements name="Converter"/>
42429 <constructor name="new"
42430 c:identifier="g_zlib_decompressor_new"
42432 <doc xml:whitespace="preserve">Creates a new #GZlibDecompressor.</doc>
42433 <return-value transfer-ownership="full">
42434 <doc xml:whitespace="preserve">a new #GZlibDecompressor</doc>
42435 <type name="ZlibDecompressor" c:type="GZlibDecompressor*"/>
42438 <parameter name="format" transfer-ownership="none">
42439 <doc xml:whitespace="preserve">The format to use for the compressed data</doc>
42440 <type name="ZlibCompressorFormat" c:type="GZlibCompressorFormat"/>
42444 <method name="get_file_info"
42445 c:identifier="g_zlib_decompressor_get_file_info"
42447 <doc xml:whitespace="preserve">Retrieves the #GFileInfo constructed from the GZIP header data
42448 of compressed data processed by @compressor, or %NULL if @decompressor's
42449 #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
42450 or the header data was not fully processed yet, or it not present in the
42451 data stream at all.</doc>
42452 <return-value transfer-ownership="none">
42453 <doc xml:whitespace="preserve">a #GFileInfo, or %NULL</doc>
42454 <type name="FileInfo" c:type="GFileInfo*"/>
42457 <property name="file-info" version="2.26" transfer-ownership="none">
42458 <doc xml:whitespace="preserve">A #GFileInfo containing the information found in the GZIP header
42459 of the data stream processed, or %NULL if the header was not yet
42460 fully processed, is not present at all, or the compressor's
42461 #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP.</doc>
42462 <type name="FileInfo"/>
42464 <property name="format"
42467 transfer-ownership="none">
42468 <type name="ZlibCompressorFormat"/>
42471 <record name="ZlibDecompressorClass"
42472 c:type="GZlibDecompressorClass"
42473 glib:is-gtype-struct-for="ZlibDecompressor">
42474 <field name="parent_class">
42475 <type name="GObject.ObjectClass" c:type="GObjectClass"/>
42478 <function name="app_info_create_from_commandline"
42479 c:identifier="g_app_info_create_from_commandline"
42481 <doc xml:whitespace="preserve">Creates a new #GAppInfo from the given information.</doc>
42482 <return-value transfer-ownership="full">
42483 <doc xml:whitespace="preserve">new #GAppInfo for given command.</doc>
42484 <type name="AppInfo" c:type="GAppInfo*"/>
42487 <parameter name="commandline" transfer-ownership="none">
42488 <doc xml:whitespace="preserve">the commandline to use</doc>
42489 <type name="utf8" c:type="char*"/>
42491 <parameter name="application_name"
42492 transfer-ownership="none"
42494 <doc xml:whitespace="preserve">the application name, or %NULL to use @commandline</doc>
42495 <type name="utf8" c:type="char*"/>
42497 <parameter name="flags" transfer-ownership="none">
42498 <doc xml:whitespace="preserve">flags that can specify details of the created #GAppInfo</doc>
42499 <type name="AppInfoCreateFlags" c:type="GAppInfoCreateFlags"/>
42503 <function name="app_info_get_all" c:identifier="g_app_info_get_all">
42504 <doc xml:whitespace="preserve">Gets a list of all of the applications currently registered
42506 For desktop files, this includes applications that have
42507 <literal>NoDisplay=true</literal> set or are excluded from
42508 display by means of <literal>OnlyShowIn</literal> or
42509 <literal>NotShowIn</literal>. See g_app_info_should_show().
42510 The returned list does not include applications which have
42511 the <literal>Hidden</literal> key set.</doc>
42512 <return-value transfer-ownership="full">
42513 <doc xml:whitespace="preserve">a newly allocated #GList of references to #GAppInfo<!---->s.</doc>
42514 <type name="GLib.List" c:type="GList*">
42515 <type name="AppInfo"/>
42519 <function name="app_info_get_all_for_type"
42520 c:identifier="g_app_info_get_all_for_type">
42521 <doc xml:whitespace="preserve">Gets a list of all #GAppInfo<!-- -->s for a given content type.
42522 or %NULL on error.</doc>
42523 <return-value transfer-ownership="full">
42524 <doc xml:whitespace="preserve">#GList of #GAppInfo<!-- -->s for given @content_type</doc>
42525 <type name="GLib.List" c:type="GList*">
42526 <type name="AppInfo"/>
42530 <parameter name="content_type" transfer-ownership="none">
42531 <doc xml:whitespace="preserve">the content type to find a #GAppInfo for</doc>
42532 <type name="utf8" c:type="char*"/>
42536 <function name="app_info_get_default_for_type"
42537 c:identifier="g_app_info_get_default_for_type"
42538 introspectable="0">
42539 <doc xml:whitespace="preserve">Gets the #GAppInfo that corresponds to a given content type.</doc>
42541 <doc xml:whitespace="preserve">#GAppInfo for given @content_type or %NULL on error.</doc>
42542 <type name="AppInfo" c:type="GAppInfo*"/>
42545 <parameter name="content_type" transfer-ownership="none">
42546 <doc xml:whitespace="preserve">the content type to find a #GAppInfo for</doc>
42547 <type name="utf8" c:type="char*"/>
42549 <parameter name="must_support_uris" transfer-ownership="none">
42550 <doc xml:whitespace="preserve">if %TRUE, the #GAppInfo is expected to support URIs</doc>
42551 <type name="gboolean" c:type="gboolean"/>
42555 <function name="app_info_get_default_for_uri_scheme"
42556 c:identifier="g_app_info_get_default_for_uri_scheme"
42557 introspectable="0">
42558 <doc xml:whitespace="preserve">Gets the default application for launching applications
42559 using this URI scheme. A URI scheme is the initial part
42560 of the URI, up to but not including the ':', e.g. "http",
42561 "ftp" or "sip".</doc>
42563 <doc xml:whitespace="preserve">#GAppInfo for given @uri_scheme or %NULL on error.</doc>
42564 <type name="AppInfo" c:type="GAppInfo*"/>
42567 <parameter name="uri_scheme" transfer-ownership="none">
42568 <doc xml:whitespace="preserve">a string containing a URI scheme.</doc>
42569 <type name="utf8" c:type="char*"/>
42573 <function name="app_info_launch_default_for_uri"
42574 c:identifier="g_app_info_launch_default_for_uri"
42576 <doc xml:whitespace="preserve">Utility function that launches the default application
42577 registered to handle the specified uri. Synchronous I/O
42578 is done on the uri to detect the type of the file if
42580 <return-value transfer-ownership="none">
42581 <doc xml:whitespace="preserve">%TRUE on success, %FALSE on error.</doc>
42582 <type name="gboolean" c:type="gboolean"/>
42585 <parameter name="uri" transfer-ownership="none">
42586 <doc xml:whitespace="preserve">the uri to show</doc>
42587 <type name="utf8" c:type="char*"/>
42589 <parameter name="launch_context" transfer-ownership="none">
42590 <doc xml:whitespace="preserve">an optional #GAppLaunchContext.</doc>
42591 <type name="AppLaunchContext" c:type="GAppLaunchContext*"/>
42595 <function name="app_info_reset_type_associations"
42596 c:identifier="g_app_info_reset_type_associations"
42598 <doc xml:whitespace="preserve">Removes all changes to the type associations done by
42599 g_app_info_set_as_default_for_type(),
42600 g_app_info_set_as_default_for_extension(),
42601 g_app_info_add_supports_type() or g_app_info_remove_supports_type().</doc>
42602 <return-value transfer-ownership="none">
42603 <type name="none" c:type="void"/>
42606 <parameter name="content_type" transfer-ownership="none">
42607 <doc xml:whitespace="preserve">a content type</doc>
42608 <type name="utf8" c:type="char*"/>
42612 <function name="async_initable_new_async"
42613 c:identifier="g_async_initable_new_async"
42615 introspectable="0">
42616 <doc xml:whitespace="preserve">Helper function for constructing #GAsyncInitiable object. This is
42617 similar to g_object_new() but also initializes the object asynchronously.
42618 When the initialization is finished, @callback will be called. You can
42619 then call g_async_initable_new_finish() to get the new object and check
42620 for any errors.</doc>
42621 <return-value transfer-ownership="none">
42622 <type name="none" c:type="void"/>
42625 <parameter name="object_type" transfer-ownership="none">
42626 <doc xml:whitespace="preserve">a #GType supporting #GAsyncInitable.</doc>
42627 <type name="GType" c:type="GType"/>
42629 <parameter name="io_priority" transfer-ownership="none">
42630 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the operation.</doc>
42631 <type name="gint" c:type="int"/>
42633 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
42634 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
42635 <type name="Cancellable" c:type="GCancellable*"/>
42637 <parameter name="callback"
42638 transfer-ownership="none"
42641 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the initialization is finished</doc>
42642 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
42644 <parameter name="user_data" transfer-ownership="none">
42645 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
42646 <type name="gpointer" c:type="gpointer"/>
42648 <parameter name="first_property_name" transfer-ownership="none">
42649 <doc xml:whitespace="preserve">the name of the first property, or %NULL if no properties</doc>
42650 <type name="utf8" c:type="gchar*"/>
42652 <parameter transfer-ownership="none">
42658 <function name="async_initable_new_valist_async"
42659 c:identifier="g_async_initable_new_valist_async"
42661 introspectable="0">
42662 <doc xml:whitespace="preserve">Helper function for constructing #GAsyncInitiable object. This is
42663 similar to g_object_new_valist() but also initializes the object
42665 When the initialization is finished, @callback will be called. You can
42666 then call g_async_initable_new_finish() to get the new object and check
42667 for any errors.</doc>
42668 <return-value transfer-ownership="none">
42669 <type name="none" c:type="void"/>
42672 <parameter name="object_type" transfer-ownership="none">
42673 <doc xml:whitespace="preserve">a #GType supporting #GAsyncInitable.</doc>
42674 <type name="GType" c:type="GType"/>
42676 <parameter name="first_property_name" transfer-ownership="none">
42677 <doc xml:whitespace="preserve">the name of the first property, followed by the value, and other property value pairs, and ended by %NULL.</doc>
42678 <type name="utf8" c:type="gchar*"/>
42680 <parameter name="var_args" transfer-ownership="none">
42681 <doc xml:whitespace="preserve">The var args list generated from @first_property_name.</doc>
42682 <type name="va_list" c:type="va_list"/>
42684 <parameter name="io_priority" transfer-ownership="none">
42685 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the operation.</doc>
42686 <type name="gint" c:type="int"/>
42688 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
42689 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
42690 <type name="Cancellable" c:type="GCancellable*"/>
42692 <parameter name="callback"
42693 transfer-ownership="none"
42696 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the initialization is finished</doc>
42697 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
42699 <parameter name="user_data" transfer-ownership="none">
42700 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
42701 <type name="gpointer" c:type="gpointer"/>
42705 <function name="async_initable_newv_async"
42706 c:identifier="g_async_initable_newv_async"
42708 <doc xml:whitespace="preserve">Helper function for constructing #GAsyncInitiable object. This is
42709 similar to g_object_newv() but also initializes the object asynchronously.
42710 When the initialization is finished, @callback will be called. You can
42711 then call g_async_initable_new_finish() to get the new object and check
42712 for any errors.</doc>
42713 <return-value transfer-ownership="none">
42714 <type name="none" c:type="void"/>
42717 <parameter name="object_type" transfer-ownership="none">
42718 <doc xml:whitespace="preserve">a #GType supporting #GAsyncInitable.</doc>
42719 <type name="GType" c:type="GType"/>
42721 <parameter name="n_parameters" transfer-ownership="none">
42722 <doc xml:whitespace="preserve">the number of parameters in @parameters</doc>
42723 <type name="guint" c:type="guint"/>
42725 <parameter name="parameters" transfer-ownership="none">
42726 <doc xml:whitespace="preserve">the parameters to use to construct the object</doc>
42727 <type name="GObject.Parameter" c:type="GParameter*"/>
42729 <parameter name="io_priority" transfer-ownership="none">
42730 <doc xml:whitespace="preserve">the <link linkend="io-priority">I/O priority</link> of the operation.</doc>
42731 <type name="gint" c:type="int"/>
42733 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
42734 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
42735 <type name="Cancellable" c:type="GCancellable*"/>
42737 <parameter name="callback"
42738 transfer-ownership="none"
42741 <doc xml:whitespace="preserve">a #GAsyncReadyCallback to call when the initialization is finished</doc>
42742 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
42744 <parameter name="user_data" transfer-ownership="none">
42745 <doc xml:whitespace="preserve">the data to pass to callback function</doc>
42746 <type name="gpointer" c:type="gpointer"/>
42750 <function name="bus_get" c:identifier="g_bus_get" version="2.26">
42751 <doc xml:whitespace="preserve">Asynchronously connects to the message bus specified by @bus_type.
42752 When the operation is finished, @callback will be invoked. You can
42753 then call g_bus_get_finish() to get the result of the operation.
42754 This is a asynchronous failable function. See g_bus_get_sync() for
42755 the synchronous version.</doc>
42756 <return-value transfer-ownership="none">
42757 <type name="none" c:type="void"/>
42760 <parameter name="bus_type" transfer-ownership="none">
42761 <doc xml:whitespace="preserve">A #GBusType.</doc>
42762 <type name="BusType" c:type="GBusType"/>
42764 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
42765 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
42766 <type name="Cancellable" c:type="GCancellable*"/>
42768 <parameter name="callback"
42769 transfer-ownership="none"
42772 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied.</doc>
42773 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
42775 <parameter name="user_data" transfer-ownership="none">
42776 <doc xml:whitespace="preserve">The data to pass to @callback.</doc>
42777 <type name="gpointer" c:type="gpointer"/>
42781 <function name="bus_get_finish"
42782 c:identifier="g_bus_get_finish"
42785 <doc xml:whitespace="preserve">Finishes an operation started with g_bus_get().
42786 The returned object is a singleton, that is, shared with other
42787 callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
42788 event that you need a private message bus connection, use
42789 g_dbus_address_get_for_bus() and
42790 g_dbus_connection_new_for_address().
42791 Note that the returned #GDBusConnection object will (usually) have
42792 the #GDBusConnection:exit-on-close property set to %TRUE.</doc>
42793 <return-value transfer-ownership="full">
42794 <doc xml:whitespace="preserve">A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().</doc>
42795 <type name="DBusConnection" c:type="GDBusConnection*"/>
42798 <parameter name="res" transfer-ownership="none">
42799 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().</doc>
42800 <type name="AsyncResult" c:type="GAsyncResult*"/>
42804 <function name="bus_get_sync"
42805 c:identifier="g_bus_get_sync"
42808 <doc xml:whitespace="preserve">Synchronously connects to the message bus specified by @bus_type.
42809 Note that the returned object may shared with other callers,
42810 e.g. if two separate parts of a process calls this function with
42811 the same @bus_type, they will share the same object.
42812 This is a synchronous failable function. See g_bus_get() and
42813 g_bus_get_finish() for the asynchronous version.
42814 The returned object is a singleton, that is, shared with other
42815 callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
42816 event that you need a private message bus connection, use
42817 g_dbus_address_get_for_bus_sync() and
42818 g_dbus_connection_new_for_address().
42819 Note that the returned #GDBusConnection object will (usually) have
42820 the #GDBusConnection:exit-on-close property set to %TRUE.</doc>
42821 <return-value transfer-ownership="full">
42822 <doc xml:whitespace="preserve">A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().</doc>
42823 <type name="DBusConnection" c:type="GDBusConnection*"/>
42826 <parameter name="bus_type" transfer-ownership="none">
42827 <doc xml:whitespace="preserve">A #GBusType.</doc>
42828 <type name="BusType" c:type="GBusType"/>
42830 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
42831 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
42832 <type name="Cancellable" c:type="GCancellable*"/>
42836 <function name="bus_own_name"
42837 c:identifier="g_bus_own_name"
42838 shadowed-by="bus_own_name_with_closures"
42840 introspectable="0">
42841 <doc xml:whitespace="preserve">Starts acquiring @name on the bus specified by @bus_type and calls
42842 acquired respectively lost. Callbacks will be invoked in the <link
42843 linkend="g-main-context-push-thread-default">thread-default main
42844 loop</link> of the thread you are calling this function from.
42845 You are guaranteed that one of the @name_acquired_handler and @name_lost_handler
42846 callbacks will be invoked after calling this function - there are three
42848 <itemizedlist>
42849 <listitem><para>
42850 </para></listitem>
42851 <listitem><para>
42852 </para></listitem>
42853 <listitem><para>
42854 </para></listitem>
42855 </itemizedlist>
42856 When you are done owning the name, just call g_bus_unown_name()
42857 with the owner id this function returns.
42858 If the name is acquired or lost (for example another application
42859 could acquire the name if you allow replacement or the application
42860 currently owning the name exits), the handlers are also invoked. If the
42861 #GDBusConnection that is used for attempting to own the name
42862 closes, then @name_lost_handler is invoked since it is no
42863 longer possible for other processes to access the process.
42864 You cannot use g_bus_own_name() several times for the same name (unless
42865 interleaved with calls to g_bus_unown_name()) - only the first call
42867 Another guarantee is that invocations of @name_acquired_handler
42868 and @name_lost_handler are guaranteed to alternate; that
42869 is, if @name_acquired_handler is invoked then you are
42870 guaranteed that the next time one of the handlers is invoked, it
42871 will be @name_lost_handler. The reverse is also true.
42872 If you plan on exporting objects (using e.g.
42873 g_dbus_connection_register_object()), note that it is generally too late
42874 to export the objects in @name_acquired_handler. Instead, you can do this
42875 in @bus_acquired_handler since you are guaranteed that this will run
42876 before @name is requested from the bus.
42877 This behavior makes it very simple to write applications that wants
42878 to own names and export objects, see <xref linkend="gdbus-owning-names"/>.
42879 Simply register objects to be exported in @bus_acquired_handler and
42880 unregister the objects (if any) in @name_lost_handler.
42881 g_bus_unown_name() to stop owning the name.</doc>
42882 <return-value transfer-ownership="none">
42883 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
42884 <type name="guint" c:type="guint"/>
42887 <parameter name="bus_type" transfer-ownership="none">
42888 <doc xml:whitespace="preserve">The type of bus to own a name on.</doc>
42889 <type name="BusType" c:type="GBusType"/>
42891 <parameter name="name" transfer-ownership="none">
42892 <doc xml:whitespace="preserve">The well-known name to own.</doc>
42893 <type name="utf8" c:type="gchar*"/>
42895 <parameter name="flags" transfer-ownership="none">
42896 <doc xml:whitespace="preserve">A set of flags from the #GBusNameOwnerFlags enumeration.</doc>
42897 <type name="BusNameOwnerFlags" c:type="GBusNameOwnerFlags"/>
42899 <parameter name="bus_acquired_handler" transfer-ownership="none">
42900 <doc xml:whitespace="preserve">Handler to invoke when connected to the bus of type @bus_type or %NULL.</doc>
42901 <type name="BusAcquiredCallback" c:type="GBusAcquiredCallback"/>
42903 <parameter name="name_acquired_handler" transfer-ownership="none">
42904 <doc xml:whitespace="preserve">Handler to invoke when @name is acquired or %NULL.</doc>
42905 <type name="BusNameAcquiredCallback"
42906 c:type="GBusNameAcquiredCallback"/>
42908 <parameter name="name_lost_handler"
42909 transfer-ownership="none"
42913 <doc xml:whitespace="preserve">Handler to invoke when @name is lost or %NULL.</doc>
42914 <type name="BusNameLostCallback" c:type="GBusNameLostCallback"/>
42916 <parameter name="user_data" transfer-ownership="none">
42917 <doc xml:whitespace="preserve">User data to pass to handlers.</doc>
42918 <type name="gpointer" c:type="gpointer"/>
42920 <parameter name="user_data_free_func"
42921 transfer-ownership="none"
42923 <doc xml:whitespace="preserve">Function for freeing @user_data or %NULL.</doc>
42924 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
42928 <function name="bus_own_name_on_connection"
42929 c:identifier="g_bus_own_name_on_connection"
42930 shadowed-by="bus_own_name_on_connection_with_closures"
42932 introspectable="0">
42933 <doc xml:whitespace="preserve">Like g_bus_own_name() but takes a #GDBusConnection instead of a
42935 g_bus_unown_name() to stop owning the name.</doc>
42936 <return-value transfer-ownership="none">
42937 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
42938 <type name="guint" c:type="guint"/>
42941 <parameter name="connection" transfer-ownership="none">
42942 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
42943 <type name="DBusConnection" c:type="GDBusConnection*"/>
42945 <parameter name="name" transfer-ownership="none">
42946 <doc xml:whitespace="preserve">The well-known name to own.</doc>
42947 <type name="utf8" c:type="gchar*"/>
42949 <parameter name="flags" transfer-ownership="none">
42950 <doc xml:whitespace="preserve">A set of flags from the #GBusNameOwnerFlags enumeration.</doc>
42951 <type name="BusNameOwnerFlags" c:type="GBusNameOwnerFlags"/>
42953 <parameter name="name_acquired_handler" transfer-ownership="none">
42954 <doc xml:whitespace="preserve">Handler to invoke when @name is acquired or %NULL.</doc>
42955 <type name="BusNameAcquiredCallback"
42956 c:type="GBusNameAcquiredCallback"/>
42958 <parameter name="name_lost_handler"
42959 transfer-ownership="none"
42963 <doc xml:whitespace="preserve">Handler to invoke when @name is lost or %NULL.</doc>
42964 <type name="BusNameLostCallback" c:type="GBusNameLostCallback"/>
42966 <parameter name="user_data" transfer-ownership="none">
42967 <doc xml:whitespace="preserve">User data to pass to handlers.</doc>
42968 <type name="gpointer" c:type="gpointer"/>
42970 <parameter name="user_data_free_func"
42971 transfer-ownership="none"
42973 <doc xml:whitespace="preserve">Function for freeing @user_data or %NULL.</doc>
42974 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
42978 <function name="bus_own_name_on_connection_with_closures"
42979 c:identifier="g_bus_own_name_on_connection_with_closures"
42980 shadows="bus_own_name_on_connection"
42982 <doc xml:whitespace="preserve">Version of g_bus_own_name_on_connection() using closures instead of callbacks for
42983 easier binding in other languages.
42984 g_bus_unown_name() to stop owning the name.</doc>
42985 <return-value transfer-ownership="none">
42986 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
42987 <type name="guint" c:type="guint"/>
42990 <parameter name="connection" transfer-ownership="none">
42991 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
42992 <type name="DBusConnection" c:type="GDBusConnection*"/>
42994 <parameter name="name" transfer-ownership="none">
42995 <doc xml:whitespace="preserve">The well-known name to own.</doc>
42996 <type name="utf8" c:type="gchar*"/>
42998 <parameter name="flags" transfer-ownership="none">
42999 <doc xml:whitespace="preserve">A set of flags from the #GBusNameOwnerFlags enumeration.</doc>
43000 <type name="BusNameOwnerFlags" c:type="GBusNameOwnerFlags"/>
43002 <parameter name="name_acquired_closure"
43003 transfer-ownership="none"
43005 <doc xml:whitespace="preserve">#GClosure to invoke when @name is acquired or %NULL.</doc>
43006 <type name="GObject.Closure" c:type="GClosure*"/>
43008 <parameter name="name_lost_closure"
43009 transfer-ownership="none"
43011 <doc xml:whitespace="preserve">#GClosure to invoke when @name is lost or %NULL.</doc>
43012 <type name="GObject.Closure" c:type="GClosure*"/>
43016 <function name="bus_own_name_with_closures"
43017 c:identifier="g_bus_own_name_with_closures"
43018 shadows="bus_own_name"
43020 <doc xml:whitespace="preserve">Version of g_bus_own_name() using closures instead of callbacks for
43021 easier binding in other languages.
43022 g_bus_unown_name() to stop owning the name.</doc>
43023 <return-value transfer-ownership="none">
43024 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
43025 <type name="guint" c:type="guint"/>
43028 <parameter name="bus_type" transfer-ownership="none">
43029 <doc xml:whitespace="preserve">The type of bus to own a name on.</doc>
43030 <type name="BusType" c:type="GBusType"/>
43032 <parameter name="name" transfer-ownership="none">
43033 <doc xml:whitespace="preserve">The well-known name to own.</doc>
43034 <type name="utf8" c:type="gchar*"/>
43036 <parameter name="flags" transfer-ownership="none">
43037 <doc xml:whitespace="preserve">A set of flags from the #GBusNameOwnerFlags enumeration.</doc>
43038 <type name="BusNameOwnerFlags" c:type="GBusNameOwnerFlags"/>
43040 <parameter name="bus_acquired_closure"
43041 transfer-ownership="none"
43043 <doc xml:whitespace="preserve">#GClosure to invoke when connected to the bus of type @bus_type or %NULL.</doc>
43044 <type name="GObject.Closure" c:type="GClosure*"/>
43046 <parameter name="name_acquired_closure"
43047 transfer-ownership="none"
43049 <doc xml:whitespace="preserve">#GClosure to invoke when @name is acquired or %NULL.</doc>
43050 <type name="GObject.Closure" c:type="GClosure*"/>
43052 <parameter name="name_lost_closure"
43053 transfer-ownership="none"
43055 <doc xml:whitespace="preserve">#GClosure to invoke when @name is lost or %NULL.</doc>
43056 <type name="GObject.Closure" c:type="GClosure*"/>
43060 <function name="bus_unown_name"
43061 c:identifier="g_bus_unown_name"
43063 <doc xml:whitespace="preserve">Stops owning a name.</doc>
43064 <return-value transfer-ownership="none">
43065 <type name="none" c:type="void"/>
43068 <parameter name="owner_id" transfer-ownership="none">
43069 <doc xml:whitespace="preserve">An identifier obtained from g_bus_own_name()</doc>
43070 <type name="guint" c:type="guint"/>
43074 <function name="bus_unwatch_name"
43075 c:identifier="g_bus_unwatch_name"
43077 <doc xml:whitespace="preserve">Stops watching a name.</doc>
43078 <return-value transfer-ownership="none">
43079 <type name="none" c:type="void"/>
43082 <parameter name="watcher_id" transfer-ownership="none">
43083 <doc xml:whitespace="preserve">An identifier obtained from g_bus_watch_name()</doc>
43084 <type name="guint" c:type="guint"/>
43088 <function name="bus_watch_name"
43089 c:identifier="g_bus_watch_name"
43090 shadowed-by="bus_watch_name_with_closures"
43092 introspectable="0">
43093 <doc xml:whitespace="preserve">Starts watching @name on the bus specified by @bus_type and calls
43094 known to have a owner respectively known to lose its
43095 owner. Callbacks will be invoked in the <link
43096 linkend="g-main-context-push-thread-default">thread-default main
43097 loop</link> of the thread you are calling this function from.
43098 You are guaranteed that one of the handlers will be invoked after
43099 calling this function. When you are done watching the name, just
43100 call g_bus_unwatch_name() with the watcher id this function
43102 If the name vanishes or appears (for example the application owning
43103 the name could restart), the handlers are also invoked. If the
43104 #GDBusConnection that is used for watching the name disconnects, then
43105 possible to access the name.
43106 Another guarantee is that invocations of @name_appeared_handler
43107 and @name_vanished_handler are guaranteed to alternate; that
43108 is, if @name_appeared_handler is invoked then you are
43109 guaranteed that the next time one of the handlers is invoked, it
43110 will be @name_vanished_handler. The reverse is also true.
43111 This behavior makes it very simple to write applications that wants
43112 to take action when a certain name exists, see <xref
43113 linkend="gdbus-watching-names"/>. Basically, the application
43114 should create object proxies in @name_appeared_handler and destroy
43115 them again (if any) in @name_vanished_handler.
43116 g_bus_unwatch_name() to stop watching the name.</doc>
43117 <return-value transfer-ownership="none">
43118 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
43119 <type name="guint" c:type="guint"/>
43122 <parameter name="bus_type" transfer-ownership="none">
43123 <doc xml:whitespace="preserve">The type of bus to watch a name on.</doc>
43124 <type name="BusType" c:type="GBusType"/>
43126 <parameter name="name" transfer-ownership="none">
43127 <doc xml:whitespace="preserve">The name (well-known or unique) to watch.</doc>
43128 <type name="utf8" c:type="gchar*"/>
43130 <parameter name="flags" transfer-ownership="none">
43131 <doc xml:whitespace="preserve">Flags from the #GBusNameWatcherFlags enumeration.</doc>
43132 <type name="BusNameWatcherFlags" c:type="GBusNameWatcherFlags"/>
43134 <parameter name="name_appeared_handler" transfer-ownership="none">
43135 <doc xml:whitespace="preserve">Handler to invoke when @name is known to exist or %NULL.</doc>
43136 <type name="BusNameAppearedCallback"
43137 c:type="GBusNameAppearedCallback"/>
43139 <parameter name="name_vanished_handler"
43140 transfer-ownership="none"
43144 <doc xml:whitespace="preserve">Handler to invoke when @name is known to not exist or %NULL.</doc>
43145 <type name="BusNameVanishedCallback"
43146 c:type="GBusNameVanishedCallback"/>
43148 <parameter name="user_data" transfer-ownership="none">
43149 <doc xml:whitespace="preserve">User data to pass to handlers.</doc>
43150 <type name="gpointer" c:type="gpointer"/>
43152 <parameter name="user_data_free_func"
43153 transfer-ownership="none"
43155 <doc xml:whitespace="preserve">Function for freeing @user_data or %NULL.</doc>
43156 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
43160 <function name="bus_watch_name_on_connection"
43161 c:identifier="g_bus_watch_name_on_connection"
43162 shadowed-by="bus_watch_name_on_connection_with_closures"
43164 introspectable="0">
43165 <doc xml:whitespace="preserve">Like g_bus_watch_name() but takes a #GDBusConnection instead of a
43167 g_bus_unwatch_name() to stop watching the name.</doc>
43168 <return-value transfer-ownership="none">
43169 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
43170 <type name="guint" c:type="guint"/>
43173 <parameter name="connection" transfer-ownership="none">
43174 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
43175 <type name="DBusConnection" c:type="GDBusConnection*"/>
43177 <parameter name="name" transfer-ownership="none">
43178 <doc xml:whitespace="preserve">The name (well-known or unique) to watch.</doc>
43179 <type name="utf8" c:type="gchar*"/>
43181 <parameter name="flags" transfer-ownership="none">
43182 <doc xml:whitespace="preserve">Flags from the #GBusNameWatcherFlags enumeration.</doc>
43183 <type name="BusNameWatcherFlags" c:type="GBusNameWatcherFlags"/>
43185 <parameter name="name_appeared_handler" transfer-ownership="none">
43186 <doc xml:whitespace="preserve">Handler to invoke when @name is known to exist or %NULL.</doc>
43187 <type name="BusNameAppearedCallback"
43188 c:type="GBusNameAppearedCallback"/>
43190 <parameter name="name_vanished_handler"
43191 transfer-ownership="none"
43195 <doc xml:whitespace="preserve">Handler to invoke when @name is known to not exist or %NULL.</doc>
43196 <type name="BusNameVanishedCallback"
43197 c:type="GBusNameVanishedCallback"/>
43199 <parameter name="user_data" transfer-ownership="none">
43200 <doc xml:whitespace="preserve">User data to pass to handlers.</doc>
43201 <type name="gpointer" c:type="gpointer"/>
43203 <parameter name="user_data_free_func"
43204 transfer-ownership="none"
43206 <doc xml:whitespace="preserve">Function for freeing @user_data or %NULL.</doc>
43207 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
43211 <function name="bus_watch_name_on_connection_with_closures"
43212 c:identifier="g_bus_watch_name_on_connection_with_closures"
43213 shadows="bus_watch_name_on_connection"
43215 <doc xml:whitespace="preserve">Version of g_bus_watch_name_on_connection() using closures instead of callbacks for
43216 easier binding in other languages.
43217 g_bus_unwatch_name() to stop watching the name.</doc>
43218 <return-value transfer-ownership="none">
43219 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
43220 <type name="guint" c:type="guint"/>
43223 <parameter name="connection" transfer-ownership="none">
43224 <doc xml:whitespace="preserve">A #GDBusConnection.</doc>
43225 <type name="DBusConnection" c:type="GDBusConnection*"/>
43227 <parameter name="name" transfer-ownership="none">
43228 <doc xml:whitespace="preserve">The name (well-known or unique) to watch.</doc>
43229 <type name="utf8" c:type="gchar*"/>
43231 <parameter name="flags" transfer-ownership="none">
43232 <doc xml:whitespace="preserve">Flags from the #GBusNameWatcherFlags enumeration.</doc>
43233 <type name="BusNameWatcherFlags" c:type="GBusNameWatcherFlags"/>
43235 <parameter name="name_appeared_closure"
43236 transfer-ownership="none"
43238 <doc xml:whitespace="preserve">#GClosure to invoke when @name is known to exist or %NULL.</doc>
43239 <type name="GObject.Closure" c:type="GClosure*"/>
43241 <parameter name="name_vanished_closure"
43242 transfer-ownership="none"
43244 <doc xml:whitespace="preserve">#GClosure to invoke when @name is known to not exist or %NULL.</doc>
43245 <type name="GObject.Closure" c:type="GClosure*"/>
43249 <function name="bus_watch_name_with_closures"
43250 c:identifier="g_bus_watch_name_with_closures"
43251 shadows="bus_watch_name"
43253 <doc xml:whitespace="preserve">Version of g_bus_watch_name() using closures instead of callbacks for
43254 easier binding in other languages.
43255 g_bus_unwatch_name() to stop watching the name.</doc>
43256 <return-value transfer-ownership="none">
43257 <doc xml:whitespace="preserve">An identifier (never 0) that an be used with</doc>
43258 <type name="guint" c:type="guint"/>
43261 <parameter name="bus_type" transfer-ownership="none">
43262 <doc xml:whitespace="preserve">The type of bus to watch a name on.</doc>
43263 <type name="BusType" c:type="GBusType"/>
43265 <parameter name="name" transfer-ownership="none">
43266 <doc xml:whitespace="preserve">The name (well-known or unique) to watch.</doc>
43267 <type name="utf8" c:type="gchar*"/>
43269 <parameter name="flags" transfer-ownership="none">
43270 <doc xml:whitespace="preserve">Flags from the #GBusNameWatcherFlags enumeration.</doc>
43271 <type name="BusNameWatcherFlags" c:type="GBusNameWatcherFlags"/>
43273 <parameter name="name_appeared_closure"
43274 transfer-ownership="none"
43276 <doc xml:whitespace="preserve">#GClosure to invoke when @name is known to exist or %NULL.</doc>
43277 <type name="GObject.Closure" c:type="GClosure*"/>
43279 <parameter name="name_vanished_closure"
43280 transfer-ownership="none"
43282 <doc xml:whitespace="preserve">#GClosure to invoke when @name is known to not exist or %NULL.</doc>
43283 <type name="GObject.Closure" c:type="GClosure*"/>
43287 <function name="content_type_can_be_executable"
43288 c:identifier="g_content_type_can_be_executable">
43289 <doc xml:whitespace="preserve">Checks if a content type can be executable. Note that for instance
43290 things like text files can be executables (i.e. scripts and batch files).
43291 can be executable, %FALSE otherwise.</doc>
43292 <return-value transfer-ownership="none">
43293 <doc xml:whitespace="preserve">%TRUE if the file type corresponds to a type that</doc>
43294 <type name="gboolean" c:type="gboolean"/>
43297 <parameter name="type" transfer-ownership="none">
43298 <doc xml:whitespace="preserve">a content type string</doc>
43299 <type name="utf8" c:type="gchar*"/>
43303 <function name="content_type_equals" c:identifier="g_content_type_equals">
43304 <doc xml:whitespace="preserve">Compares two content types for equality.
43305 %FALSE otherwise.</doc>
43306 <return-value transfer-ownership="none">
43307 <doc xml:whitespace="preserve">%TRUE if the two strings are identical or equivalent,</doc>
43308 <type name="gboolean" c:type="gboolean"/>
43311 <parameter name="type1" transfer-ownership="none">
43312 <doc xml:whitespace="preserve">a content type string</doc>
43313 <type name="utf8" c:type="gchar*"/>
43315 <parameter name="type2" transfer-ownership="none">
43316 <doc xml:whitespace="preserve">a content type string</doc>
43317 <type name="utf8" c:type="gchar*"/>
43321 <function name="content_type_from_mime_type"
43322 c:identifier="g_content_type_from_mime_type"
43324 <doc xml:whitespace="preserve">Tries to find a content type based on the mime type name.
43325 or %NULL. Free with g_free()</doc>
43326 <return-value transfer-ownership="full">
43327 <doc xml:whitespace="preserve">Newly allocated string with content type</doc>
43328 <type name="utf8" c:type="gchar*"/>
43331 <parameter name="mime_type" transfer-ownership="none">
43332 <doc xml:whitespace="preserve">a mime type string</doc>
43333 <type name="utf8" c:type="gchar*"/>
43337 <function name="content_type_get_description"
43338 c:identifier="g_content_type_get_description">
43339 <doc xml:whitespace="preserve">Gets the human readable description of the content type.
43340 returned string with g_free()</doc>
43341 <return-value transfer-ownership="full">
43342 <doc xml:whitespace="preserve">a short description of the content type @type. Free the</doc>
43343 <type name="utf8" c:type="gchar*"/>
43346 <parameter name="type" transfer-ownership="none">
43347 <doc xml:whitespace="preserve">a content type string</doc>
43348 <type name="utf8" c:type="gchar*"/>
43352 <function name="content_type_get_icon"
43353 c:identifier="g_content_type_get_icon">
43354 <doc xml:whitespace="preserve">Gets the icon for a content type.
43355 object with g_object_unref()</doc>
43356 <return-value transfer-ownership="full">
43357 <doc xml:whitespace="preserve">#GIcon corresponding to the content type. Free the returned</doc>
43358 <type name="Icon" c:type="GIcon*"/>
43361 <parameter name="type" transfer-ownership="none">
43362 <doc xml:whitespace="preserve">a content type string</doc>
43363 <type name="utf8" c:type="gchar*"/>
43367 <function name="content_type_get_mime_type"
43368 c:identifier="g_content_type_get_mime_type">
43369 <doc xml:whitespace="preserve">Gets the mime type for the content type, if one is registered.
43370 or %NULL if unknown.</doc>
43371 <return-value transfer-ownership="full">
43372 <doc xml:whitespace="preserve">the registered mime type for the given @type,</doc>
43373 <type name="utf8" c:type="gchar*"/>
43376 <parameter name="type" transfer-ownership="none">
43377 <doc xml:whitespace="preserve">a content type string</doc>
43378 <type name="utf8" c:type="gchar*"/>
43382 <function name="content_type_guess" c:identifier="g_content_type_guess">
43383 <doc xml:whitespace="preserve">Guesses the content type based on example data. If the function is
43384 uncertain, @result_uncertain will be set to %TRUE. Either @filename
43385 or @data may be %NULL, in which case the guess will be based solely
43386 on the other argument.
43387 given data. Free with g_free()</doc>
43388 <return-value transfer-ownership="full">
43389 <doc xml:whitespace="preserve">a string indicating a guessed content type for the</doc>
43390 <type name="utf8" c:type="gchar*"/>
43393 <parameter name="filename" transfer-ownership="none" allow-none="1">
43394 <doc xml:whitespace="preserve">a string, or %NULL</doc>
43395 <type name="utf8" c:type="gchar*"/>
43397 <parameter name="data" transfer-ownership="none" allow-none="1">
43398 <doc xml:whitespace="preserve">a stream of data, or %NULL</doc>
43399 <array length="2" c:type="guchar*">
43400 <type name="guint8"/>
43403 <parameter name="data_size" transfer-ownership="none">
43404 <doc xml:whitespace="preserve">the size of @data</doc>
43405 <type name="gulong" c:type="gsize"/>
43407 <parameter name="result_uncertain"
43409 caller-allocates="0"
43410 transfer-ownership="full"
43412 <doc xml:whitespace="preserve">return location for the certainty of the result, or %NULL</doc>
43413 <type name="gboolean" c:type="gboolean*"/>
43417 <function name="content_type_guess_for_tree"
43418 c:identifier="g_content_type_guess_for_tree"
43420 <doc xml:whitespace="preserve">Tries to guess the type of the tree with root @root, by
43421 looking at the files it contains. The result is an array
43422 of content types, with the best guess coming first.
43423 The types returned all have the form x-content/foo, e.g.
43424 x-content/audio-cdda (for audio CDs) or x-content/image-dcf
43425 (for a camera memory card). See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
43426 specification for more on x-content types.
43427 This function is useful in the implementation of
43428 g_mount_guess_content_type().
43429 or %NULL. Free with g_strfreev()</doc>
43430 <return-value transfer-ownership="full">
43431 <doc xml:whitespace="preserve">an %NULL-terminated array of zero or more content types,</doc>
43432 <array c:type="gchar**">
43433 <type name="utf8"/>
43437 <parameter name="root" transfer-ownership="none">
43438 <doc xml:whitespace="preserve">the root of the tree to guess a type for</doc>
43439 <type name="File" c:type="GFile*"/>
43443 <function name="content_type_is_a" c:identifier="g_content_type_is_a">
43444 <doc xml:whitespace="preserve">Determines if @type is a subset of @supertype.
43445 %FALSE otherwise.</doc>
43446 <return-value transfer-ownership="none">
43447 <doc xml:whitespace="preserve">%TRUE if @type is a kind of @supertype,</doc>
43448 <type name="gboolean" c:type="gboolean"/>
43451 <parameter name="type" transfer-ownership="none">
43452 <doc xml:whitespace="preserve">a content type string</doc>
43453 <type name="utf8" c:type="gchar*"/>
43455 <parameter name="supertype" transfer-ownership="none">
43456 <doc xml:whitespace="preserve">a content type string</doc>
43457 <type name="utf8" c:type="gchar*"/>
43461 <function name="content_type_is_unknown"
43462 c:identifier="g_content_type_is_unknown">
43463 <doc xml:whitespace="preserve">Checks if the content type is the generic "unknown" type.
43464 On UNIX this is the "application/octet-stream" mimetype,
43465 while on win32 it is "*".</doc>
43466 <return-value transfer-ownership="none">
43467 <doc xml:whitespace="preserve">%TRUE if the type is the unknown type.</doc>
43468 <type name="gboolean" c:type="gboolean"/>
43471 <parameter name="type" transfer-ownership="none">
43472 <doc xml:whitespace="preserve">a content type string</doc>
43473 <type name="utf8" c:type="gchar*"/>
43477 <function name="content_types_get_registered"
43478 c:identifier="g_content_types_get_registered">
43479 <doc xml:whitespace="preserve">Gets a list of strings containing all the registered content types
43480 known to the system. The list and its data should be freed using
43481 <programlisting>
43482 g_list_foreach (list, g_free, NULL);
43483 g_list_free (list);
43484 </programlisting></doc>
43485 <return-value transfer-ownership="full">
43486 <doc xml:whitespace="preserve">#GList of the registered content types</doc>
43487 <type name="GLib.List" c:type="GList*">
43488 <type name="utf8"/>
43492 <function name="dbus_address_get_for_bus_sync"
43493 c:identifier="g_dbus_address_get_for_bus_sync"
43496 <doc xml:whitespace="preserve">Synchronously looks up the D-Bus address for the well-known message
43497 bus instance specified by @bus_type. This may involve using various
43498 platform specific mechanisms.</doc>
43499 <return-value transfer-ownership="full">
43500 <doc xml:whitespace="preserve">A valid D-Bus address string for @bus_type or %NULL if @error is set.</doc>
43501 <type name="utf8" c:type="gchar*"/>
43504 <parameter name="bus_type" transfer-ownership="none">
43505 <doc xml:whitespace="preserve">A #GBusType.</doc>
43506 <type name="BusType" c:type="GBusType"/>
43508 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
43509 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
43510 <type name="Cancellable" c:type="GCancellable*"/>
43514 <function name="dbus_address_get_stream"
43515 c:identifier="g_dbus_address_get_stream"
43517 <doc xml:whitespace="preserve">Asynchronously connects to an endpoint specified by @address and
43518 sets up the connection so it is in a state to run the client-side
43519 of the D-Bus authentication conversation.
43520 When the operation is finished, @callback will be invoked. You can
43521 then call g_dbus_address_get_stream_finish() to get the result of
43523 This is an asynchronous failable function. See
43524 g_dbus_address_get_stream_sync() for the synchronous version.</doc>
43525 <return-value transfer-ownership="none">
43526 <type name="none" c:type="void"/>
43529 <parameter name="address" transfer-ownership="none">
43530 <doc xml:whitespace="preserve">A valid D-Bus address.</doc>
43531 <type name="utf8" c:type="gchar*"/>
43533 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
43534 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
43535 <type name="Cancellable" c:type="GCancellable*"/>
43537 <parameter name="callback"
43538 transfer-ownership="none"
43541 <doc xml:whitespace="preserve">A #GAsyncReadyCallback to call when the request is satisfied.</doc>
43542 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
43544 <parameter name="user_data" transfer-ownership="none">
43545 <doc xml:whitespace="preserve">Data to pass to @callback.</doc>
43546 <type name="gpointer" c:type="gpointer"/>
43550 <function name="dbus_address_get_stream_finish"
43551 c:identifier="g_dbus_address_get_stream_finish"
43554 <doc xml:whitespace="preserve">Finishes an operation started with g_dbus_address_get_stream().</doc>
43555 <return-value transfer-ownership="full">
43556 <doc xml:whitespace="preserve">A #GIOStream or %NULL if @error is set.</doc>
43557 <type name="IOStream" c:type="GIOStream*"/>
43560 <parameter name="res" transfer-ownership="none">
43561 <doc xml:whitespace="preserve">A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream().</doc>
43562 <type name="AsyncResult" c:type="GAsyncResult*"/>
43564 <parameter name="out_guid" transfer-ownership="none">
43565 <doc xml:whitespace="preserve">%NULL or return location to store the GUID extracted from @address, if any.</doc>
43566 <type name="utf8" c:type="gchar**"/>
43570 <function name="dbus_address_get_stream_sync"
43571 c:identifier="g_dbus_address_get_stream_sync"
43574 <doc xml:whitespace="preserve">Synchronously connects to an endpoint specified by @address and
43575 sets up the connection so it is in a state to run the client-side
43576 of the D-Bus authentication conversation.
43577 This is a synchronous failable function. See
43578 g_dbus_address_get_stream() for the asynchronous version.</doc>
43579 <return-value transfer-ownership="full">
43580 <doc xml:whitespace="preserve">A #GIOStream or %NULL if @error is set.</doc>
43581 <type name="IOStream" c:type="GIOStream*"/>
43584 <parameter name="address" transfer-ownership="none">
43585 <doc xml:whitespace="preserve">A valid D-Bus address.</doc>
43586 <type name="utf8" c:type="gchar*"/>
43588 <parameter name="out_guid" transfer-ownership="none">
43589 <doc xml:whitespace="preserve">%NULL or return location to store the GUID extracted from @address, if any.</doc>
43590 <type name="utf8" c:type="gchar**"/>
43592 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
43593 <doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
43594 <type name="Cancellable" c:type="GCancellable*"/>
43598 <function name="dbus_annotation_info_lookup"
43599 c:identifier="g_dbus_annotation_info_lookup"
43601 <doc xml:whitespace="preserve">Looks up the value of an annotation.
43602 This cost of this function is O(n) in number of annotations.</doc>
43603 <return-value transfer-ownership="none">
43604 <doc xml:whitespace="preserve">The value or %NULL if not found. Do not free, it is owned by @annotations.</doc>
43605 <type name="utf8" c:type="gchar*"/>
43608 <parameter name="annotations" transfer-ownership="none">
43609 <doc xml:whitespace="preserve">A %NULL-terminated array of annotations or %NULL.</doc>
43610 <type name="DBusAnnotationInfo" c:type="GDBusAnnotationInfo**"/>
43612 <parameter name="name" transfer-ownership="none">
43613 <doc xml:whitespace="preserve">The name of the annotation to look up.</doc>
43614 <type name="utf8" c:type="gchar*"/>
43618 <function name="dbus_error_encode_gerror"
43619 c:identifier="g_dbus_error_encode_gerror"
43621 <doc xml:whitespace="preserve">Creates a D-Bus error name to use for @error. If @error matches
43622 a registered error (cf. g_dbus_error_register_error()), the corresponding
43623 D-Bus error name will be returned.
43624 Otherwise the a name of the form
43625 <literal>org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE</literal>
43626 will be used. This allows other GDBus applications to map the error
43627 on the wire back to a #GError using g_dbus_error_new_for_dbus_error().
43628 This function is typically only used in object mappings to put a
43629 #GError on the wire. Regular applications should not use it.</doc>
43630 <return-value transfer-ownership="full">
43631 <doc xml:whitespace="preserve">A D-Bus error name (never %NULL). Free with g_free().</doc>
43632 <type name="utf8" c:type="gchar*"/>
43635 <parameter name="error" transfer-ownership="none">
43636 <doc xml:whitespace="preserve">A #GError.</doc>
43637 <type name="GLib.Error" c:type="GError*"/>
43641 <function name="dbus_error_get_remote_error"
43642 c:identifier="g_dbus_error_get_remote_error"
43644 <doc xml:whitespace="preserve">Gets the D-Bus error name used for @error, if any.
43645 This function is guaranteed to return a D-Bus error name for all
43646 #GError<!-- -->s returned from functions handling remote method
43647 calls (e.g. g_dbus_connection_call_finish()) unless
43648 g_dbus_error_strip_remote_error() has been used on @error.</doc>
43649 <return-value transfer-ownership="full">
43650 <doc xml:whitespace="preserve">An allocated string or %NULL if the D-Bus error name could not be found. Free with g_free().</doc>
43651 <type name="utf8" c:type="gchar*"/>
43654 <parameter name="error" transfer-ownership="none">
43655 <doc xml:whitespace="preserve">A #GError.</doc>
43656 <type name="GLib.Error" c:type="GError*"/>
43660 <function name="dbus_error_is_remote_error"
43661 c:identifier="g_dbus_error_is_remote_error"
43663 <doc xml:whitespace="preserve">Checks if @error represents an error received via D-Bus from a remote peer. If so,
43664 use g_dbus_error_get_remote_error() to get the name of the error.
43665 %FALSE otherwise.</doc>
43666 <return-value transfer-ownership="none">
43667 <doc xml:whitespace="preserve">%TRUE if @error represents an error from a remote peer,</doc>
43668 <type name="gboolean" c:type="gboolean"/>
43671 <parameter name="error" transfer-ownership="none">
43672 <doc xml:whitespace="preserve">A #GError.</doc>
43673 <type name="GLib.Error" c:type="GError*"/>
43677 <function name="dbus_error_new_for_dbus_error"
43678 c:identifier="g_dbus_error_new_for_dbus_error"
43680 introspectable="0">
43681 <doc xml:whitespace="preserve">Creates a #GError based on the contents of @dbus_error_name and
43682 Errors registered with g_dbus_error_register_error() will be looked
43683 up using @dbus_error_name and if a match is found, the error domain
43684 and code is used. Applications can use g_dbus_error_get_remote_error()
43685 to recover @dbus_error_name.
43686 If a match against a registered error is not found and the D-Bus
43687 error name is in a form as returned by g_dbus_error_encode_gerror()
43688 the error domain and code encoded in the name is used to
43689 create the #GError. Also, @dbus_error_name is added to the error message
43690 such that it can be recovered with g_dbus_error_get_remote_error().
43691 Otherwise, a #GError with the error code %G_IO_ERROR_DBUS_ERROR
43692 in the #G_IO_ERROR error domain is returned. Also, @dbus_error_name is
43693 added to the error message such that it can be recovered with
43694 g_dbus_error_get_remote_error().
43695 In all three cases, @dbus_error_name can always be recovered from the
43696 returned #GError using the g_dbus_error_get_remote_error() function
43697 (unless g_dbus_error_strip_remote_error() hasn't been used on the returned error).
43698 This function is typically only used in object mappings to prepare
43699 #GError instances for applications. Regular applications should not use
43702 <doc xml:whitespace="preserve">An allocated #GError. Free with g_error_free().</doc>
43703 <type name="GLib.Error" c:type="GError*"/>
43706 <parameter name="dbus_error_name" transfer-ownership="none">
43707 <doc xml:whitespace="preserve">D-Bus error name.</doc>
43708 <type name="utf8" c:type="gchar*"/>
43710 <parameter name="dbus_error_message" transfer-ownership="none">
43711 <doc xml:whitespace="preserve">D-Bus error message.</doc>
43712 <type name="utf8" c:type="gchar*"/>
43716 <function name="dbus_error_quark" c:identifier="g_dbus_error_quark">
43717 <return-value transfer-ownership="none">
43718 <type name="GLib.Quark" c:type="GQuark"/>
43721 <function name="dbus_error_register_error"
43722 c:identifier="g_dbus_error_register_error"
43724 <doc xml:whitespace="preserve">Creates an association to map between @dbus_error_name and
43725 #GError<!-- -->s specified by @error_domain and @error_code.
43726 This is typically done in the routine that returns the #GQuark for
43729 <return-value transfer-ownership="none">
43730 <doc xml:whitespace="preserve">%TRUE if the association was created, %FALSE if it already</doc>
43731 <type name="gboolean" c:type="gboolean"/>
43734 <parameter name="error_domain" transfer-ownership="none">
43735 <doc xml:whitespace="preserve">A #GQuark for a error domain.</doc>
43736 <type name="GLib.Quark" c:type="GQuark"/>
43738 <parameter name="error_code" transfer-ownership="none">
43739 <doc xml:whitespace="preserve">An error code.</doc>
43740 <type name="gint" c:type="gint"/>
43742 <parameter name="dbus_error_name" transfer-ownership="none">
43743 <doc xml:whitespace="preserve">A D-Bus error name.</doc>
43744 <type name="utf8" c:type="gchar*"/>
43748 <function name="dbus_error_register_error_domain"
43749 c:identifier="g_dbus_error_register_error_domain"
43751 <doc xml:whitespace="preserve">Helper function for associating a #GError error domain with D-Bus error names.</doc>
43752 <return-value transfer-ownership="none">
43753 <type name="none" c:type="void"/>
43756 <parameter name="error_domain_quark_name" transfer-ownership="none">
43757 <doc xml:whitespace="preserve">The error domain name.</doc>
43758 <type name="utf8" c:type="gchar*"/>
43760 <parameter name="quark_volatile" transfer-ownership="none">
43761 <doc xml:whitespace="preserve">A pointer where to store the #GQuark.</doc>
43762 <type name="gulong" c:type="gsize*"/>
43764 <parameter name="entries" transfer-ownership="none">
43765 <doc xml:whitespace="preserve">A pointer to @num_entries #GDBusErrorEntry struct items.</doc>
43766 <type name="DBusErrorEntry" c:type="GDBusErrorEntry*"/>
43768 <parameter name="num_entries" transfer-ownership="none">
43769 <doc xml:whitespace="preserve">Number of items to register.</doc>
43770 <type name="guint" c:type="guint"/>
43774 <function name="dbus_error_set_dbus_error"
43775 c:identifier="g_dbus_error_set_dbus_error"
43777 introspectable="0">
43778 <doc xml:whitespace="preserve">Does nothing if @error is %NULL. Otherwise sets *@error to
43779 a new #GError created with g_dbus_error_new_for_dbus_error()
43780 with @dbus_error_message prepend with @format (unless %NULL).</doc>
43781 <return-value transfer-ownership="none">
43782 <type name="none" c:type="void"/>
43785 <parameter name="error" transfer-ownership="none">
43786 <doc xml:whitespace="preserve">A pointer to a #GError or %NULL.</doc>
43787 <type name="GLib.Error" c:type="GError**"/>
43789 <parameter name="dbus_error_name" transfer-ownership="none">
43790 <doc xml:whitespace="preserve">D-Bus error name.</doc>
43791 <type name="utf8" c:type="gchar*"/>
43793 <parameter name="dbus_error_message" transfer-ownership="none">
43794 <doc xml:whitespace="preserve">D-Bus error message.</doc>
43795 <type name="utf8" c:type="gchar*"/>
43797 <parameter name="format" transfer-ownership="none">
43798 <doc xml:whitespace="preserve">printf()-style format to prepend to @dbus_error_message or %NULL.</doc>
43799 <type name="utf8" c:type="gchar*"/>
43801 <parameter transfer-ownership="none">
43807 <function name="dbus_error_set_dbus_error_valist"
43808 c:identifier="g_dbus_error_set_dbus_error_valist"
43810 introspectable="0">
43811 <doc xml:whitespace="preserve">Like g_dbus_error_set_dbus_error() but intended for language bindings.</doc>
43812 <return-value transfer-ownership="none">
43813 <type name="none" c:type="void"/>
43816 <parameter name="error" transfer-ownership="none">
43817 <doc xml:whitespace="preserve">A pointer to a #GError or %NULL.</doc>
43818 <type name="GLib.Error" c:type="GError**"/>
43820 <parameter name="dbus_error_name" transfer-ownership="none">
43821 <doc xml:whitespace="preserve">D-Bus error name.</doc>
43822 <type name="utf8" c:type="gchar*"/>
43824 <parameter name="dbus_error_message" transfer-ownership="none">
43825 <doc xml:whitespace="preserve">D-Bus error message.</doc>
43826 <type name="utf8" c:type="gchar*"/>
43828 <parameter name="format" transfer-ownership="none">
43829 <doc xml:whitespace="preserve">printf()-style format to prepend to @dbus_error_message or %NULL.</doc>
43830 <type name="utf8" c:type="gchar*"/>
43832 <parameter name="var_args" transfer-ownership="none">
43833 <doc xml:whitespace="preserve">Arguments for @format.</doc>
43834 <type name="va_list" c:type="va_list"/>
43838 <function name="dbus_error_strip_remote_error"
43839 c:identifier="g_dbus_error_strip_remote_error"
43841 <doc xml:whitespace="preserve">Looks for extra information in the error message used to recover
43842 the D-Bus error name and strips it if found. If stripped, the
43843 message field in @error will correspond exactly to what was
43844 received on the wire.
43845 This is typically used when presenting errors to the end user.</doc>
43846 <return-value transfer-ownership="none">
43847 <doc xml:whitespace="preserve">%TRUE if information was stripped, %FALSE otherwise.</doc>
43848 <type name="gboolean" c:type="gboolean"/>
43851 <parameter name="error" transfer-ownership="none">
43852 <doc xml:whitespace="preserve">A #GError.</doc>
43853 <type name="GLib.Error" c:type="GError*"/>
43857 <function name="dbus_error_unregister_error"
43858 c:identifier="g_dbus_error_unregister_error"
43860 <doc xml:whitespace="preserve">Destroys an association previously set up with g_dbus_error_register_error().</doc>
43861 <return-value transfer-ownership="none">
43862 <doc xml:whitespace="preserve">%TRUE if the association was destroyed, %FALSE if it wasn't found.</doc>
43863 <type name="gboolean" c:type="gboolean"/>
43866 <parameter name="error_domain" transfer-ownership="none">
43867 <doc xml:whitespace="preserve">A #GQuark for a error domain.</doc>
43868 <type name="GLib.Quark" c:type="GQuark"/>
43870 <parameter name="error_code" transfer-ownership="none">
43871 <doc xml:whitespace="preserve">An error code.</doc>
43872 <type name="gint" c:type="gint"/>
43874 <parameter name="dbus_error_name" transfer-ownership="none">
43875 <doc xml:whitespace="preserve">A D-Bus error name.</doc>
43876 <type name="utf8" c:type="gchar*"/>
43880 <function name="dbus_generate_guid"
43881 c:identifier="g_dbus_generate_guid"
43883 <doc xml:whitespace="preserve">Generate a D-Bus GUID that can be used with
43884 e.g. g_dbus_connection_new().
43885 See the D-Bus specification regarding what strings are valid D-Bus
43886 GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).</doc>
43887 <return-value transfer-ownership="full">
43888 <doc xml:whitespace="preserve">A valid D-Bus GUID. Free with g_free().</doc>
43889 <type name="utf8" c:type="gchar*"/>
43892 <function name="dbus_is_address"
43893 c:identifier="g_dbus_is_address"
43895 <doc xml:whitespace="preserve">Checks if @string is a D-Bus address.
43896 This doesn't check if @string is actually supported by #GDBusServer
43897 or #GDBusConnection - use g_dbus_is_supported_address() to do more
43899 <return-value transfer-ownership="none">
43900 <doc xml:whitespace="preserve">%TRUE if @string is a valid D-Bus address, %FALSE otherwise.</doc>
43901 <type name="gboolean" c:type="gboolean"/>
43904 <parameter name="string" transfer-ownership="none">
43905 <doc xml:whitespace="preserve">A string.</doc>
43906 <type name="utf8" c:type="gchar*"/>
43910 <function name="dbus_is_guid" c:identifier="g_dbus_is_guid" version="2.26">
43911 <doc xml:whitespace="preserve">Checks if @string is a D-Bus GUID.
43912 See the D-Bus specification regarding what strings are valid D-Bus
43913 GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).</doc>
43914 <return-value transfer-ownership="none">
43915 <doc xml:whitespace="preserve">%TRUE if @string is a guid, %FALSE otherwise.</doc>
43916 <type name="gboolean" c:type="gboolean"/>
43919 <parameter name="string" transfer-ownership="none">
43920 <doc xml:whitespace="preserve">The string to check.</doc>
43921 <type name="utf8" c:type="gchar*"/>
43925 <function name="dbus_is_interface_name"
43926 c:identifier="g_dbus_is_interface_name"
43928 <doc xml:whitespace="preserve">Checks if @string is a valid D-Bus interface name.</doc>
43929 <return-value transfer-ownership="none">
43930 <doc xml:whitespace="preserve">%TRUE if valid, %FALSE otherwise.</doc>
43931 <type name="gboolean" c:type="gboolean"/>
43934 <parameter name="string" transfer-ownership="none">
43935 <doc xml:whitespace="preserve">The string to check.</doc>
43936 <type name="utf8" c:type="gchar*"/>
43940 <function name="dbus_is_member_name"
43941 c:identifier="g_dbus_is_member_name"
43943 <doc xml:whitespace="preserve">Checks if @string is a valid D-Bus member (e.g. signal or method) name.</doc>
43944 <return-value transfer-ownership="none">
43945 <doc xml:whitespace="preserve">%TRUE if valid, %FALSE otherwise.</doc>
43946 <type name="gboolean" c:type="gboolean"/>
43949 <parameter name="string" transfer-ownership="none">
43950 <doc xml:whitespace="preserve">The string to check.</doc>
43951 <type name="utf8" c:type="gchar*"/>
43955 <function name="dbus_is_name" c:identifier="g_dbus_is_name" version="2.26">
43956 <doc xml:whitespace="preserve">Checks if @string is a valid D-Bus bus name (either unique or well-known).</doc>
43957 <return-value transfer-ownership="none">
43958 <doc xml:whitespace="preserve">%TRUE if valid, %FALSE otherwise.</doc>
43959 <type name="gboolean" c:type="gboolean"/>
43962 <parameter name="string" transfer-ownership="none">
43963 <doc xml:whitespace="preserve">The string to check.</doc>
43964 <type name="utf8" c:type="gchar*"/>
43968 <function name="dbus_is_supported_address"
43969 c:identifier="g_dbus_is_supported_address"
43972 <doc xml:whitespace="preserve">Like g_dbus_is_address() but also checks if the library suppors the
43973 transports in @string and that key/value pairs for each transport
43975 supported by this library, %FALSE if @error is set.</doc>
43976 <return-value transfer-ownership="none">
43977 <doc xml:whitespace="preserve">%TRUE if @string is a valid D-Bus address that is</doc>
43978 <type name="gboolean" c:type="gboolean"/>
43981 <parameter name="string" transfer-ownership="none">
43982 <doc xml:whitespace="preserve">A string.</doc>
43983 <type name="utf8" c:type="gchar*"/>
43987 <function name="dbus_is_unique_name"
43988 c:identifier="g_dbus_is_unique_name"
43990 <doc xml:whitespace="preserve">Checks if @string is a valid D-Bus unique bus name.</doc>
43991 <return-value transfer-ownership="none">
43992 <doc xml:whitespace="preserve">%TRUE if valid, %FALSE otherwise.</doc>
43993 <type name="gboolean" c:type="gboolean"/>
43996 <parameter name="string" transfer-ownership="none">
43997 <doc xml:whitespace="preserve">The string to check.</doc>
43998 <type name="utf8" c:type="gchar*"/>
44002 <function name="file_hash" c:identifier="g_file_hash">
44003 <doc xml:whitespace="preserve">Creates a hash value for a #GFile.
44004 This call does no blocking i/o.
44005 integer that can be used as hash value for the #GFile.
44006 This function is intended for easily hashing a #GFile to
44007 add to a #GHashTable or similar data structure.</doc>
44008 <return-value transfer-ownership="none">
44009 <doc xml:whitespace="preserve">0 if @file is not a valid #GFile, otherwise an</doc>
44010 <type name="guint" c:type="guint"/>
44013 <parameter name="file" transfer-ownership="none">
44014 <doc xml:whitespace="preserve">#gconstpointer to a #GFile.</doc>
44015 <type name="gpointer" c:type="gconstpointer"/>
44019 <function name="file_new_for_commandline_arg"
44020 c:identifier="g_file_new_for_commandline_arg">
44021 <doc xml:whitespace="preserve">Creates a #GFile with the given argument from the command line. The value of
44022 relative to the current working directory.
44023 This operation never fails, but the returned object might not support any
44024 I/O operation if @arg points to a malformed path.</doc>
44025 <return-value transfer-ownership="full">
44026 <doc xml:whitespace="preserve">a new #GFile.</doc>
44027 <type name="File" c:type="GFile*"/>
44030 <parameter name="arg" transfer-ownership="none">
44031 <doc xml:whitespace="preserve">a command line string.</doc>
44032 <type name="utf8" c:type="char*"/>
44036 <function name="file_new_for_path" c:identifier="g_file_new_for_path">
44037 <doc xml:whitespace="preserve">Constructs a #GFile for a given path. This operation never
44038 fails, but the returned object might not support any I/O
44039 operation if @path is malformed.</doc>
44040 <return-value transfer-ownership="full">
44041 <doc xml:whitespace="preserve">a new #GFile for the given @path.</doc>
44042 <type name="File" c:type="GFile*"/>
44045 <parameter name="path" transfer-ownership="none">
44046 <doc xml:whitespace="preserve">a string containing a relative or absolute path. The string must be encoded in the glib filename encoding.</doc>
44047 <type name="utf8" c:type="char*"/>
44051 <function name="file_new_for_uri" c:identifier="g_file_new_for_uri">
44052 <doc xml:whitespace="preserve">Constructs a #GFile for a given URI. This operation never
44053 fails, but the returned object might not support any I/O
44054 operation if @uri is malformed or if the uri type is
44055 not supported.</doc>
44056 <return-value transfer-ownership="full">
44057 <doc xml:whitespace="preserve">a #GFile for the given @uri.</doc>
44058 <type name="File" c:type="GFile*"/>
44061 <parameter name="uri" transfer-ownership="none">
44062 <doc xml:whitespace="preserve">a UTF8 string containing a URI.</doc>
44063 <type name="utf8" c:type="char*"/>
44067 <function name="file_parse_name" c:identifier="g_file_parse_name">
44068 <doc xml:whitespace="preserve">Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
44069 This operation never fails, but the returned object might not support any I/O
44070 operation if the @parse_name cannot be parsed.</doc>
44071 <return-value transfer-ownership="full">
44072 <doc xml:whitespace="preserve">a new #GFile.</doc>
44073 <type name="File" c:type="GFile*"/>
44076 <parameter name="parse_name" transfer-ownership="none">
44077 <doc xml:whitespace="preserve">a file name or path to be parsed.</doc>
44078 <type name="utf8" c:type="char*"/>
44082 <function name="icon_hash" c:identifier="g_icon_hash">
44083 <doc xml:whitespace="preserve">Gets a hash for an icon.
44084 use in a #GHashTable or similar data structure.</doc>
44085 <return-value transfer-ownership="none">
44086 <doc xml:whitespace="preserve">a #guint containing a hash for the @icon, suitable for</doc>
44087 <type name="guint" c:type="guint"/>
44090 <parameter name="icon" transfer-ownership="none">
44091 <doc xml:whitespace="preserve">#gconstpointer to an icon object.</doc>
44092 <type name="gpointer" c:type="gconstpointer"/>
44096 <function name="icon_new_for_string"
44097 c:identifier="g_icon_new_for_string"
44101 <doc xml:whitespace="preserve">Generate a #GIcon instance from @str. This function can fail if
44102 If your application or library provides one or more #GIcon
44103 implementations you need to ensure that each #GType is registered
44104 with the type system prior to calling g_icon_new_for_string().</doc>
44106 <doc xml:whitespace="preserve">An object implementing the #GIcon interface or %NULL if</doc>
44107 <type name="Icon" c:type="GIcon*"/>
44110 <parameter name="str" transfer-ownership="none">
44111 <doc xml:whitespace="preserve">A string obtained via g_icon_to_string().</doc>
44112 <type name="utf8" c:type="gchar*"/>
44116 <function name="initable_new"
44117 c:identifier="g_initable_new"
44119 introspectable="0">
44120 <doc xml:whitespace="preserve">Helper function for constructing #GInitiable object. This is
44121 similar to g_object_new() but also initializes the object
44122 and returns %NULL, setting an error on failure.</doc>
44123 <return-value transfer-ownership="full">
44124 <doc xml:whitespace="preserve">a newly allocated #GObject, or %NULL on error</doc>
44125 <type name="gpointer" c:type="gpointer"/>
44128 <parameter name="object_type" transfer-ownership="none">
44129 <doc xml:whitespace="preserve">a #GType supporting #GInitable.</doc>
44130 <type name="GType" c:type="GType"/>
44132 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
44133 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
44134 <type name="Cancellable" c:type="GCancellable*"/>
44136 <parameter name="error" transfer-ownership="none">
44137 <doc xml:whitespace="preserve">a #GError location to store the error occuring, or %NULL to ignore.</doc>
44138 <type name="GLib.Error" c:type="GError**"/>
44140 <parameter name="first_property_name" transfer-ownership="none">
44141 <doc xml:whitespace="preserve">the name of the first property, or %NULL if no properties</doc>
44142 <type name="utf8" c:type="gchar*"/>
44144 <parameter transfer-ownership="none">
44150 <function name="initable_new_valist"
44151 c:identifier="g_initable_new_valist"
44155 <doc xml:whitespace="preserve">Helper function for constructing #GInitiable object. This is
44156 similar to g_object_new_valist() but also initializes the object
44157 and returns %NULL, setting an error on failure.</doc>
44158 <return-value transfer-ownership="full">
44159 <doc xml:whitespace="preserve">a newly allocated #GObject, or %NULL on error</doc>
44160 <type name="GObject.Object" c:type="GObject*"/>
44163 <parameter name="object_type" transfer-ownership="none">
44164 <doc xml:whitespace="preserve">a #GType supporting #GInitable.</doc>
44165 <type name="GType" c:type="GType"/>
44167 <parameter name="first_property_name" transfer-ownership="none">
44168 <doc xml:whitespace="preserve">the name of the first property, followed by the value, and other property value pairs, and ended by %NULL.</doc>
44169 <type name="utf8" c:type="gchar*"/>
44171 <parameter name="var_args" transfer-ownership="none">
44172 <doc xml:whitespace="preserve">The var args list generated from @first_property_name.</doc>
44173 <type name="va_list" c:type="va_list"/>
44175 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
44176 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
44177 <type name="Cancellable" c:type="GCancellable*"/>
44181 <function name="initable_newv"
44182 c:identifier="g_initable_newv"
44185 <doc xml:whitespace="preserve">Helper function for constructing #GInitiable object. This is
44186 similar to g_object_newv() but also initializes the object
44187 and returns %NULL, setting an error on failure.</doc>
44188 <return-value transfer-ownership="full">
44189 <doc xml:whitespace="preserve">a newly allocated #GObject, or %NULL on error</doc>
44190 <type name="gpointer" c:type="gpointer"/>
44193 <parameter name="object_type" transfer-ownership="none">
44194 <doc xml:whitespace="preserve">a #GType supporting #GInitable.</doc>
44195 <type name="GType" c:type="GType"/>
44197 <parameter name="n_parameters" transfer-ownership="none">
44198 <doc xml:whitespace="preserve">the number of parameters in @parameters</doc>
44199 <type name="guint" c:type="guint"/>
44201 <parameter name="parameters" transfer-ownership="none">
44202 <doc xml:whitespace="preserve">the parameters to use to construct the object</doc>
44203 <type name="GObject.Parameter" c:type="GParameter*"/>
44205 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
44206 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
44207 <type name="Cancellable" c:type="GCancellable*"/>
44211 <function name="io_error_from_errno" c:identifier="g_io_error_from_errno">
44212 <doc xml:whitespace="preserve">Converts errno.h error codes into GIO error codes.</doc>
44213 <return-value transfer-ownership="none">
44214 <doc xml:whitespace="preserve">#GIOErrorEnum value for the given errno.h error number.</doc>
44215 <type name="IOErrorEnum" c:type="GIOErrorEnum"/>
44218 <parameter name="err_no" transfer-ownership="none">
44219 <doc xml:whitespace="preserve">Error number as defined in errno.h.</doc>
44220 <type name="gint" c:type="gint"/>
44224 <function name="io_error_quark" c:identifier="g_io_error_quark">
44225 <doc xml:whitespace="preserve">Gets the GIO Error Quark.</doc>
44226 <return-value transfer-ownership="none">
44227 <doc xml:whitespace="preserve">a #GQuark.</doc>
44228 <type name="GLib.Quark" c:type="GQuark"/>
44231 <function name="io_extension_get_type"
44232 c:identifier="g_io_extension_get_type">
44233 <doc xml:whitespace="preserve">Gets the type associated with @extension.</doc>
44234 <return-value transfer-ownership="none">
44235 <doc xml:whitespace="preserve">the type of @extension</doc>
44236 <type name="GType" c:type="GType"/>
44239 <parameter name="extension" transfer-ownership="none">
44240 <doc xml:whitespace="preserve">a #GIOExtension</doc>
44241 <type name="IOExtension" c:type="GIOExtension*"/>
44245 <function name="io_extension_point_implement"
44246 c:identifier="g_io_extension_point_implement"
44247 introspectable="0">
44248 <doc xml:whitespace="preserve">Registers @type as extension for the extension point with name
44249 If @type has already been registered as an extension for this
44250 extension point, the existing #GIOExtension object is returned.</doc>
44252 <doc xml:whitespace="preserve">a #GIOExtension object for #GType</doc>
44253 <type name="IOExtension" c:type="GIOExtension*"/>
44256 <parameter name="extension_point_name" transfer-ownership="none">
44257 <doc xml:whitespace="preserve">the name of the extension point</doc>
44258 <type name="utf8" c:type="char*"/>
44260 <parameter name="type" transfer-ownership="none">
44261 <doc xml:whitespace="preserve">the #GType to register as extension</doc>
44262 <type name="GType" c:type="GType"/>
44264 <parameter name="extension_name" transfer-ownership="none">
44265 <doc xml:whitespace="preserve">the name for the extension</doc>
44266 <type name="utf8" c:type="char*"/>
44268 <parameter name="priority" transfer-ownership="none">
44269 <doc xml:whitespace="preserve">the priority for the extension</doc>
44270 <type name="gint" c:type="gint"/>
44274 <function name="io_extension_point_lookup"
44275 c:identifier="g_io_extension_point_lookup"
44276 introspectable="0">
44277 <doc xml:whitespace="preserve">Looks up an existing extension point.
44278 registered extension point with the given name</doc>
44280 <doc xml:whitespace="preserve">the #GIOExtensionPoint, or %NULL if there is no</doc>
44281 <type name="IOExtensionPoint" c:type="GIOExtensionPoint*"/>
44284 <parameter name="name" transfer-ownership="none">
44285 <doc xml:whitespace="preserve">the name of the extension point</doc>
44286 <type name="utf8" c:type="char*"/>
44290 <function name="io_extension_point_register"
44291 c:identifier="g_io_extension_point_register"
44292 introspectable="0">
44293 <doc xml:whitespace="preserve">Registers an extension point.
44294 and should not be freed</doc>
44296 <doc xml:whitespace="preserve">the new #GIOExtensionPoint. This object is owned by GIO</doc>
44297 <type name="IOExtensionPoint" c:type="GIOExtensionPoint*"/>
44300 <parameter name="name" transfer-ownership="none">
44301 <doc xml:whitespace="preserve">The name of the extension point</doc>
44302 <type name="utf8" c:type="char*"/>
44306 <function name="io_modules_load_all_in_directory"
44307 c:identifier="g_io_modules_load_all_in_directory">
44308 <doc xml:whitespace="preserve">Loads all the modules in the specified directory.
44309 If don't require all modules to be initialized (and thus registering
44310 all gtypes) then you can use g_io_modules_scan_all_in_directory()
44311 which allows delayed/lazy loading of modules.
44312 from the directory,
44313 All the modules are loaded into memory, if you want to
44314 unload them (enabling on-demand loading) you must call
44315 g_type_module_unuse() on all the modules. Free the list
44316 with g_list_free().</doc>
44317 <return-value transfer-ownership="full">
44318 <doc xml:whitespace="preserve">a list of #GIOModules loaded</doc>
44319 <type name="GLib.List" c:type="GList*">
44320 <type name="IOModule"/>
44324 <parameter name="dirname" transfer-ownership="none">
44325 <doc xml:whitespace="preserve">pathname for a directory containing modules to load.</doc>
44326 <type name="utf8" c:type="gchar*"/>
44330 <function name="io_modules_scan_all_in_directory"
44331 c:identifier="g_io_modules_scan_all_in_directory"
44333 <doc xml:whitespace="preserve">Scans all the modules in the specified directory, ensuring that
44334 any extension point implemented by a module is registered.
44335 This may not actually load and initialize all the types in each
44336 module, some modules may be lazily loaded and initialized when
44337 an extension point it implementes is used with e.g.
44338 g_io_extension_point_get_extensions() or
44339 g_io_extension_point_get_extension_by_name().
44340 If you need to guarantee that all types are loaded in all the modules,
44341 use g_io_modules_scan_all_in_directory().</doc>
44342 <return-value transfer-ownership="none">
44343 <type name="none" c:type="void"/>
44346 <parameter name="dirname" transfer-ownership="none">
44347 <doc xml:whitespace="preserve">pathname for a directory containing modules to scan.</doc>
44348 <type name="utf8" c:type="char*"/>
44352 <function name="io_scheduler_cancel_all_jobs"
44353 c:identifier="g_io_scheduler_cancel_all_jobs">
44354 <doc xml:whitespace="preserve">Cancels all cancellable I/O jobs.
44355 A job is cancellable if a #GCancellable was passed into
44356 g_io_scheduler_push_job().</doc>
44357 <return-value transfer-ownership="none">
44358 <type name="none" c:type="void"/>
44361 <function name="io_scheduler_push_job"
44362 c:identifier="g_io_scheduler_push_job">
44363 <doc xml:whitespace="preserve">Schedules the I/O job to run.
44364 regardless whether the job was cancelled or has run to completion.
44365 If @cancellable is not %NULL, it can be used to cancel the I/O job
44366 by calling g_cancellable_cancel() or by calling
44367 g_io_scheduler_cancel_all_jobs().</doc>
44368 <return-value transfer-ownership="none">
44369 <type name="none" c:type="void"/>
44372 <parameter name="job_func"
44373 transfer-ownership="none"
44377 <doc xml:whitespace="preserve">a #GIOSchedulerJobFunc.</doc>
44378 <type name="IOSchedulerJobFunc" c:type="GIOSchedulerJobFunc"/>
44380 <parameter name="user_data" transfer-ownership="none">
44381 <doc xml:whitespace="preserve">data to pass to @job_func</doc>
44382 <type name="gpointer" c:type="gpointer"/>
44384 <parameter name="notify" transfer-ownership="none" scope="async">
44385 <doc xml:whitespace="preserve">a #GDestroyNotify for @user_data, or %NULL</doc>
44386 <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
44388 <parameter name="io_priority" transfer-ownership="none">
44389 <doc xml:whitespace="preserve">the <link linkend="gioscheduler">I/O priority</link> of the request.</doc>
44390 <type name="gint" c:type="gint"/>
44392 <parameter name="cancellable" transfer-ownership="none" allow-none="1">
44393 <doc xml:whitespace="preserve">optional #GCancellable object, %NULL to ignore.</doc>
44394 <type name="Cancellable" c:type="GCancellable*"/>
44398 <function name="keyfile_settings_backend_new"
44399 c:identifier="g_keyfile_settings_backend_new">
44400 <doc xml:whitespace="preserve">Creates a keyfile-backed #GSettingsBackend.
44401 The filename of the keyfile to use is given by @filename.
44402 All settings read to or written from the backend must fall under the
44403 path given in @root_path (which must start and end with a slash and
44404 not contain two consecutive slashes). @root_path may be "/".
44405 If @root_group is non-%NULL then it specifies the name of the keyfile
44406 group used for keys that are written directly below @root_path. For
44407 example, if @root_path is "/apps/example/" and @root_group is
44408 "toplevel", then settings the key "/apps/example/enabled" to a value
44409 of %TRUE will cause the following to appear in the keyfile:
44414 If @root_group is %NULL then it is not permitted to store keys
44415 directly below the @root_path.
44416 the name of the subpath (with the final slash stripped) is used as
44417 the name of the keyfile group. To continue the example, if
44418 "/apps/example/profiles/default/font-size" were set to
44419 12 then the following would appear in the keyfile:
44424 The backend will refuse writes (and return writability as being
44425 %FALSE) for keys outside of @root_path and, in the event that
44426 Writes will also be refused if the backend detects that it has the
44428 There is no checking done for your key namespace clashing with the
44429 syntax of the key file format. For example, if you have '[' or ']'
44430 characters in your path names or '=' in your key names you may be in
44432 <return-value transfer-ownership="full">
44433 <doc xml:whitespace="preserve">a keyfile-backed #GSettingsBackend</doc>
44434 <type name="SettingsBackend" c:type="GSettingsBackend*"/>
44437 <parameter name="filename" transfer-ownership="none">
44438 <doc xml:whitespace="preserve">the filename of the keyfile</doc>
44439 <type name="utf8" c:type="gchar*"/>
44441 <parameter name="root_path" transfer-ownership="none">
44442 <doc xml:whitespace="preserve">the path under which all settings keys appear</doc>
44443 <type name="utf8" c:type="gchar*"/>
44445 <parameter name="root_group" transfer-ownership="none" allow-none="1">
44446 <doc xml:whitespace="preserve">the group name corresponding to</doc>
44447 <type name="utf8" c:type="gchar*"/>
44451 <function name="proxy_get_default_for_protocol"
44452 c:identifier="g_proxy_get_default_for_protocol"
44454 introspectable="0">
44455 <doc xml:whitespace="preserve">Lookup "gio-proxy" extension point for a proxy implementation that supports
44456 specified protocol.</doc>
44458 <doc xml:whitespace="preserve">return a #GProxy or NULL if protocol is not supported.</doc>
44459 <type name="Proxy" c:type="GProxy*"/>
44462 <parameter name="protocol" transfer-ownership="none">
44463 <doc xml:whitespace="preserve">the proxy protocol name (e.g. http, socks, etc)</doc>
44464 <type name="utf8" c:type="gchar*"/>
44468 <function name="proxy_resolver_get_default"
44469 c:identifier="g_proxy_resolver_get_default"
44471 <doc xml:whitespace="preserve">Gets the default #GProxyResolver for the system.</doc>
44472 <return-value transfer-ownership="none">
44473 <doc xml:whitespace="preserve">the default #GProxyResolver.</doc>
44474 <type name="ProxyResolver" c:type="GProxyResolver*"/>
44477 <function name="resolver_error_quark"
44478 c:identifier="g_resolver_error_quark"
44480 <doc xml:whitespace="preserve">Gets the #GResolver Error Quark.</doc>
44481 <return-value transfer-ownership="none">
44482 <doc xml:whitespace="preserve">a #GQuark.</doc>
44483 <type name="GLib.Quark" c:type="GQuark"/>
44486 <function name="simple_async_report_error_in_idle"
44487 c:identifier="g_simple_async_report_error_in_idle"
44488 introspectable="0">
44489 <doc xml:whitespace="preserve">Reports an error in an asynchronous function in an idle function by
44490 directly setting the contents of the #GAsyncResult with the given error
44492 <return-value transfer-ownership="none">
44493 <type name="none" c:type="void"/>
44496 <parameter name="object" transfer-ownership="none">
44497 <doc xml:whitespace="preserve">a #GObject.</doc>
44498 <type name="GObject.Object" c:type="GObject*"/>
44500 <parameter name="callback"
44501 transfer-ownership="none"
44504 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
44505 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
44507 <parameter name="user_data" transfer-ownership="none">
44508 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
44509 <type name="gpointer" c:type="gpointer"/>
44511 <parameter name="domain" transfer-ownership="none">
44512 <doc xml:whitespace="preserve">a #GQuark containing the error domain (usually #G_IO_ERROR).</doc>
44513 <type name="GLib.Quark" c:type="GQuark"/>
44515 <parameter name="code" transfer-ownership="none">
44516 <doc xml:whitespace="preserve">a specific error code.</doc>
44517 <type name="gint" c:type="gint"/>
44519 <parameter name="format" transfer-ownership="none">
44520 <doc xml:whitespace="preserve">a formatted error reporting string.</doc>
44521 <type name="utf8" c:type="char*"/>
44523 <parameter transfer-ownership="none">
44529 <function name="simple_async_report_gerror_in_idle"
44530 c:identifier="g_simple_async_report_gerror_in_idle">
44531 <doc xml:whitespace="preserve">Reports an error in an idle function. Similar to
44532 g_simple_async_report_error_in_idle(), but takes a #GError rather
44533 than building a new one.</doc>
44534 <return-value transfer-ownership="none">
44535 <type name="none" c:type="void"/>
44538 <parameter name="object" transfer-ownership="none">
44539 <doc xml:whitespace="preserve">a #GObject.</doc>
44540 <type name="GObject.Object" c:type="GObject*"/>
44542 <parameter name="callback"
44543 transfer-ownership="none"
44546 <doc xml:whitespace="preserve">a #GAsyncReadyCallback.</doc>
44547 <type name="AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
44549 <parameter name="user_data" transfer-ownership="none">
44550 <doc xml:whitespace="preserve">user data passed to @callback.</doc>
44551 <type name="gpointer" c:type="gpointer"/>
44553 <parameter name="error" transfer-ownership="none">
44554 <doc xml:whitespace="preserve">the #GError to report</doc>
44555 <type name="GLib.Error" c:type="GError*"/>
44559 <function name="srv_target_list_sort"
44560 c:identifier="g_srv_target_list_sort"
44562 <doc xml:whitespace="preserve">Sorts @targets in place according to the algorithm in RFC 2782.</doc>
44563 <return-value transfer-ownership="full">
44564 <doc xml:whitespace="preserve">the head of the sorted list.</doc>
44565 <type name="GLib.List" c:type="GList*">
44566 <type name="gpointer" c:type="gpointer"/>
44570 <parameter name="targets" transfer-ownership="none">
44571 <doc xml:whitespace="preserve">a #GList of #GSrvTarget</doc>
44572 <type name="GLib.List" c:type="GList*">
44573 <type name="gpointer" c:type="gpointer"/>
44578 <function name="unix_is_mount_path_system_internal"
44579 c:identifier="g_unix_is_mount_path_system_internal">
44580 <doc xml:whitespace="preserve">Determines if @mount_path is considered an implementation of the
44581 OS. This is primarily used for hiding mountable and mounted volumes
44582 that only are used in the OS and has little to no relevance to the
44585 <return-value transfer-ownership="none">
44586 <doc xml:whitespace="preserve">%TRUE if @mount_path is considered an implementation detail</doc>
44587 <type name="gboolean" c:type="gboolean"/>
44590 <parameter name="mount_path" transfer-ownership="none">
44591 <doc xml:whitespace="preserve">a mount path, e.g. <filename>/media/disk</filename> or <filename>/usr</filename></doc>
44592 <type name="utf8" c:type="char*"/>
44596 <function name="unix_mount_at"
44597 c:identifier="g_unix_mount_at"
44598 introspectable="0">
44599 <doc xml:whitespace="preserve">Gets a #GUnixMountEntry for a given mount path. If @time_read
44600 is set, it will be filled with a unix timestamp for checking
44601 if the mounts have changed since with g_unix_mounts_changed_since().</doc>
44602 <return-value transfer-ownership="full">
44603 <doc xml:whitespace="preserve">a #GUnixMount.</doc>
44604 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44607 <parameter name="mount_path" transfer-ownership="none">
44608 <doc xml:whitespace="preserve">path for a possible unix mount.</doc>
44609 <type name="utf8" c:type="char*"/>
44611 <parameter name="time_read" transfer-ownership="none">
44612 <doc xml:whitespace="preserve">guint64 to contain a timestamp.</doc>
44613 <type name="guint64" c:type="guint64*"/>
44617 <function name="unix_mount_compare" c:identifier="g_unix_mount_compare">
44618 <doc xml:whitespace="preserve">Compares two unix mounts.
44619 or less than @mount2, respectively.</doc>
44620 <return-value transfer-ownership="none">
44621 <doc xml:whitespace="preserve">1, 0 or -1 if @mount1 is greater than, equal to,</doc>
44622 <type name="gint" c:type="gint"/>
44625 <parameter name="mount1" transfer-ownership="none">
44626 <doc xml:whitespace="preserve">first #GUnixMountEntry to compare.</doc>
44627 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44629 <parameter name="mount2" transfer-ownership="none">
44630 <doc xml:whitespace="preserve">second #GUnixMountEntry to compare.</doc>
44631 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44635 <function name="unix_mount_free" c:identifier="g_unix_mount_free">
44636 <doc xml:whitespace="preserve">Frees a unix mount.</doc>
44637 <return-value transfer-ownership="none">
44638 <type name="none" c:type="void"/>
44641 <parameter name="mount_entry" transfer-ownership="none">
44642 <doc xml:whitespace="preserve">a #GUnixMount.</doc>
44643 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44647 <function name="unix_mount_get_device_path"
44648 c:identifier="g_unix_mount_get_device_path">
44649 <doc xml:whitespace="preserve">Gets the device path for a unix mount.</doc>
44650 <return-value transfer-ownership="none">
44651 <doc xml:whitespace="preserve">a string containing the device path.</doc>
44652 <type name="utf8" c:type="char*"/>
44655 <parameter name="mount_entry" transfer-ownership="none">
44656 <doc xml:whitespace="preserve">a #GUnixMount.</doc>
44657 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44661 <function name="unix_mount_get_fs_type"
44662 c:identifier="g_unix_mount_get_fs_type">
44663 <doc xml:whitespace="preserve">Gets the filesystem type for the unix mount.</doc>
44664 <return-value transfer-ownership="none">
44665 <doc xml:whitespace="preserve">a string containing the file system type.</doc>
44666 <type name="utf8" c:type="char*"/>
44669 <parameter name="mount_entry" transfer-ownership="none">
44670 <doc xml:whitespace="preserve">a #GUnixMount.</doc>
44671 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44675 <function name="unix_mount_get_mount_path"
44676 c:identifier="g_unix_mount_get_mount_path">
44677 <doc xml:whitespace="preserve">Gets the mount path for a unix mount.</doc>
44678 <return-value transfer-ownership="none">
44679 <doc xml:whitespace="preserve">the mount path for @mount_entry.</doc>
44680 <type name="utf8" c:type="char*"/>
44683 <parameter name="mount_entry" transfer-ownership="none">
44684 <doc xml:whitespace="preserve">input #GUnixMountEntry to get the mount path for.</doc>
44685 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44689 <function name="unix_mount_guess_can_eject"
44690 c:identifier="g_unix_mount_guess_can_eject">
44691 <doc xml:whitespace="preserve">Guesses whether a Unix mount can be ejected.</doc>
44692 <return-value transfer-ownership="none">
44693 <doc xml:whitespace="preserve">%TRUE if @mount_entry is deemed to be ejectable.</doc>
44694 <type name="gboolean" c:type="gboolean"/>
44697 <parameter name="mount_entry" transfer-ownership="none">
44698 <doc xml:whitespace="preserve">a #GUnixMountEntry</doc>
44699 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44703 <function name="unix_mount_guess_icon"
44704 c:identifier="g_unix_mount_guess_icon">
44705 <doc xml:whitespace="preserve">Guesses the icon of a Unix mount.</doc>
44706 <return-value transfer-ownership="full">
44707 <doc xml:whitespace="preserve">a #GIcon</doc>
44708 <type name="Icon" c:type="GIcon*"/>
44711 <parameter name="mount_entry" transfer-ownership="none">
44712 <doc xml:whitespace="preserve">a #GUnixMountEntry</doc>
44713 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44717 <function name="unix_mount_guess_name"
44718 c:identifier="g_unix_mount_guess_name">
44719 <doc xml:whitespace="preserve">Guesses the name of a Unix mount.
44720 The result is a translated string.
44721 be freed with g_free()</doc>
44722 <return-value transfer-ownership="full">
44723 <doc xml:whitespace="preserve">A newly allocated string that must</doc>
44724 <type name="utf8" c:type="char*"/>
44727 <parameter name="mount_entry" transfer-ownership="none">
44728 <doc xml:whitespace="preserve">a #GUnixMountEntry</doc>
44729 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44733 <function name="unix_mount_guess_should_display"
44734 c:identifier="g_unix_mount_guess_should_display">
44735 <doc xml:whitespace="preserve">Guesses whether a Unix mount should be displayed in the UI.</doc>
44736 <return-value transfer-ownership="none">
44737 <doc xml:whitespace="preserve">%TRUE if @mount_entry is deemed to be displayable.</doc>
44738 <type name="gboolean" c:type="gboolean"/>
44741 <parameter name="mount_entry" transfer-ownership="none">
44742 <doc xml:whitespace="preserve">a #GUnixMountEntry</doc>
44743 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44747 <function name="unix_mount_is_readonly"
44748 c:identifier="g_unix_mount_is_readonly">
44749 <doc xml:whitespace="preserve">Checks if a unix mount is mounted read only.</doc>
44750 <return-value transfer-ownership="none">
44751 <doc xml:whitespace="preserve">%TRUE if @mount_entry is read only.</doc>
44752 <type name="gboolean" c:type="gboolean"/>
44755 <parameter name="mount_entry" transfer-ownership="none">
44756 <doc xml:whitespace="preserve">a #GUnixMount.</doc>
44757 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44761 <function name="unix_mount_is_system_internal"
44762 c:identifier="g_unix_mount_is_system_internal">
44763 <doc xml:whitespace="preserve">Checks if a unix mount is a system path.</doc>
44764 <return-value transfer-ownership="none">
44765 <doc xml:whitespace="preserve">%TRUE if the unix mount is for a system path.</doc>
44766 <type name="gboolean" c:type="gboolean"/>
44769 <parameter name="mount_entry" transfer-ownership="none">
44770 <doc xml:whitespace="preserve">a #GUnixMount.</doc>
44771 <type name="UnixMountEntry" c:type="GUnixMountEntry*"/>
44775 <function name="unix_mount_points_changed_since"
44776 c:identifier="g_unix_mount_points_changed_since">
44777 <doc xml:whitespace="preserve">Checks if the unix mount points have changed since a given unix time.</doc>
44778 <return-value transfer-ownership="none">
44779 <doc xml:whitespace="preserve">%TRUE if the mount points have changed since @time.</doc>
44780 <type name="gboolean" c:type="gboolean"/>
44783 <parameter name="time" transfer-ownership="none">
44784 <doc xml:whitespace="preserve">guint64 to contain a timestamp.</doc>
44785 <type name="guint64" c:type="guint64"/>
44789 <function name="unix_mount_points_get"
44790 c:identifier="g_unix_mount_points_get">
44791 <doc xml:whitespace="preserve">Gets a #GList of #GUnixMountPoint containing the unix mount points.
44792 If @time_read is set, it will be filled with the mount timestamp,
44793 allowing for checking if the mounts have changed with
44794 g_unix_mounts_points_changed_since().</doc>
44795 <return-value transfer-ownership="full">
44796 <doc xml:whitespace="preserve">a #GList of the UNIX mountpoints.</doc>
44797 <type name="GLib.List" c:type="GList*">
44798 <type name="utf8"/>
44802 <parameter name="time_read" transfer-ownership="none" allow-none="1">
44803 <doc xml:whitespace="preserve">guint64 to contain a timestamp.</doc>
44804 <type name="guint64" c:type="guint64*"/>
44808 <function name="unix_mounts_changed_since"
44809 c:identifier="g_unix_mounts_changed_since">
44810 <doc xml:whitespace="preserve">Checks if the unix mounts have changed since a given unix time.</doc>
44811 <return-value transfer-ownership="none">
44812 <doc xml:whitespace="preserve">%TRUE if the mounts have changed since @time.</doc>
44813 <type name="gboolean" c:type="gboolean"/>
44816 <parameter name="time" transfer-ownership="none">
44817 <doc xml:whitespace="preserve">guint64 to contain a timestamp.</doc>
44818 <type name="guint64" c:type="guint64"/>
44822 <function name="unix_mounts_get" c:identifier="g_unix_mounts_get">
44823 <doc xml:whitespace="preserve">Gets a #GList of #GUnixMountEntry containing the unix mounts.
44824 If @time_read is set, it will be filled with the mount
44825 timestamp, allowing for checking if the mounts have changed
44826 with g_unix_mounts_changed_since().</doc>
44827 <return-value transfer-ownership="full">
44828 <doc xml:whitespace="preserve">a #GList of the UNIX mounts.</doc>
44829 <type name="GLib.List" c:type="GList*">
44830 <type name="utf8"/>
44834 <parameter name="time_read" transfer-ownership="none" allow-none="1">
44835 <doc xml:whitespace="preserve">guint64 to contain a timestamp, or %NULL</doc>
44836 <type name="guint64" c:type="guint64*"/>