From 4caba73704c3b07f66bd16bc423c4c15feaf2921 Mon Sep 17 00:00:00 2001 From: Murray Cumming Date: Tue, 3 Mar 2015 08:41:56 +0100 Subject: Regenerate *_docs.xml files. --- gio/src/gio_docs.xml | 384 ++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 287 insertions(+), 97 deletions(-) (limited to 'gio/src') diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml index b8ea5b9e..31853ca2 100644 --- a/gio/src/gio_docs.xml +++ b/gio/src/gio_docs.xml @@ -1456,6 +1456,67 @@ Flags used when creating a #GAppInfo. + + +Signal emitted when the app info database for changes (ie: newly installed +or removed applications). + + + + + + + + + +The ::launch-failed signal is emitted when a #GAppInfo launch +fails. The startup notification id is provided, so that the launcher +can cancel the startup notification. + +Since: 2.36 + + + + + the object emitting the signal + + + + the startup notification id for the failed launch + + + + + + + + +The ::launched signal is emitted when a #GAppInfo is successfully +launched. The @platform_data is an GVariant dictionary mapping +strings to variants (ie a{sv}), which contains additional, +platform-specific data about this launch. On UNIX, at least the +"pid" and "startup-notification-id" keys will be present. + +Since: 2.36 + + + + + the object emitting the signal + + + + the #GAppInfo that was just launched + + + + additional platform-specific data for this launch + + + + + + The ::activate signal is emitted on the primary instance when an @@ -21554,6 +21615,35 @@ Since: 2.40 + + +Marks @application as busy (see g_application_mark_busy()) while +@property on @object is %TRUE. + +The binding holds a reference to @application while it is active, but +not to @object. Instead, the binding is destroyed when @object is +finalized. + +Since: 2.44 + + + + + a #GApplication + + + + a #GObject + + + + the name of a boolean property of @object + + + + + + Creates a #GFile corresponding to a filename that was given as part @@ -22057,6 +22147,25 @@ Since: 2.28 + + +Gets the application's current busy state, as set through +g_application_mark_busy() or g_application_bind_busy_property(). + +Since: 2.44 + + + + + a #GApplication + + + + %TRUE if @application is currenty marked as busy + + + + Checks if @application is registered. @@ -22427,11 +22536,7 @@ except in the case that g_application_set_inactivity_timeout() is in use. This function sets the prgname (g_set_prgname()), if not already set, -to the basename of argv[0]. Since 2.38, if %G_APPLICATION_IS_SERVICE -is specified, the prgname is set to the application ID. The main -impact of this is is that the wmclass of windows created by Gtk+ will -be set accordingly, which helps the window manager determine which -application is showing the window. +to the basename of argv[0]. Since 2.40, applications that are not explicitly flagged as services or launchers (ie: neither %G_APPLICATION_IS_SERVICE or @@ -22694,6 +22799,32 @@ Since: 2.42 + + +Destroys a binding between @property and the busy state of +@application that was previously created with +g_application_bind_busy_property(). + +Since: 2.44 + + + + + a #GApplication + + + + a #GObject + + + + the name of a boolean property of @object + + + + + + Decreases the busy count of @application. @@ -24102,7 +24233,9 @@ This function is thread-safe. In other words, you can safely call it from a thread other than the one running the operation that was passed the @cancellable. -The convention within gio is that cancelling an asynchronous +If @cancellable is %NULL, this function returns immediately for convenience. + +The convention within GIO is that cancelling an asynchronous operation causes it to complete asynchronously. That is, if you cancel the operation from the same thread in which it is running, then the operation's #GAsyncReadyCallback will not be invoked until @@ -36133,6 +36266,76 @@ Checks if the file enumerator has been closed. + + +This is a version of g_file_enumerator_next_file() that's easier to +use correctly from C programs. With g_file_enumerator_next_file(), +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 +"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 +@out_child are owned by @direnum (they are cached as hidden +properties). You must not unref them in your own code. This makes +memory management significantly easier for C code in combination +with loops. + +Finally, this function optionally allows retrieving a #GFile as +well. + +You must specify at least one of @out_info or @out_child. + +The code pattern for correctly using g_file_enumerator_iterate() from C +is: + +|[ +direnum = g_file_enumerate_children (file, ...); +while (TRUE) +{ +GFileInfo *info; +if (!g_file_enumerator_iterate (direnum, &info, NULL, cancellable, error)) +goto out; +if (!info) +break; +... do stuff with "info"; do not unref it! ... +} + +out: +g_object_unref (direnum); // Note: frees the last @info +]| + + +Since: 2.44 + + + + + an open #GFileEnumerator + + + + Output location for the next #GFileInfo, or %NULL + + + + Output location for the next #GFile, or %NULL + + + + a #GCancellable + + + + a #GError + + + + + + Returns information for the next file in the enumerated object. @@ -42888,22 +43091,6 @@ ignore. - - -Checks if an input stream's read_async function uses threads. - - - - - - input stream - - - - %TRUE if @stream's read_async function uses threads. - - - Clears the pending flag on @stream. @@ -44882,6 +45069,14 @@ Since: 2.44 the new item + + pairwise comparison function for sorting + + + + user data for @compare_func + + the position at which @item was inserted @@ -48778,22 +48973,6 @@ Since: 2.28 - - -Checks if an ouput stream's write_async function uses threads. - - - - - - a #GOutputStream. - - - - %TRUE if @stream's write_async function uses threads. - - - Clears the pending flag on @stream. @@ -50499,7 +50678,8 @@ Since: 2.38 - the object that has the property to wrap + the object that has the property +to wrap @@ -53280,9 +53460,11 @@ with it. +<!-- --> + Since: 2.28 -Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead +Deprecated: 2.40: Use g_settings_schema_source_list_schemas() instead @@ -53296,9 +53478,11 @@ modified or freed. +<!-- --> + Since: 2.26 -Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead. +Deprecated: 2.40: Use g_settings_schema_source_list_schemas() instead. If you used g_settings_list_schemas() to check for the presence of a particular schema, use g_settings_schema_source_lookup() instead of your whole loop. @@ -53352,7 +53536,7 @@ At the most basic level, a #GSettings object is a pure composition of backend, and a #GMainContext to which signals are dispatched. This constructor therefore gives you full control over constructing -#GSettings instances. The first 4 parameters are given directly as +#GSettings instances. The first 3 parameters are given directly as @schema, @backend and @path, and the main context is taken from the thread-default (as per g_settings_new()). @@ -55393,6 +55577,29 @@ Since: 2.28 + + +Creates a new #GSimpleIOStream wrapping @input_stream and @output_stream. +See also #GIOStream. + +Since: 2.44 + + + + + a #GInputStream. + + + + a #GOutputStream. + + + + a new #GSimpleIOStream instance. + + + + Creates a new #GPermission instance that represents an action that is @@ -65391,28 +65598,59 @@ Checks if a unix mount is a system path. + + +Gets the #GUnixMountMonitor for the current thread-default main +context. + +The mount monitor can be used to monitor for changes to the list of +mounted filesystems as well as the list of mount points (ie: fstab +entries). + +You must only call g_object_unref() on the return value from under +the same main context as you called this function. + +Since: 2.44 + + + + + the #GUnixMountMonitor. + + + + -Gets a new #GUnixMountMonitor. The default rate limit for which the -monitor will report consecutive changes for the mount and mount -point entry files is the default for a #GFileMonitor. Use -g_unix_mount_monitor_set_rate_limit() to change this. +Deprecated alias for g_unix_mount_monitor_get(). +This function was never a true constructor, which is why it was +renamed. + +Deprecated:2.44:Use g_unix_mount_monitor_get() instead. - a #GUnixMountMonitor. + a #GUnixMountMonitor. + -Sets the rate limit to which the @mount_monitor will report -consecutive change events to the mount and mount point entry files. +This function does nothing. + +Before 2.44, this was a partially-effective way of controlling the +rate at which events would be reported under some uncommon +circumstances. Since @mount_monitor is a singleton, it also meant +that calling this function would have side effects for other users of +the monitor. Since: 2.18 +Deprecated:2.44:This function does nothing. Don't call it. + @@ -66924,50 +67162,6 @@ Since: 2.26 - - - - - - - the GWinHttpFile being read - - - - handle to the HTTP connection, as from WinHttpConnect() - - - - handle to the HTTP request, as from WinHttpOpenRequest - - - - #GFileInputStream for the given request - - - - - - - - - - the GWinHttpFile being read - - - - handle to the HTTP connection, as from WinHttpConnect() - - - - handle to the HTTP request, as from WinHttpOpenRequest - - - - #GFileOutputStream for the given request - - - Returns a new #GVfs handle for a WinHttp vfs. @@ -67676,10 +67870,6 @@ port_add will associate a GSource to @f->source - - - - -- cgit v1.2.1