diff options
| author | Murray Cumming <murrayc@murrayc.com> | 2016-09-10 11:02:36 +0200 |
|---|---|---|
| committer | Murray Cumming <murrayc@murrayc.com> | 2016-09-10 11:02:36 +0200 |
| commit | 4ccb2a25ba0fc2433b69cd4a1c764382a23b3e67 (patch) | |
| tree | 01c45dfbdea33cf3810c7112e8aad068274e527c | |
| parent | 1be5f6c46e5b6e1352829b4383535b4c3b9e2b09 (diff) | |
| download | glibmm-4ccb2a25ba0fc2433b69cd4a1c764382a23b3e67.tar.gz | |
Regenerate *docs.xml files.
| -rw-r--r-- | gio/src/gio_docs.xml | 2902 | ||||
| -rw-r--r-- | glib/src/glib_docs.xml | 794 |
2 files changed, 3583 insertions, 113 deletions
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml index a575ef99..239e443f 100644 --- a/gio/src/gio_docs.xml +++ b/gio/src/gio_docs.xml @@ -704,23 +704,23 @@ Since: 2.26 </parameter_description> </parameter> <parameter name="G_CREDENTIALS_TYPE_LINUX_UCRED"> -<parameter_description> The native credentials type is a <type>struct ucred</type>. +<parameter_description> The native credentials type is a struct ucred. </parameter_description> </parameter> <parameter name="G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED"> -<parameter_description> The native credentials type is a <type>struct cmsgcred</type>. +<parameter_description> The native credentials type is a struct cmsgcred. </parameter_description> </parameter> <parameter name="G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED"> -<parameter_description> The native credentials type is a <type>struct sockpeercred</type>. Added in 2.30. +<parameter_description> The native credentials type is a struct sockpeercred. Added in 2.30. </parameter_description> </parameter> <parameter name="G_CREDENTIALS_TYPE_SOLARIS_UCRED"> -<parameter_description> The native credentials type is a <type>ucred_t</type>. Added in 2.40. +<parameter_description> The native credentials type is a ucred_t. Added in 2.40. </parameter_description> </parameter> <parameter name="G_CREDENTIALS_TYPE_NETBSD_UNPCBID"> -<parameter_description> The native credentials type is a <type>struct unpcbid</type>. +<parameter_description> The native credentials type is a struct unpcbid. </parameter_description> </parameter> </parameters> @@ -2973,7 +2973,7 @@ Compare with `du -x`. <description> Emitted when @file has been changed. -If using %G_FILE_MONITOR_WATCH_RENAMES on a directory monitor, and +If using %G_FILE_MONITOR_WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), @event_type may be %G_FILE_MONITOR_EVENT_RENAMED, %G_FILE_MONITOR_EVENT_MOVED_IN or %G_FILE_MONITOR_EVENT_MOVED_OUT. @@ -2992,7 +2992,7 @@ equivalent to %G_FILE_MONITOR_EVENT_CREATED and %G_FILE_MONITOR_EVENT_DELETED, with extra information. %G_FILE_MONITOR_EVENT_RENAMED is equivalent to a delete/create pair. This is exactly how the events will be reported in the case -that the %G_FILE_MONITOR_WATCH_RENAMES flag is not in use. +that the %G_FILE_MONITOR_WATCH_MOVES flag is not in use. If using the deprecated flag %G_FILE_MONITOR_SEND_MOVED flag and @event_type is #G_FILE_MONITOR_EVENT_MOVED, @file will be set to a #GFile containing the @@ -4604,6 +4604,9 @@ This signal supports detailed connections. You can connect to the detailed signal "changed::x" in order to only receive callbacks when key "x" changes. +Note that @settings only emits this signal if you have read @key at +least once while a signal handler was already connected for @key. + </description> <parameters> <parameter name="settings"> @@ -6646,6 +6649,353 @@ Since: 2.46 </description> </property> +<signal name="GXdpDocuments::handle-add"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Add">Add()</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 gxdp_documents_complete_add() 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 #GXdpDocuments. +</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_o_path_fd"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_reuse_existing"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_persistent"> +<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="GXdpDocuments::handle-add-named"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.AddNamed">AddNamed()</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 gxdp_documents_complete_add_named() 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 #GXdpDocuments. +</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_o_path_parent_fd"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_filename"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_reuse_existing"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_persistent"> +<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="GXdpDocuments::handle-delete"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Delete">Delete()</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 gxdp_documents_complete_delete() 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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<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="GXdpDocuments::handle-get-mount-point"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GetMountPoint">GetMountPoint()</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 gxdp_documents_complete_get_mount_point() 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 #GXdpDocuments. +</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="GXdpDocuments::handle-grant-permissions"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GrantPermissions">GrantPermissions()</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 gxdp_documents_complete_grant_permissions() 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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_permissions"> +<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="GXdpDocuments::handle-info"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Info">Info()</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 gxdp_documents_complete_info() 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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<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="GXdpDocuments::handle-list"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.List">List()</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 gxdp_documents_complete_list() 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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<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="GXdpDocuments::handle-lookup"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Lookup">Lookup()</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 gxdp_documents_complete_lookup() 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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_filename"> +<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="GXdpDocuments::handle-revoke-permissions"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-Documents.RevokePermissions">RevokePermissions()</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 gxdp_documents_complete_revoke_permissions() 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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<parameter_description> Argument passed by remote caller. +</parameter_description> +</parameter> +<parameter name="arg_permissions"> +<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="GXdpNetworkMonitor::changed"> +<description> +On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-freedesktop-portal-NetworkMonitor.changed">"changed"</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 #GXdpNetworkMonitor. +</parameter_description> +</parameter> +<parameter name="arg_available"> +<parameter_description> Argument. +</parameter_description> +</parameter> +</parameters> +<return></return> +</signal> + +<property name="GXdpNetworkMonitor:available"> +<description> +Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.available">"available"</link>. + +Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + +</description> +</property> + +<property name="GXdpNetworkMonitor:connectivity"> +<description> +Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.connectivity">"connectivity"</link>. + +Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + +</description> +</property> + +<property name="GXdpNetworkMonitor:metered"> +<description> +Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.metered">"metered"</link>. + +Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + +</description> +</property> + +<signal name="GXdpProxyResolver::handle-lookup"> +<description> +Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-portal-ProxyResolver.Lookup">Lookup()</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 gxdp_proxy_resolver_complete_lookup() 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 #GXdpProxyResolver. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="arg_uri"> +<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> + <property name="GZlibCompressor:file-info"> <description> If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is @@ -7555,10 +7905,9 @@ Formats a detailed action name from @action_name and @target_value. It is an error to call this function with an invalid action name. -This function is the opposite of -g_action_parse_detailed_action_name(). It will produce a string that -can be parsed back to the @action_name and @target_value by that -function. +This function is the opposite of g_action_parse_detailed_name(). +It will produce a string that can be parsed back to the @action_name +and @target_value by that function. See that function for the types of strings that will be printed by this function. @@ -7788,7 +8137,7 @@ Since: 2.20 </parameter_description> </parameter> </parameters> -<return> a string containing the @appinfo's commandline, +<return> a string containing the @appinfo's commandline, or %NULL if this information is not available </return> @@ -7884,7 +8233,7 @@ Gets the executable's name for the installed application. </parameter_description> </parameter> </parameters> -<return> a string containing the @appinfo's application +<return> a string containing the @appinfo's application binaries name </return> </function> @@ -8082,11 +8431,11 @@ required. </parameter_description> </parameter> <parameter name="launch_context"> -<parameter_description> an optional #GAppLaunchContext. +<parameter_description> an optional #GAppLaunchContext </parameter_description> </parameter> <parameter name="error"> -<parameter_description> a #GError. +<parameter_description> return location for an error, or %NULL </parameter_description> </parameter> </parameters> @@ -8094,6 +8443,62 @@ required. </return> </function> +<function name="g_app_info_launch_default_for_uri_async"> +<description> +Async version of g_app_info_launch_default_for_uri(). + +This version is useful if you are interested in receiving +error information in the case where the application is +sandboxed and the portal may present an application chooser +dialog to the user. + +Since: 2.50 + +</description> +<parameters> +<parameter name="uri"> +<parameter_description> the uri to show +</parameter_description> +</parameter> +<parameter name="context"> +<parameter_description> an optional #GAppLaunchContext +cancellable: (allow-none): a #GCancellable +</parameter_description> +</parameter> +<parameter name="callback"> +<parameter_description> a #GASyncReadyCallback to call when the request is done +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data to pass to @callback +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_app_info_launch_default_for_uri_finish"> +<description> +Finishes an asynchronous launch-default-for-uri operation. + +Since: 2.50 + +</description> +<parameters> +<parameter name="result"> +<parameter_description> a #GAsyncResult +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for an error, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if the launch was successful, %FALSE if @error is set + +</return> +</function> + <function name="g_app_info_launch_uris"> <description> Launches the application. This passes the @uris to the launched application @@ -8209,7 +8614,8 @@ Sets the application as the default handler for the given file extension. </parameter_description> </parameter> <parameter name="extension"> -<parameter_description> a string containing the file extension (without the dot). +<parameter_description> a string containing the file extension +(without the dot). </parameter_description> </parameter> <parameter name="error"> @@ -19519,8 +19925,7 @@ Since: 2.30 </description> <parameters> <parameter name="object_path"> -<parameter_description> The object path to export the manager object at, which should -not be `/`. +<parameter_description> The object path to export the manager object at. </parameter_description> </parameter> </parameters> @@ -20970,7 +21375,8 @@ Since: 2.24 </parameter_description> </parameter> </parameters> -<return> The full path to the file for @info, or %NULL if not known. +<return> The full path to the file for @info, +or %NULL if not known. </return> </function> @@ -21356,7 +21762,8 @@ Creates a new #GDesktopAppInfo. </description> <parameters> <parameter name="filename"> -<parameter_description> the path of a desktop file, in the GLib filename encoding +<parameter_description> the path of a desktop file, in the GLib +filename encoding </parameter_description> </parameter> </parameters> @@ -21864,6 +22271,25 @@ Checks if the @drive supports removable media. </return> </function> +<function name="g_drive_is_removable"> +<description> +Checks if the #GDrive and/or its media is considered removable by the user. +See g_drive_is_media_removable(). + +Since: 2.50 + +</description> +<parameters> +<parameter name="drive"> +<parameter_description> a #GDrive. +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + +</return> +</function> + <function name="g_drive_poll_for_media"> <description> Asynchronously polls @drive to see if media has been inserted or removed. @@ -24562,7 +24988,7 @@ the gboolean return value signifies "end of iteration or error", which requires allocation of a temporary #GError. In contrast, with this function, a %FALSE return from -gs_file_enumerator_iterate() *always* means +g_file_enumerator_iterate() *always* means "error". End of iteration is signaled by @out_info or @out_child being %NULL. Another crucial difference is that the references for @out_info and @@ -24907,9 +25333,9 @@ This call does no blocking I/O. </parameter_description> </parameter> </parameters> -<return> string containing the #GFile's base name, or -%NULL if given #GFile is invalid. The returned string should be -freed with g_free() when no longer needed. +<return> string containing the #GFile's +base name, or %NULL if given #GFile is invalid. The returned string +should be freed with g_free() when no longer needed. </return> </function> @@ -25041,8 +25467,8 @@ This call does no blocking I/O. </parameter_description> </parameter> </parameters> -<return> string containing the #GFile's path, or %NULL -if no such path exists. The returned string should be freed +<return> string containing the #GFile's path, +or %NULL if no such path exists. The returned string should be freed with g_free() when no longer needed. </return> </function> @@ -25065,8 +25491,8 @@ This call does no blocking I/O. </parameter_description> </parameter> </parameters> -<return> string with the relative path from @descendant -to @parent, or %NULL if @descendant doesn't have @parent as +<return> string with the relative path from +@descendant to @parent, or %NULL if @descendant doesn't have @parent as prefix. The returned string should be freed with g_free() when no longer needed. </return> @@ -27153,7 +27579,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. </parameter_description> </parameter> <parameter name="symlink_value"> -<parameter_description> a string with the path for the target of the new symlink +<parameter_description> a string with the path for the target +of the new symlink </parameter_description> </parameter> <parameter name="cancellable"> @@ -31202,7 +31629,7 @@ Since: 2.22 Creates a new #GInetSocketAddress for @address and @port. If @address is an IPv6 address, it can also contain a scope ID -(separated from the address by a "<literal>%</literal>"). +(separated from the address by a `%`). Since: 2.40 @@ -32539,7 +32966,8 @@ which allows delayed/lazy loading of modules. </description> <parameters> <parameter name="dirname"> -<parameter_description> pathname for a directory containing modules to load. +<parameter_description> pathname for a directory containing modules +to load. </parameter_description> </parameter> </parameters> @@ -32565,7 +32993,8 @@ Since: 2.30 </description> <parameters> <parameter name="dirname"> -<parameter_description> pathname for a directory containing modules to load. +<parameter_description> pathname for a directory containing modules +to load. </parameter_description> </parameter> <parameter name="scope"> @@ -32602,7 +33031,8 @@ Since: 2.24 </description> <parameters> <parameter name="dirname"> -<parameter_description> pathname for a directory containing modules to scan. +<parameter_description> pathname for a directory containing modules +to scan. </parameter_description> </parameter> </parameters> @@ -32628,7 +33058,8 @@ Since: 2.30 </description> <parameters> <parameter name="dirname"> -<parameter_description> pathname for a directory containing modules to scan. +<parameter_description> pathname for a directory containing modules +to scan. </parameter_description> </parameter> <parameter name="scope"> @@ -41496,6 +41927,33 @@ Since: 2.26 </return> </function> +<function name="g_settings_get_int64"> +<description> +Gets the value that is stored at @key in @settings. + +A convenience variant of g_settings_get() for 64-bit integers. + +It is a programmer error to give a @key that isn't specified as +having a int64 type in the schema for @settings. + +Since: 2.50 + +</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> a 64-bit integer + +</return> +</function> + <function name="g_settings_get_mapped"> <description> Gets the value that is stored at @key in @settings, subject to @@ -41655,6 +42113,34 @@ Since: 2.30 </return> </function> +<function name="g_settings_get_uint64"> +<description> +Gets the value that is stored at @key in @settings. + +A convenience variant of g_settings_get() for 64-bit unsigned +integers. + +It is a programmer error to give a @key that isn't specified as +having a uint64 type in the schema for @settings. + +Since: 2.50 + +</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> a 64-bit unsigned integer + +</return> +</function> + <function name="g_settings_get_user_value"> <description> Checks the "user value" of a key, if there is one. @@ -42862,6 +43348,38 @@ Since: 2.26 </return> </function> +<function name="g_settings_set_int64"> +<description> +Sets @key in @settings to @value. + +A convenience variant of g_settings_set() for 64-bit integers. + +It is a programmer error to give a @key that isn't specified as +having a int64 type in the schema for @settings. + +Since: 2.50 + +</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> + <function name="g_settings_set_string"> <description> Sets @key in @settings to @value. @@ -42960,6 +43478,39 @@ Since: 2.30 </return> </function> +<function name="g_settings_set_uint64"> +<description> +Sets @key in @settings to @value. + +A convenience variant of g_settings_set() for 64-bit unsigned +integers. + +It is a programmer error to give a @key that isn't specified as +having a uint64 type in the schema for @settings. + +Since: 2.50 + +</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> + <function name="g_settings_set_value"> <description> Sets @key in @settings to @value. @@ -47832,6 +48383,10 @@ Creates a new #GSocketService with no sockets to listen for. New listeners can be added with e.g. g_socket_listener_add_address() or g_socket_listener_add_inet_port(). +New services are created active, there is no need to call +g_socket_service_start(), unless g_socket_service_stop() has been +called before. + Since: 2.22 </description> @@ -47844,8 +48399,10 @@ Since: 2.22 <function name="g_socket_service_start"> <description> -Starts the service, i.e. start accepting connections -from the added sockets when the mainloop runs. +Restarts the service, i.e. start accepting connections +from the added sockets when the mainloop runs. This only needs +to be called after the service has been stopped from +g_socket_service_stop(). This call is thread-safe, so it may be called from a thread handling an incoming client request. @@ -47876,6 +48433,10 @@ g_socket_service_start() again later to begin listening again. To close the listening sockets, call g_socket_listener_close(). (This will happen automatically when the #GSocketService is finalized.) +This must be called before calling g_socket_listener_close() as +the socket service will start accepting connections immediately +when a new socket is added. + Since: 2.22 </description> @@ -49155,7 +49716,7 @@ Since: 2.40 </parameter_description> </parameter> <parameter name="path"> -<parameter_description> a filename or %NULL +<parameter_description> (type filename) (nullable: a filename or %NULL </parameter_description> </parameter> </parameters> @@ -51268,12 +51829,13 @@ Since: 2.28 </description> <parameters> <parameter name="cert_file"> -<parameter_description> file containing one or more PEM-encoded certificates to -import +<parameter_description> file containing one or more PEM-encoded +certificates to import </parameter_description> </parameter> <parameter name="key_file"> -<parameter_description> file containing a PEM-encoded private key to import +<parameter_description> file containing a PEM-encoded private key +to import </parameter_description> </parameter> <parameter name="error"> @@ -55040,6 +55602,101 @@ Free the returned object with g_object_unref(). </return> </function> +<function name="g_vfs_register_uri_scheme"> +<description> +Registers @uri_func and @parse_name_func as the #GFile URI and parse name +lookup functions for URIs with a scheme matching @scheme. +Note that @scheme is registered only within the running application, as +opposed to desktop-wide as it happens with GVfs backends. + +When a #GFile is requested with an URI containing @scheme (e.g. through +g_file_new_for_uri()), @uri_func will be called to allow a custom +constructor. The implementation of @uri_func should not be blocking, and +must not call g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme(). + +When g_file_parse_name() is called with a parse name obtained from such file, +@parse_name_func will be called to allow the #GFile to be created again. In +that case, it's responsibility of @parse_name_func to make sure the parse +name matches what the custom #GFile implementation returned when +g_file_get_parse_name() was previously called. The implementation of +@parse_name_func should not be blocking, and must not call +g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme(). + +It's an error to call this function twice with the same scheme. To unregister +a custom URI scheme, use g_vfs_unregister_uri_scheme(). + +Since: 2.50 + +</description> +<parameters> +<parameter name="vfs"> +<parameter_description> a #GVfs +</parameter_description> +</parameter> +<parameter name="scheme"> +<parameter_description> an URI scheme, e.g. "http" +</parameter_description> +</parameter> +<parameter name="uri_func"> +<parameter_description> a #GVfsFileLookupFunc +</parameter_description> +</parameter> +<parameter name="uri_data"> +<parameter_description> custom data passed to be passed to @uri_func, or %NULL +</parameter_description> +</parameter> +<parameter name="uri_destroy"> +<parameter_description> function to be called when unregistering the +URI scheme, or when @vfs is disposed, to free the resources used +by the URI lookup function +</parameter_description> +</parameter> +<parameter name="parse_name_func"> +<parameter_description> a #GVfsFileLookupFunc +</parameter_description> +</parameter> +<parameter name="parse_name_data"> +<parameter_description> custom data passed to be passed to +@parse_name_func, or %NULL +</parameter_description> +</parameter> +<parameter name="parse_name_destroy"> +<parameter_description> function to be called when unregistering the +URI scheme, or when @vfs is disposed, to free the resources used +by the parse name lookup function +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @scheme was successfully registered, or %FALSE if a handler +for @scheme already exists. + +</return> +</function> + +<function name="g_vfs_unregister_uri_scheme"> +<description> +Unregisters the URI handler for @scheme previously registered with +g_vfs_register_uri_scheme(). + +Since: 2.50 + +</description> +<parameters> +<parameter name="vfs"> +<parameter_description> a #GVfs +</parameter_description> +</parameter> +<parameter name="scheme"> +<parameter_description> an URI scheme, e.g. "http" +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @scheme was successfully unregistered, or %FALSE if a +handler for @scheme does not exist. + +</return> +</function> + <function name="g_volume_can_eject"> <description> Checks if a volume can be ejected. @@ -56919,4 +57576,2169 @@ GetLogicalDrives() is returned. </return> </function> +<function name="gxdp_documents_call_add"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Add">Add()</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 gxdp_documents_call_add_finish() to get the result of the operation. + +See gxdp_documents_call_add_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_o_path_fd"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_reuse_existing"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_persistent"> +<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="gxdp_documents_call_add_finish"> +<description> +Finishes an operation started with gxdp_documents_call_add(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="out_doc_id"> +<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 gxdp_documents_call_add(). +</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="gxdp_documents_call_add_named"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.AddNamed">AddNamed()</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 gxdp_documents_call_add_named_finish() to get the result of the operation. + +See gxdp_documents_call_add_named_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_o_path_parent_fd"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_filename"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_reuse_existing"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_persistent"> +<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="gxdp_documents_call_add_named_finish"> +<description> +Finishes an operation started with gxdp_documents_call_add_named(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="out_doc_id"> +<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 gxdp_documents_call_add_named(). +</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="gxdp_documents_call_add_named_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.AddNamed">AddNamed()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_add_named() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_o_path_parent_fd"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_filename"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_reuse_existing"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_persistent"> +<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_doc_id"> +<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="gxdp_documents_call_add_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Add">Add()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_add() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_o_path_fd"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_reuse_existing"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_persistent"> +<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_doc_id"> +<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="gxdp_documents_call_delete"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Delete">Delete()</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 gxdp_documents_call_delete_finish() to get the result of the operation. + +See gxdp_documents_call_delete_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<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="gxdp_documents_call_delete_finish"> +<description> +Finishes an operation started with gxdp_documents_call_delete(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_documents_call_delete(). +</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="gxdp_documents_call_delete_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Delete">Delete()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_delete() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<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="gxdp_documents_call_get_mount_point"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GetMountPoint">GetMountPoint()</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 gxdp_documents_call_get_mount_point_finish() to get the result of the operation. + +See gxdp_documents_call_get_mount_point_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</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="gxdp_documents_call_get_mount_point_finish"> +<description> +Finishes an operation started with gxdp_documents_call_get_mount_point(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="out_path"> +<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 gxdp_documents_call_get_mount_point(). +</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="gxdp_documents_call_get_mount_point_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GetMountPoint">GetMountPoint()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_get_mount_point() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="out_path"> +<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="gxdp_documents_call_grant_permissions"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GrantPermissions">GrantPermissions()</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 gxdp_documents_call_grant_permissions_finish() to get the result of the operation. + +See gxdp_documents_call_grant_permissions_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_permissions"> +<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="gxdp_documents_call_grant_permissions_finish"> +<description> +Finishes an operation started with gxdp_documents_call_grant_permissions(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_documents_call_grant_permissions(). +</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="gxdp_documents_call_grant_permissions_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GrantPermissions">GrantPermissions()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_grant_permissions() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_permissions"> +<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="gxdp_documents_call_info"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Info">Info()</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 gxdp_documents_call_info_finish() to get the result of the operation. + +See gxdp_documents_call_info_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<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="gxdp_documents_call_info_finish"> +<description> +Finishes an operation started with gxdp_documents_call_info(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="out_path"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_apps"> +<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 gxdp_documents_call_info(). +</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="gxdp_documents_call_info_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Info">Info()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_info() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_path"> +<parameter_description> Return location for return parameter or %NULL to ignore. +</parameter_description> +</parameter> +<parameter name="out_apps"> +<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="gxdp_documents_call_list"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.List">List()</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 gxdp_documents_call_list_finish() to get the result of the operation. + +See gxdp_documents_call_list_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<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="gxdp_documents_call_list_finish"> +<description> +Finishes an operation started with gxdp_documents_call_list(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="out_docs"> +<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 gxdp_documents_call_list(). +</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="gxdp_documents_call_list_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.List">List()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_list() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_docs"> +<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="gxdp_documents_call_lookup"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Lookup">Lookup()</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 gxdp_documents_call_lookup_finish() to get the result of the operation. + +See gxdp_documents_call_lookup_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_filename"> +<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="gxdp_documents_call_lookup_finish"> +<description> +Finishes an operation started with gxdp_documents_call_lookup(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="out_doc_id"> +<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 gxdp_documents_call_lookup(). +</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="gxdp_documents_call_lookup_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Lookup">Lookup()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_lookup() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_filename"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_doc_id"> +<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="gxdp_documents_call_revoke_permissions"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.RevokePermissions">RevokePermissions()</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 gxdp_documents_call_revoke_permissions_finish() to get the result of the operation. + +See gxdp_documents_call_revoke_permissions_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_permissions"> +<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="gxdp_documents_call_revoke_permissions_finish"> +<description> +Finishes an operation started with gxdp_documents_call_revoke_permissions(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_documents_call_revoke_permissions(). +</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="gxdp_documents_call_revoke_permissions_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-Documents.RevokePermissions">RevokePermissions()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_documents_call_revoke_permissions() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpDocumentsProxy. +</parameter_description> +</parameter> +<parameter name="arg_doc_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_app_id"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="arg_permissions"> +<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="gxdp_documents_complete_add"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Add">Add()</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 #GXdpDocuments. +</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="doc_id"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_add_named"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.AddNamed">AddNamed()</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 #GXdpDocuments. +</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="doc_id"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_delete"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Delete">Delete()</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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_get_mount_point"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GetMountPoint">GetMountPoint()</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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="path"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_grant_permissions"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.GrantPermissions">GrantPermissions()</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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_info"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Info">Info()</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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="path"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +<parameter name="apps"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_list"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.List">List()</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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="docs"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_lookup"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.Lookup">Lookup()</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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="doc_id"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_complete_revoke_permissions"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-Documents.RevokePermissions">RevokePermissions()</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 #GXdpDocuments. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_documents_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-portal-Documents.top_of_page">org.freedesktop.portal.Documents</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="gxdp_documents_override_properties"> +<description> +Overrides all #GObject properties in the #GXdpDocuments 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="gxdp_documents_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-Documents.top_of_page">org.freedesktop.portal.Documents</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 gxdp_documents_proxy_new_finish() to get the result of the operation. + +See gxdp_documents_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="gxdp_documents_proxy_new_finish"> +<description> +Finishes an operation started with gxdp_documents_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_documents_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="gxdp_documents_proxy_new_for_bus"> +<description> +Like gxdp_documents_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 gxdp_documents_proxy_new_for_bus_finish() to get the result of the operation. + +See gxdp_documents_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="gxdp_documents_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with gxdp_documents_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_documents_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="gxdp_documents_proxy_new_for_bus_sync"> +<description> +Like gxdp_documents_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gxdp_documents_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="gxdp_documents_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-Documents.top_of_page">org.freedesktop.portal.Documents</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gxdp_documents_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="gxdp_documents_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-Documents.top_of_page">org.freedesktop.portal.Documents</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="gxdp_network_monitor_emit_changed"> +<description> +Emits the <link linkend="gdbus-signal-org-freedesktop-portal-NetworkMonitor.changed">"changed"</link> D-Bus signal. + +</description> +<parameters> +<parameter name="object"> +<parameter_description> A #GXdpNetworkMonitor. +</parameter_description> +</parameter> +<parameter name="arg_available"> +<parameter_description> Argument to pass with the signal. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_network_monitor_get_available"> +<description> +Gets the value of the <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.available">"available"</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 #GXdpNetworkMonitor. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="gxdp_network_monitor_get_connectivity"> +<description> +Gets the value of the <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.connectivity">"connectivity"</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 #GXdpNetworkMonitor. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="gxdp_network_monitor_get_metered"> +<description> +Gets the value of the <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.metered">"metered"</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 #GXdpNetworkMonitor. +</parameter_description> +</parameter> +</parameters> +<return> The property value. +</return> +</function> + +<function name="gxdp_network_monitor_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-portal-NetworkMonitor.top_of_page">org.freedesktop.portal.NetworkMonitor</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="gxdp_network_monitor_override_properties"> +<description> +Overrides all #GObject properties in the #GXdpNetworkMonitor 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="gxdp_network_monitor_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-NetworkMonitor.top_of_page">org.freedesktop.portal.NetworkMonitor</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 gxdp_network_monitor_proxy_new_finish() to get the result of the operation. + +See gxdp_network_monitor_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="gxdp_network_monitor_proxy_new_finish"> +<description> +Finishes an operation started with gxdp_network_monitor_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_network_monitor_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="gxdp_network_monitor_proxy_new_for_bus"> +<description> +Like gxdp_network_monitor_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 gxdp_network_monitor_proxy_new_for_bus_finish() to get the result of the operation. + +See gxdp_network_monitor_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="gxdp_network_monitor_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with gxdp_network_monitor_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_network_monitor_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="gxdp_network_monitor_proxy_new_for_bus_sync"> +<description> +Like gxdp_network_monitor_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gxdp_network_monitor_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="gxdp_network_monitor_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-NetworkMonitor.top_of_page">org.freedesktop.portal.NetworkMonitor</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gxdp_network_monitor_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="gxdp_network_monitor_set_available"> +<description> +Sets the <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.available">"available"</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 #GXdpNetworkMonitor. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_network_monitor_set_connectivity"> +<description> +Sets the <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.connectivity">"connectivity"</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 #GXdpNetworkMonitor. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_network_monitor_set_metered"> +<description> +Sets the <link linkend="gdbus-property-org-freedesktop-portal-NetworkMonitor.metered">"metered"</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 #GXdpNetworkMonitor. +</parameter_description> +</parameter> +<parameter name="value"> +<parameter_description> The value to set. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_network_monitor_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-NetworkMonitor.top_of_page">org.freedesktop.portal.NetworkMonitor</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + +<function name="gxdp_proxy_resolver_call_lookup"> +<description> +Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-ProxyResolver.Lookup">Lookup()</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 gxdp_proxy_resolver_call_lookup_finish() to get the result of the operation. + +See gxdp_proxy_resolver_call_lookup_sync() for the synchronous, blocking version of this method. + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpProxyResolverProxy. +</parameter_description> +</parameter> +<parameter name="arg_uri"> +<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="gxdp_proxy_resolver_call_lookup_finish"> +<description> +Finishes an operation started with gxdp_proxy_resolver_call_lookup(). + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpProxyResolverProxy. +</parameter_description> +</parameter> +<parameter name="out_proxies"> +<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 gxdp_proxy_resolver_call_lookup(). +</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="gxdp_proxy_resolver_call_lookup_sync"> +<description> +Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-portal-ProxyResolver.Lookup">Lookup()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gxdp_proxy_resolver_call_lookup() for the asynchronous version of this method. + + +</description> +<parameters> +<parameter name="proxy"> +<parameter_description> A #GXdpProxyResolverProxy. +</parameter_description> +</parameter> +<parameter name="arg_uri"> +<parameter_description> Argument to pass with the method invocation. +</parameter_description> +</parameter> +<parameter name="out_proxies"> +<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="gxdp_proxy_resolver_complete_lookup"> +<description> +Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-portal-ProxyResolver.Lookup">Lookup()</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 #GXdpProxyResolver. +</parameter_description> +</parameter> +<parameter name="invocation"> +<parameter_description> A #GDBusMethodInvocation. +</parameter_description> +</parameter> +<parameter name="proxies"> +<parameter_description> Parameter to return. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="gxdp_proxy_resolver_interface_info"> +<description> +Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-portal-ProxyResolver.top_of_page">org.freedesktop.portal.ProxyResolver</link> D-Bus interface. + + +</description> +<parameters> +</parameters> +<return> A #GDBusInterfaceInfo. Do not free. +</return> +</function> + +<function name="gxdp_proxy_resolver_override_properties"> +<description> +Overrides all #GObject properties in the #GXdpProxyResolver 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="gxdp_proxy_resolver_proxy_new"> +<description> +Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-ProxyResolver.top_of_page">org.freedesktop.portal.ProxyResolver</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 gxdp_proxy_resolver_proxy_new_finish() to get the result of the operation. + +See gxdp_proxy_resolver_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="gxdp_proxy_resolver_proxy_new_finish"> +<description> +Finishes an operation started with gxdp_proxy_resolver_proxy_new(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_proxy_resolver_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="gxdp_proxy_resolver_proxy_new_for_bus"> +<description> +Like gxdp_proxy_resolver_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 gxdp_proxy_resolver_proxy_new_for_bus_finish() to get the result of the operation. + +See gxdp_proxy_resolver_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="gxdp_proxy_resolver_proxy_new_for_bus_finish"> +<description> +Finishes an operation started with gxdp_proxy_resolver_proxy_new_for_bus(). + + +</description> +<parameters> +<parameter name="res"> +<parameter_description> The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gxdp_proxy_resolver_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="gxdp_proxy_resolver_proxy_new_for_bus_sync"> +<description> +Like gxdp_proxy_resolver_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gxdp_proxy_resolver_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="gxdp_proxy_resolver_proxy_new_sync"> +<description> +Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-ProxyResolver.top_of_page">org.freedesktop.portal.ProxyResolver</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gxdp_proxy_resolver_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="gxdp_proxy_resolver_skeleton_new"> +<description> +Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-portal-ProxyResolver.top_of_page">org.freedesktop.portal.ProxyResolver</link>. + + +</description> +<parameters> +</parameters> +<return> The skeleton object. +</return> +</function> + </root> diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml index 3692d2d9..02822745 100644 --- a/glib/src/glib_docs.xml +++ b/glib/src/glib_docs.xml @@ -153,7 +153,7 @@ Since: 2.16 </parameter_description> </parameter> <parameter name="G_CHECKSUM_SHA512"> -<parameter_description> Use the SHA-512 hashing algorithm +<parameter_description> Use the SHA-512 hashing algorithm (Since: 2.36) </parameter_description> </parameter> </parameters> @@ -928,6 +928,30 @@ and g_return_val_if_fail(). </parameters> </enum> +<enum name="GLogWriterOutput"> +<description> +Return values from #GLogWriterFuncs to indicate whether the given log entry +was successfully handled by the writer, or whether there was an error in +handling it (and hence a fallback writer should be used). + +If a #GLogWriterFunc ignores a log entry, it should return +%G_LOG_WRITER_HANDLED. + +Since: 2.50 + +</description> +<parameters> +<parameter name="G_LOG_WRITER_HANDLED"> +<parameter_description> Log writer has handled the log entry. +</parameter_description> +</parameter> +<parameter name="G_LOG_WRITER_UNHANDLED"> +<parameter_description> Log writer could not handle the log entry. +</parameter_description> +</parameter> +</parameters> +</enum> + <enum name="GMarkupCollectType"> <description> A mixed enumerated type and flags field. You must specify one type @@ -3399,7 +3423,7 @@ Old South Arabian. Since 2.26 <description> These are the possible character classifications from the Unicode specification. -See <ulink url="http://www.unicode.org/Public/UNIDATA/UnicodeData.html">http://www.unicode.org/Public/UNIDATA/UnicodeData.html</ulink>. +See <ulink url="http://www.unicode.org/reports/tr44/#General_Category_Values">Unicode Character Database</unlink>. </description> <parameters> @@ -3769,6 +3793,24 @@ Windows Server 2008 R2. </parameters> </enum> +<function name="g_abort"> +<description> +A wrapper for the POSIX abort() function. + +On Windows it is a function that makes extra effort (including a call +to abort()) to ensure that a debugger-catchable exception is thrown +before the program terminates. + +See your C library manual for more details about abort(). + +Since: 2.50 + +</description> +<parameters> +</parameters> +<return></return> +</function> + <function name="g_access"> <description> A wrapper for the POSIX access() function. This function is used to @@ -3789,7 +3831,8 @@ Since: 2.8 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="mode"> @@ -6649,9 +6692,9 @@ g_autofree guint8* membuf = NULL; membuf = g_malloc (8192); -/ * Some computation on membuf * / +/<!-- -->* Some computation on membuf *<!-- -->/ -/ * membuf will be automatically freed here * / +/<!-- -->* membuf will be automatically freed here *<!-- -->/ return TRUE; } ]| @@ -7888,8 +7931,8 @@ Since: 2.12 </parameter_description> </parameter> <parameter name="full_path"> -<parameter_description> return location for a string containing the full path -of the file, or %NULL +<parameter_description> return location for a string +containing the full path of the file, or %NULL </parameter_description> </parameter> <parameter name="error"> @@ -7917,7 +7960,8 @@ Since: 2.12 </parameter_description> </parameter> <parameter name="filename"> -<parameter_description> the path of a filename to load, in the GLib file name encoding +<parameter_description> the path of a filename to load, in the +GLib file name encoding </parameter_description> </parameter> <parameter name="error"> @@ -8562,7 +8606,8 @@ be a relative path. </parameter_description> </parameter> </parameters> -<return> a newly-allocated string that must be freed with g_free(). +<return> a newly-allocated string that must be freed with +g_free(). </return> </function> @@ -8577,11 +8622,13 @@ Since: 2.8 </description> <parameters> <parameter name="args"> -<parameter_description> %NULL-terminated array of strings containing the path elements. +<parameter_description> %NULL-terminated +array of strings containing the path elements. </parameter_description> </parameter> </parameters> -<return> a newly-allocated string that must be freed with g_free(). +<return> a newly-allocated string that must be freed +with g_free(). </return> </function> @@ -8631,7 +8678,8 @@ of the separator are ignored. </parameter_description> </parameter> </parameters> -<return> a newly-allocated string that must be freed with g_free(). +<return> a newly-allocated string that must be freed with +g_free(). </return> </function> @@ -8650,11 +8698,13 @@ Since: 2.8 </parameter_description> </parameter> <parameter name="args"> -<parameter_description> %NULL-terminated array of strings containing the path elements. +<parameter_description> %NULL-terminated +array of strings containing the path elements. </parameter_description> </parameter> </parameters> -<return> a newly-allocated string that must be freed with g_free(). +<return> a newly-allocated string that must be freed +with g_free(). </return> </function> @@ -11568,7 +11618,8 @@ Since: 2.8 </description> <parameters> <parameter name="path"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> </parameters> @@ -11920,7 +11971,8 @@ Since: 2.8 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="mode"> @@ -12729,6 +12781,37 @@ should be freed with g_free() when done using it. </return> </function> +<function name="g_compute_hmac_for_bytes"> +<description> +Computes the HMAC for a binary @data. 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.50 + +</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="data"> +<parameter_description> binary blob to compute the HMAC of +</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_data"> <description> Computes the HMAC for a binary @data of @length. This is a @@ -13291,7 +13374,8 @@ Since: 2.8 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="mode"> @@ -13323,6 +13407,10 @@ If g_log_default_handler() is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually. +If structured logging is enabled, this will use g_log_structured(); +otherwise it will use g_log(). See +[Using Structured Logging][using-structured-logging]. + </description> <parameters> <parameter name="Varargs"> @@ -14374,7 +14462,7 @@ Returns the month of the year. The date must be valid. <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. +weeks are understood to begin on Sunday. The date must be valid. Can return 0 if the day is before the first Sunday of the year. @@ -16362,8 +16450,13 @@ If g_log_default_handler() is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually. -Such messages are suppressed by the g_log_default_handler() unless -the G_MESSAGES_DEBUG environment variable is set appropriately. +Such messages are suppressed by the g_log_default_handler() and +g_log_writer_default() unless the `G_MESSAGES_DEBUG` environment variable is +set appropriately. + +If structured logging is enabled, this will use g_log_structured(); +otherwise it will use g_log(). See +[Using Structured Logging][using-structured-logging]. Since: 2.6 @@ -17028,6 +17121,9 @@ If g_log_default_handler() is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually. +If structured logging is enabled, this will use g_log_structured(); +otherwise it will use g_log(). See +[Using Structured Logging][using-structured-logging]. </description> <parameters> @@ -17314,8 +17410,8 @@ Since: 2.4 </parameter_description> </parameter> </parameters> -<return> A newly-allocated string with the contents of the symbolic link, -or %NULL if an error occurred. +<return> A newly-allocated string with the contents of +the symbolic link, or %NULL if an error occurred. </return> </function> @@ -17423,7 +17519,8 @@ extensions and those listed in the `PATHEXT` environment variable. </description> <parameters> <parameter name="filename"> -<parameter_description> a filename to test in the GLib file name encoding +<parameter_description> a filename to test in the +GLib file name encoding </parameter_description> </parameter> <parameter name="test"> @@ -17459,7 +17556,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> an absolute pathname in the GLib file name encoding +<parameter_description> an absolute pathname in the +GLib file name encoding </parameter_description> </parameter> </parameters> @@ -17492,7 +17590,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname hopefully in the GLib file name encoding +<parameter_description> a pathname hopefully in the +GLib file name encoding </parameter_description> </parameter> </parameters> @@ -17587,9 +17686,9 @@ component following Section 3.3. of RFC 2396. </description> <parameters> <parameter name="filename"> -<parameter_description> an absolute filename specified in the GLib file name encoding, -which is the on-disk file name bytes on Unix, and UTF-8 on -Windows +<parameter_description> an absolute filename specified in the GLib file +name encoding, which is the on-disk file name bytes on Unix, and UTF-8 +on Windows </parameter_description> </parameter> <parameter name="hostname"> @@ -17618,7 +17717,7 @@ the [current locale][setlocale]. </description> <parameters> <parameter name="opsysstring"> -<parameter_description> a string in the encoding for filenames +<parameter_description> a string in the encoding for filenames </parameter_description> </parameter> <parameter name="len"> @@ -17682,7 +17781,8 @@ including the type suffix. </parameter_description> </parameter> </parameters> -<return> a newly-allocated string with the absolute path, or %NULL +<return> a newly-allocated string with the absolute path, +or %NULL </return> </function> @@ -17820,7 +17920,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="mode"> @@ -17976,7 +18077,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="mode"> @@ -18133,7 +18235,7 @@ On Windows, the character set used in the GLib API is always UTF-8 and said environment variables have no effect. `G_FILENAME_ENCODING` may be set to a comma-separated list of -character set names. The special token "@locale" is taken +character set names. The special token "\@locale" is taken to mean the character set for the [current locale][setlocale]. If `G_FILENAME_ENCODING` is not set, but `G_BROKEN_FILENAMES` is, the character set of the current locale is taken as the filename @@ -18389,8 +18491,10 @@ Since: 2.6 </description> <parameters> </parameters> -<return> a %NULL-terminated array of strings owned by GLib that must -not be modified or freed. +<return> +a %NULL-terminated array of strings owned by GLib that must not be +modified or freed. + </return> </function> @@ -18431,8 +18535,10 @@ Since: 2.6 </description> <parameters> </parameters> -<return> a %NULL-terminated array of strings owned by GLib that must -not be modified or freed. +<return> +a %NULL-terminated array of strings owned by GLib that must not be +modified or freed. + </return> </function> @@ -18481,7 +18587,7 @@ Since: 2.6 </description> <parameters> </parameters> -<return> a string owned by GLib that must not be modified +<return> a string owned by GLib that must not be modified or freed. </return> </function> @@ -18506,7 +18612,7 @@ Since: 2.6 </description> <parameters> </parameters> -<return> a string owned by GLib that must not be modified +<return> a string owned by GLib that must not be modified or freed. </return> </function> @@ -18531,7 +18637,7 @@ Since: 2.6 </description> <parameters> </parameters> -<return> a string owned by GLib that must not be modified +<return> a string owned by GLib that must not be modified or freed. </return> </function> @@ -18574,7 +18680,8 @@ Since: 2.28 </description> <parameters> </parameters> -<return> a string owned by GLib that must not be modified or freed. +<return> a string owned by GLib that must not be +modified or freed. </return> </function> @@ -18601,8 +18708,8 @@ Since: 2.14 </parameter_description> </parameter> </parameters> -<return> the path to the specified special directory, or %NULL -if the logical id was not found. The returned string is owned by +<return> the path to the specified special directory, or +%NULL if the logical id was not found. The returned string is owned by GLib and should not be modified or freed. </return> @@ -20509,8 +20616,13 @@ If g_log_default_handler() is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually. -Such messages are suppressed by the g_log_default_handler() unless -the G_MESSAGES_DEBUG environment variable is set appropriately. +Such messages are suppressed by the g_log_default_handler() and +g_log_writer_default() unless the `G_MESSAGES_DEBUG` environment variable is +set appropriately. + +If structured logging is enabled, this will use g_log_structured(); +otherwise it will use g_log(). See +[Using Structured Logging][using-structured-logging]. Since: 2.40 @@ -22443,6 +22555,37 @@ Since: 2.6 </return> </function> +<function name="g_key_file_load_from_bytes"> +<description> +Loads a key file from the data in @bytes into an empty #GKeyFile structure. +If the object cannot be created then %error is set to a #GKeyFileError. + +Since: 2.50 + +</description> +<parameters> +<parameter name="key_file"> +<parameter_description> an empty #GKeyFile struct +</parameter_description> +</parameter> +<parameter name="bytes"> +<parameter_description> a #GBytes +</parameter_description> +</parameter> +<parameter name="flags"> +<parameter_description> flags from #GKeyFileFlags +</parameter_description> +</parameter> +<parameter name="error"> +<parameter_description> return location for a #GError, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if a key file could be loaded, %FALSE otherwise + +</return> +</function> + <function name="g_key_file_load_from_data"> <description> Loads a key file from memory into an empty #GKeyFile structure. @@ -24221,6 +24364,9 @@ If g_log_default_handler() is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually. +If [structured logging is enabled][using-structured-logging] this will +output via the structured log writer function (see g_log_set_writer_func()). + </description> <parameters> <parameter name="log_domain"> @@ -24270,6 +24416,9 @@ 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. +This has no effect if structured logging is enabled; see +[Using Structured Logging][using-structured-logging]. + </description> <parameters> <parameter name="log_domain"> @@ -24297,6 +24446,9 @@ default "" application domain <description> Removes the log handler. +This has no effect if structured logging is enabled; see +[Using Structured Logging][using-structured-logging]. + </description> <parameters> <parameter name="log_domain"> @@ -24323,6 +24475,14 @@ You can also make some message levels fatal at runtime by setting the `G_DEBUG` environment variable (see [Running GLib Applications](glib-running.html)). +Libraries should not call this function, as it affects all messages logged +by a process, including those from other libraries. + +Structured log messages (using g_log_structured() and +g_log_structured_array()) are fatal only if the default log writer is used; +otherwise it is up to the writer function to determine which log messages +are fatal. See [Using Structured Logging][using-structured-logging]. + </description> <parameters> @@ -24343,6 +24503,9 @@ 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. +This has no effect if structured logging is enabled; see +[Using Structured Logging][using-structured-logging]. + Since: 2.6 </description> @@ -24366,6 +24529,12 @@ Since: 2.6 Sets the log levels which are fatal in the given domain. %G_LOG_LEVEL_ERROR is always fatal. +This has no effect on structured log messages (using g_log_structured() or +g_log_structured_array()). To change the fatal behaviour for specific log +messages, programs must install a custom log writer function using +g_log_set_writer_func(). See +[Using Structured Logging][using-structured-logging]. + </description> <parameters> @@ -24393,6 +24562,9 @@ 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. +This has no effect if structured logging is enabled; see +[Using Structured Logging][using-structured-logging]. + Here is an example for adding a log handler for all warning messages in the default domain: |[<!-- language="C" --> @@ -24444,6 +24616,9 @@ the log levels with the #G_LOG_FLAG_FATAL and <description> Like g_log_sets_handler(), but takes a destroy notify for the @user_data. +This has no effect if structured logging is enabled; see +[Using Structured Logging][using-structured-logging]. + Since: 2.46 </description> @@ -24478,6 +24653,418 @@ the log levels with the #G_LOG_FLAG_FATAL and </return> </function> +<function name="g_log_set_writer_func"> +<description> +Set a writer function which will be called to format and write out each log +message. Each program should set a writer function, or the default writer +(g_log_writer_default()) will be used. + +Libraries **must not** call this function — only programs are allowed to +install a writer function, as there must be a single, central point where +log messages are formatted and outputted. + +There can only be one writer function. It is an error to set more than one. + +Since: 2.50 + +</description> +<parameters> +<parameter name="func"> +<parameter_description> log writer function, which must not be %NULL +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data to pass to @func +</parameter_description> +</parameter> +<parameter name="user_data_free"> +<parameter_description> function to free @user_data once it’s +finished with, if non-%NULL +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_log_structured"> +<description> +Log a message with structured data. The message will be passed through to +the log writer set by the application using g_log_set_writer_func(). If the +message is fatal (i.e. its log level is %G_LOG_LEVEL_ERROR), the program will +be aborted at the end of this function. + +The structured data is provided as key–value pairs, where keys are UTF-8 +strings, and values are arbitrary pointers — typically pointing to UTF-8 +strings, but that is not a requirement. To pass binary (non-nul-terminated) +structured data, use g_log_structured_array(). The keys for structured data +should follow the [systemd journal +fields](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html) +specification. It is suggested that custom keys are namespaced according to +the code which sets them. For example, custom keys from GLib all have a +`GLIB_` prefix. + +The @log_domain will be converted into a `GLIB_DOMAIN` field. @log_level will +be converted into a +[`PRIORITY`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#PRIORITY=) +field. The format string will have its placeholders substituted for the provided +values and be converted into a +[`MESSAGE`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#MESSAGE=) +field. + +Other fields you may commonly want to pass into this function: + +* [`MESSAGE_ID`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#MESSAGE_ID=) +* [`CODE_FILE`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#CODE_FILE=) +* [`CODE_LINE`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#CODE_LINE=) +* [`CODE_FUNC`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#CODE_FUNC=) +* [`ERRNO`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#ERRNO=) + +Note that `CODE_FILE`, `CODE_LINE` and `CODE_FUNC` are automatically set by +the logging macros, G_DEBUG_HERE(), g_message(), g_warning(), g_critical(), +g_error(), etc, if the symbols `G_LOG_USE_STRUCTURED` is defined before including +glib.h. + +For example: +|[<!-- language="C" --> +g_log_structured (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, +"MESSAGE_ID", "06d4df59e6c24647bfe69d2c27ef0b4e", +"MY_APPLICATION_CUSTOM_FIELD", "some debug string", +"MESSAGE", "This is a debug message about pointer %p and integer %u.", +some_pointer, some_integer); +]| + +Note that each `MESSAGE_ID` must be [uniquely and randomly +generated](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#MESSAGE_ID=). +If adding a `MESSAGE_ID`, consider shipping a [message +catalog](https://www.freedesktop.org/wiki/Software/systemd/catalog/) with +your software. + +To pass a user data pointer to the log writer function which is specific to +this logging call, you must use g_log_structured_array() and pass the pointer +as a field with #GLogField.length set to zero, otherwise it will be +interpreted as a string. + +For example: +|[<!-- language="C" --> +const GLogField fields[] = { +{ "MESSAGE", "This is a debug message.", -1 }, +{ "MESSAGE_ID", "fcfb2e1e65c3494386b74878f1abf893", -1 }, +{ "MY_APPLICATION_CUSTOM_FIELD", "some debug string", -1 }, +{ "MY_APPLICATION_STATE", state_object, 0 }, +}; +g_log_structured_array (G_LOG_LEVEL_DEBUG, fields, G_N_ELEMENTS (fields)); +]| + +Note also that, even if no other structured fields are specified, there +must always be a "MESSAGE" key before the format string. The "MESSAGE"-format +pair has to be the last of the key-value pairs, and "MESSAGE" is the only +field for which printf()-style formatting is supported. + +The default writer function for `stdout` and `stderr` will automatically +append a new-line character after the message, so you should not add one +manually to the format string. + +Since: 2.50 + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> log domain, usually %G_LOG_DOMAIN +</parameter_description> +</parameter> +<parameter name="log_level"> +<parameter_description> log level, either from #GLogLevelFlags, or a user-defined +level +</parameter_description> +</parameter> +<parameter name="Varargs"> +<parameter_description> key-value pairs of structured data to add to the log entry, followed +by the key "MESSAGE", followed by a printf()-style message format, +followed by parameters to insert in the format string +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_log_structured_array"> +<description> +Log a message with structured data. The message will be passed through to the +log writer set by the application using g_log_set_writer_func(). If the +message is fatal (i.e. its log level is %G_LOG_LEVEL_ERROR), the program will +be aborted at the end of this function. + +See g_log_structured() for more documentation. + +This assumes that @log_level is already present in @fields (typically as the +`PRIORITY` field). + +Since: 2.50 + +</description> +<parameters> +<parameter name="log_level"> +<parameter_description> log level, either from #GLogLevelFlags, or a user-defined +level +</parameter_description> +</parameter> +<parameter name="fields"> +<parameter_description> key–value pairs of structured data to add +to the log message +</parameter_description> +</parameter> +<parameter name="n_fields"> +<parameter_description> number of elements in the @fields array +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_log_variant"> +<description> +Log a message with structured data, accepting the data within a #GVariant. This +version is especially useful for use in other languages, via introspection. + +The only mandatory item in the @fields dictionary is the "MESSAGE" which must +contain the text shown to the user. + +The values in the @fields dictionary are likely to be of type String +(#G_VARIANT_TYPE_STRING). Array of bytes (#G_VARIANT_TYPE_BYTESTRING) is also +supported. In this case the message is handled as binary and will be forwarded +to the log writer as such. The size of the array should not be higher than +%G_MAXSSIZE. Otherwise it will be truncated to this size. For other types +g_variant_print() will be used to convert the value into a string. + +For more details on its usage and about the parameters, see g_log_structured(). + +Since: 2.50 + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> log domain, usually %G_LOG_DOMAIN +</parameter_description> +</parameter> +<parameter name="log_level"> +<parameter_description> log level, either from #GLogLevelFlags, or a user-defined +level +</parameter_description> +</parameter> +<parameter name="fields"> +<parameter_description> a dictionary (#GVariant of the type %G_VARIANT_TYPE_VARDICT) +containing the key-value pairs of message data. +</parameter_description> +</parameter> +</parameters> +<return></return> +</function> + +<function name="g_log_writer_default"> +<description> +Format a structured log message and output it to the default log destination +for the platform. On Linux, this is typically the systemd journal, falling +back to `stdout` or `stderr` if running from the terminal or if output is +being redirected to a file. + +Support for other platform-specific logging mechanisms may be added in +future. Distributors of GLib may modify this function to impose their own +(documented) platform-specific log writing policies. + +This is suitable for use as a #GLogWriterFunc, and is the default writer used +if no other is set using g_log_set_writer_func(). + +As with g_log_default_handler(), this function drops debug and informational +messages unless their log domain (or `all`) is listed in the space-separated +`G_MESSAGES_DEBUG` environment variable. + +Since: 2.50 + +</description> +<parameters> +<parameter name="log_level"> +<parameter_description> log level, either from #GLogLevelFlags, or a user-defined +level +</parameter_description> +</parameter> +<parameter name="fields"> +<parameter_description> key–value pairs of structured data forming +the log message +</parameter_description> +</parameter> +<parameter name="n_fields"> +<parameter_description> number of elements in the @fields array +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data passed to g_log_set_writer_func() +</parameter_description> +</parameter> +</parameters> +<return> %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise +</return> +</function> + +<function name="g_log_writer_format_fields"> +<description> +Format a structured log message as a string suitable for outputting to the +terminal (or elsewhere). This will include the values of all fields it knows +how to interpret, which includes `MESSAGE` and `GLIB_DOMAIN` (see the +documentation for g_log_structured()). It does not include values from +unknown fields. + +The returned string does **not** have a trailing new-line character. It is +encoded in the character set of the current locale, which is not necessarily +UTF-8. + +Since: 2.50 + +</description> +<parameters> +<parameter name="log_level"> +<parameter_description> log level, either from #GLogLevelFlags, or a user-defined +level +</parameter_description> +</parameter> +<parameter name="fields"> +<parameter_description> key–value pairs of structured data forming +the log message +</parameter_description> +</parameter> +<parameter name="n_fields"> +<parameter_description> number of elements in the @fields array +</parameter_description> +</parameter> +<parameter name="use_color"> +<parameter_description> %TRUE to use ANSI color escape sequences when formatting the +message, %FALSE to not +</parameter_description> +</parameter> +</parameters> +<return> string containing the formatted log message, in +the character set of the current locale +</return> +</function> + +<function name="g_log_writer_is_journald"> +<description> +Check whether the given @output_fd file descriptor is a connection to the +systemd journal, or something else (like a log file or `stdout` or +`stderr`). + +Since: 2.50 + +</description> +<parameters> +<parameter name="output_fd"> +<parameter_description> output file descriptor to check +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if @output_fd points to the journal, %FALSE otherwise +</return> +</function> + +<function name="g_log_writer_journald"> +<description> +Format a structured log message and send it to the systemd journal as a set +of key–value pairs. All fields are sent to the journal, but if a field has +length zero (indicating program-specific data) then only its key will be +sent. + +This is suitable for use as a #GLogWriterFunc. + +If GLib has been compiled without systemd support, this function is still +defined, but will always return %G_LOG_WRITER_UNHANDLED. + +Since: 2.50 + +</description> +<parameters> +<parameter name="log_level"> +<parameter_description> log level, either from #GLogLevelFlags, or a user-defined +level +</parameter_description> +</parameter> +<parameter name="fields"> +<parameter_description> key–value pairs of structured data forming +the log message +</parameter_description> +</parameter> +<parameter name="n_fields"> +<parameter_description> number of elements in the @fields array +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data passed to g_log_set_writer_func() +</parameter_description> +</parameter> +</parameters> +<return> %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise +</return> +</function> + +<function name="g_log_writer_standard_streams"> +<description> +Format a structured log message and print it to either `stdout` or `stderr`, +depending on its log level. %G_LOG_LEVEL_INFO and %G_LOG_LEVEL_DEBUG messages +are sent to `stdout`; all other log levels are sent to `stderr`. Only fields +which are understood by this function are included in the formatted string +which is printed. + +If the output stream supports ANSI color escape sequences, they will be used +in the output. + +A trailing new-line character is added to the log message when it is printed. + +This is suitable for use as a #GLogWriterFunc. + +Since: 2.50 + +</description> +<parameters> +<parameter name="log_level"> +<parameter_description> log level, either from #GLogLevelFlags, or a user-defined +level +</parameter_description> +</parameter> +<parameter name="fields"> +<parameter_description> key–value pairs of structured data forming +the log message +</parameter_description> +</parameter> +<parameter name="n_fields"> +<parameter_description> number of elements in the @fields array +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> user data passed to g_log_set_writer_func() +</parameter_description> +</parameter> +</parameters> +<return> %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise +</return> +</function> + +<function name="g_log_writer_supports_color"> +<description> +Check whether the given @output_fd file descriptor supports ANSI color +escape sequences. If so, they can safely be used when formatting log +messages. + +Since: 2.50 + +</description> +<parameters> +<parameter name="output_fd"> +<parameter_description> output file descriptor to check +</parameter_description> +</parameter> +</parameters> +<return> %TRUE if ANSI color escapes are supported, %FALSE otherwise +</return> +</function> + <function name="g_logv"> <description> Logs an error or debugging message. @@ -24489,6 +25076,9 @@ If g_log_default_handler() is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually. +If [structured logging is enabled][using-structured-logging] this will +output via the structured log writer function (see g_log_set_writer_func()). + </description> <parameters> <parameter name="log_domain"> @@ -24527,7 +25117,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="buf"> @@ -25001,9 +25592,20 @@ the context used by functions like g_idle_add(). Normally you would call this function shortly after creating a new thread, passing it a #GMainContext which will be run by a #GMainLoop in that thread, to set a new default context for all -async operations in that thread. (In this case, you don't need to -ever call g_main_context_pop_thread_default().) In some cases -however, you may want to schedule a single operation in a +async operations in that thread. In this case you may not need to +ever call g_main_context_pop_thread_default(), assuming you want the +new #GMainContext to be the default for the whole lifecycle of the +thread. + +If you don't have control over how the new thread was created (e.g. +in the new thread isn't newly created, or if the thread life +cycle is managed by a #GThreadPool), it is always suggested to wrap +the logic that needs to use the new #GMainContext inside a +g_main_context_push_thread_default() / g_main_context_pop_thread_default() +pair, otherwise threads that are re-used will end up never explicitly +releasing the #GMainContext reference they hold. + +In some cases you may want to schedule a single operation in a non-default context, or temporarily use a non-default context in the main thread. In that case, you can wrap the call to the asynchronous operation inside a @@ -25815,7 +26417,8 @@ Since: 2.8 </description> <parameters> <parameter name="filename"> -<parameter_description> The path of the file to load, in the GLib filename encoding +<parameter_description> The path of the file to load, in the GLib +filename encoding </parameter_description> </parameter> <parameter name="writable"> @@ -27053,6 +27656,10 @@ If g_log_default_handler() is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually. +If structured logging is enabled, this will use g_log_structured(); +otherwise it will use g_log(). See +[Using Structured Logging][using-structured-logging]. + </description> <parameters> <parameter name="Varargs"> @@ -27077,7 +27684,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="mode"> @@ -27138,8 +27746,8 @@ Since: 2.30 </parameter_description> </parameter> </parameters> -<return> A pointer to @tmpl, which has been modified -to hold the directory name. In case of errors, %NULL is +<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> @@ -27172,8 +27780,8 @@ Since: 2.30 </parameter_description> </parameter> </parameters> -<return> A pointer to @tmpl, which has been modified -to hold the directory name. In case of errors, %NULL is +<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> @@ -30408,7 +31016,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="flags"> @@ -32861,7 +33470,8 @@ is not an absolute path it returns %NULL. </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> @@ -33181,8 +33791,8 @@ its own new-line character. 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(). +use g_log(), g_log_structured(), or the convenience macros g_message(), +g_warning() and g_error(). </description> <parameters> @@ -33206,8 +33816,8 @@ a trailing new-line character. Typically, @format should end with its own new-line character. 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(). +Instead g_log() or g_log_structured() should be used, or the convenience +macros g_message(), g_warning() and g_error(). </description> <parameters> @@ -35455,6 +36065,10 @@ Since: 2.14 <description> Returns the compile options that @regex was created with. +Depending on the version of PCRE that is used, this may or may not +include flags set by option expressions such as `(?i)` found at the +top-level within the compiled pattern. + Since: 2.26 </description> @@ -36599,7 +37213,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> </parameters> @@ -36623,7 +37238,8 @@ Since: 2.6 </description> <parameters> <parameter name="oldfilename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="newfilename"> @@ -36783,7 +37399,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> </parameters> @@ -39258,7 +39875,7 @@ button_clicked_cb (GtkButton *button, GtkWidget *other_widget) gtk_widget_hide (other_widget); } -… +... g_signal_connect (button, "clicked", (GCallback) button_clicked_cb, other_widget); @@ -43088,7 +43705,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="buf"> @@ -45419,6 +46037,10 @@ Joins a number of strings together to form one long string, with the optional @separator inserted between each of them. The returned string should be freed with g_free(). +If @str_array has no items, the return value will be an +empty string. If @str_array contains a single item, @separator will not +appear in the resulting string. + </description> <parameters> @@ -46058,6 +46680,10 @@ Since: 2.16 Asserts that all messages previously indicated via g_test_expect_message() have been seen and suppressed. +This API may only be used with the old logging API (g_log() without +%G_LOG_USE_STRUCTURED defined). It will not work with the structured logging +API. See [Testing for Messages][testing-for-messages]. + If messages at %G_LOG_LEVEL_DEBUG are emitted, but not explicitly expected via g_test_expect_message() then they will be ignored. @@ -46237,6 +46863,10 @@ with text matching @pattern, is expected to be logged. When this message is logged, it will not be printed, and the test case will not abort. +This API may only be used with the old logging API (g_log() without +%G_LOG_USE_STRUCTURED defined). It will not work with the structured logging +API. See [Testing for Messages][testing-for-messages]. + Use g_test_assert_expected_messages() to assert that all previously-expected messages have been seen and suppressed. @@ -46453,7 +47083,7 @@ be skipped (ie, a test whose name contains "/subprocess"). `quick`: Quick tests, should run really quickly and give good coverage. `undefined`: Tests for undefined behaviour, may provoke programming errors -under g_test_trap_subprocess() or g_test_expect_messages() to check +under g_test_trap_subprocess() or g_test_expect_message() to check that appropriate assertions or warnings are given `no-undefined`: Avoid tests for undefined behaviour @@ -46566,6 +47196,12 @@ function which needs the special behavior. This handler has no effect on g_error messages. +This handler also has no effect on structured log messages (using +g_log_structured() or g_log_structured_array()). To change the fatal +behaviour for specific log messages, programs must install a custom log +writer function using g_log_set_writer_func().See +[Using Structured Logging][using-structured-logging]. + Since: 2.22 </description> @@ -52572,7 +53208,8 @@ Since: 2.6 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> </parameters> @@ -53627,7 +54264,8 @@ Since: 2.18 </description> <parameters> <parameter name="filename"> -<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows) +<parameter_description> a pathname in the GLib file name encoding +(UTF-8 on Windows) </parameter_description> </parameter> <parameter name="utb"> @@ -53734,7 +54372,7 @@ Deprecated: 2.32: Use #GArray and g_array_insert_val() instead. </parameter_description> </parameter> <parameter name="index_"> -<parameter_description> insertion position, must be <= value_array->n_values +<parameter_description> insertion position, must be <= value_array->;n_values </parameter_description> </parameter> <parameter name="value"> @@ -55155,8 +55793,8 @@ a #GValue of type @dest_type. <description> Check whether g_value_transform() is able to transform values of type @src_type into values of type @dest_type. Note that for -the types to be transformable, they must be compatible and a -transform function must be registered. +the types to be transformable, they must be compatible or a +transformation function must be registered. </description> @@ -55379,7 +56017,10 @@ Ends the builder process and returns the constructed value. It is not permissible to use @builder in any way after this call except for reference counting operations (in the case of a heap-allocated #GVariantBuilder) or by reinitialising it with -g_variant_builder_init() (in the case of stack-allocated). +g_variant_builder_init() (in the case of stack-allocated). This +means that for the stack-allocated builders there is no need to +call g_variant_builder_clear() after the call to +g_variant_builder_end(). It is an error to call this function in any way that would create an inconsistent value to be constructed (ie: insufficient number of @@ -56273,6 +56914,9 @@ If the array contains a nul terminator character somewhere other than the last byte then the returned string is the string, up to the first such nul character. +g_variant_get_fixed_array() should be used instead if the array contains +arbitrary data that could not be nul-terminated or could contain nul bytes. + It is an error to call this function with a @value that is not an array of bytes. @@ -59816,6 +60460,10 @@ If g_log_default_handler() is used as the log handler function, a newline character will automatically be appended to @..., and need not be entered manually. +If structured logging is enabled, this will use g_log_structured(); +otherwise it will use g_log(). See +[Using Structured Logging][using-structured-logging]. + </description> <parameters> <parameter name="Varargs"> |