diff options
| author | José Alburquerque <jaalburqu@svn.gnome.org> | 2012-02-14 11:30:55 -0500 |
|---|---|---|
| committer | José Alburquerque <jaalburqu@svn.gnome.org> | 2012-02-14 11:30:55 -0500 |
| commit | fd8efdc63640e9a8c8b478f0fab634c502825d2f (patch) | |
| tree | 43ed07f2986bf060d624d6784694b447efdf93c5 | |
| parent | c17f1bdcdfb3fab1a8fd5c3fc19a94ad29d85780 (diff) | |
| download | glibmm-fd8efdc63640e9a8c8b478f0fab634c502825d2f.tar.gz | |
Regenerate XML docs for glibmm and giomm.
* gio/src/gio_docs.xml:
* glib/src/glib_docs.xml: Regenerate these, now including the signal
docs so that gmmproc can include their docs in the source generation
process.
| -rw-r--r-- | ChangeLog | 9 | ||||
| -rw-r--r-- | gio/src/gio_docs.xml | 24310 | ||||
| -rw-r--r-- | glib/src/glib_docs.xml | 10146 |
3 files changed, 32527 insertions, 1938 deletions
@@ -1,3 +1,12 @@ +2012-02-14 José Alburquerque <jaalburquerque@gmail.com> + + Regenerate XML docs for glibmm and giomm. + + * gio/src/gio_docs.xml: + * glib/src/glib_docs.xml: Regenerate these, now including the signal + docs so that gmmproc can include their docs in the source generation + process. + 2.31.16.1: 2012-02-13 José Alburquerque <jaalburquerque@gmail.com> diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml index 40267388..b33bf2ad 100644 --- a/gio/src/gio_docs.xml +++ b/gio/src/gio_docs.xml @@ -1,4 +1,4270 @@ <root> +<signal name="ExampleAnimal::handle-poke"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gtk-GDBus-Example-ObjectManager-Animal.Poke">Poke()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call example_animal_complete_poke() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleAnimal. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_make_sad"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_make_happy"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. + +</return> +</signal> + +<signal name="ExampleAnimal::jumped"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gtk-GDBus-Example-ObjectManager-Animal.Jumped">"Jumped"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleAnimal. +</parameter_description> +</parameter> +<parameter name="arg_height"> +<parameter_description> Argument. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenAuthorize::handle-check-authorized"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Authorize.CheckAuthorized">CheckAuthorized()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_authorize_complete_check_authorized() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenAuthorize. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenAuthorize::handle-check-not-authorized"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorized">CheckNotAuthorized()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_authorize_complete_check_not_authorized() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenAuthorize. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenAuthorize::handle-check-not-authorized-from-object"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorizedFromObject">CheckNotAuthorizedFromObject()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_authorize_complete_check_not_authorized_from_object() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenAuthorize. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::another-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-project-Bar.AnotherSignal">"AnotherSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="arg_word"> +<parameter_description> Argument. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenBar::handle-hello-world"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar.HelloWorld">HelloWorld()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_complete_hello_world() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::handle-property-cancellation"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar.PropertyCancellation">PropertyCancellation()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_complete_property_cancellation() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::handle-request-multi-property-mods"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar.RequestMultiPropertyMods">RequestMultiPropertyMods()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_complete_request_multi_property_mods() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::handle-request-signal-emission"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar.RequestSignalEmission">RequestSignalEmission()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_complete_request_signal_emission() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_which_one"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::handle-test-non-primitive-types"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar.TestNonPrimitiveTypes">TestNonPrimitiveTypes()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_complete_test_non_primitive_types() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_s"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_pairs"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_a_struct"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_array_of_strings"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_array_of_objpaths"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_array_of_signatures"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_array_of_bytestrings"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::handle-test-primitive-types"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar.TestPrimitiveTypes">TestPrimitiveTypes()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_complete_test_primitive_types() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_val_byte"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_boolean"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_int16"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_uint16"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_int32"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_uint32"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_int64"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_uint64"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_double"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_string"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_objpath"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_signature"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_val_bytestring"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::handle-unimplemented-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar.UnimplementedMethod">UnimplementedMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_complete_unimplemented_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBar::test-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-project-Bar.TestSignal">"TestSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="arg_val_int32"> +<parameter_description> Argument. +</parameter_description> +</parameter> +<parameter name="arg_array_of_strings"> +<parameter_description> Argument. +</parameter_description> +</parameter> +<parameter name="arg_array_of_bytestrings"> +<parameter_description> Argument. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_pairs"> +<parameter_description> Argument. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenBarFrobnicator::handle-random-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bar-Frobnicator.RandomMethod">RandomMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bar_frobnicator_complete_random_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBarFrobnicator. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenBat::force-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-project-Bat.ForceSignal">"ForceSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="arg_force_i"> +<parameter_description> Argument. +</parameter_description> +</parameter> +<parameter name="arg_force_s"> +<parameter_description> Argument. +</parameter_description> +</parameter> +<parameter name="arg_force_ay"> +<parameter_description> Argument. +</parameter_description> +</parameter> +<parameter name="arg_force_struct"> +<parameter_description> Argument. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenBat::handle-force-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-Bat.ForceMethod">ForceMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_bat_complete_force_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_force_in_i"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_force_in_s"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_force_in_ay"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_force_in_struct"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::added-signal-in10"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV10.AddedSignalIn10">"AddedSignalIn10"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +Since: 10.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::bar-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV10.BarSignal">"BarSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::baz-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV10.BazSignal">"BazSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::foo-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV10.FooSignal">"FooSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::handle-added-method-in10"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV10.AddedMethodIn10">AddedMethodIn10()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v10_complete_added_method_in10() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + +Since: 10.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. + +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::handle-bar-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV10.BarMethod">BarMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v10_complete_bar_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::handle-baz-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV10.BazMethod">BazMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v10_complete_baz_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::handle-foo-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV10.FooMethod">FooMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v10_complete_foo_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::handle-new-method-in2"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV10.NewMethodIn2">NewMethodIn2()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v10_complete_new_method_in2() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. + +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV10::new-signal-in2"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV10.NewSignalIn2">"NewSignalIn2"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV1::bar-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV1.BarSignal">"BarSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV1::baz-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV1.BazSignal">"BazSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV1::foo-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV1.FooSignal">"FooSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV1::handle-bar-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV1.BarMethod">BarMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v1_complete_bar_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV1::handle-baz-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV1.BazMethod">BazMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v1_complete_baz_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV1::handle-foo-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV1.FooMethod">FooMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v1_complete_foo_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::bar-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV2.BarSignal">"BarSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::baz-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV2.BazSignal">"BazSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::foo-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV2.FooSignal">"FooSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::handle-bar-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV2.BarMethod">BarMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v2_complete_bar_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::handle-baz-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV2.BazMethod">BazMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v2_complete_baz_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::handle-foo-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV2.FooMethod">FooMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v2_complete_foo_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::handle-new-method-in2"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-ChangingInterfaceV2.NewMethodIn2">NewMethodIn2()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_changing_interface_v2_complete_new_method_in2() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. + +</return> +</signal> + +<signal name="FooiGenChangingInterfaceV2::new-signal-in2"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-ChangingInterfaceV2.NewSignalIn2">"NewSignalIn2"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenComAcmeCoyote::handle-attack"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-com-acme-Coyote.Attack">Attack()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_com_acme_coyote_complete_attack() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenComAcmeCoyote::handle-run"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-com-acme-Coyote.Run">Run()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_com_acme_coyote_complete_run() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenComAcmeCoyote::handle-sleep"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-com-acme-Coyote.Sleep">Sleep()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_com_acme_coyote_complete_sleep() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenComAcmeCoyote::surprised"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-com-acme-Coyote.Surprised">"Surprised"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenFDPassing::handle-hello-fd"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-FDPassing.HelloFD">HelloFD()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_fdpassing_complete_hello_fd() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenFDPassing. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenInlineDocs::bar-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-project-InlineDocs.BarSignal">"BarSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="arg_blah"> +<parameter_description> Argument. +</parameter_description> +</parameter> +<parameter name="arg_boo"> +<parameter_description> Argument. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenInlineDocs::handle-foo-method"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-InlineDocs.FooMethod">FooMethod()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_inline_docs_complete_foo_method() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenInlineDocs::handle-method2"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-InlineDocs.Method2">Method2()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_inline_docs_complete_method2() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenMethodThreads::handle-get-self"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-project-MethodThreads.GetSelf">GetSelf()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_method_threads_complete_get_self() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenMethodThreads. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenOldieInterface::bar"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-OldieInterface.Bar">"Bar"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +Deprecated: The D-Bus signal has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenOldieInterface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenOldieInterface::handle-foo"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-OldieInterface.Foo">Foo()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_oldie_interface_complete_foo() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + +Deprecated: The D-Bus method has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenOldieInterface. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. + +</return> +</signal> + +<signal name="FooiGenRocket123::exploded-xyz"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-com-acme-Rocket.Exploded">"Exploded"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenRocket123::handle-ignite-xyz"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-com-acme-Rocket.Ignite">Ignite()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_rocket123_complete_ignite_xyz() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenTesTuglyCASEInterface::handle-get-iscsi-servers"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-TestUglyCaseInterface.GetiSCSIServers">GetiSCSIServers()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_test_ugly_case_interface_complete_get_iscsi_servers() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenTesTuglyCASEInterface. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenTesTuglyCASEInterface::servers-updated-now"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-TestUglyCaseInterface.serversUPDATEDNOW">"serversUPDATEDNOW"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenTesTuglyCASEInterface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="FooiGenUnknownXmlTags::handle-can-set-timezone"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-UnknownXmlTags.CanSetTimezone">CanSetTimezone()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call foo_igen_unknown_xml_tags_complete_can_set_timezone() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenUnknownXmlTags. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the invocation was handled, %FALSE to let other signal handlers run. +</return> +</signal> + +<signal name="FooiGenUnknownXmlTags::some-signal"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-UnknownXmlTags.SomeSignal">"SomeSignal"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenUnknownXmlTags. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GActionGroup::action-added"> +<description> +Signals that a new action was just added to the group. +This signal is emitted after the action has been added +and is now visible. + +Since: 2.28 + +</description> +<parameters> +<parameter name="action_group"> +<parameter_description> the #GActionGroup that changed +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of the action in @action_group +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GActionGroup::action-enabled-changed"> +<description> +Signals that the enabled status of the named action has changed. + +Since: 2.28 + +</description> +<parameters> +<parameter name="action_group"> +<parameter_description> the #GActionGroup that changed +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of the action in @action_group +</parameter_description> +</parameter> +<parameter name="enabled"> +<parameter_description> whether the action is enabled or not +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GActionGroup::action-removed"> +<description> +Signals that an action is just about to be removed from the group. +This signal is emitted before the action is removed, so the action +is still visible and can be queried from the signal handler. + +Since: 2.28 + +</description> +<parameters> +<parameter name="action_group"> +<parameter_description> the #GActionGroup that changed +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of the action in @action_group +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GActionGroup::action-state-changed"> +<description> +Signals that the state of the named action has changed. + +Since: 2.28 + +</description> +<parameters> +<parameter name="action_group"> +<parameter_description> the #GActionGroup that changed +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of the action in @action_group +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the new value of the state +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GApplication::activate"> +<description> +The ::activate signal is emitted on the primary instance when an +activation occurs. See g_application_activate(). + +</description> +<parameters> +<parameter name="application"> +<parameter_description> the application +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GApplication::command-line"> +<description> +The ::command-line signal is emitted on the primary instance when +a commandline is not handled locally. See g_application_run() and +the #GApplicationCommandline documentation for more information. + + +</description> +<parameters> +<parameter name="application"> +<parameter_description> the application +</parameter_description> +</parameter> +<parameter name="command_line"> +<parameter_description> a #GApplicationCommandLine representing the +passed commandline +</parameter_description> +</parameter> +</parameters> +<return> An integer that is set as the exit status for the calling +process. See g_application_command_line_set_exit_status(). +</return> +</signal> + +<signal name="GApplication::open"> +<description> +The ::open signal is emitted on the primary instance when there are +files to open. See g_application_open() for more information. + +</description> +<parameters> +<parameter name="application"> +<parameter_description> the application +</parameter_description> +</parameter> +<parameter name="files"> +<parameter_description> an array of #GFiles +</parameter_description> +</parameter> +<parameter name="n_files"> +<parameter_description> the length of @files +</parameter_description> +</parameter> +<parameter name="hint"> +<parameter_description> a hint provided by the calling instance +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GApplication::shutdown"> +<description> +The ::shutdown signal is emitted only on the registered primary instance +immediately after the main loop terminates. + +</description> +<parameters> +<parameter name="application"> +<parameter_description> the application +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GApplication::startup"> +<description> +The ::startup signal is emitted on the primary instance immediately +after registration. See g_application_register(). + +</description> +<parameters> +<parameter name="application"> +<parameter_description> the application +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GCancellable::cancelled"> +<description> +Emitted when the operation has been cancelled. + +Can be used by implementations of cancellable operations. If the +operation is cancelled from another thread, the signal will be +emitted in the thread that cancelled the operation, not the +thread that is running the operation. + +Note that disconnecting from this signal (or any signal) in a +multi-threaded program is prone to race conditions. For instance +it is possible that a signal handler may be invoked even +<emphasis>after</emphasis> a call to +g_signal_handler_disconnect() for that handler has already +returned. + +There is also a problem when cancellation happen +right before connecting to the signal. If this happens the +signal will unexpectedly not be emitted, and checking before +connecting to the signal leaves a race condition where this is +still happening. + +In order to make it safe and easy to connect handlers there +are two helper functions: g_cancellable_connect() and +g_cancellable_disconnect() which protect against problems +like this. + +An example of how to us this: +|[ +/<!-- -->* Make sure we don't do any unnecessary work if already cancelled *<!-- -->/ +if (g_cancellable_set_error_if_cancelled (cancellable)) +return; + +/<!-- -->* Set up all the data needed to be able to +* handle cancellation of the operation *<!-- -->/ +my_data = my_data_new (...); + +id = 0; +if (cancellable) +id = g_cancellable_connect (cancellable, +G_CALLBACK (cancelled_handler) +data, NULL); + +/<!-- -->* cancellable operation here... *<!-- -->/ + +g_cancellable_disconnect (cancellable, id); + +/<!-- -->* cancelled_handler is never called after this, it +* is now safe to free the data *<!-- -->/ +my_data_free (my_data); +]| + +Note that the cancelled signal is emitted in the thread that +the user cancelled from, which may be the main thread. So, the +cancellable signal should not do something that can block. + +</description> +<parameters> +<parameter name="cancellable"> +<parameter_description> a #GCancellable. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusAuthObserver::authorize-authenticated-peer"> +<description> +Emitted to check if a peer that is successfully authenticated +is authorized. + +Since: 2.26 + +</description> +<parameters> +<parameter name="observer"> +<parameter_description> The #GDBusAuthObserver emitting the signal. +</parameter_description> +</parameter> +<parameter name="stream"> +<parameter_description> A #GIOStream for the #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="credentials"> +<parameter_description> Credentials received from the peer or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the peer is authorized, %FALSE if not. + +</return> +</signal> + +<signal name="GDBusConnection::closed"> +<description> +Emitted when the connection is closed. + +The cause of this event can be +<itemizedlist> +<listitem><para> +If g_dbus_connection_close() is called. In this case +@remote_peer_vanished is set to %FALSE and @error is %NULL. +</para></listitem> +<listitem><para> +If the remote peer closes the connection. In this case +@remote_peer_vanished is set to %TRUE and @error is set. +</para></listitem> +<listitem><para> +If the remote peer sends invalid or malformed data. In this +case @remote_peer_vanished is set to %FALSE and @error +is set. +</para></listitem> +</itemizedlist> + +Upon receiving this signal, you should give up your reference to +@connection. You are guaranteed that this signal is emitted only +once. + +Since: 2.26 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> The #GDBusConnection emitting the signal. +</parameter_description> +</parameter> +<parameter name="remote_peer_vanished"> +<parameter_description> %TRUE if @connection is closed because the +remote peer closed its end of the connection. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> A #GError with more details about the event or %NULL. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusInterfaceSkeleton::g-authorize-method"> +<description> +Emitted when a method is invoked by a remote caller and used to +determine if the method call is authorized. + +Note that this signal is emitted in a thread dedicated to +handling the method call so handlers are allowed to perform +blocking IO. This means that it is appropriate to call +e.g. <ulink +url="http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#polkit-authority-check-authorization-sync">polkit_authority_check_authorization_sync()</ulink> +with the <ulink +url="http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#POLKIT-CHECK-AUTHORIZATION-FLAGS-ALLOW-USER-INTERACTION:CAPS">POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION</ulink> flag set. + +If %FALSE is returned then no further handlers are run and the +signal handler must take a reference to @invocation and finish +handling the call (e.g. return an error via +g_dbus_method_invocation_return_error()). + +Otherwise, if %TRUE is returned, signal emission continues. If no +handlers return %FALSE, then the method is dispatched. If +@interface has an enclosing #GDBusObjectSkeleton, then the +#GDBusObjectSkeleton::authorize-method signal handlers run before +the handlers for this signal. + +The default class handler just returns %TRUE. + +Please note that the common case is optimized: if no signals +handlers are connected and the default class handler isn't +overridden (for both @interface and the enclosing +#GDBusObjectSkeleton, if any) and #GDBusInterfaceSkeleton:g-flags does +not have the +%G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD +flags set, no dedicated thread is ever used and the call will be +handled in the same thread as the object that @interface belongs +to was exported in. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface"> +<parameter_description> The #GDBusInterfaceSkeleton emitting the signal. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call is authorized, %FALSE otherwise. + +</return> +</signal> + +<signal name="GDBusObject::interface-added"> +<description> +Emitted when @interface is added to @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> The #GDBusObject emitting the signal. +</parameter_description> +</parameter> +<parameter name="interface"> +<parameter_description> The #GDBusInterface that was added. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObject::interface-removed"> +<description> +Emitted when @interface is removed from @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> The #GDBusObject emitting the signal. +</parameter_description> +</parameter> +<parameter name="interface"> +<parameter_description> The #GDBusInterface that was removed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObjectManager::interface-added"> +<description> +Emitted when @interface is added to @object. + +This signal exists purely as a convenience to avoid having to +connect signals to all objects managed by @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> The #GDBusObjectManager emitting the signal. +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> The #GDBusObject on which an interface was added. +</parameter_description> +</parameter> +<parameter name="interface"> +<parameter_description> The #GDBusInterface that was added. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObjectManager::interface-removed"> +<description> +Emitted when @interface has been removed from @object. + +This signal exists purely as a convenience to avoid having to +connect signals to all objects managed by @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> The #GDBusObjectManager emitting the signal. +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> The #GDBusObject on which an interface was removed. +</parameter_description> +</parameter> +<parameter name="interface"> +<parameter_description> The #GDBusInterface that was removed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObjectManager::object-added"> +<description> +Emitted when @object is added to @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> The #GDBusObjectManager emitting the signal. +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> The #GDBusObject that was added. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObjectManager::object-removed"> +<description> +Emitted when @object is removed from @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> The #GDBusObjectManager emitting the signal. +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> The #GDBusObject that was removed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObjectManagerClient::interface-proxy-properties-changed"> +<description> +Emitted when one or more D-Bus properties on proxy changes. The +local cache has already been updated when this signal fires. Note +that both @changed_properties and @invalidated_properties are +guaranteed to never be %NULL (either may be empty though). + +This signal exists purely as a convenience to avoid having to +connect signals to all interface proxies managed by @manager. + +This signal is emitted in the +<link linkend="g-main-context-push-thread-default">thread-default main loop</link> +that @manager was constructed in. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> The #GDBusObjectManagerClient emitting the signal. +</parameter_description> +</parameter> +<parameter name="object_proxy"> +<parameter_description> The #GDBusObjectProxy on which an interface has properties that are changing. +</parameter_description> +</parameter> +<parameter name="interface_proxy"> +<parameter_description> The #GDBusProxy that has properties that are changing. +</parameter_description> +</parameter> +<parameter name="changed_properties"> +<parameter_description> A #GVariant containing the properties that changed. +</parameter_description> +</parameter> +<parameter name="invalidated_properties"> +<parameter_description> A %NULL terminated array of properties that was invalidated. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObjectManagerClient::interface-proxy-signal"> +<description> +Emitted when a D-Bus signal is received on @interface_proxy. + +This signal exists purely as a convenience to avoid having to +connect signals to all interface proxies managed by @manager. + +This signal is emitted in the +<link linkend="g-main-context-push-thread-default">thread-default main loop</link> +that @manager was constructed in. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> The #GDBusObjectManagerClient emitting the signal. +</parameter_description> +</parameter> +<parameter name="object_proxy"> +<parameter_description> The #GDBusObjectProxy on which an interface is emitting a D-Bus signal. +</parameter_description> +</parameter> +<parameter name="interface_proxy"> +<parameter_description> The #GDBusProxy that is emitting a D-Bus signal. +</parameter_description> +</parameter> +<parameter name="sender_name"> +<parameter_description> The sender of the signal or NULL if the connection is not a bus connection. +</parameter_description> +</parameter> +<parameter name="signal_name"> +<parameter_description> The signal name. +</parameter_description> +</parameter> +<parameter name="parameters"> +<parameter_description> A #GVariant tuple with parameters for the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusObjectSkeleton::authorize-method"> +<description> +Emitted when a method is invoked by a remote caller and used to +determine if the method call is authorized. + +This signal is like #GDBusInterfaceSkeleton<!-- -->'s +#GDBusInterfaceSkeleton::g-authorize-method signal, except that it is +for the enclosing object. + +The default class handler just returns %TRUE. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> The #GDBusObjectSkeleton emitting the signal. +</parameter_description> +</parameter> +<parameter name="interface"> +<parameter_description> The #GDBusInterfaceSkeleton that @invocation is for. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call is authorized, %FALSE otherwise. + +</return> +</signal> + +<signal name="GDBusProxy::g-properties-changed"> +<description> +Emitted when one or more D-Bus properties on @proxy changes. The +local cache has already been updated when this signal fires. Note +that both @changed_properties and @invalidated_properties are +guaranteed to never be %NULL (either may be empty though). + +If the proxy has the flag +%G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES set, then +@invalidated_properties will always be empty. + +This signal corresponds to the +<literal>PropertiesChanged</literal> D-Bus signal on the +<literal>org.freedesktop.DBus.Properties</literal> interface. + +Since: 2.26 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> The #GDBusProxy emitting the signal. +</parameter_description> +</parameter> +<parameter name="changed_properties"> +<parameter_description> A #GVariant containing the properties that changed +</parameter_description> +</parameter> +<parameter name="invalidated_properties"> +<parameter_description> A %NULL terminated array of properties that was invalidated +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusProxy::g-signal"> +<description> +Emitted when a signal from the remote object and interface that @proxy is for, has been received. + +Since: 2.26 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> The #GDBusProxy emitting the signal. +</parameter_description> +</parameter> +<parameter name="sender_name"> +<parameter_description> The sender of the signal or %NULL if the connection is not a bus connection. +</parameter_description> +</parameter> +<parameter name="signal_name"> +<parameter_description> The name of the signal. +</parameter_description> +</parameter> +<parameter name="parameters"> +<parameter_description> A #GVariant tuple with parameters for the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDBusServer::new-connection"> +<description> +Emitted when a new authenticated connection has been made. Use +g_dbus_connection_get_peer_credentials() to figure out what +identity (if any), was authenticated. + +If you want to accept the connection, take a reference to the +@connection object and return %TRUE. When you are done with the +connection call g_dbus_connection_close() and give up your +reference. Note that the other peer may disconnect at any time - +a typical thing to do when accepting a connection is to listen to +the #GDBusConnection::closed signal. + +If #GDBusServer:flags contains %G_DBUS_SERVER_FLAGS_RUN_IN_THREAD +then the signal is emitted in a new thread dedicated to the +connection. Otherwise the signal is emitted in the <link +linkend="g-main-context-push-thread-default">thread-default main +loop</link> of the thread that @server was constructed in. + +You are guaranteed that signal handlers for this signal runs +before incoming messages on @connection are processed. This means +that it's suitable to call g_dbus_connection_register_object() or +similar from the signal handler. + +Since: 2.26 + +</description> +<parameters> +<parameter name="server"> +<parameter_description> The #GDBusServer emitting the signal. +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> A #GDBusConnection for the new connection. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE to claim @connection, %FALSE to let other handlers +run. + +</return> +</signal> + +<signal name="GDrive::changed"> +<description> +Emitted when the drive's state has changed. + +</description> +<parameters> +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDrive::disconnected"> +<description> +This signal is emitted when the #GDrive have been +disconnected. If the recipient is holding references to the +object they should release them so the object can be +finalized. + +</description> +<parameters> +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDrive::eject-button"> +<description> +Emitted when the physical eject button (if any) of a drive has +been pressed. + +</description> +<parameters> +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GDrive::stop-button"> +<description> +Emitted when the physical stop button (if any) of a drive has +been pressed. + +Since: 2.22 + +</description> +<parameters> +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GFileMonitor::changed"> +<description> +Emitted when @file has been changed. + +If using #G_FILE_MONITOR_SEND_MOVED flag and @event_type is +#G_FILE_MONITOR_SEND_MOVED, @file will be set to a #GFile containing the +old path, and @other_file will be set to a #GFile containing the new path. + +In all the other cases, @other_file will be set to #NULL. + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> a #GFileMonitor. +</parameter_description> +</parameter> +<parameter name="file"> +<parameter_description> a #GFile. +</parameter_description> +</parameter> +<parameter name="other_file"> +<parameter_description> a #GFile or #NULL. +</parameter_description> +</parameter> +<parameter name="event_type"> +<parameter_description> a #GFileMonitorEvent. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GFilenameCompleter::got-completion-data"> +<description> +Emitted when the file name completion information comes available. + +</description> +<parameters> +</parameters> +<return></return> +</signal> + +<signal name="GMenuModel::items-changed"> +<description> +Emitted when a change has occured to the menu. + +The only changes that can occur to a menu is that items are removed +or added. Items may not change (except by being removed and added +back in the same location). This signal is capable of describing +both of those changes (at the same time). + +The signal means that starting at the index @position, @removed +items were removed and @added items were added in their place. If +@removed is zero then only items were added. If @added is zero +then only items were removed. + +As an example, if the menu contains items a, b, c, d (in that +order) and the signal (2, 1, 3) occurs then the new composition of +the menu will be a, b, _, _, _, d (with each _ representing some +new item). + +Signal handlers may query the model (particularly the added items) +and expect to see the results of the modification that is being +reported. The signal is emitted after the modification. + +</description> +<parameters> +<parameter name="model"> +<parameter_description> the #GMenuModel that is changing +</parameter_description> +</parameter> +<parameter name="position"> +<parameter_description> the position of the change +</parameter_description> +</parameter> +<parameter name="removed"> +<parameter_description> the number of items removed +</parameter_description> +</parameter> +<parameter name="added"> +<parameter_description> the number of items added +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GMount::changed"> +<description> +Emitted when the mount has been changed. + +</description> +<parameters> +<parameter name="mount"> +<parameter_description> the object on which the signal is emitted +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GMount::pre-unmount"> +<description> +This signal is emitted when the #GMount is about to be +unmounted. + +Since: 2.22 + +</description> +<parameters> +<parameter name="mount"> +<parameter_description> the object on which the signal is emitted +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GMount::unmounted"> +<description> +This signal is emitted when the #GMount have been +unmounted. If the recipient is holding references to the +object they should release them so the object can be +finalized. + +</description> +<parameters> +<parameter name="mount"> +<parameter_description> the object on which the signal is emitted +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GMountOperation::aborted"> +<description> +Emitted by the backend when e.g. a device becomes unavailable +while a mount operation is in progress. + +Implementations of GMountOperation should handle this signal +by dismissing open password dialogs. + +Since: 2.20 + +</description> +<parameters> +</parameters> +<return></return> +</signal> + +<signal name="GMountOperation::ask-password"> +<description> +Emitted when a mount operation asks the user for a password. + +If the message contains a line break, the first line should be +presented as a heading. For example, it may be used as the +primary text in a #GtkMessageDialog. + +</description> +<parameters> +<parameter name="op"> +<parameter_description> a #GMountOperation requesting a password. +</parameter_description> +</parameter> +<parameter name="message"> +<parameter_description> string containing a message to display to the user. +</parameter_description> +</parameter> +<parameter name="default_user"> +<parameter_description> string containing the default user name. +</parameter_description> +</parameter> +<parameter name="default_domain"> +<parameter_description> string containing the default domain. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> a set of #GAskPasswordFlags. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GMountOperation::ask-question"> +<description> +Emitted when asking the user a question and gives a list of +choices for the user to choose from. + +If the message contains a line break, the first line should be +presented as a heading. For example, it may be used as the +primary text in a #GtkMessageDialog. + +</description> +<parameters> +<parameter name="op"> +<parameter_description> a #GMountOperation asking a question. +</parameter_description> +</parameter> +<parameter name="message"> +<parameter_description> string containing a message to display to the user. +</parameter_description> +</parameter> +<parameter name="choices"> +<parameter_description> an array of strings for each possible choice. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GMountOperation::reply"> +<description> +Emitted when the user has replied to the mount operation. + +</description> +<parameters> +<parameter name="op"> +<parameter_description> a #GMountOperation. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GMountOperationResult indicating how the request was handled +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GMountOperation::show-processes"> +<description> +Emitted when one or more processes are blocking an operation +e.g. unmounting/ejecting a #GMount or stopping a #GDrive. + +Note that this signal may be emitted several times to update the +list of blocking processes as processes close files. The +application should only respond with g_mount_operation_reply() to +the latest signal (setting #GMountOperation:choice to the choice +the user made). + +If the message contains a line break, the first line should be +presented as a heading. For example, it may be used as the +primary text in a #GtkMessageDialog. + +Since: 2.22 + +</description> +<parameters> +<parameter name="op"> +<parameter_description> a #GMountOperation. +</parameter_description> +</parameter> +<parameter name="message"> +<parameter_description> string containing a message to display to the user. +</parameter_description> +</parameter> +<parameter name="processes"> +<parameter_description> an array of #GPid for processes +blocking the operation. +</parameter_description> +</parameter> +<parameter name="choices"> +<parameter_description> an array of strings for each possible choice. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GNetworkMonitor::network-changed"> +<description> +Emitted when the network configuration changes. If @available is +%TRUE, then some hosts may be reachable that were not reachable +before, while others that were reachable before may no longer be +reachable. If @available is %FALSE, then no remote hosts are +reachable. + +Since: 2.32 + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> a #GNetworkMonitor +</parameter_description> +</parameter> +<parameter name="available"> +<parameter_description> the current value of #GNetworkMonitor:network-available +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GResolver::reload"> +<description> +Emitted when the resolver notices that the system resolver +configuration has changed. + +</description> +<parameters> +<parameter name="resolver"> +<parameter_description> a #GResolver +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GSettings::change-event"> +<description> +The "change-event" signal is emitted once per change event that +affects this settings object. You should connect to this signal +only if you are interested in viewing groups of changes before they +are split out into multiple emissions of the "changed" signal. +For most use cases it is more appropriate to use the "changed" signal. + +In the event that the change event applies to one or more specified +keys, @keys will be an array of #GQuark of length @n_keys. In the +event that the change event applies to the #GSettings object as a +whole (ie: potentially every key has been changed) then @keys will +be %NULL and @n_keys will be 0. + +The default handler for this signal invokes the "changed" signal +for each affected key. If any other connected handler returns +%TRUE then this default functionality will be suppressed. + + +</description> +<parameters> +<parameter name="settings"> +<parameter_description> the object on which the signal was emitted +</parameter_description> +</parameter> +<parameter name="keys"> +<parameter_description> +an array of #GQuark<!-- -->s for the changed keys, or %NULL +</parameter_description> +</parameter> +<parameter name="n_keys"> +<parameter_description> the length of the @keys array, or 0 +</parameter_description> +</parameter> +</parameters> +<return> %TRUE to stop other handlers from being invoked for the +event. FALSE to propagate the event further. +</return> +</signal> + +<signal name="GSettings::changed"> +<description> +The "changed" signal is emitted when a key has potentially changed. +You should call one of the g_settings_get() calls to check the new +value. + +This signal supports detailed connections. You can connect to the +detailed signal "changed::x" in order to only receive callbacks +when key "x" changes. + +</description> +<parameters> +<parameter name="settings"> +<parameter_description> the object on which the signal was emitted +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the name of the key that changed +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GSettings::writable-change-event"> +<description> +The "writable-change-event" signal is emitted once per writability +change event that affects this settings object. You should connect +to this signal if you are interested in viewing groups of changes +before they are split out into multiple emissions of the +"writable-changed" signal. For most use cases it is more +appropriate to use the "writable-changed" signal. + +In the event that the writability change applies only to a single +key, @key will be set to the #GQuark for that key. In the event +that the writability change affects the entire settings object, +@key will be 0. + +The default handler for this signal invokes the "writable-changed" +and "changed" signals for each affected key. This is done because +changes in writability might also imply changes in value (if for +example, a new mandatory setting is introduced). If any other +connected handler returns %TRUE then this default functionality +will be suppressed. + + +</description> +<parameters> +<parameter name="settings"> +<parameter_description> the object on which the signal was emitted +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the quark of the key, or 0 +</parameter_description> +</parameter> +</parameters> +<return> %TRUE to stop other handlers from being invoked for the +event. FALSE to propagate the event further. +</return> +</signal> + +<signal name="GSettings::writable-changed"> +<description> +The "writable-changed" signal is emitted when the writability of a +key has potentially changed. You should call +g_settings_is_writable() in order to determine the new status. + +This signal supports detailed connections. You can connect to the +detailed signal "writable-changed::x" in order to only receive +callbacks when the writability of "x" changes. + +</description> +<parameters> +<parameter name="settings"> +<parameter_description> the object on which the signal was emitted +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the key +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GSimpleAction::activate"> +<description> +Indicates that the action was just activated. + +@parameter will always be of the expected type. In the event that +an incorrect type was given, no signal will be emitted. + +Since: 2.28 + +</description> +<parameters> +<parameter name="simple"> +<parameter_description> the #GSimpleAction +</parameter_description> +</parameter> +<parameter name="parameter"> +<parameter_description> the parameter to the activation +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GSimpleAction::change-state"> +<description> +Indicates that the action just received a request to change its +state. + +@value will always be of the correct state type. In the event that +an incorrect type was given, no signal will be emitted. + +If no handler is connected to this signal then the default +behaviour is to call g_simple_action_set_state() to set the state +to the requested value. If you connect a signal handler then no +default action is taken. If the state should change then you must +call g_simple_action_set_state() from the handler. + +<example> +<title>Example 'change-state' handler</title> +<programlisting> +static void +change_volume_state (GSimpleAction *action, +GVariant *value, +gpointer user_data) +{ +gint requested; + +requested = g_variant_get_int32 (value); + +// Volume only goes from 0 to 10 +if (0 <= requested && requested <= 10) +g_simple_action_set_state (action, value); +} +</programlisting> +</example> + +The handler need not set the state to the requested value. It +could set it to any value at all, or take some other action. + +Since: 2.30 + +</description> +<parameters> +<parameter name="simple"> +<parameter_description> the #GSimpleAction +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the requested value for the state +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GSocketClient::event"> +<description> +Emitted when @client's activity on @connectable changes state. +Among other things, this can be used to provide progress +information about a network connection in the UI. The meanings of +the different @event values are as follows: + +<variablelist> +<varlistentry> +<term>%G_SOCKET_CLIENT_RESOLVING:</term> +<listitem><para> +@client is about to look up @connectable in DNS. +@connection will be %NULL. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_RESOLVED:</term> +<listitem><para> +@client has successfully resolved @connectable in DNS. +@connection will be %NULL. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_CONNECTING:</term> +<listitem><para> +@client is about to make a connection to a remote host; +either a proxy server or the destination server itself. +@connection is the #GSocketConnection, which is not yet +connected. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_CONNECTED:</term> +<listitem><para> +@client has successfully connected to a remote host. +@connection is the connected #GSocketConnection. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_PROXY_NEGOTIATING:</term> +<listitem><para> +@client is about to negotiate with a proxy to get it to +connect to @connectable. @connection is the +#GSocketConnection to the proxy server. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_PROXY_NEGOTIATED:</term> +<listitem><para> +@client has negotiated a connection to @connectable through +a proxy server. @connection is the stream returned from +g_proxy_connect(), which may or may not be a +#GSocketConnection. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_TLS_HANDSHAKING:</term> +<listitem><para> +@client is about to begin a TLS handshake. @connection is a +#GTlsClientConnection. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_TLS_HANDSHAKED:</term> +<listitem><para> +@client has successfully completed the TLS handshake. +@connection is a #GTlsClientConnection. +</para></listitem> +</varlistentry> +<varlistentry> +<term>%G_SOCKET_CLIENT_COMPLETE:</term> +<listitem><para> +@client has either successfully connected to @connectable +(in which case @connection is the #GSocketConnection that +it will be returning to the caller) or has failed (in which +case @connection is %NULL and the client is about to return +an error). +</para></listitem> +</varlistentry> +</variablelist> + +Each event except %G_SOCKET_CLIENT_COMPLETE may be emitted +multiple times (or not at all) for a given connectable (in +particular, if @client ends up attempting to connect to more than +one address). However, if @client emits the #GSocketClient:event +signal at all for a given connectable, that it will always emit +it with %G_SOCKET_CLIENT_COMPLETE when it is done. + +Note that there may be additional #GSocketClientEvent values in +the future; unrecognized @event values should be ignored. + +Since: 2.32 + +</description> +<parameters> +<parameter name="client"> +<parameter_description> the #GSocketClient +</parameter_description> +</parameter> +<parameter name="event"> +<parameter_description> the event that is occurring +</parameter_description> +</parameter> +<parameter name="connectable"> +<parameter_description> the #GSocketConnectable that @event is occurring on +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> the current representation of the connection +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GSocketService::incoming"> +<description> +The ::incoming signal is emitted when a new incoming connection +to @service needs to be handled. The handler must initiate the +handling of @connection, but may not block; in essence, +asynchronous operations must be used. + +@connection will be unreffed once the signal handler returns, +so you need to ref it yourself if you are planning to use it. + +Since: 2.22 + +</description> +<parameters> +<parameter name="service"> +<parameter_description> the #GSocketService +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> a new #GSocketConnection object +</parameter_description> +</parameter> +<parameter name="source_object"> +<parameter_description> the source_object passed to +g_socket_listener_add_address() +</parameter_description> +</parameter> +</parameters> +<return> %TRUE to stop other handlers from being called + +</return> +</signal> + +<signal name="GThreadedSocketService::run"> +<description> +The ::run signal is emitted in a worker thread in response to an +incoming connection. This thread is dedicated to handling +@connection and may perform blocking IO. The signal handler need +not return until the connection is closed. + + +</description> +<parameters> +<parameter name="service"> +<parameter_description> the #GThreadedSocketService. +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> a new #GSocketConnection object. +</parameter_description> +</parameter> +<parameter name="source_object"> +<parameter_description> the source_object passed to g_socket_listener_add_address(). +</parameter_description> +</parameter> +</parameters> +<return> %TRUE to stop further signal handlers from being called +</return> +</signal> + +<signal name="GTlsConnection::accept-certificate"> +<description> +Emitted during the TLS handshake after the peer certificate has +been received. You can examine @peer_cert's certification path by +calling g_tls_certificate_get_issuer() on it. + +For a client-side connection, @peer_cert is the server's +certificate, and the signal will only be emitted if the +certificate was not acceptable according to @conn's +#GTlsClientConnection:validation_flags. If you would like the +certificate to be accepted despite @errors, return %TRUE from the +signal handler. Otherwise, if no handler accepts the certificate, +the handshake will fail with %G_TLS_ERROR_BAD_CERTIFICATE. + +For a server-side connection, @peer_cert is the certificate +presented by the client, if this was requested via the server's +#GTlsServerConnection:authentication_mode. On the server side, +the signal is always emitted when the client presents a +certificate, and the certificate will only be accepted if a +handler returns %TRUE. + +Note that if this signal is emitted as part of asynchronous I/O +in the main thread, then you should not attempt to interact with +the user before returning from the signal handler. If you want to +let the user decide whether or not to accept the certificate, you +would have to return %FALSE from the signal handler on the first +attempt, and then after the connection attempt returns a +%G_TLS_ERROR_HANDSHAKE, you can interact with the user, and if +the user decides to accept the certificate, remember that fact, +create a new connection, and return %TRUE from the signal handler +the next time. + +If you are doing I/O in another thread, you do not +need to worry about this, and can simply block in the signal +handler until the UI thread returns an answer. + +Since: 2.28 + +</description> +<parameters> +<parameter name="conn"> +<parameter_description> a #GTlsConnection +</parameter_description> +</parameter> +<parameter name="peer_cert"> +<parameter_description> the peer's #GTlsCertificate +</parameter_description> +</parameter> +<parameter name="errors"> +<parameter_description> the problems with @peer_cert. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE to accept @peer_cert (which will also +immediately end the signal emission). %FALSE to allow the signal +emission to continue, which will cause the handshake to fail if +no one else overrides it. + +</return> +</signal> + +<signal name="GUnixMountMonitor::mountpoints-changed"> +<description> +Emitted when the unix mount points have changed. + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> the object on which the signal is emitted +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GUnixMountMonitor::mounts-changed"> +<description> +Emitted when the unix mounts have changed. + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> the object on which the signal is emitted +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolume::changed"> +<description> +Emitted when the volume has been changed. + +</description> +<parameters> +</parameters> +<return></return> +</signal> + +<signal name="GVolume::removed"> +<description> +This signal is emitted when the #GVolume have been removed. If +the recipient is holding references to the object they should +release them so the object can be finalized. + +</description> +<parameters> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::drive-changed"> +<description> +Emitted when a drive changes. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="drive"> +<parameter_description> the drive that changed +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::drive-connected"> +<description> +Emitted when a drive is connected to the system. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="drive"> +<parameter_description> a #GDrive that was connected. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::drive-disconnected"> +<description> +Emitted when a drive is disconnected from the system. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="drive"> +<parameter_description> a #GDrive that was disconnected. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::drive-eject-button"> +<description> +Emitted when the eject button is pressed on @drive. + +Since: 2.18 + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="drive"> +<parameter_description> the drive where the eject button was pressed +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::drive-stop-button"> +<description> +Emitted when the stop button is pressed on @drive. + +Since: 2.22 + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="drive"> +<parameter_description> the drive where the stop button was pressed +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::mount-added"> +<description> +Emitted when a mount is added. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="mount"> +<parameter_description> a #GMount that was added. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::mount-changed"> +<description> +Emitted when a mount changes. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="mount"> +<parameter_description> a #GMount that changed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::mount-pre-unmount"> +<description> +Emitted when a mount is about to be removed. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="mount"> +<parameter_description> a #GMount that is being unmounted. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::mount-removed"> +<description> +Emitted when a mount is removed. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="mount"> +<parameter_description> a #GMount that was removed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::volume-added"> +<description> +Emitted when a mountable volume is added to the system. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="volume"> +<parameter_description> a #GVolume that was added. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::volume-changed"> +<description> +Emitted when mountable volume is changed. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="volume"> +<parameter_description> a #GVolume that changed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<signal name="GVolumeMonitor::volume-removed"> +<description> +Emitted when a mountable volume is removed from the system. + +</description> +<parameters> +<parameter name="volume_monitor"> +<parameter_description> The volume monitor emitting the signal. +</parameter_description> +</parameter> +<parameter name="volume"> +<parameter_description> a #GVolume that was removed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<function name="example_animal_call_poke"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-gtk-GDBus-Example-ObjectManager-Animal.Poke">Poke()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call example_animal_call_poke_finish() to get the result of the operation. + +See example_animal_call_poke_sync() for the synchronous, blocking version of this method. + +Since: 2.30 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #ExampleAnimalProxy. +</parameter_description> +</parameter> +<parameter name="arg_make_sad"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_make_happy"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_animal_call_poke_finish"> +<description> +Finishes an operation started with example_animal_call_poke(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #ExampleAnimalProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to example_animal_call_poke(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="example_animal_call_poke_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-gtk-GDBus-Example-ObjectManager-Animal.Poke">Poke()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See example_animal_call_poke() for the asynchronous version of this method. + +Since: 2.30 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #ExampleAnimalProxy. +</parameter_description> +</parameter> +<parameter name="arg_make_sad"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_make_happy"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="example_animal_complete_poke"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gtk-GDBus-Example-ObjectManager-Animal.Poke">Poke()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleAnimal. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_animal_dup_mood"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-gtk-GDBus-Example-ObjectManager-Animal.Mood">"Mood"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleAnimal. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). + +</return> +</function> + +<function name="example_animal_emit_jumped"> +<description> +Emits the <link linkend="gdbus-signal-org-gtk-GDBus-Example-ObjectManager-Animal.Jumped">"Jumped"</link> D-Bus signal. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleAnimal. +</parameter_description> +</parameter> +<parameter name="arg_height"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_animal_get_mood"> +<description> +Gets the value of the <link linkend="gdbus-property-org-gtk-GDBus-Example-ObjectManager-Animal.Mood">"Mood"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use example_animal_dup_mood() if on another thread.</warning> + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleAnimal. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. + +</return> +</function> + +<function name="example_animal_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Animal.top_of_page">org.gtk.GDBus.Example.ObjectManager.Animal</link> D-Bus interface. + +Since: 2.30 + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. + +</return> +</function> + +<function name="example_animal_override_properties"> +<description> +Overrides all #GObject properties in the #ExampleAnimal interface for a concrete class. +The properties are overridden in the order they are defined. + +Since: 2.30 + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. + +</return> +</function> + +<function name="example_animal_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Animal.top_of_page">org.gtk.GDBus.Example.ObjectManager.Animal</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call example_animal_proxy_new_finish() to get the result of the operation. + +See example_animal_proxy_new_sync() for the synchronous, blocking version of this constructor. + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_animal_proxy_new_finish"> +<description> +Finishes an operation started with example_animal_proxy_new(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to example_animal_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="example_animal_proxy_new_for_bus"> +<description> +Like example_animal_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call example_animal_proxy_new_for_bus_finish() to get the result of the operation. + +See example_animal_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +Since: 2.30 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_animal_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with example_animal_proxy_new_for_bus(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to example_animal_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="example_animal_proxy_new_for_bus_sync"> +<description> +Like example_animal_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See example_animal_proxy_new_for_bus() for the asynchronous version of this constructor. + +Since: 2.30 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="example_animal_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Animal.top_of_page">org.gtk.GDBus.Example.ObjectManager.Animal</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See example_animal_proxy_new() for the asynchronous version of this constructor. + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="example_animal_set_mood"> +<description> +Sets the <link linkend="gdbus-property-org-gtk-GDBus-Example-ObjectManager-Animal.Mood">"Mood"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleAnimal. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_animal_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Animal.top_of_page">org.gtk.GDBus.Example.ObjectManager.Animal</link>. + +Since: 2.30 + +</description> +<parameters> +</parameters> +<return> The skeleton object. + +</return> +</function> + +<function name="example_cat_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Cat.top_of_page">org.gtk.GDBus.Example.ObjectManager.Cat</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="example_cat_override_properties"> +<description> +Overrides all #GObject properties in the #ExampleCat interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="example_cat_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Cat.top_of_page">org.gtk.GDBus.Example.ObjectManager.Cat</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call example_cat_proxy_new_finish() to get the result of the operation. + +See example_cat_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_cat_proxy_new_finish"> +<description> +Finishes an operation started with example_cat_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to example_cat_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="example_cat_proxy_new_for_bus"> +<description> +Like example_cat_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call example_cat_proxy_new_for_bus_finish() to get the result of the operation. + +See example_cat_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_cat_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with example_cat_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to example_cat_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="example_cat_proxy_new_for_bus_sync"> +<description> +Like example_cat_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See example_cat_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="example_cat_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Cat.top_of_page">org.gtk.GDBus.Example.ObjectManager.Cat</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See example_cat_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="example_cat_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Cat.top_of_page">org.gtk.GDBus.Example.ObjectManager.Cat</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="example_object_get_animal"> +<description> +Gets the #ExampleAnimal instance for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Animal.top_of_page">org.gtk.GDBus.Example.ObjectManager.Animal</link> on @object, if any. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleObject. +</parameter_description> +</parameter> +</parameters> +<return> A #ExampleAnimal that must be freed with g_object_unref() or %NULL if @object does not implement the interface. + +</return> +</function> + +<function name="example_object_get_cat"> +<description> +Gets the #ExampleCat instance for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Cat.top_of_page">org.gtk.GDBus.Example.ObjectManager.Cat</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleObject. +</parameter_description> +</parameter> +</parameters> +<return> A #ExampleCat that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="example_object_manager_client_get_proxy_type"> +<description> +A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy<!-- -->- and #GDBusProxy<!-- -->-derived types. + + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerClient. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> The object path of the remote object (unused). +</parameter_description> +</parameter> +<parameter name="interface_name"> +<parameter_description> Interface name of the remote object or %NULL to get the object proxy #GType. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data (unused). +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusProxy<!-- -->-derived #GType if @interface_name is not %NULL, otherwise the #GType for #ExampleObjectProxy. +</return> +</function> + +<function name="example_object_manager_client_new"> +<description> +Asynchronously creates #GDBusObjectManagerClient using example_object_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call example_object_manager_client_new_finish() to get the result of the operation. + +See example_object_manager_client_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_object_manager_client_new_finish"> +<description> +Finishes an operation started with example_object_manager_client_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to example_object_manager_client_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="example_object_manager_client_new_for_bus"> +<description> +Like example_object_manager_client_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call example_object_manager_client_new_for_bus_finish() to get the result of the operation. + +See example_object_manager_client_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_object_manager_client_new_for_bus_finish"> +<description> +Finishes an operation started with example_object_manager_client_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to example_object_manager_client_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="example_object_manager_client_new_for_bus_sync"> +<description> +Like example_object_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See example_object_manager_client_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="example_object_manager_client_new_sync"> +<description> +Synchronously creates #GDBusObjectManagerClient using example_object_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See example_object_manager_client_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="example_object_peek_animal"> +<description> +Like example_object_get_animal() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleObject. +</parameter_description> +</parameter> +</parameters> +<return> A #ExampleAnimal or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. + +</return> +</function> + +<function name="example_object_peek_cat"> +<description> +Like example_object_get_cat() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleObject. +</parameter_description> +</parameter> +</parameters> +<return> A #ExampleCat or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="example_object_proxy_new"> +<description> +Creates a new proxy object. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +</parameters> +<return> The proxy object. +</return> +</function> + +<function name="example_object_skeleton_new"> +<description> +Creates a new skeleton object. + + +</description> +<parameters> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="example_object_skeleton_set_animal"> +<description> +Sets the #ExampleAnimal instance for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Animal.top_of_page">org.gtk.GDBus.Example.ObjectManager.Animal</link> on @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #ExampleAnimal or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="example_object_skeleton_set_cat"> +<description> +Sets the #ExampleCat instance for the D-Bus interface <link linkend="gdbus-interface-org-gtk-GDBus-Example-ObjectManager-Cat.top_of_page">org.gtk.GDBus.Example.ObjectManager.Cat</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #ExampleObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #ExampleCat or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="fen_add"> <description> Won't hold a ref, we have a timout callback to clean unused node_t. @@ -21,6 +4287,12064 @@ FEN subsystem initializing. <return></return> </function> +<function name="foo_igen_authorize_call_check_authorized"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Authorize.CheckAuthorized">CheckAuthorized()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_authorize_call_check_authorized_finish() to get the result of the operation. + +See foo_igen_authorize_call_check_authorized_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_call_check_authorized_finish"> +<description> +Finishes an operation started with foo_igen_authorize_call_check_authorized(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_authorize_call_check_authorized(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_call_check_authorized_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Authorize.CheckAuthorized">CheckAuthorized()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_authorize_call_check_authorized() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_call_check_not_authorized"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorized">CheckNotAuthorized()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_authorize_call_check_not_authorized_finish() to get the result of the operation. + +See foo_igen_authorize_call_check_not_authorized_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_call_check_not_authorized_finish"> +<description> +Finishes an operation started with foo_igen_authorize_call_check_not_authorized(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_authorize_call_check_not_authorized(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_call_check_not_authorized_from_object"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorizedFromObject">CheckNotAuthorizedFromObject()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_authorize_call_check_not_authorized_from_object_finish() to get the result of the operation. + +See foo_igen_authorize_call_check_not_authorized_from_object_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_call_check_not_authorized_from_object_finish"> +<description> +Finishes an operation started with foo_igen_authorize_call_check_not_authorized_from_object(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_authorize_call_check_not_authorized_from_object(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_call_check_not_authorized_from_object_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorizedFromObject">CheckNotAuthorizedFromObject()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_authorize_call_check_not_authorized_from_object() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_call_check_not_authorized_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorized">CheckNotAuthorized()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_authorize_call_check_not_authorized() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenAuthorizeProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_complete_check_authorized"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Authorize.CheckAuthorized">CheckAuthorized()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenAuthorize. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_complete_check_not_authorized"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorized">CheckNotAuthorized()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenAuthorize. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_complete_check_not_authorized_from_object"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Authorize.CheckNotAuthorizedFromObject">CheckNotAuthorizedFromObject()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenAuthorize. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-project-Authorize.top_of_page">org.project.Authorize</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_authorize_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenAuthorize interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_authorize_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Authorize.top_of_page">org.project.Authorize</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_authorize_proxy_new_finish() to get the result of the operation. + +See foo_igen_authorize_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_authorize_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_authorize_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_proxy_new_for_bus"> +<description> +Like foo_igen_authorize_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_authorize_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_authorize_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_authorize_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_authorize_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_authorize_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_proxy_new_for_bus_sync"> +<description> +Like foo_igen_authorize_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_authorize_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Authorize.top_of_page">org.project.Authorize</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_authorize_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_authorize_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-project-Authorize.top_of_page">org.project.Authorize</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_bar_call_hello_world"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar.HelloWorld">HelloWorld()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_call_hello_world_finish() to get the result of the operation. + +See foo_igen_bar_call_hello_world_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_call_hello_world_finish"> +<description> +Finishes an operation started with foo_igen_bar_call_hello_world(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_call_hello_world(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_hello_world_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar.HelloWorld">HelloWorld()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_call_hello_world() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_property_cancellation"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar.PropertyCancellation">PropertyCancellation()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_call_property_cancellation_finish() to get the result of the operation. + +See foo_igen_bar_call_property_cancellation_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_call_property_cancellation_finish"> +<description> +Finishes an operation started with foo_igen_bar_call_property_cancellation(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_call_property_cancellation(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_property_cancellation_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar.PropertyCancellation">PropertyCancellation()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_call_property_cancellation() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_request_multi_property_mods"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar.RequestMultiPropertyMods">RequestMultiPropertyMods()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_call_request_multi_property_mods_finish() to get the result of the operation. + +See foo_igen_bar_call_request_multi_property_mods_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_call_request_multi_property_mods_finish"> +<description> +Finishes an operation started with foo_igen_bar_call_request_multi_property_mods(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_call_request_multi_property_mods(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_request_multi_property_mods_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar.RequestMultiPropertyMods">RequestMultiPropertyMods()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_call_request_multi_property_mods() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_request_signal_emission"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar.RequestSignalEmission">RequestSignalEmission()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_call_request_signal_emission_finish() to get the result of the operation. + +See foo_igen_bar_call_request_signal_emission_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_which_one"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_call_request_signal_emission_finish"> +<description> +Finishes an operation started with foo_igen_bar_call_request_signal_emission(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_call_request_signal_emission(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_request_signal_emission_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar.RequestSignalEmission">RequestSignalEmission()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_call_request_signal_emission() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_which_one"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_test_non_primitive_types"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar.TestNonPrimitiveTypes">TestNonPrimitiveTypes()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_call_test_non_primitive_types_finish() to get the result of the operation. + +See foo_igen_bar_call_test_non_primitive_types_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_s"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_pairs"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_a_struct"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_strings"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_objpaths"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_signatures"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_bytestrings"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_call_test_non_primitive_types_finish"> +<description> +Finishes an operation started with foo_igen_bar_call_test_non_primitive_types(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="out_result"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_call_test_non_primitive_types(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_test_non_primitive_types_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar.TestNonPrimitiveTypes">TestNonPrimitiveTypes()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_call_test_non_primitive_types() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_s"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_pairs"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_a_struct"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_strings"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_objpaths"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_signatures"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_array_of_bytestrings"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_result"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_test_primitive_types"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar.TestPrimitiveTypes">TestPrimitiveTypes()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_call_test_primitive_types_finish() to get the result of the operation. + +See foo_igen_bar_call_test_primitive_types_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_val_byte"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_boolean"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_int16"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_uint16"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_int32"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_uint32"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_int64"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_uint64"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_double"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_string"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_objpath"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_signature"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_bytestring"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_call_test_primitive_types_finish"> +<description> +Finishes an operation started with foo_igen_bar_call_test_primitive_types(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="out_ret_byte"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_boolean"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_int16"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_uint16"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_int32"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_uint32"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_int64"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_uint64"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_double"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_string"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_objpath"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_signature"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_bytestring"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_call_test_primitive_types(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_test_primitive_types_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar.TestPrimitiveTypes">TestPrimitiveTypes()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_call_test_primitive_types() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="arg_val_byte"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_boolean"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_int16"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_uint16"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_int32"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_uint32"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_int64"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_uint64"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_double"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_string"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_objpath"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_signature"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_val_bytestring"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_ret_byte"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_boolean"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_int16"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_uint16"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_int32"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_uint32"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_int64"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_uint64"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_double"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_string"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_objpath"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_signature"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_ret_bytestring"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_unimplemented_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar.UnimplementedMethod">UnimplementedMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_call_unimplemented_method_finish() to get the result of the operation. + +See foo_igen_bar_call_unimplemented_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_call_unimplemented_method_finish"> +<description> +Finishes an operation started with foo_igen_bar_call_unimplemented_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_call_unimplemented_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_call_unimplemented_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar.UnimplementedMethod">UnimplementedMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_call_unimplemented_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_complete_hello_world"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar.HelloWorld">HelloWorld()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="response"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_complete_property_cancellation"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar.PropertyCancellation">PropertyCancellation()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_complete_request_multi_property_mods"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar.RequestMultiPropertyMods">RequestMultiPropertyMods()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_complete_request_signal_emission"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar.RequestSignalEmission">RequestSignalEmission()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_complete_test_non_primitive_types"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar.TestNonPrimitiveTypes">TestNonPrimitiveTypes()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_complete_test_primitive_types"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar.TestPrimitiveTypes">TestPrimitiveTypes()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="ret_byte"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_boolean"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_int16"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_uint16"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_int32"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_uint32"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_int64"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_uint64"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_double"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_string"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_objpath"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_signature"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="ret_bytestring"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_complete_unimplemented_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar.UnimplementedMethod">UnimplementedMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_dup_aay"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.aay">"aay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_strfreev(). +</return> +</function> + +<function name="foo_igen_bar_dup_ag"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.ag">"ag"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_bar_dup_ao"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.ao">"ao"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_strfreev(). +</return> +</function> + +<function name="foo_igen_bar_dup_as"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.as">"as"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_strfreev(). +</return> +</function> + +<function name="foo_igen_bar_dup_ay"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.ay">"ay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_finally_normal_name"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.FinallyNormalName">"FinallyNormalName"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_g"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.g">"g"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_o"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.o">"o"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_readonly_property"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.ReadonlyProperty">"ReadonlyProperty"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_s"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.s">"s"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_ag"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_ag">"unset_ag"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_ao"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_ao">"unset_ao"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_strfreev(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_as"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_as">"unset_as"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_strfreev(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_ay"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_ay">"unset_ay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_g"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_g">"unset_g"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_o"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_o">"unset_o"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_s"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_s">"unset_s"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_dup_unset_struct"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.unset_struct">"unset_struct"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_bar_dup_writeonly_property"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bar.WriteonlyProperty">"WriteonlyProperty"</link> D-Bus property. + +Since this D-Bus property is not readable, it is only meaningful to use this function on the service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_bar_emit_another_signal"> +<description> +Emits the <link linkend="gdbus-signal-org-project-Bar.AnotherSignal">"AnotherSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="arg_word"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_emit_test_signal"> +<description> +Emits the <link linkend="gdbus-signal-org-project-Bar.TestSignal">"TestSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="arg_val_int32"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +<parameter name="arg_array_of_strings"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +<parameter name="arg_array_of_bytestrings"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +<parameter name="arg_dict_s_to_pairs"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_frobnicator_call_random_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bar-Frobnicator.RandomMethod">RandomMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_frobnicator_call_random_method_finish() to get the result of the operation. + +See foo_igen_bar_frobnicator_call_random_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarFrobnicatorProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_frobnicator_call_random_method_finish"> +<description> +Finishes an operation started with foo_igen_bar_frobnicator_call_random_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarFrobnicatorProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_frobnicator_call_random_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_call_random_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bar-Frobnicator.RandomMethod">RandomMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bar_frobnicator_call_random_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBarFrobnicatorProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_complete_random_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bar-Frobnicator.RandomMethod">RandomMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBarFrobnicator. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_frobnicator_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-project-Bar-Frobnicator.top_of_page">org.project.Bar.Frobnicator</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenBarFrobnicator interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar-Frobnicator.top_of_page">org.project.Bar.Frobnicator</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_frobnicator_proxy_new_finish() to get the result of the operation. + +See foo_igen_bar_frobnicator_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_frobnicator_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_bar_frobnicator_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_frobnicator_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_proxy_new_for_bus"> +<description> +Like foo_igen_bar_frobnicator_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_frobnicator_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_bar_frobnicator_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_frobnicator_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_bar_frobnicator_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_frobnicator_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_proxy_new_for_bus_sync"> +<description> +Like foo_igen_bar_frobnicator_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_bar_frobnicator_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar-Frobnicator.top_of_page">org.project.Bar.Frobnicator</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_bar_frobnicator_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_frobnicator_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar-Frobnicator.top_of_page">org.project.Bar.Frobnicator</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_bar_get_aay"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.aay">"aay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_aay() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_ag"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.ag">"ag"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_ag() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_ao"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.ao">"ao"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_ao() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_as"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.as">"as"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_as() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_ay"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.ay">"ay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_ay() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_b"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.b">"b"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_d"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.d">"d"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_finally_normal_name"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.FinallyNormalName">"FinallyNormalName"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_finally_normal_name() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_g"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.g">"g"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_g() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_i"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.i">"i"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_n"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.n">"n"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_o"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.o">"o"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_o() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_q"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.q">"q"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_readonly_property"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.ReadonlyProperty">"ReadonlyProperty"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_readonly_property() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_s"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.s">"s"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_s() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_t"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.t">"t"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_u"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.u">"u"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_unset_ag"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_ag">"unset_ag"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_ag() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_unset_ao"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_ao">"unset_ao"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_ao() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_unset_as"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_as">"unset_as"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_as() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_unset_ay"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_ay">"unset_ay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_ay() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_unset_d"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_d">"unset_d"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_unset_g"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_g">"unset_g"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_g() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_unset_i"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_i">"unset_i"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_unset_o"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_o">"unset_o"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_o() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_unset_s"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_s">"unset_s"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_s() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_unset_struct"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.unset_struct">"unset_struct"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_unset_struct() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_writeonly_property"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.WriteonlyProperty">"WriteonlyProperty"</link> D-Bus property. + +Since this D-Bus property is not readable, it is only meaningful to use this function on the service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bar_dup_writeonly_property() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bar_get_x"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.x">"x"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_get_y"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bar.y">"y"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_bar_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-project-Bar.top_of_page">org.project.Bar</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_bar_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenBar interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_bar_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar.top_of_page">org.project.Bar</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_proxy_new_finish() to get the result of the operation. + +See foo_igen_bar_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_bar_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_proxy_new_for_bus"> +<description> +Like foo_igen_bar_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bar_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_bar_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_bar_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bar_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_proxy_new_for_bus_sync"> +<description> +Like foo_igen_bar_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_bar_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar.top_of_page">org.project.Bar</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_bar_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bar_set_aay"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.aay">"aay"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_ag"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.ag">"ag"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_ao"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.ao">"ao"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_as"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.as">"as"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_ay"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.ay">"ay"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_b"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.b">"b"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_d"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.d">"d"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_finally_normal_name"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.FinallyNormalName">"FinallyNormalName"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_g"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.g">"g"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_i"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.i">"i"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_n"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.n">"n"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_o"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.o">"o"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_q"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.q">"q"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_readonly_property"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.ReadonlyProperty">"ReadonlyProperty"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_s"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.s">"s"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_t"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.t">"t"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_u"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.u">"u"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_ag"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_ag">"unset_ag"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_ao"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_ao">"unset_ao"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_as"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_as">"unset_as"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_ay"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_ay">"unset_ay"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_d"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_d">"unset_d"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_g"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_g">"unset_g"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_i"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_i">"unset_i"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_o"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_o">"unset_o"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_s"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_s">"unset_s"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_unset_struct"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.unset_struct">"unset_struct"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_writeonly_property"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.WriteonlyProperty">"WriteonlyProperty"</link> D-Bus property to @value. + +Since this D-Bus property is writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_x"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.x">"x"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_set_y"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bar.y">"y"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBar. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bar_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar.top_of_page">org.project.Bar</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_bat_call_force_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-Bat.ForceMethod">ForceMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bat_call_force_method_finish() to get the result of the operation. + +See foo_igen_bat_call_force_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBatProxy. +</parameter_description> +</parameter> +<parameter name="arg_force_in_i"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_force_in_s"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_force_in_ay"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_force_in_struct"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_call_force_method_finish"> +<description> +Finishes an operation started with foo_igen_bat_call_force_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBatProxy. +</parameter_description> +</parameter> +<parameter name="out_force_out_i"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_force_out_s"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_force_out_ay"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_force_out_struct"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bat_call_force_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bat_call_force_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-Bat.ForceMethod">ForceMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_bat_call_force_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenBatProxy. +</parameter_description> +</parameter> +<parameter name="arg_force_in_i"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_force_in_s"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_force_in_ay"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_force_in_struct"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_force_out_i"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_force_out_s"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_force_out_ay"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_force_out_struct"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_bat_complete_force_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-Bat.ForceMethod">ForceMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="force_out_i"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="force_out_s"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="force_out_ay"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="force_out_struct"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_dup_force_ay"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bat.force_ay">"force_ay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_bat_dup_force_i"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bat.force_i">"force_i"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_bat_dup_force_s"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bat.force_s">"force_s"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_bat_dup_force_struct"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-Bat.force_struct">"force_struct"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_bat_emit_force_signal"> +<description> +Emits the <link linkend="gdbus-signal-org-project-Bat.ForceSignal">"ForceSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="arg_force_i"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +<parameter name="arg_force_s"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +<parameter name="arg_force_ay"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +<parameter name="arg_force_struct"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_get_force_ay"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bat.force_ay">"force_ay"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bat_dup_force_ay() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bat_get_force_i"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bat.force_i">"force_i"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bat_dup_force_i() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bat_get_force_s"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bat.force_s">"force_s"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bat_dup_force_s() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bat_get_force_struct"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-Bat.force_struct">"force_struct"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_bat_dup_force_struct() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_bat_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-project-Bat.top_of_page">org.project.Bat</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_bat_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenBat interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_bat_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Bat.top_of_page">org.project.Bat</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bat_proxy_new_finish() to get the result of the operation. + +See foo_igen_bat_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_bat_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bat_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bat_proxy_new_for_bus"> +<description> +Like foo_igen_bat_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_bat_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_bat_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_bat_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_bat_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bat_proxy_new_for_bus_sync"> +<description> +Like foo_igen_bat_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_bat_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bat_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Bat.top_of_page">org.project.Bat</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_bat_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_bat_set_force_ay"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bat.force_ay">"force_ay"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_set_force_i"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bat.force_i">"force_i"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_set_force_s"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bat.force_s">"force_s"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_set_force_struct"> +<description> +Sets the <link linkend="gdbus-property-org-project-Bat.force_struct">"force_struct"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenBat. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_bat_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-project-Bat.top_of_page">org.project.Bat</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_baz_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-project-Baz.top_of_page">org.project.Baz</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_baz_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenBaz interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_baz_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Baz.top_of_page">org.project.Baz</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_baz_proxy_new_finish() to get the result of the operation. + +See foo_igen_baz_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_baz_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_baz_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_baz_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_baz_proxy_new_for_bus"> +<description> +Like foo_igen_baz_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_baz_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_baz_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_baz_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_baz_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_baz_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_baz_proxy_new_for_bus_sync"> +<description> +Like foo_igen_baz_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_baz_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_baz_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-Baz.top_of_page">org.project.Baz</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_baz_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_baz_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-project-Baz.top_of_page">org.project.Baz</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_added_method_in10"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.AddedMethodIn10">AddedMethodIn10()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v10_call_added_method_in10_finish() to get the result of the operation. + +See foo_igen_changing_interface_v10_call_added_method_in10_sync() for the synchronous, blocking version of this method. + +Since: 10.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_call_added_method_in10_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v10_call_added_method_in10(). + +Since: 10.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v10_call_added_method_in10(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_added_method_in10_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.AddedMethodIn10">AddedMethodIn10()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v10_call_added_method_in10() for the asynchronous version of this method. + +Since: 10.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_bar_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.BarMethod">BarMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v10_call_bar_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v10_call_bar_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_call_bar_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v10_call_bar_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v10_call_bar_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_bar_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.BarMethod">BarMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v10_call_bar_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_baz_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.BazMethod">BazMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v10_call_baz_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v10_call_baz_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_call_baz_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v10_call_baz_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v10_call_baz_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_baz_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.BazMethod">BazMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v10_call_baz_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_foo_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.FooMethod">FooMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v10_call_foo_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v10_call_foo_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_call_foo_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v10_call_foo_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v10_call_foo_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_foo_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.FooMethod">FooMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v10_call_foo_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_new_method_in2"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.NewMethodIn2">NewMethodIn2()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v10_call_new_method_in2_finish() to get the result of the operation. + +See foo_igen_changing_interface_v10_call_new_method_in2_sync() for the synchronous, blocking version of this method. + +Since: 2.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_call_new_method_in2_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v10_call_new_method_in2(). + +Since: 2.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v10_call_new_method_in2(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_call_new_method_in2_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV10.NewMethodIn2">NewMethodIn2()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v10_call_new_method_in2() for the asynchronous version of this method. + +Since: 2.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV10Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_complete_added_method_in10"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV10.AddedMethodIn10">AddedMethodIn10()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +Since: 10.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_complete_bar_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV10.BarMethod">BarMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_complete_baz_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV10.BazMethod">BazMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_complete_foo_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV10.FooMethod">FooMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_complete_new_method_in2"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV10.NewMethodIn2">NewMethodIn2()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_emit_added_signal_in10"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV10.AddedSignalIn10">"AddedSignalIn10"</link> D-Bus signal. + +Since: 10.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_emit_bar_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV10.BarSignal">"BarSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_emit_baz_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV10.BazSignal">"BazSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_emit_foo_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV10.FooSignal">"FooSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_emit_new_signal_in2"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV10.NewSignalIn2">"NewSignalIn2"</link> D-Bus signal. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV10. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-ChangingInterfaceV10.top_of_page">ChangingInterfaceV10</link> D-Bus interface. + +Since: 10.0 + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenChangingInterfaceV10 interface for a concrete class. +The properties are overridden in the order they are defined. + +Since: 10.0 + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV10.top_of_page">ChangingInterfaceV10</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v10_proxy_new_finish() to get the result of the operation. + +See foo_igen_changing_interface_v10_proxy_new_sync() for the synchronous, blocking version of this constructor. + +Since: 10.0 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v10_proxy_new(). + +Since: 10.0 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v10_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_proxy_new_for_bus"> +<description> +Like foo_igen_changing_interface_v10_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v10_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_changing_interface_v10_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +Since: 10.0 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v10_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v10_proxy_new_for_bus(). + +Since: 10.0 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v10_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_proxy_new_for_bus_sync"> +<description> +Like foo_igen_changing_interface_v10_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v10_proxy_new_for_bus() for the asynchronous version of this constructor. + +Since: 10.0 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV10.top_of_page">ChangingInterfaceV10</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v10_proxy_new() for the asynchronous version of this constructor. + +Since: 10.0 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v10_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV10.top_of_page">ChangingInterfaceV10</link>. + +Since: 10.0 + +</description> +<parameters> +</parameters> +<return> The skeleton object. + +</return> +</function> + +<function name="foo_igen_changing_interface_v1_call_bar_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV1.BarMethod">BarMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v1_call_bar_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v1_call_bar_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_call_bar_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v1_call_bar_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v1_call_bar_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_call_bar_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV1.BarMethod">BarMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v1_call_bar_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_call_baz_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV1.BazMethod">BazMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v1_call_baz_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v1_call_baz_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_call_baz_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v1_call_baz_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v1_call_baz_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_call_baz_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV1.BazMethod">BazMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v1_call_baz_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_call_foo_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV1.FooMethod">FooMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v1_call_foo_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v1_call_foo_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_call_foo_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v1_call_foo_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v1_call_foo_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_call_foo_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV1.FooMethod">FooMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v1_call_foo_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV1Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_complete_bar_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV1.BarMethod">BarMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_complete_baz_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV1.BazMethod">BazMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_complete_foo_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV1.FooMethod">FooMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_emit_bar_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV1.BarSignal">"BarSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_emit_baz_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV1.BazSignal">"BazSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_emit_foo_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV1.FooSignal">"FooSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV1. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-ChangingInterfaceV1.top_of_page">ChangingInterfaceV1</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenChangingInterfaceV1 interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV1.top_of_page">ChangingInterfaceV1</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v1_proxy_new_finish() to get the result of the operation. + +See foo_igen_changing_interface_v1_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v1_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v1_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_proxy_new_for_bus"> +<description> +Like foo_igen_changing_interface_v1_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v1_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_changing_interface_v1_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v1_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v1_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v1_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_proxy_new_for_bus_sync"> +<description> +Like foo_igen_changing_interface_v1_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v1_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV1.top_of_page">ChangingInterfaceV1</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v1_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v1_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV1.top_of_page">ChangingInterfaceV1</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_bar_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.BarMethod">BarMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v2_call_bar_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v2_call_bar_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_call_bar_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v2_call_bar_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v2_call_bar_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_bar_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.BarMethod">BarMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v2_call_bar_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_baz_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.BazMethod">BazMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v2_call_baz_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v2_call_baz_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_call_baz_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v2_call_baz_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v2_call_baz_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_baz_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.BazMethod">BazMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v2_call_baz_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_foo_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.FooMethod">FooMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v2_call_foo_method_finish() to get the result of the operation. + +See foo_igen_changing_interface_v2_call_foo_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_call_foo_method_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v2_call_foo_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v2_call_foo_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_foo_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.FooMethod">FooMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v2_call_foo_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_new_method_in2"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.NewMethodIn2">NewMethodIn2()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v2_call_new_method_in2_finish() to get the result of the operation. + +See foo_igen_changing_interface_v2_call_new_method_in2_sync() for the synchronous, blocking version of this method. + +Since: 2.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_call_new_method_in2_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v2_call_new_method_in2(). + +Since: 2.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v2_call_new_method_in2(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_call_new_method_in2_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-ChangingInterfaceV2.NewMethodIn2">NewMethodIn2()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v2_call_new_method_in2() for the asynchronous version of this method. + +Since: 2.0 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenChangingInterfaceV2Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_complete_bar_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV2.BarMethod">BarMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_complete_baz_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV2.BazMethod">BazMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_complete_foo_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV2.FooMethod">FooMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_complete_new_method_in2"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-ChangingInterfaceV2.NewMethodIn2">NewMethodIn2()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_emit_bar_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV2.BarSignal">"BarSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_emit_baz_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV2.BazSignal">"BazSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_emit_foo_signal"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV2.FooSignal">"FooSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_emit_new_signal_in2"> +<description> +Emits the <link linkend="gdbus-signal-ChangingInterfaceV2.NewSignalIn2">"NewSignalIn2"</link> D-Bus signal. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenChangingInterfaceV2. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-ChangingInterfaceV2.top_of_page">ChangingInterfaceV2</link> D-Bus interface. + +Since: 2.0 + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenChangingInterfaceV2 interface for a concrete class. +The properties are overridden in the order they are defined. + +Since: 2.0 + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV2.top_of_page">ChangingInterfaceV2</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v2_proxy_new_finish() to get the result of the operation. + +See foo_igen_changing_interface_v2_proxy_new_sync() for the synchronous, blocking version of this constructor. + +Since: 2.0 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v2_proxy_new(). + +Since: 2.0 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v2_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_proxy_new_for_bus"> +<description> +Like foo_igen_changing_interface_v2_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_changing_interface_v2_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_changing_interface_v2_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +Since: 2.0 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_changing_interface_v2_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_changing_interface_v2_proxy_new_for_bus(). + +Since: 2.0 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_changing_interface_v2_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_proxy_new_for_bus_sync"> +<description> +Like foo_igen_changing_interface_v2_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v2_proxy_new_for_bus() for the asynchronous version of this constructor. + +Since: 2.0 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV2.top_of_page">ChangingInterfaceV2</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_changing_interface_v2_proxy_new() for the asynchronous version of this constructor. + +Since: 2.0 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_changing_interface_v2_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV2.top_of_page">ChangingInterfaceV2</link>. + +Since: 2.0 + +</description> +<parameters> +</parameters> +<return> The skeleton object. + +</return> +</function> + +<function name="foo_igen_com_acme_coyote_call_attack"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-com-acme-Coyote.Attack">Attack()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_com_acme_coyote_call_attack_finish() to get the result of the operation. + +See foo_igen_com_acme_coyote_call_attack_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_call_attack_finish"> +<description> +Finishes an operation started with foo_igen_com_acme_coyote_call_attack(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_com_acme_coyote_call_attack(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_call_attack_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-com-acme-Coyote.Attack">Attack()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_com_acme_coyote_call_attack() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_call_run"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-com-acme-Coyote.Run">Run()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_com_acme_coyote_call_run_finish() to get the result of the operation. + +See foo_igen_com_acme_coyote_call_run_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_call_run_finish"> +<description> +Finishes an operation started with foo_igen_com_acme_coyote_call_run(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_com_acme_coyote_call_run(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_call_run_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-com-acme-Coyote.Run">Run()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_com_acme_coyote_call_run() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_call_sleep"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-com-acme-Coyote.Sleep">Sleep()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_com_acme_coyote_call_sleep_finish() to get the result of the operation. + +See foo_igen_com_acme_coyote_call_sleep_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_call_sleep_finish"> +<description> +Finishes an operation started with foo_igen_com_acme_coyote_call_sleep(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_com_acme_coyote_call_sleep(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_call_sleep_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-com-acme-Coyote.Sleep">Sleep()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_com_acme_coyote_call_sleep() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenComAcmeCoyoteProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_complete_attack"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-com-acme-Coyote.Attack">Attack()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_complete_run"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-com-acme-Coyote.Run">Run()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_complete_sleep"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-com-acme-Coyote.Sleep">Sleep()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_dup_mood"> +<description> +Gets a copy of the <link linkend="gdbus-property-com-acme-Coyote.Mood">"Mood"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_com_acme_coyote_emit_surprised"> +<description> +Emits the <link linkend="gdbus-signal-com-acme-Coyote.Surprised">"Surprised"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_get_mood"> +<description> +Gets the value of the <link linkend="gdbus-property-com-acme-Coyote.Mood">"Mood"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_com_acme_coyote_dup_mood() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-com-acme-Coyote.top_of_page">com.acme.Coyote</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenComAcmeCoyote interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-com-acme-Coyote.top_of_page">com.acme.Coyote</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_com_acme_coyote_proxy_new_finish() to get the result of the operation. + +See foo_igen_com_acme_coyote_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_com_acme_coyote_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_com_acme_coyote_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_proxy_new_for_bus"> +<description> +Like foo_igen_com_acme_coyote_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_com_acme_coyote_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_com_acme_coyote_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_com_acme_coyote_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_com_acme_coyote_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_proxy_new_for_bus_sync"> +<description> +Like foo_igen_com_acme_coyote_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_com_acme_coyote_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-com-acme-Coyote.top_of_page">com.acme.Coyote</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_com_acme_coyote_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_com_acme_coyote_set_mood"> +<description> +Sets the <link linkend="gdbus-property-com-acme-Coyote.Mood">"Mood"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenComAcmeCoyote. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_com_acme_coyote_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-com-acme-Coyote.top_of_page">com.acme.Coyote</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_fdpassing_call_hello_fd"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-FDPassing.HelloFD">HelloFD()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_fdpassing_call_hello_fd_finish() to get the result of the operation. + +See foo_igen_fdpassing_call_hello_fd_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenFDPassingProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_fdpassing_call_hello_fd_finish"> +<description> +Finishes an operation started with foo_igen_fdpassing_call_hello_fd(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenFDPassingProxy. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_fd_list"> +<parameter_description> Return location for a #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_fdpassing_call_hello_fd(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_fdpassing_call_hello_fd_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-FDPassing.HelloFD">HelloFD()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_fdpassing_call_hello_fd() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenFDPassingProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_fd_list"> +<parameter_description> Return location for a #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_fdpassing_complete_hello_fd"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-FDPassing.HelloFD">HelloFD()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenFDPassing. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="response"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_fdpassing_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-FDPassing.top_of_page">FDPassing</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_fdpassing_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenFDPassing interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_fdpassing_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-FDPassing.top_of_page">FDPassing</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_fdpassing_proxy_new_finish() to get the result of the operation. + +See foo_igen_fdpassing_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_fdpassing_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_fdpassing_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_fdpassing_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_fdpassing_proxy_new_for_bus"> +<description> +Like foo_igen_fdpassing_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_fdpassing_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_fdpassing_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_fdpassing_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_fdpassing_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_fdpassing_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_fdpassing_proxy_new_for_bus_sync"> +<description> +Like foo_igen_fdpassing_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_fdpassing_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_fdpassing_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-FDPassing.top_of_page">FDPassing</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_fdpassing_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_fdpassing_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-FDPassing.top_of_page">FDPassing</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_inline_docs_call_foo_method"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-InlineDocs.FooMethod">FooMethod()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_inline_docs_call_foo_method_finish() to get the result of the operation. + +See foo_igen_inline_docs_call_foo_method_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenInlineDocsProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_call_foo_method_finish"> +<description> +Finishes an operation started with foo_igen_inline_docs_call_foo_method(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenInlineDocsProxy. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_inline_docs_call_foo_method(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_call_foo_method_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-InlineDocs.FooMethod">FooMethod()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_inline_docs_call_foo_method() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenInlineDocsProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_call_method2"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-InlineDocs.Method2">Method2()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_inline_docs_call_method2_finish() to get the result of the operation. + +See foo_igen_inline_docs_call_method2_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenInlineDocsProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_call_method2_finish"> +<description> +Finishes an operation started with foo_igen_inline_docs_call_method2(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenInlineDocsProxy. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_inline_docs_call_method2(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_call_method2_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-InlineDocs.Method2">Method2()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_inline_docs_call_method2() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenInlineDocsProxy. +</parameter_description> +</parameter> +<parameter name="arg_greeting"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_response"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_complete_foo_method"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-InlineDocs.FooMethod">FooMethod()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="response"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_complete_method2"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-InlineDocs.Method2">Method2()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="response"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_dup_baz_property"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-InlineDocs.BazProperty">"BazProperty"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_inline_docs_dup_fancy_property"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-InlineDocs.FancyProperty">"FancyProperty"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_inline_docs_dup_property2"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-InlineDocs.Property2">"Property2"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_inline_docs_dup_property3"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-InlineDocs.Property3">"Property3"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_inline_docs_dup_property4"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-InlineDocs.Property4">"Property4"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_inline_docs_dup_property5"> +<description> +Gets a copy of the <link linkend="gdbus-property-org-project-InlineDocs.Property5">"Property5"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_inline_docs_emit_bar_signal"> +<description> +Emits the <link linkend="gdbus-signal-org-project-InlineDocs.BarSignal">"BarSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="arg_blah"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +<parameter name="arg_boo"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_get_baz_property"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-InlineDocs.BazProperty">"BazProperty"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_inline_docs_dup_baz_property() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_inline_docs_get_fancy_property"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-InlineDocs.FancyProperty">"FancyProperty"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_inline_docs_dup_fancy_property() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_inline_docs_get_property2"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-InlineDocs.Property2">"Property2"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_inline_docs_dup_property2() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_inline_docs_get_property3"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-InlineDocs.Property3">"Property3"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_inline_docs_dup_property3() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_inline_docs_get_property4"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-InlineDocs.Property4">"Property4"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_inline_docs_dup_property4() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_inline_docs_get_property5"> +<description> +Gets the value of the <link linkend="gdbus-property-org-project-InlineDocs.Property5">"Property5"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_inline_docs_dup_property5() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_inline_docs_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-project-InlineDocs.top_of_page">org.project.InlineDocs</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_inline_docs_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenInlineDocs interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_inline_docs_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-InlineDocs.top_of_page">org.project.InlineDocs</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_inline_docs_proxy_new_finish() to get the result of the operation. + +See foo_igen_inline_docs_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_inline_docs_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_inline_docs_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_proxy_new_for_bus"> +<description> +Like foo_igen_inline_docs_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_inline_docs_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_inline_docs_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_inline_docs_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_inline_docs_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_proxy_new_for_bus_sync"> +<description> +Like foo_igen_inline_docs_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_inline_docs_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-InlineDocs.top_of_page">org.project.InlineDocs</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_inline_docs_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_inline_docs_set_baz_property"> +<description> +Sets the <link linkend="gdbus-property-org-project-InlineDocs.BazProperty">"BazProperty"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_set_fancy_property"> +<description> +Sets the <link linkend="gdbus-property-org-project-InlineDocs.FancyProperty">"FancyProperty"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_set_property2"> +<description> +Sets the <link linkend="gdbus-property-org-project-InlineDocs.Property2">"Property2"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_set_property3"> +<description> +Sets the <link linkend="gdbus-property-org-project-InlineDocs.Property3">"Property3"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_set_property4"> +<description> +Sets the <link linkend="gdbus-property-org-project-InlineDocs.Property4">"Property4"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_set_property5"> +<description> +Sets the <link linkend="gdbus-property-org-project-InlineDocs.Property5">"Property5"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenInlineDocs. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_inline_docs_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-project-InlineDocs.top_of_page">org.project.InlineDocs</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_method_threads_call_get_self"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-project-MethodThreads.GetSelf">GetSelf()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_method_threads_call_get_self_finish() to get the result of the operation. + +See foo_igen_method_threads_call_get_self_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenMethodThreadsProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_method_threads_call_get_self_finish"> +<description> +Finishes an operation started with foo_igen_method_threads_call_get_self(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenMethodThreadsProxy. +</parameter_description> +</parameter> +<parameter name="out_self_pointer"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_method_threads_call_get_self(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_method_threads_call_get_self_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-project-MethodThreads.GetSelf">GetSelf()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_method_threads_call_get_self() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenMethodThreadsProxy. +</parameter_description> +</parameter> +<parameter name="out_self_pointer"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_method_threads_complete_get_self"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-project-MethodThreads.GetSelf">GetSelf()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenMethodThreads. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="self_pointer"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_method_threads_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-project-MethodThreads.top_of_page">org.project.MethodThreads</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_method_threads_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenMethodThreads interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_method_threads_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-MethodThreads.top_of_page">org.project.MethodThreads</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_method_threads_proxy_new_finish() to get the result of the operation. + +See foo_igen_method_threads_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_method_threads_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_method_threads_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_method_threads_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_method_threads_proxy_new_for_bus"> +<description> +Like foo_igen_method_threads_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_method_threads_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_method_threads_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_method_threads_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_method_threads_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_method_threads_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_method_threads_proxy_new_for_bus_sync"> +<description> +Like foo_igen_method_threads_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_method_threads_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_method_threads_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-project-MethodThreads.top_of_page">org.project.MethodThreads</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_method_threads_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_method_threads_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-project-MethodThreads.top_of_page">org.project.MethodThreads</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_object_get_authorize"> +<description> +Gets the #FooiGenAuthorize instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Authorize.top_of_page">org.project.Authorize</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenAuthorize that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_bar"> +<description> +Gets the #FooiGenBar instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar.top_of_page">org.project.Bar</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBar that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_bar_frobnicator"> +<description> +Gets the #FooiGenBarFrobnicator instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar-Frobnicator.top_of_page">org.project.Bar.Frobnicator</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBarFrobnicator that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_bat"> +<description> +Gets the #FooiGenBat instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Bat.top_of_page">org.project.Bat</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBat that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_baz"> +<description> +Gets the #FooiGenBaz instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Baz.top_of_page">org.project.Baz</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBaz that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_changing_interface_v1"> +<description> +Gets the #FooiGenChangingInterfaceV1 instance for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV1.top_of_page">ChangingInterfaceV1</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenChangingInterfaceV1 that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_changing_interface_v10"> +<description> +Gets the #FooiGenChangingInterfaceV10 instance for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV10.top_of_page">ChangingInterfaceV10</link> on @object, if any. + +Since: 10.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenChangingInterfaceV10 that must be freed with g_object_unref() or %NULL if @object does not implement the interface. + +</return> +</function> + +<function name="foo_igen_object_get_changing_interface_v2"> +<description> +Gets the #FooiGenChangingInterfaceV2 instance for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV2.top_of_page">ChangingInterfaceV2</link> on @object, if any. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenChangingInterfaceV2 that must be freed with g_object_unref() or %NULL if @object does not implement the interface. + +</return> +</function> + +<function name="foo_igen_object_get_com_acme_coyote"> +<description> +Gets the #FooiGenComAcmeCoyote instance for the D-Bus interface <link linkend="gdbus-interface-com-acme-Coyote.top_of_page">com.acme.Coyote</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenComAcmeCoyote that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_fdpassing"> +<description> +Gets the #FooiGenFDPassing instance for the D-Bus interface <link linkend="gdbus-interface-FDPassing.top_of_page">FDPassing</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenFDPassing that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_inline_docs"> +<description> +Gets the #FooiGenInlineDocs instance for the D-Bus interface <link linkend="gdbus-interface-org-project-InlineDocs.top_of_page">org.project.InlineDocs</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenInlineDocs that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_method_threads"> +<description> +Gets the #FooiGenMethodThreads instance for the D-Bus interface <link linkend="gdbus-interface-org-project-MethodThreads.top_of_page">org.project.MethodThreads</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenMethodThreads that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_oldie_interface"> +<description> +Gets the #FooiGenOldieInterface instance for the D-Bus interface <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link> on @object, if any. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenOldieInterface that must be freed with g_object_unref() or %NULL if @object does not implement the interface. + +</return> +</function> + +<function name="foo_igen_object_get_rocket123"> +<description> +Gets the #FooiGenRocket123 instance for the D-Bus interface <link linkend="gdbus-interface-com-acme-Rocket.top_of_page">com.acme.Rocket</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenRocket123 that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_test_ugly_case_interface"> +<description> +Gets the #FooiGenTesTuglyCASEInterface instance for the D-Bus interface <link linkend="gdbus-interface-TestUglyCaseInterface.top_of_page">TestUglyCaseInterface</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenTesTuglyCASEInterface that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_get_unknown_xml_tags"> +<description> +Gets the #FooiGenUnknownXmlTags instance for the D-Bus interface <link linkend="gdbus-interface-UnknownXmlTags.top_of_page">UnknownXmlTags</link> on @object, if any. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenUnknownXmlTags that must be freed with g_object_unref() or %NULL if @object does not implement the interface. +</return> +</function> + +<function name="foo_igen_object_manager_client_get_proxy_type"> +<description> +A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy<!-- -->- and #GDBusProxy<!-- -->-derived types. + + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerClient. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> The object path of the remote object (unused). +</parameter_description> +</parameter> +<parameter name="interface_name"> +<parameter_description> Interface name of the remote object or %NULL to get the object proxy #GType. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data (unused). +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusProxy<!-- -->-derived #GType if @interface_name is not %NULL, otherwise the #GType for #FooiGenObjectProxy. +</return> +</function> + +<function name="foo_igen_object_manager_client_new"> +<description> +Asynchronously creates #GDBusObjectManagerClient using foo_igen_object_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_object_manager_client_new_finish() to get the result of the operation. + +See foo_igen_object_manager_client_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_manager_client_new_finish"> +<description> +Finishes an operation started with foo_igen_object_manager_client_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_object_manager_client_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_object_manager_client_new_for_bus"> +<description> +Like foo_igen_object_manager_client_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_object_manager_client_new_for_bus_finish() to get the result of the operation. + +See foo_igen_object_manager_client_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_manager_client_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_object_manager_client_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_object_manager_client_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_object_manager_client_new_for_bus_sync"> +<description> +Like foo_igen_object_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_object_manager_client_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_object_manager_client_new_sync"> +<description> +Synchronously creates #GDBusObjectManagerClient using foo_igen_object_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_object_manager_client_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed object manager client or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_object_peek_authorize"> +<description> +Like foo_igen_object_get_authorize() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenAuthorize or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_bar"> +<description> +Like foo_igen_object_get_bar() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBar or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_bar_frobnicator"> +<description> +Like foo_igen_object_get_bar_frobnicator() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBarFrobnicator or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_bat"> +<description> +Like foo_igen_object_get_bat() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBat or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_baz"> +<description> +Like foo_igen_object_get_baz() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenBaz or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_changing_interface_v1"> +<description> +Like foo_igen_object_get_changing_interface_v1() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenChangingInterfaceV1 or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_changing_interface_v10"> +<description> +Like foo_igen_object_get_changing_interface_v10() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + +Since: 10.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenChangingInterfaceV10 or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. + +</return> +</function> + +<function name="foo_igen_object_peek_changing_interface_v2"> +<description> +Like foo_igen_object_get_changing_interface_v2() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenChangingInterfaceV2 or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. + +</return> +</function> + +<function name="foo_igen_object_peek_com_acme_coyote"> +<description> +Like foo_igen_object_get_com_acme_coyote() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenComAcmeCoyote or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_fdpassing"> +<description> +Like foo_igen_object_get_fdpassing() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenFDPassing or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_inline_docs"> +<description> +Like foo_igen_object_get_inline_docs() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenInlineDocs or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_method_threads"> +<description> +Like foo_igen_object_get_method_threads() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenMethodThreads or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_oldie_interface"> +<description> +Like foo_igen_object_get_oldie_interface() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenOldieInterface or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. + +</return> +</function> + +<function name="foo_igen_object_peek_rocket123"> +<description> +Like foo_igen_object_get_rocket123() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenRocket123 or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_test_ugly_case_interface"> +<description> +Like foo_igen_object_get_test_ugly_case_interface() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenTesTuglyCASEInterface or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_peek_unknown_xml_tags"> +<description> +Like foo_igen_object_get_unknown_xml_tags() but doesn't increase the reference count on the returned object. + +<warning>It is not safe to use the returned object if you are on another thread than the one where the #GDBusObjectManagerClient or #GDBusObjectManagerServer for @object is running.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObject. +</parameter_description> +</parameter> +</parameters> +<return> A #FooiGenUnknownXmlTags or %NULL if @object does not implement the interface. Do not free the returned object, it is owned by @object. +</return> +</function> + +<function name="foo_igen_object_proxy_new"> +<description> +Creates a new proxy object. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +</parameters> +<return> The proxy object. +</return> +</function> + +<function name="foo_igen_object_skeleton_new"> +<description> +Creates a new skeleton object. + + +</description> +<parameters> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_object_skeleton_set_authorize"> +<description> +Sets the #FooiGenAuthorize instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Authorize.top_of_page">org.project.Authorize</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenAuthorize or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_bar"> +<description> +Sets the #FooiGenBar instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar.top_of_page">org.project.Bar</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenBar or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_bar_frobnicator"> +<description> +Sets the #FooiGenBarFrobnicator instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Bar-Frobnicator.top_of_page">org.project.Bar.Frobnicator</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenBarFrobnicator or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_bat"> +<description> +Sets the #FooiGenBat instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Bat.top_of_page">org.project.Bat</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenBat or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_baz"> +<description> +Sets the #FooiGenBaz instance for the D-Bus interface <link linkend="gdbus-interface-org-project-Baz.top_of_page">org.project.Baz</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenBaz or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_changing_interface_v1"> +<description> +Sets the #FooiGenChangingInterfaceV1 instance for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV1.top_of_page">ChangingInterfaceV1</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenChangingInterfaceV1 or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_changing_interface_v10"> +<description> +Sets the #FooiGenChangingInterfaceV10 instance for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV10.top_of_page">ChangingInterfaceV10</link> on @object. + +Since: 10.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenChangingInterfaceV10 or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_changing_interface_v2"> +<description> +Sets the #FooiGenChangingInterfaceV2 instance for the D-Bus interface <link linkend="gdbus-interface-ChangingInterfaceV2.top_of_page">ChangingInterfaceV2</link> on @object. + +Since: 2.0 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenChangingInterfaceV2 or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_com_acme_coyote"> +<description> +Sets the #FooiGenComAcmeCoyote instance for the D-Bus interface <link linkend="gdbus-interface-com-acme-Coyote.top_of_page">com.acme.Coyote</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenComAcmeCoyote or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_fdpassing"> +<description> +Sets the #FooiGenFDPassing instance for the D-Bus interface <link linkend="gdbus-interface-FDPassing.top_of_page">FDPassing</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenFDPassing or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_inline_docs"> +<description> +Sets the #FooiGenInlineDocs instance for the D-Bus interface <link linkend="gdbus-interface-org-project-InlineDocs.top_of_page">org.project.InlineDocs</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenInlineDocs or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_method_threads"> +<description> +Sets the #FooiGenMethodThreads instance for the D-Bus interface <link linkend="gdbus-interface-org-project-MethodThreads.top_of_page">org.project.MethodThreads</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenMethodThreads or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_oldie_interface"> +<description> +Sets the #FooiGenOldieInterface instance for the D-Bus interface <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link> on @object. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenOldieInterface or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_rocket123"> +<description> +Sets the #FooiGenRocket123 instance for the D-Bus interface <link linkend="gdbus-interface-com-acme-Rocket.top_of_page">com.acme.Rocket</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenRocket123 or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_test_ugly_case_interface"> +<description> +Sets the #FooiGenTesTuglyCASEInterface instance for the D-Bus interface <link linkend="gdbus-interface-TestUglyCaseInterface.top_of_page">TestUglyCaseInterface</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenTesTuglyCASEInterface or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_object_skeleton_set_unknown_xml_tags"> +<description> +Sets the #FooiGenUnknownXmlTags instance for the D-Bus interface <link linkend="gdbus-interface-UnknownXmlTags.top_of_page">UnknownXmlTags</link> on @object. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #FooiGenUnknownXmlTags or %NULL to clear the interface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_oldie_interface_call_foo"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-OldieInterface.Foo">Foo()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_oldie_interface_call_foo_finish() to get the result of the operation. + +See foo_igen_oldie_interface_call_foo_sync() for the synchronous, blocking version of this method. + +Deprecated: The D-Bus method has been deprecated. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenOldieInterfaceProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_oldie_interface_call_foo_finish"> +<description> +Finishes an operation started with foo_igen_oldie_interface_call_foo(). + +Deprecated: The D-Bus method has been deprecated. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenOldieInterfaceProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_oldie_interface_call_foo(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_oldie_interface_call_foo_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-OldieInterface.Foo">Foo()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_oldie_interface_call_foo() for the asynchronous version of this method. + +Deprecated: The D-Bus method has been deprecated. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenOldieInterfaceProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. + +</return> +</function> + +<function name="foo_igen_oldie_interface_complete_foo"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-OldieInterface.Foo">Foo()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +Deprecated: The D-Bus method has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenOldieInterface. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_oldie_interface_emit_bar"> +<description> +Emits the <link linkend="gdbus-signal-OldieInterface.Bar">"Bar"</link> D-Bus signal. + +Deprecated: The D-Bus signal has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenOldieInterface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_oldie_interface_get_bat"> +<description> +Gets the value of the <link linkend="gdbus-property-OldieInterface.Bat">"Bat"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +Deprecated: The D-Bus property has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenOldieInterface. +</parameter_description> +</parameter> +</parameters> +<return> The property value. + +</return> +</function> + +<function name="foo_igen_oldie_interface_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link> D-Bus interface. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. + +</return> +</function> + +<function name="foo_igen_oldie_interface_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenOldieInterface interface for a concrete class. +The properties are overridden in the order they are defined. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. + +</return> +</function> + +<function name="foo_igen_oldie_interface_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_oldie_interface_proxy_new_finish() to get the result of the operation. + +See foo_igen_oldie_interface_proxy_new_sync() for the synchronous, blocking version of this constructor. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_oldie_interface_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_oldie_interface_proxy_new(). + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_oldie_interface_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_oldie_interface_proxy_new_for_bus"> +<description> +Like foo_igen_oldie_interface_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_oldie_interface_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_oldie_interface_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_oldie_interface_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_oldie_interface_proxy_new_for_bus(). + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_oldie_interface_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_oldie_interface_proxy_new_for_bus_sync"> +<description> +Like foo_igen_oldie_interface_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_oldie_interface_proxy_new_for_bus() for the asynchronous version of this constructor. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_oldie_interface_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_oldie_interface_proxy_new() for the asynchronous version of this constructor. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. + +</return> +</function> + +<function name="foo_igen_oldie_interface_set_bat"> +<description> +Sets the <link linkend="gdbus-property-OldieInterface.Bat">"Bat"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +Deprecated: The D-Bus property has been deprecated. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenOldieInterface. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_oldie_interface_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-OldieInterface.top_of_page">OldieInterface</link>. + +Deprecated: The D-Bus interface has been deprecated. + +</description> +<parameters> +</parameters> +<return> The skeleton object. + +</return> +</function> + +<function name="foo_igen_rocket123_call_ignite_xyz"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-com-acme-Rocket.Ignite">Ignite()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_rocket123_call_ignite_xyz_finish() to get the result of the operation. + +See foo_igen_rocket123_call_ignite_xyz_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenRocket123Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_call_ignite_xyz_finish"> +<description> +Finishes an operation started with foo_igen_rocket123_call_ignite_xyz(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenRocket123Proxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_rocket123_call_ignite_xyz(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_rocket123_call_ignite_xyz_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-com-acme-Rocket.Ignite">Ignite()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_rocket123_call_ignite_xyz() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenRocket123Proxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_rocket123_complete_ignite_xyz"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-com-acme-Rocket.Ignite">Ignite()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_dup_direction"> +<description> +Gets a copy of the <link linkend="gdbus-property-com-acme-Rocket.Direction">"Direction"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_variant_unref(). +</return> +</function> + +<function name="foo_igen_rocket123_dup_type_"> +<description> +Gets a copy of the <link linkend="gdbus-property-com-acme-Rocket.Type">"Type"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_rocket123_emit_exploded_xyz"> +<description> +Emits the <link linkend="gdbus-signal-com-acme-Rocket.Exploded">"Exploded"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_get_direction"> +<description> +Gets the value of the <link linkend="gdbus-property-com-acme-Rocket.Direction">"Direction"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_rocket123_dup_direction() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_rocket123_get_speed_xyz"> +<description> +Gets the value of the <link linkend="gdbus-property-com-acme-Rocket.Speed">"Speed"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_rocket123_get_type_"> +<description> +Gets the value of the <link linkend="gdbus-property-com-acme-Rocket.Type">"Type"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_rocket123_dup_type_() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_rocket123_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-com-acme-Rocket.top_of_page">com.acme.Rocket</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_rocket123_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenRocket123 interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_rocket123_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-com-acme-Rocket.top_of_page">com.acme.Rocket</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_rocket123_proxy_new_finish() to get the result of the operation. + +See foo_igen_rocket123_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_rocket123_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_rocket123_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_rocket123_proxy_new_for_bus"> +<description> +Like foo_igen_rocket123_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_rocket123_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_rocket123_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_rocket123_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_rocket123_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_rocket123_proxy_new_for_bus_sync"> +<description> +Like foo_igen_rocket123_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_rocket123_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_rocket123_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-com-acme-Rocket.top_of_page">com.acme.Rocket</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_rocket123_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_rocket123_set_direction"> +<description> +Sets the <link linkend="gdbus-property-com-acme-Rocket.Direction">"Direction"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_set_speed_xyz"> +<description> +Sets the <link linkend="gdbus-property-com-acme-Rocket.Speed">"Speed"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_set_type_"> +<description> +Sets the <link linkend="gdbus-property-com-acme-Rocket.Type">"Type"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenRocket123. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_rocket123_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-com-acme-Rocket.top_of_page">com.acme.Rocket</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_call_get_iscsi_servers"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-TestUglyCaseInterface.GetiSCSIServers">GetiSCSIServers()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_test_ugly_case_interface_call_get_iscsi_servers_finish() to get the result of the operation. + +See foo_igen_test_ugly_case_interface_call_get_iscsi_servers_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenTesTuglyCASEInterfaceProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_test_ugly_case_interface_call_get_iscsi_servers_finish"> +<description> +Finishes an operation started with foo_igen_test_ugly_case_interface_call_get_iscsi_servers(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenTesTuglyCASEInterfaceProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_test_ugly_case_interface_call_get_iscsi_servers(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_call_get_iscsi_servers_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-TestUglyCaseInterface.GetiSCSIServers">GetiSCSIServers()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_test_ugly_case_interface_call_get_iscsi_servers() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenTesTuglyCASEInterfaceProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_complete_get_iscsi_servers"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-TestUglyCaseInterface.GetiSCSIServers">GetiSCSIServers()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenTesTuglyCASEInterface. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_test_ugly_case_interface_emit_servers_updated_now"> +<description> +Emits the <link linkend="gdbus-signal-TestUglyCaseInterface.serversUPDATEDNOW">"serversUPDATEDNOW"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenTesTuglyCASEInterface. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_test_ugly_case_interface_get_ugly_name"> +<description> +Gets the value of the <link linkend="gdbus-property-TestUglyCaseInterface.UGLYNAME">"UGLYNAME"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenTesTuglyCASEInterface. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-TestUglyCaseInterface.top_of_page">TestUglyCaseInterface</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenTesTuglyCASEInterface interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-TestUglyCaseInterface.top_of_page">TestUglyCaseInterface</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_test_ugly_case_interface_proxy_new_finish() to get the result of the operation. + +See foo_igen_test_ugly_case_interface_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_test_ugly_case_interface_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_test_ugly_case_interface_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_test_ugly_case_interface_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_proxy_new_for_bus"> +<description> +Like foo_igen_test_ugly_case_interface_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_test_ugly_case_interface_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_test_ugly_case_interface_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_test_ugly_case_interface_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_test_ugly_case_interface_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_test_ugly_case_interface_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_proxy_new_for_bus_sync"> +<description> +Like foo_igen_test_ugly_case_interface_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_test_ugly_case_interface_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-TestUglyCaseInterface.top_of_page">TestUglyCaseInterface</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_test_ugly_case_interface_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_test_ugly_case_interface_set_ugly_name"> +<description> +Sets the <link linkend="gdbus-property-TestUglyCaseInterface.UGLYNAME">"UGLYNAME"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenTesTuglyCASEInterface. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_test_ugly_case_interface_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-TestUglyCaseInterface.top_of_page">TestUglyCaseInterface</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_call_can_set_timezone"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-UnknownXmlTags.CanSetTimezone">CanSetTimezone()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_unknown_xml_tags_call_can_set_timezone_finish() to get the result of the operation. + +See foo_igen_unknown_xml_tags_call_can_set_timezone_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenUnknownXmlTagsProxy. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_unknown_xml_tags_call_can_set_timezone_finish"> +<description> +Finishes an operation started with foo_igen_unknown_xml_tags_call_can_set_timezone(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenUnknownXmlTagsProxy. +</parameter_description> +</parameter> +<parameter name="out_value"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_unknown_xml_tags_call_can_set_timezone(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_call_can_set_timezone_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-UnknownXmlTags.CanSetTimezone">CanSetTimezone()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See foo_igen_unknown_xml_tags_call_can_set_timezone() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #FooiGenUnknownXmlTagsProxy. +</parameter_description> +</parameter> +<parameter name="out_value"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the call succeded, %FALSE if @error is set. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_complete_can_set_timezone"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-UnknownXmlTags.CanSetTimezone">CanSetTimezone()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenUnknownXmlTags. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_unknown_xml_tags_dup_some_property"> +<description> +Gets a copy of the <link linkend="gdbus-property-UnknownXmlTags.SomeProperty">"SomeProperty"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenUnknownXmlTags. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. The returned value should be freed with g_free(). +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_emit_some_signal"> +<description> +Emits the <link linkend="gdbus-signal-UnknownXmlTags.SomeSignal">"SomeSignal"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenUnknownXmlTags. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_unknown_xml_tags_get_some_property"> +<description> +Gets the value of the <link linkend="gdbus-property-UnknownXmlTags.SomeProperty">"SomeProperty"</link> D-Bus property. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use foo_igen_unknown_xml_tags_dup_some_property() if on another thread.</warning> + + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenUnknownXmlTags. +</parameter_description> +</parameter> +</parameters> +<return> The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-UnknownXmlTags.top_of_page">UnknownXmlTags</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_override_properties"> +<description> +Overrides all #GObject properties in the #FooiGenUnknownXmlTags interface for a concrete class. +The properties are overridden in the order they are defined. + + +</description> +<parameters> +<parameter name="klass"> +<parameter_description> The class structure for a #GObject<!-- -->-derived class. +</parameter_description> +</parameter> +<parameter name="property_id_begin"> +<parameter_description> The property id to assign to the first overridden property. +</parameter_description> +</parameter> +</parameters> +<return> The last property id. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-UnknownXmlTags.top_of_page">UnknownXmlTags</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_unknown_xml_tags_proxy_new_finish() to get the result of the operation. + +See foo_igen_unknown_xml_tags_proxy_new_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_unknown_xml_tags_proxy_new_finish"> +<description> +Finishes an operation started with foo_igen_unknown_xml_tags_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_unknown_xml_tags_proxy_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_proxy_new_for_bus"> +<description> +Like foo_igen_unknown_xml_tags_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. +You can then call foo_igen_unknown_xml_tags_proxy_new_for_bus_finish() to get the result of the operation. + +See foo_igen_unknown_xml_tags_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_unknown_xml_tags_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with foo_igen_unknown_xml_tags_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to foo_igen_unknown_xml_tags_proxy_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_proxy_new_for_bus_sync"> +<description> +Like foo_igen_unknown_xml_tags_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See foo_igen_unknown_xml_tags_proxy_new_for_bus() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-UnknownXmlTags.top_of_page">UnknownXmlTags</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See foo_igen_unknown_xml_tags_proxy_new() for the asynchronous version of this constructor. + + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusProxyFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL +</parameter_description> +</parameter> +</parameters> +<return> The constructed proxy object or %NULL if @error is set. +</return> +</function> + +<function name="foo_igen_unknown_xml_tags_set_some_property"> +<description> +Sets the <link linkend="gdbus-property-UnknownXmlTags.SomeProperty">"SomeProperty"</link> D-Bus property to @value. + +Since this D-Bus property is both readable and writable, it is meaningful to use this function on both the client- and service-side. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #FooiGenUnknownXmlTags. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="foo_igen_unknown_xml_tags_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-UnknownXmlTags.top_of_page">UnknownXmlTags</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + <function name="g_action_activate"> <description> Activates the action. @@ -45,6 +16369,35 @@ Since: 2.28 <return></return> </function> +<function name="g_action_change_state"> +<description> +Request for the state of @action to be changed to @value. + +The action must be stateful and @value must be of the correct type. +See g_action_get_state_type(). + +This call merely requests a change. The action may refuse to change +its state or may change its state to something other than @value. +See g_action_get_state_hint(). + +If the @value GVariant is floating, it is consumed. + +Since: 2.30 + +</description> +<parameters> +<parameter name="action"> +<parameter_description> a #GAction +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the new state +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_action_get_enabled"> <description> Checks if @action is currently enabled. @@ -173,16 +16526,16 @@ Since: 2.28 <description> Queries the type of the state of @action. -If the action is stateful (ie: was created with -g_action_new_stateful()) then this function returns the #GVariantType -of the state. This is the type of the initial value given as the -state. All calls to g_action_set_state() must give a #GVariant of -this type and g_action_get_state() will return a #GVariant of the -same type. +If the action is stateful (e.g. created with +g_simple_action_new_stateful()) then this function returns the +#GVariantType of the state. This is the type of the initial value +given as the state. All calls to g_action_change_state() must give a +#GVariant of this type and g_action_get_state() will return a +#GVariant of the same type. -If the action is not stateful (ie: created with g_action_new()) then -this function will return %NULL. In that case, g_action_get_state() -will return %NULL and you must not call g_action_set_state(). +If the action is not stateful (e.g. created with g_simple_action_new()) +then this function will return %NULL. In that case, g_action_get_state() +will return %NULL and you must not call g_action_change_state(). Since: 2.28 @@ -301,7 +16654,7 @@ Activate the named action within @action_group. If the action is expecting a parameter, then the correct type of parameter must be given as @parameter. If the action is expecting no parameters then @parameter must be %NULL. See -g_action_group_get_parameter_type(). +g_action_group_get_action_parameter_type(). Since: 2.28 @@ -329,11 +16682,11 @@ Request for the state of the named action within @action_group to be changed to @value. The action must be stateful and @value must be of the correct type. -See g_action_group_get_state_type(). +See g_action_group_get_action_state_type(). This call merely requests a change. The action may refuse to change its state or may change its state to something other than @value. -See g_action_group_get_state_hint(). +See g_action_group_get_action_state_hint(). If the @value GVariant is floating, it is consumed. @@ -387,9 +16740,9 @@ Since: 2.28 Queries the type of the parameter that must be given when activating the named action within @action_group. -When activating the action using g_action_group_activate(), the -#GVariant given to that function must be of the type returned by this -function. +When activating the action using g_action_group_activate_action(), +the #GVariant given to that function must be of the type returned +by this function. In the case that this function returns %NULL, you must not give any #GVariant, but %NULL instead. @@ -422,7 +16775,7 @@ Queries the current state of the named action within @action_group. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type -given by g_action_group_get_state_type(). +given by g_action_group_get_action_state_type(). The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. @@ -490,13 +16843,14 @@ Queries the type of the state of the named action within @action_group. If the action is stateful then this function returns the -#GVariantType of the state. All calls to g_action_group_set_state() -must give a #GVariant of this type and g_action_group_get_state() -will return a #GVariant of the same type. +#GVariantType of the state. All calls to +g_action_group_change_action_state() must give a #GVariant of this +type and g_action_group_get_action_state() will return a #GVariant +of the same type. If the action is not stateful then this function will return %NULL. -In that case, g_action_group_get_state() will return %NULL and you -must not call g_action_group_set_state(). +In that case, g_action_group_get_action_state() will return %NULL +and you must not call g_action_group_change_action_state(). The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added @@ -564,29 +16918,207 @@ actions in the groupb </return> </function> -<function name="g_action_set_state"> +<function name="g_action_group_query_action"> <description> -Request for the state of @action to be changed to @value. +Queries all aspects of the named action within an @action_group. -The action must be stateful and @value must be of the correct type. -See g_action_get_state_type(). +This function acquires the information available from +g_action_group_has_action(), g_action_group_get_action_enabled(), +g_action_group_get_action_parameter_type(), +g_action_group_get_action_state_type(), +g_action_group_get_action_state_hint() and +g_action_group_get_state() with a single function call. -This call merely requests a change. The action may refuse to change -its state or may change its state to something other than @value. -See g_action_get_state_hint(). +This provides two main benefits. -If the @value GVariant is floating, it is consumed. +The first is the improvement in efficiency that comes with not having +to perform repeated lookups of the action in order to discover +different things about it. The second is that implementing +#GActionGroup can now be done by only overriding this one virtual +function. -Since: 2.28 +The interface provides a default implementation of this function that +calls the individual functions, as required, to fetch the +information. The interface also provides default implementations of +those functions that call this function. All implementations, +therefore, must override either this function or all of the others. + +If the action exists, %TRUE is returned and any of the requested +fields (as indicated by having a non-%NULL reference passed in) are +filled. If the action doesn't exist, %FALSE is returned and the +fields may or may not have been modified. + +Since: 2.32 + +</description> +<parameters> +<parameter name="action_group"> +<parameter_description> a #GActionGroup +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of an action in the group +</parameter_description> +</parameter> +<parameter name="enabled"> +<parameter_description> if the action is presently enabled +</parameter_description> +</parameter> +<parameter name="parameter_type"> +<parameter_description> the parameter type, or %NULL if none needed +</parameter_description> +</parameter> +<parameter name="state_type"> +<parameter_description> the state type, or %NULL if stateless +</parameter_description> +</parameter> +<parameter name="state_hint"> +<parameter_description> the state hint, or %NULL if none +</parameter_description> +</parameter> +<parameter name="state"> +<parameter_description> the current state, or %NULL if stateless +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the action exists, else %FALSE + +</return> +</function> + +<function name="g_action_map_add_action"> +<description> +Adds an action to the @action_map. + +If the action map already contains an action with the same name +as @action then the old action is dropped from the action map. + +The action map takes its own reference on @action. + +Since: 2.32 </description> <parameters> +<parameter name="action_map"> +<parameter_description> a #GActionMap +</parameter_description> +</parameter> <parameter name="action"> <parameter_description> a #GAction </parameter_description> </parameter> -<parameter name="value"> -<parameter_description> the new state +</parameters> +<return></return> +</function> + +<function name="g_action_map_add_action_entries"> +<description> +A convenience function for creating multiple #GSimpleAction instances +and adding them to a #GActionMap. + +Each action is constructed as per one #GActionEntry. + +<example> +<title>Using g_action_map_add_action_entries()</title> +<programlisting> +static void +activate_quit (GSimpleAction *simple, +GVariant *parameter, +gpointer user_data) +{ +exit (0); +} + +static void +activate_print_string (GSimpleAction *simple, +GVariant *parameter, +gpointer user_data) +{ +g_print ("%s\n", g_variant_get_string (parameter, NULL)); +} + +static GActionGroup * +create_action_group (void) +{ +const GActionEntry entries[] = { +{ "quit", activate_quit }, +{ "print-string", activate_print_string, "s" } +}; +GSimpleActionGroup *group; + +group = g_simple_action_group_new (); +g_action_map_add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), NULL); + +return G_ACTION_GROUP (group); +} +</programlisting> +</example> + +Since: 2.32 + +</description> +<parameters> +<parameter name="action_map"> +<parameter_description> a #GActionMap +</parameter_description> +</parameter> +<parameter name="entries"> +<parameter_description> a pointer to the first item in an array of #GActionEntry +structs +</parameter_description> +</parameter> +<parameter name="n_entries"> +<parameter_description> the length of @entries, or -1 if @entries is %NULL-terminated +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the user data for signal connections +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_action_map_lookup_action"> +<description> +Looks up the action with the name @action_name in @action_map. + +If no such action exists, returns %NULL. + +Since: 2.32 + +</description> +<parameters> +<parameter name="action_map"> +<parameter_description> a #GActionMap +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of an action +</parameter_description> +</parameter> +</parameters> +<return> a #GAction, or %NULL + +</return> +</function> + +<function name="g_action_map_remove_action"> +<description> +Removes the named action from the action map. + +If no action of this name is in the map then nothing happens. + +Since: 2.32 + +</description> +<parameters> +<parameter name="action_map"> +<parameter_description> a #GActionMap +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of the action </parameter_description> </parameter> </parameters> @@ -674,7 +17206,7 @@ Creates a new #GAppInfo from the given information. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, %NULL to ignore. +<parameter_description> a #GError location to store the error occurring, %NULL to ignore. </parameter_description> </parameter> </parameters> @@ -763,7 +17295,10 @@ the <literal>Hidden</literal> key set. <function name="g_app_info_get_all_for_type"> <description> -Gets a list of all #GAppInfos for a given content type. +Gets a list of all #GAppInfos for a given content type, +including the recommended and fallback #GAppInfos. See +g_app_info_get_recommended_for_type() and +g_app_info_get_fallback_for_type(). </description> @@ -800,7 +17335,7 @@ or %NULL if this information is not available <function name="g_app_info_get_default_for_type"> <description> -Gets the #GAppInfo that corresponds to a given content type. +Gets the default #GAppInfo for a given content type. </description> @@ -822,9 +17357,9 @@ support URIs <function name="g_app_info_get_default_for_uri_scheme"> <description> -Gets the default application for launching applications -using this URI scheme. A URI scheme is the initial part -of the URI, up to but not including the ':', e.g. "http", +Gets the default application for handling URIs with +the given URI scheme. A URI scheme is the initial part +of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". @@ -926,7 +17461,8 @@ Gets the icon for the application. </parameter_description> </parameter> </parameters> -<return> the default #GIcon for @appinfo. +<return> the default #GIcon for @appinfo or %NULL +if there is no default icon. </return> </function> @@ -974,7 +17510,7 @@ Gets a list of recommended #GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. -the last one for which #g_app_info_set_as_last_used_for_type has been +the last one for which g_app_info_set_as_last_used_for_type() has been called. Since: 2.28 @@ -1006,10 +17542,14 @@ can fail to start if it runs into problems during startup. There is no way to detect this. Some URIs can be changed when passed through a GFile (for instance -unsupported uris with strange formats like mailto:), so if you have -a textual uri you want to pass in as argument, consider using +unsupported URIs with strange formats like mailto:), so if you have +a textual URI you want to pass in as argument, consider using g_app_info_launch_uris() instead. +The launched application inherits the environment of the launching +process, but it can be modified with g_app_launch_context_setenv() and +g_app_launch_context_unsetenv(). + On UNIX, this function sets the <envar>GIO_LAUNCHED_DESKTOP_FILE</envar> environment variable with the path of the launched desktop file and <envar>GIO_LAUNCHED_DESKTOP_FILE_PID</envar> to the process @@ -1072,12 +17612,12 @@ required. <function name="g_app_info_launch_uris"> <description> -Launches the application. Passes @uris to the launched application +Launches the application. This passes the @uris to the launched application as arguments, using the optional @launch_context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. -To lauch the application without arguments pass a %NULL @uris list. +To launch the application without arguments pass a %NULL @uris list. Note that even if the launch is successful the application launched can fail to start if it runs into problems during startup. There is @@ -1134,16 +17674,17 @@ Removes a supported type from an application, if possible. <function name="g_app_info_reset_type_associations"> <description> Removes all changes to the type associations done by -g_app_info_set_as_default_for_type(), -g_app_info_set_as_default_for_extension(), -g_app_info_add_supports_type() or g_app_info_remove_supports_type(). +g_app_info_set_as_default_for_type(), +g_app_info_set_as_default_for_extension(), +g_app_info_add_supports_type() or +g_app_info_remove_supports_type(). Since: 2.20 </description> <parameters> <parameter name="content_type"> -<parameter_description> a content type +<parameter_description> a content type </parameter_description> </parameter> </parameters> @@ -1201,9 +17742,9 @@ Sets the application as the default handler for a given type. <function name="g_app_info_set_as_last_used_for_type"> <description> Sets the application as the last used application for a given type. -This will make the application appear as first in the list returned by -#g_app_info_get_recommended_for_type, regardless of the default application -for that content type. +This will make the application appear as first in the list returned +by g_app_info_get_recommended_for_type(), regardless of the default +application for that content type. </description> @@ -1300,6 +17841,28 @@ application, by setting the <envar>DISPLAY</envar> environment varia </return> </function> +<function name="g_app_launch_context_get_environment"> +<description> +Gets the complete environment variable list to be passed to +the child process when @context is used to launch an application. +This is a %NULL-terminated array of strings, where each string has +the form <literal>KEY=VALUE</literal>. + +Since: 2.32 + +</description> +<parameters> +<parameter name="context"> +<parameter_description> a #GAppLaunchContext +</parameter_description> +</parameter> +</parameters> +<return> the +child's environment + +</return> +</function> + <function name="g_app_launch_context_get_startup_notify_id"> <description> Initiates startup notification for the application and returns the @@ -1364,6 +17927,52 @@ instead you instantiate a subclass of this, such as #GdkAppLaunchContext. </return> </function> +<function name="g_app_launch_context_setenv"> +<description> +Arranges for @variable to be set to @value in the child's +environment when @context is used to launch an application. + +Since: 2.32 + +</description> +<parameters> +<parameter name="context"> +<parameter_description> a #GAppLaunchContext +</parameter_description> +</parameter> +<parameter name="variable"> +<parameter_description> the environment variable to set +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the value for to set the variable to. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_app_launch_context_unsetenv"> +<description> +Arranges for @variable to be unset in the child's environment +when @context is used to launch an application. + +Since: 2.32 + +</description> +<parameters> +<parameter name="context"> +<parameter_description> a #GAppLaunchContext +</parameter_description> +</parameter> +<parameter name="variable"> +<parameter_description> the environment variable to remove +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_application_activate"> <description> Activates the application. @@ -1513,7 +18122,7 @@ Since: 2.28 Gets the platform data associated with the invocation of @cmdline. This is a #GVariant dictionary containing information about the -context in which the invocation occured. It typically contains +context in which the invocation occurred. It typically contains information like the current working directory and the startup notification ID. @@ -1677,6 +18286,27 @@ Since: 2.28 </parameter> </parameters> <return> the identifier for @application, owned by @application + +</return> +</function> + +<function name="g_application_get_default"> +<description> +Returns the default #GApplication instance for this process. + +Normally there is only one #GApplication per process and it becomes +the default when it is created. You can exercise more control over +this by using g_application_set_default(). + +If there is no default application then %NULL is returned. + +Since: 2.32 + +</description> +<parameters> +</parameters> +<return> the default application for this process, or %NULL + </return> </function> @@ -1696,6 +18326,7 @@ Since: 2.28 </parameter> </parameters> <return> the flags for @application + </return> </function> @@ -1737,6 +18368,7 @@ Since: 2.28 </parameter> </parameters> <return> %TRUE if @application is registered + </return> </function> @@ -1763,6 +18395,7 @@ Since: 2.28 </parameter> </parameters> <return> %TRUE if @application is remote + </return> </function> @@ -1771,7 +18404,7 @@ Since: 2.28 Increases the use count of @application. Use this function to indicate that the application has a reason to -continue to run. For example, g_application_hold() is called by GTK+ +continue to run. For example, g_application_hold() is called by GTK+ when a toplevel window is on the screen. To cancel the hold, call g_application_release(). @@ -1803,6 +18436,7 @@ reproduced here: <listitem>Application identifiers must not exceed 255 characters.</listitem> </itemizedlist> + </description> <parameters> <parameter name="application_id"> @@ -1822,6 +18456,7 @@ This function calls g_type_init() for you. The application id must be valid. See g_application_id_is_valid(). + </description> <parameters> <parameter name="application_id"> @@ -1925,6 +18560,7 @@ Since: 2.28 </parameter> </parameters> <return> %TRUE if registration succeeded + </return> </function> @@ -2009,8 +18645,8 @@ suppress the default handling. See If, after the above is done, the use count of the application is zero then the exit status is returned immediately. If the use count is -non-zero then the mainloop is run until the use count falls to zero, -at which point 0 is returned. +non-zero then the default main context is iterated until the use count +falls to zero, at which point 0 is returned. If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at use count of zero is delayed for a while (ie: the instance stays @@ -2034,20 +18670,23 @@ Since: 2.28 </parameter> </parameters> <return> the exit status + </return> </function> <function name="g_application_set_action_group"> <description> -Sets or unsets the group of actions associated with the application. - -These actions are the actions that can be remotely invoked. - -It is an error to call this function after the application has been -registered. +This used to be how actions were associated with a #GApplication. +Now there is #GActionMap for that. Since: 2.28 +Deprecated:2.32:Use the #GActionMap interface instead. Never ever +mix use of this API with use of #GActionMap on the same @application +or things will go very badly wrong. This function is known to +introduce buggy behaviour (ie: signals not emitted on changes to the +action group), so you should really use #GActionMap instead. + </description> <parameters> <parameter name="application"> @@ -2087,6 +18726,27 @@ Since: 2.28 <return></return> </function> +<function name="g_application_set_default"> +<description> +Sets or unsets the default application for the process, as returned +by g_application_get_default(). + +This function does not take its own reference on @application. If +@application is destroyed then the default application will revert +back to %NULL. + +Since: 2.32 + +</description> +<parameters> +<parameter name="application"> +<parameter_description> the application to set as default, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_application_set_flags"> <description> Sets the flags for @application. @@ -2136,9 +18796,7 @@ Since: 2.28 </parameter_description> </parameter> </parameters> -<return> the timeout, in milliseconds - -</return> +<return></return> </function> <function name="g_async_initable_init_async"> @@ -2159,9 +18817,11 @@ object from another thread. If the operation was cancelled, the error the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned. -If this function is not called, or returns with an error, then all -operations on the object should fail, generally returning the -error %G_IO_ERROR_NOT_INITIALIZED. +As with #GInitable, if the object is not initialized, or initialization +returns with an error, then all operations on the object except +g_object_ref() and g_object_unref() are considered to be invalid, and +have undefined behaviour. They will often fail with g_critical() or +g_warning(), but this must not be relied on. Implementations of this method must be idempotent: i.e. multiple calls to this function with the same argument should return the same results. @@ -2222,7 +18882,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -2235,7 +18895,7 @@ will return %FALSE and set @error appropriately if present. <function name="g_async_initable_new_async"> <description> -Helper function for constructing #GAsyncInitiable object. This is +Helper function for constructing #GAsyncInitable object. This is similar to g_object_new() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -2284,8 +18944,8 @@ value pairs, and ended by %NULL. <function name="g_async_initable_new_finish"> <description> -Finishes the async construction for the various g_async_initable_new calls, -returning the created object or %NULL on error. +Finishes the async construction for the various g_async_initable_new +calls, returning the created object or %NULL on error. Since: 2.22 @@ -2296,24 +18956,23 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="res"> -<parameter_description> the #GAsyncResult.from the callback +<parameter_description> the #GAsyncResult from the callback </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to -ignore. +<parameter_description> return location for errors, or %NULL to ignore </parameter_description> </parameter> </parameters> -<return> a newly created #GObject, or %NULL on error. Free with -g_object_unref(). +<return> a newly created #GObject, or %NULL on error. +Free with g_object_unref(). </return> </function> <function name="g_async_initable_new_valist_async"> <description> -Helper function for constructing #GAsyncInitiable object. This is +Helper function for constructing #GAsyncInitable object. This is similar to g_object_new_valist() but also initializes the object asynchronously. @@ -2362,7 +19021,7 @@ finished <function name="g_async_initable_newv_async"> <description> -Helper function for constructing #GAsyncInitiable object. This is +Helper function for constructing #GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -2483,7 +19142,7 @@ g_buffered_input_stream_fill_async(). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -2639,7 +19298,8 @@ offset @offset bytes. </parameter_description> </parameter> <parameter name="buffer"> -<parameter_description> a pointer to an allocated chunk of memory +<parameter_description> a pointer to +an allocated chunk of memory </parameter_description> </parameter> <parameter name="offset"> @@ -2706,7 +19366,7 @@ On error -1 is returned and @error is set accordingly. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -2883,7 +19543,7 @@ Finishes an operation started with g_bus_get(). The returned object is a singleton, that is, shared with other callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the event that you need a private message bus connection, use -g_dbus_address_get_for_bus() and +g_dbus_address_get_for_bus_sync() and g_dbus_connection_new_for_address(). Note that the returned #GDBusConnection object will (usually) have @@ -3545,12 +20205,12 @@ Checks if a cancellable job has been cancelled. </description> <parameters> <parameter name="cancellable"> -<parameter_description> a #GCancellable or NULL. +<parameter_description> a #GCancellable or %NULL </parameter_description> </parameter> </parameters> -<return> %TRUE if @cancellable is cancelled, -FALSE if called with %NULL or if item is not cancelled. +<return> %TRUE if @cancellable is cancelled, +FALSE if called with %NULL or if item is not cancelled. </return> </function> @@ -3603,7 +20263,7 @@ that should be cancellable should create a #GCancellable and pass it to the operations. One #GCancellable can be used in multiple consecutive -operations, but not in multiple concurrent operations. +operations or in multiple concurrent operations. </description> @@ -3631,7 +20291,7 @@ is on the top of the stack). <function name="g_cancellable_push_current"> <description> Pushes @cancellable onto the cancellable stack. The current -cancellable can then be recieved using g_cancellable_get_current(). +cancellable can then be received using g_cancellable_get_current(). This is useful when implementing cancellable operations in code that does not allow you to pass down the cancellable object. @@ -3675,7 +20335,10 @@ Since: 2.22 <function name="g_cancellable_reset"> <description> -Resets @cancellable to its uncancelled state. +Resets @cancellable to its uncancelled state. + +If cancellable is currently in use by any cancellable operation +then the behavior of this function is undefined. </description> <parameters> @@ -3696,15 +20359,15 @@ that the operation was cancelled. </description> <parameters> <parameter name="cancellable"> -<parameter_description> a #GCancellable object. +<parameter_description> a #GCancellable or %NULL </parameter_description> </parameter> <parameter name="error"> -<parameter_description> #GError to append error state to. +<parameter_description> #GError to append error state to </parameter_description> </parameter> </parameters> -<return> %TRUE if @cancellable was cancelled, %FALSE if it was not. +<return> %TRUE if @cancellable was cancelled, %FALSE if it was not </return> </function> @@ -3980,7 +20643,7 @@ Since: 2.18 </parameter> </parameters> <return> an %NULL-terminated -array of zero or more content types, or %NULL. Free with g_strfreev() +array of zero or more content types. Free with g_strfreev() </return> </function> @@ -4029,8 +20692,7 @@ while on win32 it is "*". Gets a list of strings containing all the registered content types known to the system. The list and its data should be freed using <programlisting> -g_list_foreach (list, g_free, NULL); -g_list_free (list); +g_list_free_full (list, g_free); </programlisting> @@ -4069,9 +20731,9 @@ data (and there might even be other data after the end of the compressed data). When some data has successfully been converted @bytes_read and is set to the number of bytes read from @inbuf, and @bytes_written is set to indicate how many bytes was written to @outbuf. If there are more data to output -or consume (i.e. unless the G_CONVERTER_INPUT_AT_END is specified) then -G_CONVERTER_CONVERTED is returned, and if no more data is to be output -then G_CONVERTER_FINISHED is returned. +or consume (i.e. unless the %G_CONVERTER_INPUT_AT_END is specified) then +%G_CONVERTER_CONVERTED is returned, and if no more data is to be output +then %G_CONVERTER_FINISHED is returned. On error %G_CONVERTER_ERROR is returned and @error is set accordingly. Some errors need special handling: @@ -4105,7 +20767,7 @@ initial state. If the flag %G_CONVERTER_FLUSH is set then conversion is modified to try to write out all internal state to the output. The application has to call the function multiple times with the flag set, and when -the availible input has been consumed and all internal state has +the available input has been consumed and all internal state has been produced then %G_CONVERTER_FLUSHED (or %G_CONVERTER_FINISHED if really at the end) is returned instead of %G_CONVERTER_CONVERTED. This is somewhat similar to what happens at the end of the input stream, @@ -4164,7 +20826,7 @@ containing the data to convert. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -4616,7 +21278,9 @@ an error occurred. <function name="g_data_input_stream_read_line"> <description> -Reads a line from the data input stream. +Reads a line from the data input stream. Note that no encoding +checks or conversion is performed; the input is not guaranteed to +be UTF-8, and may in fact have embedded NUL characters. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -4642,11 +21306,12 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </parameter_description> </parameter> </parameters> -<return> a string with the line that was read in -(without the newlines). Set @length to a #gsize to get the -length of the read line. On an error, it will return %NULL and -@error will be set. If there's no content to read, it will -still return %NULL, but @error won't be set. +<return> a +NUL terminated byte array with the line that was read in (without +the newlines). Set @length to a #gsize to get the length of the +read line. On an error, it will return %NULL and @error will be +set. If there's no content to read, it will still return %NULL, +but @error won't be set. </return> </function> @@ -4691,7 +21356,9 @@ of the request. <function name="g_data_input_stream_read_line_finish"> <description> Finish an asynchronous call started by -g_data_input_stream_read_line_async(). +g_data_input_stream_read_line_async(). Note the warning about +string encoding in g_data_input_stream_read_line() applies here as +well. Since: 2.20 @@ -4714,7 +21381,8 @@ Since: 2.20 </parameter_description> </parameter> </parameters> -<return> a string with the line that was read in +<return> a +NUL-terminated byte array with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error will be set. If there's no content to read, it will @@ -4723,6 +21391,81 @@ still return %NULL, but @error won't be set. </return> </function> +<function name="g_data_input_stream_read_line_finish_utf8"> +<description> +Finish an asynchronous call started by +g_data_input_stream_read_line_async(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a given #GDataInputStream. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> the #GAsyncResult that was provided to the callback. +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> a #gsize to get the length of the data read in. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting. +</parameter_description> +</parameter> +</parameters> +<return> a string with the line that was read in +(without the newlines). Set @length to a #gsize to get the length +of the read line. On an error, it will return %NULL and @error +will be set. For UTF-8 conversion errors, the set error domain is +%G_CONVERT_ERROR. If there's no content to read, it will still +return %NULL, but @error won't be set. + +</return> +</function> + +<function name="g_data_input_stream_read_line_utf8"> +<description> +Reads a UTF-8 encoded line from the data input stream. + +If @cancellable is not %NULL, then the operation can be cancelled by +triggering the cancellable object from another thread. If the operation +was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + +Since: 2.30 + +</description> +<parameters> +<parameter name="stream"> +<parameter_description> a given #GDataInputStream. +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> a #gsize to get the length of the data read in. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting. +</parameter_description> +</parameter> +</parameters> +<return> a NUL terminated UTF-8 string with the +line that was read in (without the newlines). Set @length to a +#gsize to get the length of the read line. On an error, it will +return %NULL and @error will be set. For UTF-8 conversion errors, +the set error domain is %G_CONVERT_ERROR. If there's no content to +read, it will still return %NULL, but @error won't be set. + +</return> +</function> + <function name="g_data_input_stream_read_uint16"> <description> Reads an unsigned 16-bit/2-byte value from @stream. @@ -4958,7 +21701,7 @@ g_data_input_stream_read_upto() again. Note that @stop_chars may contain '\0' if @stop_chars_len is specified. -Since: 2.24 +Since: 2.26 </description> <parameters> @@ -5013,7 +21756,7 @@ When the operation is finished, @callback will be called. You can then call g_data_input_stream_read_upto_finish() to get the result of the operation. -Since: 2.24 +Since: 2.26 </description> <parameters> @@ -5115,7 +21858,7 @@ Sets the newline type for the @stream. Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read chunk ends in "CR" we must read an additional byte to know if this is "CR" or -"CR LF", and this might block if there is no more data availible. +"CR LF", and this might block if there is no more data available. </description> @@ -5406,6 +22149,44 @@ Sets the byte order of the data output stream to @order. <return></return> </function> +<function name="g_dbus_action_group_get"> +<description> +Obtains a #GDBusActionGroup for the action group which is exported at +the given @bus_name and @object_path. + +The thread default main context is taken at the time of this call. +All signals on the menu model (and any linked models) are reported +with respect to this context. All calls on the returned menu model +(and linked models) must also originate from this same context, with +the thread default main context unchanged. + +This call is non-blocking. The returned action group may or may not +already be filled in. The correct thing to do is connect the signals +for the action group to monitor for changes and then to call +g_action_group_list_actions() to get the initial list. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection +</parameter_description> +</parameter> +<parameter name="bus_name"> +<parameter_description> the bus name which exports the action group +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> the object path at which the action group is exported +</parameter_description> +</parameter> +</parameters> +<return> a #GDBusActionGroup + +</return> +</function> + <function name="g_dbus_address_get_for_bus_sync"> <description> Synchronously looks up the D-Bus address for the well-known message @@ -5678,15 +22459,13 @@ are run in the order that they were added. The same handler can be added as a filter more than once, in which case it will be run more than once. Filters added during a filter callback won't be run on the message being processed. Filter functions are allowed to modify -and even drop messages - see the #GDBusMessageFilterResult -enumeration for details. +and even drop messages. Note that filters are run in a dedicated message handling thread so they can't block and, generally, can't do anything but signal a worker thread. Also note that filters are rarely needed - use API such as g_dbus_connection_send_message_with_reply(), -g_dbus_connection_signal_subscribe() or -g_dbus_connection_call() instead. +g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead. If a filter consumes an incoming message the message is not dispatched anywhere else - not even the standard dispatch machinery @@ -5774,7 +22553,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="bus_name"> -<parameter_description> A unique or well-known bus name or %NULL if @connection is not a message bus connection. +<parameter_description> A unique or well-known bus name or %NULL if +@connection is not a message bus connection. </parameter_description> </parameter> <parameter name="object_path"> @@ -5790,7 +22570,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="parameters"> -<parameter_description> A #GVariant tuple with parameters for the method or %NULL if not passing parameters. +<parameter_description> A #GVariant tuple with parameters for the method +or %NULL if not passing parameters. </parameter_description> </parameter> <parameter name="reply_type"> @@ -5811,8 +22592,9 @@ timeout or %G_MAXINT for no timeout. </parameter_description> </parameter> <parameter name="callback"> -<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't -care about the result of the method invocation. +<parameter_description> A #GAsyncReadyCallback to call when the request is +satisfied or %NULL if you don't care about the result of the +method invocation. </parameter_description> </parameter> <parameter name="user_data"> @@ -5914,7 +22696,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="parameters"> -<parameter_description> A #GVariant tuple with parameters for the method or %NULL if not passing parameters. +<parameter_description> A #GVariant tuple with parameters for the method +or %NULL if not passing parameters. </parameter_description> </parameter> <parameter name="reply_type"> @@ -5945,6 +22728,179 @@ return values. Free with g_variant_unref(). </return> </function> +<function name="g_dbus_connection_call_with_unix_fd_list"> +<description> +Like g_dbus_connection_call() but also takes a #GUnixFDList object. + +This method is only available on UNIX. + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="bus_name"> +<parameter_description> A unique or well-known bus name or %NULL if +@connection is not a message bus connection. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> Path of remote object. +</parameter_description> +</parameter> +<parameter name="interface_name"> +<parameter_description> D-Bus interface to invoke method on. +</parameter_description> +</parameter> +<parameter name="method_name"> +<parameter_description> The name of the method to invoke. +</parameter_description> +</parameter> +<parameter name="parameters"> +<parameter_description> A #GVariant tuple with parameters for the method +or %NULL if not passing parameters. +</parameter_description> +</parameter> +<parameter name="reply_type"> +<parameter_description> The expected type of the reply, or %NULL. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusCallFlags enumeration. +</parameter_description> +</parameter> +<parameter name="timeout_msec"> +<parameter_description> The timeout in milliseconds, -1 to use the default +timeout or %G_MAXINT for no timeout. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is +satisfied or %NULL if you don't * care about the result of the +method invocation. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> The data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_connection_call_with_unix_fd_list_finish"> +<description> +Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="out_fd_list"> +<parameter_description> Return location for a #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %NULL if @error is set. Otherwise a #GVariant tuple with +return values. Free with g_variant_unref(). + +</return> +</function> + +<function name="g_dbus_connection_call_with_unix_fd_list_sync"> +<description> +Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. + +This method is only available on UNIX. + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="bus_name"> +<parameter_description> A unique or well-known bus name. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> Path of remote object. +</parameter_description> +</parameter> +<parameter name="interface_name"> +<parameter_description> D-Bus interface to invoke method on. +</parameter_description> +</parameter> +<parameter name="method_name"> +<parameter_description> The name of the method to invoke. +</parameter_description> +</parameter> +<parameter name="parameters"> +<parameter_description> A #GVariant tuple with parameters for the method +or %NULL if not passing parameters. +</parameter_description> +</parameter> +<parameter name="reply_type"> +<parameter_description> The expected type of the reply, or %NULL. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusCallFlags enumeration. +</parameter_description> +</parameter> +<parameter name="timeout_msec"> +<parameter_description> The timeout in milliseconds, -1 to use the default +timeout or %G_MAXINT for no timeout. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="out_fd_list"> +<parameter_description> Return location for a #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %NULL if @error is set. Otherwise a #GVariant tuple with +return values. Free with g_variant_unref(). + +</return> +</function> + <function name="g_dbus_connection_close"> <description> Closes @connection. Note that this never causes the process to @@ -5985,8 +22941,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="callback"> -<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't -care about the result. +<parameter_description> A #GAsyncReadyCallback to call when the request is +satisfied or %NULL if you don't care about the result. </parameter_description> </parameter> <parameter name="user_data"> @@ -6069,7 +23025,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="destination_bus_name"> -<parameter_description> The unique bus name for the destination for the signal or %NULL to emit to all listeners. +<parameter_description> The unique bus name for the destination +for the signal or %NULL to emit to all listeners. </parameter_description> </parameter> <parameter name="object_path"> @@ -6085,7 +23042,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="parameters"> -<parameter_description> A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. +<parameter_description> A #GVariant tuple with parameters for the signal +or %NULL if not passing parameters. </parameter_description> </parameter> <parameter name="error"> @@ -6098,6 +23056,97 @@ Since: 2.26 </return> </function> +<function name="g_dbus_connection_export_action_group"> +<description> +Exports @action_group on @connection at @object_path. + +The implemented D-Bus API should be considered private. It is +subject to change in the future. + +A given object path can only have one action group exported on it. +If this constraint is violated, the export will fail and 0 will be +returned (with @error set accordingly). + +You can unexport the action group using +g_dbus_connection_unexport_action_group() with the return value of +this function. + +The thread default main context is taken at the time of this call. +All incoming action activations and state change requests are +reported from this context. Any changes on the action group that +cause it to emit signals must also come from this same context. +Since incoming action activations and state change requests are +rather likely to cause changes on the action group, this effectively +limits a given action group to being exported from only one main +context. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GDBusConnection +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> a D-Bus object path +</parameter_description> +</parameter> +<parameter name="action_group"> +<parameter_description> a #GActionGroup +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a pointer to a %NULL #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> the ID of the export (never zero), or 0 in case of failure + +</return> +</function> + +<function name="g_dbus_connection_export_menu_model"> +<description> +Exports @menu on @connection at @object_path. + +The implemented D-Bus API should be considered private. +It is subject to change in the future. + +An object path can only have one action group exported on it. If this +constraint is violated, the export will fail and 0 will be +returned (with @error set accordingly). + +You can unexport the menu model using +g_dbus_connection_unexport_menu_model() with the return value of +this function. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GDBusConnection +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> a D-Bus object path +</parameter_description> +</parameter> +<parameter name="menu"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for an error, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> the ID of the export (never zero), or 0 in case of failure + +</return> +</function> + <function name="g_dbus_connection_flush"> <description> Asynchronously flushes @connection, that is, writes all queued @@ -6129,8 +23178,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="callback"> -<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't -care about the result. +<parameter_description> A #GAsyncReadyCallback to call when the request is +satisfied or %NULL if you don't care about the result. </parameter_description> </parameter> <parameter name="user_data"> @@ -6286,6 +23335,10 @@ this object, it is owned by @connection. <description> Gets the underlying stream used for IO. +While the #GDBusConnection is active, it will interact with this +stream from a worker thread, so it is not safe to interact with +the stream directly. + Since: 2.26 </description> @@ -6345,6 +23398,13 @@ Since: 2.26 Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. +If @stream is a #GSocketConnection, then the corresponding #GSocket +will be put into non-blocking mode. + +The D-Bus connection will interact with @stream from a worker thread. +As a result, the caller should not interact with @stream after this +method has been called, except by calling g_object_unref() on it. + If @observer is not %NULL it may be used to control the authentication process. @@ -6544,6 +23604,13 @@ Since: 2.26 Synchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. +If @stream is a #GSocketConnection, then the corresponding #GSocket +will be put into non-blocking mode. + +The D-Bus connection will interact with @stream from a worker thread. +As a result, the caller should not interact with @stream after this +method has been called, except by calling g_object_unref() on it. + If @observer is not %NULL it may be used to control the authentication process. @@ -6799,7 +23866,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="out_serial"> -<parameter_description> Return location for serial number assigned to @message when sending it or %NULL. +<parameter_description> Return location for serial number assigned +to @message when sending it or %NULL. </parameter_description> </parameter> <parameter name="error"> @@ -6864,7 +23932,8 @@ timeout or %G_MAXINT for no timeout. </parameter_description> </parameter> <parameter name="out_serial"> -<parameter_description> Return location for serial number assigned to @message when sending it or %NULL. +<parameter_description> Return location for serial number assigned +to @message when sending it or %NULL. </parameter_description> </parameter> <parameter name="cancellable"> @@ -6872,8 +23941,8 @@ timeout or %G_MAXINT for no timeout. </parameter_description> </parameter> <parameter name="callback"> -<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't -care about the result. +<parameter_description> A #GAsyncReadyCallback to call when the request is +satisfied or %NULL if you don't care about the result. </parameter_description> </parameter> <parameter name="user_data"> @@ -6889,7 +23958,7 @@ care about the result. Finishes an operation started with g_dbus_connection_send_message_with_reply(). Note that @error is only set if a local in-process error -occured. That is to say that the returned #GDBusMessage object may +occurred. That is to say that the returned #GDBusMessage object may be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use g_dbus_message_to_gerror() to transcode this to a #GError. @@ -6939,7 +24008,7 @@ fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed, the operation fails with %G_IO_ERROR_INVALID_ARGUMENT. Note that @error is only set if a local in-process error -occured. That is to say that the returned #GDBusMessage object may +occurred. That is to say that the returned #GDBusMessage object may be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use g_dbus_message_to_gerror() to transcode this to a #GError. @@ -6972,7 +24041,8 @@ timeout or %G_MAXINT for no timeout. </parameter_description> </parameter> <parameter name="out_serial"> -<parameter_description> Return location for serial number assigned to @message when sending it or %NULL. +<parameter_description> Return location for serial number assigned +to @message when sending it or %NULL. </parameter_description> </parameter> <parameter name="cancellable"> @@ -6995,6 +24065,13 @@ Sets whether the process should be terminated when @connection is closed by the remote peer. See #GDBusConnection:exit-on-close for more details. +Note that this function should be used with care. Most modern UNIX +desktops tie the notion of a user session the session bus, and expect +all of a users applications to quit when their bus connection goes away. +If you are setting @exit_on_close to %FALSE for the shared session +bus connection, you should make sure that your application exits +when the user session ends. + Since: 2.26 </description> @@ -7039,11 +24116,13 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="sender"> -<parameter_description> Sender name to match on (unique or well-known name) or %NULL to listen from all senders. +<parameter_description> Sender name to match on (unique or well-known name) +or %NULL to listen from all senders. </parameter_description> </parameter> <parameter name="interface_name"> -<parameter_description> D-Bus interface name to match on or %NULL to match on all interfaces. +<parameter_description> D-Bus interface name to match on or %NULL to +match on all interfaces. </parameter_description> </parameter> <parameter name="member"> @@ -7055,7 +24134,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="arg0"> -<parameter_description> Contents of first string argument to match on or %NULL to match on all kinds of arguments. +<parameter_description> Contents of first string argument to match on or %NULL +to match on all kinds of arguments. </parameter_description> </parameter> <parameter name="flags"> @@ -7071,7 +24151,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="user_data_free_func"> -<parameter_description> Function to free @user_data with when subscription is removed or %NULL. +<parameter_description> Function to free @user_data with when +subscription is removed or %NULL. </parameter_description> </parameter> </parameters> @@ -7119,6 +24200,56 @@ Since: 2.26 <return></return> </function> +<function name="g_dbus_connection_unexport_action_group"> +<description> +Reverses the effect of a previous call to +g_dbus_connection_export_action_group(). + +It is an error to call this function with an ID that wasn't returned +from g_dbus_connection_export_action_group() or to call it with the +same ID more than once. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GDBusConnection +</parameter_description> +</parameter> +<parameter name="export_id"> +<parameter_description> the ID from g_dbus_connection_export_action_group() +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_connection_unexport_menu_model"> +<description> +Reverses the effect of a previous call to +g_dbus_connection_export_menu_model(). + +It is an error to call this function with an ID that wasn't returned +from g_dbus_connection_export_menu_model() or to call it with the +same ID more than once. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GDBusConnection +</parameter_description> +</parameter> +<parameter name="export_id"> +<parameter_description> the ID from g_dbus_connection_export_menu_model() +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_dbus_connection_unregister_object"> <description> Unregisters an object. @@ -7473,6 +24604,230 @@ Since: 2.26 </return> </function> +<function name="g_dbus_gvalue_to_gvariant"> +<description> +Converts a #GValue to a #GVariant of the type indicated by the @type parameter. + +The conversion is using the following rules: +<table frame='all'> +<title>#GValue / #GVariant conversion rules</title> +<tgroup cols='2' align='left' colsep='1' rowsep='1'> +<thead> +<row> +<entry>If the #GType for @gvalue is...</entry> +<entry>... then @type must be</entry> +</row> +</thead> +<tbody> +<row> +<entry>#G_TYPE_STRING</entry> +<entry><link linkend="G-VARIANT-TYPE-STRING:CAPS">'s'</link>, <link linkend="G-VARIANT-TYPE-OBJECT-PATH:CAPS">'o'</link>, <link linkend="G-VARIANT-TYPE-SIGNATURE:CAPS">'g'</link> or <link linkend="G-VARIANT-TYPE-BYTESTRING:CAPS">'ay'</link></entry> +</row> +<row> +<entry>#G_TYPE_STRV</entry> +<entry><link linkend="G-VARIANT-TYPE-STRING-ARRAY:CAPS">'as'</link>, <link linkend="G-VARIANT-TYPE-OBJECT-PATH-ARRAY:CAPS">'ao'</link> or <link linkend="G-VARIANT-TYPE-BYTESTRING-ARRAY:CAPS">'aay'</link></entry> +</row> +<row> +<entry>#G_TYPE_BOOLEAN</entry> +<entry><link linkend="G-VARIANT-TYPE-BOOLEAN:CAPS">'b'</link></entry> +</row> +<row> +<entry>#G_TYPE_UCHAR</entry> +<entry><link linkend="G-VARIANT-TYPE-BYTE:CAPS">'y'</link></entry> +</row> +<row> +<entry>#G_TYPE_INT</entry> +<entry><link linkend="G-VARIANT-TYPE-INT32:CAPS">'i'</link> or <link linkend="G-VARIANT-TYPE-INT16:CAPS">'n'</link></entry> +</row> +<row> +<entry>#G_TYPE_UINT</entry> +<entry><link linkend="G-VARIANT-TYPE-UINT32:CAPS">'u'</link> or <link linkend="G-VARIANT-TYPE-UINT16:CAPS">'q'</link></entry> +</row> +<row> +<entry>#G_TYPE_INT64</entry> +<entry><link linkend="G-VARIANT-TYPE-INT64:CAPS">'x'</link></entry> +</row> +<row> +<entry>#G_TYPE_UINT64</entry> +<entry><link linkend="G-VARIANT-TYPE-UINT64:CAPS">'t'</link></entry> +</row> +<row> +<entry>#G_TYPE_DOUBLE</entry> +<entry><link linkend="G-VARIANT-TYPE-DOUBLE:CAPS">'d'</link></entry> +</row> +<row> +<entry>#G_TYPE_VARIANT</entry> +<entry>Any #GVariantType</entry> +</row> +</tbody> +</tgroup> +</table> +This can fail if e.g. @gvalue is of type #G_TYPE_STRING and @type +is <link linkend="G-VARIANT-TYPE-INT32:CAPS">'i'</link>. It will +also fail for any #GType (including e.g. #G_TYPE_OBJECT and +#G_TYPE_BOXED derived-types) not in the table above. + +Note that if @gvalue is of type #G_TYPE_VARIANT and its value is +%NULL, the <emphasis>empty</emphasis> #GVariant instance (never +%NULL) for @type is returned (e.g. 0 for scalar types, the empty +string for string types, <literal>'/'</literal> for object path +types, the empty array for any array type and so on). + +See the g_dbus_gvariant_to_gvalue() function for how to convert a +#GVariant to a #GValue. + +Since: 2.30 + +</description> +<parameters> +<parameter name="gvalue"> +<parameter_description> A #GValue to convert to a #GVariant. +</parameter_description> +</parameter> +<parameter name="type"> +<parameter_description> A #GVariantType. +</parameter_description> +</parameter> +</parameters> +<return> A #GVariant (never floating) of #GVariantType +@type holding the data from @gvalue or %NULL in case of +failure. Free with g_variant_unref(). + +</return> +</function> + +<function name="g_dbus_gvariant_to_gvalue"> +<description> +Converts a #GVariant to a #GValue. If @value is floating, it is consumed. + +The rules specified in the g_dbus_gvalue_to_gvariant() function are +used - this function is essentially its reverse form. + +The conversion never fails - a valid #GValue is always returned in +@out_gvalue. + +Since: 2.30 + +</description> +<parameters> +<parameter name="value"> +<parameter_description> A #GVariant. +</parameter_description> +</parameter> +<parameter name="out_gvalue"> +<parameter_description> Return location pointing to a zero-filled (uninitialized) #GValue. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_interface_dup_object"> +<description> +Gets the #GDBusObject that @interface_ belongs to, if any. + +Since: 2.32 + + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> An exported D-Bus interface. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusObject or %NULL. The returned +reference should be freed with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_interface_get_info"> +<description> +Gets D-Bus introspection information for the D-Bus interface +implemented by @interface_. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> An exported D-Bus interface. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. + +</return> +</function> + +<function name="g_dbus_interface_get_object"> +<description> +Gets the #GDBusObject that @interface_ belongs to, if any. + +<warning>It is not safe to use the returned object if @interface_ +or the returned object is being used from other threads. See +g_dbus_interface_dup_object() for a thread-safe +alternative.</warning> + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> An exported D-Bus interface. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusObject or %NULL. The returned +reference belongs to @interface_ and should not be freed. + +</return> +</function> + +<function name="g_dbus_interface_info_cache_build"> +<description> +Builds a lookup-cache to speed up +g_dbus_interface_info_lookup_method(), +g_dbus_interface_info_lookup_signal() and +g_dbus_interface_info_lookup_property(). + +If this has already been called with @info, the existing cache is +used and its use count is increased. + +Note that @info cannot be modified until +g_dbus_interface_info_cache_release() is called. + +Since: 2.30 + +</description> +<parameters> +<parameter name="info"> +<parameter_description> A #GDBusInterfaceInfo. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_interface_info_cache_release"> +<description> +Decrements the usage count for the cache for @info built by +g_dbus_interface_info_cache_build() (if any) and frees the +resources used by the cache if the usage count drops to zero. + +Since: 2.30 + +</description> +<parameters> +<parameter name="info"> +<parameter_description> A GDBusInterfaceInfo +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_dbus_interface_info_generate_xml"> <description> Appends an XML representation of @info (and its children) to @string_builder. @@ -7506,7 +24861,8 @@ Since: 2.26 <description> Looks up information about a method. -This cost of this function is O(n) in number of methods. +This cost of this function is O(n) in number of methods unless +g_dbus_interface_info_cache_build() has been used on @info. Since: 2.26 @@ -7530,7 +24886,8 @@ Since: 2.26 <description> Looks up information about a property. -This cost of this function is O(n) in number of properties. +This cost of this function is O(n) in number of properties unless +g_dbus_interface_info_cache_build() has been used on @info. Since: 2.26 @@ -7554,7 +24911,8 @@ Since: 2.26 <description> Looks up information about a signal. -This cost of this function is O(n) in number of signals. +This cost of this function is O(n) in number of signals unless +g_dbus_interface_info_cache_build() has been used on @info. Since: 2.26 @@ -7611,6 +24969,307 @@ Since: 2.26 <return></return> </function> +<function name="g_dbus_interface_set_object"> +<description> +Sets the #GDBusObject for @interface_ to @object. + +Note that @interface_ will hold a weak reference to @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> An exported D-Bus interface. +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> A #GDBusObject or %NULL. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_interface_skeleton_export"> +<description> +Exports @interface_ at @object_path on @connection. + +This can be called multiple times to export the same @interface_ +onto multiple connections however the @object_path provided must be +the same for all connections. + +Use g_dbus_interface_skeleton_unexport() to unexport the object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> The D-Bus interface to export. +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> A #GDBusConnection to export @interface_ on. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> The path to export the interface at. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the interface was exported on @connection, otherwise %FALSE with +@error set. + +</return> +</function> + +<function name="g_dbus_interface_skeleton_flush"> +<description> +If @interface_ has outstanding changes, request for these changes to be +emitted immediately. + +For example, an exported D-Bus interface may queue up property +changes and emit the +<literal>org.freedesktop.DBus.Properties::PropertiesChanged</literal> +signal later (e.g. in an idle handler). This technique is useful +for collapsing multiple property changes into one. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_interface_skeleton_get_connection"> +<description> +Gets the first connection that @interface_ is exported on, if any. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusConnection or %NULL if @interface_ is +not exported anywhere. Do not free, the object belongs to @interface_. + +</return> +</function> + +<function name="g_dbus_interface_skeleton_get_connections"> +<description> +Gets a list of the connections that @interface_ is exported on. + +Since: 2.32 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return> A list of +all the connections that @interface_ is exported on. The returned +list should be freed with g_list_free() after each element has +been freed with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_interface_skeleton_get_flags"> +<description> +Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior +of @interface_ + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return> One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. + +</return> +</function> + +<function name="g_dbus_interface_skeleton_get_info"> +<description> +Gets D-Bus introspection information for the D-Bus interface +implemented by @interface_. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusInterfaceInfo (never %NULL). Do not free. + +</return> +</function> + +<function name="g_dbus_interface_skeleton_get_object_path"> +<description> +Gets the object path that @interface_ is exported on, if any. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return> A string owned by @interface_ or %NULL if @interface_ is not exported +anywhere. Do not free, the string belongs to @interface_. + +</return> +</function> + +<function name="g_dbus_interface_skeleton_get_properties"> +<description> +Gets all D-Bus properties for @interface_. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return> A #GVariant of type <link linkend="G-VARIANT-TYPE-VARDICT:CAPS">'a{sv}'</link>. Free with g_variant_unref(). + +</return> +</function> + +<function name="g_dbus_interface_skeleton_get_vtable"> +<description> +Gets the interface vtable for the D-Bus interface implemented by +@interface_. The returned function pointers should expect @interface_ +itself to be passed as @user_data. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusInterfaceVTable (never %NULL). + +</return> +</function> + +<function name="g_dbus_interface_skeleton_has_connection"> +<description> +Checks if @interface_ is export on @connection. + +Since: 2.32 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @interface_ is exported on @connection, %FALSE otherwise. + +</return> +</function> + +<function name="g_dbus_interface_skeleton_set_flags"> +<description> +Sets flags describing what the behavior of @skeleton should be. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusInterfaceSkeletonFlags enumeration. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_interface_skeleton_unexport"> +<description> +Stops exporting @interface_ on all connections it is exported on. + +To unexport @interface_ from only a single connection, use +g_dbus_interface_skeleton_export_from_connection() + +Since: 2.30 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_interface_skeleton_unexport_from_connection"> +<description> +Stops exporting @interface_ on @connection. + +To stop exporting on all connections the interface is exported on, +use g_dbus_interface_skeleton_unexport(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_dbus_is_address"> <description> Checks if @string is a D-Bus address. @@ -7751,6 +25410,40 @@ Since: 2.26 </return> </function> +<function name="g_dbus_menu_model_get"> +<description> +Obtains a #GDBusMenuModel for the menu model which is exported +at the given @bus_name and @object_path. + +The thread default main context is taken at the time of this call. +All signals on the menu model (and any linked models) are reported +with respect to this context. All calls on the returned menu model +(and linked models) must also originate from this same context, with +the thread default main context unchanged. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GDBusConnection +</parameter_description> +</parameter> +<parameter name="bus_name"> +<parameter_description> the bus name which exports the menu model +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> the object path at which the menu model is exported +</parameter_description> +</parameter> +</parameters> +<return> a #GDBusMenuModel object. Free with +g_object_unref(). + +</return> +</function> + <function name="g_dbus_message_bytes_needed"> <description> Utility function to calculate how many bytes are needed to @@ -7802,8 +25495,8 @@ Since: 2.26 </parameter_description> </parameter> </parameters> -<return> A new #GDBusMessage or %NULL if @error is set. Free with -g_object_unref(). +<return> A new #GDBusMessage or %NULL if @error is set. +Free with g_object_unref(). </return> </function> @@ -7951,9 +25644,9 @@ Since: 2.26 </parameter_description> </parameter> </parameters> -<return> An array of header fields terminated by -%G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a -#guchar. Free with g_free(). +<return> An array of header fields +terminated by %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element +is a #guchar. Free with g_free(). </return> </function> @@ -8803,8 +26496,9 @@ Since: 2.26 </parameter_description> </parameter> </parameters> -<return> A pointer to a valid binary D-Bus message of @out_size bytes -generated by @message or %NULL if @error is set. Free with g_free(). +<return> A pointer to a +valid binary D-Bus message of @out_size bytes generated by @message +or %NULL if @error is set. Free with g_free(). </return> </function> @@ -8991,7 +26685,8 @@ Since: 2.26 <function name="g_dbus_method_invocation_get_parameters"> <description> -Gets the parameters of the method invocation. +Gets the parameters of the method invocation. If there are no input +parameters then this will return a GVariant with 0 children rather than NULL. Since: 2.26 @@ -9002,7 +26697,7 @@ Since: 2.26 </parameter_description> </parameter> </parameters> -<return> A #GVariant. Do not free, it is owned by @invocation. +<return> A #GVariant tuple. Do not unref this because it is owned by @invocation. </return> </function> @@ -9228,6 +26923,57 @@ Since: 2.26 <return></return> </function> +<function name="g_dbus_method_invocation_return_value_with_unix_fd_list"> +<description> +Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList. + +This method is only available on UNIX. + +This method will free @invocation, you cannot use it afterwards. + +Since: 2.30 + +</description> +<parameters> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="parameters"> +<parameter_description> A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_method_invocation_take_error"> +<description> +Like g_dbus_method_invocation_return_gerror() but takes ownership +of @error so the caller does not need to free it. + +This method will free @invocation, you cannot use it afterwards. + +Since: 2.30 + +</description> +<parameters> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> A #GError. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_dbus_node_info_generate_xml"> <description> Appends an XML representation of @info (and its children) to @string_builder. @@ -9283,6 +27029,10 @@ Since: 2.26 <description> Parses @xml_data and returns a #GDBusNodeInfo representing the data. +Note that this routine is using a +<link linkend="glib-Simple-XML-Subset-Parser.description">GMarkup</link>-based +parser that only accepts a subset of valid XML documents. + Since: 2.26 </description> @@ -9339,6 +27089,826 @@ Since: 2.26 <return></return> </function> +<function name="g_dbus_object_get_interface"> +<description> +Gets the D-Bus interface with name @interface_name associated with +@object, if any. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObject. +</parameter_description> +</parameter> +<parameter name="interface_name"> +<parameter_description> A D-Bus interface name. +</parameter_description> +</parameter> +</parameters> +<return> %NULL if not found, otherwise a +#GDBusInterface that must be freed with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_get_interfaces"> +<description> +Gets the D-Bus interfaces associated with @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObject. +</parameter_description> +</parameter> +</parameters> +<return> A list of #GDBusInterface instances. +The returned list must be freed by g_list_free() after each element has been freed +with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_get_object_path"> +<description> +Gets the object path for @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObject. +</parameter_description> +</parameter> +</parameters> +<return> A string owned by @object. Do not free. + +</return> +</function> + +<function name="g_dbus_object_manager_client_get_connection"> +<description> +Gets the #GDBusConnection used by @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerClient +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusConnection object. Do not free, +the object belongs to @manager. + +</return> +</function> + +<function name="g_dbus_object_manager_client_get_flags"> +<description> +Gets the flags that @manager was constructed with. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerClient +</parameter_description> +</parameter> +</parameters> +<return> Zero of more flags from the #GDBusObjectManagerClientFlags +enumeration. + +</return> +</function> + +<function name="g_dbus_object_manager_client_get_name"> +<description> +Gets the name that @manager is for. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerClient +</parameter_description> +</parameter> +</parameters> +<return> A unique or well-known name. Do not free, the string +belongs to @manager. + +</return> +</function> + +<function name="g_dbus_object_manager_client_get_name_owner"> +<description> +The unique name that owns the name that @manager is for or %NULL if +no-one currently owns that name. You can connect to the +#GObject::notify signal to track changes to the +#GDBusObjectManagerClient:name-owner property. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerClient. +</parameter_description> +</parameter> +</parameters> +<return> The name owner or %NULL if no name owner exists. Free with +g_free(). + +</return> +</function> + +<function name="g_dbus_object_manager_client_new"> +<description> +Asynchronously creates a new #GDBusObjectManagerClient object. + +This is an asynchronous failable constructor. When the result is +ready, @callback will be invoked in the +<link linkend="g-main-context-push-thread-default">thread-default main loop</link> +of the thread you are calling this method from. You can +then call g_dbus_object_manager_client_new_finish() to get the result. See +g_dbus_object_manager_client_new_sync() for the synchronous version. + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> The owner of the control object (unique or well-known name). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> The object path of the control object. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_func"> +<parameter_description> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_user_data"> +<parameter_description> User data to pass to @get_proxy_type_func. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_destroy_notify"> +<parameter_description> Free function for @get_proxy_type_user_data or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> The data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_manager_client_new_finish"> +<description> +Finishes an operation started with g_dbus_object_manager_client_new(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> A +#GDBusObjectManagerClient object or %NULL if @error is set. Free +with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_client_new_for_bus"> +<description> +Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a +#GDBusConnection. + +This is an asynchronous failable constructor. When the result is +ready, @callback will be invoked in the +<link linkend="g-main-context-push-thread-default">thread-default main loop</link> +of the thread you are calling this method from. You can +then call g_dbus_object_manager_client_new_for_bus_finish() to get the result. See +g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. + +Since: 2.30 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> The owner of the control object (unique or well-known name). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> The object path of the control object. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_func"> +<parameter_description> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_user_data"> +<parameter_description> User data to pass to @get_proxy_type_func. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_destroy_notify"> +<parameter_description> Free function for @get_proxy_type_user_data or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> The data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_manager_client_new_for_bus_finish"> +<description> +Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="res"> +<parameter_description> A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> A +#GDBusObjectManagerClient object or %NULL if @error is set. Free +with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_client_new_for_bus_sync"> +<description> +Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead +of a #GDBusConnection. + +This is a synchronous failable constructor - the calling thread is +blocked until a reply is received. See g_dbus_object_manager_client_new_for_bus() +for the asynchronous version. + +Since: 2.30 + +</description> +<parameters> +<parameter name="bus_type"> +<parameter_description> A #GBusType. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> The owner of the control object (unique or well-known name). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> The object path of the control object. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_func"> +<parameter_description> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_user_data"> +<parameter_description> User data to pass to @get_proxy_type_func. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_destroy_notify"> +<parameter_description> Free function for @get_proxy_type_user_data or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> A +#GDBusObjectManagerClient object or %NULL if @error is set. Free +with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_client_new_sync"> +<description> +Creates a new #GDBusObjectManagerClient object. + +This is a synchronous failable constructor - the calling thread is +blocked until a reply is received. See g_dbus_object_manager_client_new() +for the asynchronous version. + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GDBusConnection. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. +</parameter_description> +</parameter> +<parameter name="name"> +<parameter_description> The owner of the control object (unique or well-known name). +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> The object path of the control object. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_func"> +<parameter_description> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_user_data"> +<parameter_description> User data to pass to @get_proxy_type_func. +</parameter_description> +</parameter> +<parameter name="get_proxy_type_destroy_notify"> +<parameter_description> Free function for @get_proxy_type_user_data or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> A +#GDBusObjectManagerClient object or %NULL if @error is set. Free +with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_get_interface"> +<description> +Gets the interface proxy for @interface_name at @object_path, if +any. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManager. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> Object path to lookup. +</parameter_description> +</parameter> +<parameter name="interface_name"> +<parameter_description> D-Bus interface name to lookup. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusInterface instance or %NULL. Free +with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_get_object"> +<description> +Gets the #GDBusObjectProxy at @object_path, if any. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManager. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> Object path to lookup. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusObject or %NULL. Free with +g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_get_object_path"> +<description> +Gets the object path that @manager is for. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManager. +</parameter_description> +</parameter> +</parameters> +<return> A string owned by @manager. Do not free. + +</return> +</function> + +<function name="g_dbus_object_manager_get_objects"> +<description> +Gets all #GDBusObject objects known to @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManager. +</parameter_description> +</parameter> +</parameters> +<return> A list of +#GDBusObject objects. The returned list should be freed with +g_list_free() after each element has been freed with +g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_server_export"> +<description> +Exports @object on @manager. + +If there is already a #GDBusObject exported at the object path, +then the old object is removed. + +The object path for @object must be in the hierarchy rooted by the +object path for @manager. + +Note that @manager will take a reference on @object for as long as +it is exported. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerServer. +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> A #GDBusObjectSkeleton. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_manager_server_export_uniquely"> +<description> +Like g_dbus_object_manager_server_export() but appends a string of +the form <literal>_N</literal> (with N being a natural number) to +@object<!-- -->'s object path if an object with the given path +already exists. As such, the #GDBusObjectProxy:g-object-path property +of @object may be modified. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerServer. +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> An object. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_manager_server_get_connection"> +<description> +Gets the #GDBusConnection used by @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerServer +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusConnection object or %NULL if +@manager isn't exported on a connection. The returned object should +be freed with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_server_new"> +<description> +Creates a new #GDBusObjectManagerServer object. + +The returned server isn't yet exported on any connection. To do so, +use g_dbus_object_manager_server_set_connection(). Normally you +want to export all of your objects before doing so to avoid <ulink +url="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager">InterfacesAdded</ulink> +signals being emitted. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object_path"> +<parameter_description> The object path to export the manager object at. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusObjectManagerServer object. Free with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_manager_server_set_connection"> +<description> +Exports all objects managed by @manager on @connection. If +@connection is %NULL, stops exporting objects. + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerServer. +</parameter_description> +</parameter> +<parameter name="connection"> +<parameter_description> A #GDBusConnection or %NULL. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_manager_server_unexport"> +<description> +If @manager has an object at @path, removes the object. Otherwise +does nothing. + +Note that @object_path must be in the hierarchy rooted by the +object path for @manager. + +Since: 2.30 + +</description> +<parameters> +<parameter name="manager"> +<parameter_description> A #GDBusObjectManagerServer. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if object at @object_path was removed, %FALSE otherwise. + +</return> +</function> + +<function name="g_dbus_object_proxy_get_connection"> +<description> +Gets the connection that @proxy is for. + +Since: 2.30 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> a #GDBusObjectProxy +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusConnection. Do not free, the +object is owned by @proxy. + +</return> +</function> + +<function name="g_dbus_object_proxy_new"> +<description> +Creates a new #GDBusObjectProxy for the given connection and +object path. + +Since: 2.30 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GDBusConnection +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> the object path +</parameter_description> +</parameter> +</parameters> +<return> a new #GDBusObjectProxy + +</return> +</function> + +<function name="g_dbus_object_skeleton_add_interface"> +<description> +Adds @interface_ to @object. + +If @object already contains a #GDBusInterfaceSkeleton with the same +interface name, it is removed before @interface_ is added. + +Note that @object takes its own reference on @interface_ and holds +it until removed. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_skeleton_flush"> +<description> +This method simply calls g_dbus_interface_skeleton_flush() on all +interfaces belonging to @object. See that method for when flushing +is useful. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObjectSkeleton. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_skeleton_new"> +<description> +Creates a new #GDBusObjectSkeleton. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object_path"> +<parameter_description> An object path. +</parameter_description> +</parameter> +</parameters> +<return> A #GDBusObjectSkeleton. Free with g_object_unref(). + +</return> +</function> + +<function name="g_dbus_object_skeleton_remove_interface"> +<description> +Removes @interface_ from @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_"> +<parameter_description> A #GDBusInterfaceSkeleton. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_skeleton_remove_interface_by_name"> +<description> +Removes the #GDBusInterface with @interface_name from @object. + +If no D-Bus interface of the given interface exists, this function +does nothing. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="interface_name"> +<parameter_description> A D-Bus interface name. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_object_skeleton_set_object_path"> +<description> +Sets the object path for @object. + +Since: 2.30 + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GDBusObjectSkeleton. +</parameter_description> +</parameter> +<parameter name="object_path"> +<parameter_description> A valid D-Bus object path. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_dbus_property_info_ref"> <description> If @info is statically allocated does nothing. Otherwise increases @@ -9406,10 +27976,14 @@ NULL, &data); ]| +If @proxy has an expected interface (see +#GDBusProxy:g-interface-info) and @method_name is referenced by it, +then the return value is checked against the return type. + This is an asynchronous method. When the operation is finished, @callback will be invoked in the -<link linkend="g-main-context-push-thread-default">thread-default -main loop</link> of the thread you are calling this method from. +<link linkend="g-main-context-push-thread-default">thread-default main loop</link> +of the thread you are calling this method from. You can then call g_dbus_proxy_call_finish() to get the result of the operation. See g_dbus_proxy_call_sync() for the synchronous version of this method. @@ -9516,6 +28090,10 @@ The calling thread is blocked until a reply is received. See g_dbus_proxy_call() for the asynchronous version of this method. +If @proxy has an expected interface (see +#GDBusProxy:g-interface-info) and @method_name is referenced by it, +then the return value is checked against the return type. + Since: 2.26 </description> @@ -9529,6 +28107,53 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="parameters"> +<parameter_description> A #GVariant tuple with parameters for the signal +or %NULL if not passing parameters. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusCallFlags enumeration. +</parameter_description> +</parameter> +<parameter name="timeout_msec"> +<parameter_description> The timeout in milliseconds (with %G_MAXINT meaning +"infinite") or -1 to use the proxy default timeout. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %NULL if @error is set. Otherwise a #GVariant tuple with +return values. Free with g_variant_unref(). + +</return> +</function> + +<function name="g_dbus_proxy_call_with_unix_fd_list"> +<description> +Like g_dbus_proxy_call() but also takes a #GUnixFDList object. + +This method is only available on UNIX. + +Since: 2.30 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GDBusProxy. +</parameter_description> +</parameter> +<parameter name="method_name"> +<parameter_description> Name of method to invoke. +</parameter_description> +</parameter> +<parameter name="parameters"> <parameter_description> A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. </parameter_description> </parameter> @@ -9541,6 +28166,98 @@ Since: 2.26 "infinite") or -1 to use the proxy default timeout. </parameter_description> </parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> A #GCancellable or %NULL. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't +care about the result of the method invocation. +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> The data to pass to @callback. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_dbus_proxy_call_with_unix_fd_list_finish"> +<description> +Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GDBusProxy. +</parameter_description> +</parameter> +<parameter name="out_fd_list"> +<parameter_description> Return location for a #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list(). +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> Return location for error or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %NULL if @error is set. Otherwise a #GVariant tuple with +return values. Free with g_variant_unref(). + +</return> +</function> + +<function name="g_dbus_proxy_call_with_unix_fd_list_sync"> +<description> +Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects. + +This method is only available on UNIX. + +Since: 2.30 + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GDBusProxy. +</parameter_description> +</parameter> +<parameter name="method_name"> +<parameter_description> Name of method to invoke. +</parameter_description> +</parameter> +<parameter name="parameters"> +<parameter_description> A #GVariant tuple with parameters for the signal +or %NULL if not passing parameters. +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags from the #GDBusCallFlags enumeration. +</parameter_description> +</parameter> +<parameter name="timeout_msec"> +<parameter_description> The timeout in milliseconds (with %G_MAXINT meaning +"infinite") or -1 to use the proxy default timeout. +</parameter_description> +</parameter> +<parameter name="fd_list"> +<parameter_description> A #GUnixFDList or %NULL. +</parameter_description> +</parameter> +<parameter name="out_fd_list"> +<parameter_description> Return location for a #GUnixFDList or %NULL. +</parameter_description> +</parameter> <parameter name="cancellable"> <parameter_description> A #GCancellable or %NULL. </parameter_description> @@ -9562,8 +28279,8 @@ Looks up the value for a property from the cache. This call does no blocking IO. If @proxy has an expected interface (see -#GDBusProxy:g-interface-info), then @property_name (for existence) -is checked against it. +#GDBusProxy:g-interface-info) and @property_name is referenced by +it, then @value is checked against the type of the property. Since: 2.26 @@ -9598,8 +28315,9 @@ Since: 2.26 </parameter_description> </parameter> </parameters> -<return> A %NULL-terminated array of strings or %NULL if @proxy has -no cached properties. Free the returned array with g_strfreev(). +<return> A %NULL-terminated array of strings or %NULL if +@proxy has no cached properties. Free the returned array with +g_strfreev(). </return> </function> @@ -9664,10 +28382,9 @@ Since: 2.26 <function name="g_dbus_proxy_get_interface_info"> <description> -Returns the #GDBusInterfaceInfo, if any, specifying the minimal -interface that @proxy conforms to. - -See the #GDBusProxy:g-interface-info property for more details. +Returns the #GDBusInterfaceInfo, if any, specifying the interface +that @proxy conforms to. See the #GDBusProxy:g-interface-info +property for more details. Since: 2.26 @@ -9942,7 +28659,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="info"> -<parameter_description> A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. +<parameter_description> A #GDBusInterfaceInfo specifying the minimal interface +that @proxy conforms to or %NULL. </parameter_description> </parameter> <parameter name="name"> @@ -10043,8 +28761,8 @@ If @value is %NULL, then the cached value is removed from the property cache. If @proxy has an expected interface (see -#GDBusProxy:g-interface-info), then @property_name (for existence) -and @value (for the type) is checked against it. +#GDBusProxy:g-interface-info) and @property_name is referenced by +it, then @value is checked against the type of the property. If the @value #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g. @@ -10118,12 +28836,8 @@ Since: 2.26 <function name="g_dbus_proxy_set_interface_info"> <description> Ensure that interactions with @proxy conform to the given -interface. For example, when completing a method call, if the type -signature of the message isn't what's expected, the given #GError -is set. Signals that have a type signature mismatch are simply -dropped. - -See the #GDBusProxy:g-interface-info property for more details. +interface. See the #GDBusProxy:g-interface-info property for more +details. Since: 2.26 @@ -10339,6 +29053,23 @@ Since: 2.26 <return></return> </function> +<function name="g_desktop_app_info_get_categories"> +<description> +Gets the categories from the desktop file. + + +</description> +<parameters> +<parameter name="info"> +<parameter_description> a #GDesktopAppInfo +</parameter_description> +</parameter> +</parameters> +<return> The unparsed Categories key from the desktop file; +i.e. no attempt is made to split it by ';' or validate it. +</return> +</function> + <function name="g_desktop_app_info_get_filename"> <description> When @info was created from a known filename, return it. In some @@ -10358,6 +29089,22 @@ Since: 2.24 </return> </function> +<function name="g_desktop_app_info_get_generic_name"> +<description> +Gets the generic name from the destkop file. + + +</description> +<parameters> +<parameter name="info"> +<parameter_description> a #GDesktopAppInfo +</parameter_description> +</parameter> +</parameters> +<return> The value of the GenericName key +</return> +</function> + <function name="g_desktop_app_info_get_is_hidden"> <description> A desktop file is hidden if the Hidden key in it is @@ -10375,6 +29122,76 @@ set to True. </return> </function> +<function name="g_desktop_app_info_get_keywords"> +<description> +Gets the keywords from the desktop file. + +Since: 2.32 + +</description> +<parameters> +<parameter name="info"> +<parameter_description> a #GDesktopAppInfo +</parameter_description> +</parameter> +</parameters> +<return> The value of the Keywords key + +</return> +</function> + +<function name="g_desktop_app_info_get_nodisplay"> +<description> +Gets the value of the NoDisplay key, which helps determine if the +application info should be shown in menus. See +#G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY and g_app_info_should_show(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="info"> +<parameter_description> a #GDesktopAppInfo +</parameter_description> +</parameter> +</parameters> +<return> The value of the NoDisplay key + +</return> +</function> + +<function name="g_desktop_app_info_get_show_in"> +<description> +Checks if the application info should be shown in menus that list available +applications for a specific name of the desktop, based on the +<literal>OnlyShowIn</literal> and <literal>NotShowIn</literal> keys. + +If @desktop_env is %NULL, then the name of the desktop set with +g_desktop_app_info_set_desktop_env() is used. + +Note that g_app_info_should_show() for @info will include this check (with +%NULL for @desktop_env) as well as additional checks. + +Since: 2.30 + +</description> +<parameters> +<parameter name="info"> +<parameter_description> a #GDesktopAppInfo +</parameter_description> +</parameter> +<parameter name="desktop_env"> +<parameter_description> a string specifying a desktop name +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the @info should be shown in @desktop_env according to the +<literal>OnlyShowIn</literal> and <literal>NotShowIn</literal> keys, %FALSE +otherwise. + +</return> +</function> + <function name="g_desktop_app_info_launch_uris_as_manager"> <description> This function performs the equivalent of g_app_info_launch_uris(), @@ -10388,9 +29205,10 @@ calls. This guarantee allows additional control over the exact environment of the child processes, which is provided via a setup function -@setup, as well as the process identifier of each child process via -@pid_callback. See g_spawn_async() for more information about the -semantics of the @setup function. +@user_setup, as well as the process identifier of each child process +via @pid_callback. See g_spawn_async() for more information about the +semantics of the @user_setup function. + </description> <parameters> @@ -10428,11 +29246,12 @@ each process. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError +<parameter_description> return location for a #GError, or %NULL </parameter_description> </parameter> </parameters> -<return></return> +<return> %TRUE on successful launch, %FALSE otherwise. +</return> </function> <function name="g_desktop_app_info_lookup_get_default_for_uri_scheme"> @@ -10527,18 +29346,21 @@ Since: 2.18 <function name="g_desktop_app_info_set_desktop_env"> <description> Sets the name of the desktop that the application is running in. -This is used by g_app_info_should_show() to evaluate the +This is used by g_app_info_should_show() and +g_desktop_app_info_get_show_in() to evaluate the <literal>OnlyShowIn</literal> and <literal>NotShowIn</literal> desktop entry fields. -The <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Desktop +The <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Desktop Menu specification</ulink> recognizes the following: <simplelist> <member>GNOME</member> <member>KDE</member> <member>ROX</member> <member>XFCE</member> -<member>Old</member> +<member>LXDE</member> +<member>Unity</member> +<member>Old</member> </simplelist> Should be called only once; subsequent calls are ignored. @@ -10760,7 +29582,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -10846,6 +29668,24 @@ string should be freed when no longer needed. </return> </function> +<function name="g_drive_get_sort_key"> +<description> +Gets the sort key for @drive, if any. + +Since: 2.32 + +</description> +<parameters> +<parameter name="drive"> +<parameter_description> A #GDrive. +</parameter_description> +</parameter> +</parameters> +<return> Sorting key for @drive or %NULL if no such key is available. + +</return> +</function> + <function name="g_drive_get_start_stop_type"> <description> Gets a hint about how a drive can be started/stopped. @@ -11673,6 +30513,56 @@ References a file attribute matcher. </return> </function> +<function name="g_file_attribute_matcher_subtract"> +<description> +Subtracts all attributes of @subtract from @matcher and returns +a matcher that supports those attributes. + +Note that currently it is not possible to remove a single +attribute when the @matcher matches the whole namespace - or remove +a namespace or attribute when the matcher matches everything. This +is a limitation of the current implementation, but may be fixed +in the future. + + +</description> +<parameters> +<parameter name="matcher"> +<parameter_description> Matcher to subtract from +</parameter_description> +</parameter> +<parameter name="subtract"> +<parameter_description> The matcher to subtract +</parameter_description> +</parameter> +</parameters> +<return> A file attribute matcher matching all attributes of +@matcher that are not matched by @subtract +</return> +</function> + +<function name="g_file_attribute_matcher_to_string"> +<description> +Prints what the matcher is matching against. The format will be +equal to the format passed to g_file_attribute_matcher_new(). +The output however, might not be identical, as the matcher may +decide to use a different order or omit needless parts. + +Since: 2.32 + +</description> +<parameters> +<parameter name="matcher"> +<parameter_description> a #GFileAttributeMatcher. +</parameter_description> +</parameter> +</parameters> +<return> a string describing the attributes the matcher matches +against or %NULL if @matcher was %NULL. + +</return> +</function> + <function name="g_file_attribute_matcher_unref"> <description> Unreferences @matcher. If the reference count falls below 1, @@ -11703,7 +30593,7 @@ will be copied as symlinks, otherwise the target of the If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation -was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. +was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If @progress_callback is not %NULL, then the operation can be monitored by setting this to a #GFileProgressCallback function. @progress_callback_data @@ -11721,9 +30611,9 @@ If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY error is returned. If trying to overwrite a directory with a directory the G_IO_ERROR_WOULD_MERGE error is returned. -If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is -specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error -is returned. +If the source is a directory and the target does not exist, or +#G_FILE_COPY_OVERWRITE is specified and the target is a file, then the +G_IO_ERROR_WOULD_RECURSE error is returned. If you are interested in copying the #GFile object itself (not the on-disk file), see g_file_dup(). @@ -11744,11 +30634,12 @@ file), see g_file_dup(). </parameter_description> </parameter> <parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter_description> optional #GCancellable object, %NULL to ignore </parameter_description> </parameter> <parameter name="progress_callback"> -<parameter_description> function to callback with progress information +<parameter_description> function to callback with +progress information, or %NULL if progress information is not needed </parameter_description> </parameter> <parameter name="progress_callback_data"> @@ -11766,7 +30657,7 @@ file), see g_file_dup(). <function name="g_file_copy_async"> <description> -Copies the file @source to the location specified by @destination +Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called @@ -11791,16 +30682,17 @@ g_file_copy_finish() to get the result of the operation. </parameter_description> </parameter> <parameter name="io_priority"> -<parameter_description> the <link linkend="io-priority">I/O priority</link> -of the request. +<parameter_description> the <link linkend="io-priority">I/O priority</link> +of the request </parameter_description> </parameter> <parameter name="cancellable"> -<parameter_description> optional #GCancellable object, %NULL to ignore. +<parameter_description> optional #GCancellable object, %NULL to ignore </parameter_description> </parameter> <parameter name="progress_callback"> -<parameter_description> function to callback with progress information +<parameter_description> function to callback with progress +information, or %NULL if progress information is not needed </parameter_description> </parameter> <parameter name="progress_callback_data"> @@ -12474,7 +31366,7 @@ sure resources are released as early as possible. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -12543,7 +31435,7 @@ returned. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -12625,7 +31517,7 @@ be unset. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -12700,7 +31592,7 @@ Finishes the asynchronous operation started with g_file_enumerator_next_files_as </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -13110,7 +32002,7 @@ case that @parent is %NULL). <function name="g_file_has_prefix"> <description> Checks whether @file has the prefix specified by @prefix. In other word, -if the names of inital elements of @file<!-- -->s pathname match @prefix. +if the names of initial elements of @file<!-- -->s pathname match @prefix. Only full pathname elements are matched, so a path like /foo is not considered a prefix of /foobar, only of /foo/bar. @@ -13211,7 +32103,8 @@ Creates a new icon for a file. </parameter_description> </parameter> </parameters> -<return> a #GIcon for the given @file, or %NULL on error. +<return> a #GIcon for the given +@file, or %NULL on error. </return> </function> @@ -14185,7 +33078,7 @@ See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. </parameter_description> </parameter> <parameter name="content_type"> -<parameter_description> a content type. See #GContentType. +<parameter_description> a content type. See <link linkend="gio-GContentType">GContentType</link>. </parameter_description> </parameter> </parameters> @@ -14440,7 +33333,7 @@ any other operations on the stream will fail with %G_IO_ERROR_PENDING. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -14511,7 +33404,7 @@ Finishes an asynchronous info query operation. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -14933,7 +33826,9 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <description> Creates a directory and any parent directories that may not exist similar to 'mkdir -p'. If the file system does not support creating directories, this -function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. +function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the +directory itself already exists, this function will fail setting @error +to %G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents(). For a local #GFile the newly created directories will have the default (current) ownership and permissions of the current process. @@ -15416,7 +34311,8 @@ I/O operation if @arg points to a malformed path. </parameter_description> </parameter> </parameters> -<return> a new #GFile. +<return> a new #GFile. +Free the returned object with g_object_unref(). </return> </function> @@ -15435,7 +34331,8 @@ must be encoded in the glib filename encoding. </parameter_description> </parameter> </parameters> -<return> a new #GFile for the given @path. +<return> a new #GFile for the given @path. +Free the returned object with g_object_unref(). </return> </function> @@ -15454,7 +34351,45 @@ not supported. </parameter_description> </parameter> </parameters> -<return> a #GFile for the given @uri. +<return> a new #GFile for the given @uri. +Free the returned object with g_object_unref(). +</return> +</function> + +<function name="g_file_new_tmp"> +<description> +Opens a file in the preferred directory for temporary files (as +returned by g_get_tmp_dir()) and returns a #GFile and +#GFileIOStream pointing to it. + +@template should be a string in the GLib file name encoding +containing a sequence of six 'X' characters, and containing no +directory components. If it is %NULL, a default template is used. + +Unlike the other #GFile constructors, this will return %NULL if +a temporary file could not be created. + +Since: 2.32 + +</description> +<parameters> +<parameter name="tmpl"> +<parameter_description> Template for the file +name, as in g_file_open_tmp(), or %NULL for a default template. +</parameter_description> +</parameter> +<parameter name="iostream"> +<parameter_description> on return, a #GFileIOStream for the created file. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a new #GFile. +Free the returned object with g_object_unref(). + </return> </function> @@ -15888,8 +34823,8 @@ The @attributes value is a string that specifies the file attributes that should be gathered. It is not an error if it's not possible to read a particular requested attribute from a file - it just won't be set. @attributes should be a comma-separated list of attributes or attribute wildcards. The wildcard "*" -means all attributes, and a wildcard like "fs:*" means all attributes in the fs -namespace. The standard namespace for filesystem attributes is "fs". +means all attributes, and a wildcard like "filesystem::*" means all attributes in the +filesystem namespace. The standard namespace for filesystem attributes is "filesystem". Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem). @@ -16750,6 +35685,9 @@ Free the returned object with g_object_unref(). <description> Sets an attribute in the file with attribute name @attribute to @value. +Some attributes can be unset by setting @attribute to +%G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. + If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. @@ -17869,7 +36807,7 @@ If @icon is a #GFileIcon, the returned string is a native path (such as <literal>/path/to/my icon.png</literal>) without escaping if the #GFile for @icon is a native file. If the file is not native, the returned string is the result of g_file_get_uri() -(such as <literal>sftp://path/to/my%%20icon.png</literal>). +(such as <literal>sftp://path/to/my%20icon.png</literal>). </para></listitem> <listitem><para> If @icon is a #GThemedIcon with exactly one name, the encoding is @@ -17893,6 +36831,28 @@ be serialized. Use g_free() to free. </return> </function> +<function name="g_inet_address_equal"> +<description> +Checks if two #GInetAddress instances are equal, e.g. the same address. + +Since: 2.30 + +</description> +<parameters> +<parameter name="address"> +<parameter_description> A #GInetAddress. +</parameter_description> +</parameter> +<parameter name="other_address"> +<parameter_description> Another #GInetAddress. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @address and @other_address are equal, %FALSE otherwise. + +</return> +</function> + <function name="g_inet_address_get_family"> <description> Gets @address's family @@ -18115,6 +37075,176 @@ Since: 2.22 </return> </function> +<function name="g_inet_address_mask_equal"> +<description> +Tests if @mask and @mask2 are the same mask. + +Since: 2.32 + +</description> +<parameters> +<parameter name="mask"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +<parameter name="mask2"> +<parameter_description> another #GInetAddressMask +</parameter_description> +</parameter> +</parameters> +<return> whether @mask and @mask2 are the same mask + +</return> +</function> + +<function name="g_inet_address_mask_get_address"> +<description> +Gets @mask's base address + +Since: 2.32 + +</description> +<parameters> +<parameter name="mask"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +</parameters> +<return> @mask's base address + +</return> +</function> + +<function name="g_inet_address_mask_get_family"> +<description> +Gets the #GSocketFamily of @mask's address + +Since: 2.32 + +</description> +<parameters> +<parameter name="mask"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +</parameters> +<return> the #GSocketFamily of @mask's address + +</return> +</function> + +<function name="g_inet_address_mask_get_length"> +<description> +Gets @mask's length + +Since: 2.32 + +</description> +<parameters> +<parameter name="mask"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +</parameters> +<return> @mask's length + +</return> +</function> + +<function name="g_inet_address_mask_matches"> +<description> +Tests if @address falls within the range described by @mask. + +Since: 2.32 + +</description> +<parameters> +<parameter name="mask"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +<parameter name="address"> +<parameter_description> a #GInetAddress +</parameter_description> +</parameter> +</parameters> +<return> whether @address falls within the range described by +@mask. + +</return> +</function> + +<function name="g_inet_address_mask_new"> +<description> +Creates a new #GInetAddressMask representing all addresses whose +first @length bits match @addr. + +Since: 2.32 + +</description> +<parameters> +<parameter name="addr"> +<parameter_description> a #GInetAddress +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> number of bits of @addr to use +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a new #GInetAddressMask, or %NULL on error + +</return> +</function> + +<function name="g_inet_address_mask_new_from_string"> +<description> +Parses @mask_string as an IP address and (optional) length, and +creates a new #GInetAddressMask. The length, if present, is +delimited by a "/". If it is not present, then the length is +assumed to be the full length of the address. + +Since: 2.32 + +</description> +<parameters> +<parameter name="mask_string"> +<parameter_description> an IP address or address/length string +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a new #GInetAddressMask corresponding to @string, or %NULL +on error. + +</return> +</function> + +<function name="g_inet_address_mask_to_string"> +<description> +Converts @mask back to its corresponding string form. + +Since: 2.32 + +</description> +<parameters> +<parameter name="mask"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +</parameters> +<return> a string corresponding to @mask. + +</return> +</function> + <function name="g_inet_address_new_any"> <description> Creates a #GInetAddress for the "any" address (unassigned/"don't @@ -18138,8 +37268,8 @@ for @family. <function name="g_inet_address_new_from_bytes"> <description> Creates a new #GInetAddress from the given @family and @bytes. -@bytes should be 4 bytes for %G_INET_ADDRESS_IPV4 and 16 bytes for -%G_INET_ADDRESS_IPV6. +@bytes should be 4 bytes for %G_SOCKET_FAMILY_IPV4 and 16 bytes for +%G_SOCKET_FAMILY_IPV6. Since: 2.22 @@ -18255,6 +37385,25 @@ g_object_ref()'d if it will be stored </return> </function> +<function name="g_inet_socket_address_get_flowinfo"> +<description> +Gets the <literal>sin6_flowinfo</literal> field from @address, +which must be an IPv6 address. + +Since: 2.32 + +</description> +<parameters> +<parameter name="address"> +<parameter_description> a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress +</parameter_description> +</parameter> +</parameters> +<return> the flowinfo field + +</return> +</function> + <function name="g_inet_socket_address_get_port"> <description> Gets @address's port. @@ -18273,6 +37422,25 @@ Since: 2.22 </return> </function> +<function name="g_inet_socket_address_get_scope_id"> +<description> +Gets the <literal>sin6_scope_id</literal> field from @address, +which must be an IPv6 address. + +Since: 2.32 + +</description> +<parameters> +<parameter name="address"> +<parameter_description> a %G_SOCKET_FAMILY_IPV6 #GInetAddress +</parameter_description> +</parameter> +</parameters> +<return> the scope id field + +</return> +</function> + <function name="g_inet_socket_address_new"> <description> Creates a new #GInetSocketAddress for @address and @port. @@ -18297,8 +37465,10 @@ Since: 2.22 <function name="g_initable_init"> <description> -Initializes the object implementing the interface. This must be -done before any real use of the object after initial construction. +Initializes the object implementing the interface. + +The object must be initialized before any real use after initial +construction, either with this function or g_async_initable_init_async(). Implementations may also support cancellation. If @cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object @@ -18307,14 +37477,16 @@ from another thread. If the operation was cancelled, the error the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned. -If this function is not called, or returns with an error then all -operations on the object should fail, generally returning the -error %G_IO_ERROR_NOT_INITIALIZED. +If the object is not initialized, or initialization returns with an +error, then all operations on the object except g_object_ref() and +g_object_unref() are considered to be invalid, and have undefined +behaviour. See the <xref linkend="ginitable"/> section introduction +for more details. Implementations of this method must be idempotent, i.e. multiple calls to this function with the same argument should return the same results. Only the first call initializes the object, further calls return the result -of the first call. This is so that its safe to implement the singleton +of the first call. This is so that it's safe to implement the singleton pattern in the GObject constructor function. Since: 2.22 @@ -18330,7 +37502,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -18360,7 +37532,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -18408,7 +37580,7 @@ the value, and other property value pairs, and ended by %NULL. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -18445,7 +37617,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -18507,7 +37679,7 @@ can use a faster close that doesn't block to e.g. check errors. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -18571,7 +37743,7 @@ Finishes closing a stream asynchronously, started from g_input_stream_close_asyn </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -18653,7 +37825,7 @@ On error -1 is returned and @error is set accordingly. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -18701,7 +37873,7 @@ the number of bytes read into @buffer before the error occurred. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -18786,7 +37958,7 @@ Finishes an asynchronous stream read operation. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -18809,7 +37981,7 @@ already set or @stream is closed, it will return %FALSE and set </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -18851,7 +38023,7 @@ partial result will be returned, without an error. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -18932,7 +38104,7 @@ Finishes a stream skip operation. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -19141,8 +38313,8 @@ Looks up an existing extension point. </parameter_description> </parameter> </parameters> -<return> the #GIOExtensionPoint, or %NULL if there is no -registered extension point with the given name +<return> the #GIOExtensionPoint, or %NULL if there +is no registered extension point with the given name. </return> </function> @@ -19158,8 +38330,8 @@ Registers an extension point. </parameter_description> </parameter> </parameters> -<return> the new #GIOExtensionPoint. This object is owned by GIO -and should not be freed +<return> the new #GIOExtensionPoint. This object is +owned by GIO and should not be freed. </return> </function> @@ -19217,6 +38389,67 @@ or %NULL on error. </return> </function> +<function name="g_io_module_scope_block"> +<description> +Block modules with the given @basename from being loaded when +this scope is used with g_io_modules_scan_all_in_directory_with_scope() +or g_io_modules_load_all_in_directory_with_scope(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="scope"> +<parameter_description> a module loading scope +</parameter_description> +</parameter> +<parameter name="basename"> +<parameter_description> the basename to block +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_io_module_scope_free"> +<description> +Free a module scope. + +Since: 2.30 + +</description> +<parameters> +<parameter name="scope"> +<parameter_description> a module loading scope +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_io_module_scope_new"> +<description> +Create a new scope for loading of IO modules. A scope can be used for +blocking duplicate modules, or blocking a module you don't want to load. + +Specify the %G_IO_MODULES_SCOPE_BLOCK_DUPLICATES flag to block modules +which have the same base name as a module that has already been seen +in this scope. + +Since: 2.30 + +</description> +<parameters> +<parameter name="flags"> +<parameter_description> flags for the new scope +</parameter_description> +</parameter> +</parameters> +<return> the new module scope + +</return> +</function> + <function name="g_io_modules_load_all_in_directory"> <description> Loads all the modules in the specified directory. @@ -19242,6 +38475,37 @@ with g_list_free(). </return> </function> +<function name="g_io_modules_load_all_in_directory_with_scope"> +<description> +Loads all the modules in the specified directory. + +If don't require all modules to be initialized (and thus registering +all gtypes) then you can use g_io_modules_scan_all_in_directory() +which allows delayed/lazy loading of modules. + +Since: 2.30 + +</description> +<parameters> +<parameter name="dirname"> +<parameter_description> pathname for a directory containing modules to load. +</parameter_description> +</parameter> +<parameter name="scope"> +<parameter_description> a scope to use when scanning the modules. +</parameter_description> +</parameter> +</parameters> +<return> a list of #GIOModules loaded +from the directory, +All the modules are loaded into memory, if you want to +unload them (enabling on-demand loading) you must call +g_type_module_unuse() on all the modules. Free the list +with g_list_free(). + +</return> +</function> + <function name="g_io_modules_scan_all_in_directory"> <description> Scans all the modules in the specified directory, ensuring that @@ -19268,6 +38532,36 @@ Since: 2.24 <return></return> </function> +<function name="g_io_modules_scan_all_in_directory_with_scope"> +<description> +Scans all the modules in the specified directory, ensuring that +any extension point implemented by a module is registered. + +This may not actually load and initialize all the types in each +module, some modules may be lazily loaded and initialized when +an extension point it implementes is used with e.g. +g_io_extension_point_get_extensions() or +g_io_extension_point_get_extension_by_name(). + +If you need to guarantee that all types are loaded in all the modules, +use g_io_modules_load_all_in_directory(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="dirname"> +<parameter_description> pathname for a directory containing modules to scan. +</parameter_description> +</parameter> +<parameter name="scope"> +<parameter_description> a scope to use when scanning the modules +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_io_scheduler_cancel_all_jobs"> <description> Cancels all cancellable I/O jobs. @@ -19347,7 +38641,7 @@ g_io_scheduler_push_job() or by using refcounting for @user_data. <function name="g_io_scheduler_push_job"> <description> -Schedules the I/O job to run. +Schedules the I/O job to run in another thread. @notify will be called on @user_data after @job_func has returned, regardless whether the job was cancelled or has run to completion. @@ -19448,7 +38742,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -19515,7 +38809,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> @@ -19616,7 +38910,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> @@ -19685,7 +38979,7 @@ Since: 2.28 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -19742,6 +39036,7 @@ syntax of the key file format. For example, if you have '[' or ']' characters in your path names or '=' in your key names you may be in trouble. + </description> <parameters> <parameter name="filename"> @@ -19788,7 +39083,7 @@ loaded icon, %NULL to ignore. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -19850,7 +39145,7 @@ Finishes an asynchronous icon load started in g_loadable_icon_load_async(). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -20086,6 +39381,1336 @@ Since: 2.28 </return> </function> +<function name="g_menu_append"> +<description> +Convenience function for appending a normal menu item to the end of +@menu. Combine g_menu_new() and g_menu_insert_item() for a more +flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="detailed_action"> +<parameter_description> the detailed action string, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_append_item"> +<description> +Appends @item to the end of @menu. + +See g_menu_insert_item() for more information. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="item"> +<parameter_description> a #GMenuItem to append +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_append_section"> +<description> +Convenience function for appending a section menu item to the end of +@menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a +more flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="section"> +<parameter_description> a #GMenuModel with the items of the section +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_append_submenu"> +<description> +Convenience function for appending a submenu menu item to the end of +@menu. Combine g_menu_new_submenu() and g_menu_insert_item() for a +more flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="submenu"> +<parameter_description> a #GMenuModel with the items of the submenu +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_attribute_iter_get_name"> +<description> +Gets the name of the attribute at the current iterator position, as +a string. + +The iterator is not advanced. + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuAttributeIter +</parameter_description> +</parameter> +</parameters> +<return> the name of the attribute + +</return> +</function> + +<function name="g_menu_attribute_iter_get_next"> +<description> +This function combines g_menu_attribute_iter_next() with +g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). + +First the iterator is advanced to the next (possibly first) attribute. +If that fails, then %FALSE is returned and there are no other +effects. + +If successful, @name and @value are set to the name and value of the +attribute that has just been advanced to. At this point, +g_menu_item_get_name() and g_menu_item_get_value() will return the +same values again. + +The value returned in @name remains valid for as long as the iterator +remains at the current position. The value returned in @value must +be unreffed using g_variant_unref() when it is no longer in use. + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuAttributeIter +</parameter_description> +</parameter> +<parameter name="out_name"> +<parameter_description> the type of the attribute +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the attribute value +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success, or %FALSE if there is no additional +attribute + +</return> +</function> + +<function name="g_menu_attribute_iter_get_value"> +<description> +Gets the value of the attribute at the current iterator position. + +The iterator is not advanced. + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuAttributeIter +</parameter_description> +</parameter> +</parameters> +<return> the value of the current attribute + +</return> +</function> + +<function name="g_menu_attribute_iter_next"> +<description> +Attempts to advance the iterator to the next (possibly first) +attribute. + +%TRUE is returned on success, or %FALSE if there are no more +attributes. + +You must call this function when you first acquire the iterator +to advance it to the first attribute (and determine if the first +attribute exists at all). + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuAttributeIter +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success, or %FALSE when there are no more attributes + +</return> +</function> + +<function name="g_menu_freeze"> +<description> +Marks @menu as frozen. + +After the menu is frozen, it is an error to attempt to make any +changes to it. In effect this means that the #GMenu API must no +longer be used. + +This function causes g_menu_model_is_mutable() to begin returning +%FALSE, which has some positive performance implications. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_insert"> +<description> +Convenience function for inserting a normal menu item into @menu. +Combine g_menu_new() and g_menu_insert_item() for a more flexible +alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="position"> +<parameter_description> the position at which to insert the item +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="detailed_action"> +<parameter_description> the detailed action string, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_insert_item"> +<description> +Inserts @item into @menu. + +The "insertion" is actually done by copying all of the attribute and +link values of @item and using them to form a new item within @menu. +As such, @item itself is not really inserted, but rather, a menu item +that is exactly the same as the one presently described by @item. + +This means that @item is essentially useless after the insertion +occurs. Any changes you make to it are ignored unless it is inserted +again (at which point its updated values will be copied). + +You should probably just free @item once you're done. + +There are many convenience functions to take care of common cases. +See g_menu_insert(), g_menu_insert_section() and +g_menu_insert_submenu() as well as "prepend" and "append" variants of +each of these functions. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="position"> +<parameter_description> the position at which to insert the item +</parameter_description> +</parameter> +<parameter name="item"> +<parameter_description> the #GMenuItem to insert +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_insert_section"> +<description> +Convenience function for inserting a section menu item into @menu. +Combine g_menu_item_new_section() and g_menu_insert_item() for a more +flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="position"> +<parameter_description> the position at which to insert the item +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="section"> +<parameter_description> a #GMenuModel with the items of the section +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_insert_submenu"> +<description> +Convenience function for inserting a submenu menu item into @menu. +Combine g_menu_new_submenu() and g_menu_insert_item() for a more +flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="position"> +<parameter_description> the position at which to insert the item +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="submenu"> +<parameter_description> a #GMenuModel with the items of the submenu +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_new"> +<description> +Creates a new #GMenuItem. + +If @label is non-%NULL it is used to set the "label" attribute of the +new item. + +If @detailed_action is non-%NULL it is used to set the "action" and +possibly the "target" attribute of the new item. See +g_menu_item_set_detailed_action() for more information. + +Since: 2.32 + +</description> +<parameters> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="detailed_action"> +<parameter_description> the detailed action string, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a new #GMenuItem + +</return> +</function> + +<function name="g_menu_item_new_section"> +<description> +Creates a new #GMenuItem representing a section. + +This is a convenience API around g_menu_item_new() and +g_menu_item_set_section(). + +The effect of having one menu appear as a section of another is +exactly as it sounds: the items from @section become a direct part of +the menu that @menu_item is added to. + +Visual separation is typically displayed between two non-empty +sections. If @label is non-%NULL then it will be encorporated into +this visual indication. This allows for labeled subsections of a +menu. + +As a simple example, consider a typical "Edit" menu from a simple +program. It probably contains an "Undo" and "Redo" item, followed by +a separator, followed by "Cut", "Copy" and "Paste". + +This would be accomplished by creating three #GMenu instances. The +first would be populated with the "Undo" and "Redo" items, and the +second with the "Cut", "Copy" and "Paste" items. The first and +second menus would then be added as submenus of the third. In XML +format, this would look something like the following: + +<informalexample><programlisting><![CDATA[ +<menu id='edit-menu'> +<section> +<item label='Undo'/> +<item label='Redo'/> +</section> +<section> +<item label='Cut'/> +<item label='Copy'/> +<item label='Paste'/> +</section> +</menu> +]]></programlisting></informalexample> + +The following example is exactly equivalent. It is more illustrative +of the exact relationship between the menus and items (keeping in +mind that the 'link' element defines a new menu that is linked to the +containing one). The style of the second example is more verbose and +difficult to read (and therefore not recommended except for the +purpose of understanding what is really going on). + +<informalexample><programlisting><![CDATA[ +<menu id='edit-menu'> +<item> +<link name='section'> +<item label='Undo'/> +<item label='Redo'/> +</link> +</item> +<item> +<link name='section'> +<item label='Cut'/> +<item label='Copy'/> +<item label='Paste'/> +</link> +</item> +</menu> +]]></programlisting></informalexample> + +Since: 2.32 + +</description> +<parameters> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="section"> +<parameter_description> a #GMenuModel with the items of the section +</parameter_description> +</parameter> +</parameters> +<return> a new #GMenuItem + +</return> +</function> + +<function name="g_menu_item_new_submenu"> +<description> +Creates a new #GMenuItem representing a submenu. + +This is a convenience API around g_menu_item_new() and +g_menu_item_set_submenu(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="submenu"> +<parameter_description> a #GMenuModel with the items of the submenu +</parameter_description> +</parameter> +</parameters> +<return> a new #GMenuItem + +</return> +</function> + +<function name="g_menu_item_set_action_and_target"> +<description> +Sets or unsets the "action" and "target" attributes of @menu_item. + +If @action is %NULL then both the "action" and "target" attributes +are unset (and @format_string is ignored along with the positional +parameters). + +If @action is non-%NULL then the "action" attribute is set. +@format_string is then inspected. If it is non-%NULL then the proper +position parameters are collected to create a #GVariant instance to +use as the target value. If it is %NULL then the positional +parameters are ignored and the "target" attribute is unset. + +See also g_menu_item_set_action_and_target_value() for an equivalent +call that directly accepts a #GVariant. See +g_menu_item_set_detailed_action() for a more convenient version that +works with string-typed targets. + +See also g_menu_item_set_action_and_target_value() for a +description of the semantics of the action and target attributes. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="action"> +<parameter_description> the name of the action for this item +</parameter_description> +</parameter> +<parameter name="format_string"> +<parameter_description> a GVariant format string +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> positional parameters, as per @format_string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_action_and_target_value"> +<description> +Sets or unsets the "action" and "target" attributes of @menu_item. + +If @action is %NULL then both the "action" and "target" attributes +are unset (and @target_value is ignored). + +If @action is non-%NULL then the "action" attribute is set. The +"target" attribute is then set to the value of @target_value if it is +non-%NULL or unset otherwise. + +Normal menu items (ie: not submenu, section or other custom item +types) are expected to have the "action" attribute set to identify +the action that they are associated with. The state type of the +action help to determine the disposition of the menu item. See +#GAction and #GActionGroup for an overview of actions. + +In general, clicking on the menu item will result in activation of +the named action with the "target" attribute given as the parameter +to the action invocation. If the "target" attribute is not set then +the action is invoked with no parameter. + +If the action has no state then the menu item is usually drawn as a +plain menu item (ie: with no additional decoration). + +If the action has a boolean state then the menu item is usually drawn +as a toggle menu item (ie: with a checkmark or equivalent +indication). The item should be marked as 'toggled' or 'checked' +when the boolean state is %TRUE. + +If the action has a string state then the menu item is usually drawn +as a radio menu item (ie: with a radio bullet or equivalent +indication). The item should be marked as 'selected' when the string +state is equal to the value of the @target property. + +See g_menu_item_set_action_and_target() or +g_menu_item_set_detailed_action() for two equivalent calls that are +probably more convenient for most uses. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="action"> +<parameter_description> the name of the action for this item +</parameter_description> +</parameter> +<parameter name="target_value"> +<parameter_description> a #GVariant to use as the action target +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_attribute"> +<description> +Sets or unsets an attribute on @menu_item. + +The attribute to set or unset is specified by @attribute. This +can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, +%G_MENU_ATTRIBUTE_ACTION, %G_MENU_ATTRIBUTE_TARGET, or a custom +attribute name. +Attribute names are restricted to lowercase characters, numbers +and '-'. Furthermore, the names must begin with a lowercase character, +must not end with a '-', and must not contain consecutive dashes. + +If @format_string is non-%NULL then the proper position parameters +are collected to create a #GVariant instance to use as the attribute +value. If it is %NULL then the positional parameterrs are ignored +and the named attribute is unset. + +See also g_menu_item_set_attribute_value() for an equivalent call +that directly accepts a #GVariant. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="attribute"> +<parameter_description> the attribute to set +</parameter_description> +</parameter> +<parameter name="format_string"> +<parameter_description> a #GVariant format string, or %NULL +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> positional parameters, as per @format_string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_attribute_value"> +<description> +Sets or unsets an attribute on @menu_item. + +The attribute to set or unset is specified by @attribute. This +can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, +%G_MENU_ATTRIBUTE_ACTION, %G_MENU_ATTRIBUTE_TARGET, or a custom +attribute name. +Attribute names are restricted to lowercase characters, numbers +and '-'. Furthermore, the names must begin with a lowercase character, +must not end with a '-', and must not contain consecutive dashes. + +must consist only of lowercase +ASCII characters, digits and '-'. + +If @value is non-%NULL then it is used as the new value for the +attribute. If @value is %NULL then the attribute is unset. If +the @value #GVariant is floating, it is consumed. + +See also g_menu_item_set_attribute() for a more convenient way to do +the same. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="attribute"> +<parameter_description> the attribute to set +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> a #GVariant to use as the value, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_detailed_action"> +<description> +Sets the "action" and possibly the "target" attribute of @menu_item. + +If @detailed_action contains a double colon ("::") then it is used as +a separator between an action name and a target string. In this +case, this call is equivalent to calling +g_menu_item_set_action_and_target() with the part before the "::" and +g_menu_item_set_target_value() with a string-type #GVariant +containing the part following the "::". + +If @detailed_action doesn't contain "::" then the action is set to +the given string (verbatim) and the target value is unset. + +See g_menu_item_set_action_and_target() or +g_menu_item_set_action_and_target_value() for more flexible (but +slightly less convenient) alternatives. + +See also g_menu_set_action_and_target_value() for a description of +the semantics of the action and target attributes. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="detailed_action"> +<parameter_description> the "detailed" action string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_label"> +<description> +Sets or unsets the "label" attribute of @menu_item. + +If @label is non-%NULL it is used as the label for the menu item. If +it is %NULL then the label attribute is unset. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the label to set, or %NULL to unset +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_link"> +<description> +Creates a link from @menu_item to @model if non-%NULL, or unsets it. + +Links are used to establish a relationship between a particular menu +item and another menu. For example, %G_MENU_LINK_SUBMENU is used to +associate a submenu with a particular menu item, and %G_MENU_LINK_SECTION +is used to create a section. Other types of link can be used, but there +is no guarantee that clients will be able to make sense of them. +Link types are restricted to lowercase characters, numbers +and '-'. Furthermore, the names must begin with a lowercase character, +must not end with a '-', and must not contain consecutive dashes. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="link"> +<parameter_description> type of link to establish or unset +</parameter_description> +</parameter> +<parameter name="model"> +<parameter_description> the #GMenuModel to link to (or %NULL to unset) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_section"> +<description> +Sets or unsets the "section" link of @menu_item to @section. + +The effect of having one menu appear as a section of another is +exactly as it sounds: the items from @section become a direct part of +the menu that @menu_item is added to. See g_menu_item_new_section() +for more information about what it means for a menu item to be a +section. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="section"> +<parameter_description> a #GMenuModel, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_item_set_submenu"> +<description> +Sets or unsets the "submenu" link of @menu_item to @submenu. + +If @submenu is non-%NULL, it is linked to. If it is %NULL then the +link is unset. + +The effect of having one menu appear as a submenu of another is +exactly as it sounds. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu_item"> +<parameter_description> a #GMenuItem +</parameter_description> +</parameter> +<parameter name="submenu"> +<parameter_description> a #GMenuModel, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_link_iter_get_name"> +<description> +Gets the name of the link at the current iterator position. + +The iterator is not advanced. + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuLinkIter +</parameter_description> +</parameter> +</parameters> +<return> the type of the link + +</return> +</function> + +<function name="g_menu_link_iter_get_next"> +<description> +This function combines g_menu_link_iter_next() with +g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). + +First the iterator is advanced to the next (possibly first) link. +If that fails, then %FALSE is returned and there are no other effects. + +If successful, @out_link and @value are set to the name and #GMenuModel +of the link that has just been advanced to. At this point, +g_menu_item_get_name() and g_menu_item_get_value() will return the +same values again. + +The value returned in @out_link remains valid for as long as the iterator +remains at the current position. The value returned in @value must +be unreffed using g_object_unref() when it is no longer in use. + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuLinkIter +</parameter_description> +</parameter> +<parameter name="out_link"> +<parameter_description> the name of the link +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the linked #GMenuModel +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success, or %FALSE if there is no additional link + +</return> +</function> + +<function name="g_menu_link_iter_get_value"> +<description> +Gets the linked #GMenuModel at the current iterator position. + +The iterator is not advanced. + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuLinkIter +</parameter_description> +</parameter> +</parameters> +<return> the #GMenuModel that is linked to + +</return> +</function> + +<function name="g_menu_link_iter_next"> +<description> +Attempts to advance the iterator to the next (possibly first) +link. + +%TRUE is returned on success, or %FALSE if there are no more links. + +You must call this function when you first acquire the iterator to +advance it to the first link (and determine if the first link exists +at all). + +Since: 2.32 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> a #GMenuLinkIter +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success, or %FALSE when there are no more links + +</return> +</function> + +<function name="g_menu_model_get_item_attribute"> +<description> +Queries item at position @item_index in @model for the attribute +specified by @attribute. + +If the attribute exists and matches the #GVariantType corresponding +to @format_string then @format_string is used to deconstruct the +value into the positional parameters and %TRUE is returned. + +If the attribute does not exist, or it does exist but has the wrong +type, then the positional parameters are ignored and %FALSE is +returned. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +<parameter name="item_index"> +<parameter_description> the index of the item +</parameter_description> +</parameter> +<parameter name="attribute"> +<parameter_description> the attribute to query +</parameter_description> +</parameter> +<parameter name="format_string"> +<parameter_description> a #GVariant format string +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> positional parameters, as per @format_string +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the named attribute was found with the expected +type + +</return> +</function> + +<function name="g_menu_model_get_item_attribute_value"> +<description> +Queries the item at position @item_index in @model for the attribute +specified by @attribute. + +If @expected_type is non-%NULL then it specifies the expected type of +the attribute. If it is %NULL then any type will be accepted. + +If the attribute exists and matches @expected_type (or if the +expected type is unspecified) then the value is returned. + +If the attribute does not exist, or does not match the expected type +then %NULL is returned. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +<parameter name="item_index"> +<parameter_description> the index of the item +</parameter_description> +</parameter> +<parameter name="attribute"> +<parameter_description> the attribute to query +</parameter_description> +</parameter> +<parameter name="expected_type"> +<parameter_description> the expected type of the attribute, or +%NULL +</parameter_description> +</parameter> +</parameters> +<return> the value of the attribute + +</return> +</function> + +<function name="g_menu_model_get_item_link"> +<description> +Queries the item at position @item_index in @model for the link +specified by @link. + +If the link exists, the linked #GMenuModel is returned. If the link +does not exist, %NULL is returned. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +<parameter name="item_index"> +<parameter_description> the index of the item +</parameter_description> +</parameter> +<parameter name="link"> +<parameter_description> the link to query +</parameter_description> +</parameter> +</parameters> +<return> the linked #GMenuModel, or %NULL + +</return> +</function> + +<function name="g_menu_model_get_n_items"> +<description> +Query the number of items in @model. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +</parameters> +<return> the number of items + +</return> +</function> + +<function name="g_menu_model_is_mutable"> +<description> +Queries if @model is mutable. + +An immutable #GMenuModel will never emit the #GMenuModel::items-changed +signal. Consumers of the model may make optimisations accordingly. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the model is mutable (ie: "items-changed" may be +emitted). + +</return> +</function> + +<function name="g_menu_model_items_changed"> +<description> +Requests emission of the #GMenuModel::items-changed signal on @model. + +This function should never be called except by #GMenuModel +subclasses. Any other calls to this function will very likely lead +to a violation of the interface of the model. + +The implementation should update its internal representation of the +menu before emitting the signal. The implementation should further +expect to receive queries about the new state of the menu (and +particularly added menu items) while signal handlers are running. + +The implementation must dispatch this call directly from a mainloop +entry and not in response to calls -- particularly those from the +#GMenuModel API. Said another way: the menu must not change while +user code is running without returning to the mainloop. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +<parameter name="position"> +<parameter_description> the position of the change +</parameter_description> +</parameter> +<parameter name="removed"> +<parameter_description> the number of items removed +</parameter_description> +</parameter> +<parameter name="added"> +<parameter_description> the number of items added +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_model_iterate_item_attributes"> +<description> +Creates a #GMenuAttributeIter to iterate over the attributes of +the item at position @item_index in @model. + +You must free the iterator with g_object_unref() when you are done. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +<parameter name="item_index"> +<parameter_description> the index of the item +</parameter_description> +</parameter> +</parameters> +<return> a new #GMenuAttributeIter + +</return> +</function> + +<function name="g_menu_model_iterate_item_links"> +<description> +Creates a #GMenuLinkIter to iterate over the links of the item at +position @item_index in @model. + +You must free the iterator with g_object_unref() when you are done. + +Since: 2.32 + +</description> +<parameters> +<parameter name="model"> +<parameter_description> a #GMenuModel +</parameter_description> +</parameter> +<parameter name="item_index"> +<parameter_description> the index of the item +</parameter_description> +</parameter> +</parameters> +<return> a new #GMenuLinkIter + +</return> +</function> + +<function name="g_menu_new"> +<description> +Creates a new #GMenu. + +The new menu has no items. + +Since: 2.32 + +</description> +<parameters> +</parameters> +<return> a new #GMenu + +</return> +</function> + +<function name="g_menu_prepend"> +<description> +Convenience function for prepending a normal menu item to the start +of @menu. Combine g_menu_new() and g_menu_insert_item() for a more +flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="detailed_action"> +<parameter_description> the detailed action string, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_prepend_item"> +<description> +Prepends @item to the start of @menu. + +See g_menu_insert_item() for more information. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="item"> +<parameter_description> a #GMenuItem to prepend +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_prepend_section"> +<description> +Convenience function for prepending a section menu item to the start +of @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for +a more flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="section"> +<parameter_description> a #GMenuModel with the items of the section +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_prepend_submenu"> +<description> +Convenience function for prepending a submenu menu item to the start +of @menu. Combine g_menu_new_submenu() and g_menu_insert_item() for +a more flexible alternative. + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="label"> +<parameter_description> the section label, or %NULL +</parameter_description> +</parameter> +<parameter name="submenu"> +<parameter_description> a #GMenuModel with the items of the submenu +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_menu_remove"> +<description> +Removes an item from the menu. + +@position gives the index of the item to remove. + +It is an error if position is not in range the range from 0 to one +less than the number of items in the menu. + +It is not possible to remove items by identity since items are added +to the menu simply by copying their links and attributes (ie: +identity of the item itself is not preserved). + +Since: 2.32 + +</description> +<parameters> +<parameter name="menu"> +<parameter_description> a #GMenu +</parameter_description> +</parameter> +<parameter name="position"> +<parameter_description> the position of the item to remove +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_mount_can_eject"> <description> Checks if @mount can be eject. @@ -20170,7 +40795,7 @@ Deprecated: 2.22: Use g_mount_eject_with_operation_finish() instead. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -20237,7 +40862,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -20342,6 +40967,24 @@ g_object_unref() when no longer needed. </return> </function> +<function name="g_mount_get_sort_key"> +<description> +Gets the sort key for @mount, if any. + +Since: 2.32 + +</description> +<parameters> +<parameter name="mount"> +<parameter_description> A #GMount. +</parameter_description> +</parameter> +</parameters> +<return> Sorting key for @mount or %NULL if no such key is available. + +</return> +</function> + <function name="g_mount_get_uuid"> <description> Gets the UUID for the @mount. The reference is typically based on @@ -20425,7 +41068,7 @@ Otherwise a cached result will be used if available <function name="g_mount_guess_content_type_finish"> <description> -Finishes guessing content types of @mount. If any errors occured +Finishes guessing content types of @mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. In particular, you may get an %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content @@ -20444,7 +41087,7 @@ Since: 2.18 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> @@ -20484,7 +41127,7 @@ Otherwise a cached result will be used if available </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> @@ -20833,7 +41476,7 @@ Finishes remounting a mount. If any errors occurred during the operation, </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -20913,7 +41556,7 @@ Deprecated: 2.22: Use g_mount_unmount_with_operation_finish() instead. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -20980,7 +41623,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -21097,8 +41740,7 @@ parsing @host_and_port fails. address, an IPv4 address, or a domain name (in which case a DNS lookup is performed). Quoting with [] is supported for all address types. A port override may be specified in the usual way with a -colon. Ports may be given as decimal numbers or symbolic names (in -which case an /etc/services lookup is performed). +colon. If no port is specified in @host_and_port then @default_port will be used as the port number to connect to. @@ -21107,6 +41749,11 @@ In general, @host_and_port is expected to be provided by the user (allowing them to give the hostname, and a port overide if necessary) and @default_port is expected to be provided by the application. +(The port component of @host_and_port can also be specified as a +service name rather than as a numeric port, but this functionality +is deprecated, because it depends on the contents of /etc/services, +which is generally quite sparse on platforms other than Linux.) + Since: 2.22 </description> @@ -21160,6 +41807,214 @@ Since: 2.26 </return> </function> +<function name="g_network_monitor_base_add_network"> +<description> +Adds @network to @monitor's list of available networks. + +Since: 2.32 + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> the #GNetworkMonitorBase +</parameter_description> +</parameter> +<parameter name="network"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_network_monitor_base_remove_network"> +<description> +Removes @network from @monitor's list of available networks. + +Since: 2.32 + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> the #GNetworkMonitorBase +</parameter_description> +</parameter> +<parameter name="network"> +<parameter_description> a #GInetAddressMask +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_network_monitor_base_set_networks"> +<description> +Drops @monitor's current list of available networks and replaces +it with @networks. + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> the #GNetworkMonitorBase +</parameter_description> +</parameter> +<parameter name="networks"> +<parameter_description> an array of #GInetAddressMask +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> length of @networks +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_network_monitor_can_reach"> +<description> +Attempts to determine whether or not the host pointed to by +@connectable can be reached, without actually trying to connect to +it. + +This may return %TRUE even when #GNetworkMonitor:network-available +is %FALSE, if, for example, @monitor can determine that +@connectable refers to a host on a local network. + +If @monitor believes that an attempt to connect to @connectable +will succeed, it will return %TRUE. Otherwise, it will return +%FALSE and set @error to an appropriate error (such as +%G_IO_ERROR_HOST_UNREACHABLE). + +Note that although this does not attempt to connect to +@connectable, it may still block for a brief period of time (eg, +trying to do multicast DNS on the local network), so if you do not +want to block, you should use g_network_monitor_can_reach_async(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> a #GNetworkMonitor +</parameter_description> +</parameter> +<parameter name="connectable"> +<parameter_description> a #GSocketConnectable +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @connectable is reachable, %FALSE if not. + +</return> +</function> + +<function name="g_network_monitor_can_reach_async"> +<description> +Asynchronously attempts to determine whether or not the host +pointed to by @connectable can be reached, without actually +trying to connect to it. + +For more details, see g_network_monitor_can_reach(). + +When the operation is finished, @callback will be called. +You can then call g_network_monitor_can_reach_finish() +to get the result of the operation. + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> a #GNetworkMonitor +</parameter_description> +</parameter> +<parameter name="connectable"> +<parameter_description> a #GSocketConnectable +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback to call when the +request is satisfied +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to callback function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_network_monitor_can_reach_finish"> +<description> +Finishes an async network connectivity test. +See g_network_monitor_can_reach_async(). + + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> a #GNetworkMonitor +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for errors, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if network is reachable, %FALSE if not. +</return> +</function> + +<function name="g_network_monitor_get_default"> +<description> +Gets the default #GNetworkMonitor for the system. + +Since: 2.32 + +</description> +<parameters> +</parameters> +<return> a #GNetworkMonitor + +</return> +</function> + +<function name="g_network_monitor_get_network_available"> +<description> +Checks if the network is available. "Available" here means that the +system has a default route available for at least one of IPv4 or +IPv6. It does not necessarily imply that the public Internet is +reachable. See #GNetworkMonitor:network-available for more details. + +Since: 2.32 + +</description> +<parameters> +<parameter name="monitor"> +<parameter_description> the #GNetworkMonitor +</parameter_description> +</parameter> +</parameters> +<return> whether the network is available + +</return> +</function> + <function name="g_network_service_get_domain"> <description> Gets the domain that @srv serves. This might be either UTF-8 or @@ -21358,7 +42213,7 @@ data will reach the target. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -21421,7 +42276,7 @@ Closes an output stream. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -21432,8 +42287,9 @@ ignore. <function name="g_output_stream_flush"> <description> -Flushed any outstanding buffers in the stream. Will block during -the operation. Closing the stream will implicitly cause a flush. +Forces a write of all user-space buffered data for the given +@stream. Will block during the operation. Closing the stream will +implicitly cause a flush. This function is optional for inherited classes. @@ -21453,7 +42309,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -21463,7 +42319,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. <function name="g_output_stream_flush_async"> <description> -Flushes a stream asynchronously. +Forces an asynchronous write of all user-space buffered data for +the given @stream. For behaviour details see g_output_stream_flush(). When the operation is finished @callback will be @@ -21512,12 +42369,12 @@ Finishes flushing an output stream. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> %TRUE if flush operation suceeded, %FALSE otherwise. +<return> %TRUE if flush operation succeeded, %FALSE otherwise. </return> </function> @@ -21588,7 +42445,7 @@ already set or @stream is closed, it will return %FALSE and set </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -21621,13 +42478,16 @@ Splices an input stream into an output stream. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> </parameters> <return> a #gssize containing the size of the data spliced, or --1 if an error occurred. +-1 if an error occurred. Note that if the number of bytes +spliced is greater than %G_MAXSSIZE, then that will be +returned, and there is no way to determine the actual number +of bytes spliced. </return> </function> @@ -21691,12 +42551,15 @@ Finishes an asynchronous stream splice operation. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> </parameters> -<return> a #gssize of the number of bytes spliced. +<return> a #gssize of the number of bytes spliced. Note that if the +number of bytes spliced is greater than %G_MAXSSIZE, then that +will be returned, and there is no way to determine the actual +number of bytes spliced. </return> </function> @@ -21723,6 +42586,8 @@ partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. +Virtual: write_fn + </description> <parameters> @@ -21743,7 +42608,7 @@ On error -1 is returned and @error is set accordingly. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -21791,7 +42656,7 @@ written to the stream </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore </parameter_description> </parameter> </parameters> @@ -21882,7 +42747,7 @@ Finishes a stream write operation. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -21927,6 +42792,7 @@ Since: 2.26 </parameter> </parameters> <return> %TRUE if the permission was successfully acquired + </return> </function> @@ -21987,6 +42853,7 @@ Since: 2.26 </parameter> </parameters> <return> %TRUE if the permission was successfully acquired + </return> </function> @@ -22006,6 +42873,7 @@ Since: 2.26 </parameter> </parameters> <return> the value of the 'allowed' property + </return> </function> @@ -22025,6 +42893,7 @@ Since: 2.26 </parameter> </parameters> <return> the value of the 'can-acquire' property + </return> </function> @@ -22044,6 +42913,7 @@ Since: 2.26 </parameter> </parameters> <return> the value of the 'can-release' property + </return> </function> @@ -22115,6 +42985,7 @@ Since: 2.26 </parameter> </parameters> <return> %TRUE if the permission was successfully released + </return> </function> @@ -22175,6 +43046,7 @@ Since: 2.26 </parameter> </parameters> <return> %TRUE if the permission was successfully released + </return> </function> @@ -22691,7 +43563,7 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="result"> -<parameter_description> a #GAsyncRetult +<parameter_description> a #GAsyncResult </parameter_description> </parameter> <parameter name="error"> @@ -22891,6 +43763,78 @@ Since: 2.26 </return> </function> +<function name="g_remote_action_group_activate_action_full"> +<description> +Activates the remote action. + +This is the same as g_action_group_activate_action() except that it +allows for provision of "platform data" to be sent along with the +activation request. This typically contains details such as the user +interaction timestamp or startup notification information. + +@platform_data must be non-%NULL and must have the type +%G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed. + +Since: 2.32 + +</description> +<parameters> +<parameter name="remote"> +<parameter_description> a #GDBusActionGroup +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of the action to activate +</parameter_description> +</parameter> +<parameter name="parameter"> +<parameter_description> the optional parameter to the activation +</parameter_description> +</parameter> +<parameter name="platform_data"> +<parameter_description> the platform data to send +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_remote_action_group_change_action_state_full"> +<description> +Changes the state of a remote action. + +This is the same as g_action_group_change_action_state() except that +it allows for provision of "platform data" to be sent along with the +state change request. This typically contains details such as the +user interaction timestamp or startup notification information. + +@platform_data must be non-%NULL and must have the type +%G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed. + +Since: 2.32 + +</description> +<parameters> +<parameter name="remote"> +<parameter_description> a #GRemoteActionGroup +</parameter_description> +</parameter> +<parameter name="action_name"> +<parameter_description> the name of the action to change the state of +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the new requested value for the state +</parameter_description> +</parameter> +<parameter name="platform_data"> +<parameter_description> the platform data to send +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_resolver_error_quark"> <description> Gets the #GResolver Error Quark. @@ -22947,8 +43891,7 @@ Since: 2.22 <description> Gets the default #GResolver. You should unref it when you are done with it. #GResolver may use its reference count as a hint about how -many threads/processes, etc it should allocate for concurrent DNS -resolutions. +many threads it should allocate for concurrent DNS resolutions. Since: 2.22 @@ -23073,9 +44016,12 @@ the textual form of an IP address (in which case this just becomes a wrapper around g_inet_address_new_from_string()). On success, g_resolver_lookup_by_name() will return a #GList of -#GInetAddress, sorted in order of preference. (That is, you should -attempt to connect to the first address first, then the second if -the first fails, etc.) +#GInetAddress, sorted in order of preference and guaranteed to not +contain duplicates. That is, if using the result to connect to +@hostname, you should attempt to connect to the first address +first, then the second if the first fails, etc. If you are using +the result to listen on a socket, it is appropriate to add each +result using e.g. g_socket_listener_add_address(). If the DNS resolution fails, @error (if non-%NULL) will be set to a value from #GResolverError. @@ -23346,6 +44292,441 @@ Since: 2.22 <return></return> </function> +<function name="g_resource_enumerate_children"> +<description> +Returns all the names of children at the specified @path in the resource. +The return result is a %NULL terminated list of strings which should +be released with g_strfreev(). + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> an array of constant strings + +</return> +</function> + +<function name="g_resource_error_quark"> +<description> +Gets the #GResource Error Quark. + +Since: 2.32 + +</description> +<parameters> +</parameters> +<return> a #GQuark. + +</return> +</function> + +<function name="g_resource_get_info"> +<description> +Looks for a file at the specified @path in the resource and +if found returns information about it. + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> a location to place the length of the contents of the file, +or %NULL if the length is not needed +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> a location to place the flags about the file, +or %NULL if the length is not needed +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the file was found. %FALSE if there were errors. + +</return> +</function> + +<function name="g_resource_load"> +<description> +Loads a binary resource bundle and creates a #GResource representation of it, allowing +you to query it for data. + +If you want to use this resource in the global resource namespace you need +to register it with g_resources_register(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="filename"> +<parameter_description> the path of a filename to load, in the GLib filename encoding. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> a new #GResource, or %NULL on error. + +</return> +</function> + +<function name="g_resource_lookup_data"> +<description> +Looks for a file at the specified @path in the resource and +returns a #GBytes that lets you directly access the data in +memory. + +The data is always followed by a zero byte, so you +can safely use the data as a C string. However, that byte +is not included in the size of the GBytes. + +For uncompressed resource files this is a pointer directly into +the resource bundle, which is typically in some readonly data section +in the program binary. For compressed files we allocate memory on +the heap and automatically uncompress the data. + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> #GBytes or %NULL on error. +Free the returned object with g_bytes_unref(). + +</return> +</function> + +<function name="g_resource_new_from_data"> +<description> +Creates a GResource from a reference to the binary resource bundle. +This will keep a reference to @data while the resource lives, so +the data should not be modified or freed. + +If you want to use this resource in the global resource namespace you need +to register it with g_resources_register(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="data"> +<parameter_description> A #GBytes. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> a new #GResource, or %NULL on error. + +</return> +</function> + +<function name="g_resource_open_stream"> +<description> +Looks for a file at the specified @path in the resource and +returns a #GInputStream that lets you read the data. + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> #GInputStream or %NULL on error. +Free the returned object with g_object_unref(). + +</return> +</function> + +<function name="g_resource_ref"> +<description> +Atomically increments the reference count of @array by one. This +function is MT-safe and may be called from any thread. + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +</parameters> +<return> The passed in #GResource. + +</return> +</function> + +<function name="g_resource_unref"> +<description> +Atomically decrements the reference count of @resource by one. If the +reference count drops to 0, all memory allocated by the array is +released. This function is MT-safe and may be called from any +thread. + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_resources_enumerate_children"> +<description> +Returns all the names of children at the specified @path in the set of +globally registred resources. +The return result is a %NULL terminated list of strings which should +be released with g_strfreev(). + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> an array of constant strings + +</return> +</function> + +<function name="g_resources_get_info"> +<description> +Looks for a file at the specified @path in the set of +globally registred resources and if found returns information about it. + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> a location to place the length of the contents of the file, +or %NULL if the length is not needed +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> a location to place the flags about the file, +or %NULL if the length is not needed +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the file was found. %FALSE if there were errors. + +</return> +</function> + +<function name="g_resources_lookup_data"> +<description> +Looks for a file at the specified @path in the set of +globally registred resources and returns a #GBytes that +lets you directly access the data in memory. + +The data is always followed by a zero byte, so you +can safely use the data as a C string. However, that byte +is not included in the size of the GBytes. + +For uncompressed resource files this is a pointer directly into +the resource bundle, which is typically in some readonly data section +in the program binary. For compressed files we allocate memory on +the heap and automatically uncompress the data. + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> #GBytes or %NULL on error. +Free the returned object with g_bytes_unref(). + +</return> +</function> + +<function name="g_resources_open_stream"> +<description> +Looks for a file at the specified @path in the set of +globally registred resources and returns a #GInputStream +that lets you read the data. + +@lookup_flags controls the behaviour of the lookup. + +Since: 2.32 + +</description> +<parameters> +<parameter name="path"> +<parameter_description> A pathname inside the resource. +</parameter_description> +</parameter> +<parameter name="lookup_flags"> +<parameter_description> A #GResourceLookupFlags. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> #GInputStream or %NULL on error. +Free the returned object with g_object_unref(). + +</return> +</function> + +<function name="g_resources_register"> +<description> +Registers the resource with the process-global set of resources. +Once a resource is registered the files in it can be accessed +with the global resource lookup functions like g_resources_lookup_data(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_resources_unregister"> +<description> +Unregisters the resource from the process-global set of resources. + +Since: 2.32 + +</description> +<parameters> +<parameter name="resource"> +<parameter_description> A #GResource. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_seekable_can_seek"> <description> Tests if the stream supports the #GSeekableIface. @@ -23406,7 +44787,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -23460,7 +44841,7 @@ Virtual: truncate_fn </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -23504,7 +44885,7 @@ fact). It may not rely on the existence of a mainloop for dispatching the signal later. The implementation may call this function at any other time it likes -in response to other events (such as changes occuring outside of the +in response to other events (such as changes occurring outside of the program). These calls may originate from a mainloop or may originate in response to any other action (including from calls to g_settings_backend_write()). @@ -23609,6 +44990,7 @@ Since: 2.28 <parameters> </parameters> <return> the default #GSettingsBackend + </return> </function> @@ -23910,6 +45292,41 @@ Since: 2.26 <return></return> </function> +<function name="g_settings_create_action"> +<description> +Creates a #GAction corresponding to a given #GSettings key. + +The action has the same name as the key. + +The value of the key becomes the state of the action and the action +is enabled when the key is writable. Changing the state of the +action results in the key being written to. Changes to the value or +writability of the key cause appropriate change notifications to be +emitted for the action. + +For boolean-valued keys, action activations take no parameter and +result in the toggling of the value. For all other types, +activations take the new value for the key (which must have the +correct type). + +Since: 2.32 + +</description> +<parameters> +<parameter name="settings"> +<parameter_description> a #GSettings +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the name of a key in @settings +</parameter_description> +</parameter> +</parameters> +<return> a new #GAction + +</return> +</function> + <function name="g_settings_delay"> <description> Changes the #GSettings object into 'delay-apply' mode. In this @@ -23986,6 +45403,7 @@ Since: 2.26 </parameter> </parameters> <return> a boolean + </return> </function> @@ -24012,6 +45430,7 @@ Since: 2.26 </parameter> </parameters> <return> a 'child' settings object + </return> </function> @@ -24038,6 +45457,7 @@ Since: 2.26 </parameter> </parameters> <return> a double + </return> </function> @@ -24070,6 +45490,7 @@ Since: 2.26 </parameter> </parameters> <return> the enum value + </return> </function> @@ -24102,6 +45523,7 @@ Since: 2.26 </parameter> </parameters> <return> the flags value + </return> </function> @@ -24120,6 +45542,7 @@ Since: 2.26 </parameter> </parameters> <return> %TRUE if @settings has unapplied changes + </return> </function> @@ -24146,6 +45569,7 @@ Since: 2.26 </parameter> </parameters> <return> an integer + </return> </function> @@ -24179,6 +45603,7 @@ to each invocation of @mapping. The final value of that #gpointer is what is returned by this function. %NULL is valid; it is returned just as any other value would be. + </description> <parameters> <parameter name="settings"> @@ -24262,6 +45687,7 @@ Since: 2.28 </parameter> </parameters> <return> a #GVariant describing the range + </return> </function> @@ -24288,6 +45714,7 @@ Since: 2.26 </parameter> </parameters> <return> a newly-allocated string + </return> </function> @@ -24314,6 +45741,35 @@ Since: 2.26 <return> a newly-allocated, %NULL-terminated array of strings, the value that is stored at @key in @settings. + +</return> +</function> + +<function name="g_settings_get_uint"> +<description> +Gets the value that is stored at @key in @settings. + +A convenience variant of g_settings_get() for 32-bit unsigned +integers. + +It is a programmer error to give a @key that isn't specified as +having a uint32 type in the schema for @settings. + +Since: 2.30 + +</description> +<parameters> +<parameter name="settings"> +<parameter_description> a #GSettings object +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the key to get the value for +</parameter_description> +</parameter> +</parameters> +<return> an unsigned integer + </return> </function> @@ -24338,6 +45794,7 @@ Since: 2.26 </parameter> </parameters> <return> a new #GVariant + </return> </function> @@ -24359,6 +45816,7 @@ Since: 2.26 </parameter> </parameters> <return> %TRUE if the key @name is writable + </return> </function> @@ -24384,6 +45842,7 @@ useful there for introspection reasons, however. You should free the return value with g_strfreev() when you are done with it. + </description> <parameters> <parameter name="settings"> @@ -24406,6 +45865,7 @@ function is intended for introspection reasons. You should free the return value with g_strfreev() when you are done with it. + </description> <parameters> <parameter name="settings"> @@ -24424,7 +45884,7 @@ system. These are schemas that do not provide their own path. It is usual to instantiate these schemas directly, but if you want to you can use g_settings_new_with_path() to specify the path. -The output of this function, tTaken together with the output of +The output of this function, taken together with the output of g_settings_list_schemas() represents the complete list of all installed schemas. @@ -24465,7 +45925,8 @@ freed. <function name="g_settings_new"> <description> -Creates a new #GSettings object with a given schema. +Creates a new #GSettings object with the schema specified by +@schema_id. Signals on the newly created #GSettings object will be dispatched via the thread-default #GMainContext in effect at the time of the @@ -24476,21 +45937,71 @@ Since: 2.26 </description> <parameters> +<parameter name="schema_id"> +<parameter_description> the id of the schema +</parameter_description> +</parameter> +</parameters> +<return> a new #GSettings object + +</return> +</function> + +<function name="g_settings_new_full"> +<description> +Creates a new #GSettings object with a given schema, backend and +path. + +It should be extremely rare that you ever want to use this function. +It is made available for advanced use-cases (such as plugin systems +that want to provide access to schemas loaded from custom locations, +etc). + +At the most basic level, a #GSettings object is a pure composition of +4 things: a #GSettingsSchema, a #GSettingsBackend, a path within that +backend, and a #GMainContext to which signals are dispatched. + +This constructor therefore gives you full control over constructing +#GSettings instances. The first 4 parameters are given directly as +@schema, @backend and @path, and the main context is taken from the +thread-default (as per g_settings_new()). + +If @backend is %NULL then the default backend is used. + +If @path is %NULL then the path from the schema is used. It is an +error f @path is %NULL and the schema has no path of its own or if +@path is non-%NULL and not equal to the path that the schema does +have. + +Since: 2.32 + +</description> +<parameters> <parameter name="schema"> -<parameter_description> the name of the schema +<parameter_description> a #GSettingsSchema +</parameter_description> +</parameter> +<parameter name="backend"> +<parameter_description> a #GSettingsBackend +</parameter_description> +</parameter> +<parameter name="path"> +<parameter_description> the path to use </parameter_description> </parameter> </parameters> <return> a new #GSettings object + </return> </function> <function name="g_settings_new_with_backend"> <description> -Creates a new #GSettings object with a given schema and backend. +Creates a new #GSettings object with the schema specified by +@schema_id and a given #GSettingsBackend. -Creating settings objects with an different backend allows accessing settings -from a database other than the usual one. For example, it may make +Creating a #GSettings object with a different backend allows accessing +settings from a database other than the usual one. For example, it may make sense to pass a backend corresponding to the "defaults" settings database on the system to get a settings object that modifies the system default settings instead of the settings for this user. @@ -24499,8 +46010,8 @@ Since: 2.26 </description> <parameters> -<parameter name="schema"> -<parameter_description> the name of the schema +<parameter name="schema_id"> +<parameter_description> the id of the schema </parameter_description> </parameter> <parameter name="backend"> @@ -24509,13 +46020,14 @@ Since: 2.26 </parameter> </parameters> <return> a new #GSettings object + </return> </function> <function name="g_settings_new_with_backend_and_path"> <description> -Creates a new #GSettings object with a given schema, backend and -path. +Creates a new #GSettings object with the schema specified by +@schema_id and a given #GSettingsBackend and path. This is a mix of g_settings_new_with_backend() and g_settings_new_with_path(). @@ -24524,8 +46036,8 @@ Since: 2.26 </description> <parameters> -<parameter name="schema"> -<parameter_description> the name of the schema +<parameter name="schema_id"> +<parameter_description> the id of the schema </parameter_description> </parameter> <parameter name="backend"> @@ -24538,12 +46050,14 @@ Since: 2.26 </parameter> </parameters> <return> a new #GSettings object + </return> </function> <function name="g_settings_new_with_path"> <description> -Creates a new #GSettings object with a given schema and path. +Creates a new #GSettings object with the relocatable schema specified +by @schema_id and a given path. You only need to do this if you want to directly create a settings object with a schema that doesn't have a specified path of its own. @@ -24556,8 +46070,8 @@ Since: 2.26 </description> <parameters> -<parameter name="schema"> -<parameter_description> the name of the schema +<parameter name="schema_id"> +<parameter_description> the id of the schema </parameter_description> </parameter> <parameter name="path"> @@ -24566,6 +46080,7 @@ Since: 2.26 </parameter> </parameters> <return> a new #GSettings object + </return> </function> @@ -24599,6 +46114,7 @@ Since: 2.28 </parameter> </parameters> <return> %TRUE if @value is valid for @key + </return> </function> @@ -24643,6 +46159,235 @@ Change notifications will be emitted for affected keys. <return></return> </function> +<function name="g_settings_schema_get_id"> +<description> +Get the ID of @schema. + + +</description> +<parameters> +<parameter name="schema"> +<parameter_description> a #GSettingsSchema +</parameter_description> +</parameter> +</parameters> +<return> the ID +</return> +</function> + +<function name="g_settings_schema_get_path"> +<description> +Gets the path associated with @schema, or %NULL. + +Schemas may be single-instance or relocatable. Single-instance +schemas correspond to exactly one set of keys in the backend +database: those located at the path returned by this function. + +Relocatable schemas can be referenced by other schemas and can +threfore describe multiple sets of keys at different locations. For +relocatable schemas, this function will return %NULL. + +Since: 2.32 + +</description> +<parameters> +<parameter name="schema"> +<parameter_description> a #GSettingsSchema +</parameter_description> +</parameter> +</parameters> +<return> the path of the schema, or %NULL + +</return> +</function> + +<function name="g_settings_schema_ref"> +<description> +Increase the reference count of @schema, returning a new reference. + +Since: 2.32 + +</description> +<parameters> +<parameter name="schema"> +<parameter_description> a #GSettingsSchema +</parameter_description> +</parameter> +</parameters> +<return> a new reference to @schema + +</return> +</function> + +<function name="g_settings_schema_source_get_default"> +<description> +Gets the default system schema source. + +This function is not required for normal uses of #GSettings but it +may be useful to authors of plugin management systems or to those who +want to introspect the content of schemas. + +If no schemas are installed, %NULL will be returned. + +The returned source may actually consist of multiple schema sources +from different directories, depending on which directories were given +in <envar>XDG_DATA_DIRS</envar> and +<envar>GSETTINGS_SCHEMA_DIR</envar>. For this reason, all lookups +performed against the default source should probably be done +recursively. + +Since: 2.32 + +</description> +<parameters> +</parameters> +<return> the default schema source + +</return> +</function> + +<function name="g_settings_schema_source_lookup"> +<description> +Looks up a schema with the identifier @schema_id in @source. + +This function is not required for normal uses of #GSettings but it +may be useful to authors of plugin management systems or to those who +want to introspect the content of schemas. + +If the schema isn't found directly in @source and @recursive is %TRUE +then the parent sources will also be checked. + +If the schema isn't found, %NULL is returned. + +Since: 2.32 + +</description> +<parameters> +<parameter name="source"> +<parameter_description> a #GSettingsSchemaSource +</parameter_description> +</parameter> +<parameter name="schema_id"> +<parameter_description> a schema ID +</parameter_description> +</parameter> +<parameter name="recursive"> +<parameter_description> %TRUE if the lookup should be recursive +</parameter_description> +</parameter> +</parameters> +<return> a new #GSettingsSchema + +</return> +</function> + +<function name="g_settings_schema_source_new_from_directory"> +<description> +Attempts to create a new schema source corresponding to the contents +of the given directory. + +This function is not required for normal uses of #GSettings but it +may be useful to authors of plugin management systems. + +The directory should contain a file called +<filename>gschemas.compiled</filename> as produced by +<command>glib-compile-schemas</command>. + +If @trusted is %TRUE then <filename>gschemas.compiled</filename> is +trusted not to be corrupted. This assumption has a performance +advantage, but can result in crashes or inconsistent behaviour in the +case of a corrupted file. Generally, you should set @trusted to +%TRUE for files installed by the system and to %FALSE for files in +the home directory. + +If @parent is non-%NULL then there are two effects. + +First, if g_settings_schema_source_lookup() is called with the +@recursive flag set to %TRUE and the schema can not be found in the +source, the lookup will recurse to the parent. + +Second, any references to other schemas specified within this +source (ie: <literal>child</literal> or <literal>extents</literal>) +references may be resolved from the @parent. + +For this second reason, except in very unusual situations, the +@parent should probably be given as the default schema source, as +returned by g_settings_schema_source_get_default(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="directory"> +<parameter_description> the filename of a directory +</parameter_description> +</parameter> +<parameter name="parent"> +<parameter_description> a #GSettingsSchemaSource, or %NULL +</parameter_description> +</parameter> +<parameter name="trusted"> +<parameter_description> %TRUE, if the directory is trusted +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a pointer to a #GError pointer set to %NULL, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_settings_schema_source_ref"> +<description> +Increase the reference count of @source, returning a new reference. + +Since: 2.32 + +</description> +<parameters> +<parameter name="source"> +<parameter_description> a #GSettingsSchemaSource +</parameter_description> +</parameter> +</parameters> +<return> a new reference to @source + +</return> +</function> + +<function name="g_settings_schema_source_unref"> +<description> +Decrease the reference count of @source, possibly freeing it. + +Since: 2.32 + +</description> +<parameters> +<parameter name="source"> +<parameter_description> a #GSettingsSchemaSource +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_settings_schema_unref"> +<description> +Decrease the reference count of @schema, possibly freeing it. + +Since: 2.32 + +</description> +<parameters> +<parameter name="schema"> +<parameter_description> a #GSettingsSchema +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_settings_set"> <description> Sets @key in @settings to @value. @@ -24677,6 +46422,7 @@ Since: 2.26 </parameters> <return> %TRUE if setting the key succeeded, %FALSE if the key was not writable + </return> </function> @@ -24708,6 +46454,7 @@ Since: 2.26 </parameters> <return> %TRUE if setting the key succeeded, %FALSE if the key was not writable + </return> </function> @@ -24739,6 +46486,7 @@ Since: 2.26 </parameters> <return> %TRUE if setting the key succeeded, %FALSE if the key was not writable + </return> </function> @@ -24755,6 +46503,7 @@ After performing the write, accessing @key directly with g_settings_get_string() will return the 'nick' associated with @value. + </description> <parameters> <parameter name="settings"> @@ -24777,7 +46526,7 @@ g_settings_get_string() will return the 'nick' associated with <function name="g_settings_set_flags"> <description> Looks up the flags type nicks for the bits specified by @value, puts -them in an array of strings and writes the array to @key, withing +them in an array of strings and writes the array to @key, within @settings. It is a programmer error to give a @key that isn't contained in the @@ -24788,6 +46537,7 @@ After performing the write, accessing @key directly with g_settings_get_strv() will return an array of 'nicks'; one for each bit in @value. + </description> <parameters> <parameter name="settings"> @@ -24835,6 +46585,7 @@ Since: 2.26 </parameters> <return> %TRUE if setting the key succeeded, %FALSE if the key was not writable + </return> </function> @@ -24866,6 +46617,7 @@ Since: 2.26 </parameters> <return> %TRUE if setting the key succeeded, %FALSE if the key was not writable + </return> </function> @@ -24898,6 +46650,40 @@ Since: 2.26 </parameters> <return> %TRUE if setting the key succeeded, %FALSE if the key was not writable + +</return> +</function> + +<function name="g_settings_set_uint"> +<description> +Sets @key in @settings to @value. + +A convenience variant of g_settings_set() for 32-bit unsigned +integers. + +It is a programmer error to give a @key that isn't specified as +having a uint32 type in the schema for @settings. + +Since: 2.30 + +</description> +<parameters> +<parameter name="settings"> +<parameter_description> a #GSettings object +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the name of the key to set +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the value to set it to +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if setting the key succeeded, +%FALSE if the key was not writable + </return> </function> @@ -24930,6 +46716,7 @@ Since: 2.26 </parameters> <return> %TRUE if setting the key succeeded, %FALSE if the key was not writable + </return> </function> @@ -24977,6 +46764,36 @@ Since: 2.26 <return></return> </function> +<function name="g_simple_action_group_add_entries"> +<description> +A convenience function for creating multiple #GSimpleAction instances +and adding them to the action group. + +Since: 2.30 + +</description> +<parameters> +<parameter name="simple"> +<parameter_description> a #GSimpleActionGroup +</parameter_description> +</parameter> +<parameter name="entries"> +<parameter_description> a pointer to the first item in +an array of #GActionEntry structs +</parameter_description> +</parameter> +<parameter name="n_entries"> +<parameter_description> the length of @entries, or -1 +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the user data for signal connections +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_simple_action_group_insert"> <description> Adds an action to the action group. @@ -25124,6 +46941,9 @@ Sets the action as enabled or not. An action must be enabled in order to be activated or in order to have its state changed from outside callers. +This should only be called by the implementor of the action. Users +of the action should not attempt to modify its enabled flag. + Since: 2.28 </description> @@ -25140,6 +46960,33 @@ Since: 2.28 <return></return> </function> +<function name="g_simple_action_set_state"> +<description> +Sets the state of the action. + +This directly updates the 'state' property to the given value. + +This should only be called by the implementor of the action. Users +of the action should not attempt to directly modify the 'state' +property. Instead, they should call g_action_change_state() to +request the change. + +Since: 2.30 + +</description> +<parameters> +<parameter name="simple"> +<parameter_description> a #GSimpleAction +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the new #GVariant for the state +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_simple_async_report_error_in_idle"> <description> Reports an error in an asynchronous function in an idle function by @@ -25262,7 +47109,8 @@ is needed to complete the call. <description> Completes an asynchronous function in an idle handler in the <link linkend="g-main-context-push-thread-default">thread-default main -loop</link> of the thread that @simple was initially created in. +loop</link> of the thread that @simple was initially created in +(and re-pushes that context around the invocation of the callback). Calling this function takes a reference to @simple for as long as is needed to complete the call. @@ -25751,6 +47599,7 @@ Since: 2.26 </parameter> </parameters> <return> the #GSimplePermission, as a #GPermission + </return> </function> @@ -25955,7 +47804,7 @@ Converts a #GSocketAddress to a native <type>struct sockaddr</type>, which can be passed to low-level functions like connect() or bind(). -If not enough space is availible, a %G_IO_ERROR_NO_SPACE error is +If not enough space is available, a %G_IO_ERROR_NO_SPACE error is returned. If the address type is not known on the system then a %G_IO_ERROR_NOT_SUPPORTED error is returned. @@ -26062,7 +47911,7 @@ Since: 2.22 Enable proxy protocols to be handled by the application. When the indicated proxy protocol is returned by the #GProxyResolver, #GSocketClient will consider this protocol as supported but will -not try find a #GProxy instance to handle handshaking. The +not try to find a #GProxy instance to handle handshaking. The application must check for this case by calling g_socket_connection_get_remote_address() on the returned #GSocketConnection, and seeing if it's a #GProxyAddress of the @@ -26075,6 +47924,10 @@ proxy protocols that are reused between protocols. A good example is HTTP. It can be used to proxy HTTP, FTP and Gopher and can also be use as generic socket proxy through the HTTP CONNECT method. +When the proxy is detected as being an application proxy, TLS handshake +will be skipped. This is required to let the application do the proxy +specific handshake. + </description> <parameters> <parameter name="client"> @@ -26091,7 +47944,7 @@ be use as generic socket proxy through the HTTP CONNECT method. <function name="g_socket_client_connect"> <description> -Tries to resolve the @connectable and make a network connection to it.. +Tries to resolve the @connectable and make a network connection to it. Upon a successful connection, a new #GSocketConnection is constructed and returned. The caller owns this new object and must drop their @@ -26101,7 +47954,7 @@ The type of the #GSocketConnection object returned depends on the type of the underlying socket that is used. For instance, for a TCP/IP connection it will be a #GTcpConnection. -The socket created will be the same family as the the address that the +The socket created will be the same family as the address that the @connectable resolves to, unless family is set with g_socket_client_set_family() or indirectly via g_socket_client_set_local_address(). The socket type defaults to %G_SOCKET_TYPE_STREAM but can be set with @@ -26149,7 +48002,7 @@ Since: 2.22 </description> <parameters> <parameter name="client"> -<parameter_description> a #GTcpClient +<parameter_description> a #GSocketClient </parameter_description> </parameter> <parameter name="connectable"> @@ -26189,7 +48042,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -26205,7 +48058,7 @@ This is a helper function for g_socket_client_connect(). Attempts to create a TCP connection to the named host. -@host_and_port may be in any of a number of recognised formats; an IPv6 +@host_and_port may be in any of a number of recognized formats; an IPv6 address, an IPv4 address, or a domain name (in which case a DNS lookup is performed). Quoting with [] is supported for all address types. A port override may be specified in the usual way with a @@ -26216,7 +48069,7 @@ If no port override is given in @host_and_port then @default_port will be used as the port number to connect to. In general, @host_and_port is expected to be provided by the user (allowing -them to give the hostname, and a port overide if necessary) and +them to give the hostname, and a port override if necessary) and @default_port is expected to be provided by the application. In the case that an IP address is given, a single connection @@ -26275,7 +48128,7 @@ Since: 2.22 </description> <parameters> <parameter name="client"> -<parameter_description> a #GTcpClient +<parameter_description> a #GSocketClient </parameter_description> </parameter> <parameter name="host_and_port"> @@ -26319,7 +48172,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -26346,6 +48199,7 @@ In the event of any failure (DNS error, service not found, no hosts connectable) %NULL is returned and @error (if non-%NULL) is set accordingly. + </description> <parameters> <parameter name="client"> @@ -26427,7 +48281,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -26548,7 +48402,7 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -26611,7 +48465,7 @@ Since: 2.22 </parameter_description> </parameter> </parameters> -<return> a #GSocketAddres or %NULL. don't free +<return> a #GSocketAddress or %NULL. Do not free. </return> </function> @@ -26785,7 +48639,7 @@ Sets the local address of the socket client. The sockets created by this object will bound to the specified address (if not %NULL) before connecting. -This is useful if you want to ensure the the local +This is useful if you want to ensure that the local side of the connection is on a specific port, or on a specific interface. @@ -26893,6 +48747,14 @@ actually wraps the resulting #GTlsClientConnection in a g_tcp_wrapper_connection_get_base_io_stream() on the return value to extract the #GTlsClientConnection. +If you need to modify the behavior of the TLS handshake (eg, by +setting a client-side certificate to use, or connecting to the +#GTlsConnection::accept-certificate signal), you can connect to +@client's #GSocketClient::event signal and wait for it to be +emitted with %G_SOCKET_CLIENT_TLS_HANDSHAKING, which will give you +a chance to see the #GTlsClientConnection before the handshake +starts. + Since: 2.28 </description> @@ -27071,7 +48933,7 @@ default address. If the connect call needs to do network I/O it will block, unless non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned and the user can be notified of the connection finishing by waiting -for the G_IO_OUT condition. The result of the connection can then be +for the G_IO_OUT condition. The result of the connection must then be checked with g_socket_check_connect_result(). Since: 2.22 @@ -27142,6 +49004,99 @@ Since: 2.26 </return> </function> +<function name="g_socket_connection_connect"> +<description> +Connect @connection to the specified remote address. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GSocketConnection +</parameter_description> +</parameter> +<parameter name="address"> +<parameter_description> a #GSocketAddress specifying the remote address. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a %GCancellable or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the connection succeeded, %FALSE on error + +</return> +</function> + +<function name="g_socket_connection_connect_async"> +<description> +Asynchronously connect @connection to the specified remote address. + +This clears the #GSocket:blocking flag on @connection's underlying +socket if it is currently set. + +Use g_socket_connection_connect_finish() to retrieve the result. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GSocketConnection +</parameter_description> +</parameter> +<parameter name="address"> +<parameter_description> a #GSocketAddress specifying the remote address. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a %GCancellable or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data for the callback +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_socket_connection_connect_finish"> +<description> +Gets the result of a g_socket_connection_connect_async() call. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GSocketConnection +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> the #GAsyncResult +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the connection succeeded, %FALSE on error + +</return> +</function> + <function name="g_socket_connection_factory_create_connection"> <description> Creates a #GSocketConnection subclass of the right type for @@ -27164,7 +49119,7 @@ Since: 2.22 <function name="g_socket_connection_factory_lookup_type"> <description> Looks up the #GType to be used when creating socket connections on -sockets with the specified @family,@type and @protocol_id. +sockets with the specified @family, @type and @protocol_id. If no type is registered, the #GSocketConnection base type is returned. @@ -27193,7 +49148,7 @@ Since: 2.22 <function name="g_socket_connection_factory_register_type"> <description> Looks up the #GType to be used when creating socket connections on -sockets with the specified @family,@type and @protocol. +sockets with the specified @family, @type and @protocol. If no type is registered, the #GSocketConnection base type is returned. @@ -27287,6 +49242,25 @@ Since: 2.22 </return> </function> +<function name="g_socket_connection_is_connected"> +<description> +Checks if @connection is connected. This is equivalent to calling +g_socket_is_connected() on @connection's underlying #GSocket. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> a #GSocketConnection +</parameter_description> +</parameter> +</parameters> +<return> whether @connection is connected + +</return> +</function> + <function name="g_socket_control_message_deserialize"> <description> Tries to deserialize a socket control message of a given @@ -27449,6 +49423,25 @@ Since: 2.22 </return> </function> +<function name="g_socket_get_available_bytes"> +<description> +Get the amount of data pending in the OS input buffer. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket +</parameter_description> +</parameter> +</parameters> +<return> the number of bytes that can be read from the socket +without blocking or -1 on error. + +</return> +</function> + <function name="g_socket_get_blocking"> <description> Gets the blocking mode of the socket. For details on blocking I/O, @@ -27468,6 +49461,26 @@ Since: 2.22 </return> </function> +<function name="g_socket_get_broadcast"> +<description> +Gets the broadcast setting on @socket; if %TRUE, +it is possible to send packets to broadcast +addresses or receive from broadcast addresses. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +</parameters> +<return> the broadcast setting on @socket + +</return> +</function> + <function name="g_socket_get_credentials"> <description> Returns the credentials of the foreign process connected to this @@ -27605,6 +49618,45 @@ Free the returned object with g_object_unref(). </return> </function> +<function name="g_socket_get_multicast_loopback"> +<description> +Gets the multicast loopback setting on @socket; if %TRUE (the +default), outgoing multicast packets will be looped back to +multicast listeners on the same host. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +</parameters> +<return> the multicast loopback setting on @socket + +</return> +</function> + +<function name="g_socket_get_multicast_ttl"> +<description> +Gets the multicast time-to-live setting on @socket; see +g_socket_set_multicast_ttl() for more details. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +</parameters> +<return> the multicast time-to-live setting on @socket + +</return> +</function> + <function name="g_socket_get_protocol"> <description> Gets the socket protocol id the socket was created with. @@ -27685,6 +49737,25 @@ Since: 2.26 </return> </function> +<function name="g_socket_get_ttl"> +<description> +Gets the unicast time-to-live setting on @socket; see +g_socket_set_ttl() for more details. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +</parameters> +<return> the time-to-live setting on @socket + +</return> +</function> + <function name="g_socket_is_closed"> <description> Checks whether a socket is closed. @@ -27722,6 +49793,89 @@ Since: 2.22 </return> </function> +<function name="g_socket_join_multicast_group"> +<description> +Registers @socket to receive multicast messages sent to @group. +@socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have +been bound to an appropriate interface and port with +g_socket_bind(). + +If @iface is %NULL, the system will automatically pick an interface +to bind to based on @group. + +If @source_specific is %TRUE, source-specific multicast as defined +in RFC 4604 is used. Note that on older platforms this may fail +with a %G_IO_ERROR_NOT_SUPPORTED error. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +<parameter name="group"> +<parameter_description> a #GInetAddress specifying the group address to join. +</parameter_description> +</parameter> +<parameter name="iface"> +<parameter_description> Name of the interface to use, or %NULL +</parameter_description> +</parameter> +<parameter name="source_specific"> +<parameter_description> %TRUE if source-specific multicast should be used +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success, %FALSE on error. + +</return> +</function> + +<function name="g_socket_leave_multicast_group"> +<description> +Removes @socket from the multicast group defined by @group, @iface, +and @source_specific (which must all have the same values they had +when you joined the group). + +@socket remains bound to its address and port, and can still receive +unicast messages after calling this. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +<parameter name="group"> +<parameter_description> a #GInetAddress specifying the group address to leave. +</parameter_description> +</parameter> +<parameter name="iface"> +<parameter_description> Interface used +</parameter_description> +</parameter> +<parameter name="source_specific"> +<parameter_description> %TRUE if source-specific multicast was used +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success, %FALSE on error. + +</return> +</function> + <function name="g_socket_listen"> <description> Marks the socket as a server socket, i.e. a socket that is used @@ -27844,7 +49998,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -27950,7 +50104,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -27968,7 +50122,7 @@ sockets from. Note that adding an IPv6 address, depending on the platform, may or may not result in a listener that also accepts IPv4 -connections. For more determinstic behaviour, see +connections. For more deterministic behavior, see g_socket_listener_add_inet_port(). @source_object will be passed out in the various calls @@ -27977,7 +50131,7 @@ useful if you're listening on multiple addresses and do different things depending on what address is connected to. If successful and @effective_address is non-%NULL then it will -be set to the address that the binding actually occured at. This +be set to the address that the binding actually occurred at. This is helpful for determining the port number that was used for when requesting a binding to port 0 (ie: "any port"). This address, if requested, belongs to the caller and must be freed. @@ -28023,7 +50177,7 @@ Since: 2.22 <function name="g_socket_listener_add_any_inet_port"> <description> Listens for TCP connections on any available port number for both -IPv6 and IPv4 (if each are available). +IPv6 and IPv4 (if each is available). This is useful if you need to have a socket for incoming connections but don't care about the specific port number. @@ -28046,7 +50200,7 @@ Since: 2.24 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -28273,10 +50427,11 @@ number of bytes, up to @size. If more than @size bytes have been received, the additional data will be returned in future calls to g_socket_receive(). -If the socket is in blocking mode the call will block until there is -some data to receive or there is an error. If there is no data available -and the socket is in non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error -will be returned. To be notified when data is available, wait for the +If the socket is in blocking mode the call will block until there +is some data to receive, the connection is closed, or there is an +error. If there is no data available and the socket is in +non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be +returned. To be notified when data is available, wait for the %G_IO_IN condition. On error -1 is returned and @error is set accordingly. @@ -28307,7 +50462,8 @@ bytes long). </parameter_description> </parameter> </parameters> -<return> Number of bytes read, or -1 on error +<return> Number of bytes read, or 0 if the connection was closed by +the peer, or -1 on error </return> </function> @@ -28331,12 +50487,13 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="address"> -<parameter_description> a pointer to a #GSocketAddress pointer, or %NULL +<parameter_description> a pointer to a #GSocketAddress +pointer, or %NULL </parameter_description> </parameter> <parameter name="buffer"> -<parameter_description> a buffer to read data into (which should be at least @size -bytes long). +<parameter_description> a buffer to +read data into (which should be at least @size bytes long). </parameter_description> </parameter> <parameter name="size"> @@ -28352,7 +50509,8 @@ bytes long). </parameter_description> </parameter> </parameters> -<return> Number of bytes read, or -1 on error +<return> Number of bytes read, or 0 if the connection was closed by +the peer, or -1 on error </return> </function> @@ -28409,10 +50567,11 @@ out the length of the message other than by reading it into a sufficiently-large buffer. If the socket is in blocking mode the call will block until there -is some data to receive or there is an error. If there is no data -available and the socket is in non-blocking mode, a -%G_IO_ERROR_WOULD_BLOCK error will be returned. To be notified when -data is available, wait for the %G_IO_IN condition. +is some data to receive, the connection is closed, or there is an +error. If there is no data available and the socket is in +non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error will be +returned. To be notified when data is available, wait for the +%G_IO_IN condition. On error -1 is returned and @error is set accordingly. @@ -28425,7 +50584,8 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="address"> -<parameter_description> a pointer to a #GSocketAddress pointer, or %NULL +<parameter_description> a pointer to a #GSocketAddress +pointer, or %NULL </parameter_description> </parameter> <parameter name="vectors"> @@ -28459,7 +50619,8 @@ elements in @messages, or %NULL </parameter_description> </parameter> </parameters> -<return> Number of bytes read, or -1 on error +<return> Number of bytes read, or 0 if the connection was closed by +the peer, or -1 on error </return> </function> @@ -28500,7 +50661,8 @@ bytes long). </parameter_description> </parameter> </parameters> -<return> Number of bytes read, or -1 on error +<return> Number of bytes read, or 0 if the connection was closed by +the peer, or -1 on error </return> </function> @@ -28531,7 +50693,8 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="buffer"> -<parameter_description> the buffer containing the data to send. +<parameter_description> the buffer +containing the data to send. </parameter_description> </parameter> <parameter name="size"> @@ -28662,7 +50825,8 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="buffer"> -<parameter_description> the buffer containing the data to send. +<parameter_description> the buffer +containing the data to send. </parameter_description> </parameter> <parameter name="size"> @@ -28699,7 +50863,8 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="buffer"> -<parameter_description> the buffer containing the data to send. +<parameter_description> the buffer +containing the data to send. </parameter_description> </parameter> <parameter name="size"> @@ -28767,8 +50932,8 @@ Since: 2.22 Starts the service, i.e. start accepting connections from the added sockets when the mainloop runs. -This call is threadsafe, so it may be called from a thread -handling an incomming client request. +This call is thread-safe, so it may be called from a thread +handling an incoming client request. Since: 2.22 @@ -28787,8 +50952,8 @@ Since: 2.22 Stops the service, i.e. stops accepting connections from the added sockets when the mainloop runs. -This call is threadsafe, so it may be called from a thread -handling an incomming client request. +This call is thread-safe, so it may be called from a thread +handling an incoming client request. Since: 2.22 @@ -28829,6 +50994,28 @@ Since: 2.22 <return></return> </function> +<function name="g_socket_set_broadcast"> +<description> +Sets whether @socket should allow sending to and receiving from +broadcast addresses. This is %FALSE by default. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +<parameter name="broadcast"> +<parameter_description> whether @socket should allow sending to and receiving +from broadcast addresses +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_socket_set_keepalive"> <description> Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When @@ -28889,6 +51076,51 @@ Since: 2.22 <return></return> </function> +<function name="g_socket_set_multicast_loopback"> +<description> +Sets whether outgoing multicast packets will be received by sockets +listening on that multicast address on the same host. This is %TRUE +by default. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +<parameter name="loopback"> +<parameter_description> whether @socket should receive messages sent to its +multicast groups from the local host +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_socket_set_multicast_ttl"> +<description> +Sets the time-to-live for outgoing multicast datagrams on @socket. +By default, this is 1, meaning that multicast packets will not leave +the local network. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +<parameter name="ttl"> +<parameter_description> the time-to-live value for all multicast datagrams on @socket +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_socket_set_timeout"> <description> Sets the time in seconds after which I/O operations on @socket will @@ -28928,11 +51160,32 @@ Since: 2.26 <return></return> </function> +<function name="g_socket_set_ttl"> +<description> +Sets the time-to-live for outgoing unicast packets on @socket. +By default the platform-specific default value is used. + +Since: 2.32 + +</description> +<parameters> +<parameter name="socket"> +<parameter_description> a #GSocket. +</parameter_description> +</parameter> +<parameter name="ttl"> +<parameter_description> the time-to-live value for all unicast packets on @socket +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_socket_shutdown"> <description> Shut down part of a full-duplex connection. -If @shutdown_read is %TRUE then the recieving side of the connection +If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. If @shutdown_write is %TRUE then the sending side of the connection @@ -29160,6 +51413,69 @@ Since: 2.22 </return> </function> +<function name="g_static_resource_fini"> +<description> +Finalized a GResource initialized by g_static_resource_init (). + +This is normally used by code generated by +<link linkend="glib-compile-resources">glib-compile-resources</link> and is +not typically used by other code. + +Since: 2.32 + +</description> +<parameters> +<parameter name="static_resource"> +<parameter_description> pointer to a static #GStaticResource. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_static_resource_get_resource"> +<description> +Gets the GResource that was registred by a call to g_static_resource_init (). + +This is normally used by code generated by +<link linkend="glib-compile-resources">glib-compile-resources</link> and is +not typically used by other code. + +Since: 2.32 + +</description> +<parameters> +<parameter name="static_resource"> +<parameter_description> pointer to a static #GStaticResource. +</parameter_description> +</parameter> +</parameters> +<return> a #GResource. + +</return> +</function> + +<function name="g_static_resource_init"> +<description> +Initializes a GResource from static data using a +GStaticResource. + +This is normally used by code generated by +<link linkend="glib-compile-resources">glib-compile-resources</link> and is +not typically used by other code. + +Since: 2.32 + +</description> +<parameters> +<parameter name="static_resource"> +<parameter_description> pointer to a static #GStaticResource. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_tcp_connection_get_graceful_disconnect"> <description> Checks if graceful disconnects are used. See @@ -29182,7 +51498,7 @@ Since: 2.22 <function name="g_tcp_connection_set_graceful_disconnect"> <description> This enabled graceful disconnects on close. A graceful disconnect -means that we signal the recieving end that the connection is terminated +means that we signal the receiving end that the connection is terminated and wait for it to close the connection before closing the connection. A graceful disconnect means that we can be sure that we successfully sent @@ -29379,7 +51695,7 @@ Since: 2.18 <function name="g_threaded_socket_service_new"> <description> Creates a new #GThreadedSocketService with no listeners. Listeners -must be added with g_socket_service_add_listeners(). +must be added with one of the #GSocketListener "add" methods. Since: 2.22 @@ -29448,6 +51764,43 @@ Since: 2.28 </return> </function> +<function name="g_tls_backend_get_default_database"> +<description> +Gets the default #GTlsDatabase used to verify TLS connections. + +Since: 2.30 + +</description> +<parameters> +<parameter name="backend"> +<parameter_description> the #GTlsBackend +</parameter_description> +</parameter> +</parameters> +<return> the default database, which should be +unreffed when done. + +</return> +</function> + +<function name="g_tls_backend_get_file_database_type"> +<description> +Gets the #GTyep of @backend's #GTlsFileDatabase implementation. + +Since: 2.30 + +</description> +<parameters> +<parameter name="backend"> +<parameter_description> the #GTlsBackend +</parameter_description> +</parameter> +</parameters> +<return> the #GType of backend's #GTlsFileDatabase implementation. + +</return> +</function> + <function name="g_tls_backend_get_server_connection_type"> <description> Gets the #GType of @backend's #GTlsServerConnection implementation. @@ -29538,7 +51891,8 @@ and its contents when you are done with it. <description> Creates a #GTlsCertificate from the PEM-encoded data in @file. If @file cannot be read or parsed, the function will return %NULL and -set @error. Otherwise, this behaves like g_tls_certificate_new(). +set @error. Otherwise, this behaves like +g_tls_certificate_new_from_pem(). Since: 2.28 @@ -29563,7 +51917,7 @@ Since: 2.28 Creates a #GTlsCertificate from the PEM-encoded data in @cert_file and @key_file. If either file cannot be read or parsed, the function will return %NULL and set @error. Otherwise, this behaves -like g_tls_certificate_new(). +like g_tls_certificate_new_from_pem(). Since: 2.28 @@ -29591,7 +51945,9 @@ Since: 2.28 <description> Creates a new #GTlsCertificate from the PEM-encoded data in @data. If @data includes both a certificate and a private key, then the -returned certificate will include the private key data as well. +returned certificate will include the private key data as well. (See +the #GTlsCertificate:private-key-pem property for information about +supported formats.) If @data includes multiple certificates, only the first one will be parsed. @@ -29769,7 +52125,8 @@ Since: 2.28 </parameter_description> </parameter> </parameters> -<return> the new #GTlsClientConnection, or %NULL on error +<return> the new +#GTlsClientConnection, or %NULL on error </return> </function> @@ -29890,6 +52247,45 @@ Since: 2.28 </return> </function> +<function name="g_tls_connection_get_database"> +<description> +Gets the certificate database that @conn uses to verify +peer certificates. See g_tls_connection_set_database(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="conn"> +<parameter_description> a #GTlsConnection +</parameter_description> +</parameter> +</parameters> +<return> the certificate database that @conn uses or %NULL + +</return> +</function> + +<function name="g_tls_connection_get_interaction"> +<description> +Get the object that will be used to interact with the user. It will be used +for things like prompting the user for passwords. If %NULL is returned, then +no user interaction will occur for this connection. + +Since: 2.30 + +</description> +<parameters> +<parameter name="conn"> +<parameter_description> a connection +</parameter_description> +</parameter> +</parameters> +<return> The interaction object. + +</return> +</function> + <function name="g_tls_connection_get_peer_certificate"> <description> Gets @conn's peer's certificate after the handshake has completed. @@ -29933,7 +52329,7 @@ Since: 2.28 <function name="g_tls_connection_get_rehandshake_mode"> <description> Gets @conn rehandshaking mode. See -g_tls_connection_set_rehandshake() for details. +g_tls_connection_set_rehandshake_mode() for details. Since: 2.28 @@ -29975,7 +52371,7 @@ notification. Gets whether @conn uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb(). -Since: 2.28 +Deprecated: 2.30: Use g_tls_connection_get_database() instead </description> <parameters> @@ -30135,6 +52531,58 @@ Since: 2.28 <return></return> </function> +<function name="g_tls_connection_set_database"> +<description> +Sets the certificate database that is used to verify peer certificates. +This is set to the default database by default. See +g_tls_backend_get_default_database(). If set to %NULL, then +peer certificate validation will always set the +%G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning +#GTlsConnection::accept-certificate will always be emitted on +client-side connections, unless that bit is not set in +#GTlsClientConnection:validation-flags). + +Since: 2.30 + +</description> +<parameters> +<parameter name="conn"> +<parameter_description> a #GTlsConnection +</parameter_description> +</parameter> +<parameter name="database"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_connection_set_interaction"> +<description> +Set the object that will be used to interact with the user. It will be used +for things like prompting the user for passwords. + +The @interaction argument will normally be a derived subclass of +#GTlsInteraction. %NULL can also be provided if no user interaction +should occur for this connection. + +Since: 2.30 + +</description> +<parameters> +<parameter name="conn"> +<parameter_description> a connection +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> an interaction object, or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_tls_connection_set_rehandshake_mode"> <description> Sets how @conn behaves with respect to rehandshaking requests. @@ -30229,7 +52677,7 @@ peer certificate validation will always set the client-side connections, unless that bit is not set in #GTlsClientConnection:validation-flags). -Since: 2.28 +Deprecated: 2.30: Use g_tls_connection_set_database() instead </description> <parameters> @@ -30245,6 +52693,532 @@ Since: 2.28 <return></return> </function> +<function name="g_tls_database_create_certificate_handle"> +<description> +Create a handle string for the certificate. The database will only be able +to create a handle for certificates that originate from the database. In +cases where the database cannot create a handle for a certificate, %NULL +will be returned. + +This handle should be stable across various instances of the application, +and between applications. If a certificate is modified in the database, +then it is not guaranteed that this handle will continue to point to it. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="certificate"> +<parameter_description> certificate for which to create a handle. +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated string containing the handle. +</return> +</function> + +<function name="g_tls_database_lookup_certificate_for_handle"> +<description> +Lookup a certificate by its handle. + +The handle should have been created by calling g_tls_database_create_handle() +on a #GTlsDatabase object of the same TLS backend. The handle is designed +to remain valid across instantiations of the database. + +If the handle is no longer valid, or does not point to a certificate in +this database, then %NULL will be returned. + +This function can block, use g_tls_database_lookup_certificate_for_handle_async() to perform +the lookup operation asynchronously. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="handle"> +<parameter_description> a certificate handle +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags which affect the lookup. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated +#GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. + +</return> +</function> + +<function name="g_tls_database_lookup_certificate_for_handle_async"> +<description> +Asynchronously lookup a certificate by its handle in the database. See +g_tls_database_lookup_handle() for more information. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="handle"> +<parameter_description> a certificate handle +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags which affect the lookup. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback to call when the operation completes +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to the callback function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_database_lookup_certificate_for_handle_finish"> +<description> +Finish an asynchronous lookup of a certificate by its handle. See +g_tls_database_lookup_handle() for more information. + +If the handle is no longer valid, or does not point to a certificate in +this database, then %NULL will be returned. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError pointer, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated #GTlsCertificate object. +Use g_object_unref() to release the certificate. + +</return> +</function> + +<function name="g_tls_database_lookup_certificate_issuer"> +<description> +Lookup the issuer of @certificate in the database. + +The %issuer property +of @certificate is not modified, and the two certificates are not hooked +into a chain. + +This function can block, use g_tls_database_lookup_certificate_issuer_async() to perform +the lookup operation asynchronously. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="certificate"> +<parameter_description> a #GTlsCertificate +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> flags which affect the lookup operation +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated issuer #GTlsCertificate, +or %NULL. Use g_object_unref() to release the certificate. + +</return> +</function> + +<function name="g_tls_database_lookup_certificate_issuer_async"> +<description> +Asynchronously lookup the issuer of @certificate in the database. See +g_tls_database_lookup_certificate_issuer() for more information. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="certificate"> +<parameter_description> a #GTlsCertificate +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> flags which affect the lookup operation +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback to call when the operation completes +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to the callback function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_database_lookup_certificate_issuer_finish"> +<description> +Finish an asynchronous lookup issuer operation. See +g_tls_database_lookup_certificate_issuer() for more information. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError pointer, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated issuer #GTlsCertificate, +or %NULL. Use g_object_unref() to release the certificate. + +</return> +</function> + +<function name="g_tls_database_lookup_certificates_issued_by"> +<description> +Lookup certificates issued by this issuer in the database. + +This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform +the lookup operation asynchronously. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="issuer_raw_dn"> +<parameter_description> a #GByteArray which holds the DER encoded issuer DN. +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags which affect the lookup operation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated list of #GTlsCertificate +objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. + +</return> +</function> + +<function name="g_tls_database_lookup_certificates_issued_by_async"> +<description> +Asynchronously lookup certificates issued by this issuer in the database. See +g_tls_database_lookup_certificates_issued_by() for more information. + +The database may choose to hold a reference to the issuer byte array for the duration +of of this asynchronous operation. The byte array should not be modified during +this time. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="issuer_raw_dn"> +<parameter_description> a #GByteArray which holds the DER encoded issuer DN. +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> Flags which affect the lookup operation. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback to call when the operation completes +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to the callback function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_database_lookup_certificates_issued_by_finish"> +<description> +Finish an asynchronous lookup of certificates. See +g_tls_database_lookup_certificates_issued_by() for more information. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError pointer, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated list of #GTlsCertificate objects. +Use g_object_unref() on each certificate, and g_list_free() on the release the list. + +</return> +</function> + +<function name="g_tls_database_verify_chain"> +<description> +Verify's a certificate chain after looking up and adding any missing +certificates to the chain. + +@chain is a chain of #GTlsCertificate objects each pointing to the next +certificate in the chain by its %issuer property. The chain may initially +consist of one or more certificates. After the verification process is +complete, @chain may be modified by adding missing certificates, or removing +extra certificates. If a certificate anchor was found, then it is added to +the @chain. + +@purpose describes the purpose (or usage) for which the certificate +is being used. Typically @purpose will be set to #G_TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER +which means that the certificate is being used to authenticate a server +(and we are acting as the client). + +The @identity is used to check for pinned certificates (trust exceptions) +in the database. These will override the normal verification process on a +host by host basis. + +Currently there are no @flags, and %G_TLS_DATABASE_VERIFY_NONE should be +used. + +This function can block, use g_tls_database_verify_chain_async() to perform +the verification operation asynchronously. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="chain"> +<parameter_description> a #GTlsCertificate chain +</parameter_description> +</parameter> +<parameter name="purpose"> +<parameter_description> the purpose that this certificate chain will be used for. +</parameter_description> +</parameter> +<parameter name="identity"> +<parameter_description> the expected peer identity +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> additional verify flags +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> the appropriate #GTlsCertificateFlags which represents the +result of verification. + +</return> +</function> + +<function name="g_tls_database_verify_chain_async"> +<description> +Asynchronously verify's a certificate chain after looking up and adding +any missing certificates to the chain. See g_tls_database_verify_chain() +for more information. + +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="chain"> +<parameter_description> a #GTlsCertificate chain +</parameter_description> +</parameter> +<parameter name="purpose"> +<parameter_description> the purpose that this certificate chain will be used for. +</parameter_description> +</parameter> +<parameter name="identity"> +<parameter_description> the expected peer identity +</parameter_description> +</parameter> +<parameter name="interaction"> +<parameter_description> used to interact with the user if necessary +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> additional verify flags +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> a #GCancellable, or %NULL +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> callback to call when the operation completes +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to the callback function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_database_verify_chain_finish"> +<description> +Finish an asynchronous verify chain operation. See +g_tls_database_verify_chain() for more information. * +Since: 2.30 + +</description> +<parameters> +<parameter name="self"> +<parameter_description> a #GTlsDatabase +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError pointer, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> the appropriate #GTlsCertificateFlags which represents the +result of verification. + +</return> +</function> + <function name="g_tls_error_quark"> <description> Gets the TLS error quark. @@ -30259,6 +53233,433 @@ Since: 2.28 </return> </function> +<function name="g_tls_file_database_new"> +<description> +Creates a new #GTlsFileDatabase which uses anchor certificate authorities +in @anchors to verify certificate chains. + +The certificates in @anchors must be PEM encoded. + +Since: 2.30 + +</description> +<parameters> +<parameter name="anchors"> +<parameter_description> filename of anchor certificate authorities. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> #GError for error reporting, or %NULL to ignore. +</parameter_description> +</parameter> +</parameters> +<return> the new +#GTlsFileDatabase, or %NULL on error + +</return> +</function> + +<function name="g_tls_interaction_ask_password"> +<description> +Run synchronous interaction to ask the user for a password. In general, +g_tls_interaction_invoke_ask_password() should be used instead of this +function. + +Derived subclasses usually implement a password prompt, although they may +also choose to provide a password from elsewhere. The @password value will +be filled in and then @callback will be called. Alternatively the user may +abort this password request, which will usually abort the TLS connection. + +If the interaction is cancelled by the cancellation object, or by the +user then %G_TLS_INTERACTION_FAILED will be returned with an error that +contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may +not support immediate cancellation. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interaction"> +<parameter_description> a #GTlsInteraction object +</parameter_description> +</parameter> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> an optional #GCancellable cancellation object +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> an optional location to place an error on failure +</parameter_description> +</parameter> +</parameters> +<return> The status of the ask password interaction. + +</return> +</function> + +<function name="g_tls_interaction_ask_password_async"> +<description> +Run asynchronous interaction to ask the user for a password. In general, +g_tls_interaction_invoke_ask_password() should be used instead of this +function. + +Derived subclasses usually implement a password prompt, although they may +also choose to provide a password from elsewhere. The @password value will +be filled in and then @callback will be called. Alternatively the user may +abort this password request, which will usually abort the TLS connection. + +If the interaction is cancelled by the cancellation object, or by the +user then %G_TLS_INTERACTION_FAILED will be returned with an error that +contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may +not support immediate cancellation. + +Certain implementations may not support immediate cancellation. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interaction"> +<parameter_description> a #GTlsInteraction object +</parameter_description> +</parameter> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> an optional #GCancellable cancellation object +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> will be called when the interaction completes +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data to pass to the @callback +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_interaction_ask_password_finish"> +<description> +Complete an ask password user interaction request. This should be once +the g_tls_interaction_ask_password_async() completion callback is called. + +If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsPassword passed +to g_tls_interaction_ask_password() will have its password filled in. + +If the interaction is cancelled by the cancellation object, or by the +user then %G_TLS_INTERACTION_FAILED will be returned with an error that +contains a %G_IO_ERROR_CANCELLED error code. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interaction"> +<parameter_description> a #GTlsInteraction object +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> the result passed to the callback +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> an optional location to place an error on failure +</parameter_description> +</parameter> +</parameters> +<return> The status of the ask password interaction. + +</return> +</function> + +<function name="g_tls_interaction_invoke_ask_password"> +<description> +Invoke the interaction to ask the user for a password. It invokes this +interaction in the main loop, specifically the #GMainContext returned by +g_main_context_get_thread_default() when the interaction is created. This +is called by called by #GTlsConnection or #GTlsDatabase to ask the user +for a password. + +Derived subclasses usually implement a password prompt, although they may +also choose to provide a password from elsewhere. The @password value will +be filled in and then @callback will be called. Alternatively the user may +abort this password request, which will usually abort the TLS connection. + +The implementation can either be a synchronous (eg: modal dialog) or an +asynchronous one (eg: modeless dialog). This function will take care of +calling which ever one correctly. + +If the interaction is cancelled by the cancellation object, or by the +user then %G_TLS_INTERACTION_FAILED will be returned with an error that +contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may +not support immediate cancellation. + +Since: 2.30 + +</description> +<parameters> +<parameter name="interaction"> +<parameter_description> a #GTlsInteraction object +</parameter_description> +</parameter> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> an optional #GCancellable cancellation object +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> an optional location to place an error on failure +</parameter_description> +</parameter> +</parameters> +<return> The status of the ask password interaction. + +</return> +</function> + +<function name="g_tls_password_get_description"> +<description> +Get a description string about what the password will be used for. + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +</parameters> +<return> The description of the password. + +</return> +</function> + +<function name="g_tls_password_get_flags"> +<description> +Get flags about the password. + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +</parameters> +<return> The flags about the password. + +</return> +</function> + +<function name="g_tls_password_get_value"> +<description> +Get the password value. If @length is not %NULL then it will be +filled in with the length of the password value. (Note that the +password value is not nul-terminated, so you can only pass %NULL +for @length in contexts where you know the password will have a +certain fixed length.) + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> location to place the length of the password. +</parameter_description> +</parameter> +</parameters> +<return> The password value (owned by the password object). + +</return> +</function> + +<function name="g_tls_password_get_warning"> +<description> +Get a user readable translated warning. Usually this warning is a +representation of the password flags returned from +g_tls_password_get_flags(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +</parameters> +<return> The warning. + +</return> +</function> + +<function name="g_tls_password_new"> +<description> +Create a new #GTlsPassword object. + + +</description> +<parameters> +<parameter name="flags"> +<parameter_description> the password flags +</parameter_description> +</parameter> +<parameter name="description"> +<parameter_description> description of what the password is for +</parameter_description> +</parameter> +</parameters> +<return> The newly allocated password object +</return> +</function> + +<function name="g_tls_password_set_description"> +<description> +Set a description string about what the password will be used for. + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="description"> +<parameter_description> The description of the password +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_password_set_flags"> +<description> +Set flags about the password. + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> The flags about the password +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_password_set_value"> +<description> +Set the value for this password. The @value will be copied by the password +object. + +Specify the @length, for a non-nul-terminated password. Pass -1 as +@length if using a nul-terminated password, and @length will be +calculated automatically. (Note that the terminating nul is not +considered part of the password in this case.) + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the new password value +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> the length of the password, or -1 +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_password_set_value_full"> +<description> +Provide the value for this password. + +The @value will be owned by the password object, and later freed using +the @destroy function callback. + +Specify the @length, for a non-nul-terminated password. Pass -1 as +@length if using a nul-terminated password, and @length will be +calculated automatically. (Note that the terminating nul is not +considered part of the password in this case.) + +Virtual: set_value +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the value for the password +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> the length of the password, or -1 +</parameter_description> +</parameter> +<parameter name="destroy"> +<parameter_description> a function to use to free the password. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_tls_password_set_warning"> +<description> +Set a user readable translated warning. Usually this warning is a +representation of the password flags returned from +g_tls_password_get_flags(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="password"> +<parameter_description> a #GTlsPassword object +</parameter_description> +</parameter> +<parameter name="warning"> +<parameter_description> The user readable warning +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_tls_server_connection_new"> <description> Creates a new #GTlsServerConnection wrapping @base_io_stream (which @@ -30281,7 +53682,8 @@ Since: 2.28 </parameter_description> </parameter> </parameters> -<return> the new #GTlsServerConnection, or %NULL on error +<return> the new +#GTlsServerConnection, or %NULL on error </return> </function> @@ -30322,6 +53724,68 @@ g_object_unref()), %NULL if @error is set. </return> </function> +<function name="g_unix_connection_receive_credentials_async"> +<description> +Asynchronously receive credentials. + +For more details, see g_unix_connection_receive_credentials() which is +the synchronous version of this call. + +When the operation is finished, @callback will be called. You can then call +g_unix_connection_receive_credentials_finish() to get the result of the operation. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GUnixConnection. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to callback function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_unix_connection_receive_credentials_finish"> +<description> +Finishes an asynchronous receive credentials operation started with +g_unix_connection_receive_credentials_async(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GUnixConnection. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a #GCredentials, or %NULL on error. +Free the returned object with g_object_unref(). + +</return> +</function> + <function name="g_unix_connection_receive_fd"> <description> Receives a file descriptor from the sending end of the connection. @@ -30357,7 +53821,7 @@ Since: 2.22 <function name="g_unix_connection_send_credentials"> <description> Passes the credentials of the current user the receiving side -of the connection. The recieving end has to call +of the connection. The receiving end has to call g_unix_connection_receive_credentials() (or similar) to accept the credentials. @@ -30390,10 +53854,71 @@ Since: 2.26 </return> </function> +<function name="g_unix_connection_send_credentials_async"> +<description> +Asynchronously send credentials. + +For more details, see g_unix_connection_send_credentials() which is +the synchronous version of this call. + +When the operation is finished, @callback will be called. You can then call +g_unix_connection_send_credentials_finish() to get the result of the operation. + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GUnixConnection. +</parameter_description> +</parameter> +<parameter name="cancellable"> +<parameter_description> optional #GCancellable object, %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GAsyncReadyCallback to call when the request is satisfied +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> the data to pass to callback function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_unix_connection_send_credentials_finish"> +<description> +Finishes an asynchronous send credentials operation started with +g_unix_connection_send_credentials_async(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="connection"> +<parameter_description> A #GUnixConnection. +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> a #GAsyncResult. +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the operation was successful, otherwise %FALSE. + +</return> +</function> + <function name="g_unix_connection_send_fd"> <description> -Passes a file descriptor to the recieving side of the -connection. The recieving end has to call g_unix_connection_receive_fd() +Passes a file descriptor to the receiving side of the +connection. The receiving end has to call g_unix_connection_receive_fd() to accept the file descriptor. As well as sending the fd this also writes a single byte to the @@ -30446,7 +53971,7 @@ Since: 2.26 <function name="g_unix_credentials_message_is_supported"> <description> -Checks if passing a #GCredential on a #GSocket is supported on this platform. +Checks if passing #GCredentials on a #GSocket is supported on this platform. Since: 2.26 @@ -31255,6 +54780,24 @@ Gets the mount path for a unix mount point. </return> </function> +<function name="g_unix_mount_point_get_options"> +<description> +Gets the options for the mount point. + +Since: 2.32 + +</description> +<parameters> +<parameter name="mount_point"> +<parameter_description> a #GUnixMountPoint. +</parameter_description> +</parameter> +</parameters> +<return> a string containing the options. + +</return> +</function> + <function name="g_unix_mount_point_guess_can_eject"> <description> Guesses whether a Unix mount point can be ejected. @@ -31374,7 +54917,7 @@ Checks if the unix mount points have changed since a given unix time. Gets a #GList of #GUnixMountPoint containing the unix mount points. If @time_read is set, it will be filled with the mount timestamp, allowing for checking if the mounts have changed with -g_unix_mounts_points_changed_since(). +g_unix_mount_points_changed_since(). </description> @@ -31893,7 +55436,7 @@ Deprecated: 2.22: Use g_volume_eject_with_operation() instead. <function name="g_volume_eject_finish"> <description> -Finishes ejecting a volume. If any errors occured during the operation, +Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead. @@ -31975,7 +55518,7 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError location to store the error occuring, or %NULL to +<parameter_description> a #GError location to store the error occurring, or %NULL to ignore. </parameter_description> </parameter> @@ -32146,6 +55689,24 @@ be freed with g_free() when no longer needed. </return> </function> +<function name="g_volume_get_sort_key"> +<description> +Gets the sort key for @volume, if any. + +Since: 2.32 + +</description> +<parameters> +<parameter name="volume"> +<parameter_description> A #GVolume. +</parameter_description> +</parameter> +</parameters> +<return> Sorting key for @volume or %NULL if no such key is available. + +</return> +</function> + <function name="g_volume_get_uuid"> <description> Gets the UUID for the @volume. The reference is typically based on @@ -32192,7 +55753,7 @@ One is when implementing a user space file system driver that reads blocks of a block device that is already represented by the native volume monitor (for example a CD Audio file system driver). Such a driver will generate its own #GMount object that needs to be -assoicated with the #GVolume object that represents the volume. +associated with the #GVolume object that represents the volume. The other is for implementing a #GVolumeMonitor whose sole purpose is to return #GVolume objects representing entries in the users @@ -32369,7 +55930,7 @@ Virtual: mount_fn <function name="g_volume_mount_finish"> <description> -Finishes mounting a volume. If any errors occured during the operation, +Finishes mounting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. If the mount operation succeeded, g_volume_get_mount() on @volume @@ -32452,7 +56013,7 @@ Since: 2.26 <function name="g_win32_input_stream_new"> <description> -Creates a new #GWin32InputStream for the given @fd. +Creates a new #GWin32InputStream for the given @handle. If @close_handle is %TRUE, the handle will be closed when the stream is closed. @@ -32467,7 +56028,7 @@ as used in the Windows C libraries. <parameter_description> a Win32 file handle </parameter_description> </parameter> -<parameter name="close_fd"> +<parameter name="close_handle"> <parameter_description> %TRUE to close the handle when done </parameter_description> </parameter> @@ -32895,6 +56456,47 @@ longer require it. </return> </function> +<function name="gvdb_table_new_from_data"> +<description> +Creates a new #GvdbTable from the data in @data. + +An empty or otherwise corrupted data is considered to be a valid +#GvdbTable with no entries. + +You should call gvdb_table_unref() on the return result when you no +longer require it. + +</description> +<parameters> +<parameter name="data"> +<parameter_description> the data +</parameter_description> +</parameter> +<parameter name="data_len"> +<parameter_description> the length of @data in bytes +</parameter_description> +</parameter> +<parameter name="trusted"> +<parameter_description> if the contents of @data are trusted +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> User supplied data that owns @data +</parameter_description> +</parameter> +<parameter name="ref"> +<parameter_description> Ref function for @user_data +</parameter_description> +</parameter> +<parameter name="unref"> +<parameter_description> Unref function for @user_data +</parameter_description> +</parameter> +</parameters> +<return> a new #GvdbTable +</return> +</function> + <function name="gvdb_table_ref"> <description> Increases the reference count on @file. diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml index dbbb0271..c46b3ca8 100644 --- a/glib/src/glib_docs.xml +++ b/glib/src/glib_docs.xml @@ -1,4 +1,38 @@ <root> +<signal name="GObject::notify"> +<description> +The notify signal is emitted on an object when one of its +properties has been changed. Note that getting this signal +doesn't guarantee that the value of the property has actually +changed, it may also be emitted when the setter for the property +is called to reinstate the previous value. + +This signal is typically used to obtain change notification for a +single property, by specifying the property name as a detail in the +g_signal_connect() call, like this: +|[ +g_signal_connect (text_view->buffer, "notify::paste-target-list", +G_CALLBACK (gtk_text_view_target_list_notify), +text_view) +]| +It is important to note that you must use +<link linkend="canonical-parameter-name">canonical</link> parameter names as +detail strings for the notify signal. + +</description> +<parameters> +<parameter name="gobject"> +<parameter_description> the object which received the signal. +</parameter_description> +</parameter> +<parameter name="pspec"> +<parameter_description> the #GParamSpec of the property which changed. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + <function name="g_access"> <description> A wrapper for the POSIX access() function. This function is used to @@ -34,51 +68,6 @@ error. </return> </function> -<function name="g_allocator_free"> -<description> -Frees all of the memory allocated by the #GAllocator. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead - -</description> -<parameters> -<parameter name="allocator"> -<parameter_description> a #GAllocator. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - -<function name="g_allocator_new"> -<description> -Creates a new #GAllocator. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead - -</description> -<parameters> -<parameter name="name"> -<parameter_description> the name of the #GAllocator. This name is used to set the -name of the #GMemChunk used by the #GAllocator, and is only -used for debugging. -</parameter_description> -</parameter> -<parameter name="n_preallocs"> -<parameter_description> the number of elements in each block of memory -allocated. Larger blocks mean less calls to -g_malloc(), but some memory may be wasted. (GLib uses -128 elements per block by default.) The value must be -between 1 and 65535. -</parameter_description> -</parameter> -</parameters> -<return> a new #GAllocator. -</return> -</function> - <function name="g_array_append_val"> <description> Adds the value on to the end of the array. The array will grow in @@ -429,6 +418,34 @@ Since: 2.4 </return> </function> +<function name="g_array_set_clear_func"> +<description> +Sets a function to clear an element of @array. + +The @clear_func will be called when an element in the array +data segment is removed and when the array is freed and data +segment is deallocated as well. + +Note that in contrast with other uses of #GDestroyNotify +functions, @clear_func is expected to clear the contents of +the array element it is given, but not free the element itself. + +Since: 2.32 + +</description> +<parameters> +<parameter name="array"> +<parameter_description> A #GArray +</parameter_description> +</parameter> +<parameter name="clear_func"> +<parameter_description> a function to clear an element of @array +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_array_set_size"> <description> Sets the size of the array, expanding it if necessary. If the array @@ -489,8 +506,8 @@ than second arg, zero for equal, greater zero if first arg is greater than second arg). If two array elements compare equal, their order in the sorted array -is undefined. If you want equal elements to keep their order &#8211; i.e. -you want a stable sort &#8211; you can write a comparison function that, +is undefined. If you want equal elements to keep their order (i.e. +you want a stable sort) you can write a comparison function that, if two elements would otherwise compare equal, compares them by their addresses. @@ -636,6 +653,257 @@ code to use for converting. </return> </function> +<function name="g_ascii_isalnum"> +<description> +Determines whether a character is alphanumeric. + +Unlike the standard C library isalnum() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to +cast to #guchar before passing a possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII alphanumeric character +</return> +</function> + +<function name="g_ascii_isalpha"> +<description> +Determines whether a character is alphabetic (i.e. a letter). + +Unlike the standard C library isalpha() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to +cast to #guchar before passing a possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII alphabetic character +</return> +</function> + +<function name="g_ascii_iscntrl"> +<description> +Determines whether a character is a control character. + +Unlike the standard C library iscntrl() function, this only +recognizes standard ASCII control characters and ignores the +locale, returning %FALSE for all non-ASCII characters. Also, +unlike the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to +cast to #guchar before passing a possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII control character. +</return> +</function> + +<function name="g_ascii_isdigit"> +<description> +Determines whether a character is digit (0-9). + +Unlike the standard C library isdigit() function, this takes +a <type>char</type>, not an <type>int</type>, so don't call it +on <literal>EOF</literal>, but no need to cast to #guchar before passing a possibly +non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII digit. +</return> +</function> + +<function name="g_ascii_isgraph"> +<description> +Determines whether a character is a printing character and not a space. + +Unlike the standard C library isgraph() function, this only +recognizes standard ASCII characters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need +to cast to #guchar before passing a possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII printing character other than space. +</return> +</function> + +<function name="g_ascii_islower"> +<description> +Determines whether a character is an ASCII lower case letter. + +Unlike the standard C library islower() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need +to worry about casting to #guchar before passing a possibly +non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII lower case letter +</return> +</function> + +<function name="g_ascii_isprint"> +<description> +Determines whether a character is a printing character. + +Unlike the standard C library isprint() function, this only +recognizes standard ASCII characters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need +to cast to #guchar before passing a possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII printing character. +</return> +</function> + +<function name="g_ascii_ispunct"> +<description> +Determines whether a character is a punctuation character. + +Unlike the standard C library ispunct() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to +cast to #guchar before passing a possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII punctuation character. +</return> +</function> + +<function name="g_ascii_isspace"> +<description> +Determines whether a character is a white-space character. + +Unlike the standard C library isspace() function, this only +recognizes standard ASCII white-space and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to +cast to #guchar before passing a possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII white-space character +</return> +</function> + +<function name="g_ascii_isupper"> +<description> +Determines whether a character is an ASCII upper case letter. + +Unlike the standard C library isupper() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a <type>char</type>, +not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to +worry about casting to #guchar before passing a possibly non-ASCII +character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII upper case letter +</return> +</function> + +<function name="g_ascii_isxdigit"> +<description> +Determines whether a character is a hexadecimal-digit character. + +Unlike the standard C library isxdigit() function, this takes +a <type>char</type>, not an <type>int</type>, so don't call it +on <literal>EOF</literal>, but no need to cast to #guchar before passing a +possibly non-ASCII character in. + + +</description> +<parameters> +<parameter name="c"> +<parameter_description> any character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @c is an ASCII hexadecimal-digit character. +</return> +</function> + <function name="g_ascii_strcasecmp"> <description> Compare two strings, ignoring the case of ASCII characters. @@ -745,12 +1013,12 @@ locale-sensitive system strtod() function. To convert from a #gdouble to a string in a locale-insensitive way, use g_ascii_dtostr(). -If the correct value would cause overflow, plus or minus %HUGE_VAL -is returned (according to the sign of the value), and %ERANGE is -stored in %errno. If the correct value would cause underflow, -zero is returned and %ERANGE is stored in %errno. +If the correct value would cause overflow, plus or minus <literal>HUGE_VAL</literal> +is returned (according to the sign of the value), and <literal>ERANGE</literal> is +stored in <literal>errno</literal>. If the correct value would cause underflow, +zero is returned and <literal>ERANGE</literal> is stored in <literal>errno</literal>. -This function resets %errno before calling strtod() so that +This function resets <literal>errno</literal> before calling strtod() so that you can reliably detect overflow and underflow. @@ -784,10 +1052,11 @@ To handle input from the user you should normally use the locale-sensitive system strtoll() function. If the correct value would cause overflow, %G_MAXINT64 or %G_MININT64 -is returned, and %ERANGE is stored in %errno. If the base is -outside the valid range, zero is returned, and %EINVAL is stored -in %errno. If the string conversion fails, zero is returned, and -@endptr returns @nptr (if @endptr is non-%NULL). +is returned, and <literal>ERANGE</literal> is stored in <literal>errno</literal>. +If the base is outside the valid range, zero is returned, and +<literal>EINVAL</literal> is stored in <literal>errno</literal>. If the +string conversion fails, zero is returned, and @endptr returns @nptr +(if @endptr is non-%NULL). Since: 2.12 @@ -826,10 +1095,11 @@ To handle input from the user you should normally use the locale-sensitive system strtoull() function. If the correct value would cause overflow, %G_MAXUINT64 -is returned, and %ERANGE is stored in %errno. If the base is -outside the valid range, zero is returned, and %EINVAL is stored -in %errno. If the string conversion fails, zero is returned, and -@endptr returns @nptr (if @endptr is non-%NULL). +is returned, and <literal>ERANGE</literal> is stored in <literal>errno</literal>. +If the base is outside the valid range, zero is returned, and +<literal>EINVAL</literal> is stored in <literal>errno</literal>. +If the string conversion fails, zero is returned, and @endptr returns +@nptr (if @endptr is non-%NULL). Since: 2.2 @@ -887,7 +1157,7 @@ recognizes standard ASCII letters and ignores the locale, returning all non-ASCII characters unchanged, even if they are lower case letters in a particular character set. Also unlike the standard library function, this takes and returns a char, not an int, so -don't call it on %EOF but no need to worry about casting to #guchar +don't call it on <literal>EOF</literal> but no need to worry about casting to #guchar before passing a possibly non-ASCII character in. @@ -913,7 +1183,7 @@ recognizes standard ASCII letters and ignores the locale, returning all non-ASCII characters unchanged, even if they are upper case letters in a particular character set. Also unlike the standard library function, this takes and returns a char, not an int, so -don't call it on %EOF but no need to worry about casting to #guchar +don't call it on <literal>EOF</literal> but no need to worry about casting to #guchar before passing a possibly non-ASCII character in. @@ -950,15 +1220,265 @@ g_ascii_isxdigit()), its numeric value. Otherwise, -1. </return> </function> +<function name="g_assert"> +<description> +Debugging macro to terminate the application if the assertion +fails. If the assertion fails (i.e. the expression is not true), +an error message is logged and the application is terminated. + +The macro can be turned off in final releases of code by defining +<envar>G_DISABLE_ASSERT</envar> when compiling the application. + +</description> +<parameters> +<parameter name="expr"> +<parameter_description> the expression to check +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_cmpfloat"> +<description> +Debugging macro to terminate the application with a warning +message if a floating point number comparison fails. + +The effect of <literal>g_assert_cmpfloat (n1, op, n2)</literal> is +the same as <literal>g_assert (n1 op n2)</literal>. The advantage +of this macro is that it can produce a message that includes the +actual values of @n1 and @n2. + +Since: 2.16 + +</description> +<parameters> +<parameter name="n1"> +<parameter_description> an floating point number +</parameter_description> +</parameter> +<parameter name="cmp"> +<parameter_description> The comparison operator to use. +One of ==, !=, <, >, <=, >=. +</parameter_description> +</parameter> +<parameter name="n2"> +<parameter_description> another floating point number +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_cmphex"> +<description> +Debugging macro to terminate the application with a warning +message if an unsigned integer comparison fails. + +This is a variant of g_assert_cmpuint() that displays the numbers +in hexadecimal notation in the message. + +Since: 2.16 + +</description> +<parameters> +<parameter name="n1"> +<parameter_description> an unsigned integer +</parameter_description> +</parameter> +<parameter name="cmp"> +<parameter_description> The comparison operator to use. +One of ==, !=, <, >, <=, >=. +</parameter_description> +</parameter> +<parameter name="n2"> +<parameter_description> another unsigned integer +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_cmpint"> +<description> +Debugging macro to terminate the application with a warning +message if an integer comparison fails. + +The effect of <literal>g_assert_cmpint (n1, op, n2)</literal> is +the same as <literal>g_assert (n1 op n2)</literal>. The advantage +of this macro is that it can produce a message that includes the +actual values of @n1 and @n2. + +Since: 2.16 + +</description> +<parameters> +<parameter name="n1"> +<parameter_description> an integer +</parameter_description> +</parameter> +<parameter name="cmp"> +<parameter_description> The comparison operator to use. +One of ==, !=, <, >, <=, >=. +</parameter_description> +</parameter> +<parameter name="n2"> +<parameter_description> another integer +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_cmpstr"> +<description> +Debugging macro to terminate the application with a warning +message if a string comparison fails. The strings are compared +using g_strcmp0(). + +The effect of <literal>g_assert_cmpstr (s1, op, s2)</literal> is +the same as <literal>g_assert (g_strcmp0 (s1, s2) op 0)</literal>. +The advantage of this macro is that it can produce a message that +includes the actual values of @s1 and @s2. + +|[ +g_assert_cmpstr (mystring, ==, "fubar"); +]| + +Since: 2.16 + +</description> +<parameters> +<parameter name="s1"> +<parameter_description> a string (may be %NULL) +</parameter_description> +</parameter> +<parameter name="cmp"> +<parameter_description> The comparison operator to use. +One of ==, !=, <, >, <=, >=. +</parameter_description> +</parameter> +<parameter name="s2"> +<parameter_description> another string (may be %NULL) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_cmpuint"> +<description> +Debugging macro to terminate the application with a warning +message if an unsigned integer comparison fails. + +The effect of <literal>g_assert_cmpuint (n1, op, n2)</literal> is +the same as <literal>g_assert (n1 op n2)</literal>. The advantage +of this macro is that it can produce a message that includes the +actual values of @n1 and @n2. + +Since: 2.16 + +</description> +<parameters> +<parameter name="n1"> +<parameter_description> an unsigned integer +</parameter_description> +</parameter> +<parameter name="cmp"> +<parameter_description> The comparison operator to use. +One of ==, !=, <, >, <=, >=. +</parameter_description> +</parameter> +<parameter name="n2"> +<parameter_description> another unsigned integer +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_error"> +<description> +Debugging macro to terminate the application with a warning +message if a method has not returned the correct #GError. + +The effect of <literal>g_assert_error (err, dom, c)</literal> is +the same as <literal>g_assert (err != NULL && err->domain +== dom && err->code == c)</literal>. The advantage of this +macro is that it can produce a message that includes the incorrect +error message and code. + +This can only be used to test for a specific error. If you want to +test that @err is set, but don't care what it's set to, just use +<literal>g_assert (err != NULL)</literal> + +Since: 2.20 + +</description> +<parameters> +<parameter name="err"> +<parameter_description> a #GError, possibly %NULL +</parameter_description> +</parameter> +<parameter name="dom"> +<parameter_description> the expected error domain (a #GQuark) +</parameter_description> +</parameter> +<parameter name="c"> +<parameter_description> the expected error code +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_no_error"> +<description> +Debugging macro to terminate the application with a warning +message if a method has returned a #GError. + +The effect of <literal>g_assert_no_error (err)</literal> is +the same as <literal>g_assert (err == NULL)</literal>. The advantage +of this macro is that it can produce a message that includes +the error message and code. + +Since: 2.20 + +</description> +<parameters> +<parameter name="err"> +<parameter_description> a #GError, possibly %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_assert_not_reached"> +<description> +Debugging macro to terminate the application if it is ever +reached. If it is reached, an error message is logged and the +application is terminated. + +The macro can be turned off in final releases of code by defining +<envar>G_DISABLE_ASSERT</envar> when compiling the application. + +</description> +<parameters> +</parameters> +<return></return> +</function> + <function name="g_async_queue_length"> <description> -Returns the length of the queue, negative values mean waiting -threads, positive values mean available entries in the -@queue. Actually this function returns the number of data items in -the queue minus the number of waiting threads. Thus a return value -of 0 could mean 'n' entries in the queue and 'n' thread waiting. -That can happen due to locking of the queue or due to -scheduling. +Returns the length of the queue. + +Actually this function returns the number of data items in +the queue minus the number of waiting threads, so a negative +value means waiting threads, and a positive value means available +entries in the @queue. A return value of 0 could mean n entries +in the queue and n threads waiting. This can happen due to locking +of the queue or due to scheduling. </description> @@ -968,26 +1488,28 @@ scheduling. </parameter_description> </parameter> </parameters> -<return> the length of the @queue. +<return> the length of the @queue </return> </function> <function name="g_async_queue_length_unlocked"> <description> -Returns the length of the queue, negative values mean waiting -threads, positive values mean available entries in the -@queue. Actually this function returns the number of data items in -the queue minus the number of waiting threads. Thus a return value -of 0 could mean 'n' entries in the queue and 'n' thread waiting. -That can happen due to locking of the queue or due to -scheduling. This function must be called while holding the @queue's -lock. +Returns the length of the queue. + +Actually this function returns the number of data items in +the queue minus the number of waiting threads, so a negative +value means waiting threads, and a positive value means available +entries in the @queue. A return value of 0 could mean n entries +in the queue and n threads waiting. This can happen due to locking +of the queue or due to scheduling. + +This function must be called while holding the @queue's lock. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -997,14 +1519,20 @@ lock. <function name="g_async_queue_lock"> <description> -Acquires the @queue's lock. After that you can only call the -<function>g_async_queue_*_unlocked()</function> function variants on that -@queue. Otherwise it will deadlock. +Acquires the @queue's lock. If another thread is already +holding the lock, this call will block until the lock +becomes available. + +Call g_async_queue_unlock() to drop the lock again. + +While holding the lock, you can only call the +<function>g_async_queue_*_unlocked()</function> functions +on @queue. Otherwise, deadlock may occur. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1013,21 +1541,21 @@ Acquires the @queue's lock. After that you can only call the <function name="g_async_queue_new"> <description> -Creates a new asynchronous queue with the initial reference count of 1. +Creates a new asynchronous queue. </description> <parameters> </parameters> -<return> the new #GAsyncQueue. +<return> a new #GAsyncQueue. Free with g_async_queue_unref() </return> </function> <function name="g_async_queue_new_full"> <description> -Creates a new asynchronous queue with an initial reference count of 1 and -sets up a destroy notify function that is used to free any remaining -queue items when the queue is destroyed after the final unref. +Creates a new asynchronous queue and sets up a destroy notify +function that is used to free any remaining queue items when +the queue is destroyed after the final unref. Since: 2.16 @@ -1038,39 +1566,40 @@ Since: 2.16 </parameter_description> </parameter> </parameters> -<return> the new #GAsyncQueue. +<return> a new #GAsyncQueue. Free with g_async_queue_unref() </return> </function> <function name="g_async_queue_pop"> <description> -Pops data from the @queue. This function blocks until data become -available. +Pops data from the @queue. If @queue is empty, this function +blocks until data becomes available. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> -<return> data from the queue. +<return> data from the queue </return> </function> <function name="g_async_queue_pop_unlocked"> <description> -Pops data from the @queue. This function blocks until data become -available. This function must be called while holding the @queue's -lock. +Pops data from the @queue. If @queue is empty, this function +blocks until data becomes available. + +This function must be called while holding the @queue's lock. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1085,11 +1614,11 @@ Pushes the @data into the @queue. @data must not be %NULL. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> <parameter name="data"> -<parameter_description> @data to push into the @queue. +<parameter_description> @data to push into the @queue </parameter_description> </parameter> </parameters> @@ -1099,15 +1628,15 @@ Pushes the @data into the @queue. @data must not be %NULL. <function name="g_async_queue_push_sorted"> <description> Inserts @data into @queue using @func to determine the new -position. +position. This function requires that the @queue is sorted before pushing on -new elements. +new elements, see g_async_queue_sort(). This function will lock @queue before it sorts the queue and unlock it when it is finished. -For an example of @func see g_async_queue_sort(). +For an example of @func see g_async_queue_sort(). Since: 2.10 @@ -1122,11 +1651,7 @@ Since: 2.10 </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the #GCompareDataFunc is used to sort @queue. This function -is passed two elements of the @queue. The function should return -0 if they are equal, a negative value if the first element -should be higher in the @queue or a positive value if the first -element should be lower in the @queue than the second element. +<parameter_description> the #GCompareDataFunc is used to sort @queue </parameter_description> </parameter> <parameter name="user_data"> @@ -1142,12 +1667,18 @@ element should be lower in the @queue than the second element. Inserts @data into @queue using @func to determine the new position. +The sort function @func is passed two elements of the @queue. +It should return 0 if they are equal, a negative value if the +first element should be higher in the @queue or a positive value +if the first element should be lower in the @queue than the second +element. + This function requires that the @queue is sorted before pushing on -new elements. +new elements, see g_async_queue_sort(). -This function is called while holding the @queue's lock. +This function must be called while holding the @queue's lock. -For an example of @func see g_async_queue_sort(). +For an example of @func see g_async_queue_sort(). Since: 2.10 @@ -1162,11 +1693,7 @@ Since: 2.10 </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the #GCompareDataFunc is used to sort @queue. This function -is passed two elements of the @queue. The function should return -0 if they are equal, a negative value if the first element -should be higher in the @queue or a positive value if the first -element should be lower in the @queue than the second element. +<parameter_description> the #GCompareDataFunc is used to sort @queue </parameter_description> </parameter> <parameter name="user_data"> @@ -1179,17 +1706,18 @@ element should be lower in the @queue than the second element. <function name="g_async_queue_push_unlocked"> <description> -Pushes the @data into the @queue. @data must not be %NULL. This -function must be called while holding the @queue's lock. +Pushes the @data into the @queue. @data must not be %NULL. + +This function must be called while holding the @queue's lock. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> <parameter name="data"> -<parameter_description> @data to push into the @queue. +<parameter_description> @data to push into the @queue </parameter_description> </parameter> </parameters> @@ -1198,14 +1726,14 @@ function must be called while holding the @queue's lock. <function name="g_async_queue_ref"> <description> -Increases the reference count of the asynchronous @queue by 1. You -do not need to hold the lock to call this function. +Increases the reference count of the asynchronous @queue by 1. +You do not need to hold the lock to call this function. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1224,7 +1752,7 @@ lock. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1233,7 +1761,13 @@ lock. <function name="g_async_queue_sort"> <description> -Sorts @queue using @func. +Sorts @queue using @func. + +The sort function @func is passed two elements of the @queue. +It should return 0 if they are equal, a negative value if the +first element should be higher in the @queue or a positive value +if the first element should be lower in the @queue than the second +element. This function will lock @queue before it sorts the queue and unlock it when it is finished. @@ -1259,12 +1793,7 @@ Since: 2.10 </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the #GCompareDataFunc is used to sort @queue. This -function is passed two elements of the @queue. The function -should return 0 if they are equal, a negative value if the -first element should be higher in the @queue or a positive -value if the first element should be lower in the @queue than -the second element. +<parameter_description> the #GCompareDataFunc is used to sort @queue </parameter_description> </parameter> <parameter name="user_data"> @@ -1277,9 +1806,15 @@ the second element. <function name="g_async_queue_sort_unlocked"> <description> -Sorts @queue using @func. +Sorts @queue using @func. + +The sort function @func is passed two elements of the @queue. +It should return 0 if they are equal, a negative value if the +first element should be higher in the @queue or a positive value +if the first element should be lower in the @queue than the second +element. -This function is called while holding the @queue's lock. +This function must be called while holding the @queue's lock. Since: 2.10 @@ -1290,12 +1825,7 @@ Since: 2.10 </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the #GCompareDataFunc is used to sort @queue. This -function is passed two elements of the @queue. The function -should return 0 if they are equal, a negative value if the -first element should be higher in the @queue or a positive -value if the first element should be lower in the @queue than -the second element. +<parameter_description> the #GCompareDataFunc is used to sort @queue </parameter_description> </parameter> <parameter name="user_data"> @@ -1308,65 +1838,124 @@ the second element. <function name="g_async_queue_timed_pop"> <description> -Pops data from the @queue. If no data is received before @end_time, -%NULL is returned. +Pops data from the @queue. If the queue is empty, blocks until +@end_time or until data becomes available. + +If no data is received before @end_time, %NULL is returned. -To easily calculate @end_time a combination of g_get_current_time() +To easily calculate @end_time, a combination of g_get_current_time() and g_time_val_add() can be used. +Deprecated: use g_async_queue_timeout_pop(). </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> <parameter name="end_time"> -<parameter_description> a #GTimeVal, determining the final time. +<parameter_description> a #GTimeVal, determining the final time </parameter_description> </parameter> </parameters> <return> data from the queue or %NULL, when no data is received before @end_time. + </return> </function> <function name="g_async_queue_timed_pop_unlocked"> <description> -Pops data from the @queue. If no data is received before @end_time, -%NULL is returned. This function must be called while holding the -@queue's lock. +Pops data from the @queue. If the queue is empty, blocks until +@end_time or until data becomes available. -To easily calculate @end_time a combination of g_get_current_time() +If no data is received before @end_time, %NULL is returned. + +To easily calculate @end_time, a combination of g_get_current_time() and g_time_val_add() can be used. +This function must be called while holding the @queue's lock. + +Deprecated: use g_async_queue_timeout_pop_unlocked(). </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> <parameter name="end_time"> -<parameter_description> a #GTimeVal, determining the final time. +<parameter_description> a #GTimeVal, determining the final time </parameter_description> </parameter> </parameters> <return> data from the queue or %NULL, when no data is received before @end_time. + +</return> +</function> + +<function name="g_async_queue_timeout_pop"> +<description> +Pops data from the @queue. If the queue is empty, blocks for +@timeout microseconds, or until data becomes available. + +If no data is received before the timeout, %NULL is returned. + + +</description> +<parameters> +<parameter name="queue"> +<parameter_description> a #GAsyncQueue +</parameter_description> +</parameter> +<parameter name="timeout"> +<parameter_description> the number of microseconds to wait +</parameter_description> +</parameter> +</parameters> +<return> data from the queue or %NULL, when no data is +received before the timeout. +</return> +</function> + +<function name="g_async_queue_timeout_pop_unlocked"> +<description> +Pops data from the @queue. If the queue is empty, blocks for +@timeout microseconds, or until data becomes available. + +If no data is received before the timeout, %NULL is returned. + +This function must be called while holding the @queue's lock. + + +</description> +<parameters> +<parameter name="queue"> +<parameter_description> a #GAsyncQueue +</parameter_description> +</parameter> +<parameter name="time"> +<parameter_description> the number of microseconds to wait +</parameter_description> +</parameter> +</parameters> +<return> data from the queue or %NULL, when no data is +received before the timeout. </return> </function> <function name="g_async_queue_try_pop"> <description> -Tries to pop data from the @queue. If no data is available, %NULL is -returned. +Tries to pop data from the @queue. If no data is available, +%NULL is returned. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1377,15 +1966,16 @@ available immediately. <function name="g_async_queue_try_pop_unlocked"> <description> -Tries to pop data from the @queue. If no data is available, %NULL is -returned. This function must be called while holding the @queue's -lock. +Tries to pop data from the @queue. If no data is available, +%NULL is returned. + +This function must be called while holding the @queue's lock. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1398,10 +1988,14 @@ available immediately. <description> Releases the queue's lock. +Calling this function when you have not acquired +the with g_async_queue_lock() leads to undefined +behaviour. + </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1410,11 +2004,12 @@ Releases the queue's lock. <function name="g_async_queue_unref"> <description> -Decreases the reference count of the asynchronous @queue by 1. If -the reference count went to 0, the @queue will be destroyed and the -memory allocated will be freed. So you are not allowed to use the -@queue afterwards, as it might have disappeared. You do not need to -hold the lock to call this function. +Decreases the reference count of the asynchronous @queue by 1. + +If the reference count went to 0, the @queue will be destroyed +and the memory allocated will be freed. So you are not allowed +to use the @queue afterwards, as it might have disappeared. +You do not need to hold the lock to call this function. </description> <parameters> @@ -1428,10 +2023,10 @@ hold the lock to call this function. <function name="g_async_queue_unref_and_unlock"> <description> -Decreases the reference count of the asynchronous @queue by 1 and -releases the lock. This function must be called while holding the -@queue's lock. If the reference count went to 0, the @queue will be -destroyed and the memory allocated will be freed. +Decreases the reference count of the asynchronous @queue by 1 +and releases the lock. This function must be called while holding +the @queue's lock. If the reference count went to 0, the @queue +will be destroyed and the memory allocated will be freed. @Deprecated: Since 2.8, reference counting is done atomically so g_async_queue_unref() can be used regardless of the @queue's @@ -1440,7 +2035,7 @@ lock. </description> <parameters> <parameter name="queue"> -<parameter_description> a #GAsyncQueue. +<parameter_description> a #GAsyncQueue </parameter_description> </parameter> </parameters> @@ -1480,6 +2075,8 @@ As can be seen from the above, for portability it's best to avoid calling g_atexit() (or atexit()) except in the main executable of a program. +Deprecated:2.32: It is best to avoid g_atexit(). + </description> <parameters> <parameter name="func"> @@ -1499,6 +2096,9 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. +Before version 2.30, this function did not return a value +(but g_atomic_int_exchange_and_add() did, and had the same meaning). + Since: 2.4 </description> @@ -2104,6 +2704,9 @@ non-zero state). If you enable line-breaking you will need at least: @break_lines is typically used when putting base64-encoded data in emails. It breaks the lines at 72 columns instead of putting all of the text on the same line. This avoids problems with long lines in the email system. +Note however that it breaks the lines with <literal>LF</literal> +characters, not <literal>CR LF</literal> sequences, so the result cannot +be passed directly to SMTP or certain other protocols. Since: 2.12 @@ -2141,21 +2744,24 @@ Since: 2.12 <function name="g_basename"> <description> -Gets the name of the file without any leading directory components. -It returns a pointer into the given file name string. +Gets the name of the file without any leading directory +components. It returns a pointer into the given file name +string. -Deprecated:2.2: Use g_path_get_basename() instead, but notice that -g_path_get_basename() allocates new memory for the returned string, unlike -this function which returns a pointer into the argument. +Deprecated:2.2: Use g_path_get_basename() instead, but notice +that g_path_get_basename() allocates new memory for the +returned string, unlike this function which returns a pointer +into the argument. </description> <parameters> <parameter name="file_name"> -<parameter_description> the name of the file. +<parameter_description> the name of the file </parameter_description> </parameter> </parameters> -<return> the name of the file without any leading directory components. +<return> the name of the file without any leading +directory components </return> </function> @@ -2377,6 +2983,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE if the lock was acquired + </return> </function> @@ -2406,19 +3013,6 @@ Since: 2.24 <return></return> </function> -<function name="g_blow_chunks"> -<description> -Calls g_mem_chunk_clean() on all #GMemChunk objects. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_bookmark_file_add_application"> <description> Adds the application with @name and @exec to the list of @@ -2434,7 +3028,7 @@ time the application registered this bookmark. If @name is %NULL, the name of the application will be the same returned by g_get_application_name(); if @exec is %NULL, the command line will be a composition of the program name as -returned by g_get_prgname() and the "%u" modifier, which will be +returned by g_get_prgname() and the "\%u" modifier, which will be expanded to the bookmark's URI. This function will automatically take care of updating the @@ -3083,7 +3677,7 @@ of the file, or %NULL </parameter_description> </parameter> </parameters> -<return> %TRUE if a key file could be loaded, %FALSE othewise +<return> %TRUE if a key file could be loaded, %FALSE otherwise </return> </function> @@ -3305,9 +3899,9 @@ and g_bookmark_file_remove_application() instead. @name can be any UTF-8 encoded string used to identify an application. -@exec can have one of these two modifiers: "%f", which will +@exec can have one of these two modifiers: "\%f", which will be expanded as the local file name retrieved from the bookmark's -URI; "%u", which will be expanded as the bookmark's URI. +URI; "\%u", which will be expanded as the bookmark's URI. The expansion is done automatically when retrieving the stored command line using the g_bookmark_file_get_app_info() function. @count is the number of times the application has registered the @@ -3893,6 +4487,32 @@ the size of @array will be set to zero. </return> </function> +<function name="g_byte_array_free_to_bytes"> +<description> +Transfers the data from the #GByteArray into a new immutable #GBytes. + +The #GByteArray is freed unless the reference count of @array is greater +than one, the #GByteArray wrapper is preserved but the size of @array +will be set to zero. + +This is identical to using g_bytes_new_take() and g_byte_array_free() +together. + +Since: 2.32 + + +</description> +<parameters> +<parameter name="array"> +<parameter_description> a #GByteArray +</parameter_description> +</parameter> +</parameters> +<return> a new immutable #GBytes representing same byte +data that was in the array +</return> +</function> + <function name="g_byte_array_new"> <description> Creates a new #GByteArray with a reference count of 1. @@ -3904,6 +4524,29 @@ Creates a new #GByteArray with a reference count of 1. </return> </function> +<function name="g_byte_array_new_take"> +<description> +Create byte array containing the data. The data will be owned by the array +and will be freed with g_free(), i.e. it could be allocated using g_strdup(). + +Since: 2.32 + + +</description> +<parameters> +<parameter name="data"> +<parameter_description> byte data for the array +</parameter_description> +</parameter> +<parameter name="len"> +<parameter_description> length of @data +</parameter_description> +</parameter> +</parameters> +<return> a new #GByteArray +</return> +</function> + <function name="g_byte_array_prepend"> <description> Adds the given data to the start of the #GByteArray. The array will @@ -4060,8 +4703,8 @@ arg is less than second arg, zero for equal, greater than zero if first arg is greater than second arg). If two array elements compare equal, their order in the sorted array -is undefined. If you want equal elements to keep their order &#8211; i.e. -you want a stable sort &#8211; you can write a comparison function that, +is undefined. If you want equal elements to keep their order (i.e. +you want a stable sort) you can write a comparison function that, if two elements would otherwise compare equal, compares them by their addresses. @@ -4121,6 +4764,355 @@ Since: 2.22 <return></return> </function> +<function name="g_bytes_compare"> +<description> +Compares the two #GBytes values. + +This function can be used to sort GBytes instances in lexographical order. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes1"> +<parameter_description> a pointer to a #GBytes +</parameter_description> +</parameter> +<parameter name="bytes2"> +<parameter_description> a pointer to a #GBytes to compare with @bytes1 +</parameter_description> +</parameter> +</parameters> +<return> a negative value if bytes2 is lesser, a positive value if bytes2 is +greater, and zero if bytes2 is equal to bytes1 + +</return> +</function> + +<function name="g_bytes_equal"> +<description> +Compares the two #GBytes values being pointed to and returns +%TRUE if they are equal. + +This function can be passed to g_hash_table_new() as the @key_equal_func +parameter, when using non-%NULL #GBytes pointers as keys in a #GHashTable. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes1"> +<parameter_description> a pointer to a #GBytes +</parameter_description> +</parameter> +<parameter name="bytes2"> +<parameter_description> a pointer to a #GBytes to compare with @bytes1 +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the two keys match. + +</return> +</function> + +<function name="g_bytes_get_data"> +<description> +Get the byte data in the #GBytes. This data should not be modified. + +This function will always return the same pointer for a given #GBytes. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> location to return size of byte data +</parameter_description> +</parameter> +</parameters> +<return> a pointer to the byte data + +</return> +</function> + +<function name="g_bytes_get_size"> +<description> +Get the size of the byte data in the #GBytes. + +This function will always return the same value for a given #GBytes. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +</parameters> +<return> the size + +</return> +</function> + +<function name="g_bytes_hash"> +<description> +Creates an integer hash code for the byte data in the #GBytes. + +This function can be passed to g_hash_table_new() as the @key_equal_func +parameter, when using non-%NULL #GBytes pointers as keys in a #GHashTable. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a pointer to a #GBytes key +</parameter_description> +</parameter> +</parameters> +<return> a hash value corresponding to the key. + +</return> +</function> + +<function name="g_bytes_new"> +<description> +Creates a new #GBytes from @data. + +@data is copied. + +Since: 2.32 + +</description> +<parameters> +<parameter name="data"> +<parameter_description> the data to be used for the bytes +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> the size of @data +</parameter_description> +</parameter> +</parameters> +<return> a new #GBytes + +</return> +</function> + +<function name="g_bytes_new_from_bytes"> +<description> +Creates a #GBytes which is a subsection of another #GBytes. The @offset + +@length may not be longer than the size of @bytes. + +A reference to @bytes will be held by the newly created #GBytes until +the byte data is no longer needed. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +<parameter name="offset"> +<parameter_description> offset which subsection starts at +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> length of subsection +</parameter_description> +</parameter> +</parameters> +<return> a new #GBytes + +</return> +</function> + +<function name="g_bytes_new_static"> +<description> +Creates a new #GBytes from static data. + +@data must be static (ie: never modified or freed). + +Since: 2.32 + +</description> +<parameters> +<parameter name="data"> +<parameter_description> the data to be used for the bytes +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> the size of @data +</parameter_description> +</parameter> +</parameters> +<return> a new #GBytes + +</return> +</function> + +<function name="g_bytes_new_take"> +<description> +Creates a new #GBytes from @data. + +After this call, @data belongs to the bytes and may no longer be +modified by the caller. g_free() will be called on @data when the +bytes is no longer in use. Because of this @data must have been created by +a call to g_malloc(), g_malloc0() or g_realloc() or by one of the many +functions that wrap these calls (such as g_new(), g_strdup(), etc). + +For creating #GBytes with memory from other allocators, see +g_bytes_new_with_free_func(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="data"> +<parameter_description> the data to be used for the bytes +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> the size of @data +</parameter_description> +</parameter> +</parameters> +<return> a new #GBytes + +</return> +</function> + +<function name="g_bytes_new_with_free_func"> +<description> +Creates a #GBytes from @data. + +When the last reference is dropped, @free_func will be called with the +@user_data argument. + +@data must not be modified after this call is made until @free_func has +been called to indicate that the bytes is no longer in use. + +Since: 2.32 + +</description> +<parameters> +<parameter name="data"> +<parameter_description> the data to be used for the bytes +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> the size of @data +</parameter_description> +</parameter> +<parameter name="free_func"> +<parameter_description> the function to call to release the data +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data to pass to @free_func +</parameter_description> +</parameter> +</parameters> +<return> a new #GBytes + +</return> +</function> + +<function name="g_bytes_ref"> +<description> +Increase the reference count on @bytes. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +</parameters> +<return> the #GBytes + +</return> +</function> + +<function name="g_bytes_unref"> +<description> +Releases a reference on @bytes. This may result in the bytes being +freed. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_bytes_unref_to_array"> +<description> +Unreferences the bytes, and returns a new mutable #GByteArray containing +the same byte data. + +As an optimization, the byte data is transferred to the array without copying +if this was the last reference to bytes and bytes was created with +g_bytes_new(), g_bytes_new_take() or g_byte_array_free_to_bytes(). In all +other cases the data is copied. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +</parameters> +<return> a new mutable #GByteArray containing the same byte data + +</return> +</function> + +<function name="g_bytes_unref_to_data"> +<description> +Unreferences the bytes, and returns a pointer the same byte data +contents. + +As an optimization, the byte data is returned without copying if this was +the last reference to bytes and bytes was created with g_bytes_new(), +g_bytes_new_take() or g_byte_array_free_to_bytes(). In all other cases the +data is copied. + +Since: 2.32 + +</description> +<parameters> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +<parameter name="size"> +<parameter_description> location to place the length of the returned data +</parameter_description> +</parameter> +</parameters> +<return> a pointer to the same byte data, which should +be freed with g_free() + +</return> +</function> + <function name="g_cache_destroy"> <description> Frees the memory allocated for the #GCache. @@ -4128,10 +5120,12 @@ Frees the memory allocated for the #GCache. Note that it does not destroy the keys and values which were contained in the #GCache. +Deprecated:2.32: Use a #GHashTable instead + </description> <parameters> <parameter name="cache"> -<parameter_description> a #GCache. +<parameter_description> a #GCache </parameter_description> </parameter> </parameters> @@ -4149,18 +5143,21 @@ exist, if is created by calling the @value_new_func. The key is duplicated by calling @key_dup_func and the duplicated key and value are inserted into the #GCache. +Deprecated:2.32: Use a #GHashTable instead + </description> <parameters> <parameter name="cache"> -<parameter_description> a #GCache. +<parameter_description> a #GCache </parameter_description> </parameter> <parameter name="key"> -<parameter_description> a key describing a #GCache object. +<parameter_description> a key describing a #GCache object </parameter_description> </parameter> </parameters> -<return> a pointer to a #GCache value. +<return> a pointer to a #GCache value + </return> </function> @@ -4173,18 +5170,20 @@ entry and the @user_data. The order of value and key is different from the order in which g_hash_table_foreach() passes key-value pairs to its callback function ! +Deprecated:2.32: Use a #GHashTable instead + </description> <parameters> <parameter name="cache"> -<parameter_description> a #GCache. +<parameter_description> a #GCache </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the function to call with each #GCache key. +<parameter_description> the function to call with each #GCache key </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data to pass to the function. +<parameter_description> user data to pass to the function </parameter_description> </parameter> </parameters> @@ -4195,48 +5194,51 @@ pairs to its callback function ! <description> Creates a new #GCache. +Deprecated:2.32: Use a #GHashTable instead + </description> <parameters> <parameter name="value_new_func"> <parameter_description> a function to create a new object given a key. This is called by g_cache_insert() if an object -with the given key does not already exist. +with the given key does not already exist </parameter_description> </parameter> <parameter name="value_destroy_func"> <parameter_description> a function to destroy an object. It is called by g_cache_remove() when the object is no longer needed (i.e. its reference count drops -to 0). +to 0) </parameter_description> </parameter> <parameter name="key_dup_func"> <parameter_description> a function to copy a key. It is called by g_cache_insert() if the key does not already exist in -the #GCache. +the #GCache </parameter_description> </parameter> <parameter name="key_destroy_func"> <parameter_description> a function to destroy a key. It is called by g_cache_remove() when the object is no longer -needed (i.e. its reference count drops to 0). +needed (i.e. its reference count drops to 0) </parameter_description> </parameter> <parameter name="hash_key_func"> -<parameter_description> a function to create a hash value from a key. +<parameter_description> a function to create a hash value from a key </parameter_description> </parameter> <parameter name="hash_value_func"> -<parameter_description> a function to create a hash value from a value. +<parameter_description> a function to create a hash value from a value </parameter_description> </parameter> <parameter name="key_equal_func"> <parameter_description> a function to compare two keys. It should return -%TRUE if the two keys are equivalent. +%TRUE if the two keys are equivalent </parameter_description> </parameter> </parameters> -<return> a new #GCache. +<return> a new #GCache + </return> </function> @@ -4246,14 +5248,16 @@ Decreases the reference count of the given value. If it drops to 0 then the value and its corresponding key are destroyed, using the @value_destroy_func and @key_destroy_func passed to g_cache_new(). +Deprecated:2.32: Use a #GHashTable instead + </description> <parameters> <parameter name="cache"> -<parameter_description> a #GCache. +<parameter_description> a #GCache </parameter_description> </parameter> <parameter name="value"> -<parameter_description> the value to remove. +<parameter_description> the value to remove </parameter_description> </parameter> </parameters> @@ -4265,21 +5269,20 @@ then the value and its corresponding key are destroyed, using the Calls the given function for each of the values in the #GCache. Deprecated:2.10: The reason is that it passes pointers to internal -data structures to @func; use g_cache_key_foreach() -instead +data structures to @func; use g_cache_key_foreach() instead </description> <parameters> <parameter name="cache"> -<parameter_description> a #GCache. +<parameter_description> a #GCache </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the function to call with each #GCache value. +<parameter_description> the function to call with each #GCache value </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data to pass to the function. +<parameter_description> user data to pass to the function </parameter_description> </parameter> </parameters> @@ -5602,77 +6605,6 @@ Since: 2.8 </return> </function> -<function name="g_chunk_free"> -<description> -A convenience macro to free an atom of memory from a #GMemChunk. It -simply switches the arguments and calls g_mem_chunk_free() It is -included simply to complement the other convenience macros, -g_chunk_new() and g_chunk_new0(). - -Deprecated:2.10: Use g_slice_free() instead - -</description> -<parameters> -<parameter name="mem"> -<parameter_description> a pointer to the atom to be freed. -</parameter_description> -</parameter> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - -<function name="g_chunk_new"> -<description> -A convenience macro to allocate an atom of memory from a #GMemChunk. -It calls g_mem_chunk_alloc() and casts the returned atom to a -pointer to the given type, avoiding a type cast in the source code. - -Deprecated:2.10: Use g_slice_new() instead - -</description> -<parameters> -<parameter name="type"> -<parameter_description> the type of the #GMemChunk atoms, typically a structure name. -</parameter_description> -</parameter> -<parameter name="chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return> a pointer to the allocated atom, cast to a pointer to -@type. -</return> -</function> - -<function name="g_chunk_new0"> -<description> -A convenience macro to allocate an atom of memory from a #GMemChunk. -It calls g_mem_chunk_alloc0() and casts the returned atom to a -pointer to the given type, avoiding a type cast in the source code. - -Deprecated:2.10: Use g_slice_new0() instead - -</description> -<parameters> -<parameter name="type"> -<parameter_description> the type of the #GMemChunk atoms, typically a structure name. -</parameter_description> -</parameter> -<parameter name="chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return> a pointer to the allocated atom, cast to a pointer to -@type. -</return> -</function> - <function name="g_clear_error"> <description> If @err is %NULL, does nothing. If @err is non-%NULL, @@ -5838,8 +6770,9 @@ Invokes the closure, i.e. executes the callback represented by the @closure. </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> a #GValue to store the return value. May be %NULL if the -callback of @closure doesn't return a value. +<parameter_description> a #GValue to store the return +value. May be %NULL if the callback of @closure +doesn't return a value. </parameter_description> </parameter> <parameter name="n_param_values"> @@ -6075,7 +7008,7 @@ means that the initial reference count is not owned by any caller. g_closure_sink() checks to see if the object is still floating, and if so, unsets the floating state and decreases the reference count. If the closure is not floating, g_closure_sink() does -nothing. The reason for the existance of the floating state is to +nothing. The reason for the existence of the floating state is to prevent cumbersome code sequences like: |[ closure = g_cclosure_new (cb_func, cb_data); @@ -6376,19 +7309,116 @@ should be freed with g_free() when done using it. </return> </function> +<function name="g_compute_hmac_for_data"> +<description> +Computes the HMAC for a binary @data of @length. This is a +convenience wrapper for g_hmac_new(), g_hmac_get_string() +and g_hmac_unref(). + +The hexadecimal string returned will be in lower case. + +Since: 2.30 + +</description> +<parameters> +<parameter name="digest_type"> +<parameter_description> a #GChecksumType to use for the HMAC +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the key to use in the HMAC +</parameter_description> +</parameter> +<parameter name="key_len"> +<parameter_description> the length of the key +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> binary blob to compute the HMAC of +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> length of @data +</parameter_description> +</parameter> +</parameters> +<return> the HMAC of the binary data as a string in hexadecimal. +The returned string should be freed with g_free() when done using it. + +</return> +</function> + +<function name="g_compute_hmac_for_string"> +<description> +Computes the HMAC for a string. + +The hexadecimal string returned will be in lower case. + +Since: 2.30 + +</description> +<parameters> +<parameter name="digest_type"> +<parameter_description> a #GChecksumType to use for the HMAC +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the key to use in the HMAC +</parameter_description> +</parameter> +<parameter name="key_len"> +<parameter_description> the length of the key +</parameter_description> +</parameter> +<parameter name="str"> +<parameter_description> the string to compute the HMAC for +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> the length of the string, or -1 if the string is nul-terminated +</parameter_description> +</parameter> +</parameters> +<return> the HMAC as a hexadecimal string. +The returned string should be freed with g_free() +when done using it. + +</return> +</function> + <function name="g_cond_broadcast"> <description> -If threads are waiting for @cond, all of them are woken up. It is -good practice to lock the same mutex as the waiting threads, while -calling this function, though not required. +If threads are waiting for @cond, all of them are unblocked. +If no threads are waiting for @cond, this function has no effect. +It is good practice to lock the same mutex as the waiting threads +while calling this function, though not required. -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will do nothing. +</description> +<parameters> +<parameter name="cond"> +<parameter_description> a #GCond +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_cond_clear"> +<description> +Frees the resources allocated to a #GCond with g_cond_init(). + +This function should not be used with a #GCond that has been +statically allocated. + +Calling g_cond_clear() for a #GCond on which threads are +blocking leads to undefined behaviour. + +Since: 2.32 </description> <parameters> <parameter name="cond"> -<parameter_description> a #GCond. +<parameter_description> an initialised #GCond </parameter_description> </parameter> </parameters> @@ -6397,12 +7427,44 @@ called, and, in that case, will do nothing. <function name="g_cond_free"> <description> -Destroys the #GCond. +Destroys a #GCond that has been created with g_cond_new(). + +Calling g_cond_free() for a #GCond on which threads are +blocking leads to undefined behaviour. + +Deprecated:3.32:GCond can now be statically allocated, or embedded +in structures and initialised with g_cond_init(). </description> <parameters> <parameter name="cond"> -<parameter_description> a #GCond. +<parameter_description> a #GCond +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_cond_init"> +<description> +Initialises a #GCond so that it can be used. + +This function is useful to initialise a #GCond that has been +allocated as part of a larger structure. It is not necessary to +initialise a #GCond that has been statically allocated. + +To undo the effect of g_cond_init() when a #GCond is no longer +needed, use g_cond_clear(). + +Calling g_cond_init() on an already-initialised #GCond leads +to undefined behaviour. + +Since: 2.32 + +</description> +<parameters> +<parameter name="cond"> +<parameter_description> an uninitialized #GCond </parameter_description> </parameter> </parameters> @@ -6411,29 +7473,30 @@ Destroys the #GCond. <function name="g_cond_new"> <description> -Creates a new #GCond. This function will abort, if g_thread_init() -has not been called yet. +Allocates and initializes a new #GCond. + +Deprecated:3.32:GCond can now be statically allocated, or embedded +in structures and initialised with g_cond_init(). </description> <parameters> </parameters> -<return> a new #GCond. +<return> a newly allocated #GCond. Free with g_cond_free() + </return> </function> <function name="g_cond_signal"> <description> -If threads are waiting for @cond, exactly one of them is woken up. +If threads are waiting for @cond, at least one of them is unblocked. +If no threads are waiting for @cond, this function has no effect. It is good practice to hold the same lock as the waiting thread while calling this function, though not required. -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will do nothing. - </description> <parameters> <parameter name="cond"> -<parameter_description> a #GCond. +<parameter_description> a #GCond </parameter_description> </parameter> </parameters> @@ -6454,47 +7517,128 @@ called, and, in that case, will immediately return %TRUE. To easily calculate @abs_time a combination of g_get_current_time() and g_time_val_add() can be used. +Deprecated:2.32: Use g_cond_wait_until() instead. + </description> <parameters> <parameter name="cond"> -<parameter_description> a #GCond. +<parameter_description> a #GCond </parameter_description> </parameter> <parameter name="mutex"> -<parameter_description> a #GMutex that is currently locked. +<parameter_description> a #GMutex that is currently locked </parameter_description> </parameter> <parameter name="abs_time"> -<parameter_description> a #GTimeVal, determining the final time. +<parameter_description> a #GTimeVal, determining the final time </parameter_description> </parameter> </parameters> -<return> %TRUE if @cond was signalled, or %FALSE on timeout. +<return> %TRUE if @cond was signalled, or %FALSE on timeout </return> </function> <function name="g_cond_wait"> <description> -Waits until this thread is woken up on @cond. The @mutex is unlocked -before falling asleep and locked again before resuming. +Atomically releases @mutex and waits until @cond is signalled. -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will immediately return. +When using condition variables, it is possible that a spurious wakeup +may occur (ie: g_cond_wait() returns even though g_cond_signal() was +not called). It's also possible that a stolen wakeup may occur. +This is when g_cond_signal() is called, but another thread acquires +@mutex before this thread and modifies the state of the program in +such a way that when g_cond_wait() is able to return, the expected +condition is no longer met. + +For this reason, g_cond_wait() must always be used in a loop. See +the documentation for #GCond for a complete example. </description> <parameters> <parameter name="cond"> -<parameter_description> a #GCond. +<parameter_description> a #GCond </parameter_description> </parameter> <parameter name="mutex"> -<parameter_description> a #GMutex, that is currently locked. +<parameter_description> a #GMutex that is currently locked </parameter_description> </parameter> </parameters> <return></return> </function> +<function name="g_cond_wait_until"> +<description> +Waits until either @cond is signalled or @end_time has passed. + +As with g_cond_wait() it is possible that a spurious or stolen wakeup +could occur. For that reason, waiting on a condition variable should +always be in a loop, based on an explicitly-checked predicate. + +%TRUE is returned if the condition variable was signalled (or in the +case of a spurious wakeup). %FALSE is returned if @end_time has +passed. + +The following code shows how to correctly perform a timed wait on a +condition variable (extended the example presented in the +documentation for #GCond): + +|[ +gpointer +pop_data_timed (void) +{ +gint64 end_time; +gpointer data; + +g_mutex_lock (&data_mutex); + +end_time = g_get_monotonic_time () + 5 * G_TIME_SPAN_SECOND; +while (!current_data) +if (!g_cond_wait_until (&data_cond, &data_mutex, end_time)) +{ +// timeout has passed. +g_mutex_unlock (&data_mutex); +return NULL; +} + +// there is data for us +data = current_data; +current_data = NULL; + +g_mutex_unlock (&data_mutex); + +return data; +} +]| + +Notice that the end time is calculated once, before entering the +loop and reused. This is the motivation behind the use of absolute +time on this API -- if a relative time of 5 seconds were passed +directly to the call and a spurious wakeup occurred, the program would +have to start over waiting again (which would lead to a total wait +time of more than 5 seconds). + +Since: 2.32 + +</description> +<parameters> +<parameter name="cond"> +<parameter_description> a #GCond +</parameter_description> +</parameter> +<parameter name="mutex"> +<parameter_description> a #GMutex that is currently locked +</parameter_description> +</parameter> +<parameter name="end_time"> +<parameter_description> the monotonic time to wait until +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on a signal, %FALSE on a timeout +</return> +</function> + <function name="g_convert"> <description> Converts a string from one character set to another. @@ -6545,7 +7689,7 @@ including the terminating nul). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -6611,7 +7755,7 @@ including the terminating nul). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -6674,7 +7818,7 @@ including the terminating nul). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -6726,6 +7870,30 @@ return value can be used exactly like the return value from creat(). </return> </function> +<function name="g_critical"> +<description> +Logs a "critical warning" (#G_LOG_LEVEL_CRITICAL). +It's more or less application-defined what constitutes +a critical vs. a regular warning. You could call +g_log_set_always_fatal() to make critical warnings exit +the program, then use g_critical() for fatal errors, for +example. + +You can also make critical warnings fatal at runtime by +setting the <envar>G_DEBUG</envar> environment variable (see +<ulink url="glib-running.html">Running GLib Applications</ulink>). + +</description> +<parameters> +<parameter name="Varargs"> +<parameter_description> format string, followed by parameters to insert +into the format string (as with printf()) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_datalist_clear"> <description> Frees all the data elements of the datalist. @@ -6771,16 +7939,16 @@ not be called. <function name="g_datalist_get_data"> <description> -Gets a data element, using its string identifer. This is slower than +Gets a data element, using its string identifier. This is slower than g_datalist_id_get_data() because it compares strings. </description> <parameters> -<parameter name="dl"> +<parameter name="datalist"> <parameter_description> a datalist. </parameter_description> </parameter> -<parameter name="k"> +<parameter name="key"> <parameter_description> the string identifying a data element. </parameter_description> </parameter> @@ -7346,6 +8514,228 @@ free any memory allocated for it. <return></return> </function> +<function name="g_date_add_days"> +<description> +Increments a date some number of days. +To move forward by weeks, add weeks*7 days. +The date must be valid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to increment +</parameter_description> +</parameter> +<parameter name="n_days"> +<parameter_description> number of days to move the date forward +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_add_months"> +<description> +Increments a date by some number of months. +If the day of the month is greater than 28, +this routine may change the day of the month +(because the destination month may not have +the current day in it). The date must be valid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to increment +</parameter_description> +</parameter> +<parameter name="n_months"> +<parameter_description> number of months to move forward +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_add_years"> +<description> +Increments a date by some number of years. +If the date is February 29, and the destination +year is not a leap year, the date will be changed +to February 28. The date must be valid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to increment +</parameter_description> +</parameter> +<parameter name="n_years"> +<parameter_description> number of years to move forward +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_clamp"> +<description> +If @date is prior to @min_date, sets @date equal to @min_date. +If @date falls after @max_date, sets @date equal to @max_date. +Otherwise, @date is unchanged. +Either of @min_date and @max_date may be %NULL. +All non-%NULL dates must be valid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to clamp +</parameter_description> +</parameter> +<parameter name="min_date"> +<parameter_description> minimum accepted value for @date +</parameter_description> +</parameter> +<parameter name="max_date"> +<parameter_description> maximum accepted value for @date +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_clear"> +<description> +Initializes one or more #GDate structs to a sane but invalid +state. The cleared dates will not represent an existing date, but will +not contain garbage. Useful to init a date declared on the stack. +Validity can be tested with g_date_valid(). + +</description> +<parameters> +<parameter name="date"> +<parameter_description> pointer to one or more dates to clear +</parameter_description> +</parameter> +<parameter name="n_dates"> +<parameter_description> number of dates to clear +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_compare"> +<description> +qsort()-style comparison function for dates. +Both dates must be valid. + + +</description> +<parameters> +<parameter name="lhs"> +<parameter_description> first date to compare +</parameter_description> +</parameter> +<parameter name="rhs"> +<parameter_description> second date to compare +</parameter_description> +</parameter> +</parameters> +<return> 0 for equal, less than zero if @lhs is less than @rhs, +greater than zero if @lhs is greater than @rhs +</return> +</function> + +<function name="g_date_days_between"> +<description> +Computes the number of days between two dates. +If @date2 is prior to @date1, the returned value is negative. +Both dates must be valid. + + +</description> +<parameters> +<parameter name="date1"> +<parameter_description> the first date +</parameter_description> +</parameter> +<parameter name="date2"> +<parameter_description> the second date +</parameter_description> +</parameter> +</parameters> +<return> the number of days between @date1 and @date2 +</return> +</function> + +<function name="g_date_free"> +<description> +Frees a #GDate returned from g_date_new(). + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to free +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_get_day"> +<description> +Returns the day of the month. The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to extract the day of the month from +</parameter_description> +</parameter> +</parameters> +<return> day of the month +</return> +</function> + +<function name="g_date_get_day_of_year"> +<description> +Returns the day of the year, where Jan 1 is the first day of the +year. The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to extract day of year from +</parameter_description> +</parameter> +</parameters> +<return> day of the year +</return> +</function> + +<function name="g_date_get_days_in_month"> +<description> +Returns the number of days in a month, taking leap +years into account. + + +</description> +<parameters> +<parameter name="month"> +<parameter_description> month +</parameter_description> +</parameter> +<parameter name="year"> +<parameter_description> year +</parameter_description> +</parameter> +</parameters> +<return> number of days in @month during the @year +</return> +</function> + <function name="g_date_get_iso8601_week_of_year"> <description> Returns the week of the year, where weeks are interpreted according @@ -7365,6 +8755,399 @@ Since: 2.6 </return> </function> +<function name="g_date_get_julian"> +<description> +Returns the Julian day or "serial number" of the #GDate. The +Julian day is simply the number of days since January 1, Year 1; i.e., +January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2, +etc. The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to extract the Julian day from +</parameter_description> +</parameter> +</parameters> +<return> Julian day +</return> +</function> + +<function name="g_date_get_monday_week_of_year"> +<description> +Returns the week of the year, where weeks are understood to start on +Monday. If the date is before the first Monday of the year, return +0. The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +</parameters> +<return> week of the year +</return> +</function> + +<function name="g_date_get_monday_weeks_in_year"> +<description> +Returns the number of weeks in the year, where weeks +are taken to start on Monday. Will be 52 or 53. The +date must be valid. (Years always have 52 7-day periods, +plus 1 or 2 extra days depending on whether it's a leap +year. This function is basically telling you how many +Mondays are in the year, i.e. there are 53 Mondays if +one of the extra days happens to be a Monday.) + + +</description> +<parameters> +<parameter name="year"> +<parameter_description> a year +</parameter_description> +</parameter> +</parameters> +<return> number of Mondays in the year +</return> +</function> + +<function name="g_date_get_month"> +<description> +Returns the month of the year. The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to get the month from +</parameter_description> +</parameter> +</parameters> +<return> month of the year as a #GDateMonth +</return> +</function> + +<function name="g_date_get_sunday_week_of_year"> +<description> +Returns the week of the year during which this date falls, if weeks +are understood to being on Sunday. The date must be valid. Can return +0 if the day is before the first Sunday of the year. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +</parameters> +<return> week number +</return> +</function> + +<function name="g_date_get_sunday_weeks_in_year"> +<description> +Returns the number of weeks in the year, where weeks +are taken to start on Sunday. Will be 52 or 53. The +date must be valid. (Years always have 52 7-day periods, +plus 1 or 2 extra days depending on whether it's a leap +year. This function is basically telling you how many +Sundays are in the year, i.e. there are 53 Sundays if +one of the extra days happens to be a Sunday.) + + +</description> +<parameters> +<parameter name="year"> +<parameter_description> year to count weeks in +</parameter_description> +</parameter> +</parameters> +<return> the number of weeks in @year +</return> +</function> + +<function name="g_date_get_weekday"> +<description> +Returns the day of the week for a #GDate. The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +</parameters> +<return> day of the week as a #GDateWeekday. +</return> +</function> + +<function name="g_date_get_year"> +<description> +Returns the year of a #GDate. The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +</parameters> +<return> year in which the date falls +</return> +</function> + +<function name="g_date_is_first_of_month"> +<description> +Returns %TRUE if the date is on the first of a month. +The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to check +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the date is the first of the month +</return> +</function> + +<function name="g_date_is_last_of_month"> +<description> +Returns %TRUE if the date is the last day of the month. +The date must be valid. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to check +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the date is the last day of the month +</return> +</function> + +<function name="g_date_is_leap_year"> +<description> +Returns %TRUE if the year is a leap year. +<footnote><para>For the purposes of this function, +leap year is every year divisible by 4 unless that year +is divisible by 100. If it is divisible by 100 it would +be a leap year only if that year is also divisible +by 400.</para></footnote> + + +</description> +<parameters> +<parameter name="year"> +<parameter_description> year to check +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the year is a leap year +</return> +</function> + +<function name="g_date_new"> +<description> +Allocates a #GDate and initializes +it to a sane state. The new date will +be cleared (as if you'd called g_date_clear()) but invalid (it won't +represent an existing day). Free the return value with g_date_free(). + + +</description> +<parameters> +</parameters> +<return> a newly-allocated #GDate +</return> +</function> + +<function name="g_date_new_dmy"> +<description> +Like g_date_new(), but also sets the value of the date. Assuming the +day-month-year triplet you pass in represents an existing day, the +returned date will be valid. + + +</description> +<parameters> +<parameter name="day"> +<parameter_description> day of the month +</parameter_description> +</parameter> +<parameter name="month"> +<parameter_description> month of the year +</parameter_description> +</parameter> +<parameter name="year"> +<parameter_description> year +</parameter_description> +</parameter> +</parameters> +<return> a newly-allocated #GDate initialized with @day, @month, and @year +</return> +</function> + +<function name="g_date_new_julian"> +<description> +Like g_date_new(), but also sets the value of the date. Assuming the +Julian day number you pass in is valid (greater than 0, less than an +unreasonably large number), the returned date will be valid. + + +</description> +<parameters> +<parameter name="julian_day"> +<parameter_description> days since January 1, Year 1 +</parameter_description> +</parameter> +</parameters> +<return> a newly-allocated #GDate initialized with @julian_day +</return> +</function> + +<function name="g_date_order"> +<description> +Checks if @date1 is less than or equal to @date2, +and swap the values if this is not the case. + +</description> +<parameters> +<parameter name="date1"> +<parameter_description> the first date +</parameter_description> +</parameter> +<parameter name="date2"> +<parameter_description> the second date +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_set_day"> +<description> +Sets the day of the month for a #GDate. If the resulting +day-month-year triplet is invalid, the date will be invalid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +<parameter name="day"> +<parameter_description> day to set +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_set_dmy"> +<description> +Sets the value of a #GDate from a day, month, and year. +The day-month-year triplet must be valid; if you aren't +sure it is, call g_date_valid_dmy() to check before you +set it. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +<parameter name="day"> +<parameter_description> day +</parameter_description> +</parameter> +<parameter name="month"> +<parameter_description> month +</parameter_description> +</parameter> +<parameter name="y"> +<parameter_description> year +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_set_julian"> +<description> +Sets the value of a #GDate from a Julian day number. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +<parameter name="julian_date"> +<parameter_description> Julian day number (days since January 1, Year 1) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_set_month"> +<description> +Sets the month of the year for a #GDate. If the resulting +day-month-year triplet is invalid, the date will be invalid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +<parameter name="month"> +<parameter_description> month to set +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_set_parse"> +<description> +Parses a user-inputted string @str, and try to figure out what date it +represents, taking the <link linkend="setlocale">current locale</link> +into account. If the string is successfully parsed, the date will be +valid after the call. Otherwise, it will be invalid. You should check +using g_date_valid() to see whether the parsing succeeded. + +This function is not appropriate for file formats and the like; it +isn't very precise, and its exact behavior varies with the locale. +It's intended to be a heuristic routine that guesses what the user +means by a given string (and it does work pretty well in that +capacity). + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to fill in +</parameter_description> +</parameter> +<parameter name="str"> +<parameter_description> string to parse +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_date_set_time"> <description> Sets the value of a date from a #GTime value. @@ -7437,6 +9220,128 @@ Since: 2.10 <return></return> </function> +<function name="g_date_set_year"> +<description> +Sets the year for a #GDate. If the resulting day-month-year +triplet is invalid, the date will be invalid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate +</parameter_description> +</parameter> +<parameter name="year"> +<parameter_description> year to set +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_strftime"> +<description> +Generates a printed representation of the date, in a +<link linkend="setlocale">locale</link>-specific way. +Works just like the platform's C library strftime() function, +but only accepts date-related formats; time-related formats +give undefined results. Date must be valid. Unlike strftime() +(which uses the locale encoding), works on a UTF-8 format +string and stores a UTF-8 result. + +This function does not provide any conversion specifiers in +addition to those implemented by the platform's C library. +For example, don't expect that using g_date_strftime() would +make the \%F provided by the C99 strftime() work on Windows +where the C library only complies to C89. + + +</description> +<parameters> +<parameter name="s"> +<parameter_description> destination buffer +</parameter_description> +</parameter> +<parameter name="slen"> +<parameter_description> buffer size +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> format string +</parameter_description> +</parameter> +<parameter name="date"> +<parameter_description> valid #GDate +</parameter_description> +</parameter> +</parameters> +<return> number of characters written to the buffer, or 0 the buffer was too small +</return> +</function> + +<function name="g_date_subtract_days"> +<description> +Moves a date some number of days into the past. +To move by weeks, just move by weeks*7 days. +The date must be valid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to decrement +</parameter_description> +</parameter> +<parameter name="n_days"> +<parameter_description> number of days to move +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_subtract_months"> +<description> +Moves a date some number of months into the past. +If the current day of the month doesn't exist in +the destination month, the day of the month +may change. The date must be valid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to decrement +</parameter_description> +</parameter> +<parameter name="n_months"> +<parameter_description> number of months to move +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_subtract_years"> +<description> +Moves a date some number of years into the past. +If the current day doesn't exist in the destination +year (i.e. it's February 29 and you move to a non-leap-year) +then the day is changed to February 29. The date +must be valid. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to decrement +</parameter_description> +</parameter> +<parameter name="n_years"> +<parameter_description> number of years to move +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_date_time_add"> <description> Creates a copy of @datetime and adds the specified timespan to the copy. @@ -7748,184 +9653,221 @@ Since: 2.26 Creates a newly allocated string representing the requested @format. The format strings understood by this function are a subset of the -strftime() format language. In contrast to strftime(), this function -always produces a UTF-8 string, regardless of the current locale. -Note that the rendering of many formats is locale-dependent and may -not match the strftime() output exactly. +strftime() format language as specified by C99. The \%D, \%U and \%W +conversions are not supported, nor is the 'E' modifier. The GNU +extensions \%k, \%l, \%s and \%P are supported, however, as are the +'0', '_' and '-' modifiers. + +In contrast to strftime(), this function always produces a UTF-8 +string, regardless of the current locale. Note that the rendering of +many formats is locale-dependent and may not match the strftime() +output exactly. The following format specifiers are supported: <variablelist> <varlistentry><term> -<literal>%%a</literal>: +<literal>\%a</literal>: </term><listitem><simpara> the abbreviated weekday name according to the current locale </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%A</literal>: +<literal>\%A</literal>: </term><listitem><simpara> the full weekday name according to the current locale </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%b</literal>: +<literal>\%b</literal>: </term><listitem><simpara> the abbreviated month name according to the current locale </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%B</literal>: +<literal>\%B</literal>: </term><listitem><simpara> the full month name according to the current locale </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%d</literal>: +<literal>\%c</literal>: +</term><listitem><simpara> +the preferred date and time representation for the current locale +</simpara></listitem></varlistentry> +<varlistentry><term> +<literal>\%C</literal>: +</term><listitem><simpara> +The century number (year/100) as a 2-digit integer (00-99) +</simpara></listitem></varlistentry> +<varlistentry><term> +<literal>\%d</literal>: </term><listitem><simpara> the day of the month as a decimal number (range 01 to 31) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%e</literal>: +<literal>\%e</literal>: </term><listitem><simpara> the day of the month as a decimal number (range 1 to 31) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%F</literal>: +<literal>\%F</literal>: </term><listitem><simpara> -equivalent to <literal>%%Y-%%m-%%d</literal> (the ISO 8601 date +equivalent to <literal>\%Y-\%m-\%d</literal> (the ISO 8601 date format) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%h</literal>: +<literal>\%g</literal>: +</term><listitem><simpara> +the last two digits of the ISO 8601 week-based year as a decimal +number (00-99). This works well with \%V and \%u. +</simpara></listitem></varlistentry> +<varlistentry><term> +<literal>\%G</literal>: +</term><listitem><simpara> +the ISO 8601 week-based year as a decimal number. This works well +with \%V and \%u. +</simpara></listitem></varlistentry> +<varlistentry><term> +<literal>\%h</literal>: </term><listitem><simpara> -equivalent to <literal>%%b</literal> +equivalent to <literal>\%b</literal> </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%H</literal>: +<literal>\%H</literal>: </term><listitem><simpara> the hour as a decimal number using a 24-hour clock (range 00 to 23) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%I</literal>: +<literal>\%I</literal>: </term><listitem><simpara> the hour as a decimal number using a 12-hour clock (range 01 to 12) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%j</literal>: +<literal>\%j</literal>: </term><listitem><simpara> the day of the year as a decimal number (range 001 to 366) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%k</literal>: +<literal>\%k</literal>: </term><listitem><simpara> the hour (24-hour clock) as a decimal number (range 0 to 23); single digits are preceded by a blank </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%l</literal>: +<literal>\%l</literal>: </term><listitem><simpara> the hour (12-hour clock) as a decimal number (range 1 to 12); single digits are preceded by a blank </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%m</literal>: +<literal>\%m</literal>: </term><listitem><simpara> the month as a decimal number (range 01 to 12) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%M</literal>: +<literal>\%M</literal>: </term><listitem><simpara> the minute as a decimal number (range 00 to 59) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%N</literal>: -</term><listitem><simpara> -the micro-seconds as a decimal number -</simpara></listitem></varlistentry> -<varlistentry><term> -<literal>%%p</literal>: +<literal>\%p</literal>: </term><listitem><simpara> either "AM" or "PM" according to the given time value, or the corresponding strings for the current locale. Noon is treated as "PM" and midnight as "AM". </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%P</literal>: +<literal>\%P</literal>: </term><listitem><simpara> -like %%p but lowercase: "am" or "pm" or a corresponding string for +like \%p but lowercase: "am" or "pm" or a corresponding string for the current locale </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%r</literal>: +<literal>\%r</literal>: </term><listitem><simpara> the time in a.m. or p.m. notation </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%R</literal>: +<literal>\%R</literal>: </term><listitem><simpara> -the time in 24-hour notation (<literal>%%H:%%M</literal>) +the time in 24-hour notation (<literal>\%H:\%M</literal>) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%s</literal>: +<literal>\%s</literal>: </term><listitem><simpara> the number of seconds since the Epoch, that is, since 1970-01-01 00:00:00 UTC </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%S</literal>: +<literal>\%S</literal>: </term><listitem><simpara> the second as a decimal number (range 00 to 60) </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%t</literal>: +<literal>\%t</literal>: </term><listitem><simpara> a tab character </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%u</literal>: +<literal>\%T</literal>: +</term><listitem><simpara> +the time in 24-hour notation with seconds (<literal>\%H:\%M:\%S</literal>) +</simpara></listitem></varlistentry> +<varlistentry><term> +<literal>\%u</literal>: </term><listitem><simpara> -the day of the week as a decimal, range 1 to 7, Monday being 1 +the ISO 8601 standard day of the week as a decimal, range 1 to 7, +Monday being 1. This works well with \%G and \%V. </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%W</literal>: +<literal>\%V</literal>: </term><listitem><simpara> -the week number of the current year as a decimal number +the ISO 8601 standard week number of the current year as a decimal +number, range 01 to 53, where week 1 is the first week that has at +least 4 days in the new year. See g_date_time_get_week_of_year(). +This works well with \%G and \%u. </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%x</literal>: +<literal>\%w</literal>: +</term><listitem><simpara> +the day of the week as a decimal, range 0 to 6, Sunday being 0. +This is not the ISO 8601 standard format -- use \%u instead. +</simpara></listitem></varlistentry> +<varlistentry><term> +<literal>\%x</literal>: </term><listitem><simpara> the preferred date representation for the current locale without the time </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%X</literal>: +<literal>\%X</literal>: </term><listitem><simpara> the preferred time representation for the current locale without the date </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%y</literal>: +<literal>\%y</literal>: </term><listitem><simpara> the year as a decimal number without the century </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%Y</literal>: +<literal>\%Y</literal>: </term><listitem><simpara> the year as a decimal number including the century </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%z</literal>: +<literal>\%z</literal>: </term><listitem><simpara> the time-zone as hour offset from UTC </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%Z</literal>: +<literal>\%Z</literal>: </term><listitem><simpara> the time zone or name or abbreviation </simpara></listitem></varlistentry> <varlistentry><term> -<literal>%%%</literal>: +<literal>\%\%</literal>: </term><listitem><simpara> -a literal <literal>%%</literal> character +a literal <literal>\%</literal> character </simpara></listitem></varlistentry> </variablelist> @@ -8220,15 +10162,15 @@ calendar year. For other days, the number is such that every day within a complete week (Monday to Sunday) is contained within the same week-numbering year. -For Monday, Tuesday and Wednesday occuring near the end of the year, +For Monday, Tuesday and Wednesday occurring near the end of the year, this may mean that the week-numbering year is one greater than the calendar year (so that these days have the same week-numbering year -as the Thursday occuring early in the next year). +as the Thursday occurring early in the next year). -For Friday, Saturaday and Sunday occuring near the start of the year, +For Friday, Saturaday and Sunday occurring near the start of the year, this may mean that the week-numbering year is one less than the calendar year (so that these days have the same week-numbering year -as the Thursday occuring late in the previous year). +as the Thursday occurring late in the previous year). An equivalent description is that the week-numbering year is equal to the calendar year containing the majority of the days in the current @@ -8263,7 +10205,7 @@ the first Thursday of the year. Equivalently, this is the first week that has more than 4 of its days falling within the calendar year. The value 0 is never returned by this function. Days contained -within a year but occuring before the first ISO 8601 week of that +within a year but occurring before the first ISO 8601 week of that year are considered as being contained in the last week of the previous year. Similarly, the final days of a calendar year may be considered as being part of the first ISO 8601 week of the next year @@ -8859,10 +10801,159 @@ Since: 2.26 <return></return> </function> +<function name="g_date_to_struct_tm"> +<description> +Fills in the date-related bits of a <structname>struct tm</structname> +using the @date value. Initializes the non-date parts with something +sane but meaningless. + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to set the <structname>struct tm</structname> from +</parameter_description> +</parameter> +<parameter name="tm"> +<parameter_description> <structname>struct tm</structname> to fill +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_date_valid"> +<description> +Returns %TRUE if the #GDate represents an existing day. The date must not +contain garbage; it should have been initialized with g_date_clear() +if it wasn't allocated by one of the g_date_new() variants. + + +</description> +<parameters> +<parameter name="date"> +<parameter_description> a #GDate to check +</parameter_description> +</parameter> +</parameters> +<return> Whether the date is valid +</return> +</function> + +<function name="g_date_valid_day"> +<description> +Returns %TRUE if the day of the month is valid (a day is valid if it's +between 1 and 31 inclusive). + + +</description> +<parameters> +<parameter name="day"> +<parameter_description> day to check +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the day is valid +</return> +</function> + +<function name="g_date_valid_dmy"> +<description> +Returns %TRUE if the day-month-year triplet forms a valid, existing day +in the range of days #GDate understands (Year 1 or later, no more than +a few thousand years in the future). + + +</description> +<parameters> +<parameter name="day"> +<parameter_description> day +</parameter_description> +</parameter> +<parameter name="month"> +<parameter_description> month +</parameter_description> +</parameter> +<parameter name="year"> +<parameter_description> year +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the date is a valid one +</return> +</function> + +<function name="g_date_valid_julian"> +<description> +Returns %TRUE if the Julian day is valid. Anything greater than zero +is basically a valid Julian, though there is a 32-bit limit. + + +</description> +<parameters> +<parameter name="julian_date"> +<parameter_description> Julian day to check +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the Julian day is valid +</return> +</function> + +<function name="g_date_valid_month"> +<description> +Returns %TRUE if the month value is valid. The 12 #GDateMonth +enumeration values are the only valid months. + + +</description> +<parameters> +<parameter name="month"> +<parameter_description> month +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the month is valid +</return> +</function> + +<function name="g_date_valid_weekday"> +<description> +Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration +values are the only valid weekdays. + + +</description> +<parameters> +<parameter name="weekday"> +<parameter_description> weekday +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the weekday is valid +</return> +</function> + +<function name="g_date_valid_year"> +<description> +Returns %TRUE if the year is valid. Any year greater than 0 is valid, +though there is a 16-bit limit to what #GDate will understand. + + +</description> +<parameters> +<parameter name="year"> +<parameter_description> year +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the year is valid +</return> +</function> + <function name="g_dcgettext"> <description> This is a variant of g_dgettext() that allows specifying a locale -category instead of always using %LC_MESSAGES. See g_dgettext() for +category instead of always using <envar>LC_MESSAGES</envar>. See g_dgettext() for more information about how this functions differs from calling dcgettext() directly. @@ -8889,6 +10980,23 @@ the domain set with textdomain() </return> </function> +<function name="g_debug"> +<description> +A convenience function/macro to log a debug message. + +Since: 2.6 + +</description> +<parameters> +<parameter name="Varargs"> +<parameter_description> format string, followed by parameters to insert +into the format string (as with printf()) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_dgettext"> <description> This function is a wrapper of dgettext() which does not translate @@ -8955,6 +11063,42 @@ Closes the directory and deallocates all related resources. <return></return> </function> +<function name="g_dir_make_tmp"> +<description> +Creates a subdirectory in the preferred directory for temporary +files (as returned by g_get_tmp_dir()). + +@tmpl should be a string in the GLib file name encoding containing +a sequence of six 'X' characters, as the parameter to g_mkstemp(). +However, unlike these functions, the template should only be a +basename, no directory components are allowed. If template is +%NULL, a default template is used. + +Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not +modified, and might thus be a read-only literal string. + +Since: 2.30 + +</description> +<parameters> +<parameter name="tmpl"> +<parameter_description> Template for directory name, +as in g_mkdtemp(), basename only, or %NULL for a default template +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError +</parameter_description> +</parameter> +</parameters> +<return> The actual name used. This string +should be freed with g_free() when not needed any longer and is +is in the GLib file name encoding. In case of errors, %NULL is +returned and @error will be set. + +</return> +</function> + <function name="g_dir_open"> <description> Opens a directory for reading. The names of the files in the @@ -9032,17 +11176,21 @@ will return the first entry again. <description> Compares two #gpointer arguments and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func -parameter, when using pointers as keys in a #GHashTable. +parameter, when using opaque pointers compared by pointer value as keys +in a #GHashTable. + +This equality function is also appropriate for keys that are integers stored +in pointers, such as <literal>GINT_TO_POINTER (n)</literal>. </description> <parameters> <parameter name="v1"> -<parameter_description> a key. +<parameter_description> a key </parameter_description> </parameter> <parameter name="v2"> -<parameter_description> a key to compare with @v1. +<parameter_description> a key to compare with @v1 </parameter_description> </parameter> </parameters> @@ -9053,8 +11201,12 @@ parameter, when using pointers as keys in a #GHashTable. <function name="g_direct_hash"> <description> Converts a gpointer to a hash value. -It can be passed to g_hash_table_new() as the @hash_func parameter, -when using pointers as keys in a #GHashTable. +It can be passed to g_hash_table_new() as the @hash_func parameter, +when using opaque pointers compared by pointer value as keys in a +#GHashTable. + +This hash function is also appropriate for keys that are integers stored +in pointers, such as <literal>GINT_TO_POINTER (n)</literal>. </description> @@ -9071,6 +11223,7 @@ when using pointers as keys in a #GHashTable. <function name="g_dirname"> <description> Gets the directory components of a file name. + If the file name has no directory components "." is returned. The returned string should be freed when no longer needed. @@ -9126,21 +11279,22 @@ the domain set with textdomain() <function name="g_double_equal"> <description> -Compares the two #gdouble values being pointed to and returns +Compares the two #gdouble values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func -parameter, when using pointers to doubles as keys in a #GHashTable. +parameter, when using non-%NULL pointers to doubles as keys in a +#GHashTable. Since: 2.22 </description> <parameters> <parameter name="v1"> -<parameter_description> a pointer to a #gdouble key. +<parameter_description> a pointer to a #gdouble key </parameter_description> </parameter> <parameter name="v2"> -<parameter_description> a pointer to a #gdouble key to compare with @v1. +<parameter_description> a pointer to a #gdouble key to compare with @v1 </parameter_description> </parameter> </parameters> @@ -9152,8 +11306,9 @@ Since: 2.22 <function name="g_double_hash"> <description> Converts a pointer to a #gdouble to a hash value. -It can be passed to g_hash_table_new() as the @hash_func parameter, -when using pointers to doubles as keys in a #GHashTable. +It can be passed to g_hash_table_new() as the @hash_func parameter, +It can be passed to g_hash_table_new() as the @hash_func parameter, +when using non-%NULL pointers to doubles as keys in a #GHashTable. Since: 2.22 @@ -9179,7 +11334,7 @@ If 0 is passed as @msgidoffset, this function will fall back to trying to use the deprecated convention of using "|" as a separation character. -This uses g_dgettext() internally. See that functions for differences +This uses g_dgettext() internally. See that functions for differences with dgettext() proper. Applications should normally not use this function directly, @@ -9216,7 +11371,7 @@ a disambiguating message context. GNU gettext uses the '\004' character to separate the message context and message id in @msgctxtid. -This uses g_dgettext() internally. See that functions for differences +This uses g_dgettext() internally. See that functions for differences with dgettext() proper. This function differs from C_() in that it is not a macro and @@ -9247,7 +11402,7 @@ the domain set with textdomain() <function name="g_enum_complete_type_info"> <description> -This function is meant to be called from the complete_type_info() +This function is meant to be called from the <literal>complete_type_info</literal> function of a #GTypePlugin implementation, as in the following example: @@ -9379,6 +11534,125 @@ be stack-allocated. </return> </function> +<function name="g_environ_getenv"> +<description> +Returns the value of the environment variable @variable in the +provided list @envp. + +The name and value are in the GLib file name encoding. +On UNIX, this means the actual bytes which might or might not +be in some consistent character set and encoding. On Windows, +it is in UTF-8. On Windows, in case the environment variable's +value contains references to other environment variables, they +are expanded. + +Since: 2.32 + +</description> +<parameters> +<parameter name="envp"> +<parameter_description> an environment +list (eg, as returned from g_get_environ()) +</parameter_description> +</parameter> +<parameter name="variable"> +<parameter_description> the environment variable to get, in the GLib file name +encoding +</parameter_description> +</parameter> +</parameters> +<return> the value of the environment variable, or %NULL if +the environment variable is not set in @envp. The returned +string is owned by @envp, and will be freed if @variable is +set or unset again. + +</return> +</function> + +<function name="g_environ_setenv"> +<description> +Sets the environment variable @variable in the provided list +@envp to @value. + +Both the variable's name and value should be in the GLib +file name encoding. On UNIX, this means that they can be +arbitrary byte strings. On Windows, they should be in UTF-8. + +Since: 2.32 + +</description> +<parameters> +<parameter name="envp"> +<parameter_description> an environment +list (eg, as returned from g_get_environ()) +</parameter_description> +</parameter> +<parameter name="variable"> +<parameter_description> the environment variable to set, must not contain '=' +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the value for to set the variable to +</parameter_description> +</parameter> +<parameter name="overwrite"> +<parameter_description> whether to change the variable if it already exists +</parameter_description> +</parameter> +</parameters> +<return> the +updated environment + +</return> +</function> + +<function name="g_environ_unsetenv"> +<description> +Removes the environment variable @variable from the provided +environment @envp. + +Since: 2.32 + +</description> +<parameters> +<parameter name="envp"> +<parameter_description> an environment +list (eg, as returned from g_get_environ()) +</parameter_description> +</parameter> +<parameter name="variable"> +<parameter_description> the environment variable to remove, must not contain '=' +</parameter_description> +</parameter> +</parameters> +<return> the +updated environment + +</return> +</function> + +<function name="g_error"> +<description> +A convenience function/macro to log an error message. + +Error messages are always fatal, resulting in a call to +abort() to terminate the application. This function will +result in a core dump; don't use it for errors you expect. +Using this function indicates a bug in your program, i.e. +an assertion failure. + + +</description> +<parameters> +<parameter name="Varargs"> +<parameter_description> format string, followed by parameters to insert +into the format string (as with printf()) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_error_copy"> <description> Makes a copy of @error. @@ -9524,9 +11798,9 @@ Since: 2.22 <function name="g_file_error_from_errno"> <description> -Gets a #GFileError constant based on the passed-in @errno. -For example, if you pass in %EEXIST this function returns -#G_FILE_ERROR_EXIST. Unlike @errno values, you can portably +Gets a #GFileError constant based on the passed-in @err_no. +For example, if you pass in <literal>EEXIST</literal> this function returns +#G_FILE_ERROR_EXIST. Unlike <literal>errno</literal> values, you can portably assume that all #GFileError values will exist. Normally a #GFileError value goes into a #GError returned @@ -9586,31 +11860,33 @@ the returned string <function name="g_file_open_tmp"> <description> Opens a file for writing in the preferred directory for temporary -files (as returned by g_get_tmp_dir()). +files (as returned by g_get_tmp_dir()). -@tmpl should be a string in the GLib file name encoding containing +@tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, as the parameter to g_mkstemp(). However, unlike these functions, the template should only be a basename, no directory components are allowed. If template is %NULL, a default template is used. -Note that in contrast to g_mkstemp() (and mkstemp()) -@tmpl is not modified, and might thus be a read-only literal string. +Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not +modified, and might thus be a read-only literal string. -The actual name used is returned in @name_used if non-%NULL. This -string should be freed with g_free() when not needed any longer. -The returned name is in the GLib file name encoding. +Upon success, and if @name_used is non-%NULL, the actual name used +is returned in @name_used. This string should be freed with g_free() +when not needed any longer. The returned name is in the GLib file +name encoding. </description> <parameters> <parameter name="tmpl"> -<parameter_description> Template for file name, as in g_mkstemp(), basename only, -or %NULL, to a default template +<parameter_description> Template for file name, as in +g_mkstemp(), basename only, or %NULL for a default template </parameter_description> </parameter> <parameter name="name_used"> -<parameter_description> location to store actual name used, or %NULL +<parameter_description> location to store actual name used, +or %NULL </parameter_description> </parameter> <parameter name="error"> @@ -9618,11 +11894,10 @@ or %NULL, to a default template </parameter_description> </parameter> </parameters> -<return> A file handle (as from open()) to -the file opened for reading and writing. The file is opened in binary -mode on platforms where there is a difference. The file handle should be -closed with close(). In case of errors, -1 is returned -and @error will be set. +<return> A file handle (as from open()) to the file opened for +reading and writing. The file is opened in binary mode on platforms +where there is a difference. The file handle should be closed with +close(). In case of errors, -1 is returned and @error will be set. </return> </function> @@ -9677,7 +11952,7 @@ process, or mapped into memory. Thus, this function will fail if </listitem> </itemizedlist> -If the call was sucessful, it returns %TRUE. If the call was not successful, +If the call was successful, it returns %TRUE. If the call was not successful, it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error codes are those in the #GFileError enumeration. @@ -9753,7 +12028,7 @@ On Windows, there are no symlinks, so testing for %G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for %G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and its name indicates that it is executable, checking for well-known -extensions and those listed in the %PATHEXT environment variable. +extensions and those listed in the <envar>PATHEXT</envar> environment variable. </description> @@ -9857,7 +12132,7 @@ stored in this location. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -9903,7 +12178,7 @@ including the terminating nul). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -9931,7 +12206,7 @@ Windows </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -9977,7 +12252,7 @@ including the terminating nul). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -10169,12 +12444,42 @@ opened, or %NULL if an error occurred </return> </function> +<function name="g_format_size"> +<description> +Formats a size (for example the size of a file) into a human readable +string. Sizes are rounded to the nearest size prefix (kB, MB, GB) +and are displayed rounded to the nearest tenth. E.g. the file size +3292528 bytes will be converted into the string "3.2 MB". + +The prefix units base is 1000 (i.e. 1 kB is 1000 bytes). + +This string should be freed with g_free() when not needed any longer. + +See g_format_size_full() for more options about how the size might be +formatted. + +Since: 2.30 + +</description> +<parameters> +<parameter name="size"> +<parameter_description> a size in bytes +</parameter_description> +</parameter> +</parameters> +<return> a newly-allocated formatted string containing a human readable +file size + +</return> +</function> + <function name="g_format_size_for_display"> <description> -Formats a size (for example the size of a file) into a human readable string. -Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed -rounded to the nearest tenth. E.g. the file size 3292528 bytes will be -converted into the string "3.1 MB". +Formats a size (for example the size of a file) into a human +readable string. Sizes are rounded to the nearest size prefix +(KB, MB, GB) and are displayed rounded to the nearest tenth. +E.g. the file size 3292528 bytes will be converted into the +string "3.1 MB". The prefix units base is 1024 (i.e. 1 KB is 1024 bytes). @@ -10182,15 +12487,44 @@ This string should be freed with g_free() when not needed any longer. Since: 2.16 +Deprecated:2.30: This function is broken due to its use of SI +suffixes to denote IEC units. Use g_format_size() instead. + </description> <parameters> <parameter name="size"> -<parameter_description> a size in bytes. +<parameter_description> a size in bytes </parameter_description> </parameter> </parameters> -<return> a newly-allocated formatted string containing a human readable -file size. +<return> a newly-allocated formatted string containing a human +readable file size + +</return> +</function> + +<function name="g_format_size_full"> +<description> +Formats a size. + +This function is similar to g_format_size() but allows for flags +that modify the output. See #GFormatSizeFlags. + +Since: 2.30 + +</description> +<parameters> +<parameter name="size"> +<parameter_description> a size in bytes +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> #GFormatSizeFlags to modify the output +</parameter_description> +</parameter> +</parameters> +<return> a newly-allocated formatted string containing a human +readable file size </return> </function> @@ -10263,7 +12597,7 @@ opened </parameter_description> </parameter> </parameters> -<return> A <type>FILE</type> pointer if the file was successfully +<return> A <literal>FILE</literal> pointer if the file was successfully opened, or %NULL if an error occurred. </return> @@ -10291,9 +12625,9 @@ Since: 2.2 <function name="g_get_charset"> <description> -Obtains the character set for the <link linkend="setlocale">current -locale</link>; you might use this character set as an argument to -g_convert(), to convert from the current locale's encoding to some +Obtains the character set for the <link linkend="setlocale">current +locale</link>; you might use this character set as an argument to +g_convert(), to convert from the current locale's encoding to some other encoding. (Frequently g_locale_to_utf8() and g_locale_from_utf8() are nice shortcuts, though.) @@ -10323,28 +12657,30 @@ freed. <function name="g_get_codeset"> <description> -Get the codeset for the current locale. +Gets the character set for the current locale. </description> <parameters> </parameters> <return> a newly allocated string containing the name -of the codeset. This string must be freed with g_free(). +of the character set. This string must be freed with g_free(). </return> </function> <function name="g_get_current_dir"> <description> Gets the current directory. -The returned string should be freed when no longer needed. The encoding -of the returned string is system defined. On Windows, it is always UTF-8. + +The returned string should be freed when no longer needed. +The encoding of the returned string is system defined. +On Windows, it is always UTF-8. </description> <parameters> </parameters> -<return> the current directory. +<return> the current directory </return> </function> @@ -10366,9 +12702,10 @@ You may find g_get_real_time() to be more convenient. <function name="g_get_environ"> <description> -Gets the list of environment variables for the current process. The -list is %NULL terminated and each item in the list is of the form -'NAME=VALUE'. +Gets the list of environment variables for the current process. + +The list is %NULL terminated and each item in the list is of the +form 'NAME=VALUE'. This is equivalent to direct access to the 'environ' global variable, except portable. @@ -10381,7 +12718,8 @@ Since: 2.28 </description> <parameters> </parameters> -<return> the list of environment variables +<return> the list of +environment variables </return> </function> @@ -10491,16 +12829,16 @@ Since: 2.8 <function name="g_get_language_names"> <description> -Computes a list of applicable locale names, which can be used to -e.g. construct locale-dependent filenames or search paths. The returned -list is sorted from most desirable to least desirable and always contains +Computes a list of applicable locale names, which can be used to +e.g. construct locale-dependent filenames or search paths. The returned +list is sorted from most desirable to least desirable and always contains the default locale "C". For example, if LANGUAGE=de:en_US, then the returned list is "de", "en_US", "en", "C". -This function consults the environment variables <envar>LANGUAGE</envar>, -<envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar> +This function consults the environment variables <envar>LANGUAGE</envar>, +<envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar> to find the list of locales specified by the user. Since: 2.6 @@ -10508,7 +12846,7 @@ Since: 2.6 </description> <parameters> </parameters> -<return> a %NULL-terminated array of strings owned by GLib +<return> a %NULL-terminated array of strings owned by GLib that must not be modified or freed. </return> @@ -10547,15 +12885,20 @@ g_strfreev(). <description> Queries the system monotonic time, if available. -On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call +On POSIX systems with clock_gettime() and <literal>CLOCK_MONOTONIC</literal> this call is a very shallow wrapper for that. Otherwise, we make a best effort that probably involves returning the wall clock time (with at least microsecond accuracy, subject to the limitations of the OS kernel). -Note that, on Windows, "limitations of the OS kernel" is a rather -substantial statement. Depending on the configuration of the system, -the wall clock time is updated as infrequently as 64 times a second -(which is approximately every 16ms). +It's important to note that POSIX <literal>CLOCK_MONOTONIC</literal> does +not count time spent while the machine is suspended. + +On Windows, "limitations of the OS kernel" is a rather substantial +statement. Depending on the configuration of the system, the wall +clock time is updated as infrequently as 64 times a second (which +is approximately every 16ms). Also, on XP (but not on Vista or later) +the monotonic clock is locally monotonic, but may differ in exact +value between processes due to timer wrap handling. Since: 2.28 @@ -10856,28 +13199,76 @@ GLib and should not be modified or freed. <function name="g_getenv"> <description> -Returns the value of an environment variable. The name and value -are in the GLib file name encoding. On UNIX, this means the actual -bytes which might or might not be in some consistent character set -and encoding. On Windows, it is in UTF-8. On Windows, in case the -environment variable's value contains references to other -environment variables, they are expanded. +Returns the value of an environment variable. + +The name and value are in the GLib file name encoding. On UNIX, +this means the actual bytes which might or might not be in some +consistent character set and encoding. On Windows, it is in UTF-8. +On Windows, in case the environment variable's value contains +references to other environment variables, they are expanded. </description> <parameters> <parameter name="variable"> -<parameter_description> the environment variable to get, in the GLib file name encoding. +<parameter_description> the environment variable to get, in the GLib file name +encoding </parameter_description> </parameter> </parameters> <return> the value of the environment variable, or %NULL if -the environment variable is not found. The returned string may be -overwritten by the next call to g_getenv(), g_setenv() or -g_unsetenv(). +the environment variable is not found. The returned string +may be overwritten by the next call to g_getenv(), g_setenv() +or g_unsetenv(). </return> </function> +<function name="g_hash_table_add"> +<description> +This is a convenience function for using a #GHashTable as a set. It +is equivalent to calling g_hash_table_replace() with @key as both the +key and the value. + +When a hash table only ever contains keys that have themselves as the +corresponding value it is able to be stored more efficiently. See +the discussion in the section description. + +Since: 2.32 + +</description> +<parameters> +<parameter name="hash_table"> +<parameter_description> a #GHashTable +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> a key to insert +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hash_table_contains"> +<description> +Checks if @key is in @hash_table. + +Since: 2.32 + +</description> +<parameters> +<parameter name="hash_table"> +<parameter_description> a #GHashTable +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> a key to check +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_hash_table_destroy"> <description> Destroys all keys and values in the #GHashTable and decrements its @@ -10890,7 +13281,7 @@ destruction phase. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> </parameters> @@ -10899,34 +13290,34 @@ destruction phase. <function name="g_hash_table_find"> <description> -Calls the given function for key/value pairs in the #GHashTable until -@predicate returns %TRUE. The function is passed the key and value of -each pair, and the given @user_data parameter. The hash table may not -be modified while iterating over it (you can't add/remove items). +Calls the given function for key/value pairs in the #GHashTable +until @predicate returns %TRUE. The function is passed the key +and value of each pair, and the given @user_data parameter. The +hash table may not be modified while iterating over it (you can't +add/remove items). -Note, that hash tables are really only optimized for forward lookups, -i.e. g_hash_table_lookup(). -So code that frequently issues g_hash_table_find() or -g_hash_table_foreach() (e.g. in the order of once per every entry in a -hash table) should probably be reworked to use additional or different -data structures for reverse lookups (keep in mind that an O(n) find/foreach -operation issued for all n values in a hash table ends up needing O(n*n) -operations). +Note, that hash tables are really only optimized for forward +lookups, i.e. g_hash_table_lookup(). So code that frequently issues +g_hash_table_find() or g_hash_table_foreach() (e.g. in the order of +once per every entry in a hash table) should probably be reworked +to use additional or different data structures for reverse lookups +(keep in mind that an O(n) find/foreach operation issued for all n +values in a hash table ends up needing O(n*n) operations). Since: 2.4 </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="predicate"> -<parameter_description> function to test the key/value pairs for a certain property. +<parameter_description> function to test the key/value pairs for a certain property </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data to pass to the function. +<parameter_description> user data to pass to the function </parameter_description> </parameter> </parameters> @@ -10952,15 +13343,15 @@ order searches in contrast to g_hash_table_lookup(). </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the function to call for each key/value pair. +<parameter_description> the function to call for each key/value pair </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data to pass to the function. +<parameter_description> user data to pass to the function </parameter_description> </parameter> </parameters> @@ -10969,40 +13360,41 @@ order searches in contrast to g_hash_table_lookup(). <function name="g_hash_table_foreach_remove"> <description> -Calls the given function for each key/value pair in the #GHashTable. -If the function returns %TRUE, then the key/value pair is removed from the -#GHashTable. If you supplied key or value destroy functions when creating -the #GHashTable, they are used to free the memory allocated for the removed -keys and values. +Calls the given function for each key/value pair in the +#GHashTable. If the function returns %TRUE, then the key/value +pair is removed from the #GHashTable. If you supplied key or +value destroy functions when creating the #GHashTable, they are +used to free the memory allocated for the removed keys and values. -See #GHashTableIter for an alternative way to loop over the +See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the function to call for each key/value pair. +<parameter_description> the function to call for each key/value pair </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data to pass to the function. +<parameter_description> user data to pass to the function </parameter_description> </parameter> </parameters> -<return> the number of key/value pairs removed. +<return> the number of key/value pairs removed </return> </function> <function name="g_hash_table_foreach_steal"> <description> -Calls the given function for each key/value pair in the #GHashTable. -If the function returns %TRUE, then the key/value pair is removed from the -#GHashTable, but no key or value destroy functions are called. +Calls the given function for each key/value pair in the +#GHashTable. If the function returns %TRUE, then the key/value +pair is removed from the #GHashTable, but no key or value +destroy functions are called. See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table. @@ -11011,15 +13403,15 @@ key/value pairs in the hash table. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the function to call for each key/value pair. +<parameter_description> the function to call for each key/value pair </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data to pass to the function. +<parameter_description> user data to pass to the function </parameter_description> </parameter> </parameters> @@ -11027,10 +13419,25 @@ key/value pairs in the hash table. </return> </function> +<function name="g_hash_table_freeze"> +<description> +This function is deprecated and will be removed in the next major +release of GLib. It does nothing. + +</description> +<parameters> +<parameter name="hash_table"> +<parameter_description> a #GHashTable +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_hash_table_get_keys"> <description> -Retrieves every key inside @hash_table. The returned data is valid -until @hash_table is modified. +Retrieves every key inside @hash_table. The returned data +is valid until @hash_table is modified. Since: 2.14 @@ -11051,8 +13458,8 @@ using the list. <function name="g_hash_table_get_values"> <description> -Retrieves every value inside @hash_table. The returned data is -valid until @hash_table is modified. +Retrieves every value inside @hash_table. The returned data +is valid until @hash_table is modified. Since: 2.14 @@ -11075,24 +13482,25 @@ using the list. <description> Inserts a new key and value into a #GHashTable. -If the key already exists in the #GHashTable its current value is replaced -with the new value. If you supplied a @value_destroy_func when creating the -#GHashTable, the old value is freed using that function. If you supplied -a @key_destroy_func when creating the #GHashTable, the passed key is freed -using that function. +If the key already exists in the #GHashTable its current +value is replaced with the new value. If you supplied a +@value_destroy_func when creating the #GHashTable, the old +value is freed using that function. If you supplied a +@key_destroy_func when creating the #GHashTable, the passed +key is freed using that function. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="key"> -<parameter_description> a key to insert. +<parameter_description> a key to insert </parameter_description> </parameter> <parameter name="value"> -<parameter_description> the value to associate with the key. +<parameter_description> the value to associate with the key </parameter_description> </parameter> </parameters> @@ -11108,7 +13516,7 @@ Since: 2.16 </description> <parameters> <parameter name="iter"> -<parameter_description> an initialized #GHashTableIter. +<parameter_description> an initialized #GHashTableIter </parameter_description> </parameter> </parameters> @@ -11127,7 +13535,7 @@ GHashTableIter iter; gpointer key, value; g_hash_table_iter_init (&iter, hash_table); -while (g_hash_table_iter_next (&iter, &key, &value)) +while (g_hash_table_iter_next (&iter, &key, &value)) { / * do something with key and value * / } @@ -11138,11 +13546,11 @@ Since: 2.16 </description> <parameters> <parameter name="iter"> -<parameter_description> an uninitialized #GHashTableIter. +<parameter_description> an uninitialized #GHashTableIter </parameter_description> </parameter> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> </parameters> @@ -11160,15 +13568,15 @@ Since: 2.16 </description> <parameters> <parameter name="iter"> -<parameter_description> an initialized #GHashTableIter. +<parameter_description> an initialized #GHashTableIter </parameter_description> </parameter> <parameter name="key"> -<parameter_description> a location to store the key, or %NULL. +<parameter_description> a location to store the key, or %NULL </parameter_description> </parameter> <parameter name="value"> -<parameter_description> a location to store the value, or %NULL. +<parameter_description> a location to store the value, or %NULL </parameter_description> </parameter> </parameters> @@ -11181,20 +13589,45 @@ Since: 2.16 <description> Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable. Can only be called after -g_hash_table_iter_next() returned %TRUE, and cannot be called more -than once for the same key/value pair. +g_hash_table_iter_next() returned %TRUE, and cannot be called +more than once for the same key/value pair. -If the #GHashTable was created using g_hash_table_new_full(), the -key and value are freed using the supplied destroy functions, otherwise -you have to make sure that any dynamically allocated values are freed -yourself. +If the #GHashTable was created using g_hash_table_new_full(), +the key and value are freed using the supplied destroy functions, +otherwise you have to make sure that any dynamically allocated +values are freed yourself. Since: 2.16 </description> <parameters> <parameter name="iter"> -<parameter_description> an initialized #GHashTableIter. +<parameter_description> an initialized #GHashTableIter +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hash_table_iter_replace"> +<description> +Replaces the value currently pointed to by the iterator +from its associated #GHashTable. Can only be called after +g_hash_table_iter_next() returned %TRUE. + +If you supplied a @value_destroy_func when creating the +#GHashTable, the old value is freed using that function. + +Since: 2.30 + +</description> +<parameters> +<parameter name="iter"> +<parameter_description> an initialized #GHashTableIter +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the value to replace with </parameter_description> </parameter> </parameters> @@ -11203,18 +13636,18 @@ Since: 2.16 <function name="g_hash_table_iter_steal"> <description> -Removes the key/value pair currently pointed to by the iterator -from its associated #GHashTable, without calling the key and value -destroy functions. Can only be called after -g_hash_table_iter_next() returned %TRUE, and cannot be called more -than once for the same key/value pair. +Removes the key/value pair currently pointed to by the +iterator from its associated #GHashTable, without calling +the key and value destroy functions. Can only be called +after g_hash_table_iter_next() returned %TRUE, and cannot +be called more than once for the same key/value pair. Since: 2.16 </description> <parameters> <parameter name="iter"> -<parameter_description> an initialized #GHashTableIter. +<parameter_description> an initialized #GHashTableIter </parameter_description> </parameter> </parameters> @@ -11232,15 +13665,15 @@ g_hash_table_lookup_extended(). </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="key"> -<parameter_description> the key to look up. +<parameter_description> the key to look up </parameter_description> </parameter> </parameters> -<return> the associated value, or %NULL if the key is not found. +<return> the associated value, or %NULL if the key is not found </return> </function> @@ -11275,7 +13708,7 @@ of @hash_table are %NULL-safe. </parameter_description> </parameter> </parameters> -<return> %TRUE if the key was found in the #GHashTable. +<return> %TRUE if the key was found in the #GHashTable </return> </function> @@ -11283,63 +13716,67 @@ of @hash_table are %NULL-safe. <description> Creates a new #GHashTable with a reference count of 1. +Hash values returned by @hash_func are used to determine where keys +are stored within the #GHashTable data structure. The g_direct_hash(), +g_int_hash(), g_int64_hash(), g_double_hash() and g_str_hash() +functions are provided for some common types of keys. +If @hash_func is %NULL, g_direct_hash() is used. + +@key_equal_func is used when looking up keys in the #GHashTable. +The g_direct_equal(), g_int_equal(), g_int64_equal(), g_double_equal() +and g_str_equal() functions are provided for the most common types +of keys. If @key_equal_func is %NULL, keys are compared directly in +a similar fashion to g_direct_equal(), but without the overhead of +a function call. + </description> <parameters> <parameter name="hash_func"> -<parameter_description> a function to create a hash value from a key. -Hash values are used to determine where keys are stored within the -#GHashTable data structure. The g_direct_hash(), g_int_hash(), -g_int64_hash(), g_double_hash() and g_str_hash() functions are provided -for some common types of keys. -If hash_func is %NULL, g_direct_hash() is used. +<parameter_description> a function to create a hash value from a key </parameter_description> </parameter> <parameter name="key_equal_func"> -<parameter_description> a function to check two keys for equality. This is -used when looking up keys in the #GHashTable. The g_direct_equal(), -g_int_equal(), g_int64_equal(), g_double_equal() and g_str_equal() -functions are provided for the most common types of keys. -If @key_equal_func is %NULL, keys are compared directly in a similar -fashion to g_direct_equal(), but without the overhead of a function call. +<parameter_description> a function to check two keys for equality </parameter_description> </parameter> </parameters> -<return> a new #GHashTable. +<return> a new #GHashTable </return> </function> <function name="g_hash_table_new_full"> <description> -Creates a new #GHashTable like g_hash_table_new() with a reference count -of 1 and allows to specify functions to free the memory allocated for the -key and value that get called when removing the entry from the #GHashTable. +Creates a new #GHashTable like g_hash_table_new() with a reference +count of 1 and allows to specify functions to free the memory +allocated for the key and value that get called when removing the +entry from the #GHashTable. </description> <parameters> <parameter name="hash_func"> -<parameter_description> a function to create a hash value from a key. +<parameter_description> a function to create a hash value from a key </parameter_description> </parameter> <parameter name="key_equal_func"> -<parameter_description> a function to check two keys for equality. +<parameter_description> a function to check two keys for equality </parameter_description> </parameter> <parameter name="key_destroy_func"> <parameter_description> a function to free the memory allocated for the key -used when removing the entry from the #GHashTable or %NULL if you -don't want to supply such a function. +used when removing the entry from the #GHashTable, or %NULL +if you don't want to supply such a function. </parameter_description> </parameter> <parameter name="value_destroy_func"> <parameter_description> a function to free the memory allocated for the -value used when removing the entry from the #GHashTable or %NULL if -you don't want to supply such a function. +value used when removing the entry from the #GHashTable, or %NULL +if you don't want to supply such a function. </parameter_description> </parameter> </parameters> -<return> a new #GHashTable. +<return> a new #GHashTable </return> </function> @@ -11353,11 +13790,11 @@ Since: 2.10 </description> <parameters> <parameter name="hash_table"> -<parameter_description> a valid #GHashTable. +<parameter_description> a valid #GHashTable </parameter_description> </parameter> </parameters> -<return> the passed in #GHashTable. +<return> the passed in #GHashTable </return> </function> @@ -11375,15 +13812,15 @@ yourself. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="key"> -<parameter_description> the key to remove. +<parameter_description> the key to remove </parameter_description> </parameter> </parameters> -<return> %TRUE if the key was found and removed from the #GHashTable. +<return> %TRUE if the key was found and removed from the #GHashTable </return> </function> @@ -11391,10 +13828,10 @@ yourself. <description> Removes all keys and their associated values from a #GHashTable. -If the #GHashTable was created using g_hash_table_new_full(), the keys -and values are freed using the supplied destroy functions, otherwise you -have to make sure that any dynamically allocated values are freed -yourself. +If the #GHashTable was created using g_hash_table_new_full(), +the keys and values are freed using the supplied destroy functions, +otherwise you have to make sure that any dynamically allocated +values are freed yourself. Since: 2.12 @@ -11411,24 +13848,25 @@ Since: 2.12 <function name="g_hash_table_replace"> <description> Inserts a new key and value into a #GHashTable similar to -g_hash_table_insert(). The difference is that if the key already exists -in the #GHashTable, it gets replaced by the new key. If you supplied a -@value_destroy_func when creating the #GHashTable, the old value is freed -using that function. If you supplied a @key_destroy_func when creating the +g_hash_table_insert(). The difference is that if the key +already exists in the #GHashTable, it gets replaced by the +new key. If you supplied a @value_destroy_func when creating +the #GHashTable, the old value is freed using that function. +If you supplied a @key_destroy_func when creating the #GHashTable, the old key is freed using that function. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="key"> -<parameter_description> a key to insert. +<parameter_description> a key to insert </parameter_description> </parameter> <parameter name="value"> -<parameter_description> the value to associate with the key. +<parameter_description> the value to associate with the key </parameter_description> </parameter> </parameters> @@ -11443,7 +13881,7 @@ Returns the number of elements contained in the #GHashTable. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> </parameters> @@ -11460,15 +13898,15 @@ calling the key and value destroy functions. </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable </parameter_description> </parameter> <parameter name="key"> -<parameter_description> the key to remove. +<parameter_description> the key to remove </parameter_description> </parameter> </parameters> -<return> %TRUE if the key was found and removed from the #GHashTable. +<return> %TRUE if the key was found and removed from the #GHashTable </return> </function> @@ -11482,7 +13920,22 @@ Since: 2.12 </description> <parameters> <parameter name="hash_table"> -<parameter_description> a #GHashTable. +<parameter_description> a #GHashTable +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hash_table_thaw"> +<description> +This function is deprecated and will be removed in the next major +release of GLib. It does nothing. + +</description> +<parameters> +<parameter name="hash_table"> +<parameter_description> a #GHashTable </parameter_description> </parameter> </parameters> @@ -11501,7 +13954,723 @@ Since: 2.10 </description> <parameters> <parameter name="hash_table"> -<parameter_description> a valid #GHashTable. +<parameter_description> a valid #GHashTable +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hmac_copy"> +<description> +Copies a #GHmac. If @hmac has been closed, by calling +g_hmac_get_string() or g_hmac_get_digest(), the copied +HMAC will be closed as well. + +Since: 2.30 + +</description> +<parameters> +<parameter name="hmac"> +<parameter_description> the #GHmac to copy +</parameter_description> +</parameter> +</parameters> +<return> the copy of the passed #GHmac. Use g_hmac_unref() +when finished using it. + +</return> +</function> + +<function name="g_hmac_get_digest"> +<description> +Gets the digest from @checksum as a raw binary array and places it +into @buffer. The size of the digest depends on the type of checksum. + +Once this function has been called, the #GHmac is closed and can +no longer be updated with g_checksum_update(). + +Since: 2.30 + +</description> +<parameters> +<parameter name="hmac"> +<parameter_description> a #GHmac +</parameter_description> +</parameter> +<parameter name="buffer"> +<parameter_description> output buffer +</parameter_description> +</parameter> +<parameter name="digest_len"> +<parameter_description> an inout parameter. The caller initializes it to the +size of @buffer. After the call it contains the length of the digest +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hmac_get_string"> +<description> +Gets the HMAC as an hexadecimal string. + +Once this function has been called the #GHmac can no longer be +updated with g_hmac_update(). + +The hexadecimal characters will be lower case. + +Since: 2.30 + +</description> +<parameters> +<parameter name="hmac"> +<parameter_description> a #GHmac +</parameter_description> +</parameter> +</parameters> +<return> the hexadecimal representation of the HMAC. The +returned string is owned by the HMAC and should not be modified +or freed. + +</return> +</function> + +<function name="g_hmac_new"> +<description> +Creates a new #GHmac, using the digest algorithm @digest_type. +If the @digest_type is not known, %NULL is returned. +A #GHmac can be used to compute the HMAC of a key and an +arbitrary binary blob, using different hashing algorithms. + +A #GHmac works by feeding a binary blob through g_hmac_update() +until the data is complete; the digest can then be extracted +using g_hmac_get_string(), which will return the checksum as a +hexadecimal string; or g_hmac_get_digest(), which will return a +array of raw bytes. Once either g_hmac_get_string() or +g_hmac_get_digest() have been called on a #GHmac, the HMAC +will be closed and it won't be possible to call g_hmac_update() +on it anymore. + +Since: 2.30 + +</description> +<parameters> +<parameter name="digest_type"> +<parameter_description> the desired type of digest +</parameter_description> +</parameter> +<parameter name="key"> +<parameter_description> the key for the HMAC +</parameter_description> +</parameter> +<parameter name="key_len"> +<parameter_description> the length of the keys +</parameter_description> +</parameter> +</parameters> +<return> the newly created #GHmac, or %NULL. +Use g_hmac_unref() to free the memory allocated by it. + +</return> +</function> + +<function name="g_hmac_ref"> +<description> +Atomically increments the reference count of @hmac by one. + +This function is MT-safe and may be called from any thread. + +Since: 2.30 + +</description> +<parameters> +<parameter name="hmac"> +<parameter_description> a valid #GHmac +</parameter_description> +</parameter> +</parameters> +<return> the passed in #GHmac. + +</return> +</function> + +<function name="g_hmac_unref"> +<description> +Atomically decrements the reference count of @hmac by one. + +If the reference count drops to 0, all keys and values will be +destroyed, and all memory allocated by the hash table is released. +This function is MT-safe and may be called from any thread. +Frees the memory allocated for @hmac. + +Since: 2.30 + +</description> +<parameters> +<parameter name="hmac"> +<parameter_description> a #GHmac +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hmac_update"> +<description> +Feeds @data into an existing #GHmac. + +The HMAC must still be open, that is g_hmac_get_string() or +g_hmac_get_digest() must not have been called on @hmac. + +Since: 2.30 + +</description> +<parameters> +<parameter name="hmac"> +<parameter_description> a #GHmac +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> buffer used to compute the checksum +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> size of the buffer, or -1 if it is a nul-terminated string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_alloc"> +<description> +Allocates space for a #GHook and initializes it. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +</parameters> +<return> a new #GHook +</return> +</function> + +<function name="g_hook_append"> +<description> +Appends a #GHook onto the end of a #GHookList. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to add to the end of @hook_list +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_compare_ids"> +<description> +Compares the ids of two #GHook elements, returning a negative value +if the second id is greater than the first. + + +</description> +<parameters> +<parameter name="new_hook"> +<parameter_description> a #GHook +</parameter_description> +</parameter> +<parameter name="sibling"> +<parameter_description> a #GHook to compare with @new_hook +</parameter_description> +</parameter> +</parameters> +<return> a value <= 0 if the id of @sibling is >= the id of @new_hook +</return> +</function> + +<function name="g_hook_destroy"> +<description> +Destroys a #GHook, given its ID. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook_id"> +<parameter_description> a hook ID +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the #GHook was found in the #GHookList and destroyed +</return> +</function> + +<function name="g_hook_destroy_link"> +<description> +Removes one #GHook from a #GHookList, marking it +inactive and calling g_hook_unref() on it. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to remove +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_find"> +<description> +Finds a #GHook in a #GHookList using the given function to +test for a match. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="need_valids"> +<parameter_description> %TRUE if #GHook elements which have been destroyed +should be skipped +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> the function to call for each #GHook, which should return +%TRUE when the #GHook has been found +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> the data to pass to @func +</parameter_description> +</parameter> +</parameters> +<return> the found #GHook or %NULL if no matching #GHook is found +</return> +</function> + +<function name="g_hook_find_data"> +<description> +Finds a #GHook in a #GHookList with the given data. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="need_valids"> +<parameter_description> %TRUE if #GHook elements which have been destroyed +should be skipped +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> the data to find +</parameter_description> +</parameter> +</parameters> +<return> the #GHook with the given @data or %NULL if no matching +#GHook is found +</return> +</function> + +<function name="g_hook_find_func"> +<description> +Finds a #GHook in a #GHookList with the given function. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="need_valids"> +<parameter_description> %TRUE if #GHook elements which have been destroyed +should be skipped +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> the function to find +</parameter_description> +</parameter> +</parameters> +<return> the #GHook with the given @func or %NULL if no matching +#GHook is found +</return> +</function> + +<function name="g_hook_find_func_data"> +<description> +Finds a #GHook in a #GHookList with the given function and data. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="need_valids"> +<parameter_description> %TRUE if #GHook elements which have been destroyed +should be skipped +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> the function to find +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> the data to find +</parameter_description> +</parameter> +</parameters> +<return> the #GHook with the given @func and @data or %NULL if +no matching #GHook is found +</return> +</function> + +<function name="g_hook_first_valid"> +<description> +Returns the first #GHook in a #GHookList which has not been destroyed. +The reference count for the #GHook is incremented, so you must call +g_hook_unref() to restore it when no longer needed. (Or call +g_hook_next_valid() if you are stepping through the #GHookList.) + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="may_be_in_call"> +<parameter_description> %TRUE if hooks which are currently running +(e.g. in another thread) are considered valid. If set to %FALSE, +these are skipped +</parameter_description> +</parameter> +</parameters> +<return> the first valid #GHook, or %NULL if none are valid +</return> +</function> + +<function name="g_hook_free"> +<description> +Calls the #GHookList @finalize_hook function if it exists, +and frees the memory allocated for the #GHook. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to free +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_get"> +<description> +Returns the #GHook with the given id, or %NULL if it is not found. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook_id"> +<parameter_description> a hook id +</parameter_description> +</parameter> +</parameters> +<return> the #GHook with the given id, or %NULL if it is not found +</return> +</function> + +<function name="g_hook_insert_before"> +<description> +Inserts a #GHook into a #GHookList, before a given #GHook. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="sibling"> +<parameter_description> the #GHook to insert the new #GHook before +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to insert +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_insert_sorted"> +<description> +Inserts a #GHook into a #GHookList, sorted by the given function. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to insert +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> the comparison function used to sort the #GHook elements +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_list_clear"> +<description> +Removes all the #GHook elements from a #GHookList. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_list_init"> +<description> +Initializes a #GHookList. +This must be called before the #GHookList is used. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook_size"> +<parameter_description> the size of each element in the #GHookList, +typically <literal>sizeof (GHook)</literal> +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_list_invoke"> +<description> +Calls all of the #GHook functions in a #GHookList. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="may_recurse"> +<parameter_description> %TRUE if functions which are already running +(e.g. in another thread) can be called. If set to %FALSE, +these are skipped +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_list_invoke_check"> +<description> +Calls all of the #GHook functions in a #GHookList. +Any function which returns %FALSE is removed from the #GHookList. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="may_recurse"> +<parameter_description> %TRUE if functions which are already running +(e.g. in another thread) can be called. If set to %FALSE, +these are skipped +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_list_marshal"> +<description> +Calls a function on each valid #GHook. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="may_recurse"> +<parameter_description> %TRUE if hooks which are currently running +(e.g. in another thread) are considered valid. If set to %FALSE, +these are skipped +</parameter_description> +</parameter> +<parameter name="marshaller"> +<parameter_description> the function to call for each #GHook +</parameter_description> +</parameter> +<parameter name="marshal_data"> +<parameter_description> data to pass to @marshaller +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_list_marshal_check"> +<description> +Calls a function on each valid #GHook and destroys it if the +function returns %FALSE. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="may_recurse"> +<parameter_description> %TRUE if hooks which are currently running +(e.g. in another thread) are considered valid. If set to %FALSE, +these are skipped +</parameter_description> +</parameter> +<parameter name="marshaller"> +<parameter_description> the function to call for each #GHook +</parameter_description> +</parameter> +<parameter name="marshal_data"> +<parameter_description> data to pass to @marshaller +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_next_valid"> +<description> +Returns the next #GHook in a #GHookList which has not been destroyed. +The reference count for the #GHook is incremented, so you must call +g_hook_unref() to restore it when no longer needed. (Or continue to call +g_hook_next_valid() until %NULL is returned.) + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the current #GHook +</parameter_description> +</parameter> +<parameter name="may_be_in_call"> +<parameter_description> %TRUE if hooks which are currently running +(e.g. in another thread) are considered valid. If set to %FALSE, +these are skipped +</parameter_description> +</parameter> +</parameters> +<return> the next valid #GHook, or %NULL if none are valid +</return> +</function> + +<function name="g_hook_prepend"> +<description> +Prepends a #GHook on the start of a #GHookList. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to add to the start of @hook_list +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_hook_ref"> +<description> +Increments the reference count for a #GHook. + + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to increment the reference count of +</parameter_description> +</parameter> +</parameters> +<return> the @hook that was passed in (since 2.6) +</return> +</function> + +<function name="g_hook_unref"> +<description> +Decrements the reference count of a #GHook. +If the reference count falls to 0, the #GHook is removed +from the #GHookList and g_hook_free() is called to free it. + +</description> +<parameters> +<parameter name="hook_list"> +<parameter_description> a #GHookList +</parameter_description> +</parameter> +<parameter name="hook"> +<parameter_description> the #GHook to unref </parameter_description> </parameter> </parameters> @@ -11623,6 +14792,38 @@ Since: 2.22 </return> </function> +<function name="g_htonl"> +<description> +Converts a 32-bit integer value from host to network byte order. + + +</description> +<parameters> +<parameter name="val"> +<parameter_description> a 32-bit integer value in host byte order +</parameter_description> +</parameter> +</parameters> +<return> @val converted to network byte order +</return> +</function> + +<function name="g_htons"> +<description> +Converts a 16-bit integer value from host to network byte order. + + +</description> +<parameters> +<parameter name="val"> +<parameter_description> a 16-bit integer value in host byte order +</parameter_description> +</parameter> +</parameters> +<return> @val converted to network byte order +</return> +</function> + <function name="g_iconv"> <description> Same as the standard UNIX routine iconv(), but @@ -11808,21 +15009,22 @@ have a default priority of %G_PRIORITY_DEFAULT. <function name="g_int64_equal"> <description> -Compares the two #gint64 values being pointed to and returns +Compares the two #gint64 values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func -parameter, when using pointers to 64-bit integers as keys in a #GHashTable. +parameter, when using non-%NULL pointers to 64-bit integers as keys in a +#GHashTable. Since: 2.22 </description> <parameters> <parameter name="v1"> -<parameter_description> a pointer to a #gint64 key. +<parameter_description> a pointer to a #gint64 key </parameter_description> </parameter> <parameter name="v2"> -<parameter_description> a pointer to a #gint64 key to compare with @v1. +<parameter_description> a pointer to a #gint64 key to compare with @v1 </parameter_description> </parameter> </parameters> @@ -11834,8 +15036,10 @@ Since: 2.22 <function name="g_int64_hash"> <description> Converts a pointer to a #gint64 to a hash value. -It can be passed to g_hash_table_new() as the @hash_func parameter, -when using pointers to 64-bit integers values as keys in a #GHashTable. + +It can be passed to g_hash_table_new() as the @hash_func parameter, +when using non-%NULL pointers to 64-bit integer values as keys in a +#GHashTable. Since: 2.22 @@ -11853,20 +15057,25 @@ Since: 2.22 <function name="g_int_equal"> <description> -Compares the two #gint values being pointed to and returns +Compares the two #gint values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func -parameter, when using pointers to integers as keys in a #GHashTable. +parameter, when using non-%NULL pointers to integers as keys in a +#GHashTable. + +Note that this function acts on pointers to #gint, not on #gint directly: +if your hash table's keys are of the form +<literal>GINT_TO_POINTER (n)</literal>, use g_direct_equal() instead. </description> <parameters> <parameter name="v1"> -<parameter_description> a pointer to a #gint key. +<parameter_description> a pointer to a #gint key </parameter_description> </parameter> <parameter name="v2"> -<parameter_description> a pointer to a #gint key to compare with @v1. +<parameter_description> a pointer to a #gint key to compare with @v1 </parameter_description> </parameter> </parameters> @@ -11877,8 +15086,12 @@ parameter, when using pointers to integers as keys in a #GHashTable. <function name="g_int_hash"> <description> Converts a pointer to a #gint to a hash value. -It can be passed to g_hash_table_new() as the @hash_func parameter, -when using pointers to integers values as keys in a #GHashTable. +It can be passed to g_hash_table_new() as the @hash_func parameter, +when using non-%NULL pointers to integer values as keys in a #GHashTable. + +Note that this function acts on pointers to #gint, not on #gint directly: +if your hash table's keys are of the form +<literal>GINT_TO_POINTER (n)</literal>, use g_direct_hash() instead. </description> @@ -12028,7 +15241,7 @@ Converts an <literal>errno</literal> error number to a #GIOChannelEr </description> <parameters> <parameter name="en"> -<parameter_description> an <literal>errno</literal> error number, e.g. %EINVAL +<parameter_description> an <literal>errno</literal> error number, e.g. <literal>EINVAL</literal> </parameter_description> </parameter> </parameters> @@ -12163,7 +15376,7 @@ owned by GLib and must not be freed. Gets the current flags for a #GIOChannel, including read-only flags such as %G_IO_FLAG_IS_READABLE. -The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITEABLE +The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITABLE are cached for internal use by the channel when it is created. If they should change at some later point (e.g. partial shutdown of a socket with the UNIX shutdown() function), the user @@ -12672,7 +15885,7 @@ calling one of the API "read" functions. <function name="g_io_channel_set_flags"> <description> -Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK). +Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK). </description> @@ -13021,7 +16234,9 @@ implementation and unavoidable. <function name="g_key_file_free"> <description> -Frees a #GKeyFile. +Clears all keys and groups from @key_file, and decreases the +reference count by 1. If the reference count reaches zero, +frees the key file and all its allocated memory. Since: 2.6 @@ -13107,8 +16322,10 @@ Since: 2.6 </parameter_description> </parameter> </parameters> -<return> the values associated with the key as a list of -booleans, or %NULL if the key was not found or could not be parsed. +<return> +the values associated with the key as a list of booleans, or %NULL if the +key was not found or could not be parsed. The returned list of booleans +should be freed with g_free() when no longer needed. </return> </function> @@ -13218,8 +16435,10 @@ Since: 2.12 </parameter_description> </parameter> </parameters> -<return> the values associated with the key as a list of -doubles, or %NULL if the key was not found or could not be parsed. +<return> +the values associated with the key as a list of doubles, or %NULL if the +key was not found or could not be parsed. The returned list of doubles +should be freed with g_free() when no longer needed. </return> </function> @@ -13243,7 +16462,7 @@ Since: 2.6 </parameter_description> </parameter> </parameters> -<return> a newly-allocated %NULL-terminated array of strings. +<return> a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. </return> </function> @@ -13353,8 +16572,10 @@ Since: 2.6 </parameter_description> </parameter> </parameters> -<return> the values associated with the key as a list of -integers, or %NULL if the key was not found or could not be parsed. +<return> +the values associated with the key as a list of integers, or %NULL if +the key was not found or could not be parsed. The returned list of +integers should be freed with g_free() when no longer needed. </return> </function> @@ -13388,7 +16609,7 @@ Since: 2.6 </parameter_description> </parameter> </parameters> -<return> a newly-allocated %NULL-terminated array of strings. +<return> a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. </return> @@ -13685,8 +16906,8 @@ the return value both carries meaning and signals an error. To use this function, you must pass a #GError pointer in @error, and check whether it is not %NULL to see if an error occurred.</note> -See g_key_file_has_key_full() for a replacement function which does -follow the #GError rules. +Language bindings should use g_key_file_get_value() to test whether +or not a key exists. Since: 2.6 @@ -13715,43 +16936,6 @@ otherwise. </return> </function> -<function name="g_key_file_has_key_full"> -<description> -Looks whether the key file has the key @key in the group -@group_name. - -Since: 2.30 - - -</description> -<parameters> -<parameter name="key_file"> -<parameter_description> a #GKeyFile -</parameter_description> -</parameter> -<parameter name="group_name"> -<parameter_description> a group name -</parameter_description> -</parameter> -<parameter name="key"> -<parameter_description> a key name -</parameter_description> -</parameter> -<parameter name="has_key"> -<parameter_description> Return location for whether or not key exists -</parameter_description> -</parameter> -<parameter name="error"> -<parameter_description> return location for a #GError -</parameter_description> -</parameter> -</parameters> -<return> %TRUE if a group with the name @group_name -exists. Otherwise, @error is set and %FALSE is returned. - -</return> -</function> - <function name="g_key_file_load_from_data"> <description> Loads a key file from memory into an empty #GKeyFile structure. @@ -13917,6 +17101,24 @@ Since: 2.6 </return> </function> +<function name="g_key_file_ref"> +<description> +Increases the reference count of @key_file. + +Since: 2.32 + +</description> +<parameters> +<parameter name="key_file"> +<parameter_description> a #GKeyFile +</parameter_description> +</parameter> +</parameters> +<return> the same @key_file. + +</return> +</function> + <function name="g_key_file_remove_comment"> <description> Removes a comment above @key from @group_name. @@ -14497,7 +17699,7 @@ Since: 2.6 </parameter_description> </parameter> <parameter name="length"> -<parameter_description> return location for the length of the +<parameter_description> return location for the length of the returned string, or %NULL </parameter_description> </parameter> @@ -14512,6 +17714,23 @@ the contents of the #GKeyFile </return> </function> +<function name="g_key_file_unref"> +<description> +Decreases the reference count of @key_file by 1. If the reference count +reaches zero, frees the key file and all its allocated memory. + +Since: 2.32 + +</description> +<parameters> +<parameter name="key_file"> +<parameter_description> a #GKeyFile +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_list_alloc"> <description> Allocates space for one #GList element. It is called by @@ -15043,24 +18262,6 @@ off the end of the #GList </return> </function> -<function name="g_list_pop_allocator"> -<description> -Restores the previous #GAllocator, used when allocating #GList -elements. - -Note that this function is not available if GLib has been compiled -with <option>--disable-mem-pools</option> - -Deprecated:2.10: It does nothing, since #GList has been converted -to the <link linkend="glib-Memory-Slices">slice -allocator</link> - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_list_position"> <description> Gets the position of the given element @@ -15131,28 +18332,6 @@ elements. </return> </function> -<function name="g_list_push_allocator"> -<description> -Sets the allocator to use to allocate #GList elements. Use -g_list_pop_allocator() to restore the previous allocator. - -Note that this function is not available if GLib has been compiled -with <option>--disable-mem-pools</option> - -Deprecated:2.10: It does nothing, since #GList has been converted -to the <link linkend="glib-Memory-Slices">slice -allocator</link> - -</description> -<parameters> -<parameter name="allocator"> -<parameter_description> the #GAllocator to use when allocating #GList elements. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_list_remove"> <description> Removes an element from a #GList. @@ -15239,7 +18418,8 @@ It simply switches the next and prev pointers of each element. <function name="g_list_sort"> <description> -Sorts a #GList using the given comparison function. +Sorts a #GList using the given comparison function. The algorithm +used is a stable sort. </description> @@ -15290,14 +18470,6 @@ a user data argument. <description> Gets the names of all variables set in the environment. -Since: 2.8 - -</description> -<parameters> -</parameters> -<return> a %NULL-terminated list of strings which must be freed -with g_strfreev(). - Programs that want to be portable to Windows should typically use this function and g_getenv() instead of using the environ array from the C library directly. On Windows, the strings in the environ @@ -15305,6 +18477,14 @@ array are in system codepage encoding, while in most of the typical use cases for environment variables in GLib-using programs you want the UTF-8 encoding that this function and g_getenv() provide. +Since: 2.8 + +</description> +<parameters> +</parameters> +<return> a %NULL-terminated +list of strings which must be freed with g_strfreev(). + </return> </function> @@ -15344,7 +18524,7 @@ including the terminating nul). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -15390,7 +18570,7 @@ including the terminating nul). </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError may occur. </parameter_description> </parameter> @@ -15399,6 +18579,273 @@ errors. Any of the errors in #GConvertError may occur. </return> </function> +<function name="g_log"> +<description> +Logs an error or debugging message. + +If the log level has been set as fatal, the abort() +function is called to terminate the program. + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> the log domain, usually #G_LOG_DOMAIN +</parameter_description> +</parameter> +<parameter name="log_level"> +<parameter_description> the log level, either from #GLogLevelFlags +or a user-defined level +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> the message format. See the printf() documentation +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> the parameters to insert into the format string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_log_default_handler"> +<description> +The default log handler set up by GLib; g_log_set_default_handler() +allows to install an alternate default log handler. +This is used if no log handler has been set for the particular log +domain and log level combination. It outputs the message to stderr +or stdout and if the log level is fatal it calls abort(). + +The behavior of this log handler can be influenced by a number of +environment variables: +<variablelist> +<varlistentry> +<term><envar>G_MESSAGES_PREFIXED</envar></term> +<listitem> +A :-separated list of log levels for which messages should +be prefixed by the program name and PID of the aplication. +</listitem> +</varlistentry> +<varlistentry> +<term><envar>G_MESSAGES_DEBUG</envar></term> +<listitem> +A space-separated list of log domains for which debug and +informational messages are printed. By default these +messages are not printed. +</listitem> +</varlistentry> +</variablelist> + +stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL, +%G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for +the rest. + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> the log domain of the message +</parameter_description> +</parameter> +<parameter name="log_level"> +<parameter_description> the level of the message +</parameter_description> +</parameter> +<parameter name="message"> +<parameter_description> the message +</parameter_description> +</parameter> +<parameter name="unused_data"> +<parameter_description> data passed from g_log() which is unused +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_log_remove_handler"> +<description> +Removes the log handler. + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> the log domain +</parameter_description> +</parameter> +<parameter name="handler_id"> +<parameter_description> the id of the handler, which was returned +in g_log_set_handler() +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_log_set_always_fatal"> +<description> +Sets the message levels which are always fatal, in any log domain. +When a message with any of these levels is logged the program terminates. +You can only set the levels defined by GLib to be fatal. +%G_LOG_LEVEL_ERROR is always fatal. + +You can also make some message levels fatal at runtime by setting +the <envar>G_DEBUG</envar> environment variable (see +<ulink url="glib-running.html">Running GLib Applications</ulink>). + + +</description> +<parameters> +<parameter name="fatal_mask"> +<parameter_description> the mask containing bits set for each level +of error which is to be fatal +</parameter_description> +</parameter> +</parameters> +<return> the old fatal mask +</return> +</function> + +<function name="g_log_set_default_handler"> +<description> +Installs a default log handler which is used if no +log handler has been set for the particular log domain +and log level combination. By default, GLib uses +g_log_default_handler() as default log handler. + +Since: 2.6 + +</description> +<parameters> +<parameter name="log_func"> +<parameter_description> the log handler function +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data passed to the log handler +</parameter_description> +</parameter> +</parameters> +<return> the previous default log handler + +</return> +</function> + +<function name="g_log_set_fatal_mask"> +<description> +Sets the log levels which are fatal in the given domain. +%G_LOG_LEVEL_ERROR is always fatal. + + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> the log domain +</parameter_description> +</parameter> +<parameter name="fatal_mask"> +<parameter_description> the new fatal mask +</parameter_description> +</parameter> +</parameters> +<return> the old fatal mask for the log domain +</return> +</function> + +<function name="g_log_set_handler"> +<description> +Sets the log handler for a domain and a set of log levels. +To handle fatal and recursive messages the @log_levels parameter +must be combined with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION +bit flags. + +Note that since the #G_LOG_LEVEL_ERROR log level is always fatal, if +you want to set a handler for this log level you must combine it with +#G_LOG_FLAG_FATAL. + +<example> +<title>Adding a log handler for all warning messages in the default +(application) domain</title> +<programlisting> +g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL +| G_LOG_FLAG_RECURSION, my_log_handler, NULL); +</programlisting> +</example> + +<example> +<title>Adding a log handler for all critical messages from GTK+</title> +<programlisting> +g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL +| G_LOG_FLAG_RECURSION, my_log_handler, NULL); +</programlisting> +</example> + +<example> +<title>Adding a log handler for <emphasis>all</emphasis> messages from +GLib</title> +<programlisting> +g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL +| G_LOG_FLAG_RECURSION, my_log_handler, NULL); +</programlisting> +</example> + + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> the log domain, or %NULL for the default "" +application domain +</parameter_description> +</parameter> +<parameter name="log_levels"> +<parameter_description> the log levels to apply the log handler for. +To handle fatal and recursive messages as well, combine +the log levels with the #G_LOG_FLAG_FATAL and +#G_LOG_FLAG_RECURSION bit flags. +</parameter_description> +</parameter> +<parameter name="log_func"> +<parameter_description> the log handler function +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data passed to the log handler +</parameter_description> +</parameter> +</parameters> +<return> the id of the new handler +</return> +</function> + +<function name="g_logv"> +<description> +Logs an error or debugging message. + +If the log level has been set as fatal, the abort() +function is called to terminate the program. + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> the log domain +</parameter_description> +</parameter> +<parameter name="log_level"> +<parameter_description> the log level +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> the message format. See the printf() documentation +</parameter_description> +</parameter> +<parameter name="args"> +<parameter_description> the parameters to insert into the format string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_lstat"> <description> A wrapper for the POSIX lstat() function. The lstat() function is @@ -15458,7 +18905,7 @@ this thread is now the owner of @context. <function name="g_main_context_add_poll"> <description> Adds a file descriptor to the set of file descriptors polled for -this context. This will very seldomly be used directly. Instead +this context. This will very seldom be used directly. Instead a typical event source will use g_source_add_poll() instead. </description> @@ -15498,8 +18945,8 @@ Passes the results of polling back to the main loop. </parameter_description> </parameter> <parameter name="fds"> -<parameter_description> array of #GPollFD's that was passed to the last call to -g_main_context_query() +<parameter_description> array of #GPollFD's that was passed to +the last call to g_main_context_query() </parameter_description> </parameter> <parameter name="n_fds"> @@ -15628,19 +19075,23 @@ Gets the poll function set by g_main_context_set_poll_func(). <description> Gets the thread-default #GMainContext for this thread. Asynchronous operations that want to be able to be run in contexts other than -the default one should call this method to get a #GMainContext to -add their #GSource<!-- -->s to. (Note that even in single-threaded +the default one should call this method or +g_main_context_ref_thread_default() to get a #GMainContext to add +their #GSource<!-- -->s to. (Note that even in single-threaded programs applications may sometimes want to temporarily push a non-default context, so it is not safe to assume that this will -always return %NULL if threads are not initialized.) +always return %NULL if you are running in the default thread.) + +If you need to hold a reference on the context, use +g_main_context_ref_thread_default() instead. Since: 2.22 </description> <parameters> </parameters> -<return> the thread-default #GMainContext, or %NULL if the -thread-default context is the global default context. +<return> the thread-default #GMainContext, or +%NULL if the thread-default context is the global default context. </return> </function> @@ -15732,7 +19183,7 @@ Since: 2.28 <function name="g_main_context_is_owner"> <description> Determines whether this thread holds the (recursive) -ownership of this #GMaincontext. This is useful to +ownership of this #GMainContext. This is useful to know before waiting on another thread that may be blocking to get ownership of @context. @@ -15912,7 +19363,8 @@ Determines information necessary to poll this main loop. </parameter_description> </parameter> <parameter name="fds"> -<parameter_description> location to store #GPollFD records that need to be polled. +<parameter_description> location to +store #GPollFD records that need to be polled. </parameter_description> </parameter> <parameter name="n_fds"> @@ -15942,6 +19394,26 @@ Increases the reference count on a #GMainContext object by one. </return> </function> +<function name="g_main_context_ref_thread_default"> +<description> +Gets the thread-default #GMainContext for this thread, as with +g_main_context_get_thread_default(), but also adds a reference to +it with g_main_context_ref(). In addition, unlike +g_main_context_get_thread_default(), if the thread-default context +is the global default context, this will return that #GMainContext +(with a ref added to it) rather than returning %NULL. + +Since: 2.32 + +</description> +<parameters> +</parameters> +<return> the thread-default #GMainContext. Unref +with g_main_context_unref() when you are done with it. + +</return> +</function> + <function name="g_main_context_release"> <description> Releases ownership of a context previously acquired by this thread @@ -16458,14 +19930,19 @@ Since: 2.8 Maps a file into memory. On UNIX, this is using the mmap() function. If @writable is %TRUE, the mapped buffer may be modified, otherwise -it is an error to modify the mapped buffer. Modifications to the buffer -are not visible to other processes mapping the same file, and are not +it is an error to modify the mapped buffer. Modifications to the buffer +are not visible to other processes mapping the same file, and are not written back to the file. Note that modifications of the underlying file might affect the contents -of the #GMappedFile. Therefore, mapping should only be used if the file +of the #GMappedFile. Therefore, mapping should only be used if the file will not be modified, or if all modifications of the file are done -atomically (e.g. using g_file_set_contents()). +atomically (e.g. using g_file_set_contents()). + +If @filename is the name of an empty, regular file, the function +will successfully return an empty #GMappedFile. In other cases of +size 0 (e.g. device files such as /dev/null), @error will be set +to the #GFileError value #G_FILE_ERROR_INVAL. Since: 2.8 @@ -16490,6 +19967,43 @@ with g_mapped_file_unref(), or %NULL if the mapping failed. </return> </function> +<function name="g_mapped_file_new_from_fd"> +<description> +Maps a file into memory. On UNIX, this is using the mmap() function. + +If @writable is %TRUE, the mapped buffer may be modified, otherwise +it is an error to modify the mapped buffer. Modifications to the buffer +are not visible to other processes mapping the same file, and are not +written back to the file. + +Note that modifications of the underlying file might affect the contents +of the #GMappedFile. Therefore, mapping should only be used if the file +will not be modified, or if all modifications of the file are done +atomically (e.g. using g_file_set_contents()). + +Since: 2.30 + +</description> +<parameters> +<parameter name="fd"> +<parameter_description> The file descriptor of the file to load +</parameter_description> +</parameter> +<parameter name="writable"> +<parameter_description> whether the mapping should be writable +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated #GMappedFile which must be unref'd +with g_mapped_file_unref(), or %NULL if the mapping failed. + +</return> +</function> + <function name="g_mapped_file_ref"> <description> Increments the reference count of @file by one. It is safe to call @@ -17111,7 +20625,7 @@ Since: 2.14 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore errors +<parameter_description> location to store the error occurring, or %NULL to ignore errors </parameter_description> </parameter> </parameters> @@ -17309,14 +20823,15 @@ unchanged <function name="g_match_info_free"> <description> -Frees all the memory associated with the #GMatchInfo structure. +If @match_info is not %NULL, calls g_match_info_unref(); otherwise does +nothing. Since: 2.14 </description> <parameters> <parameter name="match_info"> -<parameter_description> a #GMatchInfo +<parameter_description> a #GMatchInfo, or %NULL </parameter_description> </parameter> </parameters> @@ -17474,7 +20989,7 @@ Since: 2.14 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore errors +<parameter_description> location to store the error occurring, or %NULL to ignore errors </parameter_description> </parameter> </parameters> @@ -17483,217 +20998,35 @@ Since: 2.14 </return> </function> -<function name="g_mem_chunk_alloc"> -<description> -Allocates an atom of memory from a #GMemChunk. - -Deprecated:2.10: Use g_slice_alloc() instead - -</description> -<parameters> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return> a pointer to the allocated atom. -</return> -</function> - -<function name="g_mem_chunk_alloc0"> -<description> -Allocates an atom of memory from a #GMemChunk, setting the memory to -0. - -Deprecated:2.10: Use g_slice_alloc0() instead - -</description> -<parameters> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return> a pointer to the allocated atom. -</return> -</function> - -<function name="g_mem_chunk_clean"> +<function name="g_match_info_ref"> <description> -Frees any blocks in a #GMemChunk which are no longer being used. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead +Increases reference count of @match_info by 1. -</description> -<parameters> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - -<function name="g_mem_chunk_create"> -<description> -A convenience macro for creating a new #GMemChunk. It calls -g_mem_chunk_new(), using the given type to create the #GMemChunk -name. The atom size is determined using -<function>sizeof()</function>, and the area size is calculated by -multiplying the @pre_alloc parameter with the atom size. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead - -</description> -<parameters> -<parameter name="type"> -<parameter_description> the type of the atoms, typically a structure name. -</parameter_description> -</parameter> -<parameter name="pre_alloc"> -<parameter_description> the number of atoms to store in each block of memory. -</parameter_description> -</parameter> -<parameter name="alloc_type"> -<parameter_description> the type of the #GMemChunk. #G_ALLOC_AND_FREE is used -if the atoms will be freed individually. #G_ALLOC_ONLY -should be used if atoms will never be freed -individually. #G_ALLOC_ONLY is quicker, since it does -not need to track free atoms, but it obviously wastes -memory if you no longer need many of the atoms. -</parameter_description> -</parameter> -</parameters> -<return> the new #GMemChunk. -</return> -</function> - -<function name="g_mem_chunk_destroy"> -<description> -Frees all of the memory allocated for a #GMemChunk. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead - -</description> -<parameters> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - -<function name="g_mem_chunk_free"> -<description> -Frees an atom in a #GMemChunk. This should only be called if the -#GMemChunk was created with #G_ALLOC_AND_FREE. Otherwise it will -simply return. - -Deprecated:2.10: Use g_slice_free1() instead +Since: 2.30 </description> <parameters> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -<parameter name="mem"> -<parameter_description> a pointer to the atom to free. +<parameter name="match_info"> +<parameter_description> a #GMatchInfo </parameter_description> </parameter> </parameters> -<return></return> -</function> - -<function name="g_mem_chunk_info"> -<description> -Outputs debugging information for all #GMemChunk objects currently -in use. It outputs the number of #GMemChunk objects currently -allocated, and calls g_mem_chunk_print() to output information on -each one. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead - -</description> -<parameters> -</parameters> -<return></return> -</function> - -<function name="g_mem_chunk_new"> -<description> -Creates a new #GMemChunk. +<return> @match_info -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead - -</description> -<parameters> -<parameter name="name"> -<parameter_description> a string to identify the #GMemChunk. It is not copied so it -should be valid for the lifetime of the #GMemChunk. It is -only used in g_mem_chunk_print(), which is used for debugging. -</parameter_description> -</parameter> -<parameter name="atom_size"> -<parameter_description> the size, in bytes, of each element in the #GMemChunk. -</parameter_description> -</parameter> -<parameter name="area_size"> -<parameter_description> the size, in bytes, of each block of memory allocated to -contain the atoms. -</parameter_description> -</parameter> -<parameter name="type"> -<parameter_description> the type of the #GMemChunk. #G_ALLOC_AND_FREE is used if the -atoms will be freed individually. #G_ALLOC_ONLY should be -used if atoms will never be freed individually. -#G_ALLOC_ONLY is quicker, since it does not need to track -free atoms, but it obviously wastes memory if you no longer -need many of the atoms. -</parameter_description> -</parameter> -</parameters> -<return> the new #GMemChunk. </return> </function> -<function name="g_mem_chunk_print"> +<function name="g_match_info_unref"> <description> -Outputs debugging information for a #GMemChunk. It outputs the name -of the #GMemChunk (set with g_mem_chunk_new()), the number of bytes -used, and the number of blocks of memory allocated. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead +Decreases reference count of @match_info by 1. When reference count drops +to zero, it frees all the memory associated with the match_info structure. -</description> -<parameters> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - -<function name="g_mem_chunk_reset"> -<description> -Resets a GMemChunk to its initial state. It frees all of the -currently allocated blocks of memory. - -Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice -allocator</link> instead +Since: 2.30 </description> <parameters> -<parameter name="mem_chunk"> -<parameter_description> a #GMemChunk. +<parameter name="match_info"> +<parameter_description> a #GMatchInfo </parameter_description> </parameter> </parameters> @@ -17703,7 +21036,7 @@ allocator</link> instead <function name="g_mem_gc_friendly"> <description> This variable is %TRUE if the <envar>G_DEBUG</envar> environment variable -includes the key <link linkend="G_DEBUG">gc-friendly</link>. +includes the key <literal>gc-friendly</literal>. </description> <parameters> @@ -17822,6 +21155,21 @@ typically simply resolve to memmove() and GLib does not include <return></return> </function> +<function name="g_message"> +<description> +A convenience function/macro to log a normal message. + +</description> +<parameters> +<parameter name="Varargs"> +<parameter_description> format string, followed by parameters to insert +into the format string (as with printf()) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_mkdir"> <description> A wrapper for the POSIX mkdir() function. The mkdir() function @@ -17873,19 +21221,82 @@ created. Returns -1 if an error occurred, with errno set. </return> </function> +<function name="g_mkdtemp"> +<description> +Creates a temporary directory. See the mkdtemp() documentation +on most UNIX-like systems. + +The parameter is a string that should follow the rules for +mkdtemp() templates, i.e. contain the string "XXXXXX". +g_mkdtemp() is slightly more flexible than mkdtemp() in that the +sequence does not have to occur at the very end of the template +and you can pass a @mode and additional @flags. The X string will +be modified to form the name of a directory that didn't exist. +The string should be in the GLib file name encoding. Most importantly, +on Windows it should be in UTF-8. + +Since: 2.30 + +</description> +<parameters> +<parameter name="tmpl"> +<parameter_description> template directory name +</parameter_description> +</parameter> +</parameters> +<return> A pointer to @tmpl, which has been modified +to hold the directory name. In case of errors, %NULL is +returned and %errno will be set. + +</return> +</function> + +<function name="g_mkdtemp_full"> +<description> +Creates a temporary directory. See the mkdtemp() documentation +on most UNIX-like systems. + +The parameter is a string that should follow the rules for +mkdtemp() templates, i.e. contain the string "XXXXXX". +g_mkdtemp() is slightly more flexible than mkdtemp() in that the +sequence does not have to occur at the very end of the template +and you can pass a @mode. The X string will be modified to form +the name of a directory that didn't exist. The string should be +in the GLib file name encoding. Most importantly, on Windows it +should be in UTF-8. + +Since: 2.30 + +</description> +<parameters> +<parameter name="tmpl"> +<parameter_description> template directory name +</parameter_description> +</parameter> +<parameter name="mode"> +<parameter_description> permissions to create the temporary directory with +</parameter_description> +</parameter> +</parameters> +<return> A pointer to @tmpl, which has been modified +to hold the directory name. In case of errors, %NULL is +returned, and %errno will be set. + +</return> +</function> + <function name="g_mkstemp"> <description> Opens a temporary file. See the mkstemp() documentation -on most UNIX-like systems. +on most UNIX-like systems. The parameter is a string that should follow the rules for -mkstemp() templates, i.e. contain the string "XXXXXX". -g_mkstemp() is slightly more flexible than mkstemp() -in that the sequence does not have to occur at the very end of the -template. The X string will -be modified to form the name of a file that didn't exist. -The string should be in the GLib file name encoding. Most importantly, -on Windows it should be in UTF-8. +mkstemp() templates, i.e. contain the string "XXXXXX". +g_mkstemp() is slightly more flexible than mkstemp() in that the +sequence does not have to occur at the very end of the template. +The X string will be modified to form the name of a file that +didn't exist. The string should be in the GLib file name encoding. +Most importantly, on Windows it should be in UTF-8. </description> @@ -17896,9 +21307,10 @@ on Windows it should be in UTF-8. </parameter> </parameters> <return> A file handle (as from open()) to the file -opened for reading and writing. The file is opened in binary mode -on platforms where there is a difference. The file handle should be -closed with close(). In case of errors, -1 is returned. +opened for reading and writing. The file is opened in binary +mode on platforms where there is a difference. The file handle +should be closed with close(). In case of errors, -1 is +returned and %errno will be set. </return> </function> @@ -17925,33 +21337,247 @@ Since: 2.22 </parameter_description> </parameter> <parameter name="flags"> -<parameter_description> flags to pass to an open() call in addition to O_EXCL and -O_CREAT, which are passed automatically +<parameter_description> flags to pass to an open() call in addition to O_EXCL +and O_CREAT, which are passed automatically </parameter_description> </parameter> <parameter name="mode"> -<parameter_description> permissios to create the temporary file with +<parameter_description> permissions to create the temporary file with </parameter_description> </parameter> </parameters> <return> A file handle (as from open()) to the file opened for reading and writing. The file handle should be -closed with close(). In case of errors, -1 is returned. +closed with close(). In case of errors, -1 is returned +and %errno will be set. </return> </function> +<function name="g_module_build_path"> +<description> +A portable way to build the filename of a module. The platform-specific +prefix and suffix are added to the filename, if needed, and the result +is added to the directory, using the correct separator character. + +The directory should specify the directory where the module can be found. +It can be %NULL or an empty string to indicate that the module is in a +standard platform-specific directory, though this is not recommended +since the wrong module may be found. + +For example, calling g_module_build_path() on a Linux system with a +@directory of <filename>/lib</filename> and a @module_name of "mylibrary" +will return <filename>/lib/libmylibrary.so</filename>. On a Windows system, +using <filename>\Windows</filename> as the directory it will return +<filename>\Windows\mylibrary.dll</filename>. + + +</description> +<parameters> +<parameter name="directory"> +<parameter_description> the directory where the module is. This can be %NULL +or the empty string to indicate that the standard platform-specific +directories will be used, though that is not recommended +</parameter_description> +</parameter> +<parameter name="module_name"> +<parameter_description> the name of the module +</parameter_description> +</parameter> +</parameters> +<return> the complete path of the module, including the standard library +prefix and suffix. This should be freed when no longer needed +</return> +</function> + +<function name="g_module_close"> +<description> +Closes a module. + + +</description> +<parameters> +<parameter name="module"> +<parameter_description> a #GModule to close +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success +</return> +</function> + +<function name="g_module_error"> +<description> +Gets a string describing the last module error. + + +</description> +<parameters> +</parameters> +<return> a string describing the last module error +</return> +</function> + +<function name="g_module_name"> +<description> +Ensures that a module will never be unloaded. +Any future g_module_close() calls on the module will be ignored. + +</description> +<parameters> +<parameter name="module"> +<parameter_description> a #GModule to make permanently resident +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_module_open"> +<description> +Opens a module. If the module has already been opened, +its reference count is incremented. + +First of all g_module_open() tries to open @file_name as a module. +If that fails and @file_name has the ".la"-suffix (and is a libtool +archive) it tries to open the corresponding module. If that fails +and it doesn't have the proper module suffix for the platform +(#G_MODULE_SUFFIX), this suffix will be appended and the corresponding +module will be opended. If that fails and @file_name doesn't have the +".la"-suffix, this suffix is appended and g_module_open() tries to open +the corresponding module. If eventually that fails as well, %NULL is +returned. + + +</description> +<parameters> +<parameter name="file_name"> +<parameter_description> the name of the file containing the module, or %NULL +to obtain a #GModule representing the main program itself +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> the flags used for opening the module. This can be the +logical OR of any of the #GModuleFlags +</parameter_description> +</parameter> +</parameters> +<return> a #GModule on success, or %NULL on failure +</return> +</function> + +<function name="g_module_supported"> +<description> +Checks if modules are supported on the current platform. + + +</description> +<parameters> +</parameters> +<return> %TRUE if modules are supported +</return> +</function> + +<function name="g_module_symbol"> +<description> +Gets a symbol pointer from a module, such as one exported +by #G_MODULE_EXPORT. Note that a valid symbol can be %NULL. + + +</description> +<parameters> +<parameter name="module"> +<parameter_description> a #GModule +</parameter_description> +</parameter> +<parameter name="symbol_name"> +<parameter_description> the name of the symbol to find +</parameter_description> +</parameter> +<parameter name="symbol"> +<parameter_description> returns the pointer to the symbol value +</parameter_description> +</parameter> +</parameters> +<return> %TRUE on success +</return> +</function> + +<function name="g_mutex_clear"> +<description> +Frees the resources allocated to a mutex with g_mutex_init(). + +This function should not be used with a #GMutex that has been +statically allocated. + +Calling g_mutex_clear() on a locked mutex leads to undefined +behaviour. + +Sine: 2.32 + +</description> +<parameters> +<parameter name="mutex"> +<parameter_description> an initialized #GMutex +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_mutex_free"> <description> -Destroys @mutex. +Destroys a @mutex that has been created with g_mutex_new(). + +Calling g_mutex_free() on a locked mutex may result +in undefined behaviour. -<note><para>Calling g_mutex_free() on a locked mutex may result in -undefined behaviour.</para></note> +Deprecated:3.32:GMutex can now be statically allocated, or embedded +in structures and initialised with g_mutex_init(). </description> <parameters> <parameter name="mutex"> -<parameter_description> a #GMutex. +<parameter_description> a #GMutex +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_mutex_init"> +<description> +Initializes a #GMutex so that it can be used. + +This function is useful to initialize a mutex that has been +allocated on the stack, or as part of a larger structure. +It is not necessary to initialize a mutex that has been +created that has been statically allocated. + +|[ +typedef struct { +GMutex m; +... +} Blob; + +Blob *b; + +b = g_new (Blob, 1); +g_mutex_init (&b->m); +]| + +To undo the effect of g_mutex_init() when a mutex is no longer +needed, use g_mutex_clear(). + +Calling g_mutex_init() on an already initialized #GMutex leads +to undefined behaviour. + +Since: 2.32 + +</description> +<parameters> +<parameter name="mutex"> +<parameter_description> an uninitialized #GMutex </parameter_description> </parameter> </parameters> @@ -17964,18 +21590,15 @@ Locks @mutex. If @mutex is already locked by another thread, the current thread will block until @mutex is unlocked by the other thread. -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will do nothing. - -<note><para>#GMutex is neither guaranteed to be recursive nor to be -non-recursive, i.e. a thread could deadlock while calling -g_mutex_lock(), if it already has locked @mutex. Use -#GStaticRecMutex, if you need recursive mutexes.</para></note> +<note>#GMutex is neither guaranteed to be recursive nor to be +non-recursive. As such, calling g_mutex_lock() on a #GMutex that has +already been locked by the same thread results in undefined behaviour +(including but not limited to deadlocks).</note> </description> <parameters> <parameter name="mutex"> -<parameter_description> a #GMutex. +<parameter_description> a #GMutex </parameter_description> </parameter> </parameters> @@ -17984,15 +21607,16 @@ g_mutex_lock(), if it already has locked @mutex. Use <function name="g_mutex_new"> <description> -Creates a new #GMutex. +Allocates and initializes a new #GMutex. -<note><para>This function will abort if g_thread_init() has not been -called yet.</para></note> +Deprecated:3.32:GMutex can now be statically allocated, or embedded +in structures and initialised with g_mutex_init(). </description> <parameters> </parameters> -<return> a new #GMutex. +<return> a newly allocated #GMutex. Use g_mutex_free() to free + </return> </function> @@ -18002,38 +21626,36 @@ Tries to lock @mutex. If @mutex is already locked by another thread, it immediately returns %FALSE. Otherwise it locks @mutex and returns %TRUE. -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will immediately return %TRUE. +<note>#GMutex is neither guaranteed to be recursive nor to be +non-recursive. As such, calling g_mutex_lock() on a #GMutex that has +already been locked by the same thread results in undefined behaviour +(including but not limited to deadlocks or arbitrary return values). +</note> -<note><para>#GMutex is neither guaranteed to be recursive nor to be -non-recursive, i.e. the return value of g_mutex_trylock() could be -both %FALSE or %TRUE, if the current thread already has locked -@mutex. Use #GStaticRecMutex, if you need recursive -mutexes.</para></note> </description> <parameters> <parameter name="mutex"> -<parameter_description> a #GMutex. +<parameter_description> a #GMutex </parameter_description> </parameter> </parameters> -<return> %TRUE, if @mutex could be locked. +<return> %TRUE if @mutex could be locked </return> </function> <function name="g_mutex_unlock"> <description> Unlocks @mutex. If another thread is blocked in a g_mutex_lock() -call for @mutex, it will be woken and can lock @mutex itself. +call for @mutex, it will become unblocked and can lock @mutex itself. -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will do nothing. +Calling g_mutex_unlock() on a mutex that is not locked by the +current thread leads to undefined behaviour. </description> <parameters> <parameter name="mutex"> -<parameter_description> a #GMutex. +<parameter_description> a #GMutex </parameter_description> </parameter> </parameters> @@ -18504,24 +22126,6 @@ too big, %NULL is returned. </return> </function> -<function name="g_node_pop_allocator"> -<description> -Restores the previous #GAllocator, used when allocating #GNode -elements. - -Note that this function is not available if GLib has been compiled -with <option>--disable-mem-pools</option> - -Deprecated:2.10: It does nothing, since #GNode has been converted to -the <link linkend="glib-Memory-Slices">slice -allocator</link> - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_node_prepend"> <description> Inserts a #GNode as the first child of the given parent. @@ -18542,28 +22146,6 @@ Inserts a #GNode as the first child of the given parent. </return> </function> -<function name="g_node_push_allocator"> -<description> -Sets the allocator to use to allocate #GNode elements. Use -g_node_pop_allocator() to restore the previous allocator. - -Note that this function is not available if GLib has been compiled -with <option>--disable-mem-pools</option> - -Deprecated:2.10: It does nothing, since #GNode has been converted to -the <link linkend="glib-Memory-Slices">slice -allocator</link> - -</description> -<parameters> -<parameter name="dummy"> -<parameter_description> the #GAllocator to use when allocating #GNode elements. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_node_reverse_children"> <description> Reverses the order of the children of a #GNode. @@ -18634,6 +22216,38 @@ Unlinks a #GNode from a tree, resulting in two separate trees. <return></return> </function> +<function name="g_ntohl"> +<description> +Converts a 32-bit integer value from network to host byte order. + + +</description> +<parameters> +<parameter name="val"> +<parameter_description> a 32-bit integer value in network byte order +</parameter_description> +</parameter> +</parameters> +<return> @val converted to host byte order. +</return> +</function> + +<function name="g_ntohs"> +<description> +Converts a 16-bit integer value from network to host byte order. + + +</description> +<parameters> +<parameter name="val"> +<parameter_description> a 16-bit integer value in network byte order +</parameter_description> +</parameter> +</parameters> +<return> @val converted to host byte order +</return> +</function> + <function name="g_nullify_pointer"> <description> Set the pointer at the specified location to %NULL. @@ -18670,7 +22284,7 @@ when the reference from @object to the proxy object should be true) or weak to strong (@is_last_ref false). Since a (normal) reference must be held to the object before -calling g_object_toggle_ref(), the initial state of the reverse +calling g_object_add_toggle_ref(), the initial state of the reverse link is always strong. Multiple toggle references may be added to the same gobject, @@ -18708,6 +22322,11 @@ the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL. +Note that as with g_object_weak_ref(), the weak references created by +this method are not thread-safe: they cannot safely be used in one +thread if the object's last g_object_unref() might happen in another +thread. Use #GWeakRef if thread-safety is required. + </description> <parameters> <parameter name="object"> @@ -19230,7 +22849,7 @@ followed by %NULL <description> This function is intended for #GObject implementations to re-enforce a <link linkend="floating-ref">floating</link> object reference. -Doing this is seldomly required: all +Doing this is seldom required: all #GInitiallyUnowned<!-- -->s are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink(). @@ -20123,6 +23742,11 @@ used for notification when an object is finalized. They are called to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive). +Note that the weak references created by this method are not +thread-safe: they cannot safely be used in one thread if the +object's last g_object_unref() might happen in another thread. +Use #GWeakRef if thread-safety is required. + </description> <parameters> <parameter name="object"> @@ -20163,6 +23787,85 @@ Removes a weak reference callback to an object. <return></return> </function> +<function name="g_on_error_query"> +<description> +Prompts the user with +<computeroutput>[E]xit, [H]alt, show [S]tack trace or [P]roceed</computeroutput>. +This function is intended to be used for debugging use only. +The following example shows how it can be used together with +the g_log() functions. + +|[ +#include <glib.h> + +static void +log_handler (const gchar *log_domain, +GLogLevelFlags log_level, +const gchar *message, +gpointer user_data) +{ +g_log_default_handler (log_domain, log_level, message, user_data); + +g_on_error_query (MY_PROGRAM_NAME); +} + +int +main (int argc, char *argv[]) +{ +g_log_set_handler (MY_LOG_DOMAIN, +G_LOG_LEVEL_WARNING | +G_LOG_LEVEL_ERROR | +G_LOG_LEVEL_CRITICAL, +log_handler, +NULL); +/ * ... * / +]| + +If [E]xit is selected, the application terminates with a call +to <literal>_exit(0)</literal>. + +If [S]tack trace is selected, g_on_error_stack_trace() is called. +This invokes <command>gdb</command>, which attaches to the current +process and shows a stack trace. The prompt is then shown again. + +If [P]roceed is selected, the function returns. + +This function may cause different actions on non-UNIX platforms. + +</description> +<parameters> +<parameter name="prg_name"> +<parameter_description> the program name, needed by <command>gdb</command> +for the [S]tack trace option. If @prg_name is %NULL, g_get_prgname() +is called to get the program name (which will work correctly if +gdk_init() or gtk_init() has been called) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_on_error_stack_trace"> +<description> +Invokes <command>gdb</command>, which attaches to the current +process and shows a stack trace. Called by g_on_error_query() +when the [S]tack trace option is selected. You can get the current +process's "program name" with g_get_prgname(), assuming that you +have called gtk_init() or gdk_init(). + +This function may cause different actions on non-UNIX platforms. + +</description> +<parameters> +<parameter name="prg_name"> +<parameter_description> the program name, needed by <command>gdb</command> +for the [S]tack trace option. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_once"> <description> The first call to this routine by a process with a given #GOnce @@ -20175,11 +23878,10 @@ For example, a mutex or a thread-specific data key must be created exactly once. In a threaded environment, calling g_once() ensures that the initialization is serialized across multiple threads. -<note><para>Calling g_once() recursively on the same #GOnce struct in -@func will lead to a deadlock.</para></note> +Calling g_once() recursively on the same #GOnce struct in +@func will lead to a deadlock. -<informalexample> -<programlisting> +|[ gpointer get_debug_flags (void) { @@ -20189,8 +23891,7 @@ g_once (&my_once, parse_debug_flags, NULL); return my_once.retval; } -</programlisting> -</informalexample> +]| Since: 2.4 @@ -20217,7 +23918,7 @@ its associated #GOnce struct are passed to g_once(). <function name="g_once_init_enter"> <description> Function to be called when starting a critical initialization -section. The argument @value_location must point to a static +section. The argument @location must point to a static 0-initialized variable that will be set to a value other than 0 at the end of the initialization section. In combination with g_once_init_leave() and the unique address @value_location, it can @@ -20226,33 +23927,31 @@ during a program's life time, and that concurrent threads are blocked until initialization completed. To be used in constructs like this: -<informalexample> -<programlisting> +|[ static gsize initialization_value = 0; if (g_once_init_enter (&initialization_value)) { -gsize setup_value = 42; /<!-- -->* initialization code here *<!-- -->/ +gsize setup_value = 42; / ** initialization code here ** / g_once_init_leave (&initialization_value, setup_value); } -/<!-- -->* use initialization_value here *<!-- -->/ -</programlisting> -</informalexample> +/ ** use initialization_value here ** / +]| Since: 2.14 </description> <parameters> -<parameter name="value_location"> -<parameter_description> location of a static initializable variable -containing 0. +<parameter name="location"> +<parameter_description> location of a static initializable variable containing 0 </parameter_description> </parameter> </parameters> <return> %TRUE if the initialization section should be entered, %FALSE and blocks otherwise + </return> </function> @@ -20268,13 +23967,12 @@ Since: 2.14 </description> <parameters> -<parameter name="value_location"> -<parameter_description> location of a static initializable variable -containing 0. +<parameter name="location"> +<parameter_description> location of a static initializable variable containing 0 </parameter_description> </parameter> -<parameter name="initialization_value"> -<parameter_description> new non-0 value for *@value_location. +<parameter name="result"> +<parameter_description> new non-0 value for *@value_location </parameter_description> </parameter> </parameters> @@ -21281,6 +24979,9 @@ Get the short description of a #GParamSpec. <description> Get the name of a #GParamSpec. +The name is always an "interned" string (as per g_intern_string()). +This allows for pointer-value comparisons. + </description> <parameters> @@ -21662,7 +25363,7 @@ See g_param_spec_internal() for details on property names. <function name="g_param_spec_pointer"> <description> -Creates a new #GParamSpecPoiner instance specifying a pointer property. +Creates a new #GParamSpecPointer instance specifying a pointer property. See g_param_spec_internal() for details on property names. @@ -22450,13 +26151,17 @@ respectively. <function name="g_parse_debug_string"> <description> Parses a string containing debugging options -into a %guint containing bit flags. This is used +into a %guint containing bit flags. This is used within GDK and GTK+ to parse the debug options passed on the command line or through environment variables. -If @string is equal to "all", all flags are set. If @string -is equal to "help", all the available keys in @keys are printed -out to standard error. +If @string is equal to <code>"all"</code>, all flags are set. Any flags +specified along with <code>"all"</code> in @string are inverted; thus, +<code>"all,foo,bar"</code> or <code>"foo,bar,all"</code> sets all flags +except those corresponding to <code>"foo"</code> and <code>"bar"</code>. + +If @string is equal to <code>"help"</code>, all the available keys in @keys +are printed out to standard error. </description> @@ -22467,7 +26172,7 @@ commas, or %NULL. </parameter_description> </parameter> <parameter name="keys"> -<parameter_description> pointer to an array of #GDebugKey which associate +<parameter_description> pointer to an array of #GDebugKey which associate strings with bit flags. </parameter_description> </parameter> @@ -22482,40 +26187,42 @@ strings with bit flags. <function name="g_path_get_basename"> <description> -Gets the last component of the filename. If @file_name ends with a -directory separator it gets the component before the last slash. If -@file_name consists only of directory separators (and on Windows, -possibly a drive letter), a single separator is returned. If -@file_name is empty, it gets ".". +Gets the last component of the filename. + +If @file_name ends with a directory separator it gets the component +before the last slash. If @file_name consists only of directory +separators (and on Windows, possibly a drive letter), a single +separator is returned. If @file_name is empty, it gets ".". </description> <parameters> <parameter name="file_name"> -<parameter_description> the name of the file. +<parameter_description> the name of the file </parameter_description> </parameter> </parameters> -<return> a newly allocated string containing the last component of -the filename. +<return> a newly allocated string containing the last +component of the filename </return> </function> <function name="g_path_get_dirname"> <description> -Gets the directory components of a file name. If the file name has no -directory components "." is returned. The returned string should be -freed when no longer needed. +Gets the directory components of a file name. + +If the file name has no directory components "." is returned. +The returned string should be freed when no longer needed. </description> <parameters> <parameter name="file_name"> -<parameter_description> the name of the file. +<parameter_description> the name of the file </parameter_description> </parameter> </parameters> -<return> the directory components of the file. +<return> the directory components of the file </return> </function> @@ -22550,29 +26257,29 @@ Windows-specific code. </description> <parameters> <parameter name="file_name"> -<parameter_description> a file name. +<parameter_description> a file name </parameter_description> </parameter> </parameters> -<return> %TRUE if @file_name is absolute. +<return> %TRUE if @file_name is absolute </return> </function> <function name="g_path_skip_root"> <description> -Returns a pointer into @file_name after the root component, i.e. after -the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute -path it returns %NULL. +Returns a pointer into @file_name after the root component, +i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name +is not an absolute path it returns %NULL. </description> <parameters> <parameter name="file_name"> -<parameter_description> a file name. +<parameter_description> a file name </parameter_description> </parameter> </parameters> -<return> a pointer into @file_name after the root component. +<return> a pointer into @file_name after the root component </return> </function> @@ -22759,6 +26466,7 @@ Since: 2.30 </parameter> </parameters> <return> %TRUE if the lock was acquired + </return> </function> @@ -22880,6 +26588,54 @@ Since: 2.16 <return></return> </function> +<function name="g_print"> +<description> +Outputs a formatted message via the print handler. +The default print handler simply outputs the message to stdout. + +g_print() should not be used from within libraries for debugging +messages, since it may be redirected by applications to special +purpose message windows or even files. Instead, libraries should +use g_log(), or the convenience functions g_message(), g_warning() +and g_error(). + +</description> +<parameters> +<parameter name="format"> +<parameter_description> the message format. See the printf() documentation +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> the parameters to insert into the format string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_printerr"> +<description> +Outputs a formatted message via the error message handler. +The default handler simply outputs the message to stderr. + +g_printerr() should not be used from within libraries. +Instead g_log() should be used, or the convenience functions +g_message(), g_warning() and g_error(). + +</description> +<parameters> +<parameter name="format"> +<parameter_description> the message format. See the printf() documentation +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> the parameters to insert into the format string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_printf"> <description> An implementation of the standard printf() function which supports @@ -22904,77 +26660,107 @@ Since: 2.2 </return> </function> +<function name="g_printf_string_upper_bound"> +<description> +Calculates the maximum space needed to store the output +of the sprintf() function. + + +</description> +<parameters> +<parameter name="format"> +<parameter_description> the format string. See the printf() documentation +</parameter_description> +</parameter> +<parameter name="args"> +<parameter_description> the parameters to be inserted into the format string +</parameter_description> +</parameter> +</parameters> +<return> the maximum space needed to store the formatted string +</return> +</function> + <function name="g_private_get"> <description> -Returns the pointer keyed to @private_key for the current thread. If -g_private_set() hasn't been called for the current @private_key and -thread yet, this pointer will be %NULL. +Returns the current value of the thread local variable @key. + +If the value has not yet been set in this thread, %NULL is returned. +Values are never copied between threads (when a new thread is +created, for example). -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will return the value of @private_key -casted to #gpointer. Note however, that private data set -<emphasis>before</emphasis> g_thread_init() will -<emphasis>not</emphasis> be retained <emphasis>after</emphasis> the -call. Instead, %NULL will be returned in all threads directly after -g_thread_init(), regardless of any g_private_set() calls issued -before threading system intialization. </description> <parameters> -<parameter name="private_key"> -<parameter_description> a #GPrivate. +<parameter name="key"> +<parameter_description> a #GPrivate </parameter_description> </parameter> </parameters> -<return> the corresponding pointer. +<return> the thread-local value </return> </function> <function name="g_private_new"> <description> -Creates a new #GPrivate. If @destructor is non-%NULL, it is a -pointer to a destructor function. Whenever a thread ends and the -corresponding pointer keyed to this instance of #GPrivate is -non-%NULL, the destructor is called with this pointer as the -argument. - -<note><para>@destructor is used quite differently from @notify in -g_static_private_set().</para></note> +Creates a new #GPrivate. -<note><para>A #GPrivate cannot be freed. Reuse it instead, if you -can, to avoid shortage, or use #GStaticPrivate.</para></note> +Deprecated:2.32: dynamic allocation of #GPrivate is a bad idea. Use +static storage and G_PRIVATE_INIT() instead. -<note><para>This function will abort if g_thread_init() has not been -called yet.</para></note> </description> <parameters> -<parameter name="destructor"> -<parameter_description> a function to destroy the data keyed to #GPrivate when -a thread ends. +<parameter name="notify"> +<parameter_description> a #GDestroyNotify </parameter_description> </parameter> </parameters> -<return> a new #GPrivate. +<return> a newly allocated #GPrivate (which can never be destroyed) </return> </function> +<function name="g_private_replace"> +<description> +Sets the thread local variable @key to have the value @value in the +current thread. + +This function differs from g_private_set() in the following way: if +the previous value was non-%NULL then the #GDestroyNotify handler for +@key is run on it. + +Since: 2.32 + +</description> +<parameters> +<parameter name="key"> +<parameter_description> a #GPrivate +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the new value +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_private_set"> <description> -Sets the pointer keyed to @private_key for the current thread. +Sets the thread local variable @key to have the value @value in the +current thread. -This function can be used even if g_thread_init() has not yet been -called, and, in that case, will set @private_key to @data casted to -#GPrivate*. See g_private_get() for resulting caveats. +This function differs from g_private_replace() in the following way: +the #GDestroyNotify for @key is not called on the old value. </description> <parameters> -<parameter name="private_key"> -<parameter_description> a #GPrivate. +<parameter name="key"> +<parameter_description> a #GPrivate </parameter_description> </parameter> -<parameter name="data"> -<parameter_description> the new pointer. +<parameter name="value"> +<parameter_description> the new value </parameter_description> </parameter> </parameters> @@ -23133,6 +26919,34 @@ Creates a new #GPtrArray with a reference count of 1. </return> </function> +<function name="g_ptr_array_new_full"> +<description> +Creates a new #GPtrArray with @reserved_size pointers preallocated +and a reference count of 1. This avoids frequent reallocation, if +you are going to add many pointers to the array. Note however that +the size of the array is still 0. It also set @element_free_func +for freeing each element when the array is destroyed either via +g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment +set to %TRUE or when removing elements. + +Since: 2.30 + +</description> +<parameters> +<parameter name="reserved_size"> +<parameter_description> number of pointers preallocated. +</parameter_description> +</parameter> +<parameter name="element_free_func"> +<parameter_description> A function to free elements with destroy @array or %NULL. +</parameter_description> +</parameter> +</parameters> +<return> A new #GPtrArray. + +</return> +</function> + <function name="g_ptr_array_new_with_free_func"> <description> Creates a new #GPtrArray with a reference count of 1 and use @element_free_func @@ -23366,8 +27180,8 @@ than second arg, zero for equal, greater than zero if irst arg is greater than second arg). If two array elements compare equal, their order in the sorted array -is undefined. If you want equal elements to keep their order &#8211; i.e. -you want a stable sort &#8211; you can write a comparison function that, +is undefined. If you want equal elements to keep their order (i.e. +you want a stable sort) you can write a comparison function that, if two elements would otherwise compare equal, compares them by their addresses. @@ -23689,6 +27503,12 @@ Frees the memory allocated for the #GQueue. Only call this function if @queue was created with g_queue_new(). If queue elements contain dynamically-allocated memory, they should be freed first. +<note><para> +If queue elements contain dynamically-allocated memory, +you should either use g_queue_free_full() or free them manually +first. +</para></note> + </description> <parameters> <parameter name="queue"> @@ -23699,6 +27519,27 @@ dynamically-allocated memory, they should be freed first. <return></return> </function> +<function name="g_queue_free_full"> +<description> +Convenience method, which frees all the memory used by a #GQueue, and +calls the specified destroy function on every element's data. + +Since: 2.32 + +</description> +<parameters> +<parameter name="queue"> +<parameter_description> a pointer to a #GQueue +</parameter_description> +</parameter> +<parameter name="free_func"> +<parameter_description> the function to be called to free each element's data +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_queue_get_length"> <description> Returns the number of items in @queue. @@ -24731,6 +28572,132 @@ Since: 2.24 </return> </function> +<function name="g_rec_mutex_clear"> +<description> +Frees the resources allocated to a recursive mutex with +g_rec_mutex_init(). + +This function should not be used with a #GRecMutex that has been +statically allocated. + +Calling g_rec_mutex_clear() on a locked recursive mutex leads +to undefined behaviour. + +Sine: 2.32 + +</description> +<parameters> +<parameter name="rec_mutex"> +<parameter_description> an initialized #GRecMutex +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rec_mutex_init"> +<description> +Initializes a #GRecMutex so that it can be used. + +This function is useful to initialize a recursive mutex +that has been allocated on the stack, or as part of a larger +structure. + +It is not necessary to initialise a recursive mutex that has been +statically allocated. + +|[ +typedef struct { +GRecMutex m; +... +} Blob; + +Blob *b; + +b = g_new (Blob, 1); +g_rec_mutex_init (&b->m); +]| + +Calling g_rec_mutex_init() on an already initialized #GRecMutex +leads to undefined behaviour. + +To undo the effect of g_rec_mutex_init() when a recursive mutex +is no longer needed, use g_rec_mutex_clear(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="rec_mutex"> +<parameter_description> an uninitialized #GRecMutex +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rec_mutex_lock"> +<description> +Locks @rec_mutex. If @rec_mutex is already locked by another +thread, the current thread will block until @rec_mutex is +unlocked by the other thread. If @rec_mutex is already locked +by the current thread, the 'lock count' of @rec_mutex is increased. +The mutex will only become available again when it is unlocked +as many times as it has been locked. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rec_mutex"> +<parameter_description> a #GRecMutex +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rec_mutex_trylock"> +<description> +Tries to lock @rec_mutex. If @rec_mutex is already locked +by another thread, it immediately returns %FALSE. Otherwise +it locks @rec_mutex and returns %TRUE. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rec_mutex"> +<parameter_description> a #GRecMutex +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @rec_mutex could be locked + +</return> +</function> + +<function name="g_rec_mutex_unlock"> +<description> +Unlocks @rec_mutex. If another thread is blocked in a +g_rec_mutex_lock() call for @rec_mutex, it will become unblocked +and can lock @rec_mutex itself. + +Calling g_rec_mutex_unlock() on a recursive mutex that is not +locked by the current thread leads to undefined behaviour. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rec_mutex"> +<parameter_description> a #GRecMutex +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_regex_check_replacement"> <description> Checks whether @replacement is a valid replacement string @@ -24766,6 +28733,32 @@ references in @replacement or %NULL </return> </function> +<function name="g_regex_escape_nul"> +<description> +Escapes the nul characters in @string to "\x00". It can be used +to compile a regex with embedded nul characters. + +For completeness, @length can be -1 for a nul-terminated string. +In this case the output string will be of course equal to @string. + +Since: 2.30 + +</description> +<parameters> +<parameter name="string"> +<parameter_description> the string to escape +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> the length of @string +</parameter_description> +</parameter> +</parameters> +<return> a newly-allocated escaped string + +</return> +</function> + <function name="g_regex_escape_string"> <description> Escapes the special characters used for regular expressions @@ -25025,7 +29018,7 @@ the #GMatchInfo, or %NULL if you do not need it <function name="g_regex_match_all_full"> <description> Using the standard algorithm for regular expression matching only -the longest match in the string is retrieved, it is not possibile +the longest match in the string is retrieved, it is not possible to obtain all the available matches. For instance matching "<a> <b> <c>" against the pattern "<.*>" you get "<a> <b> <c>". @@ -25091,7 +29084,7 @@ the #GMatchInfo, or %NULL if you do not need it </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore errors +<parameter_description> location to store the error occurring, or %NULL to ignore errors </parameter_description> </parameter> </parameters> @@ -25182,7 +29175,7 @@ the #GMatchInfo, or %NULL if you do not need it </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore errors +<parameter_description> location to store the error occurring, or %NULL to ignore errors </parameter_description> </parameter> </parameters> @@ -25358,7 +29351,7 @@ Since: 2.14 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore errors +<parameter_description> location to store the error occurring, or %NULL to ignore errors </parameter_description> </parameter> </parameters> @@ -25448,7 +29441,7 @@ Since: 2.14 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore errors +<parameter_description> location to store the error occurring, or %NULL to ignore errors </parameter_description> </parameter> </parameters> @@ -25497,7 +29490,7 @@ Since: 2.14 </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore errors +<parameter_description> location to store the error occurring, or %NULL to ignore errors </parameter_description> </parameter> </parameters> @@ -25994,6 +29987,753 @@ occurred </return> </function> +<function name="g_rw_lock_clear"> +<description> +Frees the resources allocated to a lock with g_rw_lock_init(). + +This function should not be used with a #GRWLock that has been +statically allocated. + +Calling g_rw_lock_clear() when any thread holds the lock +leads to undefined behaviour. + +Sine: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> an initialized #GRWLock +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rw_lock_init"> +<description> +Initializes a #GRWLock so that it can be used. + +This function is useful to initialize a lock that has been +allocated on the stack, or as part of a larger structure. It is not +necessary to initialise a reader-writer lock that has been statically +allocated. + +|[ +typedef struct { +GRWLock l; +... +} Blob; + +Blob *b; + +b = g_new (Blob, 1); +g_rw_lock_init (&b->l); +]| + +To undo the effect of g_rw_lock_init() when a lock is no longer +needed, use g_rw_lock_clear(). + +Calling g_rw_lock_init() on an already initialized #GRWLock leads +to undefined behaviour. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> an uninitialized #GRWLock +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rw_lock_reader_lock"> +<description> +Obtain a read lock on @rw_lock. If another thread currently holds +the write lock on @rw_lock or blocks waiting for it, the current +thread will block. Read locks can be taken recursively. + +It is implementation-defined how many threads are allowed to +hold read locks on the same lock simultaneously. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> a #GRWLock +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rw_lock_reader_trylock"> +<description> +Tries to obtain a read lock on @rw_lock and returns %TRUE if +the read lock was successfully obtained. Otherwise it +returns %FALSE. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> a #GRWLock +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @rw_lock could be locked + +</return> +</function> + +<function name="g_rw_lock_reader_unlock"> +<description> +Release a read lock on @rw_lock. + +Calling g_rw_lock_reader_unlock() on a lock that is not held +by the current thread leads to undefined behaviour. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> a #GRWLock +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rw_lock_writer_lock"> +<description> +Obtain a write lock on @rw_lock. If any thread already holds +a read or write lock on @rw_lock, the current thread will block +until all other threads have dropped their locks on @rw_lock. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> a #GRWLock +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_rw_lock_writer_trylock"> +<description> +Tries to obtain a write lock on @rw_lock. If any other thread holds +a read or write lock on @rw_lock, it immediately returns %FALSE. +Otherwise it locks @rw_lock and returns %TRUE. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> a #GRWLock +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @rw_lock could be locked + +</return> +</function> + +<function name="g_rw_lock_writer_unlock"> +<description> +Release a write lock on @rw_lock. + +Calling g_rw_lock_writer_unlock() on a lock that is not held +by the current thread leads to undefined behaviour. + +Since: 2.32 + +</description> +<parameters> +<parameter name="rw_lock"> +<parameter_description> a #GRWLock +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_add_symbol"> +<description> +Adds a symbol to the default scope. + +Deprecated: 2.2: Use g_scanner_scope_add_symbol() instead. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="symbol"> +<parameter_description> the symbol to add +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the value of the symbol +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_cur_line"> +<description> +Returns the current line in the input stream (counting +from 1). This is the line of the last token parsed via +g_scanner_get_next_token(). + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return> the current line +</return> +</function> + +<function name="g_scanner_cur_position"> +<description> +Returns the current position in the current line (counting +from 0). This is the position of the last token parsed via +g_scanner_get_next_token(). + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return> the current position on the line +</return> +</function> + +<function name="g_scanner_cur_token"> +<description> +Gets the current token type. This is simply the @token +field in the #GScanner structure. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return> the current token type +</return> +</function> + +<function name="g_scanner_cur_value"> +<description> +Gets the current token value. This is simply the @value +field in the #GScanner structure. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return> the current token value +</return> +</function> + +<function name="g_scanner_destroy"> +<description> +Frees all memory used by the #GScanner. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_eof"> +<description> +Returns %TRUE if the scanner has reached the end of +the file or text buffer. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the scanner has reached the end of +the file or text buffer +</return> +</function> + +<function name="g_scanner_error"> +<description> +Outputs an error message, via the #GScanner message handler. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> the message format. See the printf() documentation +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> the parameters to insert into the format string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_foreach_symbol"> +<description> +Calls a function for each symbol in the default scope. + +Deprecated: 2.2: Use g_scanner_scope_foreach_symbol() instead. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> the function to call with each symbol +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> data to pass to the function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_freeze_symbol_table"> +<description> +There is no reason to use this macro, since it does nothing. + +Deprecated: 2.2: This macro does nothing. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_get_next_token"> +<description> +Parses the next token just like g_scanner_peek_next_token() +and also removes it from the input stream. The token data is +placed in the @token, @value, @line, and @position fields of +the #GScanner structure. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return> the type of the token +</return> +</function> + +<function name="g_scanner_input_file"> +<description> +Prepares to scan a file. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="input_fd"> +<parameter_description> a file descriptor +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_input_text"> +<description> +Prepares to scan a text buffer. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="text"> +<parameter_description> the text buffer to scan +</parameter_description> +</parameter> +<parameter name="text_len"> +<parameter_description> the length of the text buffer +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_lookup_symbol"> +<description> +Looks up a symbol in the current scope and return its value. +If the symbol is not bound in the current scope, %NULL is +returned. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="symbol"> +<parameter_description> the symbol to look up +</parameter_description> +</parameter> +</parameters> +<return> the value of @symbol in the current scope, or %NULL +if @symbol is not bound in the current scope +</return> +</function> + +<function name="g_scanner_new"> +<description> +Creates a new #GScanner. + +The @config_templ structure specifies the initial settings +of the scanner, which are copied into the #GScanner +@config field. If you pass %NULL then the default settings +are used. + + +</description> +<parameters> +<parameter name="config_templ"> +<parameter_description> the initial scanner settings +</parameter_description> +</parameter> +</parameters> +<return> the new #GScanner +</return> +</function> + +<function name="g_scanner_peek_next_token"> +<description> +Parses the next token, without removing it from the input stream. +The token data is placed in the @next_token, @next_value, @next_line, +and @next_position fields of the #GScanner structure. + +Note that, while the token is not removed from the input stream +(i.e. the next call to g_scanner_get_next_token() will return the +same token), it will not be reevaluated. This can lead to surprising +results when changing scope or the scanner configuration after peeking +the next token. Getting the next token after switching the scope or +configuration will return whatever was peeked before, regardless of +any symbols that may have been added or removed in the new scope. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return> the type of the token +</return> +</function> + +<function name="g_scanner_remove_symbol"> +<description> +Removes a symbol from the default scope. + +Deprecated: 2.2: Use g_scanner_scope_remove_symbol() instead. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="symbol"> +<parameter_description> the symbol to remove +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_scope_add_symbol"> +<description> +Adds a symbol to the given scope. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="scope_id"> +<parameter_description> the scope id +</parameter_description> +</parameter> +<parameter name="symbol"> +<parameter_description> the symbol to add +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> the value of the symbol +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_scope_foreach_symbol"> +<description> +Calls the given function for each of the symbol/value pairs +in the given scope of the #GScanner. The function is passed +the symbol and value of each pair, and the given @user_data +parameter. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="scope_id"> +<parameter_description> the scope id +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> the function to call for each symbol/value pair +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data to pass to the function +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_scope_lookup_symbol"> +<description> +Looks up a symbol in a scope and return its value. If the +symbol is not bound in the scope, %NULL is returned. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="scope_id"> +<parameter_description> the scope id +</parameter_description> +</parameter> +<parameter name="symbol"> +<parameter_description> the symbol to look up +</parameter_description> +</parameter> +</parameters> +<return> the value of @symbol in the given scope, or %NULL +if @symbol is not bound in the given scope. + +</return> +</function> + +<function name="g_scanner_scope_remove_symbol"> +<description> +Removes a symbol from a scope. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="scope_id"> +<parameter_description> the scope id +</parameter_description> +</parameter> +<parameter name="symbol"> +<parameter_description> the symbol to remove +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_set_scope"> +<description> +Sets the current scope. + + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="scope_id"> +<parameter_description> the new scope id +</parameter_description> +</parameter> +</parameters> +<return> the old scope id +</return> +</function> + +<function name="g_scanner_sync_file_offset"> +<description> +Rewinds the filedescriptor to the current buffer position +and blows the file read ahead buffer. This is useful for +third party uses of the scanners filedescriptor, which hooks +onto the current scanning position. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_thaw_symbol_table"> +<description> +There is no reason to use this macro, since it does nothing. + +Deprecated: 2.2: This macro does nothing. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_unexp_token"> +<description> +Outputs a message through the scanner's msg_handler, +resulting from an unexpected token in the input stream. +Note that you should not call g_scanner_peek_next_token() +followed by g_scanner_unexp_token() without an intermediate +call to g_scanner_get_next_token(), as g_scanner_unexp_token() +evaluates the scanner's current token (not the peeked token) +to construct part of the message. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="expected_token"> +<parameter_description> the expected token +</parameter_description> +</parameter> +<parameter name="identifier_spec"> +<parameter_description> a string describing how the scanner's user +refers to identifiers (%NULL defaults to "identifier"). +This is used if @expected_token is %G_TOKEN_IDENTIFIER or +%G_TOKEN_IDENTIFIER_NULL. +</parameter_description> +</parameter> +<parameter name="symbol_spec"> +<parameter_description> a string describing how the scanner's user refers +to symbols (%NULL defaults to "symbol"). This is used if +@expected_token is %G_TOKEN_SYMBOL or any token value greater +than %G_TOKEN_LAST. +</parameter_description> +</parameter> +<parameter name="symbol_name"> +<parameter_description> the name of the symbol, if the scanner's current +token is a symbol. +</parameter_description> +</parameter> +<parameter name="message"> +<parameter_description> a message string to output at the end of the +warning/error, or %NULL. +</parameter_description> +</parameter> +<parameter name="is_error"> +<parameter_description> if %TRUE it is output as an error. If %FALSE it is +output as a warning. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_scanner_warn"> +<description> +Outputs a warning message, via the #GScanner message handler. + +</description> +<parameters> +<parameter name="scanner"> +<parameter_description> a #GScanner +</parameter_description> +</parameter> +<parameter name="format"> +<parameter_description> the message format. See the printf() documentation +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> the parameters to insert into the format string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_sequence_append"> <description> Adds a new item to the end of @seq. @@ -26655,7 +31395,7 @@ Since: 2.14 Removes the item pointed to by @iter. It is an error to pass the end iterator to this function. -If the sequnce has a data destroy function associated with it, this +If the sequence has a data destroy function associated with it, this function is called on the data for the removed item. Since: 2.14 @@ -27044,16 +31784,75 @@ thread-safety reasons this function can only be called once. <return></return> </function> +<function name="g_set_print_handler"> +<description> +Sets the print handler. + +Any messages passed to g_print() will be output via +the new handler. The default handler simply outputs +the message to stdout. By providing your own handler +you can redirect the output, to a GTK+ widget or a +log file for example. + + +</description> +<parameters> +<parameter name="func"> +<parameter_description> the new print handler +</parameter_description> +</parameter> +</parameters> +<return> the old print handler +</return> +</function> + +<function name="g_set_printerr_handler"> +<description> +Sets the handler for printing error messages. + +Any messages passed to g_printerr() will be output via +the new handler. The default handler simply outputs the +message to stderr. By providing your own handler you can +redirect the output, to a GTK+ widget or a log file for +example. + + +</description> +<parameters> +<parameter name="func"> +<parameter_description> the new error message handler +</parameter_description> +</parameter> +</parameters> +<return> the old error message handler +</return> +</function> + <function name="g_setenv"> <description> Sets an environment variable. Both the variable's name and value should be in the GLib file name encoding. On UNIX, this means that -they can be any sequence of bytes. On Windows, they should be in +they can be arbitrary byte strings. On Windows, they should be in UTF-8. -Note that on some systems, when variables are overwritten, the memory +Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed. +<warning><para> +Environment variable handling in UNIX is not thread-safe, and your +program may crash if one thread calls g_setenv() while another +thread is calling getenv(). (And note that many functions, such as +gettext(), call getenv() internally.) This function is only safe to +use at the very start of your program, before creating any other +threads (or creating objects that create worker threads of their +own). +</para><para> +If you need to set up the environment for a child process, you can +use g_get_environ() to get an environment array, modify that with +g_environ_setenv() and g_environ_unsetenv(), and then pass that +array directly to execvpe(), g_spawn_async(), or the like. +</para></warning> + Since: 2.4 </description> @@ -27292,9 +32091,9 @@ g_signal_override_class_handler(). </description> <parameters> <parameter name="instance_and_params"> -<parameter_description> the argument list of the signal emission. The first -element in the array is a #GValue for the instance the signal is being -emitted on. The rest are any arguments to be passed to the signal. +<parameter_description> (array) the argument list of the signal emission. +The first element in the array is a #GValue for the instance the signal +is being emitted on. The rest are any arguments to be passed to the signal. </parameter_description> </parameter> <parameter name="return_value"> @@ -27477,7 +32276,7 @@ g_signal_handler_disconnect (instance, id); </parameter_description> </parameter> <parameter name="connect_flags"> -<parameter_description> a combination of #GConnnectFlags. +<parameter_description> a combination of #GConnectFlags. </parameter_description> </parameter> </parameters> @@ -27584,10 +32383,9 @@ connected, in contrast to g_signal_emit() and g_signal_emit_valist(). </description> <parameters> <parameter name="instance_and_params"> -<parameter_description> argument list for the signal emission. The first -element in the array is a #GValue for the instance the signal is -being emitted on. The rest are any arguments to be passed to the -signal. +<parameter_description> argument list for the signal emission. +The first element in the array is a #GValue for the instance the signal +is being emitted on. The rest are any arguments to be passed to the signal. </parameter_description> </parameter> <parameter name="signal_id"> @@ -27618,7 +32416,7 @@ Returns the invocation hint of the innermost signal emission of instance. </parameter_description> </parameter> </parameters> -<return> the invocation hint of the innermost signal emission. +<return> the invocation hint of the innermost signal emission. </return> </function> @@ -28026,6 +32824,9 @@ in their <code>class_init</code> method by doing <code>super_class->signal_handler = my_signal_handler</code>. Instead they will have to use g_signal_override_class_handler(). +If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as +the marshaller for this signal. + </description> <parameters> @@ -28059,8 +32860,8 @@ not associate a class method slot with this signal. </parameter_description> </parameter> <parameter name="c_marshaller"> -<parameter_description> the function to translate arrays of parameter values to -signal emissions into C language callback invocations. +<parameter_description> the function to translate arrays of parameter +values to signal emissions into C language callback invocations or %NULL. </parameter_description> </parameter> <parameter name="return_type"> @@ -28097,6 +32898,9 @@ g_signal_chain_from_overridden_handler(). See g_signal_new() for information about signal names. +If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as +the marshaller for this signal. + Since: 2.18 </description> @@ -28131,8 +32935,8 @@ not associate a class method with this signal. </parameter_description> </parameter> <parameter name="c_marshaller"> -<parameter_description> the function to translate arrays of parameter values to -signal emissions into C language callback invocations. +<parameter_description> the function to translate arrays of parameter +values to signal emissions into C language callback invocations or %NULL. </parameter_description> </parameter> <parameter name="return_type"> @@ -28160,6 +32964,9 @@ Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. +If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as +the marshaller for this signal. + </description> <parameters> @@ -28191,8 +32998,8 @@ the default handler is to be invoked. You should at least specify </parameter_description> </parameter> <parameter name="c_marshaller"> -<parameter_description> the function to translate arrays of parameter values to -signal emissions into C language callback invocations. +<parameter_description> the function to translate arrays of parameter +values to signal emissions into C language callback invocations or %NULL. </parameter_description> </parameter> <parameter name="return_type"> @@ -28219,6 +33026,9 @@ Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. +If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as +the marshaller for this signal. + </description> <parameters> @@ -28238,7 +33048,8 @@ the default handler is to be invoked. You should at least specify </parameter_description> </parameter> <parameter name="class_closure"> -<parameter_description> The closure to invoke on signal emission; may be %NULL +<parameter_description> The closure to invoke on signal emission; +may be %NULL </parameter_description> </parameter> <parameter name="accumulator"> @@ -28250,8 +33061,9 @@ the default handler is to be invoked. You should at least specify </parameter_description> </parameter> <parameter name="c_marshaller"> -<parameter_description> the function to translate arrays of parameter values to -signal emissions into C language callback invocations +<parameter_description> the function to translate arrays of +parameter values to signal emissions into C language callback +invocations or %NULL </parameter_description> </parameter> <parameter name="return_type"> @@ -28264,7 +33076,8 @@ without a return value </parameter_description> </parameter> <parameter name="param_types"> -<parameter_description> an array of types, one for each parameter +<parameter_description> an array of types, one for +each parameter </parameter_description> </parameter> </parameters> @@ -28382,8 +33195,8 @@ be considered constant and have to be left untouched. </parameter_description> </parameter> <parameter name="query"> -<parameter_description> A user provided structure that is filled in with constant -values upon success. +<parameter_description> A user provided structure that is +filled in with constant values upon success. </parameter_description> </parameter> </parameters> @@ -28481,6 +33294,278 @@ structure which is to be invoked by the new closure </return> </function> +<function name="g_slice_alloc"> +<description> +Allocates a block of memory from the slice allocator. +The block adress handed out can be expected to be aligned +to at least <literal>1 * sizeof (void*)</literal>, +though in general slices are 2 * sizeof (void*) bytes aligned, +if a malloc() fallback implementation is used instead, +the alignment may be reduced in a libc dependent fashion. +Note that the underlying slice allocation mechanism can +be changed with the <link linkend="G_SLICE">G_SLICE=always-malloc</link> +environment variable. + +Since: 2.10 + +</description> +<parameters> +<parameter name="block_size"> +<parameter_description> the number of bytes to allocate +</parameter_description> +</parameter> +</parameters> +<return> a pointer to the allocated memory block + +</return> +</function> + +<function name="g_slice_alloc0"> +<description> +Allocates a block of memory via g_slice_alloc() and initializes +the returned memory to 0. Note that the underlying slice allocation +mechanism can be changed with the +<link linkend="G_SLICE">G_SLICE=always-malloc</link> +environment variable. + +Since: 2.10 + +</description> +<parameters> +<parameter name="block_size"> +<parameter_description> the number of bytes to allocate +</parameter_description> +</parameter> +</parameters> +<return> a pointer to the allocated block + +</return> +</function> + +<function name="g_slice_copy"> +<description> +Allocates a block of memory from the slice allocator +and copies @block_size bytes into it from @mem_block. + +Since: 2.14 + +</description> +<parameters> +<parameter name="block_size"> +<parameter_description> the number of bytes to allocate +</parameter_description> +</parameter> +<parameter name="mem_block"> +<parameter_description> the memory to copy +</parameter_description> +</parameter> +</parameters> +<return> a pointer to the allocated memory block + +</return> +</function> + +<function name="g_slice_dup"> +<description> +A convenience macro to duplicate a block of memory using +the slice allocator. + +It calls g_slice_copy() with <literal>sizeof (@type)</literal> +and casts the returned pointer to a pointer of the given type, +avoiding a type cast in the source code. +Note that the underlying slice allocation mechanism can +be changed with the <link linkend="G_SLICE">G_SLICE=always-malloc</link> +environment variable. + +Since: 2.14 + +</description> +<parameters> +<parameter name="type"> +<parameter_description> the type to duplicate, typically a structure name +</parameter_description> +</parameter> +<parameter name="mem"> +<parameter_description> the memory to copy into the allocated block +</parameter_description> +</parameter> +</parameters> +<return> a pointer to the allocated block, cast to a pointer to @type + +</return> +</function> + +<function name="g_slice_free"> +<description> +A convenience macro to free a block of memory that has +been allocated from the slice allocator. + +It calls g_slice_free1() using <literal>sizeof (type)</literal> +as the block size. +Note that the exact release behaviour can be changed with the +<link linkend="G_DEBUG">G_DEBUG=gc-friendly</link> environment +variable, also see <link linkend="G_SLICE">G_SLICE</link> for +related debugging options. + +Since: 2.10 + +</description> +<parameters> +<parameter name="type"> +<parameter_description> the type of the block to free, typically a structure name +</parameter_description> +</parameter> +<parameter name="mem"> +<parameter_description> a pointer to the block to free +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_slice_free1"> +<description> +Frees a block of memory. + +The memory must have been allocated via g_slice_alloc() or +g_slice_alloc0() and the @block_size has to match the size +specified upon allocation. Note that the exact release behaviour +can be changed with the +<link linkend="G_DEBUG">G_DEBUG=gc-friendly</link> environment +variable, also see <link linkend="G_SLICE">G_SLICE</link> for +related debugging options. + +Since: 2.10 + +</description> +<parameters> +<parameter name="block_size"> +<parameter_description> the size of the block +</parameter_description> +</parameter> +<parameter name="mem_block"> +<parameter_description> a pointer to the block to free +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_slice_free_chain"> +<description> +Frees a linked list of memory blocks of structure type @type. +The memory blocks must be equal-sized, allocated via +g_slice_alloc() or g_slice_alloc0() and linked together by +a @next pointer (similar to #GSList). The name of the +@next field in @type is passed as third argument. +Note that the exact release behaviour can be changed with the +<link linkend="G_DEBUG">G_DEBUG=gc-friendly</link> environment +variable, also see <link linkend="G_SLICE">G_SLICE</link> for +related debugging options. + +Since: 2.10 + +</description> +<parameters> +<parameter name="type"> +<parameter_description> the type of the @mem_chain blocks +</parameter_description> +</parameter> +<parameter name="mem_chain"> +<parameter_description> a pointer to the first block of the chain +</parameter_description> +</parameter> +<parameter name="next"> +<parameter_description> the field name of the next pointer in @type +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_slice_free_chain_with_offset"> +<description> +Frees a linked list of memory blocks of structure type @type. + +The memory blocks must be equal-sized, allocated via +g_slice_alloc() or g_slice_alloc0() and linked together by a +@next pointer (similar to #GSList). The offset of the @next +field in each block is passed as third argument. +Note that the exact release behaviour can be changed with the +<link linkend="G_DEBUG">G_DEBUG=gc-friendly</link> environment +variable, also see <link linkend="G_SLICE">G_SLICE</link> for +related debugging options. + +Since: 2.10 + +</description> +<parameters> +<parameter name="block_size"> +<parameter_description> the size of the blocks +</parameter_description> +</parameter> +<parameter name="mem_chain"> +<parameter_description> a pointer to the first block of the chain +</parameter_description> +</parameter> +<parameter name="next_offset"> +<parameter_description> the offset of the @next field in the blocks +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_slice_new"> +<description> +A convenience macro to allocate a block of memory from the +slice allocator. + +It calls g_slice_alloc() with <literal>sizeof (@type)</literal> +and casts the returned pointer to a pointer of the given type, +avoiding a type cast in the source code. +Note that the underlying slice allocation mechanism can +be changed with the <link linkend="G_SLICE">G_SLICE=always-malloc</link> +environment variable. + +Since: 2.10 + +</description> +<parameters> +<parameter name="type"> +<parameter_description> the type to allocate, typically a structure name +</parameter_description> +</parameter> +</parameters> +<return> a pointer to the allocated block, cast to a pointer to @type + +</return> +</function> + +<function name="g_slice_new0"> +<description> +A convenience macro to allocate a block of memory from the +slice allocator and set the memory to 0. + +It calls g_slice_alloc0() with <literal>sizeof (@type)</literal> +and casts the returned pointer to a pointer of the given type, +avoiding a type cast in the source code. +Note that the underlying slice allocation mechanism can +be changed with the <link linkend="G_SLICE">G_SLICE=always-malloc</link> +environment variable. + +Since: 2.10 + +</description> +<parameters> +<parameter name="type"> +<parameter_description> the type to allocate, typically a structure name +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_slist_alloc"> <description> Allocates space for one #GSList element. It is called by the @@ -28980,24 +34065,6 @@ is off the end of the #GSList </return> </function> -<function name="g_slist_pop_allocator"> -<description> -Restores the previous #GAllocator, used when allocating #GSList -elements. - -Note that this function is not available if GLib has been compiled -with <option>--disable-mem-pools</option> - -Deprecated: 2.10: It does nothing, since #GSList has been converted -to the <link linkend="glib-Memory-Slices">slice -allocator</link> - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_slist_position"> <description> Gets the position of the given element @@ -29052,28 +34119,6 @@ list = g_slist_prepend (list, "first"); </return> </function> -<function name="g_slist_push_allocator"> -<description> -Sets the allocator to use to allocate #GSList elements. Use -g_slist_pop_allocator() to restore the previous allocator. - -Note that this function is not available if GLib has been compiled -with <option>--disable-mem-pools</option> - -Deprecated: 2.10: It does nothing, since #GSList has been converted -to the <link linkend="glib-Memory-Slices">slice -allocator</link> - -</description> -<parameters> -<parameter name="dummy"> -<parameter_description> the #GAllocator to use when allocating #GSList elements. -</parameter_description> -</parameter> -</parameters> -<return></return> -</function> - <function name="g_slist_remove"> <description> Removes an element from a #GSList. @@ -29377,19 +34422,16 @@ Calling this function on a destroyed source is an error. </parameter_description> </parameter> </parameters> -<return> the #GMainContext with which the source is associated, -or %NULL if the context has not yet been added -to a source. +<return> the #GMainContext with which the +source is associated, or %NULL if the context has not +yet been added to a source. </return> </function> <function name="g_source_get_current_time"> <description> -Gets the "current time" to be used when checking -this source. The advantage of calling this function over -calling g_get_current_time() directly is that when -checking multiple sources, GLib can cache a single value -instead of having to repeatedly get the system time. +This function ignores @source and is otherwise the same as +g_get_current_time(). Deprecated: 2.28: use g_source_get_time() instead @@ -29504,7 +34546,7 @@ GDK_THREADS_ENTER (<!-- -->); self->idle_id = 0; GDK_THREADS_LEAVE (<!-- -->); -return FALSE; +return G_SOURCE_REMOVE; } static void @@ -29982,7 +35024,7 @@ reference when you don't need it any more. <note><para> If you are writing a GTK+ application, and the program you are spawning is a graphical application, too, then you may -want to use gdk_spawn_on_screen() instead to ensure that +want to use gdk_spawn_on_screen() instead to ensure that the spawned program opens its windows on the right screen. </para></note> @@ -30041,6 +35083,10 @@ argument vector for the child. The first string in @argv is of course the name of the program to execute. By default, the name of the program must be a full path; the <envar>PATH</envar> shell variable will only be searched if you pass the %G_SPAWN_SEARCH_PATH flag. +If the program name is not a full path and %G_SPAWN_SEARCH_PATH flag is not +used, then the program will be run from the current directory (or +@working_directory, if specified); this might be unexpected or even +dangerous in some cases when the current directory is world-writable. On Windows, note that all the string or string vector arguments to this function and the other g_spawn*() functions are in UTF-8, the @@ -30087,16 +35133,15 @@ the child's environment. If @envp is %NULL, the child inherits its parent's environment. @flags should be the bitwise OR of any flags you want to affect the -function's behaviour. The %G_SPAWN_DO_NOT_REAP_CHILD means that -the child will not automatically be reaped; you must use a -#GChildWatch source to be notified about the death of the child -process. Eventually you must call g_spawn_close_pid() on the -@child_pid, in order to free resources which may be associated -with the child process. (On Unix, using a #GChildWatch source is -equivalent to calling waitpid() or handling the %SIGCHLD signal -manually. On Windows, calling g_spawn_close_pid() is equivalent -to calling CloseHandle() on the process handle returned in -@child_pid). +function's behaviour. The %G_SPAWN_DO_NOT_REAP_CHILD means that the +child will not automatically be reaped; you must use a child watch to +be notified about the death of the child process. Eventually you must +call g_spawn_close_pid() on the @child_pid, in order to free +resources which may be associated with the child process. (On Unix, +using a child watch is equivalent to calling waitpid() or handling +the <literal>SIGCHLD</literal> signal manually. On Windows, calling g_spawn_close_pid() +is equivalent to calling CloseHandle() on the process handle returned +in @child_pid). See g_child_watch_add(). %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file descriptors will be inherited by the child; otherwise all @@ -30178,7 +35223,7 @@ process reference must be closed using g_spawn_close_pid(). <note><para> If you are writing a GTK+ application, and the program you are spawning is a graphical application, too, then you may -want to use gdk_spawn_on_screen_with_pipes() instead to ensure that +want to use gdk_spawn_on_screen_with_pipes() instead to ensure that the spawned program opens its windows on the right screen. </para></note> @@ -30490,6 +35535,8 @@ freed, you should also free the #GStaticMutex. <note><para>Calling g_static_mutex_free() on a locked mutex may result in undefined behaviour.</para></note> +Deprecated: 2.32: Use g_mutex_free() + </description> <parameters> <parameter name="mutex"> @@ -30506,6 +35553,8 @@ For some operations (like g_cond_wait()) you must have a #GMutex instead of a #GStaticMutex. This function will return the corresponding #GMutex for @mutex. +Deprecated: 2.32: Just use a #GMutex + </description> <parameters> <parameter name="mutex"> @@ -30519,8 +35568,10 @@ corresponding #GMutex for @mutex. <function name="g_static_mutex_init"> <description> -Initializes @mutex. Alternatively you can initialize it with -#G_STATIC_MUTEX_INIT. +Initializes @mutex. +Alternatively you can initialize it with #G_STATIC_MUTEX_INIT. + +Deprecated: 2.32: Use g_mutex_init() </description> <parameters> @@ -30536,6 +35587,8 @@ Initializes @mutex. Alternatively you can initialize it with <description> Works like g_mutex_lock(), but for a #GStaticMutex. +Deprecated: 2.32: Use g_mutex_lock() + </description> <parameters> <parameter name="mutex"> @@ -30550,6 +35603,8 @@ Works like g_mutex_lock(), but for a #GStaticMutex. <description> Works like g_mutex_trylock(), but for a #GStaticMutex. +Deprecated: 2.32: Use g_mutex_trylock() + </description> <parameters> <parameter name="mutex"> @@ -30565,6 +35620,8 @@ Works like g_mutex_trylock(), but for a #GStaticMutex. <description> Works like g_mutex_unlock(), but for a #GStaticMutex. +Deprecated: 2.32: Use g_mutex_unlock() + </description> <parameters> <parameter name="mutex"> @@ -30587,7 +35644,7 @@ freed, you should also free the #GStaticPrivate. </description> <parameters> <parameter name="private_key"> -<parameter_description> a #GStaticPrivate to be freed. +<parameter_description> a #GStaticPrivate to be freed </parameter_description> </parameter> </parameters> @@ -30600,14 +35657,15 @@ Works like g_private_get() only for a #GStaticPrivate. This function works even if g_thread_init() has not yet been called. + </description> <parameters> <parameter name="private_key"> -<parameter_description> a #GStaticPrivate. +<parameter_description> a #GStaticPrivate </parameter_description> </parameter> </parameters> -<return> the corresponding pointer. +<return> the corresponding pointer </return> </function> @@ -30619,7 +35677,7 @@ Initializes @private_key. Alternatively you can initialize it with </description> <parameters> <parameter name="private_key"> -<parameter_description> a #GStaticPrivate to be initialized. +<parameter_description> a #GStaticPrivate to be initialized </parameter_description> </parameter> </parameters> @@ -30644,16 +35702,16 @@ g_private_new().</para></note> </description> <parameters> <parameter name="private_key"> -<parameter_description> a #GStaticPrivate. +<parameter_description> a #GStaticPrivate </parameter_description> </parameter> <parameter name="data"> -<parameter_description> the new pointer. +<parameter_description> the new pointer </parameter_description> </parameter> <parameter name="notify"> <parameter_description> a function to be called with the pointer whenever the -current thread ends or sets this pointer again. +current thread ends or sets this pointer again </parameter_description> </parameter> </parameters> @@ -30669,6 +35727,8 @@ unbounded lifetime, i.e. objects declared 'static', but if you have a #GStaticRecMutex as a member of a structure and the structure is freed, you should also free the #GStaticRecMutex. +Deprecated: 2.32: Use g_rec_mutex_clear() + </description> <parameters> <parameter name="mutex"> @@ -30685,6 +35745,8 @@ A #GStaticRecMutex must be initialized with this function before it can be used. Alternatively you can initialize it with #G_STATIC_REC_MUTEX_INIT. +Deprecated: 2.32: Use g_rec_mutex_init() + </description> <parameters> <parameter name="mutex"> @@ -30702,6 +35764,8 @@ current thread will block until @mutex is unlocked by the other thread. If @mutex is already locked by the calling thread, this functions increases the depth of @mutex and returns immediately. +Deprecated: 2.32: Use g_rec_mutex_lock() + </description> <parameters> <parameter name="mutex"> @@ -30716,6 +35780,8 @@ functions increases the depth of @mutex and returns immediately. <description> Works like calling g_static_rec_mutex_lock() for @mutex @depth times. +Deprecated: 2.32: Use g_rec_mutex_lock() + </description> <parameters> <parameter name="mutex"> @@ -30739,6 +35805,8 @@ it immediately returns %FALSE. Otherwise it locks @mutex and returns functions increases the depth of @mutex and immediately returns %TRUE. +Deprecated: 2.32: Use g_rec_mutex_trylock() + </description> <parameters> <parameter name="mutex"> @@ -30758,6 +35826,8 @@ before. If @mutex is completely unlocked and another thread is blocked in a g_static_rec_mutex_lock() call for @mutex, it will be woken and can lock @mutex itself. +Deprecated: 2.32: Use g_rec_mutex_unlock() + </description> <parameters> <parameter name="mutex"> @@ -30778,6 +35848,8 @@ before the call to g_static_rec_mutex_unlock_full() you can call g_static_rec_mutex_lock_full() with the depth returned by this function. +Deprecated: 2.32: Use g_rec_mutex_unlock() + </description> <parameters> <parameter name="mutex"> @@ -30799,6 +35871,8 @@ unbounded lifetime, i.e. objects declared 'static', but if you have a #GStaticRWLock as a member of a structure, and the structure is freed, you should also free the #GStaticRWLock. +Deprecated: 2.32: Use a #GRWLock instead + </description> <parameters> <parameter name="lock"> @@ -30815,6 +35889,8 @@ A #GStaticRWLock must be initialized with this function before it can be used. Alternatively you can initialize it with #G_STATIC_RW_LOCK_INIT. +Deprecated: 2.32: Use g_rw_lock_init() instead + </description> <parameters> <parameter name="lock"> @@ -30839,6 +35915,8 @@ g_static_rw_lock_reader_unlock(). recursively lock for reading, but that can result in a deadlock, due to writer preference. +Deprecated: 2.32: Use g_rw_lock_reader_lock() instead + </description> <parameters> <parameter name="lock"> @@ -30857,6 +35935,8 @@ lock @lock for writing, immediately returns %FALSE. Otherwise locks @lock for reading and returns %TRUE. This lock has to be unlocked by g_static_rw_lock_reader_unlock(). +Deprectated: 2.32: Use g_rw_lock_reader_trylock() instead + </description> <parameters> <parameter name="lock"> @@ -30874,6 +35954,8 @@ Unlocks @lock. If a thread waits to lock @lock for writing and all locks for reading have been unlocked, the waiting thread is woken up and can lock @lock for writing. +Deprectated: 2.32: Use g_rw_lock_reader_unlock() instead + </description> <parameters> <parameter name="lock"> @@ -30894,6 +35976,8 @@ reading. When @lock is locked for writing, no other thread can lock @lock (neither for reading nor writing). This lock has to be unlocked by g_static_rw_lock_writer_unlock(). +Deprectated: 2.32: Use g_rw_lock_writer_lock() instead + </description> <parameters> <parameter name="lock"> @@ -30911,6 +35995,8 @@ either reading or writing) by another thread, it immediately returns %FALSE. Otherwise it locks @lock for writing and returns %TRUE. This lock has to be unlocked by g_static_rw_lock_writer_unlock(). +Deprectated: 2.32: Use g_rw_lock_writer_trylock() instead + </description> <parameters> <parameter name="lock"> @@ -30931,6 +36017,8 @@ lock @lock for writing, and some thread or threads are waiting to lock @lock for reading, the waiting threads are woken up and can lock @lock for reading. +Deprectated: 2.32: Use g_rw_lock_writer_unlock() instead + </description> <parameters> <parameter name="lock"> @@ -30968,7 +36056,8 @@ without having to repeatedly scan for the end. <description> Compares two strings for byte-by-byte equality and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the -@key_equal_func parameter, when using strings as keys in a #GHashTable. +@key_equal_func parameter, when using non-%NULL strings as keys in a +#GHashTable. Note that this function is primarily meant as a hash table comparison function. For a general-purpose, %NULL-safe string comparison function, @@ -30999,11 +36088,11 @@ Since: 2.2 </description> <parameters> <parameter name="str"> -<parameter_description> a nul-terminated string. +<parameter_description> a nul-terminated string </parameter_description> </parameter> <parameter name="prefix"> -<parameter_description> the nul-terminated prefix to look for. +<parameter_description> the nul-terminated prefix to look for </parameter_description> </parameter> </parameters> @@ -31021,11 +36110,11 @@ Since: 2.2 </description> <parameters> <parameter name="str"> -<parameter_description> a nul-terminated string. +<parameter_description> a nul-terminated string </parameter_description> </parameter> <parameter name="suffix"> -<parameter_description> the nul-terminated suffix to look for. +<parameter_description> the nul-terminated suffix to look for </parameter_description> </parameter> </parameters> @@ -31045,7 +36134,7 @@ string, is updated: <literal>hash = hash * 33 + c</literal>. This function uses the signed value of each byte. It can be passed to g_hash_table_new() as the @hash_func parameter, -when using strings as keys in a #GHashTable. +when using non-%NULL strings as keys in a #GHashTable. </description> @@ -31059,6 +36148,36 @@ when using strings as keys in a #GHashTable. </return> </function> +<function name="g_strcanon"> +<description> +For each character in @string, if the character is not in +@valid_chars, replaces the character with @substitutor. +Modifies @string in place, and return @string itself, not +a copy. The return value is to allow nesting such as +|[ +g_ascii_strup (g_strcanon (str, "abc", '?')) +]| + + +</description> +<parameters> +<parameter name="string"> +<parameter_description> a nul-terminated array of bytes +</parameter_description> +</parameter> +<parameter name="valid_chars"> +<parameter_description> bytes permitted in @string +</parameter_description> +</parameter> +<parameter name="substitutor"> +<parameter_description> replacement character for disallowed bytes +</parameter_description> +</parameter> +</parameters> +<return> @string +</return> +</function> + <function name="g_strcasecmp"> <description> A case-insensitive string comparison, corresponding to the standard @@ -31084,6 +36203,51 @@ or a positive value if @s1 > @s2. </return> </function> +<function name="g_strchomp"> +<description> +Removes trailing whitespace from a string. + +This function doesn't allocate or reallocate any memory; +it modifies @string in place. The pointer to @string is +returned to allow the nesting of functions. + +Also see g_strchug() and g_strstrip(). + + +</description> +<parameters> +<parameter name="string"> +<parameter_description> a string to remove the trailing whitespace from +</parameter_description> +</parameter> +</parameters> +<return> @string. +</return> +</function> + +<function name="g_strchug"> +<description> +Removes leading whitespace from a string, by moving the rest +of the characters forward. + +This function doesn't allocate or reallocate any memory; +it modifies @string in place. The pointer to @string is +returned to allow the nesting of functions. + +Also see g_strchomp() and g_strstrip(). + + +</description> +<parameters> +<parameter name="string"> +<parameter_description> a string to remove the leading whitespace from +</parameter_description> +</parameter> +</parameters> +<return> @string +</return> +</function> + <function name="g_strcmp0"> <description> Compares @str1 and @str2 like strcmp(). Handles %NULL @@ -31108,6 +36272,25 @@ Since: 2.16 </return> </function> +<function name="g_strcompress"> +<description> +Replaces all escaped characters with their one byte equivalent. + +This function does the reverse conversion of g_strescape(). + + +</description> +<parameters> +<parameter name="source"> +<parameter_description> a string to compress +</parameter_description> +</parameter> +</parameters> +<return> a newly-allocated copy of @source with all escaped +character compressed +</return> +</function> + <function name="g_strconcat"> <description> Concatenates all of the given strings into one long string. @@ -31137,6 +36320,38 @@ random memory junk to your string.</para></warning> </return> </function> +<function name="g_strdelimit"> +<description> +Converts any delimiter characters in @string to @new_delimiter. +Any characters in @string which are found in @delimiters are +changed to the @new_delimiter character. Modifies @string in place, +and returns @string itself, not a copy. The return value is to +allow nesting such as +|[ +g_ascii_strup (g_strdelimit (str, "abc", '?')) +]| + + +</description> +<parameters> +<parameter name="string"> +<parameter_description> the string to convert +</parameter_description> +</parameter> +<parameter name="delimiters"> +<parameter_description> a string containing the current delimiters, or %NULL +to use the standard delimiters defined in #G_STR_DELIMITERS +</parameter_description> +</parameter> +<parameter name="new_delimiter"> +<parameter_description> the new delimiter character +</parameter_description> +</parameter> +</parameters> +<return> @string +</return> +</function> + <function name="g_strdown"> <description> Converts a string to lower case. @@ -31256,7 +36471,7 @@ on a %NULL value, g_strdupv() simply returns %NULL. </description> <parameters> <parameter name="str_array"> -<parameter_description> %NULL-terminated array of strings. +<parameter_description> a %NULL-terminated array of strings </parameter_description> </parameter> </parameters> @@ -31281,8 +36496,35 @@ documentation </parameter> </parameters> <return> a UTF-8 string describing the error code. If the error code -is unknown, it returns "unknown error (<code>)". The string -can only be used until the next call to g_strerror() +is unknown, it returns "unknown error (<code>)". +</return> +</function> + +<function name="g_strescape"> +<description> +Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\' +and '"' in the string @source by inserting a '\' before +them. Additionally all characters in the range 0x01-0x1F (everything +below SPACE) and in the range 0x7F-0xFF (all non-ASCII chars) are +replaced with a '\' followed by their octal representation. +Characters supplied in @exceptions are not escaped. + +g_strcompress() does the reverse conversion. + + +</description> +<parameters> +<parameter name="source"> +<parameter_description> a string to escape +</parameter_description> +</parameter> +<parameter name="exceptions"> +<parameter_description> a string of characters not to escape in @source +</parameter_description> +</parameter> +</parameters> +<return> a newly-allocated copy of @source with certain +characters escaped. See above. </return> </function> @@ -31294,7 +36536,7 @@ If called on a %NULL value, g_strfreev() simply returns. </description> <parameters> <parameter name="str_array"> -<parameter_description> a %NULL-terminated array of strings to free. +<parameter_description> a %NULL-terminated array of strings to free </parameter_description> </parameter> </parameters> @@ -31303,7 +36545,7 @@ If called on a %NULL value, g_strfreev() simply returns. <function name="g_string_append"> <description> -Adds a string onto the end of a #GString, expanding +Adds a string onto the end of a #GString, expanding it if necessary. @@ -31324,7 +36566,7 @@ it if necessary. <function name="g_string_append_c"> <description> -Adds a byte onto the end of a #GString, expanding +Adds a byte onto the end of a #GString, expanding it if necessary. @@ -31345,12 +36587,12 @@ it if necessary. <function name="g_string_append_len"> <description> -Appends @len bytes of @val to @string. Because @len is -provided, @val may contain embedded nuls and need not +Appends @len bytes of @val to @string. Because @len is +provided, @val may contain embedded nuls and need not be nul-terminated. -Since this function does not stop at nul bytes, it is -the caller's responsibility to ensure that @val has at +Since this function does not stop at nul bytes, it is +the caller's responsibility to ensure that @val has at least @len addressable bytes. @@ -31376,7 +36618,7 @@ least @len addressable bytes. <function name="g_string_append_printf"> <description> Appends a formatted string onto the end of a #GString. -This function is similar to g_string_printf() except +This function is similar to g_string_printf() except that the text is appended to the #GString. </description> @@ -31436,7 +36678,8 @@ Since: 2.16 </parameter_description> </parameter> <parameter name="reserved_chars_allowed"> -<parameter_description> a string of reserved characters allowed to be used, or %NULL +<parameter_description> a string of reserved characters allowed +to be used, or %NULL </parameter_description> </parameter> <parameter name="allow_utf8"> @@ -31478,7 +36721,7 @@ Since: 2.14 <function name="g_string_ascii_down"> <description> -Converts all upper case ASCII letters to lower case ASCII letters. +Converts all uppercase ASCII letters to lowercase ASCII letters. </description> @@ -31488,15 +36731,15 @@ Converts all upper case ASCII letters to lower case ASCII letters. </parameter_description> </parameter> </parameters> -<return> passed-in @string pointer, with all the upper case -characters converted to lower case in place, with -semantics that exactly match g_ascii_tolower(). +<return> passed-in @string pointer, with all the +uppercase characters converted to lowercase in place, +with semantics that exactly match g_ascii_tolower(). </return> </function> <function name="g_string_ascii_up"> <description> -Converts all lower case ASCII letters to upper case ASCII letters. +Converts all lowercase ASCII letters to uppercase ASCII letters. </description> @@ -31506,24 +36749,24 @@ Converts all lower case ASCII letters to upper case ASCII letters. </parameter_description> </parameter> </parameters> -<return> passed-in @string pointer, with all the lower case -characters converted to upper case in place, with -semantics that exactly match g_ascii_toupper(). +<return> passed-in @string pointer, with all the +lowercase characters converted to uppercase in place, +with semantics that exactly match g_ascii_toupper(). </return> </function> <function name="g_string_assign"> <description> -Copies the bytes from a string into a #GString, -destroying any previous contents. It is rather like -the standard strcpy() function, except that you do not +Copies the bytes from a string into a #GString, +destroying any previous contents. It is rather like +the standard strcpy() function, except that you do not have to worry about having enough space to copy the string. </description> <parameters> <parameter name="string"> -<parameter_description> the destination #GString. Its current contents +<parameter_description> the destination #GString. Its current contents are destroyed. </parameter_description> </parameter> @@ -31563,7 +36806,7 @@ access any of the strings which were contained within it. </description> <parameters> <parameter name="chunk"> -<parameter_description> a #GStringChunk +<parameter_description> a #GStringChunk </parameter_description> </parameter> </parameters> @@ -31573,15 +36816,15 @@ access any of the strings which were contained within it. <function name="g_string_chunk_insert"> <description> Adds a copy of @string to the #GStringChunk. -It returns a pointer to the new copy of the string -in the #GStringChunk. The characters in the string -can be changed, if necessary, though you should not +It returns a pointer to the new copy of the string +in the #GStringChunk. The characters in the string +can be changed, if necessary, though you should not change anything after the end of the string. -Unlike g_string_chunk_insert_const(), this function -does not check for duplicates. Also strings added -with g_string_chunk_insert() will not be searched -by g_string_chunk_insert_const() when looking for +Unlike g_string_chunk_insert_const(), this function +does not check for duplicates. Also strings added +with g_string_chunk_insert() will not be searched +by g_string_chunk_insert_const() when looking for duplicates. @@ -31596,7 +36839,7 @@ duplicates. </parameter_description> </parameter> </parameters> -<return> a pointer to the copy of @string within +<return> a pointer to the copy of @string within the #GStringChunk </return> </function> @@ -31671,15 +36914,15 @@ nul-terminated string <function name="g_string_chunk_new"> <description> -Creates a new #GStringChunk. +Creates a new #GStringChunk. </description> <parameters> <parameter name="size"> -<parameter_description> the default size of the blocks of memory which are -allocated to store the strings. If a particular string -is larger than this default size, a larger block of +<parameter_description> the default size of the blocks of memory which are +allocated to store the strings. If a particular string +is larger than this default size, a larger block of memory will be allocated for it. </parameter_description> </parameter> @@ -31692,8 +36935,8 @@ memory will be allocated for it. <description> Converts a #GString to lowercase. -Deprecated:2.2: This function uses the locale-specific -tolower() function, which is almost never the right thing. +Deprecated:2.2: This function uses the locale-specific +tolower() function, which is almost never the right thing. Use g_string_ascii_down() or g_utf8_strdown() instead. </description> @@ -31703,14 +36946,14 @@ Use g_string_ascii_down() or g_utf8_strdown() instead. </parameter_description> </parameter> </parameters> -<return> the #GString. +<return> the #GString </return> </function> <function name="g_string_equal"> <description> -Compares two strings for equality, returning %TRUE if they are equal. +Compares two strings for equality, returning %TRUE if they are equal. For use with #GHashTable. @@ -31725,7 +36968,7 @@ For use with #GHashTable. </parameter_description> </parameter> </parameters> -<return> %TRUE if they strings are the same length and contain the +<return> %TRUE if they strings are the same length and contain the same bytes </return> </function> @@ -31759,7 +37002,7 @@ following bytes <function name="g_string_free"> <description> Frees the memory allocated for the #GString. -If @free_segment is %TRUE it also frees the character data. If +If @free_segment is %TRUE it also frees the character data. If it's %FALSE, the caller gains ownership of the buffer and must free it after use with g_free(). @@ -31771,11 +37014,11 @@ free it after use with g_free(). </parameter_description> </parameter> <parameter name="free_segment"> -<parameter_description> if %TRUE the actual character data is freed as well +<parameter_description> if %TRUE, the actual character data is freed as well </parameter_description> </parameter> </parameters> -<return> the character data of @string +<return> the character data of @string (i.e. %NULL if @free_segment is %TRUE) </return> </function> @@ -31798,7 +37041,7 @@ Creates a hash code for @str; for use with #GHashTable. <function name="g_string_insert"> <description> -Inserts a copy of a string into a #GString, +Inserts a copy of a string into a #GString, expanding it if necessary. @@ -31894,8 +37137,8 @@ into the string at the given position. </parameter_description> </parameter> <parameter name="pos"> -<parameter_description> the position at which to insert character, or -1 to -append at the end of the string +<parameter_description> the position at which to insert character, or -1 +to append at the end of the string </parameter_description> </parameter> <parameter name="wc"> @@ -31925,12 +37168,12 @@ Creates a new #GString, initialized with the given string. <function name="g_string_new_len"> <description> -Creates a new #GString with @len bytes of the @init buffer. +Creates a new #GString with @len bytes of the @init buffer. Because a length is provided, @init need not be nul-terminated, and can contain embedded nul bytes. Since this function does not stop at nul bytes, it is the caller's -responsibility to ensure that @init has at least @len addressable +responsibility to ensure that @init has at least @len addressable bytes. @@ -31977,7 +37220,7 @@ Since: 2.14 <function name="g_string_overwrite_len"> <description> -Overwrites part of a string, lengthening it if necessary. +Overwrites part of a string, lengthening it if necessary. This function will work with embedded nuls. Since: 2.14 @@ -32008,7 +37251,7 @@ Since: 2.14 <function name="g_string_prepend"> <description> -Adds a string on to the start of a #GString, +Adds a string on to the start of a #GString, expanding it if necessary. @@ -32029,7 +37272,7 @@ expanding it if necessary. <function name="g_string_prepend_c"> <description> -Adds a byte onto the start of a #GString, +Adds a byte onto the start of a #GString, expanding it if necessary. @@ -32050,12 +37293,12 @@ expanding it if necessary. <function name="g_string_prepend_len"> <description> -Prepends @len bytes of @val to @string. -Because @len is provided, @val may contain +Prepends @len bytes of @val to @string. +Because @len is provided, @val may contain embedded nuls and need not be nul-terminated. -Since this function does not stop at nul bytes, -it is the caller's responsibility to ensure that +Since this function does not stop at nul bytes, +it is the caller's responsibility to ensure that @val has at least @len addressable bytes. @@ -32103,8 +37346,8 @@ to the string. <description> Writes a formatted string into a #GString. This is similar to the standard sprintf() function, -except that the #GString buffer automatically expands -to contain the results. The previous contents of the +except that the #GString buffer automatically expands +to contain the results. The previous contents of the #GString are destroyed. </description> @@ -32131,7 +37374,7 @@ Sets the length of a #GString. If the length is less than the current length, the string will be truncated. If the length is greater than the current length, the contents of the newly added area are undefined. (However, as -always, string->str[string->len] will be a nul byte.) +always, string->str[string->len] will be a nul byte.) </description> @@ -32151,16 +37394,16 @@ always, string->str[string->len] will be a nul byte.) <function name="g_string_sized_new"> <description> -Creates a new #GString, with enough space for @dfl_size -bytes. This is useful if you are going to add a lot of -text to the string and don't want it to be reallocated +Creates a new #GString, with enough space for @dfl_size +bytes. This is useful if you are going to add a lot of +text to the string and don't want it to be reallocated too often. </description> <parameters> <parameter name="dfl_size"> -<parameter_description> the default size of the space allocated to +<parameter_description> the default size of the space allocated to hold the string </parameter_description> </parameter> @@ -32173,9 +37416,9 @@ hold the string <description> Writes a formatted string into a #GString. This is similar to the standard sprintf() function, -except that the #GString buffer automatically expands -to contain the results. The previous contents of the -#GString are destroyed. +except that the #GString buffer automatically expands +to contain the results. The previous contents of the +#GString are destroyed. Deprecated: This function has been renamed to g_string_printf(). @@ -32201,7 +37444,7 @@ Deprecated: This function has been renamed to g_string_printf(). <description> Appends a formatted string onto the end of a #GString. This function is similar to g_string_sprintf() except that -the text is appended to the #GString. +the text is appended to the #GString. Deprecated: This function has been renamed to g_string_append_printf() @@ -32225,7 +37468,7 @@ Deprecated: This function has been renamed to g_string_append_printf() <function name="g_string_truncate"> <description> -Cuts off the end of the GString, leaving the first @len bytes. +Cuts off the end of the GString, leaving the first @len bytes. </description> @@ -32247,14 +37490,14 @@ Cuts off the end of the GString, leaving the first @len bytes. <description> Converts a #GString to uppercase. -Deprecated:2.2: This function uses the locale-specific -toupper() function, which is almost never the right thing. +Deprecated:2.2: This function uses the locale-specific +toupper() function, which is almost never the right thing. Use g_string_ascii_up() or g_utf8_strup() instead. </description> <parameters> <parameter name="string"> -<parameter_description> a #GString +<parameter_description> a #GString </parameter_description> </parameter> </parameters> @@ -32265,8 +37508,8 @@ Use g_string_ascii_up() or g_utf8_strup() instead. <function name="g_string_vprintf"> <description> -Writes a formatted string into a #GString. -This function is similar to g_string_printf() except that +Writes a formatted string into a #GString. +This function is similar to g_string_printf() except that the arguments to the format string are passed as a va_list. Since: 2.14 @@ -32306,9 +37549,9 @@ Since: 2.4 </parameter_description> </parameter> </parameters> -<return> @msgval, unless @msgval is identical to @msgid and contains -a '|' character, in which case a pointer to the substring of msgid after -the first '|' character is returned. +<return> @msgval, unless @msgval is identical to @msgid +and contains a '|' character, in which case a pointer to +the substring of msgid after the first '|' character is returned. </return> </function> @@ -32560,11 +37803,11 @@ of the string @needle. </description> <parameters> <parameter name="haystack"> -<parameter_description> a nul-terminated string. +<parameter_description> a nul-terminated string </parameter_description> </parameter> <parameter name="needle"> -<parameter_description> the nul-terminated string to search for. +<parameter_description> the nul-terminated string to search for </parameter_description> </parameter> </parameters> @@ -32583,15 +37826,15 @@ to @haystack_len. </description> <parameters> <parameter name="haystack"> -<parameter_description> a nul-terminated string. +<parameter_description> a nul-terminated string </parameter_description> </parameter> <parameter name="haystack_len"> -<parameter_description> the maximum length of @haystack. +<parameter_description> the maximum length of @haystack </parameter_description> </parameter> <parameter name="needle"> -<parameter_description> the nul-terminated string to search for. +<parameter_description> the nul-terminated string to search for </parameter_description> </parameter> </parameters> @@ -32617,16 +37860,15 @@ documentation </parameter> </parameters> <return> a UTF-8 string describing the signal. If the signal is unknown, -it returns "unknown signal (<signum>)". The string can only be -used until the next call to g_strsignal() +it returns "unknown signal (<signum>)". </return> </function> <function name="g_strsplit"> <description> Splits a string into a maximum of @max_tokens pieces, using the given -@delimiter. If @max_tokens is reached, the remainder of @string is appended -to the last token. +@delimiter. If @max_tokens is reached, the remainder of @string is +appended to the last token. As a special case, the result of splitting the empty string "" is an empty vector, not a vector containing a single string. The reason for this @@ -32639,18 +37881,18 @@ before calling g_strsplit(). </description> <parameters> <parameter name="string"> -<parameter_description> a string to split. +<parameter_description> a string to split </parameter_description> </parameter> <parameter name="delimiter"> -<parameter_description> a string which specifies the places at which to split the string. -The delimiter is not included in any of the resulting strings, unless -@max_tokens is reached. +<parameter_description> a string which specifies the places at which to split +the string. The delimiter is not included in any of the resulting +strings, unless @max_tokens is reached. </parameter_description> </parameter> <parameter name="max_tokens"> -<parameter_description> the maximum number of pieces to split @string into. If this is -less than 1, the string is split completely. +<parameter_description> the maximum number of pieces to split @string into. +If this is less than 1, the string is split completely. </parameter_description> </parameter> </parameters> @@ -32718,7 +37960,7 @@ to @haystack_len. </description> <parameters> <parameter name="haystack"> -<parameter_description> a string. +<parameter_description> a string </parameter_description> </parameter> <parameter name="haystack_len"> @@ -32728,7 +37970,7 @@ search through the whole string. </parameter_description> </parameter> <parameter name="needle"> -<parameter_description> the string to search for. +<parameter_description> the string to search for </parameter_description> </parameter> </parameters> @@ -32737,6 +37979,23 @@ search through the whole string. </return> </function> +<function name="g_strstrip"> +<description> +Removes leading and trailing whitespace from a string. +See g_strchomp() and g_strchug(). + + +</description> +<parameters> +<parameter name="string"> +<parameter_description> a string to remove the leading and trailing whitespace from +</parameter_description> +</parameter> +</parameters> +<return> @string +</return> +</function> + <function name="g_strtod"> <description> Converts a string to a #gdouble value. @@ -32744,7 +38003,7 @@ It calls the standard strtod() function to handle the conversion, but if the string is not completely converted it attempts the conversion again with g_ascii_strtod(), and returns the best match. -This function should seldomly be used. The normal situation when reading +This function should seldom be used. The normal situation when reading numbers not for human consumption is to use g_ascii_strtod(). Only when you know that you must expect both locale formatted and C formatted numbers should you use this. Make sure that you don't pass strings such as comma @@ -32797,7 +38056,7 @@ Since: 2.6 </description> <parameters> <parameter name="str_array"> -<parameter_description> a %NULL-terminated array of strings. +<parameter_description> a %NULL-terminated array of strings </parameter_description> </parameter> </parameters> @@ -32929,7 +38188,7 @@ a test case changes the base URI for the scope of the test case only. Bug URIs are constructed by appending a bug specific URI portion to @uri_pattern, or by replacing the special string -'%s' within @uri_pattern if that is present. +'\%s' within @uri_pattern if that is present. Since: 2.16 @@ -32948,10 +38207,10 @@ Since: 2.16 Create a new #GTestCase, named @test_name, this API is fairly low level, calling g_test_add() or g_test_add_func() is preferable. When this test is executed, a fixture structure of size @data_size -will be allocated and filled with 0s. Then data_setup() is called +will be allocated and filled with 0s. Then @data_setup is called to initialize the fixture. After fixture setup, the actual test -function data_test() is called. Once the test run completed, the -fixture structure is torn down by calling data_teardown() and +function @data_test is called. Once the test run completed, the +fixture structure is torn down by calling @data_teardown and after that the memory is released. Splitting up a test run into fixture setup, test function and @@ -33084,7 +38343,7 @@ execute all tests matching <replaceable>TESTPATH</replaceable>. </para></listitem> </varlistentry> <varlistentry> -<term><option>-m {perf|slow|thorough|quick}</option></term> +<term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term> <listitem><para> execute tests according to these test modes: <variablelist> @@ -33107,6 +38366,20 @@ maximize coverage. quick tests, should run really quickly and give good coverage. </para></listitem> </varlistentry> +<varlistentry> +<term>undefined</term> +<listitem><para> +tests for undefined behaviour, may provoke programming errors +under g_test_trap_fork() to check that appropriate assertions +or warnings are given +</para></listitem> +</varlistentry> +<varlistentry> +<term>no-undefined</term> +<listitem><para> +avoid tests for undefined behaviour +</para></listitem> +</varlistentry> </variablelist> </para></listitem> </varlistentry> @@ -33310,9 +38583,21 @@ Since: 2.16 <return></return> </function> +<function name="g_test_perf"> +<description> +Returns %TRUE if tests are run in performance mode. + + +</description> +<parameters> +</parameters> +<return> %TRUE if in performance mode +</return> +</function> + <function name="g_test_queue_destroy"> <description> -This function enqueus a callback @destroy_func() to be executed +This function enqueus a callback @destroy_func to be executed during the next test case teardown phase. This is most useful to auto destruct allocted test resources at the end of a test run. Resources are released in reverse queue order, that means enqueueing @@ -33353,6 +38638,64 @@ Since: 2.16 <return></return> </function> +<function name="g_test_queue_unref"> +<description> +Enqueue an object to be released with g_object_unref() during +the next teardown phase. This is equivalent to calling +g_test_queue_destroy() with a destroy callback of g_object_unref(). + +Since: 2.16 + +</description> +<parameters> +<parameter name="gobject"> +<parameter_description> the object to unref +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_test_quick"> +<description> +Returns %TRUE if tests are run in quick mode. +Exactly one of g_test_quick() and g_test_slow() is active in any run; +there is no "medium speed". + + +</description> +<parameters> +</parameters> +<return> %TRUE if in quick mode +</return> +</function> + +<function name="g_test_quiet"> +<description> +Returns %TRUE if tests are run in quiet mode. +The default is neither g_test_verbose() nor g_test_quiet(). + + +</description> +<parameters> +</parameters> +<return> %TRUE if in quiet mode +</return> +</function> + +<function name="g_test_rand_bit"> +<description> +Get a reproducible random bit (0 or 1), see g_test_rand_int() +for details on test case random numbers. + +Since: 2.16 + +</description> +<parameters> +</parameters> +<return></return> +</function> + <function name="g_test_rand_double"> <description> Get a reproducible random floating point number, @@ -33479,6 +38822,20 @@ Since: 2.16 </return> </function> +<function name="g_test_slow"> +<description> +Returns %TRUE if tests are run in slow mode. +Exactly one of g_test_quick() and g_test_slow() is active in any run; +there is no "medium speed". + + +</description> +<parameters> +</parameters> +<return> the opposite of g_test_quick() +</return> +</function> + <function name="g_test_suite_add"> <description> Adds @test_case to @suite. @@ -33519,6 +38876,19 @@ Since: 2.16 <return></return> </function> +<function name="g_test_thorough"> +<description> +Returns %TRUE if tests are run in thorough mode, equivalent to +g_test_slow(). + + +</description> +<parameters> +</parameters> +<return> the same thing as g_test_slow() +</return> +</function> + <function name="g_test_timer_elapsed"> <description> Get the time since the last start of the timer with g_test_timer_start(). @@ -33560,6 +38930,116 @@ Since: 2.16 <return></return> </function> +<function name="g_test_trap_assert_failed"> +<description> +Assert that the last forked test failed. +See g_test_trap_fork(). + +This is sometimes used to test situations that are formally considered to +be undefined behaviour, like inputs that fail a g_return_if_fail() +check. In these situations you should skip the entire test, including the +call to g_test_trap_fork(), unless g_test_undefined() returns %TRUE +to indicate that undefined behaviour may be tested. + +Since: 2.16 + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="g_test_trap_assert_passed"> +<description> +Assert that the last forked test passed. +See g_test_trap_fork(). + +Since: 2.16 + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="g_test_trap_assert_stderr"> +<description> +Assert that the stderr output of the last forked test +matches @serrpattern. See g_test_trap_fork(). + +This is sometimes used to test situations that are formally considered to +be undefined behaviour, like inputs that fail a g_return_if_fail() +check. In these situations you should skip the entire test, including the +call to g_test_trap_fork(), unless g_test_undefined() returns %TRUE +to indicate that undefined behaviour may be tested. + +Since: 2.16 + +</description> +<parameters> +<parameter name="serrpattern"> +<parameter_description> a glob-style +<link linkend="glib-Glob-style-pattern-matching">pattern</link> +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_test_trap_assert_stderr_unmatched"> +<description> +Assert that the stderr output of the last forked test +does not match @serrpattern. See g_test_trap_fork(). + +Since: 2.16 + +</description> +<parameters> +<parameter name="serrpattern"> +<parameter_description> a glob-style +<link linkend="glib-Glob-style-pattern-matching">pattern</link> +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_test_trap_assert_stdout"> +<description> +Assert that the stdout output of the last forked test matches +@soutpattern. See g_test_trap_fork(). + +Since: 2.16 + +</description> +<parameters> +<parameter name="soutpattern"> +<parameter_description> a glob-style +<link linkend="glib-Glob-style-pattern-matching">pattern</link> +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_test_trap_assert_stdout_unmatched"> +<description> +Assert that the stdout output of the last forked test +does not match @soutpattern. See g_test_trap_fork(). + +Since: 2.16 + +</description> +<parameters> +<parameter name="soutpattern"> +<parameter_description> a glob-style +<link linkend="glib-Glob-style-pattern-matching">pattern</link> +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_test_trap_fork"> <description> Fork the current test program to execute a test case that might @@ -33637,13 +39117,37 @@ Since: 2.16 </return> </function> -<function name="g_thread_create"> +<function name="g_test_undefined"> <description> -This function creates a new thread with the default priority. +Returns %TRUE if tests may provoke assertions and other formally-undefined +behaviour under g_test_trap_fork(), to verify that appropriate warnings +are given. It can be useful to turn this off if running tests under +valgrind. + -If @joinable is %TRUE, you can wait for this threads termination -calling g_thread_join(). Otherwise the thread will just disappear -when it terminates. +</description> +<parameters> +</parameters> +<return> %TRUE if tests may provoke programming errors +</return> +</function> + +<function name="g_test_verbose"> +<description> +Returns %TRUE if tests are run in verbose mode. +The default is neither g_test_verbose() nor g_test_quiet(). + + +</description> +<parameters> +</parameters> +<return> %TRUE if in verbose mode +</return> +</function> + +<function name="g_thread_create"> +<description> +This function creates a new thread. The new thread executes the function @func with the argument @data. If the thread was created successfully, it is returned. @@ -33651,14 +39155,21 @@ If the thread was created successfully, it is returned. @error can be %NULL to ignore errors, or non-%NULL to report errors. The error is set, if and only if the function returns %NULL. +This function returns a reference to the created thread only if +@joinable is %TRUE. In that case, you must free this reference by +calling g_thread_unref() or g_thread_join(). If @joinable is %FALSE +then you should probably not touch the return value. + +Deprecated:2.32: Use g_thread_new() instead + </description> <parameters> <parameter name="func"> -<parameter_description> a function to execute in the new thread. +<parameter_description> a function to execute in the new thread </parameter_description> </parameter> <parameter name="data"> -<parameter_description> an argument to supply to the new thread. +<parameter_description> an argument to supply to the new thread </parameter_description> </parameter> <parameter name="joinable"> @@ -33666,46 +39177,21 @@ The error is set, if and only if the function returns %NULL. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> return location for error. +<parameter_description> return location for error, or %NULL </parameter_description> </parameter> </parameters> -<return> the new #GThread on success. +<return> the new #GThread on success + </return> </function> <function name="g_thread_create_full"> <description> -This function creates a new thread with the priority @priority. If -the underlying thread implementation supports it, the thread gets a -stack size of @stack_size or the default value for the current -platform, if @stack_size is 0. +This function creates a new thread. -If @joinable is %TRUE, you can wait for this threads termination -calling g_thread_join(). Otherwise the thread will just disappear -when it terminates. If @bound is %TRUE, this thread will be -scheduled in the system scope, otherwise the implementation is free -to do scheduling in the process scope. The first variant is more -expensive resource-wise, but generally faster. On some systems (e.g. -Linux) all threads are bound. - -The new thread executes the function @func with the argument @data. -If the thread was created successfully, it is returned. - -@error can be %NULL to ignore errors, or non-%NULL to report errors. -The error is set, if and only if the function returns %NULL. - -<note><para>It is not guaranteed that threads with different priorities -really behave accordingly. On some systems (e.g. Linux) there are no -thread priorities. On other systems (e.g. Solaris) there doesn't -seem to be different scheduling for different priorities. All in all -try to avoid being dependent on priorities. Use -%G_THREAD_PRIORITY_NORMAL here as a default.</para></note> - -<note><para>Only use g_thread_create_full() if you really can't use -g_thread_create() instead. g_thread_create() does not take -@stack_size, @bound, and @priority as arguments, as they should only -be used in cases in which it is unavoidable.</para></note> +Deprecated:2.32: The @bound and @priority arguments are now ignored. +Use g_thread_new(). </description> <parameters> @@ -33726,11 +39212,11 @@ be used in cases in which it is unavoidable.</para></note> </parameter_description> </parameter> <parameter name="bound"> -<parameter_description> should this thread be bound to a system thread? +<parameter_description> ignored </parameter_description> </parameter> <parameter name="priority"> -<parameter_description> a priority for the thread. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="error"> @@ -33744,29 +39230,26 @@ be used in cases in which it is unavoidable.</para></note> <function name="g_thread_exit"> <description> -Exits the current thread. If another thread is waiting for that -thread using g_thread_join() and the current thread is joinable, the -waiting thread will be woken up and get @retval as the return value -of g_thread_join(). If the current thread is not joinable, @retval -is ignored. Calling +Terminates the current thread. -<informalexample> -<programlisting> -g_thread_exit (retval); -</programlisting> -</informalexample> +If another thread is waiting for us using g_thread_join() then the +waiting thread will be woken up and get @retval as the return value +of g_thread_join(). -is equivalent to returning @retval from the function @func, as given -to g_thread_create(). +Calling <literal>g_thread_exit (retval)</literal> is equivalent to +returning @retval from the function @func, as given to g_thread_new(). -<note><para>Never call g_thread_exit() from within a thread of a -#GThreadPool, as that will mess up the bookkeeping and lead to funny -and unwanted results.</para></note> +<note><para> +You must only call g_thread_exit() from a thread that you created +yourself with g_thread_new() or related APIs. You must not call +this function from a thread created with another threading library +or or from within a #GThreadPool. +</para></note> </description> <parameters> <parameter name="retval"> -<parameter_description> the return value of this thread. +<parameter_description> the return value of this thread </parameter_description> </parameter> </parameters> @@ -33775,26 +39258,32 @@ and unwanted results.</para></note> <function name="g_thread_foreach"> <description> -Call @thread_func on all existing #GThread structures. Note that -threads may decide to exit while @thread_func is running, so -without intimate knowledge about the lifetime of foreign threads, -@thread_func shouldn't access the GThread* pointer passed in as -first argument. However, @thread_func will not be called for threads -which are known to have exited already. +Call @thread_func on all #GThreads that have been +created with g_thread_create(). + +Note that threads may decide to exit while @thread_func is +running, so without intimate knowledge about the lifetime of +foreign threads, @thread_func shouldn't access the GThread* +pointer passed in as first argument. However, @thread_func will +not be called for threads which are known to have exited already. Due to thread lifetime checks, this function has an execution complexity which is quadratic in the number of existing threads. Since: 2.10 +Deprecated:2.32: There aren't many things you can do with a #GThread, +except comparing it with one that was returned from g_thread_create(). +There are better ways to find out if your thread is still alive. + </description> <parameters> <parameter name="thread_func"> -<parameter_description> function to call for all GThread structures +<parameter_description> function to call for all #GThread structures </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> second argument to @thread_func +<parameter_description> second argument to @thread_func </parameter_description> </parameter> </parameters> @@ -33818,39 +39307,34 @@ Since: 2.20 <function name="g_thread_init"> <description> If you use GLib from more than one thread, you must initialize the -thread system by calling g_thread_init(). Most of the time you will -only have to call <literal>g_thread_init (NULL)</literal>. - -<note><para>Do not call g_thread_init() with a non-%NULL parameter unless -you really know what you are doing.</para></note> - -<note><para>g_thread_init() must not be called directly or indirectly as a -callback from GLib. Also no mutexes may be currently locked while -calling g_thread_init().</para></note> +thread system by calling g_thread_init(). -<note><para>g_thread_init() changes the way in which #GTimer measures -elapsed time. As a consequence, timers that are running while -g_thread_init() is called may report unreliable times.</para></note> +Since version 2.24, calling g_thread_init() multiple times is allowed, +but nothing happens except for the first call. -Calling g_thread_init() multiple times is allowed (since version -2.24), but nothing happens except for the first call. If the -argument is non-%NULL on such a call a warning will be printed, but -otherwise the argument is ignored. +Since version 2.32, GLib does not support custom thread implementations +anymore and the @vtable parameter is ignored and you should pass %NULL. -If no thread system is available and @vtable is %NULL or if not all -elements of @vtable are non-%NULL, then g_thread_init() will abort. +<note><para>g_thread_init() must not be called directly or indirectly +in a callback from GLib. Also no mutexes may be currently locked while +calling g_thread_init().</para></note> -<note><para>To use g_thread_init() in your program, you have to link with -the libraries that the command <command>pkg-config --libs +<note><para>To use g_thread_init() in your program, you have to link +with the libraries that the command <command>pkg-config --libs gthread-2.0</command> outputs. This is not the case for all the -other thread related functions of GLib. Those can be used without +other thread-related functions of GLib. Those can be used without having to link with the thread libraries.</para></note> +Deprecated:2.32: This function is no longer necessary. The GLib +threading system is automatically initialized at the start +of your program. + </description> <parameters> <parameter name="vtable"> <parameter_description> a function table of type #GThreadFunctions, that provides -the entry points to the thread system to be used. +the entry points to the thread system to be used. Since 2.32, +this parameter is ignored and should always be %NULL </parameter_description> </parameter> </parameters> @@ -33859,21 +39343,71 @@ the entry points to the thread system to be used. <function name="g_thread_join"> <description> -Waits until @thread finishes, i.e. the function @func, as given to -g_thread_create(), returns or g_thread_exit() is called by @thread. -All resources of @thread including the #GThread struct are released. -@thread must have been created with @joinable=%TRUE in -g_thread_create(). The value returned by @func or given to -g_thread_exit() by @thread is returned by this function. +Waits until @thread finishes, i.e. the function @func, as +given to g_thread_new(), returns or g_thread_exit() is called. +If @thread has already terminated, then g_thread_join() +returns immediately. + +Any thread can wait for any other thread by calling g_thread_join(), +not just its 'creator'. Calling g_thread_join() from multiple threads +for the same @thread leads to undefined behaviour. + +The value returned by @func or given to g_thread_exit() is +returned by this function. + +g_thread_join() consumes the reference to the passed-in @thread. +This will usually cause the #GThread struct and associated resources +to be freed. Use g_thread_ref() to obtain an extra reference if you +want to keep the GThread alive beyond the g_thread_join() call. + </description> <parameters> <parameter name="thread"> -<parameter_description> a #GThread to be waited for. +<parameter_description> a #GThread </parameter_description> </parameter> </parameters> -<return> the return value of the thread. +<return> the return value of the thread +</return> +</function> + +<function name="g_thread_new"> +<description> +This function creates a new thread. The new thread starts by invoking +@func with the argument data. The thread will run until @func returns +or until g_thread_exit() is called from the new thread. The return value +of @func becomes the return value of the thread, which can be obtained +with g_thread_join(). + +The @name can be useful for discriminating threads in a debugger. +Some systems restrict the length of @name to 16 bytes. + +If the thread can not be created the program aborts. See +g_thread_try_new() if you want to attempt to deal with failures. + +To free the struct returned by this function, use g_thread_unref(). +Note that g_thread_join() implicitly unrefs the #GThread as well. + +Since: 2.32 + +</description> +<parameters> +<parameter name="name"> +<parameter_description> a name for the new thread +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> a function to execute in the new thread +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> an argument to supply to the new thread +</parameter_description> +</parameter> +</parameters> +<return> the new #GThread + </return> </function> @@ -33881,17 +39415,18 @@ g_thread_exit() by @thread is returned by this function. <description> Frees all resources allocated for @pool. -If @immediate is %TRUE, no new task is processed for -@pool. Otherwise @pool is not freed before the last task is -processed. Note however, that no thread of this pool is -interrupted, while processing a task. Instead at least all still -running threads can finish their tasks before the @pool is freed. +If @immediate is %TRUE, no new task is processed for @pool. +Otherwise @pool is not freed before the last task is processed. +Note however, that no thread of this pool is interrupted while +processing a task. Instead at least all still running threads +can finish their tasks before the @pool is freed. -If @wait_ is %TRUE, the functions does not return before all tasks -to be processed (dependent on @immediate, whether all or only the -currently running) are ready. Otherwise the function returns immediately. +If @wait_ is %TRUE, the functions does not return before all +tasks to be processed (dependent on @immediate, whether all +or only the currently running) are ready. +Otherwise the function returns immediately. -After calling this function @pool must not be used anymore. +After calling this function @pool must not be used anymore. </description> <parameters> @@ -33913,19 +39448,21 @@ After calling this function @pool must not be used anymore. <function name="g_thread_pool_get_max_idle_time"> <description> -This function will return the maximum @interval that a thread will -wait in the thread pool for new tasks before being stopped. +This function will return the maximum @interval that a +thread will wait in the thread pool for new tasks before +being stopped. -If this function returns 0, threads waiting in the thread pool for -new work are not stopped. +If this function returns 0, threads waiting in the thread +pool for new work are not stopped. Since: 2.10 </description> <parameters> </parameters> -<return> the maximum @interval to wait for new tasks in the -thread pool before stopping the thread (1/1000ths of a second). +<return> the maximum @interval (milliseconds) to wait +for new tasks in the thread pool before stopping the +thread </return> </function> @@ -33994,22 +39531,22 @@ Whenever you call g_thread_pool_push(), either a new thread is created or an unused one is reused. At most @max_threads threads are running concurrently for this thread pool. @max_threads = -1 allows unlimited threads to be created for this thread pool. The -newly created or reused thread now executes the function @func with -the two arguments. The first one is the parameter to +newly created or reused thread now executes the function @func +with the two arguments. The first one is the parameter to g_thread_pool_push() and the second one is @user_data. -The parameter @exclusive determines, whether the thread pool owns -all threads exclusive or whether the threads are shared -globally. If @exclusive is %TRUE, @max_threads threads are started -immediately and they will run exclusively for this thread pool until -it is destroyed by g_thread_pool_free(). If @exclusive is %FALSE, -threads are created, when needed and shared between all -non-exclusive thread pools. This implies that @max_threads may not -be -1 for exclusive thread pools. +The parameter @exclusive determines whether the thread pool owns +all threads exclusive or shares them with other thread pools. +If @exclusive is %TRUE, @max_threads threads are started +immediately and they will run exclusively for this thread pool +until it is destroyed by g_thread_pool_free(). If @exclusive is +%FALSE, threads are created when needed and shared between all +non-exclusive thread pools. This implies that @max_threads may +not be -1 for exclusive thread pools. @error can be %NULL to ignore errors, or non-%NULL to report -errors. An error can only occur when @exclusive is set to %TRUE and -not all @max_threads threads could be created. +errors. An error can only occur when @exclusive is set to %TRUE +and not all @max_threads threads could be created. </description> @@ -34019,13 +39556,13 @@ not all @max_threads threads could be created. </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data that is handed over to @func every time it +<parameter_description> user data that is handed over to @func every time it is called </parameter_description> </parameter> <parameter name="max_threads"> -<parameter_description> the maximal number of threads to execute concurrently in -the new thread pool, -1 means no limit +<parameter_description> the maximal number of threads to execute concurrently +in the new thread pool, -1 means no limit </parameter_description> </parameter> <parameter name="exclusive"> @@ -34033,7 +39570,7 @@ the new thread pool, -1 means no limit </parameter_description> </parameter> <parameter name="error"> -<parameter_description> return location for error +<parameter_description> return location for error, or %NULL </parameter_description> </parameter> </parameters> @@ -34043,17 +39580,21 @@ the new thread pool, -1 means no limit <function name="g_thread_pool_push"> <description> -Inserts @data into the list of tasks to be executed by @pool. When -the number of currently running threads is lower than the maximal -allowed number of threads, a new thread is started (or reused) with -the properties given to g_thread_pool_new (). Otherwise @data stays -in the queue until a thread in this pool finishes its previous task -and processes @data. +Inserts @data into the list of tasks to be executed by @pool. + +When the number of currently running threads is lower than the +maximal allowed number of threads, a new thread is started (or +reused) with the properties given to g_thread_pool_new(). +Otherwise, @data stays in the queue until a thread in this pool +finishes its previous task and processes @data. @error can be %NULL to ignore errors, or non-%NULL to report errors. An error can only occur when a new thread couldn't be -created. In that case @data is simply appended to the queue of work -to do. +created. In that case @data is simply appended to the queue of +work to do. + +Before version 2.32, this function did not return a success status. + </description> <parameters> @@ -34066,20 +39607,21 @@ to do. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> return location for error +<parameter_description> return location for error, or %NULL </parameter_description> </parameter> </parameters> -<return></return> +<return> %TRUE on success, %FALSE if an error occurred +</return> </function> <function name="g_thread_pool_set_max_idle_time"> <description> -This function will set the maximum @interval that a thread waiting -in the pool for new tasks can be idle for before being -stopped. This function is similar to calling -g_thread_pool_stop_unused_threads() on a regular timeout, except, -this is done on a per thread basis. +This function will set the maximum @interval that a thread +waiting in the pool for new tasks can be idle for before +being stopped. This function is similar to calling +g_thread_pool_stop_unused_threads() on a regular timeout, +except this is done on a per thread basis. By setting @interval to 0, idle threads will not be stopped. @@ -34091,8 +39633,8 @@ Since: 2.10 </description> <parameters> <parameter name="interval"> -<parameter_description> the maximum @interval (1/1000ths of a second) a thread -can be idle. +<parameter_description> the maximum @interval (in milliseconds) +a thread can be idle </parameter_description> </parameter> </parameters> @@ -34101,22 +39643,27 @@ can be idle. <function name="g_thread_pool_set_max_threads"> <description> -Sets the maximal allowed number of threads for @pool. A value of -1 -means, that the maximal number of threads is unlimited. +Sets the maximal allowed number of threads for @pool. +A value of -1 means that the maximal number of threads +is unlimited. If @pool is an exclusive thread pool, setting +the maximal number of threads to -1 is not allowed. -Setting @max_threads to 0 means stopping all work for @pool. It is -effectively frozen until @max_threads is set to a non-zero value -again. +Setting @max_threads to 0 means stopping all work for @pool. +It is effectively frozen until @max_threads is set to a non-zero +value again. A thread is never terminated while calling @func, as supplied by -g_thread_pool_new (). Instead the maximal number of threads only -has effect for the allocation of new threads in g_thread_pool_push(). +g_thread_pool_new(). Instead the maximal number of threads only +has effect for the allocation of new threads in g_thread_pool_push(). A new thread is allocated, whenever the number of currently running threads in @pool is smaller than the maximal number. @error can be %NULL to ignore errors, or non-%NULL to report errors. An error can only occur when a new thread couldn't be -created. +created. + +Before version 2.32, this function did not return a success status. + </description> <parameters> @@ -34125,22 +39672,24 @@ created. </parameter_description> </parameter> <parameter name="max_threads"> -<parameter_description> a new maximal number of threads for @pool +<parameter_description> a new maximal number of threads for @pool, +or -1 for unlimited </parameter_description> </parameter> <parameter name="error"> -<parameter_description> return location for error +<parameter_description> return location for error, or %NULL </parameter_description> </parameter> </parameters> -<return></return> +<return> %TRUE on success, %FALSE if an error occurred +</return> </function> <function name="g_thread_pool_set_max_unused_threads"> <description> -Sets the maximal number of unused threads to @max_threads. If -@max_threads is -1, no limit is imposed on the number of unused -threads. +Sets the maximal number of unused threads to @max_threads. +If @max_threads is -1, no limit is imposed on the number +of unused threads. </description> <parameters> @@ -34159,10 +39708,10 @@ tasks to be processed by a priority determined by @func, and not just in the order in which they were added to the pool. Note, if the maximum number of threads is more than 1, the order -that threads are executed cannot be guranteed 100%. Threads are +that threads are executed cannot be guaranteed 100%. Threads are scheduled by the operating system and are executed at random. It cannot be assumed that threads are executed in the order they are -created. +created. Since: 2.10 @@ -34173,16 +39722,16 @@ Since: 2.10 </parameter_description> </parameter> <parameter name="func"> -<parameter_description> the #GCompareDataFunc used to sort the list of tasks. +<parameter_description> the #GCompareDataFunc used to sort the list of tasks. This function is passed two tasks. It should return -0 if the order in which they are handled does not matter, +0 if the order in which they are handled does not matter, a negative value if the first task should be processed before -the second or a positive value if the second task should be +the second or a positive value if the second task should be processed first. </parameter_description> </parameter> <parameter name="user_data"> -<parameter_description> user data passed to @func. +<parameter_description> user data passed to @func </parameter_description> </parameter> </parameters> @@ -34217,27 +39766,49 @@ Returns the number of tasks still unprocessed in @pool. </return> </function> +<function name="g_thread_ref"> +<description> +Increase the reference count on @thread. + +Since: 2.32 + +</description> +<parameters> +<parameter name="thread"> +<parameter_description> a #GThread +</parameter_description> +</parameter> +</parameters> +<return> a new reference to @thread + +</return> +</function> + <function name="g_thread_self"> <description> -This functions returns the #GThread corresponding to the calling -thread. +This functions returns the #GThread corresponding to the +current thread. Note that this function does not increase +the reference count of the returned struct. + +This function will return a #GThread even for threads that +were not created by GLib (i.e. those created by other threading +APIs). This may be useful for thread identification purposes +(i.e. comparisons) but you must not use GLib functions (such +as g_thread_join()) on these threads. + </description> <parameters> </parameters> -<return> the current thread. +<return> the #GThread representing the current thread </return> </function> <function name="g_thread_set_priority"> <description> -Changes the priority of @thread to @priority. +This function does nothing. -<note><para>It is not guaranteed that threads with different -priorities really behave accordingly. On some systems (e.g. Linux) -there are no thread priorities. On other systems (e.g. Solaris) there -doesn't seem to be different scheduling for different priorities. All -in all try to avoid being dependent on priorities.</para></note> +Deprecated:2.32: Thread priorities no longer have any effect. </description> <parameters> @@ -34246,7 +39817,7 @@ in all try to avoid being dependent on priorities.</para></note> </parameter_description> </parameter> <parameter name="priority"> -<parameter_description> a new priority for @thread. +<parameter_description> ignored </parameter_description> </parameter> </parameters> @@ -34255,27 +39826,81 @@ in all try to avoid being dependent on priorities.</para></note> <function name="g_thread_supported"> <description> -This function returns %TRUE if the thread system is initialized, and -%FALSE if it is not. +This macro returns %TRUE if the thread system is initialized, +and %FALSE if it is not. + +For language bindings, g_thread_get_initialized() provides +the same functionality as a function. + + +</description> +<parameters> +</parameters> +<return> %TRUE, if the thread system is initialized +</return> +</function> + +<function name="g_thread_try_new"> +<description> +This function is the same as g_thread_new() except that +it allows for the possibility of failure. -<note><para>This function is actually a macro. Apart from taking the -address of it you can however use it as if it was a -function.</para></note> +If a thread can not be created (due to resource limits), +@error is set and %NULL is returned. + +Since: 2.32 </description> <parameters> +<parameter name="name"> +<parameter_description> a name for the new thread +</parameter_description> +</parameter> +<parameter name="func"> +<parameter_description> a function to execute in the new thread +</parameter_description> +</parameter> +<parameter name="data"> +<parameter_description> an argument to supply to the new thread +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for error, or %NULL +</parameter_description> +</parameter> </parameters> -<return> %TRUE, if the thread system is initialized. +<return> the new #GThread, or %NULL if an error occurred + </return> </function> +<function name="g_thread_unref"> +<description> +Decrease the reference count on @thread, possibly freeing all +resources associated with it. + +Note that each thread holds a reference to its #GThread while +it is running, so it is safe to drop your own reference to it +if you don't need it anymore. + +Since: 2.32 + +</description> +<parameters> +<parameter name="thread"> +<parameter_description> a #GThread +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_thread_yield"> <description> -Gives way to other threads waiting to be scheduled. +Causes the calling thread to voluntarily relinquish the CPU, so +that other threads can run. This function is often used as a method to make busy wait less evil. -But in most cases you will encounter, there are better methods to do -that. So in general you shouldn't use this function. </description> <parameters> @@ -34307,6 +39932,11 @@ also be negative to decrease the value of @time_. Converts a string containing an ISO 8601 encoded date and time to a #GTimeVal and puts it into @time_. +@iso_date must include year, month, day, hours, minutes, and +seconds. It can optionally include fractions of a second and a time +zone indicator. (In the absence of any time zone indication, the +timestamp is assumed to be in local time.) + Since: 2.12 </description> @@ -34327,8 +39957,26 @@ Since: 2.12 <function name="g_time_val_to_iso8601"> <description> -Converts @time_ into an ISO 8601 encoded string, relative to the -Coordinated Universal Time (UTC). +Converts @time_ into an RFC 3339 encoded string, relative to the +Coordinated Universal Time (UTC). This is one of the many formats +allowed by ISO 8601. + +ISO 8601 allows a large number of date/time formats, with or without +punctuation and optional elements. The format returned by this function +is a complete date and time, with optional punctuation included, the +UTC time zone represented as "Z", and the @tv_usec part included if +and only if it is nonzero, i.e. either +"YYYY-MM-DDTHH:MM:SSZ" or "YYYY-MM-DDTHH:MM:SS.fffffZ". + +This corresponds to the Internet date/time format defined by +<ulink url="https://www.ietf.org/rfc/rfc3339.txt">RFC 3339</ulink>, and +to either of the two most-precise formats defined by +<ulink url="http://www.w3.org/TR/NOTE-datetime-19980827">the W3C Note +"Date and Time Formats"</ulink>. Both of these documents are profiles of +ISO 8601. + +Use g_date_time_format() or g_strdup_printf() if a different +variation of ISO 8601 format is required. Since: 2.12 @@ -34396,7 +40044,7 @@ succeed (since universal time is monotonic and continuous). Otherwise @time_ is treated is local time. The distinction between %G_TIME_TYPE_STANDARD and %G_TIME_TYPE_DAYLIGHT is ignored except in the case that the given @time_ is ambiguous. In Toronto, for example, -01:30 on November 7th 2010 occured twice (once inside of daylight +01:30 on November 7th 2010 occurred twice (once inside of daylight savings time and the next, an hour later, outside of daylight savings time). In this case, the different value of @type would result in a different interval being returned. @@ -34557,12 +40205,13 @@ Since: 2.26 <function name="g_time_zone_new_local"> <description> -Creates a #GTimeZone corresponding to local time. +Creates a #GTimeZone corresponding to local time. The local time +zone may change between invocations to this function; for example, +if the system administrator changes it. This is equivalent to calling g_time_zone_new() with the value of the <varname>TZ</varname> environment variable (including the possibility -of %NULL). Changes made to <varname>TZ</varname> after the first -call to this function may or may not be noticed by future calls. +of %NULL). You should release the return value by calling g_time_zone_unref() when you are done with it. @@ -34615,27 +40264,6 @@ Since: 2.26 </return> </function> -<function name="g_time_zone_refresh_local"> -<description> -Notifies #GTimeZone that the local timezone may have changed. - -In response, #GTimeZone will drop its cache of the local time zone. -No existing #GTimeZone will be modified and no #GDateTime will change -its timezone but future calls to g_time_zone_new_local() will start -returning the new timezone. - -#GTimeZone does no monitoring of the local timezone on its own, which -is why you have to call this function to notify it of the change. - -If you use #GTimeZoneMonitor to watch for changes then this function -will automatically be called for you. - -</description> -<parameters> -</parameters> -<return></return> -</function> - <function name="g_time_zone_unref"> <description> Decreases the reference count on @tz. @@ -34675,6 +40303,9 @@ This internally creates a main loop source using g_timeout_source_new() and attaches it to the main loop context using g_source_attach(). You can do these steps manually if you need greater control. +The interval given is in terms of monotonic time, not wall clock +time. See g_get_monotonic_time(). + </description> <parameters> @@ -34715,6 +40346,9 @@ This internally creates a main loop source using g_timeout_source_new() and attaches it to the main loop context using g_source_attach(). You can do these steps manually if you need greater control. +The interval given in terms of monotonic time, not wall clock time. +See g_get_monotonic_time(). + </description> <parameters> @@ -34761,6 +40395,9 @@ Note that the first call of the timer may not be precise for timeouts of one second. If you need finer precision and have such a timeout, you may want to use g_timeout_add() instead. +The interval given is in terms of monotonic time, not wall clock +time. See g_get_monotonic_time(). + Since: 2.14 </description> @@ -34816,6 +40453,9 @@ g_timeout_source_new_seconds() and attaches it to the main loop context using g_source_attach(). You can do these steps manually if you need greater control. +The interval given is in terms of monotonic time, not wall clock +time. See g_get_monotonic_time(). + Since: 2.14 </description> @@ -34855,6 +40495,9 @@ The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be executed. +The interval given is in terms of monotonic time, not wall clock +time. See g_get_monotonic_time(). + </description> <parameters> @@ -34878,6 +40521,9 @@ executed. The scheduling granularity/accuracy of this timeout source will be in seconds. +The interval given in terms of monotonic time, not wall clock time. +See g_get_monotonic_time(). + Since: 2.14 </description> @@ -34933,11 +40579,6 @@ stopped. The return value is the number of seconds elapsed, including any fractional part. The @microseconds out parameter is essentially useless. -<warning><para> -Calling initialization functions, in particular g_thread_init(), while a -timer is running will cause invalid return values from this function. -</para></warning> - </description> <parameters> <parameter name="timer"> @@ -35016,6 +40657,76 @@ difference between this end time and the start time. <return></return> </function> +<function name="g_trash_stack_height"> +<description> +Returns the height of a #GTrashStack. + +Note that execution of this function is of O(N) complexity +where N denotes the number of items on the stack. + + +</description> +<parameters> +<parameter name="stack_p"> +<parameter_description> a #GTrashStack +</parameter_description> +</parameter> +</parameters> +<return> the height of the stack +</return> +</function> + +<function name="g_trash_stack_peek"> +<description> +Returns the element at the top of a #GTrashStack +which may be %NULL. + + +</description> +<parameters> +<parameter name="stack_p"> +<parameter_description> a #GTrashStack +</parameter_description> +</parameter> +</parameters> +<return> the element at the top of the stack +</return> +</function> + +<function name="g_trash_stack_pop"> +<description> +Pops a piece of memory off a #GTrashStack. + + +</description> +<parameters> +<parameter name="stack_p"> +<parameter_description> a #GTrashStack +</parameter_description> +</parameter> +</parameters> +<return> the element at the top of the stack +</return> +</function> + +<function name="g_trash_stack_push"> +<description> +Pushes a piece of memory onto a #GTrashStack. + +</description> +<parameters> +<parameter name="stack_p"> +<parameter_description> a #GTrashStack +</parameter_description> +</parameter> +<parameter name="data_p"> +<parameter_description> the piece of memory to push on the stack +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_tree_destroy"> <description> Removes all keys and values from the #GTree and decreases its @@ -35724,9 +41435,9 @@ is used to manage the relationship. <function name="g_type_add_interface_static"> <description> -Adds the static @interface_type to @instantiable_type. The information -contained in the #GTypeInterfaceInfo structure pointed to by @info -is used to manage the relationship. +Adds the static @interface_type to @instantiable_type. The +information contained in the #GInterfaceInfo structure pointed to by +@info is used to manage the relationship. </description> <parameters> @@ -35797,7 +41508,7 @@ sequentially in the same memory block as the public structures. Note that the accumulated size of the private structures of -a type and all its parent types cannot excced 64kB. +a type and all its parent types cannot excced 64 KiB. This function should be called in the type's class_init() function. The private structure can be retrieved using the @@ -37060,7 +42771,7 @@ include the trailing 0. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError other than %G_CONVERT_ERROR_NO_CONVERSION may occur. </parameter_description> @@ -37101,7 +42812,7 @@ byte. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError other than %G_CONVERT_ERROR_NO_CONVERSION may occur. </parameter_description> @@ -37155,6 +42866,93 @@ Since: 2.14 </return> </function> +<function name="g_unichar_compose"> +<description> +Performs a single composition step of the +Unicode canonical composition algorithm. + +This function includes algorithmic Hangul Jamo composition, +but it is not exactly the inverse of g_unichar_decompose(). +No composition can have either of @a or @b equal to zero. +To be precise, this function composes if and only if +there exists a Primary Composite P which is canonically +equivalent to the sequence <@a,@b>. See the Unicode +Standard for the definition of Primary Composite. + +If @a and @b do not compose a new character, @ch is set to zero. + +See <ulink url="http://unicode.org/reports/tr15/">UAX#15</ulink> +for details. + +Since: 2.30 + +</description> +<parameters> +<parameter name="a"> +<parameter_description> a Unicode character +</parameter_description> +</parameter> +<parameter name="b"> +<parameter_description> a Unicode character +</parameter_description> +</parameter> +<parameter name="ch"> +<parameter_description> return location for the composed character +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the characters could be composed + +</return> +</function> + +<function name="g_unichar_decompose"> +<description> +Performs a single decomposition step of the +Unicode canonical decomposition algorithm. + +This function does not include compatibility +decompositions. It does, however, include algorithmic +Hangul Jamo decomposition, as well as 'singleton' +decompositions which replace a character by a single +other character. In the case of singletons *@b will +be set to zero. + +If @ch is not decomposable, *@a is set to @ch and *@b +is set to zero. + +Note that the way Unicode decomposition pairs are +defined, it is guaranteed that @b would not decompose +further, but @a may itself decompose. To get the full +canonical decomposition for @ch, one would need to +recursively call this function on @a. Or use +g_unichar_fully_decompose(). + +See <ulink url="http://unicode.org/reports/tr15/">UAX#15</ulink> +for details. + +Since: 2.30 + +</description> +<parameters> +<parameter name="ch"> +<parameter_description> a Unicode character +</parameter_description> +</parameter> +<parameter name="a"> +<parameter_description> return location for the first component of @ch +</parameter_description> +</parameter> +<parameter name="b"> +<parameter_description> return location for the second component of @ch +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the character could be decomposed + +</return> +</function> + <function name="g_unichar_digit_value"> <description> Determines the numeric value of a character as a decimal @@ -37173,6 +42971,53 @@ g_unichar_isdigit()), its numeric value. Otherwise, -1. </return> </function> +<function name="g_unichar_fully_decompose"> +<description> +Computes the canonical or compatibility decomposition of a +Unicode character. For compatibility decomposition, +pass %TRUE for @compat; for canonical decomposition +pass %FALSE for @compat. + +The decomposed sequence is placed in @result. Only up to +@result_len characters are written into @result. The length +of the full decomposition (irrespective of @result_len) is +returned by the function. For canonical decomposition, +currently all decompositions are of length at most 4, but +this may change in the future (very unlikely though). +At any rate, Unicode does guarantee that a buffer of length +18 is always enough for both compatibility and canonical +decompositions, so that is the size recommended. This is provided +as %G_UNICHAR_MAX_DECOMPOSITION_LENGTH. + +See <ulink url="http://unicode.org/reports/tr15/">UAX#15</ulink> +for details. + +Since: 2.30 + +</description> +<parameters> +<parameter name="ch"> +<parameter_description> a Unicode character. +</parameter_description> +</parameter> +<parameter name="compat"> +<parameter_description> whether perform canonical or compatibility decomposition +</parameter_description> +</parameter> +<parameter name="result"> +<parameter_description> location to store decomposed result, or %NULL +</parameter_description> +</parameter> +<parameter name="result_len"> +<parameter_description> length of @result +</parameter_description> +</parameter> +</parameters> +<return> the length of the full decomposition. + +</return> +</function> + <function name="g_unichar_get_mirror_char"> <description> In Unicode, some characters are <firstterm>mirrored</firstterm>. This @@ -37206,7 +43051,7 @@ Since: 2.4 <function name="g_unichar_get_script"> <description> Looks up the #GUnicodeScript for a particular character (as defined -by Unicode Standard Annex #24). No check is made for @ch being a +by Unicode Standard Annex \#24). No check is made for @ch being a valid Unicode character; if you pass in invalid character, the result is undefined. @@ -37694,6 +43539,8 @@ g_unichar_isxdigit()), its numeric value. Otherwise, -1. <description> Computes the canonical decomposition of a Unicode character. +Deprecated: 2.30: Use the more flexible g_unichar_fully_decompose() +instead. </description> <parameters> @@ -37708,6 +43555,7 @@ Computes the canonical decomposition of a Unicode character. </parameters> <return> a newly allocated string of Unicode characters. @result_len is set to the resulting length of the string. + </return> </function> @@ -37732,17 +43580,72 @@ manual for more information. <return></return> </function> +<function name="g_unicode_script_from_iso15924"> +<description> +Looks up the Unicode script for @iso15924. ISO 15924 assigns four-letter +codes to scripts. For example, the code for Arabic is 'Arab'. +This function accepts four letter codes encoded as a @guint32 in a +big-endian fashion. That is, the code expected for Arabic is +0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc). + +See <ulink url="http://unicode.org/iso15924/codelists.html">Codes for the +representation of names of scripts</ulink> for details. + +Since: 2.30 + +</description> +<parameters> +<parameter name="iso15924"> +<parameter_description> a Unicode script +</parameter_description> +</parameter> +</parameters> +<return> the Unicode script for @iso15924, or +of %G_UNICODE_SCRIPT_INVALID_CODE if @iso15924 is zero and +%G_UNICODE_SCRIPT_UNKNOWN if @iso15924 is unknown. + +</return> +</function> + +<function name="g_unicode_script_to_iso15924"> +<description> +Looks up the ISO 15924 code for @script. ISO 15924 assigns four-letter +codes to scripts. For example, the code for Arabic is 'Arab'. The +four letter codes are encoded as a @guint32 by this function in a +big-endian fashion. That is, the code returned for Arabic is +0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc). + +See <ulink url="http://unicode.org/iso15924/codelists.html">Codes for the +representation of names of scripts</ulink> for details. + +Since: 2.30 + +</description> +<parameters> +<parameter name="script"> +<parameter_description> a Unicode script +</parameter_description> +</parameter> +</parameters> +<return> the ISO 15924 code for @script, encoded as an integer, +of zero if @script is %G_UNICODE_SCRIPT_INVALID_CODE or +ISO 15924 code 'Zzzz' (script code for UNKNOWN) if @script is not understood. + +</return> +</function> + <function name="g_unix_open_pipe"> <description> Similar to the UNIX pipe() call, but on modern systems like Linux uses the pipe2() system call, which atomically creates a pipe with the configured flags. The only supported flag currently is -%FD_CLOEXEC. If for example you want to configure %O_NONBLOCK, -that must still be done separately with fcntl(). +<literal>FD_CLOEXEC</literal>. If for example you want to configure +<literal>O_NONBLOCK</literal>, that must still be done separately with +fcntl(). -<note>This function does *not* take %O_CLOEXEC, it takes -%FD_CLOEXEC as if for fcntl(); these are different on -Linux/glibc.</note> +<note>This function does *not* take <literal>O_CLOEXEC</literal>, it takes +<literal>FD_CLOEXEC</literal> as if for fcntl(); these are +different on Linux/glibc.</note> Since: 2.30 @@ -37769,8 +43672,8 @@ Since: 2.30 <function name="g_unix_set_fd_nonblocking"> <description> Control the non-blocking state of the given file descriptor, -according to @nonblock. On most systems this uses %O_NONBLOCK, but -on some older ones may use %O_NDELAY. +according to @nonblock. On most systems this uses <literal>O_NONBLOCK</literal>, but +on some older ones may use <literal>O_NDELAY</literal>. Since: 2.30 @@ -37794,7 +43697,7 @@ Since: 2.30 </return> </function> -<function name="g_unix_signal_add_watch_full"> +<function name="g_unix_signal_add"> <description> A convenience function for g_unix_signal_source_new(), which attaches to the default #GMainContext. You can remove the watch @@ -37808,11 +43711,39 @@ Since: 2.30 <parameter_description> Signal number </parameter_description> </parameter> +<parameter name="handler"> +<parameter_description> Callback +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> Data for @handler +</parameter_description> +</parameter> +</parameters> +<return> An ID (greater than 0) for the event source + +</return> +</function> + +<function name="g_unix_signal_add_full"> +<description> +A convenience function for g_unix_signal_source_new(), which +attaches to the default #GMainContext. You can remove the watch +using g_source_remove(). + +Since: 2.30 + +</description> +<parameters> <parameter name="priority"> <parameter_description> the priority of the signal source. Typically this will be in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. </parameter_description> </parameter> +<parameter name="signum"> +<parameter_description> Signal number +</parameter_description> +</parameter> <parameter name="handler"> <parameter_description> Callback </parameter_description> @@ -37834,12 +43765,13 @@ the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. <function name="g_unix_signal_source_new"> <description> Create a #GSource that will be dispatched upon delivery of the UNIX -signal @signum. Currently only %SIGHUP, %SIGINT, and %SIGTERM can +signal @signum. Currently only <literal>SIGHUP</literal>, +<literal>SIGINT</literal>, and <literal>SIGTERM</literal> can be monitored. Note that unlike the UNIX default, all sources which have created a watch will be dispatched, regardless of which underlying thread invoked g_unix_signal_source_new(). -For example, an effective use of this function is to handle SIGTERM +For example, an effective use of this function is to handle <literal>SIGTERM</literal> cleanly; flushing any outstanding files, and then calling g_main_loop_quit (). It is not safe to do any of this a regular UNIX signal handler; your handler may be invoked while malloc() or @@ -37850,12 +43782,6 @@ is safe against this kind of reentrancy. The interaction of this source when combined with native UNIX functions like sigprocmask() is not defined. -<note>For reliable behavior, if your program links to gthread -(either directly or indirectly via GObject, GIO, or a higher level -library), you should ensure g_thread_init() is called before using -this function. For example, if your program uses GObject, call -g_type_init().</note> - The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be executed. @@ -37904,17 +43830,30 @@ occurred <description> Removes an environment variable from the environment. -Note that on some systems, when variables are overwritten, the memory -used for the previous variables and its value isn't reclaimed. -Furthermore, this function can't be guaranteed to operate in a -threadsafe way. +Note that on some systems, when variables are overwritten, the +memory used for the previous variables and its value isn't reclaimed. -Since: 2.4 +<warning><para> +Environment variable handling in UNIX is not thread-safe, and your +program may crash if one thread calls g_unsetenv() while another +thread is calling getenv(). (And note that many functions, such as +gettext(), call getenv() internally.) This function is only safe +to use at the very start of your program, before creating any other +threads (or creating objects that create worker threads of their +own). +</para><para> +If you need to set up the environment for a child process, you can +use g_get_environ() to get an environment array, modify that with +g_environ_setenv() and g_environ_unsetenv(), and then pass that +array directly to execvpe(), g_spawn_async(), or the like. +</para></warning> + +Since: 2.4 </description> <parameters> <parameter name="variable"> -<parameter_description> the environment variable to remove, must not contain '='. +<parameter_description> the environment variable to remove, must not contain '=' </parameter_description> </parameter> </parameters> @@ -38063,6 +44002,25 @@ should be freed when no longer needed. </return> </function> +<function name="g_usleep"> +<description> +Pauses the current thread for the given number of microseconds. + +There are 1 million microseconds per second (represented by the +#G_USEC_PER_SEC macro). g_usleep() may have limited precision, +depending on hardware and operating system; don't rely on the exact +length of the sleep. + +</description> +<parameters> +<parameter name="microseconds"> +<parameter_description> number of microseconds to pause +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_utf16_to_ucs4"> <description> Convert a string from UTF-16 to UCS-4. The result will be @@ -38095,7 +44053,7 @@ The value stored here does not include the trailing </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError other than %G_CONVERT_ERROR_NO_CONVERSION may occur. </parameter_description> @@ -38151,7 +44109,7 @@ The value stored here does not include the trailing </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError other than %G_CONVERT_ERROR_NO_CONVERSION may occur. </parameter_description> @@ -38569,7 +44527,8 @@ converted to lowercase. <function name="g_utf8_strlen"> <description> Computes the length of the string in characters, not including -the terminating nul character. +the terminating nul character. If the @max'th byte falls in the +middle of a character, the last (partial) character is not counted. </description> @@ -38582,7 +44541,8 @@ the terminating nul character. <parameter_description> the maximum number of bytes to examine. If @max is less than 0, then the string is assumed to be nul-terminated. If @max is 0, @p will not be examined and -may be %NULL. +may be %NULL. If @max is greater than 0, up to @max +bytes are examined </parameter_description> </parameter> </parameters> @@ -38706,10 +44666,39 @@ converted to uppercase. </return> </function> +<function name="g_utf8_substring"> +<description> +Copies a substring out of a UTF-8 encoded string. +The substring will contain @end_pos - @start_pos +characters. + +Since: 2.30 + +</description> +<parameters> +<parameter name="str"> +<parameter_description> a UTF-8 encoded string +</parameter_description> +</parameter> +<parameter name="start_pos"> +<parameter_description> a character offset within @str +</parameter_description> +</parameter> +<parameter name="end_pos"> +<parameter_description> another character offset within @str +</parameter_description> +</parameter> +</parameters> +<return> a newly allocated copy of the requested +substring. Free with g_free() when no longer needed. + +</return> +</function> + <function name="g_utf8_to_ucs4"> <description> Convert a string from UTF-8 to a 32-bit fixed width -representation as UCS-4. A trailing 0 will be added to the +representation as UCS-4. A trailing 0 character will be added to the string after the converted text. @@ -38739,7 +44728,7 @@ character. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError other than %G_CONVERT_ERROR_NO_CONVERSION may occur. </parameter_description> @@ -38757,7 +44746,8 @@ error occurs, %NULL will be returned and Convert a string from UTF-8 to a 32-bit fixed width representation as UCS-4, assuming valid UTF-8 input. This function is roughly twice as fast as g_utf8_to_ucs4() -but does no error checking on the input. +but does no error checking on the input. A trailing 0 character +will be added to the string after the converted text. </description> @@ -38814,7 +44804,7 @@ The value stored here does not include the trailing 0. </parameter_description> </parameter> <parameter name="error"> -<parameter_description> location to store the error occuring, or %NULL to ignore +<parameter_description> location to store the error occurring, or %NULL to ignore errors. Any of the errors in #GConvertError other than %G_CONVERT_ERROR_NO_CONVERSION may occur. </parameter_description> @@ -38838,7 +44828,7 @@ character if some bytes were invalid, or the end of the text being validated otherwise). Note that g_utf8_validate() returns %FALSE if @max_len is -positive and NUL is met before @max_len bytes have been read. +positive and any of the @max_len bytes are NUL. </description> @@ -38892,6 +44882,7 @@ occurred Insert a copy of @value as last element of @value_array. If @value is %NULL, an uninitialized value is appended. +Deprecated: 2.32: Use #GArray and g_array_append_val() instead. </description> <parameters> @@ -38905,6 +44896,7 @@ Insert a copy of @value as last element of @value_array. If @value is </parameter> </parameters> <return> the #GValueArray passed in as @value_array + </return> </function> @@ -38913,6 +44905,7 @@ Insert a copy of @value as last element of @value_array. If @value is Construct an exact copy of a #GValueArray by duplicating all its contents. +Deprecated: 2.32: Use #GArray and g_array_ref() instead. </description> <parameters> @@ -38922,6 +44915,7 @@ contents. </parameter> </parameters> <return> Newly allocated copy of #GValueArray + </return> </function> @@ -38929,6 +44923,8 @@ contents. <description> Free a #GValueArray including its contents. +Deprecated: 2.32: Use #GArray and g_array_unref() instead. + </description> <parameters> <parameter name="value_array"> @@ -38943,6 +44939,7 @@ Free a #GValueArray including its contents. <description> Return a pointer to the value at @index_ containd in @value_array. +Deprecated: 2.32: Use g_array_index() instead. </description> <parameters> @@ -38956,6 +44953,7 @@ Return a pointer to the value at @index_ containd in @value_array. </parameter> </parameters> <return> pointer to a value at @index_ in @value_array + </return> </function> @@ -38964,6 +44962,7 @@ Return a pointer to the value at @index_ containd in @value_array. Insert a copy of @value at specified position into @value_array. If @value is %NULL, an uninitialized value is inserted. +Deprecated: 2.32: Use #GArray and g_array_insert_val() instead. </description> <parameters> @@ -38981,6 +44980,7 @@ is %NULL, an uninitialized value is inserted. </parameter> </parameters> <return> the #GValueArray passed in as @value_array + </return> </function> @@ -38990,6 +44990,7 @@ Allocate and initialize a new #GValueArray, optionally preserve space for @n_prealloced elements. New arrays always contain 0 elements, regardless of the value of @n_prealloced. +Deprecated: 2.32: Use #GArray and g_array_sized_new() instead. </description> <parameters> @@ -38999,6 +45000,7 @@ regardless of the value of @n_prealloced. </parameter> </parameters> <return> a newly allocated #GValueArray with 0 values + </return> </function> @@ -39008,6 +45010,7 @@ Insert a copy of @value as first element of @value_array. If @value is %NULL, an uninitialized value is prepended. +Deprecated: 2.32: Use #GArray and g_array_prepend_val() instead. </description> <parameters> @@ -39021,6 +45024,7 @@ Insert a copy of @value as first element of @value_array. If @value is </parameter> </parameters> <return> the #GValueArray passed in as @value_array + </return> </function> @@ -39028,6 +45032,7 @@ Insert a copy of @value as first element of @value_array. If @value is <description> Remove the value at position @index_ from @value_array. +Deprecated: 2.32: Use #GArray and g_array_remove_index() instead. </description> <parameters> @@ -39043,16 +45048,18 @@ linkend="GValueArray.n-values">n_values</link></code> </parameter> </parameters> <return> the #GValueArray passed in as @value_array + </return> </function> <function name="g_value_array_sort"> <description> -Sort @value_array using @compare_func to compare the elements accoring to +Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareFunc. The current implementation uses Quick-Sort as sorting algorithm. +Deprecated: 2.32: Use #GArray and g_array_sort(). </description> <parameters> @@ -39066,16 +45073,18 @@ The current implementation uses Quick-Sort as sorting algorithm. </parameter> </parameters> <return> the #GValueArray passed in as @value_array + </return> </function> <function name="g_value_array_sort_with_data"> <description> -Sort @value_array using @compare_func to compare the elements accoring +Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareDataFunc. The current implementation uses Quick-Sort as sorting algorithm. +Deprecated: 2.32: Use #GArray and g_array_sort_with_data(). </description> <parameters> @@ -39093,6 +45102,7 @@ The current implementation uses Quick-Sort as sorting algorithm. </parameter> </parameters> <return> the #GValueArray passed in as @value_array + </return> </function> @@ -39256,8 +45266,12 @@ Get the contents of a %G_TYPE_BOXED derived #GValue. <function name="g_value_get_char"> <description> -Get the contents of a %G_TYPE_CHAR #GValue. +Do not use this function; it is broken on platforms where the %char +type is unsigned, such as ARM and PowerPC. See g_value_get_schar(). +Get the contents of a %G_TYPE_CHAR #GValue. + +Deprecated: 2.32: This function's return type is broken, see g_value_get_schar() </description> <parameters> @@ -39448,6 +45462,23 @@ Get the contents of a pointer #GValue. </return> </function> +<function name="g_value_get_schar"> +<description> +Get the contents of a %G_TYPE_CHAR #GValue. + +Since: 2.32 + +</description> +<parameters> +<parameter name="value"> +<parameter_description> a valid #GValue of type %G_TYPE_CHAR +</parameter_description> +</parameter> +</parameters> +<return> signed 8 bit integer contents of @value +</return> +</function> + <function name="g_value_get_string"> <description> Get the contents of a %G_TYPE_STRING #GValue. @@ -39684,6 +45715,7 @@ Deprecated: 2.4: Use g_value_take_boxed() instead. <function name="g_value_set_char"> <description> Set the contents of a %G_TYPE_CHAR #GValue to @v_char. +Deprecated: 2.32: This function's input type is broken, see g_value_set_schar() </description> <parameters> @@ -39968,6 +46000,26 @@ Set the contents of a pointer #GValue to @v_pointer. <return></return> </function> +<function name="g_value_set_schar"> +<description> +Set the contents of a %G_TYPE_CHAR #GValue to @v_char. + +Since: 2.32 + +</description> +<parameters> +<parameter name="value"> +<parameter_description> a valid #GValue of type %G_TYPE_CHAR +</parameter_description> +</parameter> +<parameter name="v_char"> +<parameter_description> signed 8 bit integer to be set +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_value_set_static_boxed"> <description> Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. @@ -40236,10 +46288,8 @@ the ownership of the caller's reference to @variant; the caller doesn't have to unref it any more (i.e. the reference count of the variant is not increased). -It is a programmer error to pass a floating variant to this function. -In particular this means that callbacks in closures, and signal handlers -for signals of return type %G_TYPE_VARIANT, must never return floating -variants. +If @variant was floating then its floating reference is converted to +a hard reference. If you want the #GValue to hold its own reference to @variant, use g_value_set_variant() instead. @@ -40548,6 +46598,7 @@ Since: 2.24 </parameter> </parameters> <return> a new, floating, #GVariant + </return> </function> @@ -40621,6 +46672,7 @@ Since: 2.24 </parameter> </parameters> <return> a #GVariantBuilder + </return> </function> @@ -40666,6 +46718,7 @@ Since: 2.24 </parameter> </parameters> <return> a new reference to @builder + </return> </function> @@ -40715,6 +46768,7 @@ Since: 2.24 </parameter> </parameters> <return> the byteswapped form of @value + </return> </function> @@ -40732,6 +46786,7 @@ Since: 2.24 </parameter> </parameters> <return> the #GVariantClass of @value + </return> </function> @@ -40773,6 +46828,7 @@ Since: 2.26 <return> negative value if a < b; zero if a = b; positive value if a > b. + </return> </function> @@ -40797,7 +46853,9 @@ the length (not including the nul terminator) </parameter_description> </parameter> </parameters> -<return> a newly allocated string +<return> (transfer full) (array zero-terminated=1 length=length) +(element-type guint8): a newly allocated string + </return> </function> @@ -40828,6 +46886,38 @@ Since: 2.26 </parameter> </parameters> <return> an array of strings + +</return> +</function> + +<function name="g_variant_dup_objv"> +<description> +Gets the contents of an array of object paths #GVariant. This call +makes a deep copy; the return result should be released with +g_strfreev(). + +If @length is non-%NULL then the number of elements in the result +is stored there. In any case, the resulting array will be +%NULL-terminated. + +For an empty array, @length will be set to 0 and a pointer to a +%NULL pointer will be returned. + +Since: 2.30 + +</description> +<parameters> +<parameter name="value"> +<parameter_description> an array of object paths #GVariant +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> the length of the result, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> an array of strings + </return> </function> @@ -40854,6 +46944,7 @@ Since: 2.24 </parameter> </parameters> <return> a newly allocated string, utf8 encoded + </return> </function> @@ -40884,6 +46975,7 @@ Since: 2.24 </parameter> </parameters> <return> an array of strings + </return> </function> @@ -40908,6 +47000,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE if @one and @two are equal + </return> </function> @@ -40962,6 +47055,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE or %FALSE + </return> </function> @@ -40982,6 +47076,7 @@ Since: 2.24 </parameter> </parameters> <return> a #guchar + </return> </function> @@ -41012,7 +47107,9 @@ Since: 2.26 </parameter_description> </parameter> </parameters> -<return> the constant string +<return> +the constant string + </return> </function> @@ -41043,6 +47140,7 @@ Since: 2.26 </parameter> </parameters> <return> an array of constant strings + </return> </function> @@ -41087,6 +47185,9 @@ entries. It is an error to call this function on any other type of It is an error if @index_ is greater than the number of child items in the container. See g_variant_n_children(). +The returned value is never floating. You should free it with +g_variant_unref() when you're done with it. + This function is O(1). Since: 2.24 @@ -41103,6 +47204,7 @@ Since: 2.24 </parameter> </parameters> <return> the child at the specified index + </return> </function> @@ -41124,6 +47226,16 @@ is O(1). If the value is not already in serialised form, serialisation occurs implicitly and is approximately O(n) in the size of the result. +To deserialise the data returned by this function, in addition to the +serialised data, you must know the type of the #GVariant, and (if the +machine might be different) the endianness of the machine that stored +it. As a result, file formats or network messages that incorporate +serialised #GVariant<!---->s must include this information either +implicitly (for instance "the file always contains a +%G_VARIANT_TYPE_VARIANT and it is always in little-endian order") or +explicitly (by storing the type and/or endianness in addition to the +serialised data). + Since: 2.24 </description> @@ -41134,6 +47246,7 @@ Since: 2.24 </parameter> </parameters> <return> the serialised form of @value, or %NULL + </return> </function> @@ -41154,6 +47267,7 @@ Since: 2.24 </parameter> </parameters> <return> a #gdouble + </return> </function> @@ -41163,13 +47277,36 @@ Provides access to the serialised data for an array of fixed-sized items. @value must be an array with fixed-sized elements. Numeric types are -fixed-size as are tuples containing only other fixed-sized types. - -@element_size must be the size of a single element in the array. For -example, if calling this function for an array of 32 bit integers, +fixed-size, as are tuples containing only other fixed-sized types. + +@element_size must be the size of a single element in the array, +as given by the section on +<link linkend='gvariant-serialised-data-memory'>Serialised Data +Memory</link>. + +In particular, arrays of these fixed-sized types can be interpreted +as an array of the given C type, with @element_size set to +<code>sizeof</code> the appropriate type: + +<informaltable> +<tgroup cols='2'> +<thead><row><entry>element type</entry> <entry>C type</entry></row></thead> +<tbody> +<row><entry>%G_VARIANT_TYPE_INT16 (etc.)</entry> +<entry>#gint16 (etc.)</entry></row> +<row><entry>%G_VARIANT_TYPE_BOOLEAN</entry> +<entry>#guchar (not #gboolean!)</entry></row> +<row><entry>%G_VARIANT_TYPE_BYTE</entry> <entry>#guchar</entry></row> +<row><entry>%G_VARIANT_TYPE_HANDLE</entry> <entry>#guint32</entry></row> +<row><entry>%G_VARIANT_TYPE_DOUBLE</entry> <entry>#gdouble</entry></row> +</tbody> +</tgroup> +</informaltable> + +For example, if calling this function for an array of 32 bit integers, you might say <code>sizeof (gint32)</code>. This value isn't used except for the purpose of a double-check that the form of the -seralised data matches the caller's expectation. +serialised data matches the caller's expectation. @n_elements, which must be non-%NULL is set equal to the number of items in the array. @@ -41191,7 +47328,9 @@ Since: 2.24 </parameter_description> </parameter> </parameters> -<return> a pointer to the fixed array +<return> a pointer to +the fixed array + </return> </function> @@ -41227,6 +47366,7 @@ Since: 2.24 </parameter> </parameters> <return> a #gint32 + </return> </function> @@ -41247,6 +47387,7 @@ Since: 2.24 </parameter> </parameters> <return> a #gint16 + </return> </function> @@ -41267,6 +47408,7 @@ Since: 2.24 </parameter> </parameters> <return> a #gint32 + </return> </function> @@ -41287,6 +47429,7 @@ Since: 2.24 </parameter> </parameters> <return> a #gint64 + </return> </function> @@ -41305,6 +47448,7 @@ Since: 2.24 </parameter> </parameters> <return> the contents of @value, or %NULL + </return> </function> @@ -41337,6 +47481,38 @@ Since: 2.24 </parameter> </parameters> <return> a trusted #GVariant + +</return> +</function> + +<function name="g_variant_get_objv"> +<description> +Gets the contents of an array of object paths #GVariant. This call +makes a shallow copy; the return result should be released with +g_free(), but the individual strings must not be modified. + +If @length is non-%NULL then the number of elements in the result +is stored there. In any case, the resulting array will be +%NULL-terminated. + +For an empty array, @length will be set to 0 and a pointer to a +%NULL pointer will be returned. + +Since: 2.30 + +</description> +<parameters> +<parameter name="value"> +<parameter_description> an array of object paths #GVariant +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> the length of the result, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> an array of constant strings + </return> </function> @@ -41364,6 +47540,7 @@ Since: 2.24 </parameter> </parameters> <return> the serialised size of @value + </return> </function> @@ -41399,6 +47576,7 @@ to store the length </parameter> </parameters> <return> the constant string, utf8 encoded + </return> </function> @@ -41428,8 +47606,8 @@ Since: 2.24 </parameter_description> </parameter> </parameters> -<return> an array of constant -strings +<return> an array of constant strings + </return> </function> @@ -41450,6 +47628,7 @@ Since: 2.24 </parameter> </parameters> <return> a #GVariantType + </return> </function> @@ -41469,6 +47648,7 @@ Since: 2.24 </parameter> </parameters> <return> the type string for the type of @value + </return> </function> @@ -41489,6 +47669,7 @@ Since: 2.24 </parameter> </parameters> <return> a #guint16 + </return> </function> @@ -41509,6 +47690,7 @@ Since: 2.24 </parameter> </parameters> <return> a #guint32 + </return> </function> @@ -41529,6 +47711,7 @@ Since: 2.24 </parameter> </parameters> <return> a #guint64 + </return> </function> @@ -41594,6 +47777,7 @@ Since: 2.24 </parameter> </parameters> <return> the item contained in the variant + </return> </function> @@ -41619,6 +47803,7 @@ Since: 2.24 </parameter> </parameters> <return> a hash value corresponding to @value + </return> </function> @@ -41626,6 +47811,8 @@ Since: 2.24 <description> Checks if @value is a container. +Since: 2.24 + </description> <parameters> <parameter name="value"> @@ -41634,6 +47821,7 @@ Checks if @value is a container. </parameter> </parameters> <return> %TRUE if @value is a container + </return> </function> @@ -41643,7 +47831,8 @@ Checks whether @value has a floating reference count. This function should only ever be used to assert that a given variant is or is not floating, or for debug purposes. To acquire a reference -to a variant that might be floating, always use g_variant_ref_sink(). +to a variant that might be floating, always use g_variant_ref_sink() +or g_variant_take_ref(). See g_variant_ref_sink() for more information about floating reference counts. @@ -41658,6 +47847,7 @@ Since: 2.26 </parameter> </parameters> <return> whether @value is floating + </return> </function> @@ -41684,6 +47874,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE if @value is in normal form + </return> </function> @@ -41708,6 +47899,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE if @string is a D-Bus object path + </return> </function> @@ -41729,6 +47921,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE if the type of @value matches @type + </return> </function> @@ -41751,6 +47944,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE if @string is a D-Bus type signature + </return> </function> @@ -41777,6 +47971,7 @@ Since: 2.24 </parameter> </parameters> <return> a new heap-allocated #GVariantIter + </return> </function> @@ -41821,6 +48016,7 @@ Since: 2.24 </parameter> </parameters> <return> the number of items in @value + </return> </function> @@ -41844,7 +48040,11 @@ used when iterating over an array. It is only valid to call this function with a string constant for the format string and the same string constant must be used each time. Mixing calls to this function and g_variant_iter_next() or g_variant_iter_next_value() on -the same iterator is not recommended. +the same iterator causes undefined behavior. + +If you break out of a such a while loop using g_variant_iter_loop() then +you must free or unreference all the unpacked values as you would with +g_variant_get(). Failure to do so will cause a memory leak. See the section on <link linkend='gvariant-format-strings'>GVariant Format Strings</link>. @@ -41867,13 +48067,22 @@ g_print ("Item '%s' has type '%s'\n", key, g_variant_get_type_string (value)); /<!-- -->* no need to free 'key' and 'value' here *<!-- -->/ +/<!-- -->* unless breaking out of this loop *<!-- -->/ } } </programlisting> </example> -If you want a slightly less magical alternative that requires more -typing, see g_variant_iter_next(). +For most cases you should use g_variant_iter_next(). + +This function is really only useful when unpacking into #GVariant or +#GVariantIter in order to allow you to skip the call to +g_variant_unref() or g_variant_iter_free(). + +For example, if you are only looping over simple integer and string +types, g_variant_iter_next() is definitely preferred. For string +types, use the '&' prefix to avoid allocating any memory at all (and +thereby avoiding the need to free anything as well). Since: 2.24 @@ -41892,8 +48101,9 @@ Since: 2.24 </parameter_description> </parameter> </parameters> -<return> %TRUE if a value was unpacked, or %FALSE if there as no +<return> %TRUE if a value was unpacked, or %FALSE if there was no value + </return> </function> @@ -41915,6 +48125,7 @@ Since: 2.24 </parameter> </parameters> <return> the number of children in the container + </return> </function> @@ -41939,6 +48150,7 @@ Since: 2.24 </parameter> </parameters> <return> a new heap-allocated #GVariantIter + </return> </function> @@ -42002,8 +48214,8 @@ Since: 2.24 </parameter_description> </parameter> </parameters> -<return> %TRUE if a value was unpacked, or %FALSE if there as no -value +<return> %TRUE if a value was unpacked, or %FALSE if there as no value + </return> </function> @@ -42049,6 +48261,7 @@ Since: 2.24 </parameter> </parameters> <return> a #GVariant, or %NULL + </return> </function> @@ -42159,6 +48372,7 @@ Since: 2.24 </parameter> </parameters> <return> the number of children in the container + </return> </function> @@ -42192,6 +48406,7 @@ Since: 2.24 </parameter> </parameters> <return> a new floating #GVariant instance + </return> </function> @@ -42232,6 +48447,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new #GVariant array + </return> </function> @@ -42249,6 +48465,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new boolean #GVariant instance + </return> </function> @@ -42266,6 +48483,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new byte #GVariant instance + </return> </function> @@ -42283,11 +48501,13 @@ Since: 2.26 </description> <parameters> <parameter name="string"> -<parameter_description> a normal nul-terminated string in no particular encoding +<parameter_description> a normal +nul-terminated string in no particular encoding </parameter_description> </parameter> </parameters> <return> a floating reference to a new bytestring #GVariant instance + </return> </function> @@ -42312,6 +48532,7 @@ Since: 2.26 </parameter> </parameters> <return> a new floating #GVariant instance + </return> </function> @@ -42337,6 +48558,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new dictionary entry #GVariant + </return> </function> @@ -42354,6 +48576,50 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new double #GVariant instance + +</return> +</function> + +<function name="g_variant_new_fixed_array"> +<description> +Provides access to the serialised data for an array of fixed-sized +items. + +@value must be an array with fixed-sized elements. Numeric types are +fixed-size as are tuples containing only other fixed-sized types. + +@element_size must be the size of a single element in the array. For +example, if calling this function for an array of 32 bit integers, +you might say <code>sizeof (gint32)</code>. This value isn't used +except for the purpose of a double-check that the form of the +serialised data matches the caller's expectation. + +@n_elements, which must be non-%NULL is set equal to the number of +items in the array. + +Since: 2.32 + +</description> +<parameters> +<parameter name="element_type"> +<parameter_description> the #GVariantType of each element +</parameter_description> +</parameter> +<parameter name="elements"> +<parameter_description> a pointer to the fixed array of contiguous elements +</parameter_description> +</parameter> +<parameter name="n_elements"> +<parameter_description> the number of elements +</parameter_description> +</parameter> +<parameter name="element_size"> +<parameter_description> the size of each element +</parameter_description> +</parameter> +</parameters> +<return> a floating reference to a new array #GVariant instance + </return> </function> @@ -42376,6 +48642,10 @@ as a file installed in /usr/lib alongside your application). You should set trusted to %FALSE if @data is read from the network, a file in the user's home directory, etc. +If @data was not stored in this machine's native endianness, any multi-byte +numeric values in the returned variant will also be in non-native +endianness. g_variant_byteswap() can be used to recover the original values. + @notify will be called with @user_data when @data is no longer needed. The exact time of this call is unspecified and might even be before this function returns. @@ -42410,6 +48680,7 @@ Since: 2.24 </parameter> </parameters> <return> a new floating #GVariant of type @type + </return> </function> @@ -42431,6 +48702,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new handle #GVariant instance + </return> </function> @@ -42448,6 +48720,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new int16 #GVariant instance + </return> </function> @@ -42465,6 +48738,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new int32 #GVariant instance + </return> </function> @@ -42482,6 +48756,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new int64 #GVariant instance + </return> </function> @@ -42512,6 +48787,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new #GVariant maybe instance + </return> </function> @@ -42531,6 +48807,35 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new object path #GVariant instance + +</return> +</function> + +<function name="g_variant_new_objv"> +<description> +Constructs an array of object paths #GVariant from the given array of +strings. + +Each string must be a valid #GVariant object path; see +g_variant_is_object_path(). + +If @length is -1 then @strv is %NULL-terminated. + +Since: 2.30 + +</description> +<parameters> +<parameter name="strv"> +<parameter_description> an array of strings +</parameter_description> +</parameter> +<parameter name="length"> +<parameter_description> the length of @strv, or -1 +</parameter_description> +</parameter> +</parameters> +<return> a new floating #GVariant instance + </return> </function> @@ -42560,9 +48865,10 @@ want to parse data from untrusted sources, use g_variant_parse(). You may not use this function to return, unmodified, a single #GVariant pointer from the argument list. ie: @format may not solely -be anything along the lines of "%*", "%?", "%r", or anything starting +be anything along the lines of "%*", "%?", "\%r", or anything starting with "%@". + </description> <parameters> <parameter name="format"> @@ -42598,6 +48904,7 @@ At this point, the caller will have their own full reference to the result. This can also be done by adding the result to a container, or by passing it to another g_variant_new() call. + </description> <parameters> <parameter name="format"> @@ -42629,6 +48936,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new signature #GVariant instance + </return> </function> @@ -42648,6 +48956,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new string #GVariant instance + </return> </function> @@ -42672,6 +48981,7 @@ Since: 2.24 </parameter> </parameters> <return> a new floating #GVariant instance + </return> </function> @@ -42700,6 +49010,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new #GVariant tuple + </return> </function> @@ -42717,6 +49028,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new uint16 #GVariant instance + </return> </function> @@ -42734,6 +49046,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new uint32 #GVariant instance + </return> </function> @@ -42751,6 +49064,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new uint64 #GVariant instance + </return> </function> @@ -42808,6 +49122,7 @@ or %NULL </parameter> </parameters> <return> a new, usually floating, #GVariant + </return> </function> @@ -42829,6 +49144,7 @@ Since: 2.24 </parameter> </parameters> <return> a floating reference to a new variant #GVariant instance + </return> </function> @@ -42860,7 +49176,7 @@ In the event that the parsing is successful, the resulting #GVariant is returned. In case of any error, %NULL will be returned. If @error is non-%NULL -then it will be set to reflect the error that occured. +then it will be set to reflect the error that occurred. Officially, the language understood by the parser is "any string produced by g_variant_print()". @@ -42901,6 +49217,8 @@ The format is described <link linkend='gvariant-text'>here</link>. If @type_annotate is %TRUE, then type information is included in the output. +Since: 2.24 + </description> <parameters> <parameter name="value"> @@ -42914,6 +49232,7 @@ the output </parameter> </parameters> <return> a newly-allocated string holding the result. + </return> </function> @@ -42943,6 +49262,7 @@ the output </parameter> </parameters> <return> a #GString containing the string + </return> </function> @@ -42960,6 +49280,7 @@ Since: 2.24 </parameter> </parameters> <return> the same @value + </return> </function> @@ -42998,6 +49319,7 @@ Since: 2.24 </parameter> </parameters> <return> the same @value + </return> </function> @@ -43010,6 +49332,10 @@ The stored data is in machine native byte order but may not be in fully-normalised form if read from an untrusted source. See g_variant_get_normal_form() for a solution. +As with g_variant_get_data(), to be able to deserialise the +serialised variant successfully, its type and (if the destination +machine might be different) its endianness must also be available. + This function is approximately O(n) in the size of @data. Since: 2.24 @@ -43028,12 +49354,58 @@ Since: 2.24 <return></return> </function> +<function name="g_variant_take_ref"> +<description> +If @value is floating, sink it. Otherwise, do nothing. + +Typically you want to use g_variant_ref_sink() in order to +automatically do the correct thing with respect to floating or +non-floating references, but there is one specific scenario where +this function is helpful. + +The situation where this function is helpful is when creating an API +that allows the user to provide a callback function that returns a +#GVariant. We certainly want to allow the user the flexibility to +return a non-floating reference from this callback (for the case +where the value that is being returned already exists). + +At the same time, the style of the #GVariant API makes it likely that +for newly-created #GVariant instances, the user can be saved some +typing if they are allowed to return a #GVariant with a floating +reference. + +Using this function on the return value of the user's callback allows +the user to do whichever is more convenient for them. The caller +will alway receives exactly one full reference to the value: either +the one that was returned in the first place, or a floating reference +that has been converted to a full reference. + +This function has an odd interaction when combined with +g_variant_ref_sink() running at the same time in another thread on +the same #GVariant instance. If g_variant_ref_sink() runs first then +the result will be that the floating reference is converted to a hard +reference. If g_variant_take_ref() runs first then the result will +be that the floating reference is converted to a hard reference and +an additional reference on top of that one is added. It is best to +avoid this situation. + + +</description> +<parameters> +<parameter name="value"> +<parameter_description> a #GVariant +</parameter_description> +</parameter> +</parameters> +<return> the same @value +</return> +</function> + <function name="g_variant_type_copy"> <description> Makes a copy of a #GVariantType. It is appropriate to call g_variant_type_free() on the return value. @type may not be %NULL. -Since 2.24 </description> <parameters> @@ -43043,6 +49415,8 @@ Since 2.24 </parameter> </parameters> <return> a new #GVariantType + +Since 2.24 </return> </function> @@ -43052,7 +49426,6 @@ Returns a newly-allocated copy of the type string corresponding to @type. The returned string is nul-terminated. It is appropriate to call g_free() on the return value. -Since 2.24 </description> <parameters> @@ -43062,6 +49435,8 @@ Since 2.24 </parameter> </parameters> <return> the corresponding type string + +Since 2.24 </return> </function> @@ -43071,7 +49446,6 @@ Determines the element type of an array or maybe type. This function may only be used with array or maybe types. -Since 2.24 </description> <parameters> @@ -43081,6 +49455,8 @@ Since 2.24 </parameter> </parameters> <return> the element type of @type + +Since 2.24 </return> </function> @@ -43097,7 +49473,6 @@ The argument types of @type1 and @type2 are only #gconstpointer to allow use with #GHashTable without function pointer casting. For both arguments, a valid #GVariantType must be provided. -Since 2.24 </description> <parameters> @@ -43111,6 +49486,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type1 and @type2 are exactly equal + +Since 2.24 </return> </function> @@ -43131,7 +49508,6 @@ the key. This call, together with g_variant_type_next() provides an iterator interface over tuple and dictionary entry types. -Since 2.24 </description> <parameters> @@ -43141,6 +49517,8 @@ Since 2.24 </parameter> </parameters> <return> the first item type of @type, or %NULL + +Since 2.24 </return> </function> @@ -43170,7 +49548,6 @@ Returns the length of the type string corresponding to the given @type. This function must be used to determine the valid extent of the memory region returned by g_variant_type_peek_string(). -Since 2.24 </description> <parameters> @@ -43180,6 +49557,8 @@ Since 2.24 </parameter> </parameters> <return> the length of the corresponding type string + +Since 2.24 </return> </function> @@ -43191,7 +49570,6 @@ The argument type of @type is only #gconstpointer to allow use with #GHashTable without function pointer casting. A valid #GVariantType must be provided. -Since 2.24 </description> <parameters> @@ -43201,6 +49579,8 @@ Since 2.24 </parameter> </parameters> <return> the hash value + +Since 2.24 </return> </function> @@ -43213,7 +49593,6 @@ This function returns %TRUE for any indefinite type for which every definite subtype is an array type -- %G_VARIANT_TYPE_ARRAY, for example. -Since 2.24 </description> <parameters> @@ -43223,6 +49602,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is an array type + +Since 2.24 </return> </function> @@ -43238,7 +49619,6 @@ Only a basic type may be used as the key of a dictionary entry. This function returns %FALSE for all indefinite types except %G_VARIANT_TYPE_BASIC. -Since 2.24 </description> <parameters> @@ -43248,6 +49628,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is a basic type + +Since 2.24 </return> </function> @@ -43262,7 +49644,6 @@ This function returns %TRUE for any indefinite type for which every definite subtype is a container -- %G_VARIANT_TYPE_ARRAY, for example. -Since 2.24 </description> <parameters> @@ -43272,6 +49653,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is a container type + +Since 2.24 </return> </function> @@ -43288,7 +49671,6 @@ result in %TRUE being returned. Calling this function on an indefinite type like %G_VARIANT_TYPE_ARRAY, however, will result in %FALSE being returned. -Since 2.24 </description> <parameters> @@ -43298,6 +49680,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is definite + +Since 2.24 </return> </function> @@ -43310,7 +49694,6 @@ This function returns %TRUE for any indefinite type for which every definite subtype is a dictionary entry type -- %G_VARIANT_TYPE_DICT_ENTRY, for example. -Since 2.24 </description> <parameters> @@ -43320,6 +49703,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is a dictionary entry type + +Since 2.24 </return> </function> @@ -43332,7 +49717,6 @@ This function returns %TRUE for any indefinite type for which every definite subtype is a maybe type -- %G_VARIANT_TYPE_MAYBE, for example. -Since 2.24 </description> <parameters> @@ -43342,6 +49726,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is a maybe type + +Since 2.24 </return> </function> @@ -43353,7 +49739,6 @@ This function returns %TRUE if @type is a subtype of @supertype. All types are considered to be subtypes of themselves. Aside from that, only indefinite types can have subtypes. -Since 2.24 </description> <parameters> @@ -43367,6 +49752,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is a subtype of @supertype + +Since 2.24 </return> </function> @@ -43380,7 +49767,6 @@ This function returns %TRUE for any indefinite type for which every definite subtype is a tuple type -- %G_VARIANT_TYPE_TUPLE, for example. -Since 2.24 </description> <parameters> @@ -43390,6 +49776,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is a tuple type + +Since 2.24 </return> </function> @@ -43397,7 +49785,6 @@ Since 2.24 <description> Determines if the given @type is the variant type. -Since 2.24 </description> <parameters> @@ -43407,6 +49794,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type is the variant type + +Since 2.24 </return> </function> @@ -43418,7 +49807,6 @@ This function may only be used with a dictionary entry type. Other than the additional restriction, this call is equivalent to g_variant_type_first(). -Since 2.24 </description> <parameters> @@ -43428,6 +49816,8 @@ Since 2.24 </parameter> </parameters> <return> the key type of the dictionary entry + +Since 2.24 </return> </function> @@ -43443,7 +49833,6 @@ but must not be used with the generic tuple type In the case of a dictionary entry type, this function will always return 2. -Since 2.24 </description> <parameters> @@ -43453,6 +49842,8 @@ Since 2.24 </parameter> </parameters> <return> the number of items in @type + +Since 2.24 </return> </function> @@ -43475,6 +49866,7 @@ Since: 2.24 </parameter> </parameters> <return> a new #GVariantType + </return> </function> @@ -43485,7 +49877,6 @@ type @type. It is appropriate to call g_variant_type_free() on the return value. -Since 2.24 </description> <parameters> @@ -43495,6 +49886,8 @@ Since 2.24 </parameter> </parameters> <return> a new array #GVariantType + +Since 2.24 </return> </function> @@ -43505,7 +49898,6 @@ of type @key and a value of type @value. It is appropriate to call g_variant_type_free() on the return value. -Since 2.24 </description> <parameters> @@ -43519,6 +49911,8 @@ Since 2.24 </parameter> </parameters> <return> a new dictionary entry #GVariantType + +Since 2.24 </return> </function> @@ -43529,7 +49923,6 @@ type @type or Nothing. It is appropriate to call g_variant_type_free() on the return value. -Since 2.24 </description> <parameters> @@ -43539,6 +49932,8 @@ Since 2.24 </parameter> </parameters> <return> a new maybe #GVariantType + +Since 2.24 </return> </function> @@ -43551,7 +49946,6 @@ Constructs a new tuple type, from @items. It is appropriate to call g_variant_type_free() on the return value. -Since 2.24 </description> <parameters> @@ -43565,6 +49959,8 @@ Since 2.24 </parameter> </parameters> <return> a new tuple #GVariantType + +Since 2.24 </return> </function> @@ -43582,7 +49978,6 @@ entry then this call returns %NULL. For tuples, %NULL is returned when @type is the last item in a tuple. -Since 2.24 </description> <parameters> @@ -43592,6 +49987,8 @@ Since 2.24 </parameter> </parameters> <return> the next #GVariantType after @type, or %NULL + +Since 2.24 </return> </function> @@ -43603,7 +50000,6 @@ must call g_variant_type_get_string_length(). To get a nul-terminated string, see g_variant_type_dup_string(). -Since 2.24 </description> <parameters> @@ -43613,6 +50009,8 @@ Since 2.24 </parameter> </parameters> <return> the corresponding type string (not nul-terminated) + +Since 2.24 </return> </function> @@ -43622,7 +50020,6 @@ Checks if @type_string is a valid GVariant type string. This call is equivalent to calling g_variant_type_string_scan() and confirming that the following character is a nul terminator. -Since 2.24 </description> <parameters> @@ -43632,6 +50029,8 @@ Since 2.24 </parameter> </parameters> <return> %TRUE if @type_string is exactly one valid type string + +Since 2.24 </return> </function> @@ -43669,6 +50068,7 @@ Since: 2.24 </parameter> </parameters> <return> %TRUE if a valid type string was found + </return> </function> @@ -43678,7 +50078,6 @@ Determines the value type of a dictionary entry type. This function may only be used with a dictionary entry type. -Since 2.24 </description> <parameters> @@ -43688,6 +50087,8 @@ Since 2.24 </parameter> </parameters> <return> the value type of the dictionary entry + +Since 2.24 </return> </function> @@ -43866,6 +50267,226 @@ Since: 2.2 </return> </function> +<function name="g_wakeup_acknowledge"> +<description> +Acknowledges receipt of a wakeup signal on @wakeup. + +You must call this after @wakeup polls as ready. If not, it will +continue to poll as ready until you do so. + +If you call this function and @wakeup is not signaled, nothing +happens. + +Since: 2.30 + +</description> +<parameters> +<parameter name="wakeup"> +<parameter_description> a #GWakeup +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_wakeup_free"> +<description> +Frees @wakeup. + +You must not currently be polling on the #GPollFD returned by +g_wakeup_get_pollfd(), or the result is undefined. + +</description> +<parameters> +<parameter name="wakeup"> +<parameter_description> a #GWakeup +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_wakeup_get_pollfd"> +<description> +Prepares a @poll_fd such that polling on it will succeed when +g_wakeup_signal() has been called on @wakeup. + +@poll_fd is valid until @wakeup is freed. + +Since: 2.30 + +</description> +<parameters> +<parameter name="wakeup"> +<parameter_description> a #GWakeup +</parameter_description> +</parameter> +<parameter name="poll_fd"> +<parameter_description> a #GPollFD +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_wakeup_new"> +<description> +Creates a new #GWakeup. + +You should use g_wakeup_free() to free it when you are done. + +Since: 2.30 + +</description> +<parameters> +</parameters> +<return> a new #GWakeup + +</return> +</function> + +<function name="g_wakeup_signal"> +<description> +Signals @wakeup. + +Any future (or present) polling on the #GPollFD returned by +g_wakeup_get_pollfd() will immediately succeed until such a time as +g_wakeup_acknowledge() is called. + +This function is safe to call from a UNIX signal handler. + +Since: 2.30 + +</description> +<parameters> +<parameter name="wakeup"> +<parameter_description> a #GWakeup +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_warning"> +<description> +A convenience function/macro to log a warning message. + +You can make warnings fatal at runtime by setting the +<envar>G_DEBUG</envar> environment variable (see +<ulink url="glib-running.html">Running GLib Applications</ulink>). + +</description> +<parameters> +<parameter name="Varargs"> +<parameter_description> format string, followed by parameters to insert +into the format string (as with printf()) +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_weak_ref_clear"> +<description> +Frees resources associated with a non-statically-allocated #GWeakRef. +After this call, the #GWeakRef is left in an undefined state. + +You should only call this on a #GWeakRef that previously had +g_weak_ref_init() called on it. + +Since: 2.32 + +</description> +<parameters> +<parameter name="weak_ref"> +<parameter_description> location of a weak reference, which +may be empty +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_weak_ref_get"> +<description> +If @weak_ref is not empty, atomically acquire a strong +reference to the object it points to, and return that reference. + +This function is needed because of the potential race between taking +the pointer value and g_object_ref() on it, if the object was losing +its last reference at the same time in a different thread. + +The caller should release the resulting reference in the usual way, +by using g_object_unref(). + +Since: 2.32 + +</description> +<parameters> +<parameter name="weak_ref"> +<parameter_description> location of a weak reference to a #GObject +</parameter_description> +</parameter> +</parameters> +<return> the object pointed to +by @weak_ref, or %NULL if it was empty + +</return> +</function> + +<function name="g_weak_ref_init"> +<description> +Initialise a non-statically-allocated #GWeakRef. + +This function also calls g_weak_ref_set() with @object on the +freshly-initialised weak reference. + +This function should always be matched with a call to +g_weak_ref_clear(). It is not necessary to use this function for a +#GWeakRef in static storage because it will already be +properly initialised. Just use g_weak_ref_set() directly. + +Since: 2.32 + +</description> +<parameters> +<parameter name="weak_ref"> +<parameter_description> uninitialized or empty location for a weak +reference +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> a #GObject or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_weak_ref_set"> +<description> +Change the object to which @weak_ref points, or set it to +%NULL. + +You must own a strong reference on @object while calling this +function. + +Since: 2.32 + +</description> +<parameters> +<parameter name="weak_ref"> +<parameter_description> location for a weak reference +</parameter_description> +</parameter> +<parameter name="object"> +<parameter_description> a #GObject or %NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="g_win32_error_message"> <description> Translate a Win32 error code (as returned by GetLastError()) into @@ -44040,7 +50661,7 @@ and zero on NT-based systems. Since version 2.14, GLib works only on NT-based systems, so checking whether your are running on Win9x in your own software is moot. The least significant byte is 4 on Windows NT 4, and 5 on Windows XP. Software that needs really -detailled version and feature information should use Win32 API like +detailed version and feature information should use Win32 API like GetVersionEx() and VerifyVersionInfo(). Since: 2.6 @@ -44108,6 +50729,164 @@ failure and lack of short names. </return> </function> +<function name="gboolean"> +<description> +A standard boolean type. +Variables of this type should only contain the value +%TRUE or %FALSE. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gchar"> +<description> +Corresponds to the standard C <type>char</type> type. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gconstpointer"> +<description> +An untyped pointer to constant data. +The data pointed to should not be changed. + +This is typically used in function prototypes to indicate +that the data pointed to will not be altered by the function. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gdouble"> +<description> +Corresponds to the standard C <type>double</type> type. +Values of this type can range from -#G_MAXDOUBLE to #G_MAXDOUBLE. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gfloat"> +<description> +Corresponds to the standard C <type>float</type> type. +Values of this type can range from -#G_MAXFLOAT to #G_MAXFLOAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gint"> +<description> +Corresponds to the standard C <type>int</type> type. +Values of this type can range from #G_MININT to #G_MAXINT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gint16"> +<description> +A signed integer guaranteed to be 16 bits on all platforms. +Values of this type can range from #G_MININT16 (= -32,768) to +#G_MAXINT16 (= 32,767). + +To print or scan values of this type, use +%G_GINT16_MODIFIER and/or %G_GINT16_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gint32"> +<description> +A signed integer guaranteed to be 32 bits on all platforms. +Values of this type can range from #G_MININT32 (= -2,147,483,648) +to #G_MAXINT32 (= 2,147,483,647). + +To print or scan values of this type, use +%G_GINT32_MODIFIER and/or %G_GINT32_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gint64"> +<description> +A signed integer guaranteed to be 64 bits on all platforms. +Values of this type can range from #G_MININT64 +(= -9,223,372,036,854,775,808) to #G_MAXINT64 +(= 9,223,372,036,854,775,807). + +To print or scan values of this type, use +%G_GINT64_MODIFIER and/or %G_GINT64_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gint8"> +<description> +A signed integer guaranteed to be 8 bits on all platforms. +Values of this type can range from #G_MININT8 (= -128) to +#G_MAXINT8 (= 127). + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gintptr"> +<description> +Corresponds to the C99 type <type>intptr_t</type>, +a signed integer type that can hold any pointer. + +To print or scan values of this type, use +%G_GINTPTR_MODIFIER and/or %G_GINTPTR_FORMAT. + +Since: 2.18 + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="glib__private__"> +<description> +Do not call this function; it is used to share private +API between glib, gobject, and gio. + +</description> +<parameters> +<parameter name="arg"> +<parameter_description> Do not use this argument +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + <function name="glib_check_version"> <description> Checks that the GLib library in use is compatible with the @@ -44203,8 +50982,207 @@ by a \004 character </parameter_description> </parameter> </parameters> -<return> the transation of @str to the current locale +<return> the translation of @str to the current locale </return> </function> +<function name="glong"> +<description> +Corresponds to the standard C <type>long</type> type. +Values of this type can range from #G_MINLONG to #G_MAXLONG. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="goffset"> +<description> +A signed integer type that is used for file offsets, +corresponding to the C99 type <type>off64_t</type>. +Values of this type can range from #G_MINOFFSET to +#G_MAXOFFSET. + +To print or scan values of this type, use +%G_GOFFSET_MODIFIER and/or %G_GOFFSET_FORMAT. + +Since: 2.14 + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gpointer"> +<description> +An untyped pointer. +#gpointer looks better and is easier to use +than <type>void*</type>. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gshort"> +<description> +Corresponds to the standard C <type>short</type> type. +Values of this type can range from #G_MINSHORT to #G_MAXSHORT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gsize"> +<description> +An unsigned integer type of the result of the sizeof operator, +corresponding to the <type>size_t</type> type defined in C99. +This type is wide enough to hold the numeric value of a pointer, +so it is usually 32bit wide on a 32bit platform and 64bit wide +on a 64bit platform. Values of this type can range from 0 to +#G_MAXSIZE. + +To print or scan values of this type, use +%G_GSIZE_MODIFIER and/or %G_GSIZE_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gssize"> +<description> +A signed variant of #gsize, corresponding to the +<type>ssize_t</type> defined on most platforms. +Values of this type can range from #G_MINSSIZE +to #G_MAXSSIZE. + +To print or scan values of this type, use +%G_GSIZE_MODIFIER and/or %G_GSSIZE_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="guchar"> +<description> +Corresponds to the standard C <type>unsigned char</type> type. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="guint"> +<description> +Corresponds to the standard C <type>unsigned int</type> type. +Values of this type can range from 0 to #G_MAXUINT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="guint16"> +<description> +An unsigned integer guaranteed to be 16 bits on all platforms. +Values of this type can range from 0 to #G_MAXUINT16 (= 65,535). + +To print or scan values of this type, use +%G_GINT16_MODIFIER and/or %G_GUINT16_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="guint32"> +<description> +An unsigned integer guaranteed to be 32 bits on all platforms. +Values of this type can range from 0 to #G_MAXUINT32 (= 4,294,967,295). + +To print or scan values of this type, use +%G_GINT32_MODIFIER and/or %G_GUINT32_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="guint64"> +<description> +An unsigned integer guaranteed to be 64 bits on all platforms. +Values of this type can range from 0 to #G_MAXUINT64 +(= 18,446,744,073,709,551,615). + +To print or scan values of this type, use +%G_GINT64_MODIFIER and/or %G_GUINT64_FORMAT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="guint8"> +<description> +An unsigned integer guaranteed to be 8 bits on all platforms. +Values of this type can range from 0 to #G_MAXUINT8 (= 255). + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="guintptr"> +<description> +Corresponds to the C99 type <type>uintptr_t</type>, +an unsigned integer type that can hold any pointer. + +To print or scan values of this type, use +%G_GINTPTR_MODIFIER and/or %G_GUINTPTR_FORMAT. + +Since: 2.18 + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gulong"> +<description> +Corresponds to the standard C <type>unsigned long</type> type. +Values of this type can range from 0 to #G_MAXULONG. + +</description> +<parameters> +</parameters> +<return></return> +</function> + +<function name="gushort"> +<description> +Corresponds to the standard C <type>unsigned short</type> type. +Values of this type can range from 0 to #G_MAXUSHORT. + +</description> +<parameters> +</parameters> +<return></return> +</function> + </root> |