From 953a8329387aa8cf95e84abfa9ee135b4ac99a03 Mon Sep 17 00:00:00 2001 From: Murray Cumming Date: Fri, 22 Aug 2014 14:46:53 +0200 Subject: Regenerated *_docs.xml. --- gio/src/gio_docs.xml | 805 +++++++++++++++++++++++++++++++++++++++++-------- glib/src/glib_docs.xml | 397 ++++++++++++++++++------ 2 files changed, 988 insertions(+), 214 deletions(-) diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml index a9e39fec..5e56e5bc 100644 --- a/gio/src/gio_docs.xml +++ b/gio/src/gio_docs.xml @@ -1915,6 +1915,10 @@ Since: 2.26 The native credentials type is a <type>struct cmsgcred</type>. + + The native credentials type is a <type>struct unpcbid</type>. + + The native credentials type is a <type>struct sockpeercred</type>. Added in 2.30. @@ -2211,6 +2215,26 @@ Existing file and the operation you're using does not silently overwrite. Method name you invoked isn't known by the object you invoked it on. + + +Object you invoked a method on isn't known. Since 2.42 + + + + +Interface you invoked a method on isn't known by the object. Since 2.42 + + + + +Property you tried to access isn't known by the object. Since 2.42 + + + + +Property you tried to set is read-only. Since 2.42 + + Certain timeout errors, e.g. while starting a service. Warning: this is @@ -2924,7 +2948,7 @@ and only if %G_DBUS_PROXY_FLAGS_DO_NOT_AUTOSTART is not also specified. -Flags used when sending #GDBusMessage<!-- -->s on a #GDBusConnection. +Flags used when sending #GDBusMessages on a #GDBusConnection. Since: 2.26 @@ -4257,6 +4281,41 @@ Since: 2.32 + + +Priority levels for #GNotifications. + +Since: 2.42 + + + + + for notifications that do not require +immediate attention - typically used for contextual background +information, such as contact birthdays or local weather + + + + the default priority, to be used for the +majority of notifications (for example email messages, software updates, +completed download/sync operations) + + + + for events that require more attention, +usually because responses are time-sensitive (for example chat and SMS +messages or alarms) + + + + for urgent notifications, or notifications +that require a response in a short space of time (for example phone calls +or emergency warnings) + + + + + GOutputStreamSpliceFlags determine how streams should be spliced. @@ -5453,6 +5512,67 @@ Emitted when the unix mounts have changed. + + +Types of UNIX mounts. + + + + + Unknown UNIX mount type. + + + + Floppy disk UNIX mount type. + + + + CDROM UNIX mount type. + + + + Network File System (NFS) UNIX mount type. + + + + ZIP UNIX mount type. + + + + JAZZ UNIX mount type. + + + + Memory Stick UNIX mount type. + + + + Compact Flash UNIX mount type. + + + + Smart Media UNIX mount type. + + + + SD/MMC UNIX mount type. + + + + iPod UNIX mount type. + + + + Digital camera UNIX mount type. + + + + Hard drive UNIX mount type. + + + + + The type of name used by a #GUnixSocketAddress. @@ -19919,7 +20039,8 @@ Since: 2.28 - the state type, if the action is stateful + the state type, if the action +is stateful @@ -21198,6 +21319,59 @@ Since: 2.28 + + +Add an option to be handled by @application. + +Calling this function is the equivalent of calling +g_application_add_main_option_entries() with a single #GOptionEntry +that has its arg_data member set to %NULL. + +The parsed arguments will be packed into a #GVariantDict which +is passed to #GApplication::handle-local-options. If +%G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also +be sent to the primary instance. See +g_application_add_main_option_entries() for more details. + +See #GOptionEntry for more documentation of the arguments. + +Since: 2.42 + + + + + the #GApplication + + + + the long name of an option used to specify it in a commandline + + + + the short name of an option + + + + flags from #GOptionFlags + + + + the type of the option, as a #GOptionArg + + + + the description for the option in `--help` output + + + + the placeholder to use for the extra argument +parsed by the option in `--help` output + + + + + + Adds main option entries to be handled by @application. @@ -21856,6 +22030,26 @@ Since: 2.28 + + +Gets the resource base path of @application. + +See g_application_set_resource_base_path() for more information. + +Since: 2.42 + + + + + a #GApplication + + + + the base resource path, if one is set + + + + Increases the use count of @application. @@ -22378,6 +22572,53 @@ Since: 2.28 + + +Sets (or unsets) the base resource path of @application. + +The path is used to automatically load various [application +resources][gresource] such as menu layouts and action descriptions. +The various types of resources will be found at fixed names relative +to the given base path. + +By default, the resource base path is determined from the application +ID by prefixing '/' and replacing each '.' with '/'. This is done at +the time that the #GApplication object is constructed. Changes to +the application ID after that point will not have an impact on the +resource base path. + +As an example, if the application has an ID of "org.example.app" then +the default resource base path will be "/org/example/app". If this +is a #GtkApplication (and you have not manually changed the path) +then Gtk will then search for the menus of the application at +"/org/example/app/gtk/menus.ui". + +See #GResource for more information about adding resources to your +application. + +You can disable automatic resource loading functionality by setting +the path to %NULL. + +Changing the resource base path once the application is running is +not recommended. The point at which the resource path is consulted +for forming paths for various purposes is unspecified. + +Since: 2.42 + + + + + a #GApplication + + + + the resource path to use + + + + + + Decreases the busy count of @application. @@ -23891,8 +24132,8 @@ Gets the top cancellable from the stack. - a #GCancellable from the top of the stack, or %NULL -if the stack is empty. + a #GCancellable from the top +of the stack, or %NULL if the stack is empty. @@ -24257,8 +24498,8 @@ Since: 2.18 - Newly allocated string with content type -or %NULL. Free with g_free() + Newly allocated string with content type or +%NULL. Free with g_free() @@ -25104,12 +25345,12 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a -NUL terminated byte array with the line that was read in (without -the newlines). Set @length to a #gsize to get the length of the -read line. On an error, it will return %NULL and @error will be -set. If there's no content to read, it will still return %NULL, -but @error won't be set. + +a NUL terminated byte array with the line that was read in +(without the newlines). Set @length to a #gsize to get the length +of the read line. On an error, it will return %NULL and @error +will be set. If there's no content to read, it will still return +%NULL, but @error won't be set. @@ -25178,12 +25419,12 @@ Since: 2.20 - a -NUL-terminated byte array with the line that was read in -(without the newlines). Set @length to a #gsize to get the -length of the read line. On an error, it will return %NULL and -@error will be set. If there's no content to read, it will -still return %NULL, but @error won't be set. + +a NUL-terminated byte array with the line that was read in +(without the newlines). Set @length to a #gsize to get the length +of the read line. On an error, it will return %NULL and @error +will be set. If there's no content to read, it will still return +%NULL, but @error won't be set. @@ -25214,12 +25455,12 @@ Since: 2.30 - a string with the line that was read in -(without the newlines). Set @length to a #gsize to get the length -of the read line. On an error, it will return %NULL and @error -will be set. For UTF-8 conversion errors, the set error domain is -%G_CONVERT_ERROR. If there's no content to read, it will still -return %NULL, but @error won't be set. + a string with the line that +was read in (without the newlines). Set @length to a #gsize to +get the length of the read line. On an error, it will return +%NULL and @error will be set. For UTF-8 conversion errors, the set +error domain is %G_CONVERT_ERROR. If there's no content to read, +it will still return %NULL, but @error won't be set. @@ -25253,12 +25494,13 @@ Since: 2.30 - a NUL terminated UTF-8 string with the -line that was read in (without the newlines). Set @length to a -#gsize to get the length of the read line. On an error, it will -return %NULL and @error will be set. For UTF-8 conversion errors, -the set error domain is %G_CONVERT_ERROR. If there's no content to -read, it will still return %NULL, but @error won't be set. + a NUL terminated UTF-8 string +with the line that was read in (without the newlines). Set +@length to a #gsize to get the length of the read line. On an +error, it will return %NULL and @error will be set. For UTF-8 +conversion errors, the set error domain is %G_CONVERT_ERROR. If +there's no content to read, it will still return %NULL, but @error +won't be set. @@ -29387,7 +29629,8 @@ Since: 2.26 - A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message. + A #GVariant or %NULL if the body is +empty. Do not free, it is owned by @message. @@ -31119,8 +31362,8 @@ Since: 2.30 - The name owner or %NULL if no name owner exists. Free with -g_free(). + The name owner or %NULL if no name owner +exists. Free with g_free(). @@ -33074,6 +33317,25 @@ Gets the generic name from the destkop file. + + +Gets all applications that implement @interface. + +An application implements an interface if that interface is listed in +the Implements= line of the desktop file of the application. + +Since: 2.42 + + + + + the name of the interface + + + + + + A desktop file is hidden if the Hidden key in it is @@ -33135,8 +33397,10 @@ Checks if the application info should be shown in menus that list available applications for a specific name of the desktop, based on the `OnlyShowIn` and `NotShowIn` keys. -If @desktop_env is %NULL, then the name of the desktop set with -g_desktop_app_info_set_desktop_env() is used. +@desktop_env should typically be given as %NULL, in which case the +`XDG_CURRENT_DESKTOP` environment variable is consulted. If you want +to override the default mechanism then you may specify @desktop_env, +but this is not recommended. Note that g_app_info_should_show() for @info will include this check (with %NULL for @desktop_env) as well as additional checks. @@ -33475,19 +33739,11 @@ g_desktop_app_info_get_show_in() to evaluate the `OnlyShowIn` and `NotShowIn` desktop entry fields. -The -[Desktop Menu specification](http://standards.freedesktop.org/menu-spec/latest/) -recognizes the following: -- GNOME -- KDE -- ROX -- XFCE -- LXDE -- Unity -- Old - Should be called only once; subsequent calls are ignored. +Deprecated:2.42:do not use this API. Since 2.42 the value of the +`XDG_CURRENT_DESKTOP` environment variable will be used. + @@ -34720,6 +34976,40 @@ the @matcher is automatically freed. + + +Duplicates a file attribute. + + + + + + a #GFileAttributeValue to duplicate. + + + + a duplicate of the @other. + + + + + +Sets an attribute's value from another attribute. + + + + + a #GFileAttributeValue to set the value in. + + + + a #GFileAttributeValue to get the value from. + + + + + + Copies the file @source to the location specified by @destination. @@ -34803,8 +35093,9 @@ Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called -just like in g_file_copy(), however the callback will run in the main loop, -not in the thread that is doing the I/O operation. +just like in g_file_copy(). The callback will run in the default main context +of the thread calling g_file_copy_async() — the same context as @callback is +run in. When the operation is finished, @callback will be called. You can then call g_file_copy_finish() to get the result of the operation. @@ -35785,8 +36076,9 @@ be unset. - A #GFileInfo or %NULL on error or end of enumerator. -Free the returned object with g_object_unref() when no longer needed. + A #GFileInfo or %NULL on error +or end of enumerator. Free the returned object with +g_object_unref() when no longer needed. @@ -35863,7 +36155,7 @@ ignore. - a #GList of #GFileInfo<!---->s. You must free the list with + a #GList of #GFileInfos. You must free the list with g_list_free() and unref the infos with g_object_unref() when you're done with them. @@ -35910,7 +36202,6 @@ This call does no blocking I/O. %TRUE if @file1 and @file2 are equal. -%FALSE if either is not a #GFile. @@ -36038,8 +36329,8 @@ This call does no blocking I/O. - string containing the #GFile's base name, or %NULL -if given #GFile is invalid. The returned string should be + 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. @@ -36121,8 +36412,8 @@ This call does no blocking I/O. a #GFile structure to the -parent of the given #GFile or %NULL if there is -no parent. Free the returned object with g_object_unref(). +parent of the given #GFile or %NULL if there is no parent. Free +the returned object with g_object_unref(). @@ -36171,9 +36462,9 @@ This call does no blocking I/O. - 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. + 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. @@ -36196,9 +36487,9 @@ This call does no blocking I/O. 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. +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. @@ -37061,9 +37352,9 @@ Lists the file info structure's attributes. - a null-terminated array of strings of all of the -possible attribute types for the given @name_space, or -%NULL on error. + a +null-terminated array of strings of all of the possible attribute +types for the given @name_space, or %NULL on error. @@ -41677,8 +41968,8 @@ Since: 2.20 - An allocated NUL-terminated UTF8 string or %NULL if @icon can't -be serialized. Use g_free() to free. + An allocated NUL-terminated UTF8 string or +%NULL if @icon can't be serialized. Use g_free() to free. @@ -42692,6 +42983,9 @@ It is not an error if this is not the same as the requested size, as it can happen e.g. near the end of a file. Zero is returned on end of file (or if @count is zero), but never otherwise. +The returned @buffer is not a nul-terminated string, it can contain nul bytes +at any position, and this function doesn't nul-terminate the @buffer. + If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an @@ -42866,6 +43160,7 @@ partial result will be returned, without an error. On error %NULL is returned and @error is set accordingly. +Since: 2.34 @@ -42888,6 +43183,7 @@ values include 4096 and 8192. a new #GBytes, or %NULL on error + @@ -42914,6 +43210,8 @@ Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT. +Since: 2.34 + @@ -42948,6 +43246,7 @@ priority. Default priority is %G_PRIORITY_DEFAULT. Finishes an asynchronous stream read-into-#GBytes operation. +Since: 2.34 @@ -42966,6 +43265,7 @@ ignore. the newly-allocated #GBytes, or %NULL on error + @@ -44192,17 +44492,18 @@ see g_loadable_icon_load_async(). - a location to store the type of the -loaded icon, %NULL to ignore. + a location to store the type of the loaded +icon, %NULL to ignore. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to +ignore. - a #GError location to store the error occurring, or %NULL to -ignore. + a #GError location to store the error occurring, or %NULL +to ignore. @@ -44259,8 +44560,8 @@ Finishes an asynchronous icon load started in g_loadable_icon_load_async(). - a location to store the type of the -loaded icon, %NULL to ignore. + a location to store the type of the loaded +icon, %NULL to ignore. @@ -47815,6 +48116,25 @@ Since: 2.40 + + +Sets the priority of @notification to @priority. See +#GNotificationPriority for possible values. + + + + + a #GNotification + + + + a #GNotificationPriority + + + + + + Sets the title of @notification to @title. @@ -47837,7 +48157,7 @@ Since: 2.40 -Sets or unsets whether @notification is marked as urgent. +Deprecated in favor of g_notification_set_priority(). Since: 2.40 @@ -49117,8 +49437,8 @@ Virtual: read_nonblocking - a buffer to read data into (which should be at least @count -bytes long). + a buffer to +read data into (which should be at least @count bytes long). @@ -49338,7 +49658,8 @@ Since: 2.34 - a buffer to read data into + a buffer to +read data into @@ -50225,7 +50546,7 @@ address(es). @hostname may be an ASCII-only or UTF-8 hostname, or the textual form of an IP address (in which case this just becomes a wrapper around g_inet_address_new_from_string()). -On success, g_resolver_lookup_by_name() will return a #GList of +On success, g_resolver_lookup_by_name() will return a non-empty #GList of #GInetAddress, sorted in order of preference and guaranteed to not contain duplicates. That is, if using the result to connect to @hostname, you should attempt to connect to the first address @@ -50234,7 +50555,7 @@ the result to listen on a socket, it is appropriate to add each result using e.g. g_socket_listener_add_address(). If the DNS resolution fails, @error (if non-%NULL) will be set to a -value from #GResolverError. +value from #GResolverError and %NULL will be returned. If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to @@ -50265,7 +50586,7 @@ Since: 2.22 - a #GList + a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -50348,7 +50669,7 @@ a list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain for each @record_type. If the DNS resolution fails, @error (if non-%NULL) will be set to -a value from #GResolverError. +a value from #GResolverError and %NULL will be returned. If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to @@ -50379,9 +50700,10 @@ Since: 2.34 - a #GList of #GVariant, -or %NULL on error. You must free each of the records and the list when you are -done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) + a non-empty #GList of +#GVariant, or %NULL on error. You must free each of the records and the list +when you are done with it. (You can use g_list_free_full() with +g_variant_unref() to do this.) @@ -50428,8 +50750,9 @@ Since: 2.34 Retrieves the result of a previous call to -g_resolver_lookup_records_async(). Returns a list of records as #GVariant -tuples. See #GResolverRecordType for information on what the records contain. +g_resolver_lookup_records_async(). Returns a non-empty list of records as +#GVariant tuples. See #GResolverRecordType for information on what the +records contain. If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @@ -50452,9 +50775,10 @@ Since: 2.34 - a #GList of #GVariant, -or %NULL on error. You must free each of the records and the list when you are -done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) + a non-empty #GList of +#GVariant, or %NULL on error. You must free each of the records and the list +when you are done with it. (You can use g_list_free_full() with +g_variant_unref() to do this.) @@ -50467,13 +50791,13 @@ Synchronously performs a DNS SRV lookup for the given @service and @service and @protocol arguments do not include the leading underscore that appears in the actual DNS entry. -On success, g_resolver_lookup_service() will return a #GList of +On success, g_resolver_lookup_service() will return a non-empty #GList of #GSrvTarget, sorted in order of preference. (That is, you should attempt to connect to the first target first, then the second if the first fails, etc.) If the DNS resolution fails, @error (if non-%NULL) will be set to -a value from #GResolverError. +a value from #GResolverError and %NULL will be returned. If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to @@ -50512,9 +50836,10 @@ Since: 2.22 - a #GList of #GSrvTarget, -or %NULL on error. You must free each of the targets and the list when you are -done with it. (You can use g_resolver_free_targets() to do this.) + a non-empty #GList of +#GSrvTarget, or %NULL on error. You must free each of the targets and the +list when you are done with it. (You can use g_resolver_free_targets() to do +this.) @@ -50589,8 +50914,9 @@ Since: 2.22 - a #GList of #GSrvTarget, -or %NULL on error. See g_resolver_lookup_service() for more details. + a non-empty #GList of +#GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more +details. @@ -50807,6 +51133,20 @@ Since: 2.32 + + + + + + + a GvdbTable + + + + a new #GResource for @table + + + Looks for a file at the specified @path in the resource and @@ -52896,12 +53236,13 @@ Since: 2.40 - the list of non-relocatable -schemas + the +list of non-relocatable schemas - the list of relocatable schemas + the list +of relocatable schemas @@ -56322,8 +56663,9 @@ Since: 2.22 -Creates a %GSource that can be attached to a %GMainContext to monitor -for the availability of the specified @condition on the socket. +Creates a #GSource that can be attached to a %GMainContext to monitor +for the availability of the specified @condition on the socket. The #GSource +keeps a reference to the @socket. The callback on the source is of the #GSocketSourceFunc type. @@ -57258,6 +57600,11 @@ to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to. +The @socket will not be automatically closed when the @listener is finalized +unless the listener held the final reference to the socket. Before GLib 2.42, +the @socket was automatically closed on finalization of the @listener, even +if references to it were held elsewhere. + Since: 2.22 @@ -58702,7 +59049,7 @@ process as UTF-8, and returns it as a regular NUL terminated string. -Asynchronous version of g_subprocess_communicate_utf(). Complete +Asynchronous version of g_subprocess_communicate_utf8(). Complete invocation with g_subprocess_communicate_utf8_finish(). @@ -59313,8 +59660,7 @@ Since: 2.40 -A convenience helper for creating a #GSubprocess given a provided -varargs list of arguments. +Creates a #GSubprocess given a provided varargs list of arguments. Since: 2.40 @@ -59343,8 +59689,7 @@ Since: 2.40 -A convenience helper for creating a #GSubprocess given a provided -array of arguments. +Creates a #GSubprocess given a provided array of arguments. Since: 2.40 @@ -59556,8 +59901,11 @@ Since: 2.40 - first commandline argument to pass to the subprocess, -followed by more arguments, followed by %NULL + first commandline argument to pass to the subprocess + + + + more commandline arguments, followed by %NULL @@ -59633,6 +59981,9 @@ g_subprocess_get_exit_status(). This function does not fail in the case of the subprocess having abnormal termination. See g_subprocess_wait_check() for that. +Cancelling @cancellable doesn't kill the subprocess. Call +g_subprocess_force_exit() if it is desirable. + Since: 2.40 @@ -62034,7 +62385,9 @@ Since: 2.30 - a newly allocated string containing the handle. + a newly allocated string containing the +handle. + @@ -64143,6 +64496,23 @@ Since: 2.34 + + +Guesses the type of a unix mount. If the mount type cannot be +determined, returns %G_UNIX_MOUNT_TYPE_UNKNOWN. + + + + + + a #GUnixMount. + + + + a #GUnixMountType. + + + Checks if a unix mount is mounted read only. @@ -64381,6 +64751,24 @@ Since: 2.34 + + +Guesses the type of a unix mount point. +If the mount type cannot be determined, +returns %G_UNIX_MOUNT_TYPE_UNKNOWN. + + + + + + a #GUnixMountPoint. + + + + a #GUnixMountType. + + + Checks if a unix mount point is a loopback device. @@ -65117,8 +65505,8 @@ Since: 2.18 - the activation root of @volume or %NULL. Use -g_object_unref() to free. + the activation root of @volume +or %NULL. Use g_object_unref() to free. @@ -65690,6 +66078,62 @@ 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. + + + + + + a new #GVfs handle. + + + Returns the #GZlibCompressor:file-info property. @@ -65797,29 +66241,38 @@ Since: 2.24 - + -Returns all the desktop ids for @mime_type. The desktop files -are listed in an order so that default applications are listed before -non-default ones, and handlers for inherited mimetypes are listed -after the base ones. +Sleep for a short time, then get a session bus connection and call +a method on it. -Optionally doesn't list the desktop ids given in the @except +Runs in a non-main thread. - - a mime type. - - - - NULL or a strv list + + delay in microseconds - a #GList containing the desktop ids which claim -to handle @mime_type. + the connection + + + + + +Returns the list of logical and viewable drives as defined by +GetLogicalDrives() and the registry keys +Software\Microsoft\Windows\CurrentVersion\Policies\Explorer under +HKLM or HKCU. If neither key exists the result of +GetLogicalDrives() is returned. + + + + + + bitmask with same meaning as returned by GetLogicalDrives() @@ -66370,20 +66823,32 @@ Represents a subscription on a file or directory. - + -Reload the mime information for the @dir. +Unsafe, need lock fen_lock. +port_add will associate a GSource to @f->source - - directory path which needs reloading. + + + + +< private > +Unsafe, need lock fen_lock. + + + + + + + Processes notifications, coming from the kqueue thread. @@ -66413,4 +66878,84 @@ A typical GIO Channel callback function. + + +Return two #GIOStream<!---->s connected to each other with pipes. +The "left" input stream is connected by a unidirectional pipe +to the "right" output stream, and vice versa. This can be used +as a bidirectional pipe to a child process, for instance. + +See test_pipe() if you only need a one-way pipe. + + + + + + used to return one #GIOStream + + + + used to return the other #GIOStream + + + + used to raise an error + + + + %TRUE on success + + + + + +Return a simple #GIOStream binding together @input_stream and +@output_stream. They have no additional semantics as a result of being +part of this I/O stream: in particular, closing one does not close +the other (although closing the #GIOStream will close both sub-streams). + + + + + + an input stream + + + + an output stream + + + + a new #GIOStream + + + + + +Return a "pipe to self" connecting @is to @os. This can be used +as a unidirectional pipe to or from a child process, for instance. + +See test_bidi_pipe() if you want to emulate a bidirectional pipe +via a pair of unidirectional pipes. + + + + + + used to return a #GInputStream + + + + used to return a #GOutputStream + + + + used to raise an error + + + + %TRUE on success + + + diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml index c40583a3..a9661537 100644 --- a/glib/src/glib_docs.xml +++ b/glib/src/glib_docs.xml @@ -126,7 +126,7 @@ default handler of the signal. whether the instance and data should be swapped when -calling the handler. +calling the handler; see g_signal_connect_swapped() for an example. @@ -712,7 +712,10 @@ This flag cannot be changed. indicates that the io channel is writable. This flag cannot be changed. -G_IO_FLAG_IS_WRITEABLE: a misspelled version of @G_IO_FLAG_IS_WRITABLE + + + + a misspelled version of @G_IO_FLAG_IS_WRITABLE that existed before the spelling was fixed in GLib 2.30. It is kept here for compatibility reasons. Deprecated since 2.30 @@ -1289,6 +1292,10 @@ can be configured. See also #G_PARAM_READWRITE and #G_PARAM_STATIC_STRINGS. the parameter is writable + + alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE + + the parameter will be set upon object construction @@ -1323,6 +1330,13 @@ unmodified for the lifetime of the parameter. Since 2.8 + + calls to g_object_set_property() for this +property will not automatically result in a "notify" signal being +emitted: the implementation must call g_object_notify() themselves +in case the property actually changes. Since: 2.42. + + internal @@ -2276,6 +2290,8 @@ shortage. Try again later. +Thread priorities. + Deprecated:2.32: Thread priorities no longer have any effect. @@ -2523,19 +2539,19 @@ Deprecated: 2.36: g_type_init() is now done automatically - Print no messages. + Print no messages - Print messages about object bookkeeping. + Print messages about object bookkeeping - Print messages about signal emissions. + Print messages about signal emissions - Mask covering all debug flags. + Mask covering all debug flags @@ -2549,13 +2565,13 @@ Bit masks used to check or determine characteristics of a type. Indicates an abstract type. No instances can be -created for an abstract type. +created for an abstract type Indicates an abstract value type, i.e. a type that introduces a value table, but can't be used for -g_value_init(). +g_value_init() @@ -2569,19 +2585,19 @@ fundamental type. - Indicates a classed type. + Indicates a classed type - Indicates an instantiable type (implies classed). + Indicates an instantiable type (implies classed) - Indicates a flat derivable type. + Indicates a flat derivable type - Indicates a deep derivable type (implies derivable). + Indicates a deep derivable type (implies derivable) @@ -3204,6 +3220,95 @@ Old South Arabian. Since 2.26 Takri. Since: 2.32 + + Bassa. Since: 2.42 + + + + Caucasian Albanian. Since: 2.42 + + + + Duployan. Since: 2.42 + + + + Elbasan. Since: 2.42 + + + + Grantha. Since: 2.42 + + + + Kjohki. Since: 2.42 + + + + Khudawadi, Sindhi. Since: 2.42 + + + + Linear A. Since: 2.42 + + + + Mahajani. Since: 2.42 + + + + Manichaean. Since: 2.42 + + + + Mende Kikakui. Since: 2.42 + + + + Modi. Since: 2.42 + + + + Mro. Since: 2.42 + + + + Nabataean. Since: 2.42 + + + + Old North Arabian. Since: 2.42 + + + + Old Permic. Since: 2.42 + + + + Pahawh Hmong. Since: 2.42 + + + + Palmyrene. Since: 2.42 + + + + Pau Cin Hau. Since: 2.42 + + + + Psalter Pahlavi. Since: 2.42 + + + + Siddham. Since: 2.42 + + + + Tirhuta. Since: 2.42 +@G_UNICODE_SCRIPT_WARANG_CITI Warang Citi. Since: 2.42 + + @@ -3598,33 +3703,26 @@ Allocates @size bytes on the stack; these bytes will be freed when the current stack frame is cleaned up. This macro essentially just wraps the alloca() function present on most UNIX variants. Thus it provides the same advantages and pitfalls as alloca(): -<variablelist> -<varlistentry><term></term><listitem><para> -+ alloca() is very fast, as on most systems it's implemented by just adjusting + +- alloca() is very fast, as on most systems it's implemented by just adjusting the stack pointer register. -</para></listitem></varlistentry> -<varlistentry><term></term><listitem><para> -+ It doesn't cause any memory fragmentation, within its scope, separate alloca() + +- It doesn't cause any memory fragmentation, within its scope, separate alloca() blocks just build up and are released together at function end. -</para></listitem></varlistentry> -<varlistentry><term></term><listitem><para> + - Allocation sizes have to fit into the current stack frame. For instance in a threaded environment on Linux, the per-thread stack size is limited to 2 Megabytes, so be sparse with alloca() uses. -</para></listitem></varlistentry> -<varlistentry><term></term><listitem><para> + - Allocation failure due to insufficient stack space is not indicated with a %NULL return like e.g. with malloc(). Instead, most systems probably handle it the same way as out of stack space situations from infinite function recursion, i.e. with a segmentation fault. -</para></listitem></varlistentry> -<varlistentry><term></term><listitem><para> + - Special care has to be taken when mixing alloca() with GNU C variable sized arrays. Stack space allocated with alloca() in the same scope as a variable sized array will be freed together with the variable sized array upon exit of that scope, and not upon exit of the enclosing function scope. -</para></listitem></varlistentry> -</variablelist> @@ -8558,7 +8656,7 @@ Since: 2.32 Creates an integer hash code for the byte data in the #GBytes. -This function can be passed to g_hash_table_new() as the @key_equal_func +This function can be passed to g_hash_table_new() as the @key_hash_func parameter, when using non-%NULL #GBytes pointers as keys in a #GHashTable. Since: 2.32 @@ -9804,6 +9902,9 @@ to g_closure_invoke() A generic marshaller function implemented via [libffi](http://sourceware.org/libffi/). +Normally this function is not passed explicitly to g_signal_new(), +but used automatically by GLib when specifying a %NULL marshaller. + Since: 2.30 @@ -10341,9 +10442,6 @@ If the reference is %NULL then this function does nothing. Otherwise, the reference count of the object is decreased and the pointer is set to %NULL. -This function is threadsafe and modifies the pointer atomically, -using memory barriers where needed. - A macro is also included that allows this function to be used without pointer casts. @@ -10369,9 +10467,6 @@ If the reference is %NULL then this function does nothing. Otherwise, the variable is destroyed using @destroy and the pointer is set to %NULL. -This function is threadsafe and modifies the pointer atomically, -using memory barriers where needed. - A macro is also included that allows this function to be used without pointer casts. @@ -11470,7 +11565,7 @@ well) on many platforms. Consider using g_str_to_ascii() instead. - the length of the string, or -1 if the string is + the length of the string in bytes, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) @@ -11540,7 +11635,7 @@ could combine with the base character.) - the length of the string, or -1 if the string is + the length of the string in bytes, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) @@ -11609,7 +11704,7 @@ could combine with the base character.) - the length of the string, or -1 if the string is + the length of the string in bytes, or -1 if the string is nul-terminated (Note that some encodings may allow nul bytes to occur inside strings. In that case, using -1 for the @len parameter is unsafe) @@ -11919,9 +12014,6 @@ Its up to the caller to free this as he wishes, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. -Return: %TRUE if the existing value for @key_id was replaced -by @newval, %FALSE otherwise. - Since: 2.34 @@ -11951,7 +12043,10 @@ Since: 2.34 - + %TRUE if the existing value for @key_id was replaced +by @newval, %FALSE otherwise. + + @@ -17424,7 +17519,7 @@ otherwise you have to make sure that any dynamically allocated values are freed yourself. It is safe to continue iterating the #GHashTable afterward: -|[ +|[<!-- language="C" --> while (g_hash_table_iter_next (&iter, &key, &value)) { if (condition) @@ -17889,6 +17984,8 @@ g_hmac_get_digest() have been called on a #GHmac, the HMAC will be closed and it won't be possible to call g_hmac_update() on it anymore. +Support for digests of type %G_CHECKSUM_SHA512 has been added in GLib 2.42. + Since: 2.30 @@ -19112,16 +19209,6 @@ Converts an `errno` error number to a #GIOChannelError. - - - - - - - the quark used as %G_IO_CHANNEL_ERROR - - - Flushes the write buffer for the GIOChannel. @@ -27011,8 +27098,12 @@ Looks up the #GParamSpec for a property of a class. -Installs new properties from an array of #GParamSpecs. This is -usually done in the class initializer. +Installs new properties from an array of #GParamSpecs. + +All properties should be installed during the class initializer. It +is possible to install properties after that, but doing so is not +recommend, and specifically, is not guaranteed to be thread-safe vs. +use of properties on the same type on other threads. The property id of each property is the index of each #GParamSpec in the @pspecs array. @@ -27092,7 +27183,12 @@ defining the new properties -Installs a new property. This is usually done in the class initializer. +Installs a new property. + +All properties should be installed during the class initializer. It +is possible to install properties after that, but doing so is not +recommend, and specifically, is not guaranteed to be thread-safe vs. +use of properties on the same type on other threads. Note that it is possible to redefine a property in a derived class, by installing a property with the same name. This can be useful at times, @@ -27916,9 +28012,6 @@ Its up to the caller to free this as he wishes, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. -Return: %TRUE if the existing value for @key was replaced -by @newval, %FALSE otherwise. - Since: 2.34 @@ -27948,7 +28041,10 @@ Since: 2.34 - + %TRUE if the existing value for @key was replaced +by @newval, %FALSE otherwise. + + @@ -27967,9 +28063,6 @@ Its up to the caller to free this as he wishes, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. -Return: %TRUE if the existing value for @quark was replaced -by @newval, %FALSE otherwise. - Since: 2.34 @@ -27999,7 +28092,10 @@ Since: 2.34 - + %TRUE if the existing value for @quark was replaced +by @newval, %FALSE otherwise. + + @@ -36725,7 +36821,7 @@ UTF-8. Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed. -You should be mindful fo the fact that environment variable handling +You should be mindful of the fact that environment variable handling in UNIX is not thread-safe, and your program may crash if one thread calls g_setenv() while another thread is calling getenv(). (And note that many functions, such as gettext(), call getenv() internally.) @@ -36780,15 +36876,16 @@ domain. Free the returned vector with g_strfreev(). - return location for number of args + return location for number of args, or %NULL - return location for array of args + return +location for array of args, or %NULL - return location for error + return location for error, or %NULL @@ -37220,7 +37317,29 @@ is not safe). Connects a #GCallback function to a signal for a particular object. The instance on which the signal is emitted and @data will be swapped when -calling the handler. +calling the handler. This is useful when calling pre-existing functions to +operate purely on the @data, rather than the @instance: swapping the +parameters avoids the need to write a wrapper function. + +For example, this allows the shorter code: +|[<!-- language="C" --> +g_signal_connect_swapped (button, "clicked", +(GCallback) gtk_widget_hide, other_widget); +]| + +Rather than the cumbersome: +|[<!-- language="C" --> +static void +button_clicked_cb (GtkButton *button, GtkWidget *other_widget) +{ +gtk_widget_hide (other_widget); +} + +… + +g_signal_connect (button, "clicked", +(GCallback) button_clicked_cb, other_widget); +]| @@ -37242,7 +37361,7 @@ calling the handler. - the handler id (always greater than 0 for successful connections) + the handler ID (always greater than 0 for successful connections) @@ -37598,11 +37717,14 @@ and/or @data the handlers have to match. +Destroy all signal handlers of a type instance. This function is +an implementation detail of the #GObject dispose implementation, +and should not be used outside of the type system. - The instance where a signal handler is sought. + The instance whose signal handlers are destroyed @@ -37966,7 +38088,7 @@ g_signal_chain_from_overridden_handler(). See g_signal_new() for information about signal names. -If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as +If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. Since: 2.18 @@ -38094,7 +38216,7 @@ Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. -If c_marshaller is %NULL @g_cclosure_marshal_generic will be used as +If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. @@ -42720,7 +42842,8 @@ Creates a new #GString, initialized with the given string. - the initial text to copy into the string + the initial text to copy into the string, or %NULL to +start with an empty string. @@ -43430,6 +43553,10 @@ Splits a string into a maximum of @max_tokens pieces, using the given @delimiter. If @max_tokens is reached, the remainder of @string is appended to the last token. +As an example, the result of g_strsplit (":a:bc::d:", ":", -1) is a +%NULL-terminated vector containing the six strings "", "a", "bc", "", "d" +and "". + As a special case, the result of splitting the empty string "" is an empty vector, not a vector containing a single string. The reason for this special case is that being able to represent a empty vector is typically @@ -43472,7 +43599,7 @@ For example the result of g_strsplit_set ("abc:def/ghi", ":/" %NULL-terminated vector containing the three strings "abc", "def", and "ghi". -The result if g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated +The result of g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated vector containing the four strings "", "def", "ghi", and "". As a special case, the result of splitting the empty string "" is an empty @@ -45992,7 +46119,7 @@ The meaning of @time_ depends on @type. If @type is %G_TIME_TYPE_UNIVERSAL then this function will always succeed (since universal time is monotonic and continuous). -Otherwise @time_ is treated is local time. The distinction between +Otherwise @time_ is treated as local time. The distinction between %G_TIME_TYPE_STANDARD and %G_TIME_TYPE_DAYLIGHT is ignored except in the case that the given @time_ is ambiguous. In Toronto, for example, 01:30 on November 7th 2010 occurred twice (once inside of daylight @@ -47424,7 +47551,9 @@ Registers a private class structure for a classed type; when the class is allocated, the private structures for the class and all of its parent types are allocated sequentially in the same memory block as the public -structures. This function should be called in the +structures, and are zero-filled. + +This function should be called in the type's get_type() function after the type is registered. The private structure can be retrieved using the G_TYPE_CLASS_GET_PRIVATE() macro. @@ -47570,7 +47699,7 @@ Registers a private structure for an instantiatable type. When an object is allocated, the private structures for the type and all of its parent types are allocated sequentially in the same memory block as the public -structures. +structures, and are zero-filled. Note that the accumulated size of the private structures of a type and all its parent types cannot exceed 64 KiB. @@ -47612,6 +47741,7 @@ my_object_init (MyObject *my_object) my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object, MY_TYPE_OBJECT, MyObjectPrivate); +// my_object->priv->some_field will be automatically initialised to 0 } static int @@ -47801,6 +47931,9 @@ implementators of fundamental types only. E.g. instances of the directly through g_type_create_instance() which doesn't handle things like singleton objects or object construction. +The extended members of the returned instance are guaranteed to be filled +with zeros. + Note: Do not use this function, unless you're implementing a fundamental type. Also language bindings should not use this function, but g_object_new() instead. @@ -49492,7 +49625,7 @@ for details. If a character passes the g_unichar_iswide() test then it will also pass this test, but not the other way around. Note that some characters may -pas both this test and g_unichar_iszerowidth(). +pass both this test and g_unichar_iszerowidth(). Since: 2.12 @@ -51858,20 +51991,47 @@ Initializes @value with the default value of @type. + + +Initializes and sets @value from an instantiatable type via the +value_table's collect_value() function. + +Note: The @value will be initialised with the exact type of +@instance. If you wish to set the @value's type to a different GType +(such as a parent class GType), you need to manually call +g_value_init() and g_value_set_instance(). + +Since: 2.42 + + + + + An uninitialized #GValue structure. + + + + the instance + + + + + + +Returns the value contents as pointer. This function asserts that +g_value_fits_pointer() returned %TRUE for the passed in value. +This is an internal function introduced mainly for C marshallers. + - An initialized #GValue structure. + An initialized #GValue structure - the value contents as pointer. This -function asserts that g_value_fits_pointer() returned %TRUE for the -passed in value. This is an internal function introduced mainly -for C marshallers. + the value contents as pointer @@ -53885,7 +54045,7 @@ To deserialise the data returned by this function, in addition to the serialised data, you must know the type of the #GVariant, and (if the machine might be different) the endianness of the machine that stored it. As a result, file formats or network messages that incorporate -serialised #GVariant<!---->s must include this information either +serialised #GVariants must include this information either implicitly (for instance "the file always contains a %G_VARIANT_TYPE_VARIANT and it is always in little-endian order") or explicitly (by storing the type and/or endianness in addition to the @@ -55072,7 +55232,7 @@ Note that the arguments must be of the correct width for their types specified in @format_string. This can be achieved by casting them. See the [GVariant varargs documentation][gvariant-varargs]. -|[ +|[<!-- language="C" --> MyFlags some_flags = FLAG_ONE | FLAG_TWO; const gchar *some_strings[] = { "a", "b", "c", NULL }; GVariant *new_variant; @@ -56051,6 +56211,8 @@ Since: 2.40 +Same as g_variant_error_quark(). + Deprecated: Use g_variant_parse_error_quark() instead. @@ -57823,6 +57985,20 @@ API between glib, gobject, and gio. + + +The binary age of the GLib library. +Defines how far back backwards compatibility reaches. + +An integer variable exported from the library linked +against at application run time. + + + + + + + Checks that the GLib library in use is compatible with the @@ -57883,6 +58059,33 @@ the internals of glib (such as libgio). + + +The interface age of the GLib library. +Defines how far back the API has last been extended. + +An integer variable exported from the library linked +against at application run time. + + + + + + + + + +The major version of the GLib library. + +An integer variable exported from the library linked +against at application run time. + + + + + + + A #GMemVTable containing profiling variants of the memory @@ -57896,6 +58099,32 @@ of your program. + + +The micro version number of the GLib library. + +An integer variable exported from the library linked +against at application run time. + + + + + + + + + +The minor version number of the GLib library. + +An integer variable exported from the library linked +against at application run time. + + + + + + + This function is a variant of glib_gettext() which supports -- cgit v1.2.1