From f5c255b4b49314458efc10ce691f5804025bf616 Mon Sep 17 00:00:00 2001 From: Felix Krull Date: Thu, 31 Oct 2019 14:58:22 +0100 Subject: [PATCH] Update bundled glib gir files --- rust-bindings/rust/gir-files/GLib-2.0.gir | 18654 ++++++----- rust-bindings/rust/gir-files/GObject-2.0.gir | 7776 +++-- rust-bindings/rust/gir-files/Gio-2.0.gir | 29450 ++++++++++------- rust-bindings/rust/src/auto/repo.rs | 12 +- 4 files changed, 33266 insertions(+), 22626 deletions(-) diff --git a/rust-bindings/rust/gir-files/GLib-2.0.gir b/rust-bindings/rust/gir-files/GLib-2.0.gir index 90f999cf..3d7e51ed 100644 --- a/rust-bindings/rust/gir-files/GLib-2.0.gir +++ b/rust-bindings/rust/gir-files/GLib-2.0.gir @@ -32,7 +32,7 @@ while Windows uses process handles (which are pointers). GPid is used in GLib only for descendant processes spawned with the g_spawn functions. - + @@ -41,6 +41,16 @@ particular string. A GQuark value of zero is associated to %NULL. + + Opaque type. See g_rw_lock_reader_locker_new() for details. + + + + + Opaque type. See g_rw_lock_writer_locker_new() for details. + + + Opaque type. See g_rec_mutex_locker_new() for details. @@ -63,13 +73,13 @@ g_auto(). - - Simply a replacement for time_t. It has been deprecated -since it is not equivalent to time_t on 64-bit platforms -with a 64-bit time_t. Unrelated to #GTimer. + + Simply a replacement for `time_t`. It has been deprecated +since it is not equivalent to `time_t` on 64-bit platforms +with a 64-bit `time_t`. Unrelated to #GTimer. Note that #GTime is defined to always be a 32-bit integer, -unlike time_t which may be 64-bit on some systems. Therefore, +unlike `time_t` which may be 64-bit on some systems. Therefore, #GTime will overflow in the year 2038, and you cannot use the address of a #GTime variable as argument to the UNIX time() function. @@ -82,6 +92,8 @@ GTime gtime; time (&ttime); gtime = (GTime)ttime; ]| + This is not [Y2038-safe](https://en.wikipedia.org/wiki/Year_2038_problem). + Use #GDateTime or #time_t instead. @@ -94,12 +106,51 @@ gtime = (GTime)ttime; + + Return the minimal alignment required by the platform ABI for values of the given +type. The address of a variable or struct member of the given type must always be +a multiple of this alignment. For example, most platforms require int variables +to be aligned at a 4-byte boundary, so `G_ALIGNOF (int)` is 4 on most platforms. + +Note this is not necessarily the same as the value returned by GCC’s +`__alignof__` operator, which returns the preferred alignment for a type. +The preferred alignment may be a stricter alignment than the minimal +alignment. + + + + a type-name + + + - + + + Evaluates to a truth value if the absolute difference between @a and @b is +smaller than @epsilon, and to a false value otherwise. + +For example, +- `G_APPROX_VALUE (5, 6, 2)` evaluates to true +- `G_APPROX_VALUE (3.14, 3.15, 0.001)` evaluates to false +- `G_APPROX_VALUE (n, 0.f, FLT_EPSILON)` evaluates to true if `n` is within + the single precision floating point epsilon from zero + + + + a numeric value + + + a numeric value + + + a numeric value that expresses the tolerance between @a and @b + + + - A good size for a buffer to be passed into g_ascii_dtostr(). + A good size for a buffer to be passed into g_ascii_dtostr(). It is guaranteed to be enough for all output of that function on systems with 64bit IEEE-compatible doubles. @@ -112,6 +163,13 @@ The typical usage would be something like: + + + + + + + Contains the public fields of a GArray. @@ -126,33 +184,106 @@ The typical usage would be something like: - Adds @len elements onto the end of the array. - + Adds @len elements onto the end of the array. + - the #GArray + the #GArray - a #GArray + a #GArray - a pointer to the elements to append to the end of the array + a pointer to the elements to append to the end of the array - the number of elements to append + the number of elements to append + + Checks whether @target exists in @array by performing a binary +search based on the given comparison function @compare_func which +get pointers to items as arguments. If the element is found, %TRUE +is returned and the element’s index is returned in @out_match_index +(if non-%NULL). Otherwise, %FALSE is returned and @out_match_index +is undefined. If @target exists multiple times in @array, the index +of the first instance is returned. This search is using a binary +search, so the @array must absolutely be sorted to return a correct +result (if not, the function may produce false-negative). + +This example defines a comparison function and search an element in a #GArray: +|[<!-- language="C" --> +static gint* +cmpint (gconstpointer a, gconstpointer b) +{ + const gint *_a = a; + const gint *_b = b; + + return *_a - *_b; +} +... +gint i = 424242; +guint matched_index; +gboolean result = g_array_binary_search (garray, &i, cmpint, &matched_index); +... +]| + + + %TRUE if @target is one of the elements of @array, %FALSE otherwise. + + + + + a #GArray. + + + + + + a pointer to the item to look up. + + + + A #GCompareFunc used to locate @target. + + + + return location + for the index of the element, if found. + + + + + + Create a shallow copy of a #GArray. If the array elements consist of +pointers to data, the pointers are copied but the actual data is not. + + + A copy of @array. + + + + + + + A #GArray. + + + + + + - Frees the memory allocated for the #GArray. If @free_segment is + Frees the memory allocated for the #GArray. If @free_segment is %TRUE it frees the memory block holding the elements as well. Pass %FALSE if you want to free the #GArray wrapper but preserve the underlying array for use elsewhere. If the reference count of @@ -166,35 +297,35 @@ function has been set for @array. This function is not thread-safe. If using a #GArray from multiple threads, use only the atomic g_array_ref() and g_array_unref() functions. - + - the element data if @free_segment is %FALSE, otherwise + the element data if @free_segment is %FALSE, otherwise %NULL. The element data should be freed using g_free(). - a #GArray + a #GArray - if %TRUE the actual element data is freed as well + if %TRUE the actual element data is freed as well - Gets the size of the elements in @array. - + Gets the size of the elements in @array. + - Size of each element, in bytes + Size of each element, in bytes - A #GArray + A #GArray @@ -202,7 +333,7 @@ functions. - Inserts @len elements into a #GArray at the given index. + Inserts @len elements into a #GArray at the given index. If @index_ is greater than the array’s current length, the array is expanded. The elements between the old end of the array and the newly inserted elements @@ -211,62 +342,62 @@ otherwise their values will be undefined. @data may be %NULL if (and only if) @len is zero. If @len is zero, this function is a no-op. - + - the #GArray + the #GArray - a #GArray + a #GArray - the index to place the elements at + the index to place the elements at - a pointer to the elements to insert + a pointer to the elements to insert - the number of elements to insert + the number of elements to insert - Creates a new #GArray with a reference count of 1. + Creates a new #GArray with a reference count of 1. - the new #GArray + the new #GArray - %TRUE if the array should have an extra element at + %TRUE if the array should have an extra element at the end which is set to 0 - %TRUE if #GArray elements should be automatically cleared + %TRUE if #GArray elements should be automatically cleared to 0 when they are allocated - the size of each element in bytes + the size of each element in bytes - Adds @len elements onto the start of the array. + Adds @len elements onto the start of the array. @data may be %NULL if (and only if) @len is zero. If @len is zero, this function is a no-op. @@ -274,43 +405,43 @@ function is a no-op. This operation is slower than g_array_append_vals() since the existing elements in the array have to be moved to make space for the new elements. - + - the #GArray + the #GArray - a #GArray + a #GArray - a pointer to the elements to prepend to the start of the array + a pointer to the elements to prepend to the start of the array - the number of elements to prepend, which may be zero + the number of elements to prepend, which may be zero - Atomically increments the reference count of @array by one. + Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread. - + - The passed in #GArray + The passed in #GArray - A #GArray + A #GArray @@ -318,82 +449,82 @@ This function is thread-safe and may be called from any thread. - Removes the element at the given index from a #GArray. The following + Removes the element at the given index from a #GArray. The following elements are moved down one place. - + - the #GArray + the #GArray - a #GArray + a #GArray - the index of the element to remove + the index of the element to remove - Removes the element at the given index from a #GArray. The last + Removes the element at the given index from a #GArray. The last element in the array is used to fill in the space, so this function does not preserve the order of the #GArray. But it is faster than g_array_remove_index(). - + - the #GArray + the #GArray - a @GArray + a @GArray - the index of the element to remove + the index of the element to remove - Removes the given number of elements starting at the given index + Removes the given number of elements starting at the given index from a #GArray. The following elements are moved to close the gap. - + - the #GArray + the #GArray - a @GArray + a @GArray - the index of the first element to remove + the index of the first element to remove - the number of elements to remove + the number of elements to remove - Sets a function to clear an element of @array. + Sets a function to clear an element of @array. The @clear_func will be called when an element in the array data segment is removed and when the array is freed and data @@ -403,105 +534,105 @@ pointer to the element to clear, rather than the element itself. Note that in contrast with other uses of #GDestroyNotify functions, @clear_func is expected to clear the contents of the array element it is given, but not free the element itself. - + - A #GArray + A #GArray - a function to clear an element of @array + a function to clear an element of @array - Sets the size of the array, expanding it if necessary. If the array + Sets the size of the array, expanding it if necessary. If the array was created with @clear_ set to %TRUE, the new elements are set to 0. - + - the #GArray + the #GArray - a #GArray + a #GArray - the new size of the #GArray + the new size of the #GArray - Creates a new #GArray with @reserved_size elements preallocated and + Creates a new #GArray with @reserved_size elements preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many elements to the array. Note however that the size of the array is still 0. - the new #GArray + the new #GArray - %TRUE if the array should have an extra element at + %TRUE if the array should have an extra element at the end with all bits cleared - %TRUE if all bits in the array should be cleared to 0 on + %TRUE if all bits in the array should be cleared to 0 on allocation - size of each element in the array + size of each element in the array - number of elements preallocated + number of elements preallocated - Sorts a #GArray using @compare_func which should be a qsort()-style + Sorts a #GArray using @compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater zero if first arg is greater than second arg). This is guaranteed to be a stable sort since version 2.32. - + - a #GArray + a #GArray - comparison function + comparison function - Like g_array_sort(), but the comparison function receives an extra + Like g_array_sort(), but the comparison function receives an extra user data argument. This is guaranteed to be a stable sort since version 2.32. @@ -509,39 +640,39 @@ This is guaranteed to be a stable sort since version 2.32. There used to be a comment here about making the sort stable by using the addresses of the elements in the comparison function. This did not actually work, so any such code should be removed. - + - a #GArray + a #GArray - comparison function + comparison function - data to pass to @compare_func + data to pass to @compare_func - Atomically decrements the reference count of @array by one. If the + Atomically decrements the reference count of @array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread. - + - A #GArray + A #GArray @@ -580,7 +711,7 @@ an asynchronous queue. It should only be accessed through the g_async_queue_* functions. - Returns the length of the queue. + Returns the length of the queue. Actually this function returns the number of data items in the queue minus the number of waiting threads, so a negative @@ -590,18 +721,18 @@ in the queue and n threads waiting. This can happen due to locking of the queue or due to scheduling. - the length of the @queue + the length of the @queue - a #GAsyncQueue. + a #GAsyncQueue. - Returns the length of the queue. + Returns the length of the queue. Actually this function returns the number of data items in the queue minus the number of waiting threads, so a negative @@ -613,18 +744,18 @@ of the queue or due to scheduling. This function must be called while holding the @queue's lock. - the length of the @queue. + the length of the @queue. - a #GAsyncQueue + a #GAsyncQueue - Acquires the @queue's lock. If another thread is already + Acquires the @queue's lock. If another thread is already holding the lock, this call will block until the lock becomes available. @@ -639,62 +770,62 @@ deadlock may occur. - a #GAsyncQueue + a #GAsyncQueue - Pops data from the @queue. If @queue is empty, this function + Pops data from the @queue. If @queue is empty, this function blocks until data becomes available. - data from the queue + data from the queue - a #GAsyncQueue + a #GAsyncQueue - Pops data from the @queue. If @queue is empty, this function + Pops data from the @queue. If @queue is empty, this function blocks until data becomes available. This function must be called while holding the @queue's lock. - data from the queue. + data from the queue. - a #GAsyncQueue + a #GAsyncQueue - Pushes the @data into the @queue. @data must not be %NULL. + Pushes the @data into the @queue. @data must not be %NULL. - a #GAsyncQueue + a #GAsyncQueue - @data to push into the @queue + @data to push into the @queue - Pushes the @item into the @queue. @item must not be %NULL. + Pushes the @item into the @queue. @item must not be %NULL. In contrast to g_async_queue_push(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue. @@ -704,17 +835,17 @@ so that it will be the next one to be popped off the queue. - a #GAsyncQueue + a #GAsyncQueue - data to push into the @queue + data to push into the @queue - Pushes the @item into the @queue. @item must not be %NULL. + Pushes the @item into the @queue. @item must not be %NULL. In contrast to g_async_queue_push_unlocked(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue. @@ -726,17 +857,17 @@ This function must be called while holding the @queue's lock. - a #GAsyncQueue + a #GAsyncQueue - data to push into the @queue + data to push into the @queue - Inserts @data into @queue using @func to determine the new + Inserts @data into @queue using @func to determine the new position. This function requires that the @queue is sorted before pushing on @@ -752,25 +883,25 @@ For an example of @func see g_async_queue_sort(). - a #GAsyncQueue + a #GAsyncQueue - the @data to push into the @queue + the @data to push into the @queue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - user data passed to @func. + user data passed to @func. - Inserts @data into @queue using @func to determine the new + Inserts @data into @queue using @func to determine the new position. The sort function @func is passed two elements of the @queue. @@ -791,25 +922,25 @@ For an example of @func see g_async_queue_sort(). - a #GAsyncQueue + a #GAsyncQueue - the @data to push into the @queue + the @data to push into the @queue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - user data passed to @func. + user data passed to @func. - Pushes the @data into the @queue. @data must not be %NULL. + Pushes the @data into the @queue. @data must not be %NULL. This function must be called while holding the @queue's lock. @@ -818,32 +949,32 @@ This function must be called while holding the @queue's lock. - a #GAsyncQueue + a #GAsyncQueue - @data to push into the @queue + @data to push into the @queue - Increases the reference count of the asynchronous @queue by 1. + Increases the reference count of the asynchronous @queue by 1. You do not need to hold the lock to call this function. - the @queue that was passed in (since 2.6) + the @queue that was passed in (since 2.6) - a #GAsyncQueue + a #GAsyncQueue - Increases the reference count of the asynchronous @queue by 1. + Increases the reference count of the asynchronous @queue by 1. Reference counting is done atomically. so g_async_queue_ref() can be used regardless of the @queue's lock. @@ -853,51 +984,51 @@ lock. - a #GAsyncQueue + a #GAsyncQueue - Remove an item from the queue. + Remove an item from the queue. - %TRUE if the item was removed + %TRUE if the item was removed - a #GAsyncQueue + a #GAsyncQueue - the data to remove from the @queue + the data to remove from the @queue - Remove an item from the queue. + Remove an item from the queue. This function must be called while holding the @queue's lock. - %TRUE if the item was removed + %TRUE if the item was removed - a #GAsyncQueue + a #GAsyncQueue - the data to remove from the @queue + the data to remove from the @queue - Sorts @queue using @func. + Sorts @queue using @func. The sort function @func is passed two elements of the @queue. It should return 0 if they are equal, a negative value if the @@ -925,21 +1056,21 @@ lowest priority would be at the top of the queue, you could use: - a #GAsyncQueue + a #GAsyncQueue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - user data passed to @func + user data passed to @func - Sorts @queue using @func. + Sorts @queue using @func. The sort function @func is passed two elements of the @queue. It should return 0 if they are equal, a negative value if the @@ -954,97 +1085,97 @@ This function must be called while holding the @queue's lock. - a #GAsyncQueue + a #GAsyncQueue - the #GCompareDataFunc is used to sort @queue + the #GCompareDataFunc is used to sort @queue - user data passed to @func + user data passed to @func - Pops data from the @queue. If the queue is empty, blocks until + Pops data from the @queue. If the queue is empty, blocks until @end_time or until data becomes available. If no data is received before @end_time, %NULL is returned. -To easily calculate @end_time, a combination of g_get_current_time() +To easily calculate @end_time, a combination of g_get_real_time() and g_time_val_add() can be used. use g_async_queue_timeout_pop(). - + - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before @end_time. - a #GAsyncQueue + a #GAsyncQueue - a #GTimeVal, determining the final time + a #GTimeVal, determining the final time - Pops data from the @queue. If the queue is empty, blocks until + Pops data from the @queue. If the queue is empty, blocks until @end_time or until data becomes available. If no data is received before @end_time, %NULL is returned. -To easily calculate @end_time, a combination of g_get_current_time() +To easily calculate @end_time, a combination of g_get_real_time() and g_time_val_add() can be used. This function must be called while holding the @queue's lock. use g_async_queue_timeout_pop_unlocked(). - + - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before @end_time. - a #GAsyncQueue + a #GAsyncQueue - a #GTimeVal, determining the final time + a #GTimeVal, determining the final time - Pops data from the @queue. If the queue is empty, blocks for + Pops data from the @queue. If the queue is empty, blocks for @timeout microseconds, or until data becomes available. If no data is received before the timeout, %NULL is returned. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before the timeout. - a #GAsyncQueue + a #GAsyncQueue - the number of microseconds to wait + the number of microseconds to wait - Pops data from the @queue. If the queue is empty, blocks for + Pops data from the @queue. If the queue is empty, blocks for @timeout microseconds, or until data becomes available. If no data is received before the timeout, %NULL is returned. @@ -1052,57 +1183,57 @@ If no data is received before the timeout, %NULL is returned. This function must be called while holding the @queue's lock. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is received before the timeout. - a #GAsyncQueue + a #GAsyncQueue - the number of microseconds to wait + the number of microseconds to wait - Tries to pop data from the @queue. If no data is available, + Tries to pop data from the @queue. If no data is available, %NULL is returned. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is available immediately. - a #GAsyncQueue + a #GAsyncQueue - Tries to pop data from the @queue. If no data is available, + Tries to pop data from the @queue. If no data is available, %NULL is returned. This function must be called while holding the @queue's lock. - data from the queue or %NULL, when no data is + data from the queue or %NULL, when no data is available immediately. - a #GAsyncQueue + a #GAsyncQueue - Releases the queue's lock. + Releases the queue's lock. Calling this function when you have not acquired the with g_async_queue_lock() leads to undefined @@ -1113,13 +1244,13 @@ behaviour. - a #GAsyncQueue + a #GAsyncQueue - Decreases the reference count of the asynchronous @queue by 1. + Decreases the reference count of the asynchronous @queue by 1. If the reference count went to 0, the @queue will be destroyed and the memory allocated will be freed. So you are not allowed @@ -1131,13 +1262,13 @@ You do not need to hold the lock to call this function. - a #GAsyncQueue. + a #GAsyncQueue. - Decreases the reference count of the asynchronous @queue by 1 + Decreases the reference count of the asynchronous @queue by 1 and releases the lock. This function must be called while holding the @queue's lock. If the reference count went to 0, the @queue will be destroyed and the memory allocated will be freed. @@ -1150,40 +1281,40 @@ lock. - a #GAsyncQueue + a #GAsyncQueue - Creates a new asynchronous queue. + Creates a new asynchronous queue. - a new #GAsyncQueue. Free with g_async_queue_unref() + a new #GAsyncQueue. Free with g_async_queue_unref() - Creates a new asynchronous queue and sets up a destroy notify + Creates a new asynchronous queue and sets up a destroy notify function that is used to free any remaining queue items when the queue is destroyed after the final unref. - a new #GAsyncQueue. Free with g_async_queue_unref() + a new #GAsyncQueue. Free with g_async_queue_unref() - function to free queue elements + function to free queue elements - Specifies one of the possible types of byte order. + Specifies one of the possible types of byte order. See #G_BYTE_ORDER. - + @@ -1191,7 +1322,7 @@ See #G_BYTE_ORDER. private data and should not be directly accessed. - Adds the application with @name and @exec to the list of + Adds the application with @name and @exec to the list of applications that have registered a bookmark for @uri into @bookmark. @@ -1219,26 +1350,26 @@ If no bookmark for @uri is found, one is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the name of the application registering the bookmark + the name of the application registering the bookmark or %NULL - command line to be used to launch the bookmark or %NULL + command line to be used to launch the bookmark or %NULL - Adds @group to the list of groups to which the bookmark for @uri + Adds @group to the list of groups to which the bookmark for @uri belongs to. If no bookmark for @uri is found then it is created. @@ -1248,55 +1379,55 @@ If no bookmark for @uri is found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the group name to be added + the group name to be added - Frees a #GBookmarkFile. + Frees a #GBookmarkFile. - a #GBookmarkFile + a #GBookmarkFile - Gets the time the bookmark for @uri was added to @bookmark + Gets the time the bookmark for @uri was added to @bookmark In the event the URI cannot be found, -1 is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a timestamp + a timestamp - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Gets the registration information of @app_name for the bookmark for + Gets the registration information of @app_name for the bookmark for @uri. See g_bookmark_file_set_app_info() for more information about the returned data. @@ -1311,45 +1442,45 @@ the command line fails, an error of the #G_SHELL_ERROR domain is set and %FALSE is returned. - %TRUE on success. + %TRUE on success. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - an application's name + an application's name - return location for the command line of the application, or %NULL + return location for the command line of the application, or %NULL - return location for the registration count, or %NULL + return location for the registration count, or %NULL - return location for the last registration time, or %NULL + return location for the last registration time, or %NULL - Retrieves the names of the applications that have registered the + Retrieves the names of the applications that have registered the bookmark for @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a newly allocated %NULL-terminated array of strings. + a newly allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -1357,43 +1488,43 @@ In the event the URI cannot be found, %NULL is returned and - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - return location of the length of the returned list, or %NULL + return location of the length of the returned list, or %NULL - Retrieves the description of the bookmark for @uri. + Retrieves the description of the bookmark for @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified URI cannot be found. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Retrieves the list of group names of the bookmark for @uri. + Retrieves the list of group names of the bookmark for @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. @@ -1402,7 +1533,7 @@ The returned array is %NULL terminated, so @length may optionally be %NULL. - a newly allocated %NULL-terminated array of group names. + a newly allocated %NULL-terminated array of group names. Use g_strfreev() to free it. @@ -1410,51 +1541,51 @@ be %NULL. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - return location for the length of the returned string, or %NULL + return location for the length of the returned string, or %NULL - Gets the icon of the bookmark for @uri. + Gets the icon of the bookmark for @uri. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if the icon for the bookmark for the URI was found. + %TRUE if the icon for the bookmark for the URI was found. You should free the returned strings. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - return location for the icon's location or %NULL + return location for the icon's location or %NULL - return location for the icon's MIME type or %NULL + return location for the icon's MIME type or %NULL - Gets whether the private flag of the bookmark for @uri is set. + Gets whether the private flag of the bookmark for @uri is set. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the @@ -1462,22 +1593,22 @@ event that the private flag cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. - %TRUE if the private flag is set, %FALSE otherwise. + %TRUE if the private flag is set, %FALSE otherwise. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Retrieves the MIME type of the resource pointed by @uri. + Retrieves the MIME type of the resource pointed by @uri. In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the @@ -1485,58 +1616,58 @@ event that the MIME type cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified URI cannot be found. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Gets the time when the bookmark for @uri was last modified. + Gets the time when the bookmark for @uri was last modified. In the event the URI cannot be found, -1 is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a timestamp + a timestamp - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Gets the number of bookmarks inside @bookmark. + Gets the number of bookmarks inside @bookmark. - the number of bookmarks + the number of bookmarks - a #GBookmarkFile + a #GBookmarkFile - Returns the title of the bookmark for @uri. + Returns the title of the bookmark for @uri. If @uri is %NULL, the title of @bookmark is returned. @@ -1544,28 +1675,28 @@ In the event the URI cannot be found, %NULL is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified URI cannot be found. - a #GBookmarkFile + a #GBookmarkFile - a valid URI or %NULL + a valid URI or %NULL - Returns all URIs of the bookmarks in the bookmark file @bookmark. + Returns all URIs of the bookmarks in the bookmark file @bookmark. The array of returned URIs will be %NULL-terminated, so @length may optionally be %NULL. - a newly allocated %NULL-terminated array of strings. + a newly allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -1573,183 +1704,183 @@ optionally be %NULL. - a #GBookmarkFile + a #GBookmarkFile - return location for the number of returned URIs, or %NULL + return location for the number of returned URIs, or %NULL - Gets the time the bookmark for @uri was last visited. + Gets the time the bookmark for @uri was last visited. In the event the URI cannot be found, -1 is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - a timestamp. + a timestamp. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Checks whether the bookmark for @uri inside @bookmark has been + Checks whether the bookmark for @uri inside @bookmark has been registered by application @name. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if the application @name was found + %TRUE if the application @name was found - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the name of the application + the name of the application - Checks whether @group appears in the list of groups to which + Checks whether @group appears in the list of groups to which the bookmark for @uri belongs to. In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if @group was found. + %TRUE if @group was found. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the group name to be searched + the group name to be searched - Looks whether the desktop bookmark has an item with its URI set to @uri. + Looks whether the desktop bookmark has an item with its URI set to @uri. - %TRUE if @uri is inside @bookmark, %FALSE otherwise + %TRUE if @uri is inside @bookmark, %FALSE otherwise - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Loads a bookmark file from memory into an empty #GBookmarkFile + Loads a bookmark file from memory into an empty #GBookmarkFile structure. If the object cannot be created then @error is set to a #GBookmarkFileError. - %TRUE if a desktop bookmark could be loaded. + %TRUE if a desktop bookmark could be loaded. - an empty #GBookmarkFile struct + an empty #GBookmarkFile struct - desktop bookmarks + desktop bookmarks loaded in memory - the length of @data in bytes + the length of @data in bytes - This function looks for a desktop bookmark file named @file in the + This function looks for a desktop bookmark file named @file in the paths returned from g_get_user_data_dir() and g_get_system_data_dirs(), loads the file into @bookmark and returns the file's full path in @full_path. If the file could not be loaded then @error is set to either a #GFileError or #GBookmarkFileError. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - a #GBookmarkFile + a #GBookmarkFile - a relative path to a filename to open and parse + a relative path to a filename to open and parse - return location for a string + return location for a string containing the full path of the file, or %NULL - Loads a desktop bookmark file into an empty #GBookmarkFile structure. + Loads a desktop bookmark file into an empty #GBookmarkFile structure. If the file could not be loaded then @error is set to either a #GFileError or #GBookmarkFileError. - %TRUE if a desktop bookmark file could be loaded + %TRUE if a desktop bookmark file could be loaded - an empty #GBookmarkFile struct + an empty #GBookmarkFile struct - the path of a filename to load, in the + the path of a filename to load, in the GLib file name encoding - Changes the URI of a bookmark item from @old_uri to @new_uri. Any + Changes the URI of a bookmark item from @old_uri to @new_uri. Any existing bookmark for @new_uri will be overwritten. If @new_uri is %NULL, then the bookmark is removed. @@ -1757,26 +1888,26 @@ In the event the URI cannot be found, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. - %TRUE if the URI was successfully changed + %TRUE if the URI was successfully changed - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a valid URI, or %NULL + a valid URI, or %NULL - Removes application registered with @name from the list of applications + Removes application registered with @name from the list of applications that have registered a bookmark for @uri inside @bookmark. In the event the URI cannot be found, %FALSE is returned and @@ -1786,26 +1917,26 @@ a bookmark for @uri, %FALSE is returned and error is set to #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. - %TRUE if the application was successfully removed. + %TRUE if the application was successfully removed. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the name of the application + the name of the application - Removes @group from the list of groups to which the bookmark + Removes @group from the list of groups to which the bookmark for @uri belongs to. In the event the URI cannot be found, %FALSE is returned and @@ -1814,44 +1945,44 @@ In the event no group was defined, %FALSE is returned and @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE. - %TRUE if @group was successfully removed. + %TRUE if @group was successfully removed. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the group name to be removed + the group name to be removed - Removes the bookmark for @uri from the bookmark file @bookmark. + Removes the bookmark for @uri from the bookmark file @bookmark. - %TRUE if the bookmark was removed successfully. + %TRUE if the bookmark was removed successfully. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - Sets the time the bookmark for @uri was added into @bookmark. + Sets the time the bookmark for @uri was added into @bookmark. If no bookmark for @uri is found then it is created. @@ -1860,21 +1991,21 @@ If no bookmark for @uri is found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a timestamp or -1 to use the current time + a timestamp or -1 to use the current time - Sets the meta-data of application @name inside the list of + Sets the meta-data of application @name inside the list of applications that have registered a bookmark for @uri inside @bookmark. @@ -1904,39 +2035,39 @@ for @uri, %FALSE is returned and error is set to for @uri is found, one is created. - %TRUE if the application's meta-data was successfully + %TRUE if the application's meta-data was successfully changed. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - an application's name + an application's name - an application's command line + an application's command line - the number of registrations done for this application + the number of registrations done for this application - the time of the last registration for this application + the time of the last registration for this application - Sets @description as the description of the bookmark for @uri. + Sets @description as the description of the bookmark for @uri. If @uri is %NULL, the description of @bookmark is set. @@ -1947,21 +2078,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI or %NULL + a valid URI or %NULL - a string + a string - Sets a list of group names for the item with URI @uri. Each previously + Sets a list of group names for the item with URI @uri. Each previously set group name list is removed. If @uri cannot be found then an item for it is created. @@ -1971,28 +2102,28 @@ If @uri cannot be found then an item for it is created. - a #GBookmarkFile + a #GBookmarkFile - an item's URI + an item's URI - an array of + an array of group names, or %NULL to remove all groups - number of group name values in @groups + number of group name values in @groups - Sets the icon for the bookmark for @uri. If @href is %NULL, unsets + Sets the icon for the bookmark for @uri. If @href is %NULL, unsets the currently set icon. @href can either be a full URL for the icon file or the icon name following the Icon Naming specification. @@ -2003,25 +2134,25 @@ If no bookmark for @uri is found one is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - the URI of the icon for the bookmark, or %NULL + the URI of the icon for the bookmark, or %NULL - the MIME type of the icon for the bookmark + the MIME type of the icon for the bookmark - Sets the private flag of the bookmark for @uri. + Sets the private flag of the bookmark for @uri. If a bookmark for @uri cannot be found then it is created. @@ -2030,21 +2161,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - %TRUE if the bookmark should be marked as private + %TRUE if the bookmark should be marked as private - Sets @mime_type as the MIME type of the bookmark for @uri. + Sets @mime_type as the MIME type of the bookmark for @uri. If a bookmark for @uri cannot be found then it is created. @@ -2053,21 +2184,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a MIME type + a MIME type - Sets the last time the bookmark for @uri was last modified. + Sets the last time the bookmark for @uri was last modified. If no bookmark for @uri is found then it is created. @@ -2081,21 +2212,21 @@ g_bookmark_file_set_visited(). - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a timestamp or -1 to use the current time + a timestamp or -1 to use the current time - Sets @title as the title of the bookmark for @uri inside the + Sets @title as the title of the bookmark for @uri inside the bookmark file @bookmark. If @uri is %NULL, the title of @bookmark is set. @@ -2107,21 +2238,21 @@ If a bookmark for @uri cannot be found then it is created. - a #GBookmarkFile + a #GBookmarkFile - a valid URI or %NULL + a valid URI or %NULL - a UTF-8 encoded string + a UTF-8 encoded string - Sets the time the bookmark for @uri was last visited. + Sets the time the bookmark for @uri was last visited. If no bookmark for @uri is found then it is created. @@ -2136,24 +2267,24 @@ does not affect the "modified" time. - a #GBookmarkFile + a #GBookmarkFile - a valid URI + a valid URI - a timestamp or -1 to use the current time + a timestamp or -1 to use the current time - This function outputs @bookmark as a string. + This function outputs @bookmark as a string. - + a newly allocated string holding the contents of the #GBookmarkFile @@ -2161,30 +2292,30 @@ does not affect the "modified" time. - a #GBookmarkFile + a #GBookmarkFile - return location for the length of the returned string, or %NULL + return location for the length of the returned string, or %NULL - This function outputs @bookmark into a file. The write process is + This function outputs @bookmark into a file. The write process is guaranteed to be atomic by using g_file_set_contents() internally. - %TRUE if the file was successfully written. + %TRUE if the file was successfully written. - a #GBookmarkFile + a #GBookmarkFile - path of the output file + path of the output file @@ -2195,14 +2326,14 @@ guaranteed to be atomic by using g_file_set_contents() internally. - Creates a new empty #GBookmarkFile object. + Creates a new empty #GBookmarkFile object. Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data() or g_bookmark_file_load_from_data_dirs() to read an existing bookmark file. - an empty #GBookmarkFile + an empty #GBookmarkFile @@ -2250,58 +2381,58 @@ file. - Adds the given bytes to the end of the #GByteArray. + Adds the given bytes to the end of the #GByteArray. The array will grow in size automatically if necessary. - + - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the byte data to be added + the byte data to be added - the number of bytes to add + the number of bytes to add - Frees the memory allocated by the #GByteArray. If @free_segment is + Frees the memory allocated by the #GByteArray. If @free_segment is %TRUE it frees the actual byte data. If the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array will be set to zero. - + - the element data if @free_segment is %FALSE, otherwise + the element data if @free_segment is %FALSE, otherwise %NULL. The element data should be freed using g_free(). - a #GByteArray + a #GByteArray - if %TRUE the actual byte data is freed as well + if %TRUE the actual byte data is freed as well - Transfers the data from the #GByteArray into a new immutable #GBytes. + Transfers the data from the #GByteArray into a new immutable #GBytes. The #GByteArray is freed unless the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array @@ -2309,15 +2440,15 @@ will be set to zero. This is identical to using g_bytes_new_take() and g_byte_array_free() together. - + - a new immutable #GBytes representing same + a new immutable #GBytes representing same byte data that was in the array - a #GByteArray + a #GByteArray @@ -2325,78 +2456,78 @@ together. - Creates a new #GByteArray with a reference count of 1. - + Creates a new #GByteArray with a reference count of 1. + - the new #GByteArray + the new #GByteArray - Create byte array containing the data. The data will be owned by the array + Create byte array containing the data. The data will be owned by the array and will be freed with g_free(), i.e. it could be allocated using g_strdup(). - + - a new #GByteArray + a new #GByteArray - byte data for the array + byte data for the array - length of @data + length of @data - Adds the given data to the start of the #GByteArray. + Adds the given data to the start of the #GByteArray. The array will grow in size automatically if necessary. - + - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the byte data to be added + the byte data to be added - the number of bytes to add + the number of bytes to add - Atomically increments the reference count of @array by one. + Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread. - + - The passed in #GByteArray + The passed in #GByteArray - A #GByteArray + A #GByteArray @@ -2404,123 +2535,123 @@ This function is thread-safe and may be called from any thread. - Removes the byte at the given index from a #GByteArray. + Removes the byte at the given index from a #GByteArray. The following bytes are moved down one place. - + - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the index of the byte to remove + the index of the byte to remove - Removes the byte at the given index from a #GByteArray. The last + Removes the byte at the given index from a #GByteArray. The last element in the array is used to fill in the space, so this function does not preserve the order of the #GByteArray. But it is faster than g_byte_array_remove_index(). - + - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the index of the byte to remove + the index of the byte to remove - Removes the given number of bytes starting at the given index from a + Removes the given number of bytes starting at the given index from a #GByteArray. The following elements are moved to close the gap. - + - the #GByteArray + the #GByteArray - a @GByteArray + a @GByteArray - the index of the first byte to remove + the index of the first byte to remove - the number of bytes to remove + the number of bytes to remove - Sets the size of the #GByteArray, expanding it if necessary. - + Sets the size of the #GByteArray, expanding it if necessary. + - the #GByteArray + the #GByteArray - a #GByteArray + a #GByteArray - the new size of the #GByteArray + the new size of the #GByteArray - Creates a new #GByteArray with @reserved_size bytes preallocated. + Creates a new #GByteArray with @reserved_size bytes preallocated. This avoids frequent reallocation, if you are going to add many bytes to the array. Note however that the size of the array is still 0. - + - the new #GByteArray + the new #GByteArray - number of bytes preallocated + number of bytes preallocated - Sorts a byte array, using @compare_func which should be a + Sorts a byte array, using @compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater than zero if first arg is greater than second arg). @@ -2530,59 +2661,59 @@ is undefined. If you want equal elements to keep their order (i.e. you want a stable sort) you can write a comparison function that, if two elements would otherwise compare equal, compares them by their addresses. - + - a #GByteArray + a #GByteArray - comparison function + comparison function - Like g_byte_array_sort(), but the comparison function takes an extra + Like g_byte_array_sort(), but the comparison function takes an extra user data argument. - + - a #GByteArray + a #GByteArray - comparison function + comparison function - data to pass to @compare_func + data to pass to @compare_func - Atomically decrements the reference count of @array by one. If the + Atomically decrements the reference count of @array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread. - + - A #GByteArray + A #GByteArray @@ -2617,54 +2748,54 @@ mutable array for a #GBytes sequence. To create an immutable #GBytes from a mutable #GByteArray, use the g_byte_array_free_to_bytes() function. - Creates a new #GBytes from @data. + Creates a new #GBytes from @data. @data is copied. If @size is 0, @data may be %NULL. - a new #GBytes + a new #GBytes - + the data to be used for the bytes - the size of @data + the size of @data - Creates a new #GBytes from static data. + Creates a new #GBytes from static data. @data must be static (ie: never modified or freed). It may be %NULL if @size is 0. - a new #GBytes + a new #GBytes - + the data to be used for the bytes - the size of @data + the size of @data - Creates a new #GBytes from @data. + Creates a new #GBytes from @data. After this call, @data belongs to the bytes and may no longer be modified by the caller. g_free() will be called on @data when the @@ -2678,25 +2809,25 @@ g_bytes_new_with_free_func(). @data may be %NULL if @size is 0. - a new #GBytes + a new #GBytes - + the data to be used for the bytes - the size of @data + the size of @data - Creates a #GBytes from @data. + Creates a #GBytes from @data. When the last reference is dropped, @free_func will be called with the @user_data argument. @@ -2707,33 +2838,33 @@ been called to indicate that the bytes is no longer in use. @data may be %NULL if @size is 0. - a new #GBytes + a new #GBytes - + the data to be used for the bytes - the size of @data + the size of @data - the function to call to release the data + the function to call to release the data - data to pass to @free_func + data to pass to @free_func - Compares the two #GBytes values. + Compares the two #GBytes values. This function can be used to sort GBytes instances in lexicographical order. @@ -2744,46 +2875,46 @@ comparison. If @bytes1 has a smaller value at that position it is considered less, otherwise greater than @bytes2. - a negative value if @bytes1 is less than @bytes2, a positive value + a negative value if @bytes1 is less than @bytes2, a positive value if @bytes1 is greater than @bytes2, and zero if @bytes1 is equal to @bytes2 - a pointer to a #GBytes + a pointer to a #GBytes - a pointer to a #GBytes to compare with @bytes1 + a pointer to a #GBytes to compare with @bytes1 - Compares the two #GBytes values being pointed to and returns + Compares the two #GBytes values being pointed to and returns %TRUE if they are equal. This function can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL #GBytes pointers as keys in a #GHashTable. - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #GBytes + a pointer to a #GBytes - a pointer to a #GBytes to compare with @bytes1 + a pointer to a #GBytes to compare with @bytes1 - Get the byte data in the #GBytes. This data should not be modified. + Get the byte data in the #GBytes. This data should not be modified. This function will always return the same pointer for a given #GBytes. @@ -2792,7 +2923,7 @@ may represent an empty string with @data non-%NULL and @size as 0. %NULL will not be returned if @size is non-zero. - + a pointer to the byte data, or %NULL @@ -2800,50 +2931,50 @@ not be returned if @size is non-zero. - a #GBytes + a #GBytes - location to return size of byte data + location to return size of byte data - Get the size of the byte data in the #GBytes. + Get the size of the byte data in the #GBytes. This function will always return the same value for a given #GBytes. - the size + the size - a #GBytes + a #GBytes - Creates an integer hash code for the byte data in the #GBytes. + 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_hash_func parameter, when using non-%NULL #GBytes pointers as keys in a #GHashTable. - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #GBytes key + a pointer to a #GBytes key - Creates a #GBytes which is a subsection of another #GBytes. The @offset + + Creates a #GBytes which is a subsection of another #GBytes. The @offset + @length may not be longer than the size of @bytes. A reference to @bytes will be held by the newly created #GBytes until @@ -2856,40 +2987,40 @@ the same #GBytes instead of @bytes. This allows consumers to simplify the usage of #GBytes when asynchronously writing to streams. - a new #GBytes + a new #GBytes - a #GBytes + a #GBytes - offset which subsection starts at + offset which subsection starts at - length of subsection + length of subsection - Increase the reference count on @bytes. + Increase the reference count on @bytes. - the #GBytes + the #GBytes - a #GBytes + a #GBytes - Releases a reference on @bytes. This may result in the bytes being + Releases a reference on @bytes. This may result in the bytes being freed. If @bytes is %NULL, it will return immediately. @@ -2897,13 +3028,13 @@ freed. If @bytes is %NULL, it will return immediately. - a #GBytes + a #GBytes - Unreferences the bytes, and returns a new mutable #GByteArray containing + Unreferences the bytes, and returns a new mutable #GByteArray containing the same byte data. As an optimization, the byte data is transferred to the array without copying @@ -2912,20 +3043,20 @@ g_bytes_new(), g_bytes_new_take() or g_byte_array_free_to_bytes(). In all other cases the data is copied. - a new mutable #GByteArray containing the same byte data + a new mutable #GByteArray containing the same byte data - a #GBytes + a #GBytes - Unreferences the bytes, and returns a pointer the same byte data + Unreferences the bytes, and returns a pointer the same byte data contents. As an optimization, the byte data is returned without copying if this was @@ -2934,7 +3065,7 @@ g_bytes_new_take() or g_byte_array_free_to_bytes(). In all other cases the data is copied. - a pointer to the same byte data, which should be + a pointer to the same byte data, which should be freed with g_free() @@ -2942,32 +3073,48 @@ data is copied. - a #GBytes + a #GBytes - location to place the length of the returned data + location to place the length of the returned data + + Checks the version of the GLib library that is being compiled +against. See glib_check_version() for a runtime check. + + + + the major version to check for + + + the minor version to check for + + + the micro version to check for + + + - The set of uppercase ASCII alphabet characters. + The set of uppercase ASCII alphabet characters. Used for specifying valid identifier characters in #GScannerConfig. - The set of ASCII digits. + The set of ASCII digits. Used for specifying valid identifier characters in #GScannerConfig. - The set of lowercase ASCII alphabet characters. + The set of lowercase ASCII alphabet characters. Used for specifying valid identifier characters in #GScannerConfig. @@ -2979,7 +3126,7 @@ To create a new GChecksum, use g_checksum_new(). To free a GChecksum, use g_checksum_free(). - Creates a new #GChecksum, using the checksum algorithm @checksum_type. + Creates a new #GChecksum, using the checksum algorithm @checksum_type. If the @checksum_type is not known, %NULL is returned. A #GChecksum can be used to compute the checksum, or digest, of an arbitrary binary blob, using different hashing algorithms. @@ -2994,49 +3141,49 @@ will be closed and it won't be possible to call g_checksum_update() on it anymore. - the newly created #GChecksum, or %NULL. + the newly created #GChecksum, or %NULL. Use g_checksum_free() to free the memory allocated by it. - the desired type of checksum + the desired type of checksum - Copies a #GChecksum. If @checksum has been closed, by calling + Copies a #GChecksum. If @checksum has been closed, by calling g_checksum_get_string() or g_checksum_get_digest(), the copied checksum will be closed as well. - the copy of the passed #GChecksum. Use g_checksum_free() + the copy of the passed #GChecksum. Use g_checksum_free() when finished using it. - the #GChecksum to copy + the #GChecksum to copy - Frees the memory allocated for @checksum. + Frees the memory allocated for @checksum. - a #GChecksum + a #GChecksum - Gets the digest from @checksum as a raw binary vector and places it + Gets the digest from @checksum as a raw binary vector and places it into @buffer. The size of the digest depends on the type of checksum. Once this function has been called, the #GChecksum is closed and can @@ -3047,24 +3194,24 @@ no longer be updated with g_checksum_update(). - a #GChecksum + a #GChecksum - output buffer + output buffer - an inout parameter. The caller initializes it to the size of @buffer. + an inout parameter. The caller initializes it to the size of @buffer. After the call it contains the length of the digest. - Gets the digest as an hexadecimal string. + Gets the digest as an hexadecimal string. Once this function has been called the #GChecksum can no longer be updated with g_checksum_update(). @@ -3072,33 +3219,33 @@ updated with g_checksum_update(). The hexadecimal characters will be lower case. - the hexadecimal representation of the checksum. The + the hexadecimal representation of the checksum. The returned string is owned by the checksum and should not be modified or freed. - a #GChecksum + a #GChecksum - Resets the state of the @checksum back to its initial state. + Resets the state of the @checksum back to its initial state. - the #GChecksum to reset + the #GChecksum to reset - Feeds @data into an existing #GChecksum. The checksum must still be + Feeds @data into an existing #GChecksum. The checksum must still be open, that is g_checksum_get_string() or g_checksum_get_digest() must not have been called on @checksum. @@ -3107,32 +3254,32 @@ not have been called on @checksum. - a #GChecksum + a #GChecksum - buffer used to compute the checksum + buffer used to compute the checksum - size of the buffer, or -1 if it is a null-terminated string. + size of the buffer, or -1 if it is a null-terminated string. - Gets the length in bytes of digests of type @checksum_type + Gets the length in bytes of digests of type @checksum_type - the checksum length, or -1 if @checksum_type is + the checksum length, or -1 if @checksum_type is not supported. - a #GChecksumType + a #GChecksumType @@ -3186,17 +3333,17 @@ for g_spawn_check_exit_status(). - Specifies the type of function passed to g_clear_handle_id(). + Specifies the type of function passed to g_clear_handle_id(). The implementation is expected to free the resource identified by @handle_id; for instance, if @handle_id is a #GSource ID, g_source_remove() can be used. - + - the handle ID to clear + the handle ID to clear @@ -3325,7 +3472,7 @@ A #GCond should only be accessed via the g_cond_ functions. - If threads are waiting for @cond, all of them are unblocked. + If threads are waiting for @cond, all of them are unblocked. If no threads are waiting for @cond, this function has no effect. It is good practice to lock the same mutex as the waiting threads while calling this function, though not required. @@ -3335,13 +3482,13 @@ while calling this function, though not required. - a #GCond + a #GCond - Frees the resources allocated to a #GCond with g_cond_init(). + Frees the resources allocated to a #GCond with g_cond_init(). This function should not be used with a #GCond that has been statically allocated. @@ -3354,13 +3501,13 @@ blocking leads to undefined behaviour. - an initialised #GCond + an initialised #GCond - Initialises a #GCond so that it can be used. + Initialises a #GCond so that it can be used. This function is useful to initialise a #GCond that has been allocated as part of a larger structure. It is not necessary to @@ -3377,13 +3524,13 @@ to undefined behaviour. - an uninitialized #GCond + an uninitialized #GCond - If threads are waiting for @cond, at least one of them is unblocked. + If threads are waiting for @cond, at least one of them is unblocked. If no threads are waiting for @cond, this function has no effect. It is good practice to hold the same lock as the waiting thread while calling this function, though not required. @@ -3393,13 +3540,13 @@ while calling this function, though not required. - a #GCond + a #GCond - Atomically releases @mutex and waits until @cond is signalled. + Atomically releases @mutex and waits until @cond is signalled. When this function returns, @mutex is locked again and owned by the calling thread. @@ -3419,17 +3566,17 @@ the documentation for #GCond for a complete example. - a #GCond + a #GCond - a #GMutex that is currently locked + a #GMutex that is currently locked - Waits until either @cond is signalled or @end_time has passed. + Waits until either @cond is signalled or @end_time has passed. As with g_cond_wait() it is possible that a spurious or stolen wakeup could occur. For that reason, waiting on a condition variable should @@ -3479,20 +3626,20 @@ have to start over waiting again (which would lead to a total wait time of more than 5 seconds). - %TRUE on a signal, %FALSE on a timeout + %TRUE on a signal, %FALSE on a timeout - a #GCond + a #GCond - a #GMutex that is currently locked + a #GMutex that is currently locked - the monotonic time to wait until + the monotonic time to wait until @@ -3532,20 +3679,20 @@ time of more than 5 seconds). - A function of this signature is used to copy the node data + A function of this signature is used to copy the node data when doing a deep-copy of a tree. - + - A pointer to the copy + A pointer to the copy - A pointer to the data which should be copied + A pointer to the data which should be copied - Additional data + Additional data @@ -3558,30 +3705,703 @@ flags & ~G_DATALIST_FLAGS_MASK != 0 is an error. - Represents an invalid #GDateDay. + Represents an invalid #GDateDay. - Represents an invalid Julian day number. + Represents an invalid Julian day number. - Represents an invalid year. + Represents an invalid year. + + Defines the appropriate cleanup function for a pointer type. + +The function will not be called if the variable to be cleaned up +contains %NULL. + +This will typically be the `_free()` or `_unref()` function for the given +type. + +With this definition, it will be possible to use g_autoptr() with +@TypeName. + +|[ +G_DEFINE_AUTOPTR_CLEANUP_FUNC(GObject, g_object_unref) +]| + +This macro should be used unconditionally; it is a no-op on compilers +where cleanup is not supported. + + + + a type name to define a g_autoptr() cleanup function for + + + the cleanup function + + + + + Defines the appropriate cleanup function for a type. + +This will typically be the `_clear()` function for the given type. + +With this definition, it will be possible to use g_auto() with +@TypeName. + +|[ +G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GQueue, g_queue_clear) +]| + +This macro should be used unconditionally; it is a no-op on compilers +where cleanup is not supported. + + + + a type name to define a g_auto() cleanup function for + + + the clear function + + + + + Defines the appropriate cleanup function for a type. + +With this definition, it will be possible to use g_auto() with +@TypeName. + +This function will be rarely used. It is used with pointer-based +typedefs and non-pointer types where the value of the variable +represents a resource that must be freed. Two examples are #GStrv +and file descriptors. + +@none specifies the "none" value for the type in question. It is +probably something like %NULL or `-1`. If the variable is found to +contain this value then the free function will not be called. + +|[ +G_DEFINE_AUTO_CLEANUP_FREE_FUNC(GStrv, g_strfreev, NULL) +]| + +This macro should be used unconditionally; it is a no-op on compilers +where cleanup is not supported. + + + + a type name to define a g_auto() cleanup function for + + + the free function + + + the "none" value for the type + + + + + A convenience macro which defines a function returning the +#GQuark for the name @QN. The function will be named +@q_n_quark(). + +Note that the quark name will be stringified automatically +in the macro, so you shouldn't use double quotes. + + + + the name to return a #GQuark for + + + prefix for the function name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This macro is similar to %G_GNUC_DEPRECATED_FOR, and can be used to mark +functions declarations as deprecated. Unlike %G_GNUC_DEPRECATED_FOR, it +is meant to be portable across different compilers and must be placed +before the function declaration. + +|[<!-- language="C" -- +G_DEPRECATED_FOR(my_replacement) +int my_mistake (void); +]| + + + + the name of the function that this function was deprecated for + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - The directory separator character. + The directory separator character. This is '/' on UNIX machines and '\' under Windows. - + - The directory separator as a string. + The directory separator as a string. This is "/" on UNIX machines and "\" under Windows. - + @@ -3653,58 +4473,58 @@ and year. - Allocates a #GDate and initializes + Allocates a #GDate and initializes it to a sane state. The new date will be cleared (as if you'd called g_date_clear()) but invalid (it won't represent an existing day). Free the return value with g_date_free(). - a newly-allocated #GDate + a newly-allocated #GDate - Like g_date_new(), but also sets the value of the date. Assuming the + Like g_date_new(), but also sets the value of the date. Assuming the day-month-year triplet you pass in represents an existing day, the returned date will be valid. - a newly-allocated #GDate initialized with @day, @month, and @year + a newly-allocated #GDate initialized with @day, @month, and @year - day of the month + day of the month - month of the year + month of the year - year + year - Like g_date_new(), but also sets the value of the date. Assuming the + Like g_date_new(), but also sets the value of the date. Assuming the Julian day number you pass in is valid (greater than 0, less than an unreasonably large number), the returned date will be valid. - a newly-allocated #GDate initialized with @julian_day + a newly-allocated #GDate initialized with @julian_day - days since January 1, Year 1 + days since January 1, Year 1 - Increments a date some number of days. + Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid. @@ -3713,17 +4533,17 @@ The date must be valid. - a #GDate to increment + a #GDate to increment - number of days to move the date forward + number of days to move the date forward - Increments a date by some number of months. + Increments a date by some number of months. If the day of the month is greater than 28, this routine may change the day of the month (because the destination month may not have @@ -3734,17 +4554,17 @@ the current day in it). The date must be valid. - a #GDate to increment + a #GDate to increment - number of months to move forward + number of months to move forward - Increments a date by some number of years. + Increments a date by some number of years. If the date is February 29, and the destination year is not a leap year, the date will be changed to February 28. The date must be valid. @@ -3754,17 +4574,17 @@ to February 28. The date must be valid. - a #GDate to increment + a #GDate to increment - number of years to move forward + number of years to move forward - If @date is prior to @min_date, sets @date equal to @min_date. + If @date is prior to @min_date, sets @date equal to @min_date. If @date falls after @max_date, sets @date equal to @max_date. Otherwise, @date is unchanged. Either of @min_date and @max_date may be %NULL. @@ -3775,21 +4595,21 @@ All non-%NULL dates must be valid. - a #GDate to clamp + a #GDate to clamp - minimum accepted value for @date + minimum accepted value for @date - maximum accepted value for @date + maximum accepted value for @date - Initializes one or more #GDate structs to a sane but invalid + Initializes one or more #GDate structs to a sane but invalid state. The cleared dates will not represent an existing date, but will not contain garbage. Useful to init a date declared on the stack. Validity can be tested with g_date_valid(). @@ -3799,251 +4619,251 @@ Validity can be tested with g_date_valid(). - pointer to one or more dates to clear + pointer to one or more dates to clear - number of dates to clear + number of dates to clear - qsort()-style comparison function for dates. + qsort()-style comparison function for dates. Both dates must be valid. - 0 for equal, less than zero if @lhs is less than @rhs, + 0 for equal, less than zero if @lhs is less than @rhs, greater than zero if @lhs is greater than @rhs - first date to compare + first date to compare - second date to compare + second date to compare - Copies a GDate to a newly-allocated GDate. If the input was invalid + Copies a GDate to a newly-allocated GDate. If the input was invalid (as determined by g_date_valid()), the invalid state will be copied as is into the new object. - a newly-allocated #GDate initialized from @date + a newly-allocated #GDate initialized from @date - a #GDate to copy + a #GDate to copy - Computes the number of days between two dates. + Computes the number of days between two dates. If @date2 is prior to @date1, the returned value is negative. Both dates must be valid. - the number of days between @date1 and @date2 + the number of days between @date1 and @date2 - the first date + the first date - the second date + the second date - Frees a #GDate returned from g_date_new(). + Frees a #GDate returned from g_date_new(). - a #GDate to free + a #GDate to free - Returns the day of the month. The date must be valid. + Returns the day of the month. The date must be valid. - day of the month + day of the month - a #GDate to extract the day of the month from + a #GDate to extract the day of the month from - Returns the day of the year, where Jan 1 is the first day of the + Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid. - day of the year + day of the year - a #GDate to extract day of year from + a #GDate to extract day of year from - Returns the week of the year, where weeks are interpreted according + Returns the week of the year, where weeks are interpreted according to ISO 8601. - ISO 8601 week number of the year. + ISO 8601 week number of the year. - a valid #GDate + a valid #GDate - Returns the Julian day or "serial number" of the #GDate. The + Returns the Julian day or "serial number" of the #GDate. The Julian day is simply the number of days since January 1, Year 1; i.e., January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2, etc. The date must be valid. - Julian day + Julian day - a #GDate to extract the Julian day from + a #GDate to extract the Julian day from - Returns the week of the year, where weeks are understood to start on + Returns the week of the year, where weeks are understood to start on Monday. If the date is before the first Monday of the year, return 0. The date must be valid. - week of the year + week of the year - a #GDate + a #GDate - Returns the month of the year. The date must be valid. + Returns the month of the year. The date must be valid. - month of the year as a #GDateMonth + month of the year as a #GDateMonth - a #GDate to get the month from + a #GDate to get the month from - Returns the week of the year during which this date falls, if + Returns the week of the year during which this date falls, if 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. - week number + week number - a #GDate + a #GDate - Returns the day of the week for a #GDate. The date must be valid. + Returns the day of the week for a #GDate. The date must be valid. - day of the week as a #GDateWeekday. + day of the week as a #GDateWeekday. - a #GDate + a #GDate - Returns the year of a #GDate. The date must be valid. + Returns the year of a #GDate. The date must be valid. - year in which the date falls + year in which the date falls - a #GDate + a #GDate - Returns %TRUE if the date is on the first of a month. + Returns %TRUE if the date is on the first of a month. The date must be valid. - %TRUE if the date is the first of the month + %TRUE if the date is the first of the month - a #GDate to check + a #GDate to check - Returns %TRUE if the date is the last day of the month. + Returns %TRUE if the date is the last day of the month. The date must be valid. - %TRUE if the date is the last day of the month + %TRUE if the date is the last day of the month - a #GDate to check + a #GDate to check - Checks if @date1 is less than or equal to @date2, + Checks if @date1 is less than or equal to @date2, and swap the values if this is not the case. @@ -4051,17 +4871,17 @@ and swap the values if this is not the case. - the first date + the first date - the second date + the second date - Sets the day of the month for a #GDate. If the resulting + Sets the day of the month for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. @@ -4069,17 +4889,17 @@ day-month-year triplet is invalid, the date will be invalid. - a #GDate + a #GDate - day to set + day to set - Sets the value of a #GDate from a day, month, and year. + Sets the value of a #GDate from a day, month, and year. The day-month-year triplet must be valid; if you aren't sure it is, call g_date_valid_dmy() to check before you set it. @@ -4089,42 +4909,42 @@ set it. - a #GDate + a #GDate - day + day - month + month - year + year - Sets the value of a #GDate from a Julian day number. + Sets the value of a #GDate from a Julian day number. - a #GDate + a #GDate - Julian day number (days since January 1, Year 1) + Julian day number (days since January 1, Year 1) - Sets the month of the year for a #GDate. If the resulting + Sets the month of the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. @@ -4132,17 +4952,17 @@ day-month-year triplet is invalid, the date will be invalid. - a #GDate + a #GDate - month to set + month to set - Parses a user-inputted string @str, and try to figure out what date it + Parses a user-inputted string @str, and try to figure out what date it represents, taking the [current locale][setlocale] into account. If the string is successfully parsed, the date will be valid after the call. Otherwise, it will be invalid. You should check using g_date_valid() @@ -4159,17 +4979,17 @@ capacity). - a #GDate to fill in + a #GDate to fill in - string to parse + string to parse - Sets the value of a date from a #GTime value. + Sets the value of a date from a #GTime value. The time to date conversion is done using the user's current timezone. Use g_date_set_time_t() instead. @@ -4178,17 +4998,17 @@ The time to date conversion is done using the user's current timezone. - a #GDate. + a #GDate. - #GTime value to set. + #GTime value to set. - Sets the value of a date to the date corresponding to a time + Sets the value of a date to the date corresponding to a time specified as a time_t. The time to date conversion is done using the user's current timezone. @@ -4205,38 +5025,40 @@ To set the value of a date to the current day, you could write: - a #GDate + a #GDate - time_t value to set + time_t value to set - - Sets the value of a date from a #GTimeVal value. Note that the + + Sets the value of a date from a #GTimeVal value. Note that the @tv_usec member is ignored, because #GDate can't make use of the additional precision. The time to date conversion is done using the user's current timezone. - + #GTimeVal is not year-2038-safe. Use g_date_set_time_t() + instead. + - a #GDate + a #GDate - #GTimeVal value to set + #GTimeVal value to set - Sets the year for a #GDate. If the resulting day-month-year + Sets the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. @@ -4244,17 +5066,17 @@ triplet is invalid, the date will be invalid. - a #GDate + a #GDate - year to set + year to set - Moves a date some number of days into the past. + Moves a date some number of days into the past. To move by weeks, just move by weeks*7 days. The date must be valid. @@ -4263,17 +5085,17 @@ The date must be valid. - a #GDate to decrement + a #GDate to decrement - number of days to move + number of days to move - Moves a date some number of months into the past. + Moves a date some number of months into the past. If the current day of the month doesn't exist in the destination month, the day of the month may change. The date must be valid. @@ -4283,17 +5105,17 @@ may change. The date must be valid. - a #GDate to decrement + a #GDate to decrement - number of months to move + number of months to move - Moves a date some number of years into the past. + Moves a date some number of years into the past. If the current day doesn't exist in the destination year (i.e. it's February 29 and you move to a non-leap-year) then the day is changed to February 29. The date @@ -4304,17 +5126,17 @@ must be valid. - a #GDate to decrement + a #GDate to decrement - number of years to move + number of years to move - Fills in the date-related bits of a struct tm using the @date value. + Fills in the date-related bits of a struct tm using the @date value. Initializes the non-date parts with something sane but meaningless. @@ -4322,52 +5144,52 @@ Initializes the non-date parts with something sane but meaningless. - a #GDate to set the struct tm from + a #GDate to set the struct tm from - struct tm to fill + struct tm to fill - Returns %TRUE if the #GDate represents an existing day. The date must not + Returns %TRUE if the #GDate represents an existing day. The date must not contain garbage; it should have been initialized with g_date_clear() if it wasn't allocated by one of the g_date_new() variants. - Whether the date is valid + Whether the date is valid - a #GDate to check + a #GDate to check - Returns the number of days in a month, taking leap + Returns the number of days in a month, taking leap years into account. - number of days in @month during the @year + number of days in @month during the @year - month + month - year + year - Returns the number of weeks in the year, where weeks + Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -4376,18 +5198,18 @@ Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.) - number of Mondays in the year + number of Mondays in the year - a year + a year - Returns the number of weeks in the year, where weeks + Returns the number of weeks in the year, where weeks are taken to start on Sunday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -4396,18 +5218,18 @@ Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.) - the number of weeks in @year + the number of weeks in @year - year to count weeks in + year to count weeks in - Returns %TRUE if the year is a leap year. + Returns %TRUE if the year is a leap year. For the purposes of this function, leap year is every year divisible by 4 unless that year is divisible by 100. If it @@ -4415,18 +5237,18 @@ is divisible by 100 it would be a leap year only if that year is also divisible by 400. - %TRUE if the year is a leap year + %TRUE if the year is a leap year - year to check + year to check - Generates a printed representation of the date, in a + Generates a printed representation of the date, in a [locale][setlocale]-specific way. Works just like the platform's C library strftime() function, but only accepts date-related formats; time-related formats @@ -4441,123 +5263,123 @@ make the \%F provided by the C99 strftime() work on Windows where the C library only complies to C89. - number of characters written to the buffer, or 0 the buffer was too small + number of characters written to the buffer, or 0 the buffer was too small - destination buffer + destination buffer - buffer size + buffer size - format string + format string - valid #GDate + valid #GDate - Returns %TRUE if the day of the month is valid (a day is valid if it's + Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive). - %TRUE if the day is valid + %TRUE if the day is valid - day to check + day to check - Returns %TRUE if the day-month-year triplet forms a valid, existing day + Returns %TRUE if the day-month-year triplet forms a valid, existing day in the range of days #GDate understands (Year 1 or later, no more than a few thousand years in the future). - %TRUE if the date is a valid one + %TRUE if the date is a valid one - day + day - month + month - year + year - Returns %TRUE if the Julian day is valid. Anything greater than zero + Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit. - %TRUE if the Julian day is valid + %TRUE if the Julian day is valid - Julian day to check + Julian day to check - Returns %TRUE if the month value is valid. The 12 #GDateMonth + Returns %TRUE if the month value is valid. The 12 #GDateMonth enumeration values are the only valid months. - %TRUE if the month is valid + %TRUE if the month is valid - month + month - Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration + Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays. - %TRUE if the weekday is valid + %TRUE if the weekday is valid - weekday + weekday - Returns %TRUE if the year is valid. Any year greater than 0 is valid, + Returns %TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what #GDate will understand. - %TRUE if the year is valid + %TRUE if the year is valid - year + year @@ -4626,7 +5448,7 @@ to mark a number as a day, month, or year. cannot be accessed directly. - Creates a new #GDateTime corresponding to the given date and time in + Creates a new #GDateTime corresponding to the given date and time in the time zone @tz. The @year must be between 1 and 9999, @month between 1 and 12 and @day @@ -4654,44 +5476,44 @@ return %NULL. You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeZone + a #GTimeZone - the year component of the date + the year component of the date - the month component of the date + the month component of the date - the day component of the date + the day component of the date - the hour component of the date + the hour component of the date - the minute component of the date + the minute component of the date - the number of seconds past the minute + the number of seconds past the minute - Creates a #GDateTime corresponding to the given + Creates a #GDateTime corresponding to the given [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601) @text. ISO 8601 strings of the form <date><sep><time><tz> are supported. @@ -4726,25 +5548,25 @@ formatted string. You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - an ISO 8601 formatted time string. + an ISO 8601 formatted time string. - a #GTimeZone to use if the text doesn't contain a + a #GTimeZone to use if the text doesn't contain a timezone, or %NULL. - - Creates a #GDateTime corresponding to the given #GTimeVal @tv in the + + Creates a #GDateTime corresponding to the given #GTimeVal @tv in the local time zone. The time contained in a #GTimeVal is always stored in the form of @@ -4756,20 +5578,22 @@ of the supported range of #GDateTime. You should release the return value by calling g_date_time_unref() when you are done with it. - + #GTimeVal is not year-2038-safe. Use + g_date_time_new_from_unix_local() instead. + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeVal + a #GTimeVal - - Creates a #GDateTime corresponding to the given #GTimeVal @tv in UTC. + + Creates a #GDateTime corresponding to the given #GTimeVal @tv in UTC. The time contained in a #GTimeVal is always stored in the form of seconds elapsed since 1970-01-01 00:00:00 UTC. @@ -4779,20 +5603,22 @@ of the supported range of #GDateTime. You should release the return value by calling g_date_time_unref() when you are done with it. - + #GTimeVal is not year-2038-safe. Use + g_date_time_new_from_unix_utc() instead. + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeVal + a #GTimeVal - Creates a #GDateTime corresponding to the given Unix time @t in the + Creates a #GDateTime corresponding to the given Unix time @t in the local time zone. Unix time is the number of seconds that have elapsed since 1970-01-01 @@ -4805,18 +5631,18 @@ You should release the return value by calling g_date_time_unref() when you are done with it. - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - the Unix time + the Unix time - Creates a #GDateTime corresponding to the given Unix time @t in UTC. + Creates a #GDateTime corresponding to the given Unix time @t in UTC. Unix time is the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC. @@ -4828,56 +5654,56 @@ You should release the return value by calling g_date_time_unref() when you are done with it. - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - the Unix time + the Unix time - Creates a new #GDateTime corresponding to the given date and time in + Creates a new #GDateTime corresponding to the given date and time in the local time zone. This call is equivalent to calling g_date_time_new() with the time zone returned by g_time_zone_new_local(). - + - a #GDateTime, or %NULL + a #GDateTime, or %NULL - the year component of the date + the year component of the date - the month component of the date + the month component of the date - the day component of the date + the day component of the date - the hour component of the date + the hour component of the date - the minute component of the date + the minute component of the date - the number of seconds past the minute + the number of seconds past the minute - Creates a #GDateTime corresponding to this exact instant in the given + Creates a #GDateTime corresponding to this exact instant in the given time zone @tz. The time is as accurate as the system allows, to a maximum accuracy of 1 microsecond. @@ -4889,307 +5715,307 @@ You should release the return value by calling g_date_time_unref() when you are done with it. - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GTimeZone + a #GTimeZone - Creates a #GDateTime corresponding to this exact instant in the local + Creates a #GDateTime corresponding to this exact instant in the local time zone. This is equivalent to calling g_date_time_new_now() with the time zone returned by g_time_zone_new_local(). - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - Creates a #GDateTime corresponding to this exact instant in UTC. + Creates a #GDateTime corresponding to this exact instant in UTC. This is equivalent to calling g_date_time_new_now() with the time zone returned by g_time_zone_new_utc(). - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - Creates a new #GDateTime corresponding to the given date and time in + Creates a new #GDateTime corresponding to the given date and time in UTC. This call is equivalent to calling g_date_time_new() with the time zone returned by g_time_zone_new_utc(). - + - a #GDateTime, or %NULL + a #GDateTime, or %NULL - the year component of the date + the year component of the date - the month component of the date + the month component of the date - the day component of the date + the day component of the date - the hour component of the date + the hour component of the date - the minute component of the date + the minute component of the date - the number of seconds past the minute + the number of seconds past the minute - Creates a copy of @datetime and adds the specified timespan to the copy. - + Creates a copy of @datetime and adds the specified timespan to the copy. + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - a #GTimeSpan + a #GTimeSpan - Creates a copy of @datetime and adds the specified number of days to the + Creates a copy of @datetime and adds the specified number of days to the copy. Add negative values to subtract days. - + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of days + the number of days - Creates a new #GDateTime adding the specified values to the current date and + Creates a new #GDateTime adding the specified values to the current date and time in @datetime. Add negative values to subtract. - + - the newly created #GDateTime that should be freed with + the newly created #GDateTime that should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of years to add + the number of years to add - the number of months to add + the number of months to add - the number of days to add + the number of days to add - the number of hours to add + the number of hours to add - the number of minutes to add + the number of minutes to add - the number of seconds to add + the number of seconds to add - Creates a copy of @datetime and adds the specified number of hours. + Creates a copy of @datetime and adds the specified number of hours. Add negative values to subtract hours. - + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of hours to add + the number of hours to add - Creates a copy of @datetime adding the specified number of minutes. + Creates a copy of @datetime adding the specified number of minutes. Add negative values to subtract minutes. - + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of minutes to add + the number of minutes to add - Creates a copy of @datetime and adds the specified number of months to the + Creates a copy of @datetime and adds the specified number of months to the copy. Add negative values to subtract months. The day of the month of the resulting #GDateTime is clamped to the number of days in the updated calendar month. For example, if adding 1 month to 31st January 2018, the result would be 28th February 2018. In 2020 (a leap year), the result would be 29th February. - + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of months + the number of months - Creates a copy of @datetime and adds the specified number of seconds. + Creates a copy of @datetime and adds the specified number of seconds. Add negative values to subtract seconds. - + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of seconds to add + the number of seconds to add - Creates a copy of @datetime and adds the specified number of weeks to the + Creates a copy of @datetime and adds the specified number of weeks to the copy. Add negative values to subtract weeks. - + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of weeks + the number of weeks - Creates a copy of @datetime and adds the specified number of years to the + Creates a copy of @datetime and adds the specified number of years to the copy. Add negative values to subtract years. As with g_date_time_add_months(), if the resulting date would be 29th February on a non-leap year, the day will be clamped to 28th February. - + - the newly created #GDateTime which should be freed with + the newly created #GDateTime which should be freed with g_date_time_unref(). - a #GDateTime + a #GDateTime - the number of years + the number of years - Calculates the difference in time between @end and @begin. The + Calculates the difference in time between @end and @begin. The #GTimeSpan that is returned is effectively @end - @begin (ie: positive if the first parameter is larger). - + - the difference between the two #GDateTime, as a time + the difference between the two #GDateTime, as a time span expressed in microseconds. - a #GDateTime + a #GDateTime - a #GDateTime + a #GDateTime - Creates a newly allocated string representing the requested @format. + Creates a newly allocated string representing the requested @format. The format strings understood by this function are a subset of the strftime() format language as specified by C99. The \%D, \%U and \%W @@ -5283,9 +6109,9 @@ some languages (Baltic, Slavic, Greek, and more) due to their grammatical rules. For other languages there is no difference. \%OB is a GNU and BSD strftime() extension expected to be added to the future POSIX specification, \%Ob and \%Oh are GNU strftime() extensions. Since: 2.56 - + - a newly allocated string formatted to the requested format + a newly allocated string formatted to the requested format or %NULL in the case that there was an error (such as a format specifier not being supported in the current locale). The string should be freed with g_free(). @@ -5293,184 +6119,202 @@ strftime() extension expected to be added to the future POSIX specification, - A #GDateTime + A #GDateTime - a valid UTF-8 string, containing the format for the + a valid UTF-8 string, containing the format for the #GDateTime + + Format @datetime in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), +including the date, time and time zone, and return that as a UTF-8 encoded +string. + + + a newly allocated string formatted in ISO 8601 format + or %NULL in the case that there was an error. The string + should be freed with g_free(). + + + + + A #GDateTime + + + + - Retrieves the day of the month represented by @datetime in the gregorian + Retrieves the day of the month represented by @datetime in the gregorian calendar. - + - the day of the month + the day of the month - a #GDateTime + a #GDateTime - Retrieves the ISO 8601 day of the week on which @datetime falls (1 is + Retrieves the ISO 8601 day of the week on which @datetime falls (1 is Monday, 2 is Tuesday... 7 is Sunday). - + - the day of the week + the day of the week - a #GDateTime + a #GDateTime - Retrieves the day of the year represented by @datetime in the Gregorian + Retrieves the day of the year represented by @datetime in the Gregorian calendar. - + - the day of the year + the day of the year - a #GDateTime + a #GDateTime - Retrieves the hour of the day represented by @datetime - + Retrieves the hour of the day represented by @datetime + - the hour of the day + the hour of the day - a #GDateTime + a #GDateTime - Retrieves the microsecond of the date represented by @datetime - + Retrieves the microsecond of the date represented by @datetime + - the microsecond of the second + the microsecond of the second - a #GDateTime + a #GDateTime - Retrieves the minute of the hour represented by @datetime - + Retrieves the minute of the hour represented by @datetime + - the minute of the hour + the minute of the hour - a #GDateTime + a #GDateTime - Retrieves the month of the year represented by @datetime in the Gregorian + Retrieves the month of the year represented by @datetime in the Gregorian calendar. - + - the month represented by @datetime + the month represented by @datetime - a #GDateTime + a #GDateTime - Retrieves the second of the minute represented by @datetime - + Retrieves the second of the minute represented by @datetime + - the second represented by @datetime + the second represented by @datetime - a #GDateTime + a #GDateTime - Retrieves the number of seconds since the start of the last minute, + Retrieves the number of seconds since the start of the last minute, including the fractional part. - + - the number of seconds + the number of seconds - a #GDateTime + a #GDateTime - Get the time zone for this @datetime. - + Get the time zone for this @datetime. + - the time zone + the time zone - a #GDateTime + a #GDateTime - Determines the time zone abbreviation to be used at the time and in + Determines the time zone abbreviation to be used at the time and in the time zone of @datetime. For example, in Toronto this is currently "EST" during the winter months and "EDT" during the summer months when daylight savings time is in effect. - + - the time zone abbreviation. The returned + the time zone abbreviation. The returned string is owned by the #GDateTime and it should not be modified or freed - a #GDateTime + a #GDateTime - Determines the offset to UTC in effect at the time and in the time + Determines the offset to UTC in effect at the time and in the time zone of @datetime. The offset is the number of microseconds that you add to UTC time to @@ -5478,21 +6322,21 @@ arrive at local time for the time zone (ie: negative numbers for time zones west of GMT, positive numbers for east). If @datetime represents UTC time, then the offset is always zero. - + - the number of microseconds that should be added to UTC to + the number of microseconds that should be added to UTC to get the local time - a #GDateTime + a #GDateTime - Returns the ISO 8601 week-numbering year in which the week containing + Returns the ISO 8601 week-numbering year in which the week containing @datetime falls. This function, taken together with g_date_time_get_week_of_year() and @@ -5523,20 +6367,20 @@ week (Monday to Sunday). Note that January 1 0001 in the proleptic Gregorian calendar is a Monday, so this function never returns 0. - + - the ISO 8601 week-numbering year for @datetime + the ISO 8601 week-numbering year for @datetime - a #GDateTime + a #GDateTime - Returns the ISO 8601 week number for the week containing @datetime. + Returns the ISO 8601 week number for the week containing @datetime. The ISO 8601 week number is the same for every day of the week (from Moday through Sunday). That can produce some unusual results (described below). @@ -5551,106 +6395,106 @@ year are considered as being contained in the last week of the previous year. Similarly, the final days of a calendar year may be considered as being part of the first ISO 8601 week of the next year if 4 or more days of that week are contained within the new year. - + - the ISO 8601 week number for @datetime. + the ISO 8601 week number for @datetime. - a #GDateTime + a #GDateTime - Retrieves the year represented by @datetime in the Gregorian calendar. - + Retrieves the year represented by @datetime in the Gregorian calendar. + - the year represented by @datetime + the year represented by @datetime - A #GDateTime + A #GDateTime - Retrieves the Gregorian day, month, and year of a given #GDateTime. - + Retrieves the Gregorian day, month, and year of a given #GDateTime. + - a #GDateTime. + a #GDateTime. - the return location for the gregorian year, or %NULL. + the return location for the gregorian year, or %NULL. - the return location for the month of the year, or %NULL. + the return location for the month of the year, or %NULL. - the return location for the day of the month, or %NULL. + the return location for the day of the month, or %NULL. - Determines if daylight savings time is in effect at the time and in + Determines if daylight savings time is in effect at the time and in the time zone of @datetime. - + - %TRUE if daylight savings time is in effect + %TRUE if daylight savings time is in effect - a #GDateTime + a #GDateTime - Atomically increments the reference count of @datetime by one. + Atomically increments the reference count of @datetime by one. - the #GDateTime with the reference count increased + the #GDateTime with the reference count increased - a #GDateTime + a #GDateTime - Creates a new #GDateTime corresponding to the same instant in time as + Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in the local time zone. This call is equivalent to calling g_date_time_to_timezone() with the time zone returned by g_time_zone_new_local(). - + - the newly created #GDateTime + the newly created #GDateTime - a #GDateTime + a #GDateTime - - Stores the instant in time that @datetime represents into @tv. + + Stores the instant in time that @datetime represents into @tv. The time contained in a #GTimeVal is always stored in the form of seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the time @@ -5663,24 +6507,26 @@ systems, this function returns %FALSE to indicate that the time is out of range. On systems where 'long' is 64bit, this function never fails. - + #GTimeVal is not year-2038-safe. Use + g_date_time_to_unix() instead. + - %TRUE if successful, else %FALSE + %TRUE if successful, else %FALSE - a #GDateTime + a #GDateTime - a #GTimeVal to modify + a #GTimeVal to modify - Create a new #GDateTime corresponding to the same instant in time as + Create a new #GDateTime corresponding to the same instant in time as @datetime, but in the time zone @tz. This call can fail in the case that the time goes out of bounds. For @@ -5689,60 +6535,60 @@ Greenwich will fail (due to the year 0 being out of range). You should release the return value by calling g_date_time_unref() when you are done with it. - + - a new #GDateTime, or %NULL + a new #GDateTime, or %NULL - a #GDateTime + a #GDateTime - the new #GTimeZone + the new #GTimeZone - Gives the Unix time corresponding to @datetime, rounding down to the + Gives the Unix time corresponding to @datetime, rounding down to the nearest second. Unix time is the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC, regardless of the time zone associated with @datetime. - + - the Unix time corresponding to @datetime + the Unix time corresponding to @datetime - a #GDateTime + a #GDateTime - Creates a new #GDateTime corresponding to the same instant in time as + Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in UTC. This call is equivalent to calling g_date_time_to_timezone() with the time zone returned by g_time_zone_new_utc(). - + - the newly created #GDateTime + the newly created #GDateTime - a #GDateTime + a #GDateTime - Atomically decrements the reference count of @datetime by one. + Atomically decrements the reference count of @datetime by one. When the reference count reaches zero, the resources allocated by @datetime are freed @@ -5752,62 +6598,62 @@ When the reference count reaches zero, the resources allocated by - a #GDateTime + a #GDateTime - A comparison function for #GDateTimes that is suitable + A comparison function for #GDateTimes that is suitable as a #GCompareFunc. Both #GDateTimes must be non-%NULL. - + - -1, 0 or 1 if @dt1 is less than, equal to or greater + -1, 0 or 1 if @dt1 is less than, equal to or greater than @dt2. - first #GDateTime to compare + first #GDateTime to compare - second #GDateTime to compare + second #GDateTime to compare - Checks to see if @dt1 and @dt2 are equal. + Checks to see if @dt1 and @dt2 are equal. Equal here means that they represent the same moment after converting them to the same time zone. - + - %TRUE if @dt1 and @dt2 are equal + %TRUE if @dt1 and @dt2 are equal - a #GDateTime + a #GDateTime - a #GDateTime + a #GDateTime - Hashes @datetime into a #guint, suitable for use within #GHashTable. - + Hashes @datetime into a #guint, suitable for use within #GHashTable. + - a #guint containing the hash + a #guint containing the hash - a #GDateTime + a #GDateTime @@ -5874,20 +6720,20 @@ should free any memory and resources allocated for it. An opaque structure representing an opened directory. - Closes the directory and deallocates all related resources. + Closes the directory and deallocates all related resources. - a #GDir* created by g_dir_open() + a #GDir* created by g_dir_open() - Retrieves the name of another entry in the directory, or %NULL. + Retrieves the name of another entry in the directory, or %NULL. The order of entries returned from this function is not defined, and may vary by file system or other operating-system dependent factors. @@ -5902,20 +6748,20 @@ On Windows, as is true of all GLib functions which operate on filenames, the returned name is in UTF-8. - The entry's name or %NULL if there are no + The entry's name or %NULL if there are no more entries. The return value is owned by GLib and must not be modified or freed. - a #GDir* created by g_dir_open() + a #GDir* created by g_dir_open() - Resets the given directory. The next call to g_dir_read_name() + Resets the given directory. The next call to g_dir_read_name() will return the first entry again. @@ -5923,13 +6769,13 @@ will return the first entry again. - a #GDir* created by g_dir_open() + a #GDir* created by g_dir_open() - Creates a subdirectory in the preferred directory for temporary + Creates a subdirectory in the preferred directory for temporary files (as returned by g_get_tmp_dir()). @tmpl should be a string in the GLib file name encoding containing @@ -5942,7 +6788,7 @@ Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not modified, and might thus be a read-only literal string. - The actual name used. This string + The actual name used. This string should be freed with g_free() when not needed any longer and is is in the GLib file name encoding. In case of errors, %NULL is returned and @error will be set. @@ -5950,31 +6796,31 @@ modified, and might thus be a read-only literal string. - Template for directory name, + Template for directory name, as in g_mkdtemp(), basename only, or %NULL for a default template - Opens a directory for reading. The names of the files in the + Opens a directory for reading. The names of the files in the directory can then be retrieved using g_dir_read_name(). Note that the ordering is not defined. - a newly allocated #GDir on success, %NULL on failure. + a newly allocated #GDir on success, %NULL on failure. If non-%NULL, you must free the result with g_dir_close() when you are finished with it. - the path to the directory you are interested in. On Unix + the path to the directory you are interested in. On Unix in the on-disk encoding. On Windows in UTF-8 - Currently must be set to 0. Reserved for future use. + Currently must be set to 0. Reserved for future use. @@ -5985,13 +6831,13 @@ that the ordering is not defined. mantissa and exponent of IEEE floats and doubles. These unions are defined as appropriate for a given platform. IEEE floats and doubles are supported (used for storage) by at least Intel, PPC and Sparc. - + the double value - + @@ -6029,10 +6875,19 @@ object. - The base of natural logarithms. - + The base of natural logarithms. + + + + + + + + + + Specifies the type of a function used to test two values for equality. The function should return %TRUE if both values are equal @@ -6070,113 +6925,113 @@ an error that has occurred. - Creates a new #GError with the given @domain and @code, + Creates a new #GError with the given @domain and @code, and a message formatted with @format. - a new #GError + a new #GError - error domain + error domain - error code + error code - printf()-style format for error message + printf()-style format for error message - parameters for message format + parameters for message format - Creates a new #GError; unlike g_error_new(), @message is + Creates a new #GError; unlike g_error_new(), @message is not a printf()-style format string. Use this function if @message contains text you don't have control over, that could include printf() escape sequences. - a new #GError + a new #GError - error domain + error domain - error code + error code - error message + error message - Creates a new #GError with the given @domain and @code, + Creates a new #GError with the given @domain and @code, and a message formatted with @format. - a new #GError + a new #GError - error domain + error domain - error code + error code - printf()-style format for error message + printf()-style format for error message - #va_list of parameters for the message format + #va_list of parameters for the message format - Makes a copy of @error. + Makes a copy of @error. - a new #GError + a new #GError - a #GError + a #GError - Frees a #GError and associated resources. + Frees a #GError and associated resources. - a #GError + a #GError - Returns %TRUE if @error matches @domain and @code, %FALSE + Returns %TRUE if @error matches @domain and @code, %FALSE otherwise. In particular, when @error is %NULL, %FALSE will be returned. @@ -6188,20 +7043,20 @@ extended in the future to provide a more specific error code for a certain case, your code will still work. - whether @error has @domain and @code + whether @error has @domain and @code - a #GError + a #GError - an error domain + an error domain - an error code + an error code @@ -6395,13 +7250,13 @@ differences in when a system will report a given error, etc. mantissa and exponent of IEEE floats and doubles. These unions are defined as appropriate for a given platform. IEEE floats and doubles are supported (used for storage) by at least Intel, PPC and Sparc. - + the double value - + @@ -6435,16 +7290,16 @@ as appropriate for a given platform. IEEE floats and doubles are supported - Declares a type of function which takes an arbitrary + Declares a type of function which takes an arbitrary data pointer argument and has no return value. It is not currently used in GLib or GTK+. - + - a data pointer + a data pointer @@ -6468,7 +7323,7 @@ g_slist_foreach(). - This is the platform dependent conversion specifier for scanning and + This is the platform dependent conversion specifier for scanning and printing values of type #gint16. It is a string literal, but doesn't include the percent-sign, such that you can add precision and length modifiers between percent-sign and conversion specifier. @@ -6484,7 +7339,7 @@ g_print ("%" G_GINT32_FORMAT, out); - The platform dependent length modifier for conversion specifiers + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gint16 or #guint16. It is a string literal, but doesn't include the percent-sign, such that you can add precision and length modifiers between percent-sign @@ -6499,20 +7354,30 @@ g_print ("%#" G_GINT16_MODIFIER "x", value); - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #gint32. See also #G_GINT16_FORMAT. - The platform dependent length modifier for conversion specifiers + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gint32 or #guint32. It is a string literal. See also #G_GINT16_MODIFIER. + + This macro is used to insert 64-bit integer literals +into the source code. + + + + a literal integer value, e.g. 0x1d636b02300a7aa7 + + + - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #gint64. See also #G_GINT16_FORMAT. Some platforms do not support scanning and printing 64-bit integers, @@ -6525,7 +7390,7 @@ instead. - The platform dependent length modifier for conversion specifiers + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gint64 or #guint64. It is a string literal. @@ -6536,72 +7401,291 @@ is not defined. - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #gintptr. - The platform dependent length modifier for conversion specifiers + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gintptr or #guintptr. It is a string literal. + + Expands to the GNU C `alloc_size` function attribute if the compiler +is a new enough gcc. This attribute tells the compiler that the +function returns a pointer to memory of a size that is specified +by the @xth function parameter. + +Place the attribute after the function declaration, just before the +semicolon. + +|[<!-- language="C" --> +gpointer g_malloc (gsize n_bytes) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1); +]| + +See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-alloc_005fsize-function-attribute) for more details. + + + + the index of the argument specifying the allocation size + + + + + Expands to the GNU C `alloc_size` function attribute if the compiler is a +new enough gcc. This attribute tells the compiler that the function returns +a pointer to memory of a size that is specified by the product of two +function parameters. + +Place the attribute after the function declaration, just before the +semicolon. + +|[<!-- language="C" --> +gpointer g_malloc_n (gsize n_blocks, + gsize n_block_bytes) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE2(1, 2); +]| + +See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-alloc_005fsize-function-attribute) for more details. + + + + the index of the argument specifying one factor of the allocation size + + + the index of the argument specifying the second factor of the allocation size + + + + + Expands to a a check for a compiler with __GNUC__ defined and a version +greater than or equal to the major and minor numbers provided. For example, +the following would only match on compilers such as GCC 4.8 or newer. + +|[<!-- language="C" --> +#if G_GNUC_CHECK_VERSION(4, 8) +#endif +]| + + + + major version to check against + + + minor version to check against + + + + + Like %G_GNUC_DEPRECATED, but names the intended replacement for the +deprecated symbol if the version of gcc in use is new enough to support +custom deprecation messages. + +Place the attribute after the declaration, just before the semicolon. + +|[<!-- language="C" --> +int my_mistake (void) G_GNUC_DEPRECATED_FOR(my_replacement); +]| + +See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-deprecated-function-attribute) for more details. + +Note that if @f is a macro, it will be expanded in the warning message. +You can enclose it in quotes to prevent this. (The quotes will show up +in the warning, but it's better than showing the macro expansion.) + + + + the intended replacement for the deprecated symbol, + such as the name of a function + + + + + Expands to the GNU C `format_arg` function attribute if the compiler +is gcc. This function attribute specifies that a function takes a +format string for a `printf()`, `scanf()`, `strftime()` or `strfmon()` style +function and modifies it, so that the result can be passed to a `printf()`, +`scanf()`, `strftime()` or `strfmon()` style function (with the remaining +arguments to the format function the same as they would have been +for the unmodified string). + +Place the attribute after the function declaration, just before the +semicolon. + +See the [GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-nonliteral-1) for more details. + +|[<!-- language="C" --> +gchar *g_dgettext (gchar *domain_name, gchar *msgid) G_GNUC_FORMAT (2); +]| + + + + the index of the argument + + + - Expands to "" on all modern compilers, and to __FUNCTION__ on gcc + Expands to "" on all modern compilers, and to __FUNCTION__ on gcc version 2.x. Don't use it. Use G_STRFUNC() instead - + - Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__ + Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__ on gcc version 2.x. Don't use it. Use G_STRFUNC() instead - + + + Expands to the GNU C `format` function attribute if the compiler is gcc. +This is used for declaring functions which take a variable number of +arguments, with the same syntax as `printf()`. It allows the compiler +to type-check the arguments passed to the function. + +Place the attribute after the function declaration, just before the +semicolon. + +See the +[GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288) +for more details. + +|[<!-- language="C" --> +gint g_snprintf (gchar *string, + gulong n, + gchar const *format, + ...) G_GNUC_PRINTF (3, 4); +]| + + + + the index of the argument corresponding to the + format string (the arguments are numbered from 1) + + + the index of the first of the format arguments, or 0 if + there are no format arguments + + + + + Expands to the GNU C `format` function attribute if the compiler is gcc. +This is used for declaring functions which take a variable number of +arguments, with the same syntax as `scanf()`. It allows the compiler +to type-check the arguments passed to the function. + +|[<!-- language="C" --> +int my_scanf (MyStream *stream, + const char *format, + ...) G_GNUC_SCANF (2, 3); +int my_vscanf (MyStream *stream, + const char *format, + va_list ap) G_GNUC_SCANF (2, 0); +]| + +See the +[GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288) +for details. + + + + the index of the argument corresponding to + the format string (the arguments are numbered from 1) + + + the index of the first of the format arguments, or 0 if + there are no format arguments + + + + + Expands to the GNU C `strftime` format function attribute if the compiler +is gcc. This is used for declaring functions which take a format argument +which is passed to `strftime()` or an API implementing its formats. It allows +the compiler check the format passed to the function. + +|[<!-- language="C" --> +gsize my_strftime (MyBuffer *buffer, + const char *format, + const struct tm *tm) G_GNUC_STRFTIME (2); +]| + +See the +[GNU C documentation](https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-Wformat-3288) +for details. + + + + the index of the argument corresponding to + the format string (the arguments are numbered from 1) + + + + + This macro is used to insert #goffset 64-bit integer literals +into the source code. + +See also #G_GINT64_CONSTANT. + + + + a literal integer value, e.g. 0x1d636b02300a7aa7 + + + - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #gsize. See also #G_GINT16_FORMAT. - The platform dependent length modifier for conversion specifiers + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gsize. It is a string literal. - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #gssize. See also #G_GINT16_FORMAT. - The platform dependent length modifier for conversion specifiers + The platform dependent length modifier for conversion specifiers for scanning and printing values of type #gssize. It is a string literal. - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #guint16. See also #G_GINT16_FORMAT - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #guint32. See also #G_GINT16_FORMAT. + + This macro is used to insert 64-bit unsigned integer +literals into the source code. + + + + a literal integer value, e.g. 0x1d636b02300a7aa7U + + + - This is the platform dependent conversion specifier for scanning + This is the platform dependent conversion specifier for scanning and printing values of type #guint64. See also #G_GINT16_FORMAT. Some platforms do not support scanning and printing 64-bit integers, @@ -6614,7 +7698,7 @@ instead. - This is the platform dependent conversion specifier + This is the platform dependent conversion specifier for scanning and printing values of type #guintptr. @@ -6624,20 +7708,20 @@ for scanning and printing values of type #guintptr. - + - Defined to 1 if gcc-style visibility handling is supported. - + Defined to 1 if gcc-style visibility handling is supported. + - + - + @@ -6663,14 +7747,70 @@ parameter which is passed to g_hash_table_foreach(). + + Casts a pointer to a `GHook*`. + + + + a pointer + + + + + Returns %TRUE if the #GHook is active, which is normally the case +until the #GHook is destroyed. + + + + a #GHook + + + + + Gets the flags of a hook. + + + + a #GHook + + + - The position of the first bit which is not reserved for internal + The position of the first bit which is not reserved for internal use be the #GHook implementation, i.e. `1 << G_HOOK_FLAG_USER_SHIFT` is the first bit which can be used for application-defined flags. + + Returns %TRUE if the #GHook function is currently executing. + + + + a #GHook + + + + + Returns %TRUE if the #GHook is not in a #GHookList. + + + + a #GHook + + + + + Returns %TRUE if the #GHook is valid, i.e. it is in a #GHookList, +it is active and it has not been destroyed. + + + + a #GHook + + + Specifies the type of the function passed to g_hash_table_foreach_remove(). It is called with each key/value @@ -6747,7 +7887,7 @@ must be an element of randomness that an attacker is unable to guess. following functions. - This is a convenience function for using a #GHashTable as a set. It + This is a convenience function for using a #GHashTable as a set. It is equivalent to calling g_hash_table_replace() with @key as both the key and the value. @@ -6760,46 +7900,46 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - a key to insert + a key to insert - Checks if @key is in @hash_table. + Checks if @key is in @hash_table. - %TRUE if @key is in @hash_table, %FALSE otherwise. + %TRUE if @key is in @hash_table, %FALSE otherwise. - a #GHashTable + a #GHashTable - a key to check + a key to check - Destroys all keys and values in the #GHashTable and decrements its + Destroys all keys and values in the #GHashTable and decrements its reference count by 1. If keys and/or values are dynamically allocated, you should either free them first or create the #GHashTable with destroy notifiers using g_hash_table_new_full(). In the latter case the destroy @@ -6811,7 +7951,7 @@ destruction phase. - a #GHashTable + a #GHashTable @@ -6820,7 +7960,7 @@ destruction phase. - Calls the given function for key/value pairs in the #GHashTable + Calls the given function for key/value pairs in the #GHashTable until @predicate returns %TRUE. The function is passed the key and value of each pair, and the given @user_data parameter. The hash table may not be modified while iterating over it (you can't @@ -6835,31 +7975,31 @@ to use additional or different data structures for reverse lookups values in a hash table ends up needing O(n*n) operations). - The value of the first key/value pair is returned, + The value of the first key/value pair is returned, for which @predicate evaluates to %TRUE. If no pair with the requested property is found, %NULL is returned. - a #GHashTable + a #GHashTable - function to test the key/value pairs for a certain property + function to test the key/value pairs for a certain property - user data to pass to the function + user data to pass to the function - Calls the given function for each of the key/value pairs in the + Calls the given function for each of the key/value pairs in the #GHashTable. The function is passed the key and value of each pair, and the given @user_data parameter. The hash table may not be modified while iterating over it (you can't add/remove @@ -6874,24 +8014,24 @@ order searches in contrast to g_hash_table_lookup(). - a #GHashTable + a #GHashTable - the function to call for each key/value pair + the function to call for each key/value pair - user data to pass to the function + user data to pass to the function - Calls the given function for each key/value pair in the + Calls the given function for each key/value pair in the #GHashTable. If the function returns %TRUE, then the key/value pair is removed from the #GHashTable. If you supplied key or value destroy functions when creating the #GHashTable, they are @@ -6901,29 +8041,29 @@ See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table. - the number of key/value pairs removed + the number of key/value pairs removed - a #GHashTable + a #GHashTable - the function to call for each key/value pair + the function to call for each key/value pair - user data to pass to the function + user data to pass to the function - Calls the given function for each key/value pair in the + Calls the given function for each key/value pair in the #GHashTable. If the function returns %TRUE, then the key/value pair is removed from the #GHashTable, but no key or value destroy functions are called. @@ -6932,29 +8072,29 @@ See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table. - the number of key/value pairs removed. + the number of key/value pairs removed. - a #GHashTable + a #GHashTable - the function to call for each key/value pair + the function to call for each key/value pair - user data to pass to the function + user data to pass to the function - Retrieves every key inside @hash_table. The returned data is valid + Retrieves every key inside @hash_table. The returned data is valid until changes to the hash release those keys. This iterates over every entry in the hash table to build its return value. @@ -6962,7 +8102,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a #GHashTableIter. - a #GList containing all the keys + a #GList containing all the keys inside the hash table. The content of the list is owned by the hash table and should not be modified or freed. Use g_list_free() when done using the list. @@ -6972,7 +8112,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a - a #GHashTable + a #GHashTable @@ -6981,7 +8121,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a - Retrieves every key inside @hash_table, as an array. + Retrieves every key inside @hash_table, as an array. The returned array is %NULL-terminated but may contain %NULL as a key. Use @length to determine the true length if it's possible that @@ -7000,7 +8140,7 @@ appropriate to use g_strfreev() if you call g_hash_table_steal_all() first to transfer ownership of the keys. - a + a %NULL-terminated array containing each key from the table. @@ -7008,20 +8148,20 @@ first to transfer ownership of the keys. - a #GHashTable + a #GHashTable - the length of the returned array + the length of the returned array - Retrieves every value inside @hash_table. The returned data + Retrieves every value inside @hash_table. The returned data is valid until @hash_table is modified. This iterates over every entry in the hash table to build its return value. @@ -7029,7 +8169,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a #GHashTableIter. - a #GList containing all the values + a #GList containing all the values inside the hash table. The content of the list is owned by the hash table and should not be modified or freed. Use g_list_free() when done using the list. @@ -7039,7 +8179,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a - a #GHashTable + a #GHashTable @@ -7048,7 +8188,7 @@ To iterate over the entries in a #GHashTable more efficiently, use a - Inserts a new key and value into a #GHashTable. + Inserts a new key and value into a #GHashTable. If the key already exists in the #GHashTable its current value is replaced with the new value. If you supplied a @@ -7062,53 +8202,53 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - a key to insert + a key to insert - the value to associate with the key + the value to associate with the key - Looks up a key in a #GHashTable. Note that this function cannot + Looks up a key in a #GHashTable. Note that this function cannot distinguish between a key that is not present and one which is present and has the value %NULL. If you need this distinction, use g_hash_table_lookup_extended(). - the associated value, or %NULL if the key is not found + the associated value, or %NULL if the key is not found - a #GHashTable + a #GHashTable - the key to look up + the key to look up - Looks up a key in the #GHashTable, returning the original key and the + Looks up a key in the #GHashTable, returning the original key and the associated value and a #gboolean which is %TRUE if the key was found. This is useful if you need to free the memory allocated for the original key, for example before calling g_hash_table_remove(). @@ -7118,34 +8258,34 @@ whether the %NULL key exists, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - the key to look up + the key to look up - return location for the original key + return location for the original key - return location for the value associated + return location for the value associated with the key - Creates a new #GHashTable with a reference count of 1. + Creates a new #GHashTable with a reference count of 1. Hash values returned by @hash_func are used to determine where keys are stored within the #GHashTable data structure. The g_direct_hash(), @@ -7163,7 +8303,7 @@ as its first parameter, and the user-provided key to check against as its second. - a new #GHashTable + a new #GHashTable @@ -7171,17 +8311,17 @@ its second. - a function to create a hash value from a key + a function to create a hash value from a key - a function to check two keys for equality + a function to check two keys for equality - Creates a new #GHashTable like g_hash_table_new() with a reference + Creates a new #GHashTable like g_hash_table_new() with a reference count of 1 and allows to specify functions to free the memory allocated for the key and value that get called when removing the entry from the #GHashTable. @@ -7194,7 +8334,7 @@ calling g_hash_table_remove_all() before releasing the last reference using g_hash_table_unref(). - a new #GHashTable + a new #GHashTable @@ -7202,21 +8342,21 @@ g_hash_table_unref(). - a function to create a hash value from a key + a function to create a hash value from a key - a function to check two keys for equality + a function to check two keys for equality - a function to free the memory allocated for the key + a function to free the memory allocated for the key used when removing the entry from the #GHashTable, or %NULL if you don't want to supply such a function. - a function to free the memory allocated for the + a function to free the memory allocated for the value used when removing the entry from the #GHashTable, or %NULL if you don't want to supply such a function. @@ -7224,11 +8364,11 @@ g_hash_table_unref(). - Atomically increments the reference count of @hash_table by one. + Atomically increments the reference count of @hash_table by one. This function is MT-safe and may be called from any thread. - the passed in #GHashTable + the passed in #GHashTable @@ -7236,7 +8376,7 @@ This function is MT-safe and may be called from any thread. - a valid #GHashTable + a valid #GHashTable @@ -7245,7 +8385,7 @@ This function is MT-safe and may be called from any thread. - Removes a key and its associated value from a #GHashTable. + Removes a key and its associated value from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise @@ -7253,25 +8393,25 @@ you have to make sure that any dynamically allocated values are freed yourself. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - the key to remove + the key to remove - Removes all keys and their associated values from a #GHashTable. + Removes all keys and their associated values from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the keys and values are freed using the supplied destroy functions, @@ -7283,7 +8423,7 @@ values are freed yourself. - a #GHashTable + a #GHashTable @@ -7292,7 +8432,7 @@ values are freed yourself. - Inserts a new key and value into a #GHashTable similar to + Inserts a new key and value into a #GHashTable similar to g_hash_table_insert(). The difference is that if the key already exists in the #GHashTable, it gets replaced by the new key. If you supplied a @value_destroy_func when creating @@ -7305,37 +8445,37 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - a key to insert + a key to insert - the value to associate with the key + the value to associate with the key - Returns the number of elements contained in the #GHashTable. + Returns the number of elements contained in the #GHashTable. - the number of key/value pairs in the #GHashTable. + the number of key/value pairs in the #GHashTable. - a #GHashTable + a #GHashTable @@ -7344,29 +8484,29 @@ or not. - Removes a key and its associated value from a #GHashTable without + Removes a key and its associated value from a #GHashTable without calling the key and value destroy functions. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - the key to remove + the key to remove - Removes all keys and their associated values from a #GHashTable + Removes all keys and their associated values from a #GHashTable without calling the key and value destroy functions. @@ -7374,7 +8514,7 @@ without calling the key and value destroy functions. - a #GHashTable + a #GHashTable @@ -7383,7 +8523,7 @@ without calling the key and value destroy functions. - Looks up a key in the #GHashTable, stealing the original key and the + Looks up a key in the #GHashTable, stealing the original key and the associated value and returning %TRUE if the key was found. If the key was not found, %FALSE is returned. @@ -7395,35 +8535,35 @@ You can pass %NULL for @lookup_key, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - the key to look up + the key to look up - return location for the + return location for the original key - return location + return location for the value associated with the key - Atomically decrements the reference count of @hash_table by one. + Atomically decrements the reference count of @hash_table by one. If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread. @@ -7433,7 +8573,7 @@ This function is MT-safe and may be called from any thread. - a valid #GHashTable + a valid #GHashTable @@ -7467,10 +8607,10 @@ with g_hash_table_iter_init(). - Returns the #GHashTable associated with @iter. + Returns the #GHashTable associated with @iter. - the #GHashTable associated with @iter. + the #GHashTable associated with @iter. @@ -7478,13 +8618,13 @@ with g_hash_table_iter_init(). - an initialized #GHashTableIter + an initialized #GHashTableIter - Initializes a key/value pair iterator and associates it with + Initializes a key/value pair iterator and associates it with @hash_table. Modifying the hash table after calling this function invalidates the returned iterator. |[<!-- language="C" --> @@ -7503,11 +8643,11 @@ while (g_hash_table_iter_next (&iter, &key, &value)) - an uninitialized #GHashTableIter + an uninitialized #GHashTableIter - a #GHashTable + a #GHashTable @@ -7516,31 +8656,31 @@ while (g_hash_table_iter_next (&iter, &key, &value)) - Advances @iter and retrieves the key and/or value that are now + Advances @iter and retrieves the key and/or value that are now pointed to as a result of this advancement. If %FALSE is returned, @key and @value are not set, and the iterator becomes invalid. - %FALSE if the end of the #GHashTable has been reached. + %FALSE if the end of the #GHashTable has been reached. - an initialized #GHashTableIter + an initialized #GHashTableIter - a location to store the key + a location to store the key - a location to store the value + a location to store the value - Removes the key/value pair currently pointed to by the iterator + Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned %TRUE, and cannot be called more than once for the same key/value pair. @@ -7564,13 +8704,13 @@ while (g_hash_table_iter_next (&iter, &key, &value)) - an initialized #GHashTableIter + an initialized #GHashTableIter - Replaces the value currently pointed to by the iterator + Replaces the value currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned %TRUE. @@ -7582,17 +8722,17 @@ If you supplied a @value_destroy_func when creating the - an initialized #GHashTableIter + an initialized #GHashTableIter - the value to replace with + the value to replace with - Removes the key/value pair currently pointed to by the + Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable, without calling the key and value destroy functions. Can only be called after g_hash_table_iter_next() returned %TRUE, and cannot @@ -7603,7 +8743,7 @@ be called more than once for the same key/value pair. - an initialized #GHashTableIter + an initialized #GHashTableIter @@ -7615,24 +8755,24 @@ To create a new GHmac, use g_hmac_new(). To free a GHmac, use g_hmac_unref(). - Copies a #GHmac. If @hmac has been closed, by calling + Copies a #GHmac. If @hmac has been closed, by calling g_hmac_get_string() or g_hmac_get_digest(), the copied HMAC will be closed as well. - the copy of the passed #GHmac. Use g_hmac_unref() + the copy of the passed #GHmac. Use g_hmac_unref() when finished using it. - the #GHmac to copy + the #GHmac to copy - Gets the digest from @checksum as a raw binary array and places it + Gets the digest from @checksum as a raw binary array and places it into @buffer. The size of the digest depends on the type of checksum. Once this function has been called, the #GHmac is closed and can @@ -7643,24 +8783,24 @@ no longer be updated with g_checksum_update(). - a #GHmac + a #GHmac - output buffer + output buffer - an inout parameter. The caller initializes it to the + an inout parameter. The caller initializes it to the size of @buffer. After the call it contains the length of the digest - Gets the HMAC as an hexadecimal string. + Gets the HMAC as an hexadecimal string. Once this function has been called the #GHmac can no longer be updated with g_hmac_update(). @@ -7668,36 +8808,36 @@ updated with g_hmac_update(). The hexadecimal characters will be lower case. - the hexadecimal representation of the HMAC. The + the hexadecimal representation of the HMAC. The returned string is owned by the HMAC and should not be modified or freed. - a #GHmac + a #GHmac - Atomically increments the reference count of @hmac by one. + Atomically increments the reference count of @hmac by one. This function is MT-safe and may be called from any thread. - the passed in #GHmac. + the passed in #GHmac. - a valid #GHmac + a valid #GHmac - Atomically decrements the reference count of @hmac by one. + Atomically decrements the reference count of @hmac by one. If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. @@ -7709,13 +8849,13 @@ Frees the memory allocated for @hmac. - a #GHmac + a #GHmac - Feeds @data into an existing #GHmac. + Feeds @data into an existing #GHmac. The HMAC must still be open, that is g_hmac_get_string() or g_hmac_get_digest() must not have been called on @hmac. @@ -7725,23 +8865,23 @@ g_hmac_get_digest() must not have been called on @hmac. - a #GHmac + a #GHmac - buffer used to compute the checksum + buffer used to compute the checksum - size of the buffer, or -1 if it is a nul-terminated string + size of the buffer, or -1 if it is a nul-terminated string - Creates a new #GHmac, using the digest algorithm @digest_type. + Creates a new #GHmac, using the digest algorithm @digest_type. If the @digest_type is not known, %NULL is returned. A #GHmac can be used to compute the HMAC of a key and an arbitrary binary blob, using different hashing algorithms. @@ -7759,23 +8899,23 @@ Support for digests of type %G_CHECKSUM_SHA512 has been added in GLib 2.42. Support for %G_CHECKSUM_SHA384 was added in GLib 2.52. - the newly created #GHmac, or %NULL. + the newly created #GHmac, or %NULL. Use g_hmac_unref() to free the memory allocated by it. - the desired type of digest + the desired type of digest - the key for the HMAC + the key for the HMAC - the length of the keys + the length of the keys @@ -7820,58 +8960,58 @@ Support for %G_CHECKSUM_SHA384 was added in GLib 2.52. - Compares the ids of two #GHook elements, returning a negative value + Compares the ids of two #GHook elements, returning a negative value if the second id is greater than the first. - a value <= 0 if the id of @sibling is >= the id of @new_hook + a value <= 0 if the id of @sibling is >= the id of @new_hook - a #GHook + a #GHook - a #GHook to compare with @new_hook + a #GHook to compare with @new_hook - Allocates space for a #GHook and initializes it. + Allocates space for a #GHook and initializes it. - a new #GHook + a new #GHook - a #GHookList + a #GHookList - Destroys a #GHook, given its ID. + Destroys a #GHook, given its ID. - %TRUE if the #GHook was found in the #GHookList and destroyed + %TRUE if the #GHook was found in the #GHookList and destroyed - a #GHookList + a #GHookList - a hook ID + a hook ID - Removes one #GHook from a #GHookList, marking it + Removes one #GHook from a #GHookList, marking it inactive and calling g_hook_unref() on it. @@ -7879,137 +9019,137 @@ inactive and calling g_hook_unref() on it. - a #GHookList + a #GHookList - the #GHook to remove + the #GHook to remove - Finds a #GHook in a #GHookList using the given function to + Finds a #GHook in a #GHookList using the given function to test for a match. - the found #GHook or %NULL if no matching #GHook is found + the found #GHook or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - the function to call for each #GHook, which should return + the function to call for each #GHook, which should return %TRUE when the #GHook has been found - the data to pass to @func + the data to pass to @func - Finds a #GHook in a #GHookList with the given data. + Finds a #GHook in a #GHookList with the given data. - the #GHook with the given @data or %NULL if no matching + the #GHook with the given @data or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - the data to find + the data to find - Finds a #GHook in a #GHookList with the given function. + Finds a #GHook in a #GHookList with the given function. - the #GHook with the given @func or %NULL if no matching + the #GHook with the given @func or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - the function to find + the function to find - Finds a #GHook in a #GHookList with the given function and data. + Finds a #GHook in a #GHookList with the given function and data. - the #GHook with the given @func and @data or %NULL if + the #GHook with the given @func and @data or %NULL if no matching #GHook is found - a #GHookList + a #GHookList - %TRUE if #GHook elements which have been destroyed + %TRUE if #GHook elements which have been destroyed should be skipped - the function to find + the function to find - the data to find + the data to find - Returns the first #GHook in a #GHookList which has not been destroyed. + Returns the first #GHook in a #GHookList which has not been destroyed. The reference count for the #GHook is incremented, so you must call g_hook_unref() to restore it when no longer needed. (Or call g_hook_next_valid() if you are stepping through the #GHookList.) - the first valid #GHook, or %NULL if none are valid + the first valid #GHook, or %NULL if none are valid - a #GHookList + a #GHookList - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped @@ -8017,7 +9157,7 @@ g_hook_next_valid() if you are stepping through the #GHookList.) - Calls the #GHookList @finalize_hook function if it exists, + Calls the #GHookList @finalize_hook function if it exists, and frees the memory allocated for the #GHook. @@ -8025,96 +9165,96 @@ and frees the memory allocated for the #GHook. - a #GHookList + a #GHookList - the #GHook to free + the #GHook to free - Returns the #GHook with the given id, or %NULL if it is not found. + Returns the #GHook with the given id, or %NULL if it is not found. - the #GHook with the given id, or %NULL if it is not found + the #GHook with the given id, or %NULL if it is not found - a #GHookList + a #GHookList - a hook id + a hook id - Inserts a #GHook into a #GHookList, before a given #GHook. + Inserts a #GHook into a #GHookList, before a given #GHook. - a #GHookList + a #GHookList - the #GHook to insert the new #GHook before + the #GHook to insert the new #GHook before - the #GHook to insert + the #GHook to insert - Inserts a #GHook into a #GHookList, sorted by the given function. + Inserts a #GHook into a #GHookList, sorted by the given function. - a #GHookList + a #GHookList - the #GHook to insert + the #GHook to insert - the comparison function used to sort the #GHook elements + the comparison function used to sort the #GHook elements - Returns the next #GHook in a #GHookList which has not been destroyed. + Returns the next #GHook in a #GHookList which has not been destroyed. The reference count for the #GHook is incremented, so you must call g_hook_unref() to restore it when no longer needed. (Or continue to call g_hook_next_valid() until %NULL is returned.) - the next valid #GHook, or %NULL if none are valid + the next valid #GHook, or %NULL if none are valid - a #GHookList + a #GHookList - the current #GHook + the current #GHook - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped @@ -8122,42 +9262,42 @@ g_hook_next_valid() until %NULL is returned.) - Prepends a #GHook on the start of a #GHookList. + Prepends a #GHook on the start of a #GHookList. - a #GHookList + a #GHookList - the #GHook to add to the start of @hook_list + the #GHook to add to the start of @hook_list - Increments the reference count for a #GHook. + Increments the reference count for a #GHook. - the @hook that was passed in (since 2.6) + the @hook that was passed in (since 2.6) - a #GHookList + a #GHookList - the #GHook to increment the reference count of + the #GHook to increment the reference count of - Decrements the reference count of a #GHook. + Decrements the reference count of a #GHook. If the reference count falls to 0, the #GHook is removed from the #GHookList and g_hook_free() is called to free it. @@ -8166,11 +9306,11 @@ from the #GHookList and g_hook_free() is called to free it. - a #GHookList + a #GHookList - the #GHook to unref + the #GHook to unref @@ -8327,20 +9467,20 @@ by g_hook_list_invoke(). - Removes all the #GHook elements from a #GHookList. + Removes all the #GHook elements from a #GHookList. - a #GHookList + a #GHookList - Initializes a #GHookList. + Initializes a #GHookList. This must be called before the #GHookList is used. @@ -8348,29 +9488,29 @@ This must be called before the #GHookList is used. - a #GHookList + a #GHookList - the size of each element in the #GHookList, + the size of each element in the #GHookList, typically `sizeof (GHook)`. - Calls all of the #GHook functions in a #GHookList. + Calls all of the #GHook functions in a #GHookList. - a #GHookList + a #GHookList - %TRUE if functions which are already running + %TRUE if functions which are already running (e.g. in another thread) can be called. If set to %FALSE, these are skipped @@ -8378,7 +9518,7 @@ This must be called before the #GHookList is used. - Calls all of the #GHook functions in a #GHookList. + Calls all of the #GHook functions in a #GHookList. Any function which returns %FALSE is removed from the #GHookList. @@ -8386,11 +9526,11 @@ Any function which returns %FALSE is removed from the #GHookList. - a #GHookList + a #GHookList - %TRUE if functions which are already running + %TRUE if functions which are already running (e.g. in another thread) can be called. If set to %FALSE, these are skipped @@ -8398,34 +9538,34 @@ Any function which returns %FALSE is removed from the #GHookList. - Calls a function on each valid #GHook. + Calls a function on each valid #GHook. - a #GHookList + a #GHookList - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped - the function to call for each #GHook + the function to call for each #GHook - data to pass to @marshaller + data to pass to @marshaller - Calls a function on each valid #GHook and destroys it if the + Calls a function on each valid #GHook and destroys it if the function returns %FALSE. @@ -8433,21 +9573,21 @@ function returns %FALSE. - a #GHookList + a #GHookList - %TRUE if hooks which are currently running + %TRUE if hooks which are currently running (e.g. in another thread) are considered valid. If set to %FALSE, these are skipped - the function to call for each #GHook + the function to call for each #GHook - data to pass to @marshaller + data to pass to @marshaller @@ -8475,7 +9615,7 @@ function returns %FALSE. private data and should only be accessed using the following functions. - Same as the standard UNIX routine iconv(), but + Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -8490,34 +9630,34 @@ used), or it may return -1 and set an error such as %EILSEQ, in such a situation. - count of non-reversible conversions, or -1 on error + count of non-reversible conversions, or -1 on error - conversion descriptor from g_iconv_open() + conversion descriptor from g_iconv_open() - bytes to convert + bytes to convert - inout parameter, bytes remaining to convert in @inbuf + inout parameter, bytes remaining to convert in @inbuf - converted output bytes + converted output bytes - inout parameter, bytes available to fill in @outbuf + inout parameter, bytes available to fill in @outbuf - Same as the standard UNIX routine iconv_close(), but + Same as the standard UNIX routine iconv_close(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. Should be called to clean up the conversion descriptor from g_iconv_open() when @@ -8527,18 +9667,18 @@ GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers. - -1 on error, 0 on success + -1 on error, 0 on success - a conversion descriptor from g_iconv_open() + a conversion descriptor from g_iconv_open() - Same as the standard UNIX routine iconv_open(), but + Same as the standard UNIX routine iconv_open(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -8546,30 +9686,30 @@ GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers. - a "conversion descriptor", or (GIConv)-1 if + a "conversion descriptor", or (GIConv)-1 if opening the converter failed. - destination codeset + destination codeset - source codeset + source codeset - The bias by which exponents in double-precision floats are offset. - + The bias by which exponents in double-precision floats are offset. + - The bias by which exponents in single-precision floats are offset. - + The bias by which exponents in single-precision floats are offset. + @@ -8640,30 +9780,30 @@ functions. - Open a file @filename as a #GIOChannel using mode @mode. This + Open a file @filename as a #GIOChannel using mode @mode. This channel will be closed when the last reference to it is dropped, so there is no need to call g_io_channel_close() (though doing so will not cause problems, as long as no attempt is made to access the channel after it is closed). - A #GIOChannel on success, %NULL on failure. + A #GIOChannel on success, %NULL on failure. - A string containing the name of a file + A string containing the name of a file - One of "r", "w", "a", "r+", "w+", "a+". These have + One of "r", "w", "a", "r+", "w+", "a+". These have the same meaning as in fopen() - Creates a new #GIOChannel given a file descriptor. On UNIX systems + Creates a new #GIOChannel given a file descriptor. On UNIX systems this works for plain files, pipes, and sockets. The returned #GIOChannel has a reference count of 1. @@ -8687,18 +9827,18 @@ valid file descriptor and socket. If that happens a warning is issued, and GLib assumes that it is the file descriptor you mean. - a new #GIOChannel. + a new #GIOChannel. - a file descriptor. + a file descriptor. - Close an IO channel. Any pending data to be written will be + Close an IO channel. Any pending data to be written will be flushed, ignoring errors. The channel will not be freed until the last reference is dropped using g_io_channel_unref(). Use g_io_channel_shutdown() instead. @@ -8708,107 +9848,107 @@ last reference is dropped using g_io_channel_unref(). - A #GIOChannel + A #GIOChannel - Flushes the write buffer for the GIOChannel. + Flushes the write buffer for the GIOChannel. - the status of the operation: One of + the status of the operation: One of #G_IO_STATUS_NORMAL, #G_IO_STATUS_AGAIN, or #G_IO_STATUS_ERROR. - a #GIOChannel + a #GIOChannel - This function returns a #GIOCondition depending on whether there + This function returns a #GIOCondition depending on whether there is data to be read/space to write data in the internal buffers in the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set. - A #GIOCondition + A #GIOCondition - A #GIOChannel + A #GIOChannel - Gets the buffer size. + Gets the buffer size. - the size of the buffer. + the size of the buffer. - a #GIOChannel + a #GIOChannel - Returns whether @channel is buffered. + Returns whether @channel is buffered. - %TRUE if the @channel is buffered. + %TRUE if the @channel is buffered. - a #GIOChannel + a #GIOChannel - Returns whether the file/socket/whatever associated with @channel + Returns whether the file/socket/whatever associated with @channel will be closed when @channel receives its final unref and is destroyed. The default value of this is %TRUE for channels created by g_io_channel_new_file (), and %FALSE for all other channels. - %TRUE if the channel will be closed, %FALSE otherwise. + %TRUE if the channel will be closed, %FALSE otherwise. - a #GIOChannel. + a #GIOChannel. - Gets the encoding for the input/output of the channel. + Gets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The encoding %NULL makes the channel safe for binary data. - A string containing the encoding, this string is + A string containing the encoding, this string is owned by GLib and must not be freed. - a #GIOChannel + a #GIOChannel - Gets the current flags for a #GIOChannel, including read-only + Gets the current flags for a #GIOChannel, including read-only flags such as %G_IO_FLAG_IS_READABLE. The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITABLE @@ -8819,39 +9959,39 @@ should immediately call g_io_channel_get_flags() to update the internal values of these flags. - the flags which are set on the channel + the flags which are set on the channel - a #GIOChannel + a #GIOChannel - This returns the string that #GIOChannel uses to determine + This returns the string that #GIOChannel uses to determine where in the file a line break occurs. A value of %NULL indicates autodetection. - The line termination string. This value + The line termination string. This value is owned by GLib and must not be freed. - a #GIOChannel + a #GIOChannel - a location to return the length of the line terminator + a location to return the length of the line terminator - Initializes a #GIOChannel struct. + Initializes a #GIOChannel struct. This is called by each of the above functions when creating a #GIOChannel, and so is not often needed by the application @@ -8862,66 +10002,66 @@ programmer (unless you are creating a new type of #GIOChannel). - a #GIOChannel + a #GIOChannel - Reads data from a #GIOChannel. + Reads data from a #GIOChannel. Use g_io_channel_read_chars() instead. - %G_IO_ERROR_NONE if the operation was successful. + %G_IO_ERROR_NONE if the operation was successful. - a #GIOChannel + a #GIOChannel - a buffer to read the data into (which should be at least + a buffer to read the data into (which should be at least count bytes long) - the number of bytes to read from the #GIOChannel + the number of bytes to read from the #GIOChannel - returns the number of bytes actually read + returns the number of bytes actually read - Replacement for g_io_channel_read() with the new API. + Replacement for g_io_channel_read() with the new API. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - + a buffer to read data into - the size of the buffer. Note that the buffer may not be + the size of the buffer. Note that the buffer may not be complelely filled even if there is data in the buffer if the remaining data is not a complete character. - The number of bytes read. This may be + The number of bytes read. This may be zero even on success if count < 6 and the channel's encoding is non-%NULL. This indicates that the next UTF-8 character is too wide for the buffer. @@ -8930,76 +10070,76 @@ programmer (unless you are creating a new type of #GIOChannel). - Reads a line, including the terminating character(s), + Reads a line, including the terminating character(s), from a #GIOChannel into a newly-allocated string. @str_return will contain allocated memory if the return is %G_IO_STATUS_NORMAL. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - The line read from the #GIOChannel, including the + The line read from the #GIOChannel, including the line terminator. This data should be freed with g_free() when no longer needed. This is a nul-terminated string. If a @length of zero is returned, this will be %NULL instead. - location to store length of the read data, or %NULL + location to store length of the read data, or %NULL - location to store position of line terminator, or %NULL + location to store position of line terminator, or %NULL - Reads a line from a #GIOChannel, using a #GString as a buffer. + Reads a line from a #GIOChannel, using a #GString as a buffer. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - a #GString into which the line will be written. + a #GString into which the line will be written. If @buffer already contains data, the old data will be overwritten. - location to store position of line terminator, or %NULL + location to store position of line terminator, or %NULL - Reads all the remaining data from the file. + Reads all the remaining data from the file. - %G_IO_STATUS_NORMAL on success. + %G_IO_STATUS_NORMAL on success. This function never returns %G_IO_STATUS_EOF. - a #GIOChannel + a #GIOChannel - Location to + Location to store a pointer to a string holding the remaining data in the #GIOChannel. This data should be freed with g_free() when no longer needed. This data is terminated by an extra nul @@ -9009,65 +10149,65 @@ is %G_IO_STATUS_NORMAL. - location to store length of the data + location to store length of the data - Reads a Unicode character from @channel. + Reads a Unicode character from @channel. This function cannot be called on a channel with %NULL encoding. - a #GIOStatus + a #GIOStatus - a #GIOChannel + a #GIOChannel - a location to return a character + a location to return a character - Increments the reference count of a #GIOChannel. + Increments the reference count of a #GIOChannel. - the @channel that was passed in (since 2.6) + the @channel that was passed in (since 2.6) - a #GIOChannel + a #GIOChannel - Sets the current position in the #GIOChannel, similar to the standard + Sets the current position in the #GIOChannel, similar to the standard library function fseek(). Use g_io_channel_seek_position() instead. - %G_IO_ERROR_NONE if the operation was successful. + %G_IO_ERROR_NONE if the operation was successful. - a #GIOChannel + a #GIOChannel - an offset, in bytes, which is added to the position specified + an offset, in bytes, which is added to the position specified by @type - the position in the file, which can be %G_SEEK_CUR (the current + the position in the file, which can be %G_SEEK_CUR (the current position), %G_SEEK_SET (the start of the file), or %G_SEEK_END (the end of the file) @@ -9075,23 +10215,23 @@ library function fseek(). - Replacement for g_io_channel_seek() with the new API. + Replacement for g_io_channel_seek() with the new API. - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - The offset in bytes from the position specified by @type + The offset in bytes from the position specified by @type - a #GSeekType. The type %G_SEEK_CUR is only allowed in those + a #GSeekType. The type %G_SEEK_CUR is only allowed in those cases where a call to g_io_channel_set_encoding () is allowed. See the documentation for g_io_channel_set_encoding () for details. @@ -9100,24 +10240,24 @@ library function fseek(). - Sets the buffer size. + Sets the buffer size. - a #GIOChannel + a #GIOChannel - the size of the buffer, or 0 to let GLib pick a good size + the size of the buffer, or 0 to let GLib pick a good size - The buffering state can only be set if the channel's encoding + The buffering state can only be set if the channel's encoding is %NULL. For any other encoding, the channel must be buffered. A buffered channel can only be set unbuffered if the channel's @@ -9142,17 +10282,17 @@ The default state of the channel is buffered. - a #GIOChannel + a #GIOChannel - whether to set the channel buffered or unbuffered + whether to set the channel buffered or unbuffered - Whether to close the channel on the final unref of the #GIOChannel + Whether to close the channel on the final unref of the #GIOChannel data structure. The default value of this is %TRUE for channels created by g_io_channel_new_file (), and %FALSE for all other channels. @@ -9164,18 +10304,18 @@ can cause problems when the final reference to the #GIOChannel is dropped. - a #GIOChannel + a #GIOChannel - Whether to close the channel on the final unref of + Whether to close the channel on the final unref of the GIOChannel data structure. - Sets the encoding for the input/output of the channel. + Sets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The default encoding for the external file is UTF-8. @@ -9211,40 +10351,40 @@ they are "seekable", cannot call g_io_channel_write_chars() after calling one of the API "read" functions. - %G_IO_STATUS_NORMAL if the encoding was successfully set + %G_IO_STATUS_NORMAL if the encoding was successfully set - a #GIOChannel + a #GIOChannel - the encoding type + the encoding type - Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK). + Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK). - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - the flags to set on the IO channel + the flags to set on the IO channel - This sets the string that #GIOChannel uses to determine + This sets the string that #GIOChannel uses to determine where in the file a line break occurs. @@ -9252,18 +10392,18 @@ where in the file a line break occurs. - a #GIOChannel + a #GIOChannel - The line termination string. Use %NULL for + The line termination string. Use %NULL for autodetect. Autodetection breaks on "\n", "\r\n", "\r", "\0", and the Unicode paragraph separator. Autodetection should not be used for anything other than file-based channels. - The length of the termination string. If -1 is passed, the + The length of the termination string. If -1 is passed, the string is assumed to be nul-terminated. This option allows termination strings with embedded nuls. @@ -9271,84 +10411,84 @@ where in the file a line break occurs. - Close an IO channel. Any pending data to be written will be + Close an IO channel. Any pending data to be written will be flushed if @flush is %TRUE. The channel will not be freed until the last reference is dropped using g_io_channel_unref(). - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - if %TRUE, flush pending + if %TRUE, flush pending - Returns the file descriptor of the #GIOChannel. + Returns the file descriptor of the #GIOChannel. On Windows this function returns the file descriptor or socket of the #GIOChannel. - the file descriptor of the #GIOChannel. + the file descriptor of the #GIOChannel. - a #GIOChannel, created with g_io_channel_unix_new(). + a #GIOChannel, created with g_io_channel_unix_new(). - Decrements the reference count of a #GIOChannel. + Decrements the reference count of a #GIOChannel. - a #GIOChannel + a #GIOChannel - Writes data to a #GIOChannel. + Writes data to a #GIOChannel. Use g_io_channel_write_chars() instead. - %G_IO_ERROR_NONE if the operation was successful. + %G_IO_ERROR_NONE if the operation was successful. - a #GIOChannel + a #GIOChannel - the buffer containing the data to write + the buffer containing the data to write - the number of bytes to write + the number of bytes to write - the number of bytes actually written + the number of bytes actually written - Replacement for g_io_channel_write() with the new API. + Replacement for g_io_channel_write() with the new API. On seekable channels with encodings other than %NULL or UTF-8, generic mixing of reading and writing is not allowed. A call to g_io_channel_write_chars () @@ -9356,27 +10496,27 @@ may only be made on a channel from which data has been read in the cases described in the documentation for g_io_channel_set_encoding (). - the status of the operation. + the status of the operation. - a #GIOChannel + a #GIOChannel - a buffer to write data from + a buffer to write data from - the size of the buffer. If -1, the buffer + the size of the buffer. If -1, the buffer is taken to be a nul-terminated string. - The number of bytes written. This can be nonzero + The number of bytes written. This can be nonzero even if the return value is not %G_IO_STATUS_NORMAL. If the return value is %G_IO_STATUS_NORMAL and the channel is blocking, this will always be equal @@ -9386,35 +10526,35 @@ cases described in the documentation for g_io_channel_set_encoding (). - Writes a Unicode character to @channel. + Writes a Unicode character to @channel. This function cannot be called on a channel with %NULL encoding. - a #GIOStatus + a #GIOStatus - a #GIOChannel + a #GIOChannel - a character + a character - Converts an `errno` error number to a #GIOChannelError. + Converts an `errno` error number to a #GIOChannelError. - a #GIOChannelError error number, e.g. + a #GIOChannelError error number, e.g. %G_IO_CHANNEL_ERROR_INVAL. - an `errno` error number, e.g. `EINVAL` + an `errno` error number, e.g. `EINVAL` @@ -9720,12 +10860,23 @@ in a generic way. Resource temporarily unavailable. + + Checks whether a character is a directory +separator. It returns %TRUE for '/' on UNIX +machines and for '\' or '/' under Windows. + + + + a character + + + - The name of the main group of a desktop entry file, as defined in the + The name of the main group of a desktop entry file, as defined in the [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec). Consult the specification for more details about the meanings of the keys below. @@ -9733,32 +10884,32 @@ details about the meanings of the keys below. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string list + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string list giving the available application actions. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings giving the categories in which the desktop entry should be shown in a menu. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the tooltip for the desktop entry. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean set to true + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean set to true if the application is D-Bus activatable. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the command line to execute. It is only valid for desktop entries with the `Application` type. @@ -9769,7 +10920,7 @@ entries with the `Application` type. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the generic name of the desktop entry. @@ -9779,13 +10930,13 @@ string giving the generic name of the desktop entry. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the desktop entry has been deleted by the user. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the name of the icon to be displayed for the desktop entry. @@ -9796,53 +10947,53 @@ entry. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings giving the MIME types supported by this desktop entry. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a localized string giving the specific name of the desktop entry. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings identifying the environments that should not display the desktop entry. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the desktop entry should be shown in menus. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a list of strings identifying the environments that should display the desktop entry. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string containing the working directory to run the program in. It is only valid for desktop entries with the `Application` type. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the application supports the [Startup Notification Protocol Specification](http://www.freedesktop.org/Standards/startup-notification-spec). - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is string + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is string identifying the WM class or name hint of a window that the application will create, which can be used to emulate Startup Notification with older applications. @@ -9850,7 +11001,7 @@ older applications. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean stating whether the program should be run in a terminal window. It is only valid for desktop entries with the `Application` type. @@ -9858,7 +11009,7 @@ It is only valid for desktop entries with the - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the file name of a binary on disk used to determine if the program is actually installed. It is only valid for desktop entries with the `Application` type. @@ -9866,7 +11017,7 @@ with the `Application` type. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the type of the desktop entry. Usually #G_KEY_FILE_DESKTOP_TYPE_APPLICATION, #G_KEY_FILE_DESKTOP_TYPE_LINK, or @@ -9875,33 +11026,33 @@ giving the type of the desktop entry. Usually - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the URL to access. It is only valid for desktop entries with the `Link` type. - A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string + A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string giving the version of the Desktop Entry Specification used for the desktop entry file. - The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing applications. - The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing directories. - The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop + The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop entries representing links to documents. @@ -9911,18 +11062,18 @@ entries representing links to documents. and should not be accessed directly. - Creates a new empty #GKeyFile object. Use + Creates a new empty #GKeyFile object. Use g_key_file_load_from_file(), g_key_file_load_from_data(), g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to read an existing key file. - an empty #GKeyFile. + an empty #GKeyFile. - Clears all keys and groups from @key_file, and decreases the + Clears all keys and groups from @key_file, and decreases the reference count by 1. If the reference count reaches zero, frees the key file and all its allocated memory. @@ -9931,13 +11082,13 @@ frees the key file and all its allocated memory. - a #GKeyFile + a #GKeyFile - Returns the value associated with @key under @group_name as a + Returns the value associated with @key under @group_name as a boolean. If @key cannot be found then %FALSE is returned and @error is set @@ -9946,27 +11097,27 @@ associated with @key cannot be interpreted as a boolean then %FALSE is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - the value associated with the key as a boolean, + the value associated with the key as a boolean, or %FALSE if the key was not found or could not be parsed. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - Returns the values associated with @key under @group_name as + Returns the values associated with @key under @group_name as booleans. If @key cannot be found then %NULL is returned and @error is set to @@ -9975,7 +11126,7 @@ with @key cannot be interpreted as booleans then %NULL is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - + the values associated with the key as a list of booleans, or %NULL if the key was not found or could not be parsed. The returned list of booleans should be freed with g_free() when no longer needed. @@ -9985,25 +11136,25 @@ and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - the number of booleans returned + the number of booleans returned - Retrieves a comment above @key from @group_name. + Retrieves a comment above @key from @group_name. If @key is %NULL then @comment will be read from above @group_name. If both @key and @group_name are %NULL, then @comment will be read from above the first group in the file. @@ -10013,26 +11164,26 @@ but does include any whitespace after them (on each line). It includes the line breaks between lines, but does not include the final line break. - a comment that should be freed with g_free() + a comment that should be freed with g_free() - a #GKeyFile + a #GKeyFile - a group name, or %NULL + a group name, or %NULL - a key + a key - Returns the value associated with @key under @group_name as a + Returns the value associated with @key under @group_name as a double. If @group_name is %NULL, the start_group is used. If @key cannot be found then 0.0 is returned and @error is set to @@ -10041,10 +11192,356 @@ with @key cannot be interpreted as a double then 0.0 is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - the value associated with the key as a double, or + the value associated with the key as a double, or 0.0 if the key was not found or could not be parsed. + + + a #GKeyFile + + + + a group name + + + + a key + + + + + + Returns the values associated with @key under @group_name as +doubles. + +If @key cannot be found then %NULL is returned and @error is set to +#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated +with @key cannot be interpreted as doubles then %NULL is returned +and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. + + + + the values associated with the key as a list of doubles, or %NULL if the + key was not found or could not be parsed. The returned list of doubles + should be freed with g_free() when no longer needed. + + + + + + + a #GKeyFile + + + + a group name + + + + a key + + + + the number of doubles returned + + + + + + Returns all groups in the key file loaded with @key_file. +The array of returned groups will be %NULL-terminated, so +@length may optionally be %NULL. + + + a newly-allocated %NULL-terminated array of strings. + Use g_strfreev() to free it. + + + + + + + a #GKeyFile + + + + return location for the number of returned groups, or %NULL + + + + + + Returns the value associated with @key under @group_name as a signed +64-bit integer. This is similar to g_key_file_get_integer() but can return +64-bit results without truncation. + + + the value associated with the key as a signed 64-bit integer, or +0 if the key was not found or could not be parsed. + + + + + a non-%NULL #GKeyFile + + + + a non-%NULL group name + + + + a non-%NULL key + + + + + + Returns the value associated with @key under @group_name as an +integer. + +If @key cannot be found then 0 is returned and @error is set to +#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated +with @key cannot be interpreted as an integer, or is out of range +for a #gint, then 0 is returned +and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. + + + the value associated with the key as an integer, or + 0 if the key was not found or could not be parsed. + + + + + a #GKeyFile + + + + a group name + + + + a key + + + + + + Returns the values associated with @key under @group_name as +integers. + +If @key cannot be found then %NULL is returned and @error is set to +#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated +with @key cannot be interpreted as integers, or are out of range for +#gint, then %NULL is returned +and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. + + + + the values associated with the key as a list of integers, or %NULL if + the key was not found or could not be parsed. The returned list of + integers should be freed with g_free() when no longer needed. + + + + + + + a #GKeyFile + + + + a group name + + + + a key + + + + the number of integers returned + + + + + + Returns all keys for the group name @group_name. The array of +returned keys will be %NULL-terminated, so @length may +optionally be %NULL. In the event that the @group_name cannot +be found, %NULL is returned and @error is set to +#G_KEY_FILE_ERROR_GROUP_NOT_FOUND. + + + a newly-allocated %NULL-terminated array of strings. + Use g_strfreev() to free it. + + + + + + + a #GKeyFile + + + + a group name + + + + return location for the number of keys returned, or %NULL + + + + + + Returns the actual locale which the result of +g_key_file_get_locale_string() or g_key_file_get_locale_string_list() +came from. + +If calling g_key_file_get_locale_string() or +g_key_file_get_locale_string_list() with exactly the same @key_file, +@group_name, @key and @locale, the result of those functions will +have originally been tagged with the locale that is the result of +this function. + + + the locale from the file, or %NULL if the key was not + found or the entry in the file was was untranslated + + + + + a #GKeyFile + + + + a group name + + + + a key + + + + a locale identifier or %NULL + + + + + + Returns the value associated with @key under @group_name +translated in the given @locale if available. If @locale is +%NULL then the current locale is assumed. + +If @locale is to be non-%NULL, or if the current locale will change over +the lifetime of the #GKeyFile, it must be loaded with +%G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales. + +If @key cannot be found then %NULL is returned and @error is set +to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated +with @key cannot be interpreted or no suitable translation can +be found then the untranslated value is returned. + + + a newly allocated string or %NULL if the specified + key cannot be found. + + + + + a #GKeyFile + + + + a group name + + + + a key + + + + a locale identifier or %NULL + + + + + + Returns the values associated with @key under @group_name +translated in the given @locale if available. If @locale is +%NULL then the current locale is assumed. + +If @locale is to be non-%NULL, or if the current locale will change over +the lifetime of the #GKeyFile, it must be loaded with +%G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales. + +If @key cannot be found then %NULL is returned and @error is set +to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated +with @key cannot be interpreted or no suitable translations +can be found then the untranslated values are returned. The +returned array is %NULL-terminated, so @length may optionally +be %NULL. + + + a newly allocated %NULL-terminated string array + or %NULL if the key isn't found. The string array should be freed + with g_strfreev(). + + + + + + + a #GKeyFile + + + + a group name + + + + a key + + + + a locale identifier or %NULL + + + + return location for the number of returned strings or %NULL + + + + + + Returns the name of the start group of the file. + + + The start group of the key file. + + + + + a #GKeyFile + + + + + + Returns the string value associated with @key under @group_name. +Unlike g_key_file_get_value(), this function handles escape sequences +like \s. + +In the event the key cannot be found, %NULL is returned and +@error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the +event that the @group_name cannot be found, %NULL is returned +and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. + + + a newly allocated string or %NULL if the specified + key cannot be found. + + a #GKeyFile @@ -10060,354 +11557,8 @@ and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - - Returns the values associated with @key under @group_name as -doubles. - -If @key cannot be found then %NULL is returned and @error is set to -#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated -with @key cannot be interpreted as doubles then %NULL is returned -and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - - - - the values associated with the key as a list of doubles, or %NULL if the - key was not found or could not be parsed. The returned list of doubles - should be freed with g_free() when no longer needed. - - - - - - - a #GKeyFile - - - - a group name - - - - a key - - - - the number of doubles returned - - - - - - Returns all groups in the key file loaded with @key_file. -The array of returned groups will be %NULL-terminated, so -@length may optionally be %NULL. - - - a newly-allocated %NULL-terminated array of strings. - Use g_strfreev() to free it. - - - - - - - a #GKeyFile - - - - return location for the number of returned groups, or %NULL - - - - - - Returns the value associated with @key under @group_name as a signed -64-bit integer. This is similar to g_key_file_get_integer() but can return -64-bit results without truncation. - - - the value associated with the key as a signed 64-bit integer, or -0 if the key was not found or could not be parsed. - - - - - a non-%NULL #GKeyFile - - - - a non-%NULL group name - - - - a non-%NULL key - - - - - - Returns the value associated with @key under @group_name as an -integer. - -If @key cannot be found then 0 is returned and @error is set to -#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated -with @key cannot be interpreted as an integer, or is out of range -for a #gint, then 0 is returned -and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - - - the value associated with the key as an integer, or - 0 if the key was not found or could not be parsed. - - - - - a #GKeyFile - - - - a group name - - - - a key - - - - - - Returns the values associated with @key under @group_name as -integers. - -If @key cannot be found then %NULL is returned and @error is set to -#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated -with @key cannot be interpreted as integers, or are out of range for -#gint, then %NULL is returned -and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. - - - - the values associated with the key as a list of integers, or %NULL if - the key was not found or could not be parsed. The returned list of - integers should be freed with g_free() when no longer needed. - - - - - - - a #GKeyFile - - - - a group name - - - - a key - - - - the number of integers returned - - - - - - Returns all keys for the group name @group_name. The array of -returned keys will be %NULL-terminated, so @length may -optionally be %NULL. In the event that the @group_name cannot -be found, %NULL is returned and @error is set to -#G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - - - a newly-allocated %NULL-terminated array of strings. - Use g_strfreev() to free it. - - - - - - - a #GKeyFile - - - - a group name - - - - return location for the number of keys returned, or %NULL - - - - - - Returns the actual locale which the result of -g_key_file_get_locale_string() or g_key_file_get_locale_string_list() -came from. - -If calling g_key_file_get_locale_string() or -g_key_file_get_locale_string_list() with exactly the same @key_file, -@group_name, @key and @locale, the result of those functions will -have originally been tagged with the locale that is the result of -this function. - - - the locale from the file, or %NULL if the key was not - found or the entry in the file was was untranslated - - - - - a #GKeyFile - - - - a group name - - - - a key - - - - a locale identifier or %NULL - - - - - - Returns the value associated with @key under @group_name -translated in the given @locale if available. If @locale is -%NULL then the current locale is assumed. - -If @locale is to be non-%NULL, or if the current locale will change over -the lifetime of the #GKeyFile, it must be loaded with -%G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales. - -If @key cannot be found then %NULL is returned and @error is set -to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated -with @key cannot be interpreted or no suitable translation can -be found then the untranslated value is returned. - - - a newly allocated string or %NULL if the specified - key cannot be found. - - - - - a #GKeyFile - - - - a group name - - - - a key - - - - a locale identifier or %NULL - - - - - - Returns the values associated with @key under @group_name -translated in the given @locale if available. If @locale is -%NULL then the current locale is assumed. - -If @locale is to be non-%NULL, or if the current locale will change over -the lifetime of the #GKeyFile, it must be loaded with -%G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales. - -If @key cannot be found then %NULL is returned and @error is set -to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated -with @key cannot be interpreted or no suitable translations -can be found then the untranslated values are returned. The -returned array is %NULL-terminated, so @length may optionally -be %NULL. - - - a newly allocated %NULL-terminated string array - or %NULL if the key isn't found. The string array should be freed - with g_strfreev(). - - - - - - - a #GKeyFile - - - - a group name - - - - a key - - - - a locale identifier or %NULL - - - - return location for the number of returned strings or %NULL - - - - - - Returns the name of the start group of the file. - - - The start group of the key file. - - - - - a #GKeyFile - - - - - - Returns the string value associated with @key under @group_name. -Unlike g_key_file_get_value(), this function handles escape sequences -like \s. - -In the event the key cannot be found, %NULL is returned and -@error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the -event that the @group_name cannot be found, %NULL is returned -and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - - - a newly allocated string or %NULL if the specified - key cannot be found. - - - - - a #GKeyFile - - - - a group name - - - - a key - - - - - Returns the values associated with @key under @group_name. + Returns the values associated with @key under @group_name. In the event the key cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the @@ -10415,7 +11566,7 @@ event that the @group_name cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - + a %NULL-terminated string array or %NULL if the specified key cannot be found. The array should be freed with g_strfreev(). @@ -10424,50 +11575,50 @@ and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - return location for the number of returned strings, or %NULL + return location for the number of returned strings, or %NULL - Returns the value associated with @key under @group_name as an unsigned + Returns the value associated with @key under @group_name as an unsigned 64-bit integer. This is similar to g_key_file_get_integer() but can return large positive results without truncation. - the value associated with the key as an unsigned 64-bit integer, + the value associated with the key as an unsigned 64-bit integer, or 0 if the key was not found or could not be parsed. - a non-%NULL #GKeyFile + a non-%NULL #GKeyFile - a non-%NULL group name + a non-%NULL group name - a non-%NULL key + a non-%NULL key - Returns the raw value associated with @key under @group_name. + Returns the raw value associated with @key under @group_name. Use g_key_file_get_string() to retrieve an unescaped UTF-8 string. In the event the key cannot be found, %NULL is returned and @@ -10476,46 +11627,46 @@ event that the @group_name cannot be found, %NULL is returned and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. - a newly allocated string or %NULL if the specified + a newly allocated string or %NULL if the specified key cannot be found. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - Looks whether the key file has the group @group_name. + Looks whether the key file has the group @group_name. - %TRUE if @group_name is a part of @key_file, %FALSE + %TRUE if @group_name is a part of @key_file, %FALSE otherwise. - a #GKeyFile + a #GKeyFile - a group name + a group name - Looks whether the key file has the key @key in the group + Looks whether the key file has the key @key in the group @group_name. Note that this function does not follow the rules for #GError strictly; @@ -10527,107 +11678,107 @@ Language bindings should use g_key_file_get_value() to test whether or not a key exists. - %TRUE if @key is a part of @group_name, %FALSE otherwise + %TRUE if @key is a part of @group_name, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name + a group name - a key name + a key name - Loads a key file from the data in @bytes into an empty #GKeyFile structure. + 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. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - a #GBytes + a #GBytes - flags from #GKeyFileFlags + flags from #GKeyFileFlags - Loads a key file from memory into an empty #GKeyFile structure. + Loads a key file from memory into an empty #GKeyFile structure. If the object cannot be created then %error is set to a #GKeyFileError. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - key file loaded in memory + key file loaded in memory - the length of @data in bytes (or (gsize)-1 if data is nul-terminated) + the length of @data in bytes (or (gsize)-1 if data is nul-terminated) - flags from #GKeyFileFlags + flags from #GKeyFileFlags - This function looks for a key file named @file in the paths + This function looks for a key file named @file in the paths returned from g_get_user_data_dir() and g_get_system_data_dirs(), loads the file into @key_file and returns the file's full path in @full_path. If the file could not be loaded then an %error is set to either a #GFileError or #GKeyFileError. - %TRUE if a key file could be loaded, %FALSE othewise + %TRUE if a key file could be loaded, %FALSE othewise - an empty #GKeyFile struct + an empty #GKeyFile struct - a relative path to a filename to open and parse + a relative path to a filename to open and parse - return location for a string containing the full path + return location for a string containing the full path of the file, or %NULL - flags from #GKeyFileFlags + flags from #GKeyFileFlags - This function looks for a key file named @file in the paths + This function looks for a key file named @file in the paths specified in @search_dirs, loads the file into @key_file and returns the file's full path in @full_path. @@ -10638,37 +11789,37 @@ file, a %G_FILE_ERROR is returned. If there is a problem parsing the file, a %G_KEY_FILE_ERROR is returned. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - a relative path to a filename to open and parse + a relative path to a filename to open and parse - %NULL-terminated array of directories to search + %NULL-terminated array of directories to search - return location for a string containing the full path + return location for a string containing the full path of the file, or %NULL - flags from #GKeyFileFlags + flags from #GKeyFileFlags - Loads a key file into an empty #GKeyFile structure. + Loads a key file into an empty #GKeyFile structure. If the OS returns an error when opening or reading the file, a %G_FILE_ERROR is returned. If there is a problem parsing the file, a @@ -10678,128 +11829,128 @@ This function will never return a %G_KEY_FILE_ERROR_NOT_FOUND error. If the @file is not found, %G_FILE_ERROR_NOENT is returned. - %TRUE if a key file could be loaded, %FALSE otherwise + %TRUE if a key file could be loaded, %FALSE otherwise - an empty #GKeyFile struct + an empty #GKeyFile struct - the path of a filename to load, in the GLib filename encoding + the path of a filename to load, in the GLib filename encoding - flags from #GKeyFileFlags + flags from #GKeyFileFlags - Increases the reference count of @key_file. + Increases the reference count of @key_file. - the same @key_file. + the same @key_file. - a #GKeyFile + a #GKeyFile - Removes a comment above @key from @group_name. + Removes a comment above @key from @group_name. If @key is %NULL then @comment will be removed above @group_name. If both @key and @group_name are %NULL, then @comment will be removed above the first group in the file. - %TRUE if the comment was removed, %FALSE otherwise + %TRUE if the comment was removed, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name, or %NULL + a group name, or %NULL - a key + a key - Removes the specified group, @group_name, + Removes the specified group, @group_name, from the key file. - %TRUE if the group was removed, %FALSE otherwise + %TRUE if the group was removed, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name + a group name - Removes @key in @group_name from the key file. + Removes @key in @group_name from the key file. - %TRUE if the key was removed, %FALSE otherwise + %TRUE if the key was removed, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name + a group name - a key name to remove + a key name to remove - Writes the contents of @key_file to @filename using + Writes the contents of @key_file to @filename using g_file_set_contents(). This function can fail for any of the reasons that g_file_set_contents() may fail. - %TRUE if successful, else %FALSE with @error set + %TRUE if successful, else %FALSE with @error set - a #GKeyFile + a #GKeyFile - the name of the file to write to + the name of the file to write to - Associates a new boolean value with @key under @group_name. + Associates a new boolean value with @key under @group_name. If @key cannot be found then it is created. @@ -10807,25 +11958,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - %TRUE or %FALSE + %TRUE or %FALSE - Associates a list of boolean values with @key under @group_name. + Associates a list of boolean values with @key under @group_name. If @key cannot be found then it is created. If @group_name is %NULL, the start_group is used. @@ -10834,31 +11985,31 @@ If @group_name is %NULL, the start_group is used. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of boolean values + an array of boolean values - length of @list + length of @list - Places a comment above @key from @group_name. + Places a comment above @key from @group_name. If @key is %NULL then @comment will be written above @group_name. If both @key and @group_name are %NULL, then @comment will be @@ -10868,30 +12019,30 @@ Note that this function prepends a '#' comment marker to each line of @comment. - %TRUE if the comment was written, %FALSE otherwise + %TRUE if the comment was written, %FALSE otherwise - a #GKeyFile + a #GKeyFile - a group name, or %NULL + a group name, or %NULL - a key + a key - a comment + a comment - Associates a new double value with @key under @group_name. + Associates a new double value with @key under @group_name. If @key cannot be found then it is created. @@ -10899,25 +12050,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an double value + an double value - Associates a list of double values with @key under + Associates a list of double values with @key under @group_name. If @key cannot be found then it is created. @@ -10925,31 +12076,31 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of double values + an array of double values - number of double values in @list + number of double values in @list - Associates a new integer value with @key under @group_name. + Associates a new integer value with @key under @group_name. If @key cannot be found then it is created. @@ -10957,25 +12108,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an integer value + an integer value - Associates a new integer value with @key under @group_name. + Associates a new integer value with @key under @group_name. If @key cannot be found then it is created. @@ -10983,25 +12134,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an integer value + an integer value - Associates a list of integer values with @key under @group_name. + Associates a list of integer values with @key under @group_name. If @key cannot be found then it is created. @@ -11009,31 +12160,31 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of integer values + an array of integer values - number of integer values in @list + number of integer values in @list - Sets the character which is used to separate + Sets the character which is used to separate values in lists. Typically ';' or ',' are used as separators. The default list separator is ';'. @@ -11042,17 +12193,17 @@ as separators. The default list separator is ';'. - a #GKeyFile + a #GKeyFile - the separator + the separator - Associates a string value for @key and @locale under @group_name. + Associates a string value for @key and @locale under @group_name. If the translation for @key cannot be found then it is created. @@ -11060,29 +12211,29 @@ If the translation for @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a locale identifier + a locale identifier - a string + a string - Associates a list of string values for @key and @locale under + Associates a list of string values for @key and @locale under @group_name. If the translation for @key cannot be found then it is created. @@ -11091,35 +12242,35 @@ it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a locale identifier + a locale identifier - a %NULL-terminated array of locale string values + a %NULL-terminated array of locale string values - the length of @list + the length of @list - Associates a new string value with @key under @group_name. + Associates a new string value with @key under @group_name. If @key cannot be found then it is created. If @group_name cannot be found then it is created. Unlike g_key_file_set_value(), this function handles characters @@ -11130,25 +12281,25 @@ that need escaping, such as newlines. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a string + a string - Associates a list of string values for @key under @group_name. + Associates a list of string values for @key under @group_name. If @key cannot be found then it is created. If @group_name cannot be found then it is created. @@ -11157,31 +12308,31 @@ If @group_name cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an array of string values + an array of string values - number of string values in @list + number of string values in @list - Associates a new integer value with @key under @group_name. + Associates a new integer value with @key under @group_name. If @key cannot be found then it is created. @@ -11189,25 +12340,25 @@ If @key cannot be found then it is created. - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - an integer value + an integer value - Associates a new value with @key under @group_name. + Associates a new value with @key under @group_name. If @key cannot be found then it is created. If @group_name cannot be found then it is created. To set an UTF-8 string which may contain @@ -11219,48 +12370,48 @@ g_key_file_set_string(). - a #GKeyFile + a #GKeyFile - a group name + a group name - a key + a key - a string + a string - This function outputs @key_file as a string. + This function outputs @key_file as a string. Note that this function never reports an error, so it is safe to pass %NULL as @error. - a newly allocated string holding + a newly allocated string holding the contents of the #GKeyFile - a #GKeyFile + a #GKeyFile - return location for the length of the + return location for the length of the returned string, or %NULL - Decreases the reference count of @key_file by 1. If the reference count + Decreases the reference count of @key_file by 1. If the reference count reaches zero, frees the key file and all its allocated memory. @@ -11268,7 +12419,7 @@ reaches zero, frees the key file and all its allocated memory. - a #GKeyFile + a #GKeyFile @@ -11321,29 +12472,114 @@ reaches zero, frees the key file and all its allocated memory. written back. + + Hints the compiler that the expression is likely to evaluate to +a true value. The compiler may use this information for optimizations. + +|[<!-- language="C" --> +if (G_LIKELY (random () != 1)) + g_print ("not one"); +]| + + + + the expression + + + - Specifies one of the possible types of byte order. + Specifies one of the possible types of byte order. See #G_BYTE_ORDER. - + - The natural logarithm of 10. - + The natural logarithm of 10. + - The natural logarithm of 2. - + The natural logarithm of 2. + + + Works like g_mutex_lock(), but for a lock defined with +#G_LOCK_DEFINE. + + + + the name of the lock + + + + + The #G_LOCK_ macros provide a convenient interface to #GMutex. +#G_LOCK_DEFINE defines a lock. It can appear in any place where +variable definitions may appear in programs, i.e. in the first block +of a function or outside of functions. The @name parameter will be +mangled to get the name of the #GMutex. This means that you +can use names of existing variables as the parameter - e.g. the name +of the variable you intend to protect with the lock. Look at our +give_me_next_number() example using the #G_LOCK macros: + +Here is an example for using the #G_LOCK convenience macros: +|[<!-- language="C" --> + G_LOCK_DEFINE (current_number); + + int + give_me_next_number (void) + { + static int current_number = 0; + int ret_val; + + G_LOCK (current_number); + ret_val = current_number = calc_next_number (current_number); + G_UNLOCK (current_number); + + return ret_val; + } +]| + + + + the name of the lock + + + + + This works like #G_LOCK_DEFINE, but it creates a static object. + + + + the name of the lock + + + + + This declares a lock, that is defined with #G_LOCK_DEFINE in another +module. + + + + the name of the lock + + + + + + + + + + - Multiplying the base 2 exponent by this number yields the base 10 exponent. - + Multiplying the base 2 exponent by this number yields the base 10 exponent. + - Defines the log domain. See [Log Domains](#log-domains). + Defines the log domain. See [Log Domains](#log-domains). Libraries should define this so that any messages which they log can be differentiated from messages from other @@ -11370,7 +12606,7 @@ above. - GLib log levels that are considered fatal by default. + GLib log levels that are considered fatal by default. This is not used if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. @@ -11378,7 +12614,7 @@ This is not used if structured logging is enabled; see - Log levels below 1<<G_LOG_LEVEL_USER_SHIFT are used by GLib. + Log levels below 1<<G_LOG_LEVEL_USER_SHIFT are used by GLib. Higher bits can be used for user-defined log levels. @@ -11405,19 +12641,19 @@ Higher bits can be used for user-defined log levels. - Allocates space for one #GList element. It is called by + Allocates space for one #GList element. It is called by g_list_append(), g_list_prepend(), g_list_insert() and g_list_insert_sorted() and so is rarely used on its own. - a pointer to the newly-allocated #GList element + a pointer to the newly-allocated #GList element - Adds a new element on to the end of the list. + Adds a new element on to the end of the list. Note that the return value is the new start of the list, if @list was empty; make sure you store the new value. @@ -11441,26 +12677,26 @@ number_list = g_list_append (number_list, GINT_TO_POINTER (14)); ]| - either @list or the new start of the #GList if @list was %NULL + either @list or the new start of the #GList if @list was %NULL - a pointer to a #GList + a pointer to a #GList - the data for the new element + the data for the new element - Adds the second #GList onto the end of the first #GList. + Adds the second #GList onto the end of the first #GList. Note that the elements of the second #GList are not copied. They are used directly. @@ -11470,22 +12706,22 @@ The following example moves an element to the top of the list: list = g_list_remove_link (list, llink); list = g_list_concat (llink, list); ]| - + - the start of the new #GList, which equals @list1 if not %NULL + the start of the new #GList, which equals @list1 if not %NULL - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the #GList to add to the end of the first #GList, + the #GList to add to the end of the first #GList, this must point to the top of the list @@ -11494,22 +12730,22 @@ list = g_list_concat (llink, list); - Copies a #GList. + Copies a #GList. Note that this is a "shallow" copy. If the list elements consist of pointers to data, the pointers are copied but the actual data is not. See g_list_copy_deep() if you need to copy the data as well. - + - the start of the new list that holds the same data as @list + the start of the new list that holds the same data as @list - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list @@ -11517,7 +12753,7 @@ to copy the data as well. - Makes a full (deep) copy of a #GList. + Makes a full (deep) copy of a #GList. In contrast with g_list_copy(), this function uses @func to make a copy of each list element, in addition to copying the list @@ -11538,9 +12774,9 @@ And, to entirely free the new list, you could do: |[<!-- language="C" --> g_list_free_full (another_list, g_object_unref); ]| - + - the start of the new list that holds a full copy of @list, + the start of the new list that holds a full copy of @list, use g_list_free_full() to free it @@ -11548,41 +12784,41 @@ g_list_free_full (another_list, g_object_unref); - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - a copy function used to copy every element in the list + a copy function used to copy every element in the list - user data passed to the copy function @func, or %NULL + user data passed to the copy function @func, or %NULL - Removes the node link_ from the list and frees it. + Removes the node link_ from the list and frees it. Compare this to g_list_remove_link() which removes the node without freeing it. - + - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - node to delete from @list + node to delete from @list @@ -11590,64 +12826,64 @@ without freeing it. - Finds the element in a #GList which contains the given data. - + Finds the element in a #GList which contains the given data. + - the found #GList element, or %NULL if it is not found + the found #GList element, or %NULL if it is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the element data to find + the element data to find - Finds an element in a #GList, using a supplied function to + Finds an element in a #GList, using a supplied function to find the desired element. It iterates over the list, calling the given function which should return 0 when the desired element is found. The function takes two #gconstpointer arguments, the #GList element's data as the first argument and the given user data. - + - the found #GList element, or %NULL if it is not found + the found #GList element, or %NULL if it is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - user data passed to the function + user data passed to the function - the function to call for each element. + the function to call for each element. It should return 0 when the desired element is found - Gets the first element in a #GList. - + Gets the first element in a #GList. + - the first element in the #GList, + the first element in the #GList, or %NULL if the #GList has no elements @@ -11655,7 +12891,7 @@ given user data. - any #GList element + any #GList element @@ -11663,33 +12899,33 @@ given user data. - Calls a function for each element of a #GList. + Calls a function for each element of a #GList. It is safe for @func to remove the element from @list, but it must not modify any part of the list after that element. - + - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the function to call with each element's data + the function to call with each element's data - user data to pass to the function + user data to pass to the function - Frees all of the memory used by a #GList. + Frees all of the memory used by a #GList. The freed elements are returned to the slice allocator. If list elements contain dynamically-allocated memory, you should @@ -11700,7 +12936,7 @@ either use g_list_free_full() or free them manually first. - a #GList + a #GList @@ -11708,7 +12944,7 @@ either use g_list_free_full() or free them manually first. - Frees one #GList element, but does not update links from the next and + Frees one #GList element, but does not update links from the next and previous elements in the list, so you should not call this function on an element that is currently part of a list. @@ -11719,7 +12955,7 @@ It is usually used after g_list_remove_link(). - a #GList element + a #GList element @@ -11727,7 +12963,7 @@ It is usually used after g_list_remove_link(). - Convenience method, which frees all the memory used by a #GList, + Convenience method, which frees all the memory used by a #GList, and calls @free_func on every element's data. @free_func must not modify the list (eg, by removing the freed @@ -11738,61 +12974,61 @@ element from it). - a pointer to a #GList + a pointer to a #GList - the function to be called to free each element's data + the function to be called to free each element's data - Gets the position of the element containing + Gets the position of the element containing the given data (starting from 0). - + - the index of the element containing the data, + the index of the element containing the data, or -1 if the data is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the data to find + the data to find - Inserts a new element into the list at the given position. + Inserts a new element into the list at the given position. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the list + a pointer to a #GList, this must point to the top of the list - the data for the new element + the data for the new element - the position to insert the element. If this is + the position to insert the element. If this is negative, or is larger than the number of elements in the list, the new element is added on to the end of the list. @@ -11800,36 +13036,68 @@ the given data (starting from 0). - Inserts a new element into the list before the given position. + Inserts a new element into the list before the given position. - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the list + a pointer to a #GList, this must point to the top of the list - the list element before which the new element + the list element before which the new element is inserted or %NULL to insert at the end of the list - the data for the new element + the data for the new element + + Inserts @link_ into the list before the given position. + + + the (possibly changed) start of the #GList + + + + + + + a pointer to a #GList, this must point to the top of the list + + + + + + the list element before which the new element + is inserted or %NULL to insert at the end of the list + + + + + + the list element to be added, which must not be part of + any other list + + + + + + - Inserts a new element into the list, using the given comparison + Inserts a new element into the list, using the given comparison function to determine its position. If you are adding many new elements to a list, and the number of @@ -11838,25 +13106,25 @@ g_list_prepend() to add the new items and sort the list afterwards with g_list_sort(). - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the + a pointer to a #GList, this must point to the top of the already sorted list - the data for the new element + the data for the new element - the function to compare elements in the list. It should + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. @@ -11864,7 +13132,7 @@ with g_list_sort(). - Inserts a new element into the list, using the given comparison + Inserts a new element into the list, using the given comparison function to determine its position. If you are adding many new elements to a list, and the number of @@ -11873,40 +13141,40 @@ g_list_prepend() to add the new items and sort the list afterwards with g_list_sort(). - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a pointer to a #GList, this must point to the top of the + a pointer to a #GList, this must point to the top of the already sorted list - the data for the new element + the data for the new element - the function to compare elements in the list. It should + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. - user data to pass to comparison function + user data to pass to comparison function - Gets the last element in a #GList. - + Gets the last element in a #GList. + - the last element in the #GList, + the last element in the #GList, or %NULL if the #GList has no elements @@ -11914,7 +13182,7 @@ with g_list_sort(). - any #GList element + any #GList element @@ -11922,20 +13190,20 @@ with g_list_sort(). - Gets the number of elements in a #GList. + Gets the number of elements in a #GList. This function iterates over the whole list to count its elements. Use a #GQueue instead of a GList if you regularly need the number of items. To check whether the list is non-empty, it is faster to check @list against %NULL. - + - the number of elements in the #GList + the number of elements in the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list @@ -11943,14 +13211,14 @@ of items. To check whether the list is non-empty, it is faster to check - Gets the element at the given position in a #GList. + Gets the element at the given position in a #GList. This iterates over the list until it reaches the @n-th position. If you intend to iterate over every element, it is better to use a for-loop as described in the #GList introduction. - + - the element, or %NULL if the position is off + the element, or %NULL if the position is off the end of the #GList @@ -11958,47 +13226,47 @@ described in the #GList introduction. - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the position of the element, counting from 0 + the position of the element, counting from 0 - Gets the data of the element at the given position. + Gets the data of the element at the given position. This iterates over the list until it reaches the @n-th position. If you intend to iterate over every element, it is better to use a for-loop as described in the #GList introduction. - + - the element's data, or %NULL if the position + the element's data, or %NULL if the position is off the end of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the position of the element + the position of the element - Gets the element @n places before @list. - + Gets the element @n places before @list. + - the element, or %NULL if the position is + the element, or %NULL if the position is off the end of the #GList @@ -12006,35 +13274,35 @@ described in the #GList introduction. - a #GList + a #GList - the position of the element, counting from 0 + the position of the element, counting from 0 - Gets the position of the given element + Gets the position of the given element in the #GList (starting from 0). - + - the position of the element in the #GList, + the position of the element in the #GList, or -1 if the element is not found - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - an element in the #GList + an element in the #GList @@ -12042,7 +13310,7 @@ in the #GList (starting from 0). - Prepends a new element on to the start of the list. + Prepends a new element on to the start of the list. Note that the return value is the new start of the list, which will have changed, so make sure you store the new value. @@ -12059,7 +13327,7 @@ Do not use this function to prepend a new element to a different element than the start of the list. Use g_list_insert_before() instead. - a pointer to the newly prepended element, which is the new + a pointer to the newly prepended element, which is the new start of the #GList @@ -12067,68 +13335,68 @@ element than the start of the list. Use g_list_insert_before() instead. - a pointer to a #GList, this must point to the top of the list + a pointer to a #GList, this must point to the top of the list - the data for the new element + the data for the new element - Removes an element from a #GList. + Removes an element from a #GList. If two elements contain the same data, only the first is removed. If none of the elements contain the data, the #GList is unchanged. - + - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the data of the element to remove + the data of the element to remove - Removes all list nodes with data equal to @data. + Removes all list nodes with data equal to @data. Returns the new head of the list. Contrast with g_list_remove() which removes only the first node matching the given data. - + - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - data to remove + data to remove - Removes an element from a #GList, without freeing the element. + Removes an element from a #GList, without freeing the element. The removed element's prev and next links are set to %NULL, so that it becomes a self-contained list with one element. @@ -12140,22 +13408,22 @@ list = g_list_remove_link (list, llink); free_some_data_that_may_access_the_list_again (llink->data); g_list_free (llink); ]| - + - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - an element in the #GList + an element in the #GList @@ -12163,18 +13431,18 @@ g_list_free (llink); - Reverses a #GList. + Reverses a #GList. It simply switches the next and prev pointers of each element. - + - the start of the reversed #GList + the start of the reversed #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list @@ -12182,24 +13450,24 @@ It simply switches the next and prev pointers of each element. - Sorts a #GList using the given comparison function. The algorithm + Sorts a #GList using the given comparison function. The algorithm used is a stable sort. - + - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - the comparison function used to sort the #GList. + the comparison function used to sort the #GList. This function is passed the data from 2 elements of the #GList and should return 0 if they are equal, a negative value if the first element comes before the second, or a positive value if @@ -12209,28 +13477,28 @@ used is a stable sort. - Like g_list_sort(), but the comparison function accepts + Like g_list_sort(), but the comparison function accepts a user data argument. - + - the (possibly changed) start of the #GList + the (possibly changed) start of the #GList - a #GList, this must point to the top of the list + a #GList, this must point to the top of the list - comparison function + comparison function - user data to pass to comparison function + user data to pass to comparison function @@ -12398,46 +13666,46 @@ If a #GLogWriterFunc ignores a log entry, it should return Like #glib_major_version, but from the headers used at application compile time, rather than from the library linked against at application run time. - + - The maximum value which can be held in a #gint16. + The maximum value which can be held in a #gint16. - The maximum value which can be held in a #gint32. + The maximum value which can be held in a #gint32. - The maximum value which can be held in a #gint64. + The maximum value which can be held in a #gint64. - The maximum value which can be held in a #gint8. + The maximum value which can be held in a #gint8. - The maximum value which can be held in a #guint16. + The maximum value which can be held in a #guint16. - The maximum value which can be held in a #guint32. + The maximum value which can be held in a #guint32. - The maximum value which can be held in a #guint64. + The maximum value which can be held in a #guint64. - The maximum value which can be held in a #guint8. + The maximum value which can be held in a #guint8. @@ -12447,7 +13715,7 @@ linked against at application run time. Like #gtk_micro_version, but from the headers used at application compile time, rather than from the library linked against at application run time. - + @@ -12470,17 +13738,17 @@ linked against at application run time. - + The minor version number of the GLib library. Like #gtk_minor_version, but from the headers used at application compile time, rather than from the library linked against at application run time. - + - + @@ -12488,15 +13756,15 @@ linked against at application run time. type representing a set of sources to be handled in a main loop. - Creates a new #GMainContext structure. + Creates a new #GMainContext structure. - the new #GMainContext + the new #GMainContext - Tries to become the owner of the specified context. + Tries to become the owner of the specified context. If some other thread is the owner of the context, returns %FALSE immediately. Ownership is properly recursive: the owner can require ownership again @@ -12508,19 +13776,19 @@ can call g_main_context_prepare(), g_main_context_query(), g_main_context_check(), g_main_context_dispatch(). - %TRUE if the operation succeeded, and + %TRUE if the operation succeeded, and this thread is now the owner of @context. - a #GMainContext + a #GMainContext - Adds a file descriptor to the set of file descriptors polled for + Adds a file descriptor to the set of file descriptors polled for this context. This will very seldom be used directly. Instead a typical event source will use g_source_add_unix_fd() instead. @@ -12529,16 +13797,16 @@ a typical event source will use g_source_add_unix_fd() instead. - a #GMainContext (or %NULL for the default context) + a #GMainContext (or %NULL for the default context) - a #GPollFD structure holding information about a file + a #GPollFD structure holding information about a file descriptor to watch. - the priority for this file descriptor which should be + the priority for this file descriptor which should be the same as the priority used for g_source_attach() to ensure that the file descriptor is polled whenever the results may be needed. @@ -12546,39 +13814,39 @@ a typical event source will use g_source_add_unix_fd() instead. - Passes the results of polling back to the main loop. + Passes the results of polling back to the main loop. You must have successfully acquired the context with g_main_context_acquire() before you may call this function. - %TRUE if some sources are ready to be dispatched. + %TRUE if some sources are ready to be dispatched. - a #GMainContext + a #GMainContext - the maximum numerical priority of sources to check + the maximum numerical priority of sources to check - array of #GPollFD's that was passed to + array of #GPollFD's that was passed to the last call to g_main_context_query() - return value of g_main_context_query() + return value of g_main_context_query() - Dispatches all pending sources. + Dispatches all pending sources. You must have successfully acquired the context with g_main_context_acquire() before you may call this function. @@ -12588,39 +13856,39 @@ g_main_context_acquire() before you may call this function. - a #GMainContext + a #GMainContext - Finds a source with the given source functions and user data. If + Finds a source with the given source functions and user data. If multiple sources exist with the same source function and user data, the first one found will be returned. - the source, if one was found, otherwise %NULL + the source, if one was found, otherwise %NULL - a #GMainContext (if %NULL, the default context will be used). + a #GMainContext (if %NULL, the default context will be used). - the @source_funcs passed to g_source_new(). + the @source_funcs passed to g_source_new(). - the user data from the callback. + the user data from the callback. - Finds a #GSource given a pair of context and ID. + Finds a #GSource given a pair of context and ID. -It is a programmer error to attempt to lookup a non-existent source. +It is a programmer error to attempt to look up a non-existent source. More specifically: source IDs can be reissued after a source has been destroyed and therefore it is never valid to use this function with a @@ -12632,56 +13900,56 @@ been reissued, leading to the operation being performed against the wrong source. - the #GSource + the #GSource - a #GMainContext (if %NULL, the default context will be used) + a #GMainContext (if %NULL, the default context will be used) - the source ID, as returned by g_source_get_id(). + the source ID, as returned by g_source_get_id(). - Finds a source with the given user data for the callback. If + Finds a source with the given user data for the callback. If multiple sources exist with the same user data, the first one found will be returned. - the source, if one was found, otherwise %NULL + the source, if one was found, otherwise %NULL - a #GMainContext + a #GMainContext - the user_data for the callback. + the user_data for the callback. - Gets the poll function set by g_main_context_set_poll_func(). + Gets the poll function set by g_main_context_set_poll_func(). - the poll function + the poll function - a #GMainContext + a #GMainContext - Invokes a function in such a way that @context is owned during the + Invokes a function in such a way that @context is owned during the invocation of @function. If @context is %NULL then the global default main context — as @@ -12702,27 +13970,27 @@ g_main_context_invoke_full(). Note that, as with normal idle functions, @function should probably return %FALSE. If it returns %TRUE, it will be continuously run in a loop (and may prevent this call from returning). - + - a #GMainContext, or %NULL + a #GMainContext, or %NULL - function to call + function to call - data to pass to @function + data to pass to @function - Invokes a function in such a way that @context is owned during the + Invokes a function in such a way that @context is owned during the invocation of @function. This function is the same as g_main_context_invoke() except that it @@ -12731,52 +13999,52 @@ scheduled as an idle and also lets you give a #GDestroyNotify for @data. @notify should not assume that it is called from any particular thread or with any particular context acquired. - + - a #GMainContext, or %NULL + a #GMainContext, or %NULL - the priority at which to run @function + the priority at which to run @function - function to call + function to call - data to pass to @function + data to pass to @function - a function to call when @data is no longer in use, or %NULL. + a function to call when @data is no longer in use, or %NULL. - Determines whether this thread holds the (recursive) + Determines whether this thread holds the (recursive) ownership of this #GMainContext. This is useful to know before waiting on another thread that may be blocking to get ownership of @context. - %TRUE if current thread is owner of @context. + %TRUE if current thread is owner of @context. - a #GMainContext + a #GMainContext - Runs a single iteration for the given main loop. This involves + Runs a single iteration for the given main loop. This involves checking to see if any event sources are ready to be processed, then if no events sources are ready and @may_block is %TRUE, waiting for a source to become ready, then dispatching the highest priority @@ -12790,36 +14058,36 @@ g_main_context_iteration() to return %FALSE, since the wait may be interrupted for other reasons than an event source becoming ready. - %TRUE if events were dispatched. + %TRUE if events were dispatched. - a #GMainContext (if %NULL, the default context will be used) + a #GMainContext (if %NULL, the default context will be used) - whether the call may block. + whether the call may block. - Checks if any sources have pending events for the given context. + Checks if any sources have pending events for the given context. - %TRUE if events are pending. + %TRUE if events are pending. - a #GMainContext (if %NULL, the default context will be used) + a #GMainContext (if %NULL, the default context will be used) - Pops @context off the thread-default context stack (verifying that + Pops @context off the thread-default context stack (verifying that it was on the top of the stack). @@ -12827,37 +14095,37 @@ it was on the top of the stack). - a #GMainContext object, or %NULL + a #GMainContext object, or %NULL - Prepares to poll sources within a main loop. The resulting information + Prepares to poll sources within a main loop. The resulting information for polling is determined by calling g_main_context_query (). You must have successfully acquired the context with g_main_context_acquire() before you may call this function. - %TRUE if some source is ready to be dispatched + %TRUE if some source is ready to be dispatched prior to polling. - a #GMainContext + a #GMainContext - - location to store priority of highest priority + + location to store priority of highest priority source already ready. - Acquires @context and sets it as the thread-default context for the + Acquires @context and sets it as the thread-default context for the current thread. This will cause certain asynchronous operations (such as most [gio][gio]-based I/O) which are started in this thread to run under @context and deliver their @@ -12901,65 +14169,65 @@ see g_file_supports_thread_contexts(). - a #GMainContext, or %NULL for the global default context + a #GMainContext, or %NULL for the global default context - Determines information necessary to poll this main loop. + Determines information necessary to poll this main loop. You must have successfully acquired the context with g_main_context_acquire() before you may call this function. - the number of records actually stored in @fds, + the number of records actually stored in @fds, or, if more than @n_fds records need to be stored, the number of records that need to be stored. - a #GMainContext + a #GMainContext - maximum priority source to check + maximum priority source to check - location to store timeout to be used in polling + location to store timeout to be used in polling - location to + location to store #GPollFD records that need to be polled. - length of @fds. + length of @fds. - Increases the reference count on a #GMainContext object by one. + Increases the reference count on a #GMainContext object by one. - the @context that was passed in (since 2.6) + the @context that was passed in (since 2.6) - a #GMainContext + a #GMainContext - Releases ownership of a context previously acquired by this thread + Releases ownership of a context previously acquired by this thread with g_main_context_acquire(). If the context was acquired multiple times, the ownership will be released only when g_main_context_release() is called as many times as it was acquired. @@ -12969,13 +14237,13 @@ is called as many times as it was acquired. - a #GMainContext + a #GMainContext - Removes file descriptor from the set of file descriptors to be + Removes file descriptor from the set of file descriptors to be polled for a particular context. @@ -12983,17 +14251,17 @@ polled for a particular context. - a #GMainContext + a #GMainContext - a #GPollFD descriptor previously added with g_main_context_add_poll() + a #GPollFD descriptor previously added with g_main_context_add_poll() - Sets the function to use to handle polling of file descriptors. It + Sets the function to use to handle polling of file descriptors. It will be used instead of the poll() system call (or GLib's replacement function, which is used where poll() isn't available). @@ -13006,17 +14274,17 @@ loop with an external event loop. - a #GMainContext + a #GMainContext - the function to call to poll all file descriptors + the function to call to poll all file descriptors - Decreases the reference count on a #GMainContext object by one. If + Decreases the reference count on a #GMainContext object by one. If the result is zero, free the context and free all associated memory. @@ -13024,13 +14292,13 @@ the result is zero, free the context and free all associated memory. - a #GMainContext + a #GMainContext - Tries to become the owner of the specified context, + Tries to become the owner of the specified context, as with g_main_context_acquire(). But if another thread is the owner, atomically drop @mutex and wait on @cond until that owner releases ownership or until @cond is signaled, then @@ -13038,27 +14306,27 @@ try again (once) to become the owner. Use g_main_context_is_owner() and separate locking instead. - %TRUE if the operation succeeded, and + %TRUE if the operation succeeded, and this thread is now the owner of @context. - a #GMainContext + a #GMainContext - a condition variable + a condition variable - a mutex, currently held + a mutex, currently held - If @context is currently blocking in g_main_context_iteration() + If @context is currently blocking in g_main_context_iteration() waiting for a source to become ready, cause it to stop blocking and return. Otherwise, cause the next invocation of g_main_context_iteration() to return without blocking. @@ -13092,24 +14360,24 @@ Then in a thread: - a #GMainContext + a #GMainContext - Returns the global default main context. This is the main context + Returns the global default main context. This is the main context used for main loop functions when a main loop is not explicitly specified, and corresponds to the "main" main loop. See also g_main_context_get_thread_default(). - the global default main context. + the global default main context. - Gets the thread-default #GMainContext for this thread. Asynchronous + Gets the thread-default #GMainContext for this thread. Asynchronous operations that want to be able to be run in contexts other than the default one should call this method or g_main_context_ref_thread_default() to get a #GMainContext to add @@ -13122,13 +14390,13 @@ If you need to hold a reference on the context, use g_main_context_ref_thread_default() instead. - the thread-default #GMainContext, or + the thread-default #GMainContext, or %NULL if the thread-default context is the global default context. - Gets the thread-default #GMainContext for this thread, as with + Gets the thread-default #GMainContext for this thread, as with g_main_context_get_thread_default(), but also adds a reference to it with g_main_context_ref(). In addition, unlike g_main_context_get_thread_default(), if the thread-default context @@ -13136,7 +14404,7 @@ is the global default context, this will return that #GMainContext (with a ref added to it) rather than returning %NULL. - the thread-default #GMainContext. Unref + the thread-default #GMainContext. Unref with g_main_context_unref() when you are done with it. @@ -13147,19 +14415,19 @@ is the global default context, this will return that #GMainContext representing the main event loop of a GLib or GTK+ application. - Creates a new #GMainLoop structure. + Creates a new #GMainLoop structure. - a new #GMainLoop. + a new #GMainLoop. - a #GMainContext (if %NULL, the default context will be used). + a #GMainContext (if %NULL, the default context will be used). - set to %TRUE to indicate that the loop is running. This + set to %TRUE to indicate that the loop is running. This is not very important since calling g_main_loop_run() will set this to %TRUE anyway. @@ -13167,35 +14435,35 @@ is not very important since calling g_main_loop_run() will set this to - Returns the #GMainContext of @loop. + Returns the #GMainContext of @loop. - the #GMainContext of @loop + the #GMainContext of @loop - a #GMainLoop. + a #GMainLoop. - Checks to see if the main loop is currently being run via g_main_loop_run(). + Checks to see if the main loop is currently being run via g_main_loop_run(). - %TRUE if the mainloop is currently being run. + %TRUE if the mainloop is currently being run. - a #GMainLoop. + a #GMainLoop. - Stops a #GMainLoop from running. Any calls to g_main_loop_run() + Stops a #GMainLoop from running. Any calls to g_main_loop_run() for the loop will return. Note that sources that have already been dispatched when @@ -13206,27 +14474,27 @@ g_main_loop_quit() is called will still be executed. - a #GMainLoop + a #GMainLoop - Increases the reference count on a #GMainLoop object by one. + Increases the reference count on a #GMainLoop object by one. - @loop + @loop - a #GMainLoop + a #GMainLoop - Runs a main loop until g_main_loop_quit() is called on the loop. + Runs a main loop until g_main_loop_quit() is called on the loop. If this is called for the thread of the loop's #GMainContext, it will process events from the loop, otherwise it will simply wait. @@ -13236,13 +14504,13 @@ simply wait. - a #GMainLoop + a #GMainLoop - Decreases the reference count on a #GMainLoop object by one. If + Decreases the reference count on a #GMainLoop object by one. If the result is zero, free the loop and free all associated memory. @@ -13250,7 +14518,7 @@ the result is zero, free the loop and free all associated memory. - a #GMainLoop + a #GMainLoop @@ -13262,7 +14530,7 @@ g_mapped_file_new(). It has only private members and should not be accessed directly. - Maps a file into memory. On UNIX, this is using the mmap() function. + Maps a file into memory. On UNIX, this is using the mmap() function. If @writable is %TRUE, the mapped buffer may be modified, otherwise it is an error to modify the mapped buffer. Modifications to the buffer @@ -13280,24 +14548,24 @@ size 0 (e.g. device files such as /dev/null), @error will be set to the #GFileError value #G_FILE_ERROR_INVAL. - a newly allocated #GMappedFile which must be unref'd + a newly allocated #GMappedFile which must be unref'd with g_mapped_file_unref(), or %NULL if the mapping failed. - The path of the file to load, in the GLib + The path of the file to load, in the GLib filename encoding - whether the mapping should be writable + whether the mapping should be writable - Maps a file into memory. On UNIX, this is using the mmap() function. + Maps a file into memory. On UNIX, this is using the mmap() function. If @writable is %TRUE, the mapped buffer may be modified, otherwise it is an error to modify the mapped buffer. Modifications to the buffer @@ -13310,23 +14578,23 @@ will not be modified, or if all modifications of the file are done atomically (e.g. using g_file_set_contents()). - a newly allocated #GMappedFile which must be unref'd + a newly allocated #GMappedFile which must be unref'd with g_mapped_file_unref(), or %NULL if the mapping failed. - The file descriptor of the file to load + The file descriptor of the file to load - whether the mapping should be writable + whether the mapping should be writable - This call existed before #GMappedFile had refcounting and is currently + This call existed before #GMappedFile had refcounting and is currently exactly the same as g_mapped_file_unref(). Use g_mapped_file_unref() instead. @@ -13335,30 +14603,30 @@ exactly the same as g_mapped_file_unref(). - a #GMappedFile + a #GMappedFile - Creates a new #GBytes which references the data mapped from @file. + Creates a new #GBytes which references the data mapped from @file. The mapped contents of the file must not be modified after creating this bytes object, because a #GBytes should be immutable. - A newly allocated #GBytes referencing data + A newly allocated #GBytes referencing data from @file - a #GMappedFile + a #GMappedFile - Returns the contents of a #GMappedFile. + Returns the contents of a #GMappedFile. Note that the contents may not be zero-terminated, even if the #GMappedFile is backed by a text file. @@ -13366,47 +14634,47 @@ even if the #GMappedFile is backed by a text file. If the file is empty then %NULL is returned. - the contents of @file, or %NULL. + the contents of @file, or %NULL. - a #GMappedFile + a #GMappedFile - Returns the length of the contents of a #GMappedFile. + Returns the length of the contents of a #GMappedFile. - the length of the contents of @file. + the length of the contents of @file. - a #GMappedFile + a #GMappedFile - Increments the reference count of @file by one. It is safe to call + Increments the reference count of @file by one. It is safe to call this function from any thread. - the passed in #GMappedFile. + the passed in #GMappedFile. - a #GMappedFile + a #GMappedFile - Decrements the reference count of @file by one. If the reference count + Decrements the reference count of @file by one. If the reference count drops to 0, unmaps the buffer of @file and frees it. It is safe to call this function from any thread. @@ -13418,7 +14686,7 @@ Since 2.22 - a #GMappedFile + a #GMappedFile @@ -13503,56 +14771,56 @@ See g_markup_parse_context_new(), #GMarkupParser, and so on for more details. - Creates a new parse context. A parse context is used to parse + Creates a new parse context. A parse context is used to parse marked-up documents. You can feed any number of documents into a context, as long as no errors occur; once an error occurs, the parse context can't continue to parse text (you have to free it and create a new parse context). - a new #GMarkupParseContext + a new #GMarkupParseContext - a #GMarkupParser + a #GMarkupParser - one or more #GMarkupParseFlags + one or more #GMarkupParseFlags - user data to pass to #GMarkupParser functions + user data to pass to #GMarkupParser functions - user data destroy notifier called when + user data destroy notifier called when the parse context is freed - Signals to the #GMarkupParseContext that all data has been + Signals to the #GMarkupParseContext that all data has been fed into the parse context with g_markup_parse_context_parse(). This function reports an error if the document isn't complete, for example if elements are still open. - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - a #GMarkupParseContext + a #GMarkupParseContext - Frees a #GMarkupParseContext. + Frees a #GMarkupParseContext. This function can't be called from inside one of the #GMarkupParser functions or while a subparser is pushed. @@ -13562,31 +14830,31 @@ This function can't be called from inside one of the - a #GMarkupParseContext + a #GMarkupParseContext - Retrieves the name of the currently open element. + Retrieves the name of the currently open element. If called from the start_element or end_element handlers this will give the element_name as passed to those functions. For the parent elements, see g_markup_parse_context_get_element_stack(). - the name of the currently open element, or %NULL + the name of the currently open element, or %NULL - a #GMarkupParseContext + a #GMarkupParseContext - Retrieves the element stack from the internal state of the parser. + Retrieves the element stack from the internal state of the parser. The returned #GSList is a list of strings where the first item is the currently open tag (as would be returned by @@ -13599,20 +14867,20 @@ would merely return the name of the element that is being processed. - the element stack, which must not be modified + the element stack, which must not be modified - a #GMarkupParseContext + a #GMarkupParseContext - Retrieves the current line number and the number of the character on + Retrieves the current line number and the number of the character on that line. Intended for use in error messages; there are no strict semantics for what constitutes the "current" line number other than "the best number we could come up with for error messages." @@ -13622,41 +14890,41 @@ semantics for what constitutes the "current" line number other than - a #GMarkupParseContext + a #GMarkupParseContext - return location for a line number, or %NULL + return location for a line number, or %NULL - return location for a char-on-line number, or %NULL + return location for a char-on-line number, or %NULL - Returns the user_data associated with @context. + Returns the user_data associated with @context. This will either be the user_data that was provided to g_markup_parse_context_new() or to the most recent call of g_markup_parse_context_push(). - the provided user_data. The returned data belongs to + the provided user_data. The returned data belongs to the markup context and will be freed when g_markup_parse_context_free() is called. - a #GMarkupParseContext + a #GMarkupParseContext - Feed some data to the #GMarkupParseContext. + Feed some data to the #GMarkupParseContext. The data need not be valid UTF-8; an error will be signaled if it's invalid. The data need not be an entire document; you can @@ -13668,26 +14936,26 @@ is reported, no further data may be fed to the #GMarkupParseContext; all errors are fatal. - %FALSE if an error occurred, %TRUE on success + %FALSE if an error occurred, %TRUE on success - a #GMarkupParseContext + a #GMarkupParseContext - chunk of text to parse + chunk of text to parse - length of @text in bytes + length of @text in bytes - Completes the process of a temporary sub-parser redirection. + Completes the process of a temporary sub-parser redirection. This function exists to collect the user_data allocated by a matching call to g_markup_parse_context_push(). It must be called @@ -13702,18 +14970,18 @@ be used by the subparsers themselves to implement a higher-level interface. - the user data passed to g_markup_parse_context_push() + the user data passed to g_markup_parse_context_push() - a #GMarkupParseContext + a #GMarkupParseContext - Temporarily redirects markup data to a sub-parser. + Temporarily redirects markup data to a sub-parser. This function may only be called from the start_element handler of a #GMarkupParser. It must be matched with a corresponding call to @@ -13833,35 +15101,35 @@ static void end_element (context, element_name, ...) - a #GMarkupParseContext + a #GMarkupParseContext - a #GMarkupParser + a #GMarkupParser - user data to pass to #GMarkupParser functions + user data to pass to #GMarkupParser functions - Increases the reference count of @context. + Increases the reference count of @context. - the same @context + the same @context - a #GMarkupParseContext + a #GMarkupParseContext - Decreases the reference count of @context. When its reference count + Decreases the reference count of @context. When its reference count drops to 0, it is freed. @@ -13869,7 +15137,7 @@ drops to 0, it is freed. - a #GMarkupParseContext + a #GMarkupParseContext @@ -14024,7 +15292,7 @@ back to its caller. matches. - Returns a new string containing the text in @string_to_expand with + Returns a new string containing the text in @string_to_expand with references and escape sequences expanded. References refer to the last match done with @string against @regex and have the same syntax used by g_regex_replace(). @@ -14043,22 +15311,22 @@ Use g_regex_check_replacement() to find out whether @string_to_expand contains references. - the expanded string, or %NULL if an error occurred + the expanded string, or %NULL if an error occurred - a #GMatchInfo or %NULL + a #GMatchInfo or %NULL - the string to expand + the string to expand - Retrieves the text matching the @match_num'th capturing + Retrieves the text matching the @match_num'th capturing parentheses. 0 is the full text of the match, 1 is the first paren set, 2 the second, and so on. @@ -14076,23 +15344,23 @@ The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string. - The matched substring, or %NULL if an error + The matched substring, or %NULL if an error occurred. You have to free the string yourself - #GMatchInfo structure + #GMatchInfo structure - number of the sub expression + number of the sub expression - Bundles up pointers to each of the matching substrings from a match + Bundles up pointers to each of the matching substrings from a match and stores them in an array of gchar pointers. The first element in the returned array is the match number 0, i.e. the entire matched text. @@ -14110,7 +15378,7 @@ The strings are fetched from the string passed to the match function, so you cannot call this function after freeing the string. - a %NULL-terminated array of gchar * + a %NULL-terminated array of gchar * pointers. It must be freed using g_strfreev(). If the previous match failed %NULL is returned @@ -14119,13 +15387,13 @@ so you cannot call this function after freeing the string. - a #GMatchInfo structure + a #GMatchInfo structure - Retrieves the text matching the capturing parentheses named @name. + Retrieves the text matching the capturing parentheses named @name. If @name is a valid sub pattern name but it didn't match anything (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b") @@ -14135,57 +15403,57 @@ The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string. - The matched substring, or %NULL if an error + The matched substring, or %NULL if an error occurred. You have to free the string yourself - #GMatchInfo structure + #GMatchInfo structure - name of the subexpression + name of the subexpression - Retrieves the position in bytes of the capturing parentheses named @name. + Retrieves the position in bytes of the capturing parentheses named @name. If @name is a valid sub pattern name but it didn't match anything (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b") then @start_pos and @end_pos are set to -1 and %TRUE is returned. - %TRUE if the position was fetched, %FALSE otherwise. + %TRUE if the position was fetched, %FALSE otherwise. If the position cannot be fetched, @start_pos and @end_pos are left unchanged. - #GMatchInfo structure + #GMatchInfo structure - name of the subexpression + name of the subexpression - pointer to location where to store + pointer to location where to store the start position, or %NULL - pointer to location where to store + pointer to location where to store the end position, or %NULL - Retrieves the position in bytes of the @match_num'th capturing + Retrieves the position in bytes of the @match_num'th capturing parentheses. 0 is the full text of the match, 1 is the first paren set, 2 the second, and so on. @@ -14200,34 +15468,34 @@ substring. Substrings are matched in reverse order of length, so 0 is the longest match. - %TRUE if the position was fetched, %FALSE otherwise. If + %TRUE if the position was fetched, %FALSE otherwise. If the position cannot be fetched, @start_pos and @end_pos are left unchanged - #GMatchInfo structure + #GMatchInfo structure - number of the sub expression + number of the sub expression - pointer to location where to store + pointer to location where to store the start position, or %NULL - pointer to location where to store + pointer to location where to store the end position, or %NULL - If @match_info is not %NULL, calls g_match_info_unref(); otherwise does + If @match_info is not %NULL, calls g_match_info_unref(); otherwise does nothing. @@ -14235,13 +15503,13 @@ nothing. - a #GMatchInfo, or %NULL + a #GMatchInfo, or %NULL - Retrieves the number of matched substrings (including substring 0, + Retrieves the number of matched substrings (including substring 0, that is the whole matched text), so 1 is returned if the pattern has no substrings in it and 0 is returned if the match failed. @@ -14251,50 +15519,50 @@ count is not that of the number of capturing parentheses but that of the number of matched substrings. - Number of matched substrings, or -1 if an error occurred + Number of matched substrings, or -1 if an error occurred - a #GMatchInfo structure + a #GMatchInfo structure - Returns #GRegex object used in @match_info. It belongs to Glib + Returns #GRegex object used in @match_info. It belongs to Glib and must not be freed. Use g_regex_ref() if you need to keep it after you free @match_info object. - #GRegex object used in @match_info + #GRegex object used in @match_info - a #GMatchInfo + a #GMatchInfo - Returns the string searched with @match_info. This is the + Returns the string searched with @match_info. This is the string passed to g_regex_match() or g_regex_replace() so you may not free it before calling this function. - the string searched with @match_info + the string searched with @match_info - a #GMatchInfo + a #GMatchInfo - Usually if the string passed to g_regex_match*() matches as far as + Usually if the string passed to g_regex_match*() matches as far as it goes, but is too short to match the entire pattern, %FALSE is returned. There are circumstances where it might be helpful to distinguish this case from other cases in which there is no match. @@ -14329,33 +15597,33 @@ The restrictions no longer apply. See pcrepartial(3) for more information on partial matching. - %TRUE if the match was partial, %FALSE otherwise + %TRUE if the match was partial, %FALSE otherwise - a #GMatchInfo structure + a #GMatchInfo structure - Returns whether the previous match operation succeeded. + Returns whether the previous match operation succeeded. - %TRUE if the previous match operation succeeded, + %TRUE if the previous match operation succeeded, %FALSE otherwise - a #GMatchInfo structure + a #GMatchInfo structure - Scans for the next match using the same parameters of the previous + Scans for the next match using the same parameters of the previous call to g_regex_match_full() or g_regex_match() that returned @match_info. @@ -14363,32 +15631,32 @@ The match is done on the string passed to the match function, so you cannot free it before calling this function. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GMatchInfo structure + a #GMatchInfo structure - Increases reference count of @match_info by 1. + Increases reference count of @match_info by 1. - @match_info + @match_info - a #GMatchInfo + a #GMatchInfo - Decreases reference count of @match_info by 1. When reference count drops + Decreases reference count of @match_info by 1. When reference count drops to zero, it frees all the memory associated with the match_info structure. @@ -14396,7 +15664,7 @@ to zero, it frees all the memory associated with the match_info structure. - a #GMatchInfo + a #GMatchInfo @@ -14408,10 +15676,10 @@ be used for all allocations in the same program; a call to g_mem_set_vtable(), if it exists, should be prior to any use of GLib. This functions related to this has been deprecated in 2.46, and no longer work. - + - + @@ -14424,7 +15692,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -14440,7 +15708,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -14453,7 +15721,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -14469,7 +15737,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -14482,7 +15750,7 @@ This functions related to this has been deprecated in 2.46, and no longer work.< - + @@ -14552,7 +15820,7 @@ A #GMutex should only be accessed via g_mutex_ functions. - Frees the resources allocated to a mutex with g_mutex_init(). + Frees the resources allocated to a mutex with g_mutex_init(). This function should not be used with a #GMutex that has been statically allocated. @@ -14567,13 +15835,13 @@ Sine: 2.32 - an initialized #GMutex + an initialized #GMutex - Initializes a #GMutex so that it can be used. + Initializes a #GMutex so that it can be used. This function is useful to initialize a mutex that has been allocated on the stack, or as part of a larger structure. @@ -14603,13 +15871,13 @@ to undefined behaviour. - an uninitialized #GMutex + an uninitialized #GMutex - Locks @mutex. If @mutex is already locked by another thread, the + Locks @mutex. If @mutex is already locked by another thread, the current thread will block until @mutex is unlocked by the other thread. @@ -14623,13 +15891,13 @@ already been locked by the same thread results in undefined behaviour - a #GMutex + a #GMutex - Tries to lock @mutex. If @mutex is already locked by another thread, + Tries to lock @mutex. If @mutex is already locked by another thread, it immediately returns %FALSE. Otherwise it locks @mutex and returns %TRUE. @@ -14639,18 +15907,18 @@ already been locked by the same thread results in undefined behaviour (including but not limited to deadlocks or arbitrary return values). - %TRUE if @mutex could be locked + %TRUE if @mutex could be locked - a #GMutex + a #GMutex - Unlocks @mutex. If another thread is blocked in a g_mutex_lock() + Unlocks @mutex. If another thread is blocked in a g_mutex_lock() call for @mutex, it will become unblocked and can lock @mutex itself. Calling g_mutex_unlock() on a mutex that is not locked by the @@ -14661,15 +15929,45 @@ current thread leads to undefined behaviour. - a #GMutex + a #GMutex + + Returns %TRUE if a #GNode is a leaf node. + + + + a #GNode + + + + + Returns %TRUE if a #GNode is the root of a tree. + + + + a #GNode + + + + + Determines the number of elements in an array. The array must be +declared so the compiler knows its size at compile-time; this +macro will not work on an array allocated on the heap, only static +arrays or arrays on the stack. + + + + the array + + + The #GNode struct represents one node in a [n-ary tree][glib-N-ary-Trees]. - + contains the actual data of the node. @@ -14695,508 +15993,508 @@ current thread leads to undefined behaviour. - Gets the position of the first child of a #GNode + Gets the position of the first child of a #GNode which contains the given data. - + - the index of the child of @node which contains + the index of the child of @node which contains @data, or -1 if the data is not found - a #GNode + a #GNode - the data to find + the data to find - Gets the position of a #GNode with respect to its siblings. + Gets the position of a #GNode with respect to its siblings. @child must be a child of @node. The first child is numbered 0, the second 1, and so on. - + - the position of @child with respect to its siblings + the position of @child with respect to its siblings - a #GNode + a #GNode - a child of @node + a child of @node - Calls a function for each of the children of a #GNode. Note that it + Calls a function for each of the children of a #GNode. Note that it doesn't descend beneath the child nodes. @func must not do anything that would modify the structure of the tree. - + - a #GNode + a #GNode - which types of children are to be visited, one of + which types of children are to be visited, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - the function to call for each visited node + the function to call for each visited node - user data to pass to the function + user data to pass to the function - Recursively copies a #GNode (but does not deep-copy the data inside the + Recursively copies a #GNode (but does not deep-copy the data inside the nodes, see g_node_copy_deep() if you need that). - + - a new #GNode containing the same data pointers + a new #GNode containing the same data pointers - a #GNode + a #GNode - Recursively copies a #GNode and its data. - + Recursively copies a #GNode and its data. + - a new #GNode containing copies of the data in @node. + a new #GNode containing copies of the data in @node. - a #GNode + a #GNode - the function which is called to copy the data inside each node, + the function which is called to copy the data inside each node, or %NULL to use the original data. - data to pass to @copy_func + data to pass to @copy_func - Gets the depth of a #GNode. + Gets the depth of a #GNode. If @node is %NULL the depth is 0. The root node has a depth of 1. For the children of the root node the depth is 2. And so on. - + - the depth of the #GNode + the depth of the #GNode - a #GNode + a #GNode - Removes @root and its children from the tree, freeing any memory + Removes @root and its children from the tree, freeing any memory allocated. - + - the root of the tree/subtree to destroy + the root of the tree/subtree to destroy - Finds a #GNode in a tree. - + Finds a #GNode in a tree. + - the found #GNode, or %NULL if the data is not found + the found #GNode, or %NULL if the data is not found - the root #GNode of the tree to search + the root #GNode of the tree to search - the order in which nodes are visited - %G_IN_ORDER, + the order in which nodes are visited - %G_IN_ORDER, %G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER - which types of children are to be searched, one of + which types of children are to be searched, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - the data to find + the data to find - Finds the first child of a #GNode with the given data. - + Finds the first child of a #GNode with the given data. + - the found child #GNode, or %NULL if the data is not found + the found child #GNode, or %NULL if the data is not found - a #GNode + a #GNode - which types of children are to be searched, one of + which types of children are to be searched, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - the data to find + the data to find - Gets the first sibling of a #GNode. + Gets the first sibling of a #GNode. This could possibly be the node itself. - + - the first sibling of @node + the first sibling of @node - a #GNode + a #GNode - Gets the root of a tree. - + Gets the root of a tree. + - the root of the tree + the root of the tree - a #GNode + a #GNode - Inserts a #GNode beneath the parent at the given position. - + Inserts a #GNode beneath the parent at the given position. + - the inserted #GNode + the inserted #GNode - the #GNode to place @node under + the #GNode to place @node under - the position to place @node at, with respect to its siblings + the position to place @node at, with respect to its siblings If position is -1, @node is inserted as the last child of @parent - the #GNode to insert + the #GNode to insert - Inserts a #GNode beneath the parent after the given sibling. - + Inserts a #GNode beneath the parent after the given sibling. + - the inserted #GNode + the inserted #GNode - the #GNode to place @node under + the #GNode to place @node under - the sibling #GNode to place @node after. + the sibling #GNode to place @node after. If sibling is %NULL, the node is inserted as the first child of @parent. - the #GNode to insert + the #GNode to insert - Inserts a #GNode beneath the parent before the given sibling. - + Inserts a #GNode beneath the parent before the given sibling. + - the inserted #GNode + the inserted #GNode - the #GNode to place @node under + the #GNode to place @node under - the sibling #GNode to place @node before. + the sibling #GNode to place @node before. If sibling is %NULL, the node is inserted as the last child of @parent. - the #GNode to insert + the #GNode to insert - Returns %TRUE if @node is an ancestor of @descendant. + Returns %TRUE if @node is an ancestor of @descendant. This is true if node is the parent of @descendant, or if node is the grandparent of @descendant etc. - + - %TRUE if @node is an ancestor of @descendant + %TRUE if @node is an ancestor of @descendant - a #GNode + a #GNode - a #GNode + a #GNode - Gets the last child of a #GNode. - + Gets the last child of a #GNode. + - the last child of @node, or %NULL if @node has no children + the last child of @node, or %NULL if @node has no children - a #GNode (must not be %NULL) + a #GNode (must not be %NULL) - Gets the last sibling of a #GNode. + Gets the last sibling of a #GNode. This could possibly be the node itself. - + - the last sibling of @node + the last sibling of @node - a #GNode + a #GNode - Gets the maximum height of all branches beneath a #GNode. + Gets the maximum height of all branches beneath a #GNode. This is the maximum distance from the #GNode to all leaf nodes. If @root is %NULL, 0 is returned. If @root has no children, 1 is returned. If @root has children, 2 is returned. And so on. - + - the maximum height of the tree beneath @root + the maximum height of the tree beneath @root - a #GNode + a #GNode - Gets the number of children of a #GNode. - + Gets the number of children of a #GNode. + - the number of children of @node + the number of children of @node - a #GNode + a #GNode - Gets the number of nodes in a tree. - + Gets the number of nodes in a tree. + - the number of nodes in the tree + the number of nodes in the tree - a #GNode + a #GNode - which types of children are to be counted, one of + which types of children are to be counted, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - Gets a child of a #GNode, using the given index. + Gets a child of a #GNode, using the given index. The first child is at index 0. If the index is too big, %NULL is returned. - + - the child of @node at index @n + the child of @node at index @n - a #GNode + a #GNode - the index of the desired child + the index of the desired child - Inserts a #GNode as the first child of the given parent. - + Inserts a #GNode as the first child of the given parent. + - the inserted #GNode + the inserted #GNode - the #GNode to place the new #GNode under + the #GNode to place the new #GNode under - the #GNode to insert + the #GNode to insert - Reverses the order of the children of a #GNode. + Reverses the order of the children of a #GNode. (It doesn't change the order of the grandchildren.) - + - a #GNode. + a #GNode. - Traverses a tree starting at the given root #GNode. + Traverses a tree starting at the given root #GNode. It calls the given function for each node visited. The traversal can be halted at any point by returning %TRUE from @func. @func must not do anything that would modify the structure of the tree. - + - the root #GNode of the tree to traverse + the root #GNode of the tree to traverse - the order in which nodes are visited - %G_IN_ORDER, + the order in which nodes are visited - %G_IN_ORDER, %G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER. - which types of children are to be visited, one of + which types of children are to be visited, one of %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES - the maximum depth of the traversal. Nodes below this + the maximum depth of the traversal. Nodes below this depth will not be visited. If max_depth is -1 all nodes in the tree are visited. If depth is 1, only the root is visited. If depth is 2, the root and its children are visited. And so on. - the function to call for each visited #GNode + the function to call for each visited #GNode - user data to pass to the function + user data to pass to the function - Unlinks a #GNode from a tree, resulting in two separate trees. - + Unlinks a #GNode from a tree, resulting in two separate trees. + - the #GNode to unlink, which becomes the root of a new tree + the #GNode to unlink, which becomes the root of a new tree - Creates a new #GNode containing the given data. + Creates a new #GNode containing the given data. Used to create the first node in a tree. - + - a new #GNode + a new #GNode - the data of the new node + the data of the new node @@ -15243,42 +16541,42 @@ user data passed to g_node_traverse(). If the function returns - Defines how a Unicode string is transformed in a canonical + Defines how a Unicode string is transformed in a canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. Unicode strings should generally be normalized before comparing them. - + - standardize differences that do not affect the + standardize differences that do not affect the text content, such as the above-mentioned accent representation - another name for %G_NORMALIZE_DEFAULT + another name for %G_NORMALIZE_DEFAULT - like %G_NORMALIZE_DEFAULT, but with + like %G_NORMALIZE_DEFAULT, but with composed forms rather than a maximally decomposed form - another name for %G_NORMALIZE_DEFAULT_COMPOSE + another name for %G_NORMALIZE_DEFAULT_COMPOSE - beyond %G_NORMALIZE_DEFAULT also standardize the + beyond %G_NORMALIZE_DEFAULT also standardize the "compatibility" characters in Unicode, such as SUPERSCRIPT THREE to the standard forms (in this case DIGIT THREE). Formatting information may be lost but for most text operations such characters should be considered the same - another name for %G_NORMALIZE_ALL + another name for %G_NORMALIZE_ALL - like %G_NORMALIZE_ALL, but with composed + like %G_NORMALIZE_ALL, but with composed forms rather than a maximally decomposed form - another name for %G_NORMALIZE_ALL_COMPOSE + another name for %G_NORMALIZE_ALL_COMPOSE @@ -15292,7 +16590,7 @@ should generally be normalized before comparing them. - If a long option in the main group has this name, it is not treated as a + If a long option in the main group has this name, it is not treated as a regular option. Instead it collects all non-option arguments which would otherwise be left in `argv`. The option must be of type %G_OPTION_ARG_CALLBACK, %G_OPTION_ARG_STRING_ARRAY @@ -15302,7 +16600,7 @@ or %G_OPTION_ARG_FILENAME_ARRAY. Using #G_OPTION_REMAINING instead of simply scanning `argv` for leftover arguments has the advantage that GOption takes care of necessary encoding conversions for strings or filenames. - + @@ -15337,7 +16635,7 @@ struct. - Function to be called when starting a critical initialization + Function to be called when starting a critical initialization section. The argument @location must point to a static 0-initialized variable that will be set to a value other than 0 at the end of the initialization section. In combination with @@ -15361,20 +16659,20 @@ like this: ]| - %TRUE if the initialization section should be entered, + %TRUE if the initialization section should be entered, %FALSE and blocks otherwise - location of a static initializable variable + location of a static initializable variable containing 0 - Counterpart to g_once_init_enter(). Expects a location of a static + Counterpart to g_once_init_enter(). Expects a location of a static 0-initialized initialization variable, and an initialization value other than 0. Sets the variable to the initialization value, and releases concurrent threads blocking in g_once_init_enter() on this @@ -15385,12 +16683,12 @@ initialization variable. - location of a static initializable variable + location of a static initializable variable containing 0 - new non-0 value for *@value_location + new non-0 value for *@value_location @@ -15415,12 +16713,12 @@ controlled by a #GOnce struct. options expect to find. If an option expects an extra argument, it can be specified in several ways; with a short option: `-x arg`, with a long option: `--name arg` or combined in a single argument: `--name=arg`. - + No extra argument. This is useful for simple flags. - The option takes a string argument. + The option takes a UTF-8 string argument. The option takes an integer argument. @@ -15430,50 +16728,51 @@ option: `--name arg` or combined in a single argument: `--name=arg`. #GOptionArgFunc) to parse the extra argument. - The option takes a filename as argument. + The option takes a filename as argument, which will + be in the GLib filename encoding rather than UTF-8. - The option takes a string argument, multiple + The option takes a string argument, multiple uses of the option are collected into an array of strings. - The option takes a filename as argument, + The option takes a filename as argument, multiple uses of the option are collected into an array of strings. - The option takes a double argument. The argument + The option takes a double argument. The argument can be formatted either for the user's locale or for the "C" locale. Since 2.12 - The option takes a 64-bit integer. Like + The option takes a 64-bit integer. Like %G_OPTION_ARG_INT but for larger numbers. The number can be in decimal base, or in hexadecimal (when prefixed with `0x`, for example, `0xffffffff`). Since 2.12 - The type of function to be passed as callback for %G_OPTION_ARG_CALLBACK + The type of function to be passed as callback for %G_OPTION_ARG_CALLBACK options. - + - %TRUE if the option was successfully parsed, %FALSE if an error + %TRUE if the option was successfully parsed, %FALSE if an error occurred, in which case @error should be set with g_set_error() - The name of the option being parsed. This will be either a + The name of the option being parsed. This will be either a single dash followed by a single letter (for a short name) or two dashes followed by a long option name. - The value to be parsed. + The value to be parsed. - User data added to the #GOptionGroup containing the option when it + User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() @@ -15485,42 +16784,42 @@ are accepted by the commandline option parser. The struct has only private fields and should not be directly accessed. - Adds a #GOptionGroup to the @context, so that parsing with @context + Adds a #GOptionGroup to the @context, so that parsing with @context will recognize the options in the group. Note that this will take ownership of the @group and thus the @group should not be freed. - + - a #GOptionContext + a #GOptionContext - the group to add + the group to add - A convenience function which creates a main group if it doesn't + A convenience function which creates a main group if it doesn't exist, adds the @entries to it and sets the translation domain. - + - a #GOptionContext + a #GOptionContext - a %NULL-terminated array of #GOptionEntrys + a %NULL-terminated array of #GOptionEntrys - a translation domain to use for translating + a translation domain to use for translating the `--help` output for the options in @entries with gettext(), or %NULL @@ -15528,142 +16827,142 @@ exist, adds the @entries to it and sets the translation domain. - Frees context and all the groups which have been + Frees context and all the groups which have been added to it. Please note that parsed arguments need to be freed separately (see #GOptionEntry). - + - a #GOptionContext + a #GOptionContext - Returns the description. See g_option_context_set_description(). - + Returns the description. See g_option_context_set_description(). + - the description + the description - a #GOptionContext + a #GOptionContext - Returns a formatted, translated help text for the given context. + Returns a formatted, translated help text for the given context. To obtain the text produced by `--help`, call `g_option_context_get_help (context, TRUE, NULL)`. To obtain the text produced by `--help-all`, call `g_option_context_get_help (context, FALSE, NULL)`. To obtain the help text for an option group, call `g_option_context_get_help (context, FALSE, group)`. - + - A newly allocated string containing the help text + A newly allocated string containing the help text - a #GOptionContext + a #GOptionContext - if %TRUE, only include the main group + if %TRUE, only include the main group - the #GOptionGroup to create help for, or %NULL + the #GOptionGroup to create help for, or %NULL - Returns whether automatic `--help` generation + Returns whether automatic `--help` generation is turned on for @context. See g_option_context_set_help_enabled(). - + - %TRUE if automatic help generation is turned on. + %TRUE if automatic help generation is turned on. - a #GOptionContext + a #GOptionContext - Returns whether unknown options are ignored or not. See + Returns whether unknown options are ignored or not. See g_option_context_set_ignore_unknown_options(). - + - %TRUE if unknown options are ignored. + %TRUE if unknown options are ignored. - a #GOptionContext + a #GOptionContext - Returns a pointer to the main group of @context. - + Returns a pointer to the main group of @context. + - the main group of @context, or %NULL if + the main group of @context, or %NULL if @context doesn't have a main group. Note that group belongs to @context and should not be modified or freed. - a #GOptionContext + a #GOptionContext - Returns whether strict POSIX code is enabled. + Returns whether strict POSIX code is enabled. See g_option_context_set_strict_posix() for more information. - + - %TRUE if strict POSIX is enabled, %FALSE otherwise. + %TRUE if strict POSIX is enabled, %FALSE otherwise. - a #GOptionContext + a #GOptionContext - Returns the summary. See g_option_context_set_summary(). - + Returns the summary. See g_option_context_set_summary(). + - the summary + the summary - a #GOptionContext + a #GOptionContext - Parses the command line arguments, recognizing options + Parses the command line arguments, recognizing options which have been added to @context. A side-effect of calling this function is that g_set_prgname() will be called. @@ -15684,23 +16983,23 @@ call `exit (0)`. Note that function depends on the [current locale][setlocale] for automatic character set conversion of string and filename arguments. - + - %TRUE if the parsing was successful, + %TRUE if the parsing was successful, %FALSE if an error occurred - a #GOptionContext + a #GOptionContext - a pointer to the number of command line arguments + a pointer to the number of command line arguments - a pointer to the array of command line arguments + a pointer to the array of command line arguments @@ -15708,7 +17007,7 @@ arguments. - Parses the command line arguments. + Parses the command line arguments. This function is similar to g_option_context_parse() except that it respects the normal memory rules when dealing with a strv instead of @@ -15724,19 +17023,19 @@ See g_win32_get_command_line() for a solution. This function is useful if you are trying to use #GOptionContext with #GApplication. - + - %TRUE if the parsing was successful, + %TRUE if the parsing was successful, %FALSE if an error occurred - a #GOptionContext + a #GOptionContext - a pointer to the + a pointer to the command line arguments (which must be in UTF-8 on Windows) @@ -15745,93 +17044,93 @@ This function is useful if you are trying to use #GOptionContext with - Adds a string to be displayed in `--help` output after the list + Adds a string to be displayed in `--help` output after the list of options. This text often includes a bug reporting address. Note that the summary is translated (see g_option_context_set_translate_func()). - + - a #GOptionContext + a #GOptionContext - a string to be shown in `--help` output + a string to be shown in `--help` output after the list of options, or %NULL - Enables or disables automatic generation of `--help` output. + Enables or disables automatic generation of `--help` output. By default, g_option_context_parse() recognizes `--help`, `-h`, `-?`, `--help-all` and `--help-groupname` and creates suitable output to stdout. - + - a #GOptionContext + a #GOptionContext - %TRUE to enable `--help`, %FALSE to disable it + %TRUE to enable `--help`, %FALSE to disable it - Sets whether to ignore unknown options or not. If an argument is + Sets whether to ignore unknown options or not. If an argument is ignored, it is left in the @argv array after parsing. By default, g_option_context_parse() treats unknown options as error. This setting does not affect non-option arguments (i.e. arguments which don't start with a dash). But note that GOption cannot reliably determine whether a non-option belongs to a preceding unknown option. - + - a #GOptionContext + a #GOptionContext - %TRUE to ignore unknown options, %FALSE to produce + %TRUE to ignore unknown options, %FALSE to produce an error when unknown options are met - Sets a #GOptionGroup as main group of the @context. + Sets a #GOptionGroup as main group of the @context. This has the same effect as calling g_option_context_add_group(), the only difference is that the options in the main group are treated differently when generating `--help` output. - + - a #GOptionContext + a #GOptionContext - the group to set as main group + the group to set as main group - Sets strict POSIX mode. + Sets strict POSIX mode. By default, this mode is disabled. @@ -15855,46 +17154,46 @@ options up to the verb name while leaving the remaining options to be parsed by the relevant subcommand (which can be determined by examining the verb name, which should be present in argv[1] after parsing). - + - a #GOptionContext + a #GOptionContext - the new value + the new value - Adds a string to be displayed in `--help` output before the list + Adds a string to be displayed in `--help` output before the list of options. This is typically a summary of the program functionality. Note that the summary is translated (see g_option_context_set_translate_func() and g_option_context_set_translation_domain()). - + - a #GOptionContext + a #GOptionContext - a string to be shown in `--help` output + a string to be shown in `--help` output before the list of options, or %NULL - Sets the function which is used to translate the contexts + Sets the function which is used to translate the contexts user-visible strings, for `--help` output. If @func is %NULL, strings are not translated. @@ -15905,49 +17204,49 @@ the summary (see g_option_context_set_summary()) and the description If you are using gettext(), you only need to set the translation domain, see g_option_context_set_translation_domain(). - + - a #GOptionContext + a #GOptionContext - the #GTranslateFunc, or %NULL + the #GTranslateFunc, or %NULL - user data to pass to @func, or %NULL + user data to pass to @func, or %NULL - a function which gets called to free @data, or %NULL + a function which gets called to free @data, or %NULL - A convenience function to use gettext() for translating + A convenience function to use gettext() for translating user-visible strings. - + - a #GOptionContext + a #GOptionContext - the domain to use + the domain to use - Creates a new option context. + Creates a new option context. The @parameter_string can serve multiple purposes. It can be used to add descriptions for "rest" arguments, which are not parsed by @@ -15966,15 +17265,15 @@ below the usage line, use g_option_context_set_summary(). Note that the @parameter_string is translated using the function set with g_option_context_set_translate_func(), so it should normally be passed untranslated. - + - a newly created #GOptionContext, which must be + a newly created #GOptionContext, which must be freed with g_option_context_free() after use. - a string which is displayed in + a string which is displayed in the first line of `--help` output, after the usage summary `programname [OPTION...]` @@ -15983,12 +17282,12 @@ it should normally be passed untranslated. - A GOptionEntry struct defines a single option. To have an effect, they + A GOptionEntry struct defines a single option. To have an effect, they must be added to a #GOptionGroup with g_option_context_add_main_entries() or g_option_group_add_entries(). - + - The long name of an option can be used to specify it + The long name of an option can be used to specify it in a commandline as `--long_name`. Every option must have a long name. To resolve conflicts if multiple option groups contain the same long name, it is also possible to specify the option as @@ -15996,22 +17295,22 @@ or g_option_group_add_entries(). - If an option has a short name, it can be specified + If an option has a short name, it can be specified `-short_name` in a commandline. @short_name must be a printable ASCII character different from '-', or zero if the option has no short name. - Flags from #GOptionFlags + Flags from #GOptionFlags - The type of the option, as a #GOptionArg + The type of the option, as a #GOptionArg - If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data + If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data must point to a #GOptionArgFunc callback function, which will be called to handle the extra argument. Otherwise, @arg_data is a pointer to a location to store the value, the required type of @@ -16031,13 +17330,13 @@ or g_option_group_add_entries(). - the description for the option in `--help` + the description for the option in `--help` output. The @description is translated using the @translate_func of the group, see g_option_group_set_translation_domain(). - The placeholder to use for the extra argument parsed + The placeholder to use for the extra argument parsed by the option in `--help` output. The @arg_description is translated using the @translate_func of the group, see g_option_group_set_translation_domain(). @@ -16045,37 +17344,37 @@ or g_option_group_add_entries(). - Error codes returned by option parsing. - + Error codes returned by option parsing. + - An option was not known to the parser. + An option was not known to the parser. This error will only be reported, if the parser hasn't been instructed to ignore unknown options, see g_option_context_set_ignore_unknown_options(). - A value couldn't be parsed. + A value couldn't be parsed. - A #GOptionArgFunc callback failed. + A #GOptionArgFunc callback failed. - The type of function to be used as callback when a parse error occurs. - + The type of function to be used as callback when a parse error occurs. + - The active #GOptionContext + The active #GOptionContext - The group to which the function belongs + The group to which the function belongs - User data added to the #GOptionGroup containing the option when it + User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() @@ -16133,249 +17432,249 @@ getting a `GOptionGroup` holding their options, which the application can then add to its #GOptionContext. - Creates a new #GOptionGroup. - + Creates a new #GOptionGroup. + - a newly created option group. It should be added + a newly created option group. It should be added to a #GOptionContext or freed with g_option_group_unref(). - the name for the option group, this is used to provide + the name for the option group, this is used to provide help for the options in this group with `--help-`@name - a description for this group to be shown in + a description for this group to be shown in `--help`. This string is translated using the translation domain or translation function of the group - a description for the `--help-`@name option. + a description for the `--help-`@name option. This string is translated using the translation domain or translation function of the group - user data that will be passed to the pre- and post-parse hooks, + user data that will be passed to the pre- and post-parse hooks, the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL - a function that will be called to free @user_data, or %NULL + a function that will be called to free @user_data, or %NULL - Adds the options specified in @entries to @group. - + Adds the options specified in @entries to @group. + - a #GOptionGroup + a #GOptionGroup - a %NULL-terminated array of #GOptionEntrys + a %NULL-terminated array of #GOptionEntrys - Frees a #GOptionGroup. Note that you must not free groups + Frees a #GOptionGroup. Note that you must not free groups which have been added to a #GOptionContext. Use g_option_group_unref() instead. - + - a #GOptionGroup + a #GOptionGroup - Increments the reference count of @group by one. - + Increments the reference count of @group by one. + - a #GOptionGroup + a #GOptionGroup - a #GOptionGroup + a #GOptionGroup - Associates a function with @group which will be called + Associates a function with @group which will be called from g_option_context_parse() when an error occurs. Note that the user data to be passed to @error_func can be specified when constructing the group with g_option_group_new(). - + - a #GOptionGroup + a #GOptionGroup - a function to call when an error occurs + a function to call when an error occurs - Associates two functions with @group which will be called + Associates two functions with @group which will be called from g_option_context_parse() before the first option is parsed and after the last option has been parsed, respectively. Note that the user data to be passed to @pre_parse_func and @post_parse_func can be specified when constructing the group with g_option_group_new(). - + - a #GOptionGroup + a #GOptionGroup - a function to call before parsing, or %NULL + a function to call before parsing, or %NULL - a function to call after parsing, or %NULL + a function to call after parsing, or %NULL - Sets the function which is used to translate user-visible strings, + Sets the function which is used to translate user-visible strings, for `--help` output. Different groups can use different #GTranslateFuncs. If @func is %NULL, strings are not translated. If you are using gettext(), you only need to set the translation domain, see g_option_group_set_translation_domain(). - + - a #GOptionGroup + a #GOptionGroup - the #GTranslateFunc, or %NULL + the #GTranslateFunc, or %NULL - user data to pass to @func, or %NULL + user data to pass to @func, or %NULL - a function which gets called to free @data, or %NULL + a function which gets called to free @data, or %NULL - A convenience function to use gettext() for translating + A convenience function to use gettext() for translating user-visible strings. - + - a #GOptionGroup + a #GOptionGroup - the domain to use + the domain to use - Decrements the reference count of @group by one. + Decrements the reference count of @group by one. If the reference count drops to 0, the @group will be freed. and all memory allocated by the @group is released. - + - a #GOptionGroup + a #GOptionGroup - The type of function that can be called before and after parsing. - + The type of function that can be called before and after parsing. + - %TRUE if the function completed successfully, %FALSE if an error + %TRUE if the function completed successfully, %FALSE if an error occurred, in which case @error should be set with g_set_error() - The active #GOptionContext + The active #GOptionContext - The group to which the function belongs + The group to which the function belongs - User data added to the #GOptionGroup containing the option when it + User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() - Specifies one of the possible types of byte order + Specifies one of the possible types of byte order (currently unused). See #G_BYTE_ORDER. - + - The value of pi (ratio of circle's circumference to its diameter). - + The value of pi (ratio of circle's circumference to its diameter). + A format specifier that can be used in printf()-style format strings when printing a #GPid. - + - Pi divided by 2. - + Pi divided by 2. + - Pi divided by 4. - + Pi divided by 4. + @@ -16425,52 +17724,106 @@ It is not used within GLib or GTK+. + + A macro to assist with the static initialisation of a #GPrivate. + +This macro is useful for the case that a #GDestroyNotify function +should be associated with the key. This is needed when the key will be +used to point at memory that should be deallocated when the thread +exits. + +Additionally, the #GDestroyNotify will also be called on the previous +value stored in the key when g_private_replace() is used. + +If no #GDestroyNotify is needed, then use of this macro is not +required -- if the #GPrivate is declared in static scope then it will +be properly initialised by default (ie: to all zeros). See the +examples below. + +|[<!-- language="C" --> +static GPrivate name_key = G_PRIVATE_INIT (g_free); + +// return value should not be freed +const gchar * +get_local_name (void) +{ + return g_private_get (&name_key); +} + +void +set_local_name (const gchar *name) +{ + g_private_replace (&name_key, g_strdup (name)); +} + + +static GPrivate count_key; // no free function + +gint +get_local_count (void) +{ + return GPOINTER_TO_INT (g_private_get (&count_key)); +} + +void +set_local_count (gint count) +{ + g_private_set (&count_key, GINT_TO_POINTER (count)); +} +]| + + + + a #GDestroyNotify + + + A GPatternSpec struct is the 'compiled' form of a pattern. This structure is opaque and its fields cannot be accessed directly. - Compares two compiled pattern specs and returns whether they will + Compares two compiled pattern specs and returns whether they will match the same set of strings. - Whether the compiled patterns are equal + Whether the compiled patterns are equal - a #GPatternSpec + a #GPatternSpec - another #GPatternSpec + another #GPatternSpec - Frees the memory allocated for the #GPatternSpec. + Frees the memory allocated for the #GPatternSpec. - a #GPatternSpec + a #GPatternSpec - Compiles a pattern to a #GPatternSpec. + Compiles a pattern to a #GPatternSpec. - a newly-allocated #GPatternSpec + a newly-allocated #GPatternSpec - a zero-terminated UTF-8 encoded string + a zero-terminated UTF-8 encoded string @@ -16567,25 +17920,25 @@ be accessed via the g_private_ functions. - Returns the current value of the thread local variable @key. + Returns the current value of the thread local variable @key. If the value has not yet been set in this thread, %NULL is returned. Values are never copied between threads (when a new thread is created, for example). - the thread-local value + the thread-local value - a #GPrivate + a #GPrivate - Sets the thread local variable @key to have the value @value in the + Sets the thread local variable @key to have the value @value in the current thread. This function differs from g_private_set() in the following way: if @@ -16597,17 +17950,17 @@ the previous value was non-%NULL then the #GDestroyNotify handler for - a #GPrivate + a #GPrivate - the new value + the new value - Sets the thread local variable @key to have the value @value in the + Sets the thread local variable @key to have the value @value in the current thread. This function differs from g_private_replace() in the following way: @@ -16618,11 +17971,11 @@ the #GDestroyNotify for @key is not called on the old value. - a #GPrivate + a #GPrivate - the new value + the new value @@ -16641,58 +17994,164 @@ the #GDestroyNotify for @key is not called on the old value. - Adds a pointer to the end of the pointer array. The array will grow + Adds a pointer to the end of the pointer array. The array will grow in size automatically if necessary. - + - a #GPtrArray + a #GPtrArray - the pointer to add + the pointer to add + + Makes a full (deep) copy of a #GPtrArray. + +@func, as a #GCopyFunc, takes two arguments, the data to be copied +and a @user_data pointer. On common processor architectures, it's safe to +pass %NULL as @user_data if the copy function takes only one argument. You +may get compiler warnings from this though if compiling with GCC’s +`-Wcast-function-type` warning. + +If @func is %NULL, then only the pointers (and not what they are +pointing to) are copied to the new #GPtrArray. + +The copy of @array will have the same #GDestroyNotify for its elements as +@array. + + + a deep copy of the initial #GPtrArray. + + + + + + + #GPtrArray to duplicate + + + + + + a copy function used to copy every element in the array + + + + user data passed to the copy function @func, or %NULL + + + + + + Adds all pointers of @array to the end of the array @array_to_extend. +The array will grow in size automatically if needed. @array_to_extend is +modified in-place. + +@func, as a #GCopyFunc, takes two arguments, the data to be copied +and a @user_data pointer. On common processor architectures, it's safe to +pass %NULL as @user_data if the copy function takes only one argument. You +may get compiler warnings from this though if compiling with GCC’s +`-Wcast-function-type` warning. + +If @func is %NULL, then only the pointers (and not what they are +pointing to) are copied to the new #GPtrArray. + + + + + + + a #GPtrArray. + + + + + + a #GPtrArray to add to the end of @array_to_extend. + + + + + + a copy function used to copy every element in the array + + + + user data passed to the copy function @func, or %NULL + + + + + + Adds all the pointers in @array to the end of @array_to_extend, transferring +ownership of each element from @array to @array_to_extend and modifying +@array_to_extend in-place. @array is then freed. + +As with g_ptr_array_free(), @array will be destroyed if its reference count +is 1. If its reference count is higher, it will be decremented and the +length of @array set to zero. + + + + + + + a #GPtrArray. + + + + + + a #GPtrArray to add to the end of + @array_to_extend. + + + + + + - Checks whether @needle exists in @haystack. If the element is found, %TRUE is + Checks whether @needle exists in @haystack. If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned. This does pointer comparisons only. If you want to use more complex equality checks, such as string comparisons, use g_ptr_array_find_with_equal_func(). - + - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - pointer to look for + pointer to look for - return location for the index of + return location for the index of the element, if found - Checks whether @needle exists in @haystack, using the given @equal_func. + Checks whether @needle exists in @haystack, using the given @equal_func. If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of @@ -16701,61 +18160,61 @@ the first instance is returned. @equal_func is called with the element from the array as its first parameter, and @needle as its second parameter. If @equal_func is %NULL, pointer equality is used. - + - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - pointer to look for + pointer to look for - the function to call for each element, which should + the function to call for each element, which should return %TRUE when the desired element is found; or %NULL to use pointer equality - return location for the index of + return location for the index of the element, if found - Calls a function for each element of a #GPtrArray. @func must not + Calls a function for each element of a #GPtrArray. @func must not add elements to or remove elements from the array. - + - a #GPtrArray + a #GPtrArray - the function to call for each array element + the function to call for each array element - user data to pass to the function + user data to pass to the function - Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE + Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE it frees the memory block holding the elements as well. Pass %FALSE if you want to free the #GPtrArray wrapper but preserve the underlying array for use elsewhere. If the reference count of @array @@ -16769,12 +18228,190 @@ function has been set for @array. This function is not thread-safe. If using a #GPtrArray from multiple threads, use only the atomic g_ptr_array_ref() and g_ptr_array_unref() functions. - + - the pointer array if @free_seg is %FALSE, otherwise %NULL. + the pointer array if @free_seg is %FALSE, otherwise %NULL. The pointer array should be freed using g_free(). + + + a #GPtrArray + + + + + + if %TRUE the actual pointer array is freed as well + + + + + + Inserts an element into the pointer array at the given index. The +array will grow in size automatically if necessary. + + + + + + + a #GPtrArray + + + + + + the index to place the new element at, or -1 to append + + + + the pointer to add. + + + + + + Creates a new #GPtrArray with a reference count of 1. + + + the new #GPtrArray + + + + + + + Creates a new #GPtrArray with @reserved_size pointers preallocated +and a reference count of 1. This avoids frequent reallocation, if +you are going to add many pointers to the array. Note however that +the size of the array is still 0. It also set @element_free_func +for freeing each element when the array is destroyed either via +g_ptr_array_unref(), when g_ptr_array_free() is called with +@free_segment set to %TRUE or when removing elements. + + + A new #GPtrArray + + + + + + + number of pointers preallocated + + + + A function to free elements with + destroy @array or %NULL + + + + + + Creates a new #GPtrArray with a reference count of 1 and use +@element_free_func for freeing each element when the array is destroyed +either via g_ptr_array_unref(), when g_ptr_array_free() is called with +@free_segment set to %TRUE or when removing elements. + + + A new #GPtrArray + + + + + + + A function to free elements with + destroy @array or %NULL + + + + + + Atomically increments the reference count of @array by one. +This function is thread-safe and may be called from any thread. + + + The passed in #GPtrArray + + + + + + + a #GPtrArray + + + + + + + + Removes the first occurrence of the given pointer from the pointer +array. The following elements are moved down one place. If @array +has a non-%NULL #GDestroyNotify function it is called for the +removed element. + +It returns %TRUE if the pointer was removed, or %FALSE if the +pointer was not found. + + + %TRUE if the pointer is removed, %FALSE if the pointer + is not found in the array + + + + + a #GPtrArray + + + + + + the pointer to remove + + + + + + Removes the first occurrence of the given pointer from the pointer +array. The last element in the array is used to fill in the space, +so this function does not preserve the order of the array. But it +is faster than g_ptr_array_remove(). If @array has a non-%NULL +#GDestroyNotify function it is called for the removed element. + +It returns %TRUE if the pointer was removed, or %FALSE if the +pointer was not found. + + + %TRUE if the pointer was found in the array + + + + + a #GPtrArray + + + + + + the pointer to remove + + + + + + Removes the pointer at the given index from the pointer array. +The following elements are moved down one place. If @array has +a non-%NULL #GDestroyNotify function it is called for the removed +element. If so, the return value from this function will potentially point +to freed memory (depending on the #GDestroyNotify implementation). + + + the pointer which was removed + + a #GPtrArray @@ -16782,310 +18419,132 @@ functions. - - if %TRUE the actual pointer array is freed as well - - - - - - Inserts an element into the pointer array at the given index. The -array will grow in size automatically if necessary. - - - - - - - a #GPtrArray - - - - - the index to place the new element at, or -1 to append - - - - the pointer to add. - - - - - - Creates a new #GPtrArray with a reference count of 1. - - - the new #GPtrArray - - - - - - - Creates a new #GPtrArray with @reserved_size pointers preallocated -and a reference count of 1. This avoids frequent reallocation, if -you are going to add many pointers to the array. Note however that -the size of the array is still 0. It also set @element_free_func -for freeing each element when the array is destroyed either via -g_ptr_array_unref(), when g_ptr_array_free() is called with -@free_segment set to %TRUE or when removing elements. - - - A new #GPtrArray - - - - - - - number of pointers preallocated - - - - A function to free elements with - destroy @array or %NULL - - - - - - Creates a new #GPtrArray with a reference count of 1 and use -@element_free_func for freeing each element when the array is destroyed -either via g_ptr_array_unref(), when g_ptr_array_free() is called with -@free_segment set to %TRUE or when removing elements. - - - A new #GPtrArray - - - - - - - A function to free elements with - destroy @array or %NULL - - - - - - Atomically increments the reference count of @array by one. -This function is thread-safe and may be called from any thread. - - - The passed in #GPtrArray - - - - - - - a #GPtrArray - - - - - - - - Removes the first occurrence of the given pointer from the pointer -array. The following elements are moved down one place. If @array -has a non-%NULL #GDestroyNotify function it is called for the -removed element. - -It returns %TRUE if the pointer was removed, or %FALSE if the -pointer was not found. - - - %TRUE if the pointer is removed, %FALSE if the pointer - is not found in the array - - - - - a #GPtrArray - - - - - - the pointer to remove - - - - - - Removes the first occurrence of the given pointer from the pointer -array. The last element in the array is used to fill in the space, -so this function does not preserve the order of the array. But it -is faster than g_ptr_array_remove(). If @array has a non-%NULL -#GDestroyNotify function it is called for the removed element. - -It returns %TRUE if the pointer was removed, or %FALSE if the -pointer was not found. - - - %TRUE if the pointer was found in the array - - - - - a #GPtrArray - - - - - - the pointer to remove - - - - - - Removes the pointer at the given index from the pointer array. -The following elements are moved down one place. If @array has -a non-%NULL #GDestroyNotify function it is called for the removed -element. If so, the return value from this function will potentially point -to freed memory (depending on the #GDestroyNotify implementation). - - - the pointer which was removed - - - - - a #GPtrArray - - - - - - the index of the pointer to remove + the index of the pointer to remove - Removes the pointer at the given index from the pointer array. + Removes the pointer at the given index from the pointer array. The last element in the array is used to fill in the space, so this function does not preserve the order of the array. But it is faster than g_ptr_array_remove_index(). If @array has a non-%NULL #GDestroyNotify function it is called for the removed element. If so, the return value from this function will potentially point to freed memory (depending on the #GDestroyNotify implementation). - + - the pointer which was removed + the pointer which was removed - a #GPtrArray + a #GPtrArray - the index of the pointer to remove + the index of the pointer to remove - Removes the given number of pointers starting at the given index + Removes the given number of pointers starting at the given index from a #GPtrArray. The following elements are moved to close the gap. If @array has a non-%NULL #GDestroyNotify function it is called for the removed elements. - + - the @array + the @array - a @GPtrArray + a @GPtrArray - the index of the first pointer to remove + the index of the first pointer to remove - the number of pointers to remove + the number of pointers to remove - Sets a function for freeing each element when @array is destroyed + Sets a function for freeing each element when @array is destroyed either via g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment set to %TRUE or when removing elements. - + - A #GPtrArray + A #GPtrArray - A function to free elements with + A function to free elements with destroy @array or %NULL - Sets the size of the array. When making the array larger, + Sets the size of the array. When making the array larger, newly-added elements will be set to %NULL. When making it smaller, if @array has a non-%NULL #GDestroyNotify function then it will be called for the removed elements. - + - a #GPtrArray + a #GPtrArray - the new length of the pointer array + the new length of the pointer array - Creates a new #GPtrArray with @reserved_size pointers preallocated + Creates a new #GPtrArray with @reserved_size pointers preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many pointers to the array. Note however that the size of the array is still 0. - + - the new #GPtrArray + the new #GPtrArray - number of pointers preallocated + number of pointers preallocated - Sorts the array, using @compare_func which should be a qsort()-style + Sorts the array, using @compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater than zero if irst arg is greater than second arg). @@ -17095,25 +18554,25 @@ take the pointers from the array as arguments, it takes pointers to the pointers in the array. This is guaranteed to be a stable sort since version 2.32. - + - a #GPtrArray + a #GPtrArray - comparison function + comparison function - Like g_ptr_array_sort(), but the comparison function has an extra + Like g_ptr_array_sort(), but the comparison function has an extra user data argument. Note that the comparison function for g_ptr_array_sort_with_data() @@ -17121,87 +18580,87 @@ doesn't take the pointers from the array as arguments, it takes pointers to the pointers in the array. This is guaranteed to be a stable sort since version 2.32. - + - a #GPtrArray + a #GPtrArray - comparison function + comparison function - data to pass to @compare_func + data to pass to @compare_func - Removes the pointer at the given index from the pointer array. + Removes the pointer at the given index from the pointer array. The following elements are moved down one place. The #GDestroyNotify for @array is *not* called on the removed element; ownership is transferred to the caller of this function. - + - the pointer which was removed + the pointer which was removed - a #GPtrArray + a #GPtrArray - the index of the pointer to steal + the index of the pointer to steal - Removes the pointer at the given index from the pointer array. + Removes the pointer at the given index from the pointer array. The last element in the array is used to fill in the space, so this function does not preserve the order of the array. But it is faster than g_ptr_array_steal_index(). The #GDestroyNotify for @array is *not* called on the removed element; ownership is transferred to the caller of this function. - + - the pointer which was removed + the pointer which was removed - a #GPtrArray + a #GPtrArray - the index of the pointer to steal + the index of the pointer to steal - Atomically decrements the reference count of @array by one. If the + Atomically decrements the reference count of @array by one. If the reference count drops to 0, the effect is the same as calling g_ptr_array_free() with @free_segment set to %TRUE. This function is thread-safe and may be called from any thread. - + - A #GPtrArray + A #GPtrArray @@ -17230,7 +18689,7 @@ is thread-safe and may be called from any thread. - Removes all the elements in @queue. If queue elements contain + Removes all the elements in @queue. If queue elements contain dynamically-allocated memory, they should be freed first. @@ -17238,13 +18697,13 @@ dynamically-allocated memory, they should be freed first. - a #GQueue + a #GQueue - Convenience method, which frees all the memory used by a #GQueue, + Convenience method, which frees all the memory used by a #GQueue, and calls the provided @free_func on each item in the #GQueue. @@ -17252,46 +18711,46 @@ and calls the provided @free_func on each item in the #GQueue. - a pointer to a #GQueue + a pointer to a #GQueue - the function to be called to free memory allocated + the function to be called to free memory allocated - Copies a @queue. Note that is a shallow copy. If the elements in the + Copies a @queue. Note that is a shallow copy. If the elements in the queue consist of pointers to data, the pointers are copied, but the actual data is not. - a copy of @queue + a copy of @queue - a #GQueue + a #GQueue - Removes @link_ from @queue and frees it. + Removes @link_ from @queue and frees it. @link_ must be part of @queue. - + - a #GQueue + a #GQueue - a #GList link that must be part of @queue + a #GList link that must be part of @queue @@ -17299,56 +18758,56 @@ actual data is not. - Finds the first link in @queue which contains @data. + Finds the first link in @queue which contains @data. - the first link in @queue which contains @data + the first link in @queue which contains @data - a #GQueue + a #GQueue - data to find + data to find - Finds an element in a #GQueue, using a supplied function to find the + Finds an element in a #GQueue, using a supplied function to find the desired element. It iterates over the queue, calling the given function which should return 0 when the desired element is found. The function takes two gconstpointer arguments, the #GQueue element's data as the first argument and the given user data as the second argument. - the found link, or %NULL if it wasn't found + the found link, or %NULL if it wasn't found - a #GQueue + a #GQueue - user data passed to @func + user data passed to @func - a #GCompareFunc to call for each element. It should return 0 + a #GCompareFunc to call for each element. It should return 0 when the desired element is found - Calls @func for each element in the queue passing @user_data to the + Calls @func for each element in the queue passing @user_data to the function. It is safe for @func to remove the element from @queue, but it must @@ -17359,21 +18818,21 @@ not modify any part of the queue after that element. - a #GQueue + a #GQueue - the function to call for each element's data + the function to call for each element's data - user data to pass to @func + user data to pass to @func - Frees the memory allocated for the #GQueue. Only call this function + Frees the memory allocated for the #GQueue. Only call this function if @queue was created with g_queue_new(). If queue elements contain dynamically-allocated memory, they should be freed first. @@ -17385,13 +18844,13 @@ either use g_queue_free_full() or free them manually first. - a #GQueue + a #GQueue - Convenience method, which frees all the memory used by a #GQueue, + Convenience method, which frees all the memory used by a #GQueue, and calls the specified destroy function on every element's data. @free_func should not modify the queue (eg, by removing the freed @@ -17402,50 +18861,50 @@ element from it). - a pointer to a #GQueue + a pointer to a #GQueue - the function to be called to free each element's data + the function to be called to free each element's data - Returns the number of items in @queue. + Returns the number of items in @queue. - the number of items in @queue + the number of items in @queue - a #GQueue + a #GQueue - Returns the position of the first element in @queue which contains @data. + Returns the position of the first element in @queue which contains @data. - the position of the first element in @queue which + the position of the first element in @queue which contains @data, or -1 if no element in @queue contains @data - a #GQueue + a #GQueue - the data to find + the data to find - A statically-allocated #GQueue must be initialized with this function + A statically-allocated #GQueue must be initialized with this function before it can be used. Alternatively you can initialize it with #G_QUEUE_INIT. It is not necessary to initialize queues created with g_queue_new(). @@ -17455,40 +18914,68 @@ g_queue_new(). - an uninitialized #GQueue + an uninitialized #GQueue - Inserts @data into @queue after @sibling. + Inserts @data into @queue after @sibling. @sibling must be part of @queue. Since GLib 2.44 a %NULL sibling pushes the data at the head of the queue. - + - a #GQueue + a #GQueue - a #GList link that must be part of @queue, or %NULL to + a #GList link that must be part of @queue, or %NULL to push at the head of the queue. - the data to insert + the data to insert + + Inserts @link_ into @queue after @sibling. + +@sibling must be part of @queue. + + + + + + + a #GQueue + + + + a #GList link that must be part of @queue, or %NULL to + push at the head of the queue. + + + + + + a #GList link to insert which must not be part of any other list. + + + + + + - Inserts @data into @queue before @sibling. + Inserts @data into @queue before @sibling. @sibling must be part of @queue. Since GLib 2.44 a %NULL sibling pushes the data at the tail of the queue. @@ -17498,39 +18985,67 @@ data at the tail of the queue. - a #GQueue + a #GQueue - a #GList link that must be part of @queue, or %NULL to + a #GList link that must be part of @queue, or %NULL to push at the tail of the queue. - the data to insert + the data to insert - - Inserts @data into @queue using @func to determine the new position. - + + Inserts @link_ into @queue before @sibling. + +@sibling must be part of @queue. + - a #GQueue + a #GQueue + + + + a #GList link that must be part of @queue, or %NULL to + push at the tail of the queue. + + + + + + a #GList link to insert which must not be part of any other list. + + + + + + + + Inserts @data into @queue using @func to determine the new position. + + + + + + + a #GQueue - the data to insert + the data to insert - the #GCompareDataFunc used to compare elements in the queue. It is + the #GCompareDataFunc used to compare elements in the queue. It is called with two elements of the @queue and @user_data. It should return 0 if the elements are equal, a negative value if the first element comes before the second, and a positive value if the second @@ -17538,40 +19053,40 @@ data at the tail of the queue. - user data passed to @func + user data passed to @func - Returns %TRUE if the queue is empty. + Returns %TRUE if the queue is empty. - %TRUE if the queue is empty + %TRUE if the queue is empty - a #GQueue. + a #GQueue. - Returns the position of @link_ in @queue. - + Returns the position of @link_ in @queue. + - the position of @link_, or -1 if the link is + the position of @link_, or -1 if the link is not part of @queue - a #GQueue + a #GQueue - a #GList link + a #GList link @@ -17579,60 +19094,60 @@ data at the tail of the queue. - Returns the first element of the queue. + Returns the first element of the queue. - the data of the first element in the queue, or %NULL + the data of the first element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - Returns the first link in @queue. - + Returns the first link in @queue. + - the first link in @queue, or %NULL if @queue is empty + the first link in @queue, or %NULL if @queue is empty - a #GQueue + a #GQueue - Returns the @n'th element of @queue. + Returns the @n'th element of @queue. - the data for the @n'th element of @queue, + the data for the @n'th element of @queue, or %NULL if @n is off the end of @queue - a #GQueue + a #GQueue - the position of the element + the position of the element - Returns the link at the given position - + Returns the link at the given position + - the link at the @n'th position, or %NULL + the link at the @n'th position, or %NULL if @n is off the end of the list @@ -17640,66 +19155,66 @@ data at the tail of the queue. - a #GQueue + a #GQueue - the position of the link + the position of the link - Returns the last element of the queue. + Returns the last element of the queue. - the data of the last element in the queue, or %NULL + the data of the last element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - Returns the last link in @queue. - + Returns the last link in @queue. + - the last link in @queue, or %NULL if @queue is empty + the last link in @queue, or %NULL if @queue is empty - a #GQueue + a #GQueue - Removes the first element of the queue and returns its data. + Removes the first element of the queue and returns its data. - the data of the first element in the queue, or %NULL + the data of the first element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - Removes and returns the first element of the queue. - + Removes and returns the first element of the queue. + - the #GList element at the head of the queue, or %NULL + the #GList element at the head of the queue, or %NULL if the queue is empty @@ -17707,69 +19222,69 @@ data at the tail of the queue. - a #GQueue + a #GQueue - Removes the @n'th element of @queue and returns its data. + Removes the @n'th element of @queue and returns its data. - the element's data, or %NULL if @n is off the end of @queue + the element's data, or %NULL if @n is off the end of @queue - a #GQueue + a #GQueue - the position of the element + the position of the element - Removes and returns the link at the given position. - + Removes and returns the link at the given position. + - the @n'th link, or %NULL if @n is off the end of @queue + the @n'th link, or %NULL if @n is off the end of @queue - a #GQueue + a #GQueue - the link's position + the link's position - Removes the last element of the queue and returns its data. + Removes the last element of the queue and returns its data. - the data of the last element in the queue, or %NULL + the data of the last element in the queue, or %NULL if the queue is empty - a #GQueue + a #GQueue - Removes and returns the last element of the queue. - + Removes and returns the last element of the queue. + - the #GList element at the tail of the queue, or %NULL + the #GList element at the tail of the queue, or %NULL if the queue is empty @@ -17777,41 +19292,41 @@ data at the tail of the queue. - a #GQueue + a #GQueue - Adds a new element at the head of the queue. + Adds a new element at the head of the queue. - a #GQueue. + a #GQueue. - the data for the new element. + the data for the new element. - Adds a new element at the head of the queue. - + Adds a new element at the head of the queue. + - a #GQueue + a #GQueue - a single #GList element, not a list with more than one element + a single #GList element, not a list with more than one element @@ -17819,22 +19334,22 @@ data at the tail of the queue. - Inserts a new element into @queue at the given position. + Inserts a new element into @queue at the given position. - a #GQueue + a #GQueue - the data for the new element + the data for the new element - the position to insert the new element. If @n is negative or + the position to insert the new element. If @n is negative or larger than the number of elements in the @queue, the element is added to the end of the queue. @@ -17842,24 +19357,24 @@ data at the tail of the queue. - Inserts @link into @queue at the given position. - + Inserts @link into @queue at the given position. + - a #GQueue + a #GQueue - the position to insert the link. If this is negative or larger than + the position to insert the link. If this is negative or larger than the number of elements in @queue, the link is added to the end of @queue. - the link to add to @queue + the link to add to @queue @@ -17867,35 +19382,35 @@ data at the tail of the queue. - Adds a new element at the tail of the queue. + Adds a new element at the tail of the queue. - a #GQueue + a #GQueue - the data for the new element + the data for the new element - Adds a new element at the tail of the queue. - + Adds a new element at the tail of the queue. + - a #GQueue + a #GQueue - a single #GList element, not a list with more than one element + a single #GList element, not a list with more than one element @@ -17903,94 +19418,94 @@ data at the tail of the queue. - Removes the first element in @queue that contains @data. + Removes the first element in @queue that contains @data. - %TRUE if @data was found and removed from @queue + %TRUE if @data was found and removed from @queue - a #GQueue + a #GQueue - the data to remove + the data to remove - Remove all elements whose data equals @data from @queue. + Remove all elements whose data equals @data from @queue. - the number of elements removed from @queue + the number of elements removed from @queue - a #GQueue + a #GQueue - the data to remove + the data to remove - Reverses the order of the items in @queue. + Reverses the order of the items in @queue. - a #GQueue + a #GQueue - Sorts @queue using @compare_func. + Sorts @queue using @compare_func. - a #GQueue + a #GQueue - the #GCompareDataFunc used to sort @queue. This function + the #GCompareDataFunc used to sort @queue. This function is passed two elements of the queue and should return 0 if they are equal, a negative value if the first comes before the second, and a positive value if the second comes before the first. - user data passed to @compare_func + user data passed to @compare_func - Unlinks @link_ so that it will no longer be part of @queue. + Unlinks @link_ so that it will no longer be part of @queue. The link is not freed. @link_ must be part of @queue. - + - a #GQueue + a #GQueue - a #GList link that must be part of @queue + a #GList link that must be part of @queue @@ -17998,10 +19513,10 @@ The link is not freed. - Creates a new #GQueue. + Creates a new #GQueue. - a newly allocated #GQueue + a newly allocated #GQueue @@ -18080,7 +19595,7 @@ A GRWLock should only be accessed with the g_rw_lock_ functions. - Frees the resources allocated to a lock with g_rw_lock_init(). + Frees the resources allocated to a lock with g_rw_lock_init(). This function should not be used with a #GRWLock that has been statically allocated. @@ -18095,13 +19610,13 @@ Sine: 2.32 - an initialized #GRWLock + an initialized #GRWLock - Initializes a #GRWLock so that it can be used. + Initializes a #GRWLock so that it can be used. This function is useful to initialize a lock that has been allocated on the stack, or as part of a larger structure. It is not @@ -18131,15 +19646,17 @@ to undefined behaviour. - an uninitialized #GRWLock + an uninitialized #GRWLock - Obtain a read lock on @rw_lock. If another thread currently holds -the write lock on @rw_lock or blocks waiting for it, the current -thread will block. Read locks can be taken recursively. + Obtain a read lock on @rw_lock. If another thread currently holds +the write lock on @rw_lock, the current thread will block. If another thread +does not hold the write lock, but is waiting for it, it is implementation +defined whether the reader or writer will block. Read locks can be taken +recursively. It is implementation-defined how many threads are allowed to hold read locks on the same lock simultaneously. If the limit is hit, @@ -18150,29 +19667,29 @@ or if a deadlock is detected, a critical warning will be emitted. - a #GRWLock + a #GRWLock - Tries to obtain a read lock on @rw_lock and returns %TRUE if + Tries to obtain a read lock on @rw_lock and returns %TRUE if the read lock was successfully obtained. Otherwise it returns %FALSE. - %TRUE if @rw_lock could be locked + %TRUE if @rw_lock could be locked - a #GRWLock + a #GRWLock - Release a read lock on @rw_lock. + Release a read lock on @rw_lock. Calling g_rw_lock_reader_unlock() on a lock that is not held by the current thread leads to undefined behaviour. @@ -18182,13 +19699,13 @@ by the current thread leads to undefined behaviour. - a #GRWLock + a #GRWLock - Obtain a write lock on @rw_lock. If any thread already holds + Obtain a write lock on @rw_lock. If any thread already holds a read or write lock on @rw_lock, the current thread will block until all other threads have dropped their locks on @rw_lock. @@ -18197,29 +19714,29 @@ until all other threads have dropped their locks on @rw_lock. - a #GRWLock + a #GRWLock - Tries to obtain a write lock on @rw_lock. If any other thread holds + Tries to obtain a write lock on @rw_lock. If any other thread holds a read or write lock on @rw_lock, it immediately returns %FALSE. Otherwise it locks @rw_lock and returns %TRUE. - %TRUE if @rw_lock could be locked + %TRUE if @rw_lock could be locked - a #GRWLock + a #GRWLock - Release a write lock on @rw_lock. + Release a write lock on @rw_lock. Calling g_rw_lock_writer_unlock() on a lock that is not held by the current thread leads to undefined behaviour. @@ -18229,7 +19746,7 @@ by the current thread leads to undefined behaviour. - a #GRWLock + a #GRWLock @@ -18240,129 +19757,129 @@ by the current thread leads to undefined behaviour. accessed through the g_rand_* functions. - Copies a #GRand into a new one with the same exact state as before. + Copies a #GRand into a new one with the same exact state as before. This way you can take a snapshot of the random number generator for replaying later. - the new #GRand + the new #GRand - a #GRand + a #GRand - Returns the next random #gdouble from @rand_ equally distributed over + Returns the next random #gdouble from @rand_ equally distributed over the range [0..1). - a random number + a random number - a #GRand + a #GRand - Returns the next random #gdouble from @rand_ equally distributed over + Returns the next random #gdouble from @rand_ equally distributed over the range [@begin..@end). - a random number + a random number - a #GRand + a #GRand - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - Frees the memory allocated for the #GRand. + Frees the memory allocated for the #GRand. - a #GRand + a #GRand - Returns the next random #guint32 from @rand_ equally distributed over + Returns the next random #guint32 from @rand_ equally distributed over the range [0..2^32-1]. - a random number + a random number - a #GRand + a #GRand - Returns the next random #gint32 from @rand_ equally distributed over + Returns the next random #gint32 from @rand_ equally distributed over the range [@begin..@end-1]. - a random number + a random number - a #GRand + a #GRand - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - Sets the seed for the random number generator #GRand to @seed. + Sets the seed for the random number generator #GRand to @seed. - a #GRand + a #GRand - a value to reinitialize the random number generator + a value to reinitialize the random number generator - Initializes the random number generator by an array of longs. + Initializes the random number generator by an array of longs. Array can be of arbitrary size, though only the first 624 values are taken. This function is useful if you have many low entropy seeds, or if you require more then 32 bits of actual entropy for @@ -18373,59 +19890,59 @@ your application. - a #GRand + a #GRand - array to initialize with + array to initialize with - length of array + length of array - Creates a new random number generator initialized with a seed taken + Creates a new random number generator initialized with a seed taken either from `/dev/urandom` (if existing) or from the current time (as a fallback). On Windows, the seed is taken from rand_s(). - the new #GRand + the new #GRand - Creates a new random number generator initialized with @seed. + Creates a new random number generator initialized with @seed. - the new #GRand + the new #GRand - a value to initialize the random number generator + a value to initialize the random number generator - Creates a new random number generator initialized with @seed. + Creates a new random number generator initialized with @seed. - the new #GRand + the new #GRand - an array of seeds to initialize the random number generator + an array of seeds to initialize the random number generator - an array of seeds to initialize the random number + an array of seeds to initialize the random number generator @@ -18455,7 +19972,7 @@ g_rec_mutex_ functions. - Frees the resources allocated to a recursive mutex with + Frees the resources allocated to a recursive mutex with g_rec_mutex_init(). This function should not be used with a #GRecMutex that has been @@ -18471,13 +19988,13 @@ Sine: 2.32 - an initialized #GRecMutex + an initialized #GRecMutex - Initializes a #GRecMutex so that it can be used. + Initializes a #GRecMutex so that it can be used. This function is useful to initialize a recursive mutex that has been allocated on the stack, or as part of a larger @@ -18509,13 +20026,13 @@ is no longer needed, use g_rec_mutex_clear(). - an uninitialized #GRecMutex + an uninitialized #GRecMutex - Locks @rec_mutex. If @rec_mutex is already locked by another + Locks @rec_mutex. If @rec_mutex is already locked by another thread, the current thread will block until @rec_mutex is unlocked by the other thread. If @rec_mutex is already locked by the current thread, the 'lock count' of @rec_mutex is increased. @@ -18527,29 +20044,29 @@ as many times as it has been locked. - a #GRecMutex + a #GRecMutex - Tries to lock @rec_mutex. If @rec_mutex is already locked + Tries to lock @rec_mutex. If @rec_mutex is already locked by another thread, it immediately returns %FALSE. Otherwise it locks @rec_mutex and returns %TRUE. - %TRUE if @rec_mutex could be locked + %TRUE if @rec_mutex could be locked - a #GRecMutex + a #GRecMutex - Unlocks @rec_mutex. If another thread is blocked in a + Unlocks @rec_mutex. If another thread is blocked in a g_rec_mutex_lock() call for @rec_mutex, it will become unblocked and can lock @rec_mutex itself. @@ -18561,14 +20078,14 @@ locked by the current thread leads to undefined behaviour. - a #GRecMutex + a #GRecMutex - The g_regex_*() functions implement regular + The g_regex_*() functions implement regular expression pattern matching using syntax and semantics similar to Perl regular expression. @@ -18635,157 +20152,157 @@ the excellent library written by Philip Hazel. - Compiles the regular expression to an internal form, and does + Compiles the regular expression to an internal form, and does the initial setup of the #GRegex structure. - a #GRegex structure or %NULL if an error occured. Call + a #GRegex structure or %NULL if an error occured. Call g_regex_unref() when you are done with it - the regular expression + the regular expression - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options for the regular expression, or 0 + match options for the regular expression, or 0 - Returns the number of capturing subpatterns in the pattern. + Returns the number of capturing subpatterns in the pattern. - the number of capturing subpatterns + the number of capturing subpatterns - a #GRegex + a #GRegex - Returns the compile options that @regex was created with. + 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. - flags from #GRegexCompileFlags + flags from #GRegexCompileFlags - a #GRegex + a #GRegex - Checks whether the pattern contains explicit CR or LF references. + Checks whether the pattern contains explicit CR or LF references. - %TRUE if the pattern contains explicit CR or LF references + %TRUE if the pattern contains explicit CR or LF references - a #GRegex structure + a #GRegex structure - Returns the match options that @regex was created with. + Returns the match options that @regex was created with. - flags from #GRegexMatchFlags + flags from #GRegexMatchFlags - a #GRegex + a #GRegex - Returns the number of the highest back reference + Returns the number of the highest back reference in the pattern, or 0 if the pattern does not contain back references. - the number of the highest back reference + the number of the highest back reference - a #GRegex + a #GRegex - Gets the number of characters in the longest lookbehind assertion in the + Gets the number of characters in the longest lookbehind assertion in the pattern. This information is useful when doing multi-segment matching using the partial matching facilities. - the number of characters in the longest lookbehind assertion. + the number of characters in the longest lookbehind assertion. - a #GRegex structure + a #GRegex structure - Gets the pattern string associated with @regex, i.e. a copy of + Gets the pattern string associated with @regex, i.e. a copy of the string passed to g_regex_new(). - the pattern of @regex + the pattern of @regex - a #GRegex structure + a #GRegex structure - Retrieves the number of the subexpression named @name. + Retrieves the number of the subexpression named @name. - The number of the subexpression or -1 if @name + The number of the subexpression or -1 if @name does not exists - #GRegex structure + #GRegex structure - name of the subexpression + name of the subexpression - Scans for a match in @string for the pattern in @regex. + Scans for a match in @string for the pattern in @regex. The @match_options are combined with the match options specified when the @regex structure was created, letting you have more flexibility in reusing #GRegex structures. @@ -18827,31 +20344,31 @@ you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - match options + match options - pointer to location where to store + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - Using the standard algorithm for regular expression matching only + Using the standard algorithm for regular expression matching only the longest match in the string is retrieved. This function uses a different algorithm so it can retrieve all the possible matches. For more documentation see g_regex_match_all_full(). @@ -18867,31 +20384,31 @@ you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - match options + match options - pointer to location where to store + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - Using the standard algorithm for regular expression matching only + Using the standard algorithm for regular expression matching only the longest match in the @string is retrieved, it is not possible to obtain all the available matches. For instance matching "<a> <b> <c>" against the pattern "<.*>" @@ -18931,41 +20448,41 @@ you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined. - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - match options + match options - pointer to location where to store + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - Scans for a match in @string for the pattern in @regex. + Scans for a match in @string for the pattern in @regex. The @match_options are combined with the match options specified when the @regex structure was created, letting you have more flexibility in reusing #GRegex structures. @@ -19018,55 +20535,55 @@ print_uppercase_words (const gchar *string) ]| - %TRUE is the string matched, %FALSE otherwise + %TRUE is the string matched, %FALSE otherwise - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - the string to scan for matches + the string to scan for matches - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - match options + match options - pointer to location where to store + pointer to location where to store the #GMatchInfo, or %NULL if you do not need it - Increases reference count of @regex by 1. + Increases reference count of @regex by 1. - @regex + @regex - a #GRegex + a #GRegex - Replaces all occurrences of the pattern in @regex with the + Replaces all occurrences of the pattern in @regex with the replacement text. Backreferences of the form '\number' or '\g<number>' in the replacement text are interpolated by the number-th captured subexpression of the match, '\g<name>' refers @@ -19094,40 +20611,40 @@ string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b". - a newly allocated string containing the replacements + a newly allocated string containing the replacements - a #GRegex structure + a #GRegex structure - the string to perform matches against + the string to perform matches against - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - text to replace each match with + text to replace each match with - options for the match + options for the match - Replaces occurrences of the pattern in regex with the output of + Replaces occurrences of the pattern in regex with the output of @eval for that occurrence. Setting @start_position differs from just passing over a shortened @@ -19174,44 +20691,44 @@ g_hash_table_destroy (h); ]| - a newly allocated string containing the replacements + a newly allocated string containing the replacements - a #GRegex structure from g_regex_new() + a #GRegex structure from g_regex_new() - string to perform matches against + string to perform matches against - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - options for the match + options for the match - a function to call for each match + a function to call for each match - user data to pass to the function + user data to pass to the function - Replaces all occurrences of the pattern in @regex with the + Replaces all occurrences of the pattern in @regex with the replacement text. @replacement is replaced literally, to include backreferences use g_regex_replace(). @@ -19221,40 +20738,40 @@ case of a pattern that begins with any kind of lookbehind assertion, such as "\b". - a newly allocated string containing the replacements + a newly allocated string containing the replacements - a #GRegex structure + a #GRegex structure - the string to perform matches against + the string to perform matches against - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - text to replace each match with + text to replace each match with - options for the match + options for the match - Breaks the string on the pattern, and returns an array of the tokens. + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first @@ -19273,7 +20790,7 @@ For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c". - a %NULL-terminated gchar ** array. Free + a %NULL-terminated gchar ** array. Free it using g_strfreev() @@ -19281,21 +20798,21 @@ it using g_strfreev() - a #GRegex structure + a #GRegex structure - the string to split with the pattern + the string to split with the pattern - match time option flags + match time option flags - Breaks the string on the pattern, and returns an array of the tokens. + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first @@ -19318,7 +20835,7 @@ string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b". - a %NULL-terminated gchar ** array. Free + a %NULL-terminated gchar ** array. Free it using g_strfreev() @@ -19326,36 +20843,36 @@ it using g_strfreev() - a #GRegex structure + a #GRegex structure - the string to split with the pattern + the string to split with the pattern - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - starting index of the string to match, in bytes + starting index of the string to match, in bytes - match time option flags + match time option flags - the maximum number of tokens to split @string into. + the maximum number of tokens to split @string into. If this is less than 1, the string is split completely - Decreases reference count of @regex by 1. When reference count drops + Decreases reference count of @regex by 1. When reference count drops to zero, it frees all the memory associated with the regex structure. @@ -19363,13 +20880,13 @@ to zero, it frees all the memory associated with the regex structure. - a #GRegex + a #GRegex - Checks whether @replacement is a valid replacement string + Checks whether @replacement is a valid replacement string (see g_regex_replace()), i.e. that all escape sequences in it are valid. @@ -19380,16 +20897,16 @@ about actual match, but '\0\1' (whole match followed by first subpattern) requires valid #GMatchInfo object. - whether @replacement is a valid replacement string + whether @replacement is a valid replacement string - the replacement string + the replacement string - location to store information about + location to store information about references in @replacement or %NULL @@ -19401,29 +20918,29 @@ subpattern) requires valid #GMatchInfo object. - Escapes the nul characters in @string to "\x00". It can be used + Escapes the nul characters in @string to "\x00". It can be used to compile a regex with embedded nul characters. For completeness, @length can be -1 for a nul-terminated string. In this case the output string will be of course equal to @string. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string + the length of @string - Escapes the special characters used for regular expressions + Escapes the special characters used for regular expressions in @string, for instance "a.b*c" becomes "a\.b\*c". This function is useful to dynamically generate regular expressions. @@ -19432,24 +20949,24 @@ in this case remember to specify the correct length of @string in @length. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - Scans for a match in @string for @pattern. + Scans for a match in @string for @pattern. This function is equivalent to g_regex_match() but it does not require to compile the pattern with g_regex_new(), avoiding some @@ -19461,30 +20978,30 @@ once, it's more efficient to compile the pattern once with g_regex_new() and then use g_regex_match(). - %TRUE if the string matched, %FALSE otherwise + %TRUE if the string matched, %FALSE otherwise - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 - Breaks the string on the pattern, and returns an array of + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the @@ -19513,7 +21030,7 @@ characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c". - a %NULL-terminated array of strings. Free + a %NULL-terminated array of strings. Free it using g_strfreev() @@ -19521,19 +21038,19 @@ it using g_strfreev() - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 @@ -19987,15 +21504,15 @@ to g_regex_replace_eval(), and it should append the replacement to - The search path separator character. + The search path separator character. This is ':' on UNIX machines and ';' under Windows. - + - The search path separator as a string. + The search path separator as a string. This is ":" on UNIX machines and ";" under Windows. - + @@ -20031,19 +21548,19 @@ list. - Allocates space for one #GSList element. It is called by the + Allocates space for one #GSList element. It is called by the g_slist_append(), g_slist_prepend(), g_slist_insert() and g_slist_insert_sorted() functions and so is rarely used on its own. - a pointer to the newly-allocated #GSList element. + a pointer to the newly-allocated #GSList element. - Adds a new element on to the end of the list. + Adds a new element on to the end of the list. The return value is the new start of the list, which may have changed, so make sure you store the new value. @@ -20067,44 +21584,44 @@ number_list = g_slist_append (number_list, GINT_TO_POINTER (14)); ]| - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - the data for the new element + the data for the new element - Adds the second #GSList onto the end of the first #GSList. + Adds the second #GSList onto the end of the first #GSList. Note that the elements of the second #GSList are not copied. They are used directly. - the start of the new #GSList + the start of the new #GSList - a #GSList + a #GSList - the #GSList to add to the end of the first #GSList + the #GSList to add to the end of the first #GSList @@ -20112,7 +21629,7 @@ They are used directly. - Copies a #GSList. + Copies a #GSList. Note that this is a "shallow" copy. If the list elements consist of pointers to data, the pointers are copied but @@ -20120,14 +21637,14 @@ the actual data isn't. See g_slist_copy_deep() if you need to copy the data as well. - a copy of @list + a copy of @list - a #GSList + a #GSList @@ -20135,7 +21652,7 @@ to copy the data as well. - Makes a full (deep) copy of a #GSList. + Makes a full (deep) copy of a #GSList. In contrast with g_slist_copy(), this function uses @func to make a copy of each list element, in addition to copying the list container itself. @@ -20157,30 +21674,30 @@ g_slist_free_full (another_list, g_object_unref); ]| - a full copy of @list, use g_slist_free_full() to free it + a full copy of @list, use g_slist_free_full() to free it - a #GSList + a #GSList - a copy function used to copy every element in the list + a copy function used to copy every element in the list - user data passed to the copy function @func, or #NULL + user data passed to the copy function @func, or #NULL - Removes the node link_ from the list and frees it. + Removes the node link_ from the list and frees it. Compare this to g_slist_remove_link() which removes the node without freeing it. @@ -20191,20 +21708,20 @@ consider a different data structure, such as the doubly-linked #GList. - the new head of @list + the new head of @list - a #GSList + a #GSList - node to delete + node to delete @@ -20212,11 +21729,11 @@ consider a different data structure, such as the doubly-linked - Finds the element in a #GSList which + Finds the element in a #GSList which contains the given data. - the found #GSList element, + the found #GSList element, or %NULL if it is not found @@ -20224,19 +21741,19 @@ contains the given data. - a #GSList + a #GSList - the element data to find + the element data to find - Finds an element in a #GSList, using a supplied function to + Finds an element in a #GSList, using a supplied function to find the desired element. It iterates over the list, calling the given function which should return 0 when the desired element is found. The function takes two #gconstpointer arguments, @@ -20244,31 +21761,31 @@ the #GSList element's data as the first argument and the given user data. - the found #GSList element, or %NULL if it is not found + the found #GSList element, or %NULL if it is not found - a #GSList + a #GSList - user data passed to the function + user data passed to the function - the function to call for each element. + the function to call for each element. It should return 0 when the desired element is found - Calls a function for each element of a #GSList. + Calls a function for each element of a #GSList. It is safe for @func to remove the element from @list, but it must not modify any part of the list after that element. @@ -20278,23 +21795,23 @@ not modify any part of the list after that element. - a #GSList + a #GSList - the function to call with each element's data + the function to call with each element's data - user data to pass to the function + user data to pass to the function - Frees all of the memory used by a #GSList. + Frees all of the memory used by a #GSList. The freed elements are returned to the slice allocator. If list elements contain dynamically-allocated memory, @@ -20306,7 +21823,7 @@ first. - a #GSList + a #GSList @@ -20314,7 +21831,7 @@ first. - Frees one #GSList element. + Frees one #GSList element. It is usually used after g_slist_remove_link(). @@ -20322,7 +21839,7 @@ It is usually used after g_slist_remove_link(). - a #GSList element + a #GSList element @@ -20330,7 +21847,7 @@ It is usually used after g_slist_remove_link(). - Convenience method, which frees all the memory used by a #GSList, and + Convenience method, which frees all the memory used by a #GSList, and calls the specified destroy function on every element's data. @free_func must not modify the list (eg, by removing the freed @@ -20341,61 +21858,61 @@ element from it). - a pointer to a #GSList + a pointer to a #GSList - the function to be called to free each element's data + the function to be called to free each element's data - Gets the position of the element containing + Gets the position of the element containing the given data (starting from 0). - the index of the element containing the data, + the index of the element containing the data, or -1 if the data is not found - a #GSList + a #GSList - the data to find + the data to find - Inserts a new element into the list at the given position. + Inserts a new element into the list at the given position. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - the data for the new element + the data for the new element - the position to insert the element. + the position to insert the element. If this is negative, or is larger than the number of elements in the list, the new element is added on to the end of the list. @@ -20404,56 +21921,56 @@ the given data (starting from 0). - Inserts a node before @sibling containing @data. + Inserts a node before @sibling containing @data. - the new head of the list. + the new head of the list. - a #GSList + a #GSList - node to insert @data before + node to insert @data before - data to put in the newly-inserted node + data to put in the newly-inserted node - Inserts a new element into the list, using the given + Inserts a new element into the list, using the given comparison function to determine its position. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - the data for the new element + the data for the new element - the function to compare elements in the list. + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. @@ -20461,45 +21978,45 @@ comparison function to determine its position. - Inserts a new element into the list, using the given + Inserts a new element into the list, using the given comparison function to determine its position. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - the data for the new element + the data for the new element - the function to compare elements in the list. + the function to compare elements in the list. It should return a number > 0 if the first parameter comes after the second parameter in the sort order. - data to pass to comparison function + data to pass to comparison function - Gets the last element in a #GSList. + Gets the last element in a #GSList. This function iterates over the whole list. - the last element in the #GSList, + the last element in the #GSList, or %NULL if the #GSList has no elements @@ -20507,7 +22024,7 @@ This function iterates over the whole list. - a #GSList + a #GSList @@ -20515,19 +22032,19 @@ This function iterates over the whole list. - Gets the number of elements in a #GSList. + Gets the number of elements in a #GSList. This function iterates over the whole list to count its elements. To check whether the list is non-empty, it is faster to check @list against %NULL. - the number of elements in the #GSList + the number of elements in the #GSList - a #GSList + a #GSList @@ -20535,10 +22052,10 @@ check @list against %NULL. - Gets the element at the given position in a #GSList. + Gets the element at the given position in a #GSList. - the element, or %NULL if the position is off + the element, or %NULL if the position is off the end of the #GSList @@ -20546,56 +22063,56 @@ check @list against %NULL. - a #GSList + a #GSList - the position of the element, counting from 0 + the position of the element, counting from 0 - Gets the data of the element at the given position. + Gets the data of the element at the given position. - the element's data, or %NULL if the position + the element's data, or %NULL if the position is off the end of the #GSList - a #GSList + a #GSList - the position of the element + the position of the element - Gets the position of the given element + Gets the position of the given element in the #GSList (starting from 0). - the position of the element in the #GSList, + the position of the element in the #GSList, or -1 if the element is not found - a #GSList + a #GSList - an element in the #GSList + an element in the #GSList @@ -20603,7 +22120,7 @@ in the #GSList (starting from 0). - Adds a new element on to the start of the list. + Adds a new element on to the start of the list. The return value is the new start of the list, which may have changed, so make sure you store the new value. @@ -20616,75 +22133,75 @@ list = g_slist_prepend (list, "first"); ]| - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - the data for the new element + the data for the new element - Removes an element from a #GSList. + Removes an element from a #GSList. If two elements contain the same data, only the first is removed. If none of the elements contain the data, the #GSList is unchanged. - the new start of the #GSList + the new start of the #GSList - a #GSList + a #GSList - the data of the element to remove + the data of the element to remove - Removes all list nodes with data equal to @data. + Removes all list nodes with data equal to @data. Returns the new head of the list. Contrast with g_slist_remove() which removes only the first node matching the given data. - new head of @list + new head of @list - a #GSList + a #GSList - data to remove + data to remove - Removes an element from a #GSList, without + Removes an element from a #GSList, without freeing the element. The removed element's next link is set to %NULL, so that it becomes a self-contained list with one element. @@ -20696,20 +22213,20 @@ frequently, you should consider a different data structure, such as the doubly-linked #GList. - the new start of the #GSList, without the element + the new start of the #GSList, without the element - a #GSList + a #GSList - an element in the #GSList + an element in the #GSList @@ -20717,17 +22234,17 @@ such as the doubly-linked #GList. - Reverses a #GSList. + Reverses a #GSList. - the start of the reversed #GSList + the start of the reversed #GSList - a #GSList + a #GSList @@ -20735,24 +22252,24 @@ such as the doubly-linked #GList. - Sorts a #GSList using the given comparison function. The algorithm + Sorts a #GSList using the given comparison function. The algorithm used is a stable sort. - the start of the sorted #GSList + the start of the sorted #GSList - a #GSList + a #GSList - the comparison function used to sort the #GSList. + the comparison function used to sort the #GSList. This function is passed the data from 2 elements of the #GSList and should return 0 if they are equal, a negative value if the first element comes before the second, or a positive value if @@ -20762,27 +22279,27 @@ used is a stable sort. - Like g_slist_sort(), but the sort function accepts a user data argument. + Like g_slist_sort(), but the sort function accepts a user data argument. - new head of the list + new head of the list - a #GSList + a #GSList - comparison function + comparison function - data to pass to comparison function + data to pass to comparison function @@ -20794,6 +22311,23 @@ the #GSource in the main loop. + + Cast a function pointer to a #GSourceFunc, suppressing warnings from GCC 8 +onwards with `-Wextra` or `-Wcast-function-type` enabled about the function +types being incompatible. + +For example, the correct type of callback for a source created by +g_child_watch_source_new() is #GChildWatchFunc, which accepts more arguments +than #GSourceFunc. Casting the function with `(GSourceFunc)` to call +g_source_set_callback() will trigger a warning, even though it will be cast +back to the correct type before it is called by the source. + + + + a function pointer. + + + Use this macro as the return value of a #GSourceFunc to remove the #GSource from the main loop. @@ -20801,37 +22335,105 @@ the #GSource from the main loop. - The square root of two. - + The square root of two. + + + Accepts a macro or a string and converts it into a string after +preprocessor argument expansion. For example, the following code: + +|[<!-- language="C" --> +#define AGE 27 +const gchar *greeting = G_STRINGIFY (AGE) " today!"; +]| + +is transformed by the preprocessor into (code equivalent to): + +|[<!-- language="C" --> +const gchar *greeting = "27 today!"; +]| + + + + a macro or a string + + + + + + + + + + + + Returns a member of a structure at a given offset, using the given type. + + + + the type of the struct field + + + a pointer to a struct + + + the offset of the field from the start of the struct, + in bytes + + + + + Returns an untyped pointer to a given offset of a struct. + + + + a pointer to a struct + + + the offset from the start of the struct, in bytes + + + + + Returns the offset, in bytes, of a member of a struct. + + + + a structure type, e.g. #GtkWidget + + + a field in the structure, e.g. @window + + + - The standard delimiters, used in g_strdelimit(). + The standard delimiters, used in g_strdelimit(). - + - + - + - + - + - + @@ -20932,195 +22534,195 @@ is declared by #GScannerMsgFunc. - Returns the current line in the input stream (counting + Returns the current line in the input stream (counting from 1). This is the line of the last token parsed via g_scanner_get_next_token(). - the current line + the current line - a #GScanner + a #GScanner - Returns the current position in the current line (counting + Returns the current position in the current line (counting from 0). This is the position of the last token parsed via g_scanner_get_next_token(). - the current position on the line + the current position on the line - a #GScanner + a #GScanner - Gets the current token type. This is simply the @token + Gets the current token type. This is simply the @token field in the #GScanner structure. - the current token type + the current token type - a #GScanner + a #GScanner - Gets the current token value. This is simply the @value + Gets the current token value. This is simply the @value field in the #GScanner structure. - the current token value + the current token value - a #GScanner + a #GScanner - Frees all memory used by the #GScanner. + Frees all memory used by the #GScanner. - a #GScanner + a #GScanner - Returns %TRUE if the scanner has reached the end of + Returns %TRUE if the scanner has reached the end of the file or text buffer. - %TRUE if the scanner has reached the end of + %TRUE if the scanner has reached the end of the file or text buffer - a #GScanner + a #GScanner - Outputs an error message, via the #GScanner message handler. + Outputs an error message, via the #GScanner message handler. - a #GScanner + a #GScanner - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Parses the next token just like g_scanner_peek_next_token() + Parses the next token just like g_scanner_peek_next_token() and also removes it from the input stream. The token data is placed in the @token, @value, @line, and @position fields of the #GScanner structure. - the type of the token + the type of the token - a #GScanner + a #GScanner - Prepares to scan a file. + Prepares to scan a file. - a #GScanner + a #GScanner - a file descriptor + a file descriptor - Prepares to scan a text buffer. + Prepares to scan a text buffer. - a #GScanner + a #GScanner - the text buffer to scan + the text buffer to scan - the length of the text buffer + the length of the text buffer - Looks up a symbol in the current scope and return its value. + Looks up a symbol in the current scope and return its value. If the symbol is not bound in the current scope, %NULL is returned. - the value of @symbol in the current scope, or %NULL + the value of @symbol in the current scope, or %NULL if @symbol is not bound in the current scope - a #GScanner + a #GScanner - the symbol to look up + the symbol to look up - Parses the next token, without removing it from the input stream. + Parses the next token, without removing it from the input stream. The token data is placed in the @next_token, @next_value, @next_line, and @next_position fields of the #GScanner structure. @@ -21133,43 +22735,43 @@ configuration will return whatever was peeked before, regardless of any symbols that may have been added or removed in the new scope. - the type of the token + the type of the token - a #GScanner + a #GScanner - Adds a symbol to the given scope. + Adds a symbol to the given scope. - a #GScanner + a #GScanner - the scope id + the scope id - the symbol to add + the symbol to add - the value of the symbol + the value of the symbol - Calls the given function for each of the symbol/value pairs + Calls the given function for each of the symbol/value pairs in the given scope of the #GScanner. The function is passed the symbol and value of each pair, and the given @user_data parameter. @@ -21179,88 +22781,88 @@ parameter. - a #GScanner + a #GScanner - the scope id + the scope id - the function to call for each symbol/value pair + the function to call for each symbol/value pair - user data to pass to the function + user data to pass to the function - Looks up a symbol in a scope and return its value. If the + Looks up a symbol in a scope and return its value. If the symbol is not bound in the scope, %NULL is returned. - the value of @symbol in the given scope, or %NULL + the value of @symbol in the given scope, or %NULL if @symbol is not bound in the given scope. - a #GScanner + a #GScanner - the scope id + the scope id - the symbol to look up + the symbol to look up - Removes a symbol from a scope. + Removes a symbol from a scope. - a #GScanner + a #GScanner - the scope id + the scope id - the symbol to remove + the symbol to remove - Sets the current scope. + Sets the current scope. - the old scope id + the old scope id - a #GScanner + a #GScanner - the new scope id + the new scope id - Rewinds the filedescriptor to the current buffer position + Rewinds the filedescriptor to the current buffer position and blows the file read ahead buffer. This is useful for third party uses of the scanners filedescriptor, which hooks onto the current scanning position. @@ -21270,13 +22872,13 @@ onto the current scanning position. - a #GScanner + a #GScanner - Outputs a message through the scanner's msg_handler, + Outputs a message through the scanner's msg_handler, resulting from an unexpected token in the input stream. Note that you should not call g_scanner_peek_next_token() followed by g_scanner_unexp_token() without an intermediate @@ -21289,67 +22891,67 @@ to construct part of the message. - a #GScanner + a #GScanner - the expected token + the expected token - a string describing how the scanner's user + a string describing how the scanner's user refers to identifiers (%NULL defaults to "identifier"). This is used if @expected_token is %G_TOKEN_IDENTIFIER or %G_TOKEN_IDENTIFIER_NULL. - a string describing how the scanner's user refers + a string describing how the scanner's user refers to symbols (%NULL defaults to "symbol"). This is used if @expected_token is %G_TOKEN_SYMBOL or any token value greater than %G_TOKEN_LAST. - the name of the symbol, if the scanner's current + the name of the symbol, if the scanner's current token is a symbol. - a message string to output at the end of the + a message string to output at the end of the warning/error, or %NULL. - if %TRUE it is output as an error. If %FALSE it is + if %TRUE it is output as an error. If %FALSE it is output as a warning. - Outputs a warning message, via the #GScanner message handler. + Outputs a warning message, via the #GScanner message handler. - a #GScanner + a #GScanner - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Creates a new #GScanner. + Creates a new #GScanner. The @config_templ structure specifies the initial settings of the scanner, which are copied into the #GScanner @@ -21357,12 +22959,12 @@ of the scanner, which are copied into the #GScanner are used. - the new #GScanner + the new #GScanner - the initial scanner settings + the initial scanner settings @@ -21552,25 +23154,25 @@ g_io_channel_seek_position() operation. [sequence][glib-Sequences] data type. - Adds a new item to the end of @seq. + Adds a new item to the end of @seq. - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequence + a #GSequence - the data for the new item + the data for the new item - Calls @func for each item in the sequence passing @user_data + Calls @func for each item in the sequence passing @user_data to the function. @func must not modify the sequence itself. @@ -21578,21 +23180,21 @@ to the function. @func must not modify the sequence itself. - a #GSequence + a #GSequence - the function to call for each item in @seq + the function to call for each item in @seq - user data passed to @func + user data passed to @func - Frees the memory allocated for @seq. If @seq has a data destroy + Frees the memory allocated for @seq. If @seq has a data destroy function associated with it, that function is called on all items in @seq. @@ -21601,76 +23203,76 @@ in @seq. - a #GSequence + a #GSequence - Returns the begin iterator for @seq. + Returns the begin iterator for @seq. - the begin iterator for @seq. + the begin iterator for @seq. - a #GSequence + a #GSequence - Returns the end iterator for @seg + Returns the end iterator for @seg - the end iterator for @seq + the end iterator for @seq - a #GSequence + a #GSequence - Returns the iterator at position @pos. If @pos is negative or larger + Returns the iterator at position @pos. If @pos is negative or larger than the number of items in @seq, the end iterator is returned. - The #GSequenceIter at position @pos + The #GSequenceIter at position @pos - a #GSequence + a #GSequence - a position in @seq, or -1 for the end + a position in @seq, or -1 for the end - Returns the length of @seq. Note that this method is O(h) where `h' is the + Returns the length of @seq. Note that this method is O(h) where `h' is the height of the tree. It is thus more efficient to use g_sequence_is_empty() when comparing the length to zero. - the length of @seq + the length of @seq - a #GSequence + a #GSequence - Inserts @data into @seq using @cmp_func to determine the new + Inserts @data into @seq using @cmp_func to determine the new position. The sequence must already be sorted according to @cmp_func; otherwise the new position of @data is undefined. @@ -21684,30 +23286,30 @@ it is more efficient to do unsorted insertions and then call g_sequence_sort() or g_sequence_sort_iter(). - a #GSequenceIter pointing to the new item. + a #GSequenceIter pointing to the new item. - a #GSequence + a #GSequence - the data to insert + the data to insert - the function used to compare items in the sequence + the function used to compare items in the sequence - user data passed to @cmp_func. + user data passed to @cmp_func. - Like g_sequence_insert_sorted(), but uses + Like g_sequence_insert_sorted(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @@ -21721,48 +23323,48 @@ it is more efficient to do unsorted insertions and then call g_sequence_sort() or g_sequence_sort_iter(). - a #GSequenceIter pointing to the new item + a #GSequenceIter pointing to the new item - a #GSequence + a #GSequence - data for the new item + data for the new item - the function used to compare iterators in the sequence + the function used to compare iterators in the sequence - user data passed to @iter_cmp + user data passed to @iter_cmp - Returns %TRUE if the sequence contains zero items. + Returns %TRUE if the sequence contains zero items. This function is functionally identical to checking the result of g_sequence_get_length() being equal to zero. However this function is implemented in O(1) running time. - %TRUE if the sequence is empty, otherwise %FALSE. + %TRUE if the sequence is empty, otherwise %FALSE. - a #GSequence + a #GSequence - Returns an iterator pointing to the position of the first item found + Returns an iterator pointing to the position of the first item found equal to @data according to @cmp_func and @cmp_data. If more than one item is equal, it is not guaranteed that it is the first which is returned. In that case, you can use g_sequence_iter_next() and @@ -21777,32 +23379,32 @@ This function will fail if the data contained in the sequence is unsorted. - an #GSequenceIter pointing to the position of the + an #GSequenceIter pointing to the position of the first item found equal to @data according to @cmp_func and @cmp_data, or %NULL if no such item exists - a #GSequence + a #GSequence - data to lookup + data to look up - the function used to compare items in the sequence + the function used to compare items in the sequence - user data passed to @cmp_func + user data passed to @cmp_func - Like g_sequence_lookup(), but uses a #GSequenceIterCompareFunc + Like g_sequence_lookup(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @iter_cmp is called with two iterators pointing into @seq. @@ -21814,50 +23416,50 @@ This function will fail if the data contained in the sequence is unsorted. - an #GSequenceIter pointing to the position of + an #GSequenceIter pointing to the position of the first item found equal to @data according to @iter_cmp and @cmp_data, or %NULL if no such item exists - a #GSequence + a #GSequence - data to lookup + data to look up - the function used to compare iterators in the sequence + the function used to compare iterators in the sequence - user data passed to @iter_cmp + user data passed to @iter_cmp - Adds a new item to the front of @seq + Adds a new item to the front of @seq - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequence + a #GSequence - the data for the new item + the data for the new item - Returns an iterator pointing to the position where @data would + Returns an iterator pointing to the position where @data would be inserted according to @cmp_func and @cmp_data. @cmp_func is called with two items of the @seq, and @cmp_data. @@ -21872,31 +23474,31 @@ This function will fail if the data contained in the sequence is unsorted. - an #GSequenceIter pointing to the position where @data + an #GSequenceIter pointing to the position where @data would have been inserted according to @cmp_func and @cmp_data - a #GSequence + a #GSequence - data for the new item + data for the new item - the function used to compare items in the sequence + the function used to compare items in the sequence - user data passed to @cmp_func + user data passed to @cmp_func - Like g_sequence_search(), but uses a #GSequenceIterCompareFunc + Like g_sequence_search(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @iter_cmp is called with two iterators pointing into @seq. @@ -21911,32 +23513,32 @@ This function will fail if the data contained in the sequence is unsorted. - a #GSequenceIter pointing to the position in @seq + a #GSequenceIter pointing to the position in @seq where @data would have been inserted according to @iter_cmp and @cmp_data - a #GSequence + a #GSequence - data for the new item + data for the new item - the function used to compare iterators in the sequence + the function used to compare iterators in the sequence - user data passed to @iter_cmp + user data passed to @iter_cmp - Sorts @seq using @cmp_func. + Sorts @seq using @cmp_func. @cmp_func is passed two items of @seq and should return 0 if they are equal, a negative value if the @@ -21948,21 +23550,21 @@ if the second comes before the first. - a #GSequence + a #GSequence - the function used to sort the sequence + the function used to sort the sequence - user data passed to @cmp_func + user data passed to @cmp_func - Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead + Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function @cmp_func is called with two iterators pointing into @seq. It should @@ -21975,21 +23577,21 @@ iterator comes before the first. - a #GSequence + a #GSequence - the function used to compare iterators in the sequence + the function used to compare iterators in the sequence - user data passed to @cmp_func + user data passed to @cmp_func - Calls @func for each item in the range (@begin, @end) passing + Calls @func for each item in the range (@begin, @end) passing @user_data to the function. @func must not modify the sequence itself. @@ -21998,57 +23600,57 @@ itself. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - a #GFunc + a #GFunc - user data passed to @func + user data passed to @func - Returns the data that @iter points to. + Returns the data that @iter points to. - the data that @iter points to + the data that @iter points to - a #GSequenceIter + a #GSequenceIter - Inserts a new item just before the item pointed to by @iter. + Inserts a new item just before the item pointed to by @iter. - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequenceIter + a #GSequenceIter - the data for the new item + the data for the new item - Moves the item pointed to by @src to the position indicated by @dest. + Moves the item pointed to by @src to the position indicated by @dest. After calling this function @dest will point to the position immediately after @src. It is allowed for @src and @dest to point into different sequences. @@ -22058,18 +23660,18 @@ sequences. - a #GSequenceIter pointing to the item to move + a #GSequenceIter pointing to the item to move - a #GSequenceIter pointing to the position to which + a #GSequenceIter pointing to the position to which the item is moved - Inserts the (@begin, @end) range at the destination pointed to by @dest. + Inserts the (@begin, @end) range at the destination pointed to by @dest. The @begin and @end iters must point into the same sequence. It is allowed for @dest to point to a different sequence than the one pointed into by @begin and @end. @@ -22083,37 +23685,37 @@ the (@begin, @end) range, the range does not move. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Creates a new GSequence. The @data_destroy function, if non-%NULL will + Creates a new GSequence. The @data_destroy function, if non-%NULL will be called on all items when the sequence is destroyed and on items that are removed from the sequence. - a new #GSequence + a new #GSequence - a #GDestroyNotify function, or %NULL + a #GDestroyNotify function, or %NULL - Finds an iterator somewhere in the range (@begin, @end). This + Finds an iterator somewhere in the range (@begin, @end). This iterator will be close to the middle of the range, but is not guaranteed to be exactly in the middle. @@ -22121,23 +23723,23 @@ The @begin and @end iterators must both point to the same sequence and @begin must come before or be equal to @end in the sequence. - a #GSequenceIter pointing somewhere in the + a #GSequenceIter pointing somewhere in the (@begin, @end) range - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Removes the item pointed to by @iter. It is an error to pass the + Removes the item pointed to by @iter. It is an error to pass the end iterator to this function. If the sequence has a data destroy function associated with it, this @@ -22148,13 +23750,13 @@ function is called on the data for the removed item. - a #GSequenceIter + a #GSequenceIter - Removes all items in the (@begin, @end) range. + Removes all items in the (@begin, @end) range. If the sequence has a data destroy function associated with it, this function is called on the data for the removed items. @@ -22164,17 +23766,17 @@ function is called on the data for the removed items. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Changes the data for the item pointed to by @iter to be @data. If + Changes the data for the item pointed to by @iter to be @data. If the sequence has a data destroy function associated with it, that function is called on the existing data that @iter pointed to. @@ -22183,17 +23785,17 @@ function is called on the existing data that @iter pointed to. - a #GSequenceIter + a #GSequenceIter - new data for the item + new data for the item - Moves the data pointed to by @iter to a new position as indicated by + Moves the data pointed to by @iter to a new position as indicated by @cmp_func. This function should be called for items in a sequence already sorted according to @cmp_func whenever some aspect of an item changes so that @cmp_func @@ -22209,21 +23811,21 @@ the second item comes before the first. - A #GSequenceIter + A #GSequenceIter - the function used to compare items in the sequence + the function used to compare items in the sequence - user data passed to @cmp_func. + user data passed to @cmp_func. - Like g_sequence_sort_changed(), but uses + Like g_sequence_sort_changed(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function. @@ -22238,21 +23840,21 @@ iterator comes before the first. - a #GSequenceIter + a #GSequenceIter - the function used to compare iterators in the sequence + the function used to compare iterators in the sequence - user data passed to @cmp_func + user data passed to @cmp_func - Swaps the items pointed to by @a and @b. It is allowed for @a and @b + Swaps the items pointed to by @a and @b. It is allowed for @a and @b to point into difference sequences. @@ -22260,11 +23862,11 @@ to point into difference sequences. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter @@ -22275,132 +23877,132 @@ to point into difference sequences. iterator pointing into a #GSequence. - Returns a negative number if @a comes before @b, 0 if they are equal, + Returns a negative number if @a comes before @b, 0 if they are equal, and a positive number if @a comes after @b. The @a and @b iterators must point into the same sequence. - a negative number if @a comes before @b, 0 if they are + a negative number if @a comes before @b, 0 if they are equal, and a positive number if @a comes after @b - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Returns the position of @iter + Returns the position of @iter - the position of @iter + the position of @iter - a #GSequenceIter + a #GSequenceIter - Returns the #GSequence that @iter points into. + Returns the #GSequence that @iter points into. - the #GSequence that @iter points into + the #GSequence that @iter points into - a #GSequenceIter + a #GSequenceIter - Returns whether @iter is the begin iterator + Returns whether @iter is the begin iterator - whether @iter is the begin iterator + whether @iter is the begin iterator - a #GSequenceIter + a #GSequenceIter - Returns whether @iter is the end iterator + Returns whether @iter is the end iterator - Whether @iter is the end iterator + Whether @iter is the end iterator - a #GSequenceIter + a #GSequenceIter - Returns the #GSequenceIter which is @delta positions away from @iter. + Returns the #GSequenceIter which is @delta positions away from @iter. If @iter is closer than -@delta positions to the beginning of the sequence, the begin iterator is returned. If @iter is closer than @delta positions to the end of the sequence, the end iterator is returned. - a #GSequenceIter which is @delta positions away from @iter + a #GSequenceIter which is @delta positions away from @iter - a #GSequenceIter + a #GSequenceIter - A positive or negative number indicating how many positions away + A positive or negative number indicating how many positions away from @iter the returned #GSequenceIter will be - Returns an iterator pointing to the next position after @iter. + Returns an iterator pointing to the next position after @iter. If @iter is the end iterator, the end iterator is returned. - a #GSequenceIter pointing to the next position after @iter + a #GSequenceIter pointing to the next position after @iter - a #GSequenceIter + a #GSequenceIter - Returns an iterator pointing to the previous position before @iter. + Returns an iterator pointing to the previous position before @iter. If @iter is the begin iterator, the begin iterator is returned. - a #GSequenceIter pointing to the previous position + a #GSequenceIter pointing to the previous position before @iter - a #GSequenceIter + a #GSequenceIter @@ -22505,7 +24107,7 @@ representing an event source. - Creates a new #GSource structure. The size is specified to + Creates a new #GSource structure. The size is specified to allow creating structures derived from #GSource that contain additional data. The size passed in must be at least `sizeof (GSource)`. @@ -22515,23 +24117,23 @@ and must be added to one with g_source_attach() before it will be executed. - the newly-created #GSource. + the newly-created #GSource. - structure containing functions that implement + structure containing functions that implement the sources behavior. - size of the #GSource structure to create. + size of the #GSource structure to create. - Adds @child_source to @source as a "polled" source; when @source is + Adds @child_source to @source as a "polled" source; when @source is added to a #GMainContext, @child_source will be automatically added with the same priority, when @child_source is triggered, it will cause @source to dispatch (in addition to calling its own @@ -22554,17 +24156,17 @@ Do not call this API on a #GSource that you did not create. - a #GSource + a #GSource - a second #GSource that @source should "poll" + a second #GSource that @source should "poll" - Adds a file descriptor to the set of file descriptors polled for + Adds a file descriptor to the set of file descriptors polled for this source. This is usually combined with g_source_new() to add an event source. The event source's check function will typically test the @revents field in the #GPollFD struct and return %TRUE if events need @@ -22582,18 +24184,18 @@ g_source_add_unix_fd() instead of this API. - a #GSource + a #GSource - a #GPollFD structure holding information about a file + a #GPollFD structure holding information about a file descriptor to watch. - Monitors @fd for the IO events in @events. + Monitors @fd for the IO events in @events. The tag returned by this function can be used to remove or modify the monitoring of the fd using g_source_remove_unix_fd() or @@ -22608,77 +24210,80 @@ Do not call this API on a #GSource that you did not create. As the name suggests, this function is not available on Windows. - an opaque tag + an opaque tag - a #GSource + a #GSource - the fd to monitor + the fd to monitor - an event mask + an event mask - Adds a #GSource to a @context so that it will be executed within + Adds a #GSource to a @context so that it will be executed within that context. Remove it by calling g_source_destroy(). - the ID (greater than 0) for the source within the + the ID (greater than 0) for the source within the #GMainContext. - a #GSource + a #GSource - a #GMainContext (if %NULL, the default context will be used) + a #GMainContext (if %NULL, the default context will be used) - Removes a source from its #GMainContext, if any, and mark it as + Removes a source from its #GMainContext, if any, and mark it as destroyed. The source cannot be subsequently added to another context. It is safe to call this on sources which have already been -removed from their context. +removed from their context. + +This does not unref the #GSource: if you still hold a reference, use +g_source_unref() to drop it. - a #GSource + a #GSource - Checks whether a source is allowed to be called recursively. + Checks whether a source is allowed to be called recursively. see g_source_set_can_recurse(). - whether recursion is allowed. + whether recursion is allowed. - a #GSource + a #GSource - Gets the #GMainContext with which the source is associated. + Gets the #GMainContext with which the source is associated. You can call this on a source that has been destroyed, provided that the #GMainContext it was attached to still exists (in which @@ -22688,39 +24293,39 @@ g_main_current_source(). But calling this function on a source whose #GMainContext has been destroyed is an error. - the #GMainContext with which the + the #GMainContext with which the source is associated, or %NULL if the context has not yet been added to a source. - a #GSource + a #GSource - This function ignores @source and is otherwise the same as + This function ignores @source and is otherwise the same as g_get_current_time(). use g_source_get_time() instead - + - a #GSource + a #GSource - #GTimeVal structure in which to store current time. + #GTimeVal structure in which to store current time. - Returns the numeric ID for a particular source. The ID of a source + Returns the numeric ID for a particular source. The ID of a source is a positive integer which is unique within a particular main loop context. The reverse mapping from ID to source is done by g_main_context_find_source_by_id(). @@ -22731,85 +24336,85 @@ or after g_source_destroy() yields undefined behavior. The ID returned is unique within the #GMainContext instance passed to g_source_attach(). - the ID (greater than 0) for the source + the ID (greater than 0) for the source - a #GSource + a #GSource - Gets a name for the source, used in debugging and profiling. The + Gets a name for the source, used in debugging and profiling. The name may be #NULL if it has never been set with g_source_set_name(). - the name of the source + the name of the source - a #GSource + a #GSource - Gets the priority of a source. + Gets the priority of a source. - the priority of the source + the priority of the source - a #GSource + a #GSource - Gets the "ready time" of @source, as set by + Gets the "ready time" of @source, as set by g_source_set_ready_time(). Any time before the current monotonic time (including 0) is an indication that the source will fire immediately. - the monotonic ready time, -1 for "never" + the monotonic ready time, -1 for "never" - a #GSource + a #GSource - Gets the time to be used when checking this source. The advantage of + Gets the time to be used when checking this source. The advantage of calling this function over calling g_get_monotonic_time() directly is that when checking multiple sources, GLib can cache a single value instead of having to repeatedly get the system monotonic time. The time here is the system monotonic time, if available, or some other reasonable alternative otherwise. See g_get_monotonic_time(). - + - the monotonic time in microseconds + the monotonic time in microseconds - a #GSource + a #GSource - Returns whether @source has been destroyed. + Returns whether @source has been destroyed. This is important when you operate upon your objects from within idle handlers, but may have freed the object @@ -22877,18 +24482,18 @@ once a source is destroyed it cannot be un-destroyed, so this function can be used for opportunistic checks from any thread. - %TRUE if the source has been destroyed + %TRUE if the source has been destroyed - a #GSource + a #GSource - Updates the event mask to watch for the fd identified by @tag. + Updates the event mask to watch for the fd identified by @tag. @tag is the tag returned from g_source_add_unix_fd(). @@ -22905,21 +24510,21 @@ As the name suggests, this function is not available on Windows. - a #GSource + a #GSource - the tag from g_source_add_unix_fd() + the tag from g_source_add_unix_fd() - the new event mask to watch + the new event mask to watch - Queries the events reported for the fd corresponding to @tag on + Queries the events reported for the fd corresponding to @tag on @source during the last poll. The return value of this function is only defined when the function @@ -22931,36 +24536,36 @@ Do not call this API on a #GSource that you did not create. As the name suggests, this function is not available on Windows. - the conditions reported on the fd + the conditions reported on the fd - a #GSource + a #GSource - the tag from g_source_add_unix_fd() + the tag from g_source_add_unix_fd() - Increases the reference count on a source by one. + Increases the reference count on a source by one. - @source + @source - a #GSource + a #GSource - Detaches @child_source from @source and destroys it. + Detaches @child_source from @source and destroys it. This API is only intended to be used by implementations of #GSource. Do not call this API on a #GSource that you did not create. @@ -22970,18 +24575,18 @@ Do not call this API on a #GSource that you did not create. - a #GSource + a #GSource - a #GSource previously passed to + a #GSource previously passed to g_source_add_child_source(). - Removes a file descriptor from the set of file descriptors polled for + Removes a file descriptor from the set of file descriptors polled for this source. This API is only intended to be used by implementations of #GSource. @@ -22992,17 +24597,17 @@ Do not call this API on a #GSource that you did not create. - a #GSource + a #GSource - a #GPollFD structure previously passed to g_source_add_poll(). + a #GPollFD structure previously passed to g_source_add_poll(). - Reverses the effect of a previous call to g_source_add_unix_fd(). + Reverses the effect of a previous call to g_source_add_unix_fd(). You only need to call this if you want to remove an fd from being watched while keeping the same source around. In the normal case you @@ -23018,17 +24623,17 @@ As the name suggests, this function is not available on Windows. - a #GSource + a #GSource - the tag from g_source_add_unix_fd() + the tag from g_source_add_unix_fd() - Sets the callback function for a source. The callback for a source is + Sets the callback function for a source. The callback for a source is called from the source's dispatch function. The exact type of @func depends on the type of source; ie. you @@ -23051,25 +24656,25 @@ the source is dispatched after this call returns. - the source + the source - a callback function + a callback function - the data to pass to callback function + the data to pass to callback function - a function to call when @data is no longer in use, or %NULL. + a function to call when @data is no longer in use, or %NULL. - Sets the callback function storing the data as a refcounted callback + Sets the callback function storing the data as a refcounted callback "object". This is used internally. Note that calling g_source_set_callback_indirect() assumes an initial reference count on @callback_data, and thus @@ -23085,22 +24690,22 @@ the source is dispatched after this call returns. - the source + the source - pointer to callback data "object" + pointer to callback data "object" - functions for reference counting @callback_data + functions for reference counting @callback_data and getting the callback and data - Sets whether a source can be called recursively. If @can_recurse is + Sets whether a source can be called recursively. If @can_recurse is %TRUE, then while the source is being dispatched then this source will be processed normally. Otherwise, all processing of this source is blocked until the dispatch function returns. @@ -23110,17 +24715,17 @@ source is blocked until the dispatch function returns. - a #GSource + a #GSource - whether recursion is allowed for this source + whether recursion is allowed for this source - Sets the source functions (can be used to override + Sets the source functions (can be used to override default implementations) of an unattached source. @@ -23128,17 +24733,17 @@ default implementations) of an unattached source. - a #GSource + a #GSource - the new #GSourceFuncs + the new #GSourceFuncs - Sets a name for the source, used in debugging and profiling. + Sets a name for the source, used in debugging and profiling. The name defaults to #NULL. The source name should describe in a human-readable way @@ -23160,17 +24765,17 @@ may be attempting to use it. - a #GSource + a #GSource - debug name for the source + debug name for the source - Sets the priority of a source. While the main loop is being run, a + Sets the priority of a source. While the main loop is being run, a source will be dispatched if it is ready to be dispatched and no sources at a higher (numerically smaller) priority are ready to be dispatched. @@ -23184,17 +24789,17 @@ as a child of another source. - a #GSource + a #GSource - the new priority. + the new priority. - Sets a #GSource to be dispatched when the given monotonic time is + Sets a #GSource to be dispatched when the given monotonic time is reached (or passed). If the monotonic time is in the past (as it always will be if @ready_time is 0) then the source will be dispatched immediately. @@ -23222,18 +24827,18 @@ Do not call this API on a #GSource that you did not create. - a #GSource + a #GSource - the monotonic time at which the source will be ready, + the monotonic time at which the source will be ready, 0 for "immediately", -1 for "never" - Decreases the reference count of a source by one. If the + Decreases the reference count of a source by one. If the resulting reference count is zero the source and associated memory will be destroyed. @@ -23242,13 +24847,13 @@ memory will be destroyed. - a #GSource + a #GSource - Removes the source with the given ID from the default main context. You must + Removes the source with the given ID from the default main context. You must use g_source_destroy() for sources added to a non-default main context. The ID of a #GSource is given by g_source_get_id(), or will be @@ -23267,56 +24872,56 @@ idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source. - + - For historical reasons, this function always returns %TRUE + For historical reasons, this function always returns %TRUE - the ID of the source to remove. + the ID of the source to remove. - Removes a source from the default main loop context given the + Removes a source from the default main loop context given the source functions and user data. If multiple sources exist with the same source functions and user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - The @source_funcs passed to g_source_new() + The @source_funcs passed to g_source_new() - the user data for the callback + the user data for the callback - Removes a source from the default main loop context given the user + Removes a source from the default main loop context given the user data for the callback. If multiple sources exist with the same user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - the user_data for the callback. + the user_data for the callback. - Sets the name of a source using its ID. + Sets the name of a source using its ID. This is a convenience utility to set source names from the return value of g_idle_add(), g_timeout_add(), etc. @@ -23338,11 +24943,11 @@ wrong source. - a #GSource ID + a #GSource ID - debug name for the source + debug name for the source @@ -23524,7 +25129,7 @@ required condition has been met, and returns %TRUE if so. - Specifies the type of the setup function passed to g_spawn_async(), + Specifies the type of the setup function passed to g_spawn_async(), g_spawn_sync() and g_spawn_async_with_pipes(), which can, in very limited ways, be used to affect the child's execution. @@ -23554,20 +25159,20 @@ If you need to set up the child environment differently from the parent, you should use g_get_environ(), g_environ_setenv(), and g_environ_unsetenv(), and then pass the complete environment list to the `g_spawn...` function. - + - user data to pass to the function. + user data to pass to the function. Error codes returned by spawning processes. - + Fork failed due to lack of memory. @@ -23587,7 +25192,7 @@ list to the `g_spawn...` function. execv() returned `E2BIG` - deprecated alias for %G_SPAWN_ERROR_TOO_BIG + deprecated alias for %G_SPAWN_ERROR_TOO_BIG (deprecated since GLib 2.32) execv() returned `ENOEXEC` @@ -23634,49 +25239,49 @@ list to the `g_spawn...` function. - Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes(). - + Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes(). + - no flags, default behaviour + no flags, default behaviour - the parent's open file descriptors will + the parent's open file descriptors will be inherited by the child; otherwise all descriptors except stdin, stdout and stderr will be closed before calling exec() in the child. - the child will not be automatically reaped; + the child will not be automatically reaped; you must use g_child_watch_add() yourself (or call waitpid() or handle `SIGCHLD` yourself), or the child will become a zombie. - `argv[0]` need not be an absolute path, it will be + `argv[0]` need not be an absolute path, it will be looked for in the user's `PATH`. - the child's standard output will be discarded, + the child's standard output will be discarded, instead of going to the same location as the parent's standard output. - the child's standard error will be discarded. + the child's standard error will be discarded. - the child will inherit the parent's standard + the child will inherit the parent's standard input (by default, the child's standard input is attached to `/dev/null`). - the first element of `argv` is the file to + the first element of `argv` is the file to execute, while the remaining elements are the actual argument vector to pass to the file. Normally g_spawn_async_with_pipes() uses `argv[0]` as the file to execute, and passes all of `argv` to the child. - if `argv[0]` is not an abolute path, + if `argv[0]` is not an abolute path, it will be looked for in the `PATH` from the passed child environment. Since: 2.34 - create all pipes with the `O_CLOEXEC` flag set. + create all pipes with the `O_CLOEXEC` flag set. Since: 2.40 @@ -23707,45 +25312,45 @@ See g_stat() for more information. - Adds a string onto the end of a #GString, expanding + Adds a string onto the end of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the string to append onto the end of @string + the string to append onto the end of @string - Adds a byte onto the end of a #GString, expanding + Adds a byte onto the end of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the byte to append onto the end of @string + the byte to append onto the end of @string - Appends @len bytes of @val to @string. + Appends @len bytes of @val to @string. If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to @@ -23756,26 +25361,26 @@ is considered to request the entire string length. This makes g_string_append_len() equivalent to g_string_append(). - @string + @string - a #GString + a #GString - bytes to append + bytes to append - number of bytes of @val to use, or -1 for all of @val + number of bytes of @val to use, or -1 for all of @val - Appends a formatted string onto the end of a #GString. + Appends a formatted string onto the end of a #GString. This function is similar to g_string_printf() except that the text is appended to the #GString. @@ -23784,68 +25389,68 @@ that the text is appended to the #GString. - a #GString + a #GString - the string format. See the printf() documentation + the string format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Converts a Unicode character into UTF-8, and appends it + Converts a Unicode character into UTF-8, and appends it to the string. - @string + @string - a #GString + a #GString - a Unicode character + a Unicode character - Appends @unescaped to @string, escaped any characters that + Appends @unescaped to @string, escaped any characters that are reserved in URIs using URI-style escape sequences. - @string + @string - a #GString + a #GString - a string + a string - a string of reserved characters allowed + a string of reserved characters allowed to be used, or %NULL - set %TRUE if the escaped string may include UTF8 characters + set %TRUE if the escaped string may include UTF8 characters - Appends a formatted string onto the end of a #GString. + Appends a formatted string onto the end of a #GString. This function is similar to g_string_append_printf() except that the arguments to the format string are passed as a va_list. @@ -23855,158 +25460,158 @@ as a va_list. - a #GString + a #GString - the string format. See the printf() documentation + the string format. See the printf() documentation - the list of arguments to insert in the output + the list of arguments to insert in the output - Converts all uppercase ASCII letters to lowercase ASCII letters. + Converts all uppercase ASCII letters to lowercase ASCII letters. - passed-in @string pointer, with all the + passed-in @string pointer, with all the uppercase characters converted to lowercase in place, with semantics that exactly match g_ascii_tolower(). - a GString + a GString - Converts all lowercase ASCII letters to uppercase ASCII letters. + Converts all lowercase ASCII letters to uppercase ASCII letters. - passed-in @string pointer, with all the + passed-in @string pointer, with all the lowercase characters converted to uppercase in place, with semantics that exactly match g_ascii_toupper(). - a GString + a GString - Copies the bytes from a string into a #GString, + Copies the bytes from a string into a #GString, destroying any previous contents. It is rather like the standard strcpy() function, except that you do not have to worry about having enough space to copy the string. - @string + @string - the destination #GString. Its current contents + the destination #GString. Its current contents are destroyed. - the string to copy into @string + the string to copy into @string - Converts a #GString to lowercase. + Converts a #GString to lowercase. This function uses the locale-specific tolower() function, which is almost never the right thing. Use g_string_ascii_down() or g_utf8_strdown() instead. - the #GString + the #GString - a #GString + a #GString - Compares two strings for equality, returning %TRUE if they are equal. + Compares two strings for equality, returning %TRUE if they are equal. For use with #GHashTable. - %TRUE if the strings are the same length and contain the + %TRUE if the strings are the same length and contain the same bytes - a #GString + a #GString - another #GString + another #GString - Removes @len bytes from a #GString, starting at position @pos. + Removes @len bytes from a #GString, starting at position @pos. The rest of the #GString is shifted down to fill the gap. - @string + @string - a #GString + a #GString - the position of the content to remove + the position of the content to remove - the number of bytes to remove, or -1 to remove all + the number of bytes to remove, or -1 to remove all following bytes - Frees the memory allocated for the #GString. + Frees the memory allocated for the #GString. If @free_segment is %TRUE it also frees the character data. If it's %FALSE, the caller gains ownership of the buffer and must free it after use with g_free(). - the character data of @string + the character data of @string (i.e. %NULL if @free_segment is %TRUE) - a #GString + a #GString - if %TRUE, the actual character data is freed as well + if %TRUE, the actual character data is freed as well - Transfers ownership of the contents of @string to a newly allocated + Transfers ownership of the contents of @string to a newly allocated #GBytes. The #GString structure itself is deallocated, and it is therefore invalid to use @string after invoking this function. @@ -24016,77 +25621,77 @@ trailing nul character (not reflected in its "len"), the returned equal to the "len" member. - A newly allocated #GBytes containing contents of @string; @string itself is freed + A newly allocated #GBytes containing contents of @string; @string itself is freed - a #GString + a #GString - Creates a hash code for @str; for use with #GHashTable. + Creates a hash code for @str; for use with #GHashTable. - hash code for @str + hash code for @str - a string to hash + a string to hash - Inserts a copy of a string into a #GString, + Inserts a copy of a string into a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the position to insert the copy of the string + the position to insert the copy of the string - the string to insert + the string to insert - Inserts a byte into a #GString, expanding it if necessary. + Inserts a byte into a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the position to insert the byte + the position to insert the byte - the byte to insert + the byte to insert - Inserts @len bytes of @val into @string at @pos. + Inserts @len bytes of @val into @string at @pos. If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to @@ -24098,142 +25703,142 @@ is considered to request the entire string length. If @pos is -1, bytes are inserted at the end of the string. - @string + @string - a #GString + a #GString - position in @string where insertion should + position in @string where insertion should happen, or -1 for at the end - bytes to insert + bytes to insert - number of bytes of @val to insert, or -1 for all of @val + number of bytes of @val to insert, or -1 for all of @val - Converts a Unicode character into UTF-8, and insert it + Converts a Unicode character into UTF-8, and insert it into the string at the given position. - @string + @string - a #GString + a #GString - the position at which to insert character, or -1 + the position at which to insert character, or -1 to append at the end of the string - a Unicode character + a Unicode character - Overwrites part of a string, lengthening it if necessary. + Overwrites part of a string, lengthening it if necessary. - @string + @string - a #GString + a #GString - the position at which to start overwriting + the position at which to start overwriting - the string that will overwrite the @string starting at @pos + the string that will overwrite the @string starting at @pos - Overwrites part of a string, lengthening it if necessary. + Overwrites part of a string, lengthening it if necessary. This function will work with embedded nuls. - @string + @string - a #GString + a #GString - the position at which to start overwriting + the position at which to start overwriting - the string that will overwrite the @string starting at @pos + the string that will overwrite the @string starting at @pos - the number of bytes to write from @val + the number of bytes to write from @val - Adds a string on to the start of a #GString, + Adds a string on to the start of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the string to prepend on the start of @string + the string to prepend on the start of @string - Adds a byte onto the start of a #GString, + Adds a byte onto the start of a #GString, expanding it if necessary. - @string + @string - a #GString + a #GString - the byte to prepend on the start of the #GString + the byte to prepend on the start of the #GString - Prepends @len bytes of @val to @string. + Prepends @len bytes of @val to @string. If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to @@ -24244,45 +25849,45 @@ is considered to request the entire string length. This makes g_string_prepend_len() equivalent to g_string_prepend(). - @string + @string - a #GString + a #GString - bytes to prepend + bytes to prepend - number of bytes in @val to prepend, or -1 for all of @val + number of bytes in @val to prepend, or -1 for all of @val - Converts a Unicode character into UTF-8, and prepends it + Converts a Unicode character into UTF-8, and prepends it to the string. - @string + @string - a #GString + a #GString - a Unicode character + a Unicode character - Writes a formatted string into a #GString. + Writes a formatted string into a #GString. This is similar to the standard sprintf() function, except that the #GString buffer automatically expands to contain the results. The previous contents of the @@ -24293,78 +25898,78 @@ to contain the results. The previous contents of the - a #GString + a #GString - the string format. See the printf() documentation + the string format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Sets the length of a #GString. If the length is less than + Sets the length of a #GString. If the length is less than the current length, the string will be truncated. If the length is greater than the current length, the contents of the newly added area are undefined. (However, as always, string->str[string->len] will be a nul byte.) - @string + @string - a #GString + a #GString - the new length + the new length - Cuts off the end of the GString, leaving the first @len bytes. + Cuts off the end of the GString, leaving the first @len bytes. - @string + @string - a #GString + a #GString - the new size of @string + the new size of @string - Converts a #GString to uppercase. + Converts a #GString to uppercase. This function uses the locale-specific toupper() function, which is almost never the right thing. Use g_string_ascii_up() or g_utf8_strup() instead. - @string + @string - a #GString + a #GString - Writes a formatted string into a #GString. + Writes a formatted string into a #GString. This function is similar to g_string_printf() except that the arguments to the format string are passed as a va_list. @@ -24373,15 +25978,15 @@ the arguments to the format string are passed as a va_list. - a #GString + a #GString - the string format. See the printf() documentation + the string format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string @@ -24392,7 +25997,7 @@ the arguments to the format string are passed as a va_list. It should only be accessed by using the following functions. - Frees all strings contained within the #GStringChunk. + Frees all strings contained within the #GStringChunk. After calling g_string_chunk_clear() it is not safe to access any of the strings which were contained within it. @@ -24401,13 +26006,13 @@ access any of the strings which were contained within it. - a #GStringChunk + a #GStringChunk - Frees all memory allocated by the #GStringChunk. + Frees all memory allocated by the #GStringChunk. After calling g_string_chunk_free() it is not safe to access any of the strings which were contained within it. @@ -24416,13 +26021,13 @@ access any of the strings which were contained within it. - a #GStringChunk + a #GStringChunk - Adds a copy of @string to the #GStringChunk. + Adds a copy of @string to the #GStringChunk. It returns a pointer to the new copy of the string in the #GStringChunk. The characters in the string can be changed, if necessary, though you should not @@ -24435,23 +26040,23 @@ by g_string_chunk_insert_const() when looking for duplicates. - a pointer to the copy of @string within + a pointer to the copy of @string within the #GStringChunk - a #GStringChunk + a #GStringChunk - the string to add + the string to add - Adds a copy of @string to the #GStringChunk, unless the same + Adds a copy of @string to the #GStringChunk, unless the same string has already been added to the #GStringChunk with g_string_chunk_insert_const(). @@ -24466,23 +26071,23 @@ pointer to a string added with g_string_chunk_insert(), even if they do match. - a pointer to the new or existing copy of @string + a pointer to the new or existing copy of @string within the #GStringChunk - a #GStringChunk + a #GStringChunk - the string to add + the string to add - Adds a copy of the first @len bytes of @string to the #GStringChunk. + Adds a copy of the first @len bytes of @string to the #GStringChunk. The copy is nul-terminated. Since this function does not stop at nul bytes, it is the caller's @@ -24493,35 +26098,35 @@ The characters in the returned string can be changed, if necessary, though you should not change anything after the end of the string. - a pointer to the copy of @string within the #GStringChunk + a pointer to the copy of @string within the #GStringChunk - a #GStringChunk + a #GStringChunk - bytes to insert + bytes to insert - number of bytes of @string to insert, or -1 to insert a + number of bytes of @string to insert, or -1 to insert a nul-terminated string - Creates a new #GStringChunk. + Creates a new #GStringChunk. - a new #GStringChunk + a new #GStringChunk - the default size of the blocks of memory which are + the default size of the blocks of memory which are allocated to store the strings. If a particular string is larger than this default size, a larger block of memory will be allocated for it. @@ -24531,7 +26136,7 @@ though you should not change anything after the end of the string. - Creates a unique temporary directory for each unit test and uses + Creates a unique temporary directory for each unit test and uses g_set_user_dirs() to set XDG directories to point into subdirectories of it for the duration of the unit test. The directory tree is cleaned up after the test finishes successfully. Note that this doesn’t take effect until @@ -24553,7 +26158,7 @@ guaranteed to be stable API — always use a getter function to retrieve th The subdirectories may not be created by the test harness; as with normal calls to functions like g_get_user_cache_dir(), the caller must be prepared to create the directory if it doesn’t exist. - + @@ -24581,12 +26186,22 @@ to create the directory if it doesn’t exist. + + Works like g_mutex_trylock(), but for a lock defined with +#G_LOCK_DEFINE. + + + + the name of the lock + + + An opaque structure representing a test case. - + @@ -24637,7 +26252,7 @@ Note: as a general rule of automake, files that are generated only as part of the build-from-git process (but then are distributed with the tarball) always go in srcdir (even if doing a srcdir != builddir build from git) and are considered as distributed files. - + a file that was included in the distribution tarball @@ -24679,7 +26294,7 @@ zero then @fixture will be equal to @user_data. - + @@ -24689,8 +26304,8 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to free test log messages, no ABI guarantees provided. - + Internal function for gtester to free test log messages, no ABI guarantees provided. + @@ -24701,8 +26316,8 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to retrieve test log messages, no ABI guarantees provided. - + Internal function for gtester to retrieve test log messages, no ABI guarantees provided. + @@ -24713,8 +26328,8 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to decode test log messages, no ABI guarantees provided. - + Internal function for gtester to decode test log messages, no ABI guarantees provided. + @@ -24731,41 +26346,41 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to decode test log messages, no ABI guarantees provided. - + Internal function for gtester to decode test log messages, no ABI guarantees provided. + - Specifies the prototype of fatal log handler functions. - + Specifies the prototype of fatal log handler functions. + - %TRUE if the program should abort, %FALSE otherwise + %TRUE if the program should abort, %FALSE otherwise - the log domain of the message + the log domain of the message - the log level of the message (including the fatal and recursion flags) + the log level of the message (including the fatal and recursion flags) - the message to process + the message to process - user data, set in g_test_log_set_fatal_handler() + user data, set in g_test_log_set_fatal_handler() - + @@ -24782,8 +26397,8 @@ zero then @fixture will be equal to @user_data. - Internal function for gtester to free test log messages, no ABI guarantees provided. - + Internal function for gtester to free test log messages, no ABI guarantees provided. + @@ -24795,7 +26410,7 @@ zero then @fixture will be equal to @user_data. - + @@ -24822,7 +26437,7 @@ zero then @fixture will be equal to @user_data. - + @@ -24837,7 +26452,7 @@ zero then @fixture will be equal to @user_data. Note that in contrast with g_test_trap_fork(), the default is to not show stdout and stderr. - + If this flag is given, the child process will inherit the parent's stdin. Otherwise, the child's @@ -24860,67 +26475,67 @@ not show stdout and stderr. An opaque structure representing a test suite. - Adds @test_case to @suite. - + Adds @test_case to @suite. + - a #GTestSuite + a #GTestSuite - a #GTestCase + a #GTestCase - Adds @nestedsuite to @suite. - + Adds @nestedsuite to @suite. + - a #GTestSuite + a #GTestSuite - another #GTestSuite + another #GTestSuite - - Test traps are guards around forked tests. + + Test traps are guards around forked tests. These flags determine what traps to set. #GTestTrapFlags is used only with g_test_trap_fork(), which is deprecated. g_test_trap_subprocess() uses #GTestSubprocessFlags. - + - Redirect stdout of the test child to + Redirect stdout of the test child to `/dev/null` so it cannot be observed on the console during test runs. The actual output is still captured though to allow later tests with g_test_trap_assert_stdout(). - Redirect stderr of the test child to + Redirect stderr of the test child to `/dev/null` so it cannot be observed on the console during test runs. The actual output is still captured though to allow later tests with g_test_trap_assert_stderr(). - If this flag is given, stdin of the + If this flag is given, stdin of the child process is shared with stdin of its parent process. It is redirected to `/dev/null` otherwise. - The #GThread struct represents a running thread. This struct + The #GThread struct represents a running thread. This struct is returned by g_thread_new() or g_thread_try_new(). You can obtain the #GThread struct representing the current thread by calling g_thread_self(). @@ -24935,7 +26550,7 @@ The structure is opaque -- none of its fields may be directly accessed. - This function creates a new thread. The new thread starts by invoking + This function creates a new thread. The new thread starts by invoking @func with the argument data. The thread will run until @func returns or until g_thread_exit() is called from the new thread. The return value of @func becomes the return value of the thread, which can be obtained @@ -24956,52 +26571,52 @@ To free the struct returned by this function, use g_thread_unref(). Note that g_thread_join() implicitly unrefs the #GThread as well. - the new #GThread + the new #GThread - an (optional) name for the new thread + an (optional) name for the new thread - a function to execute in the new thread + a function to execute in the new thread - an argument to supply to the new thread + an argument to supply to the new thread - This function is the same as g_thread_new() except that + This function is the same as g_thread_new() except that it allows for the possibility of failure. If a thread can not be created (due to resource limits), @error is set and %NULL is returned. - the new #GThread, or %NULL if an error occurred + the new #GThread, or %NULL if an error occurred - an (optional) name for the new thread + an (optional) name for the new thread - a function to execute in the new thread + a function to execute in the new thread - an argument to supply to the new thread + an argument to supply to the new thread - Waits until @thread finishes, i.e. the function @func, as + Waits until @thread finishes, i.e. the function @func, as given to g_thread_new(), returns or g_thread_exit() is called. If @thread has already terminated, then g_thread_join() returns immediately. @@ -25019,32 +26634,32 @@ to be freed. Use g_thread_ref() to obtain an extra reference if you want to keep the GThread alive beyond the g_thread_join() call. - the return value of the thread + the return value of the thread - a #GThread + a #GThread - Increase the reference count on @thread. + Increase the reference count on @thread. - a new reference to @thread + a new reference to @thread - a #GThread + a #GThread - Decrease the reference count on @thread, possibly freeing all + Decrease the reference count on @thread, possibly freeing all resources associated with it. Note that each thread holds a reference to its #GThread while @@ -25056,7 +26671,7 @@ if you don't need it anymore. - a #GThread + a #GThread @@ -25067,7 +26682,7 @@ if you don't need it anymore. - Terminates the current thread. + Terminates the current thread. If another thread is waiting for us using g_thread_join() then the waiting thread will be woken up and get @retval as the return value @@ -25086,13 +26701,13 @@ or or from within a #GThreadPool. - the return value of this thread + the return value of this thread - This function returns the #GThread corresponding to the + This function returns the #GThread corresponding to the current thread. Note that this function does not increase the reference count of the returned struct. @@ -25103,12 +26718,12 @@ APIs). This may be useful for thread identification purposes as g_thread_join()) on these threads. - the #GThread representing the current thread + the #GThread representing the current thread - Causes the calling thread to voluntarily relinquish the CPU, so + Causes the calling thread to voluntarily relinquish the CPU, so that other threads can run. This function is often used as a method to make busy wait less evil. @@ -25119,47 +26734,47 @@ This function is often used as a method to make busy wait less evil. - Possible errors of thread related functions. + Possible errors of thread related functions. - a thread couldn't be created due to resource + a thread couldn't be created due to resource shortage. Try again later. - Specifies the type of the @func functions passed to g_thread_new() + Specifies the type of the @func functions passed to g_thread_new() or g_thread_try_new(). - the return value of the thread + the return value of the thread - data passed to the thread + data passed to the thread - The #GThreadPool struct represents a thread pool. It has three + The #GThreadPool struct represents a thread pool. It has three public read-only members, but the underlying struct is bigger, so you must not copy this struct. - the function to execute in the threads of this pool + the function to execute in the threads of this pool - the user data for the threads of this pool + the user data for the threads of this pool - are all threads exclusive to this pool + are all threads exclusive to this pool - Frees all resources allocated for @pool. + Frees all resources allocated for @pool. If @immediate is %TRUE, no new task is processed for @pool. Otherwise @pool is not freed before the last task is processed. @@ -25179,68 +26794,68 @@ After calling this function @pool must not be used anymore. - a #GThreadPool + a #GThreadPool - should @pool shut down immediately? + should @pool shut down immediately? - should the function wait for all tasks to be finished? + should the function wait for all tasks to be finished? - Returns the maximal number of threads for @pool. + Returns the maximal number of threads for @pool. - the maximal number of threads + the maximal number of threads - a #GThreadPool + a #GThreadPool - Returns the number of threads currently running in @pool. + Returns the number of threads currently running in @pool. - the number of threads currently running + the number of threads currently running - a #GThreadPool + a #GThreadPool - Moves the item to the front of the queue of unprocessed + Moves the item to the front of the queue of unprocessed items, so that it will be processed next. - %TRUE if the item was found and moved + %TRUE if the item was found and moved - a #GThreadPool + a #GThreadPool - an unprocessed item in the pool + an unprocessed item in the pool - Inserts @data into the list of tasks to be executed by @pool. + Inserts @data into the list of tasks to be executed by @pool. When the number of currently running threads is lower than the maximal allowed number of threads, a new thread is started (or @@ -25256,22 +26871,22 @@ work to do. Before version 2.32, this function did not return a success status. - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a #GThreadPool + a #GThreadPool - a new task for @pool + a new task for @pool - Sets the maximal allowed number of threads for @pool. + Sets the maximal allowed number of threads for @pool. A value of -1 means that the maximal number of threads is unlimited. If @pool is an exclusive thread pool, setting the maximal number of threads to -1 is not allowed. @@ -25293,23 +26908,23 @@ created. Before version 2.32, this function did not return a success status. - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - a #GThreadPool + a #GThreadPool - a new maximal number of threads for @pool, + a new maximal number of threads for @pool, or -1 for unlimited - Sets the function used to sort the list of tasks. This allows the + Sets the function used to sort the list of tasks. This allows the tasks to be processed by a priority determined by @func, and not just in the order in which they were added to the pool. @@ -25324,11 +26939,11 @@ created. - a #GThreadPool + a #GThreadPool - the #GCompareDataFunc used to sort the list of tasks. + the #GCompareDataFunc used to sort the list of tasks. This function is passed two tasks. It should return 0 if the order in which they are handled does not matter, a negative value if the first task should be processed before @@ -25337,27 +26952,27 @@ created. - user data passed to @func + user data passed to @func - Returns the number of tasks still unprocessed in @pool. + Returns the number of tasks still unprocessed in @pool. - the number of unprocessed tasks + the number of unprocessed tasks - a #GThreadPool + a #GThreadPool - This function will return the maximum @interval that a + This function will return the maximum @interval that a thread will wait in the thread pool for new tasks before being stopped. @@ -25365,30 +26980,30 @@ If this function returns 0, threads waiting in the thread pool for new work are not stopped. - the maximum @interval (milliseconds) to wait + the maximum @interval (milliseconds) to wait for new tasks in the thread pool before stopping the thread - Returns the maximal allowed number of unused threads. + Returns the maximal allowed number of unused threads. - the maximal number of unused threads + the maximal number of unused threads - Returns the number of currently unused threads. + Returns the number of currently unused threads. - the number of currently unused threads + the number of currently unused threads - This function creates a new thread pool. + This function creates a new thread pool. Whenever you call g_thread_pool_push(), either a new thread is created or an unused one is reused. At most @max_threads threads @@ -25417,32 +27032,32 @@ See #GThreadError for possible errors that may occur. Note, even in case of error a valid #GThreadPool is returned. - the new #GThreadPool + the new #GThreadPool - a function to execute in the threads of the new thread pool + a function to execute in the threads of the new thread pool - user data that is handed over to @func every time it + user data that is handed over to @func every time it is called - the maximal number of threads to execute concurrently + the maximal number of threads to execute concurrently in the new thread pool, -1 means no limit - should this thread pool be exclusive? + should this thread pool be exclusive? - This function will set the maximum @interval that a thread + This function will set the maximum @interval that a thread waiting in the pool for new tasks can be idle for before being stopped. This function is similar to calling g_thread_pool_stop_unused_threads() on a regular timeout, @@ -25457,14 +27072,14 @@ The default value is 15000 (15 seconds). - the maximum @interval (in milliseconds) + the maximum @interval (in milliseconds) a thread can be idle - Sets the maximal number of unused threads to @max_threads. + Sets the maximal number of unused threads to @max_threads. If @max_threads is -1, no limit is imposed on the number of unused threads. @@ -25475,13 +27090,13 @@ The default value is 2. - maximal number of unused threads + maximal number of unused threads - Stops all currently unused threads. This does not change the + Stops all currently unused threads. This does not change the maximal number of unused threads. This function can be used to regularly stop all unused threads e.g. from g_timeout_add(). @@ -25510,45 +27125,48 @@ transitions, for example). the time is in UTC - - Represents a precise time, with seconds and microseconds. + + Represents a precise time, with seconds and microseconds. Similar to the struct timeval returned by the gettimeofday() UNIX system call. -GLib is attempting to unify around the use of 64bit integers to +GLib is attempting to unify around the use of 64-bit integers to represent microsecond-precision time. As such, this type will be removed from a future version of GLib. A consequence of using `glong` for `tv_sec` is that on 32-bit systems `GTimeVal` is subject to the year 2038 problem. - + Use #GDateTime or #guint64 instead. + - seconds + seconds - microseconds + microseconds - - Adds the given number of microseconds to @time_. @microseconds can + + Adds the given number of microseconds to @time_. @microseconds can also be negative to decrease the value of @time_. - + #GTimeVal is not year-2038-safe. Use `guint64` for + representing microseconds since the epoch, or use #GDateTime. + - a #GTimeVal + a #GTimeVal - number of microseconds to add to @time + number of microseconds to add to @time - - Converts @time_ into an RFC 3339 encoded string, relative to the + + Converts @time_ into an RFC 3339 encoded string, relative to the Coordinated Universal Time (UTC). This is one of the many formats allowed by ISO 8601. @@ -25572,25 +27190,33 @@ variation of ISO 8601 format is required. If @time_ represents a date which is too large to fit into a `struct tm`, %NULL will be returned. This is platform dependent. Note also that since `GTimeVal` stores the number of seconds as a `glong`, on 32-bit systems it -is subject to the year 2038 problem. +is subject to the year 2038 problem. Accordingly, since GLib 2.62, this +function has been deprecated. Equivalent functionality is available using: +|[ +GDateTime *dt = g_date_time_new_from_unix_utc (time_val); +iso8601_string = g_date_time_format_iso8601 (dt); +g_date_time_unref (dt); +]| The return value of g_time_val_to_iso8601() has been nullable since GLib 2.54; before then, GLib would crash under the same conditions. - + #GTimeVal is not year-2038-safe. Use + g_date_time_format_iso8601(dt) instead. + - a newly allocated string containing an ISO 8601 date, + a newly allocated string containing an ISO 8601 date, or %NULL if @time_ was too large - a #GTimeVal + a #GTimeVal - - Converts a string containing an ISO 8601 encoded date and time + + Converts a string containing an ISO 8601 encoded date and time to a #GTimeVal and puts it into @time_. @iso_date must include year, month, day, hours, minutes, and @@ -25598,30 +27224,40 @@ seconds. It can optionally include fractions of a second and a time zone indicator. (In the absence of any time zone indication, the timestamp is assumed to be in local time.) -Any leading or trailing space in @iso_date is ignored. - +Any leading or trailing space in @iso_date is ignored. + +This function was deprecated, along with #GTimeVal itself, in GLib 2.62. +Equivalent functionality is available using code like: +|[ +GDateTime *dt = g_date_time_new_from_iso8601 (iso8601_string, NULL); +gint64 time_val = g_date_time_to_unix (dt); +g_date_time_unref (dt); +]| + #GTimeVal is not year-2038-safe. Use + g_date_time_new_from_iso8601() instead. + - %TRUE if the conversion was successful. + %TRUE if the conversion was successful. - an ISO 8601 encoded date string + an ISO 8601 encoded date string - a #GTimeVal + a #GTimeVal - #GTimeZone is an opaque structure whose members cannot be accessed + #GTimeZone is an opaque structure whose members cannot be accessed directly. - Creates a #GTimeZone corresponding to @identifier. + Creates a #GTimeZone corresponding to @identifier. @identifier can either be an RFC3339/ISO 8601 time offset or something that would pass as a valid value for the `TZ` environment @@ -25686,18 +27322,18 @@ You should release the return value by calling g_time_zone_unref() when you are done with it. - the requested timezone + the requested timezone - a timezone identifier + a timezone identifier - Creates a #GTimeZone corresponding to local time. The local time + Creates a #GTimeZone corresponding to local time. The local time zone may change between invocations to this function; for example, if the system administrator changes it. @@ -25708,30 +27344,30 @@ You should release the return value by calling g_time_zone_unref() when you are done with it. - the local timezone + the local timezone - Creates a #GTimeZone corresponding to the given constant offset from UTC, + Creates a #GTimeZone corresponding to the given constant offset from UTC, in seconds. This is equivalent to calling g_time_zone_new() with a string in the form `[+|-]hh[:mm[:ss]]`. - a timezone at the given offset from UTC + a timezone at the given offset from UTC - offset to UTC, in seconds + offset to UTC, in seconds - Creates a #GTimeZone corresponding to UTC. + Creates a #GTimeZone corresponding to UTC. This is equivalent to calling g_time_zone_new() with a value like "Z", "UTC", "+00", etc. @@ -25740,12 +27376,12 @@ You should release the return value by calling g_time_zone_unref() when you are done with it. - the universal timezone + the universal timezone - Finds an interval within @tz that corresponds to the given @time_, + Finds an interval within @tz that corresponds to the given @time_, possibly adjusting @time_ if required to fit into an interval. The meaning of @time_ depends on @type. @@ -25763,26 +27399,26 @@ adjust @time_ to be 03:00 and return the interval containing the adjusted time. - the interval containing @time_, never -1 + the interval containing @time_, never -1 - a #GTimeZone + a #GTimeZone - the #GTimeType of @time_ + the #GTimeType of @time_ - a pointer to a number of seconds since January 1, 1970 + a pointer to a number of seconds since January 1, 1970 - Finds an the interval within @tz that corresponds to the given @time_. + Finds an the interval within @tz that corresponds to the given @time_. The meaning of @time_ depends on @type. If @type is %G_TIME_TYPE_UNIVERSAL then this function will always @@ -25802,26 +27438,26 @@ forward to begin daylight savings time). -1 is returned in that case. - the interval containing @time_, or -1 in case of failure + the interval containing @time_, or -1 in case of failure - a #GTimeZone + a #GTimeZone - the #GTimeType of @time_ + the #GTimeType of @time_ - a number of seconds since January 1, 1970 + a number of seconds since January 1, 1970 - Determines the time zone abbreviation to be used during a particular + Determines the time zone abbreviation to be used during a particular @interval of time in the time zone @tz. For example, in Toronto this is currently "EST" during the winter @@ -25829,22 +27465,22 @@ months and "EDT" during the summer months when daylight savings time is in effect. - the time zone abbreviation, which belongs to @tz + the time zone abbreviation, which belongs to @tz - a #GTimeZone + a #GTimeZone - an interval within the timezone + an interval within the timezone - Get the identifier of this #GTimeZone, as passed to g_time_zone_new(). + Get the identifier of this #GTimeZone, as passed to g_time_zone_new(). If the identifier passed at construction time was not recognised, `UTC` will be returned. If it was %NULL, the identifier of the local timezone at construction time will be returned. @@ -25854,18 +27490,18 @@ construction time: if provided as a time offset, that will be returned by this function. - identifier for this timezone + identifier for this timezone - a #GTimeZone + a #GTimeZone - Determines the offset to UTC in effect during a particular @interval + Determines the offset to UTC in effect during a particular @interval of time in the time zone @tz. The offset is the number of seconds that you add to UTC time to @@ -25873,73 +27509,73 @@ arrive at local time for @tz (ie: negative numbers for time zones west of GMT, positive numbers for east). - the number of seconds that should be added to UTC to get the + the number of seconds that should be added to UTC to get the local time in @tz - a #GTimeZone + a #GTimeZone - an interval within the timezone + an interval within the timezone - Determines if daylight savings time is in effect during a particular + Determines if daylight savings time is in effect during a particular @interval of time in the time zone @tz. - %TRUE if daylight savings time is in effect + %TRUE if daylight savings time is in effect - a #GTimeZone + a #GTimeZone - an interval within the timezone + an interval within the timezone - Increases the reference count on @tz. + Increases the reference count on @tz. - a new reference to @tz. + a new reference to @tz. - a #GTimeZone + a #GTimeZone - Decreases the reference count on @tz. + Decreases the reference count on @tz. - a #GTimeZone + a #GTimeZone - Opaque datatype that records a start time. + Opaque datatype that records a start time. - Resumes a timer that has previously been stopped with + Resumes a timer that has previously been stopped with g_timer_stop(). g_timer_stop() must be called before using this function. @@ -25948,26 +27584,26 @@ function. - a #GTimer. + a #GTimer. - Destroys a timer, freeing associated resources. + Destroys a timer, freeing associated resources. - a #GTimer to destroy. + a #GTimer to destroy. - If @timer has been started but not stopped, obtains the time since + If @timer has been started but not stopped, obtains the time since the timer was started. If @timer has been stopped, obtains the elapsed time between the time it was started and the time it was stopped. The return value is the number of seconds elapsed, @@ -25975,31 +27611,75 @@ including any fractional part. The @microseconds out parameter is essentially useless. - seconds elapsed as a floating point value, including any + seconds elapsed as a floating point value, including any fractional part. - a #GTimer. + a #GTimer. - return location for the fractional part of seconds + return location for the fractional part of seconds elapsed, in microseconds (that is, the total number of microseconds elapsed, modulo 1000000), or %NULL + + Exposes whether the timer is currently active. + + + %TRUE if the timer is running, %FALSE otherwise + + + + + a #GTimer. + + + + - This function is useless; it's fine to call g_timer_start() on an + This function is useless; it's fine to call g_timer_start() on an already-started timer to reset the start time, so g_timer_reset() serves no purpose. + + + a #GTimer. + + + + + + Marks a start time, so that future calls to g_timer_elapsed() will +report the time since g_timer_start() was called. g_timer_new() +automatically marks the start time, so no need to call +g_timer_start() immediately after creating the timer. + + + + + + + a #GTimer. + + + + + + Marks an end time, so calls to g_timer_elapsed() will return the +difference between this end time and the start time. + + + + a #GTimer. @@ -26007,326 +27687,296 @@ serves no purpose. - - Marks a start time, so that future calls to g_timer_elapsed() will -report the time since g_timer_start() was called. g_timer_new() -automatically marks the start time, so no need to call -g_timer_start() immediately after creating the timer. - - - - - - - a #GTimer. - - - - - - Marks an end time, so calls to g_timer_elapsed() will return the -difference between this end time and the start time. - - - - - - - a #GTimer. - - - - - Creates a new timer, and starts timing (i.e. g_timer_start() is + Creates a new timer, and starts timing (i.e. g_timer_start() is implicitly called for you). - a new #GTimer. + a new #GTimer. - The possible types of token returned from each + The possible types of token returned from each g_scanner_get_next_token() call. - the end of the file + the end of the file - a '(' character + a '(' character - a ')' character + a ')' character - a '{' character + a '{' character - a '}' character + a '}' character - a '[' character + a '[' character - a ']' character + a ']' character - a '=' character + a '=' character - a ',' character + a ',' character - not a token + not a token - an error occurred + an error occurred - a character + a character - a binary integer + a binary integer - an octal integer + an octal integer - an integer + an integer - a hex integer + a hex integer - a floating point number + a floating point number - a string + a string - a symbol + a symbol - an identifier + an identifier - a null identifier + a null identifier - one line comment + one line comment - multi line comment + multi line comment - A union holding the value of the token. + A union holding the value of the token. - token symbol value + token symbol value - token identifier value + token identifier value - token binary integer value + token binary integer value - octal integer value + octal integer value - integer value + integer value - 64-bit integer value + 64-bit integer value - floating point value + floating point value - hex integer value + hex integer value - string value + string value - comment value + comment value - character value + character value - error value + error value - The type of functions which are used to translate user-visible + The type of functions which are used to translate user-visible strings, for <option>--help</option> output. - + - a translation of the string for the current locale. + a translation of the string for the current locale. The returned string is owned by GLib and must not be freed. - the untranslated string + the untranslated string - user data specified when installing the function, e.g. + user data specified when installing the function, e.g. in g_option_group_set_translate_func() - Each piece of memory that is pushed onto the stack + Each piece of memory that is pushed onto the stack is cast to a GTrashStack*. #GTrashStack is deprecated without replacement - + - pointer to the previous element of the stack, + pointer to the previous element of the stack, gets stored in the first `sizeof (gpointer)` bytes of the element - Returns the height of a #GTrashStack. + Returns the height of a #GTrashStack. Note that execution of this function is of O(N) complexity where N denotes the number of items on the stack. #GTrashStack is deprecated without replacement - + - the height of the stack + the height of the stack - a #GTrashStack + a #GTrashStack - Returns the element at the top of a #GTrashStack + Returns the element at the top of a #GTrashStack which may be %NULL. #GTrashStack is deprecated without replacement - + - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - Pops a piece of memory off a #GTrashStack. + Pops a piece of memory off a #GTrashStack. #GTrashStack is deprecated without replacement - + - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - Pushes a piece of memory onto a #GTrashStack. + Pushes a piece of memory onto a #GTrashStack. #GTrashStack is deprecated without replacement - + - a #GTrashStack + a #GTrashStack - the piece of memory to push on the stack + the piece of memory to push on the stack - Specifies which nodes are visited during several of the tree + Specifies which nodes are visited during several of the tree functions, including g_node_traverse() and g_node_find(). - only leaf nodes should be visited. This name has + only leaf nodes should be visited. This name has been introduced in 2.6, for older version use %G_TRAVERSE_LEAFS. - only non-leaf nodes should be visited. This + only non-leaf nodes should be visited. This name has been introduced in 2.6, for older version use %G_TRAVERSE_NON_LEAFS. - all nodes should be visited. + all nodes should be visited. - a mask of all traverse flags. + a mask of all traverse flags. - identical to %G_TRAVERSE_LEAVES. + identical to %G_TRAVERSE_LEAVES. - identical to %G_TRAVERSE_NON_LEAVES. + identical to %G_TRAVERSE_NON_LEAVES. - Specifies the type of function passed to g_tree_traverse(). It is + Specifies the type of function passed to g_tree_traverse(). It is passed the key and value of each node, together with the @user_data parameter passed to g_tree_traverse(). If the function returns %TRUE, the traversal is stopped. - %TRUE to stop the traversal + %TRUE to stop the traversal - a key of a #GTree node + a key of a #GTree node - the value corresponding to the key + the value corresponding to the key - user data passed to g_tree_traverse() + user data passed to g_tree_traverse() - Specifies the type of traveral performed by g_tree_traverse(), + Specifies the type of traveral performed by g_tree_traverse(), g_node_traverse() and g_node_find(). The different orders are illustrated here: - In order: A, B, C, D, E, F, G, H, I @@ -26339,19 +27989,19 @@ illustrated here: ![](Sorted_binary_tree_breadth-first_traversal.svg) - vists a node's left child first, then the node itself, + vists a node's left child first, then the node itself, then its right child. This is the one to use if you want the output sorted according to the compare function. - visits a node, then its children. + visits a node, then its children. - visits the node's children, then the node itself. + visits the node's children, then the node itself. - is not implemented for + is not implemented for [balanced binary trees][glib-Balanced-Binary-Trees]. For [n-ary trees][glib-N-ary-Trees], it vists the root node first, then its children, then @@ -26360,12 +28010,12 @@ illustrated here: - The GTree struct is an opaque data structure representing a + The GTree struct is an opaque data structure representing a [balanced binary tree][glib-Balanced-Binary-Trees]. It should be accessed only by using the following functions. - Removes all keys and values from the #GTree and decreases its + Removes all keys and values from the #GTree and decreases its reference count by one. If keys and/or values are dynamically allocated, you should either free them first or create the #GTree using g_tree_new_full(). In the latter case the destroy functions @@ -26377,13 +28027,13 @@ the #GTree. - a #GTree + a #GTree - Calls the given function for each of the key/value pairs in the #GTree. + Calls the given function for each of the key/value pairs in the #GTree. The function is passed the key and value of each pair, and the given @data parameter. The tree is traversed in sorted order. @@ -26397,40 +28047,40 @@ the tree, then walk the list and remove each item. - a #GTree + a #GTree - the function to call for each node visited. + the function to call for each node visited. If this function returns %TRUE, the traversal is stopped. - user data to pass to the function + user data to pass to the function - Gets the height of a #GTree. + Gets the height of a #GTree. If the #GTree contains no nodes, the height is 0. If the #GTree contains only one root node the height is 1. If the root node has children the height is 2, etc. - the height of @tree + the height of @tree - a #GTree + a #GTree - Inserts a key/value pair into a #GTree. + Inserts a key/value pair into a #GTree. If the given key already exists in the #GTree its corresponding value is set to the new value. If you supplied a @value_destroy_func when @@ -26446,101 +28096,101 @@ so that the distance from the root to every leaf is as small as possible. - a #GTree + a #GTree - the key to insert + the key to insert - the value corresponding to the key + the value corresponding to the key - Gets the value corresponding to the given key. Since a #GTree is + Gets the value corresponding to the given key. Since a #GTree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree). - the value corresponding to the key, or %NULL + the value corresponding to the key, or %NULL if the key was not found - a #GTree + a #GTree - the key to look up + the key to look up - Looks up a key in the #GTree, returning the original key and the + Looks up a key in the #GTree, returning the original key and the associated value. This is useful if you need to free the memory allocated for the original key, for example before calling g_tree_remove(). - %TRUE if the key was found in the #GTree + %TRUE if the key was found in the #GTree - a #GTree + a #GTree - the key to look up + the key to look up - - returns the original key + + returns the original key - - returns the value associated with the key + + returns the value associated with the key - Gets the number of nodes in a #GTree. + Gets the number of nodes in a #GTree. - the number of nodes in @tree + the number of nodes in @tree - a #GTree + a #GTree - Increments the reference count of @tree by one. + Increments the reference count of @tree by one. It is safe to call this function from any thread. - the passed in #GTree + the passed in #GTree - a #GTree + a #GTree - Removes a key/value pair from a #GTree. + Removes a key/value pair from a #GTree. If the #GTree was created using g_tree_new_full(), the key and value are freed using the supplied destroy functions, otherwise you have to @@ -26548,23 +28198,23 @@ make sure that any dynamically allocated values are freed yourself. If the key does not exist in the #GTree, the function does nothing. - %TRUE if the key was found (prior to 2.8, this function + %TRUE if the key was found (prior to 2.8, this function returned nothing) - a #GTree + a #GTree - the key to remove + the key to remove - Inserts a new key and value into a #GTree similar to g_tree_insert(). + Inserts a new key and value into a #GTree similar to g_tree_insert(). The difference is that if the key already exists in the #GTree, it gets replaced by the new key. If you supplied a @value_destroy_func when creating the #GTree, the old value is freed using that function. If you @@ -26579,21 +28229,21 @@ so that the distance from the root to every leaf is as small as possible. - a #GTree + a #GTree - the key to insert + the key to insert - the value corresponding to the key + the value corresponding to the key - Searches a #GTree using @search_func. + Searches a #GTree using @search_func. The @search_func is called with a pointer to the key of a key/value pair in the tree, and the passed in @user_data. If @search_func returns @@ -26604,49 +28254,49 @@ will proceed among the key/value pairs that have a smaller key; if pairs that have a larger key. - the value corresponding to the found key, or %NULL + the value corresponding to the found key, or %NULL if the key was not found + + + a #GTree + + + + a function used to search the #GTree + + + + the data passed as the second argument to @search_func + + + + + + Removes a key and its associated value from a #GTree without calling +the key and value destroy functions. + +If the key does not exist in the #GTree, the function does nothing. + + + %TRUE if the key was found (prior to 2.8, this function + returned nothing) + + a #GTree - - a function used to search the #GTree - - - - the data passed as the second argument to @search_func - - - - - - Removes a key and its associated value from a #GTree without calling -the key and value destroy functions. - -If the key does not exist in the #GTree, the function does nothing. - - - %TRUE if the key was found (prior to 2.8, this function - returned nothing) - - - - - a #GTree - - - the key to remove + the key to remove - Calls the given function for each node in the #GTree. + Calls the given function for each node in the #GTree. The order of a balanced tree is somewhat arbitrary. If you just want to visit all nodes in sorted order, use g_tree_foreach() instead. If you really need to visit nodes in @@ -26657,27 +28307,27 @@ If the key does not exist in the #GTree, the function does nothing. - a #GTree + a #GTree - the function to call for each node visited. If this + the function to call for each node visited. If this function returns %TRUE, the traversal is stopped. - the order in which nodes are visited, one of %G_IN_ORDER, + the order in which nodes are visited, one of %G_IN_ORDER, %G_PRE_ORDER and %G_POST_ORDER - user data to pass to the function + user data to pass to the function - Decrements the reference count of @tree by one. + Decrements the reference count of @tree by one. If the reference count drops to 0, all keys and values will be destroyed (if destroy functions were specified) and all memory allocated by @tree will be released. @@ -26689,21 +28339,21 @@ It is safe to call this function from any thread. - a #GTree + a #GTree - Creates a new #GTree. + Creates a new #GTree. - a newly allocated #GTree + a newly allocated #GTree - the function used to order the nodes in the #GTree. + the function used to order the nodes in the #GTree. It should return values similar to the standard strcmp() function - 0 if the two arguments are equal, a negative value if the first argument comes before the second, or a positive value if the first argument comes @@ -26713,31 +28363,31 @@ It is safe to call this function from any thread. - Creates a new #GTree like g_tree_new() and allows to specify functions + Creates a new #GTree like g_tree_new() and allows to specify functions to free the memory allocated for the key and value that get called when removing the entry from the #GTree. - a newly allocated #GTree + a newly allocated #GTree - qsort()-style comparison function + qsort()-style comparison function - data to pass to comparison function + data to pass to comparison function - a function to free the memory allocated for the key + a function to free the memory allocated for the key used when removing the entry from the #GTree or %NULL if you don't want to supply such a function - a function to free the memory allocated for the + a function to free the memory allocated for the value used when removing the entry from the #GTree or %NULL if you don't want to supply such a function @@ -26745,33 +28395,99 @@ removing the entry from the #GTree. - Creates a new #GTree with a comparison function that accepts user data. + Creates a new #GTree with a comparison function that accepts user data. See g_tree_new() for more details. - a newly allocated #GTree + a newly allocated #GTree - qsort()-style comparison function + qsort()-style comparison function - data to pass to comparison function + data to pass to comparison function + + This macro can be used to mark a function declaration as unavailable. +It must be placed before the function declaration. Use of a function +that has been annotated with this macros will produce a compiler warning. + + + + the major version that introduced the symbol + + + the minor version that introduced the symbol + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - The maximum length (in codepoints) of a compatibility or canonical + The maximum length (in codepoints) of a compatibility or canonical decomposition of a single Unicode character. This is as defined by Unicode 6.1. - + + + Hints the compiler that the expression is unlikely to evaluate to +a true value. The compiler may use this information for optimizations. + +|[<!-- language="C" --> +if (G_UNLIKELY (random () == 1)) + g_print ("a random one"); +]| + + + + the expression + + + + + Works like g_mutex_unlock(), but for a lock defined with +#G_LOCK_DEFINE. + + + + the name of the lock + + + Generic delimiters characters as defined in RFC 3986. Includes ":/?#[]@". @@ -26783,151 +28499,151 @@ This is as defined by Unicode 6.1. - Number of microseconds in one second (1 million). + Number of microseconds in one second (1 million). This macro is provided for code readability. - These are the possible line break classifications. + These are the possible line break classifications. Since new unicode versions may add new types here, applications should be ready to handle unknown values. They may be regarded as %G_UNICODE_BREAK_UNKNOWN. See [Unicode Line Breaking Algorithm](http://www.unicode.org/unicode/reports/tr14/). - + - Mandatory Break (BK) + Mandatory Break (BK) - Carriage Return (CR) + Carriage Return (CR) - Line Feed (LF) + Line Feed (LF) - Attached Characters and Combining Marks (CM) + Attached Characters and Combining Marks (CM) - Surrogates (SG) + Surrogates (SG) - Zero Width Space (ZW) + Zero Width Space (ZW) - Inseparable (IN) + Inseparable (IN) - Non-breaking ("Glue") (GL) + Non-breaking ("Glue") (GL) - Contingent Break Opportunity (CB) + Contingent Break Opportunity (CB) - Space (SP) + Space (SP) - Break Opportunity After (BA) + Break Opportunity After (BA) - Break Opportunity Before (BB) + Break Opportunity Before (BB) - Break Opportunity Before and After (B2) + Break Opportunity Before and After (B2) - Hyphen (HY) + Hyphen (HY) - Nonstarter (NS) + Nonstarter (NS) - Opening Punctuation (OP) + Opening Punctuation (OP) - Closing Punctuation (CL) + Closing Punctuation (CL) - Ambiguous Quotation (QU) + Ambiguous Quotation (QU) - Exclamation/Interrogation (EX) + Exclamation/Interrogation (EX) - Ideographic (ID) + Ideographic (ID) - Numeric (NU) + Numeric (NU) - Infix Separator (Numeric) (IS) + Infix Separator (Numeric) (IS) - Symbols Allowing Break After (SY) + Symbols Allowing Break After (SY) - Ordinary Alphabetic and Symbol Characters (AL) + Ordinary Alphabetic and Symbol Characters (AL) - Prefix (Numeric) (PR) + Prefix (Numeric) (PR) - Postfix (Numeric) (PO) + Postfix (Numeric) (PO) - Complex Content Dependent (South East Asian) (SA) + Complex Content Dependent (South East Asian) (SA) - Ambiguous (Alphabetic or Ideographic) (AI) + Ambiguous (Alphabetic or Ideographic) (AI) - Unknown (XX) + Unknown (XX) - Next Line (NL) + Next Line (NL) - Word Joiner (WJ) + Word Joiner (WJ) - Hangul L Jamo (JL) + Hangul L Jamo (JL) - Hangul V Jamo (JV) + Hangul V Jamo (JV) - Hangul T Jamo (JT) + Hangul T Jamo (JT) - Hangul LV Syllable (H2) + Hangul LV Syllable (H2) - Hangul LVT Syllable (H3) + Hangul LVT Syllable (H3) - Closing Parenthesis (CP). Since 2.28 + Closing Parenthesis (CP). Since 2.28 - Conditional Japanese Starter (CJ). Since: 2.32 + Conditional Japanese Starter (CJ). Since: 2.32 - Hebrew Letter (HL). Since: 2.32 + Hebrew Letter (HL). Since: 2.32 - Regional Indicator (RI). Since: 2.36 + Regional Indicator (RI). Since: 2.36 - Emoji Base (EB). Since: 2.50 + Emoji Base (EB). Since: 2.50 - Emoji Modifier (EM). Since: 2.50 + Emoji Modifier (EM). Since: 2.50 - Zero Width Joiner (ZWJ). Since: 2.50 + Zero Width Joiner (ZWJ). Since: 2.50 - The #GUnicodeScript enumeration identifies different writing + The #GUnicodeScript enumeration identifies different writing systems. The values correspond to the names as defined in the Unicode standard. The enumeration has been added in GLib 2.14, and is interchangeable with #PangoScript. @@ -26935,457 +28651,469 @@ and is interchangeable with #PangoScript. Note that new types may be added in the future. Applications should be ready to handle unknown values. See [Unicode Standard Annex #24: Script names](http://www.unicode.org/reports/tr24/). - + - a value never returned from g_unichar_get_script() + a value never returned from g_unichar_get_script() - a character used by multiple different scripts + a character used by multiple different scripts - a mark glyph that takes its script from the + a mark glyph that takes its script from the base glyph to which it is attached - Arabic + Arabic - Armenian + Armenian - Bengali + Bengali - Bopomofo + Bopomofo - Cherokee + Cherokee - Coptic + Coptic - Cyrillic + Cyrillic - Deseret + Deseret - Devanagari + Devanagari - Ethiopic + Ethiopic - Georgian + Georgian - Gothic + Gothic - Greek + Greek - Gujarati + Gujarati - Gurmukhi + Gurmukhi - Han + Han - Hangul + Hangul - Hebrew + Hebrew - Hiragana + Hiragana - Kannada + Kannada - Katakana + Katakana - Khmer + Khmer - Lao + Lao - Latin + Latin - Malayalam + Malayalam - Mongolian + Mongolian - Myanmar + Myanmar - Ogham + Ogham - Old Italic + Old Italic - Oriya + Oriya - Runic + Runic - Sinhala + Sinhala - Syriac + Syriac - Tamil + Tamil - Telugu + Telugu - Thaana + Thaana - Thai + Thai - Tibetan + Tibetan - Canadian Aboriginal + Canadian Aboriginal - Yi + Yi - Tagalog + Tagalog - Hanunoo + Hanunoo - Buhid + Buhid - Tagbanwa + Tagbanwa - Braille + Braille - Cypriot + Cypriot - Limbu + Limbu - Osmanya + Osmanya - Shavian + Shavian - Linear B + Linear B - Tai Le + Tai Le - Ugaritic + Ugaritic - New Tai Lue + New Tai Lue - Buginese + Buginese - Glagolitic + Glagolitic - Tifinagh + Tifinagh - Syloti Nagri + Syloti Nagri - Old Persian + Old Persian - Kharoshthi + Kharoshthi - an unassigned code point + an unassigned code point - Balinese + Balinese - Cuneiform + Cuneiform - Phoenician + Phoenician - Phags-pa + Phags-pa - N'Ko + N'Ko - Kayah Li. Since 2.16.3 + Kayah Li. Since 2.16.3 - Lepcha. Since 2.16.3 + Lepcha. Since 2.16.3 - Rejang. Since 2.16.3 + Rejang. Since 2.16.3 - Sundanese. Since 2.16.3 + Sundanese. Since 2.16.3 - Saurashtra. Since 2.16.3 + Saurashtra. Since 2.16.3 - Cham. Since 2.16.3 + Cham. Since 2.16.3 - Ol Chiki. Since 2.16.3 + Ol Chiki. Since 2.16.3 - Vai. Since 2.16.3 + Vai. Since 2.16.3 - Carian. Since 2.16.3 + Carian. Since 2.16.3 - Lycian. Since 2.16.3 + Lycian. Since 2.16.3 - Lydian. Since 2.16.3 + Lydian. Since 2.16.3 - Avestan. Since 2.26 + Avestan. Since 2.26 - Bamum. Since 2.26 + Bamum. Since 2.26 - Egyptian Hieroglpyhs. Since 2.26 + Egyptian Hieroglpyhs. Since 2.26 - Imperial Aramaic. Since 2.26 + Imperial Aramaic. Since 2.26 - Inscriptional Pahlavi. Since 2.26 + Inscriptional Pahlavi. Since 2.26 - Inscriptional Parthian. Since 2.26 + Inscriptional Parthian. Since 2.26 - Javanese. Since 2.26 + Javanese. Since 2.26 - Kaithi. Since 2.26 + Kaithi. Since 2.26 - Lisu. Since 2.26 + Lisu. Since 2.26 - Meetei Mayek. Since 2.26 + Meetei Mayek. Since 2.26 - Old South Arabian. Since 2.26 + Old South Arabian. Since 2.26 - Old Turkic. Since 2.28 + Old Turkic. Since 2.28 - Samaritan. Since 2.26 + Samaritan. Since 2.26 - Tai Tham. Since 2.26 + Tai Tham. Since 2.26 - Tai Viet. Since 2.26 + Tai Viet. Since 2.26 - Batak. Since 2.28 + Batak. Since 2.28 - Brahmi. Since 2.28 + Brahmi. Since 2.28 - Mandaic. Since 2.28 + Mandaic. Since 2.28 - Chakma. Since: 2.32 + Chakma. Since: 2.32 - Meroitic Cursive. Since: 2.32 + Meroitic Cursive. Since: 2.32 - Meroitic Hieroglyphs. Since: 2.32 + Meroitic Hieroglyphs. Since: 2.32 - Miao. Since: 2.32 + Miao. Since: 2.32 - Sharada. Since: 2.32 + Sharada. Since: 2.32 - Sora Sompeng. Since: 2.32 + Sora Sompeng. Since: 2.32 - Takri. Since: 2.32 + Takri. Since: 2.32 - Bassa. Since: 2.42 + Bassa. Since: 2.42 - Caucasian Albanian. Since: 2.42 + Caucasian Albanian. Since: 2.42 - Duployan. Since: 2.42 + Duployan. Since: 2.42 - Elbasan. Since: 2.42 + Elbasan. Since: 2.42 - Grantha. Since: 2.42 + Grantha. Since: 2.42 - Kjohki. Since: 2.42 + Kjohki. Since: 2.42 - Khudawadi, Sindhi. Since: 2.42 + Khudawadi, Sindhi. Since: 2.42 - Linear A. Since: 2.42 + Linear A. Since: 2.42 - Mahajani. Since: 2.42 + Mahajani. Since: 2.42 - Manichaean. Since: 2.42 + Manichaean. Since: 2.42 - Mende Kikakui. Since: 2.42 + Mende Kikakui. Since: 2.42 - Modi. Since: 2.42 + Modi. Since: 2.42 - Mro. Since: 2.42 + Mro. Since: 2.42 - Nabataean. Since: 2.42 + Nabataean. Since: 2.42 - Old North Arabian. Since: 2.42 + Old North Arabian. Since: 2.42 - Old Permic. Since: 2.42 + Old Permic. Since: 2.42 - Pahawh Hmong. Since: 2.42 + Pahawh Hmong. Since: 2.42 - Palmyrene. Since: 2.42 + Palmyrene. Since: 2.42 - Pau Cin Hau. Since: 2.42 + Pau Cin Hau. Since: 2.42 - Psalter Pahlavi. Since: 2.42 + Psalter Pahlavi. Since: 2.42 - Siddham. Since: 2.42 + Siddham. Since: 2.42 - Tirhuta. Since: 2.42 + Tirhuta. Since: 2.42 - Warang Citi. Since: 2.42 + Warang Citi. Since: 2.42 - Ahom. Since: 2.48 + Ahom. Since: 2.48 - Anatolian Hieroglyphs. Since: 2.48 + Anatolian Hieroglyphs. Since: 2.48 - Hatran. Since: 2.48 + Hatran. Since: 2.48 - Multani. Since: 2.48 + Multani. Since: 2.48 - Old Hungarian. Since: 2.48 + Old Hungarian. Since: 2.48 - Signwriting. Since: 2.48 + Signwriting. Since: 2.48 - Adlam. Since: 2.50 + Adlam. Since: 2.50 - Bhaiksuki. Since: 2.50 + Bhaiksuki. Since: 2.50 - Marchen. Since: 2.50 + Marchen. Since: 2.50 - Newa. Since: 2.50 + Newa. Since: 2.50 - Osage. Since: 2.50 + Osage. Since: 2.50 - Tangut. Since: 2.50 + Tangut. Since: 2.50 - Masaram Gondi. Since: 2.54 + Masaram Gondi. Since: 2.54 - Nushu. Since: 2.54 + Nushu. Since: 2.54 - Soyombo. Since: 2.54 + Soyombo. Since: 2.54 - Zanabazar Square. Since: 2.54 + Zanabazar Square. Since: 2.54 - Dogra. Since: 2.58 + Dogra. Since: 2.58 - Gunjala Gondi. Since: 2.58 + Gunjala Gondi. Since: 2.58 - Hanifi Rohingya. Since: 2.58 + Hanifi Rohingya. Since: 2.58 - Makasar. Since: 2.58 + Makasar. Since: 2.58 - Medefaidrin. Since: 2.58 + Medefaidrin. Since: 2.58 - Old Sogdian. Since: 2.58 + Old Sogdian. Since: 2.58 - Sogdian. Since: 2.58 + Sogdian. Since: 2.58 + + + Elym. Since: 2.62 + + + Nand. Since: 2.62 + + + Rohg. Since: 2.62 + + + Wcho. Since: 2.62 @@ -27544,12 +29272,96 @@ enumeration. the number of enum values + + A stack-allocated #GVariantBuilder must be initialized if it is +used together with g_auto() to avoid warnings or crashes if +function returns before g_variant_builder_init() is called on the +builder. This macro can be used as initializer instead of an +explicit zeroing a variable when declaring it and a following +g_variant_builder_init(), but it cannot be assigned to a variable. + +The passed @variant_type should be a static GVariantType to avoid +lifetime issues, as copying the @variant_type does not happen in +the G_VARIANT_BUILDER_INIT() call, but rather in functions that +make sure that #GVariantBuilder is valid. + +|[ + g_auto(GVariantBuilder) builder = G_VARIANT_BUILDER_INIT (G_VARIANT_TYPE_BYTESTRING); +]| + + + + a const GVariantType* + + + + + A stack-allocated #GVariantDict must be initialized if it is used +together with g_auto() to avoid warnings or crashes if function +returns before g_variant_dict_init() is called on the builder. +This macro can be used as initializer instead of an explicit +zeroing a variable when declaring it and a following +g_variant_dict_init(), but it cannot be assigned to a variable. + +The passed @asv has to live long enough for #GVariantDict to gather +the entries from, as the gathering does not happen in the +G_VARIANT_DICT_INIT() call, but rather in functions that make sure +that #GVariantDict is valid. In context where the initialization +value has to be a constant expression, the only possible value of +@asv is %NULL. It is still possible to call g_variant_dict_init() +safely with a different @asv right after the variable was +initialized with G_VARIANT_DICT_INIT(). + +|[ + g_autoptr(GVariant) variant = get_asv_variant (); + g_auto(GVariantDict) dict = G_VARIANT_DICT_INIT (variant); +]| + + + + a GVariant* + + + + + Converts a string to a const #GVariantType. Depending on the +current debugging level, this function may perform a runtime check +to ensure that @string is a valid GVariant type string. + +It is always a programmer error to use this macro with an invalid +type string. If in doubt, use g_variant_type_string_is_valid() to +check if the string is valid. + +Since 2.24 + + + + a well-formed #GVariantType type string + + + + + Portable way to copy va_list variables. + +In order to use this function, you must include string.h yourself, +because this macro may use memmove() and GLib does not include +string.h for you. + + + + the va_list variable to place a copy of @ap2 in + + + a va_list + + + - + - A macro that should be defined by the user prior to including + A macro that should be defined by the user prior to including the glib.h header. The definition should be one of the predefined GLib version macros: %GLIB_VERSION_2_26, %GLIB_VERSION_2_28,... @@ -27561,11 +29373,11 @@ If the compiler is configured to warn about the use of deprecated functions, then using functions that were deprecated in version %GLIB_VERSION_MIN_REQUIRED or earlier will cause warnings (but using functions deprecated in later releases will not). - + - #GVariant is a variant datatype; it can contain one or more values + #GVariant is a variant datatype; it can contain one or more values along with information about the type of the values. A #GVariant may contain simple types, like an integer, or a boolean value; @@ -27751,7 +29563,7 @@ This means that in total, for our "a{sv}" example, 91 bytes of type information would be allocated. The type information cache, additionally, uses a #GHashTable to -store and lookup the cached items and stores a pointer to this +store and look up the cached items and stores a pointer to this hash table in static storage. The hash table is freed when there are zero items in the type cache. @@ -27809,7 +29621,7 @@ management for those dictionaries, but the type information would be shared. - Creates a new #GVariant instance. + Creates a new #GVariant instance. Think of this function as an analogue to g_strdup_printf(). @@ -27839,22 +29651,22 @@ new_variant = g_variant_new ("(t^as)", ]| - a new floating #GVariant instance + a new floating #GVariant instance - a #GVariant format string + a #GVariant format string - arguments, as per @format_string + arguments, as per @format_string - Creates a new #GVariant array from @children. + Creates a new #GVariant array from @children. @child_type must be non-%NULL if @n_children is zero. Otherwise, the child type is determined by inspecting the first element of the @@ -27871,57 +29683,57 @@ If the @children are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink(). - a floating reference to a new #GVariant array + a floating reference to a new #GVariant array - the element type of the new array + the element type of the new array - an array of + an array of #GVariant pointers, the children - the length of @children + the length of @children - Creates a new boolean #GVariant instance -- either %TRUE or %FALSE. + Creates a new boolean #GVariant instance -- either %TRUE or %FALSE. - a floating reference to a new boolean #GVariant instance + a floating reference to a new boolean #GVariant instance - a #gboolean value + a #gboolean value - Creates a new byte #GVariant instance. + Creates a new byte #GVariant instance. - a floating reference to a new byte #GVariant instance + a floating reference to a new byte #GVariant instance - a #guint8 value + a #guint8 value - Creates an array-of-bytes #GVariant with the contents of @string. + Creates an array-of-bytes #GVariant with the contents of @string. This function is just like g_variant_new_string() except that the string need not be valid UTF-8. @@ -27929,12 +29741,12 @@ The nul terminator character at the end of the string is stored in the array. - a floating reference to a new bytestring #GVariant instance + a floating reference to a new bytestring #GVariant instance - a normal + a normal nul-terminated string in no particular encoding @@ -27943,66 +29755,66 @@ the array. - Constructs an array of bytestring #GVariant from the given array of + Constructs an array of bytestring #GVariant from the given array of strings. If @length is -1 then @strv is %NULL-terminated. - a new floating #GVariant instance + a new floating #GVariant instance - an array of strings + an array of strings - the length of @strv, or -1 + the length of @strv, or -1 - Creates a new dictionary entry #GVariant. @key and @value must be + Creates a new dictionary entry #GVariant. @key and @value must be non-%NULL. @key must be a value of a basic type (ie: not a container). If the @key or @value are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink(). - a floating reference to a new dictionary entry #GVariant + a floating reference to a new dictionary entry #GVariant - a basic #GVariant, the key + a basic #GVariant, the key - a #GVariant, the value + a #GVariant, the value - Creates a new double #GVariant instance. + Creates a new double #GVariant instance. - a floating reference to a new double #GVariant instance + a floating reference to a new double #GVariant instance - a #gdouble floating point value + a #gdouble floating point value - Constructs a new array #GVariant instance, where the elements are + Constructs a new array #GVariant instance, where the elements are of @element_type type. @elements must be an array with fixed-sized elements. Numeric types are @@ -28017,30 +29829,30 @@ expectation. @n_elements must be the length of the @elements array. - a floating reference to a new array #GVariant instance + a floating reference to a new array #GVariant instance - the #GVariantType of each element + the #GVariantType of each element - a pointer to the fixed array of contiguous elements + a pointer to the fixed array of contiguous elements - the number of elements + the number of elements - the size of each element + the size of each element - Constructs a new serialised-mode #GVariant instance. This is the + Constructs a new serialised-mode #GVariant instance. This is the inner interface for creation of new serialised values that gets called from various functions in gvariant.c. @@ -28051,26 +29863,26 @@ Otherwise this function will internally create a copy of the memory (since GLib 2.60) or (in older versions) fail and exit the process. - a new #GVariant with a floating reference + a new #GVariant with a floating reference - a #GVariantType + a #GVariantType - a #GBytes + a #GBytes - if the contents of @bytes are trusted + if the contents of @bytes are trusted - Creates a new #GVariant instance from serialised data. + Creates a new #GVariant instance from serialised data. @type is the type of #GVariant instance that will be constructed. The interpretation of @data depends on knowing the type. @@ -28101,100 +29913,100 @@ the memory (since GLib 2.60) or (in older versions) fail and exit the process. - a new floating #GVariant of type @type + a new floating #GVariant of type @type - a definite #GVariantType + a definite #GVariantType - the serialised data + the serialised data - the size of @data + the size of @data - %TRUE if @data is definitely in normal form + %TRUE if @data is definitely in normal form - function to call when @data is no longer needed + function to call when @data is no longer needed - data for @notify + data for @notify - Creates a new handle #GVariant instance. + Creates a new handle #GVariant instance. By convention, handles are indexes into an array of file descriptors that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them. - a floating reference to a new handle #GVariant instance + a floating reference to a new handle #GVariant instance - a #gint32 value + a #gint32 value - Creates a new int16 #GVariant instance. + Creates a new int16 #GVariant instance. - a floating reference to a new int16 #GVariant instance + a floating reference to a new int16 #GVariant instance - a #gint16 value + a #gint16 value - Creates a new int32 #GVariant instance. + Creates a new int32 #GVariant instance. - a floating reference to a new int32 #GVariant instance + a floating reference to a new int32 #GVariant instance - a #gint32 value + a #gint32 value - Creates a new int64 #GVariant instance. + Creates a new int64 #GVariant instance. - a floating reference to a new int64 #GVariant instance + a floating reference to a new int64 #GVariant instance - a #gint64 value + a #gint64 value - Depending on if @child is %NULL, either wraps @child inside of a + Depending on if @child is %NULL, either wraps @child inside of a maybe container or creates a Nothing instance for the given @type. At least one of @child_type and @child must be non-%NULL. @@ -28206,38 +30018,38 @@ If @child is a floating reference (see g_variant_ref_sink()), the new instance takes ownership of @child. - a floating reference to a new #GVariant maybe instance + a floating reference to a new #GVariant maybe instance - the #GVariantType of the child, or %NULL + the #GVariantType of the child, or %NULL - the child value, or %NULL + the child value, or %NULL - Creates a D-Bus object path #GVariant with the contents of @string. + Creates a D-Bus object path #GVariant with the contents of @string. @string must be a valid D-Bus object path. Use g_variant_is_object_path() if you're not sure. - a floating reference to a new object path #GVariant instance + a floating reference to a new object path #GVariant instance - a normal C nul-terminated string + a normal C nul-terminated string - Constructs an array of object paths #GVariant from the given array of + Constructs an array of object paths #GVariant from the given array of strings. Each string must be a valid #GVariant object path; see @@ -28246,24 +30058,24 @@ g_variant_is_object_path(). If @length is -1 then @strv is %NULL-terminated. - a new floating #GVariant instance + a new floating #GVariant instance - an array of strings + an array of strings - the length of @strv, or -1 + the length of @strv, or -1 - Parses @format and returns the result. + Parses @format and returns the result. @format must be a text format #GVariant with one extension: at any point that a value may appear in the text, a '%' character followed @@ -28297,22 +30109,22 @@ be anything along the lines of "%*", "%?", "\%r", or anything starting with "%@". - a new floating #GVariant instance + a new floating #GVariant instance - a text format #GVariant + a text format #GVariant - arguments as per @format + arguments as per @format - Parses @format and returns the result. + Parses @format and returns the result. This is the version of g_variant_new_parsed() intended to be used from libraries. @@ -28335,102 +30147,102 @@ result. This can also be done by adding the result to a container, or by passing it to another g_variant_new() call. - a new, usually floating, #GVariant + a new, usually floating, #GVariant - a text format #GVariant + a text format #GVariant - a pointer to a #va_list + a pointer to a #va_list - Creates a string-type GVariant using printf formatting. + Creates a string-type GVariant using printf formatting. This is similar to calling g_strdup_printf() and then g_variant_new_string() but it saves a temporary variable and an unnecessary copy. - a floating reference to a new string + a floating reference to a new string #GVariant instance - a printf-style format string + a printf-style format string - arguments for @format_string + arguments for @format_string - Creates a D-Bus type signature #GVariant with the contents of + Creates a D-Bus type signature #GVariant with the contents of @string. @string must be a valid D-Bus type signature. Use g_variant_is_signature() if you're not sure. - a floating reference to a new signature #GVariant instance + a floating reference to a new signature #GVariant instance - a normal C nul-terminated string + a normal C nul-terminated string - Creates a string #GVariant with the contents of @string. + Creates a string #GVariant with the contents of @string. @string must be valid UTF-8, and must not be %NULL. To encode potentially-%NULL strings, use g_variant_new() with `ms` as the [format string][gvariant-format-strings-maybe-types]. - a floating reference to a new string #GVariant instance + a floating reference to a new string #GVariant instance - a normal UTF-8 nul-terminated string + a normal UTF-8 nul-terminated string - Constructs an array of strings #GVariant from the given array of + Constructs an array of strings #GVariant from the given array of strings. If @length is -1 then @strv is %NULL-terminated. - a new floating #GVariant instance + a new floating #GVariant instance - an array of strings + an array of strings - the length of @strv, or -1 + the length of @strv, or -1 - Creates a string #GVariant with the contents of @string. + Creates a string #GVariant with the contents of @string. @string must be valid UTF-8, and must not be %NULL. To encode potentially-%NULL strings, use this with g_variant_new_maybe(). @@ -28443,19 +30255,19 @@ it to this function. It is even possible that @string is immediately freed. - a floating reference to a new string + a floating reference to a new string #GVariant instance - a normal UTF-8 nul-terminated string + a normal UTF-8 nul-terminated string - Creates a new tuple #GVariant out of the items in @children. The + Creates a new tuple #GVariant out of the items in @children. The type is determined from the types of @children. No entry in the @children array may be %NULL. @@ -28465,66 +30277,66 @@ If the @children are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink(). - a floating reference to a new #GVariant tuple + a floating reference to a new #GVariant tuple - the items to make the tuple out of + the items to make the tuple out of - the length of @children + the length of @children - Creates a new uint16 #GVariant instance. + Creates a new uint16 #GVariant instance. - a floating reference to a new uint16 #GVariant instance + a floating reference to a new uint16 #GVariant instance - a #guint16 value + a #guint16 value - Creates a new uint32 #GVariant instance. + Creates a new uint32 #GVariant instance. - a floating reference to a new uint32 #GVariant instance + a floating reference to a new uint32 #GVariant instance - a #guint32 value + a #guint32 value - Creates a new uint64 #GVariant instance. + Creates a new uint64 #GVariant instance. - a floating reference to a new uint64 #GVariant instance + a floating reference to a new uint64 #GVariant instance - a #guint64 value + a #guint64 value - This function is intended to be used by libraries based on + This function is intended to be used by libraries based on #GVariant that want to provide g_variant_new()-like functionality to their users. @@ -28562,45 +30374,45 @@ result. This can also be done by adding the result to a container, or by passing it to another g_variant_new() call. - a new, usually floating, #GVariant + a new, usually floating, #GVariant - a string that is prefixed with a format string + a string that is prefixed with a format string - location to store the end pointer, + location to store the end pointer, or %NULL - a pointer to a #va_list + a pointer to a #va_list - Boxes @value. The result is a #GVariant instance representing a + Boxes @value. The result is a #GVariant instance representing a variant containing the original value. If @child is a floating reference (see g_variant_ref_sink()), the new instance takes ownership of @child. - a floating reference to a new variant #GVariant instance + a floating reference to a new variant #GVariant instance - a #GVariant instance + a #GVariant instance - Performs a byteswapping operation on the contents of @value. The + Performs a byteswapping operation on the contents of @value. The result is that all multi-byte numeric data contained in @value is byteswapped. That includes 16, 32, and 64bit signed and unsigned integers as well as file handles and double precision floating point @@ -28613,18 +30425,18 @@ bytes and containers containing only these things (recursively). The returned value is always in normal form and is marked as trusted. - the byteswapped form of @value + the byteswapped form of @value - a #GVariant + a #GVariant - Checks if calling g_variant_get() with @format_string on @value would + Checks if calling g_variant_get() with @format_string on @value would be valid from a type-compatibility standpoint. @format_string is assumed to be a valid format string (from a syntactic standpoint). @@ -28640,40 +30452,40 @@ varargs accessors to #GVariant values of uncertain values (eg: g_variant_lookup() or g_menu_model_get_item_attribute()). - %TRUE if @format_string is safe to use + %TRUE if @format_string is safe to use - a #GVariant + a #GVariant - a valid #GVariant format string + a valid #GVariant format string - %TRUE to ensure the format string makes deep copies + %TRUE to ensure the format string makes deep copies - Classifies @value according to its top-level type. + Classifies @value according to its top-level type. - the #GVariantClass of @value + the #GVariantClass of @value - a #GVariant + a #GVariant - Compares @one and @two. + Compares @one and @two. The types of @one and @two are #gconstpointer only to allow use of this function with #GTree, #GPtrArray, etc. They must each be a @@ -28694,30 +30506,30 @@ If you only require an equality comparison, g_variant_equal() is more general. - negative value if a < b; + negative value if a < b; zero if a = b; positive value if a > b. - a basic-typed #GVariant instance + a basic-typed #GVariant instance - a #GVariant instance of the same type + a #GVariant instance of the same type - Similar to g_variant_get_bytestring() except that instead of + Similar to g_variant_get_bytestring() except that instead of returning a constant string, the string is duplicated. The return value must be freed using g_free(). - + a newly allocated string @@ -28725,18 +30537,18 @@ The return value must be freed using g_free(). - an array-of-bytes #GVariant instance + an array-of-bytes #GVariant instance - a pointer to a #gsize, to store + a pointer to a #gsize, to store the length (not including the nul terminator) - Gets the contents of an array of array of bytes #GVariant. This call + Gets the contents of an array of array of bytes #GVariant. This call makes a deep copy; the return result should be released with g_strfreev(). @@ -28748,24 +30560,24 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of strings + an array of strings - an array of array of bytes #GVariant ('aay') + an array of array of bytes #GVariant ('aay') - the length of the result, or %NULL + the length of the result, or %NULL - Gets the contents of an array of object paths #GVariant. This call + Gets the contents of an array of object paths #GVariant. This call makes a deep copy; the return result should be released with g_strfreev(). @@ -28777,24 +30589,24 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of strings + an array of strings - an array of object paths #GVariant + an array of object paths #GVariant - the length of the result, or %NULL + the length of the result, or %NULL - Similar to g_variant_get_string() except that instead of returning + Similar to g_variant_get_string() except that instead of returning a constant string, the string is duplicated. The string will always be UTF-8 encoded. @@ -28802,22 +30614,22 @@ The string will always be UTF-8 encoded. The return value must be freed using g_free(). - a newly allocated string, UTF-8 encoded + a newly allocated string, UTF-8 encoded - a string #GVariant instance + a string #GVariant instance - a pointer to a #gsize, to store the length + a pointer to a #gsize, to store the length - Gets the contents of an array of strings #GVariant. This call + Gets the contents of an array of strings #GVariant. This call makes a deep copy; the return result should be released with g_strfreev(). @@ -28829,45 +30641,45 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of strings + an array of strings - an array of strings #GVariant + an array of strings #GVariant - the length of the result, or %NULL + the length of the result, or %NULL - Checks if @one and @two have the same type and value. + Checks if @one and @two have the same type and value. The types of @one and @two are #gconstpointer only to allow use of this function with #GHashTable. They must each be a #GVariant. - %TRUE if @one and @two are equal + %TRUE if @one and @two are equal - a #GVariant instance + a #GVariant instance - a #GVariant instance + a #GVariant instance - Deconstructs a #GVariant instance. + Deconstructs a #GVariant instance. Think of this function as an analogue to scanf(). @@ -28889,55 +30701,55 @@ see the section on - a #GVariant instance + a #GVariant instance - a #GVariant format string + a #GVariant format string - arguments, as per @format_string + arguments, as per @format_string - Returns the boolean value of @value. + Returns the boolean value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_BOOLEAN. - %TRUE or %FALSE + %TRUE or %FALSE - a boolean #GVariant instance + a boolean #GVariant instance - Returns the byte value of @value. + Returns the byte value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_BYTE. - a #guint8 + a #guint8 - a byte #GVariant instance + a byte #GVariant instance - Returns the string value of a #GVariant instance with an + Returns the string value of a #GVariant instance with an array-of-bytes type. The string has no particular encoding. If the array does not end with a nul terminator character, the empty @@ -28957,7 +30769,7 @@ array of bytes. The return value remains valid as long as @value exists. - + the constant string @@ -28965,13 +30777,13 @@ The return value remains valid as long as @value exists. - an array-of-bytes #GVariant instance + an array-of-bytes #GVariant instance - Gets the contents of an array of array of bytes #GVariant. This call + Gets the contents of an array of array of bytes #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified. @@ -28983,24 +30795,24 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of constant strings + an array of constant strings - an array of array of bytes #GVariant ('aay') + an array of array of bytes #GVariant ('aay') - the length of the result, or %NULL + the length of the result, or %NULL - Reads a child item out of a container #GVariant instance and + Reads a child item out of a container #GVariant instance and deconstructs it according to @format_string. This call is essentially a combination of g_variant_get_child_value() and g_variant_get(). @@ -29015,25 +30827,25 @@ see the section on - a container #GVariant + a container #GVariant - the index of the child to deconstruct + the index of the child to deconstruct - a #GVariant format string + a #GVariant format string - arguments, as per @format_string + arguments, as per @format_string - Reads a child item out of a container #GVariant instance. This + Reads a child item out of a container #GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of #GVariant. @@ -29052,22 +30864,22 @@ nesting up to at least 64 levels. This function is O(1). - the child at the specified index + the child at the specified index - a container #GVariant + a container #GVariant - the index of the child to fetch + the index of the child to fetch - Returns a pointer to the serialised form of a #GVariant instance. + Returns a pointer to the serialised form of a #GVariant instance. The returned data may not be in fully-normalised form if read from an untrusted source. The returned data must not be freed; it remains valid for as long as @value exists. @@ -29094,52 +30906,52 @@ explicitly (by storing the type and/or endianness in addition to the serialised data). - the serialised form of @value, or %NULL + the serialised form of @value, or %NULL - a #GVariant instance + a #GVariant instance - Returns a pointer to the serialised form of a #GVariant instance. + Returns a pointer to the serialised form of a #GVariant instance. The semantics of this function are exactly the same as g_variant_get_data(), except that the returned #GBytes holds a reference to the variant data. - A new #GBytes representing the variant data + A new #GBytes representing the variant data - a #GVariant + a #GVariant - Returns the double precision floating point value of @value. + Returns the double precision floating point value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_DOUBLE. - a #gdouble + a #gdouble - a double #GVariant instance + a double #GVariant instance - Provides access to the serialised data for an array of fixed-sized + Provides access to the serialised data for an array of fixed-sized items. @value must be an array with fixed-sized elements. Numeric types are @@ -29167,7 +30979,7 @@ expectation. items in the array. - a pointer to + a pointer to the fixed array @@ -29175,21 +30987,21 @@ items in the array. - a #GVariant array with fixed-sized elements + a #GVariant array with fixed-sized elements - a pointer to the location to store the number of items + a pointer to the location to store the number of items - the size of each element + the size of each element - Returns the 32-bit signed integer value of @value. + Returns the 32-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_HANDLE. @@ -29199,84 +31011,84 @@ that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them. - a #gint32 + a #gint32 - a handle #GVariant instance + a handle #GVariant instance - Returns the 16-bit signed integer value of @value. + Returns the 16-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT16. - a #gint16 + a #gint16 - a int16 #GVariant instance + a int16 #GVariant instance - Returns the 32-bit signed integer value of @value. + Returns the 32-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT32. - a #gint32 + a #gint32 - a int32 #GVariant instance + a int32 #GVariant instance - Returns the 64-bit signed integer value of @value. + Returns the 64-bit signed integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT64. - a #gint64 + a #gint64 - a int64 #GVariant instance + a int64 #GVariant instance - Given a maybe-typed #GVariant instance, extract its value. If the + Given a maybe-typed #GVariant instance, extract its value. If the value is Nothing, then this function returns %NULL. - the contents of @value, or %NULL + the contents of @value, or %NULL - a maybe-typed value + a maybe-typed value - Gets a #GVariant instance that has the same value as @value and is + Gets a #GVariant instance that has the same value as @value and is trusted to be in normal form. If @value is already trusted to be in normal form then a new @@ -29301,18 +31113,18 @@ value from this function to guarantee ownership of a single non-floating reference to it. - a trusted #GVariant + a trusted #GVariant - a #GVariant + a #GVariant - Gets the contents of an array of object paths #GVariant. This call + Gets the contents of an array of object paths #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified. @@ -29324,24 +31136,24 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of constant strings + an array of constant strings - an array of object paths #GVariant + an array of object paths #GVariant - the length of the result, or %NULL + the length of the result, or %NULL - Determines the number of bytes that would be required to store @value + Determines the number of bytes that would be required to store @value with g_variant_store(). If @value has a fixed-sized type then this function always returned @@ -29354,18 +31166,18 @@ operation which is approximately O(n) in the number of values involved. - the serialised size of @value + the serialised size of @value - a #GVariant instance + a #GVariant instance - Returns the string value of a #GVariant instance with a string + Returns the string value of a #GVariant instance with a string type. This includes the types %G_VARIANT_TYPE_STRING, %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE. @@ -29381,23 +31193,23 @@ other than those three. The return value remains valid as long as @value exists. - the constant string, UTF-8 encoded + the constant string, UTF-8 encoded - a string #GVariant instance + a string #GVariant instance - a pointer to a #gsize, + a pointer to a #gsize, to store the length - Gets the contents of an array of strings #GVariant. This call + Gets the contents of an array of strings #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified. @@ -29409,108 +31221,108 @@ For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned. - an array of constant strings + an array of constant strings - an array of strings #GVariant + an array of strings #GVariant - the length of the result, or %NULL + the length of the result, or %NULL - Determines the type of @value. + Determines the type of @value. The return value is valid for the lifetime of @value and must not be freed. - a #GVariantType + a #GVariantType - a #GVariant + a #GVariant - Returns the type string of @value. Unlike the result of calling + Returns the type string of @value. Unlike the result of calling g_variant_type_peek_string(), this string is nul-terminated. This string belongs to #GVariant and must not be freed. - the type string for the type of @value + the type string for the type of @value - a #GVariant + a #GVariant - Returns the 16-bit unsigned integer value of @value. + Returns the 16-bit unsigned integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT16. - a #guint16 + a #guint16 - a uint16 #GVariant instance + a uint16 #GVariant instance - Returns the 32-bit unsigned integer value of @value. + Returns the 32-bit unsigned integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT32. - a #guint32 + a #guint32 - a uint32 #GVariant instance + a uint32 #GVariant instance - Returns the 64-bit unsigned integer value of @value. + Returns the 64-bit unsigned integer value of @value. It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT64. - a #guint64 + a #guint64 - a uint64 #GVariant instance + a uint64 #GVariant instance - This function is intended to be used by libraries based on #GVariant + This function is intended to be used by libraries based on #GVariant that want to provide g_variant_get()-like functionality to their users. @@ -29540,41 +31352,41 @@ see the section on - a #GVariant + a #GVariant - a string that is prefixed with a format string + a string that is prefixed with a format string - location to store the end pointer, + location to store the end pointer, or %NULL - a pointer to a #va_list + a pointer to a #va_list - Unboxes @value. The result is the #GVariant instance that was + Unboxes @value. The result is the #GVariant instance that was contained in @value. - the item contained in the variant + the item contained in the variant - a variant #GVariant instance + a variant #GVariant instance - Generates a hash value for a #GVariant instance. + Generates a hash value for a #GVariant instance. The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor @@ -29585,32 +31397,32 @@ The type of @value is #gconstpointer only to allow use of this function with #GHashTable. @value must be a #GVariant. - a hash value corresponding to @value + a hash value corresponding to @value - a basic #GVariant value as a #gconstpointer + a basic #GVariant value as a #gconstpointer - Checks if @value is a container. + Checks if @value is a container. - %TRUE if @value is a container + %TRUE if @value is a container - a #GVariant instance + a #GVariant instance - Checks whether @value has a floating reference count. + Checks whether @value has a floating reference count. This function should only ever be used to assert that a given variant is or is not floating, or for debug purposes. To acquire a reference @@ -29621,18 +31433,18 @@ See g_variant_ref_sink() for more information about floating reference counts. - whether @value is floating + whether @value is floating - a #GVariant + a #GVariant - Checks if @value is in normal form. + Checks if @value is in normal form. The main reason to do this is to detect if a given chunk of serialised data is in normal form: load the data into a #GVariant @@ -29647,36 +31459,36 @@ There may be implementation specific restrictions on deeply nested values. GVariant is guaranteed to handle nesting up to at least 64 levels. - %TRUE if @value is in normal form + %TRUE if @value is in normal form - a #GVariant instance + a #GVariant instance - Checks if a value has a type matching the provided type. + Checks if a value has a type matching the provided type. - %TRUE if the type of @value matches @type + %TRUE if the type of @value matches @type - a #GVariant instance + a #GVariant instance - a #GVariantType + a #GVariantType - Creates a heap-allocated #GVariantIter for iterating over the items + Creates a heap-allocated #GVariantIter for iterating over the items in @value. Use g_variant_iter_free() to free the return value when you no longer @@ -29686,18 +31498,18 @@ A reference is taken to @value and will be released only when g_variant_iter_free() is called. - a new heap-allocated #GVariantIter + a new heap-allocated #GVariantIter - a container #GVariant + a container #GVariant - Looks up a value in a dictionary #GVariant. + Looks up a value in a dictionary #GVariant. This function is a wrapper around g_variant_lookup_value() and g_variant_get(). In the case that %NULL would have been returned, @@ -29713,30 +31525,30 @@ This function is currently implemented with a linear scan. If you plan to do many lookups then #GVariantDict may be more efficient. - %TRUE if a value was unpacked + %TRUE if a value was unpacked - a dictionary #GVariant + a dictionary #GVariant - the key to lookup in the dictionary + the key to look up in the dictionary - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - Looks up a value in a dictionary #GVariant. + Looks up a value in a dictionary #GVariant. This function works with dictionaries of the type a{s*} (and equally well with type a{o*}, but we only further discuss the string case @@ -29759,26 +31571,26 @@ This function is currently implemented with a linear scan. If you plan to do many lookups then #GVariantDict may be more efficient. - the value of the dictionary key, or %NULL + the value of the dictionary key, or %NULL - a dictionary #GVariant + a dictionary #GVariant - the key to lookup in the dictionary + the key to look up in the dictionary - a #GVariantType, or %NULL + a #GVariantType, or %NULL - Determines the number of children in a container #GVariant instance. + Determines the number of children in a container #GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of #GVariant. @@ -29791,18 +31603,18 @@ only on the type). For dictionary entries, it is always 2 This function is O(1). - the number of children in the container + the number of children in the container - a container #GVariant + a container #GVariant - Pretty-prints @value in the format understood by g_variant_parse(). + Pretty-prints @value in the format understood by g_variant_parse(). The format is described [here][gvariant-text]. @@ -29810,63 +31622,63 @@ If @type_annotate is %TRUE, then type information is included in the output. - a newly-allocated string holding the result. + a newly-allocated string holding the result. - a #GVariant + a #GVariant - %TRUE if type information should be included in + %TRUE if type information should be included in the output - Behaves as g_variant_print(), but operates on a #GString. + Behaves as g_variant_print(), but operates on a #GString. If @string is non-%NULL then it is appended to and returned. Else, a new empty #GString is allocated and it is returned. - a #GString containing the string + a #GString containing the string - a #GVariant + a #GVariant - a #GString, or %NULL + a #GString, or %NULL - %TRUE if type information should be included in + %TRUE if type information should be included in the output - Increases the reference count of @value. + Increases the reference count of @value. - the same @value + the same @value - a #GVariant + a #GVariant - #GVariant uses a floating reference count system. All functions with + #GVariant uses a floating reference count system. All functions with names starting with `g_variant_new_` return floating references. @@ -29890,18 +31702,18 @@ maintaining normal refcounting semantics in situations where values are not floating. - the same @value + the same @value - a #GVariant + a #GVariant - Stores the serialised form of @value at @data. @data should be + Stores the serialised form of @value at @data. @data should be large enough. See g_variant_get_size(). The stored data is in machine native byte order but may not be in @@ -29919,17 +31731,17 @@ This function is approximately O(n) in the size of @data. - the #GVariant to store + the #GVariant to store - the location to store the serialised data at + the location to store the serialised data at - If @value is floating, sink it. Otherwise, do nothing. + If @value is floating, sink it. Otherwise, do nothing. Typically you want to use g_variant_ref_sink() in order to automatically do the correct thing with respect to floating or @@ -29963,18 +31775,18 @@ an additional reference on top of that one is added. It is best to avoid this situation. - the same @value + the same @value - a #GVariant + a #GVariant - Decreases the reference count of @value. When its reference count + Decreases the reference count of @value. When its reference count drops to 0, the memory used by the variant is freed. @@ -29982,13 +31794,13 @@ drops to 0, the memory used by the variant is freed. - a #GVariant + a #GVariant - Determines if a given string is a valid D-Bus object path. You + Determines if a given string is a valid D-Bus object path. You should ensure that a string is a valid D-Bus object path before passing it to g_variant_new_object_path(). @@ -29998,18 +31810,18 @@ must contain only the characters `[A-Z][a-z][0-9]_`. No sequence (including the one following the final `/` character) may be empty. - %TRUE if @string is a D-Bus object path + %TRUE if @string is a D-Bus object path - a normal C nul-terminated string + a normal C nul-terminated string - Determines if a given string is a valid D-Bus type signature. You + Determines if a given string is a valid D-Bus type signature. You should ensure that a string is a valid D-Bus type signature before passing it to g_variant_new_signature(). @@ -30017,18 +31829,18 @@ D-Bus type signatures consist of zero or more definite #GVariantType strings in sequence. - %TRUE if @string is a D-Bus type signature + %TRUE if @string is a D-Bus type signature - a normal C nul-terminated string + a normal C nul-terminated string - Parses a #GVariant from a text representation. + Parses a #GVariant from a text representation. A single #GVariant is parsed from the content of @text. @@ -30061,30 +31873,30 @@ Officially, the language understood by the parser is "any string produced by g_variant_print()". - a non-floating reference to a #GVariant, or %NULL + a non-floating reference to a #GVariant, or %NULL - a #GVariantType, or %NULL + a #GVariantType, or %NULL - a string containing a GVariant in text form + a string containing a GVariant in text form - a pointer to the end of @text, or %NULL + a pointer to the end of @text, or %NULL - a location to store the end pointer, or %NULL + a location to store the end pointer, or %NULL - Pretty-prints a message showing the context of a #GVariant parse + Pretty-prints a message showing the context of a #GVariant parse error within the string for which parsing was attempted. The resulting string is suitable for output to the console or other @@ -30115,16 +31927,16 @@ g_variant_parse() then you must add nul termination before using this function. - the printed message + the printed message - a #GError from the #GVariantParseError domain + a #GError from the #GVariantParseError domain - the string that was given to the parser + the string that was given to the parser @@ -30135,7 +31947,7 @@ function. - Same as g_variant_error_quark(). + Same as g_variant_error_quark(). Use g_variant_parse_error_quark() instead. @@ -30143,7 +31955,7 @@ function. - A utility type for constructing container-type #GVariant instances. + A utility type for constructing container-type #GVariant instances. This is an opaque structure and may only be accessed using the following functions. @@ -30174,7 +31986,7 @@ access it from more than one thread. - Allocates and initialises a new #GVariantBuilder. + Allocates and initialises a new #GVariantBuilder. You should call g_variant_builder_unref() on the return value when it is no longer needed. The memory will not be automatically freed by @@ -30185,18 +31997,18 @@ the stack of the calling function and initialise it with g_variant_builder_init(). - a #GVariantBuilder + a #GVariantBuilder - a container type + a container type - Adds to a #GVariantBuilder. + Adds to a #GVariantBuilder. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_builder_add_value(). @@ -30232,21 +32044,21 @@ make_pointless_dictionary (void) - a #GVariantBuilder + a #GVariantBuilder - a #GVariant varargs format string + a #GVariant varargs format string - arguments, as per @format_string + arguments, as per @format_string - Adds to a #GVariantBuilder. + Adds to a #GVariantBuilder. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new_parsed() followed by @@ -30278,21 +32090,21 @@ make_pointless_dictionary (void) - a #GVariantBuilder + a #GVariantBuilder - a text format #GVariant + a text format #GVariant - arguments as per @format + arguments as per @format - Adds @value to @builder. + Adds @value to @builder. It is an error to call this function in any way that would create an inconsistent value to be constructed. Some examples of this are @@ -30308,17 +32120,17 @@ the @builder instance takes ownership of @value. - a #GVariantBuilder + a #GVariantBuilder - a #GVariant + a #GVariant - Releases all memory associated with a #GVariantBuilder without + Releases all memory associated with a #GVariantBuilder without freeing the #GVariantBuilder structure itself. It typically only makes sense to do this on a stack-allocated @@ -30338,13 +32150,13 @@ to call this function on uninitialised memory. - a #GVariantBuilder + a #GVariantBuilder - Closes the subcontainer inside the given @builder that was opened by + Closes the subcontainer inside the given @builder that was opened by the most recent call to g_variant_builder_open(). It is an error to call this function in any way that would create an @@ -30356,13 +32168,13 @@ subcontainer). - a #GVariantBuilder + a #GVariantBuilder - Ends the builder process and returns the constructed value. + 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 @@ -30381,18 +32193,18 @@ have been added; in this case it is impossible to infer the type of the empty array. - a new, floating, #GVariant + a new, floating, #GVariant - a #GVariantBuilder + a #GVariantBuilder - Initialises a #GVariantBuilder structure. + Initialises a #GVariantBuilder structure. @type must be non-%NULL. It specifies the type of container to construct. It can be an indefinite type such as @@ -30427,17 +32239,17 @@ this function. - a #GVariantBuilder + a #GVariantBuilder - a container type + a container type - Opens a subcontainer inside the given @builder. When done adding + Opens a subcontainer inside the given @builder. When done adding items to the subcontainer, g_variant_builder_close() must be called. @type is the type of the container: so to build a tuple of several values, @type must include the tuple itself. @@ -30479,34 +32291,34 @@ output = g_variant_builder_end (&builder); - a #GVariantBuilder + a #GVariantBuilder - the #GVariantType of the container + the #GVariantType of the container - Increases the reference count on @builder. + Increases the reference count on @builder. Don't call this on stack-allocated #GVariantBuilder instances or bad things will happen. - a new reference to @builder + a new reference to @builder - a #GVariantBuilder allocated by g_variant_builder_new() + a #GVariantBuilder allocated by g_variant_builder_new() - Decreases the reference count on @builder. + Decreases the reference count on @builder. In the event that there are no more references, releases all memory associated with the #GVariantBuilder. @@ -30519,74 +32331,74 @@ things will happen. - a #GVariantBuilder allocated by g_variant_builder_new() + a #GVariantBuilder allocated by g_variant_builder_new() - The range of possible top-level types of #GVariant instances. + The range of possible top-level types of #GVariant instances. - The #GVariant is a boolean. + The #GVariant is a boolean. - The #GVariant is a byte. + The #GVariant is a byte. - The #GVariant is a signed 16 bit integer. + The #GVariant is a signed 16 bit integer. - The #GVariant is an unsigned 16 bit integer. + The #GVariant is an unsigned 16 bit integer. - The #GVariant is a signed 32 bit integer. + The #GVariant is a signed 32 bit integer. - The #GVariant is an unsigned 32 bit integer. + The #GVariant is an unsigned 32 bit integer. - The #GVariant is a signed 64 bit integer. + The #GVariant is a signed 64 bit integer. - The #GVariant is an unsigned 64 bit integer. + The #GVariant is an unsigned 64 bit integer. - The #GVariant is a file handle index. + The #GVariant is a file handle index. - The #GVariant is a double precision floating + The #GVariant is a double precision floating point value. - The #GVariant is a normal string. + The #GVariant is a normal string. - The #GVariant is a D-Bus object path + The #GVariant is a D-Bus object path string. - The #GVariant is a D-Bus signature string. + The #GVariant is a D-Bus signature string. - The #GVariant is a variant. + The #GVariant is a variant. - The #GVariant is a maybe-typed value. + The #GVariant is a maybe-typed value. - The #GVariant is an array. + The #GVariant is an array. - The #GVariant is a tuple. + The #GVariant is a tuple. - The #GVariant is a dictionary entry. + The #GVariant is a dictionary entry. - #GVariantDict is a mutable interface to #GVariant dictionaries. + #GVariantDict is a mutable interface to #GVariant dictionaries. It can be used for doing a sequence of dictionary lookups in an efficient way on an existing #GVariant dictionary or it can be used @@ -30699,7 +32511,7 @@ key is not found. Each returns the new dictionary as a floating - Allocates and initialises a new #GVariantDict. + Allocates and initialises a new #GVariantDict. You should call g_variant_dict_unref() on the return value when it is no longer needed. The memory will not be automatically freed by @@ -30711,19 +32523,19 @@ g_variant_dict_init(). This is particularly useful when you are using #GVariantDict to construct a #GVariant. - a #GVariantDict + a #GVariantDict - the #GVariant with which to initialise the + the #GVariant with which to initialise the dictionary - Releases all memory associated with a #GVariantDict without freeing + Releases all memory associated with a #GVariantDict without freeing the #GVariantDict structure itself. It typically only makes sense to do this on a stack-allocated @@ -30743,31 +32555,31 @@ on uninitialised memory. - a #GVariantDict + a #GVariantDict - Checks if @key exists in @dict. + Checks if @key exists in @dict. - %TRUE if @key is in @dict + %TRUE if @key is in @dict - a #GVariantDict + a #GVariantDict - the key to lookup in the dictionary + the key to look up in the dictionary - Returns the current value of @dict as a #GVariant of type + Returns the current value of @dict as a #GVariant of type %G_VARIANT_TYPE_VARDICT, clearing it in the process. It is not permissible to use @dict in any way after this call except @@ -30776,18 +32588,18 @@ for reference counting operations (in the case of a heap-allocated the case of stack-allocated). - a new, floating, #GVariant + a new, floating, #GVariant - a #GVariantDict + a #GVariantDict - Initialises a #GVariantDict structure. + Initialises a #GVariantDict structure. If @from_asv is given, it is used to initialise the dictionary. @@ -30809,17 +32621,17 @@ g_variant_dict_new() instead of this function. - a #GVariantDict + a #GVariantDict - the initial value for @dict + the initial value for @dict - Inserts a value into a #GVariantDict. + Inserts a value into a #GVariantDict. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_dict_insert_value(). @@ -30829,25 +32641,25 @@ calling g_variant_new() followed by g_variant_dict_insert_value(). - a #GVariantDict + a #GVariantDict - the key to insert a value for + the key to insert a value for - a #GVariant varargs format string + a #GVariant varargs format string - arguments, as per @format_string + arguments, as per @format_string - Inserts (or replaces) a key in a #GVariantDict. + Inserts (or replaces) a key in a #GVariantDict. @value is consumed if it is floating. @@ -30856,21 +32668,21 @@ calling g_variant_new() followed by g_variant_dict_insert_value(). - a #GVariantDict + a #GVariantDict - the key to insert a value for + the key to insert a value for - the value to insert + the value to insert - Looks up a value in a #GVariantDict. + Looks up a value in a #GVariantDict. This function is a wrapper around g_variant_dict_lookup_value() and g_variant_get(). In the case that %NULL would have been returned, @@ -30882,30 +32694,30 @@ values and also determines if the values are copied or borrowed, see the section on [GVariant format strings][gvariant-format-strings-pointers]. - %TRUE if a value was unpacked + %TRUE if a value was unpacked - a #GVariantDict + a #GVariantDict - the key to lookup in the dictionary + the key to look up in the dictionary - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - Looks up a value in a #GVariantDict. + Looks up a value in a #GVariantDict. If @key is not found in @dictionary, %NULL is returned. @@ -30918,61 +32730,61 @@ returned. If @expected_type was specified then any non-%NULL return value will have this type. - the value of the dictionary key, or %NULL + the value of the dictionary key, or %NULL - a #GVariantDict + a #GVariantDict - the key to lookup in the dictionary + the key to look up in the dictionary - a #GVariantType, or %NULL + a #GVariantType, or %NULL - Increases the reference count on @dict. + Increases the reference count on @dict. Don't call this on stack-allocated #GVariantDict instances or bad things will happen. - a new reference to @dict + a new reference to @dict - a heap-allocated #GVariantDict + a heap-allocated #GVariantDict - Removes a key and its associated value from a #GVariantDict. + Removes a key and its associated value from a #GVariantDict. - %TRUE if the key was found and removed + %TRUE if the key was found and removed - a #GVariantDict + a #GVariantDict - the key to remove + the key to remove - Decreases the reference count on @dict. + Decreases the reference count on @dict. In the event that there are no more references, releases all memory associated with the #GVariantDict. @@ -30985,14 +32797,14 @@ things will happen. - a heap-allocated #GVariantDict + a heap-allocated #GVariantDict - #GVariantIter is an opaque data structure and can only be accessed + #GVariantIter is an opaque data structure and can only be accessed using the following functions. @@ -31001,7 +32813,7 @@ using the following functions. - Creates a new heap-allocated #GVariantIter to iterate over the + Creates a new heap-allocated #GVariantIter to iterate over the container that was being iterated over by @iter. Iteration begins on the new iterator from the current position of the old iterator but the two copies are independent past that point. @@ -31013,18 +32825,18 @@ A reference is taken to the container that @iter is iterating over and will be releated only when g_variant_iter_free() is called. - a new heap-allocated #GVariantIter + a new heap-allocated #GVariantIter - a #GVariantIter + a #GVariantIter - Frees a heap-allocated #GVariantIter. Only call this function on + Frees a heap-allocated #GVariantIter. Only call this function on iterators that were returned by g_variant_iter_new() or g_variant_iter_copy(). @@ -31033,13 +32845,13 @@ g_variant_iter_copy(). - a heap-allocated #GVariantIter + a heap-allocated #GVariantIter - Initialises (without allocating) a #GVariantIter. @iter may be + Initialises (without allocating) a #GVariantIter. @iter may be completely uninitialised prior to this call; its old value is ignored. @@ -31047,22 +32859,22 @@ The iterator remains valid for as long as @value exists, and need not be freed in any way. - the number of items in @value + the number of items in @value - a pointer to a #GVariantIter + a pointer to a #GVariantIter - a container #GVariant + a container #GVariant - Gets the next item in the container and unpacks it into the variable + Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE. If no more items remain then %FALSE is returned. @@ -31126,45 +32938,45 @@ See the section on [GVariant format strings][gvariant-format-strings-pointers]. - %TRUE if a value was unpacked, or %FALSE if there was no + %TRUE if a value was unpacked, or %FALSE if there was no value - a #GVariantIter + a #GVariantIter - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - Queries the number of child items in the container that we are + Queries the number of child items in the container that we are iterating over. This is the total number of items -- not the number of items remaining. This function might be useful for preallocation of arrays. - the number of children in the container + the number of children in the container - a #GVariantIter + a #GVariantIter - Gets the next item in the container and unpacks it into the variable + Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE. If no more items remain then %FALSE is returned. @@ -31207,26 +33019,26 @@ See the section on [GVariant format strings][gvariant-format-strings-pointers]. - %TRUE if a value was unpacked, or %FALSE if there as no value + %TRUE if a value was unpacked, or %FALSE if there as no value - a #GVariantIter + a #GVariantIter - a GVariant format string + a GVariant format string - the arguments to unpack the value into + the arguments to unpack the value into - Gets the next item in the container. If no more items remain then + Gets the next item in the container. If no more items remain then %NULL is returned. Use g_variant_unref() to drop your reference on the return value when @@ -31255,77 +33067,77 @@ Here is an example for iterating with g_variant_iter_next_value(): ]| - a #GVariant, or %NULL + a #GVariant, or %NULL - a #GVariantIter + a #GVariantIter - Error codes returned by parsing text-format GVariants. + Error codes returned by parsing text-format GVariants. - generic error (unused) + generic error (unused) - a non-basic #GVariantType was given where a basic type was expected + a non-basic #GVariantType was given where a basic type was expected - cannot infer the #GVariantType + cannot infer the #GVariantType - an indefinite #GVariantType was given where a definite type was expected + an indefinite #GVariantType was given where a definite type was expected - extra data after parsing finished + extra data after parsing finished - invalid character in number or unicode escape + invalid character in number or unicode escape - not a valid #GVariant format string + not a valid #GVariant format string - not a valid object path + not a valid object path - not a valid type signature + not a valid type signature - not a valid #GVariant type string + not a valid #GVariant type string - could not find a common type for array entries + could not find a common type for array entries - the numerical value is out of range of the given type + the numerical value is out of range of the given type - the numerical value is out of range for any type + the numerical value is out of range for any type - cannot parse as variant of the specified type + cannot parse as variant of the specified type - an unexpected token was encountered + an unexpected token was encountered - an unknown keyword was encountered + an unknown keyword was encountered - unterminated string constant + unterminated string constant - no value given + no value given - This section introduces the GVariant type system. It is based, in + This section introduces the GVariant type system. It is based, in large part, on the D-Bus type system, with two major changes and some minor lifting of restrictions. The [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html), @@ -31474,7 +33286,7 @@ that, due to the restriction that the key of a dictionary entry must be a basic type, "{**}" is not a valid type string. - Creates a new #GVariantType corresponding to the type string given + Creates a new #GVariantType corresponding to the type string given by @type_string. It is appropriate to call g_variant_type_free() on the return value. @@ -31482,79 +33294,79 @@ It is a programmer error to call this function with an invalid type string. Use g_variant_type_string_is_valid() if you are unsure. - a new #GVariantType + a new #GVariantType - a valid GVariant type string + a valid GVariant type string - Constructs the type corresponding to an array of elements of the + Constructs the type corresponding to an array of elements of the type @type. It is appropriate to call g_variant_type_free() on the return value. - a new array #GVariantType + a new array #GVariantType Since 2.24 - a #GVariantType + a #GVariantType - Constructs the type corresponding to a dictionary entry with a key + Constructs the type corresponding to a dictionary entry with a key of type @key and a value of type @value. It is appropriate to call g_variant_type_free() on the return value. - a new dictionary entry #GVariantType + a new dictionary entry #GVariantType Since 2.24 - a basic #GVariantType + a basic #GVariantType - a #GVariantType + a #GVariantType - Constructs the type corresponding to a maybe instance containing + Constructs the type corresponding to a maybe instance containing type @type or Nothing. It is appropriate to call g_variant_type_free() on the return value. - a new maybe #GVariantType + a new maybe #GVariantType Since 2.24 - a #GVariantType + a #GVariantType - Constructs a new tuple type, from @items. + Constructs a new tuple type, from @items. @length is the number of items in @items, or -1 to indicate that @items is %NULL-terminated. @@ -31562,79 +33374,79 @@ Since 2.24 It is appropriate to call g_variant_type_free() on the return value. - a new tuple #GVariantType + a new tuple #GVariantType Since 2.24 - an array of #GVariantTypes, one for each item + an array of #GVariantTypes, one for each item - the length of @items, or -1 + the length of @items, or -1 - Makes a copy of a #GVariantType. It is appropriate to call + Makes a copy of a #GVariantType. It is appropriate to call g_variant_type_free() on the return value. @type may not be %NULL. - a new #GVariantType + a new #GVariantType Since 2.24 - a #GVariantType + a #GVariantType - Returns a newly-allocated copy of the type string corresponding to + Returns a newly-allocated copy of the type string corresponding to @type. The returned string is nul-terminated. It is appropriate to call g_free() on the return value. - the corresponding type string + the corresponding type string Since 2.24 - a #GVariantType + a #GVariantType - Determines the element type of an array or maybe type. + Determines the element type of an array or maybe type. This function may only be used with array or maybe types. - the element type of @type + the element type of @type Since 2.24 - an array or maybe #GVariantType + an array or maybe #GVariantType - Compares @type1 and @type2 for equality. + Compares @type1 and @type2 for equality. Only returns %TRUE if the types are exactly equal. Even if one type is an indefinite type and the other is a subtype of it, %FALSE will @@ -31646,24 +33458,24 @@ allow use with #GHashTable without function pointer casting. For both arguments, a valid #GVariantType must be provided. - %TRUE if @type1 and @type2 are exactly equal + %TRUE if @type1 and @type2 are exactly equal Since 2.24 - a #GVariantType + a #GVariantType - a #GVariantType + a #GVariantType - Determines the first item type of a tuple or dictionary entry + Determines the first item type of a tuple or dictionary entry type. This function may only be used with tuple or dictionary entry types, @@ -31679,20 +33491,20 @@ This call, together with g_variant_type_next() provides an iterator interface over tuple and dictionary entry types. - the first item type of @type, or %NULL + the first item type of @type, or %NULL Since 2.24 - a tuple or dictionary entry #GVariantType + a tuple or dictionary entry #GVariantType - Frees a #GVariantType that was allocated with + Frees a #GVariantType that was allocated with g_variant_type_copy(), g_variant_type_new() or one of the container type constructor functions. @@ -31705,51 +33517,51 @@ Since 2.24 - a #GVariantType, or %NULL + a #GVariantType, or %NULL - Returns the length of the type string corresponding to the given + Returns the length of the type string corresponding to the given @type. This function must be used to determine the valid extent of the memory region returned by g_variant_type_peek_string(). - the length of the corresponding type string + the length of the corresponding type string Since 2.24 - a #GVariantType + a #GVariantType - Hashes @type. + Hashes @type. The argument type of @type is only #gconstpointer to allow use with #GHashTable without function pointer casting. A valid #GVariantType must be provided. - the hash value + the hash value Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is an array type. This is true if the + Determines if the given @type is an array type. This is true if the type string for @type starts with an 'a'. This function returns %TRUE for any indefinite type for which every @@ -31757,20 +33569,20 @@ definite subtype is an array type -- %G_VARIANT_TYPE_ARRAY, for example. - %TRUE if @type is an array type + %TRUE if @type is an array type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is a basic type. + Determines if the given @type is a basic type. Basic types are booleans, bytes, integers, doubles, strings, object paths and signatures. @@ -31781,20 +33593,20 @@ This function returns %FALSE for all indefinite types except %G_VARIANT_TYPE_BASIC. - %TRUE if @type is a basic type + %TRUE if @type is a basic type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is a container type. + Determines if the given @type is a container type. Container types are any array, maybe, tuple, or dictionary entry types plus the variant type. @@ -31804,20 +33616,20 @@ definite subtype is a container -- %G_VARIANT_TYPE_ARRAY, for example. - %TRUE if @type is a container type + %TRUE if @type is a container type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is definite (ie: not indefinite). + Determines if the given @type is definite (ie: not indefinite). A type is definite if its type string does not contain any indefinite type characters ('*', '?', or 'r'). @@ -31829,7 +33641,28 @@ indefinite type like %G_VARIANT_TYPE_ARRAY, however, will result in %FALSE being returned. - %TRUE if @type is definite + %TRUE if @type is definite + +Since 2.24 + + + + + a #GVariantType + + + + + + Determines if the given @type is a dictionary entry type. This is +true if the type string for @type starts with a '{'. + +This function returns %TRUE for any indefinite type for which every +definite subtype is a dictionary entry type -- +%G_VARIANT_TYPE_DICT_ENTRY, for example. + + + %TRUE if @type is a dictionary entry type Since 2.24 @@ -31841,29 +33674,8 @@ Since 2.24 - - Determines if the given @type is a dictionary entry type. This is -true if the type string for @type starts with a '{'. - -This function returns %TRUE for any indefinite type for which every -definite subtype is a dictionary entry type -- -%G_VARIANT_TYPE_DICT_ENTRY, for example. - - - %TRUE if @type is a dictionary entry type - -Since 2.24 - - - - - a #GVariantType - - - - - Determines if the given @type is a maybe type. This is true if the + Determines if the given @type is a maybe type. This is true if the type string for @type starts with an 'm'. This function returns %TRUE for any indefinite type for which every @@ -31871,44 +33683,44 @@ definite subtype is a maybe type -- %G_VARIANT_TYPE_MAYBE, for example. - %TRUE if @type is a maybe type + %TRUE if @type is a maybe type Since 2.24 - a #GVariantType + a #GVariantType - Checks if @type is a subtype of @supertype. + Checks if @type is a subtype of @supertype. This function returns %TRUE if @type is a subtype of @supertype. All types are considered to be subtypes of themselves. Aside from that, only indefinite types can have subtypes. - %TRUE if @type is a subtype of @supertype + %TRUE if @type is a subtype of @supertype Since 2.24 - a #GVariantType + a #GVariantType - a #GVariantType + a #GVariantType - Determines if the given @type is a tuple type. This is true if the + Determines if the given @type is a tuple type. This is true if the type string for @type starts with a '(' or if @type is %G_VARIANT_TYPE_TUPLE. @@ -31917,56 +33729,56 @@ definite subtype is a tuple type -- %G_VARIANT_TYPE_TUPLE, for example. - %TRUE if @type is a tuple type + %TRUE if @type is a tuple type Since 2.24 - a #GVariantType + a #GVariantType - Determines if the given @type is the variant type. + Determines if the given @type is the variant type. - %TRUE if @type is the variant type + %TRUE if @type is the variant type Since 2.24 - a #GVariantType + a #GVariantType - Determines the key type of a dictionary entry type. + Determines the key type of a dictionary entry type. This function may only be used with a dictionary entry type. Other than the additional restriction, this call is equivalent to g_variant_type_first(). - the key type of the dictionary entry + the key type of the dictionary entry Since 2.24 - a dictionary entry #GVariantType + a dictionary entry #GVariantType - Determines the number of items contained in a tuple or + Determines the number of items contained in a tuple or dictionary entry type. This function may only be used with tuple or dictionary entry types, @@ -31977,20 +33789,20 @@ In the case of a dictionary entry type, this function will always return 2. - the number of items in @type + the number of items in @type Since 2.24 - a tuple or dictionary entry #GVariantType + a tuple or dictionary entry #GVariantType - Determines the next item type of a tuple or dictionary entry + Determines the next item type of a tuple or dictionary entry type. @type must be the result of a previous call to @@ -32003,52 +33815,52 @@ entry then this call returns %NULL. For tuples, %NULL is returned when @type is the last item in a tuple. - the next #GVariantType after @type, or %NULL + the next #GVariantType after @type, or %NULL Since 2.24 - a #GVariantType from a previous call + a #GVariantType from a previous call - Returns the type string corresponding to the given @type. The + Returns the type string corresponding to the given @type. The result is not nul-terminated; in order to determine its length you must call g_variant_type_get_string_length(). To get a nul-terminated string, see g_variant_type_dup_string(). - the corresponding type string (not nul-terminated) + the corresponding type string (not nul-terminated) Since 2.24 - a #GVariantType + a #GVariantType - Determines the value type of a dictionary entry type. + Determines the value type of a dictionary entry type. This function may only be used with a dictionary entry type. - the value type of the dictionary entry + the value type of the dictionary entry Since 2.24 - a dictionary entry #GVariantType + a dictionary entry #GVariantType @@ -32076,25 +33888,25 @@ Since 2.24 - Checks if @type_string is a valid GVariant type string. This call is + Checks if @type_string is a valid GVariant type string. This call is equivalent to calling g_variant_type_string_scan() and confirming that the following character is a nul terminator. - %TRUE if @type_string is exactly one valid type string + %TRUE if @type_string is exactly one valid type string Since 2.24 - a pointer to any string + a pointer to any string - Scan for a single complete and valid GVariant type string in @string. + Scan for a single complete and valid GVariant type string in @string. The memory pointed to by @limit (or bytes beyond it) is never accessed. @@ -32109,40 +33921,58 @@ For the simple case of checking if a string is a valid type string, see g_variant_type_string_is_valid(). - %TRUE if a valid type string was found + %TRUE if a valid type string was found - a pointer to any string + a pointer to any string - the end of @string, or %NULL + the end of @string, or %NULL - location to store the end pointer, or %NULL + location to store the end pointer, or %NULL - Declares a type of function which takes no arguments + Declares a type of function which takes no arguments and has no return value. It is used to specify the type function passed to g_atexit(). - + + + On Windows, this macro defines a DllMain() function that stores +the actual DLL name that the code being compiled will be included in. + +On non-Windows platforms, expands to nothing. + + + + empty or "static" + + + the name of the (pointer to the) char array where + the DLL name will be stored. If this is used, you must also + include `windows.h`. If you need a more complex DLL entry + point function, you cannot use this + + + - A wrapper for the POSIX access() function. This function is used to + A wrapper for the POSIX access() function. This function is used to test a pathname for one or several of read, write or execute permissions, or just existence. @@ -32154,44 +33984,157 @@ Windows. Software that needs to handle file permissions on Windows more exactly should use the Win32 API. See your C library manual for more details about access(). - + - zero if the pathname refers to an existing file system + zero if the pathname refers to an existing file system object that has all the tested permissions, or -1 otherwise or on error. - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) - as in access() + as in access() + + 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(): + +- alloca() is very fast, as on most systems it's implemented by just adjusting + the stack pointer register. + +- It doesn't cause any memory fragmentation, within its scope, separate alloca() + blocks just build up and are released together at function end. + +- 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. + +- 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. + +- 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. + + + + number of bytes to allocate. + + + + + Adds the value on to the end of the array. The array will grow in +size automatically if necessary. + +g_array_append_val() is a macro which uses a reference to the value +parameter @v. This means that you cannot use it with literal values +such as "27". You must use variables. + + + + a #GArray + + + the value to append to the #GArray + + + + + Returns the element of a #GArray at the given index. The return +value is cast to the given type. + +This example gets a pointer to an element in a #GArray: +|[<!-- language="C" --> + EDayViewEvent *event; + // This gets a pointer to the 4th element in the array of + // EDayViewEvent structs. + event = &g_array_index (events, EDayViewEvent, 3); +]| + + + + a #GArray + + + the type of the elements + + + the index of the element to return + + + + + Inserts an element into an array at the given index. + +g_array_insert_val() is a macro which uses a reference to the value +parameter @v. This means that you cannot use it with literal values +such as "27". You must use variables. + + + + a #GArray + + + the index to place the element at + + + the value to insert into the array + + + + + Adds the value on to the start of the array. The array will grow in +size automatically if necessary. + +This operation is slower than g_array_append_val() since the +existing elements in the array have to be moved to make space for +the new element. + +g_array_prepend_val() is a macro which uses a reference to the value +parameter @v. This means that you cannot use it with literal values +such as "27". You must use variables. + + + + a #GArray + + + the value to prepend to the #GArray + + + - Determines the numeric value of a character as a decimal digit. + Determines the numeric value of a character as a decimal digit. Differs from g_unichar_digit_value() because it takes a char, so there's no worry about sign extension if characters are signed. - If @c is a decimal digit (according to g_ascii_isdigit()), + If @c is a decimal digit (according to g_ascii_isdigit()), its numeric value. Otherwise, -1. - an ASCII character + an ASCII character - Converts a #gdouble to a string, using the '.' as + Converts a #gdouble to a string, using the '.' as decimal point. This function generates enough precision that converting @@ -32202,26 +34145,26 @@ be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes, including the terminating nul character, which is always added. - The pointer to the buffer with the converted string. + The pointer to the buffer with the converted string. - A buffer to place the resulting string in + A buffer to place the resulting string in - The length of the buffer. + The length of the buffer. - The #gdouble to convert + The #gdouble to convert - Converts a #gdouble to a string, using the '.' as + Converts a #gdouble to a string, using the '.' as decimal point. To format the number you pass in a printf()-style format string. Allowed conversion specifiers are 'e', 'E', 'f', 'F', 'g' and 'G'. @@ -32232,31 +34175,201 @@ If you just want to want to serialize the value into a string, use g_ascii_dtostr(). - The pointer to the buffer with the converted string. + The pointer to the buffer with the converted string. - A buffer to place the resulting string in + A buffer to place the resulting string in - The length of the buffer. + The length of the buffer. - The printf()-style format to use for the + The printf()-style format to use for the code to use for converting. - The #gdouble to convert + The #gdouble to convert + + Determines whether a character is alphanumeric. + +Unlike the standard C library isalnum() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to cast to #guchar before +passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is alphabetic (i.e. a letter). + +Unlike the standard C library isalpha() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to cast to #guchar before +passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is a control character. + +Unlike the standard C library iscntrl() function, this only +recognizes standard ASCII control characters and ignores the +locale, returning %FALSE for all non-ASCII characters. Also, +unlike the standard library function, this takes a char, not +an int, so don't call it on %EOF, but no need to cast to #guchar +before passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is digit (0-9). + +Unlike the standard C library isdigit() function, this takes +a char, not an int, so don't call it on %EOF, but no need to +cast to #guchar before passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is a printing character and not a space. + +Unlike the standard C library isgraph() function, this only +recognizes standard ASCII characters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to cast to #guchar before +passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is an ASCII lower case letter. + +Unlike the standard C library islower() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to worry about casting +to #guchar before passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is a printing character. + +Unlike the standard C library isprint() function, this only +recognizes standard ASCII characters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to cast to #guchar before +passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is a punctuation character. + +Unlike the standard C library ispunct() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to cast to #guchar before +passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is a white-space character. + +Unlike the standard C library isspace() function, this only +recognizes standard ASCII white-space and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to cast to #guchar before +passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is an ASCII upper case letter. + +Unlike the standard C library isupper() function, this only +recognizes standard ASCII letters and ignores the locale, +returning %FALSE for all non-ASCII characters. Also, unlike +the standard library function, this takes a char, not an int, +so don't call it on %EOF, but no need to worry about casting +to #guchar before passing a possibly non-ASCII character in. + + + + any character + + + + + Determines whether a character is a hexadecimal-digit character. + +Unlike the standard C library isxdigit() function, this takes +a char, not an int, so don't call it on %EOF, but no need to +cast to #guchar before passing a possibly non-ASCII character in. + + + + any character + + + - Compare two strings, ignoring the case of ASCII characters. + Compare two strings, ignoring the case of ASCII characters. Unlike the BSD strcasecmp() function, this only recognizes standard ASCII letters and ignores the locale, treating all non-ASCII @@ -32273,26 +34386,26 @@ strings using this function, you will get false matches. Both @s1 and @s2 must be non-%NULL. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - string to compare with @s2 + string to compare with @s2 - string to compare with @s1 + string to compare with @s1 - Converts all upper case ASCII letters to lower case ASCII letters. + Converts all upper case ASCII letters to lower case ASCII letters. - a newly-allocated string, with all the upper case + a newly-allocated string, with all the upper case characters in @str converted to lower case, with semantics that exactly match g_ascii_tolower(). (Note that this is unlike the old g_strdown(), which modified the string in place.) @@ -32300,17 +34413,17 @@ Both @s1 and @s2 must be non-%NULL. - a string + a string - length of @str in bytes, or -1 if @str is nul-terminated + length of @str in bytes, or -1 if @str is nul-terminated - A convenience function for converting a string to a signed number. + A convenience function for converting a string to a signed number. This function assumes that @str contains only a number of the given @base that is within inclusive bounds limited by @min and @max. If @@ -32333,34 +34446,34 @@ parsing a string which starts with a number, but then has other characters. - %TRUE if @str was a number, otherwise %FALSE. + %TRUE if @str was a number, otherwise %FALSE. - a string + a string - base of a parsed number + base of a parsed number - a lower bound (inclusive) + a lower bound (inclusive) - an upper bound (inclusive) + an upper bound (inclusive) - a return location for a number + a return location for a number - A convenience function for converting a string to an unsigned number. + A convenience function for converting a string to an unsigned number. This function assumes that @str contains only a number of the given @base that is within inclusive bounds limited by @min and @max. If @@ -32384,34 +34497,34 @@ parsing a string which starts with a number, but then has other characters. - %TRUE if @str was a number, otherwise %FALSE. + %TRUE if @str was a number, otherwise %FALSE. - a string + a string - base of a parsed number + base of a parsed number - a lower bound (inclusive) + a lower bound (inclusive) - an upper bound (inclusive) + an upper bound (inclusive) - a return location for a number + a return location for a number - Compare @s1 and @s2, ignoring the case of ASCII characters and any + Compare @s1 and @s2, ignoring the case of ASCII characters and any characters after the first @n in each string. Unlike the BSD strcasecmp() function, this only recognizes standard @@ -32423,27 +34536,27 @@ function only on strings known to be in encodings where bytes corresponding to ASCII letters always represent themselves. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - string to compare with @s2 + string to compare with @s2 - string to compare with @s1 + string to compare with @s1 - number of characters to compare + number of characters to compare - Converts a string to a #gdouble value. + Converts a string to a #gdouble value. This function behaves like the standard strtod() function does in the C locale. It does this without actually changing @@ -32468,23 +34581,23 @@ This function resets %errno before calling strtod() so that you can reliably detect overflow and underflow. - the #gdouble value. + the #gdouble value. - the string to convert to a numeric value. + the string to convert to a numeric value. - if non-%NULL, it returns the + if non-%NULL, it returns the character after the last character used in the conversion. - Converts a string to a #gint64 value. + Converts a string to a #gint64 value. This function behaves like the standard strtoll() function does in the C locale. It does this without actually changing the current locale, since that would not be @@ -32503,27 +34616,27 @@ string conversion fails, zero is returned, and @endptr returns @nptr (if @endptr is non-%NULL). - the #gint64 value or zero on error. + the #gint64 value or zero on error. - the string to convert to a numeric value. + the string to convert to a numeric value. - if non-%NULL, it returns the + if non-%NULL, it returns the character after the last character used in the conversion. - to be used for the conversion, 2..36 or 0 + to be used for the conversion, 2..36 or 0 - Converts a string to a #guint64 value. + Converts a string to a #guint64 value. This function behaves like the standard strtoull() function does in the C locale. It does this without actually changing the current locale, since that would not be @@ -32547,30 +34660,30 @@ If the string conversion fails, zero is returned, and @endptr returns @nptr (if @endptr is non-%NULL). - the #guint64 value or zero on error. + the #guint64 value or zero on error. - the string to convert to a numeric value. + the string to convert to a numeric value. - if non-%NULL, it returns the + if non-%NULL, it returns the character after the last character used in the conversion. - to be used for the conversion, 2..36 or 0 + to be used for the conversion, 2..36 or 0 - Converts all lower case ASCII letters to upper case ASCII letters. + Converts all lower case ASCII letters to upper case ASCII letters. - a newly allocated string, with all the lower case + a newly allocated string, with all the lower case characters in @str converted to upper case, with semantics that exactly match g_ascii_toupper(). (Note that this is unlike the old g_strup(), which modified the string in place.) @@ -32578,17 +34691,17 @@ If the string conversion fails, zero is returned, and @endptr returns - a string + a string - length of @str in bytes, or -1 if @str is nul-terminated + length of @str in bytes, or -1 if @str is nul-terminated - Convert a character to ASCII lower case. + Convert a character to ASCII lower case. Unlike the standard C library tolower() function, this only recognizes standard ASCII letters and ignores the locale, returning @@ -32599,19 +34712,19 @@ don't call it on %EOF but no need to worry about casting to #guchar before passing a possibly non-ASCII character in. - the result of converting @c to lower case. If @c is + the result of converting @c to lower case. If @c is not an ASCII upper case letter, @c is returned unchanged. - any character + any character - Convert a character to ASCII upper case. + Convert a character to ASCII upper case. Unlike the standard C library toupper() function, this only recognizes standard ASCII letters and ignores the locale, returning @@ -32622,35 +34735,348 @@ don't call it on %EOF but no need to worry about casting to #guchar before passing a possibly non-ASCII character in. - the result of converting @c to upper case. If @c is not + the result of converting @c to upper case. If @c is not an ASCII lower case letter, @c is returned unchanged. - any character + any character - Determines the numeric value of a character as a hexidecimal + Determines the numeric value of a character as a hexidecimal digit. Differs from g_unichar_xdigit_value() because it takes a char, so there's no worry about sign extension if characters are signed. - If @c is a hex digit (according to g_ascii_isxdigit()), + If @c is a hex digit (according to g_ascii_isxdigit()), its numeric value. Otherwise, -1. - an ASCII character. + an ASCII character. + + Debugging macro to terminate the application if the assertion +fails. If the assertion fails (i.e. the expression is not true), +an error message is logged and the application is terminated. + +The macro can be turned off in final releases of code by defining +`G_DISABLE_ASSERT` when compiling the application, so code must +not depend on any side effects from @expr. Similarly, it must not be used +in unit tests, otherwise the unit tests will be ineffective if compiled with +`G_DISABLE_ASSERT`. Use g_assert_true() and related macros in unit tests +instead. + + + + the expression to check + + + + + Debugging macro to compare two floating point numbers. + +The effect of `g_assert_cmpfloat (n1, op, n2)` is +the same as `g_assert_true (n1 op n2)`. The advantage +of this macro is that it can produce a message that includes the +actual values of @n1 and @n2. + + + + an floating point number + + + The comparison operator to use. + One of `==`, `!=`, `<`, `>`, `<=`, `>=`. + + + another floating point number + + + + + Debugging macro to compare two floating point numbers within an epsilon. + +The effect of `g_assert_cmpfloat_with_epsilon (n1, n2, epsilon)` is +the same as `g_assert_true (abs (n1 - n2) < epsilon)`. The advantage +of this macro is that it can produce a message that includes the +actual values of @n1 and @n2. + + + + an floating point number + + + another floating point number + + + a numeric value that expresses the expected tolerance + between @n1 and @n2 + + + + + Debugging macro to compare to unsigned integers. + +This is a variant of g_assert_cmpuint() that displays the numbers +in hexadecimal notation in the message. + + + + an unsigned integer + + + The comparison operator to use. + One of `==`, `!=`, `<`, `>`, `<=`, `>=`. + + + another unsigned integer + + + + + Debugging macro to compare two integers. + +The effect of `g_assert_cmpint (n1, op, n2)` is +the same as `g_assert_true (n1 op n2)`. The advantage +of this macro is that it can produce a message that includes the +actual values of @n1 and @n2. + + + + an integer + + + The comparison operator to use. + One of `==`, `!=`, `<`, `>`, `<=`, `>=`. + + + another integer + + + + + Debugging macro to compare memory regions. If the comparison fails, +an error message is logged and the application is either terminated +or the testcase marked as failed. + +The effect of `g_assert_cmpmem (m1, l1, m2, l2)` is +the same as `g_assert_true (l1 == l2 && memcmp (m1, m2, l1) == 0)`. +The advantage of this macro is that it can produce a message that +includes the actual values of @l1 and @l2. + +|[<!-- language="C" --> + g_assert_cmpmem (buf->data, buf->len, expected, sizeof (expected)); +]| + + + + pointer to a buffer + + + length of @m1 + + + pointer to another buffer + + + length of @m2 + + + + + Debugging macro to compare two strings. If the comparison fails, +an error message is logged and the application is either terminated +or the testcase marked as failed. +The strings are compared using g_strcmp0(). + +The effect of `g_assert_cmpstr (s1, op, s2)` is +the same as `g_assert_true (g_strcmp0 (s1, s2) op 0)`. +The advantage of this macro is that it can produce a message that +includes the actual values of @s1 and @s2. + +|[<!-- language="C" --> + g_assert_cmpstr (mystring, ==, "fubar"); +]| + + + + a string (may be %NULL) + + + The comparison operator to use. + One of `==`, `!=`, `<`, `>`, `<=`, `>=`. + + + another string (may be %NULL) + + + + + Debugging macro to compare two unsigned integers. + +The effect of `g_assert_cmpuint (n1, op, n2)` is +the same as `g_assert_true (n1 op n2)`. The advantage +of this macro is that it can produce a message that includes the +actual values of @n1 and @n2. + + + + an unsigned integer + + + The comparison operator to use. + One of `==`, `!=`, `<`, `>`, `<=`, `>=`. + + + another unsigned integer + + + + + Debugging macro to compare two #GVariants. If the comparison fails, +an error message is logged and the application is either terminated +or the testcase marked as failed. The variants are compared using +g_variant_equal(). + +The effect of `g_assert_cmpvariant (v1, v2)` is the same as +`g_assert_true (g_variant_equal (v1, v2))`. The advantage of this macro is +that it can produce a message that includes the actual values of @v1 and @v2. + + + + pointer to a #GVariant + + + pointer to another #GVariant + + + + + Debugging macro to check that a method has returned +the correct #GError. + +The effect of `g_assert_error (err, dom, c)` is +the same as `g_assert_true (err != NULL && err->domain +== dom && err->code == c)`. The advantage of this +macro is that it can produce a message that includes the incorrect +error message and code. + +This can only be used to test for a specific error. If you want to +test that @err is set, but don't care what it's set to, just use +`g_assert_nonnull (err)`. + + + + a #GError, possibly %NULL + + + the expected error domain (a #GQuark) + + + the expected error code + + + + + Debugging macro to check an expression is false. + +If the assertion fails (i.e. the expression is not false), +an error message is logged and the application is either +terminated or the testcase marked as failed. + +Note that unlike g_assert(), this macro is unaffected by whether +`G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and, +conversely, g_assert() should not be used in tests. + +See g_test_set_nonfatal_assertions(). + + + + the expression to check + + + + + Debugging macro to check that a #GError is not set. + +The effect of `g_assert_no_error (err)` is +the same as `g_assert_true (err == NULL)`. The advantage +of this macro is that it can produce a message that includes +the error message and code. + + + + a #GError, possibly %NULL + + + + + Debugging macro to check an expression is not %NULL. + +If the assertion fails (i.e. the expression is %NULL), +an error message is logged and the application is either +terminated or the testcase marked as failed. + +Note that unlike g_assert(), this macro is unaffected by whether +`G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and, +conversely, g_assert() should not be used in tests. + +See g_test_set_nonfatal_assertions(). + + + + the expression to check + + + + + Debugging macro to check an expression is %NULL. + +If the assertion fails (i.e. the expression is not %NULL), +an error message is logged and the application is either +terminated or the testcase marked as failed. + +Note that unlike g_assert(), this macro is unaffected by whether +`G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and, +conversely, g_assert() should not be used in tests. + +See g_test_set_nonfatal_assertions(). + + + + the expression to check + + + + + Debugging macro to check that an expression is true. + +If the assertion fails (i.e. the expression is not true), +an error message is logged and the application is either +terminated or the testcase marked as failed. + +Note that unlike g_assert(), this macro is unaffected by whether +`G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and, +conversely, g_assert() should not be used in tests. + +See g_test_set_nonfatal_assertions(). + + + + the expression to check + + + @@ -32675,7 +35101,7 @@ are signed. - + @@ -32698,7 +35124,7 @@ are signed. - + @@ -32733,7 +35159,7 @@ are signed. - + @@ -32765,7 +35191,7 @@ are signed. - + @@ -32797,37 +35223,37 @@ are signed. - Internal function used to print messages from the public g_assert() and + Internal function used to print messages from the public g_assert() and g_assert_not_reached() macros. - + - log domain + log domain - file containing the assertion + file containing the assertion - line number of the assertion + line number of the assertion - function containing the assertion + function containing the assertion - expression which failed + expression which failed - Specifies a function to be called at normal program termination. + Specifies a function to be called at normal program termination. Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor macro that maps to a call to the atexit() function in the C @@ -32858,19 +35284,19 @@ As can be seen from the above, for portability it's best to avoid calling g_atexit() (or atexit()) except in the main executable of a program. It is best to avoid g_atexit(). - + - the function to call on normal program termination. + the function to call on normal program termination. - Atomically adds @val to the value of @atomic. + Atomically adds @val to the value of @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic += val; return tmp; }`. @@ -32881,22 +35307,22 @@ Before version 2.30, this function did not return a value (but g_atomic_int_exchange_and_add() did, and had the same meaning). - the value of @atomic before the add, signed + the value of @atomic before the add, signed - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to add + the value to add - Performs an atomic bitwise 'and' of the value of @atomic and @val, + Performs an atomic bitwise 'and' of the value of @atomic and @val, storing the result back in @atomic. This call acts as a full compiler and hardware memory barrier. @@ -32905,22 +35331,22 @@ Think of this operation as an atomic version of `{ tmp = *atomic; *atomic &= val; return tmp; }`. - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to 'and' + the value to 'and' - Compares @atomic to @oldval and, if equal, sets it to @newval. + Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs. This compare and exchange is done atomically. @@ -32931,26 +35357,26 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - %TRUE if the exchange took place + %TRUE if the exchange took place - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to compare with + the value to compare with - the value to conditionally replace with + the value to conditionally replace with - Decrements the value of @atomic by 1. + Decrements the value of @atomic by 1. Think of this operation as an atomic version of `{ *atomic -= 1; return (*atomic == 0); }`. @@ -32958,56 +35384,56 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - %TRUE if the resultant value is zero + %TRUE if the resultant value is zero - a pointer to a #gint or #guint + a pointer to a #gint or #guint - This function existed before g_atomic_int_add() returned the prior + This function existed before g_atomic_int_add() returned the prior value of the integer (which it now does). It is retained only for compatibility reasons. Don't use this function in new code. Use g_atomic_int_add() instead. - the value of @atomic before the add, signed + the value of @atomic before the add, signed - a pointer to a #gint + a pointer to a #gint - the value to add + the value to add - Gets the current value of @atomic. + Gets the current value of @atomic. This call acts as a full compiler and hardware memory barrier (before the get). - the value of the integer + the value of the integer - a pointer to a #gint or #guint + a pointer to a #gint or #guint - Increments the value of @atomic by 1. + Increments the value of @atomic by 1. Think of this operation as an atomic version of `{ *atomic += 1; }`. @@ -33018,13 +35444,13 @@ This call acts as a full compiler and hardware memory barrier. - a pointer to a #gint or #guint + a pointer to a #gint or #guint - Performs an atomic bitwise 'or' of the value of @atomic and @val, + Performs an atomic bitwise 'or' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of @@ -33033,22 +35459,22 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to 'or' + the value to 'or' - Sets the value of @atomic to @newval. + Sets the value of @atomic to @newval. This call acts as a full compiler and hardware memory barrier (after the set). @@ -33058,17 +35484,17 @@ memory barrier (after the set). - a pointer to a #gint or #guint + a pointer to a #gint or #guint - a new value to store + a new value to store - Performs an atomic bitwise 'xor' of the value of @atomic and @val, + Performs an atomic bitwise 'xor' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of @@ -33077,22 +35503,22 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gint or #guint + a pointer to a #gint or #guint - the value to 'xor' + the value to 'xor' - Atomically adds @val to the value of @atomic. + Atomically adds @val to the value of @atomic. Think of this operation as an atomic version of `{ tmp = *atomic; *atomic += val; return tmp; }`. @@ -33100,22 +35526,22 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - the value of @atomic before the add, signed + the value of @atomic before the add, signed - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to add + the value to add - Performs an atomic bitwise 'and' of the value of @atomic and @val, + Performs an atomic bitwise 'and' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of @@ -33124,22 +35550,22 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to 'and' + the value to 'and' - Compares @atomic to @oldval and, if equal, sets it to @newval. + Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs. This compare and exchange is done atomically. @@ -33150,43 +35576,43 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - %TRUE if the exchange took place + %TRUE if the exchange took place - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to compare with + the value to compare with - the value to conditionally replace with + the value to conditionally replace with - Gets the current value of @atomic. + Gets the current value of @atomic. This call acts as a full compiler and hardware memory barrier (before the get). - the value of the pointer + the value of the pointer - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - Performs an atomic bitwise 'or' of the value of @atomic and @val, + Performs an atomic bitwise 'or' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of @@ -33195,22 +35621,22 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to 'or' + the value to 'or' - Sets the value of @atomic to @newval. + Sets the value of @atomic to @newval. This call acts as a full compiler and hardware memory barrier (after the set). @@ -33220,17 +35646,17 @@ memory barrier (after the set). - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - a new value to store + a new value to store - Performs an atomic bitwise 'xor' of the value of @atomic and @val, + Performs an atomic bitwise 'xor' of the value of @atomic and @val, storing the result back in @atomic. Think of this operation as an atomic version of @@ -33239,37 +35665,37 @@ Think of this operation as an atomic version of This call acts as a full compiler and hardware memory barrier. - the value of @atomic before the operation, unsigned + the value of @atomic before the operation, unsigned - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - the value to 'xor' + the value to 'xor' - Atomically acquires a reference on the data pointed by @mem_block. + Atomically acquires a reference on the data pointed by @mem_block. - a pointer to the data, + a pointer to the data, with its reference count increased - a pointer to reference counted data + a pointer to reference counted data - Allocates @block_size bytes of memory, and adds atomic + Allocates @block_size bytes of memory, and adds atomic reference counting semantics to it. The data will be freed when its reference count drops to @@ -33279,18 +35705,18 @@ The allocated data is guaranteed to be suitably aligned for any built-in type. - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - Allocates @block_size bytes of memory, and adds atomic + Allocates @block_size bytes of memory, and adds atomic referenc counting semantics to it. The contents of the returned data is set to zero. @@ -33302,53 +35728,82 @@ The allocated data is guaranteed to be suitably aligned for any built-in type. - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - Allocates a new block of data with atomit reference counting + Allocates a new block of data with atomic reference counting semantics, and copies @block_size bytes of @mem_block into it. - a pointer to the allocated + a pointer to the allocated memory - the number of bytes to copy, must be greater than 0 + the number of bytes to copy, must be greater than 0 - the memory to copy + the memory to copy - Retrieves the size of the reference counted data pointed by @mem_block. + Retrieves the size of the reference counted data pointed by @mem_block. - the size of the data, in bytes + the size of the data, in bytes - a pointer to reference counted data + a pointer to reference counted data + + A convenience macro to allocate atomically reference counted +data with the size of the given @type. + +This macro calls g_atomic_rc_box_alloc() with `sizeof (@type)` and +casts the returned pointer to a pointer of the given @type, +avoiding a type cast in the source code. + + + + the type to allocate, typically a structure name + + + + + A convenience macro to allocate atomically reference counted +data with the size of the given @type, and set its contents +to zero. + +This macro calls g_atomic_rc_box_alloc0() with `sizeof (@type)` and +casts the returned pointer to a pointer of the given @type, +avoiding a type cast in the source code. + + + + the type to allocate, typically a structure name + + + - Atomically releases a reference on the data pointed by @mem_block. + Atomically releases a reference on the data pointed by @mem_block. If the reference was the last one, it will free the resources allocated for @mem_block. @@ -33358,13 +35813,13 @@ resources allocated for @mem_block. - a pointer to reference counted data + a pointer to reference counted data - Atomically releases a reference on the data pointed by @mem_block. + Atomically releases a reference on the data pointed by @mem_block. If the reference was the last one, it will call @clear_func to clear the contents of @mem_block, and then will free the @@ -33375,81 +35830,81 @@ resources allocated for @mem_block. - a pointer to reference counted data + a pointer to reference counted data - a function to call when clearing the data + a function to call when clearing the data - Atomically compares the current value of @arc with @val. + Atomically compares the current value of @arc with @val. - %TRUE if the reference count is the same + %TRUE if the reference count is the same as the given value - the address of an atomic reference count variable + the address of an atomic reference count variable - the value to compare + the value to compare - Atomically decreases the reference count. + Atomically decreases the reference count. - %TRUE if the reference count reached 0, and %FALSE otherwise + %TRUE if the reference count reached 0, and %FALSE otherwise - the address of an atomic reference count variable + the address of an atomic reference count variable - Atomically increases the reference count. + Atomically increases the reference count. - the address of an atomic reference count variable + the address of an atomic reference count variable - Initializes a reference count variable. + Initializes a reference count variable. - the address of an atomic reference count variable + the address of an atomic reference count variable - Decode a sequence of Base-64 encoded text into binary data. Note + Decode a sequence of Base-64 encoded text into binary data. Note that the returned binary data is not necessarily zero-terminated, so it should not be used as a character string. - + newly allocated buffer containing the binary data that @text represents. The returned buffer must be freed with g_free(). @@ -33459,40 +35914,40 @@ so it should not be used as a character string. - zero-terminated string with base64 text to decode + zero-terminated string with base64 text to decode - The length of the decoded data is written here + The length of the decoded data is written here - Decode a sequence of Base-64 encoded text into binary data + Decode a sequence of Base-64 encoded text into binary data by overwriting the input data. - The binary data that @text responds. This pointer + The binary data that @text responds. This pointer is the same as the input @text. - zero-terminated + zero-terminated string with base64 text to decode - The length of the decoded data is written here + The length of the decoded data is written here - Incrementally decode a sequence of binary data from its Base-64 stringified + Incrementally decode a sequence of binary data from its Base-64 stringified representation. By calling this function multiple times you can convert data in chunks to avoid having to have the full encoded data in memory. @@ -33502,61 +35957,61 @@ at least: (@len / 4) * 3 + 3 bytes (+ 3 may be needed in case of non-zero state). - The number of bytes of output that was written + The number of bytes of output that was written - binary input data + binary input data - max length of @in data to decode + max length of @in data to decode - output buffer + output buffer - Saved state between steps, initialize to 0 + Saved state between steps, initialize to 0 - Saved state between steps, initialize to 0 + Saved state between steps, initialize to 0 - Encode a sequence of binary data into its Base-64 stringified + Encode a sequence of binary data into its Base-64 stringified representation. - a newly allocated, zero-terminated Base-64 + a newly allocated, zero-terminated Base-64 encoded string representing @data. The returned string must be freed with g_free(). - the binary data to encode + the binary data to encode - the length of @data + the length of @data - Flush the status from a sequence of calls to g_base64_encode_step(). + Flush the status from a sequence of calls to g_base64_encode_step(). The output buffer must be large enough to fit all the data that will be written to it. It will need up to 4 bytes, or up to 5 bytes if @@ -33565,32 +36020,32 @@ line-breaking is enabled. The @out array will not be automatically nul-terminated. - The number of bytes of output that was written + The number of bytes of output that was written - whether to break long lines + whether to break long lines - pointer to destination buffer + pointer to destination buffer - Saved state from g_base64_encode_step() + Saved state from g_base64_encode_step() - Saved state from g_base64_encode_step() + Saved state from g_base64_encode_step() - Incrementally encode a sequence of binary data into its Base-64 stringified + Incrementally encode a sequence of binary data into its Base-64 stringified representation. By calling this function multiple times you can convert data in chunks to avoid having to have the full encoded data in memory. @@ -33611,42 +36066,42 @@ Note however that it breaks the lines with `LF` characters, not or certain other protocols. - The number of bytes of output that was written + The number of bytes of output that was written - the binary data to encode + the binary data to encode - the length of @in + the length of @in - whether to break long lines + whether to break long lines - pointer to destination buffer + pointer to destination buffer - Saved state between steps, initialize to 0 + Saved state between steps, initialize to 0 - Saved state between steps, initialize to 0 + Saved state between steps, initialize to 0 - Gets the name of the file without any leading directory + Gets the name of the file without any leading directory components. It returns a pointer into the given file name string. Use g_path_get_basename() instead, but notice @@ -33655,19 +36110,19 @@ string. into the argument. - the name of the file without any leading + the name of the file without any leading directory components - the name of the file + the name of the file - Sets the indicated @lock_bit in @address. If the bit is already + Sets the indicated @lock_bit in @address. If the bit is already set, this call will block until g_bit_unlock() unsets the corresponding bit. @@ -33686,77 +36141,77 @@ reliably. - a pointer to an integer + a pointer to an integer - a bit value between 0 and 31 + a bit value between 0 and 31 - Find the position of the first bit set in @mask, searching + Find the position of the first bit set in @mask, searching from (but not including) @nth_bit upwards. Bits are numbered from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63, usually). To start searching from the 0th bit, set @nth_bit to -1. - + - the index of the first bit set which is higher than @nth_bit, or -1 + the index of the first bit set which is higher than @nth_bit, or -1 if no higher bits are set - a #gulong containing flags + a #gulong containing flags - the index of the bit to start the search from + the index of the bit to start the search from - Find the position of the first bit set in @mask, searching + Find the position of the first bit set in @mask, searching from (but not including) @nth_bit downwards. Bits are numbered from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63, usually). To start searching from the last bit, set @nth_bit to -1 or GLIB_SIZEOF_LONG * 8. - + - the index of the first bit set which is lower than @nth_bit, or -1 + the index of the first bit set which is lower than @nth_bit, or -1 if no lower bits are set - a #gulong containing flags + a #gulong containing flags - the index of the bit to start the search from + the index of the bit to start the search from - Gets the number of bits used to hold @number, + Gets the number of bits used to hold @number, e.g. if @number is 4, 3 bits are needed. - + - the number of bits used to hold @number + the number of bits used to hold @number - a #guint + a #guint - Sets the indicated @lock_bit in @address, returning %TRUE if + Sets the indicated @lock_bit in @address, returning %TRUE if successful. If the bit is already set, returns %FALSE immediately. Attempting to lock on two different bits within the same integer is @@ -33770,22 +36225,22 @@ This function accesses @address atomically. All other accesses to reliably. - %TRUE if the lock was acquired + %TRUE if the lock was acquired - a pointer to an integer + a pointer to an integer - a bit value between 0 and 31 + a bit value between 0 and 31 - Clears the indicated @lock_bit in @address. If another thread is + Clears the indicated @lock_bit in @address. If another thread is currently blocked in g_bit_lock() on this same bit then it will be woken up. @@ -33798,11 +36253,11 @@ reliably. - a pointer to an integer + a pointer to an integer - a bit value between 0 and 31 + a bit value between 0 and 31 @@ -33813,7 +36268,7 @@ reliably. - Creates a filename from a series of elements using the correct + Creates a filename from a series of elements using the correct separator for filenames. On Unix, this function behaves identically to `g_build_path @@ -33830,54 +36285,54 @@ path. If the first element is a relative path, the result will be a relative path. - a newly-allocated string that must be freed with + a newly-allocated string that must be freed with g_free(). - the first element in the path + the first element in the path - remaining elements in path, terminated by %NULL + remaining elements in path, terminated by %NULL - Behaves exactly like g_build_filename(), but takes the path elements + Behaves exactly like g_build_filename(), but takes the path elements as a va_list. This function is mainly meant for language bindings. - a newly-allocated string that must be freed + a newly-allocated string that must be freed with g_free(). - the first element in the path + the first element in the path - va_list of remaining elements in path + va_list of remaining elements in path - Behaves exactly like g_build_filename(), but takes the path elements + Behaves exactly like g_build_filename(), but takes the path elements as a string array, instead of varargs. This function is mainly meant for language bindings. - a newly-allocated string that must be freed + a newly-allocated string that must be freed with g_free(). - %NULL-terminated + %NULL-terminated array of strings containing the path elements. @@ -33886,7 +36341,7 @@ meant for language bindings. - Creates a path from a series of elements using @separator as the + Creates a path from a series of elements using @separator as the separator between elements. At the boundary between two elements, any trailing occurrences of separator in the first element, or leading occurrences of separator in the second element are removed @@ -33914,42 +36369,42 @@ copies of the separator, elements consisting only of copies of the separator are ignored. - a newly-allocated string that must be freed with + a newly-allocated string that must be freed with g_free(). - a string used to separator the elements of the path. + a string used to separator the elements of the path. - the first element in the path + the first element in the path - remaining elements in path, terminated by %NULL + remaining elements in path, terminated by %NULL - Behaves exactly like g_build_path(), but takes the path elements + Behaves exactly like g_build_path(), but takes the path elements as a string array, instead of varargs. This function is mainly meant for language bindings. - a newly-allocated string that must be freed + a newly-allocated string that must be freed with g_free(). - a string used to separator the elements of the path. + a string used to separator the elements of the path. - %NULL-terminated + %NULL-terminated array of strings containing the path elements. @@ -33958,31 +36413,31 @@ meant for language bindings. - Frees the memory allocated by the #GByteArray. If @free_segment is + Frees the memory allocated by the #GByteArray. If @free_segment is %TRUE it frees the actual byte data. If the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array will be set to zero. - + - the element data if @free_segment is %FALSE, otherwise + the element data if @free_segment is %FALSE, otherwise %NULL. The element data should be freed using g_free(). - a #GByteArray + a #GByteArray - if %TRUE the actual byte data is freed as well + if %TRUE the actual byte data is freed as well - Transfers the data from the #GByteArray into a new immutable #GBytes. + Transfers the data from the #GByteArray into a new immutable #GBytes. The #GByteArray is freed unless the reference count of @array is greater than one, the #GByteArray wrapper is preserved but the size of @array @@ -33990,15 +36445,15 @@ will be set to zero. This is identical to using g_bytes_new_take() and g_byte_array_free() together. - + - a new immutable #GBytes representing same + a new immutable #GBytes representing same byte data that was in the array - a #GByteArray + a #GByteArray @@ -34006,50 +36461,50 @@ together. - Creates a new #GByteArray with a reference count of 1. - + Creates a new #GByteArray with a reference count of 1. + - the new #GByteArray + the new #GByteArray - Create byte array containing the data. The data will be owned by the array + Create byte array containing the data. The data will be owned by the array and will be freed with g_free(), i.e. it could be allocated using g_strdup(). - + - a new #GByteArray + a new #GByteArray - byte data for the array + byte data for the array - length of @data + length of @data - Atomically decrements the reference count of @array by one. If the + Atomically decrements the reference count of @array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread. - + - A #GByteArray + A #GByteArray @@ -34057,7 +36512,7 @@ thread. - Gets the canonical file name from @filename. All triple slashes are turned into + Gets the canonical file name from @filename. All triple slashes are turned into single slashes, and all `..` and `.`s resolved against @relative_to. Symlinks are not followed, and the returned path is guaranteed to be absolute. @@ -34071,44 +36526,44 @@ This function never fails, and will canonicalize file paths even if they don't exist. No file system I/O is done. - + - a newly allocated string with the + a newly allocated string with the canonical file path - the name of the file + the name of the file - the relative directory, or %NULL + the relative directory, or %NULL to use the current working directory - A wrapper for the POSIX chdir() function. The function changes the + A wrapper for the POSIX chdir() function. The function changes the current directory of the process to @path. See your C library manual for more details about chdir(). - + - 0 on success, -1 if an error occurred. + 0 on success, -1 if an error occurred. - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) - Checks that the GLib library in use is compatible with the + Checks that the GLib library in use is compatible with the given version. Generally you would pass in the constants #GLIB_MAJOR_VERSION, #GLIB_MINOR_VERSION, #GLIB_MICRO_VERSION as the three arguments to this function; that produces @@ -34124,7 +36579,7 @@ version @required_major.required_minor.@required_micro (same major version.) - %NULL if the GLib library is compatible with the + %NULL if the GLib library is compatible with the given version, or a string describing the version mismatch. The returned string is owned by GLib and must not be modified or freed. @@ -34132,36 +36587,36 @@ version @required_major.required_minor.@required_micro - the required major version + the required major version - the required minor version + the required minor version - the required micro version + the required micro version - Gets the length in bytes of digests of type @checksum_type + Gets the length in bytes of digests of type @checksum_type - the checksum length, or -1 if @checksum_type is + the checksum length, or -1 if @checksum_type is not supported. - a #GChecksumType + a #GChecksumType - Sets a function to be called when the child indicated by @pid + Sets a function to be called when the child indicated by @pid exits, at a default priority, #G_PRIORITY_DEFAULT. If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() @@ -34181,30 +36636,30 @@ This internally creates a main loop source using g_child_watch_source_new() and attaches it to the main loop context using g_source_attach(). You can do these steps manually if you need greater control. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - process id to watch. On POSIX the positive pid of a child + process id to watch. On POSIX the positive pid of a child process. On Windows a handle for a process (which doesn't have to be a child). - function to call + function to call - data to pass to @function + data to pass to @function - Sets a function to be called when the child indicated by @pid + Sets a function to be called when the child indicated by @pid exits, at the priority @priority. If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() @@ -34228,38 +36683,38 @@ This internally creates a main loop source using g_child_watch_source_new() and attaches it to the main loop context using g_source_attach(). You can do these steps manually if you need greater control. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the idle source. Typically this will be in the + the priority of the idle source. Typically this will be in the range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE. - process to watch. On POSIX the positive pid of a child process. On + process to watch. On POSIX the positive pid of a child process. On Windows a handle for a process (which doesn't have to be a child). - function to call + function to call - data to pass to @function + data to pass to @function - function to call when the idle is removed, or %NULL + function to call when the idle is removed, or %NULL - Creates a new child_watch source. + Creates a new child_watch source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be @@ -34291,21 +36746,21 @@ stating that `ECHILD` was received by `waitpid`. Calling `waitpid` for specific processes other than @pid remains a valid thing to do. - + - the newly-created child watch source + the newly-created child watch source - process to watch. On POSIX the positive pid of a child process. On + process to watch. On POSIX the positive pid of a child process. On Windows a handle for a process (which doesn't have to be a child). - If @err or *@err is %NULL, does nothing. Otherwise, + If @err or *@err is %NULL, does nothing. Otherwise, calls g_error_free() on *@err and sets *@err to %NULL. @@ -34313,7 +36768,7 @@ calls g_error_free() on *@err and sets *@err to %NULL. - Clears a numeric handler, such as a #GSource ID. + Clears a numeric handler, such as a #GSource ID. @tag_ptr must be a valid pointer to the variable holding the handler. @@ -34323,23 +36778,23 @@ set to zero. A macro is also included that allows this function to be used without pointer casts. - + - a pointer to the handler ID + a pointer to the handler ID - the function to call to clear the handler + the function to call to clear the handler - Clears a reference to a variable. + Clears a reference to a variable. @pp must not be %NULL. @@ -34359,217 +36814,217 @@ will experience undefined behaviour. - a pointer to a variable, struct member etc. holding a + a pointer to a variable, struct member etc. holding a pointer - a function to which a gpointer can be passed, to destroy *@pp + a function to which a gpointer can be passed, to destroy *@pp - This wraps the close() call; in case of error, %errno will be + This wraps the close() call; in case of error, %errno will be preserved, but the error will also be stored as a #GError in @error. Besides using #GError, there is another major reason to prefer this function over the call provided by the system; on Unix, it will attempt to correctly handle %EINTR, which has platform-specific semantics. - + - %TRUE on success, %FALSE if there was an error. + %TRUE on success, %FALSE if there was an error. - A file descriptor + A file descriptor - Computes the checksum for a binary @data. This is a + Computes the checksum for a binary @data. This is a convenience wrapper for g_checksum_new(), g_checksum_get_string() and g_checksum_free(). The hexadecimal string returned will be in lower case. - the digest of the binary data as a string in hexadecimal. + the digest of the binary data as a string in hexadecimal. The returned string should be freed with g_free() when done using it. - a #GChecksumType + a #GChecksumType - binary blob to compute the digest of + binary blob to compute the digest of - Computes the checksum for a binary @data of @length. This is a + Computes the checksum for a binary @data of @length. This is a convenience wrapper for g_checksum_new(), g_checksum_get_string() and g_checksum_free(). The hexadecimal string returned will be in lower case. - the digest of the binary data as a string in hexadecimal. + the digest of the binary data as a string in hexadecimal. The returned string should be freed with g_free() when done using it. - a #GChecksumType + a #GChecksumType - binary blob to compute the digest of + binary blob to compute the digest of - length of @data + length of @data - Computes the checksum of a string. + Computes the checksum of a string. The hexadecimal string returned will be in lower case. - the checksum as a hexadecimal string. The returned string + the checksum as a hexadecimal string. The returned string should be freed with g_free() when done using it. - a #GChecksumType + a #GChecksumType - the string to compute the checksum of + the string to compute the checksum of - the length of the string, or -1 if the string is null-terminated. + the length of the string, or -1 if the string is null-terminated. - Computes the HMAC for a binary @data. This is a + 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. - the HMAC of the binary data as a string in hexadecimal. + the HMAC of the binary data as a string in hexadecimal. The returned string should be freed with g_free() when done using it. - a #GChecksumType to use for the HMAC + a #GChecksumType to use for the HMAC - the key to use in the HMAC + the key to use in the HMAC - binary blob to compute the HMAC of + binary blob to compute the HMAC of - Computes the HMAC for a binary @data of @length. This is a + Computes the HMAC for a binary @data of @length. This is a convenience wrapper for g_hmac_new(), g_hmac_get_string() and g_hmac_unref(). The hexadecimal string returned will be in lower case. - the HMAC of the binary data as a string in hexadecimal. + the HMAC of the binary data as a string in hexadecimal. The returned string should be freed with g_free() when done using it. - a #GChecksumType to use for the HMAC + a #GChecksumType to use for the HMAC - the key to use in the HMAC + the key to use in the HMAC - the length of the key + the length of the key - binary blob to compute the HMAC of + binary blob to compute the HMAC of - length of @data + length of @data - Computes the HMAC for a string. + Computes the HMAC for a string. The hexadecimal string returned will be in lower case. - the HMAC as a hexadecimal string. + the HMAC as a hexadecimal string. The returned string should be freed with g_free() when done using it. - a #GChecksumType to use for the HMAC + a #GChecksumType to use for the HMAC - the key to use in the HMAC + the key to use in the HMAC - the length of the key + the length of the key - the string to compute the HMAC for + the string to compute the HMAC for - the length of the string, or -1 if the string is nul-terminated + the length of the string, or -1 if the string is nul-terminated - Converts a string from one character set to another. + Converts a string from one character set to another. Note that you should use g_iconv() for streaming conversions. Despite the fact that @bytes_read can return information about partial @@ -34585,7 +37040,7 @@ Using extensions such as "//TRANSLIT" may not work (or may not work well) on many platforms. Consider using g_str_to_ascii() instead. - + If the conversion was successful, a newly allocated buffer containing the converted string, which must be freed with g_free(). Otherwise %NULL and @error will be set. @@ -34595,29 +37050,29 @@ well) on many platforms. Consider using g_str_to_ascii() instead. - + the string to convert. - the length of the string in bytes, 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) - name of character set into which to convert @str + name of character set into which to convert @str - character set of @str. + character set of @str. - location to store the number of bytes in + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -34628,7 +37083,7 @@ well) on many platforms. Consider using g_str_to_ascii() instead. - the number of bytes stored in + the number of bytes stored in the output buffer (not including the terminating nul). @@ -34640,7 +37095,7 @@ well) on many platforms. Consider using g_str_to_ascii() instead. - Converts a string from one character set to another, possibly + Converts a string from one character set to another, possibly including fallback sequences for characters not representable in the output. Note that it is not guaranteed that the specification for the fallback sequences in @fallback will be honored. Some @@ -34659,7 +37114,7 @@ character until it knows that the next character is not a mark that could combine with the base character.) - + If the conversion was successful, a newly allocated buffer containing the converted string, which must be freed with g_free(). Otherwise %NULL and @error will be set. @@ -34669,29 +37124,29 @@ could combine with the base character.) - + the string to convert. - the length of the string in bytes, 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) - name of character set into which to convert @str + name of character set into which to convert @str - character set of @str. + character set of @str. - UTF-8 string to use in place of characters not + UTF-8 string to use in place of characters not present in the target encoding. (The string must be representable in the target encoding). If %NULL, characters not in the target encoding will @@ -34699,7 +37154,7 @@ could combine with the base character.) - location to store the number of bytes in + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -34707,14 +37162,14 @@ could combine with the base character.) - the number of bytes stored in + the number of bytes stored in the output buffer (not including the terminating nul). - Converts a string from one character set to another. + Converts a string from one character set to another. Note that you should use g_iconv() for streaming conversions. Despite the fact that @bytes_read can return information about partial @@ -34735,7 +37190,7 @@ the input character set. To get defined behaviour for conversion of unrepresentable characters, use g_convert_with_fallback(). - + If the conversion was successful, a newly allocated buffer containing the converted string, which must be freed with g_free(). Otherwise %NULL and @error will be set. @@ -34745,25 +37200,25 @@ unrepresentable characters, use g_convert_with_fallback(). - + the string to convert. - the length of the string in bytes, 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) - conversion descriptor from g_iconv_open() + conversion descriptor from g_iconv_open() - location to store the number of bytes in + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -34774,14 +37229,14 @@ unrepresentable characters, use g_convert_with_fallback(). - the number of bytes stored in + the number of bytes stored in the output buffer (not including the terminating nul). - Frees all the data elements of the datalist. + Frees all the data elements of the datalist. The data elements' destroy functions are called if they have been set. @@ -34790,13 +37245,13 @@ if they have been set. - a datalist. + a datalist. - Calls the given function for each data element of the datalist. The + Calls the given function for each data element of the datalist. The function is called with each data element's #GQuark id and data, together with the given @user_data parameter. Note that this function is NOT thread-safe. So unless @datalist can be protected @@ -34812,56 +37267,56 @@ than skipping over elements that are removed. - a datalist. + a datalist. - the function to call for each data element. + the function to call for each data element. - user data to pass to the function. + user data to pass to the function. - Gets a data element, using its string identifier. This is slower than + Gets a data element, using its string identifier. This is slower than g_datalist_id_get_data() because it compares strings. - the data element, or %NULL if it + the data element, or %NULL if it is not found. - a datalist. + a datalist. - the string identifying a data element. + the string identifying a data element. - Gets flags values packed in together with the datalist. + Gets flags values packed in together with the datalist. See g_datalist_set_flags(). - the flags of the datalist + the flags of the datalist - pointer to the location that holds a list + pointer to the location that holds a list - This is a variant of g_datalist_id_get_data() which + This is a variant of g_datalist_id_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -34876,71 +37331,83 @@ This function can be useful to avoid races when multiple threads are using the same datalist and the same key. - the result of calling @dup_func on the value + the result of calling @dup_func on the value associated with @key_id in @datalist, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. - location of a datalist + location of a datalist - the #GQuark identifying a data element + the #GQuark identifying a data element - function to duplicate the old value + function to duplicate the old value - passed as user_data to @dup_func + passed as user_data to @dup_func - Retrieves the data element corresponding to @key_id. + Retrieves the data element corresponding to @key_id. - the data element, or %NULL if + the data element, or %NULL if it is not found. - a datalist. + a datalist. - the #GQuark identifying a data element. + the #GQuark identifying a data element. + + Removes an element, using its #GQuark identifier. + + + + a datalist. + + + the #GQuark identifying the data element. + + + - Removes an element, without calling its destroy notification + Removes an element, without calling its destroy notification function. - the data previously stored at @key_id, + the data previously stored at @key_id, or %NULL if none. - a datalist. + a datalist. - the #GQuark identifying a data element. + the #GQuark identifying a data element. - Compares the member that is associated with @key_id in + Compares the member that is associated with @key_id in @datalist to @oldval, and if they are the same, replace @oldval with @newval. @@ -34955,39 +37422,57 @@ or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. - %TRUE if the existing value for @key_id was replaced + %TRUE if the existing value for @key_id was replaced by @newval, %FALSE otherwise. - location of a datalist + location of a datalist - the #GQuark identifying a data element + the #GQuark identifying a data element - the old value to compare against + the old value to compare against - the new value to replace it with + the new value to replace it with - destroy notify for the new value + destroy notify for the new value - destroy notify for the existing value + destroy notify for the existing value + + Sets the data corresponding to the given #GQuark id. Any previous +data with the same key is removed, and its destroy function is +called. + + + + a datalist. + + + the #GQuark to identify the data element. + + + the data element, or %NULL to remove any previous element + corresponding to @q. + + + - Sets the data corresponding to the given #GQuark id, and the + Sets the data corresponding to the given #GQuark id, and the function to be called when the element is removed from the datalist. Any previous data with the same key is removed, and its destroy function is called. @@ -34997,20 +37482,20 @@ function is called. - a datalist. + a datalist. - the #GQuark to identify the data element. + the #GQuark to identify the data element. - the data element or %NULL to remove any previous element + the data element or %NULL to remove any previous element corresponding to @key_id. - the function to call when the data element is + the function to call when the data element is removed. This function will be called with the data element and can be used to free any memory allocated for it. If @data is %NULL, then @destroy_func must @@ -35020,7 +37505,7 @@ function is called. - Resets the datalist to %NULL. It does not free any memory or call + Resets the datalist to %NULL. It does not free any memory or call any destroy functions. @@ -35028,13 +37513,77 @@ any destroy functions. - a pointer to a pointer to a datalist. + a pointer to a pointer to a datalist. + + Removes an element using its string identifier. The data element's +destroy function is called if it has been set. + + + + a datalist. + + + the string identifying the data element. + + + + + Removes an element, without calling its destroy notifier. + + + + a datalist. + + + the string identifying the data element. + + + + + Sets the data element corresponding to the given string identifier. + + + + a datalist. + + + the string to identify the data element. + + + the data element, or %NULL to remove any previous element + corresponding to @k. + + + + + Sets the data element corresponding to the given string identifier, +and the function to be called when the data element is removed. + + + + a datalist. + + + the string to identify the data element. + + + the data element, or %NULL to remove any previous element + corresponding to @k. + + + the function to call when the data element is removed. + This function will be called with the data element and can be used to + free any memory allocated for it. If @d is %NULL, then @f must + also be %NULL. + + + - Turns on flag values for a data list. This function is used + Turns on flag values for a data list. This function is used to keep a small number of boolean flags in an object with a data list without using any additional space. It is not generally useful except in circumstances where space @@ -35046,11 +37595,11 @@ example.) - pointer to the location that holds a list + pointer to the location that holds a list - the flags to turn on. The values of the flags are + the flags to turn on. The values of the flags are restricted by %G_DATALIST_FLAGS_MASK (currently 3; giving two possible boolean flags). A value for @flags that doesn't fit within the mask is @@ -35060,18 +37609,18 @@ example.) - Turns off flag values for a data list. See g_datalist_unset_flags() + Turns off flag values for a data list. See g_datalist_unset_flags() - pointer to the location that holds a list + pointer to the location that holds a list - the flags to turn off. The values of the flags are + the flags to turn off. The values of the flags are restricted by %G_DATALIST_FLAGS_MASK (currently 3: giving two possible boolean flags). A value for @flags that doesn't fit within the mask is @@ -35081,7 +37630,7 @@ example.) - Destroys the dataset, freeing all memory allocated, and calling any + Destroys the dataset, freeing all memory allocated, and calling any destroy functions set for data elements. @@ -35089,13 +37638,13 @@ destroy functions set for data elements. - the location identifying the dataset. + the location identifying the dataset. - Calls the given function for each data element which is associated + Calls the given function for each data element which is associated with the given location. Note that this function is NOT thread-safe. So unless @dataset_location can be protected from any modifications during invocation of this function, it should not be called. @@ -35109,60 +37658,102 @@ than skipping over elements that are removed. - the location identifying the dataset. + the location identifying the dataset. - the function to call for each data element. + the function to call for each data element. - user data to pass to the function. + user data to pass to the function. + + Gets the data element corresponding to a string. + + + + the location identifying the dataset. + + + the string identifying the data element. + + + - Gets the data element corresponding to a #GQuark. + Gets the data element corresponding to a #GQuark. - the data element corresponding to + the data element corresponding to the #GQuark, or %NULL if it is not found. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark id to identify the data element. + the #GQuark id to identify the data element. + + Removes a data element from a dataset. The data element's destroy +function is called if it has been set. + + + + the location identifying the dataset. + + + the #GQuark id identifying the data element. + + + - Removes an element, without calling its destroy notification + Removes an element, without calling its destroy notification function. - the data previously stored at @key_id, + the data previously stored at @key_id, or %NULL if none. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark ID identifying the data element. + the #GQuark ID identifying the data element. + + Sets the data element associated with the given #GQuark id. Any +previous data with the same key is removed, and its destroy function +is called. + + + + the location identifying the dataset. + + + the #GQuark id to identify the data element. + + + the data element. + + + - Sets the data element associated with the given #GQuark id, and also + Sets the data element associated with the given #GQuark id, and also the function to call when the data element is destroyed. Any previous data with the same key is removed, and its destroy function is called. @@ -35172,19 +37763,19 @@ is called. - the location identifying the dataset. + the location identifying the dataset. - the #GQuark id to identify the data element. + the #GQuark id to identify the data element. - the data element. + the data element. - the function to call when the data element is + the function to call when the data element is removed. This function will be called with the data element and can be used to free any memory allocated for it. @@ -35192,27 +37783,88 @@ is called. + + Removes a data element corresponding to a string. Its destroy +function is called if it has been set. + + + + the location identifying the dataset. + + + the string identifying the data element. + + + + + Removes an element, without calling its destroy notifier. + + + + the location identifying the dataset. + + + the string identifying the data element. + + + + + Sets the data corresponding to the given string identifier. + + + + the location identifying the dataset. + + + the string to identify the data element. + + + the data element. + + + + + Sets the data corresponding to the given string identifier, and the +function to call when the data element is destroyed. + + + + the location identifying the dataset. + + + the string to identify the data element. + + + the data element. + + + the function to call when the data element is removed. This + function will be called with the data element and can be used to + free any memory allocated for it. + + + - Returns the number of days in a month, taking leap + Returns the number of days in a month, taking leap years into account. - number of days in @month during the @year + number of days in @month during the @year - month + month - year + year - Returns the number of weeks in the year, where weeks + Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -35221,18 +37873,18 @@ Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.) - number of Mondays in the year + number of Mondays in the year - a year + a year - Returns the number of weeks in the year, where weeks + Returns the number of weeks in the year, where weeks are taken to start on Sunday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap @@ -35241,18 +37893,18 @@ Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.) - the number of weeks in @year + the number of weeks in @year - year to count weeks in + year to count weeks in - Returns %TRUE if the year is a leap year. + Returns %TRUE if the year is a leap year. For the purposes of this function, leap year is every year divisible by 4 unless that year is divisible by 100. If it @@ -35260,18 +37912,18 @@ is divisible by 100 it would be a leap year only if that year is also divisible by 400. - %TRUE if the year is a leap year + %TRUE if the year is a leap year - year to check + year to check - Generates a printed representation of the date, in a + Generates a printed representation of the date, in a [locale][setlocale]-specific way. Works just like the platform's C library strftime() function, but only accepts date-related formats; time-related formats @@ -35286,210 +37938,210 @@ make the \%F provided by the C99 strftime() work on Windows where the C library only complies to C89. - number of characters written to the buffer, or 0 the buffer was too small + number of characters written to the buffer, or 0 the buffer was too small - destination buffer + destination buffer - buffer size + buffer size - format string + format string - valid #GDate + valid #GDate - A comparison function for #GDateTimes that is suitable + A comparison function for #GDateTimes that is suitable as a #GCompareFunc. Both #GDateTimes must be non-%NULL. - + - -1, 0 or 1 if @dt1 is less than, equal to or greater + -1, 0 or 1 if @dt1 is less than, equal to or greater than @dt2. - first #GDateTime to compare + first #GDateTime to compare - second #GDateTime to compare + second #GDateTime to compare - Checks to see if @dt1 and @dt2 are equal. + Checks to see if @dt1 and @dt2 are equal. Equal here means that they represent the same moment after converting them to the same time zone. - + - %TRUE if @dt1 and @dt2 are equal + %TRUE if @dt1 and @dt2 are equal - a #GDateTime + a #GDateTime - a #GDateTime + a #GDateTime - Hashes @datetime into a #guint, suitable for use within #GHashTable. - + Hashes @datetime into a #guint, suitable for use within #GHashTable. + - a #guint containing the hash + a #guint containing the hash - a #GDateTime + a #GDateTime - Returns %TRUE if the day of the month is valid (a day is valid if it's + Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive). - %TRUE if the day is valid + %TRUE if the day is valid - day to check + day to check - Returns %TRUE if the day-month-year triplet forms a valid, existing day + Returns %TRUE if the day-month-year triplet forms a valid, existing day in the range of days #GDate understands (Year 1 or later, no more than a few thousand years in the future). - %TRUE if the date is a valid one + %TRUE if the date is a valid one - day + day - month + month - year + year - Returns %TRUE if the Julian day is valid. Anything greater than zero + Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit. - %TRUE if the Julian day is valid + %TRUE if the Julian day is valid - Julian day to check + Julian day to check - Returns %TRUE if the month value is valid. The 12 #GDateMonth + Returns %TRUE if the month value is valid. The 12 #GDateMonth enumeration values are the only valid months. - %TRUE if the month is valid + %TRUE if the month is valid - month + month - Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration + Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays. - %TRUE if the weekday is valid + %TRUE if the weekday is valid - weekday + weekday - Returns %TRUE if the year is valid. Any year greater than 0 is valid, + Returns %TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what #GDate will understand. - %TRUE if the year is valid + %TRUE if the year is valid - year + year - This is a variant of g_dgettext() that allows specifying a locale + This is a variant of g_dgettext() that allows specifying a locale category instead of always using `LC_MESSAGES`. See g_dgettext() for more information about how this functions differs from calling dcgettext() directly. - the translated string for the given locale category + the translated string for the given locale category - the translation domain to use, or %NULL to use + the translation domain to use, or %NULL to use the domain set with textdomain() - message to translate + message to translate - a locale category + a locale category - This function is a wrapper of dgettext() which does not translate + This function is a wrapper of dgettext() which does not translate the message if the default domain as set with textdomain() has no translations for the current locale. @@ -35523,23 +38175,23 @@ Applications should normally not use this function directly, but use the _() macro for translations. - The translated string + The translated string - the translation domain to use, or %NULL to use + the translation domain to use, or %NULL to use the domain set with textdomain() - message to translate + message to translate - Creates a subdirectory in the preferred directory for temporary + Creates a subdirectory in the preferred directory for temporary files (as returned by g_get_tmp_dir()). @tmpl should be a string in the GLib file name encoding containing @@ -35552,7 +38204,7 @@ Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not modified, and might thus be a read-only literal string. - The actual name used. This string + The actual name used. This string should be freed with g_free() when not needed any longer and is is in the GLib file name encoding. In case of errors, %NULL is returned and @error will be set. @@ -35560,58 +38212,58 @@ modified, and might thus be a read-only literal string. - Template for directory name, + Template for directory name, as in g_mkdtemp(), basename only, or %NULL for a default template - Compares two #gpointer arguments and returns %TRUE if they are equal. + Compares two #gpointer arguments and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using opaque pointers compared by pointer value as keys in a #GHashTable. This equality function is also appropriate for keys that are integers stored in pointers, such as `GINT_TO_POINTER (n)`. - + - %TRUE if the two keys match. + %TRUE if the two keys match. - a key + a key - a key to compare with @v1 + a key to compare with @v1 - Converts a gpointer to a hash value. + Converts a gpointer to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using opaque pointers compared by pointer value as keys in a #GHashTable. This hash function is also appropriate for keys that are integers stored in pointers, such as `GINT_TO_POINTER (n)`. - + - a hash value corresponding to the key. + a hash value corresponding to the key. - a #gpointer key + a #gpointer key - This function is a wrapper of dngettext() which does not translate + This function is a wrapper of dngettext() which does not translate the message if the default domain as set with textdomain() has no translations for the current locale. @@ -35619,70 +38271,70 @@ See g_dgettext() for details of how this differs from dngettext() proper. - The translated string + The translated string - the translation domain to use, or %NULL to use + the translation domain to use, or %NULL to use the domain set with textdomain() - message to translate + message to translate - plural form of the message + plural form of the message - the quantity for which translation is needed + the quantity for which translation is needed - Compares the two #gdouble values being pointed to and returns + Compares the two #gdouble values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to doubles as keys in a #GHashTable. - + - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #gdouble key + a pointer to a #gdouble key - a pointer to a #gdouble key to compare with @v1 + a pointer to a #gdouble key to compare with @v1 - Converts a pointer to a #gdouble to a hash value. + Converts a pointer to a #gdouble to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to doubles as keys in a #GHashTable. - + - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #gdouble key + a pointer to a #gdouble key - This function is a variant of g_dgettext() which supports + This function is a variant of g_dgettext() which supports a disambiguating message context. GNU gettext uses the '\004' character to separate the message context and message id in @msgctxtid. @@ -35697,28 +38349,28 @@ Applications should normally not use this function directly, but use the C_() macro for translations with context. - The translated string + The translated string - the translation domain to use, or %NULL to use + the translation domain to use, or %NULL to use the domain set with textdomain() - a combined message context and message id, separated + a combined message context and message id, separated by a \004 character - the offset of the message id in @msgctxid + the offset of the message id in @msgctxid - This function is a variant of g_dgettext() which supports + This function is a variant of g_dgettext() which supports a disambiguating message context. GNU gettext uses the '\004' character to separate the message context and message id in @msgctxtid. @@ -35730,31 +38382,31 @@ This function differs from C_() in that it is not a macro and thus you may use non-string-literals as context and msgid arguments. - The translated string + The translated string - the translation domain to use, or %NULL to use + the translation domain to use, or %NULL to use the domain set with textdomain() - the message context + the message context - the message + the message - Returns the value of the environment variable @variable in the + Returns the value of the environment variable @variable in the provided list @envp. - the value of the environment variable, or %NULL if + the value of the environment variable, or %NULL if the environment variable is not set in @envp. The returned string is owned by @envp, and will be freed if @variable is set or unset again. @@ -35762,7 +38414,7 @@ provided list @envp. - + an environment list (eg, as returned from g_get_environ()), or %NULL for an empty environment list @@ -35770,17 +38422,17 @@ provided list @envp. - the environment variable to get + the environment variable to get - Sets the environment variable @variable in the provided list + Sets the environment variable @variable in the provided list @envp to @value. - + the updated environment list. Free it using g_strfreev(). @@ -35788,7 +38440,7 @@ provided list @envp. - + an environment list that can be freed using g_strfreev() (e.g., as returned from g_get_environ()), or %NULL for an empty environment list @@ -35797,26 +38449,26 @@ provided list @envp. - the environment variable to set, must not + the environment variable to set, must not contain '=' - the value for to set the variable to + the value for to set the variable to - whether to change the variable if it already exists + whether to change the variable if it already exists - Removes the environment variable @variable from the provided + Removes the environment variable @variable from the provided environment @envp. - + the updated environment list. Free it using g_strfreev(). @@ -35824,7 +38476,7 @@ environment @envp. - + an environment list that can be freed using g_strfreev() (e.g., as returned from g_get_environ()), or %NULL for an empty environment list @@ -35832,14 +38484,14 @@ environment @envp. - the environment variable to remove, must not + the environment variable to remove, must not contain '=' - Gets a #GFileError constant based on the passed-in @err_no. + Gets a #GFileError constant based on the passed-in @err_no. For example, if you pass in `EEXIST` this function returns #G_FILE_ERROR_EXIST. Unlike `errno` values, you can portably assume that all #GFileError values will exist. @@ -35849,12 +38501,12 @@ from a function that manipulates files. So you would use g_file_error_from_errno() when constructing a #GError. - #GFileError corresponding to the given @errno + #GFileError corresponding to the given @errno - an "errno" value + an "errno" value @@ -35865,7 +38517,7 @@ g_file_error_from_errno() when constructing a #GError. - Reads an entire file into allocated memory, with good error + Reads an entire file into allocated memory, with good error checking. If the call was successful, it returns %TRUE and sets @contents to the file @@ -35877,29 +38529,29 @@ codes are those in the #GFileError enumeration. In the error case, @contents is set to %NULL and @length is set to zero. - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - name of a file to read contents from, in the GLib file name encoding + name of a file to read contents from, in the GLib file name encoding - location to store an allocated string, use g_free() to free + location to store an allocated string, use g_free() to free the returned string - location to store length in bytes of the contents, or %NULL + location to store length in bytes of the contents, or %NULL - Opens a file for writing in the preferred directory for temporary + Opens a file for writing in the preferred directory for temporary files (as returned by g_get_tmp_dir()). @tmpl should be a string in the GLib file name encoding containing @@ -35917,7 +38569,7 @@ when not needed any longer. The returned name is in the GLib file name encoding. - A file handle (as from open()) to the file opened for + A file handle (as from open()) to the file opened for reading and writing. The file is opened in binary mode on platforms where there is a difference. The file handle should be closed with close(). In case of errors, -1 is returned and @error will be set. @@ -35925,36 +38577,36 @@ name encoding. - Template for file name, as in + Template for file name, as in g_mkstemp(), basename only, or %NULL for a default template - location to store actual name used, + location to store actual name used, or %NULL - Reads the contents of the symbolic link @filename like the POSIX + Reads the contents of the symbolic link @filename like the POSIX readlink() function. The returned string is in the encoding used for filenames. Use g_filename_to_utf8() to convert it to UTF-8. - A newly-allocated string with the contents of + A newly-allocated string with the contents of the symbolic link, or %NULL if an error occurred. - the symbolic link + the symbolic link - Writes all of @contents to a file named @filename, with good error checking. + Writes all of @contents to a file named @filename, with good error checking. If a file called @filename already exists it will be overwritten. This write is atomic in the sense that it is first written to a temporary @@ -35992,29 +38644,29 @@ Note that the name for the temporary file is constructed by appending up to 7 characters to @filename. - %TRUE on success, %FALSE if an error occurred + %TRUE on success, %FALSE if an error occurred - name of a file to write @contents to, in the GLib file name + name of a file to write @contents to, in the GLib file name encoding - string to write to the file + string to write to the file - length of @contents, or -1 if @contents is a nul-terminated string + length of @contents, or -1 if @contents is a nul-terminated string - Returns %TRUE if any of the tests in the bitfield @test are + Returns %TRUE if any of the tests in the bitfield @test are %TRUE. For example, `(G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)` will return %TRUE if the file exists; the check whether it's a directory doesn't matter since the existence test is %TRUE. With @@ -36057,23 +38709,23 @@ its name indicates that it is executable, checking for well-known extensions and those listed in the `PATHEXT` environment variable. - whether a test was %TRUE + whether a test was %TRUE - a filename to test in the + a filename to test in the GLib file name encoding - bitfield of #GFileTest flags + bitfield of #GFileTest flags - Returns the display basename for the particular filename, guaranteed + Returns the display basename for the particular filename, guaranteed to be valid UTF-8. The display name might not be identical to the filename, for instance there might be problems converting it to UTF-8, and some files can be translated in the display. @@ -36091,20 +38743,20 @@ This function is preferred over g_filename_display_name() if you know the whole path, as it allows translation. - a newly allocated string containing + a newly allocated string containing a rendition of the basename of the filename in valid UTF-8 - an absolute pathname in the + an absolute pathname in the GLib file name encoding - Converts a filename into a valid UTF-8 string. The conversion is + Converts a filename into a valid UTF-8 string. The conversion is not necessarily reversible, so you should keep the original around and use the return value of this function only for display purposes. Unlike g_filename_to_utf8(), the result is guaranteed to be non-%NULL @@ -36121,34 +38773,34 @@ g_filename_display_basename(), since that allows location-based translation of filenames. - a newly allocated string containing + a newly allocated string containing a rendition of the filename in valid UTF-8 - a pathname hopefully in the + a pathname hopefully in the GLib file name encoding - Converts an escaped ASCII-encoded URI to a local filename in the + Converts an escaped ASCII-encoded URI to a local filename in the encoding used for filenames. - a newly-allocated string holding + a newly-allocated string holding the resulting filename, or %NULL on an error. - a uri describing a filename (escaped, encoded in ASCII). + a uri describing a filename (escaped, encoded in ASCII). - Location to store hostname for the URI. + Location to store hostname for the URI. If there is no hostname in the URI, %NULL will be stored in this location. @@ -36156,7 +38808,7 @@ encoding used for filenames. - Converts a string from UTF-8 to the encoding GLib uses for + Converts a string from UTF-8 to the encoding GLib uses for filenames. Note that on Windows GLib uses UTF-8 for filenames; on other platforms, this function indirectly depends on the [current locale][setlocale]. @@ -36168,22 +38820,22 @@ not UTF-8 and the conversion output contains a nul character, the error %G_CONVERT_ERROR_EMBEDDED_NUL is set and the function returns %NULL. - + The converted string, or %NULL on an error. - a UTF-8 encoded string. + a UTF-8 encoded string. - the length of the string, or -1 if the string is + the length of the string, or -1 if the string is nul-terminated. - location to store the number of bytes in + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -36194,36 +38846,36 @@ not UTF-8 and the conversion output contains a nul character, the error - the number of bytes stored in + the number of bytes stored in the output buffer (not including the terminating nul). - Converts an absolute filename to an escaped ASCII-encoded URI, with the path + Converts an absolute filename to an escaped ASCII-encoded URI, with the path component following Section 3.3. of RFC 2396. - a newly-allocated string holding the resulting + a newly-allocated string holding the resulting URI, or %NULL on an error. - an absolute filename specified in the GLib file + 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 - A UTF-8 encoded hostname, or %NULL for none. + A UTF-8 encoded hostname, or %NULL for none. - Converts a string which is in the encoding used by GLib for + Converts a string which is in the encoding used by GLib for filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8 for filenames; on other platforms, this function indirectly depends on the [current locale][setlocale]. @@ -36237,23 +38889,23 @@ function returns %NULL. Use g_convert() to produce output that may contain embedded nul characters. - The converted string, or %NULL on an error. + The converted string, or %NULL on an error. - a string in the encoding for filenames + a string in the encoding for filenames - the length of the string, or -1 if the string is + the length of the string, 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) - location to store the number of bytes in the + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -36264,14 +38916,14 @@ may contain embedded nul characters. - the number of bytes stored in the output + the number of bytes stored in the output buffer (not including the terminating nul). - Locates the first executable named @program in the user's path, in the + Locates the first executable named @program in the user's path, in the same way that execvp() would locate it. Returns an allocated string with the absolute path name, or %NULL if the program is not found in the path. If @program is already an absolute path, returns a copy of @@ -36288,21 +38940,21 @@ Windows 32-bit system directory, then in the Windows directory, and finally in the directories in the `PATH` environment variable. If the program is found, the return value contains the full name including the type suffix. - + - a newly-allocated string with the absolute path, + a newly-allocated string with the absolute path, or %NULL - a program name in the GLib file name encoding + a program name in the GLib file name encoding - Formats a size (for example the size of a file) into a human readable + Formats a size (for example the size of a file) into a human readable string. Sizes are rounded to the nearest size prefix (kB, MB, GB) and are displayed rounded to the nearest tenth. E.g. the file size 3292528 bytes will be converted into the string "3.2 MB". The returned string @@ -36317,19 +38969,19 @@ See g_format_size_full() for more options about how the size might be formatted. - a newly-allocated formatted string containing a human readable + a newly-allocated formatted string containing a human readable file size - a size in bytes + a size in bytes - Formats a size (for example the size of a file) into a human + Formats a size (for example the size of a file) into a human readable string. Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed rounded to the nearest tenth. E.g. the file size 3292528 bytes will be converted into the @@ -36342,67 +38994,67 @@ This string should be freed with g_free() when not needed any longer. suffixes to denote IEC units. Use g_format_size() instead. - a newly-allocated formatted string containing a human + a newly-allocated formatted string containing a human readable file size - a size in bytes + a size in bytes - Formats a size. + Formats a size. This function is similar to g_format_size() but allows for flags that modify the output. See #GFormatSizeFlags. - a newly-allocated formatted string containing a human + a newly-allocated formatted string containing a human readable file size - a size in bytes + a size in bytes - #GFormatSizeFlags to modify the output + #GFormatSizeFlags to modify the output - An implementation of the standard fprintf() function which supports + An implementation of the standard fprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the stream to write to. + the stream to write to. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. - Frees the memory pointed to by @mem. + Frees the memory pointed to by @mem. If @mem is %NULL it simply returns, so there is no need to check @mem against %NULL before calling this function. @@ -36412,13 +39064,13 @@ against %NULL before calling this function. - the memory to free + the memory to free - Gets a human-readable name for the application, as set by + Gets a human-readable name for the application, as set by g_set_application_name(). This name should be localized if possible, and is intended for display to the user. Contrast with g_get_prgname(), which gets a non-localized name. If @@ -36427,12 +39079,12 @@ g_get_prgname() (which may be %NULL if g_set_prgname() has also not been called). - human-readable application name. may return %NULL + human-readable application name. may return %NULL - Obtains the character set for the [current locale][setlocale]; you + Obtains the character set for the [current locale][setlocale]; you might use this character set as an argument to g_convert(), to convert from the current locale's encoding to some other encoding. (Frequently g_locale_to_utf8() and g_locale_from_utf8() are nice shortcuts, though.) @@ -36454,28 +39106,59 @@ The string returned in @charset is not allocated, and should not be freed. - %TRUE if the returned charset is UTF-8 + %TRUE if the returned charset is UTF-8 - return location for character set + return location for character set name, or %NULL. - Gets the character set for the current locale. + Gets the character set for the current locale. - a newly allocated string containing the name + a newly allocated string containing the name of the character set. This string must be freed with g_free(). + + Obtains the character set used by the console attached to the process, +which is suitable for printing output to the terminal. + +Usually this matches the result returned by g_get_charset(), but in +environments where the locale's character set does not match the encoding +of the console this function tries to guess a more suitable value instead. + +On Windows the character set returned by this function is the +output code page used by the console associated with the calling process. +If the codepage can't be determined (for example because there is no +console attached) UTF-8 is assumed. + +The return value is %TRUE if the locale's encoding is UTF-8, in that +case you can perhaps avoid calling g_convert(). + +The string returned in @charset is not allocated, and should not be +freed. + + + %TRUE if the returned charset is UTF-8 + + + + + return location for character set + name, or %NULL. + + + + - Gets the current directory. + Gets the current directory. The returned string should be freed when no longer needed. The encoding of the returned string is system defined. @@ -36485,29 +39168,31 @@ Since GLib 2.40, this function will return the value of the "PWD" environment variable if it is set and it happens to be the same as the current directory. This can make a difference in the case that the current directory is the target of a symbolic link. - + - the current directory + the current directory - - Equivalent to the UNIX gettimeofday() function, but portable. + + Equivalent to the UNIX gettimeofday() function, but portable. You may find g_get_real_time() to be more convenient. - + #GTimeVal is not year-2038-safe. Use g_get_real_time() + instead. + - #GTimeVal structure in which to store current time. + #GTimeVal structure in which to store current time. - Gets the list of environment variables for the current process. + Gets the list of environment variables for the current process. The list is %NULL terminated and each item in the list is of the form 'NAME=VALUE'. @@ -36519,7 +39204,7 @@ The return value is freshly allocated and it should be freed with g_strfreev() when it is no longer needed. - + the list of environment variables @@ -36527,7 +39212,7 @@ g_strfreev() when it is no longer needed. - Determines the preferred character sets used for filenames. + Determines the preferred character sets used for filenames. The first character set from the @charsets is the filename encoding, the subsequent character sets are used when trying to generate a displayable representation of a filename, see g_filename_display_name(). @@ -36553,12 +39238,12 @@ Note that on Unix, regardless of the locale character set or on a system might be in any random encoding or just gibberish. - %TRUE if the filename encoding is UTF-8. + %TRUE if the filename encoding is UTF-8. - + return location for the %NULL-terminated list of encoding names @@ -36567,7 +39252,7 @@ on a system might be in any random encoding or just gibberish. - Gets the current user's home directory. + Gets the current user's home directory. As with most UNIX tools, this function will return the value of the `HOME` environment variable if it is set to an existing absolute path @@ -36589,12 +39274,12 @@ should either directly check the `HOME` environment variable yourself or unset it before calling any functions in GLib. - the current user's home directory + the current user's home directory - Return a name for the machine. + Return a name for the machine. The returned name is not necessarily a fully-qualified domain name, or even present in DNS or some other name service at all. It need @@ -36610,12 +39295,12 @@ returned. The encoding of the returned string is UTF-8. - the host name of the machine. + the host name of the machine. - Computes a list of applicable locale names, which can be used to + Computes a list of applicable locale names, which can be used to e.g. construct locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable and always contains the default locale "C". @@ -36626,9 +39311,9 @@ For example, if LANGUAGE=de:en_US, then the returned list is This function consults the environment variables `LANGUAGE`, `LC_ALL`, `LC_MESSAGES` and `LANG` to find the list of locales specified by the user. - + - a %NULL-terminated array of strings owned by GLib + a %NULL-terminated array of strings owned by GLib that must not be modified or freed. @@ -36636,7 +39321,7 @@ user. - Computes a list of applicable locale names with a locale category name, + Computes a list of applicable locale names with a locale category name, which can be used to construct the fallback locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable and always contains the default locale "C". @@ -36646,9 +39331,9 @@ This function consults the environment variables `LANGUAGE`, `LC_ALL`, user. g_get_language_names() returns g_get_language_names_with_category("LC_MESSAGES"). - + - a %NULL-terminated array of strings owned by + a %NULL-terminated array of strings owned by the thread g_get_language_names_with_category was called from. It must not be modified or freed. It must be copied if planned to be used in another thread. @@ -36657,13 +39342,13 @@ g_get_language_names() returns g_get_language_names_with_category("LC_MESSAGES") - a locale category name + a locale category name - Returns a list of derived variants of @locale, which can be used to + Returns a list of derived variants of @locale, which can be used to e.g. construct locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable. This function handles territory, charset and extra locale modifiers. @@ -36673,9 +39358,9 @@ is "fr_BE", "fr". If you need the list of variants for the current locale, use g_get_language_names(). - + - a newly + a newly allocated array of newly allocated strings with the locale variants. Free with g_strfreev(). @@ -36684,13 +39369,13 @@ use g_get_language_names(). - a locale identifier + a locale identifier - Queries the system monotonic time. + Queries the system monotonic time. The monotonic clock will always increase and doesn't suffer discontinuities when the user (or NTP) changes the system time. It @@ -36700,25 +39385,25 @@ suspended. We try to use the clock that corresponds as closely as possible to the passage of time as measured by system calls such as poll() but it may not always be possible to do this. - + - the monotonic time, in microseconds + the monotonic time, in microseconds - Determine the approximate number of threads that the system will + Determine the approximate number of threads that the system will schedule simultaneously for this process. This is intended to be used as a parameter to g_thread_pool_new() for CPU bound tasks and similar cases. - Number of schedulable threads, always greater than 0 + Number of schedulable threads, always greater than 0 - Gets the name of the program. This name should not be localized, + Gets the name of the program. This name should not be localized, in contrast to g_get_application_name(). If you are using #GApplication the program name is set in @@ -36727,26 +39412,27 @@ gdk_init(), which is called by gtk_init() and the #GtkApplication::startup handler. The program name is found by taking the last component of @argv[0]. - - the name of the program. The returned string belongs + + the name of the program, or %NULL if it has not been + set yet. The returned string belongs to GLib and must not be modified or freed. - Gets the real name of the user. This usually comes from the user's + Gets the real name of the user. This usually comes from the user's entry in the `passwd` file. The encoding of the returned string is system-defined. (On Windows, it is, however, always UTF-8.) If the real user name cannot be determined, the string "Unknown" is returned. - the user's real name. + the user's real name. - Queries the system wall-clock time. + Queries the system wall-clock time. This call is functionally equivalent to g_get_current_time() except that the return value is often more convenient than dealing with a @@ -36755,14 +39441,14 @@ that the return value is often more convenient than dealing with a You should only use this call if you are actually interested in the real wall-clock time. g_get_monotonic_time() is probably more useful for measuring intervals. - + - the number of microseconds since January 1, 1970 UTC. + the number of microseconds since January 1, 1970 UTC. - Returns an ordered list of base directories in which to access + Returns an ordered list of base directories in which to access system-wide configuration information. On UNIX platforms this is determined using the mechanisms described @@ -36781,7 +39467,7 @@ CSIDL_COMMON_APPDATA folder. This information will not roam and is available to anyone using the computer. - + a %NULL-terminated array of strings owned by GLib that must not be modified or freed. @@ -36790,7 +39476,7 @@ to anyone using the computer. - Returns an ordered list of base directories in which to access + Returns an ordered list of base directories in which to access system-wide application data. On UNIX platforms this is determined using the mechanisms described @@ -36823,7 +39509,7 @@ Note that on Windows the returned list can vary depending on where this function is called. - + a %NULL-terminated array of strings owned by GLib that must not be modified or freed. @@ -36832,7 +39518,7 @@ this function is called. - Gets the directory to use for temporary files. + Gets the directory to use for temporary files. On UNIX, this is taken from the `TMPDIR` environment variable. If the variable is not set, `P_tmpdir` is @@ -36848,12 +39534,12 @@ it is always UTF-8. The return value is never %NULL or the empty string. - the directory to use for temporary files. + the directory to use for temporary files. - Returns a base directory in which to store non-essential, cached + Returns a base directory in which to store non-essential, cached data specific to particular user. On UNIX platforms this is determined using the mechanisms described @@ -36868,13 +39554,13 @@ repository for temporary Internet files is used instead. A typical path is See the [documentation for `CSIDL_INTERNET_CACHE`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_internet_cache). - a string owned by GLib that must not be modified + a string owned by GLib that must not be modified or freed. - Returns a base directory in which to store user-specific application + Returns a base directory in which to store user-specific application configuration information such as user preferences and settings. On UNIX platforms this is determined using the mechanisms described @@ -36890,13 +39576,13 @@ Note that in this case on Windows it will be the same as what g_get_user_data_dir() returns. - a string owned by GLib that must not be modified + a string owned by GLib that must not be modified or freed. - Returns a base directory in which to access application data such + Returns a base directory in which to access application data such as icons that is customized for a particular user. On UNIX platforms this is determined using the mechanisms described @@ -36912,24 +39598,24 @@ Note that in this case on Windows it will be the same as what g_get_user_config_dir() returns. - a string owned by GLib that must not be modified + a string owned by GLib that must not be modified or freed. - Gets the user name of the current user. The encoding of the returned + Gets the user name of the current user. The encoding of the returned string is system-defined. On UNIX, it might be the preferred file name encoding, or something else, and there is no guarantee that it is even consistent on a machine. On Windows, it is always UTF-8. - the user name of the current user. + the user name of the current user. - Returns a directory that is unique to the current user on the local + Returns a directory that is unique to the current user on the local system. This is determined using the mechanisms described @@ -36941,13 +39627,13 @@ In the case that this variable is not set, we return the value of g_get_user_cache_dir(), after verifying that it exists. - a string owned by GLib that must not be + a string owned by GLib that must not be modified or freed. - Returns the full path of a special directory using its logical id. + Returns the full path of a special directory using its logical id. On UNIX this is done using the XDG special user directories. For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP @@ -36959,20 +39645,20 @@ of the special directory without requiring the session to restart; GLib will not reflect any change once the special directories are loaded. - the path to the specified special directory, or + 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. - the logical id of special directory + the logical id of special directory - Returns the value of an environment variable. + Returns the value of an environment variable. On UNIX, the name and value are byte strings which might or might not be in some consistent character set and encoding. On Windows, they are @@ -36981,7 +39667,7 @@ On Windows, in case the environment variable's value contains references to other environment variables, they are expanded. - the value of the environment variable, or %NULL if + the value of the environment variable, or %NULL if the environment variable is not found. The returned string may be overwritten by the next call to g_getenv(), g_setenv() or g_unsetenv(). @@ -36989,13 +39675,13 @@ references to other environment variables, they are expanded. - the environment variable to get + the environment variable to get - This is a convenience function for using a #GHashTable as a set. It + This is a convenience function for using a #GHashTable as a set. It is equivalent to calling g_hash_table_replace() with @key as both the key and the value. @@ -37008,46 +39694,46 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - a key to insert + a key to insert - Checks if @key is in @hash_table. + Checks if @key is in @hash_table. - %TRUE if @key is in @hash_table, %FALSE otherwise. + %TRUE if @key is in @hash_table, %FALSE otherwise. - a #GHashTable + a #GHashTable - a key to check + a key to check - Destroys all keys and values in the #GHashTable and decrements its + Destroys all keys and values in the #GHashTable and decrements its reference count by 1. If keys and/or values are dynamically allocated, you should either free them first or create the #GHashTable with destroy notifiers using g_hash_table_new_full(). In the latter case the destroy @@ -37059,7 +39745,7 @@ destruction phase. - a #GHashTable + a #GHashTable @@ -37067,8 +39753,18 @@ destruction phase. + + This function is deprecated and will be removed in the next major +release of GLib. It does nothing. + + + + a #GHashTable + + + - Inserts a new key and value into a #GHashTable. + Inserts a new key and value into a #GHashTable. If the key already exists in the #GHashTable its current value is replaced with the new value. If you supplied a @@ -37082,53 +39778,53 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - a key to insert + a key to insert - the value to associate with the key + the value to associate with the key - Looks up a key in a #GHashTable. Note that this function cannot + Looks up a key in a #GHashTable. Note that this function cannot distinguish between a key that is not present and one which is present and has the value %NULL. If you need this distinction, use g_hash_table_lookup_extended(). - the associated value, or %NULL if the key is not found + the associated value, or %NULL if the key is not found - a #GHashTable + a #GHashTable - the key to look up + the key to look up - Looks up a key in the #GHashTable, returning the original key and the + Looks up a key in the #GHashTable, returning the original key and the associated value and a #gboolean which is %TRUE if the key was found. This is useful if you need to free the memory allocated for the original key, for example before calling g_hash_table_remove(). @@ -37138,34 +39834,34 @@ whether the %NULL key exists, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - the key to look up + the key to look up - return location for the original key + return location for the original key - return location for the value associated + return location for the value associated with the key - Removes a key and its associated value from a #GHashTable. + Removes a key and its associated value from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise @@ -37173,25 +39869,25 @@ you have to make sure that any dynamically allocated values are freed yourself. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - the key to remove + the key to remove - Removes all keys and their associated values from a #GHashTable. + Removes all keys and their associated values from a #GHashTable. If the #GHashTable was created using g_hash_table_new_full(), the keys and values are freed using the supplied destroy functions, @@ -37203,7 +39899,7 @@ values are freed yourself. - a #GHashTable + a #GHashTable @@ -37212,7 +39908,7 @@ values are freed yourself. - Inserts a new key and value into a #GHashTable similar to + Inserts a new key and value into a #GHashTable similar to g_hash_table_insert(). The difference is that if the key already exists in the #GHashTable, it gets replaced by the new key. If you supplied a @value_destroy_func when creating @@ -37225,37 +39921,37 @@ indicate whether the newly added value was already in the hash table or not. - %TRUE if the key did not exist yet + %TRUE if the key did not exist yet - a #GHashTable + a #GHashTable - a key to insert + a key to insert - the value to associate with the key + the value to associate with the key - Returns the number of elements contained in the #GHashTable. + Returns the number of elements contained in the #GHashTable. - the number of key/value pairs in the #GHashTable. + the number of key/value pairs in the #GHashTable. - a #GHashTable + a #GHashTable @@ -37264,29 +39960,29 @@ or not. - Removes a key and its associated value from a #GHashTable without + Removes a key and its associated value from a #GHashTable without calling the key and value destroy functions. - %TRUE if the key was found and removed from the #GHashTable + %TRUE if the key was found and removed from the #GHashTable - a #GHashTable + a #GHashTable - the key to remove + the key to remove - Removes all keys and their associated values from a #GHashTable + Removes all keys and their associated values from a #GHashTable without calling the key and value destroy functions. @@ -37294,7 +39990,7 @@ without calling the key and value destroy functions. - a #GHashTable + a #GHashTable @@ -37303,7 +39999,7 @@ without calling the key and value destroy functions. - Looks up a key in the #GHashTable, stealing the original key and the + Looks up a key in the #GHashTable, stealing the original key and the associated value and returning %TRUE if the key was found. If the key was not found, %FALSE is returned. @@ -37315,35 +40011,45 @@ You can pass %NULL for @lookup_key, provided the hash and equal functions of @hash_table are %NULL-safe. - %TRUE if the key was found in the #GHashTable + %TRUE if the key was found in the #GHashTable - a #GHashTable + a #GHashTable - the key to look up + the key to look up - return location for the + return location for the original key - return location + return location for the value associated with the key + + This function is deprecated and will be removed in the next major +release of GLib. It does nothing. + + + + a #GHashTable + + + - Atomically decrements the reference count of @hash_table by one. + Atomically decrements the reference count of @hash_table by one. If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread. @@ -37353,7 +40059,7 @@ This function is MT-safe and may be called from any thread. - a valid #GHashTable + a valid #GHashTable @@ -37361,26 +40067,38 @@ This function is MT-safe and may be called from any thread. + + Appends a #GHook onto the end of a #GHookList. + + + + a #GHookList + + + the #GHook to add to the end of @hook_list + + + - Destroys a #GHook, given its ID. + Destroys a #GHook, given its ID. - %TRUE if the #GHook was found in the #GHookList and destroyed + %TRUE if the #GHook was found in the #GHookList and destroyed - a #GHookList + a #GHookList - a hook ID + a hook ID - Removes one #GHook from a #GHookList, marking it + Removes one #GHook from a #GHookList, marking it inactive and calling g_hook_unref() on it. @@ -37388,17 +40106,17 @@ inactive and calling g_hook_unref() on it. - a #GHookList + a #GHookList - the #GHook to remove + the #GHook to remove - Calls the #GHookList @finalize_hook function if it exists, + Calls the #GHookList @finalize_hook function if it exists, and frees the memory allocated for the #GHook. @@ -37406,55 +40124,55 @@ and frees the memory allocated for the #GHook. - a #GHookList + a #GHookList - the #GHook to free + the #GHook to free - Inserts a #GHook into a #GHookList, before a given #GHook. + Inserts a #GHook into a #GHookList, before a given #GHook. - a #GHookList + a #GHookList - the #GHook to insert the new #GHook before + the #GHook to insert the new #GHook before - the #GHook to insert + the #GHook to insert - Prepends a #GHook on the start of a #GHookList. + Prepends a #GHook on the start of a #GHookList. - a #GHookList + a #GHookList - the #GHook to add to the start of @hook_list + the #GHook to add to the start of @hook_list - Decrements the reference count of a #GHook. + Decrements the reference count of a #GHook. If the reference count falls to 0, the #GHook is removed from the #GHookList and g_hook_free() is called to free it. @@ -37463,17 +40181,17 @@ from the #GHookList and g_hook_free() is called to free it. - a #GHookList + a #GHookList - the #GHook to unref + the #GHook to unref - Tests if @hostname contains segments with an ASCII-compatible + Tests if @hostname contains segments with an ASCII-compatible encoding of an Internationalized Domain Name. If this returns %TRUE, you should decode the hostname with g_hostname_to_unicode() before displaying it to the user. @@ -37483,34 +40201,34 @@ segments, and so it is possible for g_hostname_is_non_ascii() and g_hostname_is_ascii_encoded() to both return %TRUE for a name. - %TRUE if @hostname contains any ASCII-encoded + %TRUE if @hostname contains any ASCII-encoded segments. - a hostname + a hostname - Tests if @hostname is the string form of an IPv4 or IPv6 address. + Tests if @hostname is the string form of an IPv4 or IPv6 address. (Eg, "192.168.0.1".) - %TRUE if @hostname is an IP address + %TRUE if @hostname is an IP address - a hostname (or IP address in string form) + a hostname (or IP address in string form) - Tests if @hostname contains Unicode characters. If this returns + Tests if @hostname contains Unicode characters. If this returns %TRUE, you need to encode the hostname with g_hostname_to_ascii() before using it in non-IDN-aware contexts. @@ -37519,35 +40237,35 @@ segments, and so it is possible for g_hostname_is_non_ascii() and g_hostname_is_ascii_encoded() to both return %TRUE for a name. - %TRUE if @hostname contains any non-ASCII characters + %TRUE if @hostname contains any non-ASCII characters - a hostname + a hostname - Converts @hostname to its canonical ASCII form; an ASCII-only + Converts @hostname to its canonical ASCII form; an ASCII-only string containing no uppercase letters and not ending with a trailing dot. - an ASCII hostname, which must be freed, or %NULL if + an ASCII hostname, which must be freed, or %NULL if @hostname is in some way invalid. - a valid UTF-8 or ASCII hostname + a valid UTF-8 or ASCII hostname - Converts @hostname to its canonical presentation form; a UTF-8 + Converts @hostname to its canonical presentation form; a UTF-8 string in Unicode normalization form C, containing no uppercase letters, no forbidden characters, and no ASCII-encoded segments, and not ending with a trailing dot. @@ -37556,19 +40274,37 @@ Of course if @hostname is not an internationalized hostname, then the canonical presentation form will be entirely ASCII. - a UTF-8 hostname, which must be freed, or %NULL if + a UTF-8 hostname, which must be freed, or %NULL if @hostname is in some way invalid. - a valid UTF-8 or ASCII hostname + a valid UTF-8 or ASCII hostname + + Converts a 32-bit integer value from host to network byte order. + + + + a 32-bit integer value in host byte order + + + + + Converts a 16-bit integer value from host to network byte order. + + + + a 16-bit integer value in host byte order + + + - Same as the standard UNIX routine iconv(), but + Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -37583,34 +40319,34 @@ used), or it may return -1 and set an error such as %EILSEQ, in such a situation. - count of non-reversible conversions, or -1 on error + count of non-reversible conversions, or -1 on error - conversion descriptor from g_iconv_open() + conversion descriptor from g_iconv_open() - bytes to convert + bytes to convert - inout parameter, bytes remaining to convert in @inbuf + inout parameter, bytes remaining to convert in @inbuf - converted output bytes + converted output bytes - inout parameter, bytes available to fill in @outbuf + inout parameter, bytes available to fill in @outbuf - Same as the standard UNIX routine iconv_open(), but + Same as the standard UNIX routine iconv_open(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. @@ -37618,23 +40354,23 @@ GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers. - a "conversion descriptor", or (GIConv)-1 if + a "conversion descriptor", or (GIConv)-1 if opening the converter failed. - destination codeset + destination codeset - source codeset + source codeset - Adds a function to be called whenever there are no higher priority + Adds a function to be called whenever there are no higher priority events pending to the default main loop. The function is given the default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function returns %FALSE it is automatically removed from the list of event @@ -37648,24 +40384,24 @@ and attaches it to the global #GMainContext using g_source_attach(), so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - function to call + function to call - data to pass to @function. + data to pass to @function. - Adds a function to be called whenever there are no higher priority + Adds a function to be called whenever there are no higher priority events pending. If the function returns %FALSE it is automatically removed from the list of event sources and will not be called again. @@ -37677,101 +40413,101 @@ and attaches it to the global #GMainContext using g_source_attach(), so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context. - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the idle source. Typically this will be in the + the priority of the idle source. Typically this will be in the range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE. - function to call + function to call - data to pass to @function + data to pass to @function - function to call when the idle is removed, or %NULL + function to call when the idle is removed, or %NULL - Removes the idle function with the given data. - + Removes the idle function with the given data. + - %TRUE if an idle source was found and removed. + %TRUE if an idle source was found and removed. - the data for the idle source's callback. + the data for the idle source's callback. - Creates a new idle source. + Creates a new idle source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be executed. Note that the default priority for idle sources is %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which have a default priority of %G_PRIORITY_DEFAULT. - + - the newly-created idle source + the newly-created idle source - Compares the two #gint64 values being pointed to and returns + Compares the two #gint64 values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to 64-bit integers as keys in a #GHashTable. - + - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #gint64 key + a pointer to a #gint64 key - a pointer to a #gint64 key to compare with @v1 + a pointer to a #gint64 key to compare with @v1 - Converts a pointer to a #gint64 to a hash value. + Converts a pointer to a #gint64 to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to 64-bit integer values as keys in a #GHashTable. - + - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #gint64 key + a pointer to a #gint64 key - Compares the two #gint values being pointed to and returns + Compares the two #gint values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to integers as keys in a @@ -37780,104 +40516,112 @@ parameter, when using non-%NULL pointers to integers as keys in a Note that this function acts on pointers to #gint, not on #gint directly: if your hash table's keys are of the form `GINT_TO_POINTER (n)`, use g_direct_equal() instead. - + - %TRUE if the two keys match. + %TRUE if the two keys match. - a pointer to a #gint key + a pointer to a #gint key - a pointer to a #gint key to compare with @v1 + a pointer to a #gint key to compare with @v1 - Converts a pointer to a #gint to a hash value. + Converts a pointer to a #gint to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to integer values as keys in a #GHashTable. Note that this function acts on pointers to #gint, not on #gint directly: if your hash table's keys are of the form `GINT_TO_POINTER (n)`, use g_direct_hash() instead. - + - a hash value corresponding to the key. + a hash value corresponding to the key. - a pointer to a #gint key + a pointer to a #gint key - Returns a canonical representation for @string. Interned strings + Returns a canonical representation for @string. Interned strings can be compared for equality by comparing the pointers, instead of using strcmp(). g_intern_static_string() does not copy the string, -therefore @string must not be freed or modified. +therefore @string must not be freed or modified. + +This function must not be used before library constructors have finished +running. In particular, this means it cannot be used to initialize global +variables in C++. - a canonical representation for the string + a canonical representation for the string - a static string + a static string - Returns a canonical representation for @string. Interned strings + Returns a canonical representation for @string. Interned strings can be compared for equality by comparing the pointers, instead of -using strcmp(). +using strcmp(). + +This function must not be used before library constructors have finished +running. In particular, this means it cannot be used to initialize global +variables in C++. - a canonical representation for the string + a canonical representation for the string - a string + a string - Adds the #GIOChannel into the default main loop context + Adds the #GIOChannel into the default main loop context with the default priority. - the event source id + the event source id - a #GIOChannel + a #GIOChannel - the condition to watch for + the condition to watch for - the function to call when the condition is satisfied + the function to call when the condition is satisfied - user data to pass to @func + user data to pass to @func - Adds the #GIOChannel into the default main loop context + Adds the #GIOChannel into the default main loop context with the given priority. This internally creates a main loop source using g_io_create_watch() @@ -37885,47 +40629,47 @@ and attaches it to the main loop context with g_source_attach(). You can do these steps manually if you need greater control. - the event source id + the event source id - a #GIOChannel + a #GIOChannel - the priority of the #GIOChannel source + the priority of the #GIOChannel source - the condition to watch for + the condition to watch for - the function to call when the condition is satisfied + the function to call when the condition is satisfied - user data to pass to @func + user data to pass to @func - the function to call when the source is removed + the function to call when the source is removed - Converts an `errno` error number to a #GIOChannelError. + Converts an `errno` error number to a #GIOChannelError. - a #GIOChannelError error number, e.g. + a #GIOChannelError error number, e.g. %G_IO_CHANNEL_ERROR_INVAL. - an `errno` error number, e.g. `EINVAL` + an `errno` error number, e.g. `EINVAL` @@ -37936,7 +40680,7 @@ You can do these steps manually if you need greater control. - Creates a #GSource that's dispatched when @condition is met for the + Creates a #GSource that's dispatched when @condition is met for the given @channel. For example, if condition is #G_IO_IN, the source will be dispatched when there's data available for reading. @@ -37949,16 +40693,16 @@ puts the socket in non-blocking mode. This is a side-effect of the implementation and unavoidable. - a new #GSource + a new #GSource - a #GIOChannel to watch + a #GIOChannel to watch - conditions to watch for + conditions to watch for @@ -37968,8 +40712,30 @@ implementation and unavoidable. + + A convenience macro to get the next element in a #GList. +Note that it is considered perfectly acceptable to access +@list->next directly. + + + + an element in a #GList + + + + + A convenience macro to get the previous element in a #GList. +Note that it is considered perfectly acceptable to access +@list->prev directly. + + + + an element in a #GList + + + - Gets the names of all variables set in the environment. + Gets the names of all variables set in the environment. Programs that want to be portable to Windows should typically use this function and g_getenv() instead of using the environ array @@ -37979,7 +40745,7 @@ use cases for environment variables in GLib-using programs you want the UTF-8 encoding that this function and g_getenv() provide. - + a %NULL-terminated list of strings which must be freed with g_strfreev(). @@ -37988,7 +40754,7 @@ the UTF-8 encoding that this function and g_getenv() provide. - Converts a string from UTF-8 to the encoding used for strings by + Converts a string from UTF-8 to the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the [current locale][setlocale]. On Windows this means the system codepage. @@ -37999,7 +40765,7 @@ in error %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. Use g_convert() to convert input that may contain embedded nul characters. - + A newly-allocated buffer containing the converted string, or %NULL on an error, and error will be set. @@ -38008,16 +40774,16 @@ input that may contain embedded nul characters. - a UTF-8 encoded string + a UTF-8 encoded string - the length of the string, or -1 if the string is + the length of the string, or -1 if the string is nul-terminated. - location to store the number of bytes in the + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -38028,14 +40794,14 @@ input that may contain embedded nul characters. - the number of bytes stored in the output + the number of bytes stored in the output buffer (not including the terminating nul). - Converts a string which is in the encoding used for strings by + Converts a string which is in the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the [current locale][setlocale] into a UTF-8 string. @@ -38048,12 +40814,12 @@ earlier versions of this library. Use g_convert() to produce output that may contain embedded nul characters. - The converted string, or %NULL on an error. + The converted string, or %NULL on an error. - a string in the + a string in the encoding of the current locale. On Windows this means the system codepage. @@ -38061,14 +40827,14 @@ may contain embedded nul characters. - the length of the string, or -1 if the string is + the length of the string, 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) - location to store the number of bytes in the + location to store the number of bytes in the input string that were successfully converted, or %NULL. Even if the conversion was successful, this may be less than @len if there were partial characters @@ -38079,14 +40845,14 @@ may contain embedded nul characters. - the number of bytes stored in the output + the number of bytes stored in the output buffer (not including the terminating nul). - Logs an error or debugging message. + Logs an error or debugging message. If the log level has been set as fatal, G_BREAKPOINT() is called to terminate the program. See the documentation for G_BREAKPOINT() for @@ -38104,27 +40870,27 @@ output via the structured log writer function (see g_log_set_writer_func()). - the log domain, usually #G_LOG_DOMAIN, or %NULL + the log domain, usually #G_LOG_DOMAIN, or %NULL for the default - the log level, either from #GLogLevelFlags + the log level, either from #GLogLevelFlags or a user-defined level - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - The default log handler set up by GLib; g_log_set_default_handler() + The default log handler set up by GLib; g_log_set_default_handler() allows to install an alternate default log handler. This is used if no log handler has been set for the particular log domain and log level combination. It outputs the message to stderr @@ -38155,26 +40921,26 @@ This has no effect if structured logging is enabled; see - the log domain of the message, or %NULL for the + the log domain of the message, or %NULL for the default "" application domain - the level of the message + the level of the message - the message + the message - data passed from g_log() which is unused + data passed from g_log() which is unused - Removes the log handler. + Removes the log handler. This has no effect if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. @@ -38184,18 +40950,18 @@ This has no effect if structured logging is enabled; see - the log domain + the log domain - the id of the handler, which was returned + the id of the handler, which was returned in g_log_set_handler() - Sets the message levels which are always fatal, in any log domain. + Sets the message levels which are always fatal, in any log domain. When a message with any of these levels is logged the program terminates. You can only set the levels defined by GLib to be fatal. %G_LOG_LEVEL_ERROR is always fatal. @@ -38213,19 +40979,19 @@ otherwise it is up to the writer function to determine which log messages are fatal. See [Using Structured Logging][using-structured-logging]. - the old fatal mask + the old fatal mask - the mask containing bits set for each level + the mask containing bits set for each level of error which is to be fatal - Installs a default log handler which is used if no + Installs a default log handler which is used if no log handler has been set for the particular log domain and log level combination. By default, GLib uses g_log_default_handler() as default log handler. @@ -38234,22 +41000,22 @@ This has no effect if structured logging is enabled; see [Using Structured Logging][using-structured-logging]. - the previous default log handler + the previous default log handler - the log handler function + the log handler function - data passed to the log handler + data passed to the log handler - Sets the log levels which are fatal in the given domain. + 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 @@ -38264,22 +41030,22 @@ This function is mostly intended to be used with %G_LOG_LEVEL_DEBUG as fatal except inside of test programs. - the old fatal mask for the log domain + the old fatal mask for the log domain - the log domain + the log domain - the new fatal mask + the new fatal mask - Sets the log handler for a domain and a set of log levels. + Sets the log handler for a domain and a set of log levels. To handle fatal and recursive messages the @log_levels parameter must be combined with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION bit flags. @@ -38311,71 +41077,71 @@ g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL ]| - the id of the new handler + the id of the new handler - the log domain, or %NULL for the default "" + the log domain, or %NULL for the default "" application domain - the log levels to apply the log handler for. + the log levels to apply the log handler for. To handle fatal and recursive messages as well, combine the log levels with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION bit flags. - the log handler function + the log handler function - data passed to the log handler + data passed to the log handler - Like g_log_set_handler(), but takes a destroy notify for the @user_data. + Like g_log_set_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]. - the id of the new handler + the id of the new handler - the log domain, or %NULL for the default "" + the log domain, or %NULL for the default "" application domain - the log levels to apply the log handler for. + the log levels to apply the log handler for. To handle fatal and recursive messages as well, combine the log levels with the #G_LOG_FLAG_FATAL and #G_LOG_FLAG_RECURSION bit flags. - the log handler function + the log handler function - data passed to the log handler + data passed to the log handler - destroy notify for @user_data, or %NULL + destroy notify for @user_data, or %NULL - Set a writer function which will be called to format and write out each log + 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. @@ -38390,22 +41156,22 @@ There can only be one writer function. It is an error to set more than one. - log writer function, which must not be %NULL + log writer function, which must not be %NULL - user data to pass to @func + user data to pass to @func - function to free @user_data once it’s + function to free @user_data once it’s finished with, if non-%NULL - Log a message with structured data. The message will be passed through to + 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 by calling G_BREAKPOINT() at the end of this function. If the log writer returns @@ -38489,16 +41255,16 @@ manually to the format string. - log domain, usually %G_LOG_DOMAIN + log domain, usually %G_LOG_DOMAIN - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key-value pairs of structured data to add to the log entry, followed + 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 @@ -38506,7 +41272,7 @@ manually to the format string. - Log a message with structured data. The message will be passed through to the + 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. @@ -38521,19 +41287,19 @@ This assumes that @log_level is already present in @fields (typically as the - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data to add + key–value pairs of structured data to add to the log message - number of elements in the @fields array + number of elements in the @fields array @@ -38568,7 +41334,7 @@ This assumes that @log_level is already present in @fields (typically as the - Log a message with structured data, accepting the data within a #GVariant. This + 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 @@ -38588,23 +41354,23 @@ For more details on its usage and about the parameters, see g_log_structured().< - log domain, usually %G_LOG_DOMAIN + log domain, usually %G_LOG_DOMAIN - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - a dictionary (#GVariant of the type %G_VARIANT_TYPE_VARDICT) + a dictionary (#GVariant of the type %G_VARIANT_TYPE_VARDICT) containing the key-value pairs of message data. - Format a structured log message and output it to the default log destination + 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. @@ -38621,34 +41387,34 @@ messages unless their log domain (or `all`) is listed in the space-separated `G_MESSAGES_DEBUG` environment variable. - %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise + %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - user data passed to g_log_set_writer_func() + user data passed to g_log_set_writer_func() - Format a structured log message as a string suitable for outputting to the + 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 @@ -38659,36 +41425,36 @@ encoded in the character set of the current locale, which is not necessarily UTF-8. - string containing the formatted log message, in + string containing the formatted log message, in the character set of the current locale - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - %TRUE to use ANSI color escape sequences when formatting the + %TRUE to use ANSI color escape sequences when formatting the message, %FALSE to not - Check whether the given @output_fd file descriptor is a connection to the + 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`). @@ -38699,18 +41465,18 @@ the following construct without needing any additional error handling: ]| - %TRUE if @output_fd points to the journal, %FALSE otherwise + %TRUE if @output_fd points to the journal, %FALSE otherwise - output file descriptor to check + output file descriptor to check - Format a structured log message and send it to the systemd journal as a set + 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. @@ -38721,34 +41487,34 @@ If GLib has been compiled without systemd support, this function is still defined, but will always return %G_LOG_WRITER_UNHANDLED. - %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise + %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - user data passed to g_log_set_writer_func() + user data passed to g_log_set_writer_func() - Format a structured log message and print it to either `stdout` or `stderr`, + 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 @@ -38762,50 +41528,50 @@ A trailing new-line character is added to the log message when it is printed. This is suitable for use as a #GLogWriterFunc. - %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise + %G_LOG_WRITER_HANDLED on success, %G_LOG_WRITER_UNHANDLED otherwise - log level, either from #GLogLevelFlags, or a user-defined + log level, either from #GLogLevelFlags, or a user-defined level - key–value pairs of structured data forming + key–value pairs of structured data forming the log message - number of elements in the @fields array + number of elements in the @fields array - user data passed to g_log_set_writer_func() + user data passed to g_log_set_writer_func() - Check whether the given @output_fd file descriptor supports ANSI color + Check whether the given @output_fd file descriptor supports ANSI color escape sequences. If so, they can safely be used when formatting log messages. - %TRUE if ANSI color escapes are supported, %FALSE otherwise + %TRUE if ANSI color escapes are supported, %FALSE otherwise - output file descriptor to check + output file descriptor to check - Logs an error or debugging message. + Logs an error or debugging message. If the log level has been set as fatal, G_BREAKPOINT() is called to terminate the program. See the documentation for G_BREAKPOINT() for @@ -38823,37 +41589,58 @@ output via the structured log writer function (see g_log_set_writer_func()). - the log domain, or %NULL for the default "" + the log domain, or %NULL for the default "" application domain - the log level + the log level - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string + + + + + + + + + + + + + + + + + + + + + - Returns the global default main context. This is the main context + Returns the global default main context. This is the main context used for main loop functions when a main loop is not explicitly specified, and corresponds to the "main" main loop. See also g_main_context_get_thread_default(). - the global default main context. + the global default main context. - Gets the thread-default #GMainContext for this thread. Asynchronous + Gets the thread-default #GMainContext for this thread. Asynchronous operations that want to be able to be run in contexts other than the default one should call this method or g_main_context_ref_thread_default() to get a #GMainContext to add @@ -38866,13 +41653,13 @@ If you need to hold a reference on the context, use g_main_context_ref_thread_default() instead. - the thread-default #GMainContext, or + the thread-default #GMainContext, or %NULL if the thread-default context is the global default context. - Gets the thread-default #GMainContext for this thread, as with + Gets the thread-default #GMainContext for this thread, as with g_main_context_get_thread_default(), but also adds a reference to it with g_main_context_ref(). In addition, unlike g_main_context_get_thread_default(), if the thread-default context @@ -38880,21 +41667,21 @@ is the global default context, this will return that #GMainContext (with a ref added to it) rather than returning %NULL. - the thread-default #GMainContext. Unref + the thread-default #GMainContext. Unref with g_main_context_unref() when you are done with it. - Returns the currently firing source for this thread. + Returns the currently firing source for this thread. - The currently firing source or %NULL. + The currently firing source or %NULL. - Returns the depth of the stack of calls to + Returns the depth of the stack of calls to g_main_context_dispatch() on any #GMainContext in the current thread. That is, when called from the toplevel, it gives 0. When called from within a callback from g_main_context_iteration() @@ -38997,80 +41784,80 @@ following techniques: there is more work to do. - The main loop recursion level in the current thread + The main loop recursion level in the current thread - Allocates @n_bytes bytes of memory. + Allocates @n_bytes bytes of memory. If @n_bytes is 0 it returns %NULL. - a pointer to the allocated memory + a pointer to the allocated memory - the number of bytes to allocate + the number of bytes to allocate - Allocates @n_bytes bytes of memory, initialized to 0's. + Allocates @n_bytes bytes of memory, initialized to 0's. If @n_bytes is 0 it returns %NULL. - a pointer to the allocated memory + a pointer to the allocated memory - the number of bytes to allocate + the number of bytes to allocate - This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - a pointer to the allocated memory + a pointer to the allocated memory - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - a pointer to the allocated memory + a pointer to the allocated memory - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - Collects the attributes of the element from the data passed to the + Collects the attributes of the element from the data passed to the #GMarkupParser start_element function, dealing with common error conditions and supporting boolean values. @@ -39104,36 +41891,36 @@ as parse errors for boolean-valued attributes (again of type will be returned and @error will be set as appropriate. - %TRUE if successful + %TRUE if successful - the current tag name + the current tag name - the attribute names + the attribute names - the attribute values + the attribute values - a pointer to a #GError or %NULL + a pointer to a #GError or %NULL - the #GMarkupCollectType of the first attribute + the #GMarkupCollectType of the first attribute - the name of the first attribute + the name of the first attribute - a pointer to the storage location of the first attribute + a pointer to the storage location of the first attribute (or %NULL), followed by more types names and pointers, ending with %G_MARKUP_COLLECT_INVALID @@ -39146,7 +41933,7 @@ will be returned and @error will be set as appropriate. - Escapes text so that the markup parser will parse it verbatim. + Escapes text so that the markup parser will parse it verbatim. Less than, greater than, ampersand, etc. are replaced with the corresponding entities. This function would typically be used when writing out a file to be parsed with the markup parser. @@ -39162,22 +41949,22 @@ references in this range are not valid XML 1.0, but they are valid XML 1.1 and will be accepted by the GMarkup parser. - a newly allocated string with the escaped text + a newly allocated string with the escaped text - some valid UTF-8 text + some valid UTF-8 text - length of @text in bytes, or -1 if the text is nul-terminated + length of @text in bytes, or -1 if the text is nul-terminated - Formats arguments according to @format, escaping + Formats arguments according to @format, escaping all string and character arguments in the fashion of g_markup_escape_text(). This is useful when you want to insert literal strings into XML-style markup @@ -39197,126 +41984,143 @@ output = g_markup_printf_escaped ("<purchase>" ]| - newly allocated result from formatting + newly allocated result from formatting operation. Free with g_free(). - printf() style format string + printf() style format string - the arguments to insert in the format string + the arguments to insert in the format string - Formats the data in @args according to @format, escaping + Formats the data in @args according to @format, escaping all string and character arguments in the fashion of g_markup_escape_text(). See g_markup_printf_escaped(). - newly allocated result from formatting + newly allocated result from formatting operation. Free with g_free(). - printf() style format string + printf() style format string - variable argument list, similar to vprintf() + variable argument list, similar to vprintf() - Checks whether the allocator used by g_malloc() is the system's + Checks whether the allocator used by g_malloc() is the system's malloc implementation. If it returns %TRUE memory allocated with malloc() can be used interchangeable with memory allocated using g_malloc(). This function is useful for avoiding an extra copy of allocated memory returned by a non-GLib-based API. GLib always uses the system malloc, so this function always returns %TRUE. - + - if %TRUE, malloc() and g_malloc() can be mixed. + if %TRUE, malloc() and g_malloc() can be mixed. - GLib used to support some tools for memory profiling, but this + GLib used to support some tools for memory profiling, but this no longer works. There are many other useful tools for memory profiling these days which can be used instead. Use other memory profiling tools instead - + - This function used to let you override the memory allocation function. + This function used to let you override the memory allocation function. However, its use was incompatible with the use of global constructors in GLib and GIO, because those use the GLib allocators before main is reached. Therefore this function is now deprecated and is just a stub. This function now does nothing. Use other memory profiling tools instead - + - table of memory allocation routines. + table of memory allocation routines. - Allocates @byte_size bytes of memory, and copies @byte_size bytes into it + Allocates @byte_size bytes of memory, and copies @byte_size bytes into it from @mem. If @mem is %NULL it returns %NULL. - a pointer to the newly-allocated copy of the memory, or %NULL if @mem + a pointer to the newly-allocated copy of the memory, or %NULL if @mem is %NULL. - the memory to copy. + the memory to copy. - the number of bytes to copy. + the number of bytes to copy. + + Copies a block of memory @len bytes long, from @src to @dest. +The source and destination areas may overlap. + Just use memmove(). + + + + the destination address to copy the bytes to. + + + the source address to copy the bytes from. + + + the number of bytes to copy. + + + - Create a directory if it doesn't already exist. Create intermediate + Create a directory if it doesn't already exist. Create intermediate parent directories as needed, too. - 0 if the directory already exists, or was successfully + 0 if the directory already exists, or was successfully created. Returns -1 if an error occurred, with errno set. - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding - permissions to use for newly created directories + permissions to use for newly created directories - Creates a temporary directory. See the mkdtemp() documentation + Creates a temporary directory. See the mkdtemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -39333,20 +42137,20 @@ directory returned by g_get_tmp_dir(), you might want to use g_dir_make_tmp() instead. - A pointer to @tmpl, which has been + 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. - template directory name + template directory name - Creates a temporary directory. See the mkdtemp() documentation + Creates a temporary directory. See the mkdtemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -39363,24 +42167,24 @@ directory returned by g_get_tmp_dir(), you might want to use g_dir_make_tmp() instead. - A pointer to @tmpl, which has been + 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. - template directory name + template directory name - permissions to create the temporary directory with + permissions to create the temporary directory with - Opens a temporary file. See the mkstemp() documentation + Opens a temporary file. See the mkstemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -39392,7 +42196,7 @@ didn't exist. The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8. - A file handle (as from open()) to the file + A file handle (as from open()) to the file opened for reading and writing. The file is opened in binary mode on platforms where there is a difference. The file handle should be closed with close(). In case of errors, -1 is @@ -39401,13 +42205,13 @@ Most importantly, on Windows it should be in UTF-8. - template filename + template filename - Opens a temporary file. See the mkstemp() documentation + Opens a temporary file. See the mkstemp() documentation on most UNIX-like systems. The parameter is a string that should follow the rules for @@ -39420,7 +42224,7 @@ The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8. - A file handle (as from open()) to the file + A file handle (as from open()) to the file opened for reading and writing. The file handle should be closed with close(). In case of errors, -1 is returned and %errno will be set. @@ -39428,29 +42232,206 @@ on Windows it should be in UTF-8. - template filename + template filename - flags to pass to an open() call in addition to O_EXCL + flags to pass to an open() call in addition to O_EXCL and O_CREAT, which are passed automatically - permissions to create the temporary file with + permissions to create the temporary file with + + Allocates @n_structs elements of type @struct_type. +The returned pointer is cast to a pointer to the given type. +If @n_structs is 0 it returns %NULL. +Care is taken to avoid overflow when calculating the size of the allocated block. + +Since the returned pointer is already casted to the right type, +it is normally unnecessary to cast it explicitly, and doing +so might hide memory allocation errors. + + + + the type of the elements to allocate + + + the number of elements to allocate + + + + + Allocates @n_structs elements of type @struct_type, initialized to 0's. +The returned pointer is cast to a pointer to the given type. +If @n_structs is 0 it returns %NULL. +Care is taken to avoid overflow when calculating the size of the allocated block. + +Since the returned pointer is already casted to the right type, +it is normally unnecessary to cast it explicitly, and doing +so might hide memory allocation errors. + + + + the type of the elements to allocate. + + + the number of elements to allocate. + + + + + Wraps g_alloca() in a more typesafe manner. + + + + Type of memory chunks to be allocated + + + Number of chunks to be allocated + + + + + Inserts a #GNode as the last child of the given parent. + + + + the #GNode to place the new #GNode under + + + the #GNode to insert + + + + + Inserts a new #GNode as the last child of the given parent. + + + + the #GNode to place the new #GNode under + + + the data for the new #GNode + + + + + Gets the first child of a #GNode. + + + + a #GNode + + + + + Inserts a new #GNode at the given position. + + + + the #GNode to place the new #GNode under + + + the position to place the new #GNode at. If position is -1, + the new #GNode is inserted as the last child of @parent + + + the data for the new #GNode + + + + + Inserts a new #GNode after the given sibling. + + + + the #GNode to place the new #GNode under + + + the sibling #GNode to place the new #GNode after + + + the data for the new #GNode + + + + + Inserts a new #GNode before the given sibling. + + + + the #GNode to place the new #GNode under + + + the sibling #GNode to place the new #GNode before + + + the data for the new #GNode + + + + + Gets the next sibling of a #GNode. + + + + a #GNode + + + + + Inserts a new #GNode as the first child of the given parent. + + + + the #GNode to place the new #GNode under + + + the data for the new #GNode + + + + + Gets the previous sibling of a #GNode. + + + + a #GNode + + + + + Converts a 32-bit integer value from network to host byte order. + + + + a 32-bit integer value in network byte order + + + + + Converts a 16-bit integer value from network to host byte order. + + + + a 16-bit integer value in network byte order + + + - Set the pointer at the specified location to %NULL. + Set the pointer at the specified location to %NULL. - the memory address of the pointer. + the memory address of the pointer. @@ -39461,7 +42442,7 @@ on Windows it should be in UTF-8. - Prompts the user with + Prompts the user with `[E]xit, [H]alt, show [S]tack trace or [P]roceed`. This function is intended to be used for debugging use only. The following example shows how it can be used together with @@ -39502,14 +42483,18 @@ a stack trace. The prompt is then shown again. If "[P]roceed" is selected, the function returns. -This function may cause different actions on non-UNIX platforms. +This function may cause different actions on non-UNIX platforms. + +On Windows consider using the `G_DEBUGGER` environment +variable (see [Running GLib Applications](glib-running.html)) and +calling g_on_error_stack_trace() instead. - the program name, needed by gdb for the "[S]tack trace" + the program name, needed by gdb for the "[S]tack trace" option. If @prg_name is %NULL, g_get_prgname() is called to get the program name (which will work correctly if gdk_init() or gtk_init() has been called) @@ -39518,27 +42503,73 @@ This function may cause different actions on non-UNIX platforms. - Invokes gdb, which attaches to the current process and shows a + Invokes gdb, which attaches to the current process and shows a stack trace. Called by g_on_error_query() when the "[S]tack trace" option is selected. You can get the current process's program name with g_get_prgname(), assuming that you have called gtk_init() or gdk_init(). -This function may cause different actions on non-UNIX platforms. +This function may cause different actions on non-UNIX platforms. + +When running on Windows, this function is *not* called by +g_on_error_query(). If called directly, it will raise an +exception, which will crash the program. If the `G_DEBUGGER` environment +variable is set, a debugger will be invoked to attach and +handle that exception (see [Running GLib Applications](glib-running.html)). - the program name, needed by gdb for the "[S]tack trace" + the program name, needed by gdb for the "[S]tack trace" option + + The first call to this routine by a process with a given #GOnce +struct calls @func with the given argument. Thereafter, subsequent +calls to g_once() with the same #GOnce struct do not call @func +again, but return the stored result of the first call. On return +from g_once(), the status of @once will be %G_ONCE_STATUS_READY. + +For example, a mutex or a thread-specific data key must be created +exactly once. In a threaded environment, calling g_once() ensures +that the initialization is serialized across multiple threads. + +Calling g_once() recursively on the same #GOnce struct in +@func will lead to a deadlock. + +|[<!-- language="C" --> + gpointer + get_debug_flags (void) + { + static GOnce my_once = G_ONCE_INIT; + + g_once (&my_once, parse_debug_flags, NULL); + + return my_once.retval; + } +]| + + + + a #GOnce structure + + + the #GThreadFunc function associated to @once. This function + is called only once, regardless of the number of times it and + its associated #GOnce struct are passed to g_once(). + + + data to be passed to @func + + + - Function to be called when starting a critical initialization + Function to be called when starting a critical initialization section. The argument @location must point to a static 0-initialized variable that will be set to a value other than 0 at the end of the initialization section. In combination with @@ -39562,20 +42593,20 @@ like this: ]| - %TRUE if the initialization section should be entered, + %TRUE if the initialization section should be entered, %FALSE and blocks otherwise - location of a static initializable variable + location of a static initializable variable containing 0 - Counterpart to g_once_init_enter(). Expects a location of a static + Counterpart to g_once_init_enter(). Expects a location of a static 0-initialized initialization variable, and an initialization value other than 0. Sets the variable to the initialization value, and releases concurrent threads blocking in g_once_init_enter() on this @@ -39586,12 +42617,12 @@ initialization variable. - location of a static initializable variable + location of a static initializable variable containing 0 - new non-0 value for *@value_location + new non-0 value for *@value_location @@ -39602,7 +42633,7 @@ initialization variable. - Parses a string containing debugging options + Parses a string containing debugging options into a %guint containing bit flags. This is used within GDK and GTK+ to parse the debug options passed on the command line or through environment variables. @@ -39616,69 +42647,69 @@ If @string is equal to "help", all the available keys in @keys are printed out to standard error. - the combined set of bit flags. + the combined set of bit flags. - a list of debug options separated by colons, spaces, or + a list of debug options separated by colons, spaces, or commas, or %NULL. - pointer to an array of #GDebugKey which associate + pointer to an array of #GDebugKey which associate strings with bit flags. - the number of #GDebugKeys in the array. + the number of #GDebugKeys in the array. - Gets the last component of the filename. + Gets the last component of the filename. If @file_name ends with a directory separator it gets the component before the last slash. If @file_name consists only of directory separators (and on Windows, possibly a drive letter), a single separator is returned. If @file_name is empty, it gets ".". - + - a newly allocated string containing the last + a newly allocated string containing the last component of the filename - the name of the file + the name of the file - Gets the directory components of a file name. For example, the directory + Gets the directory components of a file name. For example, the directory component of `/usr/bin/test` is `/usr/bin`. The directory component of `/` is `/`. If the file name has no directory components "." is returned. The returned string should be freed when no longer needed. - + - the directory components of the file + the directory components of the file - the name of the file + the name of the file - Returns %TRUE if the given @file_name is an absolute file name. + Returns %TRUE if the given @file_name is an absolute file name. Note that this is a somewhat vague concept on Windows. On POSIX systems, an absolute file name is well-defined. It always @@ -39704,35 +42735,35 @@ either. Such paths should be avoided, or need to be handled using Windows-specific code. - %TRUE if @file_name is absolute + %TRUE if @file_name is absolute - a file name + a file name - Returns a pointer into @file_name after the root component, + Returns a pointer into @file_name after the root component, i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute path it returns %NULL. - a pointer into @file_name after the + a pointer into @file_name after the root component - a file name + a file name - Matches a string against a compiled pattern. Passing the correct + Matches a string against a compiled pattern. Passing the correct length of the string given is mandatory. The reversed string can be omitted by passing %NULL, this is more efficient if the reversed version of the string to be matched is not at hand, as @@ -39751,72 +42782,72 @@ does not contain any multibyte characters. GLib offers the g_utf8_strreverse() function to reverse UTF-8 encoded strings. - %TRUE if @string matches @pspec + %TRUE if @string matches @pspec - a #GPatternSpec + a #GPatternSpec - the length of @string (in bytes, i.e. strlen(), + the length of @string (in bytes, i.e. strlen(), not g_utf8_strlen()) - the UTF-8 encoded string to match + the UTF-8 encoded string to match - the reverse of @string or %NULL + the reverse of @string or %NULL - Matches a string against a pattern given as a string. If this + Matches a string against a pattern given as a string. If this function is to be called in a loop, it's more efficient to compile the pattern once with g_pattern_spec_new() and call g_pattern_match_string() repeatedly. - %TRUE if @string matches @pspec + %TRUE if @string matches @pspec - the UTF-8 encoded pattern + the UTF-8 encoded pattern - the UTF-8 encoded string to match + the UTF-8 encoded string to match - Matches a string against a compiled pattern. If the string is to be + Matches a string against a compiled pattern. If the string is to be matched against more than one pattern, consider using g_pattern_match() instead while supplying the reversed string. - %TRUE if @string matches @pspec + %TRUE if @string matches @pspec - a #GPatternSpec + a #GPatternSpec - the UTF-8 encoded string to match + the UTF-8 encoded string to match - This is equivalent to g_bit_lock, but working on pointers (or other + This is equivalent to g_bit_lock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of @@ -39827,39 +42858,39 @@ the pointer. - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - a bit value between 0 and 31 + a bit value between 0 and 31 - This is equivalent to g_bit_trylock, but working on pointers (or + This is equivalent to g_bit_trylock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of the pointer. - %TRUE if the lock was acquired + %TRUE if the lock was acquired - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - a bit value between 0 and 31 + a bit value between 0 and 31 - This is equivalent to g_bit_unlock, but working on pointers (or other + This is equivalent to g_bit_unlock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of @@ -39870,17 +42901,17 @@ the pointer. - a pointer to a #gpointer-sized value + a pointer to a #gpointer-sized value - a bit value between 0 and 31 + a bit value between 0 and 31 - Polls @fds, as with the poll() system call, but portably. (On + Polls @fds, as with the poll() system call, but portably. (On systems that don't have poll(), it is emulated using select().) This is used internally by #GMainContext, but it can be called directly if you need to block until a file descriptor is ready, but @@ -39899,28 +42930,28 @@ Windows, the easiest solution is to construct all of your #GPollFDs with g_io_channel_win32_make_pollfd(). - the number of entries in @fds whose @revents fields + the number of entries in @fds whose @revents fields were filled in, or 0 if the operation timed out, or -1 on error or if the call was interrupted. - file descriptors to poll + file descriptors to poll - the number of file descriptors in @fds + the number of file descriptors in @fds - amount of time to wait, in milliseconds, or -1 to wait forever + amount of time to wait, in milliseconds, or -1 to wait forever - Formats a string according to @format and prefix it to an existing + Formats a string according to @format and prefix it to an existing error message. If @err is %NULL (ie: no error variable) then do nothing. @@ -39932,21 +42963,21 @@ error condition) then also do nothing. - a return location for a #GError + a return location for a #GError - printf()-style format string + printf()-style format string - arguments to @format + arguments to @format - Outputs a formatted message via the print handler. + Outputs a formatted message via the print handler. The default print handler simply outputs the message to stdout, without appending a trailing new-line character. Typically, @format should end with its own new-line character. @@ -39962,17 +42993,17 @@ g_warning() and g_error(). - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Outputs a formatted message via the error message handler. + Outputs a formatted message via the error message handler. The default handler simply outputs the message to stderr, without appending a trailing new-line character. Typically, @format should end with its own new-line character. @@ -39986,17 +43017,17 @@ macros g_message(), g_warning() and g_error(). - the message format. See the printf() documentation + the message format. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - An implementation of the standard printf() function which supports + An implementation of the standard printf() function which supports positional parameters, as specified in the Single Unix Specification. As with the standard printf(), this does not automatically append a trailing @@ -40006,42 +43037,42 @@ own new-line character. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. - Calculates the maximum space needed to store the output + Calculates the maximum space needed to store the output of the sprintf() function. - the maximum space needed to store the formatted string + the maximum space needed to store the formatted string - the format string. See the printf() documentation + the format string. See the printf() documentation - the parameters to be inserted into the format string + the parameters to be inserted into the format string - If @dest is %NULL, free @src; otherwise, moves @src into *@dest. + If @dest is %NULL, free @src; otherwise, moves @src into *@dest. The error variable @dest points to must be %NULL. @src must be non-%NULL. @@ -40055,17 +43086,17 @@ after calling this function on it. - error return location + error return location - error to move into the return location + error to move into the return location - If @dest is %NULL, free @src; otherwise, moves @src into *@dest. + If @dest is %NULL, free @src; otherwise, moves @src into *@dest. *@dest must be %NULL. After the move, add a prefix as with g_prefix_error(). @@ -40074,56 +43105,56 @@ g_prefix_error(). - error return location + error return location - error to move into the return location + error to move into the return location - printf()-style format string + printf()-style format string - arguments to @format + arguments to @format - Checks whether @needle exists in @haystack. If the element is found, %TRUE is + Checks whether @needle exists in @haystack. If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned. This does pointer comparisons only. If you want to use more complex equality checks, such as string comparisons, use g_ptr_array_find_with_equal_func(). - + - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - pointer to look for + pointer to look for - return location for the index of + return location for the index of the element, if found - Checks whether @needle exists in @haystack, using the given @equal_func. + Checks whether @needle exists in @haystack, using the given @equal_func. If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of @@ -40132,37 +43163,52 @@ the first instance is returned. @equal_func is called with the element from the array as its first parameter, and @needle as its second parameter. If @equal_func is %NULL, pointer equality is used. - + - %TRUE if @needle is one of the elements of @haystack + %TRUE if @needle is one of the elements of @haystack - pointer array to be searched + pointer array to be searched - pointer to look for + pointer to look for - the function to call for each element, which should + the function to call for each element, which should return %TRUE when the desired element is found; or %NULL to use pointer equality - return location for the index of + return location for the index of the element, if found + + Returns the pointer at the given index of the pointer array. + +This does not perform bounds checking on the given @index_, +so you are responsible for checking it against the array length. + + + + a #GPtrArray + + + the index of the pointer to return + + + - This is just like the standard C qsort() function, but + This is just like the standard C qsort() function, but the comparison routine accepts a user data argument. This is guaranteed to be a stable sort since version 2.32. @@ -40172,29 +43218,29 @@ This is guaranteed to be a stable sort since version 2.32. - start of array to sort + start of array to sort - elements in the array + elements in the array - size of each element + size of each element - function to compare elements + function to compare elements - data to pass to @compare_func + data to pass to @compare_func - Gets the #GQuark identifying the given (static) string. If the + Gets the #GQuark identifying the given (static) string. If the string does not currently have an associated #GQuark, a new #GQuark is created, linked to the given string. @@ -40205,125 +43251,146 @@ will continue to exist until the program terminates. It can be used with statically allocated strings in the main program, but not with statically allocated memory in dynamically loaded modules, if you expect to ever unload the module again (e.g. do not use this -function in GTK+ theme engines). +function in GTK+ theme engines). + +This function must not be used before library constructors have finished +running. In particular, this means it cannot be used to initialize global +variables in C++. - the #GQuark identifying the string, or 0 if @string is %NULL + the #GQuark identifying the string, or 0 if @string is %NULL - a string + a string - Gets the #GQuark identifying the given string. If the string does + Gets the #GQuark identifying the given string. If the string does not currently have an associated #GQuark, a new #GQuark is created, -using a copy of the string. +using a copy of the string. + +This function must not be used before library constructors have finished +running. In particular, this means it cannot be used to initialize global +variables in C++. - the #GQuark identifying the string, or 0 if @string is %NULL + the #GQuark identifying the string, or 0 if @string is %NULL - a string + a string - Gets the string associated with the given #GQuark. + Gets the string associated with the given #GQuark. - the string associated with the #GQuark + the string associated with the #GQuark - a #GQuark. + a #GQuark. - Gets the #GQuark associated with the given string, or 0 if string is + Gets the #GQuark associated with the given string, or 0 if string is %NULL or it has no associated #GQuark. If you want the GQuark to be created if it doesn't already exist, -use g_quark_from_string() or g_quark_from_static_string(). +use g_quark_from_string() or g_quark_from_static_string(). + +This function must not be used before library constructors have finished +running. - the #GQuark associated with the string, or 0 if @string is + the #GQuark associated with the string, or 0 if @string is %NULL or there is no #GQuark associated with it - a string + a string + + Returns a random #gboolean from @rand_. +This corresponds to a unbiased coin toss. + + + + a #GRand + + + - Returns a random #gdouble equally distributed over the range [0..1). + Returns a random #gdouble equally distributed over the range [0..1). - a random number + a random number - Returns a random #gdouble equally distributed over the range + Returns a random #gdouble equally distributed over the range [@begin..@end). - a random number + a random number - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - Return a random #guint32 equally distributed over the range + Return a random #guint32 equally distributed over the range [0..2^32-1]. - a random number + a random number - Returns a random #gint32 equally distributed over the range + Returns a random #gint32 equally distributed over the range [@begin..@end-1]. - a random number + a random number - lower closed bound of the interval + lower closed bound of the interval - upper open bound of the interval + upper open bound of the interval - Sets the seed for the global random number generator, which is used + Sets the seed for the global random number generator, which is used by the g_random_* functions, to @seed. @@ -40331,28 +43398,28 @@ by the g_random_* functions, to @seed. - a value to reinitialize the global random number generator + a value to reinitialize the global random number generator - Acquires a reference on the data pointed by @mem_block. + Acquires a reference on the data pointed by @mem_block. - a pointer to the data, + a pointer to the data, with its reference count increased - a pointer to reference counted data + a pointer to reference counted data - Allocates @block_size bytes of memory, and adds reference + Allocates @block_size bytes of memory, and adds reference counting semantics to it. The data will be freed when its reference count drops to @@ -40362,18 +43429,18 @@ The allocated data is guaranteed to be suitably aligned for any built-in type. - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - Allocates @block_size bytes of memory, and adds reference + Allocates @block_size bytes of memory, and adds reference counting semantics to it. The contents of the returned data is set to zero. @@ -40385,53 +43452,81 @@ The allocated data is guaranteed to be suitably aligned for any built-in type. - a pointer to the allocated memory + a pointer to the allocated memory - the size of the allocation, must be greater than 0 + the size of the allocation, must be greater than 0 - Allocates a new block of data with reference counting + Allocates a new block of data with reference counting semantics, and copies @block_size bytes of @mem_block into it. - a pointer to the allocated + a pointer to the allocated memory - the number of bytes to copy, must be greater than 0 + the number of bytes to copy, must be greater than 0 - the memory to copy + the memory to copy - Retrieves the size of the reference counted data pointed by @mem_block. + Retrieves the size of the reference counted data pointed by @mem_block. - the size of the data, in bytes + the size of the data, in bytes - a pointer to reference counted data + a pointer to reference counted data + + A convenience macro to allocate reference counted data with +the size of the given @type. + +This macro calls g_rc_box_alloc() with `sizeof (@type)` and +casts the returned pointer to a pointer of the given @type, +avoiding a type cast in the source code. + + + + the type to allocate, typically a structure name + + + + + A convenience macro to allocate reference counted data with +the size of the given @type, and set its contents to zero. + +This macro calls g_rc_box_alloc0() with `sizeof (@type)` and +casts the returned pointer to a pointer of the given @type, +avoiding a type cast in the source code. + + + + the type to allocate, typically a structure name + + + - Releases a reference on the data pointed by @mem_block. + Releases a reference on the data pointed by @mem_block. If the reference was the last one, it will free the resources allocated for @mem_block. @@ -40441,13 +43536,13 @@ resources allocated for @mem_block. - a pointer to reference counted data + a pointer to reference counted data - Releases a reference on the data pointed by @mem_block. + Releases a reference on the data pointed by @mem_block. If the reference was the last one, it will call @clear_func to clear the contents of @mem_block, and then will free the @@ -40458,164 +43553,164 @@ resources allocated for @mem_block. - a pointer to reference counted data + a pointer to reference counted data - a function to call when clearing the data + a function to call when clearing the data - Reallocates the memory pointed to by @mem, so that it now has space for + Reallocates the memory pointed to by @mem, so that it now has space for @n_bytes bytes of memory. It returns the new address of the memory, which may have been moved. @mem may be %NULL, in which case it's considered to have zero-length. @n_bytes may be 0, in which case %NULL will be returned and @mem will be freed unless it is %NULL. - the new address of the allocated memory + the new address of the allocated memory - the memory to reallocate + the memory to reallocate - new size of the memory in bytes + new size of the memory in bytes - This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - the new address of the allocated memory + the new address of the allocated memory - the memory to reallocate + the memory to reallocate - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - Compares the current value of @rc with @val. + Compares the current value of @rc with @val. - %TRUE if the reference count is the same + %TRUE if the reference count is the same as the given value - the address of a reference count variable + the address of a reference count variable - the value to compare + the value to compare - Decreases the reference count. + Decreases the reference count. - %TRUE if the reference count reached 0, and %FALSE otherwise + %TRUE if the reference count reached 0, and %FALSE otherwise - the address of a reference count variable + the address of a reference count variable - Increases the reference count. + Increases the reference count. - the address of a reference count variable + the address of a reference count variable - Initializes a reference count variable. + Initializes a reference count variable. - the address of a reference count variable + the address of a reference count variable - Acquires a reference on a string. + Acquires a reference on a string. - the given string, with its reference count increased + the given string, with its reference count increased - a reference counted string + a reference counted string - Retrieves the length of @str. + Retrieves the length of @str. - the length of the given string, in bytes + the length of the given string, in bytes - a reference counted string + a reference counted string - Creates a new reference counted string and copies the contents of @str + Creates a new reference counted string and copies the contents of @str into it. - the newly created reference counted string + the newly created reference counted string - a NUL-terminated string + a NUL-terminated string - Creates a new reference counted string and copies the content of @str + Creates a new reference counted string and copies the content of @str into it. If you call this function multiple times with the same @str, or with @@ -40623,41 +43718,41 @@ the same contents of @str, it will return a new reference, instead of creating a new string. - the newly created reference + the newly created reference counted string, or a new reference to an existing string - a NUL-terminated string + a NUL-terminated string - Creates a new reference counted string and copies the contents of @str + Creates a new reference counted string and copies the contents of @str into it, up to @len bytes. Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that @str has at least @len addressable bytes. - the newly created reference counted string + the newly created reference counted string - a string + a string - length of @str to use, or -1 if @str is nul-terminated + length of @str to use, or -1 if @str is nul-terminated - Releases a reference on a string; if it was the last reference, the + Releases a reference on a string; if it was the last reference, the resources allocated by the string are freed as well. @@ -40665,13 +43760,13 @@ resources allocated by the string are freed as well. - a reference counted string + a reference counted string - Checks whether @replacement is a valid replacement string + Checks whether @replacement is a valid replacement string (see g_regex_replace()), i.e. that all escape sequences in it are valid. @@ -40682,16 +43777,16 @@ about actual match, but '\0\1' (whole match followed by first subpattern) requires valid #GMatchInfo object. - whether @replacement is a valid replacement string + whether @replacement is a valid replacement string - the replacement string + the replacement string - location to store information about + location to store information about references in @replacement or %NULL @@ -40703,29 +43798,29 @@ subpattern) requires valid #GMatchInfo object. - Escapes the nul characters in @string to "\x00". It can be used + Escapes the nul characters in @string to "\x00". It can be used to compile a regex with embedded nul characters. For completeness, @length can be -1 for a nul-terminated string. In this case the output string will be of course equal to @string. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string + the length of @string - Escapes the special characters used for regular expressions + Escapes the special characters used for regular expressions in @string, for instance "a.b*c" becomes "a\.b\*c". This function is useful to dynamically generate regular expressions. @@ -40734,24 +43829,24 @@ in this case remember to specify the correct length of @string in @length. - a newly-allocated escaped string + a newly-allocated escaped string - the string to escape + the string to escape - the length of @string, in bytes, or -1 if @string is nul-terminated + the length of @string, in bytes, or -1 if @string is nul-terminated - Scans for a match in @string for @pattern. + Scans for a match in @string for @pattern. This function is equivalent to g_regex_match() but it does not require to compile the pattern with g_regex_new(), avoiding some @@ -40763,30 +43858,30 @@ once, it's more efficient to compile the pattern once with g_regex_new() and then use g_regex_match(). - %TRUE if the string matched, %FALSE otherwise + %TRUE if the string matched, %FALSE otherwise - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 - Breaks the string on the pattern, and returns an array of + Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the @@ -40815,7 +43910,7 @@ characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c". - a %NULL-terminated array of strings. Free + a %NULL-terminated array of strings. Free it using g_strfreev() @@ -40823,25 +43918,25 @@ it using g_strfreev() - the regular expression + the regular expression - the string to scan for matches + the string to scan for matches - compile options for the regular expression, or 0 + compile options for the regular expression, or 0 - match options, or 0 + match options, or 0 - Resets the cache used for g_get_user_special_dir(), so + Resets the cache used for g_get_user_special_dir(), so that the latest on-disk version is used. Call this only if you just changed the data on disk yourself. @@ -40854,8 +43949,33 @@ the directories that actually changed value though. + + Reallocates the memory pointed to by @mem, so that it now has space for +@n_structs elements of type @struct_type. It returns the new address of +the memory, which may have been moved. +Care is taken to avoid overflow when calculating the size of the allocated block. + + + + the type of the elements to allocate + + + the currently allocated memory + + + the number of elements to allocate + + + + + + + + + + - Internal function used to print messages from the public g_return_if_fail() + Internal function used to print messages from the public g_return_if_fail() and g_return_val_if_fail() macros. @@ -40863,73 +43983,154 @@ and g_return_val_if_fail() macros. - log domain + log domain - function containing the assertion + function containing the assertion - expression which failed + expression which failed + + + + + + + + + + + + + + + + - A wrapper for the POSIX rmdir() function. The rmdir() function + A wrapper for the POSIX rmdir() function. The rmdir() function deletes a directory from the filesystem. See your C library manual for more details about how rmdir() works on your system. - + - 0 if the directory was successfully removed, -1 if an error + 0 if the directory was successfully removed, -1 if an error occurred - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) + + Adds a symbol to the default scope. + Use g_scanner_scope_add_symbol() instead. + + + + a #GScanner + + + the symbol to add + + + the value of the symbol + + + + + Calls a function for each symbol in the default scope. + Use g_scanner_scope_foreach_symbol() instead. + + + + a #GScanner + + + the function to call with each symbol + + + data to pass to the function + + + + + There is no reason to use this macro, since it does nothing. + This macro does nothing. + + + + a #GScanner + + + + + Removes a symbol from the default scope. + Use g_scanner_scope_remove_symbol() instead. + + + + a #GScanner + + + the symbol to remove + + + + + There is no reason to use this macro, since it does nothing. + This macro does nothing. + + + + a #GScanner + + + - Returns the data that @iter points to. + Returns the data that @iter points to. - the data that @iter points to + the data that @iter points to - a #GSequenceIter + a #GSequenceIter - Inserts a new item just before the item pointed to by @iter. + Inserts a new item just before the item pointed to by @iter. - an iterator pointing to the new item + an iterator pointing to the new item - a #GSequenceIter + a #GSequenceIter - the data for the new item + the data for the new item - Moves the item pointed to by @src to the position indicated by @dest. + Moves the item pointed to by @src to the position indicated by @dest. After calling this function @dest will point to the position immediately after @src. It is allowed for @src and @dest to point into different sequences. @@ -40939,18 +44140,18 @@ sequences. - a #GSequenceIter pointing to the item to move + a #GSequenceIter pointing to the item to move - a #GSequenceIter pointing to the position to which + a #GSequenceIter pointing to the position to which the item is moved - Inserts the (@begin, @end) range at the destination pointed to by @dest. + Inserts the (@begin, @end) range at the destination pointed to by @dest. The @begin and @end iters must point into the same sequence. It is allowed for @dest to point to a different sequence than the one pointed into by @begin and @end. @@ -40964,21 +44165,21 @@ the (@begin, @end) range, the range does not move. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Finds an iterator somewhere in the range (@begin, @end). This + Finds an iterator somewhere in the range (@begin, @end). This iterator will be close to the middle of the range, but is not guaranteed to be exactly in the middle. @@ -40986,23 +44187,23 @@ The @begin and @end iterators must both point to the same sequence and @begin must come before or be equal to @end in the sequence. - a #GSequenceIter pointing somewhere in the + a #GSequenceIter pointing somewhere in the (@begin, @end) range - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Removes the item pointed to by @iter. It is an error to pass the + Removes the item pointed to by @iter. It is an error to pass the end iterator to this function. If the sequence has a data destroy function associated with it, this @@ -41013,13 +44214,13 @@ function is called on the data for the removed item. - a #GSequenceIter + a #GSequenceIter - Removes all items in the (@begin, @end) range. + Removes all items in the (@begin, @end) range. If the sequence has a data destroy function associated with it, this function is called on the data for the removed items. @@ -41029,17 +44230,17 @@ function is called on the data for the removed items. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Changes the data for the item pointed to by @iter to be @data. If + Changes the data for the item pointed to by @iter to be @data. If the sequence has a data destroy function associated with it, that function is called on the existing data that @iter pointed to. @@ -41048,17 +44249,17 @@ function is called on the existing data that @iter pointed to. - a #GSequenceIter + a #GSequenceIter - new data for the item + new data for the item - Swaps the items pointed to by @a and @b. It is allowed for @a and @b + Swaps the items pointed to by @a and @b. It is allowed for @a and @b to point into difference sequences. @@ -41066,17 +44267,17 @@ to point into difference sequences. - a #GSequenceIter + a #GSequenceIter - a #GSequenceIter + a #GSequenceIter - Sets a human-readable name for the application. This name should be + Sets a human-readable name for the application. This name should be localized if possible, and is intended for display to the user. Contrast with g_set_prgname(), which sets a non-localized name. g_set_prgname() will be called automatically by gtk_init(), @@ -41093,13 +44294,13 @@ or when displaying an application's name in the task list. - localized name of the application + localized name of the application - Does nothing if @err is %NULL; if @err is non-%NULL, then *@err + Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must be %NULL. A new #GError is created and assigned to *@err. @@ -41107,29 +44308,29 @@ must be %NULL. A new #GError is created and assigned to *@err. - a return location for a #GError + a return location for a #GError - error domain + error domain - error code + error code - printf()-style format + printf()-style format - args for @format + args for @format - Does nothing if @err is %NULL; if @err is non-%NULL, then *@err + Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must be %NULL. A new #GError is created and assigned to *@err. Unlike g_set_error(), @message is not a printf()-style format string. Use this function if @message contains text you don't have control over, @@ -41140,25 +44341,25 @@ that could include printf() escape sequences. - a return location for a #GError + a return location for a #GError - error domain + error domain - error code + error code - error message + error message - Sets the name of the program. This name should not be localized, + Sets the name of the program. This name should not be localized, in contrast to g_set_application_name(). If you are using #GApplication the program name is set in @@ -41174,13 +44375,13 @@ Note that for thread-safety reasons this function can only be called once. - the name of the program. + the name of the program. - Sets the print handler. + Sets the print handler. Any messages passed to g_print() will be output via the new handler. The default handler simply outputs @@ -41189,18 +44390,18 @@ you can redirect the output, to a GTK+ widget or a log file for example. - the old print handler + the old print handler - the new print handler + the new print handler - Sets the handler for printing error messages. + Sets the handler for printing error messages. Any messages passed to g_printerr() will be output via the new handler. The default handler simply outputs the @@ -41209,18 +44410,18 @@ redirect the output, to a GTK+ widget or a log file for example. - the old error message handler + the old error message handler - the new error message handler + the new error message handler - Sets an environment variable. On UNIX, both the variable's name and + Sets an environment variable. On UNIX, both the variable's name and value can be arbitrary byte strings, except that the variable's name cannot contain '='. On Windows, they should be in UTF-8. @@ -41241,21 +44442,21 @@ g_environ_setenv() and g_environ_unsetenv(), and then pass that array directly to execvpe(), g_spawn_async(), or the like. - %FALSE if the environment variable couldn't be set. + %FALSE if the environment variable couldn't be set. - the environment variable to set, must not + the environment variable to set, must not contain '='. - the value for to set the variable to. + the value for to set the variable to. - whether to change the variable if it already exists. + whether to change the variable if it already exists. @@ -41266,7 +44467,7 @@ array directly to execvpe(), g_spawn_async(), or the like. - Parses a command line into an argument vector, in much the same way + Parses a command line into an argument vector, in much the same way the shell would, but without many of the expansions the shell would perform (variable expansion, globs, operators, filename expansion, etc. are not supported). The results are defined to be the same as @@ -41277,20 +44478,20 @@ literally. Possible errors are those from the #G_SHELL_ERROR domain. Free the returned vector with g_strfreev(). - %TRUE on success, %FALSE if error set + %TRUE on success, %FALSE if error set - command line to parse + command line to parse - return location for number of args + return location for number of args - + return location for array of args @@ -41299,7 +44500,7 @@ domain. Free the returned vector with g_strfreev(). - Quotes a string so that the shell (/bin/sh) will interpret the + Quotes a string so that the shell (/bin/sh) will interpret the quoted string to mean @unquoted_string. If you pass a filename to the shell, for example, you should first quote it with this function. The return value must be freed with g_free(). The @@ -41307,18 +44508,18 @@ quoting style used is undefined (single or double quotes may be used). - quoted string + quoted string - a literal string + a literal string - Unquotes a string as the shell (/bin/sh) would. Only handles + Unquotes a string as the shell (/bin/sh) would. Only handles quotes; if a string contains file globs, arithmetic operators, variables, backticks, redirections, or other special-to-the-shell features, the result will be different from the result a real shell @@ -41341,18 +44542,58 @@ be escaped with backslash. Otherwise double quotes preserve things literally. - an unquoted string + an unquoted string - shell-quoted string + shell-quoted string + + Performs a checked addition of @a and @b, storing the result in +@dest. + +If the operation is successful, %TRUE is returned. If the operation +overflows then the state of @dest is undefined and %FALSE is +returned. + + + + a pointer to the #gsize destination + + + the #gsize left operand + + + the #gsize right operand + + + + + Performs a checked multiplication of @a and @b, storing the result in +@dest. + +If the operation is successful, %TRUE is returned. If the operation +overflows then the state of @dest is undefined and %FALSE is +returned. + + + + a pointer to the #gsize destination + + + the #gsize left operand + + + the #gsize right operand + + + - Allocates a block of memory from the slice allocator. + Allocates a block of memory from the slice allocator. The block address handed out can be expected to be aligned to at least 1 * sizeof (void*), though in general slices are 2 * sizeof (void*) bytes aligned, @@ -41363,59 +44604,102 @@ be changed with the [`G_SLICE=always-malloc`][G_SLICE] environment variable. - a pointer to the allocated memory block, which will be %NULL if and + a pointer to the allocated memory block, which will be %NULL if and only if @mem_size is 0 - the number of bytes to allocate + the number of bytes to allocate - Allocates a block of memory via g_slice_alloc() and initializes + Allocates a block of memory via g_slice_alloc() and initializes the returned memory to 0. Note that the underlying slice allocation mechanism can be changed with the [`G_SLICE=always-malloc`][G_SLICE] environment variable. - a pointer to the allocated block, which will be %NULL if and only + a pointer to the allocated block, which will be %NULL if and only if @mem_size is 0 - the number of bytes to allocate + the number of bytes to allocate - Allocates a block of memory from the slice allocator + Allocates a block of memory from the slice allocator and copies @block_size bytes into it from @mem_block. @mem_block must be non-%NULL if @block_size is non-zero. - a pointer to the allocated memory block, which will be %NULL if and + a pointer to the allocated memory block, which will be %NULL if and only if @mem_size is 0 - the number of bytes to allocate + the number of bytes to allocate - the memory to copy + the memory to copy + + A convenience macro to duplicate a block of memory using +the slice allocator. + +It calls g_slice_copy() with `sizeof (@type)` +and casts the returned pointer to a pointer of the given type, +avoiding a type cast in the source code. +Note that the underlying slice allocation mechanism can +be changed with the [`G_SLICE=always-malloc`][G_SLICE] +environment variable. + +This can never return %NULL. + + + + the type to duplicate, typically a structure name + + + the memory to copy into the allocated block + + + + + A convenience macro to free a block of memory that has +been allocated from the slice allocator. + +It calls g_slice_free1() using `sizeof (type)` +as the block size. +Note that the exact release behaviour can be changed with the +[`G_DEBUG=gc-friendly`][G_DEBUG] environment variable, also see +[`G_SLICE`][G_SLICE] for related debugging options. + +If @mem is %NULL, this macro does nothing. + + + + the type of the block to free, typically a structure name + + + a pointer to the block to free + + + - Frees a block of memory. + Frees a block of memory. The memory must have been allocated via g_slice_alloc() or g_slice_alloc0() and the @block_size has to match the size @@ -41430,17 +44714,41 @@ If @mem_block is %NULL, this function does nothing. - the size of the block + the size of the block - a pointer to the block to free + a pointer to the block to free + + Frees a linked list of memory blocks of structure type @type. +The memory blocks must be equal-sized, allocated via +g_slice_alloc() or g_slice_alloc0() and linked together by +a @next pointer (similar to #GSList). The name of the +@next field in @type is passed as third argument. +Note that the exact release behaviour can be changed with the +[`G_DEBUG=gc-friendly`][G_DEBUG] environment variable, also see +[`G_SLICE`][G_SLICE] for related debugging options. + +If @mem_chain is %NULL, this function does nothing. + + + + the type of the @mem_chain blocks + + + a pointer to the first block of the chain + + + the field name of the next pointer in @type + + + - Frees a linked list of memory blocks of structure type @type. + Frees a linked list of memory blocks of structure type @type. The memory blocks must be equal-sized, allocated via g_slice_alloc() or g_slice_alloc0() and linked together by a @@ -41457,15 +44765,15 @@ If @mem_chain is %NULL, this function does nothing. - the size of the blocks + the size of the blocks - a pointer to the first block of the chain + a pointer to the first block of the chain - the offset of the @next field in the blocks + the offset of the @next field in the blocks @@ -41498,6 +44806,45 @@ If @mem_chain is %NULL, this function does nothing. + + A convenience macro to allocate a block of memory from the +slice allocator. + +It calls g_slice_alloc() with `sizeof (@type)` and casts the +returned pointer to a pointer of the given type, avoiding a type +cast in the source code. Note that the underlying slice allocation +mechanism can be changed with the [`G_SLICE=always-malloc`][G_SLICE] +environment variable. + +This can never return %NULL as the minimum allocation size from +`sizeof (@type)` is 1 byte. + + + + the type to allocate, typically a structure name + + + + + A convenience macro to allocate a block of memory from the +slice allocator and set the memory to 0. + +It calls g_slice_alloc0() with `sizeof (@type)` +and casts the returned pointer to a pointer of the given type, +avoiding a type cast in the source code. +Note that the underlying slice allocation mechanism can +be changed with the [`G_SLICE=always-malloc`][G_SLICE] +environment variable. + +This can never return %NULL as the minimum allocation size from +`sizeof (@type)` is 1 byte. + + + + the type to allocate, typically a structure name + + + @@ -41512,8 +44859,19 @@ If @mem_chain is %NULL, this function does nothing. + + A convenience macro to get the next element in a #GSList. +Note that it is considered perfectly acceptable to access +@slist->next directly. + + + + an element in a #GSList. + + + - A safer form of the standard sprintf() function. The output is guaranteed + A safer form of the standard sprintf() function. The output is guaranteed to not exceed @n characters (including the terminating nul character), so it is easy to ensure that a buffer overflow cannot occur. @@ -41532,33 +44890,33 @@ The format string may contain positional parameters, as specified in the Single Unix Specification. - the number of bytes which would be produced if the buffer + the number of bytes which would be produced if the buffer was large enough. - the buffer to hold the output. + the buffer to hold the output. - the maximum number of bytes to produce (including the + the maximum number of bytes to produce (including the terminating nul character). - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. - Removes the source with the given ID from the default main context. You must + Removes the source with the given ID from the default main context. You must use g_source_destroy() for sources added to a non-default main context. The ID of a #GSource is given by g_source_get_id(), or will be @@ -41577,56 +44935,56 @@ idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source. - + - For historical reasons, this function always returns %TRUE + For historical reasons, this function always returns %TRUE - the ID of the source to remove. + the ID of the source to remove. - Removes a source from the default main loop context given the + Removes a source from the default main loop context given the source functions and user data. If multiple sources exist with the same source functions and user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - The @source_funcs passed to g_source_new() + The @source_funcs passed to g_source_new() - the user data for the callback + the user data for the callback - Removes a source from the default main loop context given the user + Removes a source from the default main loop context given the user data for the callback. If multiple sources exist with the same user data, only one will be destroyed. - + - %TRUE if a source was found and removed. + %TRUE if a source was found and removed. - the user_data for the callback. + the user_data for the callback. - Sets the name of a source using its ID. + Sets the name of a source using its ID. This is a convenience utility to set source names from the return value of g_idle_add(), g_timeout_add(), etc. @@ -41648,17 +45006,17 @@ wrong source. - a #GSource ID + a #GSource ID - debug name for the source + debug name for the source - Gets the smallest prime number from a built-in array of primes which + Gets the smallest prime number from a built-in array of primes which is larger than @num. This is used within GLib to calculate the optimum size of a #GHashTable. @@ -41666,19 +45024,19 @@ The built-in array of primes ranges from 11 to 13845163 such that each prime is approximately 1.5-2 times the previous prime. - the smallest prime number from a built-in array of primes + the smallest prime number from a built-in array of primes which is larger than @num - a #guint + a #guint - See g_spawn_async_with_pipes() for a full description; this function + See g_spawn_async_with_pipes() for a full description; this function simply calls the g_spawn_async_with_pipes() without any pipes. You should call g_spawn_close_pid() on the returned child process @@ -41692,51 +45050,51 @@ windows on the right screen, you may want to use #GdkAppLaunchContext, Note that the returned @child_pid on Windows is a handle to the child process and not its identifier. Process handles and process identifiers are different concepts on Windows. - + - %TRUE on success, %FALSE if error is set + %TRUE on success, %FALSE if error is set - child's current working + child's current working directory, or %NULL to inherit parent's - + child's argument vector - + child's environment, or %NULL to inherit parent's - flags from #GSpawnFlags + flags from #GSpawnFlags - function to run in the child just before exec() + function to run in the child just before exec() - user data for @child_setup + user data for @child_setup - return location for child process reference, or %NULL + return location for child process reference, or %NULL - Identical to g_spawn_async_with_pipes() but instead of + Identical to g_spawn_async_with_pipes() but instead of creating pipes for the stdin/stdout/stderr, you can pass existing file descriptors into this function through the @stdin_fd, @stdout_fd and @stderr_fd parameters. The following @flags @@ -41754,60 +45112,60 @@ standard input (by default, the child's standard input is attached to It is valid to pass the same fd in multiple parameters (e.g. you can pass a single fd for both stdout and stderr). - + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding + child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding - child's argument vector, in the GLib file name encoding + child's argument vector, in the GLib file name encoding - child's environment, or %NULL to inherit parent's, in the GLib file name encoding + child's environment, or %NULL to inherit parent's, in the GLib file name encoding - flags from #GSpawnFlags + flags from #GSpawnFlags - function to run in the child just before exec() + function to run in the child just before exec() - user data for @child_setup + user data for @child_setup - return location for child process ID, or %NULL + return location for child process ID, or %NULL - file descriptor to use for child's stdin, or -1 + file descriptor to use for child's stdin, or -1 - file descriptor to use for child's stdout, or -1 + file descriptor to use for child's stdout, or -1 - file descriptor to use for child's stderr, or -1 + file descriptor to use for child's stderr, or -1 - Executes a child program asynchronously (your program will not + Executes a child program asynchronously (your program will not block waiting for the child to exit). The child program is specified by the only argument that must be provided, @argv. @argv should be a %NULL-terminated array of strings, to be passed @@ -41973,26 +45331,26 @@ If you are writing a GTK+ application, and the program you are spawning is a graphical application too, then to ensure that the spawned program opens its windows on the right screen, you may want to use #GdkAppLaunchContext, #GAppLaunchContext, or set the %DISPLAY environment variable. - + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - child's current working + child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding - child's argument + child's argument vector, in the GLib file name encoding - + child's environment, or %NULL to inherit parent's, in the GLib file name encoding @@ -42000,37 +45358,37 @@ windows on the right screen, you may want to use #GdkAppLaunchContext, - flags from #GSpawnFlags + flags from #GSpawnFlags - function to run in the child just before exec() + function to run in the child just before exec() - user data for @child_setup + user data for @child_setup - return location for child process ID, or %NULL + return location for child process ID, or %NULL - return location for file descriptor to write to child's stdin, or %NULL + return location for file descriptor to write to child's stdin, or %NULL - return location for file descriptor to read child's stdout, or %NULL + return location for file descriptor to read child's stdout, or %NULL - return location for file descriptor to read child's stderr, or %NULL + return location for file descriptor to read child's stderr, or %NULL - Set @error if @exit_status indicates the child exited abnormally + Set @error if @exit_status indicates the child exited abnormally (e.g. with a nonzero exit code, or via a fatal signal). The g_spawn_sync() and g_child_watch_add() family of APIs return an @@ -42066,37 +45424,37 @@ the available platform via a macro such as %G_OS_UNIX, and use WIFEXITED() and WEXITSTATUS() on @exit_status directly. Do not attempt to scan or parse the error message string; it may be translated and/or change in future versions of GLib. - + - %TRUE if child exited successfully, %FALSE otherwise (and + %TRUE if child exited successfully, %FALSE otherwise (and @error will be set) - An exit code as returned from g_spawn_sync() + An exit code as returned from g_spawn_sync() - On some platforms, notably Windows, the #GPid type represents a resource + On some platforms, notably Windows, the #GPid type represents a resource which must be closed to prevent resource leaking. g_spawn_close_pid() is provided for this purpose. It should be used on all platforms, even though it doesn't do anything under UNIX. - + - The process reference to close + The process reference to close - A simple version of g_spawn_async() that parses a command line with + A simple version of g_spawn_async() that parses a command line with g_shell_parse_argv() and passes it to g_spawn_async(). Runs a command line in the background. Unlike g_spawn_async(), the %G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note @@ -42105,20 +45463,20 @@ consider using g_spawn_async() directly if appropriate. Possible errors are those from g_shell_parse_argv() and g_spawn_async(). The same concerns on Windows apply as for g_spawn_command_line_sync(). - + - %TRUE on success, %FALSE if error is set + %TRUE on success, %FALSE if error is set - a command line + a command line - A simple version of g_spawn_sync() with little-used parameters + A simple version of g_spawn_sync() with little-used parameters removed, taking a command line instead of an argument vector. See g_spawn_sync() for full details. @command_line will be parsed by g_shell_parse_argv(). Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag @@ -42140,30 +45498,30 @@ canonical Windows paths, like "c:\\program files\\app\\app.exe", as the backslashes will be eaten, and the space will act as a separator. You need to enclose such paths with single quotes, like "'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'". - + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - a command line + a command line - return location for child output + return location for child output - return location for child errors + return location for child errors - return location for child exit status, as returned by waitpid() + return location for child exit status, as returned by waitpid() @@ -42179,7 +45537,7 @@ separator. You need to enclose such paths with single quotes, like - Executes a child synchronously (waits for the child to exit before returning). + Executes a child synchronously (waits for the child to exit before returning). All output from the child is stored in @standard_output and @standard_error, if those parameters are non-%NULL. Note that you must set the %G_SPAWN_STDOUT_TO_DEV_NULL and %G_SPAWN_STDERR_TO_DEV_NULL flags when @@ -42198,63 +45556,63 @@ If an error occurs, no data is returned in @standard_output, This function calls g_spawn_async_with_pipes() internally; see that function for full details on the other parameters and details on how these functions work on Windows. - + - %TRUE on success, %FALSE if an error was set + %TRUE on success, %FALSE if an error was set - child's current working + child's current working directory, or %NULL to inherit parent's - + child's argument vector - + child's environment, or %NULL to inherit parent's - flags from #GSpawnFlags + flags from #GSpawnFlags - function to run in the child just before exec() + function to run in the child just before exec() - user data for @child_setup + user data for @child_setup - return location for child output, or %NULL + return location for child output, or %NULL - return location for child error messages, or %NULL + return location for child error messages, or %NULL - return location for child exit status, as returned by waitpid(), or %NULL + return location for child exit status, as returned by waitpid(), or %NULL - An implementation of the standard sprintf() function which supports + An implementation of the standard sprintf() function which supports positional parameters, as specified in the Single Unix Specification. Note that it is usually better to use g_snprintf(), to avoid the @@ -42265,50 +45623,106 @@ risk of buffer overflow. See also g_strdup_printf(). - the number of bytes printed. + the number of bytes printed. - A pointer to a memory buffer to contain the resulting string. It + A pointer to a memory buffer to contain the resulting string. It is up to the caller to ensure that the allocated buffer is large enough to hold the formatted result - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the arguments to insert in the output. + the arguments to insert in the output. + + Sets @pp to %NULL, returning the value that was there before. + +Conceptually, this transfers the ownership of the pointer from the +referenced variable to the "caller" of the macro (ie: "steals" the +reference). + +The return value will be properly typed, according to the type of +@pp. + +This can be very useful when combined with g_autoptr() to prevent the +return value of a function from being automatically freed. Consider +the following example (which only works on GCC and clang): + +|[ +GObject * +create_object (void) +{ + g_autoptr(GObject) obj = g_object_new (G_TYPE_OBJECT, NULL); + + if (early_error_case) + return NULL; + + return g_steal_pointer (&obj); +} +]| + +It can also be used in similar ways for 'out' parameters and is +particularly useful for dealing with optional out parameters: + +|[ +gboolean +get_object (GObject **obj_out) +{ + g_autoptr(GObject) obj = g_object_new (G_TYPE_OBJECT, NULL); + + if (early_error_case) + return FALSE; + + if (obj_out) + *obj_out = g_steal_pointer (&obj); + + return TRUE; +} +]| + +In the above example, the object will be automatically freed in the +early error case and also in the case that %NULL was given for +@obj_out. + + + + a pointer to a pointer + + + - Copies a nul-terminated string into the dest buffer, include the + Copies a nul-terminated string into the dest buffer, include the trailing nul, and return a pointer to the trailing nul byte. This is useful for concatenating multiple strings together without having to repeatedly scan for the end. - a pointer to trailing nul byte. + a pointer to trailing nul byte. - destination buffer. + destination buffer. - source string. + source string. - Compares two strings for byte-by-byte equality and returns %TRUE + Compares two strings for byte-by-byte equality and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL strings as keys in a #GHashTable. @@ -42316,60 +45730,60 @@ if they are equal. It can be passed to g_hash_table_new() as the This function is typically used for hash table comparisons, but can be used for general purpose comparisons of non-%NULL strings. For a %NULL-safe string comparison function, see g_strcmp0(). - + - %TRUE if the two keys match + %TRUE if the two keys match - a key + a key - a key to compare with @v1 + a key to compare with @v1 - Looks whether the string @str begins with @prefix. + Looks whether the string @str begins with @prefix. - %TRUE if @str begins with @prefix, %FALSE otherwise. + %TRUE if @str begins with @prefix, %FALSE otherwise. - a nul-terminated string + a nul-terminated string - the nul-terminated prefix to look for + the nul-terminated prefix to look for - Looks whether the string @str ends with @suffix. + Looks whether the string @str ends with @suffix. - %TRUE if @str end with @suffix, %FALSE otherwise. + %TRUE if @str end with @suffix, %FALSE otherwise. - a nul-terminated string + a nul-terminated string - the nul-terminated suffix to look for + the nul-terminated suffix to look for - Converts a string to a hash value. + Converts a string to a hash value. This function implements the widely used "djb" hash apparently posted by Daniel Bernstein to comp.lang.c some time ago. The 32 @@ -42383,35 +45797,35 @@ when using non-%NULL strings as keys in a #GHashTable. Note that this function may not be a perfect fit for all use cases. For example, it produces some hash collisions with strings as short as 2. - + - a hash value corresponding to the key + a hash value corresponding to the key - a string key + a string key - Determines if a string is pure ASCII. A string is pure ASCII if it + Determines if a string is pure ASCII. A string is pure ASCII if it contains no bytes with the high bit set. - %TRUE if @str is ASCII + %TRUE if @str is ASCII - a string + a string - Checks if a search conducted for @search_term should match + Checks if a search conducted for @search_term should match @potential_hit. This function calls g_str_tokenize_and_fold() on both @@ -42435,26 +45849,26 @@ accent matching). Searching ‘fo’ would match ‘Foo’ Baz’, but not ‘SFO’ (because no word has ‘fo’ as a prefix). - %TRUE if @potential_hit is a hit + %TRUE if @potential_hit is a hit - the search term from the user + the search term from the user - the text that may be a hit + the text that may be a hit - %TRUE to accept ASCII alternates + %TRUE to accept ASCII alternates - Transliterate @str to plain ASCII. + Transliterate @str to plain ASCII. For best results, @str should be in composed normalised form. @@ -42474,22 +45888,22 @@ to be done independently of the currently locale, specify `"C"` for @from_locale. - a string in plain ASCII + a string in plain ASCII - a string, in UTF-8 + a string, in UTF-8 - the source locale, if known + the source locale, if known - Tokenises @string and performs folding on each token. + Tokenises @string and performs folding on each token. A token is a non-empty sequence of alphanumeric characters in the source string, separated by non-alphanumeric characters. An @@ -42506,23 +45920,23 @@ improve the transliteration if the language of the source string is known. - the folded tokens + the folded tokens - a string + a string - the language code (like 'de' or + the language code (like 'de' or 'en_GB') from which @string originates - a + a return location for ASCII alternates @@ -42531,57 +45945,64 @@ known. - For each character in @string, if the character is not in @valid_chars, + For each character in @string, if the character is not in @valid_chars, replaces the character with @substitutor. Modifies @string in place, and return @string itself, not a copy. The return value is to allow nesting such as |[<!-- language="C" --> g_ascii_strup (g_strcanon (str, "abc", '?')) +]| + +In order to modify a copy, you may use `g_strdup()`: +|[<!-- language="C" --> + reformatted = g_strcanon (g_strdup (const_str), "abc", '?'); + ... + g_free (reformatted); ]| - @string + @string - a nul-terminated array of bytes + a nul-terminated array of bytes - bytes permitted in @string + bytes permitted in @string - replacement character for disallowed bytes + replacement character for disallowed bytes - A case-insensitive string comparison, corresponding to the standard + A case-insensitive string comparison, corresponding to the standard strcasecmp() function on platforms which support it. See g_strncasecmp() for a discussion of why this function is deprecated and how to replace it. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - a string + a string - a string to compare with @s1 + a string to compare with @s1 - Removes trailing whitespace from a string. + Removes trailing whitespace from a string. This function doesn't allocate or reallocate any memory; it modifies @string in place. Therefore, it cannot be used @@ -42592,18 +46013,18 @@ The pointer to @string is returned to allow the nesting of functions. Also see g_strchug() and g_strstrip(). - @string + @string - a string to remove the trailing whitespace from + a string to remove the trailing whitespace from - Removes leading whitespace from a string, by moving the rest + Removes leading whitespace from a string, by moving the rest of the characters forward. This function doesn't allocate or reallocate any memory; @@ -42615,55 +46036,55 @@ The pointer to @string is returned to allow the nesting of functions. Also see g_strchomp() and g_strstrip(). - @string + @string - a string to remove the leading whitespace from + a string to remove the leading whitespace from - Compares @str1 and @str2 like strcmp(). Handles %NULL + Compares @str1 and @str2 like strcmp(). Handles %NULL gracefully by sorting it before non-%NULL strings. Comparing two %NULL pointers returns 0. - + - an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2. + an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2. - a C string or %NULL + a C string or %NULL - another C string or %NULL + another C string or %NULL - Replaces all escaped characters with their one byte equivalent. + Replaces all escaped characters with their one byte equivalent. This function does the reverse conversion of g_strescape(). - a newly-allocated copy of @source with all escaped + a newly-allocated copy of @source with all escaped character compressed - a string to compress + a string to compress - Concatenates all of the given strings into one long string. The + Concatenates all of the given strings into one long string. The returned string should be freed with g_free() when no longer needed. The variable argument list must end with %NULL. If you forget the %NULL, @@ -42674,107 +46095,114 @@ assemble a translated message from pieces, since proper translation often requires the pieces to be reordered. - a newly-allocated string containing all the string arguments + a newly-allocated string containing all the string arguments - the first string to add, which must not be %NULL + the first string to add, which must not be %NULL - a %NULL-terminated list of strings to append to the string + a %NULL-terminated list of strings to append to the string - Converts any delimiter characters in @string to @new_delimiter. + Converts any delimiter characters in @string to @new_delimiter. Any characters in @string which are found in @delimiters are changed to the @new_delimiter character. Modifies @string in place, and returns @string itself, not a copy. The return value is to allow nesting such as |[<!-- language="C" --> g_ascii_strup (g_strdelimit (str, "abc", '?')) +]| + +In order to modify a copy, you may use `g_strdup()`: +|[<!-- language="C" --> + reformatted = g_strdelimit (g_strdup (const_str), "abc", '?'); + ... + g_free (reformatted); ]| - @string + @string - the string to convert + the string to convert - a string containing the current delimiters, + a string containing the current delimiters, or %NULL to use the standard delimiters defined in #G_STR_DELIMITERS - the new delimiter character + the new delimiter character - Converts a string to lower case. + Converts a string to lower case. This function is totally broken for the reasons discussed in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown() instead. - the string + the string - the string to convert. + the string to convert. - Duplicates a string. If @str is %NULL it returns %NULL. + Duplicates a string. If @str is %NULL it returns %NULL. The returned string should be freed with g_free() when no longer needed. - a newly-allocated copy of @str + a newly-allocated copy of @str - the string to duplicate + the string to duplicate - Similar to the standard C sprintf() function but safer, since it + Similar to the standard C sprintf() function but safer, since it calculates the maximum space required and allocates memory to hold the result. The returned string should be freed with g_free() when no longer needed. - a newly-allocated string holding the result + a newly-allocated string holding the result - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the parameters to insert into the format string + the parameters to insert into the format string - Similar to the standard C vsprintf() function but safer, since it + Similar to the standard C vsprintf() function but safer, since it calculates the maximum space required and allocates memory to hold the result. The returned string should be freed with g_free() when no longer needed. @@ -42783,42 +46211,42 @@ See also g_vasprintf(), which offers the same functionality, but additionally returns the length of the allocated string. - a newly-allocated string holding the result + a newly-allocated string holding the result - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of parameters to insert into the format string + the list of parameters to insert into the format string - Copies %NULL-terminated array of strings. The copy is a deep copy; + Copies %NULL-terminated array of strings. The copy is a deep copy; the new array should be freed by first freeing each string, then the array itself. g_strfreev() does this for you. If called on a %NULL value, g_strdupv() simply returns %NULL. - a new %NULL-terminated array of strings. + a new %NULL-terminated array of strings. - a %NULL-terminated array of strings + a %NULL-terminated array of strings - Returns a string corresponding to the given error code, e.g. "no + Returns a string corresponding to the given error code, e.g. "no such process". Unlike strerror(), this always returns a string in UTF-8 encoding, and the pointer is guaranteed to remain valid for the lifetime of the process. @@ -42838,20 +46266,20 @@ as soon as the call returns: ]| - a UTF-8 string describing the error code. If the error code + a UTF-8 string describing the error code. If the error code is unknown, it returns a string like "unknown error (<code>)". - the system error number. See the standard C %errno + the system error number. See the standard C %errno documentation - Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\' + Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\' and '"' in the string @source by inserting a '\' before them. Additionally all characters in the range 0x01-0x1F (everything below SPACE) and in the range 0x7F-0xFF (all non-ASCII chars) are @@ -42861,23 +46289,23 @@ Characters supplied in @exceptions are not escaped. g_strcompress() does the reverse conversion. - a newly-allocated copy of @source with certain + a newly-allocated copy of @source with certain characters escaped. See above. - a string to escape + a string to escape - a string of characters not to escape in @source + a string of characters not to escape in @source - Frees a %NULL-terminated array of strings, as well as each + Frees a %NULL-terminated array of strings, as well as each string it contains. If @str_array is %NULL, this function simply returns. @@ -42887,28 +46315,28 @@ If @str_array is %NULL, this function simply returns. - a %NULL-terminated array of strings to free + a %NULL-terminated array of strings to free - Creates a new #GString, initialized with the given string. + Creates a new #GString, initialized with the given string. - the new #GString + the new #GString - the initial text to copy into the string, or %NULL to + the initial text to copy into the string, or %NULL to start with an empty string - Creates a new #GString with @len bytes of the @init buffer. + Creates a new #GString with @len bytes of the @init buffer. Because a length is provided, @init need not be nul-terminated, and can contain embedded nul bytes. @@ -42917,82 +46345,82 @@ responsibility to ensure that @init has at least @len addressable bytes. - a new #GString + a new #GString - initial contents of the string + initial contents of the string - length of @init to use + length of @init to use - Creates a new #GString, with enough space for @dfl_size + Creates a new #GString, with enough space for @dfl_size bytes. This is useful if you are going to add a lot of text to the string and don't want it to be reallocated too often. - the new #GString + the new #GString - the default size of the space allocated to + the default size of the space allocated to hold the string - An auxiliary function for gettext() support (see Q_()). + An auxiliary function for gettext() support (see Q_()). - @msgval, unless @msgval is identical to @msgid + @msgval, unless @msgval is identical to @msgid and contains a '|' character, in which case a pointer to the substring of msgid after the first '|' character is returned. - a string + a string - another string + another string - Joins a number of strings together to form one long string, with the + 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(). - a newly-allocated string containing all of the strings joined + a newly-allocated string containing all of the strings joined together, with @separator between them - a string to insert between each of the + a string to insert between each of the strings, or %NULL - a %NULL-terminated list of strings to join + a %NULL-terminated list of strings to join - Joins a number of strings together to form one long string, with the + 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(). @@ -43001,24 +46429,24 @@ empty string. If @str_array contains a single item, @separator will not appear in the resulting string. - a newly-allocated string containing all of the strings joined + a newly-allocated string containing all of the strings joined together, with @separator between them - a string to insert between each of the + a string to insert between each of the strings, or %NULL - a %NULL-terminated array of strings to join + a %NULL-terminated array of strings to join - Portability wrapper that calls strlcat() on systems which have it, + Portability wrapper that calls strlcat() on systems which have it, and emulates it otherwise. Appends nul-terminated @src string to @dest, guaranteeing nul-termination for @dest. The total size of @dest won't exceed @dest_size. @@ -43033,29 +46461,29 @@ Caveat: this is supposedly a more secure alternative to strcat() or strncat(), but for real security g_strconcat() is harder to mess up. - size of attempted result, which is MIN (dest_size, strlen + size of attempted result, which is MIN (dest_size, strlen (original dest)) + strlen (src), so if retval >= dest_size, truncation occurred. - destination buffer, already containing one nul-terminated string + destination buffer, already containing one nul-terminated string - source buffer + source buffer - length of @dest buffer in bytes (not length of existing string + length of @dest buffer in bytes (not length of existing string inside @dest) - Portability wrapper that calls strlcpy() on systems which have it, + Portability wrapper that calls strlcpy() on systems which have it, and emulates strlcpy() otherwise. Copies @src to @dest; @dest is guaranteed to be nul-terminated; @src must be nul-terminated; @dest_size is the buffer size, not the number of bytes to copy. @@ -43071,26 +46499,26 @@ but if you really want to avoid screwups, g_strdup() is an even better idea. - length of @src + length of @src - destination buffer + destination buffer - source buffer + source buffer - length of @dest in bytes + length of @dest in bytes - A case-insensitive string comparison, corresponding to the standard + A case-insensitive string comparison, corresponding to the standard strncasecmp() function on platforms which support it. It is similar to g_strcasecmp() except it only compares the first @n characters of the strings. @@ -43110,27 +46538,27 @@ the strings. which is good for case-insensitive sorting of UTF-8. - 0 if the strings match, a negative value if @s1 < @s2, + 0 if the strings match, a negative value if @s1 < @s2, or a positive value if @s1 > @s2. - a string + a string - a string to compare with @s1 + a string to compare with @s1 - the maximum number of characters to compare + the maximum number of characters to compare - Duplicates the first @n bytes of a string, returning a newly-allocated + Duplicates the first @n bytes of a string, returning a newly-allocated buffer @n + 1 bytes long which will always be nul-terminated. If @str is less than @n bytes long the buffer is padded with nuls. If @str is %NULL it returns %NULL. The returned value should be freed when no longer @@ -43140,42 +46568,42 @@ To copy a number of characters from a UTF-8 encoded string, use g_utf8_strncpy() instead. - a newly-allocated buffer containing the first @n bytes + a newly-allocated buffer containing the first @n bytes of @str, nul-terminated - the string to duplicate + the string to duplicate - the maximum number of bytes to copy from @str + the maximum number of bytes to copy from @str - Creates a new string @length bytes long filled with @fill_char. + Creates a new string @length bytes long filled with @fill_char. The returned string should be freed when no longer needed. - a newly-allocated string filled the @fill_char + a newly-allocated string filled the @fill_char - the length of the new string + the length of the new string - the byte to fill the string with + the byte to fill the string with - Reverses all of the bytes in a string. For example, + Reverses all of the bytes in a string. For example, `g_strreverse ("abcdef")` will result in "fedcba". Note that g_strreverse() doesn't work on UTF-8 strings @@ -43183,81 +46611,81 @@ containing multibyte characters. For that purpose, use g_utf8_strreverse(). - the same pointer passed in as @string + the same pointer passed in as @string - the string to reverse + the string to reverse - Searches the string @haystack for the last occurrence + Searches the string @haystack for the last occurrence of the string @needle. - a pointer to the found occurrence, or + a pointer to the found occurrence, or %NULL if not found. - a nul-terminated string + a nul-terminated string - the nul-terminated string to search for + the nul-terminated string to search for - Searches the string @haystack for the last occurrence + Searches the string @haystack for the last occurrence of the string @needle, limiting the length of the search to @haystack_len. - a pointer to the found occurrence, or + a pointer to the found occurrence, or %NULL if not found. - a nul-terminated string + a nul-terminated string - the maximum length of @haystack + the maximum length of @haystack - the nul-terminated string to search for + the nul-terminated string to search for - Returns a string describing the given signal, e.g. "Segmentation fault". + Returns a string describing the given signal, e.g. "Segmentation fault". You should use this function in preference to strsignal(), because it returns a string in UTF-8 encoding, and since not all platforms support the strsignal() function. - a UTF-8 string describing the signal. If the signal is unknown, + a UTF-8 string describing the signal. If the signal is unknown, it returns "unknown signal (<signum>)". - the signal number. See the `signal` documentation + the signal number. See the `signal` documentation - Splits a string into a maximum of @max_tokens pieces, using the given + 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. @@ -43273,7 +46701,7 @@ to represent empty elements, you'll need to check for the empty string before calling g_strsplit(). - a newly-allocated %NULL-terminated array of strings. Use + a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -43281,24 +46709,24 @@ before calling g_strsplit(). - a string to split + a string to split - a string which specifies the places at which to split + a string which specifies the places at which to split the string. The delimiter is not included in any of the resulting strings, unless @max_tokens is reached. - the maximum number of pieces to split @string into. + the maximum number of pieces to split @string into. If this is less than 1, the string is split completely. - Splits @string into a number of tokens not containing any of the characters + Splits @string into a number of tokens not containing any of the characters in @delimiter. A token is the (possibly empty) longest string that does not contain any of the characters in @delimiters. If @max_tokens is reached, the remainder is appended to the last token. @@ -43321,7 +46749,7 @@ Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters. - a newly-allocated %NULL-terminated array of strings. Use + a newly-allocated %NULL-terminated array of strings. Use g_strfreev() to free it. @@ -43329,50 +46757,60 @@ to delimit UTF-8 strings for anything but ASCII characters. - The string to be tokenized + The string to be tokenized - A nul-terminated string containing bytes that are used + A nul-terminated string containing bytes that are used to split the string. - The maximum number of tokens to split @string into. + The maximum number of tokens to split @string into. If this is less than 1, the string is split completely - Searches the string @haystack for the first occurrence + Searches the string @haystack for the first occurrence of the string @needle, limiting the length of the search to @haystack_len. - a pointer to the found occurrence, or + a pointer to the found occurrence, or %NULL if not found. - a string + a string - the maximum length of @haystack. Note that -1 is + the maximum length of @haystack. Note that -1 is a valid length, if @haystack is nul-terminated, meaning it will search through the whole string. - the string to search for + the string to search for + + Removes leading and trailing whitespace from a string. +See g_strchomp() and g_strchug(). + + + + a string to remove the leading and trailing whitespace from + + + - Converts a string to a #gdouble value. + Converts a string to a #gdouble value. It calls the standard strtod() function to handle the conversion, but if the string is not completely converted it attempts the conversion again with g_ascii_strtod(), and returns the best match. @@ -43385,58 +46823,58 @@ separated lists of values, since the commas may be interpreted as a decimal point in some locales, causing unexpected results. - the #gdouble value. + the #gdouble value. - the string to convert to a numeric value. + the string to convert to a numeric value. - if non-%NULL, it returns the + if non-%NULL, it returns the character after the last character used in the conversion. - Converts a string to upper case. + Converts a string to upper case. This function is totally broken for the reasons discussed in the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead. - the string + the string - the string to convert + the string to convert - Checks if @strv contains @str. @strv must not be %NULL. + Checks if @strv contains @str. @strv must not be %NULL. - %TRUE if @str is an element of @strv, according to g_str_equal(). + %TRUE if @str is an element of @strv, according to g_str_equal(). - a %NULL-terminated array of strings + a %NULL-terminated array of strings - a string + a string - Checks if @strv1 and @strv2 contain exactly the same elements in exactly the + Checks if @strv1 and @strv2 contain exactly the same elements in exactly the same order. Elements are compared using g_str_equal(). To match independently of order, sort the arrays first (using g_qsort_with_data() or similar). @@ -43444,16 +46882,16 @@ Two empty arrays are considered equal. Neither @strv1 not @strv2 may be %NULL. - %TRUE if @strv1 and @strv2 are equal + %TRUE if @strv1 and @strv2 are equal - a %NULL-terminated array of strings + a %NULL-terminated array of strings - another %NULL-terminated array of strings + another %NULL-terminated array of strings @@ -43465,22 +46903,52 @@ Two empty arrays are considered equal. Neither @strv1 not @strv2 may be - Returns the length of the given %NULL-terminated + Returns the length of the given %NULL-terminated string array @str_array. @str_array must not be %NULL. - length of @str_array. + length of @str_array. - a %NULL-terminated array of strings + a %NULL-terminated array of strings + + Hook up a new test case at @testpath, similar to g_test_add_func(). +A fixture data structure with setup and teardown functions may be provided, +similar to g_test_create_case(). + +g_test_add() is implemented as a macro, so that the fsetup(), ftest() and +fteardown() callbacks can expect a @Fixture pointer as their first argument +in a type safe manner. They otherwise have type #GTestFixtureFunc. + + + + The test path for a new test case. + + + The type of a fixture data structure. + + + Data argument for the test functions. + + + The function to set up the fixture data. + + + The actual test function. + + + The function to tear down the fixture data. + + + - Create a new test case, similar to g_test_create_case(). However + Create a new test case, similar to g_test_create_case(). However the test is assumed to use no fixture, and test suites are automatically created on the fly and added to the root fixture, based on the slash-separated portions of @testpath. The @test_data argument @@ -43493,53 +46961,53 @@ required via the `-p` command-line option or g_test_trap_subprocess(). No component of @testpath may start with a dot (`.`) if the %G_TEST_OPTION_ISOLATE_DIRS option is being used; and it is recommended to do so even if it isn’t. - + - /-separated test case path name for the test. + /-separated test case path name for the test. - Test data argument for the test function. + Test data argument for the test function. - The test function to invoke for this test. + The test function to invoke for this test. - Create a new test case, as with g_test_add_data_func(), but freeing + Create a new test case, as with g_test_add_data_func(), but freeing @test_data after the test run is complete. - + - /-separated test case path name for the test. + /-separated test case path name for the test. - Test data argument for the test function. + Test data argument for the test function. - The test function to invoke for this test. + The test function to invoke for this test. - #GDestroyNotify for @test_data. + #GDestroyNotify for @test_data. - Create a new test case, similar to g_test_create_case(). However + Create a new test case, similar to g_test_create_case(). However the test is assumed to use no fixture, and test suites are automatically created on the fly and added to the root fixture, based on the slash-separated portions of @testpath. @@ -43551,23 +47019,23 @@ required via the `-p` command-line option or g_test_trap_subprocess(). No component of @testpath may start with a dot (`.`) if the %G_TEST_OPTION_ISOLATE_DIRS option is being used; and it is recommended to do so even if it isn’t. - + - /-separated test case path name for the test. + /-separated test case path name for the test. - The test function to invoke for this test. + The test function to invoke for this test. - + @@ -43593,7 +47061,7 @@ do so even if it isn’t. - + @@ -43613,23 +47081,25 @@ do so even if it isn’t. - This function adds a message to test reports that + This function adds a message to test reports that associates a bug URI with a test case. Bug URIs are constructed from a base URI set with g_test_bug_base() and @bug_uri_snippet. - + +See also: g_test_summary() + - Bug specific bug tracker URI portion. + Bug specific bug tracker URI portion. - Specify the base URI for bug reports. + Specify the base URI for bug reports. The base URI is used to construct bug report messages for g_test_message() when g_test_bug() is called. @@ -43640,19 +47110,19 @@ case only. Bug URIs are constructed by appending a bug specific URI portion to @uri_pattern, or by replacing the special string '\%s' within @uri_pattern if that is present. - + - the base pattern for bug URIs + the base pattern for bug URIs - Creates the pathname to a data file that is required for a test. + Creates the pathname to a data file that is required for a test. This function is conceptually similar to g_build_filename() except that the first argument has been replaced with a #GTestFileType @@ -43674,28 +47144,28 @@ This allows for casual running of tests directly from the commandline in the srcdir == builddir case and should also support running of installed tests, assuming the data files have been installed in the same relative path as the test binary. - + - the path of the file, to be freed using g_free() + the path of the file, to be freed using g_free() - the type of file (built vs. distributed) + the type of file (built vs. distributed) - the first segment of the pathname + the first segment of the pathname - %NULL-terminated additional path segments + %NULL-terminated additional path segments - Create a new #GTestCase, named @test_name, this API is fairly + Create a new #GTestCase, named @test_name, this API is fairly low level, calling g_test_add() or g_test_add_func() is preferable. When this test is executed, a fixture structure of size @data_size will be automatically allocated and filled with zeros. Then @data_setup is @@ -43709,54 +47179,54 @@ fixture teardown is most useful if the same fixture is used for multiple tests. In this cases, g_test_create_case() will be called with the same fixture, but varying @test_name and @data_test arguments. - + - a newly allocated #GTestCase. + a newly allocated #GTestCase. - the name for the test case + the name for the test case - the size of the fixture data structure + the size of the fixture data structure - test data argument for the test functions + test data argument for the test functions - the function to set up the fixture data + the function to set up the fixture data - the actual test function + the actual test function - the function to teardown the fixture data + the function to teardown the fixture data - Create a new test suite with the name @suite_name. - + Create a new test suite with the name @suite_name. + - A newly allocated #GTestSuite instance. + A newly allocated #GTestSuite instance. - a name for the suite + a name for the suite - Indicates that a message with the given @log_domain and @log_level, + Indicates that a message with the given @log_domain and @log_level, 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. @@ -43790,27 +47260,27 @@ abort; use g_test_trap_subprocess() in this case. If messages at %G_LOG_LEVEL_DEBUG are emitted, but not explicitly expected via g_test_expect_message() then they will be ignored. - + - the log domain of the message + the log domain of the message - the log level of the message + the log level of the message - a glob-style [pattern][glib-Glob-style-pattern-matching] + a glob-style [pattern][glib-Glob-style-pattern-matching] - Indicates that a test failed. This function can be called + Indicates that a test failed. This function can be called multiple times from the same test. You can use this function if your test failed in a recoverable way. @@ -43823,13 +47293,13 @@ produce additional diagnostic messages or even continue running the test. If not called from inside a test, this function does nothing. - + - Returns whether a test has already failed. This will + Returns whether a test has already failed. This will be the case when g_test_fail(), g_test_incomplete() or g_test_skip() have been called, but also if an assertion has failed. @@ -43839,32 +47309,32 @@ continuing after a failed assertion might be harmful. The return value of this function is only meaningful if it is called from inside a test function. - + - %TRUE if the test has failed + %TRUE if the test has failed - Gets the pathname of the directory containing test files of the type + Gets the pathname of the directory containing test files of the type specified by @file_type. This is approximately the same as calling g_test_build_filename("."), but you don't need to free the return value. - + - the path of the directory, owned by GLib + the path of the directory, owned by GLib - the type of file (built vs. distributed) + the type of file (built vs. distributed) - Gets the pathname to a data file that is required for a test. + Gets the pathname to a data file that is required for a test. This is the same as g_test_build_filename() with two differences. The first difference is that must only use this function from within @@ -43876,36 +47346,36 @@ It is safe to use this function from a thread inside of a testcase but you must ensure that all such uses occur before the main testcase function returns (ie: it is best to ensure that all threads have been joined). - + - the path, automatically freed at the end of the testcase + the path, automatically freed at the end of the testcase - the type of file (built vs. distributed) + the type of file (built vs. distributed) - the first segment of the pathname + the first segment of the pathname - %NULL-terminated additional path segments + %NULL-terminated additional path segments - Get the toplevel test suite for the test path API. - + Get the toplevel test suite for the test path API. + - the toplevel #GTestSuite + the toplevel #GTestSuite - Indicates that a test failed because of some incomplete + Indicates that a test failed because of some incomplete functionality. This function can be called multiple times from the same test. @@ -43915,19 +47385,19 @@ produce additional diagnostic messages or even continue running the test. If not called from inside a test, this function does nothing. - + - explanation + explanation - Initialize the GLib testing framework, e.g. by seeding the + Initialize the GLib testing framework, e.g. by seeding the test random number generator, the name for g_get_prgname() and parsing test related command line args. @@ -43972,29 +47442,29 @@ g_test_init() will print an error and exit. This is to prevent no-op tests from being executed, as g_assert() is commonly (erroneously) used in unit tests, and is a no-op when compiled with `G_DISABLE_ASSERT`. Ensure your tests are compiled without `G_DISABLE_ASSERT` defined. - + - Address of the @argc parameter of the main() function. + Address of the @argc parameter of the main() function. Changed if any arguments were handled. - Address of the @argv parameter of main(). + Address of the @argv parameter of main(). Any parameters understood by g_test_init() stripped before return. - %NULL-terminated list of special options, documented below. + %NULL-terminated list of special options, documented below. - Installs a non-error fatal log handler which can be + Installs a non-error fatal log handler which can be used to decide whether log messages which are counted as fatal abort the program. @@ -44015,23 +47485,23 @@ 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]. - + - the log handler function. + the log handler function. - data passed to the log handler. + data passed to the log handler. - + @@ -44042,139 +47512,150 @@ writer function using g_log_set_writer_func().See - Report the result of a performance or measurement test. + Report the result of a performance or measurement test. The test should generally strive to maximize the reported quantities (larger values are better than smaller ones), this and @maximized_quantity can determine sorting order for test result reports. - + - the reported value + the reported value - the format string of the report message + the format string of the report message - arguments to pass to the printf() function + arguments to pass to the printf() function - Add a message to the test report. - + Add a message to the test report. + - the format string + the format string - printf-like arguments to @format + printf-like arguments to @format - Report the result of a performance or measurement test. + Report the result of a performance or measurement test. The test should generally strive to minimize the reported quantities (smaller values are better than larger ones), this and @minimized_quantity can determine sorting order for test result reports. - + - the reported value + the reported value - the format string of the report message + the format string of the report message - arguments to pass to the printf() function + arguments to pass to the printf() function - This function enqueus a callback @destroy_func to be executed + This function enqueus a callback @destroy_func to be executed during the next test case teardown phase. This is most useful to auto destruct allocated test resources at the end of a test run. Resources are released in reverse queue order, that means enqueueing callback A before callback B will cause B() to be called before A() during teardown. - + - Destroy callback for teardown phase. + Destroy callback for teardown phase. - Destroy callback data. + Destroy callback data. - Enqueue a pointer to be released with g_free() during the next + Enqueue a pointer to be released with g_free() during the next teardown phase. This is equivalent to calling g_test_queue_destroy() with a destroy callback of g_free(). - + - the pointer to be stored. + the pointer to be stored. + + Enqueue an object to be released with g_object_unref() during +the next teardown phase. This is equivalent to calling +g_test_queue_destroy() with a destroy callback of g_object_unref(). + + + + the object to unref + + + - Get a reproducible random floating point number, + Get a reproducible random floating point number, see g_test_rand_int() for details on test case random numbers. - + - a random number from the seeded random number generator. + a random number from the seeded random number generator. - Get a reproducible random floating pointer number out of a specified range, + Get a reproducible random floating pointer number out of a specified range, see g_test_rand_int() for details on test case random numbers. - + - a number with @range_start <= number < @range_end. + a number with @range_start <= number < @range_end. - the minimum value returned by this function + the minimum value returned by this function - the minimum value not returned by this function + the minimum value not returned by this function - Get a reproducible random integer number. + Get a reproducible random integer number. The random numbers generated by the g_test_rand_*() family of functions change with every new test program start, unless the --seed option is @@ -44183,33 +47664,33 @@ given when starting test programs. For individual test cases however, the random number generator is reseeded, to avoid dependencies between tests and to make --seed effective for all test cases. - + - a random number from the seeded random number generator. + a random number from the seeded random number generator. - Get a reproducible random integer number out of a specified range, + Get a reproducible random integer number out of a specified range, see g_test_rand_int() for details on test case random numbers. - + - a number with @begin <= number < @end. + a number with @begin <= number < @end. - the minimum value returned by this function + the minimum value returned by this function - the smallest value not to be returned by this function + the smallest value not to be returned by this function - Runs all tests under the toplevel suite which can be retrieved + Runs all tests under the toplevel suite which can be retrieved with g_test_get_root(). Similar to g_test_run_suite(), the test cases to be run are filtered according to test path arguments (`-p testpath` and `-s testpath`) as parsed by g_test_init(). @@ -44241,16 +47722,16 @@ g_test_add(), which lets you specify setup and teardown functions. If all tests are skipped or marked as incomplete (expected failures), this function will return 0 if producing TAP output, or 77 (treated as "skip test" by Automake) otherwise. - + - 0 on success, 1 on failure (assuming it returns at all), + 0 on success, 1 on failure (assuming it returns at all), 0 or 77 if all tests were skipped with g_test_skip() and/or g_test_incomplete() - Execute the tests within @suite and all nested #GTestSuites. + Execute the tests within @suite and all nested #GTestSuites. The test suites to be executed are filtered according to test path arguments (`-p testpath` and `-s testpath`) as parsed by g_test_init(). See the g_test_run() documentation for more @@ -44258,20 +47739,20 @@ information on the order that tests are run in. g_test_run_suite() or g_test_run() may only be called once in a program. - + - 0 on success + 0 on success - a #GTestSuite + a #GTestSuite - Changes the behaviour of g_assert_cmpstr(), g_assert_cmpint(), + Changes the behaviour of g_assert_cmpstr(), g_assert_cmpint(), g_assert_cmpuint(), g_assert_cmphex(), g_assert_cmpfloat(), g_assert_true(), g_assert_false(), g_assert_null(), g_assert_no_error(), g_assert_error(), g_test_assert_expected_messages() and the various @@ -44284,13 +47765,13 @@ Note that the g_assert_not_reached() and g_assert() are not affected by this. This function can only be called after g_test_init(). - + - Indicates that a test was skipped. + Indicates that a test was skipped. Calling this function will not stop the test from running, you need to return from the test function yourself. So you can @@ -44298,53 +47779,133 @@ produce additional diagnostic messages or even continue running the test. If not called from inside a test, this function does nothing. - + - explanation + explanation - Returns %TRUE (after g_test_init() has been called) if the test + Returns %TRUE (after g_test_init() has been called) if the test program is running under g_test_trap_subprocess(). - + - %TRUE if the test program is running under + %TRUE if the test program is running under g_test_trap_subprocess(). - - Get the time since the last start of the timer with g_test_timer_start(). - + + Set the summary for a test, which describes what the test checks, and how it +goes about checking it. This may be included in test report output, and is +useful documentation for anyone reading the source code or modifying a test +in future. It must be a single line. + +This should be called at the top of a test function. + +For example: +|[<!-- language="C" --> +static void +test_array_sort (void) +{ + g_test_summary ("Test my_array_sort() sorts the array correctly and stably, " + "including testing zero length and one-element arrays."); + + … +} +]| + +See also: g_test_bug() + - the time since the last start of the timer, as a double + + + + + One or two sentences summarising what the test checks, and how it + checks it. + + + + + + Get the time since the last start of the timer with g_test_timer_start(). + + + the time since the last start of the timer, as a double - Report the last result of g_test_timer_elapsed(). - + Report the last result of g_test_timer_elapsed(). + - the last result of g_test_timer_elapsed(), as a double + the last result of g_test_timer_elapsed(), as a double - Start a timing test. Call g_test_timer_elapsed() when the task is supposed + Start a timing test. Call g_test_timer_elapsed() when the task is supposed to be done. Call this function again to restart the timer. - + + + Assert that the stderr output of the last test subprocess +matches @serrpattern. See g_test_trap_subprocess(). + +This is sometimes used to test situations that are formally +considered to be undefined behaviour, like code that hits a +g_assert() or g_error(). In these situations you should skip the +entire test, including the call to g_test_trap_subprocess(), unless +g_test_undefined() returns %TRUE to indicate that undefined +behaviour may be tested. + + + + a glob-style [pattern][glib-Glob-style-pattern-matching] + + + + + Assert that the stderr output of the last test subprocess +does not match @serrpattern. See g_test_trap_subprocess(). + + + + a glob-style [pattern][glib-Glob-style-pattern-matching] + + + + + Assert that the stdout output of the last test subprocess matches +@soutpattern. See g_test_trap_subprocess(). + + + + a glob-style [pattern][glib-Glob-style-pattern-matching] + + + + + Assert that the stdout output of the last test subprocess +does not match @soutpattern. See g_test_trap_subprocess(). + + + + a glob-style [pattern][glib-Glob-style-pattern-matching] + + + - + @@ -44370,7 +47931,7 @@ to be done. Call this function again to restart the timer. - Fork the current test program to execute a test case that might + Fork the current test program to execute a test case that might not return or that might abort. If @usec_timeout is non-0, the forked test case is aborted and @@ -44401,40 +47962,40 @@ termination and validates child program outputs. This function is implemented only on Unix platforms, and is not always reliable due to problems inherent in fork-without-exec. Use g_test_trap_subprocess() instead. - + - %TRUE for the forked child and %FALSE for the executing parent process. + %TRUE for the forked child and %FALSE for the executing parent process. - Timeout for the forked test in micro seconds. + Timeout for the forked test in micro seconds. - Flags to modify forking behaviour. + Flags to modify forking behaviour. - Check the result of the last g_test_trap_subprocess() call. - + Check the result of the last g_test_trap_subprocess() call. + - %TRUE if the last test subprocess terminated successfully. + %TRUE if the last test subprocess terminated successfully. - Check the result of the last g_test_trap_subprocess() call. - + Check the result of the last g_test_trap_subprocess() call. + - %TRUE if the last test subprocess got killed due to a timeout. + %TRUE if the last test subprocess got killed due to a timeout. - Respawns the test program to run only @test_path in a subprocess. + Respawns the test program to run only @test_path in a subprocess. This can be used for a test case that might not return, or that might abort. @@ -44495,21 +48056,21 @@ message. return g_test_run (); } ]| - + - Test to run in a subprocess + Test to run in a subprocess - Timeout for the subprocess test in micro seconds. + Timeout for the subprocess test in micro seconds. - Flags to modify subprocess behaviour. + Flags to modify subprocess behaviour. @@ -44520,7 +48081,7 @@ message. - Terminates the current thread. + Terminates the current thread. If another thread is waiting for us using g_thread_join() then the waiting thread will be woken up and get @retval as the return value @@ -44539,13 +48100,13 @@ or or from within a #GThreadPool. - the return value of this thread + the return value of this thread - This function will return the maximum @interval that a + This function will return the maximum @interval that a thread will wait in the thread pool for new tasks before being stopped. @@ -44553,30 +48114,30 @@ If this function returns 0, threads waiting in the thread pool for new work are not stopped. - the maximum @interval (milliseconds) to wait + the maximum @interval (milliseconds) to wait for new tasks in the thread pool before stopping the thread - Returns the maximal allowed number of unused threads. + Returns the maximal allowed number of unused threads. - the maximal number of unused threads + the maximal number of unused threads - Returns the number of currently unused threads. + Returns the number of currently unused threads. - the number of currently unused threads + the number of currently unused threads - This function will set the maximum @interval that a thread + This function will set the maximum @interval that a thread waiting in the pool for new tasks can be idle for before being stopped. This function is similar to calling g_thread_pool_stop_unused_threads() on a regular timeout, @@ -44591,14 +48152,14 @@ The default value is 15000 (15 seconds). - the maximum @interval (in milliseconds) + the maximum @interval (in milliseconds) a thread can be idle - Sets the maximal number of unused threads to @max_threads. + Sets the maximal number of unused threads to @max_threads. If @max_threads is -1, no limit is imposed on the number of unused threads. @@ -44609,13 +48170,13 @@ The default value is 2. - maximal number of unused threads + maximal number of unused threads - Stops all currently unused threads. This does not change the + Stops all currently unused threads. This does not change the maximal number of unused threads. This function can be used to regularly stop all unused threads e.g. from g_timeout_add(). @@ -44624,7 +48185,7 @@ regularly stop all unused threads e.g. from g_timeout_add(). - This function returns the #GThread corresponding to the + This function returns the #GThread corresponding to the current thread. Note that this function does not increase the reference count of the returned struct. @@ -44635,12 +48196,12 @@ APIs). This may be useful for thread identification purposes as g_thread_join()) on these threads. - the #GThread representing the current thread + the #GThread representing the current thread - Causes the calling thread to voluntarily relinquish the CPU, so + Causes the calling thread to voluntarily relinquish the CPU, so that other threads can run. This function is often used as a method to make busy wait less evil. @@ -44649,8 +48210,8 @@ This function is often used as a method to make busy wait less evil. - - Converts a string containing an ISO 8601 encoded date and time + + Converts a string containing an ISO 8601 encoded date and time to a #GTimeVal and puts it into @time_. @iso_date must include year, month, day, hours, minutes, and @@ -44658,25 +48219,35 @@ seconds. It can optionally include fractions of a second and a time zone indicator. (In the absence of any time zone indication, the timestamp is assumed to be in local time.) -Any leading or trailing space in @iso_date is ignored. - +Any leading or trailing space in @iso_date is ignored. + +This function was deprecated, along with #GTimeVal itself, in GLib 2.62. +Equivalent functionality is available using code like: +|[ +GDateTime *dt = g_date_time_new_from_iso8601 (iso8601_string, NULL); +gint64 time_val = g_date_time_to_unix (dt); +g_date_time_unref (dt); +]| + #GTimeVal is not year-2038-safe. Use + g_date_time_new_from_iso8601() instead. + - %TRUE if the conversion was successful. + %TRUE if the conversion was successful. - an ISO 8601 encoded date string + an ISO 8601 encoded date string - a #GTimeVal + a #GTimeVal - Sets a function to be called at regular intervals, with the default + Sets a function to be called at regular intervals, with the default priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until it returns %FALSE, at which point the timeout is automatically destroyed and the function will not be called again. The first call @@ -44704,29 +48275,29 @@ use a custom main context. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the time between calls to the function, in milliseconds + the time between calls to the function, in milliseconds (1/1000ths of a second) - function to call + function to call - data to pass to @function + data to pass to @function - Sets a function to be called at regular intervals, with the given + Sets a function to be called at regular intervals, with the given priority. The function is called repeatedly until it returns %FALSE, at which point the timeout is automatically destroyed and the function will not be called again. The @notify function is @@ -44750,38 +48321,38 @@ use a custom main context. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the timeout source. Typically this will be in + the priority of the timeout source. Typically this will be in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. - the time between calls to the function, in milliseconds + the time between calls to the function, in milliseconds (1/1000ths of a second) - function to call + function to call - data to pass to @function + data to pass to @function - function to call when the timeout is removed, or %NULL + function to call when the timeout is removed, or %NULL - Sets a function to be called at regular intervals with the default + Sets a function to be called at regular intervals with the default priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until it returns %FALSE, at which point the timeout is automatically destroyed and the function will not be called again. @@ -44800,28 +48371,28 @@ on how to handle the return value and memory management of @data. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the time between calls to the function, in seconds + the time between calls to the function, in seconds - function to call + function to call - data to pass to @function + data to pass to @function - Sets a function to be called at regular intervals, with @priority. + Sets a function to be called at regular intervals, with @priority. The function is called repeatedly until it returns %FALSE, at which point the timeout is automatically destroyed and the function will not be called again. @@ -44857,37 +48428,37 @@ greater control. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the ID (greater than 0) of the event source. + the ID (greater than 0) of the event source. - the priority of the timeout source. Typically this will be in + the priority of the timeout source. Typically this will be in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. - the time between calls to the function, in seconds + the time between calls to the function, in seconds - function to call + function to call - data to pass to @function + data to pass to @function - function to call when the timeout is removed, or %NULL + function to call when the timeout is removed, or %NULL - Creates a new timeout source. + Creates a new timeout source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be @@ -44895,20 +48466,20 @@ executed. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the newly-created timeout source + the newly-created timeout source - the timeout interval in milliseconds. + the timeout interval in milliseconds. - Creates a new timeout source. + Creates a new timeout source. The source will not initially be associated with any #GMainContext and must be added to one with g_source_attach() before it will be @@ -44919,226 +48490,276 @@ in seconds. The interval given is in terms of monotonic time, not wall clock time. See g_get_monotonic_time(). - + - the newly-created timeout source + the newly-created timeout source - the timeout interval in seconds + the timeout interval in seconds - Returns the height of a #GTrashStack. + Returns the height of a #GTrashStack. Note that execution of this function is of O(N) complexity where N denotes the number of items on the stack. #GTrashStack is deprecated without replacement - + - the height of the stack + the height of the stack - a #GTrashStack + a #GTrashStack - Returns the element at the top of a #GTrashStack + Returns the element at the top of a #GTrashStack which may be %NULL. #GTrashStack is deprecated without replacement - + - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - Pops a piece of memory off a #GTrashStack. + Pops a piece of memory off a #GTrashStack. #GTrashStack is deprecated without replacement - + - the element at the top of the stack + the element at the top of the stack - a #GTrashStack + a #GTrashStack - Pushes a piece of memory onto a #GTrashStack. + Pushes a piece of memory onto a #GTrashStack. #GTrashStack is deprecated without replacement - + - a #GTrashStack + a #GTrashStack - the piece of memory to push on the stack + the piece of memory to push on the stack - Attempts to allocate @n_bytes, and returns %NULL on failure. + Attempts to allocate @n_bytes, and returns %NULL on failure. Contrast with g_malloc(), which aborts the program on failure. - the allocated memory, or %NULL. + the allocated memory, or %NULL. - number of bytes to allocate. + number of bytes to allocate. - Attempts to allocate @n_bytes, initialized to 0's, and returns %NULL on + Attempts to allocate @n_bytes, initialized to 0's, and returns %NULL on failure. Contrast with g_malloc0(), which aborts the program on failure. - the allocated memory, or %NULL + the allocated memory, or %NULL - number of bytes to allocate + number of bytes to allocate - This function is similar to g_try_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_try_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - the allocated memory, or %NULL + the allocated memory, or %NULL - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes - This function is similar to g_try_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_try_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - the allocated memory, or %NULL. + the allocated memory, or %NULL. - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes + + Attempts to allocate @n_structs elements of type @struct_type, and returns +%NULL on failure. Contrast with g_new(), which aborts the program on failure. +The returned pointer is cast to a pointer to the given type. +The function returns %NULL when @n_structs is 0 of if an overflow occurs. + + + + the type of the elements to allocate + + + the number of elements to allocate + + + + + Attempts to allocate @n_structs elements of type @struct_type, initialized +to 0's, and returns %NULL on failure. Contrast with g_new0(), which aborts +the program on failure. +The returned pointer is cast to a pointer to the given type. +The function returns %NULL when @n_structs is 0 or if an overflow occurs. + + + + the type of the elements to allocate + + + the number of elements to allocate + + + - Attempts to realloc @mem to a new size, @n_bytes, and returns %NULL + Attempts to realloc @mem to a new size, @n_bytes, and returns %NULL on failure. Contrast with g_realloc(), which aborts the program on failure. If @mem is %NULL, behaves the same as g_try_malloc(). - the allocated memory, or %NULL. + the allocated memory, or %NULL. - previously-allocated memory, or %NULL. + previously-allocated memory, or %NULL. - number of bytes to allocate. + number of bytes to allocate. - This function is similar to g_try_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, + This function is similar to g_try_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication. - the allocated memory, or %NULL. + the allocated memory, or %NULL. - previously-allocated memory, or %NULL. + previously-allocated memory, or %NULL. - the number of blocks to allocate + the number of blocks to allocate - the size of each block in bytes + the size of each block in bytes + + Attempts to reallocate the memory pointed to by @mem, so that it now has +space for @n_structs elements of type @struct_type, and returns %NULL on +failure. Contrast with g_renew(), which aborts the program on failure. +It returns the new address of the memory, which may have been moved. +The function returns %NULL if an overflow occurs. + + + + the type of the elements to allocate + + + the currently allocated memory + + + the number of elements to allocate + + + - Convert a string from UCS-4 to UTF-16. A 0 character will be + Convert a string from UCS-4 to UTF-16. A 0 character will be added to the result after the converted text. - - - a pointer to a newly allocated UTF-16 string. + + + a pointer to a newly allocated UTF-16 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UCS-4 encoded string + a UCS-4 encoded string - the maximum length (number of characters) of @str to use. + the maximum length (number of characters) of @str to use. If @len < 0, then the string is nul-terminated. - location to store number of + location to store number of bytes read, or %NULL. If an error occurs then the index of the invalid input is stored here. - location to store number + location to store number of #gunichar2 written, or %NULL. The value stored here does not include the trailing 0. @@ -45146,11 +48767,11 @@ added to the result after the converted text. - Convert a string from a 32-bit fixed width representation as UCS-4. + Convert a string from a 32-bit fixed width representation as UCS-4. to UTF-8. The result will be terminated with a 0 byte. - + - a pointer to a newly allocated UTF-8 string. + a pointer to a newly allocated UTF-8 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. In that case, @items_read will be set to the position of the first invalid input character. @@ -45158,62 +48779,142 @@ to UTF-8. The result will be terminated with a 0 byte. - a UCS-4 encoded string + a UCS-4 encoded string - the maximum length (number of characters) of @str to use. + the maximum length (number of characters) of @str to use. If @len < 0, then the string is nul-terminated. - location to store number of + location to store number of characters read, or %NULL. - location to store number + location to store number of bytes written or %NULL. The value here stored does not include the trailing 0 byte. + + Performs a checked addition of @a and @b, storing the result in +@dest. + +If the operation is successful, %TRUE is returned. If the operation +overflows then the state of @dest is undefined and %FALSE is +returned. + + + + a pointer to the #guint64 destination + + + the #guint64 left operand + + + the #guint64 right operand + + + + + Performs a checked multiplication of @a and @b, storing the result in +@dest. + +If the operation is successful, %TRUE is returned. If the operation +overflows then the state of @dest is undefined and %FALSE is +returned. + + + + a pointer to the #guint64 destination + + + the #guint64 left operand + + + the #guint64 right operand + + + + + Performs a checked addition of @a and @b, storing the result in +@dest. + +If the operation is successful, %TRUE is returned. If the operation +overflows then the state of @dest is undefined and %FALSE is +returned. + + + + a pointer to the #guint destination + + + the #guint left operand + + + the #guint right operand + + + + + Performs a checked multiplication of @a and @b, storing the result in +@dest. + +If the operation is successful, %TRUE is returned. If the operation +overflows then the state of @dest is undefined and %FALSE is +returned. + + + + a pointer to the #guint destination + + + the #guint left operand + + + the #guint right operand + + + - Determines the break type of @c. @c should be a Unicode character + Determines the break type of @c. @c should be a Unicode character (to derive a character from UTF-8 encoded text, use g_utf8_get_char()). The break type is used to find word and line breaks ("text boundaries"), Pango implements the Unicode boundary resolution algorithms and normally you would use a function such as pango_break() instead of caring about break types yourself. - + - the break type of @c + the break type of @c - a Unicode character + a Unicode character - Determines the canonical combining class of a Unicode character. - + Determines the canonical combining class of a Unicode character. + - the combining class of the character + the combining class of the character - a Unicode character + a Unicode character - Performs a single composition step of the + Performs a single composition step of the Unicode canonical composition algorithm. This function includes algorithmic Hangul Jamo composition, @@ -45229,28 +48930,28 @@ If @a and @b do not compose a new character, @ch is set to zero. See [UAX#15](http://unicode.org/reports/tr15/) for details. - + - %TRUE if the characters could be composed + %TRUE if the characters could be composed - a Unicode character + a Unicode character - a Unicode character + a Unicode character - - return location for the composed character + + return location for the composed character - Performs a single decomposition step of the + Performs a single decomposition step of the Unicode canonical decomposition algorithm. This function does not include compatibility @@ -45273,44 +48974,44 @@ g_unichar_fully_decompose(). See [UAX#15](http://unicode.org/reports/tr15/) for details. - + - %TRUE if the character could be decomposed + %TRUE if the character could be decomposed - a Unicode character + a Unicode character - - return location for the first component of @ch + + return location for the first component of @ch - - return location for the second component of @ch + + return location for the second component of @ch - Determines the numeric value of a character as a decimal + Determines the numeric value of a character as a decimal digit. - + - If @c is a decimal digit (according to + If @c is a decimal digit (according to g_unichar_isdigit()), its numeric value. Otherwise, -1. - a Unicode character + a Unicode character - Computes the canonical or compatibility decomposition of a + Computes the canonical or compatibility decomposition of a Unicode character. For compatibility decomposition, pass %TRUE for @compat; for canonical decomposition pass %FALSE for @compat. @@ -45329,32 +49030,32 @@ as %G_UNICHAR_MAX_DECOMPOSITION_LENGTH. See [UAX#15](http://unicode.org/reports/tr15/) for details. - + - the length of the full decomposition. + the length of the full decomposition. - a Unicode character. + a Unicode character. - whether perform canonical or compatibility decomposition + whether perform canonical or compatibility decomposition - - location to store decomposed result, or %NULL + + location to store decomposed result, or %NULL - length of @result + length of @result - In Unicode, some characters are "mirrored". This means that their + In Unicode, some characters are "mirrored". This means that their images are mirrored horizontally in text that is laid out from right to left. For instance, "(" would become its mirror image, ")", in right-to-left text. @@ -45363,157 +49064,157 @@ If @ch has the Unicode mirrored property and there is another unicode character that typically has a glyph that is the mirror image of @ch's glyph and @mirrored_ch is set, it puts that character in the address pointed to by @mirrored_ch. Otherwise the original character is put. - + - %TRUE if @ch has a mirrored character, %FALSE otherwise + %TRUE if @ch has a mirrored character, %FALSE otherwise - a Unicode character + a Unicode character - location to store the mirrored character + location to store the mirrored character - Looks up the #GUnicodeScript for a particular character (as defined + Looks up the #GUnicodeScript for a particular character (as defined by Unicode Standard Annex \#24). No check is made for @ch being a valid Unicode character; if you pass in invalid character, the result is undefined. This function is equivalent to pango_script_for_unichar() and the two are interchangeable. - + - the #GUnicodeScript for the character. + the #GUnicodeScript for the character. - a Unicode character + a Unicode character - Determines whether a character is alphanumeric. + Determines whether a character is alphanumeric. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is an alphanumeric character + %TRUE if @c is an alphanumeric character - a Unicode character + a Unicode character - Determines whether a character is alphabetic (i.e. a letter). + Determines whether a character is alphabetic (i.e. a letter). Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is an alphabetic character + %TRUE if @c is an alphabetic character - a Unicode character + a Unicode character - Determines whether a character is a control character. + Determines whether a character is a control character. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a control character + %TRUE if @c is a control character - a Unicode character + a Unicode character - Determines if a given character is assigned in the Unicode + Determines if a given character is assigned in the Unicode standard. - + - %TRUE if the character has an assigned value + %TRUE if the character has an assigned value - a Unicode character + a Unicode character - Determines whether a character is numeric (i.e. a digit). This + Determines whether a character is numeric (i.e. a digit). This covers ASCII 0-9 and also digits in other languages/scripts. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a digit + %TRUE if @c is a digit - a Unicode character + a Unicode character - Determines whether a character is printable and not a space + Determines whether a character is printable and not a space (returns %FALSE for control characters, format characters, and spaces). g_unichar_isprint() is similar, but returns %TRUE for spaces. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is printable unless it's a space + %TRUE if @c is printable unless it's a space - a Unicode character + a Unicode character - Determines whether a character is a lowercase letter. + Determines whether a character is a lowercase letter. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a lowercase letter + %TRUE if @c is a lowercase letter - a Unicode character + a Unicode character - Determines whether a character is a mark (non-spacing mark, + Determines whether a character is a mark (non-spacing mark, combining mark, or enclosing mark in Unicode speak). Given some UTF-8 text, obtain a character value with g_utf8_get_char(). @@ -45522,121 +49223,121 @@ Note: in most cases where isalpha characters are allowed, ismark characters should be allowed to as they are essential for writing most European languages as well as many non-Latin scripts. - + - %TRUE if @c is a mark character + %TRUE if @c is a mark character - a Unicode character + a Unicode character - Determines whether a character is printable. + Determines whether a character is printable. Unlike g_unichar_isgraph(), returns %TRUE for spaces. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is printable + %TRUE if @c is printable - a Unicode character + a Unicode character - Determines whether a character is punctuation or a symbol. + Determines whether a character is punctuation or a symbol. Given some UTF-8 text, obtain a character value with g_utf8_get_char(). - + - %TRUE if @c is a punctuation or symbol character + %TRUE if @c is a punctuation or symbol character - a Unicode character + a Unicode character - Determines whether a character is a space, tab, or line separator + Determines whether a character is a space, tab, or line separator (newline, carriage return, etc.). Given some UTF-8 text, obtain a character value with g_utf8_get_char(). (Note: don't use this to do word breaking; you have to use Pango or equivalent to get word breaking right, the algorithm is fairly complex.) - + - %TRUE if @c is a space character + %TRUE if @c is a space character - a Unicode character + a Unicode character - Determines if a character is titlecase. Some characters in + Determines if a character is titlecase. Some characters in Unicode which are composites, such as the DZ digraph have three case variants instead of just two. The titlecase form is used at the beginning of a word where only the first letter is capitalized. The titlecase form of the DZ digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z. - + - %TRUE if the character is titlecase + %TRUE if the character is titlecase - a Unicode character + a Unicode character - Determines if a character is uppercase. - + Determines if a character is uppercase. + - %TRUE if @c is an uppercase character + %TRUE if @c is an uppercase character - a Unicode character + a Unicode character - Determines if a character is typically rendered in a double-width + Determines if a character is typically rendered in a double-width cell. - + - %TRUE if the character is wide + %TRUE if the character is wide - a Unicode character + a Unicode character - Determines if a character is typically rendered in a double-width + Determines if a character is typically rendered in a double-width cell under legacy East Asian locales. If a character is wide according to g_unichar_iswide(), then it is also reported wide with this function, but the converse is not necessarily true. See the @@ -45646,34 +49347,34 @@ 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 pass both this test and g_unichar_iszerowidth(). - + - %TRUE if the character is wide in legacy East Asian locales + %TRUE if the character is wide in legacy East Asian locales - a Unicode character + a Unicode character - Determines if a character is a hexidecimal digit. - + Determines if a character is a hexidecimal digit. + - %TRUE if the character is a hexadecimal digit + %TRUE if the character is a hexadecimal digit - a Unicode character. + a Unicode character. - Determines if a given character typically takes zero width when rendered. + Determines if a given character typically takes zero width when rendered. The return value is %TRUE for all non-spacing and enclosing marks (e.g., combining accents), format characters, zero-width space, but not U+00AD SOFT HYPHEN. @@ -45682,32 +49383,32 @@ A typical use of this function is with one of g_unichar_iswide() or g_unichar_iswide_cjk() to determine the number of cells a string occupies when displayed on a grid display (terminals). However, note that not all terminals support zero-width rendering of zero-width marks. - + - %TRUE if the character has zero width + %TRUE if the character has zero width - a Unicode character + a Unicode character - Converts a single character to UTF-8. - + Converts a single character to UTF-8. + - number of bytes written + number of bytes written - a Unicode character code + a Unicode character code - output buffer, must have at + output buffer, must have at least 6 bytes of space. If %NULL, the length will be computed and returned and nothing will be written to @outbuf. @@ -45715,142 +49416,142 @@ terminals support zero-width rendering of zero-width marks. - Converts a character to lower case. - + Converts a character to lower case. + - the result of converting @c to lower case. + the result of converting @c to lower case. If @c is not an upperlower or titlecase character, or has no lowercase equivalent @c is returned unchanged. - a Unicode character. + a Unicode character. - Converts a character to the titlecase. - + Converts a character to the titlecase. + - the result of converting @c to titlecase. + the result of converting @c to titlecase. If @c is not an uppercase or lowercase character, @c is returned unchanged. - a Unicode character + a Unicode character - Converts a character to uppercase. - + Converts a character to uppercase. + - the result of converting @c to uppercase. + the result of converting @c to uppercase. If @c is not an lowercase or titlecase character, or has no upper case equivalent @c is returned unchanged. - a Unicode character + a Unicode character - Classifies a Unicode character by type. - + Classifies a Unicode character by type. + - the type of the character. + the type of the character. - a Unicode character + a Unicode character - Checks whether @ch is a valid Unicode character. Some possible + Checks whether @ch is a valid Unicode character. Some possible integer values of @ch will not be valid. 0 is considered a valid character, though it's normally a string terminator. - + - %TRUE if @ch is a valid Unicode character + %TRUE if @ch is a valid Unicode character - a Unicode character + a Unicode character - Determines the numeric value of a character as a hexidecimal + Determines the numeric value of a character as a hexidecimal digit. - + - If @c is a hex digit (according to + If @c is a hex digit (according to g_unichar_isxdigit()), its numeric value. Otherwise, -1. - a Unicode character + a Unicode character - Computes the canonical decomposition of a Unicode character. + Computes the canonical decomposition of a Unicode character. Use the more flexible g_unichar_fully_decompose() instead. - + - a newly allocated string of Unicode characters. + a newly allocated string of Unicode characters. @result_len is set to the resulting length of the string. - a Unicode character. + a Unicode character. - location to store the length of the return value. + location to store the length of the return value. - Computes the canonical ordering of a string in-place. + Computes the canonical ordering of a string in-place. This rearranges decomposed characters in the string according to their combining classes. See the Unicode manual for more information. - + - a UCS-4 encoded string. + a UCS-4 encoded string. - the maximum length of @string to use. + the maximum length of @string to use. - Looks up the Unicode script for @iso15924. ISO 15924 assigns four-letter + Looks up the Unicode script for @iso15924. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is 'Arab'. This function accepts four letter codes encoded as a @guint32 in a big-endian fashion. That is, the code expected for Arabic is @@ -45859,22 +49560,22 @@ big-endian fashion. That is, the code expected for Arabic is See [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) for details. - + - the Unicode script for @iso15924, or + the Unicode script for @iso15924, or of %G_UNICODE_SCRIPT_INVALID_CODE if @iso15924 is zero and %G_UNICODE_SCRIPT_UNKNOWN if @iso15924 is unknown. - a Unicode script + a Unicode script - Looks up the ISO 15924 code for @script. ISO 15924 assigns four-letter + Looks up the ISO 15924 code for @script. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is 'Arab'. The four letter codes are encoded as a @guint32 by this function in a big-endian fashion. That is, the code returned for Arabic is @@ -45883,16 +49584,16 @@ big-endian fashion. That is, the code returned for Arabic is See [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) for details. - + - the ISO 15924 code for @script, encoded as an integer, + the ISO 15924 code for @script, encoded as an integer, of zero if @script is %G_UNICODE_SCRIPT_INVALID_CODE or ISO 15924 code 'Zzzz' (script code for UNKNOWN) if @script is not understood. - a Unicode script + a Unicode script @@ -45903,7 +49604,7 @@ for details. - Sets a function to be called when the IO condition, as specified by + Sets a function to be called when the IO condition, as specified by @condition becomes true for @fd. @function will be called when the specified IO condition becomes @@ -45918,30 +49619,30 @@ to cancel the watch at any time that it exists. The source will never close the fd -- you must do it yourself. - the ID (greater than 0) of the event source + the ID (greater than 0) of the event source - a file descriptor + a file descriptor - IO conditions to watch for on @fd + IO conditions to watch for on @fd - a #GUnixFDSourceFunc + a #GUnixFDSourceFunc - data to pass to @function + data to pass to @function - Sets a function to be called when the IO condition, as specified by + Sets a function to be called when the IO condition, as specified by @condition becomes true for @fd. This is the same as g_unix_fd_add(), except that it allows you to @@ -45949,59 +49650,59 @@ specify a non-default priority and a provide a #GDestroyNotify for @user_data. - the ID (greater than 0) of the event source + the ID (greater than 0) of the event source - the priority of the source + the priority of the source - a file descriptor + a file descriptor - IO conditions to watch for on @fd + IO conditions to watch for on @fd - a #GUnixFDSourceFunc + a #GUnixFDSourceFunc - data to pass to @function + data to pass to @function - function to call when the idle is removed, or %NULL + function to call when the idle is removed, or %NULL - Creates a #GSource to watch for a particular IO condition on a file + Creates a #GSource to watch for a particular IO condition on a file descriptor. The source will never close the fd -- you must do it yourself. - the newly created #GSource + the newly created #GSource - a file descriptor + a file descriptor - IO conditions to watch for on @fd + IO conditions to watch for on @fd - Similar to the UNIX pipe() call, but on modern systems like Linux + Similar to the UNIX pipe() call, but on modern systems like Linux uses the pipe2() system call, which atomically creates a pipe with the configured flags. The only supported flag currently is %FD_CLOEXEC. If for example you want to configure %O_NONBLOCK, that @@ -46011,99 +49712,99 @@ This function does not take %O_CLOEXEC, it takes %FD_CLOEXEC as if for fcntl(); these are different on Linux/glibc. - %TRUE on success, %FALSE if not (and errno will be set). + %TRUE on success, %FALSE if not (and errno will be set). - Array of two integers + Array of two integers - Bitfield of file descriptor flags, as for fcntl() + Bitfield of file descriptor flags, as for fcntl() - Control the non-blocking state of the given file descriptor, + Control the non-blocking state of the given file descriptor, according to @nonblock. On most systems this uses %O_NONBLOCK, but on some older ones may use %O_NDELAY. - %TRUE if successful + %TRUE if successful - A file descriptor + A file descriptor - If %TRUE, set the descriptor to be non-blocking + If %TRUE, set the descriptor to be non-blocking - A convenience function for g_unix_signal_source_new(), which + A convenience function for g_unix_signal_source_new(), which attaches to the default #GMainContext. You can remove the watch using g_source_remove(). - An ID (greater than 0) for the event source + An ID (greater than 0) for the event source - Signal number + Signal number - Callback + Callback - Data for @handler + Data for @handler - A convenience function for g_unix_signal_source_new(), which + A convenience function for g_unix_signal_source_new(), which attaches to the default #GMainContext. You can remove the watch using g_source_remove(). - An ID (greater than 0) for the event source + An ID (greater than 0) for the event source - the priority of the signal source. Typically this will be in + the priority of the signal source. Typically this will be in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH. - Signal number + Signal number - Callback + Callback - Data for @handler + Data for @handler - #GDestroyNotify for @handler + #GDestroyNotify for @handler - Create a #GSource that will be dispatched upon delivery of the UNIX + Create a #GSource that will be dispatched upon delivery of the UNIX signal @signum. In GLib versions before 2.36, only `SIGHUP`, `SIGINT`, `SIGTERM` can be monitored. In GLib 2.36, `SIGUSR1` and `SIGUSR2` were added. In GLib 2.54, `SIGWINCH` was added. @@ -46128,18 +49829,18 @@ and must be added to one with g_source_attach() before it will be executed. - A newly created #GSource + A newly created #GSource - A signal number + A signal number - A wrapper for the POSIX unlink() function. The unlink() function + A wrapper for the POSIX unlink() function. The unlink() function deletes a name from the filesystem. If this was the last link to the file and no processes have it opened, the diskspace occupied by the file is freed. @@ -46147,22 +49848,22 @@ file is freed. See your C library manual for more details about unlink(). Note that on Windows, it is in general not possible to delete files that are open to some process, or mapped into memory. - + - 0 if the name was successfully deleted, -1 if an error + 0 if the name was successfully deleted, -1 if an error occurred - a pathname in the GLib file name encoding + a pathname in the GLib file name encoding (UTF-8 on Windows) - Removes an environment variable from the environment. + Removes an environment variable from the environment. Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed. @@ -46185,14 +49886,14 @@ array directly to execvpe(), g_spawn_async(), or the like. - the environment variable to remove, must + the environment variable to remove, must not contain '=' - Escapes a string for use in a URI. + Escapes a string for use in a URI. Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. @@ -46202,33 +49903,33 @@ specification, since those are allowed unescaped in some portions of a URI. - an escaped version of @unescaped. The returned string should be + an escaped version of @unescaped. The returned string should be freed when no longer needed. - the unescaped input string. + the unescaped input string. - a string of reserved characters that + a string of reserved characters that are allowed to be used, or %NULL. - %TRUE if the result can include UTF-8 characters. + %TRUE if the result can include UTF-8 characters. - Splits an URI list conforming to the text/uri-list + Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated. - a newly allocated %NULL-terminated list + a newly allocated %NULL-terminated list of strings holding the individual URIs. The array should be freed with g_strfreev(). @@ -46237,32 +49938,32 @@ discarding any comments. The URIs are not validated. - an URI list + an URI list - Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as: + Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include "file", "http", "svn+ssh", etc. - The "Scheme" component of the URI, or %NULL on error. + The "Scheme" component of the URI, or %NULL on error. The returned string should be freed when no longer needed. - a valid URI. + a valid URI. - Unescapes a segment of an escaped string. + Unescapes a segment of an escaped string. If any of the characters in @illegal_characters or the character zero appears as an escaped character in @escaped_string then that is an error and %NULL @@ -46271,7 +49972,7 @@ slash being expanded in an escaped path element, which might confuse pathname handling. - an unescaped version of @escaped_string or %NULL on error. + an unescaped version of @escaped_string or %NULL on error. The returned string should be freed when no longer needed. As a special case if %NULL is given for @escaped_string, this function will return %NULL. @@ -46279,21 +49980,21 @@ will return %NULL. - A string, may be %NULL + A string, may be %NULL - Pointer to end of @escaped_string, may be %NULL + Pointer to end of @escaped_string, may be %NULL - An optional string of illegal characters not to be allowed, may be %NULL + An optional string of illegal characters not to be allowed, may be %NULL - Unescapes a whole escaped string. + Unescapes a whole escaped string. If any of the characters in @illegal_characters or the character zero appears as an escaped character in @escaped_string then that is an error and %NULL @@ -46302,69 +50003,69 @@ slash being expanded in an escaped path element, which might confuse pathname handling. - an unescaped version of @escaped_string. The returned string + an unescaped version of @escaped_string. The returned string should be freed when no longer needed. - an escaped string to be unescaped. + an escaped string to be unescaped. - a string of illegal characters not to be + a string of illegal characters not to be allowed, or %NULL. - Pauses the current thread for the given number of microseconds. + Pauses the current thread for the given number of microseconds. There are 1 million microseconds per second (represented by the #G_USEC_PER_SEC macro). g_usleep() may have limited precision, depending on hardware and operating system; don't rely on the exact length of the sleep. - + - number of microseconds to pause + number of microseconds to pause - Convert a string from UTF-16 to UCS-4. The result will be + Convert a string from UTF-16 to UCS-4. The result will be nul-terminated. - - - a pointer to a newly allocated UCS-4 string. + + + a pointer to a newly allocated UCS-4 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-16 encoded string + a UTF-16 encoded string - the maximum length (number of #gunichar2) of @str to use. + the maximum length (number of #gunichar2) of @str to use. If @len < 0, then the string is nul-terminated. - location to store number of + location to store number of words read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial character. If an error occurs then the index of the invalid input is stored here. - location to store number + location to store number of characters written, or %NULL. The value stored here does not include the trailing 0 character. @@ -46372,7 +50073,7 @@ nul-terminated. - Convert a string from UTF-16 to UTF-8. The result will be + Convert a string from UTF-16 to UTF-8. The result will be terminated with a 0 byte. Note that the input is expected to be already in native endianness, @@ -46385,32 +50086,32 @@ string; it may e.g. include embedded NUL characters. The only validation done by this function is to ensure that the input can be correctly interpreted as UTF-16, i.e. it doesn't contain things unpaired surrogates. - + - a pointer to a newly allocated UTF-8 string. + a pointer to a newly allocated UTF-8 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-16 encoded string + a UTF-16 encoded string - the maximum length (number of #gunichar2) of @str to use. + the maximum length (number of #gunichar2) of @str to use. If @len < 0, then the string is nul-terminated. - location to store number of + location to store number of words read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial character. If an error occurs then the index of the invalid input is stored here. - location to store number + location to store number of bytes written, or %NULL. The value stored here does not include the trailing 0 byte. @@ -46418,7 +50119,7 @@ things unpaired surrogates. - Converts a string into a form that is independent of case. The + Converts a string into a form that is independent of case. The result will not correspond to any particular case, but can be compared for equality or ordered with the results of calling g_utf8_casefold() on other strings. @@ -46429,49 +50130,49 @@ ordering, though it is a fairly good one. Getting this exactly right would require a more sophisticated collation function that takes case sensitivity into account. GLib does not currently provide such a function. - + - a newly allocated string, that is a + a newly allocated string, that is a case independent form of @str. - a UTF-8 encoded string + a UTF-8 encoded string - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Compares two strings for ordering using the linguistically + Compares two strings for ordering using the linguistically correct rules for the [current locale][setlocale]. When sorting a large number of strings, it will be significantly faster to obtain collation keys with g_utf8_collate_key() and compare the keys with strcmp() when sorting instead of sorting the original strings. - + - < 0 if @str1 compares before @str2, + < 0 if @str1 compares before @str2, 0 if they compare equal, > 0 if @str1 compares after @str2. - a UTF-8 encoded string + a UTF-8 encoded string - a UTF-8 encoded string + a UTF-8 encoded string - Converts a string into a collation key that can be compared + Converts a string into a collation key that can be compared with other collation keys produced by the same function using strcmp(). @@ -46480,25 +50181,25 @@ with strcmp() will always be the same as comparing the two original keys with g_utf8_collate(). Note that this function depends on the [current locale][setlocale]. - + - a newly allocated string. This string should + a newly allocated string. This string should be freed with g_free() when you are done with it. - a UTF-8 encoded string. + a UTF-8 encoded string. - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Converts a string into a collation key that can be compared + Converts a string into a collation key that can be compared with other collation keys produced by the same function using strcmp(). In order to sort filenames correctly, this function treats the dot '.' @@ -46509,25 +50210,25 @@ would like to treat numbers intelligently so that "file1" "file10" "file5" is sorted as "file1" "file5" "file10". Note that this function depends on the [current locale][setlocale]. - + - a newly allocated string. This string should + a newly allocated string. This string should be freed with g_free() when you are done with it. - a UTF-8 encoded string. + a UTF-8 encoded string. - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Finds the start of the next UTF-8 character in the string after @p. + Finds the start of the next UTF-8 character in the string after @p. @p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than @@ -46537,69 +50238,69 @@ If @end is %NULL, the return value will never be %NULL: if the end of the string is reached, a pointer to the terminating nul byte is returned. If @end is non-%NULL, the return value will be %NULL if the end of the string is reached. - - - a pointer to the found character or %NULL if @end is + + + a pointer to the found character or %NULL if @end is set and is reached - a pointer to a position within a UTF-8 encoded string + a pointer to a position within a UTF-8 encoded string - a pointer to the byte following the end of the string, + a pointer to the byte following the end of the string, or %NULL to indicate that the string is nul-terminated - Given a position @p with a UTF-8 encoded string @str, find the start + Given a position @p with a UTF-8 encoded string @str, find the start of the previous UTF-8 character starting before @p. Returns %NULL if no UTF-8 characters are present in @str before @p. @p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than it starts with an appropriate byte. - - - a pointer to the found character or %NULL. + + + a pointer to the found character or %NULL. - pointer to the beginning of a UTF-8 encoded string + pointer to the beginning of a UTF-8 encoded string - pointer to some position within @str + pointer to some position within @str - Converts a sequence of bytes encoded as UTF-8 to a Unicode character. + Converts a sequence of bytes encoded as UTF-8 to a Unicode character. If @p does not point to a valid UTF-8 encoded character, results are undefined. If you are not sure that the bytes are complete valid Unicode characters, you should use g_utf8_get_char_validated() instead. - + - the resulting character + the resulting character - a pointer to Unicode character encoded as UTF-8 + a pointer to Unicode character encoded as UTF-8 - Convert a sequence of bytes encoded as UTF-8 to a Unicode character. + Convert a sequence of bytes encoded as UTF-8 to a Unicode character. This function checks for incomplete characters, for invalid characters such as characters that are out of the range of Unicode, and for overlong encodings of valid characters. @@ -46607,9 +50308,9 @@ overlong encodings of valid characters. Note that g_utf8_get_char_validated() returns (gunichar)-2 if @max_len is positive and any of the bytes in the first UTF-8 character sequence are nul. - + - the resulting character. If @p points to a partial + the resulting character. If @p points to a partial sequence at the end of a string that could begin a valid character (or if @max_len is zero), returns (gunichar)-2; otherwise, if @p does not point to a valid UTF-8 encoded @@ -46618,17 +50319,17 @@ sequence are nul. - a pointer to Unicode character encoded as UTF-8 + a pointer to Unicode character encoded as UTF-8 - the maximum number of bytes to read, or -1 if @p is nul-terminated + the maximum number of bytes to read, or -1 if @p is nul-terminated - If the provided string is valid UTF-8, return a copy of it. If not, + If the provided string is valid UTF-8, return a copy of it. If not, return a copy in which bytes that could not be interpreted as valid Unicode are replaced with the Unicode replacement character (U+FFFD). @@ -46637,25 +50338,39 @@ a string that was incorrectly declared to be UTF-8, and you need a valid UTF-8 version of it that can be logged or displayed to the user, with the assumption that it is close enough to ASCII or UTF-8 to be mostly readable as-is. - + - a valid UTF-8 string whose content resembles @str + a valid UTF-8 string whose content resembles @str - string to coerce into UTF-8 + string to coerce into UTF-8 - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. + + Skips to the next character in a UTF-8 string. The string must be +valid; this macro is as fast as possible, and has no error-checking. +You would use this macro to iterate over a string character by +character. The macro returns the start of the next UTF-8 character. +Before using this macro, use g_utf8_validate() to validate strings +that may contain invalid UTF-8. + + + + Pointer to the start of a valid UTF-8 character + + + - Converts a string into canonical form, standardizing + Converts a string into canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. The @@ -46680,30 +50395,30 @@ than a maximally decomposed form. This is often useful if you intend to convert the string to a legacy encoding or pass it to a system with less capable Unicode handling. - - - a newly allocated string, that is the - normalized form of @str, or %NULL if @str is not - valid UTF-8. + + + a newly allocated string, that + is the normalized form of @str, or %NULL if @str + is not valid UTF-8. - a UTF-8 encoded string. + a UTF-8 encoded string. - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - the type of normalization to perform. + the type of normalization to perform. - Converts from an integer character offset to a pointer to a position + Converts from an integer character offset to a pointer to a position within the string. Since 2.10, this function allows to pass a negative @offset to @@ -46716,127 +50431,127 @@ Therefore you should be sure that @offset is within string boundaries before calling that function. Call g_utf8_strlen() when unsure. This limitation exists as this function is called frequently during text rendering and therefore has to be as fast as possible. - - - the resulting pointer + + + the resulting pointer - a UTF-8 encoded string + a UTF-8 encoded string - a character offset within @str + a character offset within @str - Converts from a pointer to position within a string to a integer + Converts from a pointer to position within a string to a integer character offset. Since 2.10, this function allows @pos to be before @str, and returns a negative offset in this case. - + - the resulting character offset + the resulting character offset - a UTF-8 encoded string + a UTF-8 encoded string - a pointer to a position within @str + a pointer to a position within @str - Finds the previous UTF-8 character in the string before @p. + Finds the previous UTF-8 character in the string before @p. @p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than it starts with an appropriate byte. If @p might be the first character of the string, you must use g_utf8_find_prev_char() instead. - - - a pointer to the found character + + + a pointer to the found character - a pointer to a position within a UTF-8 encoded string + a pointer to a position within a UTF-8 encoded string - Finds the leftmost occurrence of the given Unicode character + Finds the leftmost occurrence of the given Unicode character in a UTF-8 encoded string, while limiting the search to @len bytes. If @len is -1, allow unbounded search. - - - %NULL if the string does not contain the character, + + + %NULL if the string does not contain the character, otherwise, a pointer to the start of the leftmost occurrence of the character in the string. - a nul-terminated UTF-8 encoded string + a nul-terminated UTF-8 encoded string - the maximum length of @p + the maximum length of @p - a Unicode character + a Unicode character - Converts all Unicode characters in the string that have a case + Converts all Unicode characters in the string that have a case to lowercase. The exact manner that this is done depends on the current locale, and may result in the number of characters in the string changing. - + - a newly allocated string, with all characters + a newly allocated string, with all characters converted to lowercase. - a UTF-8 encoded string + a UTF-8 encoded string - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Computes the length of the string in characters, not including + Computes the length of the string in characters, not including the terminating nul character. If the @max'th byte falls in the middle of a character, the last (partial) character is not counted. - + - the length of the string in characters + the length of the string in characters - pointer to the start of a UTF-8 encoded string + pointer to the start of a UTF-8 encoded string - the maximum number of bytes to examine. If @max + the maximum number of bytes to examine. If @max is less than 0, then the string is assumed to be nul-terminated. If @max is 0, @p will not be examined and may be %NULL. If @max is greater than 0, up to @max @@ -46846,61 +50561,61 @@ middle of a character, the last (partial) character is not counted. - Like the standard C strncpy() function, but copies a given number + Like the standard C strncpy() function, but copies a given number of characters instead of a given number of bytes. The @src string must be valid UTF-8 encoded text. (Use g_utf8_validate() on all text before trying to use UTF-8 utility functions with it.) Note you must ensure @dest is at least 4 * @n to fit the largest possible UTF-8 characters - - - @dest + + + @dest - buffer to fill with characters from @src + buffer to fill with characters from @src - UTF-8 encoded string + UTF-8 encoded string - character count + character count - Find the rightmost occurrence of the given Unicode character + Find the rightmost occurrence of the given Unicode character in a UTF-8 encoded string, while limiting the search to @len bytes. If @len is -1, allow unbounded search. - - - %NULL if the string does not contain the character, + + + %NULL if the string does not contain the character, otherwise, a pointer to the start of the rightmost occurrence of the character in the string. - a nul-terminated UTF-8 encoded string + a nul-terminated UTF-8 encoded string - the maximum length of @p + the maximum length of @p - a Unicode character + a Unicode character - Reverses a UTF-8 string. @str must be valid UTF-8 encoded text. + Reverses a UTF-8 string. @str must be valid UTF-8 encoded text. (Use g_utf8_validate() on all text before trying to use UTF-8 utility functions with it.) @@ -46913,93 +50628,93 @@ for display purposes. Note that unlike g_strreverse(), this function returns newly-allocated memory, which should be freed with g_free() when no longer needed. - + - a newly-allocated string which is the reverse of @str + a newly-allocated string which is the reverse of @str - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. - Converts all Unicode characters in the string that have a case + Converts all Unicode characters in the string that have a case to uppercase. The exact manner that this is done depends on the current locale, and may result in the number of characters in the string increasing. (For instance, the German ess-zet will be changed to SS.) - + - a newly allocated string, with all characters + a newly allocated string, with all characters converted to uppercase. - a UTF-8 encoded string + a UTF-8 encoded string - length of @str, in bytes, or -1 if @str is nul-terminated. + length of @str, in bytes, or -1 if @str is nul-terminated. - Copies a substring out of a UTF-8 encoded string. + Copies a substring out of a UTF-8 encoded string. The substring will contain @end_pos - @start_pos characters. - + - a newly allocated copy of the requested + a newly allocated copy of the requested substring. Free with g_free() when no longer needed. - a UTF-8 encoded string + a UTF-8 encoded string - a character offset within @str + a character offset within @str - another character offset within @str + another character offset within @str - Convert a string from UTF-8 to a 32-bit fixed width + Convert a string from UTF-8 to a 32-bit fixed width representation as UCS-4. A trailing 0 character will be added to the string after the converted text. - - - a pointer to a newly allocated UCS-4 string. + + + a pointer to a newly allocated UCS-4 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. - location to store number of + location to store number of bytes read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial @@ -47008,7 +50723,7 @@ string after the converted text. - location to store number + location to store number of characters written or %NULL. The value here stored does not include the trailing 0 character. @@ -47016,63 +50731,63 @@ string after the converted text. - Convert a string from UTF-8 to a 32-bit fixed width + Convert a string from UTF-8 to a 32-bit fixed width representation as UCS-4, assuming valid UTF-8 input. This function is roughly twice as fast as g_utf8_to_ucs4() but does no error checking on the input. A trailing 0 character will be added to the string after the converted text. - - - a pointer to a newly allocated UCS-4 string. + + + a pointer to a newly allocated UCS-4 string. This value must be freed with g_free(). - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length of @str to use, in bytes. If @len < 0, + the maximum length of @str to use, in bytes. If @len < 0, then the string is nul-terminated. - location to store the + location to store the number of characters in the result, or %NULL. - Convert a string from UTF-8 to UTF-16. A 0 character will be + Convert a string from UTF-8 to UTF-16. A 0 character will be added to the result after the converted text. - - - a pointer to a newly allocated UTF-16 string. + + + a pointer to a newly allocated UTF-16 string. This value must be freed with g_free(). If an error occurs, %NULL will be returned and @error set. - a UTF-8 encoded string + a UTF-8 encoded string - the maximum length (number of bytes) of @str to use. + the maximum length (number of bytes) of @str to use. If @len < 0, then the string is nul-terminated. - location to store number of + location to store number of bytes read, or %NULL. If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be returned in case @str contains a trailing partial character. If an error occurs then the index of the invalid input is stored here. - location to store number + location to store number of #gunichar2 written, or %NULL. The value stored here does not include the trailing 0. @@ -47080,7 +50795,7 @@ added to the result after the converted text. - Validates UTF-8 encoded text. @str is the text to validate; + Validates UTF-8 encoded text. @str is the text to validate; if @str is nul-terminated, then @max_len can be -1, otherwise @max_len should be the number of bytes to validate. If @end is non-%NULL, then the end of the valid range @@ -47095,57 +50810,57 @@ Returns %TRUE if all of @str was valid. Many GLib and GTK+ routines require valid UTF-8 as input; so data read from a file or the network should be checked with g_utf8_validate() before doing anything else with it. - + - %TRUE if the text was valid UTF-8 + %TRUE if the text was valid UTF-8 - a pointer to character data + a pointer to character data - max bytes to validate, or -1 to go until NUL + max bytes to validate, or -1 to go until NUL - return location for end of valid data + return location for end of valid data - Validates UTF-8 encoded text. + Validates UTF-8 encoded text. As with g_utf8_validate(), but @max_len must be set, and hence this function will always return %FALSE if any of the bytes of @str are nul. - + - %TRUE if the text was valid UTF-8 + %TRUE if the text was valid UTF-8 - a pointer to character data + a pointer to character data - max bytes to validate + max bytes to validate - return location for end of valid data + return location for end of valid data - Parses the string @str and verify if it is a UUID. + Parses the string @str and verify if it is a UUID. The function accepts the following syntax: @@ -47155,21 +50870,21 @@ Note that hyphens are required within the UUID string itself, as per the aforementioned RFC. - %TRUE if @str is a valid UUID, %FALSE otherwise. + %TRUE if @str is a valid UUID, %FALSE otherwise. - a string representing a UUID + a string representing a UUID - Generates a random UUID (RFC 4122 version 4) as a string. + Generates a random UUID (RFC 4122 version 4) as a string. - A string that should be freed with g_free(). + A string that should be freed with g_free(). @@ -47180,7 +50895,7 @@ as per the aforementioned RFC. - Determines if a given string is a valid D-Bus object path. You + Determines if a given string is a valid D-Bus object path. You should ensure that a string is a valid D-Bus object path before passing it to g_variant_new_object_path(). @@ -47190,18 +50905,18 @@ must contain only the characters `[A-Z][a-z][0-9]_`. No sequence (including the one following the final `/` character) may be empty. - %TRUE if @string is a D-Bus object path + %TRUE if @string is a D-Bus object path - a normal C nul-terminated string + a normal C nul-terminated string - Determines if a given string is a valid D-Bus type signature. You + Determines if a given string is a valid D-Bus type signature. You should ensure that a string is a valid D-Bus type signature before passing it to g_variant_new_signature(). @@ -47209,18 +50924,18 @@ D-Bus type signatures consist of zero or more definite #GVariantType strings in sequence. - %TRUE if @string is a D-Bus type signature + %TRUE if @string is a D-Bus type signature - a normal C nul-terminated string + a normal C nul-terminated string - Parses a #GVariant from a text representation. + Parses a #GVariant from a text representation. A single #GVariant is parsed from the content of @text. @@ -47253,30 +50968,30 @@ Officially, the language understood by the parser is "any string produced by g_variant_print()". - a non-floating reference to a #GVariant, or %NULL + a non-floating reference to a #GVariant, or %NULL - a #GVariantType, or %NULL + a #GVariantType, or %NULL - a string containing a GVariant in text form + a string containing a GVariant in text form - a pointer to the end of @text, or %NULL + a pointer to the end of @text, or %NULL - a location to store the end pointer, or %NULL + a location to store the end pointer, or %NULL - Pretty-prints a message showing the context of a #GVariant parse + Pretty-prints a message showing the context of a #GVariant parse error within the string for which parsing was attempted. The resulting string is suitable for output to the console or other @@ -47307,16 +51022,16 @@ g_variant_parse() then you must add nul termination before using this function. - the printed message + the printed message - a #GError from the #GVariantParseError domain + a #GError from the #GVariantParseError domain - the string that was given to the parser + the string that was given to the parser @@ -47327,7 +51042,7 @@ function. - Same as g_variant_error_quark(). + Same as g_variant_error_quark(). Use g_variant_parse_error_quark() instead. @@ -47356,25 +51071,25 @@ function. - Checks if @type_string is a valid GVariant type string. This call is + Checks if @type_string is a valid GVariant type string. This call is equivalent to calling g_variant_type_string_scan() and confirming that the following character is a nul terminator. - %TRUE if @type_string is exactly one valid type string + %TRUE if @type_string is exactly one valid type string Since 2.24 - a pointer to any string + a pointer to any string - Scan for a single complete and valid GVariant type string in @string. + Scan for a single complete and valid GVariant type string in @string. The memory pointed to by @limit (or bytes beyond it) is never accessed. @@ -47389,26 +51104,26 @@ For the simple case of checking if a string is a valid type string, see g_variant_type_string_is_valid(). - %TRUE if a valid type string was found + %TRUE if a valid type string was found - a pointer to any string + a pointer to any string - the end of @string, or %NULL + the end of @string, or %NULL - location to store the end pointer, or %NULL + location to store the end pointer, or %NULL - An implementation of the GNU vasprintf() function which supports + An implementation of the GNU vasprintf() function which supports positional parameters, as specified in the Single Unix Specification. This function is similar to g_vsprintf(), except that it allocates a string to hold the output, instead of putting the output in a buffer @@ -47417,75 +51132,75 @@ you allocate in advance. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the return location for the newly-allocated string. + the return location for the newly-allocated string. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - An implementation of the standard fprintf() function which supports + An implementation of the standard fprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the stream to write to. + the stream to write to. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - An implementation of the standard vprintf() function which supports + An implementation of the standard vprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - A safer form of the standard vsprintf() function. The output is guaranteed + A safer form of the standard vsprintf() function. The output is guaranteed to not exceed @n characters (including the terminating nul character), so it is easy to ensure that a buffer overflow cannot occur. @@ -47504,59 +51219,68 @@ The format string may contain positional parameters, as specified in the Single Unix Specification. - the number of bytes which would be produced if the buffer + the number of bytes which would be produced if the buffer was large enough. - the buffer to hold the output. + the buffer to hold the output. - the maximum number of bytes to produce (including the + the maximum number of bytes to produce (including the terminating nul character). - a standard printf() format string, but notice + a standard printf() format string, but notice string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. - An implementation of the standard vsprintf() function which supports + An implementation of the standard vsprintf() function which supports positional parameters, as specified in the Single Unix Specification. `glib/gprintf.h` must be explicitly included in order to use this function. - the number of bytes printed. + the number of bytes printed. - the buffer to hold the output. + the buffer to hold the output. - a standard printf() format string, but notice + a standard printf() format string, but notice [string precision pitfalls][string-precision] - the list of arguments to insert in the output. + the list of arguments to insert in the output. + + Logs a warning if the expression is not true. + + + + the expression to check + + + - Internal function used to print messages from the public g_warn_if_reached() + Internal function used to print messages from the public g_warn_if_reached() and g_warn_if_fail() macros. @@ -47564,23 +51288,23 @@ and g_warn_if_fail() macros. - log domain + log domain - file containing the warning + file containing the warning - line number of the warning + line number of the warning - function containing the warning + function containing the warning - expression which failed + expression which failed diff --git a/rust-bindings/rust/gir-files/GObject-2.0.gir b/rust-bindings/rust/gir-files/GObject-2.0.gir index f96d5410..06856f1b 100644 --- a/rust-bindings/rust/gir-files/GObject-2.0.gir +++ b/rust-bindings/rust/gir-files/GObject-2.0.gir @@ -24,30 +24,119 @@ marshalling the signal argument into GValues. - A numerical value which represents the unique identifier of a registered + A numerical value which represents the unique identifier of a registered type. - + + + A convenience macro to ease adding private data to instances of a new type +in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or +G_DEFINE_ABSTRACT_TYPE_WITH_CODE(). + +For instance: + +|[<!-- language="C" --> + typedef struct _MyObject MyObject; + typedef struct _MyObjectClass MyObjectClass; + + typedef struct { + gint foo; + gint bar; + } MyObjectPrivate; + + G_DEFINE_TYPE_WITH_CODE (MyObject, my_object, G_TYPE_OBJECT, + G_ADD_PRIVATE (MyObject)) +]| + +Will add MyObjectPrivate as the private data to any instance of the MyObject +type. + +G_DEFINE_TYPE_* macros will automatically create a private function +based on the arguments to this macro, which can be used to safely +retrieve the private data from an instance of the type; for instance: + +|[<!-- language="C" --> + gint + my_object_get_foo (MyObject *obj) + { + MyObjectPrivate *priv = my_object_get_instance_private (obj); + + g_return_val_if_fail (MY_IS_OBJECT (obj), 0); + + return priv->foo; + } + + void + my_object_set_bar (MyObject *obj, + gint bar) + { + MyObjectPrivate *priv = my_object_get_instance_private (obj); + + g_return_if_fail (MY_IS_OBJECT (obj)); + + if (priv->bar != bar) + priv->bar = bar; + } +]| + +Note that this macro can only be used together with the G_DEFINE_TYPE_* +macros, since it depends on variable names from those macros. + +Also note that private structs added with these macros must have a struct +name of the form `TypeNamePrivate`. + +It is safe to call the `_get_instance_private` function on %NULL or invalid +objects since it's only adding an offset to the instance pointer. In that +case the returned pointer must not be dereferenced. + + + + the name of the type in CamelCase + + + + + A convenience macro to ease adding private data to instances of a new dynamic +type in the @_C_ section of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). See +G_ADD_PRIVATE() for details, it is similar but for static types. + +Note that this macro can only be used together with the +G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable +names from that macro. + + + + the name of the type in CamelCase + + + + + + + + + + - A callback function used by the type system to finalize those portions + A callback function used by the type system to finalize those portions of a derived types class structure that were setup from the corresponding GBaseInitFunc() function. Class finalization basically works the inverse way in which class initialization is performed. See GClassInitFunc() for a discussion of the class initialization process. - + - The #GTypeClass structure to finalize + The #GTypeClass structure to finalize - A callback function used by the type system to do base initialization + A callback function used by the type system to do base initialization of the class structures of derived types. It is called as part of the initialization process of all derived classes and should reallocate or reset all dynamic class members copied over from the parent class. @@ -55,13 +144,13 @@ For example, class members (such as strings) that are not sufficiently handled by a plain memory copy of the parent class into the derived class have to be altered. See GClassInitFunc() for a discussion of the class initialization process. - + - The #GTypeClass structure to initialize + The #GTypeClass structure to initialize @@ -145,79 +234,79 @@ binding, source, and target instances to drop. #GBinding is available since GObject 2.26 - Retrieves the flags passed when constructing the #GBinding. + Retrieves the flags passed when constructing the #GBinding. - the #GBindingFlags used by the #GBinding + the #GBindingFlags used by the #GBinding - a #GBinding + a #GBinding - Retrieves the #GObject instance used as the source of the binding. + Retrieves the #GObject instance used as the source of the binding. - the source #GObject + the source #GObject - a #GBinding + a #GBinding - Retrieves the name of the property of #GBinding:source used as the source + Retrieves the name of the property of #GBinding:source used as the source of the binding. - the name of the source property + the name of the source property - a #GBinding + a #GBinding - Retrieves the #GObject instance used as the target of the binding. + Retrieves the #GObject instance used as the target of the binding. - the target #GObject + the target #GObject - a #GBinding + a #GBinding - Retrieves the name of the property of #GBinding:target used as the target + Retrieves the name of the property of #GBinding:target used as the target of the binding. - the name of the target property + the name of the target property - a #GBinding + a #GBinding - Explicitly releases the binding between the source and the target + Explicitly releases the binding between the source and the target property expressed by @binding. This function will release the reference that is being held on @@ -230,7 +319,7 @@ to it. - a #GBinding + a #GBinding @@ -346,6 +435,25 @@ structure passed. + + Cast a function pointer to a #GCallback. + + + + a function pointer. + + + + + Checks whether the user data of the #GCClosure should be passed as the +first parameter to the callback. See g_cclosure_new_swap(). + + + + a #GCClosure + + + A #GCClosure is a specialization of #GClosure for C function callbacks. @@ -358,7 +466,7 @@ structure passed. - A #GClosureMarshal function for use with signals with handlers that + A #GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled(). @@ -368,30 +476,30 @@ accumulator, such as g_signal_accumulator_true_handled(). - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - The invocation hint given as the last argument to + The invocation hint given as the last argument to g_closure_invoke(). - Additional data specified when registering the + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -399,42 +507,42 @@ accumulator, such as g_signal_accumulator_true_handled(). - The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -443,7 +551,7 @@ accumulator, such as g_signal_accumulator_true_handled(). - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -452,69 +560,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue which can store the returned #gboolean + a #GValue which can store the returned #gboolean - 2 + 2 - a #GValue array holding instance and arg1 + a #GValue array holding instance and arg1 - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -523,7 +631,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`. @@ -531,69 +639,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue, which can store the returned string + a #GValue, which can store the returned string - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -602,7 +710,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`. @@ -610,69 +718,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gboolean parameter + a #GValue array holding the instance and the #gboolean parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOOLEAN(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOOLEAN(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -681,7 +789,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`. @@ -689,69 +797,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GBoxed* parameter + a #GValue array holding the instance and the #GBoxed* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOXED(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOXED(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -760,7 +868,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`. @@ -768,69 +876,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar parameter + a #GValue array holding the instance and the #gchar parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__CHAR(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__CHAR(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -839,7 +947,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`. @@ -847,69 +955,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gdouble parameter + a #GValue array holding the instance and the #gdouble parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__DOUBLE(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__DOUBLE(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -918,7 +1026,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type.. @@ -926,69 +1034,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the enumeration parameter + a #GValue array holding the instance and the enumeration parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ENUM(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ENUM(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -997,7 +1105,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -1005,69 +1113,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the flags parameter + a #GValue array holding the instance and the flags parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLAGS(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLAGS(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1076,7 +1184,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`. @@ -1084,69 +1192,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gfloat parameter + a #GValue array holding the instance and the #gfloat parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLOAT(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLOAT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1155,7 +1263,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)`. @@ -1163,69 +1271,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gint parameter + a #GValue array holding the instance and the #gint parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__INT(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__INT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1234,7 +1342,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, glong arg1, gpointer user_data)`. @@ -1242,69 +1350,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #glong parameter + a #GValue array holding the instance and the #glong parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__LONG(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__LONG(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1313,7 +1421,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`. @@ -1321,69 +1429,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GObject* parameter + a #GValue array holding the instance and the #GObject* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__OBJECT(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__OBJECT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1392,7 +1500,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`. @@ -1400,69 +1508,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GParamSpec* parameter + a #GValue array holding the instance and the #GParamSpec* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__PARAM(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__PARAM(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1471,7 +1579,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`. @@ -1479,69 +1587,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gpointer parameter + a #GValue array holding the instance and the #gpointer parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__POINTER(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__POINTER(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1550,7 +1658,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`. @@ -1558,69 +1666,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar* parameter + a #GValue array holding the instance and the #gchar* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__STRING(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__STRING(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1629,7 +1737,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`. @@ -1637,69 +1745,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guchar parameter + a #GValue array holding the instance and the #guchar parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UCHAR(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UCHAR(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1708,7 +1816,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer user_data)`. @@ -1716,34 +1824,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guint parameter + a #GValue array holding the instance and the #guint parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`. @@ -1751,69 +1859,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT_POINTER(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT_POINTER(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1822,42 +1930,42 @@ denotes a flags type. - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1866,7 +1974,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`. @@ -1874,69 +1982,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gulong parameter + a #GValue array holding the instance and the #gulong parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ULONG(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ULONG(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -1945,7 +2053,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`. @@ -1953,69 +2061,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GVariant* parameter + a #GValue array holding the instance and the #GVariant* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VARIANT(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VARIANT(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2024,7 +2132,7 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer user_data)`. @@ -2032,69 +2140,69 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 1 + 1 - a #GValue array holding only the instance + a #GValue array holding only the instance - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VOID(). + The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VOID(). - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is invoked. + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args. @@ -2103,7 +2211,7 @@ denotes a flags type. - A generic marshaller function implemented via + A generic marshaller function implemented via [libffi](http://sourceware.org/libffi/). Normally this function is not passed explicitly to g_signal_new(), @@ -2114,30 +2222,30 @@ but used automatically by GLib when specifying a %NULL marshaller. - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - The invocation hint given as the last argument to + The invocation hint given as the last argument to g_closure_invoke(). - Additional data specified when registering the + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -2145,7 +2253,7 @@ but used automatically by GLib when specifying a %NULL marshaller. - A generic #GVaClosureMarshal function implemented via + A generic #GVaClosureMarshal function implemented via [libffi](http://sourceware.org/libffi/). @@ -2153,36 +2261,36 @@ but used automatically by GLib when specifying a %NULL marshaller. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the instance on which the closure is + the instance on which the closure is invoked. - va_list of arguments to be passed to the closure. + va_list of arguments to be passed to the closure. - additional data specified when + additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() - the length of the @param_types array + the length of the @param_types array - the #GType of each argument from + the #GType of each argument from @args_list. @@ -2191,100 +2299,122 @@ but used automatically by GLib when specifying a %NULL marshaller. - Creates a new closure which invokes @callback_func with @user_data as + Creates a new closure which invokes @callback_func with @user_data as the last parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - the function to invoke + the function to invoke - user data to pass to @callback_func + user data to pass to @callback_func - destroy notify to be called when @user_data is no longer used + destroy notify to be called when @user_data is no longer used - A variant of g_cclosure_new() which uses @object as @user_data and + A variant of g_cclosure_new() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - + - a new #GCClosure + a new #GCClosure - the function to invoke + the function to invoke - a #GObject pointer to pass to @callback_func + a #GObject pointer to pass to @callback_func - A variant of g_cclosure_new_swap() which uses @object as @user_data + A variant of g_cclosure_new_swap() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - + - a new #GCClosure + a new #GCClosure - the function to invoke + the function to invoke - a #GObject pointer to pass to @callback_func + a #GObject pointer to pass to @callback_func - Creates a new closure which invokes @callback_func with @user_data as + Creates a new closure which invokes @callback_func with @user_data as the first parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - the function to invoke + the function to invoke - user data to pass to @callback_func + user data to pass to @callback_func - destroy notify to be called when @user_data is no longer used + destroy notify to be called when @user_data is no longer used + + Check if the closure still needs a marshaller. See g_closure_set_marshal(). + + + + a #GClosure + + + + + Get the total number of notifiers connected with the closure @cl. +The count includes the meta marshaller, the finalize and invalidate notifiers +and the marshal guards. Note that each guard counts as two notifiers. +See g_closure_set_meta_marshal(), g_closure_add_finalize_notifier(), +g_closure_add_invalidate_notifier() and g_closure_add_marshal_guards(). + + + + a #GClosure + + + The type used for callback functions in structure definitions and function signatures. This doesn't mean that all callback functions must take no @@ -2297,30 +2427,30 @@ is connected). Use G_CALLBACK() to cast the callback function to a #GCallback. - A callback function used by the type system to finalize a class. + A callback function used by the type system to finalize a class. This function is rarely needed, as dynamically allocated class resources should be handled by GBaseInitFunc() and GBaseFinalizeFunc(). Also, specification of a GClassFinalizeFunc() in the #GTypeInfo structure of a static type is invalid, because classes of static types will never be finalized (they are artificially kept alive when their reference count drops to zero). - + - The #GTypeClass structure to finalize + The #GTypeClass structure to finalize - The @class_data member supplied via the #GTypeInfo structure + The @class_data member supplied via the #GTypeInfo structure - A callback function used by the type system to initialize the class + A callback function used by the type system to initialize the class of a specific type. This function should initialize all static class members. @@ -2415,23 +2545,23 @@ is called to complete the initialization process with the static members Corresponding finalization counter parts to the GBaseInitFunc() functions have to be provided to release allocated resources at class finalization time. - + - The #GTypeClass structure to initialize. + The #GTypeClass structure to initialize. - The @class_data member supplied via the #GTypeInfo structure. + The @class_data member supplied via the #GTypeInfo structure. - A #GClosure represents a callback supplied by the programmer. It + A #GClosure represents a callback supplied by the programmer. It will generally comprise a function of some kind and a marshaller used to call it. It is the responsibility of the marshaller to convert the arguments for the invocation from #GValues into @@ -2544,30 +2674,30 @@ callback function/data pointer combination: - A variant of g_closure_new_simple() which stores @object in the + A variant of g_closure_new_simple() which stores @object in the @data field of the closure and calls g_object_watch_closure() on @object and the created closure. This function is mainly useful when implementing new types of closures. - + - a newly allocated #GClosure + a newly allocated #GClosure - the size of the structure to allocate, must be at least + the size of the structure to allocate, must be at least `sizeof (GClosure)` - a #GObject pointer to store in the @data field of the newly + a #GObject pointer to store in the @data field of the newly allocated #GClosure - Allocates a struct of the given size and initializes the initial + Allocates a struct of the given size and initializes the initial part as a #GClosure. This function is mainly useful when implementing new types of closures. @@ -2605,23 +2735,23 @@ MyClosure *my_closure_new (gpointer data) ]| - a floating reference to a new #GClosure + a floating reference to a new #GClosure - the size of the structure to allocate, must be at least + the size of the structure to allocate, must be at least `sizeof (GClosure)` - data to store in the @data field of the newly allocated #GClosure + data to store in the @data field of the newly allocated #GClosure - Registers a finalization notifier which will be called when the + Registers a finalization notifier which will be called when the reference count of @closure goes down to 0. Multiple finalization notifiers on a single closure are invoked in unspecified order. If a single call to g_closure_unref() results in the closure being @@ -2633,21 +2763,21 @@ be run before the finalize notifiers. - a #GClosure + a #GClosure - data to pass to @notify_func + data to pass to @notify_func - the callback function to register + the callback function to register - Registers an invalidation notifier which will be called when the + Registers an invalidation notifier which will be called when the @closure is invalidated with g_closure_invalidate(). Invalidation notifiers are invoked before finalization notifiers, in an unspecified order. @@ -2657,21 +2787,21 @@ unspecified order. - a #GClosure + a #GClosure - data to pass to @notify_func + data to pass to @notify_func - the callback function to register + the callback function to register - Adds a pair of notifiers which get invoked before and after the + Adds a pair of notifiers which get invoked before and after the closure callback, respectively. This is typically used to protect the extra arguments for the duration of the callback. See g_object_watch_closure() for an example of marshal guards. @@ -2681,31 +2811,31 @@ g_object_watch_closure() for an example of marshal guards. - a #GClosure + a #GClosure - data to pass + data to pass to @pre_marshal_notify - a function to call before the closure callback + a function to call before the closure callback - data to pass + data to pass to @post_marshal_notify - a function to call after the closure callback + a function to call after the closure callback - Sets a flag on the closure to indicate that its calling + Sets a flag on the closure to indicate that its calling environment has become invalid, and thus causes any future invocations of g_closure_invoke() on this @closure to be ignored. Also, invalidation notifiers installed on the closure will @@ -2724,34 +2854,34 @@ been invalidated before). - #GClosure to invalidate + #GClosure to invalidate - Invokes the closure, i.e. executes the callback represented by the @closure. + Invokes the closure, i.e. executes the callback represented by the @closure. - a #GClosure + a #GClosure - a #GValue to store the return + a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. - the length of the @param_values array + the length of the @param_values array - an array of + an array of #GValues holding the arguments on which to invoke the callback of @closure @@ -2759,28 +2889,28 @@ been invalidated before). - a context-dependent invocation hint + a context-dependent invocation hint - Increments the reference count on a closure to force it staying + Increments the reference count on a closure to force it staying alive while the caller holds a pointer to it. - The @closure passed in, for convenience + The @closure passed in, for convenience - #GClosure to increment the reference count on + #GClosure to increment the reference count on - Removes a finalization notifier. + Removes a finalization notifier. Notice that notifiers are automatically removed after they are run. @@ -2789,22 +2919,22 @@ Notice that notifiers are automatically removed after they are run. - a #GClosure + a #GClosure - data which was passed to g_closure_add_finalize_notifier() + data which was passed to g_closure_add_finalize_notifier() when registering @notify_func - the callback function to remove + the callback function to remove - Removes an invalidation notifier. + Removes an invalidation notifier. Notice that notifiers are automatically removed after they are run. @@ -2813,22 +2943,22 @@ Notice that notifiers are automatically removed after they are run. - a #GClosure + a #GClosure - data which was passed to g_closure_add_invalidate_notifier() + data which was passed to g_closure_add_invalidate_notifier() when registering @notify_func - the callback function to remove + the callback function to remove - Sets the marshaller of @closure. The `marshal_data` + Sets the marshaller of @closure. The `marshal_data` of @marshal provides a way for a meta marshaller to provide additional information to the marshaller. (See g_closure_set_meta_marshal().) For GObject's C predefined marshallers (the g_cclosure_marshal_*() @@ -2840,17 +2970,17 @@ functions), what it provides is a callback function to use instead of - a #GClosure + a #GClosure - a #GClosureMarshal function + a #GClosureMarshal function - Sets the meta marshaller of @closure. A meta marshaller wraps + Sets the meta marshaller of @closure. A meta marshaller wraps @closure->marshal and modifies the way it is called in some fashion. The most common use of this facility is for C callbacks. The same marshallers (generated by [glib-genmarshal][glib-genmarshal]), @@ -2870,22 +3000,22 @@ the right callback and passes it to the marshaller as the - a #GClosure + a #GClosure - context-dependent data to pass + context-dependent data to pass to @meta_marshal - a #GClosureMarshal function + a #GClosureMarshal function - Takes over the initial ownership of a closure. Each closure is + Takes over the initial ownership of a closure. Each closure is initially created in a "floating" state, which means that the initial reference count is not owned by any caller. g_closure_sink() checks to see if the object is still floating, and if so, unsets the @@ -2931,14 +3061,14 @@ g_closure_ref() should be called prior to this function. - #GClosure to decrement the initial reference count on, if it's + #GClosure to decrement the initial reference count on, if it's still being held - Decrements the reference count of a closure after it was previously + Decrements the reference count of a closure after it was previously incremented by the same caller. If no other callers are using the closure, then the closure will be destroyed and freed. @@ -2947,7 +3077,7 @@ closure, then the closure will be destroyed and freed. - #GClosure to decrement the reference count on + #GClosure to decrement the reference count on @@ -3035,6 +3165,714 @@ connection. calling the handler; see g_signal_connect_swapped() for an example. + + A convenience macro for emitting the usual declarations in the +header file for a type which is intended to be subclassed. + +You might use it in a header as follows: + +|[ +#ifndef _gtk_frobber_h_ +#define _gtk_frobber_h_ + +#define GTK_TYPE_FROBBER gtk_frobber_get_type () +GDK_AVAILABLE_IN_3_12 +G_DECLARE_DERIVABLE_TYPE (GtkFrobber, gtk_frobber, GTK, FROBBER, GtkWidget) + +struct _GtkFrobberClass +{ + GtkWidgetClass parent_class; + + void (* handle_frob) (GtkFrobber *frobber, + guint n_frobs); + + gpointer padding[12]; +}; + +GtkWidget * gtk_frobber_new (void); + +... + +#endif +]| + +This results in the following things happening: + +- the usual gtk_frobber_get_type() function is declared with a return type of #GType + +- the GtkFrobber struct is created with GtkWidget as the first and only item. You are expected to use + a private structure from your .c file to store your instance variables. + +- the GtkFrobberClass type is defined as a typedef to struct _GtkFrobberClass, which is left undefined. + You should do this from the header file directly after you use the macro. + +- the GTK_FROBBER() and GTK_FROBBER_CLASS() casts are emitted as static inline functions along with + the GTK_IS_FROBBER() and GTK_IS_FROBBER_CLASS() type checking functions and GTK_FROBBER_GET_CLASS() + function. + +- g_autoptr() support being added for your type, based on the type of your parent class + +You can only use this function if your parent type also supports g_autoptr(). + +Because the type macro (GTK_TYPE_FROBBER in the above example) is not a callable, you must continue to +manually define this as a macro for yourself. + +The declaration of the _get_type() function is the first thing emitted by the macro. This allows this macro +to be used in the usual way with export control and API versioning macros. + +If you are writing a library, it is important to note that it is possible to convert a type from using +G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI. As a precaution, you +should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be +subclassed. Once a class structure has been exposed it is not possible to change its size or remove or +reorder items without breaking the API and/or ABI. If you want to declare your own class structure, use +G_DECLARE_DERIVABLE_TYPE(). If you want to declare a class without exposing the class or instance +structures, use G_DECLARE_FINAL_TYPE(). + +If you must use G_DECLARE_DERIVABLE_TYPE() you should be sure to include some padding at the bottom of your +class structure to leave space for the addition of future virtual functions. + + + + The name of the new type, in camel case (like GtkWidget) + + + The name of the new type in lowercase, with words + separated by '_' (like 'gtk_widget') + + + The name of the module, in all caps (like 'GTK') + + + The bare name of the type, in all caps (like 'WIDGET') + + + the name of the parent type, in camel case (like GtkWidget) + + + + + A convenience macro for emitting the usual declarations in the header file for a type which is not (at the +present time) intended to be subclassed. + +You might use it in a header as follows: + +|[ +#ifndef _myapp_window_h_ +#define _myapp_window_h_ + +#include <gtk/gtk.h> + +#define MY_APP_TYPE_WINDOW my_app_window_get_type () +G_DECLARE_FINAL_TYPE (MyAppWindow, my_app_window, MY_APP, WINDOW, GtkWindow) + +MyAppWindow * my_app_window_new (void); + +... + +#endif +]| + +This results in the following things happening: + +- the usual my_app_window_get_type() function is declared with a return type of #GType + +- the MyAppWindow types is defined as a typedef of struct _MyAppWindow. The struct itself is not + defined and should be defined from the .c file before G_DEFINE_TYPE() is used. + +- the MY_APP_WINDOW() cast is emitted as static inline function along with the MY_APP_IS_WINDOW() type + checking function + +- the MyAppWindowClass type is defined as a struct containing GtkWindowClass. This is done for the + convenience of the person defining the type and should not be considered to be part of the ABI. In + particular, without a firm declaration of the instance structure, it is not possible to subclass the type + and therefore the fact that the size of the class structure is exposed is not a concern and it can be + freely changed at any point in the future. + +- g_autoptr() support being added for your type, based on the type of your parent class + +You can only use this function if your parent type also supports g_autoptr(). + +Because the type macro (MY_APP_TYPE_WINDOW in the above example) is not a callable, you must continue to +manually define this as a macro for yourself. + +The declaration of the _get_type() function is the first thing emitted by the macro. This allows this macro +to be used in the usual way with export control and API versioning macros. + +If you want to declare your own class structure, use G_DECLARE_DERIVABLE_TYPE(). + +If you are writing a library, it is important to note that it is possible to convert a type from using +G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI. As a precaution, you +should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be +subclassed. Once a class structure has been exposed it is not possible to change its size or remove or +reorder items without breaking the API and/or ABI. + + + + The name of the new type, in camel case (like GtkWidget) + + + The name of the new type in lowercase, with words + separated by '_' (like 'gtk_widget') + + + The name of the module, in all caps (like 'GTK') + + + The bare name of the type, in all caps (like 'WIDGET') + + + the name of the parent type, in camel case (like GtkWidget) + + + + + A convenience macro for emitting the usual declarations in the header file for a GInterface type. + +You might use it in a header as follows: + +|[ +#ifndef _my_model_h_ +#define _my_model_h_ + +#define MY_TYPE_MODEL my_model_get_type () +GDK_AVAILABLE_IN_3_12 +G_DECLARE_INTERFACE (MyModel, my_model, MY, MODEL, GObject) + +struct _MyModelInterface +{ + GTypeInterface g_iface; + + gpointer (* get_item) (MyModel *model); +}; + +gpointer my_model_get_item (MyModel *model); + +... + +#endif +]| + +This results in the following things happening: + +- the usual my_model_get_type() function is declared with a return type of #GType + +- the MyModelInterface type is defined as a typedef to struct _MyModelInterface, + which is left undefined. You should do this from the header file directly after + you use the macro. + +- the MY_MODEL() cast is emitted as static inline functions along with + the MY_IS_MODEL() type checking function and MY_MODEL_GET_IFACE() function. + +- g_autoptr() support being added for your type, based on your prerequisite type. + +You can only use this function if your prerequisite type also supports g_autoptr(). + +Because the type macro (MY_TYPE_MODEL in the above example) is not a callable, you must continue to +manually define this as a macro for yourself. + +The declaration of the _get_type() function is the first thing emitted by the macro. This allows this macro +to be used in the usual way with export control and API versioning macros. + + + + The name of the new type, in camel case (like GtkWidget) + + + The name of the new type in lowercase, with words + separated by '_' (like 'gtk_widget') + + + The name of the module, in all caps (like 'GTK') + + + The bare name of the type, in all caps (like 'WIDGET') + + + the name of the prerequisite type, in camel case (like GtkWidget) + + + + + A convenience macro for type implementations. +Similar to G_DEFINE_TYPE(), but defines an abstract type. +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + + + A convenience macro for type implementations. +Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and +allows you to insert custom code into the *_get_type() function, e.g. +interface implementations via G_IMPLEMENT_INTERFACE(). +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + Custom code that gets inserted in the @type_name_get_type() function. + + + + + Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type. +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + + + A convenience macro for boxed type implementations, which defines a +type_name_get_type() function registering the boxed type. + + + + The name of the new type, in Camel case + + + The name of the new type, in lowercase, with words + separated by '_' + + + the #GBoxedCopyFunc for the new type + + + the #GBoxedFreeFunc for the new type + + + + + A convenience macro for boxed type implementations. +Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the +type_name_get_type() function, e.g. to register value transformations with +g_value_register_transform_func(), for instance: + +|[<!-- language="C" --> +G_DEFINE_BOXED_TYPE_WITH_CODE (GdkRectangle, gdk_rectangle, + gdk_rectangle_copy, + gdk_rectangle_free, + register_rectangle_transform_funcs (g_define_type_id)) +]| + +Similarly to the %G_DEFINE_TYPE family of macros, the #GType of the newly +defined boxed type is exposed in the `g_define_type_id` variable. + + + + The name of the new type, in Camel case + + + The name of the new type, in lowercase, with words + separated by '_' + + + the #GBoxedCopyFunc for the new type + + + the #GBoxedFreeFunc for the new type + + + Custom code that gets inserted in the *_get_type() function + + + + + A convenience macro for dynamic type implementations, which declares a +class initialization function, an instance initialization function (see +#GTypeInfo for information about these) and a static variable named +`t_n`_parent_class pointing to the parent class. Furthermore, +it defines a `*_get_type()` and a static `*_register_type()` functions +for use in your `module_init()`. + +See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example. + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + + + A more general version of G_DEFINE_DYNAMIC_TYPE() which +allows to specify #GTypeFlags and custom code. + +|[ +G_DEFINE_DYNAMIC_TYPE_EXTENDED (GtkGadget, + gtk_gadget, + GTK_TYPE_THING, + 0, + G_IMPLEMENT_INTERFACE_DYNAMIC (TYPE_GIZMO, + gtk_gadget_gizmo_init)); +]| +expands to +|[ +static void gtk_gadget_init (GtkGadget *self); +static void gtk_gadget_class_init (GtkGadgetClass *klass); +static void gtk_gadget_class_finalize (GtkGadgetClass *klass); + +static gpointer gtk_gadget_parent_class = NULL; +static GType gtk_gadget_type_id = 0; + +static void gtk_gadget_class_intern_init (gpointer klass) +{ + gtk_gadget_parent_class = g_type_class_peek_parent (klass); + gtk_gadget_class_init ((GtkGadgetClass*) klass); +} + +GType +gtk_gadget_get_type (void) +{ + return gtk_gadget_type_id; +} + +static void +gtk_gadget_register_type (GTypeModule *type_module) +{ + const GTypeInfo g_define_type_info = { + sizeof (GtkGadgetClass), + (GBaseInitFunc) NULL, + (GBaseFinalizeFunc) NULL, + (GClassInitFunc) gtk_gadget_class_intern_init, + (GClassFinalizeFunc) gtk_gadget_class_finalize, + NULL, // class_data + sizeof (GtkGadget), + 0, // n_preallocs + (GInstanceInitFunc) gtk_gadget_init, + NULL // value_table + }; + gtk_gadget_type_id = g_type_module_register_type (type_module, + GTK_TYPE_THING, + "GtkGadget", + &g_define_type_info, + (GTypeFlags) flags); + { + const GInterfaceInfo g_implement_interface_info = { + (GInterfaceInitFunc) gtk_gadget_gizmo_init + }; + g_type_module_add_interface (type_module, g_define_type_id, TYPE_GIZMO, &g_implement_interface_info); + } +} +]| + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + #GTypeFlags to pass to g_type_module_register_type() + + + Custom code that gets inserted in the *_get_type() function. + + + + + A convenience macro for #GTypeInterface definitions, which declares +a default vtable initialization function and defines a *_get_type() +function. + +The macro expects the interface initialization function to have the +name `t_n ## _default_init`, and the interface structure to have the +name `TN ## Interface`. + +The initialization function has signature +`static void t_n ## _default_init (TypeName##Interface *klass);`, rather than +the full #GInterfaceInitFunc signature, for brevity and convenience. If you +need to use an initialization function with an `iface_data` argument, you +must write the #GTypeInterface definitions manually. + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words separated by '_'. + + + The #GType of the prerequisite type for the interface, or 0 +(%G_TYPE_INVALID) for no prerequisite type. + + + + + A convenience macro for #GTypeInterface definitions. Similar to +G_DEFINE_INTERFACE(), but allows you to insert custom code into the +*_get_type() function, e.g. additional interface implementations +via G_IMPLEMENT_INTERFACE(), or additional prerequisite types. See +G_DEFINE_TYPE_EXTENDED() for a similar example using +G_DEFINE_TYPE_WITH_CODE(). + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words separated by '_'. + + + The #GType of the prerequisite type for the interface, or 0 +(%G_TYPE_INVALID) for no prerequisite type. + + + Custom code that gets inserted in the *_get_type() function. + + + + + A convenience macro for pointer type implementations, which defines a +type_name_get_type() function registering the pointer type. + + + + The name of the new type, in Camel case + + + The name of the new type, in lowercase, with words + separated by '_' + + + + + A convenience macro for pointer type implementations. +Similar to G_DEFINE_POINTER_TYPE(), but allows to insert +custom code into the type_name_get_type() function. + + + + The name of the new type, in Camel case + + + The name of the new type, in lowercase, with words + separated by '_' + + + Custom code that gets inserted in the *_get_type() function + + + + + A convenience macro for type implementations, which declares a class +initialization function, an instance initialization function (see #GTypeInfo +for information about these) and a static variable named `t_n_parent_class` +pointing to the parent class. Furthermore, it defines a *_get_type() function. +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + + + The most general convenience macro for type implementations, on which +G_DEFINE_TYPE(), etc are based. + +|[<!-- language="C" --> +G_DEFINE_TYPE_EXTENDED (GtkGadget, + gtk_gadget, + GTK_TYPE_WIDGET, + 0, + G_ADD_PRIVATE (GtkGadget) + G_IMPLEMENT_INTERFACE (TYPE_GIZMO, + gtk_gadget_gizmo_init)); +]| +expands to +|[<!-- language="C" --> +static void gtk_gadget_init (GtkGadget *self); +static void gtk_gadget_class_init (GtkGadgetClass *klass); +static gpointer gtk_gadget_parent_class = NULL; +static gint GtkGadget_private_offset; +static void gtk_gadget_class_intern_init (gpointer klass) +{ + gtk_gadget_parent_class = g_type_class_peek_parent (klass); + if (GtkGadget_private_offset != 0) + g_type_class_adjust_private_offset (klass, &GtkGadget_private_offset); + gtk_gadget_class_init ((GtkGadgetClass*) klass); +} +static inline gpointer gtk_gadget_get_instance_private (GtkGadget *self) +{ + return (G_STRUCT_MEMBER_P (self, GtkGadget_private_offset)); +} + +GType +gtk_gadget_get_type (void) +{ + static volatile gsize g_define_type_id__volatile = 0; + if (g_once_init_enter (&g_define_type_id__volatile)) + { + GType g_define_type_id = + g_type_register_static_simple (GTK_TYPE_WIDGET, + g_intern_static_string ("GtkGadget"), + sizeof (GtkGadgetClass), + (GClassInitFunc) gtk_gadget_class_intern_init, + sizeof (GtkGadget), + (GInstanceInitFunc) gtk_gadget_init, + 0); + { + GtkGadget_private_offset = + g_type_add_instance_private (g_define_type_id, sizeof (GtkGadgetPrivate)); + } + { + const GInterfaceInfo g_implement_interface_info = { + (GInterfaceInitFunc) gtk_gadget_gizmo_init + }; + g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info); + } + g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); + } + return g_define_type_id__volatile; +} +]| +The only pieces which have to be manually provided are the definitions of +the instance and class structure and the definitions of the instance and +class init functions. + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + #GTypeFlags to pass to g_type_register_static() + + + Custom code that gets inserted in the *_get_type() function. + + + + + A convenience macro for type implementations. +Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the +*_get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). +See G_DEFINE_TYPE_EXTENDED() for an example. + + + + The name of the new type, in Camel case. + + + The name of the new type in lowercase, with words separated by '_'. + + + The #GType of the parent type. + + + Custom code that gets inserted in the *_get_type() function. + + + + + A convenience macro for type implementations, which declares a class +initialization function, an instance initialization function (see #GTypeInfo +for information about these), a static variable named `t_n_parent_class` +pointing to the parent class, and adds private instance data to the type. +Furthermore, it defines a *_get_type() function. See G_DEFINE_TYPE_EXTENDED() +for an example. + +Note that private structs added with this macros must have a struct +name of the form @TN Private. + +The private instance data can be retrieved using the automatically generated +getter function `t_n_get_instance_private()`. + +See also: G_ADD_PRIVATE() + + + + The name of the new type, in Camel case. + + + The name of the new type, in lowercase, with words + separated by '_'. + + + The #GType of the parent type. + + + + + Casts a derived #GEnumClass structure into a #GEnumClass structure. + + + + a valid #GEnumClass + + + + + Get the type identifier from a given #GEnumClass structure. + + + + a #GEnumClass + + + + + Get the static type name from a given #GEnumClass structure. + + + + a #GEnumClass + + + The class of an enumeration type holds information about its possible values. @@ -3078,6 +3916,33 @@ nickname. + + Casts a derived #GFlagsClass structure into a #GFlagsClass structure. + + + + a valid #GFlagsClass + + + + + Get the type identifier from a given #GFlagsClass structure. + + + + a #GFlagsClass + + + + + Get the static type name from a given #GFlagsClass structure. + + + + a #GFlagsClass + + + The class of a flags type holds information about its possible values. @@ -3117,6 +3982,401 @@ nickname. + + A convenience macro to ease interface addition in the `_C_` section +of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE(). +See G_DEFINE_TYPE_EXTENDED() for an example. + +Note that this macro can only be used together with the G_DEFINE_TYPE_* +macros, since it depends on variable names from those macros. + + + + The #GType of the interface to add + + + The interface init function, of type #GInterfaceInitFunc + + + + + A convenience macro to ease interface addition in the @_C_ section +of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). See G_DEFINE_DYNAMIC_TYPE_EXTENDED() +for an example. + +Note that this macro can only be used together with the +G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable +names from that macro. + + + + The #GType of the interface to add + + + The interface init function + + + + + Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) +pointer. Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Casts a derived #GInitiallyUnownedClass structure into a +#GInitiallyUnownedClass structure. + + + + a valid #GInitiallyUnownedClass + + + + + Get the class structure associated to a #GInitiallyUnowned instance. + + + + a #GInitiallyUnowned instance. + + + + + + + + + + + + Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM +or derived. + + + + a #GEnumClass + + + + + Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS +or derived. + + + + a #GFlagsClass + + + + + Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED. + + + + Instance to check for being a %G_TYPE_INITIALLY_UNOWNED. + + + + + Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type +%G_TYPE_INITIALLY_UNOWNED or derived. + + + + a #GInitiallyUnownedClass + + + + + Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_OBJECT. + + + + Instance to check for being a %G_TYPE_OBJECT. + + + + + Checks whether @class "is a" valid #GObjectClass structure of type +%G_TYPE_OBJECT or derived. + + + + a #GObjectClass + + + + + Checks whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM +or derived. + + + + a #GParamSpec + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_CHAR. + + + + a valid #GParamSpec instance + + + + + Checks whether @pclass "is a" valid #GParamSpecClass structure of type +%G_TYPE_PARAM or derived. + + + + a #GParamSpecClass + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_DOUBLE. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLOAT. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_GTYPE. + + + + a #GParamSpec + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT64. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_LONG. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OVERRIDE. + + + + a #GParamSpec + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UCHAR. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT64. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ULONG. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UNICHAR. + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VALUE_ARRAY. + Use #GArray instead of #GValueArray + + + + a valid #GParamSpec instance + + + + + Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VARIANT. + + + + a #GParamSpec + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Checks if @value is a valid and initialized #GValue structure. + + + + A #GValue structure. + + + All the fields in the GInitiallyUnowned structure are private to the #GInitiallyUnowned implementation and should never be @@ -3260,7 +4520,7 @@ accessed directly. - a #GObject + a #GObject @@ -3292,7 +4552,7 @@ accessed directly. - A callback function used by the type system to initialize a new + A callback function used by the type system to initialize a new instance of a type. This function initializes all instance members and allocates any resources required by it. @@ -3303,139 +4563,233 @@ belongs to the type the current initializer was introduced for. The extended members of @instance are guaranteed to have been filled with zeros before this function is called. - + - The instance to initialize + The instance to initialize - The class of the type the instance is + The class of the type the instance is created for - A callback function used by the type system to finalize an interface. + A callback function used by the type system to finalize an interface. This function should destroy any internal data and release any resources allocated by the corresponding GInterfaceInitFunc() function. - + - The interface structure to finalize + The interface structure to finalize - The @interface_data supplied via the #GInterfaceInfo structure + The @interface_data supplied via the #GInterfaceInfo structure - A structure that provides information to the type system which is + A structure that provides information to the type system which is used specifically for managing interface types. - + - location of the interface initialization function + location of the interface initialization function - location of the interface finalization function + location of the interface finalization function - user-supplied data passed to the interface init/finalize functions + user-supplied data passed to the interface init/finalize functions - A callback function used by the type system to initialize a new + A callback function used by the type system to initialize a new interface. This function should initialize all internal data and allocate any resources required by the interface. The members of @iface_data are guaranteed to have been filled with zeros before this function is called. - + - The interface structure to initialize + The interface structure to initialize - The @interface_data supplied via the #GInterfaceInfo structure + The @interface_data supplied via the #GInterfaceInfo structure + + Casts a #GObject or derived pointer into a (GObject*) pointer. +Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Casts a derived #GObjectClass structure into a #GObjectClass structure. + + + + a valid #GObjectClass + + + + + Return the name of a class structure's type. + + + + a valid #GObjectClass + + + + + Get the type id of a class structure. + + + + a valid #GObjectClass + + + + + Get the class structure associated to a #GObject instance. + + + + a #GObject instance. + + + + + Get the type id of an object. + + + + Object to return the type id for. + + + + + Get the name of an object's type. + + + + Object to return the type name for. + + + + + This macro should be used to emit a standard warning about unexpected +properties in set_property() and get_property() implementations. + + + + the #GObject on which set_property() or get_property() was called + + + the numeric id of the property + + + the #GParamSpec of the property + + + + + + + + + + + + + + + + All the fields in the GObject structure are private to the #GObject implementation and should never be accessed directly. - Creates a new instance of a #GObject subtype and sets its properties. + Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. - a new instance of + a new instance of @object_type - the type id of the #GObject subtype to instantiate + the type id of the #GObject subtype to instantiate - the name of the first property + the name of the first property - the value of the first property, followed optionally by more + the value of the first property, followed optionally by more name/value pairs, followed by %NULL - Creates a new instance of a #GObject subtype and sets its properties. + Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. - + - a new instance of @object_type + a new instance of @object_type - the type id of the #GObject subtype to instantiate + the type id of the #GObject subtype to instantiate - the name of the first property + the name of the first property - the value of the first property, followed optionally by more + the value of the first property, followed optionally by more name/value pairs, followed by %NULL - Creates a new instance of a #GObject subtype and sets its properties using + Creates a new instance of a #GObject subtype and sets its properties using the provided arrays. Both arrays must have exactly @n_properties elements, and the names and values correspond by index. @@ -3443,27 +4797,27 @@ Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. - a new instance of + a new instance of @object_type - the object type to instantiate + the object type to instantiate - the number of properties + the number of properties - the names of each property to be set + the names of each property to be set - the values of each property to be set + the values of each property to be set @@ -3471,29 +4825,29 @@ which are not explicitly specified are set to their default values. - Creates a new instance of a #GObject subtype and sets its properties. + Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. Use g_object_new_with_properties() instead. deprecated. See #GParameter for more information. - + - a new instance of + a new instance of @object_type - the type id of the #GObject subtype to instantiate + the type id of the #GObject subtype to instantiate - the length of the @parameters array + the length of the @parameters array - an array of #GParameter + an array of #GParameter @@ -3501,7 +4855,7 @@ deprecated. See #GParameter for more information. - + @@ -3515,32 +4869,32 @@ deprecated. See #GParameter for more information. - Find the #GParamSpec with the given name for an + Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). - the #GParamSpec for the property of the + the #GParamSpec for the property of the interface with the name @property_name, or %NULL if no such property exists. - any interface vtable for the + any interface vtable for the interface, or the default vtable for the interface - name of a property to lookup. + name of a property to look up. - Add a property to an interface; this is only useful for interfaces + Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly @@ -3562,25 +4916,25 @@ If @pspec is a floating reference, it will be consumed. - any interface vtable for the + any interface vtable for the interface, or the default vtable for the interface. - the #GParamSpec for the new property + the #GParamSpec for the new property - Lists the properties of an interface.Generally, the interface + Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). - a + a pointer to an array of pointers to #GParamSpec structures. The paramspecs are owned by GLib, but the array should be freed with g_free() when you are done with @@ -3591,12 +4945,12 @@ already been loaded, g_type_default_interface_peek(). - any interface vtable for the + any interface vtable for the interface, or the default vtable for the interface - location to store number of properties returned. + location to store number of properties returned. @@ -3672,7 +5026,7 @@ already been loaded, g_type_default_interface_peek(). - Emits a "notify" signal for the property @property_name on @object. + Emits a "notify" signal for the property @property_name on @object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() @@ -3688,7 +5042,7 @@ called. - a #GObject + a #GObject @@ -3717,7 +5071,7 @@ called. - Increases the reference count of the object by one and sets a + Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established. @@ -3745,29 +5099,29 @@ however if there are multiple toggle references to an object, none of them will ever be notified until all but one are removed. For this reason, you should only ever use a toggle reference if there is important state in the proxy object. - + - a #GObject + a #GObject - a function to call when this reference is the + a function to call when this reference is the last reference to the object, or is no longer the last reference. - data to pass to @notify + data to pass to @notify - Adds a weak reference from weak_pointer to @object to indicate that + Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL. @@ -3776,24 +5130,24 @@ Note that as with g_object_weak_ref(), the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use #GWeakRef if thread-safety is required. - + - The object that should be weak referenced. + The object that should be weak referenced. - The memory address + The memory address of a pointer. - Creates a binding between @source_property on @source and @target_property + Creates a binding between @source_property on @source and @target_property on @target. Whenever the @source_property is changed the @target_property is updated using the same value. For instance: @@ -3817,36 +5171,36 @@ The binding will automatically be removed when either the @source or the A #GObject can have multiple bindings. - the #GBinding instance representing the + the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. - the source #GObject + the source #GObject - the property on @source to bind + the property on @source to bind - the target #GObject + the target #GObject - the property on @target to bind + the property on @target to bind - flags to pass to #GBinding + flags to pass to #GBinding - Complete version of g_object_bind_property(). + Complete version of g_object_bind_property(). Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by @@ -3873,56 +5227,56 @@ for each transformation function, please use g_object_bind_property_with_closures() instead. - the #GBinding instance representing the + the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. - the source #GObject + the source #GObject - the property on @source to bind + the property on @source to bind - the target #GObject + the target #GObject - the property on @target to bind + the property on @target to bind - flags to pass to #GBinding + flags to pass to #GBinding - the transformation function + the transformation function from the @source to the @target, or %NULL to use the default - the transformation function + the transformation function from the @target to the @source, or %NULL to use the default - custom data to be passed to the transformation functions, + custom data to be passed to the transformation functions, or %NULL - a function to call when disposing the binding, to free + a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required - Creates a binding between @source_property on @source and @target_property + Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by the binding. @@ -3931,46 +5285,46 @@ g_object_bind_property_full(), using #GClosures instead of function pointers. - the #GBinding instance representing the + the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. - the source #GObject + the source #GObject - the property on @source to bind + the property on @source to bind - the target #GObject + the target #GObject - the property on @target to bind + the property on @target to bind - flags to pass to #GBinding + flags to pass to #GBinding - a #GClosure wrapping the transformation function + a #GClosure wrapping the transformation function from the @source to the @target, or %NULL to use the default - a #GClosure wrapping the transformation function + a #GClosure wrapping the transformation function from the @target to the @source, or %NULL to use the default - A convenience function to connect multiple signals at once. + A convenience function to connect multiple signals at once. The signal specs expected by this function have the form "modifier::signal_name", where modifier can be one of the following: @@ -3993,22 +5347,22 @@ The signal specs expected by this function have the form "signal::destroy", gtk_widget_destroyed, &menu->toplevel, NULL); ]| - + - @object + @object - a #GObject + a #GObject - the spec for the first signal + the spec for the first signal - #GCallback for the first signal, followed by data for the + #GCallback for the first signal, followed by data for the first signal, followed optionally by more signal spec/callback/data triples, followed by %NULL @@ -4016,27 +5370,27 @@ The signal specs expected by this function have the form - A convenience function to disconnect multiple signals at once. + A convenience function to disconnect multiple signals at once. The signal specs expected by this function have the form "any_signal", which means to disconnect any signal with matching callback and data, or "any_signal::signal_name", which only disconnects the signal named "signal_name". - + - a #GObject + a #GObject - the spec for the first signal + the spec for the first signal - #GCallback for the first signal, followed by data for the first signal, + #GCallback for the first signal, followed by data for the first signal, followed optionally by more signal spec/callback/data triples, followed by %NULL @@ -4044,7 +5398,7 @@ disconnects the signal named "signal_name". - This is a variant of g_object_get_data() which returns + This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -4058,9 +5412,9 @@ is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. - + - the result of calling @dup_func on the value + the result of calling @dup_func on the value associated with @key on @object, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. @@ -4068,25 +5422,25 @@ object. - the #GObject to store user data on + the #GObject to store user data on - a string, naming the user data pointer + a string, naming the user data pointer - function to dup the value + function to dup the value - passed as user_data to @dup_func + passed as user_data to @dup_func - This is a variant of g_object_get_qdata() which returns + This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -4100,9 +5454,9 @@ is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. - + - the result of calling @dup_func on the value + the result of calling @dup_func on the value associated with @quark on @object, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. @@ -4110,41 +5464,41 @@ object. - the #GObject to store user data on + the #GObject to store user data on - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - function to dup the value + function to dup the value - passed as user_data to @dup_func + passed as user_data to @dup_func - This function is intended for #GObject implementations to re-enforce + This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink(). - + - a #GObject + a #GObject - Increases the freeze count on @object. If the freeze count is + Increases the freeze count on @object. If the freeze count is non-zero, the emission of "notify" signals on @object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one @@ -4153,19 +5507,19 @@ object is frozen. This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified. - + - a #GObject + a #GObject - Gets properties of an object. + Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for @@ -4189,147 +5543,154 @@ of three properties: an integer, a string and an object: g_free (strval); g_object_unref (objval); ]| - + - a #GObject + a #GObject - name of the first property to get + name of the first property to get - return location for the first property, followed optionally by more + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - Gets a named field from the objects table of associations (see g_object_set_data()). - + Gets a named field from the objects table of associations (see g_object_set_data()). + - the data if found, + the data if found, or %NULL if no such data exists. - #GObject containing the associations + #GObject containing the associations - name of the key for that association + name of the key for that association - Gets a property of an object. @value must have been initialized to the -expected type of the property (or a type to which the expected type can be -transformed) using g_value_init(). + Gets a property of an object. + +The @value can be: + + - an empty #GValue initialized by %G_VALUE_INIT, which will be + automatically initialized with the expected type of the property + (since GLib 2.60) + - a #GValue initialized with the expected type of the property + - a #GValue initialized with a type to which the expected type + of the property can be transformed In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset(). Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming. - + - a #GObject + a #GObject - the name of the property to get + the name of the property to get - return location for the property value + return location for the property value - This function gets back user data pointers stored via + This function gets back user data pointers stored via g_object_set_qdata(). - + - The user data pointer set, or %NULL + The user data pointer set, or %NULL - The GObject to get a stored user data pointer from + The GObject to get a stored user data pointer from - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer - Gets properties of an object. + Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for the type, for instance by calling g_free() or g_object_unref(). See g_object_get(). - + - a #GObject + a #GObject - name of the first property to get + name of the first property to get - return location for the first property, followed optionally by more + return location for the first property, followed optionally by more name/return location pairs, followed by %NULL - Gets @n_properties properties for an @object. + Gets @n_properties properties for an @object. Obtained properties will be set to @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in. - + - a #GObject + a #GObject - the number of properties + the number of properties - the names of each property to get + the names of each property to get - the values of each property to get + the values of each property to get @@ -4337,21 +5698,21 @@ properties are passed in. - Checks whether @object has a [floating][floating-ref] reference. - + Checks whether @object has a [floating][floating-ref] reference. + - %TRUE if @object has a floating reference + %TRUE if @object has a floating reference - a #GObject + a #GObject - Emits a "notify" signal for the property @property_name on @object. + Emits a "notify" signal for the property @property_name on @object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() @@ -4361,23 +5722,23 @@ Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called. - + - a #GObject + a #GObject - the name of a property installed on the class of @object. + the name of a property installed on the class of @object. - Emits a "notify" signal for the property specified by @pspec on @object. + Emits a "notify" signal for the property specified by @pspec on @object. This function omits the property name lookup, hence it is faster than g_object_notify(). @@ -4415,42 +5776,42 @@ and then notify a change on the "foo" property with: |[<!-- language="C" --> g_object_notify_by_pspec (self, properties[PROP_FOO]); ]| - + - a #GObject + a #GObject - the #GParamSpec of a property installed on the class of @object. + the #GParamSpec of a property installed on the class of @object. - Increases the reference count of @object. + Increases the reference count of @object. Since GLib 2.56, if `GLIB_VERSION_MAX_ALLOWED` is 2.56 or greater, the type of @object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit. - + - the same @object + the same @object - a #GObject + a #GObject - Increase the reference count of @object, and possibly remove the + Increase the reference count of @object, and possibly remove the [floating][floating-ref] reference, if @object has a floating reference. In other words, if the object is floating, then this call "assumes @@ -4461,64 +5822,64 @@ adds a new normal reference increasing the reference count by one. Since GLib 2.56, the type of @object will be propagated to the return type under the same conditions as for g_object_ref(). - + - @object + @object - a #GObject + a #GObject - Removes a reference added with g_object_add_toggle_ref(). The + Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one. - + - a #GObject + a #GObject - a function to call when this reference is the + a function to call when this reference is the last reference to the object, or is no longer the last reference. - data to pass to @notify + data to pass to @notify - Removes a weak reference from @object that was previously added + Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer(). - + - The object that is weak referenced. + The object that is weak referenced. - The memory address + The memory address of a pointer. - Compares the user data for the key @key on @object with + Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval. @@ -4530,42 +5891,45 @@ old value (@oldval) is passed to the caller, including the registered destroy notify for it (passed out in @old_destroy). It’s up to the caller to free this as needed, which may or may not include using @old_destroy as sometimes replacement -should not destroy the object in the normal way. - +should not destroy the object in the normal way. + +See g_object_set_data() for guidance on using a small, bounded set of values +for @key. + - %TRUE if the existing value for @key was replaced + %TRUE if the existing value for @key was replaced by @newval, %FALSE otherwise. - the #GObject to store user data on + the #GObject to store user data on - a string, naming the user data pointer + a string, naming the user data pointer - the old value to compare against + the old value to compare against - the new value + the new value - a destroy notify for the new value + a destroy notify for the new value - destroy notify for the existing value + destroy notify for the existing value - Compares the user data for the key @quark on @object with + Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval. @@ -4578,158 +5942,163 @@ the registered destroy notify for it (passed out in @old_destroy). It’s up to the caller to free this as needed, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. - + - %TRUE if the existing value for @quark was replaced + %TRUE if the existing value for @quark was replaced by @newval, %FALSE otherwise. - the #GObject to store user data on + the #GObject to store user data on - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - the old value to compare against + the old value to compare against - the new value + the new value - a destroy notify for the new value + a destroy notify for the new value - destroy notify for the existing value + destroy notify for the existing value - Releases all references to other objects. This can be used to break + Releases all references to other objects. This can be used to break reference cycles. This function should only be called from object system implementations. - + - a #GObject + a #GObject - Sets properties on an object. + Sets properties on an object. Note that the "notify" signals are queued and only emitted (in reverse order) after all properties have been set. See g_object_freeze_notify(). - + - a #GObject + a #GObject - name of the first property to set + name of the first property to set - value for the first property, followed optionally by more + value for the first property, followed optionally by more name/value pairs, followed by %NULL - Each object carries around a table of associations from + Each object carries around a table of associations from strings to pointers. This function lets you set an association. If the object already had an association with that name, -the old association will be destroyed. - +the old association will be destroyed. + +Internally, the @key is converted to a #GQuark using g_quark_from_string(). +This means a copy of @key is kept permanently (even after @object has been +finalized) — so it is recommended to only use a small, bounded set of values +for @key in your program, to avoid the #GQuark storage growing unbounded. + - #GObject containing the associations. + #GObject containing the associations. - name of the key + name of the key - data to associate with that key + data to associate with that key - Like g_object_set_data() except it adds notification + Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed. Note that the @destroy callback is not called if @data is %NULL. - + - #GObject containing the associations + #GObject containing the associations - name of the key + name of the key - data to associate with that key + data to associate with that key - function to call when the association is destroyed + function to call when the association is destroyed - Sets a property on an object. - + Sets a property on an object. + - a #GObject + a #GObject - the name of the property to set + the name of the property to set - the value + the value - This sets an opaque, named pointer on an object. + This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() @@ -4737,103 +6106,103 @@ until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored. - + - The GObject to set store a user data pointer + The GObject to set store a user data pointer - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer - An opaque user data pointer + An opaque user data pointer - This function works like g_object_set_qdata(), but in addition, + This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark. - + - The GObject to set store a user data pointer + The GObject to set store a user data pointer - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer - An opaque user data pointer + An opaque user data pointer - Function to invoke with @data as argument, when @data + Function to invoke with @data as argument, when @data needs to be freed - Sets properties on an object. - + Sets properties on an object. + - a #GObject + a #GObject - name of the first property to set + name of the first property to set - value for the first property, followed optionally by more + value for the first property, followed optionally by more name/value pairs, followed by %NULL - Sets @n_properties properties for an @object. + Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in. - + - a #GObject + a #GObject - the number of properties + the number of properties - the names of each property to be set + the names of each property to be set - the values of each property to be set + the values of each property to be set @@ -4841,27 +6210,27 @@ properties are passed in. - Remove a specified datum from the object's data associations, + Remove a specified datum from the object's data associations, without invoking the association's destroy handler. - + - the data if found, or %NULL + the data if found, or %NULL if no such data exists. - #GObject containing the associations + #GObject containing the associations - name of the key + name of the key - This function gets back user data pointers stored via + This function gets back user data pointers stored via g_object_set_qdata() and removes the @data from object without invoking its destroy() function (if any was set). @@ -4896,24 +6265,24 @@ Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full(). - + - The user data pointer set, or %NULL + The user data pointer set, or %NULL - The GObject to get a stored user data pointer from + The GObject to get a stored user data pointer from - A #GQuark, naming the user data pointer + A #GQuark, naming the user data pointer - Reverts the effect of a previous call to + Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted. @@ -4922,38 +6291,38 @@ Duplicate notifications for each property are squashed so that at most one in which they have been queued. It is an error to call this function when the freeze count is zero. - + - a #GObject + a #GObject - Decreases the reference count of @object. When its reference count + Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed). If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this. - + - a #GObject + a #GObject - This function essentially limits the life time of the @closure to + This function essentially limits the life time of the @closure to the life time of the object. That is, when the object is finalized, the @closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized @@ -4962,23 +6331,23 @@ added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the @closure. Usually, this function will be called on closures that use this @object as closure data. - + - #GObject restricting lifetime of @closure + #GObject restricting lifetime of @closure - #GClosure to watch + #GClosure to watch - Adds a weak reference callback to an object. Weak references are + Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a @@ -4988,42 +6357,42 @@ Note that the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use #GWeakRef if thread-safety is required. - + - #GObject to reference weakly + #GObject to reference weakly - callback to invoke before the object is freed + callback to invoke before the object is freed - extra data to pass to notify + extra data to pass to notify - Removes a weak reference callback to an object. - + Removes a weak reference callback to an object. + - #GObject to remove a weak reference from + #GObject to remove a weak reference from - callback to search for + callback to search for - data to search for + data to search for @@ -5225,7 +6594,7 @@ my_singleton_constructor (GType type, - a #GObject + a #GObject @@ -5256,26 +6625,26 @@ my_singleton_constructor (GType type, - Looks up the #GParamSpec for a property of a class. + Looks up the #GParamSpec for a property of a class. - the #GParamSpec for the property, or + the #GParamSpec for the property, or %NULL if the class doesn't have a property of that name - a #GObjectClass + a #GObjectClass - the name of the property to look up + the name of the property to look up - Installs new properties from an array of #GParamSpecs. + 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 @@ -5342,15 +6711,15 @@ my_object_set_foo (MyObject *self, gint foo) - a #GObjectClass + a #GObjectClass - the length of the #GParamSpecs array + the length of the #GParamSpecs array - the #GParamSpecs array + the #GParamSpecs array defining the new properties @@ -5359,7 +6728,7 @@ my_object_set_foo (MyObject *self, gint foo) - Installs a new property. + 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 @@ -5375,24 +6744,24 @@ e.g. to change the range of allowed values or the default value. - a #GObjectClass + a #GObjectClass - the id for the new property + the id for the new property - the #GParamSpec for the new property + the #GParamSpec for the new property - Get an array of #GParamSpec* for all properties of a class. + Get an array of #GParamSpec* for all properties of a class. - an array of + an array of #GParamSpec* which should be freed after use @@ -5400,17 +6769,17 @@ e.g. to change the range of allowed values or the default value. - a #GObjectClass + a #GObjectClass - return location for the length of the returned array + return location for the length of the returned array - Registers @property_id as referring to a property with the name + Registers @property_id as referring to a property with the name @name in a parent class or in an interface implemented by @oclass. This allows this class to "override" a property implementation in a parent class or to provide the implementation of a property from @@ -5432,15 +6801,15 @@ g_param_spec_get_redirect_target(). - a #GObjectClass + a #GObjectClass - the new property ID + the new property ID - the name of a property registered in a parent class or + the name of a property registered in a parent class or in an interface of this class. @@ -5527,27 +6896,350 @@ a #GObjectClass. - Mask containing the bits of #GParamSpec.flags which are reserved for GLib. - + Mask containing the bits of #GParamSpec.flags which are reserved for GLib. + + + Casts a derived #GParamSpec object (e.g. of type #GParamSpecInt) into +a #GParamSpec object. + + + + a valid #GParamSpec + + + + + Cast a #GParamSpec instance into a #GParamSpecBoolean. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecBoxed. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecChar. + + + + a valid #GParamSpec instance + + + + + Casts a derived #GParamSpecClass structure into a #GParamSpecClass structure. + + + + a valid #GParamSpecClass + + + + + Cast a #GParamSpec instance into a #GParamSpecDouble. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecEnum. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecFlags. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecFloat. + + + + a valid #GParamSpec instance + + + + + Retrieves the #GParamSpecClass of a #GParamSpec. + + + + a valid #GParamSpec + + + + + Casts a #GParamSpec into a #GParamSpecGType. + + + + a #GParamSpec + + + + + Cast a #GParamSpec instance into a #GParamSpecInt. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecInt64. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecLong. + + + + a valid #GParamSpec instance + + + + + Casts a #GParamSpec instance into a #GParamSpecObject. + + + + a valid #GParamSpec instance + + + + + Casts a #GParamSpec into a #GParamSpecOverride. + + + + a #GParamSpec + + + + + Casts a #GParamSpec instance into a #GParamSpecParam. + + + + a valid #GParamSpec instance + + + + + Casts a #GParamSpec instance into a #GParamSpecPointer. + + + + a valid #GParamSpec instance + + + + + Casts a #GParamSpec instance into a #GParamSpecString. + + + + a valid #GParamSpec instance + + + + + Retrieves the #GType of this @pspec. + + + + a valid #GParamSpec + + + + + Retrieves the #GType name of this @pspec. + + + + a valid #GParamSpec + + + + + Cast a #GParamSpec instance into a #GParamSpecUChar. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecUInt. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecUInt64. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecULong. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecUnichar. + + + + a valid #GParamSpec instance + + + + + Cast a #GParamSpec instance into a #GParamSpecValueArray. + Use #GArray instead of #GValueArray + + + + a valid #GParamSpec instance + + + + + Retrieves the #GType to initialize a #GValue for this parameter. + + + + a valid #GParamSpec + + + + + Casts a #GParamSpec into a #GParamSpecVariant. + + + + a #GParamSpec + + + - #GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB. + #GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB. Since 2.13.0 - + - Minimum shift count to be used for user defined flags, to be stored in + Minimum shift count to be used for user defined flags, to be stored in #GParamSpec.flags. The maximum allowed is 10. - + + + Evaluates to the @field_name inside the @inst private data +structure for @TypeName. + +Note that this macro can only be used together with the G_DEFINE_TYPE_* +and G_ADD_PRIVATE() macros, since it depends on variable names from +those macros. + + + + the name of the type in CamelCase + + + the instance of @TypeName you wish to access + + + the type of the field in the private data structure + + + the name of the field in the private data structure + + + + + Evaluates to a pointer to the @field_name inside the @inst private data +structure for @TypeName. + +Note that this macro can only be used together with the G_DEFINE_TYPE_* +and G_ADD_PRIVATE() macros, since it depends on variable names from +those macros. + + + + the name of the type in CamelCase + + + the instance of @TypeName you wish to access + + + the name of the field in the private data structure + + + + + Evaluates to the offset of the @field inside the instance private data +structure for @TypeName. + +Note that this macro can only be used together with the G_DEFINE_TYPE_* +and G_ADD_PRIVATE() macros, since it depends on variable names from +those macros. + + + + the name of the type in CamelCase + + + the name of the field in the private data structure + + + Through the #GParamFlags flag values, certain aspects of parameters can be configured. See also #G_PARAM_STATIC_STRINGS. - + the parameter is readable @@ -5602,7 +7294,7 @@ can be configured. See also #G_PARAM_STATIC_STRINGS. - #GParamSpec is an object structure that encapsulates the metadata + #GParamSpec is an object structure that encapsulates the metadata required to specify parameters, such as e.g. #GObject properties. ## Parameter names # {#canonical-parameter-names} @@ -5612,9 +7304,9 @@ Subsequent characters can be letters, numbers or a '-'. All other characters are replaced by a '-' during construction. The result of this replacement is called the canonical name of the parameter. - + - Creates a new #GParamSpec instance. + Creates a new #GParamSpec instance. A property name consists of segments consisting of ASCII letters and digits, separated by either the '-' or '_' character. The first @@ -5631,36 +7323,36 @@ strings associated with them, the @nick, which should be suitable for use as a label for the property in a property editor, and the @blurb, which should be a somewhat longer description, suitable for e.g. a tooltip. The @nick and @blurb should ideally be localized. - + - a newly allocated #GParamSpec instance + a newly allocated #GParamSpec instance - the #GType for the property; must be derived from #G_TYPE_PARAM + the #GType for the property; must be derived from #G_TYPE_PARAM - the canonical name of the property + the canonical name of the property - the nickname of the property + the nickname of the property - a short description of the property + a short description of the property - a combination of #GParamFlags + a combination of #GParamFlags - + @@ -5671,7 +7363,7 @@ e.g. a tooltip. The @nick and @blurb should ideally be localized. - + @@ -5685,7 +7377,7 @@ e.g. a tooltip. The @nick and @blurb should ideally be localized. - + @@ -5699,7 +7391,7 @@ e.g. a tooltip. The @nick and @blurb should ideally be localized. - + @@ -5716,274 +7408,274 @@ e.g. a tooltip. The @nick and @blurb should ideally be localized. - Get the short description of a #GParamSpec. - + Get the short description of a #GParamSpec. + - the short description of @pspec. + the short description of @pspec. - a valid #GParamSpec + a valid #GParamSpec - Gets the default value of @pspec as a pointer to a #GValue. + Gets the default value of @pspec as a pointer to a #GValue. The #GValue will remain valid for the life of @pspec. - + - a pointer to a #GValue which must not be modified + a pointer to a #GValue which must not be modified - a #GParamSpec + a #GParamSpec - Get the name of a #GParamSpec. + Get the name of a #GParamSpec. The name is always an "interned" string (as per g_intern_string()). This allows for pointer-value comparisons. - + - the name of @pspec. + the name of @pspec. - a valid #GParamSpec + a valid #GParamSpec - Gets the GQuark for the name. - + Gets the GQuark for the name. + - the GQuark for @pspec->name. + the GQuark for @pspec->name. - a #GParamSpec + a #GParamSpec - Get the nickname of a #GParamSpec. - + Get the nickname of a #GParamSpec. + - the nickname of @pspec. + the nickname of @pspec. - a valid #GParamSpec + a valid #GParamSpec - Gets back user data pointers stored via g_param_spec_set_qdata(). - + Gets back user data pointers stored via g_param_spec_set_qdata(). + - the user data pointer set, or %NULL + the user data pointer set, or %NULL - a valid #GParamSpec + a valid #GParamSpec - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - If the paramspec redirects operations to another paramspec, + If the paramspec redirects operations to another paramspec, returns that paramspec. Redirect is used typically for providing a new implementation of a property in a derived type while preserving all the properties from the parent type. Redirection is established by creating a property of type #GParamSpecOverride. See g_object_class_override_property() for an example of the use of this capability. - + - paramspec to which requests on this + paramspec to which requests on this paramspec should be redirected, or %NULL if none. - a #GParamSpec + a #GParamSpec - Increments the reference count of @pspec. - + Increments the reference count of @pspec. + - the #GParamSpec that was passed into this function + the #GParamSpec that was passed into this function - a valid #GParamSpec + a valid #GParamSpec - Convenience function to ref and sink a #GParamSpec. - + Convenience function to ref and sink a #GParamSpec. + - the #GParamSpec that was passed into this function + the #GParamSpec that was passed into this function - a valid #GParamSpec + a valid #GParamSpec - Sets an opaque, named pointer on a #GParamSpec. The name is + Sets an opaque, named pointer on a #GParamSpec. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @pspec with g_param_spec_get_qdata(). Setting a previously set user data pointer, overrides (frees) the old pointer set, using %NULL as pointer essentially removes the data stored. - + - the #GParamSpec to set store a user data pointer + the #GParamSpec to set store a user data pointer - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - an opaque user data pointer + an opaque user data pointer - This function works like g_param_spec_set_qdata(), but in addition, + This function works like g_param_spec_set_qdata(), but in addition, a `void (*destroy) (gpointer)` function may be specified which is called with @data as argument when the @pspec is finalized, or the data is being overwritten by a call to g_param_spec_set_qdata() with the same @quark. - + - the #GParamSpec to set store a user data pointer + the #GParamSpec to set store a user data pointer - a #GQuark, naming the user data pointer + a #GQuark, naming the user data pointer - an opaque user data pointer + an opaque user data pointer - function to invoke with @data as argument, when @data needs to + function to invoke with @data as argument, when @data needs to be freed - The initial reference count of a newly created #GParamSpec is 1, + The initial reference count of a newly created #GParamSpec is 1, even though no one has explicitly called g_param_spec_ref() on it yet. So the initial reference count is flagged as "floating", until someone calls `g_param_spec_ref (pspec); g_param_spec_sink (pspec);` in sequence on it, taking over the initial reference count (thus ending up with a @pspec that has a reference count of 1 still, but is not flagged "floating" anymore). - - - - - - - a valid #GParamSpec - - - - - - Gets back user data pointers stored via g_param_spec_set_qdata() -and removes the @data from @pspec without invoking its destroy() -function (if any was set). Usually, calling this function is only -required to update user data pointers with a destroy notifier. - - - the user data pointer set, or %NULL - - - - - the #GParamSpec to get a stored user data pointer from - - - - a #GQuark, naming the user data pointer - - - - - - Decrements the reference count of a @pspec. - a valid #GParamSpec + a valid #GParamSpec + + + + + + Gets back user data pointers stored via g_param_spec_set_qdata() +and removes the @data from @pspec without invoking its destroy() +function (if any was set). Usually, calling this function is only +required to update user data pointers with a destroy notifier. + + + the user data pointer set, or %NULL + + + + + the #GParamSpec to get a stored user data pointer from + + + + a #GQuark, naming the user data pointer + + + + + + Decrements the reference count of a @pspec. + + + + + + + a valid #GParamSpec - private #GTypeInstance portion + private #GTypeInstance portion - name of this parameter: always an interned string + name of this parameter: always an interned string - #GParamFlags flags for this parameter + #GParamFlags flags for this parameter - the #GValue type for this parameter + the #GValue type for this parameter - #GType type that uses (introduces) this parameter + #GType type that uses (introduces) this parameter @@ -6040,21 +7732,21 @@ required to update user data pointers with a destroy notifier. - The class structure for the GParamSpec type. + The class structure for the GParamSpec type. Normally, GParamSpec classes are filled by g_param_type_register_static(). - + - the parent class + the parent class - the #GValue type for this parameter + the #GValue type for this parameter - + @@ -6067,7 +7759,7 @@ g_param_type_register_static(). - + @@ -6083,7 +7775,7 @@ g_param_type_register_static(). - + @@ -6099,7 +7791,7 @@ g_param_type_register_static(). - + @@ -6313,34 +8005,34 @@ properties. quickly accessed by owner and name. The implementation of the #GObject property system uses such a pool to store the #GParamSpecs of the properties all object types. - + - Inserts a #GParamSpec in the pool. - + Inserts a #GParamSpec in the pool. + - a #GParamSpecPool. + a #GParamSpecPool. - the #GParamSpec to insert + the #GParamSpec to insert - a #GType identifying the owner of @pspec + a #GType identifying the owner of @pspec - Gets an array of all #GParamSpecs owned by @owner_type in + Gets an array of all #GParamSpecs owned by @owner_type in the pool. - + - a newly + a newly allocated array containing pointers to all #GParamSpecs owned by @owner_type in the pool @@ -6349,25 +8041,25 @@ the pool. - a #GParamSpecPool + a #GParamSpecPool - the owner to look for + the owner to look for - return location for the length of the returned array + return location for the length of the returned array - Gets an #GList of all #GParamSpecs owned by @owner_type in + Gets an #GList of all #GParamSpecs owned by @owner_type in the pool. - + - a + a #GList of all #GParamSpecs owned by @owner_type in the pool#GParamSpecs. @@ -6376,75 +8068,75 @@ the pool. - a #GParamSpecPool + a #GParamSpecPool - the owner to look for + the owner to look for - Looks up a #GParamSpec in the pool. - + Looks up a #GParamSpec in the pool. + - The found #GParamSpec, or %NULL if no + The found #GParamSpec, or %NULL if no matching #GParamSpec was found. - a #GParamSpecPool + a #GParamSpecPool - the name to look for + the name to look for - the owner to look for + the owner to look for - If %TRUE, also try to find a #GParamSpec with @param_name + If %TRUE, also try to find a #GParamSpec with @param_name owned by an ancestor of @owner_type. - Removes a #GParamSpec from the pool. - + Removes a #GParamSpec from the pool. + - a #GParamSpecPool + a #GParamSpecPool - the #GParamSpec to remove + the #GParamSpec to remove - Creates a new #GParamSpecPool. + Creates a new #GParamSpecPool. If @type_prefixing is %TRUE, lookups in the newly created pool will allow to specify the owner as a colon-separated prefix of the property name, like "GtkContainer:border-width". This feature is deprecated, so you should always set @type_prefixing to %FALSE. - + - a newly allocated #GParamSpecPool. + a newly allocated #GParamSpecPool. - Whether the pool will support type-prefixed property names. + Whether the pool will support type-prefixed property names. @@ -6483,25 +8175,25 @@ properties. - This structure is used to provide the type system with the information + This structure is used to provide the type system with the information required to initialize and destruct (finalize) a parameter's class and instances thereof. The initialized structure is passed to the g_param_type_register_static() The type system will perform a deep copy of this structure, so its memory does not need to be persistent across invocation of g_param_type_register_static(). - + - Size of the instance (object) structure. + Size of the instance (object) structure. - Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. + Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. - + @@ -6513,12 +8205,12 @@ g_param_type_register_static(). - The #GType of values conforming to this #GParamSpec + The #GType of values conforming to this #GParamSpec - + @@ -6531,7 +8223,7 @@ g_param_type_register_static(). - + @@ -6547,7 +8239,7 @@ g_param_type_register_static(). - + @@ -6563,7 +8255,7 @@ g_param_type_register_static(). - + @@ -6710,16 +8402,16 @@ values compare equal. - The GParameter struct is an auxiliary structure used + The GParameter struct is an auxiliary structure used to hand parameter name/value pairs to g_object_newv(). This type is not introspectable. - + - the parameter name + the parameter name - the parameter value + the parameter value @@ -6931,11 +8623,199 @@ filled in by the g_signal_query() function. + + Checks that @g_class is a class structure of the type identified by @g_type +and issues a warning if this is not the case. Returns @g_class casted +to a pointer to @c_type. %NULL is not a valid class structure. + +This macro should only be used in type implementations. + + + + Location of a #GTypeClass structure + + + The type to be returned + + + The corresponding C type of class structure of @g_type + + + + + Checks if @g_class is a class structure of the type identified by +@g_type. If @g_class is %NULL, %FALSE will be returned. + +This macro should only be used in type implementations. + + + + Location of a #GTypeClass structure + + + The type to be checked + + + + + Checks if @instance is a valid #GTypeInstance structure, +otherwise issues a warning and returns %FALSE. %NULL is not a valid +#GTypeInstance. + +This macro should only be used in type implementations. + + + + Location of a #GTypeInstance structure + + + + + Checks that @instance is an instance of the type identified by @g_type +and issues a warning if this is not the case. Returns @instance casted +to a pointer to @c_type. + +No warning will be issued if @instance is %NULL, and %NULL will be returned. + +This macro should only be used in type implementations. + + + + Location of a #GTypeInstance structure + + + The type to be returned + + + The corresponding C type of @g_type + + + + + Checks if @instance is an instance of the fundamental type identified by @g_type. +If @instance is %NULL, %FALSE will be returned. + +This macro should only be used in type implementations. + + + + Location of a #GTypeInstance structure. + + + The fundamental type to be checked + + + + + Checks if @instance is an instance of the type identified by @g_type. If +@instance is %NULL, %FALSE will be returned. + +This macro should only be used in type implementations. + + + + Location of a #GTypeInstance structure. + + + The type to be checked + + + + + Checks if @value has been initialized to hold values +of a value type. + +This macro should only be used in type implementations. + + + + a #GValue + + + + + Checks if @value has been initialized to hold values +of type @g_type. + +This macro should only be used in type implementations. + + + + a #GValue + + + The type to be checked + + + + + Gets the private class structure for a particular type. +The private structure must have been registered in the +get_type() function with g_type_add_class_private(). + +This macro should only be used in type implementations. + + + + the class of a type deriving from @private_type + + + the type identifying which private data to retrieve + + + The C type for the private structure + + + - A bit in the type number that's supposed to be left untouched. - + A bit in the type number that's supposed to be left untouched. + + + Get the type identifier from a given @class structure. + +This macro should only be used in type implementations. + + + + Location of a valid #GTypeClass structure + + + + + Get the type identifier from a given @instance structure. + +This macro should only be used in type implementations. + + + + Location of a valid #GTypeInstance structure + + + + + Get the type identifier from a given @interface structure. + +This macro should only be used in type implementations. + + + + Location of a valid #GTypeInterface structure + + + + + The fundamental type which is the ancestor of @type. +Fundamental types are types that serve as ultimate bases for the derived types, +thus they are the roots of distinct inheritance hierarchies. + + + + A #GType value. + + + An integer constant that represents the number of identifiers reserved for types that are assigned at compile-time. @@ -6943,56 +8823,336 @@ for types that are assigned at compile-time. - Shift value used in converting numbers to type IDs. - + Shift value used in converting numbers to type IDs. + + + Checks if @type has a #GTypeValueTable. + + + + A #GType value + + + + + Get the class structure of a given @instance, casted +to a specified ancestor type @g_type of the instance. + +Note that while calling a GInstanceInitFunc(), the class pointer +gets modified, so it might not always return the expected pointer. + +This macro should only be used in type implementations. + + + + Location of the #GTypeInstance structure + + + The #GType of the class to be returned + + + The C type of the class structure + + + + + Get the interface structure for interface @g_type of a given @instance. + +This macro should only be used in type implementations. + + + + Location of the #GTypeInstance structure + + + The #GType of the interface to be returned + + + The C type of the interface structure + + + + + Gets the private structure for a particular type. +The private structure must have been registered in the +class_init function with g_type_class_add_private(). + +This macro should only be used in type implementations. + Use %G_ADD_PRIVATE and the generated + `your_type_get_instance_private()` function instead + + + + the instance of a type deriving from @private_type + + + the type identifying which private data to retrieve + + + The C type for the private structure + + + + + Checks if @type is an abstract type. An abstract type cannot be +instantiated and is normally used as an abstract base class for +derived classes. + + + + A #GType value + + + + + + + + + + + + Checks if @type is a classed type. + + + + A #GType value + + + + + Checks if @type is a deep derivable type. A deep derivable type +can be used as the base class of a deep (multi-level) class hierarchy. + + + + A #GType value + + + + + Checks if @type is a derivable type. A derivable type can +be used as the base class of a flat (single-level) class hierarchy. + + + + A #GType value + + + + + Checks if @type is derived (or in object-oriented terminology: +inherited) from another type (this holds true for all non-fundamental +types). + + + + A #GType value + + + + + Checks whether @type "is a" %G_TYPE_ENUM. + + + + a #GType ID. + + + + + Checks whether @type "is a" %G_TYPE_FLAGS. + + + + a #GType ID. + + + + + Checks if @type is a fundamental type. + + + + A #GType value + + + + + Checks if @type can be instantiated. Instantiation is the +process of creating an instance (object) of this type. + + + + A #GType value + + + + + Checks if @type is an interface type. +An interface type provides a pure API, the implementation +of which is provided by another type (which is then said to conform +to the interface). GLib interfaces are somewhat analogous to Java +interfaces and C++ classes containing only pure virtual functions, +with the difference that GType interfaces are not derivable (but see +g_type_interface_add_prerequisite() for an alternative). + + + + A #GType value + + + + + Check if the passed in type id is a %G_TYPE_OBJECT or derived from it. + + + + Type id to check + + + + + Checks whether @type "is a" %G_TYPE_PARAM. + + + + a #GType ID + + + + + Checks whether the passed in type ID can be used for g_value_init(). +That is, this macro checks whether this type provides an implementation +of the #GTypeValueTable functions required for a type to create a #GValue of. + + + + A #GType value. + + + + + Checks if @type is an abstract value type. An abstract value type introduces +a value table, but can't be used for g_value_init() and is normally used as +an abstract base type for derived value types. + + + + A #GType value + + + + + Checks if @type is a value type and can be used with g_value_init(). + + + + A #GType value + + + + + Get the type ID for the fundamental type number @x. +Use g_type_fundamental_next() instead of this macro to create new fundamental +types. + + + + the fundamental type number. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - First fundamental type number to create a new fundamental type id with + First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE. - + - Last fundamental type number reserved for BSE. - + Last fundamental type number reserved for BSE. + - First fundamental type number to create a new fundamental type id with + First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib. - + - Last fundamental type number reserved for GLib. - + Last fundamental type number reserved for GLib. + - First available fundamental type number to create new fundamental + First available fundamental type number to create new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL(). - + - A callback function used for notification when the state + A callback function used for notification when the state of a toggle reference changes. See g_object_add_toggle_ref(). - + - Callback data passed to g_object_add_toggle_ref() + Callback data passed to g_object_add_toggle_ref() - The object on which g_object_add_toggle_ref() was called. + The object on which g_object_add_toggle_ref() was called. - %TRUE if the toggle reference is now the + %TRUE if the toggle reference is now the last reference to the object. %FALSE if the toggle reference was the last reference and there are now other references. @@ -7001,16 +9161,16 @@ of a toggle reference changes. See g_object_add_toggle_ref(). - + - An opaque structure used as the base of all classes. - + An opaque structure used as the base of all classes. + - Registers a private structure for an instantiatable type. + 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 @@ -7074,24 +9234,24 @@ my_object_get_some_field (MyObject *my_object) ]| Use the G_ADD_PRIVATE() macro with the `G_DEFINE_*` family of macros to add instance private data to a type - + - class structure for an instantiatable + class structure for an instantiatable type - size of private structure + size of private structure - Gets the offset of the private data for instances of @g_class. + Gets the offset of the private data for instances of @g_class. This is how many bytes you should add to the instance pointer of a class in order to get the private data for the type represented by @@ -7099,20 +9259,20 @@ class in order to get the private data for the type represented by You can only call this function after you have registered a private data area for @g_class using g_type_class_add_private(). - + - the offset, in bytes + the offset, in bytes - a #GTypeClass + a #GTypeClass - + @@ -7126,7 +9286,7 @@ data area for @g_class using g_type_class_add_private(). - This is a convenience function often needed in class initializers. + This is a convenience function often needed in class initializers. It returns the class structure of the immediate parent type of the class passed in. Since derived classes hold a reference count on their parent classes as long as they are instantiated, the returned @@ -7134,54 +9294,54 @@ class will always exist. This function is essentially equivalent to: g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class))) - + - the parent class + the parent class of @g_class - the #GTypeClass structure to + the #GTypeClass structure to retrieve the parent class for - Decrements the reference count of the class structure being passed in. + Decrements the reference count of the class structure being passed in. Once the last reference count of a class has been released, classes may be finalized by the type system, so further dereferencing of a class pointer after g_type_class_unref() are invalid. - + - a #GTypeClass structure to unref + a #GTypeClass structure to unref - A variant of g_type_class_unref() for use in #GTypeClassCacheFunc + A variant of g_type_class_unref() for use in #GTypeClassCacheFunc implementations. It unreferences a class without consulting the chain of #GTypeClassCacheFuncs, avoiding the recursion which would occur otherwise. - + - a #GTypeClass structure to unref + a #GTypeClass structure to unref - + @@ -7195,62 +9355,62 @@ otherwise. - This function is essentially the same as g_type_class_ref(), + This function is essentially the same as g_type_class_ref(), except that the classes reference count isn't incremented. As a consequence, this function may return %NULL if the class of the type passed in does not currently exist (hasn't been referenced before). - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist - type ID of a classed type + type ID of a classed type - A more efficient version of g_type_class_peek() which works only for + A more efficient version of g_type_class_peek() which works only for static types. - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist or is dynamically loaded - type ID of a classed type + type ID of a classed type - Increments the reference count of the class structure belonging to + Increments the reference count of the class structure belonging to @type. This function will demand-create the class if it doesn't exist already. - + - the #GTypeClass + the #GTypeClass structure for the given type ID - type ID of a classed type + type ID of a classed type - A callback function which is called when the reference count of a class + A callback function which is called when the reference count of a class drops to zero. It may use g_type_class_ref() to prevent the class from being freed. You should not call g_type_class_unref() from a #GTypeClassCacheFunc function to prevent infinite recursion, use @@ -7259,89 +9419,89 @@ g_type_class_unref_uncached() instead. The functions have to check the class id passed in to figure whether they actually want to cache the class of this type, since all classes are routed through the same #GTypeClassCacheFunc chain. - + - %TRUE to stop further #GTypeClassCacheFuncs from being + %TRUE to stop further #GTypeClassCacheFuncs from being called, %FALSE to continue - data that was given to the g_type_add_class_cache_func() call + data that was given to the g_type_add_class_cache_func() call - The #GTypeClass structure which is + The #GTypeClass structure which is unreferenced - These flags used to be passed to g_type_init_with_debug_flags() which + These flags used to be passed to g_type_init_with_debug_flags() which is now deprecated. If you need to enable debugging features, use the GOBJECT_DEBUG environment variable. 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 - Keep a count of instances of each type + Keep a count of instances of each type - Mask covering all debug flags + Mask covering all debug flags - Bit masks used to check or determine characteristics of a type. - + Bit masks used to check or determine characteristics of a type. + - Indicates an abstract type. No instances can be + Indicates an abstract type. No instances can be created for an abstract type - Indicates an abstract value type, i.e. a type + Indicates an abstract value type, i.e. a type that introduces a value table, but can't be used for g_value_init() - Bit masks used to check or determine specific characteristics of a + Bit masks used to check or determine specific characteristics of a 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) - A structure that provides information to the type system which is + A structure that provides information to the type system which is used specifically for managing fundamental types. - + - #GTypeFundamentalFlags describing the characteristics of the fundamental type + #GTypeFundamentalFlags describing the characteristics of the fundamental type - This structure is used to provide the type system with the information + This structure is used to provide the type system with the information required to initialize and destruct (finalize) a type's class and its instances. @@ -7350,21 +9510,21 @@ The initialized structure is passed to the g_type_register_static() function g_type_plugin_complete_type_info()). The type system will perform a deep copy of this structure, so its memory does not need to be persistent across invocation of g_type_register_static(). - + - Size of the class structure (required for interface, classed and instantiatable types) + Size of the class structure (required for interface, classed and instantiatable types) - Location of the base initialization function (optional) + Location of the base initialization function (optional) - Location of the base finalization function (optional) + Location of the base finalization function (optional) - Location of the class initialization function for + Location of the class initialization function for classed and instantiatable types. Location of the default vtable inititalization function for interface types. (optional) This function is used both to fill in virtual functions in the class or default vtable, @@ -7373,41 +9533,41 @@ across invocation of g_type_register_static(). - Location of the class finalization function for + Location of the class finalization function for classed and instantiatable types. Location of the default vtable finalization function for interface types. (optional) - User-supplied data passed to the class init/finalize functions + User-supplied data passed to the class init/finalize functions - Size of the instance (object) structure (required for instantiatable types only) + Size of the instance (object) structure (required for instantiatable types only) - Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. + Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. - Location of the instance initialization function (optional, for instantiatable types only) + Location of the instance initialization function (optional, for instantiatable types only) - A #GTypeValueTable function table for generic handling of GValues + A #GTypeValueTable function table for generic handling of GValues of this type (usually only useful for fundamental types) - An opaque structure used as the base of all type instances. - + An opaque structure used as the base of all type instances. + - + @@ -7422,8 +9582,8 @@ across invocation of g_type_register_static(). - An opaque structure used as the base of all interface types. - + An opaque structure used as the base of all interface types. + @@ -7431,13 +9591,13 @@ across invocation of g_type_register_static(). - Returns the corresponding #GTypeInterface structure of the parent type + Returns the corresponding #GTypeInterface structure of the parent type of the instance type to which @g_iface belongs. This is useful when deriving the implementation of an interface from the parent type and then possibly overriding some methods. - + - the + the corresponding #GTypeInterface structure of the parent type of the instance type to which @g_iface belongs, or %NULL if the parent type doesn't conform to the interface @@ -7445,80 +9605,80 @@ then possibly overriding some methods. - a #GTypeInterface structure + a #GTypeInterface structure - Adds @prerequisite_type to the list of prerequisites of @interface_type. + Adds @prerequisite_type to the list of prerequisites of @interface_type. This means that any type implementing @interface_type must also implement @prerequisite_type. Prerequisites can be thought of as an alternative to interface derivation (which GType doesn't support). An interface can have at most one instantiatable prerequisite type. - + - #GType value of an interface type + #GType value of an interface type - #GType value of an interface or instantiatable type + #GType value of an interface or instantiatable type - Returns the #GTypePlugin structure for the dynamic interface + Returns the #GTypePlugin structure for the dynamic interface @interface_type which has been added to @instance_type, or %NULL if @interface_type has not been added to @instance_type or does not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). - + - the #GTypePlugin for the dynamic + the #GTypePlugin for the dynamic interface @interface_type of @instance_type - #GType of an instantiatable type + #GType of an instantiatable type - #GType of an interface type + #GType of an interface type - Returns the #GTypeInterface structure of an interface to which the + Returns the #GTypeInterface structure of an interface to which the passed in class conforms. - + - the #GTypeInterface + the #GTypeInterface structure of @iface_type if implemented by @instance_class, %NULL otherwise - a #GTypeClass structure + a #GTypeClass structure - an interface ID which this class conforms to + an interface ID which this class conforms to - Returns the prerequisites of an interfaces type. - + Returns the prerequisites of an interfaces type. + - a + a newly-allocated zero-terminated array of #GType containing the prerequisites of @interface_type @@ -7527,11 +9687,11 @@ passed in class conforms. - an interface type + an interface type - location to return the number + location to return the number of prerequisites, or %NULL @@ -7539,26 +9699,26 @@ passed in class conforms. - A callback called after an interface vtable is initialized. + A callback called after an interface vtable is initialized. See g_type_add_interface_check(). - + - data passed to g_type_add_interface_check() + data passed to g_type_add_interface_check() - the interface that has been + the interface that has been initialized - #GTypeModule provides a simple implementation of the #GTypePlugin + #GTypeModule provides a simple implementation of the #GTypePlugin interface. The model of #GTypeModule is a dynamically loaded module which implements some number of types and interface implementations. When the module is loaded, it registers its types and interfaces @@ -7609,7 +9769,7 @@ in #GTypeModuleClass. - Registers an additional interface for a type, whose interface lives + Registers an additional interface for a type, whose interface lives in the given type plugin. If the interface was already registered for the type in this plugin, nothing will be done. @@ -7624,25 +9784,25 @@ instead. This can be used when making a static build of the module. - a #GTypeModule + a #GTypeModule - type to which to add the interface. + type to which to add the interface. - interface type to add + interface type to add - type information structure + type information structure - Looks up or registers an enumeration that is implemented with a particular + Looks up or registers an enumeration that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -7654,20 +9814,20 @@ Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - the new or existing type ID + the new or existing type ID - a #GTypeModule + a #GTypeModule - name for the type + name for the type - an array of #GEnumValue structs for the + an array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -7676,7 +9836,7 @@ instead. This can be used when making a static build of the module. - Looks up or registers a flags type that is implemented with a particular + Looks up or registers a flags type that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -7688,20 +9848,20 @@ Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - the new or existing type ID + the new or existing type ID - a #GTypeModule + a #GTypeModule - name for the type + name for the type - an array of #GFlagsValue structs for the + an array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0. @@ -7710,7 +9870,7 @@ instead. This can be used when making a static build of the module. - Looks up or registers a type that is implemented with a particular + Looks up or registers a type that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -7726,51 +9886,51 @@ Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - the new or existing type ID + the new or existing type ID - a #GTypeModule + a #GTypeModule - the type for the parent class + the type for the parent class - name for the type + name for the type - type information structure + type information structure - flags field providing details about the type + flags field providing details about the type - Sets the name for a #GTypeModule + Sets the name for a #GTypeModule - a #GTypeModule. + a #GTypeModule. - a human-readable name to use in error messages. + a human-readable name to use in error messages. - Decreases the use count of a #GTypeModule by one. If the + Decreases the use count of a #GTypeModule by one. If the result is zero, the module will be unloaded. (However, the #GTypeModule will not be freed, and types associated with the #GTypeModule are not unregistered. Once a #GTypeModule is @@ -7781,25 +9941,25 @@ initialized, it must exist forever.) - a #GTypeModule + a #GTypeModule - Increases the use count of a #GTypeModule by one. If the + Increases the use count of a #GTypeModule by one. If the use count was zero before, the plugin will be loaded. If loading the plugin fails, the use count is reset to its prior value. - %FALSE if the plugin needed to be loaded and + %FALSE if the plugin needed to be loaded and loading the plugin failed. - a #GTypeModule + a #GTypeModule @@ -7893,7 +10053,7 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. - The GObject type system supports dynamic loading of types. + The GObject type system supports dynamic loading of types. The #GTypePlugin interface is used to handle the lifecycle of dynamically loaded types. It goes as follows: @@ -7941,7 +10101,7 @@ when the type is needed again. implements most of this except for the actual module loading and unloading. It even handles multiple registered types per module. - Calls the @complete_interface_info function from the + Calls the @complete_interface_info function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -7950,26 +10110,26 @@ function outside of the GObject type system itself. - the #GTypePlugin + the #GTypePlugin - the #GType of an instantiable type to which the interface + the #GType of an instantiable type to which the interface is added - the #GType of the interface whose info is completed + the #GType of the interface whose info is completed - the #GInterfaceInfo to fill in + the #GInterfaceInfo to fill in - Calls the @complete_type_info function from the #GTypePluginClass of @plugin. + Calls the @complete_type_info function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -7978,25 +10138,25 @@ type system itself. - a #GTypePlugin + a #GTypePlugin - the #GType whose info is completed + the #GType whose info is completed - the #GTypeInfo struct to fill in + the #GTypeInfo struct to fill in - the #GTypeValueTable to fill in + the #GTypeValueTable to fill in - Calls the @unuse_plugin function from the #GTypePluginClass of + Calls the @unuse_plugin function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -8005,13 +10165,13 @@ the GObject type system itself. - a #GTypePlugin + a #GTypePlugin - Calls the @use_plugin function from the #GTypePluginClass of + Calls the @use_plugin function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. @@ -8020,7 +10180,7 @@ the GObject type system itself. - a #GTypePlugin + a #GTypePlugin @@ -8133,33 +10293,33 @@ to increase the use count of @plugin. - A structure holding information for a specific type. + A structure holding information for a specific type. It is filled in by the g_type_query() function. - + - the #GType value of the type + the #GType value of the type - the name of the type + the name of the type - the size of the class structure + the size of the class structure - the size of the instance structure + the size of the instance structure - The #GTypeValueTable provides the functions required by the #GValue + The #GTypeValueTable provides the functions required by the #GValue implementation, to serve as a container for values of a type. - + - + @@ -8172,7 +10332,7 @@ implementation, to serve as a container for values of a type. - + @@ -8185,7 +10345,7 @@ implementation, to serve as a container for values of a type. - + @@ -8201,7 +10361,7 @@ implementation, to serve as a container for values of a type. - + @@ -8213,7 +10373,7 @@ implementation, to serve as a container for values of a type. - A string format describing how to collect the contents of + A string format describing how to collect the contents of this value bit-by-bit. Each character in the format represents an argument to be collected, and the characters themselves indicate the type of the argument. Currently supported arguments are: @@ -8229,7 +10389,7 @@ implementation, to serve as a container for values of a type. - + @@ -8250,14 +10410,14 @@ implementation, to serve as a container for values of a type. - Format description of the arguments to collect for @lcopy_value, + Format description of the arguments to collect for @lcopy_value, analogous to @collect_format. Usually, @lcopy_format string consists only of 'p's to provide lcopy_value() with pointers to storage locations. - + @@ -8278,25 +10438,220 @@ implementation, to serve as a container for values of a type. - Returns the location of the #GTypeValueTable associated with @type. + Returns the location of the #GTypeValueTable associated with @type. Note that this function should only be used from source code that implements or has internal knowledge of the implementation of @type. - + - location of the #GTypeValueTable associated with @type or + location of the #GTypeValueTable associated with @type or %NULL if there is no #GTypeValueTable associated with @type - a #GType + a #GType + + Checks if @value holds (or contains) a value of @type. +This macro will also check for @value != %NULL and issue a +warning if the check fails. + + + + A #GValue structure. + + + A #GType value. + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_BOOLEAN. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values derived +from type %G_TYPE_BOXED. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_CHAR. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_DOUBLE. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values derived from type %G_TYPE_ENUM. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values derived from type %G_TYPE_FLAGS. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_FLOAT. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_GTYPE. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_INT. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_INT64. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_LONG. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values derived from type %G_TYPE_OBJECT. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values derived from type %G_TYPE_PARAM. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_POINTER. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_STRING. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_UCHAR. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_UINT. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_UINT64. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_ULONG. + + + + a valid #GValue structure + + + + + Checks whether the given #GValue can hold values of type %G_TYPE_VARIANT. + + + + a valid #GValue structure + + + If passed to G_VALUE_COLLECT(), allocated data won't be copied but used verbatim. This does not affect ref-counted types like @@ -8304,6 +10659,24 @@ objects. + + Get the type identifier of @value. + + + + A #GValue structure. + + + + + Gets the type name of @value. + + + + A #GValue structure. + + + This is the signature of va_list marshaller functions, an optional marshaller that can be used in some situations to avoid @@ -8370,435 +10743,435 @@ only be accessed through the G_VALUE_TYPE() macro. - Copies the value of @src_value into @dest_value. + Copies the value of @src_value into @dest_value. - An initialized #GValue structure. + An initialized #GValue structure. - An initialized #GValue structure of the same type as @src_value. + An initialized #GValue structure of the same type as @src_value. - Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting, + Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting, the boxed value is duplicated and needs to be later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), return_value); - boxed contents of @value + boxed contents of @value - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing + Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing its reference count. If the contents of the #GValue are %NULL, then %NULL will be returned. - + - object content of @value, + object content of @value, should be unreferenced when no longer needed. - a valid #GValue whose type is derived from %G_TYPE_OBJECT + a valid #GValue whose type is derived from %G_TYPE_OBJECT - Get the contents of a %G_TYPE_PARAM #GValue, increasing its + Get the contents of a %G_TYPE_PARAM #GValue, increasing its reference count. - + - #GParamSpec content of @value, should be unreferenced when + #GParamSpec content of @value, should be unreferenced when no longer needed. - a valid #GValue whose type is derived from %G_TYPE_PARAM + a valid #GValue whose type is derived from %G_TYPE_PARAM - Get a copy the contents of a %G_TYPE_STRING #GValue. + Get a copy the contents of a %G_TYPE_STRING #GValue. - a newly allocated copy of the string content of @value + a newly allocated copy of the string content of @value - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - Get the contents of a variant #GValue, increasing its refcount. The returned + Get the contents of a variant #GValue, increasing its refcount. The returned #GVariant is never floating. - variant contents of @value (may be %NULL); + variant contents of @value (may be %NULL); should be unreffed using g_variant_unref() when no longer needed - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - Determines if @value will fit inside the size of a pointer value. + Determines if @value will fit inside the size of a pointer value. This is an internal function introduced mainly for C marshallers. - %TRUE if @value will fit inside a pointer value. + %TRUE if @value will fit inside a pointer value. - An initialized #GValue structure. + An initialized #GValue structure. - Get the contents of a %G_TYPE_BOOLEAN #GValue. + Get the contents of a %G_TYPE_BOOLEAN #GValue. - boolean contents of @value + boolean contents of @value - a valid #GValue of type %G_TYPE_BOOLEAN + a valid #GValue of type %G_TYPE_BOOLEAN - Get the contents of a %G_TYPE_BOXED derived #GValue. + Get the contents of a %G_TYPE_BOXED derived #GValue. - boxed contents of @value + boxed contents of @value - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - Do not use this function; it is broken on platforms where the %char + Do not use this function; it is broken on platforms where the %char type is unsigned, such as ARM and PowerPC. See g_value_get_schar(). Get the contents of a %G_TYPE_CHAR #GValue. This function's return type is broken, see g_value_get_schar() - character contents of @value + character contents of @value - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - Get the contents of a %G_TYPE_DOUBLE #GValue. + Get the contents of a %G_TYPE_DOUBLE #GValue. - double contents of @value + double contents of @value - a valid #GValue of type %G_TYPE_DOUBLE + a valid #GValue of type %G_TYPE_DOUBLE - Get the contents of a %G_TYPE_ENUM #GValue. + Get the contents of a %G_TYPE_ENUM #GValue. - enum contents of @value + enum contents of @value - a valid #GValue whose type is derived from %G_TYPE_ENUM + a valid #GValue whose type is derived from %G_TYPE_ENUM - Get the contents of a %G_TYPE_FLAGS #GValue. + Get the contents of a %G_TYPE_FLAGS #GValue. - flags contents of @value + flags contents of @value - a valid #GValue whose type is derived from %G_TYPE_FLAGS + a valid #GValue whose type is derived from %G_TYPE_FLAGS - Get the contents of a %G_TYPE_FLOAT #GValue. + Get the contents of a %G_TYPE_FLOAT #GValue. - float contents of @value + float contents of @value - a valid #GValue of type %G_TYPE_FLOAT + a valid #GValue of type %G_TYPE_FLOAT - Get the contents of a %G_TYPE_GTYPE #GValue. + Get the contents of a %G_TYPE_GTYPE #GValue. - the #GType stored in @value + the #GType stored in @value - a valid #GValue of type %G_TYPE_GTYPE + a valid #GValue of type %G_TYPE_GTYPE - Get the contents of a %G_TYPE_INT #GValue. + Get the contents of a %G_TYPE_INT #GValue. - integer contents of @value + integer contents of @value - a valid #GValue of type %G_TYPE_INT + a valid #GValue of type %G_TYPE_INT - Get the contents of a %G_TYPE_INT64 #GValue. + Get the contents of a %G_TYPE_INT64 #GValue. - 64bit integer contents of @value + 64bit integer contents of @value - a valid #GValue of type %G_TYPE_INT64 + a valid #GValue of type %G_TYPE_INT64 - Get the contents of a %G_TYPE_LONG #GValue. + Get the contents of a %G_TYPE_LONG #GValue. - long integer contents of @value + long integer contents of @value - a valid #GValue of type %G_TYPE_LONG + a valid #GValue of type %G_TYPE_LONG - Get the contents of a %G_TYPE_OBJECT derived #GValue. - + Get the contents of a %G_TYPE_OBJECT derived #GValue. + - object contents of @value + object contents of @value - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - Get the contents of a %G_TYPE_PARAM #GValue. - + Get the contents of a %G_TYPE_PARAM #GValue. + - #GParamSpec content of @value + #GParamSpec content of @value - a valid #GValue whose type is derived from %G_TYPE_PARAM + a valid #GValue whose type is derived from %G_TYPE_PARAM - Get the contents of a pointer #GValue. + Get the contents of a pointer #GValue. - pointer contents of @value + pointer contents of @value - a valid #GValue of %G_TYPE_POINTER + a valid #GValue of %G_TYPE_POINTER - Get the contents of a %G_TYPE_CHAR #GValue. + Get the contents of a %G_TYPE_CHAR #GValue. - signed 8 bit integer contents of @value + signed 8 bit integer contents of @value - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - Get the contents of a %G_TYPE_STRING #GValue. + Get the contents of a %G_TYPE_STRING #GValue. - string content of @value + string content of @value - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - Get the contents of a %G_TYPE_UCHAR #GValue. + Get the contents of a %G_TYPE_UCHAR #GValue. - unsigned character contents of @value + unsigned character contents of @value - a valid #GValue of type %G_TYPE_UCHAR + a valid #GValue of type %G_TYPE_UCHAR - Get the contents of a %G_TYPE_UINT #GValue. + Get the contents of a %G_TYPE_UINT #GValue. - unsigned integer contents of @value + unsigned integer contents of @value - a valid #GValue of type %G_TYPE_UINT + a valid #GValue of type %G_TYPE_UINT - Get the contents of a %G_TYPE_UINT64 #GValue. + Get the contents of a %G_TYPE_UINT64 #GValue. - unsigned 64bit integer contents of @value + unsigned 64bit integer contents of @value - a valid #GValue of type %G_TYPE_UINT64 + a valid #GValue of type %G_TYPE_UINT64 - Get the contents of a %G_TYPE_ULONG #GValue. + Get the contents of a %G_TYPE_ULONG #GValue. - unsigned long integer contents of @value + unsigned long integer contents of @value - a valid #GValue of type %G_TYPE_ULONG + a valid #GValue of type %G_TYPE_ULONG - Get the contents of a variant #GValue. + Get the contents of a variant #GValue. - variant contents of @value (may be %NULL) + variant contents of @value (may be %NULL) - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - Initializes @value with the default value of @type. + Initializes @value with the default value of @type. - the #GValue structure that has been passed in + the #GValue structure that has been passed in - A zero-filled (uninitialized) #GValue structure. + A zero-filled (uninitialized) #GValue structure. - Type the #GValue should hold values of. + Type the #GValue should hold values of. - Initializes and sets @value from an instantiatable type via the + 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 @@ -8811,82 +11184,82 @@ g_value_init() and g_value_set_instance(). - An uninitialized #GValue structure. + An uninitialized #GValue structure. - the instance + the instance - Returns the value contents as pointer. This function asserts that + 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. - the value contents as pointer + the value contents as pointer - An initialized #GValue structure + An initialized #GValue structure - Clears the current value in @value and resets it to the default value + Clears the current value in @value and resets it to the default value (as if the value had just been initialized). - the #GValue structure that has been passed in + the #GValue structure that has been passed in - An initialized #GValue structure. + An initialized #GValue structure. - Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean. + Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean. - a valid #GValue of type %G_TYPE_BOOLEAN + a valid #GValue of type %G_TYPE_BOOLEAN - boolean value to be set + boolean value to be set - Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. + Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - boxed value to be set + boxed value to be set - This is an internal function introduced mainly for C marshallers. + This is an internal function introduced mainly for C marshallers. Use g_value_take_boxed() instead. @@ -8894,17 +11267,17 @@ This is an internal function introduced mainly for C marshallers. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - duplicated unowned boxed value to be set + duplicated unowned boxed value to be set - Set the contents of a %G_TYPE_CHAR #GValue to @v_char. + Set the contents of a %G_TYPE_CHAR #GValue to @v_char. This function's input type is broken, see g_value_set_schar() @@ -8912,102 +11285,102 @@ This is an internal function introduced mainly for C marshallers. - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - character value to be set + character value to be set - Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double. + Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double. - a valid #GValue of type %G_TYPE_DOUBLE + a valid #GValue of type %G_TYPE_DOUBLE - double value to be set + double value to be set - Set the contents of a %G_TYPE_ENUM #GValue to @v_enum. + Set the contents of a %G_TYPE_ENUM #GValue to @v_enum. - a valid #GValue whose type is derived from %G_TYPE_ENUM + a valid #GValue whose type is derived from %G_TYPE_ENUM - enum value to be set + enum value to be set - Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags. + Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags. - a valid #GValue whose type is derived from %G_TYPE_FLAGS + a valid #GValue whose type is derived from %G_TYPE_FLAGS - flags value to be set + flags value to be set - Set the contents of a %G_TYPE_FLOAT #GValue to @v_float. + Set the contents of a %G_TYPE_FLOAT #GValue to @v_float. - a valid #GValue of type %G_TYPE_FLOAT + a valid #GValue of type %G_TYPE_FLOAT - float value to be set + float value to be set - Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype. + Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype. - a valid #GValue of type %G_TYPE_GTYPE + a valid #GValue of type %G_TYPE_GTYPE - #GType to be set + #GType to be set - Sets @value from an instantiatable type via the + Sets @value from an instantiatable type via the value_table's collect_value() function. @@ -9015,68 +11388,68 @@ value_table's collect_value() function. - An initialized #GValue structure. + An initialized #GValue structure. - the instance + the instance - Set the contents of a %G_TYPE_INT #GValue to @v_int. + Set the contents of a %G_TYPE_INT #GValue to @v_int. - a valid #GValue of type %G_TYPE_INT + a valid #GValue of type %G_TYPE_INT - integer value to be set + integer value to be set - Set the contents of a %G_TYPE_INT64 #GValue to @v_int64. + Set the contents of a %G_TYPE_INT64 #GValue to @v_int64. - a valid #GValue of type %G_TYPE_INT64 + a valid #GValue of type %G_TYPE_INT64 - 64bit integer value to be set + 64bit integer value to be set - Set the contents of a %G_TYPE_LONG #GValue to @v_long. + Set the contents of a %G_TYPE_LONG #GValue to @v_long. - a valid #GValue of type %G_TYPE_LONG + a valid #GValue of type %G_TYPE_LONG - long integer value to be set + long integer value to be set - Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object. + Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object. g_value_set_object() increases the reference count of @v_object (the #GValue holds a reference to @v_object). If you do not wish @@ -9087,110 +11460,110 @@ need it), use g_value_take_object() instead. It is important that your #GValue holds a reference to @v_object (either its own, or one it has taken) to ensure that the object won't be destroyed while the #GValue still exists). - + - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - object value to be set + object value to be set - This is an internal function introduced mainly for C marshallers. + This is an internal function introduced mainly for C marshallers. Use g_value_take_object() instead. - + - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - object value to be set + object value to be set - Set the contents of a %G_TYPE_PARAM #GValue to @param. - + Set the contents of a %G_TYPE_PARAM #GValue to @param. + - a valid #GValue of type %G_TYPE_PARAM + a valid #GValue of type %G_TYPE_PARAM - the #GParamSpec to be set + the #GParamSpec to be set - This is an internal function introduced mainly for C marshallers. + This is an internal function introduced mainly for C marshallers. Use g_value_take_param() instead. - + - a valid #GValue of type %G_TYPE_PARAM + a valid #GValue of type %G_TYPE_PARAM - the #GParamSpec to be set + the #GParamSpec to be set - Set the contents of a pointer #GValue to @v_pointer. + Set the contents of a pointer #GValue to @v_pointer. - a valid #GValue of %G_TYPE_POINTER + a valid #GValue of %G_TYPE_POINTER - pointer value to be set + pointer value to be set - Set the contents of a %G_TYPE_CHAR #GValue to @v_char. + Set the contents of a %G_TYPE_CHAR #GValue to @v_char. - a valid #GValue of type %G_TYPE_CHAR + a valid #GValue of type %G_TYPE_CHAR - signed 8 bit integer to be set + signed 8 bit integer to be set - Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. + Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. The boxed value is assumed to be static, and is thus not duplicated when setting the #GValue. @@ -9199,17 +11572,17 @@ when setting the #GValue. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - static boxed value to be set + static boxed value to be set - Set the contents of a %G_TYPE_STRING #GValue to @v_string. + Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is assumed to be static, and is thus not duplicated when setting the #GValue. @@ -9218,34 +11591,34 @@ when setting the #GValue. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - static string to be set + static string to be set - Set the contents of a %G_TYPE_STRING #GValue to @v_string. + Set the contents of a %G_TYPE_STRING #GValue to @v_string. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - caller-owned string to be duplicated for the #GValue + caller-owned string to be duplicated for the #GValue - This is an internal function introduced mainly for C marshallers. + This is an internal function introduced mainly for C marshallers. Use g_value_take_string() instead. @@ -9253,85 +11626,85 @@ when setting the #GValue. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - duplicated unowned string to be set + duplicated unowned string to be set - Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar. + Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar. - a valid #GValue of type %G_TYPE_UCHAR + a valid #GValue of type %G_TYPE_UCHAR - unsigned character value to be set + unsigned character value to be set - Set the contents of a %G_TYPE_UINT #GValue to @v_uint. + Set the contents of a %G_TYPE_UINT #GValue to @v_uint. - a valid #GValue of type %G_TYPE_UINT + a valid #GValue of type %G_TYPE_UINT - unsigned integer value to be set + unsigned integer value to be set - Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64. + Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64. - a valid #GValue of type %G_TYPE_UINT64 + a valid #GValue of type %G_TYPE_UINT64 - unsigned 64bit integer value to be set + unsigned 64bit integer value to be set - Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong. + Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong. - a valid #GValue of type %G_TYPE_ULONG + a valid #GValue of type %G_TYPE_ULONG - unsigned long integer value to be set + unsigned long integer value to be set - Set the contents of a variant #GValue to @variant. + Set the contents of a variant #GValue to @variant. If the variant is floating, it is consumed. @@ -9339,95 +11712,95 @@ If the variant is floating, it is consumed. - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - a #GVariant, or %NULL + a #GVariant, or %NULL - Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed -and takes over the ownership of the callers reference to @v_boxed; -the caller doesn't have to unref it any more. + Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed +and takes over the ownership of the caller’s reference to @v_boxed; +the caller doesn’t have to unref it any more. - a valid #GValue of %G_TYPE_BOXED derived type + a valid #GValue of %G_TYPE_BOXED derived type - duplicated unowned boxed value to be set + duplicated unowned boxed value to be set - Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object -and takes over the ownership of the callers reference to @v_object; -the caller doesn't have to unref it any more (i.e. the reference + Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object +and takes over the ownership of the caller’s reference to @v_object; +the caller doesn’t have to unref it any more (i.e. the reference count of the object is not increased). If you want the #GValue to hold its own reference to @v_object, use g_value_set_object() instead. - + - a valid #GValue of %G_TYPE_OBJECT derived type + a valid #GValue of %G_TYPE_OBJECT derived type - object value to be set + object value to be set - Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes -over the ownership of the callers reference to @param; the caller -doesn't have to unref it any more. - + Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes +over the ownership of the caller’s reference to @param; the caller +doesn’t have to unref it any more. + - a valid #GValue of type %G_TYPE_PARAM + a valid #GValue of type %G_TYPE_PARAM - the #GParamSpec to be set + the #GParamSpec to be set - Sets the contents of a %G_TYPE_STRING #GValue to @v_string. + Sets the contents of a %G_TYPE_STRING #GValue to @v_string. - a valid #GValue of type %G_TYPE_STRING + a valid #GValue of type %G_TYPE_STRING - string to take ownership of + string to take ownership of - Set the contents of a variant #GValue to @variant, and takes over + Set the contents of a variant #GValue to @variant, and takes over the ownership of the caller's reference to @variant; the caller doesn't have to unref it any more (i.e. the reference count of the variant is not increased). @@ -9445,17 +11818,17 @@ This is an internal function introduced mainly for C marshallers. - a valid #GValue of type %G_TYPE_VARIANT + a valid #GValue of type %G_TYPE_VARIANT - a #GVariant, or %NULL + a #GVariant, or %NULL - Tries to cast the contents of @src_value into a type appropriate + Tries to cast the contents of @src_value into a type appropriate to store in @dest_value, e.g. to transform a %G_TYPE_INT value into a %G_TYPE_FLOAT value. Performing transformations between value types might incur precision lossage. Especially @@ -9464,23 +11837,23 @@ results and shouldn't be relied upon for production code (such as rcfile value or object property serialization). - Whether a transformation rule was found and could be applied. + Whether a transformation rule was found and could be applied. Upon failing transformations, @dest_value is left untouched. - Source value. + Source value. - Target value. + Target value. - Clears the current value in @value (if any) and "unsets" the type, + Clears the current value in @value (if any) and "unsets" the type, this releases all resources associated with this GValue. An unset value is the same as an uninitialized (zero-filled) #GValue structure. @@ -9490,13 +11863,13 @@ structure. - An initialized #GValue structure. + An initialized #GValue structure. - Registers a value transformation function for use in g_value_transform(). + Registers a value transformation function for use in g_value_transform(). A previously registered transformation function for @src_type and @dest_type will be replaced. @@ -9505,56 +11878,56 @@ will be replaced. - Source type. + Source type. - Target type. + Target type. - a function which transforms values of type @src_type + a function which transforms values of type @src_type into value of type @dest_type - Returns whether a #GValue of type @src_type can be copied into + Returns whether a #GValue of type @src_type can be copied into a #GValue of type @dest_type. - %TRUE if g_value_copy() is possible with @src_type and @dest_type. + %TRUE if g_value_copy() is possible with @src_type and @dest_type. - source type to be copied. + source type to be copied. - destination type for copying. + destination type for copying. - Check whether g_value_transform() is able to transform values + 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 or a transformation function must be registered. - %TRUE if the transformation is possible, %FALSE otherwise. + %TRUE if the transformation is possible, %FALSE otherwise. - Source type. + Source type. - Target type. + Target type. @@ -9575,60 +11948,60 @@ transformation function must be registered. - Allocate and initialize a new #GValueArray, optionally preserve space + Allocate and initialize a new #GValueArray, optionally preserve space for @n_prealloced elements. New arrays always contain 0 elements, regardless of the value of @n_prealloced. Use #GArray and g_array_sized_new() instead. - a newly allocated #GValueArray with 0 values + a newly allocated #GValueArray with 0 values - number of values to preallocate space for + number of values to preallocate space for - Insert a copy of @value as last element of @value_array. If @value is + Insert a copy of @value as last element of @value_array. If @value is %NULL, an uninitialized value is appended. Use #GArray and g_array_append_val() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to add an element to + #GValueArray to add an element to - #GValue to copy into #GValueArray, or %NULL + #GValue to copy into #GValueArray, or %NULL - Construct an exact copy of a #GValueArray by duplicating all its + Construct an exact copy of a #GValueArray by duplicating all its contents. Use #GArray and g_array_ref() instead. - Newly allocated copy of #GValueArray + Newly allocated copy of #GValueArray - #GValueArray to copy + #GValueArray to copy - Free a #GValueArray including its contents. + Free a #GValueArray including its contents. Use #GArray and g_array_unref() instead. @@ -9636,96 +12009,96 @@ contents. - #GValueArray to free + #GValueArray to free - Return a pointer to the value at @index_ containd in @value_array. + Return a pointer to the value at @index_ containd in @value_array. Use g_array_index() instead. - pointer to a value at @index_ in @value_array + pointer to a value at @index_ in @value_array - #GValueArray to get a value from + #GValueArray to get a value from - index of the value of interest + index of the value of interest - Insert a copy of @value at specified position into @value_array. If @value + Insert a copy of @value at specified position into @value_array. If @value is %NULL, an uninitialized value is inserted. Use #GArray and g_array_insert_val() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to add an element to + #GValueArray to add an element to - insertion position, must be <= value_array->;n_values + insertion position, must be <= value_array->;n_values - #GValue to copy into #GValueArray, or %NULL + #GValue to copy into #GValueArray, or %NULL - Insert a copy of @value as first element of @value_array. If @value is + Insert a copy of @value as first element of @value_array. If @value is %NULL, an uninitialized value is prepended. Use #GArray and g_array_prepend_val() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to add an element to + #GValueArray to add an element to - #GValue to copy into #GValueArray, or %NULL + #GValue to copy into #GValueArray, or %NULL - Remove the value at position @index_ from @value_array. + Remove the value at position @index_ from @value_array. Use #GArray and g_array_remove_index() instead. - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to remove an element from + #GValueArray to remove an element from - position of value to remove, which must be less than + position of value to remove, which must be less than @value_array->n_values - Sort @value_array using @compare_func to compare the elements according to + Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareFunc. The current implementation uses the same sorting algorithm as standard @@ -9733,22 +12106,22 @@ C qsort() function. Use #GArray and g_array_sort(). - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to sort + #GValueArray to sort - function to compare elements + function to compare elements - Sort @value_array using @compare_func to compare the elements according + Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareDataFunc. The current implementation uses the same sorting algorithm as standard @@ -9756,20 +12129,20 @@ C qsort() function. Use #GArray and g_array_sort_with_data(). - the #GValueArray passed in as @value_array + the #GValueArray passed in as @value_array - #GValueArray to sort + #GValueArray to sort - function to compare elements + function to compare elements - extra data argument provided for @compare_func + extra data argument provided for @compare_func @@ -9836,33 +12209,33 @@ before it was disposed will continue to point to %NULL. If #GWeakRefs are taken after the object is disposed and re-referenced, they will continue to point to it until its refcount goes back to zero, at which point they too will be invalidated. - + - + - Frees resources associated with a non-statically-allocated #GWeakRef. + Frees resources associated with a non-statically-allocated #GWeakRef. After this call, the #GWeakRef is left in an undefined state. You should only call this on a #GWeakRef that previously had g_weak_ref_init() called on it. - + - location of a weak reference, which + location of a weak reference, which may be empty - If @weak_ref is not empty, atomically acquire a strong + If @weak_ref is not empty, atomically acquire a strong reference to the object it points to, and return that reference. This function is needed because of the potential race between taking @@ -9871,21 +12244,21 @@ its last reference at the same time in a different thread. The caller should release the resulting reference in the usual way, by using g_object_unref(). - + - the object pointed to + the object pointed to by @weak_ref, or %NULL if it was empty - location of a weak reference to a #GObject + location of a weak reference to a #GObject - Initialise a non-statically-allocated #GWeakRef. + Initialise a non-statically-allocated #GWeakRef. This function also calls g_weak_ref_set() with @object on the freshly-initialised weak reference. @@ -9894,39 +12267,39 @@ This function should always be matched with a call to g_weak_ref_clear(). It is not necessary to use this function for a #GWeakRef in static storage because it will already be properly initialised. Just use g_weak_ref_set() directly. - + - uninitialized or empty location for a weak + uninitialized or empty location for a weak reference - a #GObject or %NULL + a #GObject or %NULL - Change the object to which @weak_ref points, or set it to + Change the object to which @weak_ref points, or set it to %NULL. You must own a strong reference on @object while calling this function. - + - location for a weak reference + location for a weak reference - a #GObject or %NULL + a #GObject or %NULL @@ -9961,68 +12334,84 @@ function. + + Assert that @object is non-%NULL, then release one reference to it with +g_object_unref() and assert that it has been finalized (i.e. that there +are no more references). + +If assertions are disabled via `G_DISABLE_ASSERT`, +this macro just calls g_object_unref() without any further checks. + +This macro should only be used in regression tests. + + + + an object + + + - Provide a copy of a boxed structure @src_boxed which is of type @boxed_type. + Provide a copy of a boxed structure @src_boxed which is of type @boxed_type. - The newly created copy of the boxed + The newly created copy of the boxed structure. - The type of @src_boxed. + The type of @src_boxed. - The boxed structure to be copied. + The boxed structure to be copied. - Free the boxed structure @boxed which is of type @boxed_type. + Free the boxed structure @boxed which is of type @boxed_type. - The type of @boxed. + The type of @boxed. - The boxed structure to be freed. + The boxed structure to be freed. - This function creates a new %G_TYPE_BOXED derived type id for a new + This function creates a new %G_TYPE_BOXED derived type id for a new boxed type with name @name. Boxed type handling functions have to be provided to copy and free opaque boxed structures of this type. - New %G_TYPE_BOXED derived type id for @name. + New %G_TYPE_BOXED derived type id for @name. - Name of the new boxed type. + Name of the new boxed type. - Boxed structure copy function. + Boxed structure copy function. - Boxed structure free function. + Boxed structure free function. - A #GClosureMarshal function for use with signals with handlers that + A #GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled(). @@ -10032,30 +12421,30 @@ accumulator, such as g_signal_accumulator_true_handled(). - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - The invocation hint given as the last argument to + The invocation hint given as the last argument to g_closure_invoke(). - Additional data specified when registering the + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -10063,7 +12452,7 @@ accumulator, such as g_signal_accumulator_true_handled(). - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -10072,34 +12461,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue which can store the returned #gboolean + a #GValue which can store the returned #gboolean - 2 + 2 - a #GValue array holding instance and arg1 + a #GValue array holding instance and arg1 - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`. @@ -10107,34 +12496,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - a #GValue, which can store the returned string + a #GValue, which can store the returned string - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`. @@ -10142,34 +12531,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gboolean parameter + a #GValue array holding the instance and the #gboolean parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`. @@ -10177,34 +12566,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GBoxed* parameter + a #GValue array holding the instance and the #GBoxed* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`. @@ -10212,34 +12601,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar parameter + a #GValue array holding the instance and the #gchar parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`. @@ -10247,34 +12636,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gdouble parameter + a #GValue array holding the instance and the #gdouble parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type.. @@ -10282,34 +12671,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the enumeration parameter + a #GValue array holding the instance and the enumeration parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. @@ -10317,34 +12706,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the flags parameter + a #GValue array holding the instance and the flags parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`. @@ -10352,34 +12741,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gfloat parameter + a #GValue array holding the instance and the #gfloat parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gint arg1, gpointer user_data)`. @@ -10387,34 +12776,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gint parameter + a #GValue array holding the instance and the #gint parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, glong arg1, gpointer user_data)`. @@ -10422,34 +12811,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #glong parameter + a #GValue array holding the instance and the #glong parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`. @@ -10457,34 +12846,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GObject* parameter + a #GValue array holding the instance and the #GObject* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`. @@ -10492,34 +12881,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GParamSpec* parameter + a #GValue array holding the instance and the #GParamSpec* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`. @@ -10527,34 +12916,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gpointer parameter + a #GValue array holding the instance and the #gpointer parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`. @@ -10562,34 +12951,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gchar* parameter + a #GValue array holding the instance and the #gchar* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`. @@ -10597,34 +12986,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guchar parameter + a #GValue array holding the instance and the #guchar parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer user_data)`. @@ -10632,34 +13021,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #guint parameter + a #GValue array holding the instance and the #guint parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`. @@ -10667,34 +13056,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 3 + 3 - a #GValue array holding instance, arg1 and arg2 + a #GValue array holding instance, arg1 and arg2 - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`. @@ -10702,34 +13091,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #gulong parameter + a #GValue array holding the instance and the #gulong parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`. @@ -10737,34 +13126,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 2 + 2 - a #GValue array holding the instance and the #GVariant* parameter + a #GValue array holding the instance and the #GVariant* parameter - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A marshaller for a #GCClosure with a callback of type + A marshaller for a #GCClosure with a callback of type `void (*callback) (gpointer instance, gpointer user_data)`. @@ -10772,34 +13161,34 @@ denotes a flags type. - the #GClosure to which the marshaller belongs + the #GClosure to which the marshaller belongs - ignored + ignored - 1 + 1 - a #GValue array holding only the instance + a #GValue array holding only the instance - the invocation hint given as the last argument + the invocation hint given as the last argument to g_closure_invoke() - additional data specified when registering the marshaller + additional data specified when registering the marshaller - A generic marshaller function implemented via + A generic marshaller function implemented via [libffi](http://sourceware.org/libffi/). Normally this function is not passed explicitly to g_signal_new(), @@ -10810,30 +13199,30 @@ but used automatically by GLib when specifying a %NULL marshaller. - A #GClosure. + A #GClosure. - A #GValue to store the return value. May be %NULL + A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. - The length of the @param_values array. + The length of the @param_values array. - An array of #GValues holding the arguments + An array of #GValues holding the arguments on which to invoke the callback of closure. - The invocation hint given as the last argument to + The invocation hint given as the last argument to g_closure_invoke(). - Additional data specified when registering the + Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -10841,101 +13230,101 @@ but used automatically by GLib when specifying a %NULL marshaller. - Creates a new closure which invokes @callback_func with @user_data as + Creates a new closure which invokes @callback_func with @user_data as the last parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - the function to invoke + the function to invoke - user data to pass to @callback_func + user data to pass to @callback_func - destroy notify to be called when @user_data is no longer used + destroy notify to be called when @user_data is no longer used - A variant of g_cclosure_new() which uses @object as @user_data and + A variant of g_cclosure_new() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - + - a new #GCClosure + a new #GCClosure - the function to invoke + the function to invoke - a #GObject pointer to pass to @callback_func + a #GObject pointer to pass to @callback_func - A variant of g_cclosure_new_swap() which uses @object as @user_data + A variant of g_cclosure_new_swap() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - + - a new #GCClosure + a new #GCClosure - the function to invoke + the function to invoke - a #GObject pointer to pass to @callback_func + a #GObject pointer to pass to @callback_func - Creates a new closure which invokes @callback_func with @user_data as + Creates a new closure which invokes @callback_func with @user_data as the first parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - the function to invoke + the function to invoke - user data to pass to @callback_func + user data to pass to @callback_func - destroy notify to be called when @user_data is no longer used + destroy notify to be called when @user_data is no longer used - Clears a reference to a #GObject. + Clears a reference to a #GObject. @object_ptr must not be %NULL. @@ -10945,19 +13334,62 @@ pointer is set to %NULL. A macro is also included that allows this function to be used without pointer casts. - + - a pointer to a #GObject reference + a pointer to a #GObject reference + + Disconnects a handler from @instance so it will not be called during +any future or currently ongoing emissions of the signal it has been +connected to. The @handler_id_ptr is then set to zero, which is never a valid handler ID value (see g_signal_connect()). + +If the handler ID is 0 then this function does nothing. + +A macro is also included that allows this function to be used without +pointer casts. + + + + + + + A pointer to a handler ID (of type #gulong) of the handler to be disconnected. + + + + The instance to remove the signal handler from. + + + + + + Clears a weak reference to a #GObject. + +@weak_pointer_location must not be %NULL. + +If the weak reference is %NULL then this function does nothing. +Otherwise, the weak reference to the object is removed for that location +and the pointer is set to %NULL. + +A macro is also included that allows this function to be used without +pointer casts. The function itself is static inline, so its address may vary +between compilation units. + + + + The memory address of a pointer + + + - This function is meant to be called from the `complete_type_info` + This function is meant to be called from the `complete_type_info` function of a #GTypePlugin implementation, as in the following example: @@ -10983,15 +13415,15 @@ my_enum_complete_type_info (GTypePlugin *plugin, - the type identifier of the type being completed + the type identifier of the type being completed - the #GTypeInfo struct to be filled in + the #GTypeInfo struct to be filled in - An array of #GEnumValue structs for the possible + An array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -10999,82 +13431,82 @@ my_enum_complete_type_info (GTypePlugin *plugin, - Returns the #GEnumValue for a value. + Returns the #GEnumValue for a value. - the #GEnumValue for @value, or %NULL + the #GEnumValue for @value, or %NULL if @value is not a member of the enumeration - a #GEnumClass + a #GEnumClass - the value to look up + the value to look up - Looks up a #GEnumValue by name. + Looks up a #GEnumValue by name. - the #GEnumValue with name @name, + the #GEnumValue with name @name, or %NULL if the enumeration doesn't have a member with that name - a #GEnumClass + a #GEnumClass - the name to look up + the name to look up - Looks up a #GEnumValue by nickname. + Looks up a #GEnumValue by nickname. - the #GEnumValue with nickname @nick, + the #GEnumValue with nickname @nick, or %NULL if the enumeration doesn't have a member with that nickname - a #GEnumClass + a #GEnumClass - the nickname to look up + the nickname to look up - Registers a new static enumeration type with the name @name. + Registers a new static enumeration type with the name @name. It is normally more convenient to let [glib-mkenums][glib-mkenums], generate a my_enum_get_type() function from a usual C enumeration definition than to write one yourself using g_enum_register_static(). - The new type identifier. + The new type identifier. - A nul-terminated string used as the name of the new type. + A nul-terminated string used as the name of the new type. - An array of #GEnumValue structs for the possible + An array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. GObject keeps a reference to the data, so it cannot be stack-allocated. @@ -11083,28 +13515,28 @@ definition than to write one yourself using g_enum_register_static(). - Pretty-prints @value in the form of the enum’s name. + Pretty-prints @value in the form of the enum’s name. This is intended to be used for debugging purposes. The format of the output may change in the future. - a newly-allocated text string + a newly-allocated text string - the type identifier of a #GEnumClass type + the type identifier of a #GEnumClass type - the value + the value - This function is meant to be called from the complete_type_info() + This function is meant to be called from the complete_type_info() function of a #GTypePlugin implementation, see the example for g_enum_complete_type_info() above. @@ -11113,15 +13545,15 @@ g_enum_complete_type_info() above. - the type identifier of the type being completed + the type identifier of the type being completed - the #GTypeInfo struct to be filled in + the #GTypeInfo struct to be filled in - An array of #GFlagsValue structs for the possible + An array of #GFlagsValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -11129,80 +13561,80 @@ g_enum_complete_type_info() above. - Returns the first #GFlagsValue which is set in @value. + Returns the first #GFlagsValue which is set in @value. - the first #GFlagsValue which is set in + the first #GFlagsValue which is set in @value, or %NULL if none is set - a #GFlagsClass + a #GFlagsClass - the value + the value - Looks up a #GFlagsValue by name. + Looks up a #GFlagsValue by name. - the #GFlagsValue with name @name, + the #GFlagsValue with name @name, or %NULL if there is no flag with that name - a #GFlagsClass + a #GFlagsClass - the name to look up + the name to look up - Looks up a #GFlagsValue by nickname. + Looks up a #GFlagsValue by nickname. - the #GFlagsValue with nickname @nick, + the #GFlagsValue with nickname @nick, or %NULL if there is no flag with that nickname - a #GFlagsClass + a #GFlagsClass - the nickname to look up + the nickname to look up - Registers a new static flags type with the name @name. + Registers a new static flags type with the name @name. It is normally more convenient to let [glib-mkenums][glib-mkenums] generate a my_flags_get_type() function from a usual C enumeration definition than to write one yourself using g_flags_register_static(). - The new type identifier. + The new type identifier. - A nul-terminated string used as the name of the new type. + A nul-terminated string used as the name of the new type. - An array of #GFlagsValue structs for the possible + An array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0. GObject keeps a reference to the data, so it cannot be stack-allocated. @@ -11210,23 +13642,23 @@ definition than to write one yourself using g_flags_register_static(). - Pretty-prints @value in the form of the flag names separated by ` | ` and + Pretty-prints @value in the form of the flag names separated by ` | ` and sorted. Any extra bits will be shown at the end as a hexadecimal number. This is intended to be used for debugging purposes. The format of the output may change in the future. - a newly-allocated text string + a newly-allocated text string - the type identifier of a #GFlagsClass type + the type identifier of a #GFlagsClass type - the value + the value @@ -11238,7 +13670,7 @@ may change in the future. - Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN + Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN property. In many cases, it may be more appropriate to use an enum with g_param_spec_enum(), both to improve code clarity by using explicitly named values, and to allow for more values to be added in future without breaking @@ -11246,190 +13678,41 @@ API. See g_param_spec_internal() for details on property names. - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - - - default value for the property specified - - - - flags for the property specified - - - - - - Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED -derived property. - -See g_param_spec_internal() for details on property names. - - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - - - %G_TYPE_BOXED derived type of this property - - - - flags for the property specified - - - - - - Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property. - - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - - - minimum value for the property specified - - - - maximum value for the property specified - - - - default value for the property specified - - - - flags for the property specified - - - - - - Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE -property. - -See g_param_spec_internal() for details on property names. - - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - - - minimum value for the property specified - - - - maximum value for the property specified - - - - default value for the property specified - - - - flags for the property specified - - - - - - Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM -property. - -See g_param_spec_internal() for details on property names. - a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - - a #GType derived from %G_TYPE_ENUM - - - default value for the property specified - + default value for the property specified + - flags for the property specified + flags for the property specified - - Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS -property. + + Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED +derived property. See g_param_spec_internal() for details on property names. - + - a newly created parameter specification + a newly created parameter specification @@ -11445,568 +13728,561 @@ See g_param_spec_internal() for details on property names. description of the property specified - - a #GType derived from %G_TYPE_FLAGS + + %G_TYPE_BOXED derived type of this property + + + + flags for the property specified + + + + + + Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + minimum value for the property specified + + + + maximum value for the property specified + + + + default value for the property specified + + + + flags for the property specified + + + + + + Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE +property. + +See g_param_spec_internal() for details on property names. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + minimum value for the property specified + + + + maximum value for the property specified + + + + default value for the property specified + + + + flags for the property specified + + + + + + Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM +property. + +See g_param_spec_internal() for details on property names. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + a #GType derived from %G_TYPE_ENUM - default value for the property specified + default value for the property specified + + + + flags for the property specified + + + + + + Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS +property. + +See g_param_spec_internal() for details on property names. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + a #GType derived from %G_TYPE_FLAGS + + + + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property. + Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecGType instance specifying a + Creates a new #GParamSpecGType instance specifying a %G_TYPE_GTYPE property. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GType whose subtypes are allowed as values + a #GType whose subtypes are allowed as values of the property (use %G_TYPE_NONE for any type) - flags for the property specified + flags for the property specified - Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property. + Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property. + Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property. + Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT + Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT derived property. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - %G_TYPE_OBJECT derived type of this property + %G_TYPE_OBJECT derived type of this property - flags for the property specified + flags for the property specified - Creates a new property of type #GParamSpecOverride. This is used + Creates a new property of type #GParamSpecOverride. This is used to direct operations to another paramspec, and will not be directly useful unless you are implementing a new base type similar to GObject. - the newly created #GParamSpec + the newly created #GParamSpec - the name of the property. + the name of the property. - The property that is being overridden + The property that is being overridden - Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM + Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM property. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GType derived from %G_TYPE_PARAM + a #GType derived from %G_TYPE_PARAM - flags for the property specified + flags for the property specified - Creates a new #GParamSpecPointer instance specifying a pointer property. + Creates a new #GParamSpecPointer instance specifying a pointer property. Where possible, it is better to use g_param_spec_object() or g_param_spec_boxed() to expose memory management information. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecPool. + Creates a new #GParamSpecPool. If @type_prefixing is %TRUE, lookups in the newly created pool will allow to specify the owner as a colon-separated prefix of the property name, like "GtkContainer:border-width". This feature is deprecated, so you should always set @type_prefixing to %FALSE. - + - a newly allocated #GParamSpecPool. + a newly allocated #GParamSpecPool. - Whether the pool will support type-prefixed property names. + Whether the pool will support type-prefixed property names. - Creates a new #GParamSpecString instance. + Creates a new #GParamSpecString instance. See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - default value for the property specified + default value for the property specified - flags for the property specified + flags for the property specified - Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property. + Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - minimum value for the property specified + minimum value for the property specified - maximum value for the property specified + maximum value for the property specified - - default value for the property specified - - - - flags for the property specified - - - - - - Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property. - -See g_param_spec_internal() for details on property names. - - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - - - minimum value for the property specified - - - - maximum value for the property specified - - - - default value for the property specified - - - - flags for the property specified - - - - - - Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64 -property. - -See g_param_spec_internal() for details on property names. - - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - - - minimum value for the property specified - - - - maximum value for the property specified - - - - default value for the property specified - - - - flags for the property specified - - - - - - Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG -property. - -See g_param_spec_internal() for details on property names. - - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - - - minimum value for the property specified - - - - maximum value for the property specified - - - - default value for the property specified - - - - flags for the property specified - - - - - - Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT -property. #GValue structures for this property can be accessed with -g_value_set_uint() and g_value_get_uint(). - -See g_param_spec_internal() for details on property names. - - - a newly created parameter specification - - - - - canonical name of the property specified - - - - nick name for the property specified - - - - description of the property specified - - default value for the property specified - + flags for the property specified @@ -12014,8 +14290,164 @@ See g_param_spec_internal() for details on property names. + + Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property. + +See g_param_spec_internal() for details on property names. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + minimum value for the property specified + + + + maximum value for the property specified + + + + default value for the property specified + + + + flags for the property specified + + + + + + Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64 +property. + +See g_param_spec_internal() for details on property names. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + minimum value for the property specified + + + + maximum value for the property specified + + + + default value for the property specified + + + + flags for the property specified + + + + + + Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG +property. + +See g_param_spec_internal() for details on property names. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + minimum value for the property specified + + + + maximum value for the property specified + + + + default value for the property specified + + + + flags for the property specified + + + + + + Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT +property. #GValue structures for this property can be accessed with +g_value_set_uint() and g_value_get_uint(). + +See g_param_spec_internal() for details on property names. + + + a newly created parameter specification + + + + + canonical name of the property specified + + + + nick name for the property specified + + + + description of the property specified + + + + default value for the property specified + + + + flags for the property specified + + + + - Creates a new #GParamSpecValueArray instance specifying a + Creates a new #GParamSpecValueArray instance specifying a %G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a %G_TYPE_BOXED type, as such, #GValue structures for this property can be accessed with g_value_set_boxed() and g_value_get_boxed(). @@ -12023,35 +14455,35 @@ can be accessed with g_value_set_boxed() and g_value_get_boxed(). See g_param_spec_internal() for details on property names. - a newly created parameter specification + a newly created parameter specification - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GParamSpec describing the elements contained in + a #GParamSpec describing the elements contained in arrays of this property, may be %NULL - flags for the property specified + flags for the property specified - Creates a new #GParamSpecVariant instance specifying a #GVariant + Creates a new #GParamSpecVariant instance specifying a #GVariant property. If @default_value is floating, it is consumed. @@ -12059,191 +14491,264 @@ If @default_value is floating, it is consumed. See g_param_spec_internal() for details on property names. - the newly created #GParamSpec + the newly created #GParamSpec - canonical name of the property specified + canonical name of the property specified - nick name for the property specified + nick name for the property specified - description of the property specified + description of the property specified - a #GVariantType + a #GVariantType - a #GVariant of type @type to + a #GVariant of type @type to use as the default value, or %NULL - flags for the property specified + flags for the property specified - Registers @name as the name of a new static type derived from + Registers @name as the name of a new static type derived from #G_TYPE_PARAM. The type system uses the information contained in the #GParamSpecTypeInfo structure pointed to by @info to manage the #GParamSpec type and its instances. - + - The new type identifier. + The new type identifier. - 0-terminated string used as the name of the new #GParamSpec type. + 0-terminated string used as the name of the new #GParamSpec type. - The #GParamSpecTypeInfo for this #GParamSpec type. + The #GParamSpecTypeInfo for this #GParamSpec type. - Transforms @src_value into @dest_value if possible, and then + Transforms @src_value into @dest_value if possible, and then validates @dest_value, in order for it to conform to @pspec. If @strict_validation is %TRUE this function will only succeed if the transformed @dest_value complied to @pspec without modifications. See also g_value_type_transformable(), g_value_transform() and g_param_value_validate(). - + - %TRUE if transformation and validation were successful, + %TRUE if transformation and validation were successful, %FALSE otherwise and @dest_value is left untouched. - a valid #GParamSpec + a valid #GParamSpec - souce #GValue + souce #GValue - destination #GValue of correct type for @pspec + destination #GValue of correct type for @pspec - %TRUE requires @dest_value to conform to @pspec + %TRUE requires @dest_value to conform to @pspec without modifications - Checks whether @value contains the default value as specified in @pspec. - + Checks whether @value contains the default value as specified in @pspec. + - whether @value contains the canonical default for this @pspec + whether @value contains the canonical default for this @pspec - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - Sets @value to its default value as specified in @pspec. - + Sets @value to its default value as specified in @pspec. + - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - Ensures that the contents of @value comply with the specifications + Ensures that the contents of @value comply with the specifications set out by @pspec. For example, a #GParamSpecInt might require that integers stored in @value may not be smaller than -42 and not be greater than +42. If @value contains an integer outside of this range, it is modified accordingly, so the resulting value will fit into the range -42 .. +42. - + - whether modifying @value was necessary to ensure validity + whether modifying @value was necessary to ensure validity - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1, + Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1, if @value1 is found to be less than, equal to or greater than @value2, respectively. - + - -1, 0 or +1, for a less than, equal to or greater than result + -1, 0 or +1, for a less than, equal to or greater than result - a valid #GParamSpec + a valid #GParamSpec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - a #GValue of correct type for @pspec + a #GValue of correct type for @pspec - Creates a new %G_TYPE_POINTER derived type id for a new + Creates a new %G_TYPE_POINTER derived type id for a new pointer type with name @name. - a new %G_TYPE_POINTER derived type id for @name. + a new %G_TYPE_POINTER derived type id for @name. - the name of the new pointer type. + the name of the new pointer type. + + Updates a #GObject pointer to refer to @new_object. It increments the +reference count of @new_object (if non-%NULL), decrements the reference +count of the current value of @object_ptr (if non-%NULL), and assigns +@new_object to @object_ptr. The assignment is not atomic. + +@object_ptr must not be %NULL. + +A macro is also included that allows this function to be used without +pointer casts. The function itself is static inline, so its address may vary +between compilation units. + +One convenient usage of this function is in implementing property setters: +|[ + void + foo_set_bar (Foo *foo, + Bar *new_bar) + { + g_return_if_fail (IS_FOO (foo)); + g_return_if_fail (new_bar == NULL || IS_BAR (new_bar)); + + if (g_set_object (&foo->bar, new_bar)) + g_object_notify (foo, "bar"); + } +]| + + + + a pointer to a #GObject reference + + + a pointer to the new #GObject to + assign to it, or %NULL to clear the pointer + + + + + Updates a pointer to weakly refer to @new_object. It assigns @new_object +to @weak_pointer_location and ensures that @weak_pointer_location will +automaticaly be set to %NULL if @new_object gets destroyed. The assignment +is not atomic. The weak reference is not thread-safe, see +g_object_add_weak_pointer() for details. + +@weak_pointer_location must not be %NULL. + +A macro is also included that allows this function to be used without +pointer casts. The function itself is static inline, so its address may vary +between compilation units. + +One convenient usage of this function is in implementing property setters: +|[ + void + foo_set_bar (Foo *foo, + Bar *new_bar) + { + g_return_if_fail (IS_FOO (foo)); + g_return_if_fail (new_bar == NULL || IS_BAR (new_bar)); + + if (g_set_weak_pointer (&foo->bar, new_bar)) + g_object_notify (foo, "bar"); + } +]| + + + + the memory address of a pointer + + + a pointer to the new #GObject to + assign to it, or %NULL to clear the pointer + + + - A predefined #GSignalAccumulator for signals intended to be used as a + A predefined #GSignalAccumulator for signals intended to be used as a hook for application code to provide a particular value. Usually only one such value is desired and multiple handlers for the same signal don't make much sense (except for the case of the default @@ -12253,106 +14758,106 @@ usually want the signal connection to override the class handler). This accumulator will use the return value from the first signal handler that is run as the return value for the signal and not run any further handlers (ie: the first handler "wins"). - + - standard #GSignalAccumulator result + standard #GSignalAccumulator result - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - A predefined #GSignalAccumulator for signals that return a + A predefined #GSignalAccumulator for signals that return a boolean values. The behavior that this accumulator gives is that a return of %TRUE stops the signal emission: no further callbacks will be invoked, while a return of %FALSE allows the emission to continue. The idea here is that a %TRUE return indicates that the callback handled the signal, and no further handling is needed. - + - standard #GSignalAccumulator result + standard #GSignalAccumulator result - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - standard #GSignalAccumulator parameter + standard #GSignalAccumulator parameter - Adds an emission hook for a signal, which will get called for any emission + Adds an emission hook for a signal, which will get called for any emission of that signal, independent of the instance. This is possible only for signals which don't have #G_SIGNAL_NO_HOOKS flag set. - the hook id, for later use with g_signal_remove_emission_hook(). + the hook id, for later use with g_signal_remove_emission_hook(). - the signal identifier, as returned by g_signal_lookup(). + the signal identifier, as returned by g_signal_lookup(). - the detail on which to call the hook. + the detail on which to call the hook. - a #GSignalEmissionHook function. + a #GSignalEmissionHook function. - user data for @hook_func. + user data for @hook_func. - a #GDestroyNotify for @hook_data. + a #GDestroyNotify for @hook_data. - Calls the original class closure of a signal. This function should only + Calls the original class closure of a signal. This function should only be called from an overridden class closure; see g_signal_override_class_closure() and g_signal_override_class_handler(). - + - the argument list of the signal emission. + the argument list of the signal emission. The first element in the array is a #GValue for the instance the signal is being emitted on. The rest are any arguments to be passed to the signal. @@ -12360,132 +14865,175 @@ g_signal_override_class_handler(). - Location for the return value. + Location for the return value. - Calls the original class closure of a signal. This function should + Calls the original class closure of a signal. This function should only be called from an overridden class closure; see g_signal_override_class_closure() and g_signal_override_class_handler(). - + - the instance the signal is being + the instance the signal is being emitted on. - parameters to be passed to the parent class closure, followed by a + parameters to be passed to the parent class closure, followed by a location for the return value. If the return type of the signal is #G_TYPE_NONE, the return value location can be omitted. + + Connects a #GCallback function to a signal for a particular object. + +The handler will be called before the default handler of the signal. + +See [memory management of signal handlers][signal-memory-management] for +details on how to handle the return value and memory management of @data. + + + + the instance to connect to. + + + a string of the form "signal-name::detail". + + + the #GCallback to connect. + + + data to pass to @c_handler calls. + + + + + Connects a #GCallback function to a signal for a particular object. + +The handler will be called after the default handler of the signal. + + + + the instance to connect to. + + + a string of the form "signal-name::detail". + + + the #GCallback to connect. + + + data to pass to @c_handler calls. + + + - Connects a closure to a signal for a particular object. + Connects a closure to a signal for a particular object. - the handler ID (always greater than 0 for successful connections) + the handler ID (always greater than 0 for successful connections) - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the closure to connect. + the closure to connect. - whether the handler should be called before or after the + whether the handler should be called before or after the default handler of the signal. - Connects a closure to a signal for a particular object. + Connects a closure to a signal for a particular object. - the handler ID (always greater than 0 for successful connections) + the handler ID (always greater than 0 for successful connections) - the instance to connect to. + the instance to connect to. - the id of the signal. + the id of the signal. - the detail. + the detail. - the closure to connect. + the closure to connect. - whether the handler should be called before or after the + whether the handler should be called before or after the default handler of the signal. - Connects a #GCallback function to a signal for a particular object. Similar + Connects a #GCallback function to a signal for a particular object. Similar to g_signal_connect(), but allows to provide a #GClosureNotify for the data which will be called when the signal handler is disconnected and no longer used. Specify @connect_flags if you need `..._after()` or `..._swapped()` variants of this function. - the handler ID (always greater than 0 for successful connections) + the handler ID (always greater than 0 for successful connections) - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the #GCallback to connect. + the #GCallback to connect. - data to pass to @c_handler calls. + data to pass to @c_handler calls. - a #GClosureNotify for @data. + a #GClosureNotify for @data. - a combination of #GConnectFlags. + a combination of #GConnectFlags. - This is similar to g_signal_connect_data(), but uses a closure which + This is similar to g_signal_connect_data(), but uses a closure which ensures that the @gobject stays alive during the call to @c_handler by temporarily adding a reference count to @gobject. @@ -12493,37 +15041,80 @@ When the @gobject is destroyed the signal handler will be automatically disconnected. Note that this is not currently threadsafe (ie: emitting a signal while @gobject is being destroyed in another thread is not safe). - + - the handler id. + the handler id. - the instance to connect to. + the instance to connect to. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - the #GCallback to connect. + the #GCallback to connect. - the object to pass as data + the object to pass as data to @c_handler. - a combination of #GConnectFlags. + a combination of #GConnectFlags. + + 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. 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); +]| + + + + the instance to connect to. + + + a string of the form "signal-name::detail". + + + the #GCallback to connect. + + + data to pass to @c_handler calls. + + + - Emits a signal. + Emits a signal. Note that g_signal_emit() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). @@ -12533,19 +15124,19 @@ if no handlers are connected, in contrast to g_signal_emitv(). - the instance the signal is being emitted on. + the instance the signal is being emitted on. - the signal id + the signal id - the detail + the detail - parameters to be passed to the signal, followed by a + parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is #G_TYPE_NONE, the return value location can be omitted. @@ -12553,7 +15144,7 @@ if no handlers are connected, in contrast to g_signal_emitv(). - Emits a signal. + Emits a signal. Note that g_signal_emit_by_name() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). @@ -12563,15 +15154,15 @@ if no handlers are connected, in contrast to g_signal_emitv(). - the instance the signal is being emitted on. + the instance the signal is being emitted on. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - parameters to be passed to the signal, followed by a + parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is #G_TYPE_NONE, the return value location can be omitted. @@ -12579,7 +15170,7 @@ if no handlers are connected, in contrast to g_signal_emitv(). - Emits a signal. + Emits a signal. Note that g_signal_emit_valist() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). @@ -12589,20 +15180,20 @@ if no handlers are connected, in contrast to g_signal_emitv(). - the instance the signal is being + the instance the signal is being emitted on. - the signal id + the signal id - the detail + the detail - a list of parameters to be passed to the signal, followed by a + a list of parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is #G_TYPE_NONE, the return value location can be omitted. @@ -12610,7 +15201,7 @@ if no handlers are connected, in contrast to g_signal_emitv(). - Emits a signal. + Emits a signal. Note that g_signal_emitv() doesn't change @return_value if no handlers are connected, in contrast to g_signal_emit() and g_signal_emit_valist(). @@ -12620,7 +15211,7 @@ connected, in contrast to g_signal_emit() and g_signal_emit_valist(). - argument list for the signal emission. + argument list for the signal emission. The first element in the array is a #GValue for the instance the signal is being emitted on. The rest are any arguments to be passed to the signal. @@ -12628,15 +15219,15 @@ connected, in contrast to g_signal_emit() and g_signal_emit_valist(). - the signal id + the signal id - the detail + the detail - Location to + Location to store the return value of the signal emission. This must be provided if the specified signal returns a value, but may be ignored otherwise. @@ -12644,21 +15235,21 @@ specified signal returns a value, but may be ignored otherwise. - Returns the invocation hint of the innermost signal emission of instance. + Returns the invocation hint of the innermost signal emission of instance. - the invocation hint of the innermost signal emission. + the invocation hint of the innermost signal emission. - the instance to query + the instance to query - Blocks a handler of an instance so it will not be called during any + Blocks a handler of an instance so it will not be called during any signal emissions unless it is unblocked again. Thus "blocking" a signal handler means to temporarily deactive it, a signal handler has to be unblocked exactly the same amount of times it has been @@ -12672,17 +15263,17 @@ signal of @instance. - The instance to block the signal handler of. + The instance to block the signal handler of. - Handler id of the handler to be blocked. + Handler id of the handler to be blocked. - Disconnects a handler from an instance so it will not be called during + Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The @handler_id becomes invalid and may be reused. @@ -12694,78 +15285,78 @@ signal of @instance. - The instance to remove the signal handler from. + The instance to remove the signal handler from. - Handler id of the handler to be disconnected. + Handler id of the handler to be disconnected. - Finds the first signal handler that matches certain selection criteria. + Finds the first signal handler that matches certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. The match @mask has to be non-0 for successful matches. If no handler was found, 0 is returned. - A valid non-0 signal handler id for a successful match. + A valid non-0 signal handler id for a successful match. - The instance owning the signal handler to be found. + The instance owning the signal handler to be found. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handler has to match. - Signal the handler has to be connected to. + Signal the handler has to be connected to. - Signal detail the handler has to be connected to. + Signal detail the handler has to be connected to. - The closure the handler will invoke. + The closure the handler will invoke. - The C closure callback of the handler (useless for non-C closures). + The C closure callback of the handler (useless for non-C closures). - The closure data of the handler's closure. + The closure data of the handler's closure. - Returns whether @handler_id is the ID of a handler connected to @instance. + Returns whether @handler_id is the ID of a handler connected to @instance. - whether @handler_id identifies a handler connected to @instance. + whether @handler_id identifies a handler connected to @instance. - The instance where a signal handler is sought. + The instance where a signal handler is sought. - the handler ID. + the handler ID. - Undoes the effect of a previous g_signal_handler_block() call. A + Undoes the effect of a previous g_signal_handler_block() call. A blocked handler is skipped during signal emissions and will not be invoked, unblocking it (for exactly the amount of times it has been blocked before) reverts its "blocked" state, so the handler will be @@ -12784,17 +15375,32 @@ connected to a signal of @instance and is currently blocked. - The instance to unblock the signal handler of. + The instance to unblock the signal handler of. - Handler id of the handler to be unblocked. + Handler id of the handler to be unblocked. + + Blocks all handlers on an instance that match @func and @data. + + + + The instance to block handlers from. + + + The C closure callback of the handlers (useless for non-C closures). + + + The closure data of the handlers' closures. + + + - Blocks all handlers on an instance that match a certain selection criteria. + Blocks all handlers on an instance that match a certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC @@ -12803,58 +15409,85 @@ If no handlers were found, 0 is returned, the number of blocked handlers otherwise. - The number of handlers that matched. + The number of handlers that matched. - The instance to block handlers from. + The instance to block handlers from. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. - Signal the handlers have to be connected to. + Signal the handlers have to be connected to. - Signal detail the handlers have to be connected to. + Signal detail the handlers have to be connected to. - The closure the handlers will invoke. + The closure the handlers will invoke. - The C closure callback of the handlers (useless for non-C closures). + The C closure callback of the handlers (useless for non-C closures). - The closure data of the handlers' closures. + The closure data of the handlers' closures. - Destroy all signal handlers of a type instance. This function is + 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 whose signal handlers are destroyed + The instance whose signal handlers are destroyed + + Disconnects all handlers on an instance that match @data. + + + + The instance to remove handlers from + + + the closure data of the handlers' closures + + + + + Disconnects all handlers on an instance that match @func and @data. + + + + The instance to remove handlers from. + + + The C closure callback of the handlers (useless for non-C closures). + + + The closure data of the handlers' closures. + + + - Disconnects all handlers on an instance that match a certain + Disconnects all handlers on an instance that match a certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. Passing at least one of the @@ -12864,43 +15497,58 @@ matches. If no handlers were found, 0 is returned, the number of disconnected handlers otherwise. - The number of handlers that matched. + The number of handlers that matched. - The instance to remove handlers from. + The instance to remove handlers from. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. - Signal the handlers have to be connected to. + Signal the handlers have to be connected to. - Signal detail the handlers have to be connected to. + Signal detail the handlers have to be connected to. - The closure the handlers will invoke. + The closure the handlers will invoke. - The C closure callback of the handlers (useless for non-C closures). + The C closure callback of the handlers (useless for non-C closures). - The closure data of the handlers' closures. + The closure data of the handlers' closures. + + Unblocks all handlers on an instance that match @func and @data. + + + + The instance to unblock handlers from. + + + The C closure callback of the handlers (useless for non-C closures). + + + The closure data of the handlers' closures. + + + - Unblocks all handlers on an instance that match a certain selection + Unblocks all handlers on an instance that match a certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC @@ -12910,43 +15558,43 @@ otherwise. The match criteria should not apply to any handlers that are not currently blocked. - The number of handlers that matched. + The number of handlers that matched. - The instance to unblock handlers from. + The instance to unblock handlers from. - Mask indicating which of @signal_id, @detail, @closure, @func + Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. - Signal the handlers have to be connected to. + Signal the handlers have to be connected to. - Signal detail the handlers have to be connected to. + Signal detail the handlers have to be connected to. - The closure the handlers will invoke. + The closure the handlers will invoke. - The C closure callback of the handlers (useless for non-C closures). + The C closure callback of the handlers (useless for non-C closures). - The closure data of the handlers' closures. + The closure data of the handlers' closures. - Returns whether there are any handlers connected to @instance for the + Returns whether there are any handlers connected to @instance for the given signal id and detail. If @detail is 0 then it will only match handlers that were connected @@ -12964,53 +15612,53 @@ emit the signal if no one is attached anyway, thus saving the cost of building the arguments. - %TRUE if a handler is connected to the signal, %FALSE + %TRUE if a handler is connected to the signal, %FALSE otherwise. - the object whose signal handlers are sought. + the object whose signal handlers are sought. - the signal id. + the signal id. - the detail. + the detail. - whether blocked handlers should count as match. + whether blocked handlers should count as match. - Lists the signals by id that a certain instance or interface type + Lists the signals by id that a certain instance or interface type created. Further information about the signals can be acquired through g_signal_query(). - Newly allocated array of signal IDs. + Newly allocated array of signal IDs. - Instance or interface type. + Instance or interface type. - Location to store the number of signal ids for @itype. + Location to store the number of signal ids for @itype. - Given the name of the signal and the type of object it connects to, gets + Given the name of the signal and the type of object it connects to, gets the signal's identifying integer. Emitting the signal by number is somewhat faster than using the name each time. @@ -13019,38 +15667,38 @@ Also tries the ancestors of the given type. See g_signal_new() for details on allowed signal names. - the signal's identifying number, or 0 if no signal was found. + the signal's identifying number, or 0 if no signal was found. - the signal's name. + the signal's name. - the type that the signal operates on. + the type that the signal operates on. - Given the signal's identifier, finds its name. + Given the signal's identifier, finds its name. Two different signals may have the same name, if they have differing types. - the signal name, or %NULL if the signal number was invalid. + the signal name, or %NULL if the signal number was invalid. - the signal's identifying number. + the signal's identifying number. - Creates a new signal. (This is usually done in the class initializer.) + Creates a new signal. (This is usually done in the class initializer.) A signal name consists of segments consisting of ASCII letters and digits, separated by either the '-' or '_' character. The first @@ -13064,65 +15712,71 @@ If 0 is used for @class_offset subclasses cannot override the class handler in their class_init method by doing super_class->signal_handler = my_signal_handler. Instead they will have to use g_signal_override_class_handler(). -If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as -the marshaller for this signal. +If @c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as +the marshaller for this signal. In some simple cases, g_signal_new() +will use a more optimized c_marshaller and va_marshaller for the signal +instead of g_cclosure_marshal_generic(). + +If @c_marshaller is non-%NULL, you need to also specify a va_marshaller +using g_signal_set_va_marshaller() or the generic va_marshaller will +be used. - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type. - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. - The offset of the function pointer in the class structure + The offset of the function pointer in the class structure for this type. Used to invoke a class method generically. Pass 0 to not associate a class method slot with this signal. - the accumulator for this signal; may be %NULL. + the accumulator for this signal; may be %NULL. - user data for the @accumulator. + user data for the @accumulator. - the function to translate arrays of parameter + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value. - the number of parameter types to follow. + the number of parameter types to follow. - a list of types, one for each parameter. + a list of types, one for each parameter. - Creates a new signal. (This is usually done in the class initializer.) + Creates a new signal. (This is usually done in the class initializer.) This is a variant of g_signal_new() that takes a C callback instead of a class offset for the signal's class handler. This function @@ -13140,61 +15794,61 @@ If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type. - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. - a #GCallback which acts as class implementation of + a #GCallback which acts as class implementation of this signal. Used to invoke a class method generically. Pass %NULL to not associate a class method with this signal. - the accumulator for this signal; may be %NULL. + the accumulator for this signal; may be %NULL. - user data for the @accumulator. + user data for the @accumulator. - the function to translate arrays of parameter + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value. - the number of parameter types to follow. + the number of parameter types to follow. - a list of types, one for each parameter. + a list of types, one for each parameter. - Creates a new signal. (This is usually done in the class initializer.) + Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. @@ -13202,59 +15856,59 @@ If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type. - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. - The closure to invoke on signal emission; may be %NULL. + The closure to invoke on signal emission; may be %NULL. - the accumulator for this signal; may be %NULL. + the accumulator for this signal; may be %NULL. - user data for the @accumulator. + user data for the @accumulator. - the function to translate arrays of parameter + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value. - the number of parameter types in @args. + the number of parameter types in @args. - va_list of #GType, one for each parameter. + va_list of #GType, one for each parameter. - Creates a new signal. (This is usually done in the class initializer.) + Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. @@ -13262,55 +15916,55 @@ If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - the signal id + the signal id - the name for the signal + the name for the signal - the type this signal pertains to. It will also pertain to + the type this signal pertains to. It will also pertain to types which are derived from this type - a combination of #GSignalFlags specifying detail of when + a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST - The closure to invoke on signal emission; + The closure to invoke on signal emission; may be %NULL - the accumulator for this signal; may be %NULL + the accumulator for this signal; may be %NULL - user data for the @accumulator + user data for the @accumulator - the function to translate arrays of + the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL - the type of return value, or #G_TYPE_NONE for a signal + the type of return value, or #G_TYPE_NONE for a signal without a return value - the length of @param_types + the length of @param_types - an array of types, one for + an array of types, one for each parameter @@ -13319,35 +15973,35 @@ the marshaller for this signal. - Overrides the class closure (i.e. the default handler) for the given signal + Overrides the class closure (i.e. the default handler) for the given signal for emissions on instances of @instance_type. @instance_type must be derived from the type to which the signal belongs. See g_signal_chain_from_overridden() and g_signal_chain_from_overridden_handler() for how to chain up to the parent class closure from inside the overridden one. - + - the signal id + the signal id - the instance type on which to override the class closure + the instance type on which to override the class closure for the signal. - the closure. + the closure. - Overrides the class closure (i.e. the default handler) for the + Overrides the class closure (i.e. the default handler) for the given signal for emissions on instances of @instance_type with callback @class_handler. @instance_type must be derived from the type to which the signal belongs. @@ -13355,59 +16009,59 @@ type to which the signal belongs. See g_signal_chain_from_overridden() and g_signal_chain_from_overridden_handler() for how to chain up to the parent class closure from inside the overridden one. - + - the name for the signal + the name for the signal - the instance type on which to override the class handler + the instance type on which to override the class handler for the signal. - the handler. + the handler. - Internal function to parse a signal name into its @signal_id + Internal function to parse a signal name into its @signal_id and @detail quark. - Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values. + Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - The interface/instance type that introduced "signal-name". + The interface/instance type that introduced "signal-name". - Location to store the signal id. + Location to store the signal id. - Location to store the detail quark. + Location to store the detail quark. - %TRUE forces creation of a #GQuark for the detail. + %TRUE forces creation of a #GQuark for the detail. - Queries the signal system for in-depth information about a + Queries the signal system for in-depth information about a specific signal. This function will fill in a user-provided structure to hold signal-specific information. If an invalid signal id is passed in, the @signal_id member of the #GSignalQuery @@ -13419,36 +16073,36 @@ be considered constant and have to be left untouched. - The signal id of the signal to query information for. + The signal id of the signal to query information for. - A user provided structure that is + A user provided structure that is filled in with constant values upon success. - Deletes an emission hook. + Deletes an emission hook. - the id of the signal + the id of the signal - the id of the emission hook, as returned by + the id of the emission hook, as returned by g_signal_add_emission_hook() - Change the #GSignalCVaMarshaller used for a given signal. This is a + Change the #GSignalCVaMarshaller used for a given signal. This is a specialised form of the marshaller that can often be used for the common case of a single connected signal handler and avoids the overhead of #GValue. Its use is optional. @@ -13458,21 +16112,21 @@ overhead of #GValue. Its use is optional. - the signal id + the signal id - the instance type on which to set the marshaller. + the instance type on which to set the marshaller. - the marshaller to set. + the marshaller to set. - Stops a signal's current emission. + Stops a signal's current emission. This will prevent the default method from running, if the signal was %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after" @@ -13485,21 +16139,21 @@ Prints a warning if used on a signal which isn't being emitted. - the object whose signal handlers you wish to stop. + the object whose signal handlers you wish to stop. - the signal identifier, as returned by g_signal_lookup(). + the signal identifier, as returned by g_signal_lookup(). - the detail which the signal was emitted with. + the detail which the signal was emitted with. - Stops a signal's current emission. + Stops a signal's current emission. This is just like g_signal_stop_emission() except it will look up the signal id for you. @@ -13509,38 +16163,38 @@ signal id for you. - the object whose signal handlers you wish to stop. + the object whose signal handlers you wish to stop. - a string of the form "signal-name::detail". + a string of the form "signal-name::detail". - Creates a new closure which invokes the function found at the offset + Creates a new closure which invokes the function found at the offset @struct_offset in the class structure of the interface or classed type identified by @itype. - a floating reference to a new #GCClosure + a floating reference to a new #GCClosure - the #GType identifier of an interface or classed type + the #GType identifier of an interface or classed type - the offset of the member function of @itype's class + the offset of the member function of @itype's class structure which is to be invoked by the new closure - Set the callback for a source as a #GClosure. + Set the callback for a source as a #GClosure. If the source is not one of the standard GLib types, the @closure_callback and @closure_marshal fields of the #GSourceFuncs structure must have been @@ -13551,17 +16205,17 @@ filled in with pointers to appropriate functions. - the source + the source - a #GClosure + a #GClosure - Sets a dummy callback for @source. The callback will do nothing, and + Sets a dummy callback for @source. The callback will do nothing, and if the source expects a #gboolean return value, it will return %TRUE. (If the source expects any other type of return value, it will return a 0/%NULL value; whatever g_value_init() initializes a #GValue to for @@ -13577,53 +16231,53 @@ functions. - the source + the source - Return a newly allocated string, which describes the contents of a + Return a newly allocated string, which describes the contents of a #GValue. The main purpose of this function is to describe #GValue contents for debugging output, the way in which the contents are described may change between different GLib versions. - Newly allocated string. + Newly allocated string. - #GValue which contents are to be described. + #GValue which contents are to be described. - Adds a #GTypeClassCacheFunc to be called before the reference count of a + Adds a #GTypeClassCacheFunc to be called before the reference count of a class goes from one to zero. This can be used to prevent premature class destruction. All installed #GTypeClassCacheFunc functions will be chained until one of them returns %TRUE. The functions have to check the class id passed in to figure whether they actually want to cache the class of this type, since all classes are routed through the same #GTypeClassCacheFunc chain. - + - data to be passed to @cache_func + data to be passed to @cache_func - a #GTypeClassCacheFunc + a #GTypeClassCacheFunc - Registers a private class structure for a classed type; + 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 @@ -13633,23 +16287,23 @@ 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. - + - GType of an classed type + GType of an classed type - size of private structure + size of private structure - + @@ -13663,7 +16317,7 @@ G_TYPE_CLASS_GET_PRIVATE() macro. - Adds a function to be called after an interface vtable is + Adds a function to be called after an interface vtable is initialized for any class (i.e. after the @interface_init member of #GInterfaceInfo has been called). @@ -13672,71 +16326,71 @@ that depends on the interfaces of a class. For instance, the implementation of #GObject uses this facility to check that an object implements all of the properties that are defined on its interfaces. - + - data to pass to @check_func + data to pass to @check_func - function to be called after each interface + function to be called after each interface is initialized - Adds the dynamic @interface_type to @instantiable_type. The information + Adds the dynamic @interface_type to @instantiable_type. The information contained in the #GTypePlugin structure pointed to by @plugin is used to manage the relationship. - + - #GType value of an instantiable type + #GType value of an instantiable type - #GType value of an interface type + #GType value of an interface type - #GTypePlugin structure to retrieve the #GInterfaceInfo from + #GTypePlugin structure to retrieve the #GInterfaceInfo from - Adds the static @interface_type to @instantiable_type. + Adds the static @interface_type to @instantiable_type. The information contained in the #GInterfaceInfo structure pointed to by @info is used to manage the relationship. - + - #GType value of an instantiable type + #GType value of an instantiable type - #GType value of an interface type + #GType value of an interface type - #GInterfaceInfo structure for this + #GInterfaceInfo structure for this (@instance_type, @interface_type) combination - + @@ -13750,7 +16404,7 @@ pointed to by @info is used to manage the relationship. - + @@ -13764,22 +16418,22 @@ pointed to by @info is used to manage the relationship. - Private helper function to aid implementation of the + Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE() macro. - + - %TRUE if @instance is valid, %FALSE otherwise + %TRUE if @instance is valid, %FALSE otherwise - a valid #GTypeInstance structure + a valid #GTypeInstance structure - + @@ -13793,7 +16447,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -13807,7 +16461,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -13821,7 +16475,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -13832,7 +16486,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -13843,7 +16497,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -13857,11 +16511,11 @@ G_TYPE_CHECK_INSTANCE() macro. - Return a newly allocated and 0-terminated array of type IDs, listing + Return a newly allocated and 0-terminated array of type IDs, listing the child types of @type. - + - Newly allocated + Newly allocated and 0-terminated array of child types, free with g_free() @@ -13869,18 +16523,18 @@ the child types of @type. - the parent type + the parent type - location to store the length of + location to store the length of the returned array, or %NULL - + @@ -13894,61 +16548,61 @@ the child types of @type. - This function is essentially the same as g_type_class_ref(), + This function is essentially the same as g_type_class_ref(), except that the classes reference count isn't incremented. As a consequence, this function may return %NULL if the class of the type passed in does not currently exist (hasn't been referenced before). - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist - type ID of a classed type + type ID of a classed type - A more efficient version of g_type_class_peek() which works only for + A more efficient version of g_type_class_peek() which works only for static types. - + - the #GTypeClass + the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist or is dynamically loaded - type ID of a classed type + type ID of a classed type - Increments the reference count of the class structure belonging to + Increments the reference count of the class structure belonging to @type. This function will demand-create the class if it doesn't exist already. - + - the #GTypeClass + the #GTypeClass structure for the given type ID - type ID of a classed type + type ID of a classed type - Creates and initializes an instance of @type if @type is valid and + Creates and initializes an instance of @type if @type is valid and can be instantiated. The type system only performs basic allocation and structure setups for instances: actual instance creation should happen through functions supplied by the type's fundamental type @@ -13964,38 +16618,38 @@ 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. - + - an allocated and initialized instance, subject to further + an allocated and initialized instance, subject to further treatment by the fundamental type implementation - an instantiatable type to create an instance for + an instantiatable type to create an instance for - If the interface type @g_type is currently in use, returns its + If the interface type @g_type is currently in use, returns its default interface vtable. - + - the default + the default vtable for the interface, or %NULL if the type is not currently in use - an interface type + an interface type - Increments the reference count for the interface type @g_type, + Increments the reference count for the interface type @g_type, and returns the default interface vtable for the type. If the type is not currently in use, then the default vtable @@ -14005,55 +16659,55 @@ the type (the @base_init and @class_init members of #GTypeInfo). Calling g_type_default_interface_ref() is useful when you want to make sure that signals and properties for an interface have been installed. - + - the default + the default vtable for the interface; call g_type_default_interface_unref() when you are done using the interface. - an interface type + an interface type - Decrements the reference count for the type corresponding to the + Decrements the reference count for the type corresponding to the interface default vtable @g_iface. If the type is dynamic, then when no one is using the interface and all references have been released, the finalize function for the interface's default vtable (the @class_finalize member of #GTypeInfo) will be called. - + - the default vtable + the default vtable structure for a interface, as returned by g_type_default_interface_ref() - Returns the length of the ancestry of the passed in type. This + Returns the length of the ancestry of the passed in type. This includes the type itself, so that e.g. a fundamental type has depth 1. - + - the depth of @type + the depth of @type - a #GType + a #GType - Ensures that the indicated @type has been registered with the + Ensures that the indicated @type has been registered with the type system, and its _class_init() method has been run. In theory, simply calling the type's _get_type() method (or using @@ -14065,245 +16719,245 @@ which _get_type() methods do on the first call). As a result, if you write a bare call to a _get_type() macro, it may get optimized out by the compiler. Using g_type_ensure() guarantees that the type's _get_type() method is called. - + - a #GType + a #GType - Frees an instance of a type, returning it to the instance pool for + Frees an instance of a type, returning it to the instance pool for the type, if there is one. Like g_type_create_instance(), this function is reserved for implementors of fundamental types. - + - an instance of a type + an instance of a type - Lookup the type ID from a given type name, returning 0 if no type + Look up the type ID from a given type name, returning 0 if no type has been registered under this name (this is the preferred method to find out by name whether a specific type has been registered yet). - + - corresponding type ID or 0 + corresponding type ID or 0 - type name to lookup + type name to look up - Internal function, used to extract the fundamental type ID portion. + Internal function, used to extract the fundamental type ID portion. Use G_TYPE_FUNDAMENTAL() instead. - + - fundamental type ID + fundamental type ID - valid type ID + valid type ID - Returns the next free fundamental type id which can be used to + Returns the next free fundamental type id which can be used to register a new fundamental type with g_type_register_fundamental(). The returned type ID represents the highest currently registered fundamental type identifier. - + - the next available fundamental type ID to be registered, + the next available fundamental type ID to be registered, or 0 if the type system ran out of fundamental type IDs - Returns the number of instances allocated of the particular type; + Returns the number of instances allocated of the particular type; this is only available if GLib is built with debugging support and the instance_count debug flag is set (by setting the GOBJECT_DEBUG variable to include instance-count). - + - the number of instances allocated of the given type; + the number of instances allocated of the given type; if instance counts are not available, returns 0. - a #GType + a #GType - Returns the #GTypePlugin structure for @type. - + Returns the #GTypePlugin structure for @type. + - the corresponding plugin + the corresponding plugin if @type is a dynamic type, %NULL otherwise - #GType to retrieve the plugin for + #GType to retrieve the plugin for - Obtains data which has previously been attached to @type + Obtains data which has previously been attached to @type with g_type_set_qdata(). Note that this does not take subtyping into account; data attached to one type with g_type_set_qdata() cannot be retrieved from a subtype using g_type_get_qdata(). - + - the data, or %NULL if no data was found + the data, or %NULL if no data was found - a #GType + a #GType - a #GQuark id to identify the data + a #GQuark id to identify the data - Returns an opaque serial number that represents the state of the set + Returns an opaque serial number that represents the state of the set of registered types. Any time a type is registered this serial changes, which means you can cache information based on type lookups (such as g_type_from_name()) and know if the cache is still valid at a later time by comparing the current serial with the one at the type lookup. - + - An unsigned int, representing the state of type registrations + An unsigned int, representing the state of type registrations - This function used to initialise the type system. Since GLib 2.36, + This function used to initialise the type system. Since GLib 2.36, the type system is initialised automatically and this function does nothing. the type system is now initialised automatically - + - This function used to initialise the type system with debugging + This function used to initialise the type system with debugging flags. Since GLib 2.36, the type system is initialised automatically and this function does nothing. If you need to enable debugging features, use the GOBJECT_DEBUG environment variable. the type system is now initialised automatically - + - bitwise combination of #GTypeDebugFlags values for + bitwise combination of #GTypeDebugFlags values for debugging purposes - Adds @prerequisite_type to the list of prerequisites of @interface_type. + Adds @prerequisite_type to the list of prerequisites of @interface_type. This means that any type implementing @interface_type must also implement @prerequisite_type. Prerequisites can be thought of as an alternative to interface derivation (which GType doesn't support). An interface can have at most one instantiatable prerequisite type. - + - #GType value of an interface type + #GType value of an interface type - #GType value of an interface or instantiatable type + #GType value of an interface or instantiatable type - Returns the #GTypePlugin structure for the dynamic interface + Returns the #GTypePlugin structure for the dynamic interface @interface_type which has been added to @instance_type, or %NULL if @interface_type has not been added to @instance_type or does not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). - + - the #GTypePlugin for the dynamic + the #GTypePlugin for the dynamic interface @interface_type of @instance_type - #GType of an instantiatable type + #GType of an instantiatable type - #GType of an interface type + #GType of an interface type - Returns the #GTypeInterface structure of an interface to which the + Returns the #GTypeInterface structure of an interface to which the passed in class conforms. - + - the #GTypeInterface + the #GTypeInterface structure of @iface_type if implemented by @instance_class, %NULL otherwise - a #GTypeClass structure + a #GTypeClass structure - an interface ID which this class conforms to + an interface ID which this class conforms to - Returns the prerequisites of an interfaces type. - + Returns the prerequisites of an interfaces type. + - a + a newly-allocated zero-terminated array of #GType containing the prerequisites of @interface_type @@ -14312,22 +16966,22 @@ passed in class conforms. - an interface type + an interface type - location to return the number + location to return the number of prerequisites, or %NULL - Return a newly allocated and 0-terminated array of type IDs, listing + Return a newly allocated and 0-terminated array of type IDs, listing the interface types that @type conforms to. - + - Newly allocated + Newly allocated and 0-terminated array of interface types, free with g_free() @@ -14335,57 +16989,57 @@ the interface types that @type conforms to. - the type to list interface types for + the type to list interface types for - location to store the length of + location to store the length of the returned array, or %NULL - If @is_a_type is a derivable type, check whether @type is a + If @is_a_type is a derivable type, check whether @type is a descendant of @is_a_type. If @is_a_type is an interface, check whether @type conforms to it. - + - %TRUE if @type is a @is_a_type + %TRUE if @type is a @is_a_type - type to check anchestry for + type to check anchestry for - possible anchestor of @type or interface that @type + possible anchestor of @type or interface that @type could conform to - Get the unique name that is assigned to a type ID. Note that this + Get the unique name that is assigned to a type ID. Note that this function (like all other GType API) cannot cope with invalid type IDs. %G_TYPE_INVALID may be passed to this function, as may be any other validly registered type ID, but randomized type IDs should not be passed in and will most likely lead to a crash. - + - static type name or %NULL + static type name or %NULL - type to return name for + type to return name for - + @@ -14396,7 +17050,7 @@ not be passed in and will most likely lead to a crash. - + @@ -14407,278 +17061,278 @@ not be passed in and will most likely lead to a crash. - Given a @leaf_type and a @root_type which is contained in its + Given a @leaf_type and a @root_type which is contained in its anchestry, return the type that @root_type is the immediate parent of. In other words, this function determines the type that is derived directly from @root_type which is also a base class of @leaf_type. Given a root type and a leaf type, this function can be used to determine the types and order in which the leaf type is descended from the root type. - + - immediate child of @root_type and anchestor of @leaf_type + immediate child of @root_type and anchestor of @leaf_type - descendant of @root_type and the type to be returned + descendant of @root_type and the type to be returned - immediate parent of the returned type + immediate parent of the returned type - Return the direct parent type of the passed in type. If the passed + Return the direct parent type of the passed in type. If the passed in type has no parent, i.e. is a fundamental type, 0 is returned. - + - the parent type + the parent type - the derived type + the derived type - Get the corresponding quark of the type IDs name. - + Get the corresponding quark of the type IDs name. + - the type names quark or 0 + the type names quark or 0 - type to return quark of type name for + type to return quark of type name for - Queries the type system for information about a specific type. + Queries the type system for information about a specific type. This function will fill in a user-provided structure to hold type-specific information. If an invalid #GType is passed in, the @type member of the #GTypeQuery is 0. All members filled into the #GTypeQuery structure should be considered constant and have to be left untouched. - + - #GType of a static, classed type + #GType of a static, classed type - a user provided structure that is + a user provided structure that is filled in with constant values upon success - Registers @type_name as the name of a new dynamic type derived from + Registers @type_name as the name of a new dynamic type derived from @parent_type. The type system uses the information contained in the #GTypePlugin structure pointed to by @plugin to manage the type and its instances (if not abstract). The value of @flags determines the nature (e.g. abstract or not) of the type. - + - the new type identifier or #G_TYPE_INVALID if registration failed + the new type identifier or #G_TYPE_INVALID if registration failed - type from which this type will be derived + type from which this type will be derived - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - #GTypePlugin structure to retrieve the #GTypeInfo from + #GTypePlugin structure to retrieve the #GTypeInfo from - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - Registers @type_id as the predefined identifier and @type_name as the + Registers @type_id as the predefined identifier and @type_name as the name of a fundamental type. If @type_id is already registered, or a type named @type_name is already registered, the behaviour is undefined. The type system uses the information contained in the #GTypeInfo structure pointed to by @info and the #GTypeFundamentalInfo structure pointed to by @finfo to manage the type and its instances. The value of @flags determines additional characteristics of the fundamental type. - + - the predefined type identifier + the predefined type identifier - a predefined type identifier + a predefined type identifier - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - #GTypeInfo structure for this type + #GTypeInfo structure for this type - #GTypeFundamentalInfo structure for this type + #GTypeFundamentalInfo structure for this type - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - Registers @type_name as the name of a new static type derived from + Registers @type_name as the name of a new static type derived from @parent_type. The type system uses the information contained in the #GTypeInfo structure pointed to by @info to manage the type and its instances (if not abstract). The value of @flags determines the nature (e.g. abstract or not) of the type. - + - the new type identifier + the new type identifier - type from which this type will be derived + type from which this type will be derived - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - #GTypeInfo structure for this type + #GTypeInfo structure for this type - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - Registers @type_name as the name of a new static type derived from + Registers @type_name as the name of a new static type derived from @parent_type. The value of @flags determines the nature (e.g. abstract or not) of the type. It works by filling a #GTypeInfo struct and calling g_type_register_static(). - + - the new type identifier + the new type identifier - type from which this type will be derived + type from which this type will be derived - 0-terminated string used as the name of the new type + 0-terminated string used as the name of the new type - size of the class structure (see #GTypeInfo) + size of the class structure (see #GTypeInfo) - location of the class initialization function (see #GTypeInfo) + location of the class initialization function (see #GTypeInfo) - size of the instance structure (see #GTypeInfo) + size of the instance structure (see #GTypeInfo) - location of the instance initialization function (see #GTypeInfo) + location of the instance initialization function (see #GTypeInfo) - bitwise combination of #GTypeFlags values + bitwise combination of #GTypeFlags values - Removes a previously installed #GTypeClassCacheFunc. The cache + Removes a previously installed #GTypeClassCacheFunc. The cache maintained by @cache_func has to be empty when calling g_type_remove_class_cache_func() to avoid leaks. - + - data that was given when adding @cache_func + data that was given when adding @cache_func - a #GTypeClassCacheFunc + a #GTypeClassCacheFunc - Removes an interface check function added with + Removes an interface check function added with g_type_add_interface_check(). - + - callback data passed to g_type_add_interface_check() + callback data passed to g_type_add_interface_check() - callback function passed to g_type_add_interface_check() + callback function passed to g_type_add_interface_check() - Attaches arbitrary data to a type. - + Attaches arbitrary data to a type. + - a #GType + a #GType - a #GQuark id to identify the data + a #GQuark id to identify the data - the data + the data - + @@ -14692,26 +17346,26 @@ g_type_add_interface_check(). - Returns the location of the #GTypeValueTable associated with @type. + Returns the location of the #GTypeValueTable associated with @type. Note that this function should only be used from source code that implements or has internal knowledge of the implementation of @type. - + - location of the #GTypeValueTable associated with @type or + location of the #GTypeValueTable associated with @type or %NULL if there is no #GTypeValueTable associated with @type - a #GType + a #GType - Registers a value transformation function for use in g_value_transform(). + Registers a value transformation function for use in g_value_transform(). A previously registered transformation function for @src_type and @dest_type will be replaced. @@ -14720,56 +17374,56 @@ will be replaced. - Source type. + Source type. - Target type. + Target type. - a function which transforms values of type @src_type + a function which transforms values of type @src_type into value of type @dest_type - Returns whether a #GValue of type @src_type can be copied into + Returns whether a #GValue of type @src_type can be copied into a #GValue of type @dest_type. - %TRUE if g_value_copy() is possible with @src_type and @dest_type. + %TRUE if g_value_copy() is possible with @src_type and @dest_type. - source type to be copied. + source type to be copied. - destination type for copying. + destination type for copying. - Check whether g_value_transform() is able to transform values + 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 or a transformation function must be registered. - %TRUE if the transformation is possible, %FALSE otherwise. + %TRUE if the transformation is possible, %FALSE otherwise. - Source type. + Source type. - Target type. + Target type. diff --git a/rust-bindings/rust/gir-files/Gio-2.0.gir b/rust-bindings/rust/gir-files/Gio-2.0.gir index cd902f6a..398fd868 100644 --- a/rust-bindings/rust/gir-files/Gio-2.0.gir +++ b/rust-bindings/rust/gir-files/Gio-2.0.gir @@ -18,8 +18,162 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - #GAction represents a single named action. + #GAction represents a single named action. The main interface to an action is that it can be activated with g_action_activate(). This results in the 'activate' signal being @@ -50,7 +204,7 @@ Probably the only useful thing to do with a #GAction is to put it inside of a #GSimpleActionGroup. - Checks if @action_name is valid. + Checks if @action_name is valid. @action_name is valid if it consists only of alphanumeric characters, plus '-' and '.'. The empty string is not a valid action name. @@ -59,18 +213,18 @@ It is an error to call this function with a non-utf8 @action_name. @action_name must not be %NULL. - %TRUE if @action_name is valid + %TRUE if @action_name is valid - an potential action name + an potential action name - Parses a detailed action name into its separate name and target + Parses a detailed action name into its separate name and target components. Detailed action names can have three formats. @@ -96,26 +250,26 @@ For strings, this third format must be used if * target value is empty or contains characters other than alphanumerics, '-' and '.'. - %TRUE if successful, else %FALSE with @error set + %TRUE if successful, else %FALSE with @error set - a detailed action name + a detailed action name - the action name + the action name - the target value, or %NULL for no target + the target value, or %NULL for no target - Formats a detailed action name from @action_name and @target_value. + Formats a detailed action name from @action_name and @target_value. It is an error to call this function with an invalid action name. @@ -127,22 +281,22 @@ See that function for the types of strings that will be printed by this function. - a detailed format string + a detailed format string - a valid action name + a valid action name - a #GVariant target value, or %NULL + a #GVariant target value, or %NULL - Activates the action. + Activates the action. @parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter @@ -155,17 +309,17 @@ If the @parameter GVariant is floating, it is consumed. - a #GAction + a #GAction - the parameter to the activation + the parameter to the activation - Request for the state of @action to be changed to @value. + Request for the state of @action to be changed to @value. The action must be stateful and @value must be of the correct type. See g_action_get_state_type(). @@ -181,48 +335,48 @@ If the @value GVariant is floating, it is consumed. - a #GAction + a #GAction - the new state + the new state - Checks if @action is currently enabled. + Checks if @action is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - whether the action is enabled + whether the action is enabled - a #GAction + a #GAction - Queries the name of @action. + Queries the name of @action. - the name of the action + the name of the action - a #GAction + a #GAction - Queries the type of the parameter that must be given when activating + Queries the type of the parameter that must be given when activating @action. When activating the action using g_action_activate(), the #GVariant @@ -232,18 +386,18 @@ In the case that this function returns %NULL, you must not give any #GVariant, but %NULL instead. - the parameter type + the parameter type - a #GAction + a #GAction - Queries the current state of @action. + Queries the current state of @action. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -253,18 +407,18 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the current state of the action + the current state of the action - a #GAction + a #GAction - Requests a hint about the valid range of values for the state of + Requests a hint about the valid range of values for the state of @action. If %NULL is returned it either means that the action is not stateful @@ -284,18 +438,18 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the state range hint + the state range hint - a #GAction + a #GAction - Queries the type of the state of @action. + Queries the type of the state of @action. If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the @@ -309,18 +463,18 @@ then this function will return %NULL. In that case, g_action_get_state() will return %NULL and you must not call g_action_change_state(). - the state type, if the action is stateful + the state type, if the action is stateful - a #GAction + a #GAction - Activates the action. + Activates the action. @parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter @@ -333,17 +487,17 @@ If the @parameter GVariant is floating, it is consumed. - a #GAction + a #GAction - the parameter to the activation + the parameter to the activation - Request for the state of @action to be changed to @value. + Request for the state of @action to be changed to @value. The action must be stateful and @value must be of the correct type. See g_action_get_state_type(). @@ -359,48 +513,48 @@ If the @value GVariant is floating, it is consumed. - a #GAction + a #GAction - the new state + the new state - Checks if @action is currently enabled. + Checks if @action is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - whether the action is enabled + whether the action is enabled - a #GAction + a #GAction - Queries the name of @action. + Queries the name of @action. - the name of the action + the name of the action - a #GAction + a #GAction - Queries the type of the parameter that must be given when activating + Queries the type of the parameter that must be given when activating @action. When activating the action using g_action_activate(), the #GVariant @@ -410,18 +564,18 @@ In the case that this function returns %NULL, you must not give any #GVariant, but %NULL instead. - the parameter type + the parameter type - a #GAction + a #GAction - Queries the current state of @action. + Queries the current state of @action. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -431,18 +585,18 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the current state of the action + the current state of the action - a #GAction + a #GAction - Requests a hint about the valid range of values for the state of + Requests a hint about the valid range of values for the state of @action. If %NULL is returned it either means that the action is not stateful @@ -462,18 +616,18 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the state range hint + the state range hint - a #GAction + a #GAction - Queries the type of the state of @action. + Queries the type of the state of @action. If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the @@ -487,12 +641,12 @@ then this function will return %NULL. In that case, g_action_get_state() will return %NULL and you must not call g_action_change_state(). - the state type, if the action is stateful + the state type, if the action is stateful - a #GAction + a #GAction @@ -600,7 +754,7 @@ See g_action_map_add_action_entries() for an example. - #GActionGroup represents a group of actions. Actions can be used to + #GActionGroup represents a group of actions. Actions can be used to expose functionality in a structured way, either from one part of a program to another, or to the outside world. Action groups are often used together with a #GMenuModel that provides additional @@ -647,7 +801,7 @@ not be implemented - their "wrappers" are actually implemented with calls to g_action_group_query_action(). - Emits the #GActionGroup::action-added signal on @action_group. + Emits the #GActionGroup::action-added signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -656,17 +810,17 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - Emits the #GActionGroup::action-enabled-changed signal on @action_group. + Emits the #GActionGroup::action-enabled-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -675,21 +829,21 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - whether or not the action is now enabled + whether or not the action is now enabled - Emits the #GActionGroup::action-removed signal on @action_group. + Emits the #GActionGroup::action-removed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -698,17 +852,17 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - Emits the #GActionGroup::action-state-changed signal on @action_group. + Emits the #GActionGroup::action-state-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -717,21 +871,21 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - the new state of the named action + the new state of the named action - Activate the named action within @action_group. + Activate the named action within @action_group. If the action is expecting a parameter, then the correct type of parameter must be given as @parameter. If the action is expecting no @@ -743,21 +897,21 @@ g_action_group_get_action_parameter_type(). - a #GActionGroup + a #GActionGroup - the name of the action to activate + the name of the action to activate - parameters to the activation + parameters to the activation - Request for the state of the named action within @action_group to be + Request for the state of the named action within @action_group to be changed to @value. The action must be stateful and @value must be of the correct type. @@ -774,42 +928,42 @@ If the @value GVariant is floating, it is consumed. - a #GActionGroup + a #GActionGroup - the name of the action to request the change on + the name of the action to request the change on - the new state + the new state - Checks if the named action within @action_group is currently enabled. + Checks if the named action within @action_group is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - whether or not the action is currently enabled + whether or not the action is currently enabled - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Queries the type of the parameter that must be given when activating + Queries the type of the parameter that must be given when activating the named action within @action_group. When activating the action using g_action_group_activate_action(), @@ -824,22 +978,22 @@ possible for an action to be removed and for a new action to be added with the same name but a different parameter type. - the parameter type + the parameter type - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Queries the current state of the named action within @action_group. + Queries the current state of the named action within @action_group. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -849,22 +1003,22 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the current state of the action + the current state of the action - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Requests a hint about the valid range of values for the state of the + Requests a hint about the valid range of values for the state of the named action within @action_group. If %NULL is returned it either means that the action is not stateful @@ -884,22 +1038,22 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the state range hint + the state range hint - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Queries the type of the state of the named action within + Queries the type of the state of the named action within @action_group. If the action is stateful then this function returns the @@ -917,46 +1071,46 @@ possible for an action to be removed and for a new action to be added with the same name but a different state type. - the state type, if the action is stateful + the state type, if the action is stateful - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Checks if the named action exists within @action_group. + Checks if the named action exists within @action_group. - whether the named action exists + whether the named action exists - a #GActionGroup + a #GActionGroup - the name of the action to check for + the name of the action to check for - Lists the actions contained within @action_group. + Lists the actions contained within @action_group. The caller is responsible for freeing the list with g_strfreev() when it is no longer required. - a %NULL-terminated array of the names of the + a %NULL-terminated array of the names of the actions in the group @@ -964,13 +1118,13 @@ actions in the group - a #GActionGroup + a #GActionGroup - Queries all aspects of the named action within an @action_group. + Queries all aspects of the named action within an @action_group. This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), @@ -999,42 +1153,42 @@ filled. If the action doesn't exist, %FALSE is returned and the fields may or may not have been modified. - %TRUE if the action exists, else %FALSE + %TRUE if the action exists, else %FALSE - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - if the action is presently enabled + if the action is presently enabled - the parameter type, or %NULL if none needed + the parameter type, or %NULL if none needed - the state type, or %NULL if stateless + the state type, or %NULL if stateless - the state hint, or %NULL if none + the state hint, or %NULL if none - the current state, or %NULL if stateless + the current state, or %NULL if stateless - Emits the #GActionGroup::action-added signal on @action_group. + Emits the #GActionGroup::action-added signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1043,17 +1197,17 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - Emits the #GActionGroup::action-enabled-changed signal on @action_group. + Emits the #GActionGroup::action-enabled-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1062,21 +1216,21 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - whether or not the action is now enabled + whether or not the action is now enabled - Emits the #GActionGroup::action-removed signal on @action_group. + Emits the #GActionGroup::action-removed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1085,17 +1239,17 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - Emits the #GActionGroup::action-state-changed signal on @action_group. + Emits the #GActionGroup::action-state-changed signal on @action_group. This function should only be called by #GActionGroup implementations. @@ -1104,21 +1258,21 @@ This function should only be called by #GActionGroup implementations. - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - the new state of the named action + the new state of the named action - Activate the named action within @action_group. + Activate the named action within @action_group. If the action is expecting a parameter, then the correct type of parameter must be given as @parameter. If the action is expecting no @@ -1130,21 +1284,21 @@ g_action_group_get_action_parameter_type(). - a #GActionGroup + a #GActionGroup - the name of the action to activate + the name of the action to activate - parameters to the activation + parameters to the activation - Request for the state of the named action within @action_group to be + Request for the state of the named action within @action_group to be changed to @value. The action must be stateful and @value must be of the correct type. @@ -1161,42 +1315,42 @@ If the @value GVariant is floating, it is consumed. - a #GActionGroup + a #GActionGroup - the name of the action to request the change on + the name of the action to request the change on - the new state + the new state - Checks if the named action within @action_group is currently enabled. + Checks if the named action within @action_group is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - whether or not the action is currently enabled + whether or not the action is currently enabled - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Queries the type of the parameter that must be given when activating + Queries the type of the parameter that must be given when activating the named action within @action_group. When activating the action using g_action_group_activate_action(), @@ -1211,22 +1365,22 @@ possible for an action to be removed and for a new action to be added with the same name but a different parameter type. - the parameter type + the parameter type - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Queries the current state of the named action within @action_group. + Queries the current state of the named action within @action_group. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -1236,22 +1390,22 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the current state of the action + the current state of the action - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Requests a hint about the valid range of values for the state of the + Requests a hint about the valid range of values for the state of the named action within @action_group. If %NULL is returned it either means that the action is not stateful @@ -1271,22 +1425,22 @@ The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - the state range hint + the state range hint - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Queries the type of the state of the named action within + Queries the type of the state of the named action within @action_group. If the action is stateful then this function returns the @@ -1304,46 +1458,46 @@ possible for an action to be removed and for a new action to be added with the same name but a different state type. - the state type, if the action is stateful + the state type, if the action is stateful - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query - Checks if the named action exists within @action_group. + Checks if the named action exists within @action_group. - whether the named action exists + whether the named action exists - a #GActionGroup + a #GActionGroup - the name of the action to check for + the name of the action to check for - Lists the actions contained within @action_group. + Lists the actions contained within @action_group. The caller is responsible for freeing the list with g_strfreev() when it is no longer required. - a %NULL-terminated array of the names of the + a %NULL-terminated array of the names of the actions in the group @@ -1351,13 +1505,13 @@ actions in the group - a #GActionGroup + a #GActionGroup - Queries all aspects of the named action within an @action_group. + Queries all aspects of the named action within an @action_group. This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), @@ -1386,36 +1540,36 @@ filled. If the action doesn't exist, %FALSE is returned and the fields may or may not have been modified. - %TRUE if the action exists, else %FALSE + %TRUE if the action exists, else %FALSE - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - if the action is presently enabled + if the action is presently enabled - the parameter type, or %NULL if none needed + the parameter type, or %NULL if none needed - the state type, or %NULL if stateless + the state type, or %NULL if stateless - the state hint, or %NULL if none + the state hint, or %NULL if none - the current state, or %NULL if stateless + the current state, or %NULL if stateless @@ -1491,16 +1645,16 @@ is still visible and can be queried from the signal handler. - whether the named action exists + whether the named action exists - a #GActionGroup + a #GActionGroup - the name of the action to check for + the name of the action to check for @@ -1510,7 +1664,7 @@ is still visible and can be queried from the signal handler. - a %NULL-terminated array of the names of the + a %NULL-terminated array of the names of the actions in the group @@ -1518,7 +1672,7 @@ actions in the group - a #GActionGroup + a #GActionGroup @@ -1528,16 +1682,16 @@ actions in the group - whether or not the action is currently enabled + whether or not the action is currently enabled - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query @@ -1547,16 +1701,16 @@ actions in the group - the parameter type + the parameter type - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query @@ -1566,16 +1720,16 @@ actions in the group - the state type, if the action is stateful + the state type, if the action is stateful - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query @@ -1585,16 +1739,16 @@ actions in the group - the state range hint + the state range hint - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query @@ -1604,16 +1758,16 @@ actions in the group - the current state of the action + the current state of the action - a #GActionGroup + a #GActionGroup - the name of the action to query + the name of the action to query @@ -1627,15 +1781,15 @@ actions in the group - a #GActionGroup + a #GActionGroup - the name of the action to request the change on + the name of the action to request the change on - the new state + the new state @@ -1649,15 +1803,15 @@ actions in the group - a #GActionGroup + a #GActionGroup - the name of the action to activate + the name of the action to activate - parameters to the activation + parameters to the activation @@ -1671,11 +1825,11 @@ actions in the group - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group @@ -1689,11 +1843,11 @@ actions in the group - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group @@ -1707,15 +1861,15 @@ actions in the group - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - whether or not the action is now enabled + whether or not the action is now enabled @@ -1729,15 +1883,15 @@ actions in the group - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - the new state of the named action + the new state of the named action @@ -1747,36 +1901,36 @@ actions in the group - %TRUE if the action exists, else %FALSE + %TRUE if the action exists, else %FALSE - a #GActionGroup + a #GActionGroup - the name of an action in the group + the name of an action in the group - if the action is presently enabled + if the action is presently enabled - the parameter type, or %NULL if none needed + the parameter type, or %NULL if none needed - the state type, or %NULL if stateless + the state type, or %NULL if stateless - the state hint, or %NULL if none + the state hint, or %NULL if none - the current state, or %NULL if stateless + the current state, or %NULL if stateless @@ -1793,12 +1947,12 @@ actions in the group - the name of the action + the name of the action - a #GAction + a #GAction @@ -1808,12 +1962,12 @@ actions in the group - the parameter type + the parameter type - a #GAction + a #GAction @@ -1823,12 +1977,12 @@ actions in the group - the state type, if the action is stateful + the state type, if the action is stateful - a #GAction + a #GAction @@ -1838,12 +1992,12 @@ actions in the group - the state range hint + the state range hint - a #GAction + a #GAction @@ -1853,12 +2007,12 @@ actions in the group - whether the action is enabled + whether the action is enabled - a #GAction + a #GAction @@ -1868,12 +2022,12 @@ actions in the group - the current state of the action + the current state of the action - a #GAction + a #GAction @@ -1887,11 +2041,11 @@ actions in the group - a #GAction + a #GAction - the new state + the new state @@ -1905,11 +2059,11 @@ actions in the group - a #GAction + a #GAction - the parameter to the activation + the parameter to the activation @@ -1917,7 +2071,7 @@ actions in the group - The GActionMap interface is implemented by #GActionGroup + The GActionMap interface is implemented by #GActionGroup implementations that operate by containing a number of named #GAction instances, such as #GSimpleActionGroup. @@ -1928,7 +2082,7 @@ This is the motivation for the 'Map' part of the interface name. - Adds an action to the @action_map. + Adds an action to the @action_map. If the action map already contains an action with the same name as @action then the old action is dropped from the action map. @@ -1940,37 +2094,37 @@ The action map takes its own reference on @action. - a #GActionMap + a #GActionMap - a #GAction + a #GAction - Looks up the action with the name @action_name in @action_map. + Looks up the action with the name @action_name in @action_map. If no such action exists, returns %NULL. - a #GAction, or %NULL + a #GAction, or %NULL - a #GActionMap + a #GActionMap - the name of an action + the name of an action - Removes the named action from the action map. + Removes the named action from the action map. If no action of this name is in the map then nothing happens. @@ -1979,17 +2133,17 @@ If no action of this name is in the map then nothing happens. - a #GActionMap + a #GActionMap - the name of the action + the name of the action - Adds an action to the @action_map. + Adds an action to the @action_map. If the action map already contains an action with the same name as @action then the old action is dropped from the action map. @@ -2001,17 +2155,17 @@ The action map takes its own reference on @action. - a #GActionMap + a #GActionMap - a #GAction + a #GAction - A convenience function for creating multiple #GSimpleAction instances + A convenience function for creating multiple #GSimpleAction instances and adding them to a #GActionMap. Each action is constructed as per one #GActionEntry. @@ -2054,48 +2208,48 @@ create_action_group (void) - a #GActionMap + a #GActionMap - a pointer to + a pointer to the first item in an array of #GActionEntry structs - the length of @entries, or -1 if @entries is %NULL-terminated + the length of @entries, or -1 if @entries is %NULL-terminated - the user data for signal connections + the user data for signal connections - Looks up the action with the name @action_name in @action_map. + Looks up the action with the name @action_name in @action_map. If no such action exists, returns %NULL. - a #GAction, or %NULL + a #GAction, or %NULL - a #GActionMap + a #GActionMap - the name of an action + the name of an action - Removes the named action from the action map. + Removes the named action from the action map. If no action of this name is in the map then nothing happens. @@ -2104,11 +2258,11 @@ If no action of this name is in the map then nothing happens. - a #GActionMap + a #GActionMap - the name of the action + the name of the action @@ -2124,16 +2278,16 @@ If no action of this name is in the map then nothing happens. - a #GAction, or %NULL + a #GAction, or %NULL - a #GActionMap + a #GActionMap - the name of an action + the name of an action @@ -2147,11 +2301,11 @@ If no action of this name is in the map then nothing happens. - a #GActionMap + a #GActionMap - a #GAction + a #GAction @@ -2165,11 +2319,11 @@ If no action of this name is in the map then nothing happens. - a #GActionMap + a #GActionMap - the name of the action + the name of the action @@ -2177,7 +2331,7 @@ If no action of this name is in the map then nothing happens. - #GAppInfo and #GAppLaunchContext are used for describing and launching + #GAppInfo and #GAppLaunchContext are used for describing and launching applications installed on the system. As of GLib 2.20, URIs will always be converted to POSIX paths @@ -2227,7 +2381,7 @@ Different launcher applications (e.g. file managers) may have different ideas of what a given URI means. - Creates a new #GAppInfo from the given information. + Creates a new #GAppInfo from the given information. Note that for @commandline, the quoting rules of the Exec key of the [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) @@ -2236,26 +2390,26 @@ percent-encoded URIs, the percent-character must be doubled in order to prevent being swallowed by Exec key unquoting. See the specification for exact quoting rules. - new #GAppInfo for given command. + new #GAppInfo for given command. - the commandline to use + the commandline to use - the application name, or %NULL to use @commandline + the application name, or %NULL to use @commandline - flags that can specify details of the created #GAppInfo + flags that can specify details of the created #GAppInfo - Gets a list of all of the applications currently registered + Gets a list of all of the applications currently registered on this system. For desktop files, this includes applications that have @@ -2265,20 +2419,20 @@ The returned list does not include applications which have the `Hidden` key set. - a newly allocated #GList of references to #GAppInfos. + a newly allocated #GList of references to #GAppInfos. - Gets a list of all #GAppInfos for a given content type, + Gets a list of all #GAppInfos for a given content type, including the recommended and fallback #GAppInfos. See g_app_info_get_recommended_for_type() and g_app_info_get_fallback_for_type(). - #GList of #GAppInfos + #GList of #GAppInfos for given @content_type or %NULL on error. @@ -2286,55 +2440,55 @@ g_app_info_get_fallback_for_type(). - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - Gets the default #GAppInfo for a given content type. + Gets the default #GAppInfo for a given content type. - #GAppInfo for given @content_type or + #GAppInfo for given @content_type or %NULL on error. - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - if %TRUE, the #GAppInfo is expected to + if %TRUE, the #GAppInfo is expected to support URIs - Gets the default application for handling URIs with + Gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". - #GAppInfo for given @uri_scheme or %NULL on error. + #GAppInfo for given @uri_scheme or %NULL on error. - a string containing a URI scheme. + a string containing a URI scheme. - Gets a list of fallback #GAppInfos for a given content type, i.e. + Gets a list of fallback #GAppInfos for a given content type, i.e. those applications which claim to support the given content type by MIME type subclassing and not directly. - #GList of #GAppInfos + #GList of #GAppInfos for given @content_type or %NULL on error. @@ -2342,13 +2496,13 @@ by MIME type subclassing and not directly. - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - Gets a list of recommended #GAppInfos for a given content type, i.e. + Gets a list of recommended #GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. @@ -2356,7 +2510,7 @@ the last one for which g_app_info_set_as_last_used_for_type() has been called. - #GList of #GAppInfos + #GList of #GAppInfos for given @content_type or %NULL on error. @@ -2364,38 +2518,38 @@ called. - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - Utility function that launches the default application + Utility function that launches the default application registered to handle the specified uri. Synchronous I/O is done on the uri to detect the type of the file if required. The D-Bus–activated applications don't have to be started if your application terminates too soon after this function. To prevent this, use -g_app_info_launch_default_for_uri() instead. +g_app_info_launch_default_for_uri_async() instead. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - the uri to show + the uri to show - an optional #GAppLaunchContext + an optional #GAppLaunchContext - Async version of g_app_info_launch_default_for_uri(). + 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 @@ -2411,43 +2565,43 @@ in receiving error information from their activation. - the uri to show + the uri to show - an optional #GAppLaunchContext + an optional #GAppLaunchContext - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback to call when the request is done + a #GAsyncReadyCallback to call when the request is done - data to pass to @callback + data to pass to @callback - Finishes an asynchronous launch-default-for-uri operation. + Finishes an asynchronous launch-default-for-uri operation. - %TRUE if the launch was successful, %FALSE if @error is set + %TRUE if the launch was successful, %FALSE if @error is set - a #GAsyncResult + a #GAsyncResult - Removes all changes to the type associations done by + Removes all changes to the type associations done by g_app_info_set_as_default_for_type(), g_app_info_set_as_default_for_extension(), g_app_info_add_supports_type() or @@ -2458,110 +2612,110 @@ g_app_info_remove_supports_type(). - a content type + a content type - Adds a content type to the application information to indicate the + Adds a content type to the application information to indicate the application is capable of opening files with the given content type. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string. + a string. - Obtains the information whether the #GAppInfo can be deleted. + Obtains the information whether the #GAppInfo can be deleted. See g_app_info_delete(). - %TRUE if @appinfo can be deleted + %TRUE if @appinfo can be deleted - a #GAppInfo + a #GAppInfo - Checks if a supported content type can be removed from an application. + Checks if a supported content type can be removed from an application. - %TRUE if it is possible to remove supported + %TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. - a #GAppInfo. + a #GAppInfo. - Tries to delete a #GAppInfo. + Tries to delete a #GAppInfo. On some platforms, there may be a difference between user-defined #GAppInfos which can be deleted, and system-wide ones which cannot. See g_app_info_can_delete(). - %TRUE if @appinfo has been deleted + %TRUE if @appinfo has been deleted - a #GAppInfo + a #GAppInfo - Creates a duplicate of a #GAppInfo. + Creates a duplicate of a #GAppInfo. - a duplicate of @appinfo. + a duplicate of @appinfo. - a #GAppInfo. + a #GAppInfo. - Checks if two #GAppInfos are equal. + Checks if two #GAppInfos are equal. Note that the check <emphasis>may not</emphasis> compare each individual field, and only does an identity check. In case detecting changes in the contents is needed, program code must additionally compare relevant fields. - %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. - the first #GAppInfo. + the first #GAppInfo. - the second #GAppInfo. + the second #GAppInfo. @@ -2578,32 +2732,32 @@ contents is needed, program code must additionally compare relevant fields. - Gets a human-readable description of an installed application. + Gets a human-readable description of an installed application. - a string containing a description of the + a string containing a description of the application @appinfo, or %NULL if none. - a #GAppInfo. + a #GAppInfo. - Gets the display name of the application. The display name is often more + Gets the display name of the application. The display name is often more descriptive to the user than the name itself. - the display name of the application for @appinfo, or the name if + the display name of the application for @appinfo, or the name if no display name is available. - a #GAppInfo. + a #GAppInfo. @@ -2620,22 +2774,22 @@ no display name is available. - Gets the icon for the application. + Gets the icon for the application. - the default #GIcon for @appinfo or %NULL + the default #GIcon for @appinfo or %NULL if there is no default icon. - a #GAppInfo. + a #GAppInfo. - Gets the ID of an application. An id is a string that + Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification. @@ -2644,32 +2798,32 @@ Note that the returned ID may be %NULL, depending on how the @appinfo has been constructed. - a string containing the application's ID. + a string containing the application's ID. - a #GAppInfo. + a #GAppInfo. - Gets the installed name of the application. + Gets the installed name of the application. - the name of the application for @appinfo. + the name of the application for @appinfo. - a #GAppInfo. + a #GAppInfo. - Retrieves the list of content types that @app_info claims to support. + Retrieves the list of content types that @app_info claims to support. If this information is not provided by the environment, this function will return %NULL. This function does not take in consideration associations added with @@ -2677,7 +2831,7 @@ g_app_info_add_supports_type(), but only those exported directly by the application. - + a list of content types. @@ -2685,13 +2839,13 @@ the application. - a #GAppInfo that can handle files + a #GAppInfo that can handle files - Launches the application. Passes @files to the launched application + Launches the application. Passes @files to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -2720,28 +2874,28 @@ should it be inherited by further processes. The `DISPLAY` and on information provided in @context. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GList of #GFile objects + a #GList of #GFile objects - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL - Launches the application. This passes the @uris to the launched application + Launches the application. This passes the @uris to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -2753,28 +2907,28 @@ can fail to start if it runs into problems during startup. There is no way to detect this. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GList containing URIs to launch. + a #GList containing URIs to launch. - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL - Async version of g_app_info_launch_uris(). + Async version of g_app_info_launch_uris(). The @callback is invoked immediately after the application launch, but it waits for activation in case of D-Bus–activated applications and also provides @@ -2786,352 +2940,352 @@ g_app_info_launch_default_for_uri_async(). - a #GAppInfo + a #GAppInfo - a #GList containing URIs to launch. + a #GList containing URIs to launch. - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback to call when the request is done + a #GAsyncReadyCallback to call when the request is done - data to pass to @callback + data to pass to @callback - Finishes a g_app_info_launch_uris_async() operation. + Finishes a g_app_info_launch_uris_async() operation. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GAsyncResult + a #GAsyncResult - Removes a supported type from an application, if possible. + Removes a supported type from an application, if possible. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string. + a string. - Sets the application as the default handler for the given file extension. + Sets the application as the default handler for the given file extension. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string containing the file extension + a string containing the file extension (without the dot). - Sets the application as the default handler for a given type. + Sets the application as the default handler for a given type. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - the content type. + the content type. - Sets the application as the last used application for a given type. + Sets the application as the last used application for a given type. This will make the application appear as first in the list returned by g_app_info_get_recommended_for_type(), regardless of the default application for that content type. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - the content type. + the content type. - Checks if the application info should be shown in menus that + Checks if the application info should be shown in menus that list available applications. - %TRUE if the @appinfo should be shown, %FALSE otherwise. + %TRUE if the @appinfo should be shown, %FALSE otherwise. - a #GAppInfo. + a #GAppInfo. - Checks if the application accepts files as arguments. + Checks if the application accepts files as arguments. - %TRUE if the @appinfo supports files. + %TRUE if the @appinfo supports files. - a #GAppInfo. + a #GAppInfo. - Checks if the application supports reading files and directories from URIs. + Checks if the application supports reading files and directories from URIs. - %TRUE if the @appinfo supports URIs. + %TRUE if the @appinfo supports URIs. - a #GAppInfo. + a #GAppInfo. - Adds a content type to the application information to indicate the + Adds a content type to the application information to indicate the application is capable of opening files with the given content type. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string. + a string. - Obtains the information whether the #GAppInfo can be deleted. + Obtains the information whether the #GAppInfo can be deleted. See g_app_info_delete(). - %TRUE if @appinfo can be deleted + %TRUE if @appinfo can be deleted - a #GAppInfo + a #GAppInfo - Checks if a supported content type can be removed from an application. + Checks if a supported content type can be removed from an application. - %TRUE if it is possible to remove supported + %TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. - a #GAppInfo. + a #GAppInfo. - Tries to delete a #GAppInfo. + Tries to delete a #GAppInfo. On some platforms, there may be a difference between user-defined #GAppInfos which can be deleted, and system-wide ones which cannot. See g_app_info_can_delete(). - %TRUE if @appinfo has been deleted + %TRUE if @appinfo has been deleted - a #GAppInfo + a #GAppInfo - Creates a duplicate of a #GAppInfo. + Creates a duplicate of a #GAppInfo. - a duplicate of @appinfo. + a duplicate of @appinfo. - a #GAppInfo. + a #GAppInfo. - Checks if two #GAppInfos are equal. + Checks if two #GAppInfos are equal. Note that the check <emphasis>may not</emphasis> compare each individual field, and only does an identity check. In case detecting changes in the contents is needed, program code must additionally compare relevant fields. - %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. - the first #GAppInfo. + the first #GAppInfo. - the second #GAppInfo. + the second #GAppInfo. - Gets the commandline with which the application will be + Gets the commandline with which the application will be started. - a string containing the @appinfo's commandline, + a string containing the @appinfo's commandline, or %NULL if this information is not available - a #GAppInfo + a #GAppInfo - Gets a human-readable description of an installed application. + Gets a human-readable description of an installed application. - a string containing a description of the + a string containing a description of the application @appinfo, or %NULL if none. - a #GAppInfo. + a #GAppInfo. - Gets the display name of the application. The display name is often more + Gets the display name of the application. The display name is often more descriptive to the user than the name itself. - the display name of the application for @appinfo, or the name if + the display name of the application for @appinfo, or the name if no display name is available. - a #GAppInfo. + a #GAppInfo. - Gets the executable's name for the installed application. + Gets the executable's name for the installed application. - a string containing the @appinfo's application + a string containing the @appinfo's application binaries name - a #GAppInfo + a #GAppInfo - Gets the icon for the application. + Gets the icon for the application. - the default #GIcon for @appinfo or %NULL + the default #GIcon for @appinfo or %NULL if there is no default icon. - a #GAppInfo. + a #GAppInfo. - Gets the ID of an application. An id is a string that + Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification. @@ -3140,32 +3294,32 @@ Note that the returned ID may be %NULL, depending on how the @appinfo has been constructed. - a string containing the application's ID. + a string containing the application's ID. - a #GAppInfo. + a #GAppInfo. - Gets the installed name of the application. + Gets the installed name of the application. - the name of the application for @appinfo. + the name of the application for @appinfo. - a #GAppInfo. + a #GAppInfo. - Retrieves the list of content types that @app_info claims to support. + Retrieves the list of content types that @app_info claims to support. If this information is not provided by the environment, this function will return %NULL. This function does not take in consideration associations added with @@ -3173,7 +3327,7 @@ g_app_info_add_supports_type(), but only those exported directly by the application. - + a list of content types. @@ -3181,13 +3335,13 @@ the application. - a #GAppInfo that can handle files + a #GAppInfo that can handle files - Launches the application. Passes @files to the launched application + Launches the application. Passes @files to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -3216,28 +3370,28 @@ should it be inherited by further processes. The `DISPLAY` and on information provided in @context. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GList of #GFile objects + a #GList of #GFile objects - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL - Launches the application. This passes the @uris to the launched application + Launches the application. This passes the @uris to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -3249,28 +3403,28 @@ can fail to start if it runs into problems during startup. There is no way to detect this. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GList containing URIs to launch. + a #GList containing URIs to launch. - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL - Async version of g_app_info_launch_uris(). + Async version of g_app_info_launch_uris(). The @callback is invoked immediately after the application launch, but it waits for activation in case of D-Bus–activated applications and also provides @@ -3282,166 +3436,166 @@ g_app_info_launch_default_for_uri_async(). - a #GAppInfo + a #GAppInfo - a #GList containing URIs to launch. + a #GList containing URIs to launch. - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback to call when the request is done + a #GAsyncReadyCallback to call when the request is done - data to pass to @callback + data to pass to @callback - Finishes a g_app_info_launch_uris_async() operation. + Finishes a g_app_info_launch_uris_async() operation. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GAsyncResult + a #GAsyncResult - Removes a supported type from an application, if possible. + Removes a supported type from an application, if possible. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string. + a string. - Sets the application as the default handler for the given file extension. + Sets the application as the default handler for the given file extension. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string containing the file extension + a string containing the file extension (without the dot). - Sets the application as the default handler for a given type. + Sets the application as the default handler for a given type. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - the content type. + the content type. - Sets the application as the last used application for a given type. + Sets the application as the last used application for a given type. This will make the application appear as first in the list returned by g_app_info_get_recommended_for_type(), regardless of the default application for that content type. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - the content type. + the content type. - Checks if the application info should be shown in menus that + Checks if the application info should be shown in menus that list available applications. - %TRUE if the @appinfo should be shown, %FALSE otherwise. + %TRUE if the @appinfo should be shown, %FALSE otherwise. - a #GAppInfo. + a #GAppInfo. - Checks if the application accepts files as arguments. + Checks if the application accepts files as arguments. - %TRUE if the @appinfo supports files. + %TRUE if the @appinfo supports files. - a #GAppInfo. + a #GAppInfo. - Checks if the application supports reading files and directories from URIs. + Checks if the application supports reading files and directories from URIs. - %TRUE if the @appinfo supports URIs. + %TRUE if the @appinfo supports URIs. - a #GAppInfo. + a #GAppInfo. @@ -3473,12 +3627,12 @@ list available applications. - a duplicate of @appinfo. + a duplicate of @appinfo. - a #GAppInfo. + a #GAppInfo. @@ -3488,16 +3642,16 @@ list available applications. - %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. - the first #GAppInfo. + the first #GAppInfo. - the second #GAppInfo. + the second #GAppInfo. @@ -3507,12 +3661,12 @@ list available applications. - a string containing the application's ID. + a string containing the application's ID. - a #GAppInfo. + a #GAppInfo. @@ -3522,12 +3676,12 @@ list available applications. - the name of the application for @appinfo. + the name of the application for @appinfo. - a #GAppInfo. + a #GAppInfo. @@ -3537,13 +3691,13 @@ list available applications. - a string containing a description of the + a string containing a description of the application @appinfo, or %NULL if none. - a #GAppInfo. + a #GAppInfo. @@ -3566,13 +3720,13 @@ application @appinfo, or %NULL if none. - the default #GIcon for @appinfo or %NULL + the default #GIcon for @appinfo or %NULL if there is no default icon. - a #GAppInfo. + a #GAppInfo. @@ -3582,22 +3736,22 @@ if there is no default icon. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GList of #GFile objects + a #GList of #GFile objects - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL @@ -3607,12 +3761,12 @@ if there is no default icon. - %TRUE if the @appinfo supports URIs. + %TRUE if the @appinfo supports URIs. - a #GAppInfo. + a #GAppInfo. @@ -3622,12 +3776,12 @@ if there is no default icon. - %TRUE if the @appinfo supports files. + %TRUE if the @appinfo supports files. - a #GAppInfo. + a #GAppInfo. @@ -3637,22 +3791,22 @@ if there is no default icon. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GList containing URIs to launch. + a #GList containing URIs to launch. - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL @@ -3662,12 +3816,12 @@ if there is no default icon. - %TRUE if the @appinfo should be shown, %FALSE otherwise. + %TRUE if the @appinfo should be shown, %FALSE otherwise. - a #GAppInfo. + a #GAppInfo. @@ -3677,16 +3831,16 @@ if there is no default icon. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - the content type. + the content type. @@ -3696,16 +3850,16 @@ if there is no default icon. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string containing the file extension + a string containing the file extension (without the dot). @@ -3716,16 +3870,16 @@ if there is no default icon. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string. + a string. @@ -3735,13 +3889,13 @@ if there is no default icon. - %TRUE if it is possible to remove supported + %TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. - a #GAppInfo. + a #GAppInfo. @@ -3751,16 +3905,16 @@ if there is no default icon. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - a string. + a string. @@ -3770,12 +3924,12 @@ if there is no default icon. - %TRUE if @appinfo can be deleted + %TRUE if @appinfo can be deleted - a #GAppInfo + a #GAppInfo @@ -3785,12 +3939,12 @@ if there is no default icon. - %TRUE if @appinfo has been deleted + %TRUE if @appinfo has been deleted - a #GAppInfo + a #GAppInfo @@ -3813,13 +3967,13 @@ if there is no default icon. - the display name of the application for @appinfo, or the name if + the display name of the application for @appinfo, or the name if no display name is available. - a #GAppInfo. + a #GAppInfo. @@ -3829,16 +3983,16 @@ no display name is available. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GAppInfo. + a #GAppInfo. - the content type. + the content type. @@ -3848,7 +4002,7 @@ no display name is available. - + a list of content types. @@ -3856,7 +4010,7 @@ no display name is available. - a #GAppInfo that can handle files + a #GAppInfo that can handle files @@ -3870,29 +4024,29 @@ no display name is available. - a #GAppInfo + a #GAppInfo - a #GList containing URIs to launch. + a #GList containing URIs to launch. - a #GAppLaunchContext or %NULL + a #GAppLaunchContext or %NULL - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback to call when the request is done + a #GAsyncReadyCallback to call when the request is done - data to pass to @callback + data to pass to @callback @@ -3902,16 +4056,16 @@ no display name is available. - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GAppInfo + a #GAppInfo - a #GAsyncResult + a #GAsyncResult @@ -3919,7 +4073,7 @@ no display name is available. - #GAppInfoMonitor is a very simple object used for monitoring the app + #GAppInfoMonitor is a very simple object used for monitoring the app info database for changes (ie: newly installed or removed applications). @@ -3937,7 +4091,7 @@ The reason for this is that changes to the list of installed applications often come in groups (like during system updates) and rescanning the list on every change is pointless and expensive. - Gets the #GAppInfoMonitor for the current thread-default main + Gets the #GAppInfoMonitor for the current thread-default main context. The #GAppInfoMonitor will emit a "changed" signal in the @@ -3948,7 +4102,7 @@ You must only call g_object_unref() on the return value from under the same main context as you created it. - a reference to a #GAppInfoMonitor + a reference to a #GAppInfoMonitor @@ -3966,34 +4120,34 @@ handle for instance startup notification and launching the new application on the same screen as the launching window. - Creates a new application launch context. This is not normally used, + Creates a new application launch context. This is not normally used, instead you instantiate a subclass of this, such as #GdkAppLaunchContext. - a #GAppLaunchContext. + a #GAppLaunchContext. - Gets the display string for the @context. This is used to ensure new + Gets the display string for the @context. This is used to ensure new applications are started on the same display as the launching application, by setting the `DISPLAY` environment variable. - a display string for the display. + a display string for the display. - a #GAppLaunchContext + a #GAppLaunchContext - a #GAppInfo + a #GAppInfo - a #GList of #GFile objects + a #GList of #GFile objects @@ -4001,28 +4155,28 @@ application, by setting the `DISPLAY` environment variable. - Initiates startup notification for the application and returns the + Initiates startup notification for the application and returns the `DESKTOP_STARTUP_ID` for the launched operation, if supported. Startup notification IDs are defined in the [FreeDesktop.Org Startup Notifications standard](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt"). - a startup notification ID for the application, or %NULL if + a startup notification ID for the application, or %NULL if not supported. - a #GAppLaunchContext + a #GAppLaunchContext - a #GAppInfo + a #GAppInfo - a #GList of of #GFile objects + a #GList of of #GFile objects @@ -4030,7 +4184,7 @@ Startup notification IDs are defined in the - Called when an application has failed to launch, so that it can cancel + Called when an application has failed to launch, so that it can cancel the application startup notification started in g_app_launch_context_get_startup_notify_id(). @@ -4038,11 +4192,11 @@ the application startup notification started in g_app_launch_context_get_startup - a #GAppLaunchContext. + a #GAppLaunchContext. - the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). @@ -4065,25 +4219,25 @@ the application startup notification started in g_app_launch_context_get_startup - Gets the display string for the @context. This is used to ensure new + Gets the display string for the @context. This is used to ensure new applications are started on the same display as the launching application, by setting the `DISPLAY` environment variable. - a display string for the display. + a display string for the display. - a #GAppLaunchContext + a #GAppLaunchContext - a #GAppInfo + a #GAppInfo - a #GList of #GFile objects + a #GList of #GFile objects @@ -4091,13 +4245,13 @@ application, by setting the `DISPLAY` environment variable. - Gets the complete environment variable list to be passed to + Gets the complete environment variable list to be passed to the child process when @context is used to launch an application. This is a %NULL-terminated array of strings, where each string has the form `KEY=VALUE`. - + the child's environment @@ -4105,34 +4259,34 @@ the form `KEY=VALUE`. - a #GAppLaunchContext + a #GAppLaunchContext - Initiates startup notification for the application and returns the + Initiates startup notification for the application and returns the `DESKTOP_STARTUP_ID` for the launched operation, if supported. Startup notification IDs are defined in the [FreeDesktop.Org Startup Notifications standard](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt"). - a startup notification ID for the application, or %NULL if + a startup notification ID for the application, or %NULL if not supported. - a #GAppLaunchContext + a #GAppLaunchContext - a #GAppInfo + a #GAppInfo - a #GList of of #GFile objects + a #GList of of #GFile objects @@ -4140,7 +4294,7 @@ Startup notification IDs are defined in the - Called when an application has failed to launch, so that it can cancel + Called when an application has failed to launch, so that it can cancel the application startup notification started in g_app_launch_context_get_startup_notify_id(). @@ -4148,17 +4302,17 @@ the application startup notification started in g_app_launch_context_get_startup - a #GAppLaunchContext. + a #GAppLaunchContext. - the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). - Arranges for @variable to be set to @value in the child's + Arranges for @variable to be set to @value in the child's environment when @context is used to launch an application. @@ -4166,21 +4320,21 @@ environment when @context is used to launch an application. - a #GAppLaunchContext + a #GAppLaunchContext - the environment variable to set + the environment variable to set - the value for to set the variable to. + the value for to set the variable to. - Arranges for @variable to be unset in the child's environment + Arranges for @variable to be unset in the child's environment when @context is used to launch an application. @@ -4188,11 +4342,11 @@ when @context is used to launch an application. - a #GAppLaunchContext + a #GAppLaunchContext - the environment variable to remove + the environment variable to remove @@ -4247,20 +4401,20 @@ platform-specific data about this launch. On UNIX, at least the - a display string for the display. + a display string for the display. - a #GAppLaunchContext + a #GAppLaunchContext - a #GAppInfo + a #GAppInfo - a #GList of #GFile objects + a #GList of #GFile objects @@ -4272,21 +4426,21 @@ platform-specific data about this launch. On UNIX, at least the - a startup notification ID for the application, or %NULL if + a startup notification ID for the application, or %NULL if not supported. - a #GAppLaunchContext + a #GAppLaunchContext - a #GAppInfo + a #GAppInfo - a #GList of of #GFile objects + a #GList of of #GFile objects @@ -4302,11 +4456,11 @@ platform-specific data about this launch. On UNIX, at least the - a #GAppLaunchContext. + a #GAppLaunchContext. - the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). @@ -4368,7 +4522,7 @@ platform-specific data about this launch. On UNIX, at least the - A #GApplication is the foundation of an application. It wraps some + A #GApplication is the foundation of an application. It wraps some low-level platform-specific services and is intended to act as the foundation for higher-level application classes such as #GtkApplication or #MxApplication. In general, you should not use @@ -4486,7 +4640,7 @@ For an example of using extra D-Bus hooks with GApplication, see - Creates a new #GApplication instance. + Creates a new #GApplication instance. If non-%NULL, the application id must be valid. See g_application_id_is_valid(). @@ -4495,22 +4649,22 @@ If no application ID is given then some features of #GApplication (most notably application uniqueness) will be disabled. - a new #GApplication instance + a new #GApplication instance - the application id + the application id - the application flags + the application flags - Returns the default #GApplication instance for this process. + Returns the default #GApplication instance for this process. Normally there is only one #GApplication per process and it becomes the default when it is created. You can exercise more control over @@ -4519,12 +4673,12 @@ this by using g_application_set_default(). If there is no default application then %NULL is returned. - the default application for this process, or %NULL + the default application for this process, or %NULL - Checks if @application_id is a valid application identifier. + Checks if @application_id is a valid application identifier. A valid ID is required for calls to g_application_new() and g_application_set_application_id(). @@ -4571,18 +4725,18 @@ For example, if the owner of 7-zip.org used an application identifier for an archiving application, it might be named `org._7_zip.Archiver`. - %TRUE if @application_id is valid + %TRUE if @application_id is valid - a potential application identifier + a potential application identifier - Activates the application. + Activates the application. In essence, this results in the #GApplication::activate signal being emitted in the primary instance. @@ -4594,7 +4748,7 @@ The application must be registered before calling this function. - a #GApplication + a #GApplication @@ -4748,7 +4902,7 @@ See g_application_run() for more details on #GApplication startup. - Opens the given files. + Opens the given files. In essence, this results in the #GApplication::open signal being emitted in the primary instance. @@ -4768,21 +4922,21 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - a #GApplication + a #GApplication - an array of #GFiles to open + an array of #GFiles to open - the length of the @files array + the length of the @files array - a hint (or ""), but never %NULL + a hint (or ""), but never %NULL @@ -4832,7 +4986,7 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - Activates the application. + Activates the application. In essence, this results in the #GApplication::activate signal being emitted in the primary instance. @@ -4844,13 +4998,13 @@ The application must be registered before calling this function. - a #GApplication + a #GApplication - Add an option to be handled by @application. + 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 @@ -4869,38 +5023,38 @@ See #GOptionEntry for more documentation of the arguments. - the #GApplication + the #GApplication - the long name of an option used to specify it in a commandline + the long name of an option used to specify it in a commandline - the short name of an option + the short name of an option - flags from #GOptionFlags + flags from #GOptionFlags - the type of the option, as a #GOptionArg + the type of the option, as a #GOptionArg - the description for the option in `--help` output + the description for the option in `--help` output - the placeholder to use for the extra argument + the placeholder to use for the extra argument parsed by the option in `--help` output - Adds main option entries to be handled by @application. + Adds main option entries to be handled by @application. This function is comparable to g_option_context_add_main_entries(). @@ -4960,11 +5114,11 @@ the options with g_variant_dict_lookup(): - a #GApplication + a #GApplication - a + a %NULL-terminated list of #GOptionEntrys @@ -4973,7 +5127,7 @@ the options with g_variant_dict_lookup(): - Adds a #GOptionGroup to the commandline handling of @application. + Adds a #GOptionGroup to the commandline handling of @application. This function is comparable to g_option_context_add_group(). @@ -5004,17 +5158,17 @@ new functionality whereby unrecognised options are rejected even if - the #GApplication + the #GApplication - a #GOptionGroup + a #GOptionGroup - Marks @application as busy (see g_application_mark_busy()) while + 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 @@ -5026,35 +5180,35 @@ finalized. - a #GApplication + a #GApplication - a #GObject + a #GObject - the name of a boolean property of @object + the name of a boolean property of @object - Gets the unique identifier for @application. + Gets the unique identifier for @application. - the identifier for @application, owned by @application + the identifier for @application, owned by @application - a #GApplication + a #GApplication - Gets the #GDBusConnection being used by the application, or %NULL. + Gets the #GDBusConnection being used by the application, or %NULL. If #GApplication is using its D-Bus backend then this function will return the #GDBusConnection being used for uniqueness and @@ -5069,18 +5223,18 @@ This function must not be called before the application has been registered. See g_application_get_is_registered(). - a #GDBusConnection, or %NULL + a #GDBusConnection, or %NULL - a #GApplication + a #GApplication - Gets the D-Bus object path being used by the application, or %NULL. + Gets the D-Bus object path being used by the application, or %NULL. If #GApplication is using its D-Bus backend then this function will return the D-Bus object path that #GApplication is using. If the @@ -5096,83 +5250,83 @@ This function must not be called before the application has been registered. See g_application_get_is_registered(). - the object path, or %NULL + the object path, or %NULL - a #GApplication + a #GApplication - Gets the flags for @application. + Gets the flags for @application. See #GApplicationFlags. - the flags for @application + the flags for @application - a #GApplication + a #GApplication - Gets the current inactivity timeout for the application. + Gets the current inactivity timeout for the application. This is the amount of time (in milliseconds) after the last call to g_application_release() before the application stops running. - the timeout, in milliseconds + the timeout, in milliseconds - a #GApplication + a #GApplication - Gets the application's current busy state, as set through + Gets the application's current busy state, as set through g_application_mark_busy() or g_application_bind_busy_property(). - %TRUE if @application is currenty marked as busy + %TRUE if @application is currenty marked as busy - a #GApplication + a #GApplication - Checks if @application is registered. + Checks if @application is registered. An application is registered if g_application_register() has been successfully called. - %TRUE if @application is registered + %TRUE if @application is registered - a #GApplication + a #GApplication - Checks if @application is remote. + Checks if @application is remote. If @application is remote then it means that another instance of application already exists (the 'primary' instance). Calls to @@ -5184,34 +5338,34 @@ g_application_register() has been called. See g_application_get_is_registered(). - %TRUE if @application is remote + %TRUE if @application is remote - a #GApplication + a #GApplication - Gets the resource base path of @application. + Gets the resource base path of @application. See g_application_set_resource_base_path() for more information. - the base resource path, if one is set + the base resource path, if one is set - a #GApplication + a #GApplication - Increases the use count of @application. + Increases the use count of @application. Use this function to indicate that the application has a reason to continue to run. For example, g_application_hold() is called by GTK+ @@ -5224,13 +5378,13 @@ To cancel the hold, call g_application_release(). - a #GApplication + a #GApplication - Increases the busy count of @application. + Increases the busy count of @application. Use this function to indicate that the application is busy, for instance while a long running operation is pending. @@ -5246,13 +5400,13 @@ To cancel the busy indication, use g_application_unmark_busy(). - a #GApplication + a #GApplication - Opens the given files. + Opens the given files. In essence, this results in the #GApplication::open signal being emitted in the primary instance. @@ -5272,27 +5426,27 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - a #GApplication + a #GApplication - an array of #GFiles to open + an array of #GFiles to open - the length of the @files array + the length of the @files array - a hint (or ""), but never %NULL + a hint (or ""), but never %NULL - Immediately quits the application. + Immediately quits the application. Upon return to the mainloop, g_application_run() will return, calling only the 'shutdown' function before doing so. @@ -5311,13 +5465,13 @@ unspecified. - a #GApplication + a #GApplication - Attempts registration of the application. + Attempts registration of the application. This is the point at which the application discovers if it is the primary instance or merely acting as a remote for an already-existing @@ -5349,22 +5503,22 @@ instance is or is not the primary instance of the application. See g_application_get_is_remote() for that. - %TRUE if registration succeeded + %TRUE if registration succeeded - a #GApplication + a #GApplication - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Decrease the use count of @application. + Decrease the use count of @application. When the use count reaches zero, the application will stop running. @@ -5376,13 +5530,13 @@ call to g_application_hold(). - a #GApplication + a #GApplication - Runs the application. + Runs the application. This function is intended to be run from main() and its return value is intended to be returned by main(). Although you are expected to pass @@ -5459,20 +5613,20 @@ control over when processes invoked via the commandline will exit and what their exit status will be. - the exit status + the exit status - a #GApplication + a #GApplication - the argc from main() (or 0 if @argv is %NULL) + the argc from main() (or 0 if @argv is %NULL) - + the argv from main(), or %NULL @@ -5481,7 +5635,7 @@ what their exit status will be. - Sends a notification on behalf of @application to the desktop shell. + Sends a notification on behalf of @application to the desktop shell. There is no guarantee that the notification is displayed immediately, or even at all. @@ -5513,21 +5667,21 @@ g_application_withdraw_notification(). - a #GApplication + a #GApplication - id of the notification, or %NULL + id of the notification, or %NULL - the #GNotification to send + the #GNotification to send - This used to be how actions were associated with a #GApplication. + This used to be how actions were associated with a #GApplication. Now there is #GActionMap for that. Use the #GActionMap interface instead. Never ever mix use of this API with use of #GActionMap on the same @application @@ -5540,17 +5694,17 @@ action group), so you should really use #GActionMap instead. - a #GApplication + a #GApplication - a #GActionGroup, or %NULL + a #GActionGroup, or %NULL - Sets the unique identifier for @application. + Sets the unique identifier for @application. The application id can only be modified if @application has not yet been registered. @@ -5563,17 +5717,17 @@ g_application_id_is_valid(). - a #GApplication + a #GApplication - the identifier for @application + the identifier for @application - Sets or unsets the default application for the process, as returned + Sets or unsets the default application for the process, as returned by g_application_get_default(). This function does not take its own reference on @application. If @@ -5585,13 +5739,13 @@ back to %NULL. - the application to set as default, or %NULL + the application to set as default, or %NULL - Sets the flags for @application. + Sets the flags for @application. The flags can only be modified if @application has not yet been registered. @@ -5603,17 +5757,17 @@ See #GApplicationFlags. - a #GApplication + a #GApplication - the flags for @application + the flags for @application - Sets the current inactivity timeout for the application. + Sets the current inactivity timeout for the application. This is the amount of time (in milliseconds) after the last call to g_application_release() before the application stops running. @@ -5627,17 +5781,17 @@ zero. Any timeouts currently in progress are not impacted. - a #GApplication + a #GApplication - the timeout, in milliseconds + the timeout, in milliseconds - Adds a description to the @application option context. + Adds a description to the @application option context. See g_option_context_set_description() for more information. @@ -5646,18 +5800,18 @@ See g_option_context_set_description() for more information. - the #GApplication + the #GApplication - a string to be shown in `--help` output + a string to be shown in `--help` output after the list of options, or %NULL - Sets the parameter string to be used by the commandline handling of @application. + Sets the parameter string to be used by the commandline handling of @application. This function registers the argument to be passed to g_option_context_new() when the internal #GOptionContext of @application is created. @@ -5669,18 +5823,18 @@ See g_option_context_new() for more information about @parameter_string. - the #GApplication + the #GApplication - a string which is displayed + a string which is displayed in the first line of `--help` output, after the usage summary `programname [OPTION...]`. - Adds a summary to the @application option context. + Adds a summary to the @application option context. See g_option_context_set_summary() for more information. @@ -5689,18 +5843,18 @@ See g_option_context_set_summary() for more information. - the #GApplication + the #GApplication - a string to be shown in `--help` output + a string to be shown in `--help` output before the list of options, or %NULL - Sets (or unsets) the base resource path of @application. + 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. @@ -5739,17 +5893,17 @@ before chaining up to the parent implementation. - a #GApplication + a #GApplication - the resource path to use + the resource path to use - Destroys a binding between @property and the busy state of + Destroys a binding between @property and the busy state of @application that was previously created with g_application_bind_busy_property(). @@ -5758,21 +5912,21 @@ g_application_bind_busy_property(). - a #GApplication + a #GApplication - a #GObject + a #GObject - the name of a boolean property of @object + the name of a boolean property of @object - Decreases the busy count of @application. + Decreases the busy count of @application. When the busy count reaches zero, the new state will be propagated to other processes. @@ -5785,13 +5939,13 @@ call to g_application_mark_busy(). - a #GApplication + a #GApplication - Withdraws a notification that was sent with + Withdraws a notification that was sent with g_application_send_notification(). This call does nothing if a notification with @id doesn't exist or @@ -5810,11 +5964,11 @@ there is no need to explicitly withdraw the notification in that case. - a #GApplication + a #GApplication - id of a previously sent notification + id of a previously sent notification @@ -6007,7 +6161,7 @@ after registration. See g_application_register(). - a #GApplication + a #GApplication @@ -6021,21 +6175,21 @@ after registration. See g_application_register(). - a #GApplication + a #GApplication - an array of #GFiles to open + an array of #GFiles to open - the length of the @files array + the length of the @files array - a hint (or ""), but never %NULL + a hint (or ""), but never %NULL @@ -6243,7 +6397,7 @@ after registration. See g_application_register(). - #GApplicationCommandLine represents a command-line invocation of + #GApplicationCommandLine represents a command-line invocation of an application. It is created by #GApplication and emitted in the #GApplication::command-line signal and virtual function. @@ -6399,7 +6553,7 @@ The complete example can be found here: [gapplication-example-cmdline3.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline3.c) - Gets the stdin of the invoking process. + Gets the stdin of the invoking process. The #GInputStream can be used to read data passed to the standard input of the invoking process. @@ -6411,12 +6565,12 @@ future, support may be expanded to other platforms. You must only call this function once per commandline invocation. - a #GInputStream for stdin + a #GInputStream for stdin - a #GApplicationCommandLine + a #GApplicationCommandLine @@ -6450,7 +6604,7 @@ You must only call this function once per commandline invocation. - Creates a #GFile corresponding to a filename that was given as part + Creates a #GFile corresponding to a filename that was given as part of the invocation of @cmdline. This differs from g_file_new_for_commandline_arg() in that it @@ -6458,22 +6612,22 @@ resolves relative pathnames using the current working directory of the invoking process rather than the local process. - a new #GFile + a new #GFile - a #GApplicationCommandLine + a #GApplicationCommandLine - an argument from @cmdline + an argument from @cmdline - Gets the list of arguments that was passed on the command line. + Gets the list of arguments that was passed on the command line. The strings in the array may contain non-UTF-8 data on UNIX (such as filenames or arguments given in the system locale) but are always in @@ -6486,7 +6640,7 @@ The return value is %NULL-terminated and should be freed using g_strfreev(). - + the string array containing the arguments (the argv) @@ -6494,17 +6648,17 @@ g_strfreev(). - a #GApplicationCommandLine + a #GApplicationCommandLine - the length of the arguments array, or %NULL + the length of the arguments array, or %NULL - Gets the working directory of the command line invocation. + Gets the working directory of the command line invocation. The string may contain non-utf8 data. It is possible that the remote application did not send a working @@ -6514,18 +6668,18 @@ The return value should not be modified or freed and is valid for as long as @cmdline exists. - the current directory, or %NULL + the current directory, or %NULL - a #GApplicationCommandLine + a #GApplicationCommandLine - Gets the contents of the 'environ' variable of the command line + Gets the contents of the 'environ' variable of the command line invocation, as would be returned by g_get_environ(), ie as a %NULL-terminated list of strings in the form 'NAME=VALUE'. The strings may contain non-utf8 data. @@ -6542,7 +6696,7 @@ See g_application_command_line_getenv() if you are only interested in the value of a single environment variable. - + the environment strings, or %NULL if they were not sent @@ -6550,42 +6704,42 @@ in the value of a single environment variable. - a #GApplicationCommandLine + a #GApplicationCommandLine - Gets the exit status of @cmdline. See + Gets the exit status of @cmdline. See g_application_command_line_set_exit_status() for more information. - the exit status + the exit status - a #GApplicationCommandLine + a #GApplicationCommandLine - Determines if @cmdline represents a remote invocation. + Determines if @cmdline represents a remote invocation. - %TRUE if the invocation was remote + %TRUE if the invocation was remote - a #GApplicationCommandLine + a #GApplicationCommandLine - Gets the options there were passed to g_application_command_line(). + Gets the options there were passed to g_application_command_line(). If you did not override local_command_line() then these are the same options that were parsed according to the #GOptionEntrys added to the @@ -6596,18 +6750,18 @@ If no options were sent then an empty dictionary is returned so that you don't need to check for %NULL. - a #GVariantDict with the options + a #GVariantDict with the options - a #GApplicationCommandLine + a #GApplicationCommandLine - Gets the platform data associated with the invocation of @cmdline. + Gets the platform data associated with the invocation of @cmdline. This is a #GVariant dictionary containing information about the context in which the invocation occurred. It typically contains @@ -6617,18 +6771,18 @@ notification ID. For local invocation, it will be %NULL. - the platform data, or %NULL + the platform data, or %NULL - #GApplicationCommandLine + #GApplicationCommandLine - Gets the stdin of the invoking process. + Gets the stdin of the invoking process. The #GInputStream can be used to read data passed to the standard input of the invoking process. @@ -6640,18 +6794,18 @@ future, support may be expanded to other platforms. You must only call this function once per commandline invocation. - a #GInputStream for stdin + a #GInputStream for stdin - a #GApplicationCommandLine + a #GApplicationCommandLine - Gets the value of a particular environment variable of the command + Gets the value of a particular environment variable of the command line invocation, as would be returned by g_getenv(). The strings may contain non-utf8 data. @@ -6664,22 +6818,22 @@ The return value should not be modified or freed and is valid for as long as @cmdline exists. - the value of the variable, or %NULL if unset or unsent + the value of the variable, or %NULL if unset or unsent - a #GApplicationCommandLine + a #GApplicationCommandLine - the environment variable to get + the environment variable to get - Formats a message and prints it using the stdout print handler in the + Formats a message and prints it using the stdout print handler in the invoking process. If @cmdline is a local invocation then this is exactly equivalent to @@ -6691,21 +6845,21 @@ g_print() in the invoking process. - a #GApplicationCommandLine + a #GApplicationCommandLine - a printf-style format string + a printf-style format string - arguments, as per @format + arguments, as per @format - Formats a message and prints it using the stderr print handler in the + Formats a message and prints it using the stderr print handler in the invoking process. If @cmdline is a local invocation then this is exactly equivalent to @@ -6717,21 +6871,21 @@ calling g_printerr() in the invoking process. - a #GApplicationCommandLine + a #GApplicationCommandLine - a printf-style format string + a printf-style format string - arguments, as per @format + arguments, as per @format - Sets the exit status that will be used when the invoking process + Sets the exit status that will be used when the invoking process exits. The return value of the #GApplication::command-line signal is @@ -6758,11 +6912,11 @@ status of the local #GApplicationCommandLine is used. - a #GApplicationCommandLine + a #GApplicationCommandLine - the exit status + the exit status @@ -6829,12 +6983,12 @@ contains private data only. - a #GInputStream for stdin + a #GInputStream for stdin - a #GApplicationCommandLine + a #GApplicationCommandLine @@ -6850,34 +7004,34 @@ contains private data only. - Flags used to define the behaviour of a #GApplication. + Flags used to define the behaviour of a #GApplication. - Default + Default - Run as a service. In this mode, registration + Run as a service. In this mode, registration fails if the service is already running, and the application will initially wait up to 10 seconds for an initial activation message to arrive. - Don't try to become the primary instance. + Don't try to become the primary instance. - This application handles opening files (in + This application handles opening files (in the primary instance). Note that this flag only affects the default implementation of local_command_line(), and has no effect if %G_APPLICATION_HANDLES_COMMAND_LINE is given. See g_application_run() for details. - This application handles command line + This application handles command line arguments (in the primary instance). Note that this flag only affect the default implementation of local_command_line(). See g_application_run() for details. - Send the environment of the + Send the environment of the launching process to the primary instance. Set this flag if your application is expected to behave differently depending on certain environment variables. For instance, an editor might be expected @@ -6887,7 +7041,7 @@ contains private data only. g_application_command_line_getenv(). - Make no attempts to do any of the typical + Make no attempts to do any of the typical single-instance application negotiation, even if the application ID is given. The application neither attempts to become the owner of the application ID nor does it check if an existing @@ -6895,16 +7049,16 @@ contains private data only. Since: 2.30. - Allow users to override the + Allow users to override the application ID from the command line with `--gapplication-app-id`. Since: 2.48 - Allow another instance to take over + Allow another instance to take over the bus name. Since: 2.60 - Take over from another instance. This flag is + Take over from another instance. This flag is usually set by passing `--gapplication-replace` on the commandline. Since: 2.60 @@ -6913,30 +7067,30 @@ contains private data only. - #GAskPasswordFlags are used to request specific information from the + #GAskPasswordFlags are used to request specific information from the user, or to notify the user of their choices in an authentication situation. - operation requires a password. + operation requires a password. - operation requires a username. + operation requires a username. - operation requires a domain. + operation requires a domain. - operation supports saving settings. + operation supports saving settings. - operation supports anonymous users. + operation supports anonymous users. - operation takes TCRYPT parameters (Since: 2.58) + operation takes TCRYPT parameters (Since: 2.58) - This is the asynchronous version of #GInitable; it behaves the same + This is the asynchronous version of #GInitable; it behaves the same in all ways except that initialization is asynchronous. For more details see the descriptions on #GInitable. @@ -7036,7 +7190,7 @@ foo_async_initable_iface_init (gpointer g_iface, ]| - Helper function for constructing #GAsyncInitable object. This is + Helper function for constructing #GAsyncInitable object. This is similar to g_object_new() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -7048,85 +7202,85 @@ for any errors. - a #GType supporting #GAsyncInitable. + a #GType supporting #GAsyncInitable. - the [I/O priority][io-priority] of the operation + the [I/O priority][io-priority] of the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the initialization is + a #GAsyncReadyCallback to call when the initialization is finished - the data to pass to callback function + the data to pass to callback function - the name of the first property, or %NULL if no + the name of the first property, or %NULL if no properties - the value of the first property, followed by other property + the value of the first property, followed by other property value pairs, and ended by %NULL. - Helper function for constructing #GAsyncInitable object. This is + Helper function for constructing #GAsyncInitable object. This is similar to g_object_new_valist() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can then call g_async_initable_new_finish() to get the new object and check for any errors. - + - a #GType supporting #GAsyncInitable. + a #GType supporting #GAsyncInitable. - the name of the first property, followed by + the name of the first property, followed by the value, and other property value pairs, and ended by %NULL. - The var args list generated from @first_property_name. + The var args list generated from @first_property_name. - the [I/O priority][io-priority] of the operation + the [I/O priority][io-priority] of the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the initialization is + a #GAsyncReadyCallback to call when the initialization is finished - the data to pass to callback function + the data to pass to callback function - Helper function for constructing #GAsyncInitable object. This is + Helper function for constructing #GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -7134,44 +7288,44 @@ then call g_async_initable_new_finish() to get the new object and check for any errors. Use g_object_new_with_properties() and g_async_initable_init_async() instead. See #GParameter for more information. - + - a #GType supporting #GAsyncInitable. + a #GType supporting #GAsyncInitable. - the number of parameters in @parameters + the number of parameters in @parameters - the parameters to use to construct the object + the parameters to use to construct the object - the [I/O priority][io-priority] of the operation + the [I/O priority][io-priority] of the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the initialization is + a #GAsyncReadyCallback to call when the initialization is finished - the data to pass to callback function + the data to pass to callback function - Starts asynchronous initialization of the object implementing the + Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead. @@ -7213,49 +7367,49 @@ any interface methods. - a #GAsyncInitable. + a #GAsyncInitable. - the [I/O priority][io-priority] of the operation + the [I/O priority][io-priority] of the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes asynchronous initialization and returns the result. + Finishes asynchronous initialization and returns the result. See g_async_initable_init_async(). - %TRUE if successful. If an error has occurred, this function + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GAsyncInitable. + a #GAsyncInitable. - a #GAsyncResult. + a #GAsyncResult. - Starts asynchronous initialization of the object implementing the + Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead. @@ -7297,63 +7451,63 @@ any interface methods. - a #GAsyncInitable. + a #GAsyncInitable. - the [I/O priority][io-priority] of the operation + the [I/O priority][io-priority] of the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes asynchronous initialization and returns the result. + Finishes asynchronous initialization and returns the result. See g_async_initable_init_async(). - %TRUE if successful. If an error has occurred, this function + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GAsyncInitable. + a #GAsyncInitable. - a #GAsyncResult. + a #GAsyncResult. - Finishes the async construction for the various g_async_initable_new + Finishes the async construction for the various g_async_initable_new calls, returning the created object or %NULL on error. - + - a newly created #GObject, + a newly created #GObject, or %NULL on error. Free with g_object_unref(). - the #GAsyncInitable from the callback + the #GAsyncInitable from the callback - the #GAsyncResult from the callback + the #GAsyncResult from the callback @@ -7375,23 +7529,23 @@ initialization may fail. - a #GAsyncInitable. + a #GAsyncInitable. - the [I/O priority][io-priority] of the operation + the [I/O priority][io-priority] of the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -7401,17 +7555,17 @@ initialization may fail. - %TRUE if successful. If an error has occurred, this function + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GAsyncInitable. + a #GAsyncInitable. - a #GAsyncResult. + a #GAsyncResult. @@ -7447,7 +7601,7 @@ later iteration of the main context. - Provides a base class for implementing asynchronous function results. + Provides a base class for implementing asynchronous function results. Asynchronous operations are broken up into two separate operations which are chained together by a #GAsyncReadyCallback. To begin @@ -7533,105 +7687,105 @@ higher priority. It is recommended to choose priorities between as a default. - Gets the source object from a #GAsyncResult. + Gets the source object from a #GAsyncResult. - a new reference to the source + a new reference to the source object for the @res, or %NULL if there is none. - a #GAsyncResult + a #GAsyncResult - Gets the user data from a #GAsyncResult. + Gets the user data from a #GAsyncResult. - the user data for @res. + the user data for @res. - a #GAsyncResult. + a #GAsyncResult. - Checks if @res has the given @source_tag (generally a function + Checks if @res has the given @source_tag (generally a function pointer indicating the function @res was created by). - %TRUE if @res has the indicated @source_tag, %FALSE if + %TRUE if @res has the indicated @source_tag, %FALSE if not. - a #GAsyncResult + a #GAsyncResult - an application-defined tag + an application-defined tag - Gets the source object from a #GAsyncResult. + Gets the source object from a #GAsyncResult. - a new reference to the source + a new reference to the source object for the @res, or %NULL if there is none. - a #GAsyncResult + a #GAsyncResult - Gets the user data from a #GAsyncResult. + Gets the user data from a #GAsyncResult. - the user data for @res. + the user data for @res. - a #GAsyncResult. + a #GAsyncResult. - Checks if @res has the given @source_tag (generally a function + Checks if @res has the given @source_tag (generally a function pointer indicating the function @res was created by). - %TRUE if @res has the indicated @source_tag, %FALSE if + %TRUE if @res has the indicated @source_tag, %FALSE if not. - a #GAsyncResult + a #GAsyncResult - an application-defined tag + an application-defined tag - If @res is a #GSimpleAsyncResult, this is equivalent to + If @res is a #GSimpleAsyncResult, this is equivalent to g_simple_async_result_propagate_error(). Otherwise it returns %FALSE. @@ -7643,13 +7797,13 @@ set by virtual methods should also be extracted by virtual methods, to enable subclasses to chain up correctly. - %TRUE if @error is has been filled in with an error from + %TRUE if @error is has been filled in with an error from @res, %FALSE if not. - a #GAsyncResult + a #GAsyncResult @@ -7666,12 +7820,12 @@ to enable subclasses to chain up correctly. - the user data for @res. + the user data for @res. - a #GAsyncResult. + a #GAsyncResult. @@ -7681,13 +7835,13 @@ to enable subclasses to chain up correctly. - a new reference to the source + a new reference to the source object for the @res, or %NULL if there is none. - a #GAsyncResult + a #GAsyncResult @@ -7697,25 +7851,74 @@ to enable subclasses to chain up correctly. - %TRUE if @res has the indicated @source_tag, %FALSE if + %TRUE if @res has the indicated @source_tag, %FALSE if not. - a #GAsyncResult + a #GAsyncResult - an application-defined tag + an application-defined tag + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Buffered input stream implements #GFilterInputStream and provides + Buffered input stream implements #GFilterInputStream and provides for buffered reads. By default, #GBufferedInputStream's buffer size is set at 4 kilobytes. @@ -7732,41 +7935,41 @@ cannot be reduced below the size of the data within the buffer. - Creates a new #GInputStream from the given @base_stream, with + Creates a new #GInputStream from the given @base_stream, with a buffer set to the default size (4 kilobytes). - a #GInputStream for the given @base_stream. + a #GInputStream for the given @base_stream. - a #GInputStream + a #GInputStream - Creates a new #GBufferedInputStream from the given @base_stream, + Creates a new #GBufferedInputStream from the given @base_stream, with a buffer set to @size. - a #GInputStream. + a #GInputStream. - a #GInputStream + a #GInputStream - a #gsize + a #gsize - Tries to read @count bytes from the stream into the buffer. + Tries to read @count bytes from the stream into the buffer. Will block during this read. If @count is zero, returns zero and does nothing. A value of @count @@ -7792,27 +7995,27 @@ For the asynchronous, non-blocking, version of this function, see g_buffered_input_stream_fill_async(). - the number of bytes read into @stream's buffer, up to @count, + the number of bytes read into @stream's buffer, up to @count, or -1 on error. - a #GBufferedInputStream + a #GBufferedInputStream - the number of bytes that will be read from the stream + the number of bytes that will be read from the stream - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Reads data into @stream's buffer asynchronously, up to @count size. + Reads data into @stream's buffer asynchronously, up to @count size. @io_priority can be used to prioritize reads. For the synchronous version of this function, see g_buffered_input_stream_fill(). @@ -7824,51 +8027,51 @@ of bytes that are required to fill the buffer. - a #GBufferedInputStream + a #GBufferedInputStream - the number of bytes that will be read from the stream + the number of bytes that will be read from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object + optional #GCancellable object - a #GAsyncReadyCallback + a #GAsyncReadyCallback - a #gpointer + a #gpointer - Finishes an asynchronous read. + Finishes an asynchronous read. - a #gssize of the read stream, or `-1` on an error. + a #gssize of the read stream, or `-1` on an error. - a #GBufferedInputStream + a #GBufferedInputStream - a #GAsyncResult + a #GAsyncResult - Tries to read @count bytes from the stream into the buffer. + Tries to read @count bytes from the stream into the buffer. Will block during this read. If @count is zero, returns zero and does nothing. A value of @count @@ -7894,27 +8097,27 @@ For the asynchronous, non-blocking, version of this function, see g_buffered_input_stream_fill_async(). - the number of bytes read into @stream's buffer, up to @count, + the number of bytes read into @stream's buffer, up to @count, or -1 on error. - a #GBufferedInputStream + a #GBufferedInputStream - the number of bytes that will be read from the stream + the number of bytes that will be read from the stream - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Reads data into @stream's buffer asynchronously, up to @count size. + Reads data into @stream's buffer asynchronously, up to @count size. @io_priority can be used to prioritize reads. For the synchronous version of this function, see g_buffered_input_stream_fill(). @@ -7926,114 +8129,114 @@ of bytes that are required to fill the buffer. - a #GBufferedInputStream + a #GBufferedInputStream - the number of bytes that will be read from the stream + the number of bytes that will be read from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object + optional #GCancellable object - a #GAsyncReadyCallback + a #GAsyncReadyCallback - a #gpointer + a #gpointer - Finishes an asynchronous read. + Finishes an asynchronous read. - a #gssize of the read stream, or `-1` on an error. + a #gssize of the read stream, or `-1` on an error. - a #GBufferedInputStream + a #GBufferedInputStream - a #GAsyncResult + a #GAsyncResult - Gets the size of the available data within the stream. + Gets the size of the available data within the stream. - size of the available stream. + size of the available stream. - #GBufferedInputStream + #GBufferedInputStream - Gets the size of the input buffer. + Gets the size of the input buffer. - the current buffer size. + the current buffer size. - a #GBufferedInputStream + a #GBufferedInputStream - Peeks in the buffer, copying data of size @count into @buffer, + Peeks in the buffer, copying data of size @count into @buffer, offset @offset bytes. - a #gsize of the number of bytes peeked, or -1 on error. + a #gsize of the number of bytes peeked, or -1 on error. - a #GBufferedInputStream + a #GBufferedInputStream - a pointer to + a pointer to an allocated chunk of memory - a #gsize + a #gsize - a #gsize + a #gsize - Returns the buffer with the currently available bytes. The returned + Returns the buffer with the currently available bytes. The returned buffer must not be modified and will become invalid when reading from the stream or filling the buffer. - + read-only buffer @@ -8041,17 +8244,17 @@ the stream or filling the buffer. - a #GBufferedInputStream + a #GBufferedInputStream - a #gsize to get the number of bytes available in the buffer + a #gsize to get the number of bytes available in the buffer - Tries to read a single byte from the stream or the buffer. Will block + Tries to read a single byte from the stream or the buffer. Will block during this read. On success, the byte read from the stream is returned. On end of stream @@ -8066,22 +8269,22 @@ partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - the byte read from the @stream, or -1 on end of stream or error. + the byte read from the @stream, or -1 on end of stream or error. - a #GBufferedInputStream + a #GBufferedInputStream - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Sets the size of the internal buffer of @stream to @size, or to the + Sets the size of the internal buffer of @stream to @size, or to the size of the contents of the buffer. The buffer can never be resized smaller than its current contents. @@ -8090,11 +8293,11 @@ smaller than its current contents. - a #GBufferedInputStream + a #GBufferedInputStream - a #gsize + a #gsize @@ -8118,21 +8321,21 @@ smaller than its current contents. - the number of bytes read into @stream's buffer, up to @count, + the number of bytes read into @stream's buffer, up to @count, or -1 on error. - a #GBufferedInputStream + a #GBufferedInputStream - the number of bytes that will be read from the stream + the number of bytes that will be read from the stream - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore @@ -8146,27 +8349,27 @@ smaller than its current contents. - a #GBufferedInputStream + a #GBufferedInputStream - the number of bytes that will be read from the stream + the number of bytes that will be read from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object + optional #GCancellable object - a #GAsyncReadyCallback + a #GAsyncReadyCallback - a #gpointer + a #gpointer @@ -8176,16 +8379,16 @@ smaller than its current contents. - a #gssize of the read stream, or `-1` on an error. + a #gssize of the read stream, or `-1` on an error. - a #GBufferedInputStream + a #GBufferedInputStream - a #GAsyncResult + a #GAsyncResult @@ -8236,7 +8439,7 @@ smaller than its current contents. - Buffered output stream implements #GFilterOutputStream and provides + Buffered output stream implements #GFilterOutputStream and provides for buffered writes. By default, #GBufferedOutputStream's buffer size is set at 4 kilobytes. @@ -8253,68 +8456,68 @@ size cannot be reduced below the size of the data within the buffer. - Creates a new buffered output stream for a base stream. + Creates a new buffered output stream for a base stream. - a #GOutputStream for the given @base_stream. + a #GOutputStream for the given @base_stream. - a #GOutputStream. + a #GOutputStream. - Creates a new buffered output stream with a given buffer size. + Creates a new buffered output stream with a given buffer size. - a #GOutputStream with an internal buffer set to @size. + a #GOutputStream with an internal buffer set to @size. - a #GOutputStream. + a #GOutputStream. - a #gsize. + a #gsize. - Checks if the buffer automatically grows as data is added. + Checks if the buffer automatically grows as data is added. - %TRUE if the @stream's buffer automatically grows, + %TRUE if the @stream's buffer automatically grows, %FALSE otherwise. - a #GBufferedOutputStream. + a #GBufferedOutputStream. - Gets the size of the buffer in the @stream. + Gets the size of the buffer in the @stream. - the current size of the buffer. + the current size of the buffer. - a #GBufferedOutputStream. + a #GBufferedOutputStream. - Sets whether or not the @stream's buffer should automatically grow. + Sets whether or not the @stream's buffer should automatically grow. If @auto_grow is true, then each write will just make the buffer larger, and you must manually flush the buffer to actually write out the data to the underlying stream. @@ -8324,28 +8527,28 @@ the data to the underlying stream. - a #GBufferedOutputStream. + a #GBufferedOutputStream. - a #gboolean. + a #gboolean. - Sets the size of the internal buffer to @size. + Sets the size of the internal buffer to @size. - a #GBufferedOutputStream. + a #GBufferedOutputStream. - a #gsize. + a #gsize. @@ -8431,7 +8634,7 @@ the data to the underlying stream. - Invoked when the name being watched is known to have to have a owner. + Invoked when the name being watched is known to have to have an owner. @@ -8478,24 +8681,24 @@ the connection was disconnected. - Flags used in g_bus_own_name(). + Flags used in g_bus_own_name(). - No flags set. + No flags set. - Allow another message bus connection to claim the name. + Allow another message bus connection to claim the name. - If another message bus connection owns the name and have + If another message bus connection owns the name and have specified #G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the other connection. - If another message bus connection owns the name, immediately + If another message bus connection owns the name, immediately return an error from g_bus_own_name() rather than entering the waiting queue for that name. (Since 2.54) - Invoked when the name being watched is known not to have to have a owner. + Invoked when the name being watched is known not to have to have an owner. This is also invoked when the #GDBusConnection on which the watch was established has been closed. In that case, @connection will be @@ -8521,61 +8724,61 @@ established has been closed. In that case, @connection will be - Flags used in g_bus_watch_name(). + Flags used in g_bus_watch_name(). - No flags set. + No flags set. - If no-one owns the name when + If no-one owns the name when beginning to watch the name, ask the bus to launch an owner for the name. - An enumeration for well-known message buses. + An enumeration for well-known message buses. - An alias for the message bus that activated the process, if any. + An alias for the message bus that activated the process, if any. - Not a message bus. + Not a message bus. - The system-wide message bus. + The system-wide message bus. - The login session message bus. + The login session message bus. - #GBytesIcon specifies an image held in memory in a common format (usually + #GBytesIcon specifies an image held in memory in a common format (usually png) to be used as icon. - Creates a new icon for a bytes. + Creates a new icon for a bytes. - a #GIcon for the given + a #GIcon for the given @bytes, or %NULL on error. - a #GBytes. + a #GBytes. - Gets the #GBytes associated with the given @icon. + Gets the #GBytes associated with the given @icon. - a #GBytes, or %NULL. + a #GBytes, or %NULL. - a #GIcon. + a #GIcon. @@ -8585,13 +8788,132 @@ png) to be used as icon. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - GCancellable is a thread-safe operation cancellation stack used + GCancellable is a thread-safe operation cancellation stack used throughout GIO to allow for cancellation of synchronous and asynchronous operations. - Creates a new #GCancellable object. + Creates a new #GCancellable object. Applications that want to start one or more operations that should be cancellable should create a #GCancellable @@ -8601,15 +8923,15 @@ One #GCancellable can be used in multiple consecutive operations or in multiple concurrent operations. - a #GCancellable. + a #GCancellable. - Gets the top cancellable from the stack. + Gets the top cancellable from the stack. - a #GCancellable from the top + a #GCancellable from the top of the stack, or %NULL if the stack is empty. @@ -8626,7 +8948,7 @@ of the stack, or %NULL if the stack is empty. - Will set @cancellable to cancelled, and will emit the + Will set @cancellable to cancelled, and will emit the #GCancellable::cancelled signal. (However, see the warning about race conditions in the documentation for that signal if you are planning to connect to it.) @@ -8648,13 +8970,13 @@ the application returns to the main loop. - a #GCancellable object. + a #GCancellable object. - Convenience function to connect to the #GCancellable::cancelled + Convenience function to connect to the #GCancellable::cancelled signal. Also handles the race condition that may happen if the cancellable is cancelled right before connecting. @@ -8674,31 +8996,31 @@ earlier GLib versions which now makes it easier to write cleanup code that unconditionally invokes e.g. g_cancellable_cancel(). - The id of the signal handler or 0 if @cancellable has already + The id of the signal handler or 0 if @cancellable has already been cancelled. - A #GCancellable. + A #GCancellable. - The #GCallback to connect. + The #GCallback to connect. - Data to pass to @callback. + Data to pass to @callback. - Free function for @data or %NULL. + Free function for @data or %NULL. - Disconnects a handler from a cancellable instance similar to + Disconnects a handler from a cancellable instance similar to g_signal_handler_disconnect(). Additionally, in the event that a signal handler is currently running, this call will block until the handler has finished. Calling this function from a @@ -8718,17 +9040,17 @@ nothing. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Handler id of the handler to be disconnected, or `0`. + Handler id of the handler to be disconnected, or `0`. - Gets the file descriptor for a cancellable job. This can be used to + Gets the file descriptor for a cancellable job. This can be used to implement cancellable operations on Unix systems. The returned fd will turn readable when @cancellable is cancelled. @@ -8743,34 +9065,34 @@ the returned file descriptor. See also g_cancellable_make_pollfd(). - A valid file descriptor. `-1` if the file descriptor + A valid file descriptor. `-1` if the file descriptor is not supported, or on errors. - a #GCancellable. + a #GCancellable. - Checks if a cancellable job has been cancelled. + Checks if a cancellable job has been cancelled. - %TRUE if @cancellable is cancelled, + %TRUE if @cancellable is cancelled, FALSE if called with %NULL or if item is not cancelled. - a #GCancellable or %NULL + a #GCancellable or %NULL - Creates a #GPollFD corresponding to @cancellable; this can be passed + Creates a #GPollFD corresponding to @cancellable; this can be passed to g_poll() and used to poll for cancellation. This is useful both for unix systems without a native poll and for portability to windows. @@ -8790,23 +9112,23 @@ readable status. Reading to unset the readable status is done with g_cancellable_reset(). - %TRUE if @pollfd was successfully initialized, %FALSE on + %TRUE if @pollfd was successfully initialized, %FALSE on failure to prepare the cancellable. - a #GCancellable or %NULL + a #GCancellable or %NULL - a pointer to a #GPollFD + a pointer to a #GPollFD - Pops @cancellable off the cancellable stack (verifying that @cancellable + Pops @cancellable off the cancellable stack (verifying that @cancellable is on the top of the stack). @@ -8814,13 +9136,13 @@ is on the top of the stack). - a #GCancellable object + a #GCancellable object - Pushes @cancellable onto the cancellable stack. The current + Pushes @cancellable onto the cancellable stack. The current cancellable can then be received using g_cancellable_get_current(). This is useful when implementing cancellable operations in @@ -8834,13 +9156,13 @@ so you rarely have to call this yourself. - a #GCancellable object + a #GCancellable object - Releases a resources previously allocated by g_cancellable_get_fd() + Releases a resources previously allocated by g_cancellable_get_fd() or g_cancellable_make_pollfd(). For compatibility reasons with older releases, calling this function @@ -8855,13 +9177,13 @@ descriptors when many #GCancellables are used at the same time. - a #GCancellable + a #GCancellable - Resets @cancellable to its uncancelled state. + Resets @cancellable to its uncancelled state. If cancellable is currently in use by any cancellable operation then the behavior of this function is undefined. @@ -8878,28 +9200,28 @@ create a fresh cancellable for further async operations. - a #GCancellable object. + a #GCancellable object. - If the @cancellable is cancelled, sets the error to notify + If the @cancellable is cancelled, sets the error to notify that the operation was cancelled. - %TRUE if @cancellable was cancelled, %FALSE if it was not + %TRUE if @cancellable was cancelled, %FALSE if it was not - a #GCancellable or %NULL + a #GCancellable or %NULL - Creates a source that triggers if @cancellable is cancelled and + Creates a source that triggers if @cancellable is cancelled and calls its callback of type #GCancellableSourceFunc. This is primarily useful for attaching to another (non-cancellable) source with g_source_add_child_source() to add cancellability to it. @@ -8910,12 +9232,12 @@ in which case the source will never trigger. The new #GSource will hold a reference to the #GCancellable. - the new #GSource. + the new #GSource. - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -9065,70 +9387,70 @@ returned by g_cancellable_source_new(). - #GCharsetConverter is an implementation of #GConverter based on + #GCharsetConverter is an implementation of #GConverter based on GIConv. - Creates a new #GCharsetConverter. + Creates a new #GCharsetConverter. - a new #GCharsetConverter or %NULL on error. + a new #GCharsetConverter or %NULL on error. - destination charset + destination charset - source charset + source charset - Gets the number of fallbacks that @converter has applied so far. + Gets the number of fallbacks that @converter has applied so far. - the number of fallbacks that @converter has applied + the number of fallbacks that @converter has applied - a #GCharsetConverter + a #GCharsetConverter - Gets the #GCharsetConverter:use-fallback property. + Gets the #GCharsetConverter:use-fallback property. - %TRUE if fallbacks are used by @converter + %TRUE if fallbacks are used by @converter - a #GCharsetConverter + a #GCharsetConverter - Sets the #GCharsetConverter:use-fallback property. + Sets the #GCharsetConverter:use-fallback property. - a #GCharsetConverter + a #GCharsetConverter - %TRUE to use fallbacks + %TRUE to use fallbacks @@ -9150,7 +9472,7 @@ GIConv. - #GConverter is implemented by objects that convert + #GConverter is implemented by objects that convert binary data in various ways. The conversion can be stateful and may fail at any place. @@ -9159,7 +9481,7 @@ compression, decompression and regular expression replace. - This is the main operation used when converting data. It is to be called + This is the main operation used when converting data. It is to be called multiple times in a loop, and each time it will do some work, i.e. producing some output (in @outbuf) or consuming some input (from @inbuf) or both. If its not possible to do any work an error is returned. @@ -9243,52 +9565,52 @@ to produce as much output as possible and then return an error (typically %G_IO_ERROR_PARTIAL_INPUT). - a #GConverterResult, %G_CONVERTER_ERROR on error. + a #GConverterResult, %G_CONVERTER_ERROR on error. - a #GConverter. + a #GConverter. - the buffer + the buffer containing the data to convert. - the number of bytes in @inbuf + the number of bytes in @inbuf - a buffer to write + a buffer to write converted data in. - the number of bytes in @outbuf, must be at least one + the number of bytes in @outbuf, must be at least one - a #GConverterFlags controlling the conversion details + a #GConverterFlags controlling the conversion details - will be set to the number of bytes read from @inbuf on success + will be set to the number of bytes read from @inbuf on success - will be set to the number of bytes written to @outbuf on success + will be set to the number of bytes written to @outbuf on success - Resets all internal state in the converter, making it behave + Resets all internal state in the converter, making it behave as if it was just created. If the converter has any internal state that would produce output then that output is lost. @@ -9297,13 +9619,13 @@ state that would produce output then that output is lost. - a #GConverter. + a #GConverter. - This is the main operation used when converting data. It is to be called + This is the main operation used when converting data. It is to be called multiple times in a loop, and each time it will do some work, i.e. producing some output (in @outbuf) or consuming some input (from @inbuf) or both. If its not possible to do any work an error is returned. @@ -9387,52 +9709,52 @@ to produce as much output as possible and then return an error (typically %G_IO_ERROR_PARTIAL_INPUT). - a #GConverterResult, %G_CONVERTER_ERROR on error. + a #GConverterResult, %G_CONVERTER_ERROR on error. - a #GConverter. + a #GConverter. - the buffer + the buffer containing the data to convert. - the number of bytes in @inbuf + the number of bytes in @inbuf - a buffer to write + a buffer to write converted data in. - the number of bytes in @outbuf, must be at least one + the number of bytes in @outbuf, must be at least one - a #GConverterFlags controlling the conversion details + a #GConverterFlags controlling the conversion details - will be set to the number of bytes read from @inbuf on success + will be set to the number of bytes read from @inbuf on success - will be set to the number of bytes written to @outbuf on success + will be set to the number of bytes written to @outbuf on success - Resets all internal state in the converter, making it behave + Resets all internal state in the converter, making it behave as if it was just created. If the converter has any internal state that would produce output then that output is lost. @@ -9441,7 +9763,7 @@ state that would produce output then that output is lost. - a #GConverter. + a #GConverter. @@ -9472,46 +9794,46 @@ and may fail at any place. - a #GConverterResult, %G_CONVERTER_ERROR on error. + a #GConverterResult, %G_CONVERTER_ERROR on error. - a #GConverter. + a #GConverter. - the buffer + the buffer containing the data to convert. - the number of bytes in @inbuf + the number of bytes in @inbuf - a buffer to write + a buffer to write converted data in. - the number of bytes in @outbuf, must be at least one + the number of bytes in @outbuf, must be at least one - a #GConverterFlags controlling the conversion details + a #GConverterFlags controlling the conversion details - will be set to the number of bytes read from @inbuf on success + will be set to the number of bytes read from @inbuf on success - will be set to the number of bytes written to @outbuf on success + will be set to the number of bytes written to @outbuf on success @@ -9525,7 +9847,7 @@ and may fail at any place. - a #GConverter. + a #GConverter. @@ -9533,7 +9855,7 @@ and may fail at any place. - Converter input stream implements #GInputStream and allows + Converter input stream implements #GInputStream and allows conversion of data of various types during reading. As of GLib 2.34, #GConverterInputStream implements @@ -9541,33 +9863,33 @@ As of GLib 2.34, #GConverterInputStream implements - Creates a new converter input stream for the @base_stream. + Creates a new converter input stream for the @base_stream. - a new #GInputStream. + a new #GInputStream. - a #GInputStream + a #GInputStream - a #GConverter + a #GConverter - Gets the #GConverter that is used by @converter_stream. + Gets the #GConverter that is used by @converter_stream. - the converter of the converter input stream + the converter of the converter input stream - a #GConverterInputStream + a #GConverterInputStream @@ -9632,7 +9954,7 @@ As of GLib 2.34, #GConverterInputStream implements - Converter output stream implements #GOutputStream and allows + Converter output stream implements #GOutputStream and allows conversion of data of various types during reading. As of GLib 2.34, #GConverterOutputStream implements @@ -9640,33 +9962,33 @@ As of GLib 2.34, #GConverterOutputStream implements - Creates a new converter output stream for the @base_stream. + Creates a new converter output stream for the @base_stream. - a new #GOutputStream. + a new #GOutputStream. - a #GOutputStream + a #GOutputStream - a #GConverter + a #GConverter - Gets the #GConverter that is used by @converter_stream. + Gets the #GConverter that is used by @converter_stream. - the converter of the converter output stream + the converter of the converter output stream - a #GConverterOutputStream + a #GConverterOutputStream @@ -9746,7 +10068,7 @@ As of GLib 2.34, #GConverterOutputStream implements - The #GCredentials type is a reference-counted wrapper for native + The #GCredentials type is a reference-counted wrapper for native credentials. This information is typically used for identifying, authenticating and authorizing other processes. @@ -9778,16 +10100,16 @@ credential type is a ucred_t. This corresponds to %G_CREDENTIALS_TYPE_SOLARIS_UCRED. - Creates a new #GCredentials object with credentials matching the + Creates a new #GCredentials object with credentials matching the the current process. - A #GCredentials. Free with g_object_unref(). + A #GCredentials. Free with g_object_unref(). - Gets a pointer to native credentials of type @native_type from + Gets a pointer to native credentials of type @native_type from @credentials. It is a programming error (which will cause an warning to be @@ -9795,7 +10117,7 @@ logged) to use this method if there is no #GCredentials support for the OS or if @native_type isn't supported by the OS. - The pointer to native credentials or %NULL if the + The pointer to native credentials or %NULL if the operation there is no #GCredentials support for the OS or if @native_type isn't supported by the OS. Do not free the returned data, it is owned by @credentials. @@ -9803,17 +10125,17 @@ data, it is owned by @credentials. - A #GCredentials. + A #GCredentials. - The type of native credentials to get. + The type of native credentials to get. - Tries to get the UNIX process identifier from @credentials. This + Tries to get the UNIX process identifier from @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the @@ -9821,18 +10143,18 @@ OS or if the native credentials type does not contain information about the UNIX process ID. - The UNIX process ID, or -1 if @error is set. + The UNIX process ID, or -1 if @error is set. - A #GCredentials + A #GCredentials - Tries to get the UNIX user identifier from @credentials. This + Tries to get the UNIX user identifier from @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the @@ -9840,40 +10162,40 @@ OS or if the native credentials type does not contain information about the UNIX user. - The UNIX user identifier or -1 if @error is set. + The UNIX user identifier or -1 if @error is set. - A #GCredentials + A #GCredentials - Checks if @credentials and @other_credentials is the same user. + Checks if @credentials and @other_credentials is the same user. This operation can fail if #GCredentials is not supported on the the OS. - %TRUE if @credentials and @other_credentials has the same + %TRUE if @credentials and @other_credentials has the same user, %FALSE otherwise or if @error is set. - A #GCredentials. + A #GCredentials. - A #GCredentials. + A #GCredentials. - Copies the native credentials of type @native_type from @native + Copies the native credentials of type @native_type from @native into @credentials. It is a programming error (which will cause an warning to be @@ -9885,21 +10207,21 @@ the OS or if @native_type isn't supported by the OS. - A #GCredentials. + A #GCredentials. - The type of native credentials to set. + The type of native credentials to set. - A pointer to native credentials. + A pointer to native credentials. - Tries to set the UNIX user identifier on @credentials. This method + Tries to set the UNIX user identifier on @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the @@ -9908,32 +10230,32 @@ about the UNIX user. It can also fail if the OS does not allow the use of "spoofed" credentials. - %TRUE if @uid was set, %FALSE if error is set. + %TRUE if @uid was set, %FALSE if error is set. - A #GCredentials. + A #GCredentials. - The UNIX user identifier to set. + The UNIX user identifier to set. - Creates a human-readable textual representation of @credentials + Creates a human-readable textual representation of @credentials that can be used in logging and debug messages. The format of the returned string may change in future GLib release. - A string that should be freed with g_free(). + A string that should be freed with g_free(). - A #GCredentials object. + A #GCredentials object. @@ -9944,34 +10266,321 @@ returned string may change in future GLib release. - Enumeration describing different kinds of native credential types. + Enumeration describing different kinds of native credential types. - Indicates an invalid native credential type. + Indicates an invalid native credential type. - The native credentials type is a struct ucred. + The native credentials type is a struct ucred. - The native credentials type is a struct cmsgcred. + The native credentials type is a struct cmsgcred. - The native credentials type is a struct sockpeercred. Added in 2.30. + The native credentials type is a struct sockpeercred. Added in 2.30. - The native credentials type is a ucred_t. Added in 2.40. + The native credentials type is a ucred_t. Added in 2.40. - The native credentials type is a struct unpcbid. + The native credentials type is a struct unpcbid. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - #GDBusActionGroup is an implementation of the #GActionGroup + #GDBusActionGroup is an implementation of the #GActionGroup interface that can be used as a proxy for an action group that is exported over D-Bus with g_dbus_connection_export_action_group(). - Obtains a #GDBusActionGroup for the action group which is exported at + Obtains a #GDBusActionGroup for the action group which is exported at the given @bus_name and @object_path. The thread default main context is taken at the time of this call. @@ -9986,21 +10595,21 @@ for the action group to monitor for changes and then to call g_action_group_list_actions() to get the initial list. - a #GDBusActionGroup + a #GDBusActionGroup - A #GDBusConnection + A #GDBusConnection - the bus name which exports the action + the bus name which exports the action group or %NULL if @connection is not a message bus connection - the object path at which the action group is exported + the object path at which the action group is exported @@ -10028,22 +10637,22 @@ g_action_group_list_actions() to get the initial list. - If @info is statically allocated does nothing. Otherwise increases + If @info is statically allocated does nothing. Otherwise increases the reference count. - The same @info. + The same @info. - A #GDBusNodeInfo + A #GDBusNodeInfo - If @info is statically allocated, does nothing. Otherwise decreases + If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -10052,29 +10661,29 @@ the memory used is freed. - A #GDBusAnnotationInfo. + A #GDBusAnnotationInfo. - Looks up the value of an annotation. + Looks up the value of an annotation. The cost of this function is O(n) in number of annotations. - The value or %NULL if not found. Do not free, it is owned by @annotations. + The value or %NULL if not found. Do not free, it is owned by @annotations. - A %NULL-terminated array of annotations or %NULL. + A %NULL-terminated array of annotations or %NULL. - The name of the annotation to look up. + The name of the annotation to look up. @@ -10102,22 +10711,22 @@ The cost of this function is O(n) in number of annotations. - If @info is statically allocated does nothing. Otherwise increases + If @info is statically allocated does nothing. Otherwise increases the reference count. - The same @info. + The same @info. - A #GDBusArgInfo + A #GDBusArgInfo - If @info is statically allocated, does nothing. Otherwise decreases + If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -10126,24 +10735,50 @@ the memory used is freed. - A #GDBusArgInfo. + A #GDBusArgInfo. - The #GDBusAuthObserver type provides a mechanism for participating + The #GDBusAuthObserver type provides a mechanism for participating in how a #GDBusServer (or a #GDBusConnection) authenticates remote peers. Simply instantiate a #GDBusAuthObserver and connect to the signals you are interested in. Note that new signals may be added in the future -## Controlling Authentication # {#auth-observer} +## Controlling Authentication Mechanisms -For example, if you only want to allow D-Bus connections from -processes owned by the same uid as the server, you would use a -signal handler like the following: +By default, a #GDBusServer or server-side #GDBusConnection will allow +any authentication mechanism to be used. If you only +want to allow D-Bus connections with the `EXTERNAL` mechanism, +which makes use of credentials passing and is the recommended +mechanism for modern Unix platforms such as Linux and the BSD family, +you would use a signal handler like this: + +|[<!-- language="C" --> +static gboolean +on_allow_mechanism (GDBusAuthObserver *observer, + const gchar *mechanism, + gpointer user_data) +{ + if (g_strcmp0 (mechanism, "EXTERNAL") == 0) + { + return TRUE; + } + + return FALSE; +} +]| + +## Controlling Authorization # {#auth-observer} + +By default, a #GDBusServer or server-side #GDBusConnection will accept +connections from any successfully authenticated user (but not from +anonymous connections using the `ANONYMOUS` mechanism). If you only +want to allow D-Bus connections from processes owned by the same uid +as the server, you would use a signal handler like the following: |[<!-- language="C" --> static gboolean @@ -10168,49 +10803,49 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, } ]| - Creates a new #GDBusAuthObserver object. + Creates a new #GDBusAuthObserver object. - A #GDBusAuthObserver. Free with g_object_unref(). + A #GDBusAuthObserver. Free with g_object_unref(). - Emits the #GDBusAuthObserver::allow-mechanism signal on @observer. + Emits the #GDBusAuthObserver::allow-mechanism signal on @observer. - %TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. + %TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. - A #GDBusAuthObserver. + A #GDBusAuthObserver. - The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. + The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. - Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer. + Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer. - %TRUE if the peer is authorized, %FALSE if not. + %TRUE if the peer is authorized, %FALSE if not. - A #GDBusAuthObserver. + A #GDBusAuthObserver. - A #GIOStream for the #GDBusConnection. + A #GIOStream for the #GDBusConnection. - Credentials received from the peer or %NULL. + Credentials received from the peer or %NULL. @@ -10248,35 +10883,35 @@ is authorized. - Flags used in g_dbus_connection_call() and similar APIs. + Flags used in g_dbus_connection_call() and similar APIs. - No flags set. + No flags set. - The bus must not launch + The bus must not launch an owner for the destination name in response to this method invocation. - the caller is prepared to + the caller is prepared to wait for interactive authorization. Since 2.46. - Capabilities negotiated with the remote peer. + Capabilities negotiated with the remote peer. - No flags set. + No flags set. - The connection + The connection supports exchanging UNIX file descriptors with the remote peer. - The #GDBusConnection type is used for D-Bus connections to remote + The #GDBusConnection type is used for D-Bus connections to remote peers such as a message buses. It is a low-level API that offers a lot of flexibility. For instance, it lets you establish a connection -over any transport that can by represented as an #GIOStream. +over any transport that can by represented as a #GIOStream. This class is rarely used directly in D-Bus clients. If you are writing a D-Bus client, it is often easier to use the g_bus_own_name(), @@ -10325,39 +10960,39 @@ Here is an example for exporting a #GObject: - Finishes an operation started with g_dbus_connection_new(). + Finishes an operation started with g_dbus_connection_new(). - a #GDBusConnection or %NULL if @error is set. Free + a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). - a #GAsyncResult obtained from the #GAsyncReadyCallback + a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new(). - Finishes an operation started with g_dbus_connection_new_for_address(). + Finishes an operation started with g_dbus_connection_new_for_address(). - a #GDBusConnection or %NULL if @error is set. Free with + a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). - a #GAsyncResult obtained from the #GAsyncReadyCallback passed + a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new() - Synchronously connects and sets up a D-Bus client connection for + Synchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by @address which must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -10375,31 +11010,31 @@ If @observer is not %NULL it may be used to control the authentication process. - a #GDBusConnection or %NULL if @error is set. Free with + a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). - a D-Bus address + a D-Bus address - flags describing how to make the connection + flags describing how to make the connection - a #GDBusAuthObserver or %NULL + a #GDBusAuthObserver or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - Synchronously sets up a D-Bus connection for exchanging D-Bus messages + Synchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. If @stream is a #GSocketConnection, then the corresponding #GSocket @@ -10416,34 +11051,34 @@ This is a synchronous failable constructor. See g_dbus_connection_new() for the asynchronous version. - a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). + a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). - a #GIOStream + a #GIOStream - the GUID to use if a authenticating as a server or %NULL + the GUID to use if a authenticating as a server or %NULL - flags describing how to make the connection + flags describing how to make the connection - a #GDBusAuthObserver or %NULL + a #GDBusAuthObserver or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - Asynchronously sets up a D-Bus connection for exchanging D-Bus messages + Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. If @stream is a #GSocketConnection, then the corresponding #GSocket @@ -10460,7 +11095,7 @@ When the operation is finished, @callback will be invoked. You can then call g_dbus_connection_new_finish() to get the result of the operation. -This is a asynchronous failable constructor. See +This is an asynchronous failable constructor. See g_dbus_connection_new_sync() for the synchronous version. @@ -10469,37 +11104,37 @@ version. - a #GIOStream + a #GIOStream - the GUID to use if a authenticating as a server or %NULL + the GUID to use if a authenticating as a server or %NULL - flags describing how to make the connection + flags describing how to make the connection - a #GDBusAuthObserver or %NULL + a #GDBusAuthObserver or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to @callback + the data to pass to @callback - Asynchronously connects and sets up a D-Bus client connection for + Asynchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by @address which must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -10511,13 +11146,13 @@ server. In particular, @flags cannot contain the %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags. When the operation is finished, @callback will be invoked. You can -then call g_dbus_connection_new_finish() to get the result of the -operation. +then call g_dbus_connection_new_for_address_finish() to get the result of +the operation. If @observer is not %NULL it may be used to control the authentication process. -This is a asynchronous failable constructor. See +This is an asynchronous failable constructor. See g_dbus_connection_new_for_address_sync() for the synchronous version. @@ -10526,33 +11161,33 @@ version. - a D-Bus address + a D-Bus address - flags describing how to make the connection + flags describing how to make the connection - a #GDBusAuthObserver or %NULL + a #GDBusAuthObserver or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to @callback + the data to pass to @callback - Adds a message filter. Filters are handlers that are run on all + Adds a message filter. Filters are handlers that are run on all incoming and outgoing messages, prior to standard dispatch. Filters are run in the order that they were added. The same handler can be added as a filter more than once, in which case it will be run more @@ -10581,32 +11216,32 @@ filter is removed, and may be called after @connection has been destroyed.) - a filter identifier that can be used with + a filter identifier that can be used with g_dbus_connection_remove_filter() - a #GDBusConnection + a #GDBusConnection - a filter function + a filter function - user data to pass to @filter_function + user data to pass to @filter_function - function to free @user_data with when filter + function to free @user_data with when filter is removed or %NULL - Asynchronously invokes the @method_name method on the + Asynchronously invokes the @method_name method on the @interface_name D-Bus interface on the remote object at @object_path owned by @bus_name. @@ -10657,82 +11292,82 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. - a #GDBusConnection + a #GDBusConnection - a unique or well-known bus name or %NULL if + a unique or well-known bus name or %NULL if @connection is not a message bus connection - path of remote object + path of remote object - D-Bus interface to invoke method on + D-Bus interface to invoke method on - the name of the method to invoke + the name of the method to invoke - a #GVariant tuple with parameters for the method + a #GVariant tuple with parameters for the method or %NULL if not passing parameters - the expected type of the reply (which will be a + the expected type of the reply (which will be a tuple), or %NULL - flags from the #GDBusCallFlags enumeration + flags from the #GDBusCallFlags enumeration - the timeout in milliseconds, -1 to use the default + the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the request + a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation - the data to pass to @callback + the data to pass to @callback - Finishes an operation started with g_dbus_connection_call(). + Finishes an operation started with g_dbus_connection_call(). - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - a #GDBusConnection + a #GDBusConnection - a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call() + a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call() - Synchronously invokes the @method_name method on the + Synchronously invokes the @method_name method on the @interface_name D-Bus interface on the remote object at @object_path owned by @bus_name. @@ -10770,58 +11405,58 @@ g_dbus_connection_call() for the asynchronous version of this method. - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - a #GDBusConnection + a #GDBusConnection - a unique or well-known bus name or %NULL if + a unique or well-known bus name or %NULL if @connection is not a message bus connection - path of remote object + path of remote object - D-Bus interface to invoke method on + D-Bus interface to invoke method on - the name of the method to invoke + the name of the method to invoke - a #GVariant tuple with parameters for the method + a #GVariant tuple with parameters for the method or %NULL if not passing parameters - the expected type of the reply, or %NULL + the expected type of the reply, or %NULL - flags from the #GDBusCallFlags enumeration + flags from the #GDBusCallFlags enumeration - the timeout in milliseconds, -1 to use the default + the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout - a #GCancellable or %NULL + a #GCancellable or %NULL - Like g_dbus_connection_call() but also takes a #GUnixFDList object. + Like g_dbus_connection_call() but also takes a #GUnixFDList object. This method is only available on UNIX. @@ -10830,154 +11465,154 @@ This method is only available on UNIX. - a #GDBusConnection + a #GDBusConnection - a unique or well-known bus name or %NULL if + a unique or well-known bus name or %NULL if @connection is not a message bus connection - path of remote object + path of remote object - D-Bus interface to invoke method on + D-Bus interface to invoke method on - the name of the method to invoke + the name of the method to invoke - a #GVariant tuple with parameters for the method + a #GVariant tuple with parameters for the method or %NULL if not passing parameters - the expected type of the reply, or %NULL + the expected type of the reply, or %NULL - flags from the #GDBusCallFlags enumeration + flags from the #GDBusCallFlags enumeration - the timeout in milliseconds, -1 to use the default + the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout - a #GUnixFDList or %NULL + a #GUnixFDList or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the request is + a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't * care about the result of the method invocation - The data to pass to @callback. + The data to pass to @callback. - Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). + Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - a #GDBusConnection + a #GDBusConnection - return location for a #GUnixFDList or %NULL + return location for a #GUnixFDList or %NULL - a #GAsyncResult obtained from the #GAsyncReadyCallback passed to + a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list() - Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. + Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. This method is only available on UNIX. - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - a #GDBusConnection + a #GDBusConnection - a unique or well-known bus name or %NULL + a unique or well-known bus name or %NULL if @connection is not a message bus connection - path of remote object + path of remote object - D-Bus interface to invoke method on + D-Bus interface to invoke method on - the name of the method to invoke + the name of the method to invoke - a #GVariant tuple with parameters for + a #GVariant tuple with parameters for the method or %NULL if not passing parameters - the expected type of the reply, or %NULL + the expected type of the reply, or %NULL - flags from the #GDBusCallFlags enumeration + flags from the #GDBusCallFlags enumeration - the timeout in milliseconds, -1 to use the default + the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout - a #GUnixFDList or %NULL + a #GUnixFDList or %NULL - return location for a #GUnixFDList or %NULL + return location for a #GUnixFDList or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - Closes @connection. Note that this never causes the process to + Closes @connection. Note that this never causes the process to exit (this might only happen if the other end of a shared message bus connection disconnects, see #GDBusConnection:exit-on-close). @@ -11007,66 +11642,66 @@ version. - a #GDBusConnection + a #GDBusConnection - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the request is + a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result - The data to pass to @callback + The data to pass to @callback - Finishes an operation started with g_dbus_connection_close(). + Finishes an operation started with g_dbus_connection_close(). - %TRUE if the operation succeeded, %FALSE if @error is set + %TRUE if the operation succeeded, %FALSE if @error is set - a #GDBusConnection + a #GDBusConnection - a #GAsyncResult obtained from the #GAsyncReadyCallback passed + a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close() - Synchronously closes @connection. The calling thread is blocked + Synchronously closes @connection. The calling thread is blocked until this is done. See g_dbus_connection_close() for the asynchronous version of this method and more details about what it does. - %TRUE if the operation succeeded, %FALSE if @error is set + %TRUE if the operation succeeded, %FALSE if @error is set - a #GDBusConnection + a #GDBusConnection - a #GCancellable or %NULL + a #GCancellable or %NULL - Emits a signal. + Emits a signal. If the parameters GVariant is floating, it is consumed. @@ -11075,40 +11710,40 @@ This can only fail if @parameters is not compatible with the D-Bus protocol (%G_IO_ERROR_CLOSED). - %TRUE unless @error is set + %TRUE unless @error is set - a #GDBusConnection + a #GDBusConnection - the unique bus name for the destination + the unique bus name for the destination for the signal or %NULL to emit to all listeners - path of remote object + path of remote object - D-Bus interface to emit a signal on + D-Bus interface to emit a signal on - the name of the signal to emit + the name of the signal to emit - a #GVariant tuple with parameters for the signal + a #GVariant tuple with parameters for the signal or %NULL if not passing parameters - Exports @action_group on @connection at @object_path. + Exports @action_group on @connection at @object_path. The implemented D-Bus API should be considered private. It is subject to change in the future. @@ -11131,26 +11766,26 @@ limits a given action group to being exported from only one main context. - the ID of the export (never zero), or 0 in case of failure + the ID of the export (never zero), or 0 in case of failure - a #GDBusConnection + a #GDBusConnection - a D-Bus object path + a D-Bus object path - a #GActionGroup + a #GActionGroup - Exports @menu on @connection at @object_path. + Exports @menu on @connection at @object_path. The implemented D-Bus API should be considered private. It is subject to change in the future. @@ -11164,26 +11799,26 @@ g_dbus_connection_unexport_menu_model() with the return value of this function. - the ID of the export (never zero), or 0 in case of failure + the ID of the export (never zero), or 0 in case of failure - a #GDBusConnection + a #GDBusConnection - a D-Bus object path + a D-Bus object path - a #GMenuModel + a #GMenuModel - Asynchronously flushes @connection, that is, writes all queued + Asynchronously flushes @connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using g_output_stream_flush_async()). This is useful in programs that wants to emit a D-Bus signal and then exit immediately. Without @@ -11201,55 +11836,6 @@ version. - - - a #GDBusConnection - - - - a #GCancellable or %NULL - - - - a #GAsyncReadyCallback to call when the - request is satisfied or %NULL if you don't care about the result - - - - The data to pass to @callback - - - - - - Finishes an operation started with g_dbus_connection_flush(). - - - %TRUE if the operation succeeded, %FALSE if @error is set - - - - - a #GDBusConnection - - - - a #GAsyncResult obtained from the #GAsyncReadyCallback passed - to g_dbus_connection_flush() - - - - - - Synchronously flushes @connection. The calling thread is blocked -until this is done. See g_dbus_connection_flush() for the -asynchronous version of this method and more details about what it -does. - - - %TRUE if the operation succeeded, %FALSE if @error is set - - a #GDBusConnection @@ -11259,30 +11845,22 @@ does. a #GCancellable or %NULL + + a #GAsyncReadyCallback to call when the + request is satisfied or %NULL if you don't care about the result + + + + The data to pass to @callback + + - - Gets the capabilities negotiated with the remote peer - + + Finishes an operation started with g_dbus_connection_flush(). + - zero or more flags from the #GDBusCapabilityFlags enumeration - - - - - a #GDBusConnection - - - - - - Gets whether the process is terminated when @connection is -closed by the remote peer. See -#GDBusConnection:exit-on-close for more details. - - - whether the process is terminated when @connection is - closed by the remote peer + %TRUE if the operation succeeded, %FALSE if @error is set @@ -11290,59 +11868,116 @@ closed by the remote peer. See a #GDBusConnection + + a #GAsyncResult obtained from the #GAsyncReadyCallback passed + to g_dbus_connection_flush() + + - - Gets the flags used to construct this connection - + + Synchronously flushes @connection. The calling thread is blocked +until this is done. See g_dbus_connection_flush() for the +asynchronous version of this method and more details about what it +does. + - zero or more flags from the #GDBusConnectionFlags enumeration - + %TRUE if the operation succeeded, %FALSE if @error is set + a #GDBusConnection + + a #GCancellable or %NULL + + + + + + Gets the capabilities negotiated with the remote peer + + + zero or more flags from the #GDBusCapabilityFlags enumeration + + + + + a #GDBusConnection + + + + + + Gets whether the process is terminated when @connection is +closed by the remote peer. See +#GDBusConnection:exit-on-close for more details. + + + whether the process is terminated when @connection is + closed by the remote peer + + + + + a #GDBusConnection + + + + + + Gets the flags used to construct this connection + + + zero or more flags from the #GDBusConnectionFlags enumeration + + + + + a #GDBusConnection + + - The GUID of the peer performing the role of server when + The GUID of the peer performing the role of server when authenticating. See #GDBusConnection:guid for more details. - The GUID. Do not free this string, it is owned by + The GUID. Do not free this string, it is owned by @connection. - a #GDBusConnection + a #GDBusConnection - Retrieves the last serial number assigned to a #GDBusMessage on + Retrieves the last serial number assigned to a #GDBusMessage on the current thread. This includes messages sent via both low-level API such as g_dbus_connection_send_message() as well as high-level API such as g_dbus_connection_emit_signal(), g_dbus_connection_call() or g_dbus_proxy_call(). - the last used serial or zero when no message has been sent + the last used serial or zero when no message has been sent within the current thread - a #GDBusConnection + a #GDBusConnection - Gets the credentials of the authenticated peer. This will always + Gets the credentials of the authenticated peer. This will always return %NULL unless @connection acted as a server (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed) when set up and the client passed credentials as part of the @@ -11353,69 +11988,69 @@ each application is a client. So this method will always return %NULL for message bus clients. - a #GCredentials or %NULL if not + a #GCredentials or %NULL if not available. Do not free this object, it is owned by @connection. - a #GDBusConnection + a #GDBusConnection - Gets the underlying stream used for IO. + Gets the underlying stream used for IO. While the #GDBusConnection is active, it will interact with this stream from a worker thread, so it is not safe to interact with the stream directly. - the stream used for IO + the stream used for IO - a #GDBusConnection + a #GDBusConnection - Gets the unique name of @connection as assigned by the message + Gets the unique name of @connection as assigned by the message bus. This can also be used to figure out if @connection is a message bus connection. - the unique name or %NULL if @connection is not a message + the unique name or %NULL if @connection is not a message bus connection. Do not free this string, it is owned by @connection. - a #GDBusConnection + a #GDBusConnection - Gets whether @connection is closed. + Gets whether @connection is closed. - %TRUE if the connection is closed, %FALSE otherwise + %TRUE if the connection is closed, %FALSE otherwise - a #GDBusConnection + a #GDBusConnection - Registers callbacks for exported objects at @object_path with the + Registers callbacks for exported objects at @object_path with the D-Bus interface that is described in @interface_info. Calls to functions in @vtable (and @user_data_free_func) will happen @@ -11455,75 +12090,75 @@ as the object is exported. Also note that @vtable will be copied. See this [server][gdbus-server] for an example of how to use this method. - 0 if @error is set, otherwise a registration id (never 0) + 0 if @error is set, otherwise a registration id (never 0) that can be used with g_dbus_connection_unregister_object() - a #GDBusConnection + a #GDBusConnection - the object path to register at + the object path to register at - introspection data for the interface + introspection data for the interface - a #GDBusInterfaceVTable to call into or %NULL + a #GDBusInterfaceVTable to call into or %NULL - data to pass to functions in @vtable + data to pass to functions in @vtable - function to call when the object path is unregistered + function to call when the object path is unregistered - Version of g_dbus_connection_register_object() using closures instead of a + Version of g_dbus_connection_register_object() using closures instead of a #GDBusInterfaceVTable for easier binding in other languages. - 0 if @error is set, otherwise a registration id (never 0) + 0 if @error is set, otherwise a registration id (never 0) that can be used with g_dbus_connection_unregister_object() . - A #GDBusConnection. + A #GDBusConnection. - The object path to register at. + The object path to register at. - Introspection data for the interface. + Introspection data for the interface. - #GClosure for handling incoming method calls. + #GClosure for handling incoming method calls. - #GClosure for getting a property. + #GClosure for getting a property. - #GClosure for setting a property. + #GClosure for setting a property. - Registers a whole subtree of dynamic objects. + Registers a whole subtree of dynamic objects. The @enumerate and @introspection functions in @vtable are used to convey, to remote callers, what nodes exist in the subtree rooted @@ -11559,40 +12194,40 @@ See this [server][gdbus-subtree-server] for an example of how to use this method. - 0 if @error is set, otherwise a subtree registration id (never 0) + 0 if @error is set, otherwise a subtree registration id (never 0) that can be used with g_dbus_connection_unregister_subtree() . - a #GDBusConnection + a #GDBusConnection - the object path to register the subtree at + the object path to register the subtree at - a #GDBusSubtreeVTable to enumerate, introspect and + a #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree - flags used to fine tune the behavior of the subtree + flags used to fine tune the behavior of the subtree - data to pass to functions in @vtable + data to pass to functions in @vtable - function to call when the subtree is unregistered + function to call when the subtree is unregistered - Removes a filter. + Removes a filter. Note that since filters run in a different thread, there is a race condition where it is possible that the filter will be running even @@ -11606,17 +12241,17 @@ called when it is guaranteed that the data is no longer needed. - a #GDBusConnection + a #GDBusConnection - an identifier obtained from g_dbus_connection_add_filter() + an identifier obtained from g_dbus_connection_add_filter() - Asynchronously sends @message to the peer represented by @connection. + Asynchronously sends @message to the peer represented by @connection. Unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number @@ -11637,32 +12272,32 @@ Note that @message must be unlocked, unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag. - %TRUE if the message was well-formed and queued for + %TRUE if the message was well-formed and queued for transmission, %FALSE if @error is set - a #GDBusConnection + a #GDBusConnection - a #GDBusMessage + a #GDBusMessage - flags affecting how the message is sent + flags affecting how the message is sent - return location for serial number assigned + return location for serial number assigned to @message when sending it or %NULL - Asynchronously sends @message to the peer represented by @connection. + Asynchronously sends @message to the peer represented by @connection. Unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number @@ -11695,44 +12330,44 @@ UNIX file descriptors. - a #GDBusConnection + a #GDBusConnection - a #GDBusMessage + a #GDBusMessage - flags affecting how the message is sent + flags affecting how the message is sent - the timeout in milliseconds, -1 to use the default + the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout - return location for serial number assigned + return location for serial number assigned to @message when sending it or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the request + a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result - The data to pass to @callback + The data to pass to @callback - Finishes an operation started with g_dbus_connection_send_message_with_reply(). + Finishes an operation started with g_dbus_connection_send_message_with_reply(). Note that @error is only set if a local in-process error occurred. That is to say that the returned #GDBusMessage object may @@ -11744,23 +12379,23 @@ for an example of how to use this low-level API to send and receive UNIX file descriptors. - a locked #GDBusMessage or %NULL if @error is set + a locked #GDBusMessage or %NULL if @error is set - a #GDBusConnection + a #GDBusConnection - a #GAsyncResult obtained from the #GAsyncReadyCallback passed to + a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply() - Synchronously sends @message to the peer represented by @connection + Synchronously sends @message to the peer represented by @connection and blocks the calling thread until a reply is received or the timeout is reached. See g_dbus_connection_send_message_with_reply() for the asynchronous version of this method. @@ -11790,47 +12425,47 @@ Note that @message must be unlocked, unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag. - a locked #GDBusMessage that is the reply + a locked #GDBusMessage that is the reply to @message or %NULL if @error is set - a #GDBusConnection + a #GDBusConnection - a #GDBusMessage + a #GDBusMessage - flags affecting how the message is sent. + flags affecting how the message is sent. - the timeout in milliseconds, -1 to use the default + the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout - return location for serial number + return location for serial number assigned to @message when sending it or %NULL - a #GCancellable or %NULL + a #GCancellable or %NULL - Sets whether the process should be terminated when @connection is + Sets whether the process should be terminated when @connection is closed by the remote peer. See #GDBusConnection:exit-on-close for more details. Note that this function should be used with care. Most modern UNIX -desktops tie the notion of a user session the session bus, and expect -all of a users applications to quit when their bus connection goes away. +desktops tie the notion of a user session with the session bus, and expect +all of a user's applications to quit when their bus connection goes away. If you are setting @exit_on_close to %FALSE for the shared session bus connection, you should make sure that your application exits when the user session ends. @@ -11840,18 +12475,18 @@ when the user session ends. - a #GDBusConnection + a #GDBusConnection - whether the process should be terminated + whether the process should be terminated when @connection is closed by the remote peer - Subscribes to signals on @connection and invokes @callback with a whenever + Subscribes to signals on @connection and invokes @callback with a whenever the signal is received. Note that @callback will be invoked in the [thread-default main context][g-main-context-push-thread-default] of the thread you are calling this method from. @@ -11884,79 +12519,79 @@ to never be zero. This function can never fail. - a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe() + a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe() - a #GDBusConnection + a #GDBusConnection - sender name to match on (unique or well-known name) + sender name to match on (unique or well-known name) or %NULL to listen from all senders - D-Bus interface name to match on or %NULL to + D-Bus interface name to match on or %NULL to match on all interfaces - D-Bus signal name to match on or %NULL to match on + D-Bus signal name to match on or %NULL to match on all signals - object path to match on or %NULL to match on + object path to match on or %NULL to match on all object paths - contents of first string argument to match on or %NULL + contents of first string argument to match on or %NULL to match on all kinds of arguments - #GDBusSignalFlags describing how arg0 is used in subscribing to the + #GDBusSignalFlags describing how arg0 is used in subscribing to the signal - callback to invoke when there is a signal matching the requested data + callback to invoke when there is a signal matching the requested data - user data to pass to @callback + user data to pass to @callback - function to free @user_data with when + function to free @user_data with when subscription is removed or %NULL - Unsubscribes from signals. + Unsubscribes from signals. - a #GDBusConnection + a #GDBusConnection - a subscription id obtained from + a subscription id obtained from g_dbus_connection_signal_subscribe() - If @connection was created with + If @connection was created with %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method starts processing messages. Does nothing on if @connection wasn't created with this flag or if the method has already been called. @@ -11966,13 +12601,13 @@ created with this flag or if the method has already been called. - a #GDBusConnection + a #GDBusConnection - Reverses the effect of a previous call to + Reverses the effect of a previous call to g_dbus_connection_export_action_group(). It is an error to call this function with an ID that wasn't returned @@ -11984,17 +12619,17 @@ same ID more than once. - a #GDBusConnection + a #GDBusConnection - the ID from g_dbus_connection_export_action_group() + the ID from g_dbus_connection_export_action_group() - Reverses the effect of a previous call to + Reverses the effect of a previous call to g_dbus_connection_export_menu_model(). It is an error to call this function with an ID that wasn't returned @@ -12006,48 +12641,48 @@ same ID more than once. - a #GDBusConnection + a #GDBusConnection - the ID from g_dbus_connection_export_menu_model() + the ID from g_dbus_connection_export_menu_model() - Unregisters an object. + Unregisters an object. - %TRUE if the object was unregistered, %FALSE otherwise + %TRUE if the object was unregistered, %FALSE otherwise - a #GDBusConnection + a #GDBusConnection - a registration id obtained from + a registration id obtained from g_dbus_connection_register_object() - Unregisters a subtree. + Unregisters a subtree. - %TRUE if the subtree was unregistered, %FALSE otherwise + %TRUE if the subtree was unregistered, %FALSE otherwise - a #GDBusConnection + a #GDBusConnection - a subtree registration id obtained from + a subtree registration id obtained from g_dbus_connection_register_subtree() @@ -12150,179 +12785,179 @@ once. - Flags used when creating a new #GDBusConnection. + Flags used when creating a new #GDBusConnection. - No flags set. + No flags set. - Perform authentication against server. + Perform authentication against server. - Perform authentication against client. + Perform authentication against client. - When + When authenticating as a server, allow the anonymous authentication method. - Pass this flag if connecting to a peer that is a + Pass this flag if connecting to a peer that is a message bus. This means that the Hello() method will be invoked as part of the connection setup. - If set, processing of D-Bus messages is + If set, processing of D-Bus messages is delayed until g_dbus_connection_start_message_processing() is called. - Error codes for the %G_DBUS_ERROR error domain. + Error codes for the %G_DBUS_ERROR error domain. - A generic error; "something went wrong" - see the error message for + A generic error; "something went wrong" - see the error message for more. - There was not enough memory to complete an operation. + There was not enough memory to complete an operation. - The bus doesn't know how to launch a service to supply the bus name + The bus doesn't know how to launch a service to supply the bus name you wanted. - The bus name you referenced doesn't exist (i.e. no application owns + The bus name you referenced doesn't exist (i.e. no application owns it). - No reply to a message expecting one, usually means a timeout occurred. + No reply to a message expecting one, usually means a timeout occurred. - Something went wrong reading or writing to a socket, for example. + Something went wrong reading or writing to a socket, for example. - A D-Bus bus address was malformed. + A D-Bus bus address was malformed. - Requested operation isn't supported (like ENOSYS on UNIX). + Requested operation isn't supported (like ENOSYS on UNIX). - Some limited resource is exhausted. + Some limited resource is exhausted. - Security restrictions don't allow doing what you're trying to do. + Security restrictions don't allow doing what you're trying to do. - Authentication didn't work. + Authentication didn't work. - Unable to connect to server (probably caused by ECONNREFUSED on a + Unable to connect to server (probably caused by ECONNREFUSED on a socket). - Certain timeout errors, possibly ETIMEDOUT on a socket. Note that + Certain timeout errors, possibly ETIMEDOUT on a socket. Note that %G_DBUS_ERROR_NO_REPLY is used for message reply timeouts. Warning: this is confusingly-named given that %G_DBUS_ERROR_TIMED_OUT also exists. We can't fix it for compatibility reasons so just be careful. - No network access (probably ENETUNREACH on a socket). + No network access (probably ENETUNREACH on a socket). - Can't bind a socket since its address is in use (i.e. EADDRINUSE). + Can't bind a socket since its address is in use (i.e. EADDRINUSE). - The connection is disconnected and you're trying to use it. + The connection is disconnected and you're trying to use it. - Invalid arguments passed to a method call. + Invalid arguments passed to a method call. - Missing file. + Missing file. - Existing file and the operation you're using does not silently overwrite. + 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. + Method name you invoked isn't known by the object you invoked it on. - Certain timeout errors, e.g. while starting a service. Warning: this is + Certain timeout errors, e.g. while starting a service. Warning: this is confusingly-named given that %G_DBUS_ERROR_TIMEOUT also exists. We can't fix it for compatibility reasons so just be careful. - Tried to remove or modify a match rule that didn't exist. + Tried to remove or modify a match rule that didn't exist. - The match rule isn't syntactically valid. + The match rule isn't syntactically valid. - While starting a new process, the exec() call failed. + While starting a new process, the exec() call failed. - While starting a new process, the fork() call failed. + While starting a new process, the fork() call failed. - While starting a new process, the child exited with a status code. + While starting a new process, the child exited with a status code. - While starting a new process, the child exited on a signal. + While starting a new process, the child exited on a signal. - While starting a new process, something went wrong. + While starting a new process, something went wrong. - We failed to setup the environment correctly. + We failed to setup the environment correctly. - We failed to setup the config parser correctly. + We failed to setup the config parser correctly. - Bus name was not valid. + Bus name was not valid. - Service file not found in system-services directory. + Service file not found in system-services directory. - Permissions are incorrect on the setuid helper. + Permissions are incorrect on the setuid helper. - Service file invalid (Name, User or Exec missing). + Service file invalid (Name, User or Exec missing). - Tried to get a UNIX process ID and it wasn't available. + Tried to get a UNIX process ID and it wasn't available. - Tried to get a UNIX process ID and it wasn't available. + Tried to get a UNIX process ID and it wasn't available. - A type signature is not valid. + A type signature is not valid. - A file contains invalid syntax or is otherwise broken. + A file contains invalid syntax or is otherwise broken. - Asked for SELinux security context and it wasn't available. + Asked for SELinux security context and it wasn't available. - Asked for ADT audit data and it wasn't available. + Asked for ADT audit data and it wasn't available. - There's already an object with the requested object path. + There's already an object with the requested object path. - Object you invoked a method on isn't known. Since 2.42 + 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 + 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 access isn't known by the object. Since 2.42 - Property you tried to set is read-only. Since 2.42 + Property you tried to set is read-only. Since 2.42 - Creates a D-Bus error name to use for @error. If @error matches + Creates a D-Bus error name to use for @error. If @error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned. @@ -12335,18 +12970,18 @@ This function is typically only used in object mappings to put a #GError on the wire. Regular applications should not use it. - A D-Bus error name (never %NULL). Free with g_free(). + A D-Bus error name (never %NULL). Free with g_free(). - A #GError. + A #GError. - Gets the D-Bus error name used for @error, if any. + Gets the D-Bus error name used for @error, if any. This function is guaranteed to return a D-Bus error name for all #GErrors returned from functions handling remote method calls @@ -12354,35 +12989,35 @@ This function is guaranteed to return a D-Bus error name for all g_dbus_error_strip_remote_error() has been used on @error. - an allocated string or %NULL if the D-Bus error name + an allocated string or %NULL if the D-Bus error name could not be found. Free with g_free(). - a #GError + a #GError - Checks if @error represents an error received via D-Bus from a remote peer. If so, + Checks if @error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error. - %TRUE if @error represents an error from a remote peer, + %TRUE if @error represents an error from a remote peer, %FALSE otherwise. - A #GError. + A #GError. - Creates a #GError based on the contents of @dbus_error_name and + Creates a #GError based on the contents of @dbus_error_name and @dbus_error_message. Errors registered with g_dbus_error_register_error() will be looked @@ -12410,16 +13045,16 @@ This function is typically only used in object mappings to prepare it. - An allocated #GError. Free with g_error_free(). + An allocated #GError. Free with g_error_free(). - D-Bus error name. + D-Bus error name. - D-Bus error message. + D-Bus error message. @@ -12430,61 +13065,61 @@ it. - Creates an association to map between @dbus_error_name and + Creates an association to map between @dbus_error_name and #GErrors specified by @error_domain and @error_code. This is typically done in the routine that returns the #GQuark for an error domain. - %TRUE if the association was created, %FALSE if it already + %TRUE if the association was created, %FALSE if it already exists. - A #GQuark for a error domain. + A #GQuark for a error domain. - An error code. + An error code. - A D-Bus error name. + A D-Bus error name. - Helper function for associating a #GError error domain with D-Bus error names. + Helper function for associating a #GError error domain with D-Bus error names. - The error domain name. + The error domain name. - A pointer where to store the #GQuark. + A pointer where to store the #GQuark. - A pointer to @num_entries #GDBusErrorEntry struct items. + A pointer to @num_entries #GDBusErrorEntry struct items. - Number of items to register. + Number of items to register. - Does nothing if @error is %NULL. Otherwise sets *@error to + Does nothing if @error is %NULL. Otherwise sets *@error to a new #GError created with g_dbus_error_new_for_dbus_error() with @dbus_error_message prepend with @format (unless %NULL). @@ -12493,58 +13128,58 @@ with @dbus_error_message prepend with @format (unless %NULL). - A pointer to a #GError or %NULL. + A pointer to a #GError or %NULL. - D-Bus error name. + D-Bus error name. - D-Bus error message. + D-Bus error message. - printf()-style format to prepend to @dbus_error_message or %NULL. + printf()-style format to prepend to @dbus_error_message or %NULL. - Arguments for @format. + Arguments for @format. - Like g_dbus_error_set_dbus_error() but intended for language bindings. + Like g_dbus_error_set_dbus_error() but intended for language bindings. - A pointer to a #GError or %NULL. + A pointer to a #GError or %NULL. - D-Bus error name. + D-Bus error name. - D-Bus error message. + D-Bus error message. - printf()-style format to prepend to @dbus_error_message or %NULL. + printf()-style format to prepend to @dbus_error_message or %NULL. - Arguments for @format. + Arguments for @format. - Looks for extra information in the error message used to recover + Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in @error will correspond exactly to what was received on the wire. @@ -12552,34 +13187,34 @@ received on the wire. This is typically used when presenting errors to the end user. - %TRUE if information was stripped, %FALSE otherwise. + %TRUE if information was stripped, %FALSE otherwise. - A #GError. + A #GError. - Destroys an association previously set up with g_dbus_error_register_error(). + Destroys an association previously set up with g_dbus_error_register_error(). - %TRUE if the association was destroyed, %FALSE if it wasn't found. + %TRUE if the association was destroyed, %FALSE if it wasn't found. - A #GQuark for a error domain. + A #GQuark for a error domain. - An error code. + An error code. - A D-Bus error name. + A D-Bus error name. @@ -12598,61 +13233,61 @@ This is typically used when presenting errors to the end user. - The #GDBusInterface type is the base type for D-Bus interfaces both + The #GDBusInterface type is the base type for D-Bus interfaces both on the service side (see #GDBusInterfaceSkeleton) and client side (see #GDBusProxy). - Gets the #GDBusObject that @interface_ belongs to, if any. + Gets the #GDBusObject that @interface_ belongs to, if any. - A #GDBusObject or %NULL. The returned + A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). - An exported D-Bus interface. + An exported D-Bus interface. - Gets D-Bus introspection information for the D-Bus interface + Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - A #GDBusInterfaceInfo. Do not free. + A #GDBusInterfaceInfo. Do not free. - An exported D-Bus interface. + An exported D-Bus interface. - Gets the #GDBusObject that @interface_ belongs to, if any. + Gets the #GDBusObject that @interface_ belongs to, if any. It is not safe to use the returned object if @interface_ or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative. - A #GDBusObject or %NULL. The returned + A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. - An exported D-Bus interface + An exported D-Bus interface - Sets the #GDBusObject for @interface_ to @object. + Sets the #GDBusObject for @interface_ to @object. Note that @interface_ will hold a weak reference to @object. @@ -12661,66 +13296,66 @@ Note that @interface_ will hold a weak reference to @object. - An exported D-Bus interface. + An exported D-Bus interface. - A #GDBusObject or %NULL. + A #GDBusObject or %NULL. - Gets the #GDBusObject that @interface_ belongs to, if any. + Gets the #GDBusObject that @interface_ belongs to, if any. - A #GDBusObject or %NULL. The returned + A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). - An exported D-Bus interface. + An exported D-Bus interface. - Gets D-Bus introspection information for the D-Bus interface + Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - A #GDBusInterfaceInfo. Do not free. + A #GDBusInterfaceInfo. Do not free. - An exported D-Bus interface. + An exported D-Bus interface. - Gets the #GDBusObject that @interface_ belongs to, if any. + Gets the #GDBusObject that @interface_ belongs to, if any. It is not safe to use the returned object if @interface_ or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative. - A #GDBusObject or %NULL. The returned + A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. - An exported D-Bus interface + An exported D-Bus interface - Sets the #GDBusObject for @interface_ to @object. + Sets the #GDBusObject for @interface_ to @object. Note that @interface_ will hold a weak reference to @object. @@ -12729,11 +13364,11 @@ Note that @interface_ will hold a weak reference to @object. - An exported D-Bus interface. + An exported D-Bus interface. - A #GDBusObject or %NULL. + A #GDBusObject or %NULL. @@ -12790,12 +13425,12 @@ Note that @interface_ will hold a weak reference to @object. - A #GDBusInterfaceInfo. Do not free. + A #GDBusInterfaceInfo. Do not free. - An exported D-Bus interface. + An exported D-Bus interface. @@ -12805,13 +13440,13 @@ Note that @interface_ will hold a weak reference to @object. - A #GDBusObject or %NULL. The returned + A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. - An exported D-Bus interface + An exported D-Bus interface @@ -12825,11 +13460,11 @@ Note that @interface_ will hold a weak reference to @object. - An exported D-Bus interface. + An exported D-Bus interface. - A #GDBusObject or %NULL. + A #GDBusObject or %NULL. @@ -12839,13 +13474,13 @@ Note that @interface_ will hold a weak reference to @object. - A #GDBusObject or %NULL. The returned + A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). - An exported D-Bus interface. + An exported D-Bus interface. @@ -12888,7 +13523,7 @@ reference should be freed with g_object_unref(). - Builds a lookup-cache to speed up + Builds a lookup-cache to speed up g_dbus_interface_info_lookup_method(), g_dbus_interface_info_lookup_signal() and g_dbus_interface_info_lookup_property(). @@ -12904,13 +13539,13 @@ g_dbus_interface_info_cache_release() is called. - A #GDBusInterfaceInfo. + A #GDBusInterfaceInfo. - Decrements the usage count for the cache for @info built by + Decrements the usage count for the cache for @info built by g_dbus_interface_info_cache_build() (if any) and frees the resources used by the cache if the usage count drops to zero. @@ -12919,13 +13554,13 @@ resources used by the cache if the usage count drops to zero. - A GDBusInterfaceInfo + A GDBusInterfaceInfo - Appends an XML representation of @info (and its children) to @string_builder. + Appends an XML representation of @info (and its children) to @string_builder. This function is typically used for generating introspection XML documents at run-time for handling the @@ -12937,99 +13572,99 @@ method. - A #GDBusNodeInfo + A #GDBusNodeInfo - Indentation level. + Indentation level. - A #GString to to append XML data to. + A #GString to to append XML data to. - Looks up information about a method. + Looks up information about a method. The cost of this function is O(n) in number of methods unless g_dbus_interface_info_cache_build() has been used on @info. - A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info. + A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info. - A #GDBusInterfaceInfo. + A #GDBusInterfaceInfo. - A D-Bus method name (typically in CamelCase) + A D-Bus method name (typically in CamelCase) - Looks up information about a property. + Looks up information about a property. The cost of this function is O(n) in number of properties unless g_dbus_interface_info_cache_build() has been used on @info. - A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info. + A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info. - A #GDBusInterfaceInfo. + A #GDBusInterfaceInfo. - A D-Bus property name (typically in CamelCase). + A D-Bus property name (typically in CamelCase). - Looks up information about a signal. + Looks up information about a signal. The cost of this function is O(n) in number of signals unless g_dbus_interface_info_cache_build() has been used on @info. - A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info. + A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info. - A #GDBusInterfaceInfo. + A #GDBusInterfaceInfo. - A D-Bus signal name (typically in CamelCase) + A D-Bus signal name (typically in CamelCase) - If @info is statically allocated does nothing. Otherwise increases + If @info is statically allocated does nothing. Otherwise increases the reference count. - The same @info. + The same @info. - A #GDBusInterfaceInfo + A #GDBusInterfaceInfo - If @info is statically allocated, does nothing. Otherwise decreases + If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -13038,7 +13673,7 @@ the memory used is freed. - A #GDBusInterfaceInfo. + A #GDBusInterfaceInfo. @@ -13128,11 +13763,11 @@ the memory used is freed. - Abstract base class for D-Bus interfaces on the service side. + Abstract base class for D-Bus interfaces on the service side. - If @interface_ has outstanding changes, request for these changes to be + If @interface_ has outstanding changes, request for these changes to be emitted immediately. For example, an exported D-Bus interface may queue up property @@ -13146,7 +13781,7 @@ for collapsing multiple property changes into one. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. @@ -13166,54 +13801,54 @@ for collapsing multiple property changes into one. - Gets D-Bus introspection information for the D-Bus interface + Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - A #GDBusInterfaceInfo (never %NULL). Do not free. + A #GDBusInterfaceInfo (never %NULL). Do not free. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets all D-Bus properties for @interface_. + Gets all D-Bus properties for @interface_. - A #GVariant of type + A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets the interface vtable for the D-Bus interface implemented by + Gets the interface vtable for the D-Bus interface implemented by @interface_. The returned function pointers should expect @interface_ itself to be passed as @user_data. - A #GDBusInterfaceVTable (never %NULL). + A #GDBusInterfaceVTable (never %NULL). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Exports @interface_ at @object_path on @connection. + Exports @interface_ at @object_path on @connection. This can be called multiple times to export the same @interface_ onto multiple connections however the @object_path provided must be @@ -13222,27 +13857,27 @@ the same for all connections. Use g_dbus_interface_skeleton_unexport() to unexport the object. - %TRUE if the interface was exported on @connection, otherwise %FALSE with + %TRUE if the interface was exported on @connection, otherwise %FALSE with @error set. - The D-Bus interface to export. + The D-Bus interface to export. - A #GDBusConnection to export @interface_ on. + A #GDBusConnection to export @interface_ on. - The path to export the interface at. + The path to export the interface at. - If @interface_ has outstanding changes, request for these changes to be + If @interface_ has outstanding changes, request for these changes to be emitted immediately. For example, an exported D-Bus interface may queue up property @@ -13256,31 +13891,31 @@ for collapsing multiple property changes into one. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets the first connection that @interface_ is exported on, if any. + Gets the first connection that @interface_ is exported on, if any. - A #GDBusConnection or %NULL if @interface_ is + A #GDBusConnection or %NULL if @interface_ is not exported anywhere. Do not free, the object belongs to @interface_. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets a list of the connections that @interface_ is exported on. + Gets a list of the connections that @interface_ is exported on. - A list of + A list of all the connections that @interface_ is exported on. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -13290,125 +13925,125 @@ not exported anywhere. Do not free, the object belongs to @interface_. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior + Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior of @interface_ - One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. + One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets D-Bus introspection information for the D-Bus interface + Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - A #GDBusInterfaceInfo (never %NULL). Do not free. + A #GDBusInterfaceInfo (never %NULL). Do not free. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets the object path that @interface_ is exported on, if any. + Gets the object path that @interface_ is exported on, if any. - A string owned by @interface_ or %NULL if @interface_ is not exported + A string owned by @interface_ or %NULL if @interface_ is not exported anywhere. Do not free, the string belongs to @interface_. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets all D-Bus properties for @interface_. + Gets all D-Bus properties for @interface_. - A #GVariant of type + A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Gets the interface vtable for the D-Bus interface implemented by + Gets the interface vtable for the D-Bus interface implemented by @interface_. The returned function pointers should expect @interface_ itself to be passed as @user_data. - A #GDBusInterfaceVTable (never %NULL). + A #GDBusInterfaceVTable (never %NULL). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Checks if @interface_ is exported on @connection. + Checks if @interface_ is exported on @connection. - %TRUE if @interface_ is exported on @connection, %FALSE otherwise. + %TRUE if @interface_ is exported on @connection, %FALSE otherwise. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - A #GDBusConnection. + A #GDBusConnection. - Sets flags describing what the behavior of @skeleton should be. + Sets flags describing what the behavior of @skeleton should be. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Flags from the #GDBusInterfaceSkeletonFlags enumeration. + Flags from the #GDBusInterfaceSkeletonFlags enumeration. - Stops exporting @interface_ on all connections it is exported on. + Stops exporting @interface_ on all connections it is exported on. To unexport @interface_ from only a single connection, use g_dbus_interface_skeleton_unexport_from_connection() @@ -13418,13 +14053,13 @@ g_dbus_interface_skeleton_unexport_from_connection() - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Stops exporting @interface_ on @connection. + Stops exporting @interface_ on @connection. To stop exporting on all connections the interface is exported on, use g_dbus_interface_skeleton_unexport(). @@ -13434,11 +14069,11 @@ use g_dbus_interface_skeleton_unexport(). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - A #GDBusConnection. + A #GDBusConnection. @@ -13510,12 +14145,12 @@ to was exported in. - A #GDBusInterfaceInfo (never %NULL). Do not free. + A #GDBusInterfaceInfo (never %NULL). Do not free. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. @@ -13525,12 +14160,12 @@ to was exported in. - A #GDBusInterfaceVTable (never %NULL). + A #GDBusInterfaceVTable (never %NULL). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. @@ -13540,14 +14175,14 @@ to was exported in. - A #GVariant of type + A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. @@ -13561,7 +14196,7 @@ Free with g_variant_unref(). - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. @@ -13595,12 +14230,12 @@ Free with g_variant_unref(). - Flags describing the behavior of a #GDBusInterfaceSkeleton instance. + Flags describing the behavior of a #GDBusInterfaceSkeleton instance. - No flags set. + No flags set. - Each method invocation is handled in + Each method invocation is handled in a thread dedicated to the invocation. This means that the method implementation can use blocking IO without blocking any other part of the process. It also means that the method implementation must use locking to access data structures used by other threads. @@ -13671,11 +14306,11 @@ the call, you must return the value of type %G_VARIANT_TYPE_UNIT. - #GDBusMenuModel is an implementation of #GMenuModel that can be used + #GDBusMenuModel is an implementation of #GMenuModel that can be used as a proxy for a menu model that is exported over D-Bus with g_dbus_connection_export_menu_model(). - Obtains a #GDBusMenuModel for the menu model which is exported + Obtains a #GDBusMenuModel for the menu model which is exported at the given @bus_name and @object_path. The thread default main context is taken at the time of this call. @@ -13685,40 +14320,40 @@ with respect to this context. All calls on the returned menu model the thread default main context unchanged. - a #GDBusMenuModel object. Free with + a #GDBusMenuModel object. Free with g_object_unref(). - a #GDBusConnection + a #GDBusConnection - the bus name which exports the menu model + the bus name which exports the menu model or %NULL if @connection is not a message bus connection - the object path at which the menu model is exported + the object path at which the menu model is exported - A type for representing D-Bus messages that can be sent or received + A type for representing D-Bus messages that can be sent or received on a #GDBusConnection. - Creates a new empty #GDBusMessage. + Creates a new empty #GDBusMessage. - A #GDBusMessage. Free with g_object_unref(). + A #GDBusMessage. Free with g_object_unref(). - Creates a new #GDBusMessage from the data stored at @blob. The byte + Creates a new #GDBusMessage from the data stored at @blob. The byte order that the message was in can be retrieved using g_dbus_message_get_byte_order(). @@ -13726,100 +14361,100 @@ If the @blob cannot be parsed, contains invalid fields, or contains invalid headers, %G_IO_ERROR_INVALID_ARGUMENT will be returned. - A new #GDBusMessage or %NULL if @error is set. Free with + A new #GDBusMessage or %NULL if @error is set. Free with g_object_unref(). - A blob representing a binary D-Bus message. + A blob representing a binary D-Bus message. - The length of @blob. + The length of @blob. - A #GDBusCapabilityFlags describing what protocol features are supported. + A #GDBusCapabilityFlags describing what protocol features are supported. - Creates a new #GDBusMessage for a method call. + Creates a new #GDBusMessage for a method call. - A #GDBusMessage. Free with g_object_unref(). + A #GDBusMessage. Free with g_object_unref(). - A valid D-Bus name or %NULL. + A valid D-Bus name or %NULL. - A valid object path. + A valid object path. - A valid D-Bus interface name or %NULL. + A valid D-Bus interface name or %NULL. - A valid method name. + A valid method name. - Creates a new #GDBusMessage for a signal emission. + Creates a new #GDBusMessage for a signal emission. - A #GDBusMessage. Free with g_object_unref(). + A #GDBusMessage. Free with g_object_unref(). - A valid object path. + A valid object path. - A valid D-Bus interface name. + A valid D-Bus interface name. - A valid signal name. + A valid signal name. - Utility function to calculate how many bytes are needed to + Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at @blob. - Number of bytes needed or -1 if @error is set (e.g. if + Number of bytes needed or -1 if @error is set (e.g. if @blob contains invalid data or not enough data is available to determine the size). - A blob representing a binary D-Bus message. + A blob representing a binary D-Bus message. - The length of @blob (must be at least 16). + The length of @blob (must be at least 16). - Copies @message. The copy is a deep copy and the returned + Copies @message. The copy is a deep copy and the returned #GDBusMessage is completely identical except that it is guaranteed to not be locked. @@ -13827,130 +14462,130 @@ This operation can fail if e.g. @message contains file descriptors and the per-process or system-wide open files limit is reached. - A new #GDBusMessage or %NULL if @error is set. + A new #GDBusMessage or %NULL if @error is set. Free with g_object_unref(). - A #GDBusMessage. + A #GDBusMessage. - Convenience to get the first item in the body of @message. + Convenience to get the first item in the body of @message. - The string item or %NULL if the first item in the body of + The string item or %NULL if the first item in the body of @message is not a string. - A #GDBusMessage. + A #GDBusMessage. - Gets the body of a message. + Gets the body of a message. - A #GVariant or %NULL if the body is + A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message. - A #GDBusMessage. + A #GDBusMessage. - Gets the byte order of @message. + Gets the byte order of @message. - The byte order. + The byte order. - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Gets the flags for @message. + Gets the flags for @message. - Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). + Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). - A #GDBusMessage. + A #GDBusMessage. - Gets a header field on @message. + Gets a header field on @message. The caller is responsible for checking the type of the returned #GVariant matches what is expected. - A #GVariant with the value if the header was found, %NULL + A #GVariant with the value if the header was found, %NULL otherwise. Do not free, it is owned by @message. - A #GDBusMessage. + A #GDBusMessage. - A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) + A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) - Gets an array of all header fields on @message that are set. + Gets an array of all header fields on @message that are set. - An array of header fields + An array of header fields terminated by %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a #guchar. Free with g_free(). @@ -13959,277 +14594,277 @@ is a #guchar. Free with g_free(). - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Checks whether @message is locked. To monitor changes to this + Checks whether @message is locked. To monitor changes to this value, conncet to the #GObject::notify signal to listen for changes on the #GDBusMessage:locked property. - %TRUE if @message is locked, %FALSE otherwise. + %TRUE if @message is locked, %FALSE otherwise. - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Gets the type of @message. + Gets the type of @message. - A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). + A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Gets the serial for @message. + Gets the serial for @message. - A #guint32. + A #guint32. - A #GDBusMessage. + A #GDBusMessage. - Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. + Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. - The value. + The value. - A #GDBusMessage. + A #GDBusMessage. - Gets the UNIX file descriptors associated with @message, if any. + Gets the UNIX file descriptors associated with @message, if any. This method is only available on UNIX. - A #GUnixFDList or %NULL if no file descriptors are + A #GUnixFDList or %NULL if no file descriptors are associated. Do not free, this object is owned by @message. - A #GDBusMessage. + A #GDBusMessage. - If @message is locked, does nothing. Otherwise locks the message. + If @message is locked, does nothing. Otherwise locks the message. - A #GDBusMessage. + A #GDBusMessage. - Creates a new #GDBusMessage that is an error reply to @method_call_message. + Creates a new #GDBusMessage that is an error reply to @method_call_message. - A #GDBusMessage. Free with g_object_unref(). + A #GDBusMessage. Free with g_object_unref(). - A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. - A valid D-Bus error name. + A valid D-Bus error name. - The D-Bus error message in a printf() format. + The D-Bus error message in a printf() format. - Arguments for @error_message_format. + Arguments for @error_message_format. - Creates a new #GDBusMessage that is an error reply to @method_call_message. + Creates a new #GDBusMessage that is an error reply to @method_call_message. - A #GDBusMessage. Free with g_object_unref(). + A #GDBusMessage. Free with g_object_unref(). - A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. - A valid D-Bus error name. + A valid D-Bus error name. - The D-Bus error message. + The D-Bus error message. - Like g_dbus_message_new_method_error() but intended for language bindings. + Like g_dbus_message_new_method_error() but intended for language bindings. - A #GDBusMessage. Free with g_object_unref(). + A #GDBusMessage. Free with g_object_unref(). - A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. - A valid D-Bus error name. + A valid D-Bus error name. - The D-Bus error message in a printf() format. + The D-Bus error message in a printf() format. - Arguments for @error_message_format. + Arguments for @error_message_format. - Creates a new #GDBusMessage that is a reply to @method_call_message. + Creates a new #GDBusMessage that is a reply to @method_call_message. - #GDBusMessage. Free with g_object_unref(). + #GDBusMessage. Free with g_object_unref(). - A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. - Produces a human-readable multi-line description of @message. + Produces a human-readable multi-line description of @message. The contents of the description has no ABI guarantees, the contents and formatting is subject to change at any time. Typical output @@ -14263,22 +14898,22 @@ UNIX File Descriptors: ]| - A string that should be freed with g_free(). + A string that should be freed with g_free(). - A #GDBusMessage. + A #GDBusMessage. - Indentation level. + Indentation level. - Sets the body @message. As a side-effect the + Sets the body @message. As a side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the type string of @body (or cleared if @body is %NULL). @@ -14289,86 +14924,86 @@ If @body is floating, @message assumes ownership of @body. - A #GDBusMessage. + A #GDBusMessage. - Either %NULL or a #GVariant that is a tuple. + Either %NULL or a #GVariant that is a tuple. - Sets the byte order of @message. + Sets the byte order of @message. - A #GDBusMessage. + A #GDBusMessage. - The byte order. + The byte order. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Sets the flags to set on @message. + Sets the flags to set on @message. - A #GDBusMessage. + A #GDBusMessage. - Flags for @message that are set (typically values from the #GDBusMessageFlags + Flags for @message that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). - Sets a header field on @message. + Sets a header field on @message. If @value is floating, @message assumes ownership of @value. @@ -14377,174 +15012,174 @@ If @value is floating, @message assumes ownership of @value. - A #GDBusMessage. + A #GDBusMessage. - A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) + A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) - A #GVariant to set the header field or %NULL to clear the header field. + A #GVariant to set the header field or %NULL to clear the header field. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Sets @message to be of @type. + Sets @message to be of @type. - A #GDBusMessage. + A #GDBusMessage. - A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). + A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Sets the serial for @message. + Sets the serial for @message. - A #GDBusMessage. + A #GDBusMessage. - A #guint32. + A #guint32. - Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. + Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. - A #GDBusMessage. + A #GDBusMessage. - The value to set. + The value to set. - Sets the UNIX file descriptors associated with @message. As a + Sets the UNIX file descriptors associated with @message. As a side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field is set to the number of fds in @fd_list (or cleared if @fd_list is %NULL). @@ -14556,21 +15191,21 @@ This method is only available on UNIX. - A #GDBusMessage. + A #GDBusMessage. - A #GUnixFDList or %NULL. + A #GUnixFDList or %NULL. - Serializes @message to a blob. The byte order returned by + Serializes @message to a blob. The byte order returned by g_dbus_message_get_byte_order() will be used. - A pointer to a + A pointer to a valid binary D-Bus message of @out_size bytes generated by @message or %NULL if @error is set. Free with g_free(). @@ -14579,21 +15214,21 @@ or %NULL if @error is set. Free with g_free(). - A #GDBusMessage. + A #GDBusMessage. - Return location for size of generated blob. + Return location for size of generated blob. - A #GDBusCapabilityFlags describing what protocol features are supported. + A #GDBusCapabilityFlags describing what protocol features are supported. - If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does + If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does nothing and returns %FALSE. Otherwise this method encodes the error in @message as a #GError @@ -14602,12 +15237,12 @@ using g_dbus_error_set_dbus_error() using the information in the well as the first string item in @message's body. - %TRUE if @error was set, %FALSE otherwise. + %TRUE if @error was set, %FALSE otherwise. - A #GDBusMessage. + A #GDBusMessage. @@ -14617,12 +15252,12 @@ well as the first string item in @message's body. - Enumeration used to describe the byte order of a D-Bus message. + Enumeration used to describe the byte order of a D-Bus message. - The byte order is big endian. + The byte order is big endian. - The byte order is little endian. + The byte order is little endian. @@ -14713,72 +15348,72 @@ a message to be sent to the other peer. - Message flags used in #GDBusMessage. + Message flags used in #GDBusMessage. - No flags set. + No flags set. - A reply is not expected. + A reply is not expected. - The bus must not launch an + The bus must not launch an owner for the destination name in response to this message. - If set on a method + If set on a method call, this flag means that the caller is prepared to wait for interactive authorization. Since 2.46. - Header fields used in #GDBusMessage. + Header fields used in #GDBusMessage. - Not a valid header field. + Not a valid header field. - The object path. + The object path. - The interface name. + The interface name. - The method or signal name. + The method or signal name. - The name of the error that occurred. + The name of the error that occurred. - The serial number the message is a reply to. + The serial number the message is a reply to. - The name the message is intended for. + The name the message is intended for. - Unique name of the sender of the message (filled in by the bus). + Unique name of the sender of the message (filled in by the bus). - The signature of the message body. + The signature of the message body. - The number of UNIX file descriptors that accompany the message. + The number of UNIX file descriptors that accompany the message. - Message types used in #GDBusMessage. + Message types used in #GDBusMessage. - Message is of invalid type. + Message is of invalid type. - Method call. + Method call. - Method reply. + Method reply. - Error reply. + Error reply. - Signal emission. + Signal emission. @@ -14811,22 +15446,22 @@ authorization. Since 2.46. - If @info is statically allocated does nothing. Otherwise increases + If @info is statically allocated does nothing. Otherwise increases the reference count. - The same @info. + The same @info. - A #GDBusMethodInfo + A #GDBusMethodInfo - If @info is statically allocated, does nothing. Otherwise decreases + If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -14835,14 +15470,14 @@ the memory used is freed. - A #GDBusMethodInfo. + A #GDBusMethodInfo. - Instances of the #GDBusMethodInvocation class are used when + Instances of the #GDBusMethodInvocation class are used when handling D-Bus method calls. It provides a way to asynchronously return results and errors. @@ -14850,21 +15485,21 @@ The normal way to obtain a #GDBusMethodInvocation object is to receive it as an argument to the handle_method_call() function in a #GDBusInterfaceVTable that was passed to g_dbus_connection_register_object(). - Gets the #GDBusConnection the method was invoked on. + Gets the #GDBusConnection the method was invoked on. - A #GDBusConnection. Do not free, it is owned by @invocation. + A #GDBusConnection. Do not free, it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets the name of the D-Bus interface the method was invoked on. + Gets the name of the D-Bus interface the method was invoked on. If this method call is a property Get, Set or GetAll call that has been redirected to the method call handler then @@ -14872,18 +15507,18 @@ been redirected to the method call handler then #GDBusInterfaceVTable for more information. - A string. Do not free, it is owned by @invocation. + A string. Do not free, it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets the #GDBusMessage for the method invocation. This is useful if + Gets the #GDBusMessage for the method invocation. This is useful if you need to use low-level protocol features, such as UNIX file descriptor passing, that cannot be properly expressed in the #GVariant API. @@ -14893,18 +15528,18 @@ for an example of how to use this low-level API to send and receive UNIX file descriptors. - #GDBusMessage. Do not free, it is owned by @invocation. + #GDBusMessage. Do not free, it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets information about the method call, if any. + Gets information about the method call, if any. If this method invocation is a property Get, Set or GetAll call that has been redirected to the method call handler then %NULL will be @@ -14912,61 +15547,61 @@ returned. See g_dbus_method_invocation_get_property_info() and #GDBusInterfaceVTable for more information. - A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation. + A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets the name of the method that was invoked. + Gets the name of the method that was invoked. - A string. Do not free, it is owned by @invocation. + A string. Do not free, it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets the object path the method was invoked on. + Gets the object path the method was invoked on. - A string. Do not free, it is owned by @invocation. + A string. Do not free, it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets the parameters of the method invocation. If there are no input + Gets the parameters of the method invocation. If there are no input parameters then this will return a GVariant with 0 children rather than NULL. - A #GVariant tuple. Do not unref this because it is owned by @invocation. + A #GVariant tuple. Do not unref this because it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets information about the property that this method call is for, if + Gets information about the property that this method call is for, if any. This will only be set in the case of an invocation in response to a @@ -14979,46 +15614,46 @@ See #GDBusInterfaceVTable for more information. If the call was GetAll, %NULL will be returned. - a #GDBusPropertyInfo or %NULL + a #GDBusPropertyInfo or %NULL - A #GDBusMethodInvocation + A #GDBusMethodInvocation - Gets the bus name that invoked the method. + Gets the bus name that invoked the method. - A string. Do not free, it is owned by @invocation. + A string. Do not free, it is owned by @invocation. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). + Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). - A #gpointer. + A #gpointer. - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - Finishes handling a D-Bus method call by returning an error. + Finishes handling a D-Bus method call by returning an error. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @@ -15029,21 +15664,21 @@ This method will take ownership of @invocation. See - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A valid D-Bus error name. + A valid D-Bus error name. - A valid D-Bus error message. + A valid D-Bus error message. - Finishes handling a D-Bus method call by returning an error. + Finishes handling a D-Bus method call by returning an error. See g_dbus_error_encode_gerror() for details about what error name will be returned on the wire. In a nutshell, if the given error is @@ -15069,29 +15704,29 @@ the recommendations of the D-Bus specification). - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A #GQuark for the #GError error domain. + A #GQuark for the #GError error domain. - The error code. + The error code. - printf()-style format. + printf()-style format. - Parameters for @format. + Parameters for @format. - Like g_dbus_method_invocation_return_error() but without printf()-style formatting. + Like g_dbus_method_invocation_return_error() but without printf()-style formatting. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @@ -15102,25 +15737,25 @@ This method will take ownership of @invocation. See - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A #GQuark for the #GError error domain. + A #GQuark for the #GError error domain. - The error code. + The error code. - The error message. + The error message. - Like g_dbus_method_invocation_return_error() but intended for + Like g_dbus_method_invocation_return_error() but intended for language bindings. This method will take ownership of @invocation. See @@ -15132,29 +15767,29 @@ This method will take ownership of @invocation. See - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A #GQuark for the #GError error domain. + A #GQuark for the #GError error domain. - The error code. + The error code. - printf()-style format. + printf()-style format. - #va_list of parameters for @format. + #va_list of parameters for @format. - Like g_dbus_method_invocation_return_error() but takes a #GError + Like g_dbus_method_invocation_return_error() but takes a #GError instead of the error domain, error code and message. This method will take ownership of @invocation. See @@ -15166,17 +15801,17 @@ This method will take ownership of @invocation. See - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A #GError. + A #GError. - Finishes handling a D-Bus method call by returning @parameters. + Finishes handling a D-Bus method call by returning @parameters. If the @parameters GVariant is floating, it is consumed. It is an error if @parameters is not of the right format: it must be a tuple @@ -15214,17 +15849,17 @@ specification). - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. + A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. - Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList. + Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList. This method is only available on UNIX. @@ -15237,21 +15872,21 @@ This method will take ownership of @invocation. See - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. + A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. - A #GUnixFDList or %NULL. + A #GUnixFDList or %NULL. - Like g_dbus_method_invocation_return_gerror() but takes ownership + Like g_dbus_method_invocation_return_gerror() but takes ownership of @error so the caller does not need to free it. This method will take ownership of @invocation. See @@ -15263,11 +15898,11 @@ This method will take ownership of @invocation. See - A #GDBusMethodInvocation. + A #GDBusMethodInvocation. - A #GError. + A #GError. @@ -15303,7 +15938,7 @@ This method will take ownership of @invocation. See - Parses @xml_data and returns a #GDBusNodeInfo representing the data. + Parses @xml_data and returns a #GDBusNodeInfo representing the data. The introspection XML must contain exactly one top-level <node> element. @@ -15313,19 +15948,19 @@ Note that this routine is using a parser that only accepts a subset of valid XML documents. - A #GDBusNodeInfo structure or %NULL if @error is set. Free + A #GDBusNodeInfo structure or %NULL if @error is set. Free with g_dbus_node_info_unref(). - Valid D-Bus introspection XML. + Valid D-Bus introspection XML. - Appends an XML representation of @info (and its children) to @string_builder. + Appends an XML representation of @info (and its children) to @string_builder. This function is typically used for generating introspection XML documents at run-time for handling the `org.freedesktop.DBus.Introspectable.Introspect` method. @@ -15335,56 +15970,56 @@ handling the `org.freedesktop.DBus.Introspectable.Introspect` method. - A #GDBusNodeInfo. + A #GDBusNodeInfo. - Indentation level. + Indentation level. - A #GString to to append XML data to. + A #GString to to append XML data to. - Looks up information about an interface. + Looks up information about an interface. The cost of this function is O(n) in number of interfaces. - A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info. + A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info. - A #GDBusNodeInfo. + A #GDBusNodeInfo. - A D-Bus interface name. + A D-Bus interface name. - If @info is statically allocated does nothing. Otherwise increases + If @info is statically allocated does nothing. Otherwise increases the reference count. - The same @info. + The same @info. - A #GDBusNodeInfo + A #GDBusNodeInfo - If @info is statically allocated, does nothing. Otherwise decreases + If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -15393,43 +16028,43 @@ the memory used is freed. - A #GDBusNodeInfo. + A #GDBusNodeInfo. - The #GDBusObject type is the base type for D-Bus objects on both + The #GDBusObject type is the base type for D-Bus objects on both the service side (see #GDBusObjectSkeleton) and the client side (see #GDBusObjectProxy). It is essentially just a container of interfaces. - Gets the D-Bus interface with name @interface_name associated with + Gets the D-Bus interface with name @interface_name associated with @object, if any. - %NULL if not found, otherwise a + %NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). - A #GDBusObject. + A #GDBusObject. - A D-Bus interface name. + A D-Bus interface name. - Gets the D-Bus interfaces associated with @object. + Gets the D-Bus interfaces associated with @object. - A list of #GDBusInterface instances. + A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -15438,21 +16073,21 @@ interfaces. - A #GDBusObject. + A #GDBusObject. - Gets the object path for @object. + Gets the object path for @object. - A string owned by @object. Do not free. + A string owned by @object. Do not free. - A #GDBusObject. + A #GDBusObject. @@ -15486,30 +16121,30 @@ interfaces. - Gets the D-Bus interface with name @interface_name associated with + Gets the D-Bus interface with name @interface_name associated with @object, if any. - %NULL if not found, otherwise a + %NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). - A #GDBusObject. + A #GDBusObject. - A D-Bus interface name. + A D-Bus interface name. - Gets the D-Bus interfaces associated with @object. + Gets the D-Bus interfaces associated with @object. - A list of #GDBusInterface instances. + A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -15518,21 +16153,21 @@ interfaces. - A #GDBusObject. + A #GDBusObject. - Gets the object path for @object. + Gets the object path for @object. - A string owned by @object. Do not free. + A string owned by @object. Do not free. - A #GDBusObject. + A #GDBusObject. @@ -15573,12 +16208,12 @@ interfaces. - A string owned by @object. Do not free. + A string owned by @object. Do not free. - A #GDBusObject. + A #GDBusObject. @@ -15588,7 +16223,7 @@ interfaces. - A list of #GDBusInterface instances. + A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -15597,7 +16232,7 @@ interfaces. - A #GDBusObject. + A #GDBusObject. @@ -15607,17 +16242,17 @@ interfaces. - %NULL if not found, otherwise a + %NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). - A #GDBusObject. + A #GDBusObject. - A D-Bus interface name. + A D-Bus interface name. @@ -15657,7 +16292,7 @@ interfaces. - The #GDBusObjectManager type is the base type for service- and + The #GDBusObjectManager type is the base type for service- and client-side implementations of the standardized [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) interface. @@ -15666,67 +16301,67 @@ See #GDBusObjectManagerClient for the client-side implementation and #GDBusObjectManagerServer for the service-side implementation. - Gets the interface proxy for @interface_name at @object_path, if + Gets the interface proxy for @interface_name at @object_path, if any. - A #GDBusInterface instance or %NULL. Free + A #GDBusInterface instance or %NULL. Free with g_object_unref(). - A #GDBusObjectManager. + A #GDBusObjectManager. - Object path to lookup. + Object path to look up. - D-Bus interface name to lookup. + D-Bus interface name to look up. - Gets the #GDBusObjectProxy at @object_path, if any. + Gets the #GDBusObjectProxy at @object_path, if any. - A #GDBusObject or %NULL. Free with + A #GDBusObject or %NULL. Free with g_object_unref(). - A #GDBusObjectManager. + A #GDBusObjectManager. - Object path to lookup. + Object path to look up. - Gets the object path that @manager is for. + Gets the object path that @manager is for. - A string owned by @manager. Do not free. + A string owned by @manager. Do not free. - A #GDBusObjectManager. + A #GDBusObjectManager. - Gets all #GDBusObject objects known to @manager. + Gets all #GDBusObject objects known to @manager. - A list of + A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -15736,7 +16371,7 @@ any. - A #GDBusObjectManager. + A #GDBusObjectManager. @@ -15804,67 +16439,67 @@ any. - Gets the interface proxy for @interface_name at @object_path, if + Gets the interface proxy for @interface_name at @object_path, if any. - A #GDBusInterface instance or %NULL. Free + A #GDBusInterface instance or %NULL. Free with g_object_unref(). - A #GDBusObjectManager. + A #GDBusObjectManager. - Object path to lookup. + Object path to look up. - D-Bus interface name to lookup. + D-Bus interface name to look up. - Gets the #GDBusObjectProxy at @object_path, if any. + Gets the #GDBusObjectProxy at @object_path, if any. - A #GDBusObject or %NULL. Free with + A #GDBusObject or %NULL. Free with g_object_unref(). - A #GDBusObjectManager. + A #GDBusObjectManager. - Object path to lookup. + Object path to look up. - Gets the object path that @manager is for. + Gets the object path that @manager is for. - A string owned by @manager. Do not free. + A string owned by @manager. Do not free. - A #GDBusObjectManager. + A #GDBusObjectManager. - Gets all #GDBusObject objects known to @manager. + Gets all #GDBusObject objects known to @manager. - A list of + A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -15874,7 +16509,7 @@ any. - A #GDBusObjectManager. + A #GDBusObjectManager. @@ -15943,7 +16578,7 @@ connect signals to all objects managed by @manager. - #GDBusObjectManagerClient is used to create, monitor and delete object + #GDBusObjectManagerClient is used to create, monitor and delete object proxies for remote objects exported by a #GDBusObjectManagerServer (or any code implementing the [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) @@ -16023,24 +16658,8 @@ same main loop. - Finishes an operation started with g_dbus_object_manager_client_new(). + Finishes an operation started with g_dbus_object_manager_client_new(). - - A - #GDBusObjectManagerClient object or %NULL if @error is set. Free - with g_object_unref(). - - - - - A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new(). - - - - - - Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). - A #GDBusObjectManagerClient object or %NULL if @error is set. Free @@ -16049,13 +16668,29 @@ same main loop. - A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus(). + A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new(). + + + + + + Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). + + + A + #GDBusObjectManagerClient object or %NULL if @error is set. Free + with g_object_unref(). + + + + + A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus(). - Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead + Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection. This is a synchronous failable constructor - the calling thread is @@ -16063,11 +16698,164 @@ blocked until a reply is received. See g_dbus_object_manager_client_new_for_bus( for the asynchronous version. - A + A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). + + + A #GBusType. + + + + Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + + + + The owner of the control object (unique or well-known name). + + + + The object path of the control object. + + + + A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + + + + User data to pass to @get_proxy_type_func. + + + + Free function for @get_proxy_type_user_data or %NULL. + + + + A #GCancellable or %NULL + + + + + + Creates a new #GDBusObjectManagerClient object. + +This is a synchronous failable constructor - the calling thread is +blocked until a reply is received. See g_dbus_object_manager_client_new() +for the asynchronous version. + + + A + #GDBusObjectManagerClient object or %NULL if @error is set. Free + with g_object_unref(). + + + + + A #GDBusConnection. + + + + Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + + + + The owner of the control object (unique or well-known name), or %NULL when not using a message bus connection. + + + + The object path of the control object. + + + + A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + + + + User data to pass to @get_proxy_type_func. + + + + Free function for @get_proxy_type_user_data or %NULL. + + + + A #GCancellable or %NULL + + + + + + Asynchronously creates a new #GDBusObjectManagerClient object. + +This is an asynchronous failable constructor. When the result is +ready, @callback will be invoked in the +[thread-default main context][g-main-context-push-thread-default] +of the thread you are calling this method from. You can +then call g_dbus_object_manager_client_new_finish() to get the result. See +g_dbus_object_manager_client_new_sync() for the synchronous version. + + + + + + + A #GDBusConnection. + + + + Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + + + + The owner of the control object (unique or well-known name). + + + + The object path of the control object. + + + + A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + + + + User data to pass to @get_proxy_type_func. + + + + Free function for @get_proxy_type_user_data or %NULL. + + + + A #GCancellable or %NULL + + + + A #GAsyncReadyCallback to call when the request is satisfied. + + + + The data to pass to @callback. + + + + + + Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a +#GDBusConnection. + +This is an asynchronous failable constructor. When the result is +ready, @callback will be invoked in the +[thread-default main loop][g-main-context-push-thread-default] +of the thread you are calling this method from. You can +then call g_dbus_object_manager_client_new_for_bus_finish() to get the result. See +g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. + + + + A #GBusType. @@ -16101,165 +16889,12 @@ for the asynchronous version. A #GCancellable or %NULL - - - - Creates a new #GDBusObjectManagerClient object. - -This is a synchronous failable constructor - the calling thread is -blocked until a reply is received. See g_dbus_object_manager_client_new() -for the asynchronous version. - - - A - #GDBusObjectManagerClient object or %NULL if @error is set. Free - with g_object_unref(). - - - - - A #GDBusConnection. - - - - Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. - - - - The owner of the control object (unique or well-known name), or %NULL when not using a message bus connection. - - - - The object path of the control object. - - - - A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. - - - - User data to pass to @get_proxy_type_func. - - - - Free function for @get_proxy_type_user_data or %NULL. - - - - A #GCancellable or %NULL - - - - - - Asynchronously creates a new #GDBusObjectManagerClient object. - -This is an asynchronous failable constructor. When the result is -ready, @callback will be invoked in the -[thread-default main context][g-main-context-push-thread-default] -of the thread you are calling this method from. You can -then call g_dbus_object_manager_client_new_finish() to get the result. See -g_dbus_object_manager_client_new_sync() for the synchronous version. - - - - - - - A #GDBusConnection. - - - - Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. - - - - The owner of the control object (unique or well-known name). - - - - The object path of the control object. - - - - A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. - - - - User data to pass to @get_proxy_type_func. - - - - Free function for @get_proxy_type_user_data or %NULL. - - - - A #GCancellable or %NULL - - - A #GAsyncReadyCallback to call when the request is satisfied. + A #GAsyncReadyCallback to call when the request is satisfied. - The data to pass to @callback. - - - - - - Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a -#GDBusConnection. - -This is an asynchronous failable constructor. When the result is -ready, @callback will be invoked in the -[thread-default main loop][g-main-context-push-thread-default] -of the thread you are calling this method from. You can -then call g_dbus_object_manager_client_new_for_bus_finish() to get the result. See -g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. - - - - - - - A #GBusType. - - - - Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. - - - - The owner of the control object (unique or well-known name). - - - - The object path of the control object. - - - - A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. - - - - User data to pass to @get_proxy_type_func. - - - - Free function for @get_proxy_type_user_data or %NULL. - - - - A #GCancellable or %NULL - - - - A #GAsyncReadyCallback to call when the request is satisfied. - - - - The data to pass to @callback. + The data to pass to @callback. @@ -16314,65 +16949,65 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. - Gets the #GDBusConnection used by @manager. + Gets the #GDBusConnection used by @manager. - A #GDBusConnection object. Do not free, + A #GDBusConnection object. Do not free, the object belongs to @manager. - A #GDBusObjectManagerClient + A #GDBusObjectManagerClient - Gets the flags that @manager was constructed with. + Gets the flags that @manager was constructed with. - Zero of more flags from the #GDBusObjectManagerClientFlags + Zero of more flags from the #GDBusObjectManagerClientFlags enumeration. - A #GDBusObjectManagerClient + A #GDBusObjectManagerClient - Gets the name that @manager is for, or %NULL if not a message bus + Gets the name that @manager is for, or %NULL if not a message bus connection. - A unique or well-known name. Do not free, the string + A unique or well-known name. Do not free, the string belongs to @manager. - A #GDBusObjectManagerClient + A #GDBusObjectManagerClient - The unique name that owns the name that @manager is for or %NULL if + The unique name that owns the name that @manager is for or %NULL if no-one currently owns that name. You can connect to the #GObject::notify signal to track changes to the #GDBusObjectManagerClient:name-owner property. - The name owner or %NULL if no name owner + The name owner or %NULL if no name owner exists. Free with g_free(). - A #GDBusObjectManagerClient. + A #GDBusObjectManagerClient. @@ -16565,12 +17200,12 @@ that @manager was constructed in. - Flags used when constructing a #GDBusObjectManagerClient. + Flags used when constructing a #GDBusObjectManagerClient. - No flags set. + No flags set. - If not set and the + If not set and the manager is for a well-known name, then request the bus to launch an owner for the name if no-one owns the name. This flag can only be used in managers for well-known names. @@ -16590,12 +17225,12 @@ that @manager was constructed in. - A string owned by @manager. Do not free. + A string owned by @manager. Do not free. - A #GDBusObjectManager. + A #GDBusObjectManager. @@ -16605,7 +17240,7 @@ that @manager was constructed in. - A list of + A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -16615,7 +17250,7 @@ that @manager was constructed in. - A #GDBusObjectManager. + A #GDBusObjectManager. @@ -16625,17 +17260,17 @@ that @manager was constructed in. - A #GDBusObject or %NULL. Free with + A #GDBusObject or %NULL. Free with g_object_unref(). - A #GDBusObjectManager. + A #GDBusObjectManager. - Object path to lookup. + Object path to look up. @@ -16645,21 +17280,21 @@ that @manager was constructed in. - A #GDBusInterface instance or %NULL. Free + A #GDBusInterface instance or %NULL. Free with g_object_unref(). - A #GDBusObjectManager. + A #GDBusObjectManager. - Object path to lookup. + Object path to look up. - D-Bus interface name to lookup. + D-Bus interface name to look up. @@ -16737,7 +17372,7 @@ that @manager was constructed in. - #GDBusObjectManagerServer is used to export #GDBusObject instances using + #GDBusObjectManagerServer is used to export #GDBusObject instances using the standardized [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) interface. For example, remote D-Bus clients can get all objects @@ -16762,7 +17397,7 @@ interface. - Creates a new #GDBusObjectManagerServer object. + Creates a new #GDBusObjectManagerServer object. The returned server isn't yet exported on any connection. To do so, use g_dbus_object_manager_server_set_connection(). Normally you @@ -16771,18 +17406,18 @@ want to export all of your objects before doing so to avoid signals being emitted. - A #GDBusObjectManagerServer object. Free with g_object_unref(). + A #GDBusObjectManagerServer object. Free with g_object_unref(). - The object path to export the manager object at. + The object path to export the manager object at. - Exports @object on @manager. + Exports @object on @manager. If there is already a #GDBusObject exported at the object path, then the old object is removed. @@ -16798,17 +17433,17 @@ it is exported. - A #GDBusObjectManagerServer. + A #GDBusObjectManagerServer. - A #GDBusObjectSkeleton. + A #GDBusObjectSkeleton. - Like g_dbus_object_manager_server_export() but appends a string of + Like g_dbus_object_manager_server_export() but appends a string of the form _N (with N being a natural number) to @object's object path if an object with the given path already exists. As such, the #GDBusObjectProxy:g-object-path property of @object may be modified. @@ -16818,51 +17453,51 @@ if an object with the given path already exists. As such, the - A #GDBusObjectManagerServer. + A #GDBusObjectManagerServer. - An object. + An object. - Gets the #GDBusConnection used by @manager. + Gets the #GDBusConnection used by @manager. - A #GDBusConnection object or %NULL if + A #GDBusConnection object or %NULL if @manager isn't exported on a connection. The returned object should be freed with g_object_unref(). - A #GDBusObjectManagerServer + A #GDBusObjectManagerServer - Returns whether @object is currently exported on @manager. + Returns whether @object is currently exported on @manager. - %TRUE if @object is exported + %TRUE if @object is exported - A #GDBusObjectManagerServer. + A #GDBusObjectManagerServer. - An object. + An object. - Exports all objects managed by @manager on @connection. If + Exports all objects managed by @manager on @connection. If @connection is %NULL, stops exporting objects. @@ -16870,33 +17505,33 @@ if an object with the given path already exists. As such, the - A #GDBusObjectManagerServer. + A #GDBusObjectManagerServer. - A #GDBusConnection or %NULL. + A #GDBusConnection or %NULL. - If @manager has an object at @path, removes the object. Otherwise + If @manager has an object at @path, removes the object. Otherwise does nothing. Note that @object_path must be in the hierarchy rooted by the object path for @manager. - %TRUE if object at @object_path was removed, %FALSE otherwise. + %TRUE if object at @object_path was removed, %FALSE otherwise. - A #GDBusObjectManagerServer. + A #GDBusObjectManagerServer. - An object path. + An object path. @@ -16933,42 +17568,42 @@ object path for @manager. - A #GDBusObjectProxy is an object used to represent a remote object + A #GDBusObjectProxy is an object used to represent a remote object with one or more D-Bus interfaces. Normally, you don't instantiate a #GDBusObjectProxy yourself - typically #GDBusObjectManagerClient is used to obtain it. - Creates a new #GDBusObjectProxy for the given connection and + Creates a new #GDBusObjectProxy for the given connection and object path. - a new #GDBusObjectProxy + a new #GDBusObjectProxy - a #GDBusConnection + a #GDBusConnection - the object path + the object path - Gets the connection that @proxy is for. + Gets the connection that @proxy is for. - A #GDBusConnection. Do not free, the + A #GDBusConnection. Do not free, the object is owned by @proxy. - a #GDBusObjectProxy + a #GDBusObjectProxy @@ -17005,7 +17640,7 @@ object path. - A #GDBusObjectSkeleton instance is essentially a group of D-Bus + A #GDBusObjectSkeleton instance is essentially a group of D-Bus interfaces. The set of exported interfaces on the object may be dynamic and change at runtime. @@ -17013,15 +17648,15 @@ This type is intended to be used with #GDBusObjectManager. - Creates a new #GDBusObjectSkeleton. + Creates a new #GDBusObjectSkeleton. - A #GDBusObjectSkeleton. Free with g_object_unref(). + A #GDBusObjectSkeleton. Free with g_object_unref(). - An object path. + An object path. @@ -17044,7 +17679,7 @@ This type is intended to be used with #GDBusObjectManager. - Adds @interface_ to @object. + Adds @interface_ to @object. If @object already contains a #GDBusInterfaceSkeleton with the same interface name, it is removed before @interface_ is added. @@ -17057,17 +17692,17 @@ it until removed. - A #GDBusObjectSkeleton. + A #GDBusObjectSkeleton. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - This method simply calls g_dbus_interface_skeleton_flush() on all + This method simply calls g_dbus_interface_skeleton_flush() on all interfaces belonging to @object. See that method for when flushing is useful. @@ -17076,30 +17711,30 @@ is useful. - A #GDBusObjectSkeleton. + A #GDBusObjectSkeleton. - Removes @interface_ from @object. + Removes @interface_ from @object. - A #GDBusObjectSkeleton. + A #GDBusObjectSkeleton. - A #GDBusInterfaceSkeleton. + A #GDBusInterfaceSkeleton. - Removes the #GDBusInterface with @interface_name from @object. + Removes the #GDBusInterface with @interface_name from @object. If no D-Bus interface of the given interface exists, this function does nothing. @@ -17109,28 +17744,28 @@ does nothing. - A #GDBusObjectSkeleton. + A #GDBusObjectSkeleton. - A D-Bus interface name. + A D-Bus interface name. - Sets the object path for @object. + Sets the object path for @object. - A #GDBusObjectSkeleton. + A #GDBusObjectSkeleton. - A valid D-Bus object path. + A valid D-Bus object path. @@ -17231,22 +17866,22 @@ The default class handler just returns %TRUE. - If @info is statically allocated does nothing. Otherwise increases + If @info is statically allocated does nothing. Otherwise increases the reference count. - The same @info. + The same @info. - A #GDBusPropertyInfo + A #GDBusPropertyInfo - If @info is statically allocated, does nothing. Otherwise decreases + If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -17255,26 +17890,26 @@ the memory used is freed. - A #GDBusPropertyInfo. + A #GDBusPropertyInfo. - Flags describing the access control of a D-Bus property. + Flags describing the access control of a D-Bus property. - No flags set. + No flags set. - Property is readable. + Property is readable. - Property is writable. + Property is writable. - #GDBusProxy is a base class used for proxies to access a D-Bus + #GDBusProxy is a base class used for proxies to access a D-Bus interface on a remote object. A #GDBusProxy can be constructed for both well-known and unique names. @@ -17316,79 +17951,79 @@ An example using a proxy for a well-known name can be found in - Finishes creating a #GDBusProxy. + Finishes creating a #GDBusProxy. - A #GDBusProxy or %NULL if @error is set. + A #GDBusProxy or %NULL if @error is set. Free with g_object_unref(). - A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new(). + A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new(). - Finishes creating a #GDBusProxy. + Finishes creating a #GDBusProxy. - A #GDBusProxy or %NULL if @error is set. + A #GDBusProxy or %NULL if @error is set. Free with g_object_unref(). - A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus(). + A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus(). - Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. - A #GDBusProxy or %NULL if error is set. + A #GDBusProxy or %NULL if error is set. Free with g_object_unref(). - A #GBusType. + A #GBusType. - Flags used when constructing the proxy. + Flags used when constructing the proxy. - A #GDBusInterfaceInfo specifying the minimal interface + A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. - A bus name (well-known or unique). + A bus name (well-known or unique). - An object path. + An object path. - A D-Bus interface name. + A D-Bus interface name. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Creates a proxy for accessing @interface_name on the remote object + Creates a proxy for accessing @interface_name on the remote object at @object_path owned by @name at @connection and synchronously loads D-Bus properties unless the %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. @@ -17412,43 +18047,43 @@ and g_dbus_proxy_new_finish() for the asynchronous version. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. - A #GDBusProxy or %NULL if error is set. + A #GDBusProxy or %NULL if error is set. Free with g_object_unref(). - A #GDBusConnection. + A #GDBusConnection. - Flags used when constructing the proxy. + Flags used when constructing the proxy. - A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - An object path. + An object path. - A D-Bus interface name. + A D-Bus interface name. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Creates a proxy for accessing @interface_name on the remote object + Creates a proxy for accessing @interface_name on the remote object at @object_path owned by @name at @connection and asynchronously loads D-Bus properties unless the %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to @@ -17481,45 +18116,45 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. - A #GDBusConnection. + A #GDBusConnection. - Flags used when constructing the proxy. + Flags used when constructing the proxy. - A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - An object path. + An object path. - A D-Bus interface name. + A D-Bus interface name. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Callback function to invoke when the proxy is ready. + Callback function to invoke when the proxy is ready. - User data to pass to @callback. + User data to pass to @callback. - Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. @@ -17528,39 +18163,39 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. - A #GBusType. + A #GBusType. - Flags used when constructing the proxy. + Flags used when constructing the proxy. - A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. - A bus name (well-known or unique). + A bus name (well-known or unique). - An object path. + An object path. - A D-Bus interface name. + A D-Bus interface name. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Callback function to invoke when the proxy is ready. + Callback function to invoke when the proxy is ready. - User data to pass to @callback. + User data to pass to @callback. @@ -17603,7 +18238,7 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. - Asynchronously invokes the @method_name method on @proxy. + Asynchronously invokes the @method_name method on @proxy. If @method_name contains any dots, then @name is split into interface and method name parts. This allows using @proxy for invoking methods on @@ -17651,62 +18286,62 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. - A #GDBusProxy. + A #GDBusProxy. - Name of method to invoke. + Name of method to invoke. - A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. + A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. - Flags from the #GDBusCallFlags enumeration. + Flags from the #GDBusCallFlags enumeration. - The timeout in milliseconds (with %G_MAXINT meaning + The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't + A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation. - The data to pass to @callback. + The data to pass to @callback. - Finishes an operation started with g_dbus_proxy_call(). + Finishes an operation started with g_dbus_proxy_call(). - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - A #GDBusProxy. + A #GDBusProxy. - A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call(). + A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call(). - Synchronously invokes the @method_name method on @proxy. + Synchronously invokes the @method_name method on @proxy. If @method_name contains any dots, then @name is split into interface and method name parts. This allows using @proxy for invoking methods on @@ -17742,41 +18377,41 @@ If @proxy has an expected interface (see then the return value is checked against the return type. - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - A #GDBusProxy. + A #GDBusProxy. - Name of method to invoke. + Name of method to invoke. - A #GVariant tuple with parameters for the signal + A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. - Flags from the #GDBusCallFlags enumeration. + Flags from the #GDBusCallFlags enumeration. - The timeout in milliseconds (with %G_MAXINT meaning + The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Like g_dbus_proxy_call() but also takes a #GUnixFDList object. + Like g_dbus_proxy_call() but also takes a #GUnixFDList object. This method is only available on UNIX. @@ -17785,117 +18420,117 @@ This method is only available on UNIX. - A #GDBusProxy. + A #GDBusProxy. - Name of method to invoke. + Name of method to invoke. - A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. + A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. - Flags from the #GDBusCallFlags enumeration. + Flags from the #GDBusCallFlags enumeration. - The timeout in milliseconds (with %G_MAXINT meaning + The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. - A #GUnixFDList or %NULL. + A #GUnixFDList or %NULL. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't + A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation. - The data to pass to @callback. + The data to pass to @callback. - Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list(). + Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list(). - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - A #GDBusProxy. + A #GDBusProxy. - Return location for a #GUnixFDList or %NULL. + Return location for a #GUnixFDList or %NULL. - A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list(). + A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list(). - Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects. + Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects. This method is only available on UNIX. - %NULL if @error is set. Otherwise a #GVariant tuple with + %NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). - A #GDBusProxy. + A #GDBusProxy. - Name of method to invoke. + Name of method to invoke. - A #GVariant tuple with parameters for the signal + A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. - Flags from the #GDBusCallFlags enumeration. + Flags from the #GDBusCallFlags enumeration. - The timeout in milliseconds (with %G_MAXINT meaning + The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. - A #GUnixFDList or %NULL. + A #GUnixFDList or %NULL. - Return location for a #GUnixFDList or %NULL. + Return location for a #GUnixFDList or %NULL. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Looks up the value for a property from the cache. This call does no + Looks up the value for a property from the cache. This call does no blocking IO. If @proxy has an expected interface (see @@ -17903,27 +18538,27 @@ If @proxy has an expected interface (see it, then @value is checked against the type of the property. - A reference to the #GVariant instance + A reference to the #GVariant instance that holds the value for @property_name or %NULL if the value is not in the cache. The returned reference must be freed with g_variant_unref(). - A #GDBusProxy. + A #GDBusProxy. - Property name. + Property name. - Gets the names of all cached properties on @proxy. + Gets the names of all cached properties on @proxy. - A + A %NULL-terminated array of strings or %NULL if @proxy has no cached properties. Free the returned array with g_strfreev(). @@ -17933,136 +18568,136 @@ it, then @value is checked against the type of the property. - A #GDBusProxy. + A #GDBusProxy. - Gets the connection @proxy is for. + Gets the connection @proxy is for. - A #GDBusConnection owned by @proxy. Do not free. + A #GDBusConnection owned by @proxy. Do not free. - A #GDBusProxy. + A #GDBusProxy. - Gets the timeout to use if -1 (specifying default timeout) is + Gets the timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. See the #GDBusProxy:g-default-timeout property for more details. - Timeout to use for @proxy. + Timeout to use for @proxy. - A #GDBusProxy. + A #GDBusProxy. - Gets the flags that @proxy was constructed with. + Gets the flags that @proxy was constructed with. - Flags from the #GDBusProxyFlags enumeration. + Flags from the #GDBusProxyFlags enumeration. - A #GDBusProxy. + A #GDBusProxy. - Returns the #GDBusInterfaceInfo, if any, specifying the interface + Returns the #GDBusInterfaceInfo, if any, specifying the interface that @proxy conforms to. See the #GDBusProxy:g-interface-info property for more details. - A #GDBusInterfaceInfo or %NULL. + A #GDBusInterfaceInfo or %NULL. Do not unref the returned object, it is owned by @proxy. - A #GDBusProxy + A #GDBusProxy - Gets the D-Bus interface name @proxy is for. + Gets the D-Bus interface name @proxy is for. - A string owned by @proxy. Do not free. + A string owned by @proxy. Do not free. - A #GDBusProxy. + A #GDBusProxy. - Gets the name that @proxy was constructed for. + Gets the name that @proxy was constructed for. - A string owned by @proxy. Do not free. + A string owned by @proxy. Do not free. - A #GDBusProxy. + A #GDBusProxy. - The unique name that owns the name that @proxy is for or %NULL if + The unique name that owns the name that @proxy is for or %NULL if no-one currently owns that name. You may connect to the #GObject::notify signal to track changes to the #GDBusProxy:g-name-owner property. - The name owner or %NULL if no name + The name owner or %NULL if no name owner exists. Free with g_free(). - A #GDBusProxy. + A #GDBusProxy. - Gets the object path @proxy is for. + Gets the object path @proxy is for. - A string owned by @proxy. Do not free. + A string owned by @proxy. Do not free. - A #GDBusProxy. + A #GDBusProxy. - If @value is not %NULL, sets the cached value for the property with + If @value is not %NULL, sets the cached value for the property with name @property_name to the value in @value. If @value is %NULL, then the cached value is removed from the @@ -18101,21 +18736,21 @@ it is more efficient to only transmit the delta using e.g. signals - A #GDBusProxy + A #GDBusProxy - Property name. + Property name. - Value for the property or %NULL to remove it from the cache. + Value for the property or %NULL to remove it from the cache. - Sets the timeout to use if -1 (specifying default timeout) is + Sets the timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. @@ -18126,17 +18761,17 @@ See the #GDBusProxy:g-default-timeout property for more details. - A #GDBusProxy. + A #GDBusProxy. - Timeout in milliseconds. + Timeout in milliseconds. - Ensure that interactions with @proxy conform to the given + Ensure that interactions with @proxy conform to the given interface. See the #GDBusProxy:g-interface-info property for more details. @@ -18145,11 +18780,11 @@ details. - A #GDBusProxy + A #GDBusProxy - Minimum interface this proxy conforms to + Minimum interface this proxy conforms to or %NULL to unset. @@ -18336,26 +18971,26 @@ This signal corresponds to the - Flags used when constructing an instance of a #GDBusProxy derived class. + Flags used when constructing an instance of a #GDBusProxy derived class. - No flags set. + No flags set. - Don't load properties. + Don't load properties. - Don't connect to signals on the remote object. + Don't connect to signals on the remote object. - If the proxy is for a well-known name, + If the proxy is for a well-known name, do not ask the bus to launch an owner during proxy initialization or a method call. This flag is only meaningful in proxies for well-known names. - If set, the property value for any __invalidated property__ will be (asynchronously) retrieved upon receiving the [`PropertiesChanged`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties) D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32. + If set, the property value for any __invalidated property__ will be (asynchronously) retrieved upon receiving the [`PropertiesChanged`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties) D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32. - If the proxy is for a well-known name, + If the proxy is for a well-known name, do not ask the bus to launch an owner during proxy initialization, but allow it to be autostarted by a method call. This flag is only meaningful in proxies for well-known names, and only if %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is not also specified. @@ -18399,18 +19034,18 @@ that @manager was constructed in. - Flags used when sending #GDBusMessages on a #GDBusConnection. + Flags used when sending #GDBusMessages on a #GDBusConnection. - No flags set. + No flags set. - Do not automatically + Do not automatically assign a serial number from the #GDBusConnection object when sending a message. - #GDBusServer is a helper for listening to and accepting D-Bus + #GDBusServer is a helper for listening to and accepting D-Bus connections. This can be used to create a new D-Bus server, allowing two peers to use the D-Bus protocol for their own specialized communication. A server instance provided in this way will not perform message routing or @@ -18420,15 +19055,24 @@ To just export an object on a well-known name on a message bus, such as the session or system bus, you should instead use g_bus_own_name(). An example of peer-to-peer communication with G-DBus can be found -in [gdbus-example-peer.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-peer.c). +in [gdbus-example-peer.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-peer.c). + +Note that a minimal #GDBusServer will accept connections from any +peer. In many use-cases it will be necessary to add a #GDBusAuthObserver +that only accepts connections that have successfully authenticated +as the same user that is running the #GDBusServer. - Creates a new D-Bus server that listens on the first address in + Creates a new D-Bus server that listens on the first address in @address that works. Once constructed, you can use g_dbus_server_get_client_address() to get a D-Bus address string that clients can use to connect. +To have control over the available authentication mechanisms and +the users that are authorized to connect, it is strongly recommended +to provide a non-%NULL #GDBusAuthObserver. + Connect to the #GDBusServer::new-connection signal to handle incoming connections. @@ -18437,118 +19081,118 @@ g_dbus_server_start(). #GDBusServer is used in this [example][gdbus-peer-to-peer]. -This is a synchronous failable constructor. See -g_dbus_server_new() for the asynchronous version. +This is a synchronous failable constructor. There is currently no +asynchronous version. - A #GDBusServer or %NULL if @error is set. Free with + A #GDBusServer or %NULL if @error is set. Free with g_object_unref(). - A D-Bus address. + A D-Bus address. - Flags from the #GDBusServerFlags enumeration. + Flags from the #GDBusServerFlags enumeration. - A D-Bus GUID. + A D-Bus GUID. - A #GDBusAuthObserver or %NULL. + A #GDBusAuthObserver or %NULL. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Gets a + Gets a [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses) string that can be used by clients to connect to @server. - A D-Bus address string. Do not free, the string is owned + A D-Bus address string. Do not free, the string is owned by @server. - A #GDBusServer. + A #GDBusServer. - Gets the flags for @server. + Gets the flags for @server. - A set of flags from the #GDBusServerFlags enumeration. + A set of flags from the #GDBusServerFlags enumeration. - A #GDBusServer. + A #GDBusServer. - Gets the GUID for @server. + Gets the GUID for @server. - A D-Bus GUID. Do not free this string, it is owned by @server. + A D-Bus GUID. Do not free this string, it is owned by @server. - A #GDBusServer. + A #GDBusServer. - Gets whether @server is active. + Gets whether @server is active. - %TRUE if server is active, %FALSE otherwise. + %TRUE if server is active, %FALSE otherwise. - A #GDBusServer. + A #GDBusServer. - Starts @server. + Starts @server. - A #GDBusServer. + A #GDBusServer. - Stops @server. + Stops @server. - A #GDBusServer. + A #GDBusServer. @@ -18613,17 +19257,17 @@ run. - Flags used when creating a #GDBusServer. + Flags used when creating a #GDBusServer. - No flags set. + No flags set. - All #GDBusServer::new-connection + All #GDBusServer::new-connection signals will run in separated dedicated threads (see signal for details). - Allow the anonymous + Allow the anonymous authentication method. @@ -18665,21 +19309,21 @@ authentication method. - Flags used when subscribing to signals via g_dbus_connection_signal_subscribe(). + Flags used when subscribing to signals via g_dbus_connection_signal_subscribe(). - No flags set. + No flags set. - Don't actually send the AddMatch + Don't actually send the AddMatch D-Bus call for this signal subscription. This gives you more control over which match rules you add (but you must add them manually). - Match first arguments that + Match first arguments that contain a bus or interface name with the given namespace. - Match first arguments that + Match first arguments that contain an object path that is either equivalent to the given path, or one of the paths is a subpath of the other. @@ -18708,22 +19352,22 @@ or one of the paths is a subpath of the other. - If @info is statically allocated does nothing. Otherwise increases + If @info is statically allocated does nothing. Otherwise increases the reference count. - The same @info. + The same @info. - A #GDBusSignalInfo + A #GDBusSignalInfo - If @info is statically allocated, does nothing. Otherwise decreases + If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. @@ -18732,7 +19376,7 @@ the memory used is freed. - A #GDBusSignalInfo. + A #GDBusSignalInfo. @@ -18818,12 +19462,12 @@ The return value will be freed with g_strfreev(). - Flags passed to g_dbus_connection_register_subtree(). + Flags passed to g_dbus_connection_register_subtree(). - No flags set. + No flags set. - Method calls to objects not in the enumerated range + Method calls to objects not in the enumerated range will still be dispatched. This is useful if you want to dynamically spawn objects in the subtree. @@ -18896,107 +19540,200 @@ case. - - Extension point for default handler to URI association. See + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extension point for default handler to URI association. See [Extending GIO][extending-gio]. - + The #GDesktopAppInfoLookup interface is deprecated and + unused by GIO. + + + + + + + + + + + + + + + + + + + + + + The string used to obtain a Unix device path with g_drive_get_identifier(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Data input stream implements #GInputStream and includes functions for + Data input stream implements #GInputStream and includes functions for reading structured data directly from a binary input stream. - Creates a new data input stream for the @base_stream. + Creates a new data input stream for the @base_stream. - a new #GDataInputStream. + a new #GDataInputStream. - a #GInputStream. + a #GInputStream. - Gets the byte order for the data input stream. + Gets the byte order for the data input stream. - the @stream's current #GDataStreamByteOrder. + the @stream's current #GDataStreamByteOrder. - a given #GDataInputStream. + a given #GDataInputStream. - Gets the current newline type for the @stream. + Gets the current newline type for the @stream. - #GDataStreamNewlineType for the given @stream. + #GDataStreamNewlineType for the given @stream. - a given #GDataInputStream. + a given #GDataInputStream. - Reads an unsigned 8-bit/1-byte value from @stream. + Reads an unsigned 8-bit/1-byte value from @stream. - an unsigned 8-bit/1-byte value read from the @stream or `0` + an unsigned 8-bit/1-byte value read from the @stream or `0` if an error occurred. - a given #GDataInputStream. + a given #GDataInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads a 16-bit/2-byte value from @stream. + Reads a 16-bit/2-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). - a signed 16-bit/2-byte value read from @stream or `0` if + a signed 16-bit/2-byte value read from @stream or `0` if an error occurred. - a given #GDataInputStream. + a given #GDataInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads a signed 32-bit/4-byte value from @stream. + Reads a signed 32-bit/4-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -19006,23 +19743,23 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a signed 32-bit/4-byte value read from the @stream or `0` if + a signed 32-bit/4-byte value read from the @stream or `0` if an error occurred. - a given #GDataInputStream. + a given #GDataInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads a 64-bit/8-byte value from @stream. + Reads a 64-bit/8-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -19032,23 +19769,23 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a signed 64-bit/8-byte value read from @stream or `0` if + a signed 64-bit/8-byte value read from @stream or `0` if an error occurred. - a given #GDataInputStream. + a given #GDataInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads a line from the data input stream. Note that no encoding + Reads a line from the data input stream. Note that no encoding checks or conversion is performed; the input is not guaranteed to be UTF-8, and may in fact have embedded NUL characters. @@ -19057,7 +19794,7 @@ triggering the cancellable object from another thread. If the operation 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 @@ -19069,21 +19806,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a given #GDataInputStream. + a given #GDataInputStream. - a #gsize to get the length of the data read in. + a #gsize to get the length of the data read in. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - The asynchronous version of g_data_input_stream_read_line(). It is + The asynchronous version of g_data_input_stream_read_line(). It is an error to have two outstanding calls to this function. When the operation is finished, @callback will be called. You @@ -19095,35 +19832,35 @@ the result of the operation. - a given #GDataInputStream. + a given #GDataInputStream. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied. + callback to call when the request is satisfied. - the data to pass to callback function. + the data to pass to callback function. - Finish an asynchronous call started by + Finish an asynchronous call started by g_data_input_stream_read_line_async(). Note the warning about string encoding in g_data_input_stream_read_line() applies here as well. - + 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 @@ -19135,25 +19872,25 @@ well. - a given #GDataInputStream. + a given #GDataInputStream. - the #GAsyncResult that was provided to the callback. + the #GAsyncResult that was provided to the callback. - a #gsize to get the length of the data read in. + a #gsize to get the length of the data read in. - Finish an asynchronous call started by + Finish an asynchronous call started by g_data_input_stream_read_line_async(). - a string with the line that + 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 @@ -19163,28 +19900,28 @@ g_data_input_stream_read_line_async(). - a given #GDataInputStream. + a given #GDataInputStream. - the #GAsyncResult that was provided to the callback. + the #GAsyncResult that was provided to the callback. - a #gsize to get the length of the data read in. + a #gsize to get the length of the data read in. - Reads a UTF-8 encoded line from the data input stream. + Reads a UTF-8 encoded line from the data input stream. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a NUL terminated UTF-8 string + 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 @@ -19195,43 +19932,43 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a given #GDataInputStream. + a given #GDataInputStream. - a #gsize to get the length of the data read in. + a #gsize to get the length of the data read in. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads an unsigned 16-bit/2-byte value from @stream. + Reads an unsigned 16-bit/2-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). - an unsigned 16-bit/2-byte value read from the @stream or `0` if + an unsigned 16-bit/2-byte value read from the @stream or `0` if an error occurred. - a given #GDataInputStream. + a given #GDataInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads an unsigned 32-bit/4-byte value from @stream. + Reads an unsigned 32-bit/4-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -19241,23 +19978,23 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - an unsigned 32-bit/4-byte value read from the @stream or `0` if + an unsigned 32-bit/4-byte value read from the @stream or `0` if an error occurred. - a given #GDataInputStream. + a given #GDataInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads an unsigned 64-bit/8-byte value from @stream. + Reads an unsigned 64-bit/8-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order(). @@ -19267,23 +20004,23 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - an unsigned 64-bit/8-byte read from @stream or `0` if + an unsigned 64-bit/8-byte read from @stream or `0` if an error occurred. - a given #GDataInputStream. + a given #GDataInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Reads a string from the data input stream, up to the first + Reads a string from the data input stream, up to the first occurrence of any of the stop characters. Note that, in contrast to g_data_input_stream_read_until_async(), @@ -19298,7 +20035,7 @@ does not consume the stop character. consistent behaviour regarding the stop character. - a string with the data that was read + a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -19306,25 +20043,25 @@ does not consume the stop character. - a given #GDataInputStream. + a given #GDataInputStream. - characters to terminate the read. + characters to terminate the read. - a #gsize to get the length of the data read in. + a #gsize to get the length of the data read in. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - The asynchronous version of g_data_input_stream_read_until(). + The asynchronous version of g_data_input_stream_read_until(). It is an error to have two outstanding calls to this function. Note that, in contrast to g_data_input_stream_read_until(), @@ -19347,39 +20084,39 @@ g_data_input_stream_read_upto_async() instead. - a given #GDataInputStream. + a given #GDataInputStream. - characters to terminate the read. + characters to terminate the read. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied. + callback to call when the request is satisfied. - the data to pass to callback function. + the data to pass to callback function. - Finish an asynchronous call started by + Finish an asynchronous call started by g_data_input_stream_read_until_async(). Use g_data_input_stream_read_upto_finish() instead, which has more consistent behaviour regarding the stop character. - a string with the data that was read + a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -19387,21 +20124,21 @@ g_data_input_stream_read_until_async(). - a given #GDataInputStream. + a given #GDataInputStream. - the #GAsyncResult that was provided to the callback. + the #GAsyncResult that was provided to the callback. - a #gsize to get the length of the data read in. + a #gsize to get the length of the data read in. - Reads a string from the data input stream, up to the first + Reads a string from the data input stream, up to the first occurrence of any of the stop characters. In contrast to g_data_input_stream_read_until(), this function @@ -19415,7 +20152,7 @@ specified. The returned string will always be nul-terminated on success. - a string with the data that was read + a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error @@ -19423,30 +20160,30 @@ The returned string will always be nul-terminated on success. - a #GDataInputStream + a #GDataInputStream - characters to terminate the read + characters to terminate the read - length of @stop_chars. May be -1 if @stop_chars is + length of @stop_chars. May be -1 if @stop_chars is nul-terminated - a #gsize to get the length of the data read in + a #gsize to get the length of the data read in - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - The asynchronous version of g_data_input_stream_read_upto(). + The asynchronous version of g_data_input_stream_read_upto(). It is an error to have two outstanding calls to this function. In contrast to g_data_input_stream_read_until(), this function @@ -19466,38 +20203,38 @@ the result of the operation. - a #GDataInputStream + a #GDataInputStream - characters to terminate the read + characters to terminate the read - length of @stop_chars. May be -1 if @stop_chars is + length of @stop_chars. May be -1 if @stop_chars is nul-terminated - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finish an asynchronous call started by + Finish an asynchronous call started by g_data_input_stream_read_upto_async(). Note that this function does not consume the stop character. You @@ -19507,7 +20244,7 @@ g_data_input_stream_read_upto_async() again. The returned string will always be nul-terminated on success. - a string with the data that was read + a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -19515,21 +20252,21 @@ The returned string will always be nul-terminated on success. - a #GDataInputStream + a #GDataInputStream - the #GAsyncResult that was provided to the callback + the #GAsyncResult that was provided to the callback - a #gsize to get the length of the data read in + a #gsize to get the length of the data read in - This function sets the byte order for the given @stream. All subsequent + This function sets the byte order for the given @stream. All subsequent reads from the @stream will be read in the given @order. @@ -19537,17 +20274,17 @@ reads from the @stream will be read in the given @order. - a given #GDataInputStream. + a given #GDataInputStream. - a #GDataStreamByteOrder to set. + a #GDataStreamByteOrder to set. - Sets the newline type for the @stream. + Sets the newline type for the @stream. Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read chunk ends in "CR" we must read an additional byte to know if this is "CR" or @@ -19558,11 +20295,11 @@ chunk ends in "CR" we must read an additional byte to know if this is "CR" or - a #GDataInputStream. + a #GDataInputStream. - the type of new line return as #GDataStreamNewlineType. + the type of new line return as #GDataStreamNewlineType. @@ -19630,227 +20367,227 @@ chunk ends in "CR" we must read an additional byte to know if this is "CR" or - Data output stream implements #GOutputStream and includes functions for + Data output stream implements #GOutputStream and includes functions for writing data directly to an output stream. - Creates a new data output stream for @base_stream. + Creates a new data output stream for @base_stream. - #GDataOutputStream. + #GDataOutputStream. - a #GOutputStream. + a #GOutputStream. - Gets the byte order for the stream. + Gets the byte order for the stream. - the #GDataStreamByteOrder for the @stream. + the #GDataStreamByteOrder for the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - Puts a byte into the output stream. + Puts a byte into the output stream. - %TRUE if @data was successfully added to the @stream. + %TRUE if @data was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a #guchar. + a #guchar. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Puts a signed 16-bit integer into the output stream. + Puts a signed 16-bit integer into the output stream. - %TRUE if @data was successfully added to the @stream. + %TRUE if @data was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a #gint16. + a #gint16. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Puts a signed 32-bit integer into the output stream. + Puts a signed 32-bit integer into the output stream. - %TRUE if @data was successfully added to the @stream. + %TRUE if @data was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a #gint32. + a #gint32. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Puts a signed 64-bit integer into the stream. + Puts a signed 64-bit integer into the stream. - %TRUE if @data was successfully added to the @stream. + %TRUE if @data was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a #gint64. + a #gint64. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Puts a string into the output stream. + Puts a string into the output stream. - %TRUE if @string was successfully added to the @stream. + %TRUE if @string was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a string. + a string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Puts an unsigned 16-bit integer into the output stream. + Puts an unsigned 16-bit integer into the output stream. - %TRUE if @data was successfully added to the @stream. + %TRUE if @data was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a #guint16. + a #guint16. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Puts an unsigned 32-bit integer into the stream. + Puts an unsigned 32-bit integer into the stream. - %TRUE if @data was successfully added to the @stream. + %TRUE if @data was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a #guint32. + a #guint32. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Puts an unsigned 64-bit integer into the stream. + Puts an unsigned 64-bit integer into the stream. - %TRUE if @data was successfully added to the @stream. + %TRUE if @data was successfully added to the @stream. - a #GDataOutputStream. + a #GDataOutputStream. - a #guint64. + a #guint64. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Sets the byte order of the data output stream to @order. + Sets the byte order of the data output stream to @order. - a #GDataOutputStream. + a #GDataOutputStream. - a %GDataStreamByteOrder. + a %GDataStreamByteOrder. @@ -19945,7 +20682,7 @@ across various machine architectures. - A #GDatagramBased is a networking interface for representing datagram-based + A #GDatagramBased is a networking interface for representing datagram-based communications. It is a more or less direct mapping of the core parts of the BSD socket API in a portable GObject interface. It is implemented by #GSocket, which wraps the UNIX socket API on UNIX and winsock2 on Windows. @@ -19994,7 +20731,7 @@ To use a #GDatagramBased concurrently from multiple threads, you must implement your own locking. - Checks on the readiness of @datagram_based to perform operations. The + Checks on the readiness of @datagram_based to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @datagram_based. The result is returned. @@ -20032,22 +20769,22 @@ these flags, the output is guaranteed to be masked by @condition. This call never blocks. - the #GIOCondition mask of the current state + the #GIOCondition mask of the current state - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to check + a #GIOCondition mask to check - Waits for up to @timeout microseconds for condition to become true on + Waits for up to @timeout microseconds for condition to become true on @datagram_based. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @timeout is @@ -20055,31 +20792,31 @@ reached before the condition is met, then %FALSE is returned and @error is set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). - %TRUE if the condition was met, %FALSE otherwise + %TRUE if the condition was met, %FALSE otherwise - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to wait for + a #GIOCondition mask to wait for - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a #GCancellable + a #GCancellable - Creates a #GSource that can be attached to a #GMainContext to monitor for + Creates a #GSource that can be attached to a #GMainContext to monitor for the availability of the specified @condition on the #GDatagramBased. The #GSource keeps a reference to the @datagram_based. @@ -20095,26 +20832,26 @@ change). You can check for this in the callback using g_cancellable_is_cancelled(). - a newly allocated #GSource + a newly allocated #GSource - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to monitor + a #GIOCondition mask to monitor - a #GCancellable + a #GCancellable - Receive one or more data messages from @datagram_based in one go. + Receive one or more data messages from @datagram_based in one go. @messages must point to an array of #GInputMessage structs and @num_messages must be the length of this array. Each #GInputMessage @@ -20166,7 +20903,7 @@ messages successfully received before the error will be returned. If other error. - number of messages received, or -1 on error. Note that the number + number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -20175,36 +20912,36 @@ other error. - a #GDatagramBased + a #GDatagramBased - an array of #GInputMessage structs + an array of #GInputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags for the overall operation + an int containing #GSocketMsgFlags flags for the overall operation - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a %GCancellable + a %GCancellable - Send one or more data messages from @datagram_based in one go. + Send one or more data messages from @datagram_based in one go. @messages must point to an array of #GOutputMessage structs and @num_messages must be the length of this array. Each #GOutputMessage @@ -20247,7 +20984,7 @@ successfully sent before the error will be returned. If @cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - number of messages sent, or -1 on error. Note that the number of + number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -20255,36 +20992,36 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - a #GDatagramBased + a #GDatagramBased - an array of #GOutputMessage structs + an array of #GOutputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags + an int containing #GSocketMsgFlags flags - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a %GCancellable + a %GCancellable - Checks on the readiness of @datagram_based to perform operations. The + Checks on the readiness of @datagram_based to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @datagram_based. The result is returned. @@ -20322,22 +21059,22 @@ these flags, the output is guaranteed to be masked by @condition. This call never blocks. - the #GIOCondition mask of the current state + the #GIOCondition mask of the current state - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to check + a #GIOCondition mask to check - Waits for up to @timeout microseconds for condition to become true on + Waits for up to @timeout microseconds for condition to become true on @datagram_based. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @timeout is @@ -20345,31 +21082,31 @@ reached before the condition is met, then %FALSE is returned and @error is set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). - %TRUE if the condition was met, %FALSE otherwise + %TRUE if the condition was met, %FALSE otherwise - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to wait for + a #GIOCondition mask to wait for - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a #GCancellable + a #GCancellable - Creates a #GSource that can be attached to a #GMainContext to monitor for + Creates a #GSource that can be attached to a #GMainContext to monitor for the availability of the specified @condition on the #GDatagramBased. The #GSource keeps a reference to the @datagram_based. @@ -20385,26 +21122,26 @@ change). You can check for this in the callback using g_cancellable_is_cancelled(). - a newly allocated #GSource + a newly allocated #GSource - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to monitor + a #GIOCondition mask to monitor - a #GCancellable + a #GCancellable - Receive one or more data messages from @datagram_based in one go. + Receive one or more data messages from @datagram_based in one go. @messages must point to an array of #GInputMessage structs and @num_messages must be the length of this array. Each #GInputMessage @@ -20456,7 +21193,7 @@ messages successfully received before the error will be returned. If other error. - number of messages received, or -1 on error. Note that the number + number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -20465,36 +21202,36 @@ other error. - a #GDatagramBased + a #GDatagramBased - an array of #GInputMessage structs + an array of #GInputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags for the overall operation + an int containing #GSocketMsgFlags flags for the overall operation - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a %GCancellable + a %GCancellable - Send one or more data messages from @datagram_based in one go. + Send one or more data messages from @datagram_based in one go. @messages must point to an array of #GOutputMessage structs and @num_messages must be the length of this array. Each #GOutputMessage @@ -20537,7 +21274,7 @@ successfully sent before the error will be returned. If @cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - number of messages sent, or -1 on error. Note that the number of + number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -20545,30 +21282,30 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - a #GDatagramBased + a #GDatagramBased - an array of #GOutputMessage structs + an array of #GOutputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags + an int containing #GSocketMsgFlags flags - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a %GCancellable + a %GCancellable @@ -20589,7 +21326,7 @@ documented in the interface methods. - number of messages received, or -1 on error. Note that the number + number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -20598,30 +21335,30 @@ documented in the interface methods. - a #GDatagramBased + a #GDatagramBased - an array of #GInputMessage structs + an array of #GInputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags for the overall operation + an int containing #GSocketMsgFlags flags for the overall operation - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a %GCancellable + a %GCancellable @@ -20631,7 +21368,7 @@ documented in the interface methods. - number of messages sent, or -1 on error. Note that the number of + number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -20639,30 +21376,30 @@ documented in the interface methods. - a #GDatagramBased + a #GDatagramBased - an array of #GOutputMessage structs + an array of #GOutputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags + an int containing #GSocketMsgFlags flags - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a %GCancellable + a %GCancellable @@ -20672,20 +21409,20 @@ documented in the interface methods. - a newly allocated #GSource + a newly allocated #GSource - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to monitor + a #GIOCondition mask to monitor - a #GCancellable + a #GCancellable @@ -20695,16 +21432,16 @@ documented in the interface methods. - the #GIOCondition mask of the current state + the #GIOCondition mask of the current state - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to check + a #GIOCondition mask to check @@ -20714,25 +21451,25 @@ documented in the interface methods. - %TRUE if the condition was met, %FALSE otherwise + %TRUE if the condition was met, %FALSE otherwise - a #GDatagramBased + a #GDatagramBased - a #GIOCondition mask to wait for + a #GIOCondition mask to wait for - the maximum time (in microseconds) to wait, 0 to not block, or -1 + the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely - a #GCancellable + a #GCancellable @@ -20764,7 +21501,7 @@ returned by g_datagram_based_create_source(). - #GDesktopAppInfo is an implementation of #GAppInfo based on + #GDesktopAppInfo is an implementation of #GAppInfo based on desktop files. Note that `<gio/gdesktopappinfo.h>` belongs to the UNIX-specific @@ -20773,7 +21510,7 @@ file when using it. - Creates a new #GDesktopAppInfo based on a desktop file id. + Creates a new #GDesktopAppInfo based on a desktop file id. A desktop file id is the basename of the desktop file, including the .desktop extension. GIO is looking for a desktop file with this name @@ -20786,54 +21523,54 @@ prefix-to-subdirectory mapping that is described in the `/usr/share/applications/kde/foo.desktop`). - a new #GDesktopAppInfo, or %NULL if no desktop + a new #GDesktopAppInfo, or %NULL if no desktop file with that id exists. - the desktop file id + the desktop file id - Creates a new #GDesktopAppInfo. + Creates a new #GDesktopAppInfo. - a new #GDesktopAppInfo or %NULL on error. + a new #GDesktopAppInfo or %NULL on error. - the path of a desktop file, in the GLib + the path of a desktop file, in the GLib filename encoding - Creates a new #GDesktopAppInfo. + Creates a new #GDesktopAppInfo. - a new #GDesktopAppInfo or %NULL on error. + a new #GDesktopAppInfo or %NULL on error. - an opened #GKeyFile + an opened #GKeyFile - Gets all applications that implement @interface. + 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. - + - a list of #GDesktopAppInfo + a list of #GDesktopAppInfo objects. @@ -20841,13 +21578,13 @@ objects. - the name of the interface + the name of the interface - Searches desktop files for ones that match @search_string. + Searches desktop files for ones that match @search_string. The return value is an array of strvs. Each strv contains a list of applications that matched @search_string with an equal score. The @@ -20855,9 +21592,9 @@ outer list is sorted by score so that the first strv contains the best-matching applications, and so on. The algorithm for determining matches is undefined and may change at any time. - + - a + a list of strvs. Free each item with g_strfreev() and free the outer list with g_free(). @@ -20868,13 +21605,13 @@ any time. - the search string to use + the search string to use - Sets the name of the desktop that the application is running in. + Sets the name of the desktop that the application is running in. This is used by g_app_info_should_show() and g_desktop_app_info_get_show_in() to evaluate the `OnlyShowIn` and `NotShowIn` @@ -20889,172 +21626,172 @@ Should be called only once; subsequent calls are ignored. - a string specifying what desktop this is + a string specifying what desktop this is - Gets the user-visible display name of the "additional application + Gets the user-visible display name of the "additional application action" specified by @action_name. This corresponds to the "Name" key within the keyfile group for the action. - the locale-specific action name + the locale-specific action name - a #GDesktopAppInfo + a #GDesktopAppInfo - the name of the action as from + the name of the action as from g_desktop_app_info_list_actions() - Looks up a boolean value in the keyfile backing @info. + Looks up a boolean value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. - the boolean value, or %FALSE if the key + the boolean value, or %FALSE if the key is not found - a #GDesktopAppInfo + a #GDesktopAppInfo - the key to look up + the key to look up - Gets the categories from the desktop file. + Gets the categories from the desktop file. - The unparsed Categories key from the desktop file; + The unparsed Categories key from the desktop file; i.e. no attempt is made to split it by ';' or validate it. - a #GDesktopAppInfo + a #GDesktopAppInfo - When @info was created from a known filename, return it. In some + When @info was created from a known filename, return it. In some situations such as the #GDesktopAppInfo returned from g_desktop_app_info_new_from_keyfile(), this function will return %NULL. - The full path to the file for @info, + The full path to the file for @info, or %NULL if not known. - a #GDesktopAppInfo + a #GDesktopAppInfo - Gets the generic name from the destkop file. + Gets the generic name from the destkop file. - The value of the GenericName key + The value of the GenericName key - a #GDesktopAppInfo + a #GDesktopAppInfo - A desktop file is hidden if the Hidden key in it is + A desktop file is hidden if the Hidden key in it is set to True. - %TRUE if hidden, %FALSE otherwise. + %TRUE if hidden, %FALSE otherwise. - a #GDesktopAppInfo. + a #GDesktopAppInfo. - Gets the keywords from the desktop file. + Gets the keywords from the desktop file. - The value of the Keywords key + The value of the Keywords key - a #GDesktopAppInfo + a #GDesktopAppInfo - Looks up a localized string value in the keyfile backing @info + Looks up a localized string value in the keyfile backing @info translated to the current locale. The @key is looked up in the "Desktop Entry" group. - a newly allocated string, or %NULL if the key + a newly allocated string, or %NULL if the key is not found - a #GDesktopAppInfo + a #GDesktopAppInfo - the key to look up + the key to look up - Gets the value of the NoDisplay key, which helps determine if the + Gets the value of the NoDisplay key, which helps determine if the application info should be shown in menus. See #G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY and g_app_info_should_show(). - The value of the NoDisplay key + The value of the NoDisplay key - a #GDesktopAppInfo + a #GDesktopAppInfo - Checks if the application info should be shown in menus that list available + 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. @@ -21067,67 +21804,67 @@ Note that g_app_info_should_show() for @info will include this check (with %NULL for @desktop_env) as well as additional checks. - %TRUE if the @info should be shown in @desktop_env according to the + %TRUE if the @info should be shown in @desktop_env according to the `OnlyShowIn` and `NotShowIn` keys, %FALSE otherwise. - a #GDesktopAppInfo + a #GDesktopAppInfo - a string specifying a desktop name + a string specifying a desktop name - Retrieves the StartupWMClass field from @info. This represents the + Retrieves the StartupWMClass field from @info. This represents the WM_CLASS property of the main window of the application, if launched through @info. - the startup WM class, or %NULL if none is set + the startup WM class, or %NULL if none is set in the desktop file. - a #GDesktopAppInfo that supports startup notify + a #GDesktopAppInfo that supports startup notify - Looks up a string value in the keyfile backing @info. + Looks up a string value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. - a newly allocated string, or %NULL if the key + a newly allocated string, or %NULL if the key is not found - a #GDesktopAppInfo + a #GDesktopAppInfo - the key to look up + the key to look up - - Looks up a string list value in the keyfile backing @info. + + Looks up a string list value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. - + a %NULL-terminated string array or %NULL if the specified key cannot be found. The array should be freed with g_strfreev(). @@ -21136,40 +21873,40 @@ The @key is looked up in the "Desktop Entry" group. - a #GDesktopAppInfo + a #GDesktopAppInfo - the key to look up + the key to look up - return location for the number of returned strings, or %NULL + return location for the number of returned strings, or %NULL - Returns whether @key exists in the "Desktop Entry" group + Returns whether @key exists in the "Desktop Entry" group of the keyfile backing @info. - %TRUE if the @key exists + %TRUE if the @key exists - a #GDesktopAppInfo + a #GDesktopAppInfo - the key to look up + the key to look up - Activates the named application action. + Activates the named application action. You may only call this function on action names that were returned from g_desktop_app_info_list_actions(). @@ -21190,22 +21927,22 @@ occur while using this function. - a #GDesktopAppInfo + a #GDesktopAppInfo - the name of the action as from + the name of the action as from g_desktop_app_info_list_actions() - a #GAppLaunchContext + a #GAppLaunchContext - This function performs the equivalent of g_app_info_launch_uris(), + This function performs the equivalent of g_app_info_launch_uris(), but is intended primarily for operating system components that launch applications. Ordinary applications should use g_app_info_launch_uris(). @@ -21220,127 +21957,127 @@ optimized posix_spawn() codepath to be used. If application launching occurs via some other mechanism (eg: D-Bus activation) then @spawn_flags, @user_setup, @user_setup_data, @pid_callback and @pid_callback_data are ignored. - + - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GDesktopAppInfo + a #GDesktopAppInfo - List of URIs + List of URIs - a #GAppLaunchContext + a #GAppLaunchContext - #GSpawnFlags, used for each process + #GSpawnFlags, used for each process - a #GSpawnChildSetupFunc, used once + a #GSpawnChildSetupFunc, used once for each process. - User data for @user_setup + User data for @user_setup - Callback for child processes + Callback for child processes - User data for @callback + User data for @callback - Equivalent to g_desktop_app_info_launch_uris_as_manager() but allows + Equivalent to g_desktop_app_info_launch_uris_as_manager() but allows you to pass in file descriptors for the stdin, stdout and stderr streams of the launched process. If application launching occurs via some non-spawn mechanism (e.g. D-Bus activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. - + - %TRUE on successful launch, %FALSE otherwise. + %TRUE on successful launch, %FALSE otherwise. - a #GDesktopAppInfo + a #GDesktopAppInfo - List of URIs + List of URIs - a #GAppLaunchContext + a #GAppLaunchContext - #GSpawnFlags, used for each process + #GSpawnFlags, used for each process - a #GSpawnChildSetupFunc, used once + a #GSpawnChildSetupFunc, used once for each process. - User data for @user_setup + User data for @user_setup - Callback for child processes + Callback for child processes - User data for @callback + User data for @callback - file descriptor to use for child's stdin, or -1 + file descriptor to use for child's stdin, or -1 - file descriptor to use for child's stdout, or -1 + file descriptor to use for child's stdout, or -1 - file descriptor to use for child's stderr, or -1 + file descriptor to use for child's stderr, or -1 - Returns the list of "additional application actions" supported on the + Returns the list of "additional application actions" supported on the desktop file, as per the desktop file specification. As per the specification, this is the list of actions that are explicitly listed in the "Actions" key of the [Desktop Entry] group. - a list of strings, always non-%NULL + a list of strings, always non-%NULL - a #GDesktopAppInfo + a #GDesktopAppInfo @@ -21356,84 +22093,88 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. - + #GDesktopAppInfoLookup is an opaque data structure and can only be accessed using the following functions. - - - Gets the default application for launching applications -using this URI scheme for a particular GDesktopAppInfoLookup + The #GDesktopAppInfoLookup interface is deprecated and + unused by GIO. + + + Gets the default application for launching applications +using this URI scheme for a particular #GDesktopAppInfoLookup implementation. -The GDesktopAppInfoLookup interface and this function is used +The #GDesktopAppInfoLookup interface and this function is used to implement g_app_info_get_default_for_uri_scheme() backends in a GIO module. There is no reason for applications to use it directly. Applications should use g_app_info_get_default_for_uri_scheme(). - The #GDesktopAppInfoLookup interface is deprecated and unused by gio. - + The #GDesktopAppInfoLookup interface is deprecated and + unused by GIO. + - #GAppInfo for given @uri_scheme or %NULL on error. + #GAppInfo for given @uri_scheme or %NULL on error. - a #GDesktopAppInfoLookup + a #GDesktopAppInfoLookup - a string containing a URI scheme. + a string containing a URI scheme. - - Gets the default application for launching applications -using this URI scheme for a particular GDesktopAppInfoLookup + + Gets the default application for launching applications +using this URI scheme for a particular #GDesktopAppInfoLookup implementation. -The GDesktopAppInfoLookup interface and this function is used +The #GDesktopAppInfoLookup interface and this function is used to implement g_app_info_get_default_for_uri_scheme() backends in a GIO module. There is no reason for applications to use it directly. Applications should use g_app_info_get_default_for_uri_scheme(). - The #GDesktopAppInfoLookup interface is deprecated and unused by gio. - + The #GDesktopAppInfoLookup interface is deprecated and + unused by GIO. + - #GAppInfo for given @uri_scheme or %NULL on error. + #GAppInfo for given @uri_scheme or %NULL on error. - a #GDesktopAppInfoLookup + a #GDesktopAppInfoLookup - a string containing a URI scheme. + a string containing a URI scheme. - Interface that is used by backends to associate default + Interface that is used by backends to associate default handlers with URI schemes. - + - + - #GAppInfo for given @uri_scheme or %NULL on error. + #GAppInfo for given @uri_scheme or %NULL on error. - a #GDesktopAppInfoLookup + a #GDesktopAppInfoLookup - a string containing a URI scheme. + a string containing a URI scheme. @@ -21441,30 +22182,30 @@ handlers with URI schemes. - During invocation, g_desktop_app_info_launch_uris_as_manager() may + During invocation, g_desktop_app_info_launch_uris_as_manager() may create one or more child processes. This callback is invoked once for each, providing the process ID. - + - a #GDesktopAppInfo + a #GDesktopAppInfo - Process identifier + Process identifier - User data + User data - #GDrive - this represent a piece of hardware connected to the machine. + #GDrive - this represent a piece of hardware connected to the machine. It's generally only created for removable hardware or hardware with removable media. @@ -21492,72 +22233,72 @@ For porting from GnomeVFS note that there is no equivalent of #GDrive in that API. - Checks if a drive can be ejected. + Checks if a drive can be ejected. - %TRUE if the @drive can be ejected, %FALSE otherwise. + %TRUE if the @drive can be ejected, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be polled for media changes. + Checks if a drive can be polled for media changes. - %TRUE if the @drive can be polled for media changes, + %TRUE if the @drive can be polled for media changes, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be started. + Checks if a drive can be started. - %TRUE if the @drive can be started, %FALSE otherwise. + %TRUE if the @drive can be started, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be started degraded. + Checks if a drive can be started degraded. - %TRUE if the @drive can be started degraded, %FALSE otherwise. + %TRUE if the @drive can be started degraded, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be stopped. + Checks if a drive can be stopped. - %TRUE if the @drive can be stopped, %FALSE otherwise. + %TRUE if the @drive can be stopped, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -21585,7 +22326,7 @@ For porting from GnomeVFS note that there is no equivalent of - Asynchronously ejects a drive. + Asynchronously ejects a drive. When the operation is finished, @callback will be called. You can then call g_drive_eject_finish() to obtain the @@ -21597,23 +22338,23 @@ result of the operation. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback @@ -21630,27 +22371,27 @@ result of the operation. - Finishes ejecting a drive. + Finishes ejecting a drive. Use g_drive_eject_with_operation_finish() instead. - %TRUE if the drive has been ejected successfully, + %TRUE if the drive has been ejected successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Ejects a drive. This is an asynchronous operation, and is + Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the @drive and #GAsyncResult data returned in the @callback. @@ -21659,58 +22400,58 @@ and #GAsyncResult data returned in the @callback. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes ejecting a drive. If any errors occurred during the operation, + Finishes ejecting a drive. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the drive was successfully ejected. %FALSE otherwise. + %TRUE if the drive was successfully ejected. %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Gets the kinds of identifiers that @drive has. + Gets the kinds of identifiers that @drive has. Use g_drive_get_identifier() to obtain the identifiers themselves. - a %NULL-terminated + a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -21719,177 +22460,118 @@ themselves. - a #GDrive + a #GDrive - Gets the icon for @drive. + Gets the icon for @drive. - #GIcon for the @drive. + #GIcon for the @drive. Free the returned object with g_object_unref(). - a #GDrive. + a #GDrive. - Gets the identifier of the given kind for @drive. The only + Gets the identifier of the given kind for @drive. The only identifier currently available is #G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE. - a newly allocated string containing the + a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. - a #GDrive + a #GDrive - the kind of identifier to return + the kind of identifier to return - Gets the name of @drive. + Gets the name of @drive. - a string containing @drive's name. The returned + a string containing @drive's name. The returned string should be freed when no longer needed. - a #GDrive. + a #GDrive. - Gets the sort key for @drive, if any. + Gets the sort key for @drive, if any. - Sorting key for @drive or %NULL if no such key is available. + Sorting key for @drive or %NULL if no such key is available. - A #GDrive. + A #GDrive. - Gets a hint about how a drive can be started/stopped. + Gets a hint about how a drive can be started/stopped. - A value from the #GDriveStartStopType enumeration. + A value from the #GDriveStartStopType enumeration. - a #GDrive. + a #GDrive. - Gets the icon for @drive. + Gets the icon for @drive. - symbolic #GIcon for the @drive. + symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). - a #GDrive. + a #GDrive. - Get a list of mountable volumes for @drive. + Get a list of mountable volumes for @drive. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - #GList containing any #GVolume objects on the given @drive. + #GList containing any #GVolume objects on the given @drive. - - - a #GDrive. - - - - - - Checks if the @drive has media. Note that the OS may not be polling -the drive for media changes; see g_drive_is_media_check_automatic() -for more details. - - - %TRUE if @drive has media, %FALSE otherwise. - - - - - a #GDrive. - - - - - - Check if @drive has any mountable volumes. - - - %TRUE if the @drive contains volumes, %FALSE otherwise. - - - - - a #GDrive. - - - - - - Checks if @drive is capabable of automatically detecting media changes. - - - %TRUE if the @drive is capabable of automatically detecting - media changes, %FALSE otherwise. - - - - - a #GDrive. - - - - - - Checks if the @drive supports removable media. - - - %TRUE if @drive supports removable media, %FALSE otherwise. - - a #GDrive. @@ -21897,23 +22579,82 @@ for more details. - - Checks if the #GDrive and/or its media is considered removable by the user. -See g_drive_is_media_removable(). - + + Checks if the @drive has media. Note that the OS may not be polling +the drive for media changes; see g_drive_is_media_check_automatic() +for more details. + - %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + %TRUE if @drive has media, %FALSE otherwise. - a #GDrive. + a #GDrive. + + + + + + Check if @drive has any mountable volumes. + + + %TRUE if the @drive contains volumes, %FALSE otherwise. + + + + + a #GDrive. + + + + + + Checks if @drive is capabable of automatically detecting media changes. + + + %TRUE if the @drive is capabable of automatically detecting + media changes, %FALSE otherwise. + + + + + a #GDrive. + + + + + + Checks if the @drive supports removable media. + + + %TRUE if @drive supports removable media, %FALSE otherwise. + + + + + a #GDrive. + + + + + + Checks if the #GDrive and/or its media is considered removable by the user. +See g_drive_is_media_removable(). + + + %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + + + + + a #GDrive. - Asynchronously polls @drive to see if media has been inserted or removed. + Asynchronously polls @drive to see if media has been inserted or removed. When the operation is finished, @callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the @@ -21924,44 +22665,44 @@ result of the operation. - a #GDrive. + a #GDrive. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback - Finishes an operation started with g_drive_poll_for_media() on a drive. + Finishes an operation started with g_drive_poll_for_media() on a drive. - %TRUE if the drive has been poll_for_mediaed successfully, + %TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Asynchronously starts a drive. + Asynchronously starts a drive. When the operation is finished, @callback will be called. You can then call g_drive_start_finish() to obtain the @@ -21972,53 +22713,53 @@ result of the operation. - a #GDrive. + a #GDrive. - flags affecting the start operation. + flags affecting the start operation. - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback - Finishes starting a drive. + Finishes starting a drive. - %TRUE if the drive has been started successfully, + %TRUE if the drive has been started successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Asynchronously stops a drive. + Asynchronously stops a drive. When the operation is finished, @callback will be called. You can then call g_drive_stop_finish() to obtain the @@ -22029,28 +22770,28 @@ result of the operation. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for stopping. + flags affecting the unmount if required for stopping. - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback @@ -22067,97 +22808,97 @@ result of the operation. - Finishes stopping a drive. + Finishes stopping a drive. - %TRUE if the drive has been stopped successfully, + %TRUE if the drive has been stopped successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Checks if a drive can be ejected. + Checks if a drive can be ejected. - %TRUE if the @drive can be ejected, %FALSE otherwise. + %TRUE if the @drive can be ejected, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be polled for media changes. + Checks if a drive can be polled for media changes. - %TRUE if the @drive can be polled for media changes, + %TRUE if the @drive can be polled for media changes, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be started. + Checks if a drive can be started. - %TRUE if the @drive can be started, %FALSE otherwise. + %TRUE if the @drive can be started, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be started degraded. + Checks if a drive can be started degraded. - %TRUE if the @drive can be started degraded, %FALSE otherwise. + %TRUE if the @drive can be started degraded, %FALSE otherwise. - a #GDrive. + a #GDrive. - Checks if a drive can be stopped. + Checks if a drive can be stopped. - %TRUE if the @drive can be stopped, %FALSE otherwise. + %TRUE if the @drive can be stopped, %FALSE otherwise. - a #GDrive. + a #GDrive. - Asynchronously ejects a drive. + Asynchronously ejects a drive. When the operation is finished, @callback will be called. You can then call g_drive_eject_finish() to obtain the @@ -22169,49 +22910,49 @@ result of the operation. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback - Finishes ejecting a drive. + Finishes ejecting a drive. Use g_drive_eject_with_operation_finish() instead. - %TRUE if the drive has been ejected successfully, + %TRUE if the drive has been ejected successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Ejects a drive. This is an asynchronous operation, and is + Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the @drive and #GAsyncResult data returned in the @callback. @@ -22220,58 +22961,58 @@ and #GAsyncResult data returned in the @callback. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes ejecting a drive. If any errors occurred during the operation, + Finishes ejecting a drive. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the drive was successfully ejected. %FALSE otherwise. + %TRUE if the drive was successfully ejected. %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Gets the kinds of identifiers that @drive has. + Gets the kinds of identifiers that @drive has. Use g_drive_get_identifier() to obtain the identifiers themselves. - a %NULL-terminated + a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -22280,177 +23021,118 @@ themselves. - a #GDrive + a #GDrive - Gets the icon for @drive. + Gets the icon for @drive. - #GIcon for the @drive. + #GIcon for the @drive. Free the returned object with g_object_unref(). - a #GDrive. + a #GDrive. - Gets the identifier of the given kind for @drive. The only + Gets the identifier of the given kind for @drive. The only identifier currently available is #G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE. - a newly allocated string containing the + a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. - a #GDrive + a #GDrive - the kind of identifier to return + the kind of identifier to return - Gets the name of @drive. + Gets the name of @drive. - a string containing @drive's name. The returned + a string containing @drive's name. The returned string should be freed when no longer needed. - a #GDrive. + a #GDrive. - Gets the sort key for @drive, if any. + Gets the sort key for @drive, if any. - Sorting key for @drive or %NULL if no such key is available. + Sorting key for @drive or %NULL if no such key is available. - A #GDrive. + A #GDrive. - Gets a hint about how a drive can be started/stopped. + Gets a hint about how a drive can be started/stopped. - A value from the #GDriveStartStopType enumeration. + A value from the #GDriveStartStopType enumeration. - a #GDrive. + a #GDrive. - Gets the icon for @drive. + Gets the icon for @drive. - symbolic #GIcon for the @drive. + symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). - a #GDrive. + a #GDrive. - Get a list of mountable volumes for @drive. + Get a list of mountable volumes for @drive. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - #GList containing any #GVolume objects on the given @drive. + #GList containing any #GVolume objects on the given @drive. - - - a #GDrive. - - - - - - Checks if the @drive has media. Note that the OS may not be polling -the drive for media changes; see g_drive_is_media_check_automatic() -for more details. - - - %TRUE if @drive has media, %FALSE otherwise. - - - - - a #GDrive. - - - - - - Check if @drive has any mountable volumes. - - - %TRUE if the @drive contains volumes, %FALSE otherwise. - - - - - a #GDrive. - - - - - - Checks if @drive is capabable of automatically detecting media changes. - - - %TRUE if the @drive is capabable of automatically detecting - media changes, %FALSE otherwise. - - - - - a #GDrive. - - - - - - Checks if the @drive supports removable media. - - - %TRUE if @drive supports removable media, %FALSE otherwise. - - a #GDrive. @@ -22458,23 +23140,82 @@ for more details. - - Checks if the #GDrive and/or its media is considered removable by the user. -See g_drive_is_media_removable(). - + + Checks if the @drive has media. Note that the OS may not be polling +the drive for media changes; see g_drive_is_media_check_automatic() +for more details. + - %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + %TRUE if @drive has media, %FALSE otherwise. - a #GDrive. + a #GDrive. + + + + + + Check if @drive has any mountable volumes. + + + %TRUE if the @drive contains volumes, %FALSE otherwise. + + + + + a #GDrive. + + + + + + Checks if @drive is capabable of automatically detecting media changes. + + + %TRUE if the @drive is capabable of automatically detecting + media changes, %FALSE otherwise. + + + + + a #GDrive. + + + + + + Checks if the @drive supports removable media. + + + %TRUE if @drive supports removable media, %FALSE otherwise. + + + + + a #GDrive. + + + + + + Checks if the #GDrive and/or its media is considered removable by the user. +See g_drive_is_media_removable(). + + + %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + + + + + a #GDrive. - Asynchronously polls @drive to see if media has been inserted or removed. + Asynchronously polls @drive to see if media has been inserted or removed. When the operation is finished, @callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the @@ -22485,44 +23226,44 @@ result of the operation. - a #GDrive. + a #GDrive. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback - Finishes an operation started with g_drive_poll_for_media() on a drive. + Finishes an operation started with g_drive_poll_for_media() on a drive. - %TRUE if the drive has been poll_for_mediaed successfully, + %TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Asynchronously starts a drive. + Asynchronously starts a drive. When the operation is finished, @callback will be called. You can then call g_drive_start_finish() to obtain the @@ -22533,53 +23274,53 @@ result of the operation. - a #GDrive. + a #GDrive. - flags affecting the start operation. + flags affecting the start operation. - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback - Finishes starting a drive. + Finishes starting a drive. - %TRUE if the drive has been started successfully, + %TRUE if the drive has been started successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Asynchronously stops a drive. + Asynchronously stops a drive. When the operation is finished, @callback will be called. You can then call g_drive_stop_finish() to obtain the @@ -22590,59 +23331,59 @@ result of the operation. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for stopping. + flags affecting the unmount if required for stopping. - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback - Finishes stopping a drive. + Finishes stopping a drive. - %TRUE if the drive has been stopped successfully, + %TRUE if the drive has been stopped successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. - Emitted when the drive's state has changed. + Emitted when the drive's state has changed. - This signal is emitted when the #GDrive have been + This signal is emitted when the #GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -22651,14 +23392,14 @@ finalized. - Emitted when the physical eject button (if any) of a drive has + Emitted when the physical eject button (if any) of a drive has been pressed. - Emitted when the physical stop button (if any) of a drive has + Emitted when the physical stop button (if any) of a drive has been pressed. @@ -22715,13 +23456,13 @@ been pressed. - a string containing @drive's name. The returned + a string containing @drive's name. The returned string should be freed when no longer needed. - a #GDrive. + a #GDrive. @@ -22731,13 +23472,13 @@ been pressed. - #GIcon for the @drive. + #GIcon for the @drive. Free the returned object with g_object_unref(). - a #GDrive. + a #GDrive. @@ -22747,12 +23488,12 @@ been pressed. - %TRUE if the @drive contains volumes, %FALSE otherwise. + %TRUE if the @drive contains volumes, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -22762,26 +23503,11 @@ been pressed. - #GList containing any #GVolume objects on the given @drive. + #GList containing any #GVolume objects on the given @drive. - - - a #GDrive. - - - - - - - - - - %TRUE if @drive supports removable media, %FALSE otherwise. - - a #GDrive. @@ -22790,16 +23516,31 @@ been pressed. - - - + + + - %TRUE if @drive has media, %FALSE otherwise. + %TRUE if @drive supports removable media, %FALSE otherwise. - a #GDrive. + a #GDrive. + + + + + + + + + + %TRUE if @drive has media, %FALSE otherwise. + + + + + a #GDrive. @@ -22809,13 +23550,13 @@ been pressed. - %TRUE if the @drive is capabable of automatically detecting + %TRUE if the @drive is capabable of automatically detecting media changes, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -22825,12 +23566,12 @@ been pressed. - %TRUE if the @drive can be ejected, %FALSE otherwise. + %TRUE if the @drive can be ejected, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -22840,13 +23581,13 @@ been pressed. - %TRUE if the @drive can be polled for media changes, + %TRUE if the @drive can be polled for media changes, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -22860,23 +23601,23 @@ been pressed. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback @@ -22886,17 +23627,17 @@ been pressed. - %TRUE if the drive has been ejected successfully, + %TRUE if the drive has been ejected successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. @@ -22910,19 +23651,19 @@ been pressed. - a #GDrive. + a #GDrive. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback @@ -22932,17 +23673,17 @@ been pressed. - %TRUE if the drive has been poll_for_mediaed successfully, + %TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. @@ -22952,18 +23693,18 @@ been pressed. - a newly allocated string containing the + a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. - a #GDrive + a #GDrive - the kind of identifier to return + the kind of identifier to return @@ -22973,7 +23714,7 @@ been pressed. - a %NULL-terminated + a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -22982,7 +23723,7 @@ been pressed. - a #GDrive + a #GDrive @@ -22992,12 +23733,12 @@ been pressed. - A value from the #GDriveStartStopType enumeration. + A value from the #GDriveStartStopType enumeration. - a #GDrive. + a #GDrive. @@ -23007,12 +23748,12 @@ been pressed. - %TRUE if the @drive can be started, %FALSE otherwise. + %TRUE if the @drive can be started, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -23022,12 +23763,12 @@ been pressed. - %TRUE if the @drive can be started degraded, %FALSE otherwise. + %TRUE if the @drive can be started degraded, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -23041,28 +23782,28 @@ been pressed. - a #GDrive. + a #GDrive. - flags affecting the start operation. + flags affecting the start operation. - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback @@ -23072,17 +23813,17 @@ been pressed. - %TRUE if the drive has been started successfully, + %TRUE if the drive has been started successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. @@ -23092,12 +23833,12 @@ been pressed. - %TRUE if the @drive can be stopped, %FALSE otherwise. + %TRUE if the @drive can be stopped, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -23111,28 +23852,28 @@ been pressed. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for stopping. + flags affecting the unmount if required for stopping. - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data to pass to @callback + user data to pass to @callback @@ -23142,17 +23883,17 @@ been pressed. - %TRUE if the drive has been stopped successfully, + %TRUE if the drive has been stopped successfully, %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. @@ -23179,28 +23920,28 @@ been pressed. - a #GDrive. + a #GDrive. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. @@ -23210,16 +23951,16 @@ been pressed. - %TRUE if the drive was successfully ejected. %FALSE otherwise. + %TRUE if the drive was successfully ejected. %FALSE otherwise. - a #GDrive. + a #GDrive. - a #GAsyncResult. + a #GAsyncResult. @@ -23229,12 +23970,12 @@ been pressed. - Sorting key for @drive or %NULL if no such key is available. + Sorting key for @drive or %NULL if no such key is available. - A #GDrive. + A #GDrive. @@ -23244,13 +23985,13 @@ been pressed. - symbolic #GIcon for the @drive. + symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). - a #GDrive. + a #GDrive. @@ -23260,12 +24001,12 @@ been pressed. - %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. - a #GDrive. + a #GDrive. @@ -23305,33 +24046,33 @@ been pressed. - #GDtlsClientConnection is the client-side subclass of + #GDtlsClientConnection is the client-side subclass of #GDtlsConnection, representing a client-side DTLS connection. - Creates a new #GDtlsClientConnection wrapping @base_socket which is + Creates a new #GDtlsClientConnection wrapping @base_socket which is assumed to communicate with the server identified by @server_identity. - the new + the new #GDtlsClientConnection, or %NULL on error - the #GDatagramBased to wrap + the #GDatagramBased to wrap - the expected identity of the server + the expected identity of the server - Gets the list of distinguished names of the Certificate Authorities + Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be %NULL. @@ -23340,7 +24081,7 @@ Each item in the list is a #GByteArray which contains the complete subject DN of the certificate authority. - the list of + the list of CA DNs. You should unref each element with g_byte_array_unref() and then the free the list with g_list_free(). @@ -23351,43 +24092,43 @@ the free the list with g_list_free(). - the #GDtlsClientConnection + the #GDtlsClientConnection - Gets @conn's expected server identity + Gets @conn's expected server identity - a #GSocketConnectable describing the + a #GSocketConnectable describing the expected server identity, or %NULL if the expected identity is not known. - the #GDtlsClientConnection + the #GDtlsClientConnection - Gets @conn's validation flags + Gets @conn's validation flags - the validation flags + the validation flags - the #GDtlsClientConnection + the #GDtlsClientConnection - Sets @conn's expected server identity, which is used both to tell + Sets @conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let @conn know what name to look for in the certificate when performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. @@ -23397,17 +24138,17 @@ performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. - the #GDtlsClientConnection + the #GDtlsClientConnection - a #GSocketConnectable describing the expected server identity + a #GSocketConnectable describing the expected server identity - Sets @conn's validation flags, to override the default set of + Sets @conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, %G_TLS_CERTIFICATE_VALIDATE_ALL is used. @@ -23416,17 +24157,17 @@ checks performed when validating a server certificate. By default, - the #GDtlsClientConnection + the #GDtlsClientConnection - the #GTlsCertificateFlags to use + the #GTlsCertificateFlags to use - A list of the distinguished names of the Certificate Authorities + A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes. @@ -23438,7 +24179,7 @@ subject DN of the certificate authority. - A #GSocketConnectable describing the identity of the server that + A #GSocketConnectable describing the identity of the server that is expected on the other end of the connection. If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in @@ -23455,7 +24196,7 @@ virtual hosts. - What steps to perform when validating a certificate received from + What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in all of the ways indicated here will be rejected unless the application overrides the default via #GDtlsConnection::accept-certificate. @@ -23471,7 +24212,7 @@ overrides the default via #GDtlsConnection::accept-certificate. - #GDtlsConnection is the base DTLS connection class type, which wraps + #GDtlsConnection is the base DTLS connection class type, which wraps a #GDatagramBased and provides DTLS encryption on top of it. Its subclasses, #GDtlsClientConnection and #GDtlsServerConnection, implement client-side and server-side DTLS, respectively. @@ -23510,7 +24251,7 @@ error on further I/O. - Gets the name of the application-layer protocol negotiated during + Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a @@ -23519,18 +24260,18 @@ does not support ALPN, then this will be %NULL. See g_dtls_connection_set_advertised_protocols(). - the negotiated protocol, or %NULL + the negotiated protocol, or %NULL - a #GDtlsConnection + a #GDtlsConnection - Attempts a TLS handshake on @conn. + Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -23561,22 +24302,22 @@ older versions of GLib. handshake. - success or failure + success or failure - a #GDtlsConnection + a #GDtlsConnection - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously performs a TLS handshake on @conn. See + Asynchronously performs a TLS handshake on @conn. See g_dtls_connection_handshake() for more information. @@ -23584,49 +24325,49 @@ g_dtls_connection_handshake() for more information. - a #GDtlsConnection + a #GDtlsConnection - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the handshake is complete + callback to call when the handshake is complete - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous TLS handshake operation. See + Finish an asynchronous TLS handshake operation. See g_dtls_connection_handshake() for more information. - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set. - a #GDtlsConnection + a #GDtlsConnection - a #GAsyncResult. + a #GAsyncResult. - Sets the list of application-layer protocols to advertise that the + Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -23642,11 +24383,11 @@ for a list of registered protocol IDs. - a #GDtlsConnection + a #GDtlsConnection - a %NULL-terminated + a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -23655,7 +24396,7 @@ for a list of registered protocol IDs. - Shut down part or all of a DTLS connection. + Shut down part or all of a DTLS connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to @@ -23673,30 +24414,30 @@ partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. - %TRUE on success, %FALSE otherwise + %TRUE on success, %FALSE otherwise - a #GDtlsConnection + a #GDtlsConnection - %TRUE to stop reception of incoming datagrams + %TRUE to stop reception of incoming datagrams - %TRUE to stop sending outgoing datagrams + %TRUE to stop sending outgoing datagrams - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously shut down part or all of the DTLS connection. See + Asynchronously shut down part or all of the DTLS connection. See g_dtls_connection_shutdown() for more information. @@ -23704,57 +24445,57 @@ g_dtls_connection_shutdown() for more information. - a #GDtlsConnection + a #GDtlsConnection - %TRUE to stop reception of incoming datagrams + %TRUE to stop reception of incoming datagrams - %TRUE to stop sending outgoing datagrams + %TRUE to stop sending outgoing datagrams - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the shutdown operation is complete + callback to call when the shutdown operation is complete - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous TLS shutdown operation. See + Finish an asynchronous TLS shutdown operation. See g_dtls_connection_shutdown() for more information. - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set - a #GDtlsConnection + a #GDtlsConnection - a #GAsyncResult + a #GAsyncResult - Close the DTLS connection. This is equivalent to calling + Close the DTLS connection. This is equivalent to calling g_dtls_connection_shutdown() to shut down both sides of the connection. Closing a #GDtlsConnection waits for all buffered but untransmitted data to @@ -23773,59 +24514,9 @@ released as early as possible. If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_close() again to complete closing the #GDtlsConnection. - + - %TRUE on success, %FALSE otherwise - - - - - a #GDtlsConnection - - - - a #GCancellable, or %NULL - - - - - - Asynchronously close the DTLS connection. See g_dtls_connection_close() for -more information. - - - - - - - a #GDtlsConnection - - - - the [I/O priority][io-priority] of the request - - - - a #GCancellable, or %NULL - - - - callback to call when the close operation is complete - - - - the data to pass to the callback function - - - - - - Finish an asynchronous TLS close operation. See g_dtls_connection_close() -for more information. - - - %TRUE on success, %FALSE on failure, in which -case @error will be set + %TRUE on success, %FALSE otherwise @@ -23833,167 +24524,217 @@ case @error will be set a #GDtlsConnection + + a #GCancellable, or %NULL + + + + + + Asynchronously close the DTLS connection. See g_dtls_connection_close() for +more information. + + + + + + + a #GDtlsConnection + + + + the [I/O priority][io-priority] of the request + + + + a #GCancellable, or %NULL + + + + callback to call when the close operation is complete + + + + the data to pass to the callback function + + + + + + Finish an asynchronous TLS close operation. See g_dtls_connection_close() +for more information. + + + %TRUE on success, %FALSE on failure, in which +case @error will be set + + + + + a #GDtlsConnection + + - a #GAsyncResult + a #GAsyncResult - Used by #GDtlsConnection implementations to emit the + Used by #GDtlsConnection implementations to emit the #GDtlsConnection::accept-certificate signal. - + - %TRUE if one of the signal handlers has returned + %TRUE if one of the signal handlers has returned %TRUE to accept @peer_cert - a #GDtlsConnection + a #GDtlsConnection - the peer's #GTlsCertificate + the peer's #GTlsCertificate - the problems with @peer_cert + the problems with @peer_cert - Gets @conn's certificate, as set by + Gets @conn's certificate, as set by g_dtls_connection_set_certificate(). - @conn's certificate, or %NULL + @conn's certificate, or %NULL - a #GDtlsConnection + a #GDtlsConnection - Gets the certificate database that @conn uses to verify + Gets the certificate database that @conn uses to verify peer certificates. See g_dtls_connection_set_database(). - the certificate database that @conn uses or %NULL + the certificate database that @conn uses or %NULL - a #GDtlsConnection + a #GDtlsConnection - Get the object that will be used to interact with the user. It will be used + Get the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. If %NULL is returned, then no user interaction will occur for this connection. - The interaction object. + The interaction object. - a connection + a connection - Gets the name of the application-layer protocol negotiated during + Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_dtls_connection_set_advertised_protocols(). - + - the negotiated protocol, or %NULL + the negotiated protocol, or %NULL - a #GDtlsConnection + a #GDtlsConnection - Gets @conn's peer's certificate after the handshake has completed. + Gets @conn's peer's certificate after the handshake has completed. (It is not set during the emission of #GDtlsConnection::accept-certificate.) - @conn's peer's certificate, or %NULL + @conn's peer's certificate, or %NULL - a #GDtlsConnection + a #GDtlsConnection - Gets the errors associated with validating @conn's peer's + Gets the errors associated with validating @conn's peer's certificate, after the handshake has completed. (It is not set during the emission of #GDtlsConnection::accept-certificate.) - @conn's peer's certificate errors + @conn's peer's certificate errors - a #GDtlsConnection + a #GDtlsConnection - Gets @conn rehandshaking mode. See + Gets @conn rehandshaking mode. See g_dtls_connection_set_rehandshake_mode() for details. - + - @conn's rehandshaking mode + @conn's rehandshaking mode - a #GDtlsConnection + a #GDtlsConnection - Tests whether or not @conn expects a proper TLS close notification + Tests whether or not @conn expects a proper TLS close notification when the connection is closed. See g_dtls_connection_set_require_close_notify() for details. - %TRUE if @conn requires a proper TLS close notification. + %TRUE if @conn requires a proper TLS close notification. - a #GDtlsConnection + a #GDtlsConnection - Attempts a TLS handshake on @conn. + Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -24022,74 +24763,74 @@ older versions of GLib. #GDtlsConnection::accept_certificate may be emitted during the handshake. - + - success or failure + success or failure - a #GDtlsConnection + a #GDtlsConnection - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously performs a TLS handshake on @conn. See + Asynchronously performs a TLS handshake on @conn. See g_dtls_connection_handshake() for more information. - + - a #GDtlsConnection + a #GDtlsConnection - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the handshake is complete + callback to call when the handshake is complete - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous TLS handshake operation. See + Finish an asynchronous TLS handshake operation. See g_dtls_connection_handshake() for more information. - + - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set. - a #GDtlsConnection + a #GDtlsConnection - a #GAsyncResult. + a #GAsyncResult. - Sets the list of application-layer protocols to advertise that the + Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -24099,17 +24840,17 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + - a #GDtlsConnection + a #GDtlsConnection - a %NULL-terminated + a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -24118,7 +24859,7 @@ for a list of registered protocol IDs. - This sets the certificate that @conn will present to its peer + This sets the certificate that @conn will present to its peer during the TLS handshake. For a #GDtlsServerConnection, it is mandatory to set this, and that will normally be done at construct time. @@ -24142,17 +24883,17 @@ non-%NULL.) - a #GDtlsConnection + a #GDtlsConnection - the certificate to use for @conn + the certificate to use for @conn - Sets the certificate database that is used to verify peer certificates. + Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to %NULL, then peer certificate validation will always set the @@ -24166,17 +24907,17 @@ client-side connections, unless that bit is not set in - a #GDtlsConnection + a #GDtlsConnection - a #GTlsDatabase + a #GTlsDatabase - Set the object that will be used to interact with the user. It will be used + Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. The @interaction argument will normally be a derived subclass of @@ -24188,17 +24929,17 @@ should occur for this connection. - a connection + a connection - an interaction object, or %NULL + an interaction object, or %NULL - Sets how @conn behaves with respect to rehandshaking requests. + Sets how @conn behaves with respect to rehandshaking requests. %G_TLS_REHANDSHAKE_NEVER means that it will never agree to rehandshake after the initial handshake is complete. (For a client, @@ -24221,23 +24962,23 @@ software. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + - a #GDtlsConnection + a #GDtlsConnection - the rehandshaking mode + the rehandshaking mode - Sets whether or not @conn expects a proper TLS close notification + Sets whether or not @conn expects a proper TLS close notification before the connection is closed. If this is %TRUE (the default), then @conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a @@ -24268,17 +25009,17 @@ than closing @conn itself. - a #GDtlsConnection + a #GDtlsConnection - whether or not to require close notification + whether or not to require close notification - Shut down part or all of a DTLS connection. + Shut down part or all of a DTLS connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to @@ -24294,90 +25035,90 @@ is equivalent to calling g_dtls_connection_close(). If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. - + - %TRUE on success, %FALSE otherwise + %TRUE on success, %FALSE otherwise - a #GDtlsConnection + a #GDtlsConnection - %TRUE to stop reception of incoming datagrams + %TRUE to stop reception of incoming datagrams - %TRUE to stop sending outgoing datagrams + %TRUE to stop sending outgoing datagrams - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously shut down part or all of the DTLS connection. See + Asynchronously shut down part or all of the DTLS connection. See g_dtls_connection_shutdown() for more information. - + - a #GDtlsConnection + a #GDtlsConnection - %TRUE to stop reception of incoming datagrams + %TRUE to stop reception of incoming datagrams - %TRUE to stop sending outgoing datagrams + %TRUE to stop sending outgoing datagrams - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the shutdown operation is complete + callback to call when the shutdown operation is complete - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous TLS shutdown operation. See + Finish an asynchronous TLS shutdown operation. See g_dtls_connection_shutdown() for more information. - + - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set - a #GDtlsConnection + a #GDtlsConnection - a #GAsyncResult + a #GAsyncResult - The list of application-layer protocols that the connection + The list of application-layer protocols that the connection advertises that it is willing to speak. See g_dtls_connection_set_advertised_protocols(). @@ -24385,34 +25126,34 @@ g_dtls_connection_set_advertised_protocols(). - The #GDatagramBased that the connection wraps. Note that this may be any + The #GDatagramBased that the connection wraps. Note that this may be any implementation of #GDatagramBased, not just a #GSocket. - The connection's certificate; see + The connection's certificate; see g_dtls_connection_set_certificate(). - The certificate database to use when verifying this TLS connection. + The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database(). - A #GTlsInteraction object to be used when the connection or certificate + A #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. - The application-layer protocol negotiated during the TLS + The application-layer protocol negotiated during the TLS handshake. See g_dtls_connection_get_negotiated_protocol(). - The connection's peer's certificate, after the TLS handshake has + The connection's peer's certificate, after the TLS handshake has completed and the certificate has been accepted. Note in particular that this is not yet set during the emission of #GDtlsConnection::accept-certificate. @@ -24422,7 +25163,7 @@ detect when a handshake has occurred.) - The errors noticed-and-ignored while verifying + The errors noticed-and-ignored while verifying #GDtlsConnection:peer-certificate. Normally this should be 0, but it may not be if #GDtlsClientConnection:validation-flags is not %G_TLS_CERTIFICATE_VALIDATE_ALL, or if @@ -24431,7 +25172,7 @@ behavior. - The rehandshaking mode. See + The rehandshaking mode. See g_dtls_connection_set_rehandshake_mode(). Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed @@ -24439,12 +25180,12 @@ g_dtls_connection_set_rehandshake_mode(). - Whether or not proper TLS close notification is required. + Whether or not proper TLS close notification is required. See g_dtls_connection_set_require_close_notify(). - Emitted during the TLS handshake after the peer certificate has + Emitted during the TLS handshake after the peer certificate has been received. You can examine @peer_cert's certification path by calling g_tls_certificate_get_issuer() on it. @@ -24478,7 +25219,7 @@ If you are doing I/O in another thread, you do not need to worry about this, and can simply block in the signal handler until the UI thread returns an answer. - %TRUE to accept @peer_cert (which will also + %TRUE to accept @peer_cert (which will also immediately end the signal emission). %FALSE to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it. @@ -24486,11 +25227,11 @@ no one else overrides it. - the peer's #GTlsCertificate + the peer's #GTlsCertificate - the problems with @peer_cert. + the problems with @peer_cert. @@ -24526,16 +25267,16 @@ no one else overrides it. - success or failure + success or failure - a #GDtlsConnection + a #GDtlsConnection - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -24549,23 +25290,23 @@ no one else overrides it. - a #GDtlsConnection + a #GDtlsConnection - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the handshake is complete + callback to call when the handshake is complete - the data to pass to the callback function + the data to pass to the callback function @@ -24575,17 +25316,17 @@ no one else overrides it. - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set. - a #GDtlsConnection + a #GDtlsConnection - a #GAsyncResult. + a #GAsyncResult. @@ -24595,24 +25336,24 @@ case @error will be set. - %TRUE on success, %FALSE otherwise + %TRUE on success, %FALSE otherwise - a #GDtlsConnection + a #GDtlsConnection - %TRUE to stop reception of incoming datagrams + %TRUE to stop reception of incoming datagrams - %TRUE to stop sending outgoing datagrams + %TRUE to stop sending outgoing datagrams - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -24626,31 +25367,31 @@ case @error will be set. - a #GDtlsConnection + a #GDtlsConnection - %TRUE to stop reception of incoming datagrams + %TRUE to stop reception of incoming datagrams - %TRUE to stop sending outgoing datagrams + %TRUE to stop sending outgoing datagrams - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the shutdown operation is complete + callback to call when the shutdown operation is complete - the data to pass to the callback function + the data to pass to the callback function @@ -24660,17 +25401,17 @@ case @error will be set. - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set - a #GDtlsConnection + a #GDtlsConnection - a #GAsyncResult + a #GAsyncResult @@ -24684,11 +25425,11 @@ case @error will be set - a #GDtlsConnection + a #GDtlsConnection - a %NULL-terminated + a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -24701,12 +25442,12 @@ case @error will be set - the negotiated protocol, or %NULL + the negotiated protocol, or %NULL - a #GDtlsConnection + a #GDtlsConnection @@ -24714,32 +25455,32 @@ case @error will be set - #GDtlsServerConnection is the server-side subclass of #GDtlsConnection, + #GDtlsServerConnection is the server-side subclass of #GDtlsConnection, representing a server-side DTLS connection. - Creates a new #GDtlsServerConnection wrapping @base_socket. + Creates a new #GDtlsServerConnection wrapping @base_socket. - the new + the new #GDtlsServerConnection, or %NULL on error - the #GDatagramBased to wrap + the #GDatagramBased to wrap - the default server certificate, or %NULL + the default server certificate, or %NULL - The #GTlsAuthenticationMode for the server. This can be changed + The #GTlsAuthenticationMode for the server. This can be changed before calling g_dtls_connection_handshake() if you want to rehandshake with a different mode from the initial handshake. @@ -24753,8 +25494,50 @@ rehandshake with a different mode from the initial handshake. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - #GEmblem is an implementation of #GIcon that supports + #GEmblem is an implementation of #GIcon that supports having an emblem, which is an icon with additional properties. It can than be added to a #GEmblemedIcon. @@ -24763,62 +25546,62 @@ supported. More may be added in the future. - Creates a new emblem for @icon. + Creates a new emblem for @icon. - a new #GEmblem. + a new #GEmblem. - a GIcon containing the icon. + a GIcon containing the icon. - Creates a new emblem for @icon. + Creates a new emblem for @icon. - a new #GEmblem. + a new #GEmblem. - a GIcon containing the icon. + a GIcon containing the icon. - a GEmblemOrigin enum defining the emblem's origin + a GEmblemOrigin enum defining the emblem's origin - Gives back the icon from @emblem. + Gives back the icon from @emblem. - a #GIcon. The returned object belongs to + a #GIcon. The returned object belongs to the emblem and should not be modified or freed. - a #GEmblem from which the icon should be extracted. + a #GEmblem from which the icon should be extracted. - Gets the origin of the emblem. + Gets the origin of the emblem. - the origin of the emblem + the origin of the emblem - a #GEmblem + a #GEmblem @@ -24834,23 +25617,23 @@ supported. More may be added in the future. - GEmblemOrigin is used to add information about the origin of the emblem + GEmblemOrigin is used to add information about the origin of the emblem to #GEmblem. - Emblem of unknown origin + Emblem of unknown origin - Emblem adds device-specific information + Emblem adds device-specific information - Emblem depicts live metadata, such as "readonly" + Emblem depicts live metadata, such as "readonly" - Emblem comes from a user-defined tag, e.g. set by nautilus (in the future) + Emblem comes from a user-defined tag, e.g. set by nautilus (in the future) - #GEmblemedIcon is an implementation of #GIcon that supports + #GEmblemedIcon is an implementation of #GIcon that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via g_emblemed_icon_add_emblem(). @@ -24859,58 +25642,58 @@ of the emblems. See also #GEmblem for more information. - Creates a new emblemed icon for @icon with the emblem @emblem. + Creates a new emblemed icon for @icon with the emblem @emblem. - a new #GIcon + a new #GIcon - a #GIcon + a #GIcon - a #GEmblem, or %NULL + a #GEmblem, or %NULL - Adds @emblem to the #GList of #GEmblems. + Adds @emblem to the #GList of #GEmblems. - a #GEmblemedIcon + a #GEmblemedIcon - a #GEmblem + a #GEmblem - Removes all the emblems from @icon. + Removes all the emblems from @icon. - a #GEmblemedIcon + a #GEmblemedIcon - Gets the list of emblems for the @icon. + Gets the list of emblems for the @icon. - a #GList of + a #GList of #GEmblems that is owned by @emblemed @@ -24918,21 +25701,21 @@ of the emblems. See also #GEmblem for more information. - a #GEmblemedIcon + a #GEmblemedIcon - Gets the main icon for @emblemed. + Gets the main icon for @emblemed. - a #GIcon that is owned by @emblemed + a #GIcon that is owned by @emblemed - a #GEmblemedIcon + a #GEmblemedIcon @@ -24956,300 +25739,328 @@ of the emblems. See also #GEmblem for more information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + - A key in the "access" namespace for checking deletion privileges. + A key in the "access" namespace for checking deletion privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to delete the file. - + - A key in the "access" namespace for getting execution privileges. + A key in the "access" namespace for getting execution privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to execute the file. - + - A key in the "access" namespace for getting read privileges. + A key in the "access" namespace for getting read privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to read the file. - + - A key in the "access" namespace for checking renaming privileges. + A key in the "access" namespace for checking renaming privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to rename the file. - + - A key in the "access" namespace for checking trashing privileges. + A key in the "access" namespace for checking trashing privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to move the file to the trash. - + - A key in the "access" namespace for getting write privileges. + A key in the "access" namespace for getting write privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to write to the file. - + - A key in the "dos" namespace for checking if the file's archive flag + A key in the "dos" namespace for checking if the file's archive flag is set. This attribute is %TRUE if the archive flag is set. This attribute is only available for DOS file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "dos" namespace for checking if the file is a NTFS mount point + A key in the "dos" namespace for checking if the file is a NTFS mount point (a volume mount or a junction point). This attribute is %TRUE if file is a reparse point of type [IO_REPARSE_TAG_MOUNT_POINT](https://msdn.microsoft.com/en-us/library/dd541667.aspx). This attribute is only available for DOS file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "dos" namespace for checking if the file's backup flag + A key in the "dos" namespace for checking if the file's backup flag is set. This attribute is %TRUE if the backup flag is set. This attribute is only available for DOS file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "dos" namespace for getting the file NTFS reparse tag. + A key in the "dos" namespace for getting the file NTFS reparse tag. This value is 0 for files that are not reparse points. See the [Reparse Tags](https://msdn.microsoft.com/en-us/library/dd541667.aspx) page for possible reparse tag values. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "etag" namespace for getting the value of the file's + A key in the "etag" namespace for getting the value of the file's entity tag. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "filesystem" namespace for getting the number of bytes of free space left on the + A key in the "filesystem" namespace for getting the number of bytes of free space left on the file system. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + - A key in the "filesystem" namespace for checking if the file system + A key in the "filesystem" namespace for checking if the file system is read only. Is set to %TRUE if the file system is read only. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "filesystem" namespace for checking if the file system + A key in the "filesystem" namespace for checking if the file system is remote. Is set to %TRUE if the file system is remote. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "filesystem" namespace for getting the total size (in bytes) of the file system, + A key in the "filesystem" namespace for getting the total size (in bytes) of the file system, used in g_file_query_filesystem_info(). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + - A key in the "filesystem" namespace for getting the file system's type. + A key in the "filesystem" namespace for getting the file system's type. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "filesystem" namespace for getting the number of bytes of used on the + A key in the "filesystem" namespace for getting the number of bytes of used on the file system. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + - A key in the "filesystem" namespace for hinting a file manager + A key in the "filesystem" namespace for hinting a file manager application whether it should preview (e.g. thumbnail) files on the file system. The value for this key contain a #GFilesystemPreviewType. - + - A key in the "gvfs" namespace that gets the name of the current + A key in the "gvfs" namespace that gets the name of the current GVFS backend in use. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "id" namespace for getting a file identifier. + A key in the "id" namespace for getting a file identifier. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. An example use would be during listing files, to avoid recursive directory scanning. - + - A key in the "id" namespace for getting the file system identifier. + A key in the "id" namespace for getting the file system identifier. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. An example use would be during drag and drop to see if the source and target are on the same filesystem (default to move) or not (default to copy). - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected. + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable. + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled. + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started. + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started degraded. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped. + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable. + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for getting the HAL UDI for the mountable + A key in the "mountable" namespace for getting the HAL UDI for the mountable file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) + A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is automatically polled for media. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "mountable" namespace for getting the #GDriveStartStopType. + A key in the "mountable" namespace for getting the #GDriveStartStopType. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "mountable" namespace for getting the unix device. + A key in the "mountable" namespace for getting the unix device. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "mountable" namespace for getting the unix device file. + A key in the "mountable" namespace for getting the unix device file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "owner" namespace for getting the file owner's group. + A key in the "owner" namespace for getting the file owner's group. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "owner" namespace for getting the user name of the + A key in the "owner" namespace for getting the user name of the file's owner. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "owner" namespace for getting the real name of the + A key in the "owner" namespace for getting the real name of the user that owns the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "preview" namespace for getting a #GIcon that can be + A key in the "preview" namespace for getting a #GIcon that can be used to get preview of the file. For example, it may be a low resolution thumbnail without metadata. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a #GIcon. - + - A key in the "recent" namespace for getting time, when the metadata for the + A key in the "recent" namespace for getting time, when the metadata for the file in `recent:///` was last changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT64. - + - A key in the "selinux" namespace for getting the file's SELinux + A key in the "selinux" namespace for getting the file's SELinux context. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only available if GLib has been built with SELinux support. - + - A key in the "standard" namespace for getting the amount of disk space + A key in the "standard" namespace for getting the amount of disk space that is consumed by the file (in bytes). This will generally be larger than the file size (due to block size overhead) but can occasionally be smaller (for example, for sparse files). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + - A key in the "standard" namespace for getting the content type of the file. + A key in the "standard" namespace for getting the content type of the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. The value for this key should contain a valid content type. - + - A key in the "standard" namespace for getting the copy name of the file. + A key in the "standard" namespace for getting the copy name of the file. The copy name is an optional version of the name. If available it's always in UTF8, and corresponds directly to the original filename (only transcoded to UTF8). This is useful if you want to copy the file to another filesystem that @@ -25257,11 +26068,11 @@ might have a different encoding. If the filename is not a valid string in the encoding selected for the filesystem it is in then the copy name will not be set. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "standard" namespace for getting the description of the file. + A key in the "standard" namespace for getting the description of the file. The description is a utf8 string that describes the file, generally containing the filename, but can also contain furter information. Example descriptions could be "filename (on hostname)" for a remote file or "filename (in trash)" @@ -25269,42 +26080,42 @@ for a file in the trash. This is useful for instance as the window title when displaying a directory or for a bookmarks menu. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "standard" namespace for getting the display name of the file. + A key in the "standard" namespace for getting the display name of the file. A display name is guaranteed to be in UTF8 and can thus be displayed in the UI. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "standard" namespace for edit name of the file. + A key in the "standard" namespace for edit name of the file. An edit name is similar to the display name, but it is meant to be used when you want to rename the file in the UI. The display name might contain information you don't want in the new filename (such as "(invalid unicode)" if the filename was in an invalid encoding). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "standard" namespace for getting the fast content type. + A key in the "standard" namespace for getting the fast content type. The fast content type isn't as reliable as the regular one, as it only uses the filename to guess it, but it is faster to calculate than the regular content type. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "standard" namespace for getting the icon for the file. + A key in the "standard" namespace for getting the icon for the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a #GIcon. - + @@ -25323,71 +26134,72 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. A key in the "standard" namespace for checking if the file is a symlink. Typically the actual type is something else, if we followed the symlink to get the type. +On Windows NTFS mountpoints are considered to be symlinks as well. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "standard" namespace for checking if a file is virtual. + A key in the "standard" namespace for checking if a file is virtual. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "standard" namespace for checking if a file is + A key in the "standard" namespace for checking if a file is volatile. This is meant for opaque, non-POSIX-like backends to indicate that the URI is not persistent. Applications should look at #G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET for the persistent URI. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "standard" namespace for getting the name of the file. + A key in the "standard" namespace for getting the name of the file. The name is the on-disk filename which may not be in any known encoding, and can thus not be generally displayed as is. Use #G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the name in a user interface. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + - A key in the "standard" namespace for getting the file's size (in bytes). + A key in the "standard" namespace for getting the file's size (in bytes). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + - A key in the "standard" namespace for setting the sort order of a file. + A key in the "standard" namespace for setting the sort order of a file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT32. An example use would be in file managers, which would use this key to set the order files are displayed. Files with smaller sort order should be sorted first, and files without sort order as if sort order was zero. - + - A key in the "standard" namespace for getting the symbolic icon for the file. + A key in the "standard" namespace for getting the symbolic icon for the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a #GIcon. - + - A key in the "standard" namespace for getting the symlink target, if the file + A key in the "standard" namespace for getting the symlink target, if the file is a symlink. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + - A key in the "standard" namespace for getting the target URI for the file, in + A key in the "standard" namespace for getting the target URI for the file, in the case of %G_FILE_TYPE_SHORTCUT or %G_FILE_TYPE_MOUNTABLE files. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + @@ -25398,14 +26210,14 @@ The value for this key should contain a #GFileType. - A key in the "thumbnail" namespace for checking if thumbnailing failed. + A key in the "thumbnail" namespace for checking if thumbnailing failed. This attribute is %TRUE if thumbnailing failed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "thumbnail" namespace for checking whether the thumbnail is outdated. + A key in the "thumbnail" namespace for checking whether the thumbnail is outdated. This attribute is %TRUE if the thumbnail is up-to-date with the file it represents, and %FALSE if the file has been modified since the thumbnail was generated. @@ -25413,185 +26225,395 @@ If %G_FILE_ATTRIBUTE_THUMBNAILING_FAILED is %TRUE and this attribute is %FALSE, it indicates that thumbnailing may be attempted again and may succeed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "thumbnail" namespace for getting the path to the thumbnail + A key in the "thumbnail" namespace for getting the path to the thumbnail image. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + - A key in the "time" namespace for getting the time the file was last + A key in the "time" namespace for getting the time the file was last accessed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was last accessed, in seconds since the UNIX epoch. - + - A key in the "time" namespace for getting the microseconds of the time + A key in the "time" namespace for getting the microseconds of the time the file was last accessed. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "time" namespace for getting the time the file was last + A key in the "time" namespace for getting the time the file was last changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was last changed, in seconds since the UNIX epoch. This corresponds to the traditional UNIX ctime. - + - A key in the "time" namespace for getting the microseconds of the time + A key in the "time" namespace for getting the microseconds of the time the file was last changed. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "time" namespace for getting the time the file was created. + A key in the "time" namespace for getting the time the file was created. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was created, in seconds since the UNIX epoch. This corresponds to the NTFS ctime. - + - A key in the "time" namespace for getting the microseconds of the time + A key in the "time" namespace for getting the microseconds of the time the file was created. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "time" namespace for getting the time the file was last + A key in the "time" namespace for getting the time the file was last modified. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was modified, in seconds since the UNIX epoch. - + - A key in the "time" namespace for getting the microseconds of the time + A key in the "time" namespace for getting the microseconds of the time the file was last modified. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "trash" namespace. When requested against + A key in the "trash" namespace. When requested against items in `trash:///`, will return the date and time when the file was trashed. The format of the returned string is YYYY-MM-DDThh:mm:ss. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + - A key in the "trash" namespace. When requested against + A key in the "trash" namespace. When requested against `trash:///` returns the number of (toplevel) items in the trash folder. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "trash" namespace. When requested against + A key in the "trash" namespace. When requested against items in `trash:///`, will return the original path to the file before it was trashed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + - A key in the "unix" namespace for getting the number of blocks allocated + A key in the "unix" namespace for getting the number of blocks allocated for the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + - A key in the "unix" namespace for getting the block size for the file + A key in the "unix" namespace for getting the block size for the file system. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "unix" namespace for getting the device id of the device the + A key in the "unix" namespace for getting the device id of the device the file is located on (see stat() documentation). This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "unix" namespace for getting the group ID for the file. + A key in the "unix" namespace for getting the group ID for the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "unix" namespace for getting the inode of the file. + A key in the "unix" namespace for getting the inode of the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + - A key in the "unix" namespace for checking if the file represents a + A key in the "unix" namespace for checking if the file represents a UNIX mount point. This attribute is %TRUE if the file is a UNIX mount point. Since 2.58, `/` is considered to be a mount point. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + - A key in the "unix" namespace for getting the mode of the file + A key in the "unix" namespace for getting the mode of the file (e.g. whether the file is a regular file, symlink, etc). See lstat() documentation. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "unix" namespace for getting the number of hard links + A key in the "unix" namespace for getting the number of hard links for a file. See lstat() documentation. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "unix" namespace for getting the device ID for the file + A key in the "unix" namespace for getting the device ID for the file (if it is a special file). See lstat() documentation. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - A key in the "unix" namespace for getting the user ID for the file. + A key in the "unix" namespace for getting the user ID for the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - #GFile is a high level abstraction for manipulating files on a + #GFile is a high level abstraction for manipulating files on a virtual file system. #GFiles are lightweight, immutable objects that do no I/O upon creation. It is necessary to understand that #GFile objects do not represent files, merely an identifier for a @@ -25674,29 +26696,29 @@ HTTP 1.1 for HTTP Etag headers, which are a very similar concept. - Constructs a #GFile from a series of elements using the correct + Constructs a #GFile from a series of elements using the correct separator for filenames. Using this function is equivalent to calling g_build_filename(), followed by g_file_new_for_path() on the result. - a new #GFile + a new #GFile - the first element in the path + the first element in the path - remaining elements in path, terminated by %NULL + remaining elements in path, terminated by %NULL - Creates a #GFile with the given argument from the command line. + Creates a #GFile with the given argument from the command line. The value of @arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. This operation never fails, but the returned object might not @@ -25712,19 +26734,19 @@ for you there. It is also always possible to use this function with #GOptionContext arguments of type %G_OPTION_ARG_FILENAME. - a new #GFile. + a new #GFile. Free the returned object with g_object_unref(). - a command line string + a command line string - Creates a #GFile with the given argument from the command line. + Creates a #GFile with the given argument from the command line. This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an @@ -25737,58 +26759,58 @@ other than the invocation of the current process. See also g_application_command_line_create_file_for_arg(). - a new #GFile + a new #GFile - a command line string + a command line string - the current working directory of the commandline + the current working directory of the commandline - Constructs a #GFile for a given path. This operation never + Constructs a #GFile for a given path. This operation never fails, but the returned object might not support any I/O operation if @path is malformed. - a new #GFile for the given @path. + a new #GFile for the given @path. Free the returned object with g_object_unref(). - a string containing a relative or absolute path. + a string containing a relative or absolute path. The string must be encoded in the glib filename encoding. - Constructs a #GFile for a given URI. This operation never + Constructs a #GFile for a given URI. This operation never fails, but the returned object might not support any I/O operation if @uri is malformed or if the uri type is not supported. - a new #GFile for the given @uri. + a new #GFile for the given @uri. Free the returned object with g_object_unref(). - a UTF-8 string containing a URI + a UTF-8 string containing a URI - Opens a file in the preferred directory for temporary files (as + Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a #GFile and #GFileIOStream pointing to it. @@ -25800,41 +26822,41 @@ Unlike the other #GFile constructors, this will return %NULL if a temporary file could not be created. - a new #GFile. + a new #GFile. Free the returned object with g_object_unref(). - Template for the file + Template for the file name, as in g_file_open_tmp(), or %NULL for a default template - on return, a #GFileIOStream for the created file + on return, a #GFileIOStream for the created file - Constructs a #GFile with the given @parse_name (i.e. something + Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the @parse_name cannot be parsed. - a new #GFile. + a new #GFile. - a file name or path to be parsed + a file name or path to be parsed - Gets an output stream for appending data to the file. + Gets an output stream for appending data to the file. If the file doesn't already exist it is created. By default files created are generally readable by everyone, @@ -25853,28 +26875,28 @@ Some file systems don't allow all file names, and may return an possible too, and depend on what kind of filesystem the file is on. - a #GFileOutputStream, or %NULL on error. + a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously opens @file for appending. + Asynchronously opens @file for appending. For more details, see g_file_append_to() which is the synchronous version of this call. @@ -25888,56 +26910,56 @@ of the operation. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file append operation started with + Finishes an asynchronous file append operation started with g_file_append_to_async(). - a valid #GFileOutputStream + a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - #GAsyncResult + #GAsyncResult - Copies the file @source to the location specified by @destination. + Copies the file @source to the location specified by @destination. Can not handle recursive copies of directories. If the flag #G_FILE_COPY_OVERWRITE is specified an already @@ -25979,40 +27001,40 @@ If you are interested in copying the #GFile object itself (not the on-disk file), see g_file_dup(). - %TRUE on success, %FALSE otherwise. + %TRUE on success, %FALSE otherwise. - input #GFile + input #GFile - destination #GFile + destination #GFile - set of #GFileCopyFlags + set of #GFileCopyFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - function to callback with + function to callback with progress information, or %NULL if progress information is not needed - user data to pass to @progress_callback + user data to pass to @progress_callback - Copies the file @source to the location specified by @destination + Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called @@ -26028,65 +27050,65 @@ g_file_copy_finish() to get the result of the operation. - input #GFile + input #GFile - destination #GFile + destination #GFile - set of #GFileCopyFlags + set of #GFileCopyFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - function to callback with progress + function to callback with progress information, or %NULL if progress information is not needed - user data to pass to @progress_callback + user data to pass to @progress_callback - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes copying the file started with g_file_copy_async(). + Finishes copying the file started with g_file_copy_async(). - a %TRUE on success, %FALSE on error. + a %TRUE on success, %FALSE on error. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Creates a new file and returns an output stream for writing to it. + Creates a new file and returns an output stream for writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -26107,29 +27129,29 @@ be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - a #GFileOutputStream for the newly created + a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously creates a new file and returns an output stream + Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist. For more details, see g_file_create() which is @@ -26144,55 +27166,55 @@ of the operation. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file create operation started with + Finishes an asynchronous file create operation started with g_file_create_async(). - a #GFileOutputStream or %NULL on error. + a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Creates a new file and returns a stream for reading and + Creates a new file and returns a stream for reading and writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -26217,29 +27239,29 @@ not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - a #GFileIOStream for the newly created + a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously creates a new file and returns a stream + Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist. For more details, see g_file_create_readwrite() which is @@ -26254,55 +27276,55 @@ the result of the operation. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file create operation started with + Finishes an asynchronous file create operation started with g_file_create_readwrite_async(). - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Deletes a file. If the @file is a directory, it will only be + Deletes a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). If @cancellable is not %NULL, then the operation can be cancelled by @@ -26310,23 +27332,23 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the file was deleted. %FALSE otherwise. + %TRUE if the file was deleted. %FALSE otherwise. - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously delete a file. If the @file is a directory, it will + Asynchronously delete a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). @@ -26335,49 +27357,49 @@ g_unlink(). - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes deleting a file started with g_file_delete_async(). + Finishes deleting a file started with g_file_delete_async(). - %TRUE if the file was deleted. %FALSE otherwise. + %TRUE if the file was deleted. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Duplicates a #GFile handle. This operation does not duplicate + Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file. @@ -26389,19 +27411,19 @@ reference count. This call does no blocking I/O. - a new #GFile that is a duplicate + a new #GFile that is a duplicate of the given #GFile. - input #GFile + input #GFile - Starts an asynchronous eject on a mountable. + Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_finish(). @@ -26416,53 +27438,53 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous eject operation started by + Finishes an asynchronous eject operation started by g_file_eject_mountable(). Use g_file_eject_mountable_with_operation_finish() instead. - %TRUE if the @file was ejected successfully. + %TRUE if the @file was ejected successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Starts an asynchronous eject on a mountable. + Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_with_operation_finish(). @@ -26476,56 +27498,56 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous eject operation started by + Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation(). - %TRUE if the @file was ejected successfully. + %TRUE if the @file was ejected successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Gets the requested information about the files in a directory. + Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -26550,32 +27572,32 @@ be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY error will be returned. Other errors are possible too. - A #GFileEnumerator if successful, + A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the requested information about the files + Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -26591,60 +27613,60 @@ the operation. - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an async enumerate children operation. + Finishes an async enumerate children operation. See g_file_enumerate_children_async(). - a #GFileEnumerator or %NULL + a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Checks if the two given #GFiles refer to the same file. + Checks if the two given #GFiles refer to the same file. Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename @@ -26653,51 +27675,51 @@ aliasing. This call does no blocking I/O. - %TRUE if @file1 and @file2 are equal. + %TRUE if @file1 and @file2 are equal. - the first #GFile + the first #GFile - the second #GFile + the second #GFile - Gets a #GMount for the #GFile. + Gets a #GMount for the #GFile. -If the #GFileIface for @file does not have a mount (e.g. -possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND -and %NULL will be returned. +#GMount is returned only for user interesting locations, see +#GVolumeMonitor. If the #GFileIface for @file does not have a #mount, +@error will be set to %G_IO_ERROR_NOT_FOUND and %NULL #will be returned. 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. - a #GMount where the @file is located + a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the mount for the file. + Asynchronously gets the mount for the file. For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call. @@ -26711,45 +27733,45 @@ get the result of the operation. - a #GFile + a #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous find mount request. + Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async(). - #GMount for given @file or %NULL on error. + #GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - a #GAsyncResult + a #GAsyncResult @@ -26766,7 +27788,7 @@ See g_file_find_enclosing_mount_async(). - Gets the child of @file for a given @display_name (i.e. a UTF-8 + Gets the child of @file for a given @display_name (i.e. a UTF-8 version of the name). If this function fails, it returns %NULL and @error will be set. This is very useful when constructing a #GFile for a new file and the user entered the filename in the @@ -26776,44 +27798,44 @@ type a filename in the file selector. This call does no blocking I/O. - a #GFile to the specified child, or + a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). - input #GFile + input #GFile - string to a possible child + string to a possible child - Gets the parent directory for the @file. + Gets the parent directory for the @file. If the @file represents the root directory of the file system, then %NULL will be returned. This call does no blocking I/O. - a #GFile structure to the + 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(). - input #GFile + input #GFile - Gets the parse name of the @file. + Gets the parse name of the @file. A parse name is a UTF-8 string that describes the file such that one can get the #GFile back using g_file_parse_name(). @@ -26829,14 +27851,14 @@ to UTF-8 the pathname is used, otherwise the IRI is used This call does no blocking I/O. - a string containing the #GFile's parse name. + a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile @@ -26867,25 +27889,25 @@ This call does no blocking I/O. - Gets the URI for the @file. + Gets the URI for the @file. This call does no blocking I/O. - a string containing the #GFile's URI. + a string containing the #GFile's URI. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile - Gets the URI scheme for a #GFile. + Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] @@ -26895,47 +27917,47 @@ Common schemes include "file", "http", "ftp", etc. This call does no blocking I/O. - a string containing the URI scheme for the given + a string containing the URI scheme for the given #GFile. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile - Checks to see if a #GFile has a given URI scheme. + Checks to see if a #GFile has a given URI scheme. This call does no blocking I/O. - %TRUE if #GFile's backend supports the + %TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. - input #GFile + input #GFile - a string containing a URI scheme + a string containing a URI scheme - Creates a hash value for a #GFile. + Creates a hash value for a #GFile. This call does no blocking I/O. - 0 if @file is not a valid #GFile, otherwise an + 0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -26943,13 +27965,13 @@ This call does no blocking I/O. - #gconstpointer to a #GFile + #gconstpointer to a #GFile - Checks to see if a file is native to the platform. + Checks to see if a file is native to the platform. A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, @@ -26962,18 +27984,18 @@ will return %FALSE, but g_file_get_path() will still return a native path. This call does no blocking I/O. - %TRUE if @file is native + %TRUE if @file is native - input #GFile + input #GFile - Creates a directory. Note that this will only create a child directory + Creates a directory. Note that this will only create a child directory of the immediate parent directory of the path or URI given by the #GFile. To recursively create directories, see g_file_make_directory_with_parents(). This function will fail if the parent directory does not exist, setting @@ -26989,73 +28011,73 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on successful creation, %FALSE otherwise. + %TRUE on successful creation, %FALSE otherwise. - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously creates a directory. + Asynchronously creates a directory. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous directory creation, started with + Finishes an asynchronous directory creation, started with g_file_make_directory_async(). - %TRUE on successful directory creation, %FALSE otherwise. + %TRUE on successful directory creation, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Creates a symbolic link named @file which contains the string + Creates a symbolic link named @file which contains the string @symlink_value. If @cancellable is not %NULL, then the operation can be cancelled by @@ -27063,28 +28085,28 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on the creation of a new symlink, %FALSE otherwise. + %TRUE on the creation of a new symlink, %FALSE otherwise. - a #GFile with the name of the symlink to create + a #GFile with the name of the symlink to create - a string with the path for the target + a string with the path for the target of the new symlink - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Recursively measures the disk usage of @file. + Recursively measures the disk usage of @file. This is essentially an analog of the 'du' command, but it also reports the number of directories and non-directory files encountered @@ -27092,7 +28114,7 @@ reports the number of directories and non-directory files encountered By default, errors are only reported against the toplevel file itself. Errors found while recursing are silently ignored, unless -%G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags. +%G_FILE_MEASURE_REPORT_ANY_ERROR is given in @flags. The returned size, @disk_usage, is in bytes and should be formatted with g_format_size() in order to get something reasonable for showing @@ -27104,47 +28126,47 @@ periodic progress updates while scanning. See the documentation for callback will be invoked. - %TRUE if successful, with the out parameters set. + %TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. - a #GFile + a #GFile - #GFileMeasureFlags + #GFileMeasureFlags - optional #GCancellable + optional #GCancellable - a #GFileMeasureProgressCallback + a #GFileMeasureProgressCallback - user_data for @progress_callback + user_data for @progress_callback - the number of bytes of disk space used + the number of bytes of disk space used - the number of directories encountered + the number of directories encountered - the number of non-directories encountered + the number of non-directories encountered - Recursively measures the disk usage of @file. + Recursively measures the disk usage of @file. This is the asynchronous version of g_file_measure_disk_usage(). See there for more information. @@ -27154,74 +28176,74 @@ there for more information. - a #GFile + a #GFile - #GFileMeasureFlags + #GFileMeasureFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable + optional #GCancellable - a #GFileMeasureProgressCallback + a #GFileMeasureProgressCallback - user_data for @progress_callback + user_data for @progress_callback - a #GAsyncReadyCallback to call when complete + a #GAsyncReadyCallback to call when complete - the data to pass to callback function + the data to pass to callback function - Collects the results from an earlier call to + Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information. - %TRUE if successful, with the out parameters set. + %TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. - a #GFile + a #GFile - the #GAsyncResult passed to your #GAsyncReadyCallback + the #GAsyncResult passed to your #GAsyncReadyCallback - the number of bytes of disk space used + the number of bytes of disk space used - the number of directories encountered + the number of directories encountered - the number of non-directories encountered + the number of non-directories encountered - Obtains a directory monitor for the given file. + Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported. If @cancellable is not %NULL, then the operation can be cancelled by @@ -27235,29 +28257,29 @@ directory for changes made via hard links; if you want to do this then you must register individual watches with g_file_monitor(). - a #GFileMonitor for the given @file, + a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileMonitorFlags + a set of #GFileMonitorFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Obtains a file monitor for the given file. If no file notification + Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used. If @cancellable is not %NULL, then the operation can be cancelled by @@ -27273,29 +28295,29 @@ usage, and may not have any effect depending on the #GFileMonitor backend and/or filesystem type. - a #GFileMonitor for the given @file, + a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileMonitorFlags + a set of #GFileMonitorFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Starts a @mount_operation, mounting the volume that contains + Starts a @mount_operation, mounting the volume that contains the file @location. When this operation has completed, @callback will be called with @@ -27311,56 +28333,56 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a mount operation started by g_file_mount_enclosing_volume(). + Finishes a mount operation started by g_file_mount_enclosing_volume(). - %TRUE if successful. If an error has occurred, + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Mounts a file of type G_FILE_TYPE_MOUNTABLE. + Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using @mount_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -27377,58 +28399,58 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a mount operation. See g_file_mount_mountable() for details. + Finishes a mount operation. See g_file_mount_mountable() for details. Finish an asynchronous mount operation that was started with g_file_mount_mountable(). - a #GFile or %NULL on error. + a #GFile or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Tries to move the file or directory @source to the location specified + Tries to move the file or directory @source to the location specified by @destination. If native move operations are supported then this is used, otherwise a copy + delete fallback is used. The native implementation may support moving directories (for instance on moves @@ -27467,41 +28489,41 @@ the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native move operation isn't available). - %TRUE on successful move, %FALSE otherwise. + %TRUE on successful move, %FALSE otherwise. - #GFile pointing to the source location + #GFile pointing to the source location - #GFile pointing to the destination location + #GFile pointing to the destination location - set of #GFileCopyFlags + set of #GFileCopyFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - #GFileProgressCallback + #GFileProgressCallback function for updates - gpointer to user data for + gpointer to user data for the callback function - Opens an existing file for reading and writing. The result is + Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file. @@ -27519,23 +28541,23 @@ really need to do read and write streaming, rather than just opening for reading or writing. - #GFileIOStream or %NULL on error. + #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - #GFile to open + #GFile to open - a #GCancellable + a #GCancellable - Asynchronously opens @file for reading and writing. + Asynchronously opens @file for reading and writing. For more details, see g_file_open_readwrite() which is the synchronous version of this call. @@ -27549,51 +28571,51 @@ the result of the operation. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file read operation started with + Finishes an asynchronous file read operation started with g_file_open_readwrite_async(). - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Polls a file of type #G_FILE_TYPE_MOUNTABLE. + Polls a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -27608,48 +28630,48 @@ the result of the operation. - input #GFile + input #GFile - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a poll operation. See g_file_poll_mountable() for details. + Finishes a poll operation. See g_file_poll_mountable() for details. Finish an asynchronous poll operation that was polled with g_file_poll_mountable(). - %TRUE if the operation finished successfully. %FALSE + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Checks whether @file has the prefix specified by @prefix. + Checks whether @file has the prefix specified by @prefix. In other words, if the names of initial elements of @file's pathname match @prefix. Only full pathname elements are matched, @@ -27665,23 +28687,23 @@ filesystem point of view), because the prefix of @file is an alias of @prefix. - %TRUE if the @files's parent, grandparent, etc is @prefix, + %TRUE if the @files's parent, grandparent, etc is @prefix, %FALSE otherwise. - input #GFile + input #GFile - input #GFile + input #GFile - Similar to g_file_query_info(), but obtains information + Similar to g_file_query_info(), but obtains information about the filesystem the @file is on, rather than the file itself. For instance the amount of space available and the type of the filesystem. @@ -27708,28 +28730,28 @@ be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - a #GFileInfo or %NULL if there was an error. + a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the requested information about the filesystem + Asynchronously gets the requested information about the filesystem that the specified @file is on. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -27746,56 +28768,56 @@ operation. - input #GFile + input #GFile - an attribute query string + an attribute query string - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous filesystem info query. + Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async(). - #GFileInfo for given @file + #GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Gets the requested information about specified @file. + Gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as the type or size of the file). @@ -27827,32 +28849,32 @@ returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - a #GFileInfo for the given @file, or %NULL + a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the requested information about specified @file. + Asynchronously gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -27867,60 +28889,60 @@ then call g_file_query_info_finish() to get the result of the operation. - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file info query. + Finishes an asynchronous file info query. See g_file_query_info_async(). - #GFileInfo for given @file + #GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Obtain the list of settable attributes for the file. + Obtain the list of settable attributes for the file. Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will @@ -27932,25 +28954,25 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GFileAttributeInfoList describing the settable attributes. + a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Obtain the list of attribute namespaces where new attributes + Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace). @@ -27959,25 +28981,25 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GFileAttributeInfoList describing the writable namespaces. + a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously opens @file for reading. + Asynchronously opens @file for reading. For more details, see g_file_read() which is the synchronous version of this call. @@ -27991,51 +29013,51 @@ of the operation. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file read operation started with + Finishes an asynchronous file read operation started with g_file_read_async(). - a #GFileInputStream or %NULL on error. + a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Opens a file for reading. The result is a #GFileInputStream that + Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -28048,23 +29070,23 @@ error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - #GFileInputStream or %NULL on error. + #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). - #GFile to read + #GFile to read - a #GCancellable + a #GCancellable - Returns an output stream for overwriting the file, possibly + Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -28107,37 +29129,37 @@ file systems don't allow all file names, and may return an possible too, and depend on what kind of filesystem the file is on. - a #GFileOutputStream or %NULL on error. + a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an optional [entity tag][gfile-etag] + an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously overwrites the file, replacing the contents, + Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first. For more details, see g_file_replace() which is @@ -28152,64 +29174,64 @@ of the operation. - input #GFile + input #GFile - an [entity tag][gfile-etag] for the current #GFile, + an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file replace operation started with + Finishes an asynchronous file replace operation started with g_file_replace_async(). - a #GFileOutputStream, or %NULL on error. + a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Returns an output stream for overwriting the file in readwrite mode, + Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -28221,37 +29243,37 @@ supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - an optional [entity tag][gfile-etag] + an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously overwrites the file in read-write mode, + Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first. @@ -28267,86 +29289,86 @@ the result of the operation. - input #GFile + input #GFile - an [entity tag][gfile-etag] for the current #GFile, + an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file replace operation started with + Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async(). - a #GFileIOStream, or %NULL on error. + a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Resolves a relative path for @file to an absolute path. + Resolves a relative path for @file to an absolute path. This call does no blocking I/O. - #GFile to the resolved path. + #GFile to the resolved path. %NULL if @relative_path is %NULL or if @file is invalid. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a given relative path string + a given relative path string - Sets an attribute in the file with attribute name @attribute to @value. + Sets an attribute in the file with attribute name @attribute to @value. Some attributes can be unset by setting @type to %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. @@ -28356,40 +29378,40 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the attribute was set, %FALSE otherwise. + %TRUE if the attribute was set, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - The type of the attribute + The type of the attribute - a pointer to the value (or the pointer + a pointer to the value (or the pointer itself if the type is a pointer type) - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously sets the attributes of @file with @info. + Asynchronously sets the attributes of @file with @info. For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call. @@ -28403,60 +29425,60 @@ the result of the operation. - input #GFile + input #GFile - a #GFileInfo + a #GFileInfo - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback + a #GAsyncReadyCallback - a #gpointer + a #gpointer - Finishes setting an attribute started in g_file_set_attributes_async(). + Finishes setting an attribute started in g_file_set_attributes_async(). - %TRUE if the attributes were set correctly, %FALSE otherwise. + %TRUE if the attributes were set correctly, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - a #GFileInfo + a #GFileInfo - Tries to set all attributes in the #GFileInfo on the target + Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error. If there is any error during this operation then @error will @@ -28470,31 +29492,31 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %FALSE if there was any error, %TRUE otherwise. + %FALSE if there was any error, %TRUE otherwise. - input #GFile + input #GFile - a #GFileInfo + a #GFileInfo - #GFileQueryInfoFlags + #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Renames @file to the specified display name. + Renames @file to the specified display name. The display name is converted from UTF-8 to the correct encoding for the target filesystem if possible and the @file is renamed to this. @@ -28511,29 +29533,29 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GFile specifying what @file was renamed to, + a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a string + a string - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously sets the display name for a given #GFile. + Asynchronously sets the display name for a given #GFile. For more details, see g_file_set_display_name() which is the synchronous version of this call. @@ -28547,55 +29569,55 @@ the result of the operation. - input #GFile + input #GFile - a string + a string - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes setting a display name started with + Finishes setting a display name started with g_file_set_display_name_async(). - a #GFile or %NULL on error. + a #GFile or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Starts a file of type #G_FILE_TYPE_MOUNTABLE. + Starts a file of type #G_FILE_TYPE_MOUNTABLE. Using @start_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -28612,55 +29634,55 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, or %NULL to avoid user interaction + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a start operation. See g_file_start_mountable() for details. + Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable(). - %TRUE if the operation finished successfully. %FALSE + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Stops a file of type #G_FILE_TYPE_MOUNTABLE. + Stops a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -28675,58 +29697,58 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction. - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an stop operation, see g_file_stop_mountable() for details. + Finishes an stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable(). - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Sends @file to the "Trashcan", if possible. This is similar to + Sends @file to the "Trashcan", if possible. This is similar to deleting it, but the user can recover it before emptying the trashcan. Not all file systems support trashing, so this call can return the %G_IO_ERROR_NOT_SUPPORTED error. @@ -28736,73 +29758,73 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on successful trash, %FALSE otherwise. + %TRUE on successful trash, %FALSE otherwise. - #GFile to send to trash + #GFile to send to trash - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously sends @file to the Trash location, if possible. + Asynchronously sends @file to the Trash location, if possible. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file trashing operation, started with + Finishes an asynchronous file trashing operation, started with g_file_trash_async(). - %TRUE on successful trash, %FALSE otherwise. + %TRUE on successful trash, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Unmounts a file of type G_FILE_TYPE_MOUNTABLE. + Unmounts a file of type G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -28818,31 +29840,31 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an unmount operation, see g_file_unmount_mountable() for details. + Finishes an unmount operation, see g_file_unmount_mountable() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable(). @@ -28850,23 +29872,23 @@ with g_file_unmount_mountable(). instead. - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. + Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -28881,59 +29903,59 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an unmount operation, + Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation(). - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Gets an output stream for appending data to the file. + Gets an output stream for appending data to the file. If the file doesn't already exist it is created. By default files created are generally readable by everyone, @@ -28952,28 +29974,28 @@ Some file systems don't allow all file names, and may return an possible too, and depend on what kind of filesystem the file is on. - a #GFileOutputStream, or %NULL on error. + a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously opens @file for appending. + Asynchronously opens @file for appending. For more details, see g_file_append_to() which is the synchronous version of this call. @@ -28987,56 +30009,56 @@ of the operation. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file append operation started with + Finishes an asynchronous file append operation started with g_file_append_to_async(). - a valid #GFileOutputStream + a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - #GAsyncResult + #GAsyncResult - Copies the file @source to the location specified by @destination. + Copies the file @source to the location specified by @destination. Can not handle recursive copies of directories. If the flag #G_FILE_COPY_OVERWRITE is specified an already @@ -29078,40 +30100,40 @@ If you are interested in copying the #GFile object itself (not the on-disk file), see g_file_dup(). - %TRUE on success, %FALSE otherwise. + %TRUE on success, %FALSE otherwise. - input #GFile + input #GFile - destination #GFile + destination #GFile - set of #GFileCopyFlags + set of #GFileCopyFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - function to callback with + function to callback with progress information, or %NULL if progress information is not needed - user data to pass to @progress_callback + user data to pass to @progress_callback - Copies the file @source to the location specified by @destination + Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called @@ -29127,47 +30149,47 @@ g_file_copy_finish() to get the result of the operation. - input #GFile + input #GFile - destination #GFile + destination #GFile - set of #GFileCopyFlags + set of #GFileCopyFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - function to callback with progress + function to callback with progress information, or %NULL if progress information is not needed - user data to pass to @progress_callback + user data to pass to @progress_callback - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Copies the file attributes from @source to @destination. + Copies the file attributes from @source to @destination. Normally only a subset of the file attributes are copied, those that are copies in a normal file copy operation @@ -29177,50 +30199,50 @@ all the metadata that is possible to copy is copied. This is useful when implementing move by copy + delete source. - %TRUE if the attributes were copied successfully, + %TRUE if the attributes were copied successfully, %FALSE otherwise. - a #GFile with attributes + a #GFile with attributes - a #GFile to copy attributes to + a #GFile to copy attributes to - a set of #GFileCopyFlags + a set of #GFileCopyFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Finishes copying the file started with g_file_copy_async(). + Finishes copying the file started with g_file_copy_async(). - a %TRUE on success, %FALSE on error. + a %TRUE on success, %FALSE on error. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Creates a new file and returns an output stream for writing to it. + Creates a new file and returns an output stream for writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -29241,29 +30263,29 @@ be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - a #GFileOutputStream for the newly created + a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously creates a new file and returns an output stream + Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist. For more details, see g_file_create() which is @@ -29278,55 +30300,55 @@ of the operation. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file create operation started with + Finishes an asynchronous file create operation started with g_file_create_async(). - a #GFileOutputStream or %NULL on error. + a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Creates a new file and returns a stream for reading and + Creates a new file and returns a stream for reading and writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -29351,29 +30373,29 @@ not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - a #GFileIOStream for the newly created + a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously creates a new file and returns a stream + Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist. For more details, see g_file_create_readwrite() which is @@ -29388,55 +30410,55 @@ the result of the operation. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file create operation started with + Finishes an asynchronous file create operation started with g_file_create_readwrite_async(). - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Deletes a file. If the @file is a directory, it will only be + Deletes a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). If @cancellable is not %NULL, then the operation can be cancelled by @@ -29444,23 +30466,23 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the file was deleted. %FALSE otherwise. + %TRUE if the file was deleted. %FALSE otherwise. - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously delete a file. If the @file is a directory, it will + Asynchronously delete a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). @@ -29469,49 +30491,49 @@ g_unlink(). - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes deleting a file started with g_file_delete_async(). + Finishes deleting a file started with g_file_delete_async(). - %TRUE if the file was deleted. %FALSE otherwise. + %TRUE if the file was deleted. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Duplicates a #GFile handle. This operation does not duplicate + Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file. @@ -29523,19 +30545,19 @@ reference count. This call does no blocking I/O. - a new #GFile that is a duplicate + a new #GFile that is a duplicate of the given #GFile. - input #GFile + input #GFile - Starts an asynchronous eject on a mountable. + Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_finish(). @@ -29550,53 +30572,53 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous eject operation started by + Finishes an asynchronous eject operation started by g_file_eject_mountable(). Use g_file_eject_mountable_with_operation_finish() instead. - %TRUE if the @file was ejected successfully. + %TRUE if the @file was ejected successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Starts an asynchronous eject on a mountable. + Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_with_operation_finish(). @@ -29610,56 +30632,56 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous eject operation started by + Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation(). - %TRUE if the @file was ejected successfully. + %TRUE if the @file was ejected successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Gets the requested information about the files in a directory. + Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -29684,32 +30706,32 @@ be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY error will be returned. Other errors are possible too. - A #GFileEnumerator if successful, + A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the requested information about the files + Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -29725,60 +30747,60 @@ the operation. - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an async enumerate children operation. + Finishes an async enumerate children operation. See g_file_enumerate_children_async(). - a #GFileEnumerator or %NULL + a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Checks if the two given #GFiles refer to the same file. + Checks if the two given #GFiles refer to the same file. Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename @@ -29787,51 +30809,51 @@ aliasing. This call does no blocking I/O. - %TRUE if @file1 and @file2 are equal. + %TRUE if @file1 and @file2 are equal. - the first #GFile + the first #GFile - the second #GFile + the second #GFile - Gets a #GMount for the #GFile. + Gets a #GMount for the #GFile. -If the #GFileIface for @file does not have a mount (e.g. -possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND -and %NULL will be returned. +#GMount is returned only for user interesting locations, see +#GVolumeMonitor. If the #GFileIface for @file does not have a #mount, +@error will be set to %G_IO_ERROR_NOT_FOUND and %NULL #will be returned. 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. - a #GMount where the @file is located + a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the mount for the file. + Asynchronously gets the mount for the file. For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call. @@ -29845,51 +30867,51 @@ get the result of the operation. - a #GFile + a #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous find mount request. + Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async(). - #GMount for given @file or %NULL on error. + #GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - a #GAsyncResult + a #GAsyncResult - Gets the base name (the last component of the path) for a given #GFile. + Gets the base name (the last component of the path) for a given #GFile. If called for the top level of a system (such as the filesystem root or a uri like sftp://host/) it will return a single directory separator @@ -29904,20 +30926,20 @@ attribute with g_file_query_info(). This call does no blocking I/O. - string containing the #GFile's + 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. - input #GFile + input #GFile - Gets a child of @file with basename equal to @name. + Gets a child of @file with basename equal to @name. Note that the file with that specific name might not exist, but you can still have a #GFile that points to it. You can use this @@ -29926,23 +30948,23 @@ for instance to create that file. This call does no blocking I/O. - a #GFile to a child specified by @name. + a #GFile to a child specified by @name. Free the returned object with g_object_unref(). - input #GFile + input #GFile - string containing the child's basename + string containing the child's basename - Gets the child of @file for a given @display_name (i.e. a UTF-8 + Gets the child of @file for a given @display_name (i.e. a UTF-8 version of the name). If this function fails, it returns %NULL and @error will be set. This is very useful when constructing a #GFile for a new file and the user entered the filename in the @@ -29952,44 +30974,44 @@ type a filename in the file selector. This call does no blocking I/O. - a #GFile to the specified child, or + a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). - input #GFile + input #GFile - string to a possible child + string to a possible child - Gets the parent directory for the @file. + Gets the parent directory for the @file. If the @file represents the root directory of the file system, then %NULL will be returned. This call does no blocking I/O. - a #GFile structure to the + 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(). - input #GFile + input #GFile - Gets the parse name of the @file. + Gets the parse name of the @file. A parse name is a UTF-8 string that describes the file such that one can get the #GFile back using g_file_parse_name(). @@ -30005,44 +31027,44 @@ to UTF-8 the pathname is used, otherwise the IRI is used This call does no blocking I/O. - a string containing the #GFile's parse name. + a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile - Gets the local pathname for #GFile, if one exists. If non-%NULL, this is + Gets the local pathname for #GFile, if one exists. If non-%NULL, this is guaranteed to be an absolute, canonical path. It might contain symlinks. This call does no blocking I/O. - string containing the #GFile's path, + 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. - input #GFile + input #GFile - Gets the path for @descendant relative to @parent. + Gets the path for @descendant relative to @parent. This call does no blocking I/O. - string with the relative path from + 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. @@ -30050,35 +31072,35 @@ This call does no blocking I/O. - input #GFile + input #GFile - input #GFile + input #GFile - Gets the URI for the @file. + Gets the URI for the @file. This call does no blocking I/O. - a string containing the #GFile's URI. + a string containing the #GFile's URI. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile - Gets the URI scheme for a #GFile. + Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] @@ -30088,43 +31110,43 @@ Common schemes include "file", "http", "ftp", etc. This call does no blocking I/O. - a string containing the URI scheme for the given + a string containing the URI scheme for the given #GFile. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile - Checks if @file has a parent, and optionally, if it is @parent. + Checks if @file has a parent, and optionally, if it is @parent. If @parent is %NULL then this function returns %TRUE if @file has any parent at all. If @parent is non-%NULL then %TRUE is only returned if @file is an immediate child of @parent. - %TRUE if @file is an immediate child of @parent (or any parent in + %TRUE if @file is an immediate child of @parent (or any parent in the case that @parent is %NULL). - input #GFile + input #GFile - the parent to check for, or %NULL + the parent to check for, or %NULL - Checks whether @file has the prefix specified by @prefix. + Checks whether @file has the prefix specified by @prefix. In other words, if the names of initial elements of @file's pathname match @prefix. Only full pathname elements are matched, @@ -30140,50 +31162,50 @@ filesystem point of view), because the prefix of @file is an alias of @prefix. - %TRUE if the @files's parent, grandparent, etc is @prefix, + %TRUE if the @files's parent, grandparent, etc is @prefix, %FALSE otherwise. - input #GFile + input #GFile - input #GFile + input #GFile - Checks to see if a #GFile has a given URI scheme. + Checks to see if a #GFile has a given URI scheme. This call does no blocking I/O. - %TRUE if #GFile's backend supports the + %TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. - input #GFile + input #GFile - a string containing a URI scheme + a string containing a URI scheme - Creates a hash value for a #GFile. + Creates a hash value for a #GFile. This call does no blocking I/O. - 0 if @file is not a valid #GFile, otherwise an + 0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -30191,13 +31213,13 @@ This call does no blocking I/O. - #gconstpointer to a #GFile + #gconstpointer to a #GFile - Checks to see if a file is native to the platform. + Checks to see if a file is native to the platform. A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, @@ -30210,18 +31232,18 @@ will return %FALSE, but g_file_get_path() will still return a native path. This call does no blocking I/O. - %TRUE if @file is native + %TRUE if @file is native - input #GFile + input #GFile - Loads the contents of @file and returns it as #GBytes. + Loads the contents of @file and returns it as #GBytes. If @file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling @@ -30234,27 +31256,27 @@ this is not included in the #GBytes length. The resulting #GBytes should be freed with g_bytes_unref() when no longer in use. - a #GBytes or %NULL and @error is set + a #GBytes or %NULL and @error is set - a #GFile + a #GFile - a #GCancellable or %NULL + a #GCancellable or %NULL - a location to place the current + a location to place the current entity tag for the file, or %NULL if the entity tag is not needed - Asynchronously loads the contents of @file as #GBytes. + Asynchronously loads the contents of @file as #GBytes. If @file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling @@ -30270,26 +31292,26 @@ See g_file_load_bytes() for more information. - a #GFile + a #GFile - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Completes an asynchronous request to g_file_load_bytes_async(). + Completes an asynchronous request to g_file_load_bytes_async(). For resources, @etag_out will be set to %NULL. @@ -30300,27 +31322,27 @@ freed with g_bytes_unref() when no longer in use. See g_file_load_bytes() for more information. - a #GBytes or %NULL and @error is set + a #GBytes or %NULL and @error is set - a #GFile + a #GFile - a #GAsyncResult provided to the callback + a #GAsyncResult provided to the callback - a location to place the current + a location to place the current entity tag for the file, or %NULL if the entity tag is not needed - Loads the content of the file into memory. The data is always + Loads the content of the file into memory. The data is always zero-terminated, but this is not included in the resultant @length. The returned @content should be freed with g_free() when no longer needed. @@ -30330,39 +31352,39 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the @file's contents were successfully loaded. + %TRUE if the @file's contents were successfully loaded. %FALSE if there were errors. - input #GFile + input #GFile - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a location to place the contents of the file + a location to place the contents of the file - a location to place the length of the contents of the file, + a location to place the length of the contents of the file, or %NULL if the length is not needed - a location to place the current entity tag for the file, + a location to place the current entity tag for the file, or %NULL if the entity tag is not needed - Starts an asynchronous load of the @file's contents. + Starts an asynchronous load of the @file's contents. For more details, see g_file_load_contents() which is the synchronous version of this call. @@ -30381,64 +31403,64 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous load of the @file's contents. + Finishes an asynchronous load of the @file's contents. The contents are placed in @contents, and @length is set to the size of the @contents string. The @content should be freed with g_free() when no longer needed. If @etag_out is present, it will be set to the new entity tag for the @file. - %TRUE if the load was successful. If %FALSE and @error is + %TRUE if the load was successful. If %FALSE and @error is present, it will be set appropriately. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - a location to place the contents of the file + a location to place the contents of the file - a location to place the length of the contents of the file, + a location to place the length of the contents of the file, or %NULL if the length is not needed - a location to place the current entity tag for the file, + a location to place the current entity tag for the file, or %NULL if the entity tag is not needed - Reads the partial contents of a file. A #GFileReadMoreCallback should + Reads the partial contents of a file. A #GFileReadMoreCallback should be used to stop reading from the file when appropriate, else this function will behave exactly as g_file_load_contents_async(). This operation can be finished by g_file_load_partial_contents_finish(). @@ -30455,71 +31477,71 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a + a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to the callback functions + the data to pass to the callback functions - Finishes an asynchronous partial load operation that was started + Finishes an asynchronous partial load operation that was started with g_file_load_partial_contents_async(). The data is always zero-terminated, but this is not included in the resultant @length. The returned @content should be freed with g_free() when no longer needed. - %TRUE if the load was successful. If %FALSE and @error is + %TRUE if the load was successful. If %FALSE and @error is present, it will be set appropriately. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - a location to place the contents of the file + a location to place the contents of the file - a location to place the length of the contents of the file, + a location to place the length of the contents of the file, or %NULL if the length is not needed - a location to place the current entity tag for the file, + a location to place the current entity tag for the file, or %NULL if the entity tag is not needed - Creates a directory. Note that this will only create a child directory + Creates a directory. Note that this will only create a child directory of the immediate parent directory of the path or URI given by the #GFile. To recursively create directories, see g_file_make_directory_with_parents(). This function will fail if the parent directory does not exist, setting @@ -30535,73 +31557,73 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on successful creation, %FALSE otherwise. + %TRUE on successful creation, %FALSE otherwise. - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously creates a directory. + Asynchronously creates a directory. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous directory creation, started with + Finishes an asynchronous directory creation, started with g_file_make_directory_async(). - %TRUE on successful directory creation, %FALSE otherwise. + %TRUE on successful directory creation, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Creates a directory and any parent directories that may not + Creates a directory and any parent directories that may not exist similar to 'mkdir -p'. If the file system does not support creating directories, this function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists, @@ -30616,24 +31638,24 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if all directories have been successfully created, %FALSE + %TRUE if all directories have been successfully created, %FALSE otherwise. - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Creates a symbolic link named @file which contains the string + Creates a symbolic link named @file which contains the string @symlink_value. If @cancellable is not %NULL, then the operation can be cancelled by @@ -30641,28 +31663,28 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on the creation of a new symlink, %FALSE otherwise. + %TRUE on the creation of a new symlink, %FALSE otherwise. - a #GFile with the name of the symlink to create + a #GFile with the name of the symlink to create - a string with the path for the target + a string with the path for the target of the new symlink - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Recursively measures the disk usage of @file. + Recursively measures the disk usage of @file. This is essentially an analog of the 'du' command, but it also reports the number of directories and non-directory files encountered @@ -30670,7 +31692,7 @@ reports the number of directories and non-directory files encountered By default, errors are only reported against the toplevel file itself. Errors found while recursing are silently ignored, unless -%G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags. +%G_FILE_MEASURE_REPORT_ANY_ERROR is given in @flags. The returned size, @disk_usage, is in bytes and should be formatted with g_format_size() in order to get something reasonable for showing @@ -30682,47 +31704,47 @@ periodic progress updates while scanning. See the documentation for callback will be invoked. - %TRUE if successful, with the out parameters set. + %TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. - a #GFile + a #GFile - #GFileMeasureFlags + #GFileMeasureFlags - optional #GCancellable + optional #GCancellable - a #GFileMeasureProgressCallback + a #GFileMeasureProgressCallback - user_data for @progress_callback + user_data for @progress_callback - the number of bytes of disk space used + the number of bytes of disk space used - the number of directories encountered + the number of directories encountered - the number of non-directories encountered + the number of non-directories encountered - Recursively measures the disk usage of @file. + Recursively measures the disk usage of @file. This is the asynchronous version of g_file_measure_disk_usage(). See there for more information. @@ -30732,74 +31754,74 @@ there for more information. - a #GFile + a #GFile - #GFileMeasureFlags + #GFileMeasureFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable + optional #GCancellable - a #GFileMeasureProgressCallback + a #GFileMeasureProgressCallback - user_data for @progress_callback + user_data for @progress_callback - a #GAsyncReadyCallback to call when complete + a #GAsyncReadyCallback to call when complete - the data to pass to callback function + the data to pass to callback function - Collects the results from an earlier call to + Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information. - %TRUE if successful, with the out parameters set. + %TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. - a #GFile + a #GFile - the #GAsyncResult passed to your #GAsyncReadyCallback + the #GAsyncResult passed to your #GAsyncReadyCallback - the number of bytes of disk space used + the number of bytes of disk space used - the number of directories encountered + the number of directories encountered - the number of non-directories encountered + the number of non-directories encountered - Obtains a file or directory monitor for the given file, + Obtains a file or directory monitor for the given file, depending on the type of the file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -30807,29 +31829,29 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GFileMonitor for the given @file, + a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileMonitorFlags + a set of #GFileMonitorFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Obtains a directory monitor for the given file. + Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported. If @cancellable is not %NULL, then the operation can be cancelled by @@ -30843,29 +31865,29 @@ directory for changes made via hard links; if you want to do this then you must register individual watches with g_file_monitor(). - a #GFileMonitor for the given @file, + a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileMonitorFlags + a set of #GFileMonitorFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Obtains a file monitor for the given file. If no file notification + Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used. If @cancellable is not %NULL, then the operation can be cancelled by @@ -30881,29 +31903,29 @@ usage, and may not have any effect depending on the #GFileMonitor backend and/or filesystem type. - a #GFileMonitor for the given @file, + a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileMonitorFlags + a set of #GFileMonitorFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Starts a @mount_operation, mounting the volume that contains + Starts a @mount_operation, mounting the volume that contains the file @location. When this operation has completed, @callback will be called with @@ -30919,56 +31941,56 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a mount operation started by g_file_mount_enclosing_volume(). + Finishes a mount operation started by g_file_mount_enclosing_volume(). - %TRUE if successful. If an error has occurred, + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Mounts a file of type G_FILE_TYPE_MOUNTABLE. + Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using @mount_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -30985,58 +32007,58 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a mount operation. See g_file_mount_mountable() for details. + Finishes a mount operation. See g_file_mount_mountable() for details. Finish an asynchronous mount operation that was started with g_file_mount_mountable(). - a #GFile or %NULL on error. + a #GFile or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Tries to move the file or directory @source to the location specified + Tries to move the file or directory @source to the location specified by @destination. If native move operations are supported then this is used, otherwise a copy + delete fallback is used. The native implementation may support moving directories (for instance on moves @@ -31075,41 +32097,41 @@ the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native move operation isn't available). - %TRUE on successful move, %FALSE otherwise. + %TRUE on successful move, %FALSE otherwise. - #GFile pointing to the source location + #GFile pointing to the source location - #GFile pointing to the destination location + #GFile pointing to the destination location - set of #GFileCopyFlags + set of #GFileCopyFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - #GFileProgressCallback + #GFileProgressCallback function for updates - gpointer to user data for + gpointer to user data for the callback function - Opens an existing file for reading and writing. The result is + Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file. @@ -31127,23 +32149,23 @@ really need to do read and write streaming, rather than just opening for reading or writing. - #GFileIOStream or %NULL on error. + #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - #GFile to open + #GFile to open - a #GCancellable + a #GCancellable - Asynchronously opens @file for reading and writing. + Asynchronously opens @file for reading and writing. For more details, see g_file_open_readwrite() which is the synchronous version of this call. @@ -31157,51 +32179,51 @@ the result of the operation. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file read operation started with + Finishes an asynchronous file read operation started with g_file_open_readwrite_async(). - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Exactly like g_file_get_path(), but caches the result via + Exactly like g_file_get_path(), but caches the result via g_object_set_qdata_full(). This is useful for example in C applications which mix `g_file_*` APIs with native ones. It also avoids an extra duplicated string when possible, so will be @@ -31210,19 +32232,19 @@ generally more efficient. This call does no blocking I/O. - string containing the #GFile's path, + string containing the #GFile's path, or %NULL if no such path exists. The returned string is owned by @file. - input #GFile + input #GFile - Polls a file of type #G_FILE_TYPE_MOUNTABLE. + Polls a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -31237,48 +32259,48 @@ the result of the operation. - input #GFile + input #GFile - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a poll operation. See g_file_poll_mountable() for details. + Finishes a poll operation. See g_file_poll_mountable() for details. Finish an asynchronous poll operation that was polled with g_file_poll_mountable(). - %TRUE if the operation finished successfully. %FALSE + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Returns the #GAppInfo that is registered as the default + Returns the #GAppInfo that is registered as the default application to handle the file specified by @file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -31286,72 +32308,73 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GAppInfo if the handle was found, + a #GAppInfo if the handle was found, %NULL if there were errors. When you are done with it, release it with g_object_unref() - a #GFile to open + a #GFile to open - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Async version of g_file_query_default_handler(). + Async version of g_file_query_default_handler(). - a #GFile to open + a #GFile to open + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the request is done + a #GAsyncReadyCallback to call when the request is done - data to pass to @callback + data to pass to @callback - Finishes a g_file_query_default_handler_async() operation. + Finishes a g_file_query_default_handler_async() operation. - a #GAppInfo if the handle was found, + a #GAppInfo if the handle was found, %NULL if there were errors. When you are done with it, release it with g_object_unref() - a #GFile to open + a #GFile to open - a #GAsyncResult + a #GAsyncResult - Utility function to check if a particular file exists. This is + Utility function to check if a particular file exists. This is implemented using g_file_query_info() and as such does blocking I/O. Note that in many cases it is [racy to first check for file existence](https://en.wikipedia.org/wiki/Time_of_check_to_time_of_use) @@ -31375,52 +32398,52 @@ dialog. If you do this, you should make sure to also handle the errors that can happen due to races when you execute the operation. - %TRUE if the file exists (and can be detected without error), + %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled). - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Utility function to inspect the #GFileType of a file. This is + Utility function to inspect the #GFileType of a file. This is implemented using g_file_query_info() and as such does blocking I/O. The primary use case of this method is to check if a file is a regular file, directory, or symlink. - The #GFileType of the file and #G_FILE_TYPE_UNKNOWN + The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file does not exist - input #GFile + input #GFile - a set of #GFileQueryInfoFlags passed to g_file_query_info() + a set of #GFileQueryInfoFlags passed to g_file_query_info() - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Similar to g_file_query_info(), but obtains information + Similar to g_file_query_info(), but obtains information about the filesystem the @file is on, rather than the file itself. For instance the amount of space available and the type of the filesystem. @@ -31447,28 +32470,28 @@ be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - a #GFileInfo or %NULL if there was an error. + a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the requested information about the filesystem + Asynchronously gets the requested information about the filesystem that the specified @file is on. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -31485,56 +32508,56 @@ operation. - input #GFile + input #GFile - an attribute query string + an attribute query string - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous filesystem info query. + Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async(). - #GFileInfo for given @file + #GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Gets the requested information about specified @file. + Gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as the type or size of the file). @@ -31566,32 +32589,32 @@ returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - a #GFileInfo for the given @file, or %NULL + a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously gets the requested information about specified @file. + Asynchronously gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -31606,60 +32629,60 @@ then call g_file_query_info_finish() to get the result of the operation. - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file info query. + Finishes an asynchronous file info query. See g_file_query_info_async(). - #GFileInfo for given @file + #GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Obtain the list of settable attributes for the file. + Obtain the list of settable attributes for the file. Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will @@ -31671,25 +32694,25 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GFileAttributeInfoList describing the settable attributes. + a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Obtain the list of attribute namespaces where new attributes + Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace). @@ -31698,25 +32721,25 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GFileAttributeInfoList describing the writable namespaces. + a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Opens a file for reading. The result is a #GFileInputStream that + Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -31729,23 +32752,23 @@ error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - #GFileInputStream or %NULL on error. + #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). - #GFile to read + #GFile to read - a #GCancellable + a #GCancellable - Asynchronously opens @file for reading. + Asynchronously opens @file for reading. For more details, see g_file_read() which is the synchronous version of this call. @@ -31759,51 +32782,51 @@ of the operation. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file read operation started with + Finishes an asynchronous file read operation started with g_file_read_async(). - a #GFileInputStream or %NULL on error. + a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Returns an output stream for overwriting the file, possibly + Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -31846,37 +32869,37 @@ file systems don't allow all file names, and may return an possible too, and depend on what kind of filesystem the file is on. - a #GFileOutputStream or %NULL on error. + a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an optional [entity tag][gfile-etag] + an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously overwrites the file, replacing the contents, + Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first. For more details, see g_file_replace() which is @@ -31891,44 +32914,44 @@ of the operation. - input #GFile + input #GFile - an [entity tag][gfile-etag] for the current #GFile, + an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Replaces the contents of @file with @contents of @length bytes. + Replaces the contents of @file with @contents of @length bytes. If @etag is specified (not %NULL), any existing file must have that etag, or the error %G_IO_ERROR_WRONG_ETAG will be returned. @@ -31946,52 +32969,52 @@ The returned @new_etag can be used to verify that the file hasn't changed the next time it is saved over. - %TRUE if successful. If an error has occurred, this function + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - input #GFile + input #GFile - a string containing the new contents for @file + a string containing the new contents for @file - the length of @contents in bytes + the length of @contents in bytes - the old [entity-tag][gfile-etag] for the document, + the old [entity-tag][gfile-etag] for the document, or %NULL - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - a location to a new [entity tag][gfile-etag] + a location to a new [entity tag][gfile-etag] for the document. This should be freed with g_free() when no longer needed, or %NULL - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Starts an asynchronous replacement of @file with the given + Starts an asynchronous replacement of @file with the given @contents of @length bytes. @etag will replace the document's current entity tag. @@ -32016,47 +33039,47 @@ contents (without copying) for the duration of the call. - input #GFile + input #GFile - string of contents to replace the file with + string of contents to replace the file with - the length of @contents in bytes + the length of @contents in bytes - a new [entity tag][gfile-etag] for the @file, or %NULL + a new [entity tag][gfile-etag] for the @file, or %NULL - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Same as g_file_replace_contents_async() but takes a #GBytes input instead. + Same as g_file_replace_contents_async() but takes a #GBytes input instead. This function will keep a ref on @contents until the operation is done. Unlike g_file_replace_contents_async() this allows forgetting about the content without waiting for the callback. @@ -32070,59 +33093,59 @@ g_file_replace_contents_finish(). - input #GFile + input #GFile - a #GBytes + a #GBytes - a new [entity tag][gfile-etag] for the @file, or %NULL + a new [entity tag][gfile-etag] for the @file, or %NULL - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous replace of the given @file. See + Finishes an asynchronous replace of the given @file. See g_file_replace_contents_async(). Sets @new_etag to the new entity tag for the document, if present. - %TRUE on success, %FALSE on failure. + %TRUE on success, %FALSE on failure. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - a location of a new [entity tag][gfile-etag] + a location of a new [entity tag][gfile-etag] for the document. This should be freed with g_free() when it is no longer needed, or %NULL @@ -32130,27 +33153,27 @@ tag for the document, if present. - Finishes an asynchronous file replace operation started with + Finishes an asynchronous file replace operation started with g_file_replace_async(). - a #GFileOutputStream, or %NULL on error. + a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Returns an output stream for overwriting the file in readwrite mode, + Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -32162,37 +33185,37 @@ supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - an optional [entity tag][gfile-etag] + an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously overwrites the file in read-write mode, + Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first. @@ -32208,86 +33231,86 @@ the result of the operation. - input #GFile + input #GFile - an [entity tag][gfile-etag] for the current #GFile, + an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file replace operation started with + Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async(). - a #GFileIOStream, or %NULL on error. + a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Resolves a relative path for @file to an absolute path. + Resolves a relative path for @file to an absolute path. This call does no blocking I/O. - #GFile to the resolved path. + #GFile to the resolved path. %NULL if @relative_path is %NULL or if @file is invalid. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a given relative path string + a given relative path string - Sets an attribute in the file with attribute name @attribute to @value. + Sets an attribute in the file with attribute name @attribute to @value. Some attributes can be unset by setting @type to %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. @@ -32297,40 +33320,40 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the attribute was set, %FALSE otherwise. + %TRUE if the attribute was set, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - The type of the attribute + The type of the attribute - a pointer to the value (or the pointer + a pointer to the value (or the pointer itself if the type is a pointer type) - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. + Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. If @attribute is of a different type, this operation will fail, returning %FALSE. @@ -32339,36 +33362,36 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the @attribute was successfully set to @value + %TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - a string containing the attribute's new value + a string containing the attribute's new value - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. + Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -32376,36 +33399,36 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the @attribute was successfully set to @value + %TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - a #gint32 containing the attribute's new value + a #gint32 containing the attribute's new value - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. + Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -32413,35 +33436,35 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the @attribute was successfully set, %FALSE otherwise. + %TRUE if the @attribute was successfully set, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - a #guint64 containing the attribute's new value + a #guint64 containing the attribute's new value - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. + Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -32449,35 +33472,35 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the @attribute was successfully set, %FALSE otherwise. + %TRUE if the @attribute was successfully set, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - a string containing the attribute's value + a string containing the attribute's value - #GFileQueryInfoFlags + #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. + Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -32485,36 +33508,36 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the @attribute was successfully set to @value + %TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - a #guint32 containing the attribute's new value + a #guint32 containing the attribute's new value - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. + Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by @@ -32522,36 +33545,36 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if the @attribute was successfully set to @value + %TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - a #guint64 containing the attribute's new value + a #guint64 containing the attribute's new value - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously sets the attributes of @file with @info. + Asynchronously sets the attributes of @file with @info. For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call. @@ -32565,60 +33588,60 @@ the result of the operation. - input #GFile + input #GFile - a #GFileInfo + a #GFileInfo - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback + a #GAsyncReadyCallback - a #gpointer + a #gpointer - Finishes setting an attribute started in g_file_set_attributes_async(). + Finishes setting an attribute started in g_file_set_attributes_async(). - %TRUE if the attributes were set correctly, %FALSE otherwise. + %TRUE if the attributes were set correctly, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - a #GFileInfo + a #GFileInfo - Tries to set all attributes in the #GFileInfo on the target + Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error. If there is any error during this operation then @error will @@ -32632,31 +33655,31 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %FALSE if there was any error, %TRUE otherwise. + %FALSE if there was any error, %TRUE otherwise. - input #GFile + input #GFile - a #GFileInfo + a #GFileInfo - #GFileQueryInfoFlags + #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Renames @file to the specified display name. + Renames @file to the specified display name. The display name is converted from UTF-8 to the correct encoding for the target filesystem if possible and the @file is renamed to this. @@ -32673,29 +33696,29 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GFile specifying what @file was renamed to, + a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a string + a string - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously sets the display name for a given #GFile. + Asynchronously sets the display name for a given #GFile. For more details, see g_file_set_display_name() which is the synchronous version of this call. @@ -32709,55 +33732,55 @@ the result of the operation. - input #GFile + input #GFile - a string + a string - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes setting a display name started with + Finishes setting a display name started with g_file_set_display_name_async(). - a #GFile or %NULL on error. + a #GFile or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Starts a file of type #G_FILE_TYPE_MOUNTABLE. + Starts a file of type #G_FILE_TYPE_MOUNTABLE. Using @start_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -32774,55 +33797,55 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, or %NULL to avoid user interaction + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes a start operation. See g_file_start_mountable() for details. + Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable(). - %TRUE if the operation finished successfully. %FALSE + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Stops a file of type #G_FILE_TYPE_MOUNTABLE. + Stops a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -32837,75 +33860,75 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction. - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an stop operation, see g_file_stop_mountable() for details. + Finishes an stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable(). - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Checks if @file supports + Checks if @file supports [thread-default contexts][g-main-context-push-thread-default-context]. If this returns %FALSE, you cannot perform asynchronous operations on @file in a thread that has a thread-default context. - Whether or not @file supports thread-default contexts. + Whether or not @file supports thread-default contexts. - a #GFile + a #GFile - Sends @file to the "Trashcan", if possible. This is similar to + Sends @file to the "Trashcan", if possible. This is similar to deleting it, but the user can recover it before emptying the trashcan. Not all file systems support trashing, so this call can return the %G_IO_ERROR_NOT_SUPPORTED error. @@ -32915,73 +33938,73 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on successful trash, %FALSE otherwise. + %TRUE on successful trash, %FALSE otherwise. - #GFile to send to trash + #GFile to send to trash - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - Asynchronously sends @file to the Trash location, if possible. + Asynchronously sends @file to the Trash location, if possible. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous file trashing operation, started with + Finishes an asynchronous file trashing operation, started with g_file_trash_async(). - %TRUE on successful trash, %FALSE otherwise. + %TRUE on successful trash, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Unmounts a file of type G_FILE_TYPE_MOUNTABLE. + Unmounts a file of type G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -32997,31 +34020,31 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an unmount operation, see g_file_unmount_mountable() for details. + Finishes an unmount operation, see g_file_unmount_mountable() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable(). @@ -33029,23 +34052,23 @@ with g_file_unmount_mountable(). instead. - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. + Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -33060,53 +34083,53 @@ the result of the operation. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function - Finishes an unmount operation, + Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation(). - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -33153,15 +34176,15 @@ The registry stores Key-Value pair formats as #GFileAttributeInfos. - Creates a new file attribute info list. + Creates a new file attribute info list. - a #GFileAttributeInfoList. + a #GFileAttributeInfoList. - Adds a new attribute with @name to the @list, setting + Adds a new attribute with @name to the @list, setting its @type and @flags. @@ -33169,72 +34192,72 @@ its @type and @flags. - a #GFileAttributeInfoList. + a #GFileAttributeInfoList. - the name of the attribute to add. + the name of the attribute to add. - the #GFileAttributeType for the attribute. + the #GFileAttributeType for the attribute. - #GFileAttributeInfoFlags for the attribute. + #GFileAttributeInfoFlags for the attribute. - Makes a duplicate of a file attribute info list. + Makes a duplicate of a file attribute info list. - a copy of the given @list. + a copy of the given @list. - a #GFileAttributeInfoList to duplicate. + a #GFileAttributeInfoList to duplicate. - Gets the file attribute with the name @name from @list. + Gets the file attribute with the name @name from @list. - a #GFileAttributeInfo for the @name, or %NULL if an + a #GFileAttributeInfo for the @name, or %NULL if an attribute isn't found. - a #GFileAttributeInfoList. + a #GFileAttributeInfoList. - the name of the attribute to lookup. + the name of the attribute to look up. - References a file attribute info list. + References a file attribute info list. - #GFileAttributeInfoList or %NULL on error. + #GFileAttributeInfoList or %NULL on error. - a #GFileAttributeInfoList to reference. + a #GFileAttributeInfoList to reference. - Removes a reference from the given @list. If the reference count + Removes a reference from the given @list. If the reference count falls to zero, the @list is deleted. @@ -33242,7 +34265,7 @@ falls to zero, the @list is deleted. - The #GFileAttributeInfoList to unreference. + The #GFileAttributeInfoList to unreference. @@ -33252,7 +34275,7 @@ falls to zero, the @list is deleted. Determines if a string matches a file attribute. - Creates a new file attribute matcher, which matches attributes + Creates a new file attribute matcher, which matches attributes against a given string. #GFileAttributeMatchers are reference counted structures, and are created with a reference count of 1. If the number of references falls to 0, the #GFileAttributeMatcher is @@ -33271,112 +34294,112 @@ The wildcard "*" may be used to match all keys and namespaces, or standard namespace. - `"standard::type,unix::*"`: matches the type key in the standard namespace and all keys in the unix namespace. - + - a #GFileAttributeMatcher + a #GFileAttributeMatcher - an attribute string to match. + an attribute string to match. - Checks if the matcher will match all of the keys in a given namespace. + Checks if the matcher will match all of the keys in a given namespace. This will always return %TRUE if a wildcard character is in use (e.g. if matcher was created with "standard::*" and @ns is "standard", or if matcher was created using "*" and namespace is anything.) TODO: this is awkwardly worded. - + - %TRUE if the matcher matches all of the entries + %TRUE if the matcher matches all of the entries in the given @ns, %FALSE otherwise. - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - a string containing a file attribute namespace. + a string containing a file attribute namespace. - Gets the next matched attribute from a #GFileAttributeMatcher. - + Gets the next matched attribute from a #GFileAttributeMatcher. + - a string containing the next attribute or %NULL if + a string containing the next attribute or %NULL if no more attribute exist. - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - Checks if an attribute will be matched by an attribute matcher. If + Checks if an attribute will be matched by an attribute matcher. If the matcher was created with the "*" matching string, this function will always return %TRUE. - + - %TRUE if @attribute matches @matcher. %FALSE otherwise. + %TRUE if @attribute matches @matcher. %FALSE otherwise. - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - a file attribute key. + a file attribute key. - Checks if a attribute matcher only matches a given attribute. Always + Checks if a attribute matcher only matches a given attribute. Always returns %FALSE if "*" was used when creating the matcher. - + - %TRUE if the matcher only matches @attribute. %FALSE otherwise. + %TRUE if the matcher only matches @attribute. %FALSE otherwise. - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - a file attribute key. + a file attribute key. - References a file attribute matcher. - + References a file attribute matcher. + - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - Subtracts all attributes of @subtract from @matcher and returns + Subtracts all attributes of @subtract from @matcher and returns a matcher that supports those attributes. Note that currently it is not possible to remove a single @@ -33384,51 +34407,51 @@ attribute when the @matcher matches the whole namespace - or remove a namespace or attribute when the matcher matches everything. This is a limitation of the current implementation, but may be fixed in the future. - + - A file attribute matcher matching all attributes of + A file attribute matcher matching all attributes of @matcher that are not matched by @subtract - Matcher to subtract from + Matcher to subtract from - The matcher to subtract + The matcher to subtract - Prints what the matcher is matching against. The format will be + Prints what the matcher is matching against. The format will be equal to the format passed to g_file_attribute_matcher_new(). The output however, might not be identical, as the matcher may decide to use a different order or omit needless parts. - + - a string describing the attributes the matcher matches + a string describing the attributes the matcher matches against or %NULL if @matcher was %NULL. - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - Unreferences @matcher. If the reference count falls below 1, + Unreferences @matcher. If the reference count falls below 1, the @matcher is automatically freed. - + - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. @@ -33524,7 +34547,7 @@ the @matcher is automatically freed. - #GFileDescriptorBased is implemented by streams (implementations of + #GFileDescriptorBased is implemented by streams (implementations of #GInputStream or #GOutputStream) that are based on file descriptors. Note that `<gio/gfiledescriptorbased.h>` belongs to the UNIX-specific @@ -33532,29 +34555,29 @@ GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file when using it. - Gets the underlying file descriptor. + Gets the underlying file descriptor. - The file descriptor + The file descriptor - a #GFileDescriptorBased. + a #GFileDescriptorBased. - Gets the underlying file descriptor. + Gets the underlying file descriptor. - The file descriptor + The file descriptor - a #GFileDescriptorBased. + a #GFileDescriptorBased. @@ -33571,12 +34594,12 @@ file when using it. - The file descriptor + The file descriptor - a #GFileDescriptorBased. + a #GFileDescriptorBased. @@ -33584,7 +34607,7 @@ file when using it. - #GFileEnumerator allows you to operate on a set of #GFiles, + #GFileEnumerator allows you to operate on a set of #GFiles, returning a #GFileInfo structure for each file enumerated (e.g. g_file_enumerate_children() will return a #GFileEnumerator for each of the children within a directory). @@ -33612,7 +34635,7 @@ a #GFileEnumerator is closed, no further actions may be performed on it, and it should be freed with g_object_unref(). - Asynchronously closes the file enumerator. + Asynchronously closes the file enumerator. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -33624,29 +34647,29 @@ g_file_enumerator_close_finish(). - a #GFileEnumerator. + a #GFileEnumerator. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes closing a file enumerator, started from g_file_enumerator_close_async(). + Finishes closing a file enumerator, started from g_file_enumerator_close_async(). If the file enumerator was already closed when g_file_enumerator_close_async() was called, then this function will report %G_IO_ERROR_CLOSED in @error, and @@ -33658,16 +34681,16 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %FALSE will be returned. - %TRUE if the close operation has finished successfully. + %TRUE if the close operation has finished successfully. - a #GFileEnumerator. + a #GFileEnumerator. - a #GAsyncResult. + a #GAsyncResult. @@ -33687,7 +34710,7 @@ returned. - Returns information for the next file in the enumerated object. + Returns information for the next file in the enumerated object. Will block until the information is available. The #GFileInfo returned from this function will contain attributes that match the attribute string that was passed when the #GFileEnumerator was created. @@ -33700,24 +34723,24 @@ enumerator is at the end, %NULL will be returned and @error will be unset. - A #GFileInfo or %NULL on error + A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. - a #GFileEnumerator. + a #GFileEnumerator. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request information for a number of files from the enumerator asynchronously. + Request information for a number of files from the enumerator asynchronously. When all i/o for the operation is finished the @callback will be called with the requested information. @@ -33742,36 +34765,36 @@ priority is %G_PRIORITY_DEFAULT. - a #GFileEnumerator. + a #GFileEnumerator. - the number of file info objects to request + the number of file info objects to request - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). + Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). - a #GList of #GFileInfos. 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. @@ -33780,17 +34803,17 @@ priority is %G_PRIORITY_DEFAULT. - a #GFileEnumerator. + a #GFileEnumerator. - a #GAsyncResult. + a #GAsyncResult. - Releases all resources used by this enumerator, making the + Releases all resources used by this enumerator, making the enumerator return %G_IO_ERROR_CLOSED on all calls. This will be automatically called when the last reference @@ -33798,22 +34821,22 @@ is dropped, but you might want to call this function to make sure resources are released as early as possible. - #TRUE on success or #FALSE on error. + #TRUE on success or #FALSE on error. - a #GFileEnumerator. + a #GFileEnumerator. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Asynchronously closes the file enumerator. + Asynchronously closes the file enumerator. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -33825,29 +34848,29 @@ g_file_enumerator_close_finish(). - a #GFileEnumerator. + a #GFileEnumerator. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes closing a file enumerator, started from g_file_enumerator_close_async(). + Finishes closing a file enumerator, started from g_file_enumerator_close_async(). If the file enumerator was already closed when g_file_enumerator_close_async() was called, then this function will report %G_IO_ERROR_CLOSED in @error, and @@ -33859,22 +34882,22 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %FALSE will be returned. - %TRUE if the close operation has finished successfully. + %TRUE if the close operation has finished successfully. - a #GFileEnumerator. + a #GFileEnumerator. - a #GAsyncResult. + a #GAsyncResult. - Return a new #GFile which refers to the file named by @info in the source + Return a new #GFile which refers to the file named by @info in the source directory of @enumerator. This function is primarily intended to be used inside loops with g_file_enumerator_next_file(). @@ -33886,65 +34909,65 @@ This is a convenience method that's equivalent to: ]| - a #GFile for the #GFileInfo passed it. + a #GFile for the #GFileInfo passed it. - a #GFileEnumerator + a #GFileEnumerator - a #GFileInfo gotten from g_file_enumerator_next_file() + a #GFileInfo gotten from g_file_enumerator_next_file() or the async equivalents. - Get the #GFile container which is being enumerated. + Get the #GFile container which is being enumerated. - the #GFile which is being enumerated. + the #GFile which is being enumerated. - a #GFileEnumerator + a #GFileEnumerator - Checks if the file enumerator has pending operations. + Checks if the file enumerator has pending operations. - %TRUE if the @enumerator has pending operations. + %TRUE if the @enumerator has pending operations. - a #GFileEnumerator. + a #GFileEnumerator. - Checks if the file enumerator has been closed. + Checks if the file enumerator has been closed. - %TRUE if the @enumerator is closed. + %TRUE if the @enumerator is closed. - a #GFileEnumerator. + a #GFileEnumerator. - This is a version of g_file_enumerator_next_file() that's easier to + 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. @@ -33988,25 +35011,25 @@ out: - an open #GFileEnumerator + an open #GFileEnumerator - Output location for the next #GFileInfo, or %NULL + Output location for the next #GFileInfo, or %NULL - Output location for the next #GFile, or %NULL + Output location for the next #GFile, or %NULL - a #GCancellable + a #GCancellable - Returns information for the next file in the enumerated object. + Returns information for the next file in the enumerated object. Will block until the information is available. The #GFileInfo returned from this function will contain attributes that match the attribute string that was passed when the #GFileEnumerator was created. @@ -34019,24 +35042,24 @@ enumerator is at the end, %NULL will be returned and @error will be unset. - A #GFileInfo or %NULL on error + A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. - a #GFileEnumerator. + a #GFileEnumerator. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request information for a number of files from the enumerator asynchronously. + Request information for a number of files from the enumerator asynchronously. When all i/o for the operation is finished the @callback will be called with the requested information. @@ -34061,36 +35084,36 @@ priority is %G_PRIORITY_DEFAULT. - a #GFileEnumerator. + a #GFileEnumerator. - the number of file info objects to request + the number of file info objects to request - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). + Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). - a #GList of #GFileInfos. 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. @@ -34099,28 +35122,28 @@ priority is %G_PRIORITY_DEFAULT. - a #GFileEnumerator. + a #GFileEnumerator. - a #GAsyncResult. + a #GAsyncResult. - Sets the file enumerator as having pending operations. + Sets the file enumerator as having pending operations. - a #GFileEnumerator. + a #GFileEnumerator. - a boolean value. + a boolean value. @@ -34144,18 +35167,18 @@ priority is %G_PRIORITY_DEFAULT. - A #GFileInfo or %NULL on error + A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. - a #GFileEnumerator. + a #GFileEnumerator. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -34185,27 +35208,27 @@ priority is %G_PRIORITY_DEFAULT. - a #GFileEnumerator. + a #GFileEnumerator. - the number of file info objects to request + the number of file info objects to request - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -34215,7 +35238,7 @@ priority is %G_PRIORITY_DEFAULT. - a #GList of #GFileInfos. 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. @@ -34224,11 +35247,11 @@ priority is %G_PRIORITY_DEFAULT. - a #GFileEnumerator. + a #GFileEnumerator. - a #GAsyncResult. + a #GAsyncResult. @@ -34242,23 +35265,23 @@ priority is %G_PRIORITY_DEFAULT. - a #GFileEnumerator. + a #GFileEnumerator. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -34268,16 +35291,16 @@ priority is %G_PRIORITY_DEFAULT. - %TRUE if the close operation has finished successfully. + %TRUE if the close operation has finished successfully. - a #GFileEnumerator. + a #GFileEnumerator. - a #GAsyncResult. + a #GAsyncResult. @@ -34344,7 +35367,7 @@ priority is %G_PRIORITY_DEFAULT. - GFileIOStream provides io streams that both read and write to the same + GFileIOStream provides io streams that both read and write to the same file handle. GFileIOStream implements #GSeekable, which allows the io @@ -34389,23 +35412,23 @@ on the output stream. - Gets the entity tag for the file when it has been written. + Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - the entity tag for the stream. + the entity tag for the stream. - a #GFileIOStream. + a #GFileIOStream. - Queries a file io stream for the given @attributes. + Queries a file io stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_io_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -34424,26 +35447,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - a #GFileInfo for the @stream, or %NULL on error. + a #GFileInfo for the @stream, or %NULL on error. - a #GFileIOStream. + a #GFileIOStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Asynchronously queries the @stream for a #GFileInfo. When completed, + Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_io_stream_query_info_finish(). @@ -34455,46 +35478,46 @@ g_file_io_stream_query_info(). - a #GFileIOStream. + a #GFileIOStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][gio-GIOScheduler] of the request + the [I/O priority][gio-GIOScheduler] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finalizes the asynchronous query started + Finalizes the asynchronous query started by g_file_io_stream_query_info_async(). - A #GFileInfo for the finished query. + A #GFileInfo for the finished query. - a #GFileIOStream. + a #GFileIOStream. - a #GAsyncResult. + a #GAsyncResult. @@ -34548,23 +35571,23 @@ by g_file_io_stream_query_info_async(). - Gets the entity tag for the file when it has been written. + Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - the entity tag for the stream. + the entity tag for the stream. - a #GFileIOStream. + a #GFileIOStream. - Queries a file io stream for the given @attributes. + Queries a file io stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_io_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -34583,26 +35606,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - a #GFileInfo for the @stream, or %NULL on error. + a #GFileInfo for the @stream, or %NULL on error. - a #GFileIOStream. + a #GFileIOStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Asynchronously queries the @stream for a #GFileInfo. When completed, + Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_io_stream_query_info_finish(). @@ -34614,46 +35637,46 @@ g_file_io_stream_query_info(). - a #GFileIOStream. + a #GFileIOStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][gio-GIOScheduler] of the request + the [I/O priority][gio-GIOScheduler] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finalizes the asynchronous query started + Finalizes the asynchronous query started by g_file_io_stream_query_info_async(). - A #GFileInfo for the finished query. + A #GFileInfo for the finished query. - a #GFileIOStream. + a #GFileIOStream. - a #GAsyncResult. + a #GAsyncResult. @@ -34754,20 +35777,20 @@ by g_file_io_stream_query_info_async(). - a #GFileInfo for the @stream, or %NULL on error. + a #GFileInfo for the @stream, or %NULL on error. - a #GFileIOStream. + a #GFileIOStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -34781,27 +35804,27 @@ by g_file_io_stream_query_info_async(). - a #GFileIOStream. + a #GFileIOStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][gio-GIOScheduler] of the request + the [I/O priority][gio-GIOScheduler] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -34811,16 +35834,16 @@ by g_file_io_stream_query_info_async(). - A #GFileInfo for the finished query. + A #GFileInfo for the finished query. - a #GFileIOStream. + a #GFileIOStream. - a #GAsyncResult. + a #GAsyncResult. @@ -34830,12 +35853,12 @@ by g_file_io_stream_query_info_async(). - the entity tag for the stream. + the entity tag for the stream. - a #GFileIOStream. + a #GFileIOStream. @@ -34886,42 +35909,42 @@ by g_file_io_stream_query_info_async(). - #GFileIcon specifies an icon by pointing to an image file + #GFileIcon specifies an icon by pointing to an image file to be used as icon. - Creates a new icon for a file. + Creates a new icon for a file. - a #GIcon for the given + a #GIcon for the given @file, or %NULL on error. - a #GFile. + a #GFile. - Gets the #GFile associated with the given @icon. + Gets the #GFile associated with the given @icon. - a #GFile, or %NULL. + a #GFile, or %NULL. - a #GIcon. + a #GIcon. - The file containing the icon. + The file containing the icon. @@ -34939,13 +35962,13 @@ to be used as icon. - a new #GFile that is a duplicate + a new #GFile that is a duplicate of the given #GFile. - input #GFile + input #GFile @@ -34955,7 +35978,7 @@ to be used as icon. - 0 if @file is not a valid #GFile, otherwise an + 0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -34963,7 +35986,7 @@ to be used as icon. - #gconstpointer to a #GFile + #gconstpointer to a #GFile @@ -34973,16 +35996,16 @@ to be used as icon. - %TRUE if @file1 and @file2 are equal. + %TRUE if @file1 and @file2 are equal. - the first #GFile + the first #GFile - the second #GFile + the second #GFile @@ -34992,12 +36015,12 @@ to be used as icon. - %TRUE if @file is native + %TRUE if @file is native - input #GFile + input #GFile @@ -35007,18 +36030,18 @@ to be used as icon. - %TRUE if #GFile's backend supports the + %TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. - input #GFile + input #GFile - a string containing a URI scheme + a string containing a URI scheme @@ -35028,14 +36051,14 @@ to be used as icon. - a string containing the URI scheme for the given + a string containing the URI scheme for the given #GFile. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile @@ -35071,14 +36094,14 @@ to be used as icon. - a string containing the #GFile's URI. + a string containing the #GFile's URI. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile @@ -35088,14 +36111,14 @@ to be used as icon. - a string containing the #GFile's parse name. + a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. - input #GFile + input #GFile @@ -35105,14 +36128,14 @@ to be used as icon. - a #GFile structure to the + 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(). - input #GFile + input #GFile @@ -35122,17 +36145,17 @@ to be used as icon. - %TRUE if the @files's parent, grandparent, etc is @prefix, + %TRUE if the @files's parent, grandparent, etc is @prefix, %FALSE otherwise. - input #GFile + input #GFile - input #GFile + input #GFile @@ -35158,18 +36181,18 @@ to be used as icon. - #GFile to the resolved path. + #GFile to the resolved path. %NULL if @relative_path is %NULL or if @file is invalid. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a given relative path string + a given relative path string @@ -35179,18 +36202,18 @@ to be used as icon. - a #GFile to the specified child, or + a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). - input #GFile + input #GFile - string to a possible child + string to a possible child @@ -35200,25 +36223,25 @@ to be used as icon. - A #GFileEnumerator if successful, + A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35233,33 +36256,33 @@ to be used as icon. - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -35269,18 +36292,18 @@ to be used as icon. - a #GFileEnumerator or %NULL + a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -35290,25 +36313,25 @@ to be used as icon. - a #GFileInfo for the given @file, or %NULL + a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35323,33 +36346,33 @@ to be used as icon. - input #GFile + input #GFile - an attribute query string + an attribute query string - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -35359,18 +36382,18 @@ to be used as icon. - #GFileInfo for given @file + #GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -35380,21 +36403,21 @@ to be used as icon. - a #GFileInfo or %NULL if there was an error. + a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an attribute query string + an attribute query string - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35409,29 +36432,29 @@ to be used as icon. - input #GFile + input #GFile - an attribute query string + an attribute query string - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -35441,18 +36464,18 @@ to be used as icon. - #GFileInfo for given @file + #GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -35462,18 +36485,18 @@ to be used as icon. - a #GMount where the @file is located + a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35488,25 +36511,25 @@ to be used as icon. - a #GFile + a #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -35516,17 +36539,17 @@ to be used as icon. - #GMount for given @file or %NULL on error. + #GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - a #GAsyncResult + a #GAsyncResult @@ -35536,22 +36559,22 @@ to be used as icon. - a #GFile specifying what @file was renamed to, + a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a string + a string - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35566,29 +36589,29 @@ to be used as icon. - input #GFile + input #GFile - a string + a string - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -35598,17 +36621,17 @@ to be used as icon. - a #GFile or %NULL on error. + a #GFile or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -35618,18 +36641,18 @@ to be used as icon. - a #GFileAttributeInfoList describing the settable attributes. + a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35656,18 +36679,18 @@ to be used as icon. - a #GFileAttributeInfoList describing the writable namespaces. + a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35694,33 +36717,33 @@ to be used as icon. - %TRUE if the attribute was set, %FALSE otherwise. + %TRUE if the attribute was set, %FALSE otherwise. - input #GFile + input #GFile - a string containing the attribute's name + a string containing the attribute's name - The type of the attribute + The type of the attribute - a pointer to the value (or the pointer + a pointer to the value (or the pointer itself if the type is a pointer type) - a set of #GFileQueryInfoFlags + a set of #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35731,24 +36754,24 @@ to be used as icon. - %FALSE if there was any error, %TRUE otherwise. + %FALSE if there was any error, %TRUE otherwise. - input #GFile + input #GFile - a #GFileInfo + a #GFileInfo - #GFileQueryInfoFlags + #GFileQueryInfoFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35763,32 +36786,32 @@ to be used as icon. - input #GFile + input #GFile - a #GFileInfo + a #GFileInfo - a #GFileQueryInfoFlags + a #GFileQueryInfoFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback + a #GAsyncReadyCallback - a #gpointer + a #gpointer @@ -35798,20 +36821,20 @@ to be used as icon. - %TRUE if the attributes were set correctly, %FALSE otherwise. + %TRUE if the attributes were set correctly, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult - a #GFileInfo + a #GFileInfo @@ -35821,17 +36844,17 @@ to be used as icon. - #GFileInputStream or %NULL on error. + #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). - #GFile to read + #GFile to read - a #GCancellable + a #GCancellable @@ -35845,25 +36868,25 @@ to be used as icon. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -35873,17 +36896,17 @@ to be used as icon. - a #GFileInputStream or %NULL on error. + a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -35893,21 +36916,21 @@ to be used as icon. - a #GFileOutputStream, or %NULL on error. + a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -35922,29 +36945,29 @@ to be used as icon. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -35954,18 +36977,18 @@ to be used as icon. - a valid #GFileOutputStream + a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - #GAsyncResult + #GAsyncResult @@ -35975,22 +36998,22 @@ to be used as icon. - a #GFileOutputStream for the newly created + a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36005,29 +37028,29 @@ to be used as icon. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36037,17 +37060,17 @@ to be used as icon. - a #GFileOutputStream or %NULL on error. + a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36057,30 +37080,30 @@ to be used as icon. - a #GFileOutputStream or %NULL on error. + a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - an optional [entity tag][gfile-etag] + an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36095,38 +37118,38 @@ to be used as icon. - input #GFile + input #GFile - an [entity tag][gfile-etag] for the current #GFile, + an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36136,17 +37159,17 @@ to be used as icon. - a #GFileOutputStream, or %NULL on error. + a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36156,16 +37179,16 @@ to be used as icon. - %TRUE if the file was deleted. %FALSE otherwise. + %TRUE if the file was deleted. %FALSE otherwise. - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36180,25 +37203,25 @@ to be used as icon. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36208,16 +37231,16 @@ to be used as icon. - %TRUE if the file was deleted. %FALSE otherwise. + %TRUE if the file was deleted. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36227,16 +37250,16 @@ to be used as icon. - %TRUE on successful trash, %FALSE otherwise. + %TRUE on successful trash, %FALSE otherwise. - #GFile to send to trash + #GFile to send to trash - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36251,25 +37274,25 @@ to be used as icon. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36279,16 +37302,16 @@ to be used as icon. - %TRUE on successful trash, %FALSE otherwise. + %TRUE on successful trash, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36298,16 +37321,16 @@ to be used as icon. - %TRUE on successful creation, %FALSE otherwise. + %TRUE on successful creation, %FALSE otherwise. - input #GFile + input #GFile - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36322,25 +37345,25 @@ to be used as icon. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36350,16 +37373,16 @@ to be used as icon. - %TRUE on successful directory creation, %FALSE otherwise. + %TRUE on successful directory creation, %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36369,21 +37392,21 @@ to be used as icon. - %TRUE on the creation of a new symlink, %FALSE otherwise. + %TRUE on the creation of a new symlink, %FALSE otherwise. - a #GFile with the name of the symlink to create + a #GFile with the name of the symlink to create - a string with the path for the target + a string with the path for the target of the new symlink - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36410,34 +37433,34 @@ to be used as icon. - %TRUE on success, %FALSE otherwise. + %TRUE on success, %FALSE otherwise. - input #GFile + input #GFile - destination #GFile + destination #GFile - set of #GFileCopyFlags + set of #GFileCopyFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - function to callback with + function to callback with progress information, or %NULL if progress information is not needed - user data to pass to @progress_callback + user data to pass to @progress_callback @@ -36451,41 +37474,41 @@ to be used as icon. - input #GFile + input #GFile - destination #GFile + destination #GFile - set of #GFileCopyFlags + set of #GFileCopyFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - function to callback with progress + function to callback with progress information, or %NULL if progress information is not needed - user data to pass to @progress_callback + user data to pass to @progress_callback - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36495,16 +37518,16 @@ to be used as icon. - a %TRUE on success, %FALSE on error. + a %TRUE on success, %FALSE on error. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36514,34 +37537,34 @@ to be used as icon. - %TRUE on successful move, %FALSE otherwise. + %TRUE on successful move, %FALSE otherwise. - #GFile pointing to the source location + #GFile pointing to the source location - #GFile pointing to the destination location + #GFile pointing to the destination location - set of #GFileCopyFlags + set of #GFileCopyFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - #GFileProgressCallback + #GFileProgressCallback function for updates - gpointer to user data for + gpointer to user data for the callback function @@ -36572,30 +37595,30 @@ to be used as icon. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -36605,17 +37628,17 @@ to be used as icon. - a #GFile or %NULL on error. + a #GFile or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36629,25 +37652,25 @@ to be used as icon. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -36657,17 +37680,17 @@ to be used as icon. - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36681,25 +37704,25 @@ to be used as icon. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -36709,17 +37732,17 @@ to be used as icon. - %TRUE if the @file was ejected successfully. + %TRUE if the @file was ejected successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36733,30 +37756,30 @@ to be used as icon. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -36766,18 +37789,18 @@ to be used as icon. - %TRUE if successful. If an error has occurred, + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36787,22 +37810,22 @@ to be used as icon. - a #GFileMonitor for the given @file, + a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileMonitorFlags + a set of #GFileMonitorFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36813,22 +37836,22 @@ to be used as icon. - a #GFileMonitor for the given @file, + a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a set of #GFileMonitorFlags + a set of #GFileMonitorFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36839,17 +37862,17 @@ to be used as icon. - #GFileIOStream or %NULL on error. + #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - #GFile to open + #GFile to open - a #GCancellable + a #GCancellable @@ -36863,25 +37886,25 @@ to be used as icon. - input #GFile + input #GFile - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36891,17 +37914,17 @@ to be used as icon. - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36911,22 +37934,22 @@ to be used as icon. - a #GFileIOStream for the newly created + a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -36941,29 +37964,29 @@ to be used as icon. - input #GFile + input #GFile - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -36973,17 +37996,17 @@ to be used as icon. - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -36993,30 +38016,30 @@ to be used as icon. - a #GFileIOStream or %NULL on error. + a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). - a #GFile + a #GFile - an optional [entity tag][gfile-etag] + an optional [entity tag][gfile-etag] for the current #GFile, or #NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore @@ -37031,38 +38054,38 @@ to be used as icon. - input #GFile + input #GFile - an [entity tag][gfile-etag] for the current #GFile, + an [entity tag][gfile-etag] for the current #GFile, or %NULL to ignore - %TRUE if a backup should be created + %TRUE if a backup should be created - a set of #GFileCreateFlags + a set of #GFileCreateFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -37072,17 +38095,17 @@ to be used as icon. - a #GFileIOStream, or %NULL on error. + a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -37096,27 +38119,27 @@ to be used as icon. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, or %NULL to avoid user interaction + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -37126,17 +38149,17 @@ to be used as icon. - %TRUE if the operation finished successfully. %FALSE + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -37150,30 +38173,30 @@ otherwise. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction. - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -37183,17 +38206,17 @@ otherwise. - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -37211,30 +38234,30 @@ otherwise. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -37244,17 +38267,17 @@ otherwise. - %TRUE if the operation finished successfully. + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -37268,30 +38291,30 @@ otherwise. - input #GFile + input #GFile - flags affecting the operation + flags affecting the operation - a #GMountOperation, + a #GMountOperation, or %NULL to avoid user interaction - optional #GCancellable object, + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -37301,17 +38324,17 @@ otherwise. - %TRUE if the @file was ejected successfully. + %TRUE if the @file was ejected successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -37325,20 +38348,20 @@ otherwise. - input #GFile + input #GFile - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback to call + a #GAsyncReadyCallback to call when the request is satisfied, or %NULL - the data to pass to callback function + the data to pass to callback function @@ -37348,17 +38371,17 @@ otherwise. - %TRUE if the operation finished successfully. %FALSE + %TRUE if the operation finished successfully. %FALSE otherwise. - input #GFile + input #GFile - a #GAsyncResult + a #GAsyncResult @@ -37368,41 +38391,41 @@ otherwise. - %TRUE if successful, with the out parameters set. + %TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. - a #GFile + a #GFile - #GFileMeasureFlags + #GFileMeasureFlags - optional #GCancellable + optional #GCancellable - a #GFileMeasureProgressCallback + a #GFileMeasureProgressCallback - user_data for @progress_callback + user_data for @progress_callback - the number of bytes of disk space used + the number of bytes of disk space used - the number of directories encountered + the number of directories encountered - the number of non-directories encountered + the number of non-directories encountered @@ -37416,35 +38439,35 @@ otherwise. - a #GFile + a #GFile - #GFileMeasureFlags + #GFileMeasureFlags - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable + optional #GCancellable - a #GFileMeasureProgressCallback + a #GFileMeasureProgressCallback - user_data for @progress_callback + user_data for @progress_callback - a #GAsyncReadyCallback to call when complete + a #GAsyncReadyCallback to call when complete - the data to pass to callback function + the data to pass to callback function @@ -37454,29 +38477,29 @@ otherwise. - %TRUE if successful, with the out parameters set. + %TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. - a #GFile + a #GFile - the #GAsyncResult passed to your #GAsyncReadyCallback + the #GAsyncResult passed to your #GAsyncReadyCallback - the number of bytes of disk space used + the number of bytes of disk space used - the number of directories encountered + the number of directories encountered - the number of non-directories encountered + the number of non-directories encountered @@ -37484,7 +38507,7 @@ otherwise. - Functionality for manipulating basic metadata for files. #GFileInfo + Functionality for manipulating basic metadata for files. #GFileInfo implements methods for getting information that all files should contain, and allows for manipulation of extended attributes. @@ -37510,255 +38533,256 @@ of a particular file at runtime. attributes. - Creates a new file info structure. - + Creates a new file info structure. + - a #GFileInfo. + a #GFileInfo. - Clears the status information from @info. - + Clears the status information from @info. + - a #GFileInfo. + a #GFileInfo. - First clears all of the [GFileAttribute][gio-GFileAttribute] of @dest_info, + First clears all of the [GFileAttribute][gio-GFileAttribute] of @dest_info, and then copies all of the file attributes from @src_info to @dest_info. - + - source to copy attributes from. + source to copy attributes from. - destination to copy attributes to. + destination to copy attributes to. - Duplicates a file info structure. - + Duplicates a file info structure. + - a duplicate #GFileInfo of @other. + a duplicate #GFileInfo of @other. - a #GFileInfo. + a #GFileInfo. - Gets the value of a attribute, formated as a string. + Gets the value of a attribute, formated as a string. This escapes things as needed to make the string valid -utf8. - - - a UTF-8 string associated with the given @attribute. +UTF-8. + + + a UTF-8 string associated with the given @attribute, or + %NULL if the attribute wasn’t set. When you're done with the string it must be freed with g_free(). - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the value of a boolean attribute. If the attribute does not + Gets the value of a boolean attribute. If the attribute does not contain a boolean value, %FALSE will be returned. - + - the boolean value contained within the attribute. + the boolean value contained within the attribute. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the value of a byte string attribute. If the attribute does + Gets the value of a byte string attribute. If the attribute does not contain a byte string, %NULL will be returned. - + - the contents of the @attribute value as a byte string, or + the contents of the @attribute value as a byte string, or %NULL otherwise. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the attribute type, value and status for an attribute key. - + Gets the attribute type, value and status for an attribute key. + - %TRUE if @info has an attribute named @attribute, + %TRUE if @info has an attribute named @attribute, %FALSE otherwise. - a #GFileInfo + a #GFileInfo - a file attribute key + a file attribute key - return location for the attribute type, or %NULL + return location for the attribute type, or %NULL - return location for the + return location for the attribute value, or %NULL; the attribute value will not be %NULL - return location for the attribute status, or %NULL + return location for the attribute status, or %NULL - Gets a signed 32-bit integer contained within the attribute. If the + Gets a signed 32-bit integer contained within the attribute. If the attribute does not contain a signed 32-bit integer, or is invalid, 0 will be returned. - + - a signed 32-bit integer from the attribute. + a signed 32-bit integer from the attribute. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets a signed 64-bit integer contained within the attribute. If the + Gets a signed 64-bit integer contained within the attribute. If the attribute does not contain an signed 64-bit integer, or is invalid, 0 will be returned. - + - a signed 64-bit integer from the attribute. + a signed 64-bit integer from the attribute. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the value of a #GObject attribute. If the attribute does + Gets the value of a #GObject attribute. If the attribute does not contain a #GObject, %NULL will be returned. - + - a #GObject associated with the given @attribute, or + a #GObject associated with the given @attribute, or %NULL otherwise. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the attribute status for an attribute key. - + Gets the attribute status for an attribute key. + - a #GFileAttributeStatus for the given @attribute, or + a #GFileAttributeStatus for the given @attribute, or %G_FILE_ATTRIBUTE_STATUS_UNSET if the key is invalid. - a #GFileInfo + a #GFileInfo - a file attribute key + a file attribute key - Gets the value of a string attribute. If the attribute does + Gets the value of a string attribute. If the attribute does not contain a string, %NULL will be returned. - + - the contents of the @attribute value as a UTF-8 string, or + the contents of the @attribute value as a UTF-8 string, or %NULL otherwise. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the value of a stringv attribute. If the attribute does + Gets the value of a stringv attribute. If the attribute does not contain a stringv, %NULL will be returned. - + - the contents of the @attribute value as a stringv, or + the contents of the @attribute value as a stringv, or %NULL otherwise. Do not free. These returned strings are UTF-8. @@ -37766,351 +38790,368 @@ not contain a stringv, %NULL will be returned. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the attribute type for an attribute key. - + Gets the attribute type for an attribute key. + - a #GFileAttributeType for the given @attribute, or + a #GFileAttributeType for the given @attribute, or %G_FILE_ATTRIBUTE_TYPE_INVALID if the key is not set. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets an unsigned 32-bit integer contained within the attribute. If the + Gets an unsigned 32-bit integer contained within the attribute. If the attribute does not contain an unsigned 32-bit integer, or is invalid, 0 will be returned. - + - an unsigned 32-bit integer from the attribute. + an unsigned 32-bit integer from the attribute. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets a unsigned 64-bit integer contained within the attribute. If the + Gets a unsigned 64-bit integer contained within the attribute. If the attribute does not contain an unsigned 64-bit integer, or is invalid, 0 will be returned. - + - a unsigned 64-bit integer from the attribute. + a unsigned 64-bit integer from the attribute. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Gets the file's content type. - + Gets the file's content type. + - a string containing the file's content type. + a string containing the file's content type. - a #GFileInfo. + a #GFileInfo. - Returns the #GDateTime representing the deletion date of the file, as + Returns the #GDateTime representing the deletion date of the file, as available in G_FILE_ATTRIBUTE_TRASH_DELETION_DATE. If the G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned. - + - a #GDateTime, or %NULL. + a #GDateTime, or %NULL. - a #GFileInfo. + a #GFileInfo. - Gets a display name for a file. - + Gets a display name for a file. + - a string containing the display name. + a string containing the display name. - a #GFileInfo. + a #GFileInfo. - Gets the edit name for a file. - + Gets the edit name for a file. + - a string containing the edit name. + a string containing the edit name. - a #GFileInfo. + a #GFileInfo. - Gets the [entity tag][gfile-etag] for a given + Gets the [entity tag][gfile-etag] for a given #GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE. - + - a string containing the value of the "etag:value" attribute. + a string containing the value of the "etag:value" attribute. - a #GFileInfo. + a #GFileInfo. - Gets a file's type (whether it is a regular file, symlink, etc). + Gets a file's type (whether it is a regular file, symlink, etc). This is different from the file's content type, see g_file_info_get_content_type(). - + - a #GFileType for the given file. + a #GFileType for the given file. - a #GFileInfo. + a #GFileInfo. - Gets the icon for a file. - + Gets the icon for a file. + - #GIcon for the given @info. + #GIcon for the given @info. - a #GFileInfo. + a #GFileInfo. - Checks if a file is a backup file. - + Checks if a file is a backup file. + - %TRUE if file is a backup file, %FALSE otherwise. + %TRUE if file is a backup file, %FALSE otherwise. - a #GFileInfo. + a #GFileInfo. - Checks if a file is hidden. - + Checks if a file is hidden. + - %TRUE if the file is a hidden file, %FALSE otherwise. + %TRUE if the file is a hidden file, %FALSE otherwise. - a #GFileInfo. + a #GFileInfo. - Checks if a file is a symlink. - + Checks if a file is a symlink. + - %TRUE if the given @info is a symlink. + %TRUE if the given @info is a symlink. - a #GFileInfo. + a #GFileInfo. - - Gets the modification time of the current @info and sets it + + Gets the modification time of the current @info and returns it as a +#GDateTime. + + + modification time, or %NULL if unknown + + + + + a #GFileInfo. + + + + + + Gets the modification time of the current @info and sets it in @result. - + Use g_file_info_get_modification_date_time() instead, as + #GTimeVal is deprecated due to the year 2038 problem. + - a #GFileInfo. + a #GFileInfo. - a #GTimeVal. + a #GTimeVal. - Gets the name for a file. - + Gets the name for a file. + - a string containing the file name. + a string containing the file name. - a #GFileInfo. + a #GFileInfo. - Gets the file's size. - + Gets the file's size. + - a #goffset containing the file's size. + a #goffset containing the file's size. - a #GFileInfo. + a #GFileInfo. - Gets the value of the sort_order attribute from the #GFileInfo. + Gets the value of the sort_order attribute from the #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. - + - a #gint32 containing the value of the "standard::sort_order" attribute. + a #gint32 containing the value of the "standard::sort_order" attribute. - a #GFileInfo. + a #GFileInfo. - Gets the symbolic icon for a file. - + Gets the symbolic icon for a file. + - #GIcon for the given @info. + #GIcon for the given @info. - a #GFileInfo. + a #GFileInfo. - Gets the symlink target for a given #GFileInfo. - + Gets the symlink target for a given #GFileInfo. + - a string containing the symlink target. + a string containing the symlink target. - a #GFileInfo. + a #GFileInfo. - Checks if a file info structure has an attribute named @attribute. - + Checks if a file info structure has an attribute named @attribute. + - %TRUE if @Ginfo has an attribute named @attribute, + %TRUE if @Ginfo has an attribute named @attribute, %FALSE otherwise. - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Checks if a file info structure has an attribute in the + Checks if a file info structure has an attribute in the specified @name_space. - + - %TRUE if @Ginfo has an attribute in @name_space, + %TRUE if @Ginfo has an attribute in @name_space, %FALSE otherwise. - a #GFileInfo. + a #GFileInfo. - a file attribute namespace. + a file attribute namespace. - Lists the file info structure's attributes. - + Lists the file info structure's attributes. + - a + a null-terminated array of strings of all of the possible attribute types for the given @name_space, or %NULL on error. @@ -38119,255 +39160,255 @@ types for the given @name_space, or %NULL on error. - a #GFileInfo. + a #GFileInfo. - a file attribute key's namespace, or %NULL to list + a file attribute key's namespace, or %NULL to list all attributes. - Removes all cases of @attribute from @info if it exists. - + Removes all cases of @attribute from @info if it exists. + - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - Sets the @attribute to contain the given value, if possible. To unset the + Sets the @attribute to contain the given value, if possible. To unset the attribute, use %G_FILE_ATTRIBUTE_TYPE_INVALID for @type. - + - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - a #GFileAttributeType + a #GFileAttributeType - pointer to the value + pointer to the value - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. - + - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - a boolean value. + a boolean value. - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. - + - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - a byte string. + a byte string. - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. - + - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - a signed 32-bit integer + a signed 32-bit integer - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. - + - a #GFileInfo. + a #GFileInfo. - attribute name to set. + attribute name to set. - int64 value to set attribute to. + int64 value to set attribute to. - Sets @mask on @info to match specific attribute types. - + Sets @mask on @info to match specific attribute types. + - a #GFileInfo. + a #GFileInfo. - a #GFileAttributeMatcher. + a #GFileAttributeMatcher. - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. - + - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - a #GObject. + a #GObject. - Sets the attribute status for an attribute key. This is only + Sets the attribute status for an attribute key. This is only needed by external code that implement g_file_set_attributes_from_info() or similar functions. The attribute must exist in @info for this to work. Otherwise %FALSE is returned and @info is unchanged. - + - %TRUE if the status was changed, %FALSE if the key was not set. + %TRUE if the status was changed, %FALSE if the key was not set. - a #GFileInfo + a #GFileInfo - a file attribute key + a file attribute key - a #GFileAttributeStatus + a #GFileAttributeStatus - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. - + - a #GFileInfo. + a #GFileInfo. - a file attribute key. + a file attribute key. - a UTF-8 string. + a UTF-8 string. - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. Sinze: 2.22 - + - a #GFileInfo. + a #GFileInfo. - a file attribute key + a file attribute key - a %NULL + a %NULL terminated array of UTF-8 strings. @@ -38376,125 +39417,9 @@ Sinze: 2.22 - Sets the @attribute to contain the given @attr_value, + Sets the @attribute to contain the given @attr_value, if possible. - - - - - - - a #GFileInfo. - - - - a file attribute key. - - - - an unsigned 32-bit integer. - - - - - - Sets the @attribute to contain the given @attr_value, -if possible. - - - - - - - a #GFileInfo. - - - - a file attribute key. - - - - an unsigned 64-bit integer. - - - - - - Sets the content type attribute for a given #GFileInfo. -See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. - - - - - - - a #GFileInfo. - - - - a content type. See [GContentType][gio-GContentType] - - - - - - Sets the display name for the current #GFileInfo. -See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME. - - - - - - - a #GFileInfo. - - - - a string containing a display name. - - - - - - Sets the edit name for the current file. -See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. - - - - - - - a #GFileInfo. - - - - a string containing an edit name. - - - - - - Sets the file type in a #GFileInfo to @type. -See %G_FILE_ATTRIBUTE_STANDARD_TYPE. - - - - - - - a #GFileInfo. - - - - a #GFileType. - - - - - - Sets the icon for a given #GFileInfo. -See %G_FILE_ATTRIBUTE_STANDARD_ICON. - + @@ -38503,142 +39428,150 @@ See %G_FILE_ATTRIBUTE_STANDARD_ICON. a #GFileInfo. + + a file attribute key. + + + + an unsigned 32-bit integer. + + + + + + Sets the @attribute to contain the given @attr_value, +if possible. + + + + + + + a #GFileInfo. + + + + a file attribute key. + + + + an unsigned 64-bit integer. + + + + + + Sets the content type attribute for a given #GFileInfo. +See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. + + + + + + + a #GFileInfo. + + + + a content type. See [GContentType][gio-GContentType] + + + + + + Sets the display name for the current #GFileInfo. +See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME. + + + + + + + a #GFileInfo. + + + + a string containing a display name. + + + + + + Sets the edit name for the current file. +See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. + + + + + + + a #GFileInfo. + + + + a string containing an edit name. + + + + + + Sets the file type in a #GFileInfo to @type. +See %G_FILE_ATTRIBUTE_STANDARD_TYPE. + + + + + + + a #GFileInfo. + + + + a #GFileType. + + + + + + Sets the icon for a given #GFileInfo. +See %G_FILE_ATTRIBUTE_STANDARD_ICON. + + + + + + + a #GFileInfo. + + - a #GIcon. + a #GIcon. - Sets the "is_hidden" attribute in a #GFileInfo according to @is_hidden. + Sets the "is_hidden" attribute in a #GFileInfo according to @is_hidden. See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN. - + - a #GFileInfo. + a #GFileInfo. - a #gboolean. + a #gboolean. - Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink. + Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink. See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK. - - - - - - - a #GFileInfo. - - - - a #gboolean. - - - - - - Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED attribute in the file -info to the given time value. - - - - - - - a #GFileInfo. - - - - a #GTimeVal. - - - - - - Sets the name attribute for the current #GFileInfo. -See %G_FILE_ATTRIBUTE_STANDARD_NAME. - - - - - - - a #GFileInfo. - - - - a string containing a name. - - - - - - Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info -to the given size. - - - - - - - a #GFileInfo. - - - - a #goffset containing the file's size. - - - - - - Sets the sort order attribute in the file info structure. See -%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. - - - - - - - a #GFileInfo. - - - - a sort order integer. - - - - - - Sets the symbolic icon for a given #GFileInfo. -See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. - - - - - - - a #GFileInfo. - - - - a #GIcon. - - - - - - Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info -to the given symlink target. - + @@ -38647,22 +39580,150 @@ to the given symlink target. a #GFileInfo. - - a static string containing a path to a symlink target. - + + a #gboolean. + - - Unsets a mask set by g_file_info_set_attribute_mask(), if one -is set. - + + Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED attribute in the file +info to the given date/time value. + - #GFileInfo. + a #GFileInfo. + + + + a #GDateTime. + + + + + + Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED attribute in the file +info to the given time value. + Use g_file_info_set_modification_date_time() instead, as + #GTimeVal is deprecated due to the year 2038 problem. + + + + + + + a #GFileInfo. + + + + a #GTimeVal. + + + + + + Sets the name attribute for the current #GFileInfo. +See %G_FILE_ATTRIBUTE_STANDARD_NAME. + + + + + + + a #GFileInfo. + + + + a string containing a name. + + + + + + Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info +to the given size. + + + + + + + a #GFileInfo. + + + + a #goffset containing the file's size. + + + + + + Sets the sort order attribute in the file info structure. See +%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. + + + + + + + a #GFileInfo. + + + + a sort order integer. + + + + + + Sets the symbolic icon for a given #GFileInfo. +See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. + + + + + + + a #GFileInfo. + + + + a #GIcon. + + + + + + Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info +to the given symlink target. + + + + + + + a #GFileInfo. + + + + a static string containing a path to a symlink target. + + + + + + Unsets a mask set by g_file_info_set_attribute_mask(), if one +is set. + + + + + + + #GFileInfo. @@ -38672,7 +39733,7 @@ is set. - GFileInputStream provides input streams that take their + GFileInputStream provides input streams that take their content from a file. GFileInputStream implements #GSeekable, which allows the input @@ -38695,33 +39756,33 @@ To position a file input stream, use g_seekable_seek(). - Queries a file input stream the given @attributes. This function blocks + Queries a file input stream the given @attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with %G_IO_ERROR_PENDING. - a #GFileInfo, or %NULL on error. + a #GFileInfo, or %NULL on error. - a #GFileInputStream. + a #GFileInputStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Queries the stream information asynchronously. + Queries the stream information asynchronously. When the operation is finished @callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation. @@ -38738,45 +39799,45 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - a #GFileInputStream. + a #GFileInputStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous info query operation. + Finishes an asynchronous info query operation. - #GFileInfo. + #GFileInfo. - a #GFileInputStream. + a #GFileInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -38813,33 +39874,33 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - Queries a file input stream the given @attributes. This function blocks + Queries a file input stream the given @attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with %G_IO_ERROR_PENDING. - a #GFileInfo, or %NULL on error. + a #GFileInfo, or %NULL on error. - a #GFileInputStream. + a #GFileInputStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Queries the stream information asynchronously. + Queries the stream information asynchronously. When the operation is finished @callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation. @@ -38856,45 +39917,45 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - a #GFileInputStream. + a #GFileInputStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous info query operation. + Finishes an asynchronous info query operation. - #GFileInfo. + #GFileInfo. - a #GFileInputStream. + a #GFileInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -38963,20 +40024,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - a #GFileInfo, or %NULL on error. + a #GFileInfo, or %NULL on error. - a #GFileInputStream. + a #GFileInputStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -38990,27 +40051,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - a #GFileInputStream. + a #GFileInputStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -39020,16 +40081,16 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - #GFileInfo. + #GFileInfo. - a #GFileInputStream. + a #GFileInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -39121,7 +40182,7 @@ default main context of the calling thread (ie: the same way that the final async result would be reported). @current_size is in the same units as requested by the operation (see -%G_FILE_DISK_USAGE_APPARENT_SIZE). +%G_FILE_MEASURE_APPARENT_SIZE). The frequency of the updates is implementation defined, but is ideally about once every 200ms. @@ -39156,7 +40217,7 @@ result. Always check the async result to get the final value. - Monitors a file or directory for changes. + Monitors a file or directory for changes. To obtain a #GFileMonitor for a file or directory, use g_file_monitor(), g_file_monitor_file(), or @@ -39172,15 +40233,15 @@ cause notifications to be blocked even if the thread-default context is still running). - Cancels a file monitor. + Cancels a file monitor. - always %TRUE + always %TRUE - a #GFileMonitor. + a #GFileMonitor. @@ -39206,21 +40267,21 @@ context is still running). - Cancels a file monitor. + Cancels a file monitor. - always %TRUE + always %TRUE - a #GFileMonitor. + a #GFileMonitor. - Emits the #GFileMonitor::changed signal if a change + Emits the #GFileMonitor::changed signal if a change has taken place. Should be called from file monitor implementations only. @@ -39233,39 +40294,39 @@ thread that the monitor was created in. - a #GFileMonitor. + a #GFileMonitor. - a #GFile. + a #GFile. - a #GFile. + a #GFile. - a set of #GFileMonitorEvent flags. + a set of #GFileMonitorEvent flags. - Returns whether the monitor is canceled. + Returns whether the monitor is canceled. - %TRUE if monitor is canceled. %FALSE otherwise. + %TRUE if monitor is canceled. %FALSE otherwise. - a #GFileMonitor + a #GFileMonitor - Sets the rate limit to which the @monitor will report + Sets the rate limit to which the @monitor will report consecutive change events to the same file. @@ -39273,11 +40334,11 @@ consecutive change events to the same file. - a #GFileMonitor. + a #GFileMonitor. - a non-negative integer with the limit in milliseconds + a non-negative integer with the limit in milliseconds to poll for changes @@ -39296,7 +40357,7 @@ consecutive change events to the same file. - Emitted when @file has been changed. + Emitted when @file has been changed. If using %G_FILE_MONITOR_WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), @@ -39329,15 +40390,15 @@ In all the other cases, @other_file will be set to #NULL. - a #GFile. + a #GFile. - a #GFile or #NULL. + a #GFile or #NULL. - a #GFileMonitorEvent. + a #GFileMonitorEvent. @@ -39374,12 +40435,12 @@ In all the other cases, @other_file will be set to #NULL. - always %TRUE + always %TRUE - a #GFileMonitor. + a #GFileMonitor. @@ -39427,44 +40488,44 @@ In all the other cases, @other_file will be set to #NULL. - Specifies what type of event a monitor event is. + Specifies what type of event a monitor event is. - a file changed. + a file changed. - a hint that this was probably the last change in a set of changes. + a hint that this was probably the last change in a set of changes. - a file was deleted. + a file was deleted. - a file was created. + a file was created. - a file attribute was changed. + a file attribute was changed. - the file location will soon be unmounted. + the file location will soon be unmounted. - the file location was unmounted. + the file location was unmounted. - the file was moved -- only sent if the + the file was moved -- only sent if the (deprecated) %G_FILE_MONITOR_SEND_MOVED flag is set - the file was renamed within the + the file was renamed within the current directory -- only sent if the %G_FILE_MONITOR_WATCH_MOVES flag is set. Since: 2.46. - the file was moved into the + the file was moved into the monitored directory from another location -- only sent if the %G_FILE_MONITOR_WATCH_MOVES flag is set. Since: 2.46. - the file was moved out of the + the file was moved out of the monitored directory to another location -- only sent if the %G_FILE_MONITOR_WATCH_MOVES flag is set. Since: 2.46 @@ -39500,7 +40561,7 @@ In all the other cases, @other_file will be set to #NULL. - GFileOutputStream provides output streams that write their + GFileOutputStream provides output streams that write their content to a file. GFileOutputStream implements #GSeekable, which allows the output @@ -39539,23 +40600,23 @@ stream, use g_seekable_truncate(). - Gets the entity tag for the file when it has been written. + Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - the entity tag for the stream. + the entity tag for the stream. - a #GFileOutputStream. + a #GFileOutputStream. - Queries a file output stream for the given @attributes. + Queries a file output stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -39574,26 +40635,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - a #GFileInfo for the @stream, or %NULL on error. + a #GFileInfo for the @stream, or %NULL on error. - a #GFileOutputStream. + a #GFileOutputStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Asynchronously queries the @stream for a #GFileInfo. When completed, + Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_output_stream_query_info_finish(). @@ -39605,46 +40666,46 @@ g_file_output_stream_query_info(). - a #GFileOutputStream. + a #GFileOutputStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][gio-GIOScheduler] of the request + the [I/O priority][gio-GIOScheduler] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finalizes the asynchronous query started + Finalizes the asynchronous query started by g_file_output_stream_query_info_async(). - A #GFileInfo for the finished query. + A #GFileInfo for the finished query. - a #GFileOutputStream. + a #GFileOutputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -39698,23 +40759,23 @@ by g_file_output_stream_query_info_async(). - Gets the entity tag for the file when it has been written. + Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - the entity tag for the stream. + the entity tag for the stream. - a #GFileOutputStream. + a #GFileOutputStream. - Queries a file output stream for the given @attributes. + Queries a file output stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -39733,26 +40794,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - a #GFileInfo for the @stream, or %NULL on error. + a #GFileInfo for the @stream, or %NULL on error. - a #GFileOutputStream. + a #GFileOutputStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Asynchronously queries the @stream for a #GFileInfo. When completed, + Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_output_stream_query_info_finish(). @@ -39764,46 +40825,46 @@ g_file_output_stream_query_info(). - a #GFileOutputStream. + a #GFileOutputStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][gio-GIOScheduler] of the request + the [I/O priority][gio-GIOScheduler] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finalizes the asynchronous query started + Finalizes the asynchronous query started by g_file_output_stream_query_info_async(). - A #GFileInfo for the finished query. + A #GFileInfo for the finished query. - a #GFileOutputStream. + a #GFileOutputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -39904,20 +40965,20 @@ by g_file_output_stream_query_info_async(). - a #GFileInfo for the @stream, or %NULL on error. + a #GFileInfo for the @stream, or %NULL on error. - a #GFileOutputStream. + a #GFileOutputStream. - a file attribute query string. + a file attribute query string. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -39931,27 +40992,27 @@ by g_file_output_stream_query_info_async(). - a #GFileOutputStream. + a #GFileOutputStream. - a file attribute query string. + a file attribute query string. - the [I/O priority][gio-GIOScheduler] of the request + the [I/O priority][gio-GIOScheduler] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -39961,16 +41022,16 @@ by g_file_output_stream_query_info_async(). - A #GFileInfo for the finished query. + A #GFileInfo for the finished query. - a #GFileOutputStream. + a #GFileOutputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -39980,12 +41041,12 @@ by g_file_output_stream_query_info_async(). - the entity tag for the stream. + the entity tag for the stream. - a #GFileOutputStream. + a #GFileOutputStream. @@ -40093,7 +41154,16 @@ should be read, or %FALSE otherwise. - Indicates the file's on-disk type. + Indicates the file's on-disk type. + +On Windows systems a file will never have %G_FILE_TYPE_SYMBOLIC_LINK type; +use #GFileInfo and %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK to determine +whether a file is a symlink or not. This is due to the fact that NTFS does +not have a single filesystem object type for symbolic links - it has +files that symlink to files, and directories that symlink to directories. +#GFileType enumeration cannot precisely represent this important distinction, +which is why all Windows symlinks will continue to be reported as +%G_FILE_TYPE_REGULAR or %G_FILE_TYPE_DIRECTORY. File's type is unknown. @@ -40119,15 +41189,15 @@ should be read, or %FALSE otherwise. - Completes partial file and directory names given a partial string by + Completes partial file and directory names given a partial string by looking in the file system for clues. Can return a list of possible completion strings for widget implementations. - Creates a new filename completer. + Creates a new filename completer. - a #GFilenameCompleter. + a #GFilenameCompleter. @@ -40143,30 +41213,30 @@ completion strings for widget implementations. - Obtains a completion for @initial_text from @completer. + Obtains a completion for @initial_text from @completer. - a completed string, or %NULL if no completion exists. + a completed string, or %NULL if no completion exists. This string is not owned by GIO, so remember to g_free() it when finished. - the filename completer. + the filename completer. - text to be completed. + text to be completed. - Gets an array of completion strings for a given initial text. + Gets an array of completion strings for a given initial text. - array of strings with possible completions for @initial_text. + array of strings with possible completions for @initial_text. This array must be freed by g_strfreev() when finished. @@ -40174,17 +41244,17 @@ This array must be freed by g_strfreev() when finished. - the filename completer. + the filename completer. - text to be completed. + text to be completed. - If @dirs_only is %TRUE, @completer will only + If @dirs_only is %TRUE, @completer will only complete directory names, and not file names. @@ -40192,17 +41262,17 @@ complete directory names, and not file names. - the filename completer. + the filename completer. - a #gboolean. + a #gboolean. - Emitted when the file name completion information comes available. + Emitted when the file name completion information comes available. @@ -40252,67 +41322,67 @@ complete directory names, and not file names. - Indicates a hint from the file system whether files should be + Indicates a hint from the file system whether files should be previewed in a file manager. Returned as the value of the key #G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW. - Only preview files if user has explicitly requested it. + Only preview files if user has explicitly requested it. - Preview files if user has requested preview of "local" files. + Preview files if user has requested preview of "local" files. - Never preview files. + Never preview files. - Base class for input stream implementations that perform some + Base class for input stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping. - Gets the base stream for the filter stream. + Gets the base stream for the filter stream. - a #GInputStream. + a #GInputStream. - a #GFilterInputStream. + a #GFilterInputStream. - Returns whether the base stream will be closed when @stream is + Returns whether the base stream will be closed when @stream is closed. - %TRUE if the base stream will be closed. + %TRUE if the base stream will be closed. - a #GFilterInputStream. + a #GFilterInputStream. - Sets whether the base stream will be closed when @stream is closed. + Sets whether the base stream will be closed when @stream is closed. - a #GFilterInputStream. + a #GFilterInputStream. - %TRUE to close the base stream. + %TRUE to close the base stream. @@ -40361,53 +41431,53 @@ closed. - Base class for output stream implementations that perform some + Base class for output stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping. - Gets the base stream for the filter stream. + Gets the base stream for the filter stream. - a #GOutputStream. + a #GOutputStream. - a #GFilterOutputStream. + a #GFilterOutputStream. - Returns whether the base stream will be closed when @stream is + Returns whether the base stream will be closed when @stream is closed. - %TRUE if the base stream will be closed. + %TRUE if the base stream will be closed. - a #GFilterOutputStream. + a #GFilterOutputStream. - Sets whether the base stream will be closed when @stream is closed. + Sets whether the base stream will be closed when @stream is closed. - a #GFilterOutputStream. + a #GFilterOutputStream. - %TRUE to close the base stream. + %TRUE to close the base stream. @@ -40455,8 +41525,120 @@ closed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Error codes returned by GIO functions. + Error codes returned by GIO functions. Note that this domain may be extended in future GLib releases. In general, new error codes either only apply to new APIs, or else @@ -40475,257 +41657,257 @@ but should instead treat all unrecognized error codes the same as See also #GPollableReturn for a cheaper way of returning %G_IO_ERROR_WOULD_BLOCK to callers without allocating a #GError. - Generic error condition for when an operation fails + Generic error condition for when an operation fails and no more specific #GIOErrorEnum value is defined. - File not found. + File not found. - File already exists. + File already exists. - File is a directory. + File is a directory. - File is not a directory. + File is not a directory. - File is a directory that isn't empty. + File is a directory that isn't empty. - File is not a regular file. + File is not a regular file. - File is not a symbolic link. + File is not a symbolic link. - File cannot be mounted. + File cannot be mounted. - Filename is too many characters. + Filename is too many characters. - Filename is invalid or contains invalid characters. + Filename is invalid or contains invalid characters. - File contains too many symbolic links. + File contains too many symbolic links. - No space left on drive. + No space left on drive. - Invalid argument. + Invalid argument. - Permission denied. + Permission denied. - Operation (or one of its parameters) not supported + Operation (or one of its parameters) not supported - File isn't mounted. + File isn't mounted. - File is already mounted. + File is already mounted. - File was closed. + File was closed. - Operation was cancelled. See #GCancellable. + Operation was cancelled. See #GCancellable. - Operations are still pending. + Operations are still pending. - File is read only. + File is read only. - Backup couldn't be created. + Backup couldn't be created. - File's Entity Tag was incorrect. + File's Entity Tag was incorrect. - Operation timed out. + Operation timed out. - Operation would be recursive. + Operation would be recursive. - File is busy. + File is busy. - Operation would block. + Operation would block. - Host couldn't be found (remote operations). + Host couldn't be found (remote operations). - Operation would merge files. + Operation would merge files. - Operation failed and a helper program has + Operation failed and a helper program has already interacted with the user. Do not display any error dialog. - The current process has too many files + The current process has too many files open and can't open any more. Duplicate descriptors do count toward this limit. Since 2.20 - The object has not been initialized. Since 2.22 + The object has not been initialized. Since 2.22 - The requested address is already in use. Since 2.22 + The requested address is already in use. Since 2.22 - Need more input to finish operation. Since 2.24 + Need more input to finish operation. Since 2.24 - The input data was invalid. Since 2.24 + The input data was invalid. Since 2.24 - A remote object generated an error that + A remote object generated an error that doesn't correspond to a locally registered #GError error domain. Use g_dbus_error_get_remote_error() to extract the D-Bus error name and g_dbus_error_strip_remote_error() to fix up the message so it matches what was received on the wire. Since 2.26. - Host unreachable. Since 2.26 + Host unreachable. Since 2.26 - Network unreachable. Since 2.26 + Network unreachable. Since 2.26 - Connection refused. Since 2.26 + Connection refused. Since 2.26 - Connection to proxy server failed. Since 2.26 + Connection to proxy server failed. Since 2.26 - Proxy authentication failed. Since 2.26 + Proxy authentication failed. Since 2.26 - Proxy server needs authentication. Since 2.26 + Proxy server needs authentication. Since 2.26 - Proxy connection is not allowed by ruleset. + Proxy connection is not allowed by ruleset. Since 2.26 - Broken pipe. Since 2.36 + Broken pipe. Since 2.36 - Connection closed by peer. Note that this + Connection closed by peer. Note that this is the same code as %G_IO_ERROR_BROKEN_PIPE; before 2.44 some "connection closed" errors returned %G_IO_ERROR_BROKEN_PIPE, but others returned %G_IO_ERROR_FAILED. Now they should all return the same value, which has this more logical name. Since 2.44. - Transport endpoint is not connected. Since 2.44 + Transport endpoint is not connected. Since 2.44 - Message too large. Since 2.48. + Message too large. Since 2.48. - #GIOExtension is an opaque data structure and can only be accessed + #GIOExtension is an opaque data structure and can only be accessed using the following functions. - Gets the name under which @extension was registered. + Gets the name under which @extension was registered. Note that the same type may be registered as extension for multiple extension points, under different names. - the name of @extension. + the name of @extension. - a #GIOExtension + a #GIOExtension - Gets the priority with which @extension was registered. + Gets the priority with which @extension was registered. - the priority of @extension + the priority of @extension - a #GIOExtension + a #GIOExtension - Gets the type associated with @extension. + Gets the type associated with @extension. - the type of @extension + the type of @extension - a #GIOExtension + a #GIOExtension - Gets a reference to the class for the type that is + Gets a reference to the class for the type that is associated with @extension. - the #GTypeClass for the type of @extension + the #GTypeClass for the type of @extension - a #GIOExtension + a #GIOExtension - #GIOExtensionPoint is an opaque data structure and can only be accessed + #GIOExtensionPoint is an opaque data structure and can only be accessed using the following functions. - Finds a #GIOExtension for an extension point by name. + Finds a #GIOExtension for an extension point by name. - the #GIOExtension for @extension_point that has the + the #GIOExtension for @extension_point that has the given name, or %NULL if there is no extension with that name - a #GIOExtensionPoint + a #GIOExtensionPoint - the name of the extension to get + the name of the extension to get - Gets a list of all extensions that implement this extension point. + Gets a list of all extensions that implement this extension point. The list is sorted by priority, beginning with the highest priority. - a #GList of + a #GList of #GIOExtensions. The list is owned by GIO and should not be modified. @@ -40734,28 +41916,28 @@ The list is sorted by priority, beginning with the highest priority. - a #GIOExtensionPoint + a #GIOExtensionPoint - Gets the required type for @extension_point. + Gets the required type for @extension_point. - the #GType that all implementations must have, + the #GType that all implementations must have, or #G_TYPE_INVALID if the extension point has no required type - a #GIOExtensionPoint + a #GIOExtensionPoint - Sets the required type for @extension_point to @type. + Sets the required type for @extension_point to @type. All implementations must henceforth have this type. @@ -40763,94 +41945,94 @@ All implementations must henceforth have this type. - a #GIOExtensionPoint + a #GIOExtensionPoint - the #GType to require + the #GType to require - Registers @type as extension for the extension point with name + Registers @type as extension for the extension point with name @extension_point_name. If @type has already been registered as an extension for this extension point, the existing #GIOExtension object is returned. - a #GIOExtension object for #GType + a #GIOExtension object for #GType - the name of the extension point + the name of the extension point - the #GType to register as extension + the #GType to register as extension - the name for the extension + the name for the extension - the priority for the extension + the priority for the extension - Looks up an existing extension point. + Looks up an existing extension point. - the #GIOExtensionPoint, or %NULL if there + the #GIOExtensionPoint, or %NULL if there is no registered extension point with the given name. - the name of the extension point + the name of the extension point - Registers an extension point. + Registers an extension point. - the new #GIOExtensionPoint. This object is + the new #GIOExtensionPoint. This object is owned by GIO and should not be freed. - The name of the extension point + The name of the extension point - Provides an interface and default functions for loading and unloading + Provides an interface and default functions for loading and unloading modules. This is used internally to make GIO extensible, but can also be used by others to implement module loading. - Creates a new GIOModule that will load the specific + Creates a new GIOModule that will load the specific shared library when in use. - a #GIOModule from given @filename, + a #GIOModule from given @filename, or %NULL on error. - filename of the shared library module. + filename of the shared library module. @@ -40951,14 +42133,14 @@ for static builds. - Represents a scope for loading IO modules. A scope can be used for blocking + Represents a scope for loading IO modules. A scope can be used for blocking duplicate modules, or blocking a module you don't want to load. The scope can be used with g_io_modules_load_all_in_directory_with_scope() or g_io_modules_scan_all_in_directory_with_scope(). - Block modules with the given @basename from being loaded when + Block modules with the given @basename from being loaded when this scope is used with g_io_modules_scan_all_in_directory_with_scope() or g_io_modules_load_all_in_directory_with_scope(). @@ -40967,30 +42149,30 @@ or g_io_modules_load_all_in_directory_with_scope(). - a module loading scope + a module loading scope - the basename to block + the basename to block - Free a module scope. + Free a module scope. - a module loading scope + a module loading scope - Create a new scope for loading of IO modules. A scope can be used for + Create a new scope for loading of IO modules. A scope can be used for blocking duplicate modules, or blocking a module you don't want to load. Specify the %G_IO_MODULE_SCOPE_BLOCK_DUPLICATES flag to block modules @@ -40998,24 +42180,24 @@ which have the same base name as a module that has already been seen in this scope. - the new module scope + the new module scope - flags for the new scope + flags for the new scope - Flags for use with g_io_module_scope_new(). + Flags for use with g_io_module_scope_new(). - No module scan flags + No module scan flags - When using this scope to load or + When using this scope to load or scan modules, automatically block a modules which has the same base basename as previously loaded module. @@ -41024,36 +42206,36 @@ in this scope. Opaque class for defining and scheduling IO jobs. - Used from an I/O job to send a callback to be run in the thread + Used from an I/O job to send a callback to be run in the thread that the job was started from, waiting for the result (and thus blocking the I/O job). Use g_main_context_invoke(). - The return value of @func + The return value of @func - a #GIOSchedulerJob + a #GIOSchedulerJob - a #GSourceFunc callback that will be called in the original thread + a #GSourceFunc callback that will be called in the original thread - data to pass to @func + data to pass to @func - a #GDestroyNotify for @user_data, or %NULL + a #GDestroyNotify for @user_data, or %NULL - Used from an I/O job to send a callback to be run asynchronously in + Used from an I/O job to send a callback to be run asynchronously in the thread that the job was started from. The callback will be run when the main loop is available, but at that time the I/O job might have finished. The return value from the callback is ignored. @@ -41069,19 +42251,19 @@ g_io_scheduler_push_job() or by using refcounting for @user_data. - a #GIOSchedulerJob + a #GIOSchedulerJob - a #GSourceFunc callback that will be called in the original thread + a #GSourceFunc callback that will be called in the original thread - data to pass to @func + data to pass to @func - a #GDestroyNotify for @user_data, or %NULL + a #GDestroyNotify for @user_data, or %NULL @@ -41114,7 +42296,7 @@ to see if they have been cancelled. - GIOStream represents an object that has both read and write streams. + GIOStream represents an object that has both read and write streams. Generally the two streams act as separate input and output streams, but they share some common resources and state. For instance, for seekable streams, both streams may use the same position. @@ -41162,21 +42344,21 @@ not be well-defined due to the state the wrapper stream leaves the base stream in (though they are guaranteed not to crash). - Finishes an asynchronous io stream splice operation. + Finishes an asynchronous io stream splice operation. - %TRUE on success, %FALSE otherwise. + %TRUE on success, %FALSE otherwise. - a #GAsyncResult. + a #GAsyncResult. - Requests an asynchronous close of the stream, releasing resources + Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation. @@ -41192,41 +42374,41 @@ classes. However, if you override one you must override all. - a #GIOStream + a #GIOStream - the io priority of the request + the io priority of the request - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Closes a stream. + Closes a stream. - %TRUE if stream was successfully closed, %FALSE otherwise. + %TRUE if stream was successfully closed, %FALSE otherwise. - a #GIOStream + a #GIOStream - a #GAsyncResult + a #GAsyncResult @@ -41246,52 +42428,52 @@ classes. However, if you override one you must override all. - Gets the input stream for this object. This is used + Gets the input stream for this object. This is used for reading. - a #GInputStream, owned by the #GIOStream. + a #GInputStream, owned by the #GIOStream. Do not free. - a #GIOStream + a #GIOStream - Gets the output stream for this object. This is used for + Gets the output stream for this object. This is used for writing. - a #GOutputStream, owned by the #GIOStream. + a #GOutputStream, owned by the #GIOStream. Do not free. - a #GIOStream + a #GIOStream - Clears the pending flag on @stream. + Clears the pending flag on @stream. - a #GIOStream + a #GIOStream - Closes the stream, releasing resources related to it. This will also + Closes the stream, releasing resources related to it. This will also close the individual input and output streams, if they are not already closed. @@ -41326,22 +42508,22 @@ The default implementation of this method just calls close on the individual input/output streams. - %TRUE on success, %FALSE on failure + %TRUE on success, %FALSE on failure - a #GIOStream + a #GIOStream - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Requests an asynchronous close of the stream, releasing resources + Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation. @@ -41357,123 +42539,123 @@ classes. However, if you override one you must override all. - a #GIOStream + a #GIOStream - the io priority of the request + the io priority of the request - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Closes a stream. + Closes a stream. - %TRUE if stream was successfully closed, %FALSE otherwise. + %TRUE if stream was successfully closed, %FALSE otherwise. - a #GIOStream + a #GIOStream - a #GAsyncResult + a #GAsyncResult - Gets the input stream for this object. This is used + Gets the input stream for this object. This is used for reading. - a #GInputStream, owned by the #GIOStream. + a #GInputStream, owned by the #GIOStream. Do not free. - a #GIOStream + a #GIOStream - Gets the output stream for this object. This is used for + Gets the output stream for this object. This is used for writing. - a #GOutputStream, owned by the #GIOStream. + a #GOutputStream, owned by the #GIOStream. Do not free. - a #GIOStream + a #GIOStream - Checks if a stream has pending actions. + Checks if a stream has pending actions. - %TRUE if @stream has pending actions. + %TRUE if @stream has pending actions. - a #GIOStream + a #GIOStream - Checks if a stream is closed. + Checks if a stream is closed. - %TRUE if the stream is closed. + %TRUE if the stream is closed. - a #GIOStream + a #GIOStream - Sets @stream to have actions pending. If the pending flag is + Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. - %TRUE if pending was previously unset and is now set. + %TRUE if pending was previously unset and is now set. - a #GIOStream + a #GIOStream - Asyncronously splice the output stream of @stream1 to the input stream of + Asyncronously splice the output stream of @stream1 to the input stream of @stream2, and splice the output stream of @stream2 to the input stream of @stream1. @@ -41486,31 +42668,31 @@ result of the operation. - a #GIOStream. + a #GIOStream. - a #GIOStream. + a #GIOStream. - a set of #GIOStreamSpliceFlags. + a set of #GIOStreamSpliceFlags. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. @@ -41543,13 +42725,13 @@ result of the operation. - a #GInputStream, owned by the #GIOStream. + a #GInputStream, owned by the #GIOStream. Do not free. - a #GIOStream + a #GIOStream @@ -41559,13 +42741,13 @@ Do not free. - a #GOutputStream, owned by the #GIOStream. + a #GOutputStream, owned by the #GIOStream. Do not free. - a #GIOStream + a #GIOStream @@ -41595,23 +42777,23 @@ Do not free. - a #GIOStream + a #GIOStream - the io priority of the request + the io priority of the request - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -41621,16 +42803,16 @@ Do not free. - %TRUE if stream was successfully closed, %FALSE otherwise. + %TRUE if stream was successfully closed, %FALSE otherwise. - a #GIOStream + a #GIOStream - a #GAsyncResult + a #GAsyncResult @@ -41721,25 +42903,1670 @@ Do not free. - GIOStreamSpliceFlags determine how streams should be spliced. + GIOStreamSpliceFlags determine how streams should be spliced. - Do not close either stream. + Do not close either stream. - Close the first stream after + Close the first stream after the splice. - Close the second stream after + Close the second stream after the splice. - Wait for both splice operations to finish + Wait for both splice operations to finish before calling the callback. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - #GIcon is a very minimal interface for icons. It provides functions + #GIcon is a very minimal interface for icons. It provides functions for checking the equality of two icons, hashing of icons and serializing an icon to and from strings. @@ -41769,36 +44596,36 @@ understood by g_icon_deserialize(), yielding one of the built-in icon types. - Deserializes a #GIcon previously serialized using g_icon_serialize(). + Deserializes a #GIcon previously serialized using g_icon_serialize(). - a #GIcon, or %NULL when deserialization fails. + a #GIcon, or %NULL when deserialization fails. - a #GVariant created with g_icon_serialize() + a #GVariant created with g_icon_serialize() - Gets a hash for an icon. + Gets a hash for an icon. - a #guint containing a hash for the @icon, suitable for + a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. - #gconstpointer to an icon object. + #gconstpointer to an icon object. - Generate a #GIcon instance from @str. This function can fail if + Generate a #GIcon instance from @str. This function can fail if @str is not valid - see g_icon_to_string() for discussion. If your application or library provides one or more #GIcon @@ -41806,70 +44633,70 @@ implementations you need to ensure that each #GType is registered with the type system prior to calling g_icon_new_for_string(). - An object implementing the #GIcon + An object implementing the #GIcon interface or %NULL if @error is set. - A string obtained via g_icon_to_string(). + A string obtained via g_icon_to_string(). - Checks if two icons are equal. + Checks if two icons are equal. - %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. - pointer to the first #GIcon. + pointer to the first #GIcon. - pointer to the second #GIcon. + pointer to the second #GIcon. - Gets a hash for an icon. + Gets a hash for an icon. - a #guint containing a hash for the @icon, suitable for + a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. - #gconstpointer to an icon object. + #gconstpointer to an icon object. - Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved + Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace. - a #GVariant, or %NULL when serialization fails. + a #GVariant, or %NULL when serialization fails. - a #GIcon + a #GIcon - Generates a textual representation of @icon that can be used for + Generates a textual representation of @icon that can be used for serialization such as when passing @icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get @icon back from the returned string. @@ -41887,13 +44714,13 @@ in the following two cases the encoding is simply the name (such as `network-server`). - An allocated NUL-terminated UTF8 string or + An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. - a #GIcon. + a #GIcon. @@ -41907,43 +44734,43 @@ in the following two cases - Checks if two icons are equal. + Checks if two icons are equal. - %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. - pointer to the first #GIcon. + pointer to the first #GIcon. - pointer to the second #GIcon. + pointer to the second #GIcon. - Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved + Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace. - a #GVariant, or %NULL when serialization fails. + a #GVariant, or %NULL when serialization fails. - a #GIcon + a #GIcon - Generates a textual representation of @icon that can be used for + Generates a textual representation of @icon that can be used for serialization such as when passing @icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get @icon back from the returned string. @@ -41961,13 +44788,13 @@ in the following two cases the encoding is simply the name (such as `network-server`). - An allocated NUL-terminated UTF8 string or + An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. - a #GIcon. + a #GIcon. @@ -41986,13 +44813,13 @@ examples of how to implement this interface. - a #guint containing a hash for the @icon, suitable for + a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. - #gconstpointer to an icon object. + #gconstpointer to an icon object. @@ -42002,16 +44829,16 @@ use in a #GHashTable or similar data structure. - %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. - pointer to the first #GIcon. + pointer to the first #GIcon. - pointer to the second #GIcon. + pointer to the second #GIcon. @@ -42021,13 +44848,13 @@ use in a #GHashTable or similar data structure. - An allocated NUL-terminated UTF8 string or + An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. - a #GIcon. + a #GIcon. @@ -42064,12 +44891,12 @@ use in a #GHashTable or similar data structure. - a #GVariant, or %NULL when serialization fails. + a #GVariant, or %NULL when serialization fails. - a #GIcon + a #GIcon @@ -42077,7 +44904,7 @@ use in a #GHashTable or similar data structure. - #GInetAddress represents an IPv4 or IPv6 internet address. Use + #GInetAddress represents an IPv4 or IPv6 internet address. Use g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to look up the #GInetAddress for a hostname. Use g_resolver_lookup_by_address() or @@ -42089,327 +44916,327 @@ To actually connect to a remote host, you will need a port number). - Creates a #GInetAddress for the "any" address (unassigned/"don't + Creates a #GInetAddress for the "any" address (unassigned/"don't care") for @family. - a new #GInetAddress corresponding to the "any" address + a new #GInetAddress corresponding to the "any" address for @family. Free the returned object with g_object_unref(). - the address family + the address family - Creates a new #GInetAddress from the given @family and @bytes. + Creates a new #GInetAddress from the given @family and @bytes. @bytes should be 4 bytes for %G_SOCKET_FAMILY_IPV4 and 16 bytes for %G_SOCKET_FAMILY_IPV6. - a new #GInetAddress corresponding to @family and @bytes. + a new #GInetAddress corresponding to @family and @bytes. Free the returned object with g_object_unref(). - raw address data + raw address data - the address family of @bytes + the address family of @bytes - Parses @string as an IP address and creates a new #GInetAddress. + Parses @string as an IP address and creates a new #GInetAddress. - a new #GInetAddress corresponding to @string, or %NULL if + a new #GInetAddress corresponding to @string, or %NULL if @string could not be parsed. Free the returned object with g_object_unref(). - a string representation of an IP address + a string representation of an IP address - Creates a #GInetAddress for the loopback address for @family. + Creates a #GInetAddress for the loopback address for @family. - a new #GInetAddress corresponding to the loopback address + a new #GInetAddress corresponding to the loopback address for @family. Free the returned object with g_object_unref(). - the address family + the address family - Gets the raw binary address data from @address. + Gets the raw binary address data from @address. - a pointer to an internal array of the bytes in @address, + a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). - a #GInetAddress + a #GInetAddress - Converts @address to string form. + Converts @address to string form. - a representation of @address as a string, which should be + a representation of @address as a string, which should be freed after use. - a #GInetAddress + a #GInetAddress - Checks if two #GInetAddress instances are equal, e.g. the same address. + Checks if two #GInetAddress instances are equal, e.g. the same address. - %TRUE if @address and @other_address are equal, %FALSE otherwise. + %TRUE if @address and @other_address are equal, %FALSE otherwise. - A #GInetAddress. + A #GInetAddress. - Another #GInetAddress. + Another #GInetAddress. - Gets @address's family + Gets @address's family - @address's family + @address's family - a #GInetAddress + a #GInetAddress - Tests whether @address is the "any" address for its family. + Tests whether @address is the "any" address for its family. - %TRUE if @address is the "any" address for its family. + %TRUE if @address is the "any" address for its family. - a #GInetAddress + a #GInetAddress - Tests whether @address is a link-local address (that is, if it + Tests whether @address is a link-local address (that is, if it identifies a host on a local network that is not connected to the Internet). - %TRUE if @address is a link-local address. + %TRUE if @address is a link-local address. - a #GInetAddress + a #GInetAddress - Tests whether @address is the loopback address for its family. + Tests whether @address is the loopback address for its family. - %TRUE if @address is the loopback address for its family. + %TRUE if @address is the loopback address for its family. - a #GInetAddress + a #GInetAddress - Tests whether @address is a global multicast address. + Tests whether @address is a global multicast address. - %TRUE if @address is a global multicast address. + %TRUE if @address is a global multicast address. - a #GInetAddress + a #GInetAddress - Tests whether @address is a link-local multicast address. + Tests whether @address is a link-local multicast address. - %TRUE if @address is a link-local multicast address. + %TRUE if @address is a link-local multicast address. - a #GInetAddress + a #GInetAddress - Tests whether @address is a node-local multicast address. + Tests whether @address is a node-local multicast address. - %TRUE if @address is a node-local multicast address. + %TRUE if @address is a node-local multicast address. - a #GInetAddress + a #GInetAddress - Tests whether @address is an organization-local multicast address. + Tests whether @address is an organization-local multicast address. - %TRUE if @address is an organization-local multicast address. + %TRUE if @address is an organization-local multicast address. - a #GInetAddress + a #GInetAddress - Tests whether @address is a site-local multicast address. + Tests whether @address is a site-local multicast address. - %TRUE if @address is a site-local multicast address. + %TRUE if @address is a site-local multicast address. - a #GInetAddress + a #GInetAddress - Tests whether @address is a multicast address. + Tests whether @address is a multicast address. - %TRUE if @address is a multicast address. + %TRUE if @address is a multicast address. - a #GInetAddress + a #GInetAddress - Tests whether @address is a site-local address such as 10.0.0.1 + Tests whether @address is a site-local address such as 10.0.0.1 (that is, the address identifies a host on a local network that can not be reached directly from the Internet, but which may have outgoing Internet connectivity via a NAT or firewall). - %TRUE if @address is a site-local address. + %TRUE if @address is a site-local address. - a #GInetAddress + a #GInetAddress - Gets the size of the native raw binary address for @address. This + Gets the size of the native raw binary address for @address. This is the size of the data that you get from g_inet_address_to_bytes(). - the number of bytes used for the native version of @address. + the number of bytes used for the native version of @address. - a #GInetAddress + a #GInetAddress - Gets the raw binary address data from @address. + Gets the raw binary address data from @address. - a pointer to an internal array of the bytes in @address, + a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). - a #GInetAddress + a #GInetAddress - Converts @address to string form. + Converts @address to string form. - a representation of @address as a string, which should be + a representation of @address as a string, which should be freed after use. - a #GInetAddress + a #GInetAddress @@ -42421,52 +45248,52 @@ freed after use. - Whether this is the "any" address for its family. + Whether this is the "any" address for its family. See g_inet_address_get_is_any(). - Whether this is a link-local address. + Whether this is a link-local address. See g_inet_address_get_is_link_local(). - Whether this is the loopback address for its family. + Whether this is the loopback address for its family. See g_inet_address_get_is_loopback(). - Whether this is a global multicast address. + Whether this is a global multicast address. See g_inet_address_get_is_mc_global(). - Whether this is a link-local multicast address. + Whether this is a link-local multicast address. See g_inet_address_get_is_mc_link_local(). - Whether this is a node-local multicast address. + Whether this is a node-local multicast address. See g_inet_address_get_is_mc_node_local(). - Whether this is an organization-local multicast address. + Whether this is an organization-local multicast address. See g_inet_address_get_is_mc_org_local(). - Whether this is a site-local multicast address. + Whether this is a site-local multicast address. See g_inet_address_get_is_mc_site_local(). - Whether this is a multicast address. + Whether this is a multicast address. See g_inet_address_get_is_multicast(). - Whether this is a site-local address. + Whether this is a site-local address. See g_inet_address_get_is_loopback(). @@ -42486,13 +45313,13 @@ See g_inet_address_get_is_loopback(). - a representation of @address as a string, which should be + a representation of @address as a string, which should be freed after use. - a #GInetAddress + a #GInetAddress @@ -42502,14 +45329,14 @@ freed after use. - a pointer to an internal array of the bytes in @address, + a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). - a #GInetAddress + a #GInetAddress @@ -42517,138 +45344,138 @@ array can be gotten with g_inet_address_get_native_size(). - #GInetAddressMask represents a range of IPv4 or IPv6 addresses + #GInetAddressMask represents a range of IPv4 or IPv6 addresses described by a base address and a length indicating how many bits of the base address are relevant for matching purposes. These are often given in string form. Eg, "10.0.0.0/8", or "fe80::/10". - Creates a new #GInetAddressMask representing all addresses whose + Creates a new #GInetAddressMask representing all addresses whose first @length bits match @addr. - a new #GInetAddressMask, or %NULL on error + a new #GInetAddressMask, or %NULL on error - a #GInetAddress + a #GInetAddress - number of bits of @addr to use + number of bits of @addr to use - Parses @mask_string as an IP address and (optional) length, and + Parses @mask_string as an IP address and (optional) length, and creates a new #GInetAddressMask. The length, if present, is delimited by a "/". If it is not present, then the length is assumed to be the full length of the address. - a new #GInetAddressMask corresponding to @string, or %NULL + a new #GInetAddressMask corresponding to @string, or %NULL on error. - an IP address or address/length string + an IP address or address/length string - Tests if @mask and @mask2 are the same mask. + Tests if @mask and @mask2 are the same mask. - whether @mask and @mask2 are the same mask + whether @mask and @mask2 are the same mask - a #GInetAddressMask + a #GInetAddressMask - another #GInetAddressMask + another #GInetAddressMask - Gets @mask's base address + Gets @mask's base address - @mask's base address + @mask's base address - a #GInetAddressMask + a #GInetAddressMask - Gets the #GSocketFamily of @mask's address + Gets the #GSocketFamily of @mask's address - the #GSocketFamily of @mask's address + the #GSocketFamily of @mask's address - a #GInetAddressMask + a #GInetAddressMask - Gets @mask's length + Gets @mask's length - @mask's length + @mask's length - a #GInetAddressMask + a #GInetAddressMask - Tests if @address falls within the range described by @mask. + Tests if @address falls within the range described by @mask. - whether @address falls within the range described by + whether @address falls within the range described by @mask. - a #GInetAddressMask + a #GInetAddressMask - a #GInetAddress + a #GInetAddress - Converts @mask back to its corresponding string form. + Converts @mask back to its corresponding string form. - a string corresponding to @mask. + a string corresponding to @mask. - a #GInetAddressMask + a #GInetAddressMask @@ -42682,105 +45509,105 @@ on error. - An IPv4 or IPv6 socket address; that is, the combination of a + An IPv4 or IPv6 socket address; that is, the combination of a #GInetAddress and a port number. - Creates a new #GInetSocketAddress for @address and @port. + Creates a new #GInetSocketAddress for @address and @port. - a new #GInetSocketAddress + a new #GInetSocketAddress - a #GInetAddress + a #GInetAddress - a port number + a port number - Creates a new #GInetSocketAddress for @address and @port. + 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 `%`). - a new #GInetSocketAddress, or %NULL if @address cannot be + a new #GInetSocketAddress, or %NULL if @address cannot be parsed. - the string form of an IP address + the string form of an IP address - a port number + a port number - Gets @address's #GInetAddress. + Gets @address's #GInetAddress. - the #GInetAddress for @address, which must be + the #GInetAddress for @address, which must be g_object_ref()'d if it will be stored - a #GInetSocketAddress + a #GInetSocketAddress - Gets the `sin6_flowinfo` field from @address, + Gets the `sin6_flowinfo` field from @address, which must be an IPv6 address. - the flowinfo field + the flowinfo field - a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress + a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress - Gets @address's port. + Gets @address's port. - the port for @address + the port for @address - a #GInetSocketAddress + a #GInetSocketAddress - Gets the `sin6_scope_id` field from @address, + Gets the `sin6_scope_id` field from @address, which must be an IPv6 address. - the scope id field + the scope id field - a %G_SOCKET_FAMILY_IPV6 #GInetAddress + a %G_SOCKET_FAMILY_IPV6 #GInetAddress @@ -42789,7 +45616,7 @@ which must be an IPv6 address. - The `sin6_flowinfo` field, for IPv6 addresses. + The `sin6_flowinfo` field, for IPv6 addresses. @@ -42815,7 +45642,7 @@ which must be an IPv6 address. - #GInitable is implemented by objects that can fail during + #GInitable is implemented by objects that can fail during initialization. If an object implements this interface then it must be initialized as the first thing after construction, either via g_initable_init() or g_async_initable_init_async() @@ -42841,106 +45668,106 @@ during normal construction and automatically initialize them, throwing an exception on failure. - Helper function for constructing #GInitable object. This is + Helper function for constructing #GInitable object. This is similar to g_object_new() but also initializes the object and returns %NULL, setting an error on failure. - a newly allocated + a newly allocated #GObject, or %NULL on error - a #GType supporting #GInitable. + a #GType supporting #GInitable. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GError location to store the error occurring, or %NULL to + a #GError location to store the error occurring, or %NULL to ignore. - the name of the first property, or %NULL if no + the name of the first property, or %NULL if no properties - the value if the first property, followed by and other property + the value if the first property, followed by and other property value pairs, and ended by %NULL. - Helper function for constructing #GInitable object. This is + Helper function for constructing #GInitable object. This is similar to g_object_new_valist() but also initializes the object and returns %NULL, setting an error on failure. - + - a newly allocated + a newly allocated #GObject, or %NULL on error - a #GType supporting #GInitable. + a #GType supporting #GInitable. - the name of the first property, followed by + the name of the first property, followed by the value, and other property value pairs, and ended by %NULL. - The var args list generated from @first_property_name. + The var args list generated from @first_property_name. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Helper function for constructing #GInitable object. This is + Helper function for constructing #GInitable object. This is similar to g_object_newv() but also initializes the object and returns %NULL, setting an error on failure. Use g_object_new_with_properties() and g_initable_init() instead. See #GParameter for more information. - + - a newly allocated + a newly allocated #GObject, or %NULL on error - a #GType supporting #GInitable. + a #GType supporting #GInitable. - the number of parameters in @parameters + the number of parameters in @parameters - the parameters to use to construct the object + the parameters to use to construct the object - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Initializes the object implementing the interface. + Initializes the object implementing the interface. This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead. @@ -42980,23 +45807,23 @@ on the result of g_object_new(), regardless of whether it is in fact a new instance. - %TRUE if successful. If an error has occurred, this function will + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GInitable. + a #GInitable. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Initializes the object implementing the interface. + Initializes the object implementing the interface. This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead. @@ -43036,17 +45863,17 @@ on the result of g_object_new(), regardless of whether it is in fact a new instance. - %TRUE if successful. If an error has occurred, this function will + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GInitable. + a #GInitable. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -43064,17 +45891,17 @@ may fail. - %TRUE if successful. If an error has occurred, this function will + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GInitable. + a #GInitable. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -43142,7 +45969,7 @@ Flags relevant to this message will be returned in @flags. For example, - #GInputStream has functions to read from a stream (g_input_stream_read()), + #GInputStream has functions to read from a stream (g_input_stream_read()), to close a stream (g_input_stream_close()) and to skip some content (g_input_stream_skip()). @@ -43155,7 +45982,7 @@ streaming APIs. All of these functions have async variants too. - Requests an asynchronous closes of the stream, releasing resources related to it. + Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation. @@ -43171,41 +45998,41 @@ override one you must override all. - A #GInputStream. + A #GInputStream. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes closing a stream asynchronously, started from g_input_stream_close_async(). + Finishes closing a stream asynchronously, started from g_input_stream_close_async(). - %TRUE if the stream was closed successfully. + %TRUE if the stream was closed successfully. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -43225,7 +46052,7 @@ override one you must override all. - Request an asynchronous read of @count bytes from the stream into the buffer + Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. When the operation is finished @callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation. @@ -43254,53 +46081,53 @@ override one you must override all. - A #GInputStream. + A #GInputStream. - - 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). - - the number of bytes that will be read from the stream + + the number of bytes that will be read from the stream - the [I/O priority][io-priority] + the [I/O priority][io-priority] of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous stream read operation. + Finishes an asynchronous stream read operation. - number of bytes read in, or -1 on error, or 0 on end of file. + number of bytes read in, or -1 on error, or 0 on end of file. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -43326,7 +46153,7 @@ of the request. - Tries to skip @count bytes from the stream. Will block during the operation. + Tries to skip @count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some @@ -43342,26 +46169,26 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - Number of bytes skipped, or -1 on error + Number of bytes skipped, or -1 on error - a #GInputStream. + a #GInputStream. - the number of bytes that will be skipped from the stream + the number of bytes that will be skipped from the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request an asynchronous skip of @count bytes from the stream. + Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation. @@ -43390,64 +46217,64 @@ However, if you override one, you must override all. - A #GInputStream. + A #GInputStream. - the number of bytes that will be skipped from the stream + the number of bytes that will be skipped from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes a stream skip operation. + Finishes a stream skip operation. - the size of the bytes skipped, or %-1 on error. + the size of the bytes skipped, or `-1` on error. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. - Clears the pending flag on @stream. + Clears the pending flag on @stream. - input stream + input stream - Closes the stream, releasing resources related to it. + Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. @@ -43472,22 +46299,22 @@ Cancelling a close will still leave the stream closed, but some streams can use a faster close that doesn't block to e.g. check errors. - %TRUE on success, %FALSE on failure + %TRUE on success, %FALSE on failure - A #GInputStream. + A #GInputStream. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Requests an asynchronous closes of the stream, releasing resources related to it. + Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation. @@ -43503,75 +46330,75 @@ override one you must override all. - A #GInputStream. + A #GInputStream. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes closing a stream asynchronously, started from g_input_stream_close_async(). + Finishes closing a stream asynchronously, started from g_input_stream_close_async(). - %TRUE if the stream was closed successfully. + %TRUE if the stream was closed successfully. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. - Checks if an input stream has pending actions. + Checks if an input stream has pending actions. - %TRUE if @stream has pending actions. + %TRUE if @stream has pending actions. - input stream. + input stream. - Checks if an input stream is closed. + Checks if an input stream is closed. - %TRUE if the stream is closed. + %TRUE if the stream is closed. - input stream. + input stream. - Tries to read @count bytes from the stream into the buffer starting at + Tries to read @count bytes from the stream into the buffer starting at @buffer. Will block during this read. If count is zero returns zero and does nothing. A value of @count @@ -43594,33 +46421,33 @@ partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - Number of bytes read, or -1 on error, or 0 on end of file. + Number of bytes read, or -1 on error, or 0 on end of file. - a #GInputStream. + a #GInputStream. - - 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). - - the number of bytes that will be read from the stream + + the number of bytes that will be read from the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Tries to read @count bytes from the stream into the buffer starting at + Tries to read @count bytes from the stream into the buffer starting at @buffer. Will block during this read. This function is similar to g_input_stream_read(), except it tries to @@ -43641,37 +46468,37 @@ available from C. If you need it from another language then you must write your own loop around g_input_stream_read(). - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GInputStream. + a #GInputStream. - - 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). - - the number of bytes that will be read from the stream + + the number of bytes that will be read from the stream - location to store the number of bytes that was read from the stream + location to store the number of bytes that was read from the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request an asynchronous read of @count bytes from the stream into the + Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. This is the asynchronous equivalent of g_input_stream_read_all(). @@ -43687,40 +46514,40 @@ priority. Default priority is %G_PRIORITY_DEFAULT. - A #GInputStream + A #GInputStream - - 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) - - the number of bytes that will be read from the stream + + the number of bytes that will be read from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous stream read operation started with + Finishes an asynchronous stream read operation started with g_input_stream_read_all_async(). As a special exception to the normal conventions for functions that @@ -43731,26 +46558,26 @@ available from C. If you need it from another language then you must write your own loop around g_input_stream_read_async(). - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GInputStream + a #GInputStream - a #GAsyncResult + a #GAsyncResult - location to store the number of bytes that was read from the stream + location to store the number of bytes that was read from the stream - Request an asynchronous read of @count bytes from the stream into the buffer + Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. When the operation is finished @callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation. @@ -43779,41 +46606,41 @@ override one you must override all. - A #GInputStream. + A #GInputStream. - - 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). - - the number of bytes that will be read from the stream + + the number of bytes that will be read from the stream - the [I/O priority][io-priority] + the [I/O priority][io-priority] of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Like g_input_stream_read(), this tries to read @count bytes from + Like g_input_stream_read(), this tries to read @count bytes from the stream in a blocking fashion. However, rather than reading into a user-supplied buffer, this will create a new #GBytes containing the data that was read. This may be easier to use from language @@ -43838,27 +46665,27 @@ partial result will be returned, without an error. On error %NULL is returned and @error is set accordingly. - a new #GBytes, or %NULL on error + a new #GBytes, or %NULL on error - a #GInputStream. + a #GInputStream. - maximum number of bytes that will be read from the stream. Common + maximum number of bytes that will be read from the stream. Common values include 4096 and 8192. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request an asynchronous read of @count bytes from the stream into a + Request an asynchronous read of @count bytes from the stream into a new #GBytes. When the operation is finished @callback will be called. You can then call g_input_stream_read_bytes_finish() to get the result of the operation. @@ -43884,85 +46711,85 @@ priority. Default priority is %G_PRIORITY_DEFAULT. - A #GInputStream. + A #GInputStream. - the number of bytes that will be read from the stream + the number of bytes that will be read from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous stream read-into-#GBytes operation. + Finishes an asynchronous stream read-into-#GBytes operation. - the newly-allocated #GBytes, or %NULL on error + the newly-allocated #GBytes, or %NULL on error - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. - Finishes an asynchronous stream read operation. + Finishes an asynchronous stream read operation. - number of bytes read in, or -1 on error, or 0 on end of file. + number of bytes read in, or -1 on error, or 0 on end of file. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. - Sets @stream to have actions pending. If the pending flag is + Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. - %TRUE if pending was previously unset and is now set. + %TRUE if pending was previously unset and is now set. - input stream + input stream - Tries to skip @count bytes from the stream. Will block during the operation. + Tries to skip @count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some @@ -43978,26 +46805,26 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - Number of bytes skipped, or -1 on error + Number of bytes skipped, or -1 on error - a #GInputStream. + a #GInputStream. - the number of bytes that will be skipped from the stream + the number of bytes that will be skipped from the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request an asynchronous skip of @count bytes from the stream. + Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation. @@ -44026,45 +46853,45 @@ However, if you override one, you must override all. - A #GInputStream. + A #GInputStream. - the number of bytes that will be skipped from the stream + the number of bytes that will be skipped from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes a stream skip operation. + Finishes a stream skip operation. - the size of the bytes skipped, or %-1 on error. + the size of the bytes skipped, or `-1` on error. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -44107,20 +46934,20 @@ However, if you override one, you must override all. - Number of bytes skipped, or -1 on error + Number of bytes skipped, or -1 on error - a #GInputStream. + a #GInputStream. - the number of bytes that will be skipped from the stream + the number of bytes that will be skipped from the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -44150,35 +46977,35 @@ However, if you override one, you must override all. - A #GInputStream. + A #GInputStream. - - 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). - - the number of bytes that will be read from the stream + + the number of bytes that will be read from the stream - the [I/O priority][io-priority] + the [I/O priority][io-priority] of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -44188,16 +47015,16 @@ of the request. - number of bytes read in, or -1 on error, or 0 on end of file. + number of bytes read in, or -1 on error, or 0 on end of file. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -44211,27 +47038,27 @@ of the request. - A #GInputStream. + A #GInputStream. - the number of bytes that will be skipped from the stream + the number of bytes that will be skipped from the stream - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -44241,16 +47068,16 @@ of the request. - the size of the bytes skipped, or %-1 on error. + the size of the bytes skipped, or `-1` on error. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -44264,23 +47091,23 @@ of the request. - A #GInputStream. + A #GInputStream. - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -44290,16 +47117,16 @@ of the request. - %TRUE if the stream was closed successfully. + %TRUE if the stream was closed successfully. - a #GInputStream. + a #GInputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -44364,8 +47191,22 @@ first buffer, switching to the next as needed. + + + + + + + + + + + + + + - #GListModel is an interface that represents a mutable list of + #GListModel is an interface that represents a mutable list of #GObjects. Its main intention is as a model for various widgets in user interfaces, such as list views, but it can also be used as a convenient method of returning lists of data, with support for @@ -44414,29 +47255,29 @@ the [thread-default main context][g-main-context-push-thread-default] in effect at the time that the model was created. - Get the item at @position. If @position is greater than the number of + Get the item at @position. If @position is greater than the number of items in @list, %NULL is returned. %NULL is never returned for an index that is smaller than the length of the list. See g_list_model_get_n_items(). - the object at @position. + the object at @position. - a #GListModel + a #GListModel - the position of the item to fetch + the position of the item to fetch - Gets the type of the items in @list. All items returned from + Gets the type of the items in @list. All items returned from g_list_model_get_type() are of that type or a subtype, or are an implementation of that interface. @@ -44444,58 +47285,58 @@ The item type of a #GListModel can not change during the life of the model. - the #GType of the items contained in @list. + the #GType of the items contained in @list. - a #GListModel + a #GListModel - Gets the number of items in @list. + Gets the number of items in @list. Depending on the model implementation, calling this function may be less efficient than iterating the list with increasing values for @position until g_list_model_get_item() returns %NULL. - the number of items in @list. + the number of items in @list. - a #GListModel + a #GListModel - Get the item at @position. If @position is greater than the number of + Get the item at @position. If @position is greater than the number of items in @list, %NULL is returned. %NULL is never returned for an index that is smaller than the length of the list. See g_list_model_get_n_items(). - the item at @position. + the item at @position. - a #GListModel + a #GListModel - the position of the item to fetch + the position of the item to fetch - Gets the type of the items in @list. All items returned from + Gets the type of the items in @list. All items returned from g_list_model_get_type() are of that type or a subtype, or are an implementation of that interface. @@ -44503,58 +47344,58 @@ The item type of a #GListModel can not change during the life of the model. - the #GType of the items contained in @list. + the #GType of the items contained in @list. - a #GListModel + a #GListModel - Gets the number of items in @list. + Gets the number of items in @list. Depending on the model implementation, calling this function may be less efficient than iterating the list with increasing values for @position until g_list_model_get_item() returns %NULL. - the number of items in @list. + the number of items in @list. - a #GListModel + a #GListModel - Get the item at @position. If @position is greater than the number of + Get the item at @position. If @position is greater than the number of items in @list, %NULL is returned. %NULL is never returned for an index that is smaller than the length of the list. See g_list_model_get_n_items(). - the object at @position. + the object at @position. - a #GListModel + a #GListModel - the position of the item to fetch + the position of the item to fetch - Emits the #GListModel::items-changed signal on @list. + Emits the #GListModel::items-changed signal on @list. This function should only be called by classes implementing #GListModel. It has to be called after the internal representation @@ -44580,63 +47421,66 @@ same contents of the model. - a #GListModel + a #GListModel - the position at which @list changed + the position at which @list changed - the number of items removed + the number of items removed - the number of items added + the number of items added - This signal is emitted whenever items were added or removed to -@list. At @position, @removed items were removed and @added items -were added in their place. + This signal is emitted whenever items were added to or removed +from @list. At @position, @removed items were removed and @added +items were added in their place. + +Note: If @removed != @added, the positions of all later items +in the model change. - the position at which @list changed + the position at which @list changed - the number of items removed + the number of items removed - the number of items added + the number of items added - The virtual function table for #GListModel. + The virtual function table for #GListModel. - parent #GTypeInterface + parent #GTypeInterface - the #GType of the items contained in @list. + the #GType of the items contained in @list. - a #GListModel + a #GListModel @@ -44646,12 +47490,12 @@ were added in their place. - the number of items in @list. + the number of items in @list. - a #GListModel + a #GListModel @@ -44661,16 +47505,16 @@ were added in their place. - the object at @position. + the object at @position. - a #GListModel + a #GListModel - the position of the item to fetch + the position of the item to fetch @@ -44678,7 +47522,7 @@ were added in their place. - #GListStore is a simple implementation of #GListModel that stores all + #GListStore is a simple implementation of #GListModel that stores all items in memory. It provides insertions, deletions, and lookups in logarithmic time @@ -44686,22 +47530,22 @@ with a fast path for the common case of iterating the list linearly. - Creates a new #GListStore with items of type @item_type. @item_type + Creates a new #GListStore with items of type @item_type. @item_type must be a subclass of #GObject. - a new #GListStore + a new #GListStore - the #GType of items in the list + the #GType of items in the list - Appends @item to @store. @item must be of type #GListStore:item-type. + Appends @item to @store. @item must be of type #GListStore:item-type. This function takes a ref on @item. @@ -44713,17 +47557,17 @@ efficiently. - a #GListStore + a #GListStore - the new item + the new item - Inserts @item into @store at @position. @item must be of type + Inserts @item into @store at @position. @item must be of type #GListStore:item-type or derived from it. @position must be smaller than the length of the list, or equal to it to append. @@ -44737,21 +47581,21 @@ efficiently. - a #GListStore + a #GListStore - the position at which to insert the new item + the position at which to insert the new item - the new item + the new item - Inserts @item into @store at a position to be determined by the + Inserts @item into @store at a position to be determined by the @compare_func. The list must already be sorted before calling this function or the @@ -44761,30 +47605,30 @@ inserting items by way of this function. This function takes a ref on @item. - the position at which @item was inserted + the position at which @item was inserted - a #GListStore + a #GListStore - the new item + the new item - pairwise comparison function for sorting + pairwise comparison function for sorting - user data for @compare_func + user data for @compare_func - Removes the item from @store that is at @position. @position must be + Removes the item from @store that is at @position. @position must be smaller than the current length of the list. Use g_list_store_splice() to remove multiple items at the same time @@ -44795,51 +47639,51 @@ efficiently. - a #GListStore + a #GListStore - the position of the item that is to be removed + the position of the item that is to be removed - Removes all items from @store. + Removes all items from @store. - a #GListStore + a #GListStore - Sort the items in @store according to @compare_func. + Sort the items in @store according to @compare_func. - a #GListStore + a #GListStore - pairwise comparison function for sorting + pairwise comparison function for sorting - user data for @compare_func + user data for @compare_func - Changes @store by removing @n_removals items and adding @n_additions + Changes @store by removing @n_removals items and adding @n_additions items to it. @additions must contain @n_additions items of type #GListStore:item-type. %NULL is not permitted. @@ -44858,31 +47702,31 @@ the list at the time this function is called). - a #GListStore + a #GListStore - the position at which to make the change + the position at which to make the change - the number of items to remove + the number of items to remove - the items to add + the items to add - the number of items to add + the number of items to add - The type of items contained in this list store. Items must be + The type of items contained in this list store. Items must be subclasses of #GObject. @@ -44894,41 +47738,41 @@ subclasses of #GObject. - Extends the #GIcon interface and adds the ability to + Extends the #GIcon interface and adds the ability to load icons from streams. - Loads a loadable icon. For the asynchronous version of this function, + Loads a loadable icon. For the asynchronous version of this function, see g_loadable_icon_load_async(). - a #GInputStream to read the icon from. + a #GInputStream to read the icon from. - a #GLoadableIcon. + a #GLoadableIcon. - an integer. + an integer. - a location to store the type of the loaded + a location to store the type of the loaded icon, %NULL to ignore. - optional #GCancellable object, %NULL to + optional #GCancellable object, %NULL to ignore. - Loads an icon asynchronously. To finish this function, see + Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load(). @@ -44937,82 +47781,82 @@ version of this function, see g_loadable_icon_load(). - a #GLoadableIcon. + a #GLoadableIcon. - an integer. + an integer. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous icon load started in g_loadable_icon_load_async(). + Finishes an asynchronous icon load started in g_loadable_icon_load_async(). - a #GInputStream to read the icon from. + a #GInputStream to read the icon from. - a #GLoadableIcon. + a #GLoadableIcon. - a #GAsyncResult. + a #GAsyncResult. - a location to store the type of the loaded + a location to store the type of the loaded icon, %NULL to ignore. - Loads a loadable icon. For the asynchronous version of this function, + Loads a loadable icon. For the asynchronous version of this function, see g_loadable_icon_load_async(). - a #GInputStream to read the icon from. + a #GInputStream to read the icon from. - a #GLoadableIcon. + a #GLoadableIcon. - an integer. + an integer. - a location to store the type of the loaded + a location to store the type of the loaded icon, %NULL to ignore. - optional #GCancellable object, %NULL to + optional #GCancellable object, %NULL to ignore. - Loads an icon asynchronously. To finish this function, see + Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load(). @@ -45021,46 +47865,46 @@ version of this function, see g_loadable_icon_load(). - a #GLoadableIcon. + a #GLoadableIcon. - an integer. + an integer. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous icon load started in g_loadable_icon_load_async(). + Finishes an asynchronous icon load started in g_loadable_icon_load_async(). - a #GInputStream to read the icon from. + a #GInputStream to read the icon from. - a #GLoadableIcon. + a #GLoadableIcon. - a #GAsyncResult. + a #GAsyncResult. - a location to store the type of the loaded + a location to store the type of the loaded icon, %NULL to ignore. @@ -45078,25 +47922,25 @@ version of this function, see g_loadable_icon_load(). - a #GInputStream to read the icon from. + a #GInputStream to read the icon from. - a #GLoadableIcon. + a #GLoadableIcon. - an integer. + an integer. - a location to store the type of the loaded + a location to store the type of the loaded icon, %NULL to ignore. - optional #GCancellable object, %NULL to + optional #GCancellable object, %NULL to ignore. @@ -45111,24 +47955,24 @@ ignore. - a #GLoadableIcon. + a #GLoadableIcon. - an integer. + an integer. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -45138,20 +47982,20 @@ ignore. - a #GInputStream to read the icon from. + a #GInputStream to read the icon from. - a #GLoadableIcon. + a #GLoadableIcon. - a #GAsyncResult. + a #GAsyncResult. - a location to store the type of the loaded + a location to store the type of the loaded icon, %NULL to ignore. @@ -45159,6 +48003,55 @@ ignore. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The menu item attribute which holds the action name of the item. Action names are namespaced with an identifier for the action group in which the @@ -45186,6 +48079,27 @@ for 'verbs' (ie: stock icons). + + + + + + + + + + + + + + + + + + + + + The menu item attribute which holds the label of the item. @@ -45199,6 +48113,34 @@ See also g_menu_item_set_action_and_target() + + + + + + + + + + + + + + + + + + + + + + + + + + + + The name of the link that associates a menu item with a section. The linked menu will usually be shown in place of the menu item, using the item's label @@ -45215,8 +48157,64 @@ See also g_menu_item_set_link(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - #GMemoryInputStream is a class for using arbitrary + #GMemoryInputStream is a class for using arbitrary memory chunks as input for GIO streaming input operations. As of GLib 2.34, #GMemoryInputStream implements @@ -45225,91 +48223,91 @@ As of GLib 2.34, #GMemoryInputStream implements - Creates a new empty #GMemoryInputStream. + Creates a new empty #GMemoryInputStream. - a new #GInputStream + a new #GInputStream - Creates a new #GMemoryInputStream with data from the given @bytes. + Creates a new #GMemoryInputStream with data from the given @bytes. - new #GInputStream read from @bytes + new #GInputStream read from @bytes - a #GBytes + a #GBytes - Creates a new #GMemoryInputStream with data in memory of a given size. + Creates a new #GMemoryInputStream with data in memory of a given size. - new #GInputStream read from @data of @len bytes. + new #GInputStream read from @data of @len bytes. - input data + input data - length of the data, may be -1 if @data is a nul-terminated string + length of the data, may be -1 if @data is a nul-terminated string - function that is called to free @data, or %NULL + function that is called to free @data, or %NULL - Appends @bytes to data that can be read from the input stream. + Appends @bytes to data that can be read from the input stream. - a #GMemoryInputStream + a #GMemoryInputStream - input data + input data - Appends @data to data that can be read from the input stream + Appends @data to data that can be read from the input stream - a #GMemoryInputStream + a #GMemoryInputStream - input data + input data - length of the data, may be -1 if @data is a nul-terminated string + length of the data, may be -1 if @data is a nul-terminated string - function that is called to free @data, or %NULL + function that is called to free @data, or %NULL @@ -45371,7 +48369,7 @@ As of GLib 2.34, #GMemoryInputStream implements - #GMemoryOutputStream is a class for using arbitrary + #GMemoryOutputStream is a class for using arbitrary memory chunks as output for GIO streaming output operations. As of GLib 2.34, #GMemoryOutputStream trivially implements @@ -45380,7 +48378,7 @@ As of GLib 2.34, #GMemoryOutputStream trivially implements - Creates a new #GMemoryOutputStream. + Creates a new #GMemoryOutputStream. In most cases this is not the function you want. See g_memory_output_stream_new_resizable() instead. @@ -45423,32 +48421,32 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); ]| - A newly created #GMemoryOutputStream object. + A newly created #GMemoryOutputStream object. - pointer to a chunk of memory to use, or %NULL + pointer to a chunk of memory to use, or %NULL - the size of @data + the size of @data - a function with realloc() semantics (like g_realloc()) + a function with realloc() semantics (like g_realloc()) to be called when @data needs to be grown, or %NULL - a function to be called on @data when the stream is + a function to be called on @data when the stream is finalized, or %NULL - Creates a new #GMemoryOutputStream, using g_realloc() and g_free() + Creates a new #GMemoryOutputStream, using g_realloc() and g_free() for memory allocation. @@ -45456,40 +48454,40 @@ for memory allocation. - Gets any loaded data from the @ostream. + Gets any loaded data from the @ostream. Note that the returned pointer may become invalid on the next write or truncate operation on the stream. - pointer to the stream's data, or %NULL if the data + pointer to the stream's data, or %NULL if the data has been stolen - a #GMemoryOutputStream + a #GMemoryOutputStream - Returns the number of bytes from the start up to including the last + Returns the number of bytes from the start up to including the last byte written in the stream that has not been truncated away. - the number of bytes written to the stream + the number of bytes written to the stream - a #GMemoryOutputStream + a #GMemoryOutputStream - Gets the size of the currently allocated data area (available from + Gets the size of the currently allocated data area (available from g_memory_output_stream_get_data()). You probably don't want to use this function on resizable streams. @@ -45506,33 +48504,33 @@ In any case, if you want the number of bytes currently written to the stream, use g_memory_output_stream_get_data_size(). - the number of bytes allocated for the data buffer + the number of bytes allocated for the data buffer - a #GMemoryOutputStream + a #GMemoryOutputStream - Returns data from the @ostream as a #GBytes. @ostream must be + Returns data from the @ostream as a #GBytes. @ostream must be closed before calling this function. - the stream's data + the stream's data - a #GMemoryOutputStream + a #GMemoryOutputStream - Gets any loaded data from the @ostream. Ownership of the data + Gets any loaded data from the @ostream. Ownership of the data is transferred to the caller; when no longer needed it must be freed using the free function set in @ostream's #GMemoryOutputStream:destroy-function property. @@ -45540,35 +48538,35 @@ freed using the free function set in @ostream's @ostream must be closed before calling this function. - the stream's data, or %NULL if it has previously + the stream's data, or %NULL if it has previously been stolen - a #GMemoryOutputStream + a #GMemoryOutputStream - Pointer to buffer where data will be written. + Pointer to buffer where data will be written. - Size of data written to the buffer. + Size of data written to the buffer. - Function called with the buffer as argument when the stream is destroyed. + Function called with the buffer as argument when the stream is destroyed. - Function with realloc semantics called to enlarge the buffer. + Function with realloc semantics called to enlarge the buffer. - Current size of the data buffer. + Current size of the data buffer. @@ -45628,7 +48626,7 @@ freed using the free function set in @ostream's - #GMenu is a simple implementation of #GMenuModel. + #GMenu is a simple implementation of #GMenuModel. You populate a #GMenu by adding #GMenuItem instances to it. There are some convenience functions to allow you to directly @@ -45637,17 +48635,17 @@ a regular item, use g_menu_insert(). To add a section, use g_menu_insert_section(). To add a submenu, use g_menu_insert_submenu(). - Creates a new #GMenu. + Creates a new #GMenu. The new menu has no items. - a new #GMenu + a new #GMenu - Convenience function for appending a normal menu item to the end of + Convenience function for appending a normal menu item to the end of @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. @@ -45656,21 +48654,21 @@ flexible alternative. - a #GMenu + a #GMenu - the section label, or %NULL + the section label, or %NULL - the detailed action string, or %NULL + the detailed action string, or %NULL - Appends @item to the end of @menu. + Appends @item to the end of @menu. See g_menu_insert_item() for more information. @@ -45679,17 +48677,17 @@ See g_menu_insert_item() for more information. - a #GMenu + a #GMenu - a #GMenuItem to append + a #GMenuItem to append - Convenience function for appending a section menu item to the end of + Convenience function for appending a section menu item to the end of @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. @@ -45698,21 +48696,21 @@ more flexible alternative. - a #GMenu + a #GMenu - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the section + a #GMenuModel with the items of the section - Convenience function for appending a submenu menu item to the end of + Convenience function for appending a submenu menu item to the end of @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. @@ -45721,21 +48719,21 @@ more flexible alternative. - a #GMenu + a #GMenu - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the submenu + a #GMenuModel with the items of the submenu - Marks @menu as frozen. + Marks @menu as frozen. After the menu is frozen, it is an error to attempt to make any changes to it. In effect this means that the #GMenu API must no @@ -45749,13 +48747,13 @@ This function causes g_menu_model_is_mutable() to begin returning - a #GMenu + a #GMenu - Convenience function for inserting a normal menu item into @menu. + Convenience function for inserting a normal menu item into @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. @@ -45764,25 +48762,25 @@ alternative. - a #GMenu + a #GMenu - the position at which to insert the item + the position at which to insert the item - the section label, or %NULL + the section label, or %NULL - the detailed action string, or %NULL + the detailed action string, or %NULL - Inserts @item into @menu. + Inserts @item into @menu. The "insertion" is actually done by copying all of the attribute and link values of @item and using them to form a new item within @menu. @@ -45805,21 +48803,21 @@ each of these functions. - a #GMenu + a #GMenu - the position at which to insert the item + the position at which to insert the item - the #GMenuItem to insert + the #GMenuItem to insert - Convenience function for inserting a section menu item into @menu. + Convenience function for inserting a section menu item into @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. @@ -45828,25 +48826,25 @@ flexible alternative. - a #GMenu + a #GMenu - the position at which to insert the item + the position at which to insert the item - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the section + a #GMenuModel with the items of the section - Convenience function for inserting a submenu menu item into @menu. + Convenience function for inserting a submenu menu item into @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. @@ -45855,25 +48853,25 @@ flexible alternative. - a #GMenu + a #GMenu - the position at which to insert the item + the position at which to insert the item - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the submenu + a #GMenuModel with the items of the submenu - Convenience function for prepending a normal menu item to the start + Convenience function for prepending a normal menu item to the start of @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. @@ -45882,21 +48880,21 @@ flexible alternative. - a #GMenu + a #GMenu - the section label, or %NULL + the section label, or %NULL - the detailed action string, or %NULL + the detailed action string, or %NULL - Prepends @item to the start of @menu. + Prepends @item to the start of @menu. See g_menu_insert_item() for more information. @@ -45905,17 +48903,17 @@ See g_menu_insert_item() for more information. - a #GMenu + a #GMenu - a #GMenuItem to prepend + a #GMenuItem to prepend - Convenience function for prepending a section menu item to the start + Convenience function for prepending a section menu item to the start of @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. @@ -45924,21 +48922,21 @@ a more flexible alternative. - a #GMenu + a #GMenu - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the section + a #GMenuModel with the items of the section - Convenience function for prepending a submenu menu item to the start + Convenience function for prepending a submenu menu item to the start of @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. @@ -45947,21 +48945,21 @@ a more flexible alternative. - a #GMenu + a #GMenu - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the submenu + a #GMenuModel with the items of the submenu - Removes an item from the menu. + Removes an item from the menu. @position gives the index of the item to remove. @@ -45977,35 +48975,35 @@ identity of the item itself is not preserved). - a #GMenu + a #GMenu - the position of the item to remove + the position of the item to remove - Removes all items in the menu. + Removes all items in the menu. - a #GMenu + a #GMenu - #GMenuAttributeIter is an opaque structure type. You must access it + #GMenuAttributeIter is an opaque structure type. You must access it using the functions below. - This function combines g_menu_attribute_iter_next() with + This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). First the iterator is advanced to the next (possibly first) attribute. @@ -46022,44 +49020,44 @@ remains at the current position. The value returned in @value must be unreffed using g_variant_unref() when it is no longer in use. - %TRUE on success, or %FALSE if there is no additional + %TRUE on success, or %FALSE if there is no additional attribute - a #GMenuAttributeIter + a #GMenuAttributeIter - the type of the attribute + the type of the attribute - the attribute value + the attribute value - Gets the name of the attribute at the current iterator position, as + Gets the name of the attribute at the current iterator position, as a string. The iterator is not advanced. - the name of the attribute + the name of the attribute - a #GMenuAttributeIter + a #GMenuAttributeIter - This function combines g_menu_attribute_iter_next() with + This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). First the iterator is advanced to the next (possibly first) attribute. @@ -46076,43 +49074,43 @@ remains at the current position. The value returned in @value must be unreffed using g_variant_unref() when it is no longer in use. - %TRUE on success, or %FALSE if there is no additional + %TRUE on success, or %FALSE if there is no additional attribute - a #GMenuAttributeIter + a #GMenuAttributeIter - the type of the attribute + the type of the attribute - the attribute value + the attribute value - Gets the value of the attribute at the current iterator position. + Gets the value of the attribute at the current iterator position. The iterator is not advanced. - the value of the current attribute + the value of the current attribute - a #GMenuAttributeIter + a #GMenuAttributeIter - Attempts to advance the iterator to the next (possibly first) + Attempts to advance the iterator to the next (possibly first) attribute. %TRUE is returned on success, or %FALSE if there are no more @@ -46123,12 +49121,12 @@ to advance it to the first attribute (and determine if the first attribute exists at all). - %TRUE on success, or %FALSE when there are no more attributes + %TRUE on success, or %FALSE when there are no more attributes - a #GMenuAttributeIter + a #GMenuAttributeIter @@ -46149,21 +49147,21 @@ attribute exists at all). - %TRUE on success, or %FALSE if there is no additional + %TRUE on success, or %FALSE if there is no additional attribute - a #GMenuAttributeIter + a #GMenuAttributeIter - the type of the attribute + the type of the attribute - the attribute value + the attribute value @@ -46174,10 +49172,10 @@ attribute exists at all). - #GMenuItem is an opaque structure type. You must access it using the + #GMenuItem is an opaque structure type. You must access it using the functions below. - Creates a new #GMenuItem. + Creates a new #GMenuItem. If @label is non-%NULL it is used to set the "label" attribute of the new item. @@ -46187,44 +49185,44 @@ possibly the "target" attribute of the new item. See g_menu_item_set_detailed_action() for more information. - a new #GMenuItem + a new #GMenuItem - the section label, or %NULL + the section label, or %NULL - the detailed action string, or %NULL + the detailed action string, or %NULL - Creates a #GMenuItem as an exact copy of an existing menu item in a + Creates a #GMenuItem as an exact copy of an existing menu item in a #GMenuModel. @item_index must be valid (ie: be sure to call g_menu_model_get_n_items() first). - a new #GMenuItem. + a new #GMenuItem. - a #GMenuModel + a #GMenuModel - the index of an item in @model + the index of an item in @model - Creates a new #GMenuItem representing a section. + Creates a new #GMenuItem representing a section. This is a convenience API around g_menu_item_new() and g_menu_item_set_section(). @@ -46286,43 +49284,43 @@ purpose of understanding what is really going on). ]| - a new #GMenuItem + a new #GMenuItem - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the section + a #GMenuModel with the items of the section - Creates a new #GMenuItem representing a submenu. + Creates a new #GMenuItem representing a submenu. This is a convenience API around g_menu_item_new() and g_menu_item_set_submenu(). - a new #GMenuItem + a new #GMenuItem - the section label, or %NULL + the section label, or %NULL - a #GMenuModel with the items of the submenu + a #GMenuModel with the items of the submenu - Queries the named @attribute on @menu_item. + Queries the named @attribute on @menu_item. If the attribute exists and matches the #GVariantType corresponding to @format_string then @format_string is used to deconstruct the @@ -46333,75 +49331,75 @@ type, then the positional parameters are ignored and %FALSE is returned. - %TRUE if the named attribute was found with the expected + %TRUE if the named attribute was found with the expected type - a #GMenuItem + a #GMenuItem - the attribute name to query + the attribute name to query - a #GVariant format string + a #GVariant format string - positional parameters, as per @format_string + positional parameters, as per @format_string - Queries the named @attribute on @menu_item. + Queries the named @attribute on @menu_item. If @expected_type is specified and the attribute does not have this type, %NULL is returned. %NULL is also returned if the attribute simply does not exist. - the attribute value, or %NULL + the attribute value, or %NULL - a #GMenuItem + a #GMenuItem - the attribute name to query + the attribute name to query - the expected type of the attribute + the expected type of the attribute - Queries the named @link on @menu_item. + Queries the named @link on @menu_item. - the link, or %NULL + the link, or %NULL - a #GMenuItem + a #GMenuItem - the link name to query + the link name to query - Sets or unsets the "action" and "target" attributes of @menu_item. + Sets or unsets the "action" and "target" attributes of @menu_item. If @action is %NULL then both the "action" and "target" attributes are unset (and @format_string is ignored along with the positional @@ -46426,25 +49424,25 @@ description of the semantics of the action and target attributes. - a #GMenuItem + a #GMenuItem - the name of the action for this item + the name of the action for this item - a GVariant format string + a GVariant format string - positional parameters, as per @format_string + positional parameters, as per @format_string - Sets or unsets the "action" and "target" attributes of @menu_item. + Sets or unsets the "action" and "target" attributes of @menu_item. If @action is %NULL then both the "action" and "target" attributes are unset (and @target_value is ignored). @@ -46486,21 +49484,21 @@ probably more convenient for most uses. - a #GMenuItem + a #GMenuItem - the name of the action for this item + the name of the action for this item - a #GVariant to use as the action target + a #GVariant to use as the action target - Sets or unsets an attribute on @menu_item. + Sets or unsets an attribute on @menu_item. The attribute to set or unset is specified by @attribute. This can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, @@ -46523,25 +49521,25 @@ that directly accepts a #GVariant. - a #GMenuItem + a #GMenuItem - the attribute to set + the attribute to set - a #GVariant format string, or %NULL + a #GVariant format string, or %NULL - positional parameters, as per @format_string + positional parameters, as per @format_string - Sets or unsets an attribute on @menu_item. + Sets or unsets an attribute on @menu_item. The attribute to set or unset is specified by @attribute. This can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, @@ -46566,21 +49564,21 @@ the same. - a #GMenuItem + a #GMenuItem - the attribute to set + the attribute to set - a #GVariant to use as the value, or %NULL + a #GVariant to use as the value, or %NULL - Sets the "action" and possibly the "target" attribute of @menu_item. + Sets the "action" and possibly the "target" attribute of @menu_item. The format of @detailed_action is the same format parsed by g_action_parse_detailed_name(). @@ -46597,17 +49595,17 @@ the semantics of the action and target attributes. - a #GMenuItem + a #GMenuItem - the "detailed" action string + the "detailed" action string - Sets (or unsets) the icon on @menu_item. + Sets (or unsets) the icon on @menu_item. This call is the same as calling g_icon_serialize() and using the result as the value to g_menu_item_set_attribute_value() for @@ -46625,17 +49623,17 @@ If @icon is %NULL then the icon is unset. - a #GMenuItem + a #GMenuItem - a #GIcon, or %NULL + a #GIcon, or %NULL - Sets or unsets the "label" attribute of @menu_item. + Sets or unsets the "label" attribute of @menu_item. If @label is non-%NULL it is used as the label for the menu item. If it is %NULL then the label attribute is unset. @@ -46645,17 +49643,17 @@ it is %NULL then the label attribute is unset. - a #GMenuItem + a #GMenuItem - the label to set, or %NULL to unset + the label to set, or %NULL to unset - Creates a link from @menu_item to @model if non-%NULL, or unsets it. + Creates a link from @menu_item to @model if non-%NULL, or unsets it. Links are used to establish a relationship between a particular menu item and another menu. For example, %G_MENU_LINK_SUBMENU is used to @@ -46671,21 +49669,21 @@ must not end with a '-', and must not contain consecutive dashes. - a #GMenuItem + a #GMenuItem - type of link to establish or unset + type of link to establish or unset - the #GMenuModel to link to (or %NULL to unset) + the #GMenuModel to link to (or %NULL to unset) - Sets or unsets the "section" link of @menu_item to @section. + Sets or unsets the "section" link of @menu_item to @section. The effect of having one menu appear as a section of another is exactly as it sounds: the items from @section become a direct part of @@ -46698,17 +49696,17 @@ section. - a #GMenuItem + a #GMenuItem - a #GMenuModel, or %NULL + a #GMenuModel, or %NULL - Sets or unsets the "submenu" link of @menu_item to @submenu. + Sets or unsets the "submenu" link of @menu_item to @submenu. If @submenu is non-%NULL, it is linked to. If it is %NULL then the link is unset. @@ -46721,22 +49719,22 @@ exactly as it sounds. - a #GMenuItem + a #GMenuItem - a #GMenuModel, or %NULL + a #GMenuModel, or %NULL - #GMenuLinkIter is an opaque structure type. You must access it using + #GMenuLinkIter is an opaque structure type. You must access it using the functions below. - This function combines g_menu_link_iter_next() with + This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). First the iterator is advanced to the next (possibly first) link. @@ -46752,42 +49750,42 @@ remains at the current position. The value returned in @value must be unreffed using g_object_unref() when it is no longer in use. - %TRUE on success, or %FALSE if there is no additional link + %TRUE on success, or %FALSE if there is no additional link - a #GMenuLinkIter + a #GMenuLinkIter - the name of the link + the name of the link - the linked #GMenuModel + the linked #GMenuModel - Gets the name of the link at the current iterator position. + Gets the name of the link at the current iterator position. The iterator is not advanced. - the type of the link + the type of the link - a #GMenuLinkIter + a #GMenuLinkIter - This function combines g_menu_link_iter_next() with + This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). First the iterator is advanced to the next (possibly first) link. @@ -46803,42 +49801,42 @@ remains at the current position. The value returned in @value must be unreffed using g_object_unref() when it is no longer in use. - %TRUE on success, or %FALSE if there is no additional link + %TRUE on success, or %FALSE if there is no additional link - a #GMenuLinkIter + a #GMenuLinkIter - the name of the link + the name of the link - the linked #GMenuModel + the linked #GMenuModel - Gets the linked #GMenuModel at the current iterator position. + Gets the linked #GMenuModel at the current iterator position. The iterator is not advanced. - the #GMenuModel that is linked to + the #GMenuModel that is linked to - a #GMenuLinkIter + a #GMenuLinkIter - Attempts to advance the iterator to the next (possibly first) + Attempts to advance the iterator to the next (possibly first) link. %TRUE is returned on success, or %FALSE if there are no more links. @@ -46848,12 +49846,12 @@ advance it to the first link (and determine if the first link exists at all). - %TRUE on success, or %FALSE when there are no more links + %TRUE on success, or %FALSE when there are no more links - a #GMenuLinkIter + a #GMenuLinkIter @@ -46874,20 +49872,20 @@ at all). - %TRUE on success, or %FALSE if there is no additional link + %TRUE on success, or %FALSE if there is no additional link - a #GMenuLinkIter + a #GMenuLinkIter - the name of the link + the name of the link - the linked #GMenuModel + the linked #GMenuModel @@ -46898,7 +49896,7 @@ at all). - #GMenuModel represents the contents of a menu -- an ordered list of + #GMenuModel represents the contents of a menu -- an ordered list of menu items. The items are associated with actions, which can be activated through them. Items can be grouped in sections, and may have submenus associated with them. Both items and sections usually @@ -47013,7 +50011,7 @@ be rendered as "selected" when the state of the action is equal to the target value of the menu item. - Queries the item at position @item_index in @model for the attribute + Queries the item at position @item_index in @model for the attribute specified by @attribute. If @expected_type is non-%NULL then it specifies the expected type of @@ -47026,24 +50024,24 @@ If the attribute does not exist, or does not match the expected type then %NULL is returned. - the value of the attribute + the value of the attribute - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - the attribute to query + the attribute to query - the expected type of the attribute, or + the expected type of the attribute, or %NULL @@ -47074,27 +50072,27 @@ then %NULL is returned. - Queries the item at position @item_index in @model for the link + Queries the item at position @item_index in @model for the link specified by @link. If the link exists, the linked #GMenuModel is returned. If the link does not exist, %NULL is returned. - the linked #GMenuModel, or %NULL + the linked #GMenuModel, or %NULL - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - the link to query + the link to query @@ -47124,81 +50122,81 @@ does not exist, %NULL is returned. - Query the number of items in @model. + Query the number of items in @model. - the number of items + the number of items - a #GMenuModel + a #GMenuModel - Queries if @model is mutable. + Queries if @model is mutable. An immutable #GMenuModel will never emit the #GMenuModel::items-changed signal. Consumers of the model may make optimisations accordingly. - %TRUE if the model is mutable (ie: "items-changed" may be + %TRUE if the model is mutable (ie: "items-changed" may be emitted). - a #GMenuModel + a #GMenuModel - Creates a #GMenuAttributeIter to iterate over the attributes of + Creates a #GMenuAttributeIter to iterate over the attributes of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - a new #GMenuAttributeIter + a new #GMenuAttributeIter - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - Creates a #GMenuLinkIter to iterate over the links of the item at + Creates a #GMenuLinkIter to iterate over the links of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - a new #GMenuLinkIter + a new #GMenuLinkIter - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - Queries item at position @item_index in @model for the attribute + Queries item at position @item_index in @model for the attribute specified by @attribute. If the attribute exists and matches the #GVariantType corresponding @@ -47216,35 +50214,35 @@ g_variant_get(), followed by a g_variant_unref(). As such, particular, no '&' characters are allowed in @format_string. - %TRUE if the named attribute was found with the expected + %TRUE if the named attribute was found with the expected type - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - the attribute to query + the attribute to query - a #GVariant format string + a #GVariant format string - positional parameters, as per @format_string + positional parameters, as per @format_string - Queries the item at position @item_index in @model for the attribute + Queries the item at position @item_index in @model for the attribute specified by @attribute. If @expected_type is non-%NULL then it specifies the expected type of @@ -47257,89 +50255,89 @@ If the attribute does not exist, or does not match the expected type then %NULL is returned. - the value of the attribute + the value of the attribute - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - the attribute to query + the attribute to query - the expected type of the attribute, or + the expected type of the attribute, or %NULL - Queries the item at position @item_index in @model for the link + Queries the item at position @item_index in @model for the link specified by @link. If the link exists, the linked #GMenuModel is returned. If the link does not exist, %NULL is returned. - the linked #GMenuModel, or %NULL + the linked #GMenuModel, or %NULL - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - the link to query + the link to query - Query the number of items in @model. + Query the number of items in @model. - the number of items + the number of items - a #GMenuModel + a #GMenuModel - Queries if @model is mutable. + Queries if @model is mutable. An immutable #GMenuModel will never emit the #GMenuModel::items-changed signal. Consumers of the model may make optimisations accordingly. - %TRUE if the model is mutable (ie: "items-changed" may be + %TRUE if the model is mutable (ie: "items-changed" may be emitted). - a #GMenuModel + a #GMenuModel - Requests emission of the #GMenuModel::items-changed signal on @model. + Requests emission of the #GMenuModel::items-changed signal on @model. This function should never be called except by #GMenuModel subclasses. Any other calls to this function will very likely lead @@ -47360,61 +50358,61 @@ user code is running without returning to the mainloop. - a #GMenuModel + a #GMenuModel - the position of the change + the position of the change - the number of items removed + the number of items removed - the number of items added + the number of items added - Creates a #GMenuAttributeIter to iterate over the attributes of + Creates a #GMenuAttributeIter to iterate over the attributes of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - a new #GMenuAttributeIter + a new #GMenuAttributeIter - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - Creates a #GMenuLinkIter to iterate over the links of the item at + Creates a #GMenuLinkIter to iterate over the links of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - a new #GMenuLinkIter + a new #GMenuLinkIter - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item @@ -47426,7 +50424,7 @@ You must free the iterator with g_object_unref() when you are done. - Emitted when a change has occured to the menu. + Emitted when a change has occured to the menu. The only changes that can occur to a menu is that items are removed or added. Items may not change (except by being removed and added @@ -47451,15 +50449,15 @@ reported. The signal is emitted after the modification. - the position of the change + the position of the change - the number of items removed + the number of items removed - the number of items added + the number of items added @@ -47474,13 +50472,13 @@ reported. The signal is emitted after the modification. - %TRUE if the model is mutable (ie: "items-changed" may be + %TRUE if the model is mutable (ie: "items-changed" may be emitted). - a #GMenuModel + a #GMenuModel @@ -47490,12 +50488,12 @@ reported. The signal is emitted after the modification. - the number of items + the number of items - a #GMenuModel + a #GMenuModel @@ -47530,16 +50528,16 @@ reported. The signal is emitted after the modification. - a new #GMenuAttributeIter + a new #GMenuAttributeIter - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item @@ -47549,24 +50547,24 @@ reported. The signal is emitted after the modification. - the value of the attribute + the value of the attribute - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - the attribute to query + the attribute to query - the expected type of the attribute, or + the expected type of the attribute, or %NULL @@ -47602,16 +50600,16 @@ reported. The signal is emitted after the modification. - a new #GMenuLinkIter + a new #GMenuLinkIter - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item @@ -47621,20 +50619,20 @@ reported. The signal is emitted after the modification. - the linked #GMenuModel, or %NULL + the linked #GMenuModel, or %NULL - a #GMenuModel + a #GMenuModel - the index of the item + the index of the item - the link to query + the link to query @@ -47645,7 +50643,7 @@ reported. The signal is emitted after the modification. - The #GMount interface represents user-visible mounts. Note, when + The #GMount interface represents user-visible mounts. Note, when porting from GnomeVFS, #GMount is the moral equivalent of #GnomeVFSVolume. #GMount is a "mounted" filesystem that you can access. Mounted is in @@ -47666,29 +50664,29 @@ successfully. If an @error is present when g_mount_unmount_with_operation_finis is called, then it will be filled with any error information. - Checks if @mount can be ejected. + Checks if @mount can be ejected. - %TRUE if the @mount can be ejected. + %TRUE if the @mount can be ejected. - a #GMount. + a #GMount. - Checks if @mount can be unmounted. + Checks if @mount can be unmounted. - %TRUE if the @mount can be unmounted. + %TRUE if the @mount can be unmounted. - a #GMount. + a #GMount. @@ -47705,7 +50703,7 @@ is called, then it will be filled with any error information. - Ejects a mount. This is an asynchronous operation, and is + Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_eject_with_operation() instead. @@ -47715,49 +50713,49 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes ejecting a mount. If any errors occurred during the operation, + Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_eject_with_operation_finish() instead. - %TRUE if the mount was successfully ejected. %FALSE otherwise. + %TRUE if the mount was successfully ejected. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Ejects a mount. This is an asynchronous operation, and is + Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -47766,77 +50764,77 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes ejecting a mount. If any errors occurred during the operation, + Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the mount was successfully ejected. %FALSE otherwise. + %TRUE if the mount was successfully ejected. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Gets the default location of @mount. The default location of the given + Gets the default location of @mount. The default location of the given @mount is a path that reflects the main entry point for the user (e.g. the home directory, or the root of the volume). - a #GFile. + a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the drive for the @mount. + Gets the drive for the @mount. This is a convenience method for getting the #GVolume and then using that object to get the #GDrive. - a #GDrive or %NULL if @mount is not + a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -47844,97 +50842,97 @@ using that object to get the #GDrive. - a #GMount. + a #GMount. - Gets the icon for @mount. + Gets the icon for @mount. - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the name of @mount. + Gets the name of @mount. - the name for the given @mount. + the name for the given @mount. The returned string should be freed with g_free() when no longer needed. - a #GMount. + a #GMount. - Gets the root directory on @mount. + Gets the root directory on @mount. - a #GFile. + a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the sort key for @mount, if any. + Gets the sort key for @mount, if any. - Sorting key for @mount or %NULL if no such key is available. + Sorting key for @mount or %NULL if no such key is available. - A #GMount. + A #GMount. - Gets the symbolic icon for @mount. + Gets the symbolic icon for @mount. - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the UUID for the @mount. The reference is typically based on + Gets the UUID for the @mount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - the UUID for @mount or %NULL if no UUID + the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -47942,16 +50940,16 @@ available. - a #GMount. + a #GMount. - Gets the volume for the @mount. + Gets the volume for the @mount. - a #GVolume or %NULL if @mount is not + a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -47959,13 +50957,13 @@ available. - a #GMount. + a #GMount. - Tries to guess the type of content stored on @mount. Returns one or + Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -47982,37 +50980,37 @@ is finished by calling g_mount_guess_content_type_finish() with the - a #GMount + a #GMount - Whether to force a rescan of the content. + Whether to force a rescan of the content. Otherwise a cached result will be used if available - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data passed to @callback + user data passed to @callback - Finishes guessing content types of @mount. If any errors occurred + Finishes guessing content types of @mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. In particular, you may get an %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content guessing. - a %NULL-terminated array of content types or %NULL on error. + a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -48020,17 +51018,17 @@ guessing. - a #GMount + a #GMount - a #GAsyncResult + a #GAsyncResult - Tries to guess the type of content stored on @mount. Returns one or + Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -48041,7 +51039,7 @@ This is an synchronous operation and as such may block doing IO; see g_mount_guess_content_type() for the asynchronous version. - a %NULL-terminated array of content types or %NULL on error. + a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -48049,16 +51047,16 @@ see g_mount_guess_content_type() for the asynchronous version. - a #GMount + a #GMount - Whether to force a rescan of the content. + Whether to force a rescan of the content. Otherwise a cached result will be used if available - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore @@ -48075,7 +51073,7 @@ see g_mount_guess_content_type() for the asynchronous version. - Remounts a mount. This is an asynchronous operation, and is + Remounts a mount. This is an asynchronous operation, and is finished by calling g_mount_remount_finish() with the @mount and #GAsyncResults data returned in the @callback. @@ -48090,53 +51088,53 @@ unmounted. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes remounting a mount. If any errors occurred during the operation, + Finishes remounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the mount was successfully remounted. %FALSE otherwise. + %TRUE if the mount was successfully remounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Unmounts a mount. This is an asynchronous operation, and is + Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_unmount_with_operation() instead. @@ -48146,49 +51144,49 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes unmounting a mount. If any errors occurred during the operation, + Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_unmount_with_operation_finish() instead. - %TRUE if the mount was successfully unmounted. %FALSE otherwise. + %TRUE if the mount was successfully unmounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Unmounts a mount. This is an asynchronous operation, and is + Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -48197,47 +51195,47 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes unmounting a mount. If any errors occurred during the operation, + Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the mount was successfully unmounted. %FALSE otherwise. + %TRUE if the mount was successfully unmounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. @@ -48254,35 +51252,35 @@ and #GAsyncResult data returned in the @callback. - Checks if @mount can be ejected. + Checks if @mount can be ejected. - %TRUE if the @mount can be ejected. + %TRUE if the @mount can be ejected. - a #GMount. + a #GMount. - Checks if @mount can be unmounted. + Checks if @mount can be unmounted. - %TRUE if the @mount can be unmounted. + %TRUE if the @mount can be unmounted. - a #GMount. + a #GMount. - Ejects a mount. This is an asynchronous operation, and is + Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_eject_with_operation() instead. @@ -48292,49 +51290,49 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes ejecting a mount. If any errors occurred during the operation, + Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_eject_with_operation_finish() instead. - %TRUE if the mount was successfully ejected. %FALSE otherwise. + %TRUE if the mount was successfully ejected. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Ejects a mount. This is an asynchronous operation, and is + Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -48343,77 +51341,77 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes ejecting a mount. If any errors occurred during the operation, + Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the mount was successfully ejected. %FALSE otherwise. + %TRUE if the mount was successfully ejected. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Gets the default location of @mount. The default location of the given + Gets the default location of @mount. The default location of the given @mount is a path that reflects the main entry point for the user (e.g. the home directory, or the root of the volume). - a #GFile. + a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the drive for the @mount. + Gets the drive for the @mount. This is a convenience method for getting the #GVolume and then using that object to get the #GDrive. - a #GDrive or %NULL if @mount is not + a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -48421,97 +51419,97 @@ using that object to get the #GDrive. - a #GMount. + a #GMount. - Gets the icon for @mount. + Gets the icon for @mount. - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the name of @mount. + Gets the name of @mount. - the name for the given @mount. + the name for the given @mount. The returned string should be freed with g_free() when no longer needed. - a #GMount. + a #GMount. - Gets the root directory on @mount. + Gets the root directory on @mount. - a #GFile. + a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the sort key for @mount, if any. + Gets the sort key for @mount, if any. - Sorting key for @mount or %NULL if no such key is available. + Sorting key for @mount or %NULL if no such key is available. - A #GMount. + A #GMount. - Gets the symbolic icon for @mount. + Gets the symbolic icon for @mount. - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. - Gets the UUID for the @mount. The reference is typically based on + Gets the UUID for the @mount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - the UUID for @mount or %NULL if no UUID + the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -48519,16 +51517,16 @@ available. - a #GMount. + a #GMount. - Gets the volume for the @mount. + Gets the volume for the @mount. - a #GVolume or %NULL if @mount is not + a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -48536,13 +51534,13 @@ available. - a #GMount. + a #GMount. - Tries to guess the type of content stored on @mount. Returns one or + Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -48559,37 +51557,37 @@ is finished by calling g_mount_guess_content_type_finish() with the - a #GMount + a #GMount - Whether to force a rescan of the content. + Whether to force a rescan of the content. Otherwise a cached result will be used if available - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data passed to @callback + user data passed to @callback - Finishes guessing content types of @mount. If any errors occurred + Finishes guessing content types of @mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. In particular, you may get an %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content guessing. - a %NULL-terminated array of content types or %NULL on error. + a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -48597,17 +51595,17 @@ guessing. - a #GMount + a #GMount - a #GAsyncResult + a #GAsyncResult - Tries to guess the type of content stored on @mount. Returns one or + Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -48618,7 +51616,7 @@ This is an synchronous operation and as such may block doing IO; see g_mount_guess_content_type() for the asynchronous version. - a %NULL-terminated array of content types or %NULL on error. + a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -48626,22 +51624,22 @@ see g_mount_guess_content_type() for the asynchronous version. - a #GMount + a #GMount - Whether to force a rescan of the content. + Whether to force a rescan of the content. Otherwise a cached result will be used if available - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Determines if @mount is shadowed. Applications or libraries should + Determines if @mount is shadowed. Applications or libraries should avoid displaying @mount in the user interface if it is shadowed. A mount is said to be shadowed if there exists one or more user @@ -48666,18 +51664,18 @@ manage shadow mounts (and shadows the underlying mount) if the activation root on a #GVolume is set. - %TRUE if @mount is shadowed. + %TRUE if @mount is shadowed. - A #GMount. + A #GMount. - Remounts a mount. This is an asynchronous operation, and is + Remounts a mount. This is an asynchronous operation, and is finished by calling g_mount_remount_finish() with the @mount and #GAsyncResults data returned in the @callback. @@ -48692,53 +51690,53 @@ unmounted. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes remounting a mount. If any errors occurred during the operation, + Finishes remounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the mount was successfully remounted. %FALSE otherwise. + %TRUE if the mount was successfully remounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Increments the shadow count on @mount. Usually used by + Increments the shadow count on @mount. Usually used by #GVolumeMonitor implementations when creating a shadow mount for @mount, see g_mount_is_shadowed() for more information. The caller will need to emit the #GMount::changed signal on @mount manually. @@ -48748,13 +51746,13 @@ will need to emit the #GMount::changed signal on @mount manually. - A #GMount. + A #GMount. - Unmounts a mount. This is an asynchronous operation, and is + Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_unmount_with_operation() instead. @@ -48764,49 +51762,49 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes unmounting a mount. If any errors occurred during the operation, + Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_unmount_with_operation_finish() instead. - %TRUE if the mount was successfully unmounted. %FALSE otherwise. + %TRUE if the mount was successfully unmounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Unmounts a mount. This is an asynchronous operation, and is + Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. @@ -48815,53 +51813,53 @@ and #GAsyncResult data returned in the @callback. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. - Finishes unmounting a mount. If any errors occurred during the operation, + Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - %TRUE if the mount was successfully unmounted. %FALSE otherwise. + %TRUE if the mount was successfully unmounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. - Decrements the shadow count on @mount. Usually used by + Decrements the shadow count on @mount. Usually used by #GVolumeMonitor implementations when destroying a shadow mount for @mount, see g_mount_is_shadowed() for more information. The caller will need to emit the #GMount::changed signal on @mount manually. @@ -48871,19 +51869,19 @@ will need to emit the #GMount::changed signal on @mount manually. - A #GMount. + A #GMount. - Emitted when the mount has been changed. + Emitted when the mount has been changed. - This signal may be emitted when the #GMount is about to be + This signal may be emitted when the #GMount is about to be unmounted. This signal depends on the backend and is only emitted if @@ -48893,7 +51891,7 @@ GIO was used to unmount. - This signal is emitted when the #GMount have been + This signal is emitted when the #GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -48939,14 +51937,14 @@ finalized. - a #GFile. + a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. @@ -48956,14 +51954,14 @@ finalized. - the name for the given @mount. + the name for the given @mount. The returned string should be freed with g_free() when no longer needed. - a #GMount. + a #GMount. @@ -48973,14 +51971,14 @@ finalized. - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. @@ -48990,7 +51988,7 @@ finalized. - the UUID for @mount or %NULL if no UUID + the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -48998,7 +51996,7 @@ finalized. - a #GMount. + a #GMount. @@ -49008,7 +52006,7 @@ finalized. - a #GVolume or %NULL if @mount is not + a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -49016,7 +52014,7 @@ finalized. - a #GMount. + a #GMount. @@ -49026,7 +52024,7 @@ finalized. - a #GDrive or %NULL if @mount is not + a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -49034,7 +52032,7 @@ finalized. - a #GMount. + a #GMount. @@ -49044,12 +52042,12 @@ finalized. - %TRUE if the @mount can be unmounted. + %TRUE if the @mount can be unmounted. - a #GMount. + a #GMount. @@ -49059,12 +52057,12 @@ finalized. - %TRUE if the @mount can be ejected. + %TRUE if the @mount can be ejected. - a #GMount. + a #GMount. @@ -49078,23 +52076,23 @@ finalized. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. @@ -49104,16 +52102,16 @@ finalized. - %TRUE if the mount was successfully unmounted. %FALSE otherwise. + %TRUE if the mount was successfully unmounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. @@ -49127,23 +52125,23 @@ finalized. - a #GMount. + a #GMount. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. @@ -49153,16 +52151,16 @@ finalized. - %TRUE if the mount was successfully ejected. %FALSE otherwise. + %TRUE if the mount was successfully ejected. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. @@ -49176,28 +52174,28 @@ finalized. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. @@ -49207,16 +52205,16 @@ finalized. - %TRUE if the mount was successfully remounted. %FALSE otherwise. + %TRUE if the mount was successfully remounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. @@ -49230,24 +52228,24 @@ finalized. - a #GMount + a #GMount - Whether to force a rescan of the content. + Whether to force a rescan of the content. Otherwise a cached result will be used if available - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data passed to @callback + user data passed to @callback @@ -49257,7 +52255,7 @@ finalized. - a %NULL-terminated array of content types or %NULL on error. + a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -49265,11 +52263,11 @@ finalized. - a #GMount + a #GMount - a #GAsyncResult + a #GAsyncResult @@ -49279,7 +52277,7 @@ finalized. - a %NULL-terminated array of content types or %NULL on error. + a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -49287,16 +52285,16 @@ finalized. - a #GMount + a #GMount - Whether to force a rescan of the content. + Whether to force a rescan of the content. Otherwise a cached result will be used if available - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore @@ -49323,28 +52321,28 @@ finalized. - a #GMount. + a #GMount. - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. @@ -49354,16 +52352,16 @@ finalized. - %TRUE if the mount was successfully unmounted. %FALSE otherwise. + %TRUE if the mount was successfully unmounted. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. @@ -49377,28 +52375,28 @@ finalized. - a #GMount. + a #GMount. - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to avoid + a #GMountOperation or %NULL to avoid user interaction. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback, or %NULL. + a #GAsyncReadyCallback, or %NULL. - user data passed to @callback. + user data passed to @callback. @@ -49408,16 +52406,16 @@ finalized. - %TRUE if the mount was successfully ejected. %FALSE otherwise. + %TRUE if the mount was successfully ejected. %FALSE otherwise. - a #GMount. + a #GMount. - a #GAsyncResult. + a #GAsyncResult. @@ -49427,14 +52425,14 @@ finalized. - a #GFile. + a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. @@ -49444,12 +52442,12 @@ finalized. - Sorting key for @mount or %NULL if no such key is available. + Sorting key for @mount or %NULL if no such key is available. - A #GMount. + A #GMount. @@ -49459,14 +52457,14 @@ finalized. - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GMount. + a #GMount. @@ -49480,7 +52478,7 @@ finalized. - #GMountOperation provides a mechanism for interacting with the user. + #GMountOperation provides a mechanism for interacting with the user. It can be used for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. It can also be used to ask the user questions or show a list of applications @@ -49503,10 +52501,10 @@ encrypting file containers, partitions or whole disks, typically used with Windo improvements and auditing fixes. - Creates a new mount operation. + Creates a new mount operation. - a #GMountOperation. + a #GMountOperation. @@ -49569,18 +52567,18 @@ improvements and auditing fixes. - Emits the #GMountOperation::reply signal. + Emits the #GMountOperation::reply signal. - a #GMountOperation + a #GMountOperation - a #GMountOperationResult + a #GMountOperationResult @@ -49637,325 +52635,325 @@ improvements and auditing fixes. - Check to see whether the mount operation is being used + Check to see whether the mount operation is being used for an anonymous user. - %TRUE if mount operation is anonymous. + %TRUE if mount operation is anonymous. - a #GMountOperation. + a #GMountOperation. - Gets a choice from the mount operation. + Gets a choice from the mount operation. - an integer containing an index of the user's choice from -the choice's list, or %0. + an integer containing an index of the user's choice from +the choice's list, or `0`. - a #GMountOperation. + a #GMountOperation. - Gets the domain of the mount operation. + Gets the domain of the mount operation. - a string set to the domain. + a string set to the domain. - a #GMountOperation. + a #GMountOperation. - Check to see whether the mount operation is being used + Check to see whether the mount operation is being used for a TCRYPT hidden volume. - %TRUE if mount operation is for hidden volume. + %TRUE if mount operation is for hidden volume. - a #GMountOperation. + a #GMountOperation. - Check to see whether the mount operation is being used + Check to see whether the mount operation is being used for a TCRYPT system volume. - %TRUE if mount operation is for system volume. + %TRUE if mount operation is for system volume. - a #GMountOperation. + a #GMountOperation. - Gets a password from the mount operation. + Gets a password from the mount operation. - a string containing the password within @op. + a string containing the password within @op. - a #GMountOperation. + a #GMountOperation. - Gets the state of saving passwords for the mount operation. + Gets the state of saving passwords for the mount operation. - a #GPasswordSave flag. + a #GPasswordSave flag. - a #GMountOperation. + a #GMountOperation. - Gets a PIM from the mount operation. + Gets a PIM from the mount operation. - The VeraCrypt PIM within @op. + The VeraCrypt PIM within @op. - a #GMountOperation. + a #GMountOperation. - Get the user name from the mount operation. + Get the user name from the mount operation. - a string containing the user name. + a string containing the user name. - a #GMountOperation. + a #GMountOperation. - Emits the #GMountOperation::reply signal. + Emits the #GMountOperation::reply signal. - a #GMountOperation + a #GMountOperation - a #GMountOperationResult + a #GMountOperationResult - Sets the mount operation to use an anonymous user if @anonymous is %TRUE. + Sets the mount operation to use an anonymous user if @anonymous is %TRUE. - - - a #GMountOperation. - - - - boolean value. - - - - - - Sets a default choice for the mount operation. - - - - - - - a #GMountOperation. - - - - an integer. - - - - - - Sets the mount operation's domain. - - - - - - - a #GMountOperation. - - - - the domain to set. - - - - - - Sets the mount operation to use a hidden volume if @hidden_volume is %TRUE. - - - - - - - a #GMountOperation. - - - - boolean value. - - - - - - Sets the mount operation to use a system volume if @system_volume is %TRUE. - - - - - - - a #GMountOperation. - - - - boolean value. - - - - - - Sets the mount operation's password to @password. - - - - - - - a #GMountOperation. - - - - password to set. - - - - - - Sets the state of saving passwords for the mount operation. - - - - - - - a #GMountOperation. - - - - a set of #GPasswordSave flags. - - - - - - Sets the mount operation's PIM to @pim. - - - - - - - a #GMountOperation. - - - - an unsigned integer. - - - - - - Sets the user name within @op to @username. - - - - a #GMountOperation. + + boolean value. + + + + + + Sets a default choice for the mount operation. + + + + + + + a #GMountOperation. + + + + an integer. + + + + + + Sets the mount operation's domain. + + + + + + + a #GMountOperation. + + + + the domain to set. + + + + + + Sets the mount operation to use a hidden volume if @hidden_volume is %TRUE. + + + + + + + a #GMountOperation. + + + + boolean value. + + + + + + Sets the mount operation to use a system volume if @system_volume is %TRUE. + + + + + + + a #GMountOperation. + + + + boolean value. + + + + + + Sets the mount operation's password to @password. + + + + + + + a #GMountOperation. + + + + password to set. + + + + + + Sets the state of saving passwords for the mount operation. + + + + + + + a #GMountOperation. + + + + a set of #GPasswordSave flags. + + + + + + Sets the mount operation's PIM to @pim. + + + + + + + a #GMountOperation. + + + + an unsigned integer. + + + + + + Sets the user name within @op to @username. + + + + + + + a #GMountOperation. + + - input username. + input username. - Whether to use an anonymous user when authenticating. + Whether to use an anonymous user when authenticating. - The index of the user's choice when a question is asked during the + The index of the user's choice when a question is asked during the mount operation. See the #GMountOperation::ask-question signal. - The domain to use for the mount operation. + The domain to use for the mount operation. - Whether the device to be unlocked is a TCRYPT hidden volume. + Whether the device to be unlocked is a TCRYPT hidden volume. See [the VeraCrypt documentation](https://www.veracrypt.fr/en/Hidden%20Volume.html). - Whether the device to be unlocked is a TCRYPT system volume. + Whether the device to be unlocked is a TCRYPT system volume. In this context, a system volume is a volume with a bootloader and operating system installed. This is only supported for Windows operating systems. For further documentation, see @@ -49963,21 +52961,21 @@ operating systems. For further documentation, see - The password that is used for authentication when carrying out + The password that is used for authentication when carrying out the mount operation. - Determines if and how the password information should be saved. + Determines if and how the password information should be saved. - The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See + The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See [the VeraCrypt documentation](https://www.veracrypt.fr/en/Personal%20Iterations%20Multiplier%20(PIM).html). - The user name that is used for authentication when carrying out + The user name that is used for authentication when carrying out the mount operation. @@ -49988,7 +52986,7 @@ the mount operation. - Emitted by the backend when e.g. a device becomes unavailable + Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress. Implementations of GMountOperation should handle this signal @@ -49998,7 +52996,7 @@ by dismissing open password dialogs. - Emitted when a mount operation asks the user for a password. + Emitted when a mount operation asks the user for a password. If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the @@ -50008,25 +53006,25 @@ primary text in a #GtkMessageDialog. - string containing a message to display to the user. + string containing a message to display to the user. - string containing the default user name. + string containing the default user name. - string containing the default domain. + string containing the default domain. - a set of #GAskPasswordFlags. + a set of #GAskPasswordFlags. - Emitted when asking the user a question and gives a list of + Emitted when asking the user a question and gives a list of choices for the user to choose from. If the message contains a line break, the first line should be @@ -50037,11 +53035,11 @@ primary text in a #GtkMessageDialog. - string containing a message to display to the user. + string containing a message to display to the user. - an array of strings for each possible choice. + an array of strings for each possible choice. @@ -50049,19 +53047,19 @@ primary text in a #GtkMessageDialog. - Emitted when the user has replied to the mount operation. + Emitted when the user has replied to the mount operation. - a #GMountOperationResult indicating how the request was handled + a #GMountOperationResult indicating how the request was handled - Emitted when one or more processes are blocking an operation + Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a #GMount or stopping a #GDrive. Note that this signal may be emitted several times to update the @@ -50078,18 +53076,18 @@ primary text in a #GtkMessageDialog. - string containing a message to display to the user. + string containing a message to display to the user. - an array of #GPid for processes + an array of #GPid for processes blocking the operation. - an array of strings for each possible choice. + an array of strings for each possible choice. @@ -50097,7 +53095,7 @@ primary text in a #GtkMessageDialog. - Emitted when an unmount operation has been busy for more than some time + Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds). When unmounting or ejecting a volume, the kernel might need to flush @@ -50118,16 +53116,16 @@ primary text in a #GtkMessageDialog. - string containing a mesage to display to the user + string containing a mesage to display to the user - the estimated time left before the operation completes, + the estimated time left before the operation completes, in microseconds, or -1 - the amount of bytes to be written before the operation + the amount of bytes to be written before the operation completes (or -1 if such amount is not known), or zero if the operation is completed @@ -50198,11 +53196,11 @@ primary text in a #GtkMessageDialog. - a #GMountOperation + a #GMountOperation - a #GMountOperationResult + a #GMountOperationResult @@ -50352,18 +53350,18 @@ primary text in a #GtkMessageDialog. - #GMountOperationResult is returned as a result when a request for + #GMountOperationResult is returned as a result when a request for information is send by the mounting operation. - The request was fulfilled and the + The request was fulfilled and the user specified data is now available - The user requested the mount operation + The user requested the mount operation to be aborted - The request was unhandled (i.e. not + The request was unhandled (i.e. not implemented) @@ -50377,19 +53375,151 @@ information is send by the mounting operation. file operations on the mount. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extension point for network status monitoring functionality. See [Extending GIO][extending-gio]. - - An socket address of some unknown native type. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An socket address of some unknown native type. + + + + Creates a new #GNativeSocketAddress for @native and @len. + + + a new #GNativeSocketAddress + + + + + a native address object + + + + the length of @native, in bytes + + + + + + + + + + + + + + + + + + + @@ -50420,16 +53550,20 @@ See [Extending GIO][extending-gio]. - #GNetworkAddress provides an easy way to resolve a hostname and + #GNetworkAddress provides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple IP addresses and multiple address families. +The enumeration results of resolved addresses *may* be cached as long +as this object is kept alive which may have unexpected results if +alive for too long. + See #GSocketConnectable for an example of using the connectable interface. - Creates a new #GSocketConnectable for connecting to the given + Creates a new #GSocketConnectable for connecting to the given @hostname and @port. Note that depending on the configuration of the machine, a @@ -50439,22 +53573,22 @@ g_network_address_new_loopback() to create a #GNetworkAddress that is guaranteed to resolve to both addresses. - the new #GNetworkAddress + the new #GNetworkAddress - the hostname + the hostname - the port + the port - Creates a new #GSocketConnectable for connecting to the local host + Creates a new #GSocketConnectable for connecting to the local host over a loopback connection to the given @port. This is intended for use in connecting to local services which may be running on IPv4 or IPv6. @@ -50465,21 +53599,21 @@ g_network_address_new() will often only return an IPv4 address when resolving `localhost`, and an IPv6 address for `localhost6`. g_network_address_get_hostname() will always return `localhost` for -#GNetworkAddresses created with this constructor. +a #GNetworkAddress created with this constructor. - the new #GNetworkAddress + the new #GNetworkAddress - the port + the port - Creates a new #GSocketConnectable for connecting to the given + Creates a new #GSocketConnectable for connecting to the given @hostname and @port. May fail and return %NULL in case parsing @host_and_port fails. @@ -50502,23 +53636,23 @@ is deprecated, because it depends on the contents of /etc/services, which is generally quite sparse on platforms other than Linux.) - the new + the new #GNetworkAddress, or %NULL on error - the hostname and optionally a port + the hostname and optionally a port - the default port if not in @host_and_port + the default port if not in @host_and_port - Creates a new #GSocketConnectable for connecting to the given + Creates a new #GSocketConnectable for connecting to the given @uri. May fail and return %NULL in case parsing @uri fails. Using this rather than g_network_address_new() or @@ -50526,60 +53660,60 @@ g_network_address_parse() allows #GSocketClient to determine when to use application-specific proxy protocols. - the new + the new #GNetworkAddress, or %NULL on error - the hostname and optionally a port + the hostname and optionally a port - The default port if none is found in the URI + The default port if none is found in the URI - Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, + Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, depending on what @addr was created with. - @addr's hostname + @addr's hostname - a #GNetworkAddress + a #GNetworkAddress - Gets @addr's port number + Gets @addr's port number - @addr's port (which may be 0) + @addr's port (which may be 0) - a #GNetworkAddress + a #GNetworkAddress - Gets @addr's scheme + Gets @addr's scheme - @addr's scheme (%NULL if not built from URI) + @addr's scheme (%NULL if not built from URI) - a #GNetworkAddress + a #GNetworkAddress @@ -50610,28 +53744,28 @@ depending on what @addr was created with. - The host's network connectivity state, as reported by #GNetworkMonitor. + The host's network connectivity state, as reported by #GNetworkMonitor. - The host is not configured with a + The host is not configured with a route to the Internet; it may or may not be connected to a local network. - The host is connected to a network, but + The host is connected to a network, but does not appear to be able to reach the full Internet, perhaps due to upstream network problems. - The host is behind a captive portal and + The host is behind a captive portal and cannot reach the full Internet. - The host is connected to a network, and + The host is connected to a network, and appears to be able to reach the full Internet. - #GNetworkMonitor provides an easy-to-use cross-platform API + #GNetworkMonitor provides an easy-to-use cross-platform API for monitoring network connectivity. On Linux, the available implementations are based on the kernel's netlink interface and on NetworkManager. @@ -50640,15 +53774,15 @@ There is also an implementation for use inside Flatpak sandboxes. - Gets the default #GNetworkMonitor for the system. + Gets the default #GNetworkMonitor for the system. - a #GNetworkMonitor + a #GNetworkMonitor - Attempts to determine whether or not the host pointed to by + Attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -50667,26 +53801,26 @@ trying to do multicast DNS on the local network), so if you do not want to block, you should use g_network_monitor_can_reach_async(). - %TRUE if @connectable is reachable, %FALSE if not. + %TRUE if @connectable is reachable, %FALSE if not. - a #GNetworkMonitor + a #GNetworkMonitor - a #GSocketConnectable + a #GSocketConnectable - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously attempts to determine whether or not the host + Asynchronously attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -50701,43 +53835,43 @@ to get the result of the operation. - a #GNetworkMonitor + a #GNetworkMonitor - a #GSocketConnectable + a #GSocketConnectable - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an async network connectivity test. + Finishes an async network connectivity test. See g_network_monitor_can_reach_async(). - %TRUE if network is reachable, %FALSE if not. + %TRUE if network is reachable, %FALSE if not. - a #GNetworkMonitor + a #GNetworkMonitor - a #GAsyncResult + a #GAsyncResult @@ -50757,7 +53891,7 @@ See g_network_monitor_can_reach_async(). - Attempts to determine whether or not the host pointed to by + Attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -50776,26 +53910,26 @@ trying to do multicast DNS on the local network), so if you do not want to block, you should use g_network_monitor_can_reach_async(). - %TRUE if @connectable is reachable, %FALSE if not. + %TRUE if @connectable is reachable, %FALSE if not. - a #GNetworkMonitor + a #GNetworkMonitor - a #GSocketConnectable + a #GSocketConnectable - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously attempts to determine whether or not the host + Asynchronously attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -50810,49 +53944,49 @@ to get the result of the operation. - a #GNetworkMonitor + a #GNetworkMonitor - a #GSocketConnectable + a #GSocketConnectable - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an async network connectivity test. + Finishes an async network connectivity test. See g_network_monitor_can_reach_async(). - %TRUE if network is reachable, %FALSE if not. + %TRUE if network is reachable, %FALSE if not. - a #GNetworkMonitor + a #GNetworkMonitor - a #GAsyncResult + a #GAsyncResult - Gets a more detailed networking state than + Gets a more detailed networking state than g_network_monitor_get_network_available(). If #GNetworkMonitor:network-available is %FALSE, then the @@ -50873,56 +54007,56 @@ attempt to connect to remote servers, but should gracefully fall back to their "offline" behavior if the connection attempt fails. - the network connectivity state + the network connectivity state - the #GNetworkMonitor + the #GNetworkMonitor - Checks if the network is available. "Available" here means that the + Checks if the network is available. "Available" here means that the system has a default route available for at least one of IPv4 or IPv6. It does not necessarily imply that the public Internet is reachable. See #GNetworkMonitor:network-available for more details. - whether the network is available + whether the network is available - the #GNetworkMonitor + the #GNetworkMonitor - Checks if the network is metered. + Checks if the network is metered. See #GNetworkMonitor:network-metered for more details. - whether the connection is metered + whether the connection is metered - the #GNetworkMonitor + the #GNetworkMonitor - More detailed information about the host's network connectivity. + More detailed information about the host's network connectivity. See g_network_monitor_get_connectivity() and #GNetworkConnectivity for more details. - Whether the network is considered available. That is, whether the + Whether the network is considered available. That is, whether the system has a default route for at least one of IPv4 or IPv6. Real-world networks are of course much more complicated than @@ -50942,7 +54076,7 @@ See also #GNetworkMonitor::network-changed. - Whether the network is considered metered. That is, whether the + Whether the network is considered metered. That is, whether the system has traffic flowing through the default connection that is subject to limitations set by service providers. For example, traffic might be billed by the amount of data transmitted, or there might be a @@ -50962,23 +54096,23 @@ See also #GNetworkMonitor:network-available. - Emitted when the network configuration changes. + Emitted when the network configuration changes. - the current value of #GNetworkMonitor:network-available + the current value of #GNetworkMonitor:network-available - The virtual function table for #GNetworkMonitor. + The virtual function table for #GNetworkMonitor. - The parent interface. + The parent interface. @@ -51001,20 +54135,20 @@ See also #GNetworkMonitor:network-available. - %TRUE if @connectable is reachable, %FALSE if not. + %TRUE if @connectable is reachable, %FALSE if not. - a #GNetworkMonitor + a #GNetworkMonitor - a #GSocketConnectable + a #GSocketConnectable - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -51028,24 +54162,24 @@ See also #GNetworkMonitor:network-available. - a #GNetworkMonitor + a #GNetworkMonitor - a #GSocketConnectable + a #GSocketConnectable - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback to call when the + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -51055,16 +54189,16 @@ See also #GNetworkMonitor:network-available. - %TRUE if network is reachable, %FALSE if not. + %TRUE if network is reachable, %FALSE if not. - a #GNetworkMonitor + a #GNetworkMonitor - a #GAsyncResult + a #GAsyncResult @@ -51072,7 +54206,7 @@ See also #GNetworkMonitor:network-available. - Like #GNetworkAddress does with hostnames, #GNetworkService + Like #GNetworkAddress does with hostnames, #GNetworkService provides an easy way to resolve a SRV record, and then attempt to connect to one of the hosts that implements that service, handling service priority/weighting, multiple IP addresses, and multiple @@ -51084,89 +54218,89 @@ interface. - Creates a new #GNetworkService representing the given @service, + Creates a new #GNetworkService representing the given @service, @protocol, and @domain. This will initially be unresolved; use the #GSocketConnectable interface to resolve it. - a new #GNetworkService + a new #GNetworkService - the service type to look up (eg, "ldap") + the service type to look up (eg, "ldap") - the networking protocol to use for @service (eg, "tcp") + the networking protocol to use for @service (eg, "tcp") - the DNS domain to look up the service in + the DNS domain to look up the service in - Gets the domain that @srv serves. This might be either UTF-8 or + Gets the domain that @srv serves. This might be either UTF-8 or ASCII-encoded, depending on what @srv was created with. - @srv's domain name + @srv's domain name - a #GNetworkService + a #GNetworkService - Gets @srv's protocol name (eg, "tcp"). + Gets @srv's protocol name (eg, "tcp"). - @srv's protocol name + @srv's protocol name - a #GNetworkService + a #GNetworkService - Get's the URI scheme used to resolve proxies. By default, the service name + Get's the URI scheme used to resolve proxies. By default, the service name is used as scheme. - @srv's scheme name + @srv's scheme name - a #GNetworkService + a #GNetworkService - Gets @srv's service name (eg, "ldap"). + Gets @srv's service name (eg, "ldap"). - @srv's service name + @srv's service name - a #GNetworkService + a #GNetworkService - Set's the URI scheme used to resolve proxies. By default, the service name + Set's the URI scheme used to resolve proxies. By default, the service name is used as scheme. @@ -51174,11 +54308,11 @@ is used as scheme. - a #GNetworkService + a #GNetworkService - a URI scheme + a URI scheme @@ -51212,7 +54346,7 @@ is used as scheme. - #GNotification is a mechanism for creating a notification to be shown + #GNotification is a mechanism for creating a notification to be shown to the user -- typically as a pop-up notification presented by the desktop environment shell. @@ -51234,7 +54368,7 @@ clicked. A notification can be sent with g_application_send_notification(). - Creates a new #GNotification with @title as its title. + Creates a new #GNotification with @title as its title. After populating @notification with more details, it can be sent to the desktop shell with g_application_send_notification(). Changing @@ -51242,18 +54376,18 @@ any properties after this call will not have any effect until resending @notification. - a new #GNotification instance + a new #GNotification instance - the title of the notification + the title of the notification - Adds a button to @notification that activates the action in + Adds a button to @notification that activates the action in @detailed_action when clicked. That action must be an application-wide action (starting with "app."). If @detailed_action contains a target, the action will be activated with that target as @@ -51267,21 +54401,21 @@ for @detailed_action. - a #GNotification + a #GNotification - label of the button + label of the button - a detailed action name + a detailed action name - Adds a button to @notification that activates @action when clicked. + Adds a button to @notification that activates @action when clicked. @action must be an application-wide action (it must start with "app."). If @target_format is given, it is used to collect remaining @@ -51294,29 +54428,29 @@ parameter. - a #GNotification + a #GNotification - label of the button + label of the button - an action name + an action name - a #GVariant format string, or %NULL + a #GVariant format string, or %NULL - positional parameters, as determined by @target_format + positional parameters, as determined by @target_format - Adds a button to @notification that activates @action when clicked. + Adds a button to @notification that activates @action when clicked. @action must be an application-wide action (it must start with "app."). If @target is non-%NULL, @action will be activated with @target as @@ -51327,42 +54461,42 @@ its parameter. - a #GNotification + a #GNotification - label of the button + label of the button - an action name + an action name - a #GVariant to use as @action's parameter, or %NULL + a #GVariant to use as @action's parameter, or %NULL - Sets the body of @notification to @body. + Sets the body of @notification to @body. - a #GNotification + a #GNotification - the new body for @notification, or %NULL + the new body for @notification, or %NULL - Sets the default action of @notification to @detailed_action. This + Sets the default action of @notification to @detailed_action. This action is activated when the notification is clicked on. The action in @detailed_action must be an application-wide action (it @@ -51379,17 +54513,17 @@ was sent on is activated. - a #GNotification + a #GNotification - a detailed action name + a detailed action name - Sets the default action of @notification to @action. This action is + Sets the default action of @notification to @action. This action is activated when the notification is clicked on. It must be an application-wide action (it must start with "app."). @@ -51406,25 +54540,25 @@ was sent on is activated. - a #GNotification + a #GNotification - an action name + an action name - a #GVariant format string, or %NULL + a #GVariant format string, or %NULL - positional parameters, as determined by @target_format + positional parameters, as determined by @target_format - Sets the default action of @notification to @action. This action is + Sets the default action of @notification to @action. This action is activated when the notification is clicked on. It must be an application-wide action (start with "app."). @@ -51439,38 +54573,38 @@ was sent on is activated. - a #GNotification + a #GNotification - an action name + an action name - a #GVariant to use as @action's parameter, or %NULL + a #GVariant to use as @action's parameter, or %NULL - Sets the icon of @notification to @icon. + Sets the icon of @notification to @icon. - a #GNotification + a #GNotification - the icon to be shown in @notification, as a #GIcon + the icon to be shown in @notification, as a #GIcon - Sets the priority of @notification to @priority. See + Sets the priority of @notification to @priority. See #GNotificationPriority for possible values. @@ -51478,34 +54612,34 @@ was sent on is activated. - a #GNotification + a #GNotification - a #GNotificationPriority + a #GNotificationPriority - Sets the title of @notification to @title. + Sets the title of @notification to @title. - a #GNotification + a #GNotification - the new title for @notification + the new title for @notification - Deprecated in favor of g_notification_set_priority(). + Deprecated in favor of g_notification_set_priority(). Since 2.42, this has been deprecated in favour of g_notification_set_priority(). @@ -51514,39 +54648,60 @@ was sent on is activated. - a #GNotification + a #GNotification - %TRUE if @notification is urgent + %TRUE if @notification is urgent - Priority levels for #GNotifications. + Priority levels for #GNotifications. - the default priority, to be used for the + the default priority, to be used for the majority of notifications (for example email messages, software updates, completed download/sync operations) - for notifications that do not require + for notifications that do not require immediate attention - typically used for contextual background information, such as contact birthdays or local weather - for events that require more attention, + 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 + for urgent notifications, or notifications that require a response in a short space of time (for example phone calls or emergency warnings) + + + + + + + + + + + + + + + + + + + + + Structure used for scatter/gather data output when sending multiple messages or packets in one go. You generally pass in an array of @@ -51586,7 +54741,7 @@ If @address is %NULL then the message is sent to the default receiver - #GOutputStream has functions to write to a stream (g_output_stream_write()), + #GOutputStream has functions to write to a stream (g_output_stream_write()), to close a stream (g_output_stream_close()) and to flush pending writes (g_output_stream_flush()). @@ -51599,7 +54754,7 @@ streaming APIs. All of these functions have async variants too. - Requests an asynchronous close of the stream, releasing resources + Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation. @@ -51615,41 +54770,41 @@ classes. However, if you override one you must override all. - A #GOutputStream. + A #GOutputStream. - the io priority of the request. + the io priority of the request. - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Closes an output stream. + Closes an output stream. - %TRUE if stream was successfully closed, %FALSE otherwise. + %TRUE if stream was successfully closed, %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -51669,7 +54824,7 @@ classes. However, if you override one you must override all. - Forces a write of all user-space buffered data for the given + Forces a write of all user-space buffered data for the given @stream. Will block during the operation. Closing the stream will implicitly cause a flush. @@ -51680,22 +54835,22 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - a #GOutputStream. + a #GOutputStream. - optional cancellable object + optional cancellable object - Forces an asynchronous write of all user-space buffered data for + Forces an asynchronous write of all user-space buffered data for the given @stream. For behaviour details see g_output_stream_flush(). @@ -51708,50 +54863,50 @@ result of the operation. - a #GOutputStream. + a #GOutputStream. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes flushing an output stream. + Finishes flushing an output stream. - %TRUE if flush operation succeeded, %FALSE otherwise. + %TRUE if flush operation succeeded, %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - a GAsyncResult. + a GAsyncResult. - Splices an input stream into an output stream. + Splices an input stream into an output stream. - a #gssize containing the size of the data spliced, or + a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -51760,25 +54915,25 @@ result of the operation. - a #GOutputStream. + a #GOutputStream. - a #GInputStream. + a #GInputStream. - a set of #GOutputStreamSpliceFlags. + a set of #GOutputStreamSpliceFlags. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Splices a stream asynchronously. + Splices a stream asynchronously. When the operation is finished @callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation. @@ -51791,40 +54946,40 @@ g_output_stream_splice(). - a #GOutputStream. + a #GOutputStream. - a #GInputStream. + a #GInputStream. - a set of #GOutputStreamSpliceFlags. + a set of #GOutputStreamSpliceFlags. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - Finishes an asynchronous stream splice operation. + Finishes an asynchronous stream splice operation. - a #gssize of the number of bytes spliced. Note that if the + a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -51832,17 +54987,17 @@ g_output_stream_splice(). - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - Request an asynchronous write of @count bytes from @buffer into + Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_finish() to get the result of the operation. @@ -51883,57 +55038,57 @@ the contents (without copying) for the duration of the call. - A #GOutputStream. + A #GOutputStream. - the buffer containing the data to write. + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes a stream write operation. + Finishes a stream write operation. - a #gssize containing the number of bytes written to the stream. + a #gssize containing the number of bytes written to the stream. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - Tries to write @count bytes from @buffer into the stream. Will block + Tries to write @count bytes from @buffer into the stream. Will block during the operation. If count is 0, returns 0 and does nothing. A value of @count @@ -51955,32 +55110,32 @@ partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - Number of bytes written, or -1 on error + Number of bytes written, or -1 on error - a #GOutputStream. + a #GOutputStream. - the buffer containing the data to write. + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - optional cancellable object + optional cancellable object - Request an asynchronous write of the bytes contained in @n_vectors @vectors into + Request an asynchronous write of the bytes contained in @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_finish() to get the result of the operation. @@ -52016,61 +55171,61 @@ until @callback is called. - A #GOutputStream. + A #GOutputStream. - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - the I/O priority of the request. + the I/O priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes a stream writev operation. + Finishes a stream writev operation. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - location to store the number of bytes that were written to the stream + location to store the number of bytes that were written to the stream - Tries to write the bytes contained in the @n_vectors @vectors into the + Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. If @n_vectors is 0 or the sum of all bytes in @vectors is 0, returns 0 and @@ -52095,50 +55250,50 @@ are exceeded. For example, when writing to a local file on UNIX platforms, the aggregate buffer size must not exceed %G_MAXSSIZE bytes. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - location to store the number of bytes that were + location to store the number of bytes that were written to the stream - optional cancellable object + optional cancellable object - Clears the pending flag on @stream. + Clears the pending flag on @stream. - output stream + output stream - Closes the stream, releasing resources related to it. + Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. @@ -52169,22 +55324,22 @@ cancellation (as with any error) there is no guarantee that all written data will reach the target. - %TRUE on success, %FALSE on failure + %TRUE on success, %FALSE on failure - A #GOutputStream. + A #GOutputStream. - optional cancellable object + optional cancellable object - Requests an asynchronous close of the stream, releasing resources + Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation. @@ -52200,47 +55355,47 @@ classes. However, if you override one you must override all. - A #GOutputStream. + A #GOutputStream. - the io priority of the request. + the io priority of the request. - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Closes an output stream. + Closes an output stream. - %TRUE if stream was successfully closed, %FALSE otherwise. + %TRUE if stream was successfully closed, %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - Forces a write of all user-space buffered data for the given + Forces a write of all user-space buffered data for the given @stream. Will block during the operation. Closing the stream will implicitly cause a flush. @@ -52251,22 +55406,22 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - a #GOutputStream. + a #GOutputStream. - optional cancellable object + optional cancellable object - Forces an asynchronous write of all user-space buffered data for + Forces an asynchronous write of all user-space buffered data for the given @stream. For behaviour details see g_output_stream_flush(). @@ -52279,92 +55434,92 @@ result of the operation. - a #GOutputStream. + a #GOutputStream. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes flushing an output stream. + Finishes flushing an output stream. - %TRUE if flush operation succeeded, %FALSE otherwise. + %TRUE if flush operation succeeded, %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - a GAsyncResult. + a GAsyncResult. - Checks if an output stream has pending actions. + Checks if an output stream has pending actions. - %TRUE if @stream has pending actions. + %TRUE if @stream has pending actions. - a #GOutputStream. + a #GOutputStream. - Checks if an output stream has already been closed. + Checks if an output stream has already been closed. - %TRUE if @stream is closed. %FALSE otherwise. + %TRUE if @stream is closed. %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - Checks if an output stream is being closed. This can be + Checks if an output stream is being closed. This can be used inside e.g. a flush implementation to see if the flush (or other i/o operation) is called from within the closing operation. - %TRUE if @stream is being closed. %FALSE otherwise. + %TRUE if @stream is being closed. %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - This is a utility function around g_output_stream_write_all(). It + This is a utility function around g_output_stream_write_all(). It uses g_strdup_vprintf() to turn @format and @... into a string that is then written to @stream. @@ -52378,58 +55533,58 @@ create you own printf()-like wrapper around g_output_stream_write() or g_output_stream_write_all(). - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - location to store the number of bytes that was + location to store the number of bytes that was written to the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - location to store the error occurring, or %NULL to ignore + location to store the error occurring, or %NULL to ignore - the format string. See the printf() documentation + the format string. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Sets @stream to have actions pending. If the pending flag is + Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. - %TRUE if pending was previously unset and is now set. + %TRUE if pending was previously unset and is now set. - a #GOutputStream. + a #GOutputStream. - Splices an input stream into an output stream. + Splices an input stream into an output stream. - a #gssize containing the size of the data spliced, or + a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -52438,25 +55593,25 @@ already set or @stream is closed, it will return %FALSE and set - a #GOutputStream. + a #GOutputStream. - a #GInputStream. + a #GInputStream. - a set of #GOutputStreamSpliceFlags. + a set of #GOutputStreamSpliceFlags. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Splices a stream asynchronously. + Splices a stream asynchronously. When the operation is finished @callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation. @@ -52469,40 +55624,40 @@ g_output_stream_splice(). - a #GOutputStream. + a #GOutputStream. - a #GInputStream. + a #GInputStream. - a set of #GOutputStreamSpliceFlags. + a set of #GOutputStreamSpliceFlags. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - Finishes an asynchronous stream splice operation. + Finishes an asynchronous stream splice operation. - a #gssize of the number of bytes spliced. Note that if the + a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -52510,17 +55665,17 @@ g_output_stream_splice(). - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - This is a utility function around g_output_stream_write_all(). It + This is a utility function around g_output_stream_write_all(). It uses g_strdup_vprintf() to turn @format and @args into a string that is then written to @stream. @@ -52534,39 +55689,39 @@ create you own printf()-like wrapper around g_output_stream_write() or g_output_stream_write_all(). - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - location to store the number of bytes that was + location to store the number of bytes that was written to the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - location to store the error occurring, or %NULL to ignore + location to store the error occurring, or %NULL to ignore - the format string. See the printf() documentation + the format string. See the printf() documentation - the parameters to insert into the format string + the parameters to insert into the format string - Tries to write @count bytes from @buffer into the stream. Will block + Tries to write @count bytes from @buffer into the stream. Will block during the operation. If count is 0, returns 0 and does nothing. A value of @count @@ -52588,32 +55743,32 @@ partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - Number of bytes written, or -1 on error + Number of bytes written, or -1 on error - a #GOutputStream. + a #GOutputStream. - the buffer containing the data to write. + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - optional cancellable object + optional cancellable object - Tries to write @count bytes from @buffer into the stream. Will block + Tries to write @count bytes from @buffer into the stream. Will block during the operation. This function is similar to g_output_stream_write(), except it tries to @@ -52634,37 +55789,37 @@ language then you must write your own loop around g_output_stream_write(). - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - the buffer containing the data to write. + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - location to store the number of bytes that was + location to store the number of bytes that was written to the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request an asynchronous write of @count bytes from @buffer into + Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_all_finish() to get the result of the operation. @@ -52685,39 +55840,39 @@ until @callback is called. - A #GOutputStream + A #GOutputStream - the buffer containing the data to write + the buffer containing the data to write - the number of bytes to write + the number of bytes to write - the io priority of the request + the io priority of the request - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous stream write operation started with + Finishes an asynchronous stream write operation started with g_output_stream_write_all_async(). As a special exception to the normal conventions for functions that @@ -52729,26 +55884,26 @@ language then you must write your own loop around g_output_stream_write_async(). - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream + a #GOutputStream - a #GAsyncResult + a #GAsyncResult - location to store the number of bytes that was written to the stream + location to store the number of bytes that was written to the stream - Request an asynchronous write of @count bytes from @buffer into + Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_finish() to get the result of the operation. @@ -52789,39 +55944,39 @@ the contents (without copying) for the duration of the call. - A #GOutputStream. + A #GOutputStream. - the buffer containing the data to write. + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - A wrapper function for g_output_stream_write() which takes a + A wrapper function for g_output_stream_write() which takes a #GBytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of #GBytes is helpful over a bare pointer interface. @@ -52834,26 +55989,26 @@ remaining bytes, using g_bytes_new_from_bytes(). Passing the same data in the output stream. - Number of bytes written, or -1 on error + Number of bytes written, or -1 on error - a #GOutputStream. + a #GOutputStream. - the #GBytes to write + the #GBytes to write - optional cancellable object + optional cancellable object - This function is similar to g_output_stream_write_async(), but + This function is similar to g_output_stream_write_async(), but takes a #GBytes as input. Due to the refcounted nature of #GBytes, this allows the stream to avoid taking a copy of the data. @@ -52872,69 +56027,69 @@ g_output_stream_write_bytes(). - A #GOutputStream. + A #GOutputStream. - The bytes to write + The bytes to write - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes a stream write-from-#GBytes operation. + Finishes a stream write-from-#GBytes operation. - a #gssize containing the number of bytes written to the stream. + a #gssize containing the number of bytes written to the stream. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - Finishes a stream write operation. + Finishes a stream write operation. - a #gssize containing the number of bytes written to the stream. + a #gssize containing the number of bytes written to the stream. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - Tries to write the bytes contained in the @n_vectors @vectors into the + Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. If @n_vectors is 0 or the sum of all bytes in @vectors is 0, returns 0 and @@ -52959,37 +56114,37 @@ are exceeded. For example, when writing to a local file on UNIX platforms, the aggregate buffer size must not exceed %G_MAXSSIZE bytes. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - location to store the number of bytes that were + location to store the number of bytes that were written to the stream - optional cancellable object + optional cancellable object - Tries to write the bytes contained in the @n_vectors @vectors into the + Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. This function is similar to g_output_stream_writev(), except it tries to @@ -53013,37 +56168,37 @@ The content of the individual elements of @vectors might be changed by this function. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - location to store the number of bytes that were + location to store the number of bytes that were written to the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Request an asynchronous write of the bytes contained in the @n_vectors @vectors into + Request an asynchronous write of the bytes contained in the @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_all_finish() to get the result of the operation. @@ -53065,39 +56220,39 @@ of @vectors might be changed by this function. - A #GOutputStream + A #GOutputStream - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - the I/O priority of the request + the I/O priority of the request - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous stream write operation started with + Finishes an asynchronous stream write operation started with g_output_stream_writev_all_async(). As a special exception to the normal conventions for functions that @@ -53109,26 +56264,26 @@ language then you must write your own loop around g_output_stream_writev_async(). - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream + a #GOutputStream - a #GAsyncResult + a #GAsyncResult - location to store the number of bytes that were written to the stream + location to store the number of bytes that were written to the stream - Request an asynchronous write of the bytes contained in @n_vectors @vectors into + Request an asynchronous write of the bytes contained in @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_finish() to get the result of the operation. @@ -53164,55 +56319,55 @@ until @callback is called. - A #GOutputStream. + A #GOutputStream. - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - the I/O priority of the request. + the I/O priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes a stream writev operation. + Finishes a stream writev operation. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - location to store the number of bytes that were written to the stream + location to store the number of bytes that were written to the stream @@ -53233,26 +56388,26 @@ until @callback is called. - Number of bytes written, or -1 on error + Number of bytes written, or -1 on error - a #GOutputStream. + a #GOutputStream. - the buffer containing the data to write. + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - optional cancellable object + optional cancellable object @@ -53262,7 +56417,7 @@ until @callback is called. - a #gssize containing the size of the data spliced, or + a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -53271,19 +56426,19 @@ until @callback is called. - a #GOutputStream. + a #GOutputStream. - a #GInputStream. + a #GInputStream. - a set of #GOutputStreamSpliceFlags. + a set of #GOutputStreamSpliceFlags. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -53293,16 +56448,16 @@ until @callback is called. - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - a #GOutputStream. + a #GOutputStream. - optional cancellable object + optional cancellable object @@ -53332,33 +56487,33 @@ until @callback is called. - A #GOutputStream. + A #GOutputStream. - the buffer containing the data to write. + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -53368,16 +56523,16 @@ until @callback is called. - a #gssize containing the number of bytes written to the stream. + a #gssize containing the number of bytes written to the stream. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -53391,31 +56546,31 @@ until @callback is called. - a #GOutputStream. + a #GOutputStream. - a #GInputStream. + a #GInputStream. - a set of #GOutputStreamSpliceFlags. + a set of #GOutputStreamSpliceFlags. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. @@ -53425,7 +56580,7 @@ until @callback is called. - a #gssize of the number of bytes spliced. Note that if the + a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -53433,11 +56588,11 @@ until @callback is called. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -53451,23 +56606,23 @@ until @callback is called. - a #GOutputStream. + a #GOutputStream. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -53477,16 +56632,16 @@ until @callback is called. - %TRUE if flush operation succeeded, %FALSE otherwise. + %TRUE if flush operation succeeded, %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - a GAsyncResult. + a GAsyncResult. @@ -53500,23 +56655,23 @@ until @callback is called. - A #GOutputStream. + A #GOutputStream. - the io priority of the request. + the io priority of the request. - optional cancellable object + optional cancellable object - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -53526,16 +56681,16 @@ until @callback is called. - %TRUE if stream was successfully closed, %FALSE otherwise. + %TRUE if stream was successfully closed, %FALSE otherwise. - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. @@ -53545,31 +56700,31 @@ until @callback is called. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - location to store the number of bytes that were + location to store the number of bytes that were written to the stream - optional cancellable object + optional cancellable object @@ -53583,33 +56738,33 @@ until @callback is called. - A #GOutputStream. + A #GOutputStream. - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - the I/O priority of the request. + the I/O priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - callback to call when the request is satisfied + callback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -53619,20 +56774,20 @@ until @callback is called. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - a #GAsyncResult. + a #GAsyncResult. - location to store the number of bytes that were written to the stream + location to store the number of bytes that were written to the stream @@ -53683,16 +56838,16 @@ until @callback is called. - GOutputStreamSpliceFlags determine how streams should be spliced. + GOutputStreamSpliceFlags determine how streams should be spliced. - Do not close either stream. + Do not close either stream. - Close the source stream after + Close the source stream after the splice. - Close the target stream after + Close the target stream after the splice. @@ -53711,35 +56866,161 @@ one buffer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extension point for proxy functionality. See [Extending GIO][extending-gio]. + + + + + + + + + + + + + + Extension point for proxy resolving functionality. See [Extending GIO][extending-gio]. + + + + + + + - #GPasswordSave is used to indicate the lifespan of a saved password. + #GPasswordSave is used to indicate the lifespan of a saved password. #Gvfs stores passwords in the Gnome keyring when this flag allows it to, and later retrieves it again from there. - never save a password. + never save a password. - save a password for the session. + save a password for the session. - save a password permanently. + save a password permanently. - A #GPermission represents the status of the caller's permission to + A #GPermission represents the status of the caller's permission to perform a certain action. You can query if the action is currently allowed and if it is @@ -53756,7 +57037,7 @@ unlock" button in a dialog and to provide the mechanism to invoke when that button is clicked. - Attempts to acquire the permission represented by @permission. + Attempts to acquire the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is @@ -53773,22 +57054,22 @@ user interaction is required). See g_permission_acquire_async() for the non-blocking version. - %TRUE if the permission was successfully acquired + %TRUE if the permission was successfully acquired - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Attempts to acquire the permission represented by @permission. + Attempts to acquire the permission represented by @permission. This is the first half of the asynchronous version of g_permission_acquire(). @@ -53798,47 +57079,47 @@ g_permission_acquire(). - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - the #GAsyncReadyCallback to call when done + the #GAsyncReadyCallback to call when done - the user data to pass to @callback + the user data to pass to @callback - Collects the result of attempting to acquire the permission + Collects the result of attempting to acquire the permission represented by @permission. This is the second half of the asynchronous version of g_permission_acquire(). - %TRUE if the permission was successfully acquired + %TRUE if the permission was successfully acquired - a #GPermission instance + a #GPermission instance - the #GAsyncResult given to the #GAsyncReadyCallback + the #GAsyncResult given to the #GAsyncReadyCallback - Attempts to release the permission represented by @permission. + Attempts to release the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the @@ -53855,22 +57136,22 @@ user interaction is required). See g_permission_release_async() for the non-blocking version. - %TRUE if the permission was successfully released + %TRUE if the permission was successfully released - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Attempts to release the permission represented by @permission. + Attempts to release the permission represented by @permission. This is the first half of the asynchronous version of g_permission_release(). @@ -53880,47 +57161,47 @@ g_permission_release(). - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - the #GAsyncReadyCallback to call when done + the #GAsyncReadyCallback to call when done - the user data to pass to @callback + the user data to pass to @callback - Collects the result of attempting to release the permission + Collects the result of attempting to release the permission represented by @permission. This is the second half of the asynchronous version of g_permission_release(). - %TRUE if the permission was successfully released + %TRUE if the permission was successfully released - a #GPermission instance + a #GPermission instance - the #GAsyncResult given to the #GAsyncReadyCallback + the #GAsyncResult given to the #GAsyncReadyCallback - Attempts to acquire the permission represented by @permission. + Attempts to acquire the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is @@ -53937,22 +57218,22 @@ user interaction is required). See g_permission_acquire_async() for the non-blocking version. - %TRUE if the permission was successfully acquired + %TRUE if the permission was successfully acquired - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Attempts to acquire the permission represented by @permission. + Attempts to acquire the permission represented by @permission. This is the first half of the asynchronous version of g_permission_acquire(). @@ -53962,95 +57243,95 @@ g_permission_acquire(). - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - the #GAsyncReadyCallback to call when done + the #GAsyncReadyCallback to call when done - the user data to pass to @callback + the user data to pass to @callback - Collects the result of attempting to acquire the permission + Collects the result of attempting to acquire the permission represented by @permission. This is the second half of the asynchronous version of g_permission_acquire(). - %TRUE if the permission was successfully acquired + %TRUE if the permission was successfully acquired - a #GPermission instance + a #GPermission instance - the #GAsyncResult given to the #GAsyncReadyCallback + the #GAsyncResult given to the #GAsyncReadyCallback - Gets the value of the 'allowed' property. This property is %TRUE if + Gets the value of the 'allowed' property. This property is %TRUE if the caller currently has permission to perform the action that @permission represents the permission to perform. - the value of the 'allowed' property + the value of the 'allowed' property - a #GPermission instance + a #GPermission instance - Gets the value of the 'can-acquire' property. This property is %TRUE + Gets the value of the 'can-acquire' property. This property is %TRUE if it is generally possible to acquire the permission by calling g_permission_acquire(). - the value of the 'can-acquire' property + the value of the 'can-acquire' property - a #GPermission instance + a #GPermission instance - Gets the value of the 'can-release' property. This property is %TRUE + Gets the value of the 'can-release' property. This property is %TRUE if it is generally possible to release the permission by calling g_permission_release(). - the value of the 'can-release' property + the value of the 'can-release' property - a #GPermission instance + a #GPermission instance - This function is called by the #GPermission implementation to update + This function is called by the #GPermission implementation to update the properties of the permission. You should never call this function except from a #GPermission implementation. @@ -54061,25 +57342,25 @@ GObject notify signals are generated, as appropriate. - a #GPermission instance + a #GPermission instance - the new value for the 'allowed' property + the new value for the 'allowed' property - the new value for the 'can-acquire' property + the new value for the 'can-acquire' property - the new value for the 'can-release' property + the new value for the 'can-release' property - Attempts to release the permission represented by @permission. + Attempts to release the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the @@ -54096,22 +57377,22 @@ user interaction is required). See g_permission_release_async() for the non-blocking version. - %TRUE if the permission was successfully released + %TRUE if the permission was successfully released - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Attempts to release the permission represented by @permission. + Attempts to release the permission represented by @permission. This is the first half of the asynchronous version of g_permission_release(). @@ -54121,57 +57402,57 @@ g_permission_release(). - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - the #GAsyncReadyCallback to call when done + the #GAsyncReadyCallback to call when done - the user data to pass to @callback + the user data to pass to @callback - Collects the result of attempting to release the permission + Collects the result of attempting to release the permission represented by @permission. This is the second half of the asynchronous version of g_permission_release(). - %TRUE if the permission was successfully released + %TRUE if the permission was successfully released - a #GPermission instance + a #GPermission instance - the #GAsyncResult given to the #GAsyncReadyCallback + the #GAsyncResult given to the #GAsyncReadyCallback - %TRUE if the caller currently has permission to perform the action that + %TRUE if the caller currently has permission to perform the action that @permission represents the permission to perform. - %TRUE if it is generally possible to acquire the permission by calling + %TRUE if it is generally possible to acquire the permission by calling g_permission_acquire(). - %TRUE if it is generally possible to release the permission by calling + %TRUE if it is generally possible to release the permission by calling g_permission_release(). @@ -54191,16 +57472,16 @@ g_permission_release(). - %TRUE if the permission was successfully acquired + %TRUE if the permission was successfully acquired - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -54214,19 +57495,19 @@ g_permission_release(). - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - the #GAsyncReadyCallback to call when done + the #GAsyncReadyCallback to call when done - the user data to pass to @callback + the user data to pass to @callback @@ -54236,16 +57517,16 @@ g_permission_release(). - %TRUE if the permission was successfully acquired + %TRUE if the permission was successfully acquired - a #GPermission instance + a #GPermission instance - the #GAsyncResult given to the #GAsyncReadyCallback + the #GAsyncResult given to the #GAsyncReadyCallback @@ -54255,16 +57536,16 @@ g_permission_release(). - %TRUE if the permission was successfully released + %TRUE if the permission was successfully released - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -54278,19 +57559,19 @@ g_permission_release(). - a #GPermission instance + a #GPermission instance - a #GCancellable, or %NULL + a #GCancellable, or %NULL - the #GAsyncReadyCallback to call when done + the #GAsyncReadyCallback to call when done - the user data to pass to @callback + the user data to pass to @callback @@ -54300,16 +57581,16 @@ g_permission_release(). - %TRUE if the permission was successfully released + %TRUE if the permission was successfully released - a #GPermission instance + a #GPermission instance - the #GAsyncResult given to the #GAsyncReadyCallback + the #GAsyncResult given to the #GAsyncReadyCallback @@ -54325,14 +57606,14 @@ g_permission_release(). - #GPollableInputStream is implemented by #GInputStreams that + #GPollableInputStream is implemented by #GInputStreams that can be polled for readiness to read. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. - Checks if @stream is actually pollable. Some classes may implement + Checks if @stream is actually pollable. Some classes may implement #GPollableInputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableInputStream methods is undefined. @@ -54341,18 +57622,18 @@ For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - %TRUE if @stream is pollable, %FALSE if not. + %TRUE if @stream is pollable, %FALSE if not. - a #GPollableInputStream. + a #GPollableInputStream. - Creates a #GSource that triggers when @stream can be read, or + Creates a #GSource that triggers when @stream can be read, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -54362,22 +57643,22 @@ triggers, so you should use g_pollable_input_stream_read_nonblocking() rather than g_input_stream_read() from the callback. - a new #GSource + a new #GSource - a #GPollableInputStream. + a #GPollableInputStream. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Checks if @stream can be read. + Checks if @stream can be read. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_input_stream_read() @@ -54387,7 +57668,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a %G_IO_ERROR_WOULD_BLOCK error rather than blocking. - %TRUE if @stream is readable, %FALSE if not. If an error + %TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -54395,13 +57676,13 @@ g_pollable_input_stream_read_nonblocking(), which will return a - a #GPollableInputStream. + a #GPollableInputStream. - Attempts to read up to @count bytes from @stream into @buffer, as + Attempts to read up to @count bytes from @stream into @buffer, as with g_input_stream_read(). If @stream is not currently readable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a #GSource @@ -54414,30 +57695,30 @@ may happen if you call this method after a source triggers due to having been cancelled. - the number of bytes read, or -1 on error (including + the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). - a #GPollableInputStream + a #GPollableInputStream - a buffer to + a buffer to read data into (which should be at least @count bytes long). - the number of bytes you want to read + the number of bytes you want to read - Checks if @stream is actually pollable. Some classes may implement + Checks if @stream is actually pollable. Some classes may implement #GPollableInputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableInputStream methods is undefined. @@ -54446,18 +57727,18 @@ For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - %TRUE if @stream is pollable, %FALSE if not. + %TRUE if @stream is pollable, %FALSE if not. - a #GPollableInputStream. + a #GPollableInputStream. - Creates a #GSource that triggers when @stream can be read, or + Creates a #GSource that triggers when @stream can be read, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -54467,22 +57748,22 @@ triggers, so you should use g_pollable_input_stream_read_nonblocking() rather than g_input_stream_read() from the callback. - a new #GSource + a new #GSource - a #GPollableInputStream. + a #GPollableInputStream. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Checks if @stream can be read. + Checks if @stream can be read. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_input_stream_read() @@ -54492,7 +57773,7 @@ g_pollable_input_stream_read_nonblocking(), which will return a %G_IO_ERROR_WOULD_BLOCK error rather than blocking. - %TRUE if @stream is readable, %FALSE if not. If an error + %TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -54500,13 +57781,13 @@ g_pollable_input_stream_read_nonblocking(), which will return a - a #GPollableInputStream. + a #GPollableInputStream. - Attempts to read up to @count bytes from @stream into @buffer, as + Attempts to read up to @count bytes from @stream into @buffer, as with g_input_stream_read(). If @stream is not currently readable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a #GSource @@ -54519,28 +57800,28 @@ may happen if you call this method after a source triggers due to having been cancelled. - the number of bytes read, or -1 on error (including + the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). - a #GPollableInputStream + a #GPollableInputStream - a buffer to + a buffer to read data into (which should be at least @count bytes long). - the number of bytes you want to read + the number of bytes you want to read - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -54566,12 +57847,12 @@ readable. - %TRUE if @stream is pollable, %FALSE if not. + %TRUE if @stream is pollable, %FALSE if not. - a #GPollableInputStream. + a #GPollableInputStream. @@ -54581,7 +57862,7 @@ readable. - %TRUE if @stream is readable, %FALSE if not. If an error + %TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -54589,7 +57870,7 @@ readable. - a #GPollableInputStream. + a #GPollableInputStream. @@ -54599,16 +57880,16 @@ readable. - a new #GSource + a new #GSource - a #GPollableInputStream. + a #GPollableInputStream. - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -54618,24 +57899,24 @@ readable. - the number of bytes read, or -1 on error (including + the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). - a #GPollableInputStream + a #GPollableInputStream - a buffer to + a buffer to read data into (which should be at least @count bytes long). - the number of bytes you want to read + the number of bytes you want to read @@ -54643,34 +57924,34 @@ readable. - #GPollableOutputStream is implemented by #GOutputStreams that + #GPollableOutputStream is implemented by #GOutputStreams that can be polled for readiness to write. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. - + - Checks if @stream is actually pollable. Some classes may implement + Checks if @stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableOutputStream methods is undefined. For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - + - %TRUE if @stream is pollable, %FALSE if not. + %TRUE if @stream is pollable, %FALSE if not. - a #GPollableOutputStream. + a #GPollableOutputStream. - Creates a #GSource that triggers when @stream can be written, or + Creates a #GSource that triggers when @stream can be written, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -54678,24 +57959,24 @@ As with g_pollable_output_stream_is_writable(), it is possible that the stream may not actually be writable even after the source triggers, so you should use g_pollable_output_stream_write_nonblocking() rather than g_output_stream_write() from the callback. - + - a new #GSource + a new #GSource - a #GPollableOutputStream. + a #GPollableOutputStream. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Checks if @stream can be written. + Checks if @stream can be written. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_output_stream_write() @@ -54703,9 +57984,9 @@ after this returns %TRUE would still block. To guarantee non-blocking behavior, you should always use g_pollable_output_stream_write_nonblocking(), which will return a %G_IO_ERROR_WOULD_BLOCK error rather than blocking. - + - %TRUE if @stream is writable, %FALSE if not. If an error + %TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -54713,13 +57994,13 @@ g_pollable_output_stream_write_nonblocking(), which will return a - a #GPollableOutputStream. + a #GPollableOutputStream. - Attempts to write up to @count bytes from @buffer to @stream, as + Attempts to write up to @count bytes from @buffer to @stream, as with g_output_stream_write(). If @stream is not currently writable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -54734,32 +58015,32 @@ to having been cancelled. Also note that if %G_IO_ERROR_WOULD_BLOCK is returned some underlying transports like D/TLS require that you re-send the same @buffer and @count in the next write call. - + - the number of bytes written, or -1 on error (including + the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). - a #GPollableOutputStream + a #GPollableOutputStream - a buffer to write + a buffer to write data from - the number of bytes you want to write + the number of bytes you want to write - Attempts to write the bytes contained in the @n_vectors @vectors to @stream, + Attempts to write the bytes contained in the @n_vectors @vectors to @stream, as with g_output_stream_writev(). If @stream is not currently writable, this will immediately return %@G_POLLABLE_RETURN_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -54775,9 +58056,9 @@ to having been cancelled. Also note that if %G_POLLABLE_RETURN_WOULD_BLOCK is returned some underlying transports like D/TLS require that you re-send the same @vectors and @n_vectors in the next write call. - + - %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -54785,48 +58066,48 @@ be set. - a #GPollableOutputStream + a #GPollableOutputStream - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - location to store the number of bytes that were + location to store the number of bytes that were written to the stream - Checks if @stream is actually pollable. Some classes may implement + Checks if @stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableOutputStream methods is undefined. For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - + - %TRUE if @stream is pollable, %FALSE if not. + %TRUE if @stream is pollable, %FALSE if not. - a #GPollableOutputStream. + a #GPollableOutputStream. - Creates a #GSource that triggers when @stream can be written, or + Creates a #GSource that triggers when @stream can be written, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -54834,24 +58115,24 @@ As with g_pollable_output_stream_is_writable(), it is possible that the stream may not actually be writable even after the source triggers, so you should use g_pollable_output_stream_write_nonblocking() rather than g_output_stream_write() from the callback. - + - a new #GSource + a new #GSource - a #GPollableOutputStream. + a #GPollableOutputStream. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Checks if @stream can be written. + Checks if @stream can be written. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_output_stream_write() @@ -54859,9 +58140,9 @@ after this returns %TRUE would still block. To guarantee non-blocking behavior, you should always use g_pollable_output_stream_write_nonblocking(), which will return a %G_IO_ERROR_WOULD_BLOCK error rather than blocking. - + - %TRUE if @stream is writable, %FALSE if not. If an error + %TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -54869,13 +58150,13 @@ g_pollable_output_stream_write_nonblocking(), which will return a - a #GPollableOutputStream. + a #GPollableOutputStream. - Attempts to write up to @count bytes from @buffer to @stream, as + Attempts to write up to @count bytes from @buffer to @stream, as with g_output_stream_write(). If @stream is not currently writable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -54890,36 +58171,36 @@ to having been cancelled. Also note that if %G_IO_ERROR_WOULD_BLOCK is returned some underlying transports like D/TLS require that you re-send the same @buffer and @count in the next write call. - + - the number of bytes written, or -1 on error (including + the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). - a #GPollableOutputStream + a #GPollableOutputStream - a buffer to write + a buffer to write data from - the number of bytes you want to write + the number of bytes you want to write - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Attempts to write the bytes contained in the @n_vectors @vectors to @stream, + Attempts to write the bytes contained in the @n_vectors @vectors to @stream, as with g_output_stream_writev(). If @stream is not currently writable, this will immediately return %@G_POLLABLE_RETURN_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -54935,9 +58216,9 @@ to having been cancelled. Also note that if %G_POLLABLE_RETURN_WOULD_BLOCK is returned some underlying transports like D/TLS require that you re-send the same @vectors and @n_vectors in the next write call. - + - %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -54945,26 +58226,26 @@ be set. - a #GPollableOutputStream + a #GPollableOutputStream - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - location to store the number of bytes that were + location to store the number of bytes that were written to the stream - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -54980,22 +58261,28 @@ g_pollable_output_stream_is_writable(), and then calls g_output_stream_write() if it returns %TRUE. This means you only need to override it if it is possible that your @is_writable implementation may return %TRUE when the stream is not actually -writable. - +writable. + +The default implementation of @writev_nonblocking calls +g_pollable_output_stream_write_nonblocking() for each vector, and converts +its return value and error (if set) to a #GPollableReturn. You should +override this where possible to avoid having to allocate a #GError to return +%G_IO_ERROR_WOULD_BLOCK. + The parent interface. - + - %TRUE if @stream is pollable, %FALSE if not. + %TRUE if @stream is pollable, %FALSE if not. - a #GPollableOutputStream. + a #GPollableOutputStream. @@ -55003,9 +58290,9 @@ writable. - + - %TRUE if @stream is writable, %FALSE if not. If an error + %TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -55013,7 +58300,7 @@ writable. - a #GPollableOutputStream. + a #GPollableOutputStream. @@ -55021,18 +58308,18 @@ writable. - + - a new #GSource + a new #GSource - a #GPollableOutputStream. + a #GPollableOutputStream. - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -55040,26 +58327,26 @@ writable. - + - the number of bytes written, or -1 on error (including + the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). - a #GPollableOutputStream + a #GPollableOutputStream - a buffer to write + a buffer to write data from - the number of bytes you want to write + the number of bytes you want to write @@ -55067,9 +58354,9 @@ writable. - + - %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -55077,21 +58364,21 @@ be set. - a #GPollableOutputStream + a #GPollableOutputStream - the buffer containing the #GOutputVectors to write. + the buffer containing the #GOutputVectors to write. - the number of vectors to write + the number of vectors to write - location to store the number of bytes that were + location to store the number of bytes that were written to the stream @@ -55100,7 +58387,7 @@ be set. - Return value for various IO operations that signal errors via the + Return value for various IO operations that signal errors via the return value and not necessarily via a #GError. This enum exists to be able to return errors to callers without having to @@ -55110,13 +58397,13 @@ regularly happening errors like %G_IO_ERROR_WOULD_BLOCK. In case of %G_POLLABLE_RETURN_FAILED a #GError should be set for the operation to give details about the error that happened. - Generic error condition for when an operation fails. + Generic error condition for when an operation fails. - The operation was successfully finished. + The operation was successfully finished. - The operation would block. + The operation would block. @@ -55140,7 +58427,7 @@ g_pollable_output_stream_create_source(). - A #GPropertyAction is a way to get a #GAction with a state value + A #GPropertyAction is a way to get a #GAction with a state value reflecting and controlling the value of a #GObject property. The state of the action will correspond to the value of the property. @@ -55193,7 +58480,7 @@ property of a #GtkStack if this value is actually stored in combine its use with g_settings_bind(). - Creates a #GAction corresponding to the value of property + Creates a #GAction corresponding to the value of property @property_name on @object. The property must be existent and readable and writable (and not @@ -55203,72 +58490,72 @@ This function takes a reference on @object and doesn't release it until the action is destroyed. - a new #GPropertyAction + a new #GPropertyAction - the name of the action to create + the name of the action to create - the object that has the property + the object that has the property to wrap - the name of the property + the name of the property - If @action is currently enabled. + If @action is currently enabled. If the action is disabled then calls to g_action_activate() and g_action_change_state() have no effect. - If %TRUE, the state of the action will be the negation of the + If %TRUE, the state of the action will be the negation of the property value, provided the property is boolean. - The name of the action. This is mostly meaningful for identifying + The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GActionMap. - The object to wrap a property on. + The object to wrap a property on. The object must be a non-%NULL #GObject with properties. - The type of the parameter that must be given when activating the + The type of the parameter that must be given when activating the action. - The name of the property to wrap on the object. + The name of the property to wrap on the object. The property must exist on the passed-in object and it must be readable and writable (and not construct-only). - The state of the action, or %NULL if the action is stateless. + The state of the action, or %NULL if the action is stateless. - The #GVariantType of the state that the action has, or %NULL if the + The #GVariantType of the state that the action has, or %NULL if the action is stateless. - A #GProxy handles connecting to a remote host via a given type of + A #GProxy handles connecting to a remote host via a given type of proxy server. It is implemented by the 'gio-proxy' extension point. The extensions are named after their proxy protocol name. As an example, a SOCKS5 proxy implementation can be retrieved with the @@ -55276,105 +58563,105 @@ name 'socks5' using the function g_io_extension_point_get_extension_by_name(). - Lookup "gio-proxy" extension point for a proxy implementation that supports -specified protocol. + Find the `gio-proxy` extension point for a proxy implementation that supports +the specified protocol. - return a #GProxy or NULL if protocol + return a #GProxy or NULL if protocol is not supported. - the proxy protocol name (e.g. http, socks, etc) + the proxy protocol name (e.g. http, socks, etc) - Given @connection to communicate with a proxy (eg, a + Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload. - a #GIOStream that will replace @connection. This might + a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. - a #GProxy + a #GProxy - a #GIOStream + a #GIOStream - a #GProxyAddress + a #GProxyAddress - a #GCancellable + a #GCancellable - Asynchronous version of g_proxy_connect(). + Asynchronous version of g_proxy_connect(). - a #GProxy + a #GProxy - a #GIOStream + a #GIOStream - a #GProxyAddress + a #GProxyAddress - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback + a #GAsyncReadyCallback - callback data + callback data - See g_proxy_connect(). + See g_proxy_connect(). - a #GIOStream. + a #GIOStream. - a #GProxy + a #GProxy - a #GAsyncResult + a #GAsyncResult - Some proxy protocols expect to be passed a hostname, which they + Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return %FALSE if @proxy is implementing such a protocol. When %FALSE is returned, the caller @@ -55383,100 +58670,100 @@ should resolve the destination hostname first, and then pass a g_proxy_connect() or g_proxy_connect_async(). - %TRUE if hostname resolution is supported. + %TRUE if hostname resolution is supported. - a #GProxy + a #GProxy - Given @connection to communicate with a proxy (eg, a + Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload. - a #GIOStream that will replace @connection. This might + a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. - a #GProxy + a #GProxy - a #GIOStream + a #GIOStream - a #GProxyAddress + a #GProxyAddress - a #GCancellable + a #GCancellable - Asynchronous version of g_proxy_connect(). + Asynchronous version of g_proxy_connect(). - a #GProxy + a #GProxy - a #GIOStream + a #GIOStream - a #GProxyAddress + a #GProxyAddress - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback + a #GAsyncReadyCallback - callback data + callback data - See g_proxy_connect(). + See g_proxy_connect(). - a #GIOStream. + a #GIOStream. - a #GProxy + a #GProxy - a #GAsyncResult + a #GAsyncResult - Some proxy protocols expect to be passed a hostname, which they + Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return %FALSE if @proxy is implementing such a protocol. When %FALSE is returned, the caller @@ -55485,23 +58772,23 @@ should resolve the destination hostname first, and then pass a g_proxy_connect() or g_proxy_connect_async(). - %TRUE if hostname resolution is supported. + %TRUE if hostname resolution is supported. - a #GProxy + a #GProxy - Support for proxied #GInetSocketAddress. + Support for proxied #GInetSocketAddress. - Creates a new #GProxyAddress for @inetaddr with @protocol that should + Creates a new #GProxyAddress for @inetaddr with @protocol that should tunnel through @dest_hostname and @dest_port. (Note that this method doesn't set the #GProxyAddress:uri or @@ -55509,141 +58796,141 @@ tunnel through @dest_hostname and @dest_port. directly if you want to set those.) - a new #GProxyAddress + a new #GProxyAddress - The proxy server #GInetAddress. + The proxy server #GInetAddress. - The proxy server port. + The proxy server port. - The proxy protocol to support, in lower case (e.g. socks, http). + The proxy protocol to support, in lower case (e.g. socks, http). - The destination hostname the proxy should tunnel to. + The destination hostname the proxy should tunnel to. - The destination port to tunnel to. + The destination port to tunnel to. - The username to authenticate to the proxy server + The username to authenticate to the proxy server (or %NULL). - The password to authenticate to the proxy server + The password to authenticate to the proxy server (or %NULL). - Gets @proxy's destination hostname; that is, the name of the host + Gets @proxy's destination hostname; that is, the name of the host that will be connected to via the proxy, not the name of the proxy itself. - the @proxy's destination hostname + the @proxy's destination hostname - a #GProxyAddress + a #GProxyAddress - Gets @proxy's destination port; that is, the port on the + Gets @proxy's destination port; that is, the port on the destination host that will be connected to via the proxy, not the port number of the proxy itself. - the @proxy's destination port + the @proxy's destination port - a #GProxyAddress + a #GProxyAddress - Gets the protocol that is being spoken to the destination + Gets the protocol that is being spoken to the destination server; eg, "http" or "ftp". - the @proxy's destination protocol + the @proxy's destination protocol - a #GProxyAddress + a #GProxyAddress - Gets @proxy's password. + Gets @proxy's password. - the @proxy's password + the @proxy's password - a #GProxyAddress + a #GProxyAddress - Gets @proxy's protocol. eg, "socks" or "http" + Gets @proxy's protocol. eg, "socks" or "http" - the @proxy's protocol + the @proxy's protocol - a #GProxyAddress + a #GProxyAddress - Gets the proxy URI that @proxy was constructed from. + Gets the proxy URI that @proxy was constructed from. - the @proxy's URI, or %NULL if unknown + the @proxy's URI, or %NULL if unknown - a #GProxyAddress + a #GProxyAddress - Gets @proxy's username. + Gets @proxy's username. - the @proxy's username + the @proxy's username - a #GProxyAddress + a #GProxyAddress @@ -55655,7 +58942,7 @@ server; eg, "http" or "ftp". - The protocol being spoke to the destination host, or %NULL if + The protocol being spoke to the destination host, or %NULL if the #GProxyAddress doesn't know. @@ -55666,7 +58953,7 @@ the #GProxyAddress doesn't know. - The URI string that the proxy was constructed from (or %NULL + The URI string that the proxy was constructed from (or %NULL if the creator didn't specify this). @@ -55681,14 +58968,14 @@ if the creator didn't specify this). - Class structure for #GProxyAddress. + Class structure for #GProxyAddress. - #GProxyAddressEnumerator is a wrapper around #GSocketAddressEnumerator which + #GProxyAddressEnumerator is a wrapper around #GSocketAddressEnumerator which takes the #GSocketAddress instances returned by the #GSocketAddressEnumerator and wraps them in #GProxyAddress instances, using the given #GProxyAddressEnumerator:proxy-resolver. @@ -55702,12 +58989,12 @@ with one. - The default port to use if #GProxyAddressEnumerator:uri does not + The default port to use if #GProxyAddressEnumerator:uri does not specify one. - The proxy resolver to use. + The proxy resolver to use. @@ -55800,26 +59087,26 @@ specify one. - a #GIOStream that will replace @connection. This might + a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. - a #GProxy + a #GProxy - a #GIOStream + a #GIOStream - a #GProxyAddress + a #GProxyAddress - a #GCancellable + a #GCancellable @@ -55833,27 +59120,27 @@ specify one. - a #GProxy + a #GProxy - a #GIOStream + a #GIOStream - a #GProxyAddress + a #GProxyAddress - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback + a #GAsyncReadyCallback - callback data + callback data @@ -55863,16 +59150,16 @@ specify one. - a #GIOStream. + a #GIOStream. - a #GProxy + a #GProxy - a #GAsyncResult + a #GAsyncResult @@ -55882,12 +59169,12 @@ specify one. - %TRUE if hostname resolution is supported. + %TRUE if hostname resolution is supported. - a #GProxy + a #GProxy @@ -55895,7 +59182,7 @@ specify one. - #GProxyResolver provides synchronous and asynchronous network proxy + #GProxyResolver provides synchronous and asynchronous network proxy resolution. #GProxyResolver is used within #GSocketClient through the method g_socket_connectable_proxy_enumerate(). @@ -55904,31 +59191,31 @@ be found in glib-networking. GIO comes with an implementation for use inside Flatpak portals. - Gets the default #GProxyResolver for the system. + Gets the default #GProxyResolver for the system. - the default #GProxyResolver. + the default #GProxyResolver. - Checks if @resolver can be used on this system. (This is used + Checks if @resolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns %TRUE for this method.) - %TRUE if @resolver is supported. + %TRUE if @resolver is supported. - a #GProxyResolver + a #GProxyResolver - Looks into the system proxy configuration to determine what proxy, + Looks into the system proxy configuration to determine what proxy, if any, to use to connect to @uri. The returned proxy URIs are of the form `<protocol>://[user[:password]@]host:port` or `direct://`, where <protocol> could be http, rtsp, socks @@ -55945,7 +59232,7 @@ Direct connection should not be attempted unless it is part of the returned array of proxies. - A + A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -55954,21 +59241,21 @@ returned array of proxies. - a #GProxyResolver + a #GProxyResolver - a URI representing the destination to connect to + a URI representing the destination to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more + Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details. @@ -55976,34 +59263,34 @@ details. - a #GProxyResolver + a #GProxyResolver - a URI representing the destination to connect to + a URI representing the destination to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Call this function to obtain the array of proxy URIs when + Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details. - A + A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -56012,33 +59299,33 @@ g_proxy_resolver_lookup() for more details. - a #GProxyResolver + a #GProxyResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - Checks if @resolver can be used on this system. (This is used + Checks if @resolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns %TRUE for this method.) - %TRUE if @resolver is supported. + %TRUE if @resolver is supported. - a #GProxyResolver + a #GProxyResolver - Looks into the system proxy configuration to determine what proxy, + Looks into the system proxy configuration to determine what proxy, if any, to use to connect to @uri. The returned proxy URIs are of the form `<protocol>://[user[:password]@]host:port` or `direct://`, where <protocol> could be http, rtsp, socks @@ -56055,7 +59342,7 @@ Direct connection should not be attempted unless it is part of the returned array of proxies. - A + A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -56064,21 +59351,21 @@ returned array of proxies. - a #GProxyResolver + a #GProxyResolver - a URI representing the destination to connect to + a URI representing the destination to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more + Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details. @@ -56086,34 +59373,34 @@ details. - a #GProxyResolver + a #GProxyResolver - a URI representing the destination to connect to + a URI representing the destination to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Call this function to obtain the array of proxy URIs when + Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details. - A + A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -56122,33 +59409,33 @@ g_proxy_resolver_lookup() for more details. - a #GProxyResolver + a #GProxyResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - The virtual function table for #GProxyResolver. + The virtual function table for #GProxyResolver. - The parent interface. + The parent interface. - %TRUE if @resolver is supported. + %TRUE if @resolver is supported. - a #GProxyResolver + a #GProxyResolver @@ -56158,7 +59445,7 @@ g_proxy_resolver_lookup() for more details. - A + A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -56167,15 +59454,15 @@ g_proxy_resolver_lookup() for more details. - a #GProxyResolver + a #GProxyResolver - a URI representing the destination to connect to + a URI representing the destination to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -56189,23 +59476,23 @@ g_proxy_resolver_lookup() for more details. - a #GProxyResolver + a #GProxyResolver - a URI representing the destination to connect to + a URI representing the destination to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback @@ -56215,7 +59502,7 @@ g_proxy_resolver_lookup() for more details. - A + A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -56224,17 +59511,52 @@ g_proxy_resolver_lookup() for more details. - a #GProxyResolver + a #GProxyResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Changes the size of the memory block pointed to by @data to @size bytes. @@ -56257,7 +59579,7 @@ The function should have the same semantics as realloc(). - The GRemoteActionGroup interface is implemented by #GActionGroup + The GRemoteActionGroup interface is implemented by #GActionGroup instances that either transmit action invocations to other processes or receive action invocations in the local process from other processes. @@ -56281,7 +59603,7 @@ invocations that arrive by way of D-Bus. - Activates the remote action. + Activates the remote action. This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the @@ -56296,25 +59618,25 @@ interaction timestamp or startup notification information. - a #GDBusActionGroup + a #GDBusActionGroup - the name of the action to activate + the name of the action to activate - the optional parameter to the activation + the optional parameter to the activation - the platform data to send + the platform data to send - Changes the state of a remote action. + Changes the state of a remote action. This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the @@ -56329,25 +59651,25 @@ user interaction timestamp or startup notification information. - a #GRemoteActionGroup + a #GRemoteActionGroup - the name of the action to change the state of + the name of the action to change the state of - the new requested value for the state + the new requested value for the state - the platform data to send + the platform data to send - Activates the remote action. + Activates the remote action. This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the @@ -56362,25 +59684,25 @@ interaction timestamp or startup notification information. - a #GDBusActionGroup + a #GDBusActionGroup - the name of the action to activate + the name of the action to activate - the optional parameter to the activation + the optional parameter to the activation - the platform data to send + the platform data to send - Changes the state of a remote action. + Changes the state of a remote action. This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the @@ -56395,26 +59717,26 @@ user interaction timestamp or startup notification information. - a #GRemoteActionGroup + a #GRemoteActionGroup - the name of the action to change the state of + the name of the action to change the state of - the new requested value for the state + the new requested value for the state - the platform data to send + the platform data to send - The virtual function table for #GRemoteActionGroup. + The virtual function table for #GRemoteActionGroup. @@ -56427,19 +59749,19 @@ user interaction timestamp or startup notification information. - a #GDBusActionGroup + a #GDBusActionGroup - the name of the action to activate + the name of the action to activate - the optional parameter to the activation + the optional parameter to the activation - the platform data to send + the platform data to send @@ -56453,19 +59775,19 @@ user interaction timestamp or startup notification information. - a #GRemoteActionGroup + a #GRemoteActionGroup - the name of the action to change the state of + the name of the action to change the state of - the new requested value for the state + the new requested value for the state - the platform data to send + the platform data to send @@ -56473,7 +59795,7 @@ user interaction timestamp or startup notification information. - #GResolver provides cancellable synchronous and asynchronous DNS + #GResolver provides cancellable synchronous and asynchronous DNS resolution, for hostnames (g_resolver_lookup_by_address(), g_resolver_lookup_by_name() and their async variants) and SRV (service) records (g_resolver_lookup_service()). @@ -56483,7 +59805,7 @@ g_resolver_lookup_by_name() and their async variants) and SRV making it easy to connect to a remote host/service. - Frees @addresses (which should be the return value from + Frees @addresses (which should be the return value from g_resolver_lookup_by_name() or g_resolver_lookup_by_name_finish()). (This is a convenience method; you can also simply free the results by hand.) @@ -56493,7 +59815,7 @@ by hand.) - a #GList of #GInetAddress + a #GList of #GInetAddress @@ -56501,7 +59823,7 @@ by hand.) - Frees @targets (which should be the return value from + Frees @targets (which should be the return value from g_resolver_lookup_service() or g_resolver_lookup_service_finish()). (This is a convenience method; you can also simply free the results by hand.) @@ -56511,7 +59833,7 @@ results by hand.) - a #GList of #GSrvTarget + a #GList of #GSrvTarget @@ -56519,17 +59841,17 @@ results by hand.) - Gets the default #GResolver. You should unref it when you are done + Gets the default #GResolver. You should unref it when you are done with it. #GResolver may use its reference count as a hint about how many threads it should allocate for concurrent DNS resolutions. - the default #GResolver. + the default #GResolver. - Synchronously reverse-resolves @address to determine its + Synchronously reverse-resolves @address to determine its associated hostname. If the DNS resolution fails, @error (if non-%NULL) will be set to @@ -56540,27 +59862,27 @@ operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - a hostname (either ASCII-only, or in ASCII-encoded + a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. - a #GResolver + a #GResolver - the address to reverse-resolve + the address to reverse-resolve - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously reverse-resolving @address to determine its + Begins asynchronously reverse-resolving @address to determine its associated hostname, and eventually calls @callback, which must call g_resolver_lookup_by_address_finish() to get the final result. @@ -56569,29 +59891,29 @@ call g_resolver_lookup_by_address_finish() to get the final result. - a #GResolver + a #GResolver - the address to reverse-resolve + the address to reverse-resolve - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a previous call to + Retrieves the result of a previous call to g_resolver_lookup_by_address_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -56599,23 +59921,23 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a hostname (either ASCII-only, or in ASCII-encoded + a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - Synchronously resolves @hostname to determine its associated IP + Synchronously resolves @hostname to determine its associated IP 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()). @@ -56640,7 +59962,7 @@ address, it may be easier to create a #GNetworkAddress and use its #GSocketConnectable interface. - a non-empty #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.) @@ -56650,21 +59972,21 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GResolver + a #GResolver - the hostname to look up + the hostname to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously resolving @hostname to determine its + Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -56674,29 +59996,29 @@ See g_resolver_lookup_by_name() for more details. - a #GResolver + a #GResolver - the hostname to look up the address of + the hostname to look up the address of - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a call to + Retrieves the result of a call to g_resolver_lookup_by_name_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -56704,7 +60026,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a #GList + a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -56713,22 +60035,22 @@ for more details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - This differs from g_resolver_lookup_by_name() in that you can modify + This differs from g_resolver_lookup_by_name() in that you can modify the lookup behavior with @flags. For example this can be used to limit results with #G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY. - a non-empty #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.) @@ -56738,25 +60060,25 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GResolver + a #GResolver - the hostname to look up + the hostname to look up - extra #GResolverNameLookupFlags for the lookup + extra #GResolverNameLookupFlags for the lookup - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously resolving @hostname to determine its + Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_with_flags_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -56766,33 +60088,33 @@ See g_resolver_lookup_by_name() for more details. - a #GResolver + a #GResolver - the hostname to look up the address of + the hostname to look up the address of - extra #GResolverNameLookupFlags for the lookup + extra #GResolverNameLookupFlags for the lookup - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a call to + Retrieves the result of a call to g_resolver_lookup_by_name_with_flags_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -56800,7 +60122,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a #GList + a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -56809,17 +60131,17 @@ for more details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - Synchronously performs a DNS record lookup for the given @rrname and returns + Synchronously performs a DNS record lookup for the given @rrname and returns a list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain for each @record_type. @@ -56831,7 +60153,7 @@ operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - a non-empty #GList of + 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.) @@ -56841,25 +60163,25 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the DNS name to lookup the record for + the DNS name to look up the record for - the type of DNS record to lookup + the type of DNS record to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously performing a DNS lookup for the given + Begins asynchronously performing a DNS lookup for the given @rrname, and eventually calls @callback, which must call g_resolver_lookup_records_finish() to get the final result. See g_resolver_lookup_records() for more details. @@ -56869,33 +60191,33 @@ g_resolver_lookup_records() for more details. - a #GResolver + a #GResolver - the DNS name to lookup the record for + the DNS name to look up the record for - the type of DNS record to lookup + the type of DNS record to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a previous call to + Retrieves the result of a previous call to g_resolver_lookup_records_async(). Returns a non-empty list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain. @@ -56905,7 +60227,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a non-empty #GList of + 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.) @@ -56915,11 +60237,11 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback @@ -56967,7 +60289,7 @@ g_variant_unref() to do this.) - Retrieves the result of a previous call to + Retrieves the result of a previous call to g_resolver_lookup_service_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -56975,7 +60297,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a non-empty #GList of + a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -56984,11 +60306,11 @@ details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback @@ -57005,7 +60327,7 @@ details. - Synchronously reverse-resolves @address to determine its + Synchronously reverse-resolves @address to determine its associated hostname. If the DNS resolution fails, @error (if non-%NULL) will be set to @@ -57016,27 +60338,27 @@ operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - a hostname (either ASCII-only, or in ASCII-encoded + a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. - a #GResolver + a #GResolver - the address to reverse-resolve + the address to reverse-resolve - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously reverse-resolving @address to determine its + Begins asynchronously reverse-resolving @address to determine its associated hostname, and eventually calls @callback, which must call g_resolver_lookup_by_address_finish() to get the final result. @@ -57045,29 +60367,29 @@ call g_resolver_lookup_by_address_finish() to get the final result. - a #GResolver + a #GResolver - the address to reverse-resolve + the address to reverse-resolve - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a previous call to + Retrieves the result of a previous call to g_resolver_lookup_by_address_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -57075,23 +60397,23 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a hostname (either ASCII-only, or in ASCII-encoded + a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - Synchronously resolves @hostname to determine its associated IP + Synchronously resolves @hostname to determine its associated IP 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()). @@ -57116,7 +60438,7 @@ address, it may be easier to create a #GNetworkAddress and use its #GSocketConnectable interface. - a non-empty #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.) @@ -57126,21 +60448,21 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GResolver + a #GResolver - the hostname to look up + the hostname to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously resolving @hostname to determine its + Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -57150,29 +60472,29 @@ See g_resolver_lookup_by_name() for more details. - a #GResolver + a #GResolver - the hostname to look up the address of + the hostname to look up the address of - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a call to + Retrieves the result of a call to g_resolver_lookup_by_name_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -57180,7 +60502,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a #GList + a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -57189,22 +60511,22 @@ for more details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - This differs from g_resolver_lookup_by_name() in that you can modify + This differs from g_resolver_lookup_by_name() in that you can modify the lookup behavior with @flags. For example this can be used to limit results with #G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY. - a non-empty #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.) @@ -57214,25 +60536,25 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GResolver + a #GResolver - the hostname to look up + the hostname to look up - extra #GResolverNameLookupFlags for the lookup + extra #GResolverNameLookupFlags for the lookup - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously resolving @hostname to determine its + Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_with_flags_finish() to get the result. See g_resolver_lookup_by_name() for more details. @@ -57242,33 +60564,33 @@ See g_resolver_lookup_by_name() for more details. - a #GResolver + a #GResolver - the hostname to look up the address of + the hostname to look up the address of - extra #GResolverNameLookupFlags for the lookup + extra #GResolverNameLookupFlags for the lookup - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a call to + Retrieves the result of a call to g_resolver_lookup_by_name_with_flags_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -57276,7 +60598,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a #GList + a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -57285,17 +60607,17 @@ for more details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - Synchronously performs a DNS record lookup for the given @rrname and returns + Synchronously performs a DNS record lookup for the given @rrname and returns a list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain for each @record_type. @@ -57307,7 +60629,7 @@ operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - a non-empty #GList of + 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.) @@ -57317,25 +60639,25 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the DNS name to lookup the record for + the DNS name to look up the record for - the type of DNS record to lookup + the type of DNS record to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously performing a DNS lookup for the given + Begins asynchronously performing a DNS lookup for the given @rrname, and eventually calls @callback, which must call g_resolver_lookup_records_finish() to get the final result. See g_resolver_lookup_records() for more details. @@ -57345,33 +60667,33 @@ g_resolver_lookup_records() for more details. - a #GResolver + a #GResolver - the DNS name to lookup the record for + the DNS name to look up the record for - the type of DNS record to lookup + the type of DNS record to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a previous call to + Retrieves the result of a previous call to g_resolver_lookup_records_async(). Returns a non-empty list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain. @@ -57381,7 +60703,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a non-empty #GList of + 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.) @@ -57391,17 +60713,17 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - Synchronously performs a DNS SRV lookup for the given @service and + Synchronously performs a DNS SRV lookup for the given @service and @protocol in the given @domain and returns an array of #GSrvTarget. @domain may be an ASCII-only or UTF-8 hostname. Note also that the @service and @protocol arguments do not include the leading underscore @@ -57424,7 +60746,7 @@ to create a #GNetworkService and use its #GSocketConnectable interface. - a non-empty #GList of + 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.) @@ -57434,29 +60756,29 @@ this.) - a #GResolver + a #GResolver - the service type to look up (eg, "ldap") + the service type to look up (eg, "ldap") - the networking protocol to use for @service (eg, "tcp") + the networking protocol to use for @service (eg, "tcp") - the DNS domain to look up the service in + the DNS domain to look up the service in - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Begins asynchronously performing a DNS SRV lookup for the given + Begins asynchronously performing a DNS SRV lookup for the given @service and @protocol in the given @domain, and eventually calls @callback, which must call g_resolver_lookup_service_finish() to get the final result. See g_resolver_lookup_service() for more @@ -57467,37 +60789,37 @@ details. - a #GResolver + a #GResolver - the service type to look up (eg, "ldap") + the service type to look up (eg, "ldap") - the networking protocol to use for @service (eg, "tcp") + the networking protocol to use for @service (eg, "tcp") - the DNS domain to look up the service in + the DNS domain to look up the service in - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback - Retrieves the result of a previous call to + Retrieves the result of a previous call to g_resolver_lookup_service_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to @@ -57505,7 +60827,7 @@ a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - a non-empty #GList of + a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -57514,17 +60836,17 @@ details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback - Sets @resolver to be the application's default resolver (reffing + Sets @resolver to be the application's default resolver (reffing @resolver, and unreffing the previous default resolver, if any). Future calls to g_resolver_get_default() will return this resolver. @@ -57539,7 +60861,7 @@ itself as the default resolver for all later code to use. - the new default #GResolver + the new default #GResolver @@ -57551,7 +60873,7 @@ itself as the default resolver for all later code to use. - Emitted when the resolver notices that the system resolver + Emitted when the resolver notices that the system resolver configuration has changed. @@ -57580,7 +60902,7 @@ configuration has changed. - a non-empty #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.) @@ -57590,15 +60912,15 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GResolver + a #GResolver - the hostname to look up + the hostname to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -57612,23 +60934,23 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GResolver + a #GResolver - the hostname to look up the address of + the hostname to look up the address of - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback @@ -57638,7 +60960,7 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GList + a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -57647,11 +60969,11 @@ for more details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback @@ -57661,21 +60983,21 @@ for more details. - a hostname (either ASCII-only, or in ASCII-encoded + a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. - a #GResolver + a #GResolver - the address to reverse-resolve + the address to reverse-resolve - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -57689,23 +61011,23 @@ for more details. - a #GResolver + a #GResolver - the address to reverse-resolve + the address to reverse-resolve - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback @@ -57715,17 +61037,17 @@ for more details. - a hostname (either ASCII-only, or in ASCII-encoded + a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback @@ -57781,7 +61103,7 @@ form), or %NULL on error. - a non-empty #GList of + a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -57790,11 +61112,11 @@ details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback @@ -57804,7 +61126,7 @@ details. - a non-empty #GList of + 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.) @@ -57814,19 +61136,19 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the DNS name to lookup the record for + the DNS name to look up the record for - the type of DNS record to lookup + the type of DNS record to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -57840,27 +61162,27 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the DNS name to lookup the record for + the DNS name to look up the record for - the type of DNS record to lookup + the type of DNS record to look up - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback @@ -57870,7 +61192,7 @@ g_variant_unref() to do this.) - a non-empty #GList of + 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.) @@ -57880,11 +61202,11 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback @@ -57898,27 +61220,27 @@ g_variant_unref() to do this.) - a #GResolver + a #GResolver - the hostname to look up the address of + the hostname to look up the address of - extra #GResolverNameLookupFlags for the lookup + extra #GResolverNameLookupFlags for the lookup - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call after resolution completes + callback to call after resolution completes - data for @callback + data for @callback @@ -57928,7 +61250,7 @@ g_variant_unref() to do this.) - a #GList + a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -57937,11 +61259,11 @@ for more details. - a #GResolver + a #GResolver - the result passed to your #GAsyncReadyCallback + the result passed to your #GAsyncReadyCallback @@ -57951,7 +61273,7 @@ for more details. - a non-empty #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.) @@ -57961,19 +61283,19 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - a #GResolver + a #GResolver - the hostname to look up + the hostname to look up - extra #GResolverNameLookupFlags for the lookup + extra #GResolverNameLookupFlags for the lookup - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -57981,23 +61303,23 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - An error code used with %G_RESOLVER_ERROR in a #GError returned + An error code used with %G_RESOLVER_ERROR in a #GError returned from a #GResolver routine. - the requested name/address/service was not + the requested name/address/service was not found - the requested information could not + the requested information could not be looked up due to a network error or similar problem - unknown error + unknown error - Gets the #GResolver Error Quark. + Gets the #GResolver Error Quark. - a #GQuark. + a #GQuark. @@ -58018,48 +61340,54 @@ from a #GResolver routine. - The type of record that g_resolver_lookup_records() or + The type of record that g_resolver_lookup_records() or g_resolver_lookup_records_async() should retrieve. The records are returned as lists of #GVariant tuples. Each record type has different values in the variant tuples returned. %G_RESOLVER_RECORD_SRV records are returned as variants with the signature -'(qqqs)', containing a guint16 with the priority, a guint16 with the -weight, a guint16 with the port, and a string of the hostname. +`(qqqs)`, containing a `guint16` with the priority, a `guint16` with the +weight, a `guint16` with the port, and a string of the hostname. %G_RESOLVER_RECORD_MX records are returned as variants with the signature -'(qs)', representing a guint16 with the preference, and a string containing +`(qs)`, representing a `guint16` with the preference, and a string containing the mail exchanger hostname. %G_RESOLVER_RECORD_TXT records are returned as variants with the signature -'(as)', representing an array of the strings in the text record. +`(as)`, representing an array of the strings in the text record. Note: Most TXT +records only contain a single string, but +[RFC 1035](https://tools.ietf.org/html/rfc1035#section-3.3.14) does allow a +record to contain multiple strings. The RFC which defines the interpretation +of a specific TXT record will likely require concatenation of multiple +strings if they are present, as with +[RFC 7208](https://tools.ietf.org/html/rfc7208#section-3.3). %G_RESOLVER_RECORD_SOA records are returned as variants with the signature -'(ssuuuuu)', representing a string containing the primary name server, a -string containing the administrator, the serial as a guint32, the refresh -interval as guint32, the retry interval as a guint32, the expire timeout -as a guint32, and the ttl as a guint32. +`(ssuuuuu)`, representing a string containing the primary name server, a +string containing the administrator, the serial as a `guint32`, the refresh +interval as a `guint32`, the retry interval as a `guint32`, the expire timeout +as a `guint32`, and the TTL as a `guint32`. %G_RESOLVER_RECORD_NS records are returned as variants with the signature -'(s)', representing a string of the hostname of the name server. +`(s)`, representing a string of the hostname of the name server. - lookup DNS SRV records for a domain + look up DNS SRV records for a domain - lookup DNS MX records for a domain + look up DNS MX records for a domain - lookup DNS TXT records for a name + look up DNS TXT records for a name - lookup DNS SOA records for a zone + look up DNS SOA records for a zone - lookup DNS NS records for a domain + look up DNS NS records for a domain - Applications and libraries often contain binary or textual data that is + Applications and libraries often contain binary or textual data that is really part of the application, rather than user data. For instance #GtkBuilder .ui files, splashscreen images, GMenu markup XML, CSS files, icons, etc. These are often shipped as files in `$datadir/appname`, or @@ -58089,7 +61417,7 @@ the preprocessing step is skipped. `to-pixdata` which will use the gdk-pixbuf-pixdata command to convert images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside -the resource file, rather than an (uncompressed) copy if it. For this, the gdk-pixbuf-pixdata +the resource file, rather than an (uncompressed) copy of it. For this, the gdk-pixbuf-pixdata program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will abort. @@ -58186,7 +61514,7 @@ the slash should ideally be absolute, but this is not strictly required. It is location of a single resource with an individual file. - Creates a GResource from a reference to the binary resource bundle. + Creates a GResource from a reference to the binary resource bundle. This will keep a reference to @data while the resource lives, so the data should not be modified or freed. @@ -58200,18 +61528,18 @@ GLib 2.56, or in older versions fail and exit the process. If @data is empty or corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned. - a new #GResource, or %NULL on error + a new #GResource, or %NULL on error - A #GBytes + A #GBytes - Registers the resource with the process-global set of resources. + Registers the resource with the process-global set of resources. Once a resource is registered the files in it can be accessed with the global resource lookup functions like g_resources_lookup_data(). @@ -58220,26 +61548,26 @@ with the global resource lookup functions like g_resources_lookup_data(). - A #GResource + A #GResource - Unregisters the resource from the process-global set of resources. + Unregisters the resource from the process-global set of resources. - A #GResource + A #GResource - Returns all the names of children at the specified @path in the resource. + Returns all the names of children at the specified @path in the resource. The return result is a %NULL terminated list of strings which should be released with g_strfreev(). @@ -58249,63 +61577,63 @@ If @path is invalid or does not exist in the #GResource, @lookup_flags controls the behaviour of the lookup. - an array of constant strings + an array of constant strings - A #GResource + A #GResource - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - Looks for a file at the specified @path in the resource and + Looks for a file at the specified @path in the resource and if found returns information about it. @lookup_flags controls the behaviour of the lookup. - %TRUE if the file was found. %FALSE if there were errors + %TRUE if the file was found. %FALSE if there were errors - A #GResource + A #GResource - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - a location to place the length of the contents of the file, + a location to place the length of the contents of the file, or %NULL if the length is not needed - a location to place the flags about the file, + a location to place the flags about the file, or %NULL if the length is not needed - Looks for a file at the specified @path in the resource and + Looks for a file at the specified @path in the resource and returns a #GBytes that lets you directly access the data in memory. @@ -58321,68 +61649,68 @@ the heap and automatically uncompress the data. @lookup_flags controls the behaviour of the lookup. - #GBytes or %NULL on error. + #GBytes or %NULL on error. Free the returned object with g_bytes_unref() - A #GResource + A #GResource - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - Looks for a file at the specified @path in the resource and + Looks for a file at the specified @path in the resource and returns a #GInputStream that lets you read the data. @lookup_flags controls the behaviour of the lookup. - #GInputStream or %NULL on error. + #GInputStream or %NULL on error. Free the returned object with g_object_unref() - A #GResource + A #GResource - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - Atomically increments the reference count of @resource by one. This + Atomically increments the reference count of @resource by one. This function is MT-safe and may be called from any thread. - The passed in #GResource + The passed in #GResource - A #GResource + A #GResource - Atomically decrements the reference count of @resource by one. If the + Atomically decrements the reference count of @resource by one. If the reference count drops to 0, all memory allocated by the resource is released. This function is MT-safe and may be called from any thread. @@ -58392,13 +61720,13 @@ thread. - A #GResource + A #GResource - Loads a binary resource bundle and creates a #GResource representation of it, allowing + Loads a binary resource bundle and creates a #GResource representation of it, allowing you to query it for data. If you want to use this resource in the global resource namespace you need @@ -58410,57 +61738,393 @@ there is an error in reading it, an error from g_mapped_file_new() will be returned. - a new #GResource, or %NULL on error + a new #GResource, or %NULL on error - the path of a filename to load, in the GLib filename encoding + the path of a filename to load, in the GLib filename encoding - An error code used with %G_RESOURCE_ERROR in a #GError returned + An error code used with %G_RESOURCE_ERROR in a #GError returned from a #GResource routine. - no file was found at the requested path + no file was found at the requested path - unknown error + unknown error - Gets the #GResource Error Quark. + Gets the #GResource Error Quark. - a #GQuark + a #GQuark - GResourceFlags give information about a particular file inside a resource + GResourceFlags give information about a particular file inside a resource bundle. - No flags set. + No flags set. - The file is compressed. + The file is compressed. - GResourceLookupFlags determine how resource path lookups are handled. + GResourceLookupFlags determine how resource path lookups are handled. - No flags set. + No flags set. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extension point for #GSettingsBackend functionality. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - #GSeekable is implemented by streams (implementations of + #GSeekable is implemented by streams (implementations of #GInputStream or #GOutputStream) that support seeking. Seekable streams largely fall into two categories: resizable and @@ -58476,36 +62140,36 @@ lseek() on a normal file. Seeking past the end and writing data will usually cause the stream to resize by introducing zero bytes. - Tests if the stream supports the #GSeekableIface. + Tests if the stream supports the #GSeekableIface. - %TRUE if @seekable can be seeked. %FALSE otherwise. + %TRUE if @seekable can be seeked. %FALSE otherwise. - a #GSeekable. + a #GSeekable. - Tests if the length of the stream can be adjusted with + Tests if the length of the stream can be adjusted with g_seekable_truncate(). - %TRUE if the stream can be truncated, %FALSE otherwise. + %TRUE if the stream can be truncated, %FALSE otherwise. - a #GSeekable. + a #GSeekable. - Seeks in the stream by the given @offset, modified by @type. + Seeks in the stream by the given @offset, modified by @type. Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If @@ -58521,46 +62185,46 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if successful. If an error + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GSeekable. + a #GSeekable. - a #goffset. + a #goffset. - a #GSeekType. + a #GSeekType. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Tells the current position within the stream. + Tells the current position within the stream. - the offset from the beginning of the buffer. + the offset from the beginning of the buffer. - a #GSeekable. + a #GSeekable. - Sets the length of the stream to @offset. If the stream was previously + Sets the length of the stream to @offset. If the stream was previously larger than @offset, the extra data is discarded. If the stream was previouly shorter than @offset, it is extended with NUL ('\0') bytes. @@ -58571,57 +62235,57 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - %TRUE if successful. If an error + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GSeekable. + a #GSeekable. - new length for @seekable, in bytes. + new length for @seekable, in bytes. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Tests if the stream supports the #GSeekableIface. + Tests if the stream supports the #GSeekableIface. - %TRUE if @seekable can be seeked. %FALSE otherwise. + %TRUE if @seekable can be seeked. %FALSE otherwise. - a #GSeekable. + a #GSeekable. - Tests if the length of the stream can be adjusted with + Tests if the length of the stream can be adjusted with g_seekable_truncate(). - %TRUE if the stream can be truncated, %FALSE otherwise. + %TRUE if the stream can be truncated, %FALSE otherwise. - a #GSeekable. + a #GSeekable. - Seeks in the stream by the given @offset, modified by @type. + Seeks in the stream by the given @offset, modified by @type. Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If @@ -58637,46 +62301,46 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - %TRUE if successful. If an error + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GSeekable. + a #GSeekable. - a #goffset. + a #goffset. - a #GSeekType. + a #GSeekType. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Tells the current position within the stream. + Tells the current position within the stream. - the offset from the beginning of the buffer. + the offset from the beginning of the buffer. - a #GSeekable. + a #GSeekable. - Sets the length of the stream to @offset. If the stream was previously + Sets the length of the stream to @offset. If the stream was previously larger than @offset, the extra data is discarded. If the stream was previouly shorter than @offset, it is extended with NUL ('\0') bytes. @@ -58687,22 +62351,22 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - %TRUE if successful. If an error + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GSeekable. + a #GSeekable. - new length for @seekable, in bytes. + new length for @seekable, in bytes. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -58719,12 +62383,12 @@ partial result will be returned, without an error. - the offset from the beginning of the buffer. + the offset from the beginning of the buffer. - a #GSeekable. + a #GSeekable. @@ -58734,12 +62398,12 @@ partial result will be returned, without an error. - %TRUE if @seekable can be seeked. %FALSE otherwise. + %TRUE if @seekable can be seeked. %FALSE otherwise. - a #GSeekable. + a #GSeekable. @@ -58749,26 +62413,26 @@ partial result will be returned, without an error. - %TRUE if successful. If an error + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GSeekable. + a #GSeekable. - a #goffset. + a #goffset. - a #GSeekType. + a #GSeekType. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -58778,12 +62442,12 @@ partial result will be returned, without an error. - %TRUE if the stream can be truncated, %FALSE otherwise. + %TRUE if the stream can be truncated, %FALSE otherwise. - a #GSeekable. + a #GSeekable. @@ -58793,22 +62457,22 @@ partial result will be returned, without an error. - %TRUE if successful. If an error + %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. - a #GSeekable. + a #GSeekable. - new length for @seekable, in bytes. + new length for @seekable, in bytes. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -58816,7 +62480,7 @@ partial result will be returned, without an error. - The #GSettings class provides a convenient API for storing and retrieving + The #GSettings class provides a convenient API for storing and retrieving application settings. Reads and writes can be considered to be non-blocking. Reading @@ -59105,7 +62769,7 @@ rules. It should not be committed to version control or included in `EXTRA_DIST`. - Creates a new #GSettings object with the schema specified by + Creates a new #GSettings object with the schema specified by @schema_id. Signals on the newly created #GSettings object will be dispatched @@ -59114,18 +62778,18 @@ call to g_settings_new(). The new #GSettings will hold a reference on the context. See g_main_context_push_thread_default(). - a new #GSettings object + a new #GSettings object - the id of the schema + the id of the schema - Creates a new #GSettings object with a given schema, backend and + Creates a new #GSettings object with a given schema, backend and path. It should be extremely rare that you ever want to use this function. @@ -59150,26 +62814,26 @@ error if @path is %NULL and the schema has no path of its own or if have. - a new #GSettings object + a new #GSettings object - a #GSettingsSchema + a #GSettingsSchema - a #GSettingsBackend + a #GSettingsBackend - the path to use + the path to use - Creates a new #GSettings object with the schema specified by + Creates a new #GSettings object with the schema specified by @schema_id and a given #GSettingsBackend. Creating a #GSettings object with a different backend allows accessing @@ -59179,48 +62843,48 @@ the system to get a settings object that modifies the system default settings instead of the settings for this user. - a new #GSettings object + a new #GSettings object - the id of the schema + the id of the schema - the #GSettingsBackend to use + the #GSettingsBackend to use - Creates a new #GSettings object with the schema specified by + Creates a new #GSettings object with the schema specified by @schema_id and a given #GSettingsBackend and path. This is a mix of g_settings_new_with_backend() and g_settings_new_with_path(). - a new #GSettings object + a new #GSettings object - the id of the schema + the id of the schema - the #GSettingsBackend to use + the #GSettingsBackend to use - the path to use + the path to use - Creates a new #GSettings object with the relocatable schema specified + Creates a new #GSettings object with the relocatable schema specified by @schema_id and a given path. You only need to do this if you want to directly create a settings @@ -59235,51 +62899,51 @@ begins and ends with '/' and does not contain two consecutive '/' characters. - a new #GSettings object + a new #GSettings object - the id of the schema + the id of the schema - the path to use + the path to use - Deprecated. + Deprecated. Use g_settings_schema_source_list_schemas() instead - a list of relocatable - #GSettings schemas that are available. The list must not be - modified or freed. + a list of relocatable + #GSettings schemas that are available, in no defined order. The list must + not be modified or freed. - Deprecated. + Deprecated. 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. - a list of #GSettings - schemas that are available. The list must not be modified or - freed. + a list of #GSettings + schemas that are available, in no defined order. The list must not be + modified or freed. - Ensures that all pending operations are complete for the default backend. + Ensures that all pending operations are complete for the default backend. Writes made to a #GSettings are handled asynchronously. For this reason, it is very unlikely that the changes have it to disk by the @@ -59295,7 +62959,7 @@ time the call is done). - Removes an existing binding for @property on @object. + Removes an existing binding for @property on @object. Note that bindings are automatically removed when the object is finalized, so it is rarely necessary to call this @@ -59306,11 +62970,11 @@ function. - the object + the object - the property whose binding is removed + the property whose binding is removed @@ -59375,7 +63039,7 @@ function. - Applies any changes that have been made to the settings. This + Applies any changes that have been made to the settings. This function does nothing unless @settings is in 'delay-apply' mode; see g_settings_delay(). In the normal case settings are always applied immediately. @@ -59385,13 +63049,13 @@ applied immediately. - a #GSettings instance + a #GSettings instance - Create a binding between the @key in the @settings object + Create a binding between the @key in the @settings object and the property @property of @object. The binding uses the default GIO mapping functions to map @@ -59417,29 +63081,29 @@ binding overrides the first one. - a #GSettings object + a #GSettings object - the key to bind + the key to bind - a #GObject + a #GObject - the name of the property to bind + the name of the property to bind - flags for the binding + flags for the binding - Create a binding between the @key in the @settings object + Create a binding between the @key in the @settings object and the property @property of @object. The binding uses the provided mapping functions to map between @@ -59455,47 +63119,47 @@ binding overrides the first one. - a #GSettings object + a #GSettings object - the key to bind + the key to bind - a #GObject + a #GObject - the name of the property to bind + the name of the property to bind - flags for the binding + flags for the binding - a function that gets called to convert values + a function that gets called to convert values from @settings to @object, or %NULL to use the default GIO mapping - a function that gets called to convert values + a function that gets called to convert values from @object to @settings, or %NULL to use the default GIO mapping - data that gets passed to @get_mapping and @set_mapping + data that gets passed to @get_mapping and @set_mapping - #GDestroyNotify function for @user_data + #GDestroyNotify function for @user_data - Create a binding between the writability of @key in the + Create a binding between the writability of @key in the @settings object and the property @property of @object. The property must be boolean; "sensitive" or "visible" properties of widgets are the most likely candidates. @@ -59518,29 +63182,29 @@ binding overrides the first one. - a #GSettings object + a #GSettings object - the key to bind + the key to bind - a #GObject + a #GObject - the name of a boolean property to bind + the name of a boolean property to bind - whether to 'invert' the value + whether to 'invert' the value - Creates a #GAction corresponding to a given #GSettings key. + Creates a #GAction corresponding to a given #GSettings key. The action has the same name as the key. @@ -59556,22 +63220,22 @@ activations take the new value for the key (which must have the correct type). - a new #GAction + a new #GAction - a #GSettings + a #GSettings - the name of a key in @settings + the name of a key in @settings - Changes the #GSettings object into 'delay-apply' mode. In this + Changes the #GSettings object into 'delay-apply' mode. In this mode, changes to @settings are not immediately propagated to the backend, but kept locally until g_settings_apply() is called. @@ -59580,13 +63244,13 @@ backend, but kept locally until g_settings_apply() is called. - a #GSettings object + a #GSettings object - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience function that combines g_settings_get_value() with g_variant_get(). @@ -59600,25 +63264,25 @@ the type given in the schema. - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - a #GVariant format string + a #GVariant format string - arguments as per @format + arguments as per @format - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for booleans. @@ -59626,22 +63290,22 @@ It is a programmer error to give a @key that isn't specified as having a boolean type in the schema for @settings. - a boolean + a boolean - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Creates a child settings object which has a base path of + Creates a child settings object which has a base path of `base-path/@name`, where `base-path` is the base path of @settings. @@ -59649,22 +63313,22 @@ The schema for the child settings object must have been declared in the schema of @settings using a <child> element. - a 'child' settings object + a 'child' settings object - a #GSettings object + a #GSettings object - the name of the child schema + the name of the child schema - Gets the "default value" of a key. + Gets the "default value" of a key. This is the value that would be read if g_settings_reset() were to be called on the key. @@ -59687,22 +63351,22 @@ It is a programmer error to give a @key that isn't contained in the schema for @settings. - the default value + the default value - a #GSettings object + a #GSettings object - the key to get the default value for + the key to get the default value for - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for doubles. @@ -59710,22 +63374,22 @@ It is a programmer error to give a @key that isn't specified as having a 'double' type in the schema for @settings. - a double + a double - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Gets the value that is stored in @settings for @key and converts it + Gets the value that is stored in @settings for @key and converts it to the enum value that it represents. In order to use this function the type of the value must be a string @@ -59739,22 +63403,22 @@ value for the enumerated type then this function will return the default value. - the enum value + the enum value - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Gets the value that is stored in @settings for @key and converts it + Gets the value that is stored in @settings for @key and converts it to the flags value that it represents. In order to use this function the type of the value must be an array @@ -59768,37 +63432,37 @@ value for the flags type then this function will return the default value. - the flags value + the flags value - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Returns whether the #GSettings object has any unapplied + Returns whether the #GSettings object has any unapplied changes. This can only be the case if it is in 'delayed-apply' mode. - %TRUE if @settings has unapplied changes + %TRUE if @settings has unapplied changes - a #GSettings object + a #GSettings object - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 32-bit integers. @@ -59806,22 +63470,22 @@ It is a programmer error to give a @key that isn't specified as having a int32 type in the schema for @settings. - an integer + an integer - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 64-bit integers. @@ -59829,22 +63493,22 @@ It is a programmer error to give a @key that isn't specified as having a int64 type in the schema for @settings. - a 64-bit integer + a 64-bit integer - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Gets the value that is stored at @key in @settings, subject to + Gets the value that is stored at @key in @settings, subject to application-level validation/mapping. You should use this function when the application needs to perform @@ -59873,31 +63537,31 @@ what is returned by this function. %NULL is valid; it is returned just as any other value would be. - the result, which may be %NULL + the result, which may be %NULL - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - the function to map the value in the + the function to map the value in the settings database to the value used by the application - user data for @mapping + user data for @mapping - Queries the range of a key. + Queries the range of a key. Use g_settings_schema_key_get_range() instead. @@ -59905,17 +63569,17 @@ just as any other value would be. - a #GSettings + a #GSettings - the key to query the range of + the key to query the range of - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for strings. @@ -59923,28 +63587,28 @@ It is a programmer error to give a @key that isn't specified as having a string type in the schema for @settings. - a newly-allocated string + a newly-allocated string - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - A convenience variant of g_settings_get() for string arrays. + A convenience variant of g_settings_get() for string arrays. It is a programmer error to give a @key that isn't specified as having an array of strings type in the schema for @settings. - a + a newly-allocated, %NULL-terminated array of strings, the value that is stored at @key in @settings. @@ -59953,17 +63617,17 @@ is stored at @key in @settings. - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 32-bit unsigned integers. @@ -59972,22 +63636,22 @@ It is a programmer error to give a @key that isn't specified as having a uint32 type in the schema for @settings. - an unsigned integer + an unsigned integer - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Gets the value that is stored at @key in @settings. + Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 64-bit unsigned integers. @@ -59996,22 +63660,22 @@ It is a programmer error to give a @key that isn't specified as having a uint64 type in the schema for @settings. - a 64-bit unsigned integer + a 64-bit unsigned integer - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Checks the "user value" of a key, if there is one. + Checks the "user value" of a key, if there is one. The user value of a key is the last value that was set by the user. @@ -60031,61 +63695,61 @@ It is a programmer error to give a @key that isn't contained in the schema for @settings. - the user's value, if set + the user's value, if set - a #GSettings object + a #GSettings object - the key to get the user value for + the key to get the user value for - Gets the value that is stored in @settings for @key. + Gets the value that is stored in @settings for @key. It is a programmer error to give a @key that isn't contained in the schema for @settings. - a new #GVariant + a new #GVariant - a #GSettings object + a #GSettings object - the key to get the value for + the key to get the value for - Finds out if a key can be written or not + Finds out if a key can be written or not - %TRUE if the key @name is writable + %TRUE if the key @name is writable - a #GSettings object + a #GSettings object - the name of a key + the name of a key - Gets the list of children on @settings. + Gets the list of children on @settings. The list is exactly the list of strings for which it is not an error to call g_settings_get_child(). @@ -60098,20 +63762,21 @@ You should free the return value with g_strfreev() when you are done with it. - a list of the children on @settings + a list of the children on + @settings, in no defined order - a #GSettings object + a #GSettings object - - Introspects the list of keys on @settings. + + Introspects the list of keys on @settings. You should probably not be calling this function from "normal" code (since you should already know what keys are in your schema). This @@ -60119,49 +63784,51 @@ function is intended for introspection reasons. You should free the return value with g_strfreev() when you are done with it. + Use g_settings_schema_list_keys instead(). - a list of the keys on @settings + a list of the keys on + @settings, in no defined order - a #GSettings object + a #GSettings object - Checks if the given @value is of the correct type and within the + Checks if the given @value is of the correct type and within the permitted range for @key. Use g_settings_schema_key_range_check() instead. - %TRUE if @value is valid for @key + %TRUE if @value is valid for @key - a #GSettings + a #GSettings - the key to check + the key to check - the value to check + the value to check - Resets @key to its default value. + Resets @key to its default value. This call resets the key, as much as possible, to its default value. -That might the value specified in the schema or the one set by the +That might be the value specified in the schema or the one set by the administrator. @@ -60169,17 +63836,17 @@ administrator. - a #GSettings object + a #GSettings object - the name of a key + the name of a key - Reverts all non-applied changes to the settings. This function + Reverts all non-applied changes to the settings. This function does nothing unless @settings is in 'delay-apply' mode; see g_settings_delay(). In the normal case settings are always applied immediately. @@ -60191,13 +63858,13 @@ Change notifications will be emitted for affected keys. - a #GSettings instance + a #GSettings instance - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience function that combines g_settings_set_value() with g_variant_new(). @@ -60207,31 +63874,31 @@ schema for @settings or for the #GVariantType of @format to mismatch the type given in the schema. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - a #GVariant format string + a #GVariant format string - arguments as per @format + arguments as per @format - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for booleans. @@ -60239,27 +63906,27 @@ It is a programmer error to give a @key that isn't specified as having a boolean type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to + the value to set it to - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for doubles. @@ -60267,27 +63934,27 @@ It is a programmer error to give a @key that isn't specified as having a 'double' type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to + the value to set it to - Looks up the enumerated type nick for @value and writes it to @key, + Looks up the enumerated type nick for @value and writes it to @key, within @settings. It is a programmer error to give a @key that isn't contained in the @@ -60299,26 +63966,26 @@ g_settings_get_string() will return the 'nick' associated with @value. - %TRUE, if the set succeeds + %TRUE, if the set succeeds - a #GSettings object + a #GSettings object - a key, within @settings + a key, within @settings - an enumerated value + an enumerated value - Looks up the flags type nicks for the bits specified by @value, puts + Looks up the flags type nicks for the bits specified by @value, puts them in an array of strings and writes the array to @key, within @settings. @@ -60331,26 +63998,26 @@ g_settings_get_strv() will return an array of 'nicks'; one for each bit in @value. - %TRUE, if the set succeeds + %TRUE, if the set succeeds - a #GSettings object + a #GSettings object - a key, within @settings + a key, within @settings - a flags value + a flags value - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for 32-bit integers. @@ -60358,27 +64025,27 @@ It is a programmer error to give a @key that isn't specified as having a int32 type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to + the value to set it to - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for 64-bit integers. @@ -60386,27 +64053,27 @@ It is a programmer error to give a @key that isn't specified as having a int64 type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to + the value to set it to - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for strings. @@ -60414,27 +64081,27 @@ It is a programmer error to give a @key that isn't specified as having a string type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to + the value to set it to - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for string arrays. If @value is %NULL, then @key is set to be the empty array. @@ -60443,21 +64110,21 @@ It is a programmer error to give a @key that isn't specified as having an array of strings type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to, or %NULL + the value to set it to, or %NULL @@ -60465,7 +64132,7 @@ having an array of strings type in the schema for @settings. - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for 32-bit unsigned integers. @@ -60474,27 +64141,27 @@ It is a programmer error to give a @key that isn't specified as having a uint32 type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to + the value to set it to - Sets @key in @settings to @value. + Sets @key in @settings to @value. A convenience variant of g_settings_set() for 64-bit unsigned integers. @@ -60503,27 +64170,27 @@ It is a programmer error to give a @key that isn't specified as having a uint64 type in the schema for @settings. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - the value to set it to + the value to set it to - Sets @key in @settings to @value. + Sets @key in @settings to @value. It is a programmer error to give a @key that isn't contained in the schema for @settings or for @value to have the incorrect type, per @@ -60532,45 +64199,45 @@ the schema. If @value is floating then this function consumes the reference. - %TRUE if setting the key succeeded, + %TRUE if setting the key succeeded, %FALSE if the key was not writable - a #GSettings object + a #GSettings object - the name of the key to set + the name of the key to set - a #GVariant of the correct type + a #GVariant of the correct type - The name of the context that the settings are stored in. + The name of the context that the settings are stored in. - Whether the #GSettings object is in 'delay-apply' mode. See + Whether the #GSettings object is in 'delay-apply' mode. See g_settings_delay() for details. - If this property is %TRUE, the #GSettings object has outstanding + If this property is %TRUE, the #GSettings object has outstanding changes that will be applied when g_settings_apply() is called. - The path within the backend where the settings are stored. + The path within the backend where the settings are stored. - The name of the schema that describes the types of keys + The name of the schema that describes the types of keys for this #GSettings object. The type of this property is *not* #GSettingsSchema. @@ -60584,12 +64251,12 @@ version, this property may instead refer to a #GSettingsSchema. - The name of the schema that describes the types of keys + The name of the schema that describes the types of keys for this #GSettings object. - The #GSettingsSchema describing the types of keys for this + The #GSettingsSchema describing the types of keys for this #GSettings object. Ideally, this property would be called 'schema'. #GSettingsSchema @@ -60605,7 +64272,7 @@ than the schema itself. Take care. - The "change-event" signal is emitted once per change event that + The "change-event" signal is emitted once per change event that affects this settings object. You should connect to this signal only if you are interested in viewing groups of changes before they are split out into multiple emissions of the "changed" signal. @@ -60621,26 +64288,26 @@ The default handler for this signal invokes the "changed" signal for each affected key. If any other connected handler returns %TRUE then this default functionality will be suppressed. - %TRUE to stop other handlers from being invoked for the + %TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further. - + an array of #GQuarks for the changed keys, or %NULL - the length of the @keys array, or 0 + the length of the @keys array, or 0 - The "changed" signal is emitted when a key has potentially changed. + The "changed" signal is emitted when a key has potentially changed. You should call one of the g_settings_get() calls to check the new value. @@ -60655,13 +64322,13 @@ least once while a signal handler was already connected for @key. - the name of the key that changed + the name of the key that changed - The "writable-change-event" signal is emitted once per writability + The "writable-change-event" signal is emitted once per writability change event that affects this settings object. You should connect to this signal if you are interested in viewing groups of changes before they are split out into multiple emissions of the @@ -60680,19 +64347,19 @@ example, a new mandatory setting is introduced). If any other connected handler returns %TRUE then this default functionality will be suppressed. - %TRUE to stop other handlers from being invoked for the + %TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further. - the quark of the key, or 0 + the quark of the key, or 0 - The "writable-changed" signal is emitted when the writability of a + The "writable-changed" signal is emitted when the writability of a key has potentially changed. You should call g_settings_is_writable() in order to determine the new status. @@ -60704,14 +64371,14 @@ callbacks when the writability of "x" changes. - the key + the key - The #GSettingsBackend interface defines a generic interface for + The #GSettingsBackend interface defines a generic interface for non-strictly-typed data that is stored in a hierarchy. To implement an alternative storage backend for #GSettings, you need to implement the #GSettingsBackend interface and then make it implement the @@ -60737,7 +64404,7 @@ C preprocessor symbol %G_SETTINGS_ENABLE_BACKEND before including `gio/gsettingsbackend.h`. - Calculate the longest common prefix of all keys in a tree and write + Calculate the longest common prefix of all keys in a tree and write out an array of the key names relative to that prefix and, optionally, the value to store at each of those keys. @@ -60750,22 +64417,22 @@ g_free(). You should not attempt to free or unref the contents of - a #GTree containing the changes + a #GTree containing the changes - the location to save the path + the location to save the path - the + the location to save the relative keys - + the location to save the values, or %NULL @@ -60774,14 +64441,14 @@ g_free(). You should not attempt to free or unref the contents of - Returns the default #GSettingsBackend. It is possible to override + Returns the default #GSettingsBackend. It is possible to override the default by setting the `GSETTINGS_BACKEND` environment variable to the name of a settings backend. The user gets a reference to the backend. - the default #GSettingsBackend + the default #GSettingsBackend @@ -60944,7 +64611,7 @@ The user gets a reference to the backend. - Signals that a single key has possibly changed. Backend + Signals that a single key has possibly changed. Backend implementations should call this if a key has possibly changed its value. @@ -60972,21 +64639,21 @@ value that was passed to that call. - a #GSettingsBackend implementation + a #GSettingsBackend implementation - the name of the key + the name of the key - the origin tag + the origin tag - This call is a convenience wrapper. It gets the list of changes from + This call is a convenience wrapper. It gets the list of changes from @tree, computes the longest common prefix and calls g_settings_backend_changed(). @@ -60995,21 +64662,21 @@ g_settings_backend_changed(). - a #GSettingsBackend implementation + a #GSettingsBackend implementation - a #GTree containing the changes + a #GTree containing the changes - the origin tag + the origin tag - Signals that a list of keys have possibly changed. Backend + Signals that a list of keys have possibly changed. Backend implementations should call this if keys have possibly changed their values. @@ -61036,27 +64703,27 @@ keys that were changed) but this is not strictly required. - a #GSettingsBackend implementation + a #GSettingsBackend implementation - the path containing the changes + the path containing the changes - the %NULL-terminated list of changed keys + the %NULL-terminated list of changed keys - the origin tag + the origin tag - Signals that all keys below a given path may have possibly changed. + Signals that all keys below a given path may have possibly changed. Backend implementations should call this if an entire path of keys have possibly changed their values. @@ -61083,21 +64750,21 @@ single key in the application will be notified of a possible change. - a #GSettingsBackend implementation + a #GSettingsBackend implementation - the path containing the changes + the path containing the changes - the origin tag + the origin tag - Signals that the writability of all keys below a given path may have + Signals that the writability of all keys below a given path may have changed. Since GSettings performs no locking operations for itself, this call @@ -61108,17 +64775,17 @@ will always be made in response to external events. - a #GSettingsBackend implementation + a #GSettingsBackend implementation - the name of the path + the name of the path - Signals that the writability of a single key has possibly changed. + Signals that the writability of a single key has possibly changed. Since GSettings performs no locking operations for itself, this call will always be made in response to external events. @@ -61128,11 +64795,11 @@ will always be made in response to external events. - a #GSettingsBackend implementation + a #GSettingsBackend implementation - the name of the key + the name of the key @@ -61527,7 +65194,7 @@ g_settings_get_mapped() - The #GSettingsSchemaSource and #GSettingsSchema APIs provide a + The #GSettingsSchemaSource and #GSettingsSchema APIs provide a mechanism for advanced control over the loading of schemas and a mechanism for introspecting their content. @@ -61619,42 +65286,42 @@ In that case, the plugin loading system must compile the schemas for itself before attempting to create the settings source. - Get the ID of @schema. + Get the ID of @schema. - the ID + the ID - a #GSettingsSchema + a #GSettingsSchema - Gets the key named @name from @schema. + Gets the key named @name from @schema. It is a programmer error to request a key that does not exist. See g_settings_schema_list_keys(). - the #GSettingsSchemaKey for @name + the #GSettingsSchemaKey for @name - a #GSettingsSchema + a #GSettingsSchema - the name of a key + the name of a key - Gets the path associated with @schema, or %NULL. + Gets the path associated with @schema, or %NULL. Schemas may be single-instance or relocatable. Single-instance schemas correspond to exactly one set of keys in the backend @@ -61665,125 +65332,126 @@ threfore describe multiple sets of keys at different locations. For relocatable schemas, this function will return %NULL. - the path of the schema, or %NULL + the path of the schema, or %NULL - a #GSettingsSchema + a #GSettingsSchema - Checks if @schema has a key named @name. + Checks if @schema has a key named @name. - %TRUE if such a key exists + %TRUE if such a key exists - a #GSettingsSchema + a #GSettingsSchema - the name of a key + the name of a key - Gets the list of children in @schema. + Gets the list of children in @schema. You should free the return value with g_strfreev() when you are done with it. - a list of the children on @settings + a list of the children on + @settings, in no defined order - a #GSettingsSchema + a #GSettingsSchema - Introspects the list of keys on @schema. + Introspects the list of keys on @schema. You should probably not be calling this function from "normal" code (since you should already know what keys are in your schema). This function is intended for introspection reasons. - a list of the keys on - @schema + a list of the keys on + @schema, in no defined order - a #GSettingsSchema + a #GSettingsSchema - Increase the reference count of @schema, returning a new reference. + Increase the reference count of @schema, returning a new reference. - a new reference to @schema + a new reference to @schema - a #GSettingsSchema + a #GSettingsSchema - Decrease the reference count of @schema, possibly freeing it. + Decrease the reference count of @schema, possibly freeing it. - a #GSettingsSchema + a #GSettingsSchema - #GSettingsSchemaKey is an opaque data structure and can only be accessed + #GSettingsSchemaKey is an opaque data structure and can only be accessed using the following functions. - Gets the default value for @key. + Gets the default value for @key. Note that this is the default value according to the schema. System administrator defaults and lockdown are not visible via this API. - the default value for the key + the default value for the key - a #GSettingsSchemaKey + a #GSettingsSchemaKey - Gets the description for @key. + Gets the description for @key. If no description has been provided in the schema for @key, returns %NULL. @@ -61799,32 +65467,32 @@ function has to parse all of the source XML files in the schema directory. - the description for @key, or %NULL + the description for @key, or %NULL - a #GSettingsSchemaKey + a #GSettingsSchemaKey - Gets the name of @key. + Gets the name of @key. - the name of @key. + the name of @key. - a #GSettingsSchemaKey + a #GSettingsSchemaKey - Queries the range of a key. + Queries the range of a key. This function will return a #GVariant that fully describes the range of values that are valid for @key. @@ -61862,18 +65530,18 @@ You should free the returned value with g_variant_unref() when it is no longer needed. - a #GVariant describing the range + a #GVariant describing the range - a #GSettingsSchemaKey + a #GSettingsSchemaKey - Gets the summary for @key. + Gets the summary for @key. If no summary has been provided in the schema for @key, returns %NULL. @@ -61888,85 +65556,85 @@ function has to parse all of the source XML files in the schema directory. - the summary for @key, or %NULL + the summary for @key, or %NULL - a #GSettingsSchemaKey + a #GSettingsSchemaKey - Gets the #GVariantType of @key. + Gets the #GVariantType of @key. - the type of @key + the type of @key - a #GSettingsSchemaKey + a #GSettingsSchemaKey - Checks if the given @value is of the correct type and within the + Checks if the given @value is of the correct type and within the permitted range for @key. It is a programmer error if @value is not of the correct type -- you must check for this first. - %TRUE if @value is valid for @key + %TRUE if @value is valid for @key - a #GSettingsSchemaKey + a #GSettingsSchemaKey - the value to check + the value to check - Increase the reference count of @key, returning a new reference. + Increase the reference count of @key, returning a new reference. - a new reference to @key + a new reference to @key - a #GSettingsSchemaKey + a #GSettingsSchemaKey - Decrease the reference count of @key, possibly freeing it. + Decrease the reference count of @key, possibly freeing it. - a #GSettingsSchemaKey + a #GSettingsSchemaKey - This is an opaque structure type. You may not access it directly. + This is an opaque structure type. You may not access it directly. - Attempts to create a new schema source corresponding to the contents + Attempts to create a new schema source corresponding to the contents of the given directory. This function is not required for normal uses of #GSettings but it @@ -62003,21 +65671,21 @@ returned by g_settings_schema_source_get_default(). - the filename of a directory + the filename of a directory - a #GSettingsSchemaSource, or %NULL + a #GSettingsSchemaSource, or %NULL - %TRUE, if the directory is trusted + %TRUE, if the directory is trusted - Lists the schemas in a given source. + Lists the schemas in a given source. If @recursive is %TRUE then include parent sources. If %FALSE then only include the schemas from one source (ie: one directory). You @@ -62035,23 +65703,23 @@ use by database editors, commandline tools, etc. - a #GSettingsSchemaSource + a #GSettingsSchemaSource - if we should recurse + if we should recurse - the - list of non-relocatable schemas + the + list of non-relocatable schemas, in no defined order - the list - of relocatable schemas + the list + of relocatable schemas, in no defined order @@ -62059,7 +65727,7 @@ use by database editors, commandline tools, etc. - Looks up a schema with the identifier @schema_id in @source. + Looks up a schema with the identifier @schema_id in @source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -62071,53 +65739,53 @@ then the parent sources will also be checked. If the schema isn't found, %NULL is returned. - a new #GSettingsSchema + a new #GSettingsSchema - a #GSettingsSchemaSource + a #GSettingsSchemaSource - a schema ID + a schema ID - %TRUE if the lookup should be recursive + %TRUE if the lookup should be recursive - Increase the reference count of @source, returning a new reference. + Increase the reference count of @source, returning a new reference. - a new reference to @source + a new reference to @source - a #GSettingsSchemaSource + a #GSettingsSchemaSource - Decrease the reference count of @source, possibly freeing it. + Decrease the reference count of @source, possibly freeing it. - a #GSettingsSchemaSource + a #GSettingsSchemaSource - Gets the default system schema source. + Gets the default system schema source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -62132,42 +65800,42 @@ lookups performed against the default source should probably be done recursively. - the default schema source + the default schema source - A #GSimpleAction is the obvious simple implementation of the #GAction + A #GSimpleAction is the obvious simple implementation of the #GAction interface. This is the easiest way to create an action for purposes of adding it to a #GSimpleActionGroup. See also #GtkAction. - Creates a new action. + Creates a new action. The created action is stateless. See g_simple_action_new_stateful() to create an action that has state. - a new #GSimpleAction + a new #GSimpleAction - the name of the action + the name of the action - the type of parameter that will be passed to + the type of parameter that will be passed to handlers for the #GSimpleAction::activate signal, or %NULL for no parameter - Creates a new stateful action. + Creates a new stateful action. All future state values must have the same #GVariantType as the initial @state. @@ -62175,27 +65843,27 @@ All future state values must have the same #GVariantType as the initial If the @state #GVariant is floating, it is consumed. - a new #GSimpleAction + a new #GSimpleAction - the name of the action + the name of the action - the type of the parameter that will be passed to + the type of the parameter that will be passed to handlers for the #GSimpleAction::activate signal, or %NULL for no parameter - the initial state of the action + the initial state of the action - Sets the action as enabled or not. + Sets the action as enabled or not. An action must be enabled in order to be activated or in order to have its state changed from outside callers. @@ -62208,17 +65876,17 @@ of the action should not attempt to modify its enabled flag. - a #GSimpleAction + a #GSimpleAction - whether the action is enabled + whether the action is enabled - Sets the state of the action. + Sets the state of the action. This directly updates the 'state' property to the given value. @@ -62234,17 +65902,17 @@ If the @value GVariant is floating, it is consumed. - a #GSimpleAction + a #GSimpleAction - the new #GVariant for the state + the new #GVariant for the state - Sets the state hint for the action. + Sets the state hint for the action. See g_action_get_state_hint() for more information about action state hints. @@ -62254,43 +65922,43 @@ action state hints. - a #GSimpleAction + a #GSimpleAction - a #GVariant representing the state hint + a #GVariant representing the state hint - If @action is currently enabled. + If @action is currently enabled. If the action is disabled then calls to g_action_activate() and g_action_change_state() have no effect. - The name of the action. This is mostly meaningful for identifying + The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GSimpleActionGroup. - The type of the parameter that must be given when activating the + The type of the parameter that must be given when activating the action. - The state of the action, or %NULL if the action is stateless. + The state of the action, or %NULL if the action is stateless. - The #GVariantType of the state that the action has, or %NULL if the + The #GVariantType of the state that the action has, or %NULL if the action is stateless. - Indicates that the action was just activated. + Indicates that the action was just activated. @parameter will always be of the expected type, i.e. the parameter type specified when the action was created. If an incorrect type is given when @@ -62308,14 +65976,14 @@ of #GSimpleAction to connect only one handler or the other. - the parameter to the activation, or %NULL if it has + the parameter to the activation, or %NULL if it has no parameter - Indicates that the action just received a request to change its + Indicates that the action just received a request to change its state. @value will always be of the correct state type, i.e. the type of the @@ -62353,28 +66021,28 @@ It could set it to any value at all, or take some other action. - the requested value for the state + the requested value for the state - #GSimpleActionGroup is a hash table filled with #GAction objects, + #GSimpleActionGroup is a hash table filled with #GAction objects, implementing the #GActionGroup and #GActionMap interfaces. - Creates a new, empty, #GSimpleActionGroup. + Creates a new, empty, #GSimpleActionGroup. - a new #GSimpleActionGroup + a new #GSimpleActionGroup - A convenience function for creating multiple #GSimpleAction instances + A convenience function for creating multiple #GSimpleAction instances and adding them to the action group. Use g_action_map_add_action_entries() @@ -62383,28 +66051,28 @@ and adding them to the action group. - a #GSimpleActionGroup + a #GSimpleActionGroup - a pointer to the first item in + a pointer to the first item in an array of #GActionEntry structs - the length of @entries, or -1 + the length of @entries, or -1 - the user data for signal connections + the user data for signal connections - Adds an action to the action group. + Adds an action to the action group. If the action group already contains an action with the same name as @action then the old action is dropped from the group. @@ -62417,38 +66085,38 @@ The action group takes its own reference on @action. - a #GSimpleActionGroup + a #GSimpleActionGroup - a #GAction + a #GAction - Looks up the action with the name @action_name in the group. + Looks up the action with the name @action_name in the group. If no such action exists, returns %NULL. Use g_action_map_lookup_action() - a #GAction, or %NULL + a #GAction, or %NULL - a #GSimpleActionGroup + a #GSimpleActionGroup - the name of an action + the name of an action - Removes the named action from the action group. + Removes the named action from the action group. If no action of this name is in the group then nothing happens. Use g_action_map_remove_action() @@ -62458,11 +66126,11 @@ If no action of this name is in the group then nothing happens. - a #GSimpleActionGroup + a #GSimpleActionGroup - the name of the action + the name of the action @@ -62489,7 +66157,7 @@ If no action of this name is in the group then nothing happens. - As of GLib 2.46, #GSimpleAsyncResult is deprecated in favor of + As of GLib 2.46, #GSimpleAsyncResult is deprecated in favor of #GTask, which provides a simpler API. #GSimpleAsyncResult implements #GAsyncResult. @@ -62657,7 +66325,7 @@ baker_bake_cake_finish (Baker *self, - Creates a #GSimpleAsyncResult. + Creates a #GSimpleAsyncResult. The common convention is to create the #GSimpleAsyncResult in the function that starts the asynchronous operation and use that same @@ -62670,124 +66338,124 @@ this function returns. Use g_task_new() instead. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #GObject, or %NULL. + a #GObject, or %NULL. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - the asynchronous function. + the asynchronous function. - Creates a new #GSimpleAsyncResult with a set error. + Creates a new #GSimpleAsyncResult with a set error. Use g_task_new() and g_task_return_new_error() instead. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #GObject, or %NULL. + a #GObject, or %NULL. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - a #GQuark. + a #GQuark. - an error code. + an error code. - a string with format characters. + a string with format characters. - a list of values to insert into @format. + a list of values to insert into @format. - Creates a #GSimpleAsyncResult from an error condition. + Creates a #GSimpleAsyncResult from an error condition. Use g_task_new() and g_task_return_error() instead. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #GObject, or %NULL. + a #GObject, or %NULL. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - a #GError + a #GError - Creates a #GSimpleAsyncResult from an error condition, and takes over the + Creates a #GSimpleAsyncResult from an error condition, and takes over the caller's ownership of @error, so the caller does not need to free it anymore. Use g_task_new() and g_task_return_error() instead. - a #GSimpleAsyncResult + a #GSimpleAsyncResult - a #GObject, or %NULL + a #GObject, or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data passed to @callback + user data passed to @callback - a #GError + a #GError - Ensures that the data passed to the _finish function of an async + Ensures that the data passed to the _finish function of an async operation is consistent. Three checks are performed. First, @result is checked to ensure that it is really a @@ -62802,26 +66470,26 @@ check is skipped.) Use #GTask and g_task_is_valid() instead. - #TRUE if all checks passed or #FALSE if any failed. + #TRUE if all checks passed or #FALSE if any failed. - the #GAsyncResult passed to the _finish function. + the #GAsyncResult passed to the _finish function. - the #GObject passed to the _finish function. + the #GObject passed to the _finish function. - the asynchronous function. + the asynchronous function. - Completes an asynchronous I/O job immediately. Must be called in + Completes an asynchronous I/O job immediately. Must be called in the thread where the asynchronous result was to be delivered, as it invokes the callback directly. If you are in a different thread use g_simple_async_result_complete_in_idle(). @@ -62835,13 +66503,13 @@ is needed to complete the call. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - Completes an asynchronous function in an idle handler in the + Completes an asynchronous function in an idle handler in the [thread-default main context][g-main-context-push-thread-default] of the thread that @simple was initially created in (and re-pushes that context around the invocation of the callback). @@ -62855,74 +66523,74 @@ is needed to complete the call. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - Gets the operation result boolean from within the asynchronous result. + Gets the operation result boolean from within the asynchronous result. Use #GTask and g_task_propagate_boolean() instead. - %TRUE if the operation's result was %TRUE, %FALSE + %TRUE if the operation's result was %TRUE, %FALSE if the operation's result was %FALSE. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - Gets a pointer result as returned by the asynchronous function. + Gets a pointer result as returned by the asynchronous function. Use #GTask and g_task_propagate_pointer() instead. - a pointer from the result. + a pointer from the result. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - Gets a gssize from the asynchronous result. + Gets a gssize from the asynchronous result. Use #GTask and g_task_propagate_int() instead. - a gssize returned from the asynchronous function. + a gssize returned from the asynchronous function. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - Gets the source tag for the #GSimpleAsyncResult. + Gets the source tag for the #GSimpleAsyncResult. Use #GTask and g_task_get_source_tag() instead. - a #gpointer to the source object for the #GSimpleAsyncResult. + a #gpointer to the source object for the #GSimpleAsyncResult. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - Propagates an error from within the simple asynchronous result to + Propagates an error from within the simple asynchronous result to a given destination. If the #GCancellable given to a prior call to @@ -62931,18 +66599,18 @@ function will return %TRUE with @dest set appropriately. Use #GTask instead. - %TRUE if the error was propagated to @dest. %FALSE otherwise. + %TRUE if the error was propagated to @dest. %FALSE otherwise. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - Runs the asynchronous job in a separate thread and then calls + Runs the asynchronous job in a separate thread and then calls g_simple_async_result_complete_in_idle() on @simple to return the result to the appropriate main loop. @@ -62955,25 +66623,25 @@ is needed to run the job and report its completion. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #GSimpleAsyncThreadFunc. + a #GSimpleAsyncThreadFunc. - the io priority of the request. + the io priority of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Sets a #GCancellable to check before dispatching results. + Sets a #GCancellable to check before dispatching results. This function has one very specific purpose: the provided cancellable is checked at the time of g_simple_async_result_propagate_error() If @@ -62995,17 +66663,17 @@ unrelated g_simple_async_result_set_handle_cancellation() function. - a #GSimpleAsyncResult + a #GSimpleAsyncResult - a #GCancellable to check, or %NULL to unset + a #GCancellable to check, or %NULL to unset - Sets an error within the asynchronous result without a #GError. + Sets an error within the asynchronous result without a #GError. Use #GTask and g_task_return_new_error() instead. @@ -63013,29 +66681,29 @@ unrelated g_simple_async_result_set_handle_cancellation() function. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #GQuark (usually #G_IO_ERROR). + a #GQuark (usually #G_IO_ERROR). - an error code. + an error code. - a formatted error reporting string. + a formatted error reporting string. - a list of variables to fill in @format. + a list of variables to fill in @format. - Sets an error within the asynchronous result without a #GError. + Sets an error within the asynchronous result without a #GError. Unless writing a binding, see g_simple_async_result_set_error(). Use #GTask and g_task_return_error() instead. @@ -63044,29 +66712,29 @@ Unless writing a binding, see g_simple_async_result_set_error(). - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #GQuark (usually #G_IO_ERROR). + a #GQuark (usually #G_IO_ERROR). - an error code. + an error code. - a formatted error reporting string. + a formatted error reporting string. - va_list of arguments. + va_list of arguments. - Sets the result from a #GError. + Sets the result from a #GError. Use #GTask and g_task_return_error() instead. @@ -63074,17 +66742,17 @@ Unless writing a binding, see g_simple_async_result_set_error(). - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - #GError. + #GError. - Sets whether to handle cancellation within the asynchronous operation. + Sets whether to handle cancellation within the asynchronous operation. This function has nothing to do with g_simple_async_result_set_check_cancellable(). It only refers to the @@ -63095,17 +66763,17 @@ g_simple_async_result_set_check_cancellable(). It only refers to the - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #gboolean. + a #gboolean. - Sets the operation result to a boolean within the asynchronous result. + Sets the operation result to a boolean within the asynchronous result. Use #GTask and g_task_return_boolean() instead. @@ -63113,17 +66781,17 @@ g_simple_async_result_set_check_cancellable(). It only refers to the - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #gboolean. + a #gboolean. - Sets the operation result within the asynchronous result to a pointer. + Sets the operation result within the asynchronous result to a pointer. Use #GTask and g_task_return_pointer() instead. @@ -63131,21 +66799,21 @@ g_simple_async_result_set_check_cancellable(). It only refers to the - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a pointer result from an asynchronous function. + a pointer result from an asynchronous function. - a #GDestroyNotify function. + a #GDestroyNotify function. - Sets the operation result within the asynchronous result to + Sets the operation result within the asynchronous result to the given @op_res. Use #GTask and g_task_return_int() instead. @@ -63154,17 +66822,17 @@ the given @op_res. - a #GSimpleAsyncResult. + a #GSimpleAsyncResult. - a #gssize. + a #gssize. - Sets the result from @error, and takes over the caller's ownership + Sets the result from @error, and takes over the caller's ownership of @error, so the caller does not need to free it any more. Use #GTask and g_task_return_error() instead. @@ -63173,11 +66841,11 @@ of @error, so the caller does not need to free it any more. - a #GSimpleAsyncResult + a #GSimpleAsyncResult - a #GError + a #GError @@ -63209,7 +66877,7 @@ checks for cancellation. - GSimpleIOStream creates a #GIOStream from an arbitrary #GInputStream and + GSimpleIOStream creates a #GIOStream from an arbitrary #GInputStream and #GOutputStream. This allows any pair of input and output streams to be used with #GIOStream methods. @@ -63218,20 +66886,20 @@ by other means, for instance creating them with platform specific methods as g_unix_input_stream_new() or g_win32_input_stream_new(), and you want to take advantage of the methods provided by #GIOStream. - Creates a new #GSimpleIOStream wrapping @input_stream and @output_stream. + Creates a new #GSimpleIOStream wrapping @input_stream and @output_stream. See also #GIOStream. - a new #GSimpleIOStream instance. + a new #GSimpleIOStream instance. - a #GInputStream. + a #GInputStream. - a #GOutputStream. + a #GOutputStream. @@ -63244,29 +66912,29 @@ See also #GIOStream. - #GSimplePermission is a trivial implementation of #GPermission that + #GSimplePermission is a trivial implementation of #GPermission that represents a permission that is either always or never allowed. The value is given at construction and doesn't change. Calling request or release will result in errors. - Creates a new #GPermission instance that represents an action that is + Creates a new #GPermission instance that represents an action that is either always or never allowed. - the #GSimplePermission, as a #GPermission + the #GSimplePermission, as a #GPermission - %TRUE if the action is allowed + %TRUE if the action is allowed - #GSimpleProxyResolver is a simple #GProxyResolver implementation + #GSimpleProxyResolver is a simple #GProxyResolver implementation that handles a single default proxy, multiple URI-scheme-specific proxies, and a list of hosts that proxies should not be used for. @@ -63277,30 +66945,30 @@ with g_socket_client_set_proxy_resolver(). - Creates a new #GSimpleProxyResolver. See + Creates a new #GSimpleProxyResolver. See #GSimpleProxyResolver:default-proxy and #GSimpleProxyResolver:ignore-hosts for more details on how the arguments are interpreted. - a new #GSimpleProxyResolver + a new #GSimpleProxyResolver - the default proxy to use, eg + the default proxy to use, eg "socks://192.168.1.1" - an optional list of hosts/IP addresses + an optional list of hosts/IP addresses to not use a proxy for. - Sets the default proxy on @resolver, to be used for any URIs that + Sets the default proxy on @resolver, to be used for any URIs that don't match #GSimpleProxyResolver:ignore-hosts or a proxy set via g_simple_proxy_resolver_set_uri_proxy(). @@ -63313,17 +66981,17 @@ the socks5, socks4a, and socks4 proxy types. - a #GSimpleProxyResolver + a #GSimpleProxyResolver - the default proxy to use + the default proxy to use - Sets the list of ignored hosts. + Sets the list of ignored hosts. See #GSimpleProxyResolver:ignore-hosts for more details on how the @ignore_hosts argument is interpreted. @@ -63333,18 +67001,18 @@ See #GSimpleProxyResolver:ignore-hosts for more details on how the - a #GSimpleProxyResolver + a #GSimpleProxyResolver - %NULL-terminated list of hosts/IP addresses + %NULL-terminated list of hosts/IP addresses to not use a proxy for - Adds a URI-scheme-specific proxy to @resolver; URIs whose scheme + Adds a URI-scheme-specific proxy to @resolver; URIs whose scheme matches @uri_scheme (and which don't match #GSimpleProxyResolver:ignore-hosts) will be proxied via @proxy. @@ -63358,21 +67026,21 @@ types. - a #GSimpleProxyResolver + a #GSimpleProxyResolver - the URI scheme to add a proxy for + the URI scheme to add a proxy for - the proxy to use for @uri_scheme + the proxy to use for @uri_scheme - The default proxy URI that will be used for any URI that doesn't + The default proxy URI that will be used for any URI that doesn't match #GSimpleProxyResolver:ignore-hosts, and doesn't match any of the schemes set with g_simple_proxy_resolver_set_uri_proxy(). @@ -63382,7 +67050,7 @@ to all three of the socks5, socks4a, and socks4 proxy types. - A list of hostnames and IP addresses that the resolver should + A list of hostnames and IP addresses that the resolver should allow direct connections to. Entries can be in one of 4 formats: @@ -63477,7 +67145,7 @@ commonly used by other applications. - A #GSocket is a low-level networking primitive. It is a more or less + A #GSocket is a low-level networking primitive. It is a more or less direct mapping of the BSD socket API in a portable GObject based API. It supports both the UNIX socket implementations and winsock2 on Windows. @@ -63532,7 +67200,7 @@ locking. - Creates a new #GSocket with the defined family, type and protocol. + Creates a new #GSocket with the defined family, type and protocol. If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type for the family and type is used. @@ -63547,27 +67215,27 @@ system, so you can use protocols not listed in #GSocketProtocol if you know the protocol number used for it. - a #GSocket or %NULL on error. + a #GSocket or %NULL on error. Free the returned object with g_object_unref(). - the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4. + the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4. - the socket type to use. + the socket type to use. - the id of the protocol to use, or 0 for default. + the id of the protocol to use, or 0 for default. - Creates a new #GSocket from a native file descriptor + Creates a new #GSocket from a native file descriptor or winsock SOCKET handle. This reads all the settings from the file descriptor so that @@ -63582,19 +67250,19 @@ Since GLib 2.46, it is no longer a fatal error to call this on a non-socket descriptor. Instead, a GError will be set with code %G_IO_ERROR_FAILED - a #GSocket or %NULL on error. + a #GSocket or %NULL on error. Free the returned object with g_object_unref(). - a native socket file descriptor. + a native socket file descriptor. - Accept incoming connections on a connection-based socket. This removes + Accept incoming connections on a connection-based socket. This removes the first outstanding connection request from the listening socket and creates a #GSocket object for it. @@ -63606,23 +67274,23 @@ or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled. To be notified of an incoming connection, wait for the %G_IO_IN condition. - a new #GSocket, or %NULL on error. + a new #GSocket, or %NULL on error. Free the returned object with g_object_unref(). - a #GSocket. + a #GSocket. - a %GCancellable or %NULL + a %GCancellable or %NULL - When a socket is created it is attached to an address family, but it + When a socket is created it is attached to an address family, but it doesn't have an address in this family. g_socket_bind() assigns the address (sometimes called name) of the socket. @@ -63647,42 +67315,42 @@ broadcast packets sent to that address. (The behavior of unicast UDP packets to an address with multiple listeners is not defined.) - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocket. + a #GSocket. - a #GSocketAddress specifying the local address. + a #GSocketAddress specifying the local address. - whether to allow reusing this address + whether to allow reusing this address - Checks and resets the pending connect error for the socket. + Checks and resets the pending connect error for the socket. This is used to check for errors when g_socket_connect() is used in non-blocking mode. - %TRUE if no error, %FALSE otherwise, setting @error to the error + %TRUE if no error, %FALSE otherwise, setting @error to the error - a #GSocket + a #GSocket - Closes the socket, shutting down any active connection. + Closes the socket, shutting down any active connection. Closing a socket does not wait for all outstanding I/O operations to finish, so the caller should not rely on them to be guaranteed @@ -63713,18 +67381,18 @@ only works if the client will close its connection after the server does.) - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - a #GSocket + a #GSocket - Checks on the readiness of @socket to perform operations. + Checks on the readiness of @socket to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @socket. The result is returned. @@ -63743,22 +67411,22 @@ these conditions will always be set in the output if they are true. This call never blocks. - the @GIOCondition mask of the current state + the @GIOCondition mask of the current state - a #GSocket + a #GSocket - a #GIOCondition mask to check + a #GIOCondition mask to check - Waits for up to @timeout_us microseconds for @condition to become true + Waits for up to @timeout_us microseconds for @condition to become true on @socket. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @@ -63776,30 +67444,30 @@ resolution, and the behavior is undefined if @timeout_us is not an exact number of milliseconds. - %TRUE if the condition was met, %FALSE otherwise + %TRUE if the condition was met, %FALSE otherwise - a #GSocket + a #GSocket - a #GIOCondition mask to wait for + a #GIOCondition mask to wait for - the maximum time (in microseconds) to wait, or -1 + the maximum time (in microseconds) to wait, or -1 - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Waits for @condition to become true on @socket. When the condition + Waits for @condition to become true on @socket. When the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if the @@ -63811,26 +67479,26 @@ the appropriate value (%G_IO_ERROR_CANCELLED or See also g_socket_condition_timed_wait(). - %TRUE if the condition was met, %FALSE otherwise + %TRUE if the condition was met, %FALSE otherwise - a #GSocket + a #GSocket - a #GIOCondition mask to wait for + a #GIOCondition mask to wait for - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Connect the socket to the specified remote address. + Connect the socket to the specified remote address. For connection oriented socket this generally means we attempt to make a connection to the @address. For a connection-less socket it sets @@ -63848,41 +67516,41 @@ for the G_IO_OUT condition. The result of the connection must then be checked with g_socket_check_connect_result(). - %TRUE if connected, %FALSE on error. + %TRUE if connected, %FALSE on error. - a #GSocket. + a #GSocket. - a #GSocketAddress specifying the remote address. + a #GSocketAddress specifying the remote address. - a %GCancellable or %NULL + a %GCancellable or %NULL - Creates a #GSocketConnection subclass of the right type for + Creates a #GSocketConnection subclass of the right type for @socket. - a #GSocketConnection + a #GSocketConnection - a #GSocket + a #GSocket - Creates a #GSource that can be attached to a %GMainContext to monitor + 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. @@ -63904,26 +67572,26 @@ marked as having had a timeout, and so the next #GSocket I/O method you call will then fail with a %G_IO_ERROR_TIMED_OUT. - a newly allocated %GSource, free with g_source_unref(). + a newly allocated %GSource, free with g_source_unref(). - a #GSocket + a #GSocket - a #GIOCondition mask to monitor + a #GIOCondition mask to monitor - a %GCancellable or %NULL + a %GCancellable or %NULL - Get the amount of data pending in the OS input buffer, without blocking. + Get the amount of data pending in the OS input buffer, without blocking. If @socket is a UDP or SCTP socket, this will return the size of just the next packet, even if additional packets are buffered after @@ -63937,50 +67605,50 @@ g_socket_get_available_bytes() first and then doing a receive of exactly the right size. - the number of bytes that can be read from the socket + the number of bytes that can be read from the socket without blocking or truncating, or -1 on error. - a #GSocket + a #GSocket - Gets the blocking mode of the socket. For details on blocking I/O, + Gets the blocking mode of the socket. For details on blocking I/O, see g_socket_set_blocking(). - %TRUE if blocking I/O is used, %FALSE otherwise. + %TRUE if blocking I/O is used, %FALSE otherwise. - a #GSocket. + a #GSocket. - Gets the broadcast setting on @socket; if %TRUE, + Gets the broadcast setting on @socket; if %TRUE, it is possible to send packets to broadcast addresses. - the broadcast setting on @socket + the broadcast setting on @socket - a #GSocket. + a #GSocket. - Returns the credentials of the foreign process connected to this + Returns the credentials of the foreign process connected to this socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX sockets). @@ -63988,135 +67656,142 @@ If this operation isn't supported on the OS, the method fails with the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented by reading the %SO_PEERCRED option on the underlying socket. +This method can be expected to be available on the following platforms: + +- Linux since GLib 2.26 +- OpenBSD since GLib 2.30 +- Solaris, Illumos and OpenSolaris since GLib 2.40 +- NetBSD since GLib 2.42 + Other ways to obtain credentials from a foreign peer includes the #GUnixCredentialsMessage type and g_unix_connection_send_credentials() / g_unix_connection_receive_credentials() functions. - %NULL if @error is set, otherwise a #GCredentials object + %NULL if @error is set, otherwise a #GCredentials object that must be freed with g_object_unref(). - a #GSocket. + a #GSocket. - Gets the socket family of the socket. + Gets the socket family of the socket. - a #GSocketFamily + a #GSocketFamily - a #GSocket. + a #GSocket. - Returns the underlying OS socket object. On unix this + Returns the underlying OS socket object. On unix this is a socket file descriptor, and on Windows this is a Winsock2 SOCKET handle. This may be useful for doing platform specific or otherwise unusual operations on the socket. - the file descriptor of the socket. + the file descriptor of the socket. - a #GSocket. + a #GSocket. - Gets the keepalive mode of the socket. For details on this, + Gets the keepalive mode of the socket. For details on this, see g_socket_set_keepalive(). - %TRUE if keepalive is active, %FALSE otherwise. + %TRUE if keepalive is active, %FALSE otherwise. - a #GSocket. + a #GSocket. - Gets the listen backlog setting of the socket. For details on this, + Gets the listen backlog setting of the socket. For details on this, see g_socket_set_listen_backlog(). - the maximum number of pending connections. + the maximum number of pending connections. - a #GSocket. + a #GSocket. - Try to get the local address of a bound socket. This is only + Try to get the local address of a bound socket. This is only useful if the socket has been bound to a local address, either explicitly or implicitly when connecting. - a #GSocketAddress or %NULL on error. + a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). - a #GSocket. + a #GSocket. - Gets the multicast loopback setting on @socket; if %TRUE (the + Gets the multicast loopback setting on @socket; if %TRUE (the default), outgoing multicast packets will be looped back to multicast listeners on the same host. - the multicast loopback setting on @socket + the multicast loopback setting on @socket - a #GSocket. + a #GSocket. - Gets the multicast time-to-live setting on @socket; see + Gets the multicast time-to-live setting on @socket; see g_socket_set_multicast_ttl() for more details. - the multicast time-to-live setting on @socket + the multicast time-to-live setting on @socket - a #GSocket. + a #GSocket. - Gets the value of an integer-valued option on @socket, as with + Gets the value of an integer-valued option on @socket, as with getsockopt(). (If you need to fetch a non-integer-valued option, you will need to call getsockopt() directly.) @@ -64131,121 +67806,121 @@ Note that even for socket options that are a single byte in size, g_socket_get_option() will handle the conversion internally. - success or failure. On failure, @error will be set, and + success or failure. On failure, @error will be set, and the system error value (`errno` or WSAGetLastError()) will still be set to the result of the getsockopt() call. - a #GSocket + a #GSocket - the "API level" of the option (eg, `SOL_SOCKET`) + the "API level" of the option (eg, `SOL_SOCKET`) - the "name" of the option (eg, `SO_BROADCAST`) + the "name" of the option (eg, `SO_BROADCAST`) - return location for the option value + return location for the option value - Gets the socket protocol id the socket was created with. + Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned. - a protocol id, or -1 if unknown + a protocol id, or -1 if unknown - a #GSocket. + a #GSocket. - Try to get the remote address of a connected socket. This is only + Try to get the remote address of a connected socket. This is only useful for connection oriented sockets that have been connected. - a #GSocketAddress or %NULL on error. + a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). - a #GSocket. + a #GSocket. - Gets the socket type of the socket. + Gets the socket type of the socket. - a #GSocketType + a #GSocketType - a #GSocket. + a #GSocket. - Gets the timeout setting of the socket. For details on this, see + Gets the timeout setting of the socket. For details on this, see g_socket_set_timeout(). - the timeout in seconds + the timeout in seconds - a #GSocket. + a #GSocket. - Gets the unicast time-to-live setting on @socket; see + Gets the unicast time-to-live setting on @socket; see g_socket_set_ttl() for more details. - the time-to-live setting on @socket + the time-to-live setting on @socket - a #GSocket. + a #GSocket. - Checks whether a socket is closed. + Checks whether a socket is closed. - %TRUE if socket is closed, %FALSE otherwise + %TRUE if socket is closed, %FALSE otherwise - a #GSocket + a #GSocket - Check whether the socket is connected. This is only useful for + Check whether the socket is connected. This is only useful for connection-oriented sockets. If using g_socket_shutdown(), this function will return %TRUE until the @@ -64254,18 +67929,18 @@ connect, this function will not return %TRUE until after you call g_socket_check_connect_result(). - %TRUE if socket is connected, %FALSE otherwise. + %TRUE if socket is connected, %FALSE otherwise. - a #GSocket. + a #GSocket. - Registers @socket to receive multicast messages sent to @group. + Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind(). @@ -64281,30 +67956,30 @@ To bind to a given source-specific multicast address, use g_socket_join_multicast_group_ssm() instead. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocket. + a #GSocket. - a #GInetAddress specifying the group address to join. + a #GInetAddress specifying the group address to join. - %TRUE if source-specific multicast should be used + %TRUE if source-specific multicast should be used - Name of the interface to use, or %NULL + Name of the interface to use, or %NULL - Registers @socket to receive multicast messages sent to @group. + Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind(). @@ -64321,31 +67996,31 @@ Note that this function can be called multiple times for the same packets from more than one source. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocket. + a #GSocket. - a #GInetAddress specifying the group address to join. + a #GInetAddress specifying the group address to join. - a #GInetAddress specifying the + a #GInetAddress specifying the source-specific multicast address or %NULL to ignore. - Name of the interface to use, or %NULL + Name of the interface to use, or %NULL - Removes @socket from the multicast group defined by @group, @iface, + Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group). @@ -64356,30 +68031,30 @@ To unbind to a given source-specific multicast address, use g_socket_leave_multicast_group_ssm() instead. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocket. + a #GSocket. - a #GInetAddress specifying the group address to leave. + a #GInetAddress specifying the group address to leave. - %TRUE if source-specific multicast was used + %TRUE if source-specific multicast was used - Interface used + Interface used - Removes @socket from the multicast group defined by @group, @iface, + Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group). @@ -64387,31 +68062,31 @@ when you joined the group). unicast messages after calling this. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocket. + a #GSocket. - a #GInetAddress specifying the group address to leave. + a #GInetAddress specifying the group address to leave. - a #GInetAddress specifying the + a #GInetAddress specifying the source-specific multicast address or %NULL to ignore. - Name of the interface to use, or %NULL + Name of the interface to use, or %NULL - Marks the socket as a server socket, i.e. a socket that is used + Marks the socket as a server socket, i.e. a socket that is used to accept incoming requests using g_socket_accept(). Before calling this the socket must be bound to a local address using @@ -64421,18 +68096,18 @@ To set the maximum amount of outstanding clients, use g_socket_set_listen_backlog(). - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocket. + a #GSocket. - Receive data (up to @size bytes) from a socket. This is mainly used by + Receive data (up to @size bytes) from a socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_receive_from() with @address set to %NULL. @@ -64457,34 +68132,34 @@ returned. To be notified when data is available, wait for the On error -1 is returned and @error is set accordingly. - Number of bytes read, or 0 if the connection was closed by + Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error - a #GSocket + a #GSocket - a buffer to + a buffer to read data into (which should be at least @size bytes long). - the number of bytes you want to read from the socket + the number of bytes you want to read from the socket - a %GCancellable or %NULL + a %GCancellable or %NULL - Receive data (up to @size bytes) from a socket. + Receive data (up to @size bytes) from a socket. If @address is non-%NULL then @address will be set equal to the source address of the received packet. @@ -64493,39 +68168,39 @@ source address of the received packet. See g_socket_receive() for additional information. - Number of bytes read, or 0 if the connection was closed by + Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error - a #GSocket + a #GSocket - a pointer to a #GSocketAddress + a pointer to a #GSocketAddress pointer, or %NULL - a buffer to + a buffer to read data into (which should be at least @size bytes long). - the number of bytes you want to read from the socket + the number of bytes you want to read from the socket - a %GCancellable or %NULL + a %GCancellable or %NULL - Receive data from a socket. For receiving multiple messages, see + Receive data from a socket. For receiving multiple messages, see g_socket_receive_messages(); for easier use, see g_socket_receive() and g_socket_receive_from(). @@ -64586,54 +68261,56 @@ returned. To be notified when data is available, wait for the On error -1 is returned and @error is set accordingly. - Number of bytes read, or 0 if the connection was closed by + Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error - a #GSocket + a #GSocket - a pointer to a #GSocketAddress + a pointer to a #GSocketAddress pointer, or %NULL - an array of #GInputVector structs + an array of #GInputVector structs - the number of elements in @vectors, or -1 + the number of elements in @vectors, or -1 - a pointer + a pointer which may be filled with an array of #GSocketControlMessages, or %NULL - a pointer which will be filled with the number of + a pointer which will be filled with the number of elements in @messages, or %NULL - a pointer to an int containing #GSocketMsgFlags flags + a pointer to an int containing #GSocketMsgFlags flags, + which may additionally contain + [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) - a %GCancellable or %NULL + a %GCancellable or %NULL - Receive multiple data messages from @socket in one go. This is the most + Receive multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_receive(), g_socket_receive_from(), and g_socket_receive_message(). @@ -64683,7 +68360,7 @@ be returned if zero messages could be received; otherwise the number of messages successfully received before the error will be returned. - number of messages received, or -1 on error. Note that the number + number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if in non-blocking mode, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -64692,67 +68369,69 @@ messages successfully received before the error will be returned. - a #GSocket + a #GSocket - an array of #GInputMessage structs + an array of #GInputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags for the overall operation + an int containing #GSocketMsgFlags flags for the overall operation, + which may additionally contain + [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) - a %GCancellable or %NULL + a %GCancellable or %NULL - This behaves exactly the same as g_socket_receive(), except that + This behaves exactly the same as g_socket_receive(), except that the choice of blocking or non-blocking behavior is determined by the @blocking argument rather than by @socket's properties. - Number of bytes read, or 0 if the connection was closed by + Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error - a #GSocket + a #GSocket - a buffer to + a buffer to read data into (which should be at least @size bytes long). - the number of bytes you want to read from the socket + the number of bytes you want to read from the socket - whether to do blocking or non-blocking I/O + whether to do blocking or non-blocking I/O - a %GCancellable or %NULL + a %GCancellable or %NULL - Tries to send @size bytes from @buffer on the socket. This is + Tries to send @size bytes from @buffer on the socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_send_to() with @address set to %NULL. @@ -64768,34 +68447,34 @@ very common due to the way the underlying APIs work.) On error -1 is returned and @error is set accordingly. - Number of bytes written (which may be less than @size), or -1 + Number of bytes written (which may be less than @size), or -1 on error - a #GSocket + a #GSocket - the buffer + the buffer containing the data to send. - the number of bytes to send + the number of bytes to send - a %GCancellable or %NULL + a %GCancellable or %NULL - Send data to @address on @socket. For sending multiple messages see + Send data to @address on @socket. For sending multiple messages see g_socket_send_messages(); for easier use, see g_socket_send() and g_socket_send_to(). @@ -64834,52 +68513,53 @@ very common due to the way the underlying APIs work.) On error -1 is returned and @error is set accordingly. - Number of bytes written (which may be less than @size), or -1 + Number of bytes written (which may be less than @size), or -1 on error - a #GSocket + a #GSocket - a #GSocketAddress, or %NULL + a #GSocketAddress, or %NULL - an array of #GOutputVector structs + an array of #GOutputVector structs - the number of elements in @vectors, or -1 + the number of elements in @vectors, or -1 - a pointer to an + a pointer to an array of #GSocketControlMessages, or %NULL. - number of elements in @messages, or -1. + number of elements in @messages, or -1. - an int containing #GSocketMsgFlags flags + an int containing #GSocketMsgFlags flags, which may additionally + contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) - a %GCancellable or %NULL + a %GCancellable or %NULL - This behaves exactly the same as g_socket_send_message(), except that + This behaves exactly the same as g_socket_send_message(), except that the choice of timeout behavior is determined by the @timeout_us argument rather than by @socket's properties. @@ -64888,61 +68568,62 @@ if the socket is currently not writable %G_POLLABLE_RETURN_WOULD_BLOCK is returned. @bytes_written will contain 0 in both cases. - %G_POLLABLE_RETURN_OK if all data was successfully written, + %G_POLLABLE_RETURN_OK if all data was successfully written, %G_POLLABLE_RETURN_WOULD_BLOCK if the socket is currently not writable, or %G_POLLABLE_RETURN_FAILED if an error happened and @error is set. - a #GSocket + a #GSocket - a #GSocketAddress, or %NULL + a #GSocketAddress, or %NULL - an array of #GOutputVector structs + an array of #GOutputVector structs - the number of elements in @vectors, or -1 + the number of elements in @vectors, or -1 - a pointer to an + a pointer to an array of #GSocketControlMessages, or %NULL. - number of elements in @messages, or -1. + number of elements in @messages, or -1. - an int containing #GSocketMsgFlags flags + an int containing #GSocketMsgFlags flags, which may additionally + contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) - the maximum time (in microseconds) to wait, or -1 + the maximum time (in microseconds) to wait, or -1 - location to store the number of bytes that were written to the socket + location to store the number of bytes that were written to the socket - a %GCancellable or %NULL + a %GCancellable or %NULL - Send multiple data messages from @socket in one go. This is the most + Send multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_send(), g_socket_send_to(), and g_socket_send_message(). @@ -64978,7 +68659,7 @@ be returned if zero messages could be sent; otherwise the number of messages successfully sent before the error will be returned. - number of messages sent, or -1 on error. Note that the number of + number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if the socket is non-blocking or if @num_messages was larger than UIO_MAXIOV (1024), in which case the caller may re-try to send the remaining messages. @@ -64986,105 +68667,106 @@ successfully sent before the error will be returned. - a #GSocket + a #GSocket - an array of #GOutputMessage structs + an array of #GOutputMessage structs - the number of elements in @messages + the number of elements in @messages - an int containing #GSocketMsgFlags flags + an int containing #GSocketMsgFlags flags, which may additionally + contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) - a %GCancellable or %NULL + a %GCancellable or %NULL - Tries to send @size bytes from @buffer to @address. If @address is + Tries to send @size bytes from @buffer to @address. If @address is %NULL then the message is sent to the default receiver (set by g_socket_connect()). See g_socket_send() for additional information. - Number of bytes written (which may be less than @size), or -1 + Number of bytes written (which may be less than @size), or -1 on error - a #GSocket + a #GSocket - a #GSocketAddress, or %NULL + a #GSocketAddress, or %NULL - the buffer + the buffer containing the data to send. - the number of bytes to send + the number of bytes to send - a %GCancellable or %NULL + a %GCancellable or %NULL - This behaves exactly the same as g_socket_send(), except that + This behaves exactly the same as g_socket_send(), except that the choice of blocking or non-blocking behavior is determined by the @blocking argument rather than by @socket's properties. - Number of bytes written (which may be less than @size), or -1 + Number of bytes written (which may be less than @size), or -1 on error - a #GSocket + a #GSocket - the buffer + the buffer containing the data to send. - the number of bytes to send + the number of bytes to send - whether to do blocking or non-blocking I/O + whether to do blocking or non-blocking I/O - a %GCancellable or %NULL + a %GCancellable or %NULL - Sets the blocking mode of the socket. In blocking mode + Sets the blocking mode of the socket. In blocking mode all operations (which don’t take an explicit blocking parameter) block until they succeed or there is an error. In non-blocking mode all functions return results immediately or @@ -65099,17 +68781,17 @@ is a GSocket level feature. - a #GSocket. + a #GSocket. - Whether to use blocking I/O or not. + Whether to use blocking I/O or not. - Sets whether @socket should allow sending to broadcast addresses. + Sets whether @socket should allow sending to broadcast addresses. This is %FALSE by default. @@ -65117,18 +68799,18 @@ This is %FALSE by default. - a #GSocket. + a #GSocket. - whether @socket should allow sending to broadcast + whether @socket should allow sending to broadcast addresses - Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When + Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When this flag is set on a socket, the system will attempt to verify that the remote socket endpoint is still present if a sufficiently long period of time passes with no data being exchanged. If the system is unable to @@ -65149,17 +68831,17 @@ garbage-collected if clients crash or become unreachable. - a #GSocket. + a #GSocket. - Value for the keepalive flag + Value for the keepalive flag - Sets the maximum number of outstanding connections allowed + Sets the maximum number of outstanding connections allowed when listening on this socket. If more clients than this are connecting to the socket and the application is not handling them on time then the new connections will be refused. @@ -65172,17 +68854,17 @@ effect if called after that. - a #GSocket. + a #GSocket. - the maximum number of pending connections. + the maximum number of pending connections. - Sets whether outgoing multicast packets will be received by sockets + Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is %TRUE by default. @@ -65191,18 +68873,18 @@ by default. - a #GSocket. + a #GSocket. - whether @socket should receive messages sent to its + whether @socket should receive messages sent to its multicast groups from the local host - Sets the time-to-live for outgoing multicast datagrams on @socket. + Sets the time-to-live for outgoing multicast datagrams on @socket. By default, this is 1, meaning that multicast packets will not leave the local network. @@ -65211,17 +68893,17 @@ the local network. - a #GSocket. + a #GSocket. - the time-to-live value for all multicast datagrams on @socket + the time-to-live value for all multicast datagrams on @socket - Sets the value of an integer-valued option on @socket, as with + Sets the value of an integer-valued option on @socket, as with setsockopt(). (If you need to set a non-integer-valued option, you will need to call setsockopt() directly.) @@ -65232,32 +68914,32 @@ platform-dependent options, you may need to include additional headers. - success or failure. On failure, @error will be set, and + success or failure. On failure, @error will be set, and the system error value (`errno` or WSAGetLastError()) will still be set to the result of the setsockopt() call. - a #GSocket + a #GSocket - the "API level" of the option (eg, `SOL_SOCKET`) + the "API level" of the option (eg, `SOL_SOCKET`) - the "name" of the option (eg, `SO_BROADCAST`) + the "name" of the option (eg, `SO_BROADCAST`) - the value to set the option to + the value to set the option to - Sets the time in seconds after which I/O operations on @socket will + Sets the time in seconds after which I/O operations on @socket will time out if they have not yet completed. On a blocking socket, this means that any blocking #GSocket @@ -65283,17 +68965,17 @@ cause the timeout to be reset. - a #GSocket. + a #GSocket. - the timeout for @socket, in seconds, or 0 for none + the timeout for @socket, in seconds, or 0 for none - Sets the time-to-live for outgoing unicast packets on @socket. + Sets the time-to-live for outgoing unicast packets on @socket. By default the platform-specific default value is used. @@ -65301,17 +68983,17 @@ By default the platform-specific default value is used. - a #GSocket. + a #GSocket. - the time-to-live value for all unicast packets on @socket + the time-to-live value for all unicast packets on @socket - Shut down part or all of a full-duplex connection. + Shut down part or all of a full-duplex connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. @@ -65327,26 +69009,26 @@ then wait for the other side to close the connection, thus ensuring that the other side saw all sent data. - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - a #GSocket + a #GSocket - whether to shut down the read side + whether to shut down the read side - whether to shut down the write side + whether to shut down the write side - Checks if a socket is capable of speaking IPv4. + Checks if a socket is capable of speaking IPv4. IPv4 sockets are capable of speaking IPv4. On some operating systems and under some combinations of circumstances IPv6 sockets are also @@ -65357,12 +69039,12 @@ No other types of sockets are currently considered as being capable of speaking IPv4. - %TRUE if this socket can be used with IPv4. + %TRUE if this socket can be used with IPv4. - a #GSocket + a #GSocket @@ -65371,7 +69053,7 @@ of speaking IPv4. - Whether the socket should allow sending to broadcast addresses. + Whether the socket should allow sending to broadcast addresses. @@ -65390,11 +69072,11 @@ of speaking IPv4. - Whether outgoing multicast packets loop back to the local host. + Whether outgoing multicast packets loop back to the local host. - Time-to-live out outgoing multicast packets + Time-to-live out outgoing multicast packets @@ -65404,11 +69086,11 @@ of speaking IPv4. - The timeout in seconds on socket I/O + The timeout in seconds on socket I/O - Time-to-live for outgoing unicast packets + Time-to-live for outgoing unicast packets @@ -65422,64 +69104,64 @@ of speaking IPv4. - #GSocketAddress is the equivalent of struct sockaddr in the BSD + #GSocketAddress is the equivalent of struct sockaddr in the BSD sockets API. This is an abstract class; use #GInetSocketAddress for internet sockets, or #GUnixSocketAddress for UNIX domain sockets. - Creates a #GSocketAddress subclass corresponding to the native + Creates a #GSocketAddress subclass corresponding to the native struct sockaddr @native. - a new #GSocketAddress if @native could successfully + a new #GSocketAddress if @native could successfully be converted, otherwise %NULL - a pointer to a struct sockaddr + a pointer to a struct sockaddr - the size of the memory location pointed to by @native + the size of the memory location pointed to by @native - Gets the socket family type of @address. + Gets the socket family type of @address. - the socket family type of @address + the socket family type of @address - a #GSocketAddress + a #GSocketAddress - Gets the size of @address's native struct sockaddr. + Gets the size of @address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native(). - the size of the native struct sockaddr that + the size of the native struct sockaddr that @address represents - a #GSocketAddress + a #GSocketAddress - Converts a #GSocketAddress to a native struct sockaddr, which can + Converts a #GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). If not enough space is available, a %G_IO_ERROR_NO_SPACE error @@ -65487,59 +69169,59 @@ is returned. If the address type is not known on the system then a %G_IO_ERROR_NOT_SUPPORTED error is returned. - %TRUE if @dest was filled in, %FALSE on error + %TRUE if @dest was filled in, %FALSE on error - a #GSocketAddress + a #GSocketAddress - a pointer to a memory location that will contain the native + a pointer to a memory location that will contain the native struct sockaddr - the size of @dest. Must be at least as large as + the size of @dest. Must be at least as large as g_socket_address_get_native_size() - Gets the socket family type of @address. + Gets the socket family type of @address. - the socket family type of @address + the socket family type of @address - a #GSocketAddress + a #GSocketAddress - Gets the size of @address's native struct sockaddr. + Gets the size of @address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native(). - the size of the native struct sockaddr that + the size of the native struct sockaddr that @address represents - a #GSocketAddress + a #GSocketAddress - Converts a #GSocketAddress to a native struct sockaddr, which can + Converts a #GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). If not enough space is available, a %G_IO_ERROR_NO_SPACE error @@ -65547,21 +69229,21 @@ is returned. If the address type is not known on the system then a %G_IO_ERROR_NOT_SUPPORTED error is returned. - %TRUE if @dest was filled in, %FALSE on error + %TRUE if @dest was filled in, %FALSE on error - a #GSocketAddress + a #GSocketAddress - a pointer to a memory location that will contain the native + a pointer to a memory location that will contain the native struct sockaddr - the size of @dest. Must be at least as large as + the size of @dest. Must be at least as large as g_socket_address_get_native_size() @@ -65583,12 +69265,12 @@ struct sockaddr - the socket family type of @address + the socket family type of @address - a #GSocketAddress + a #GSocketAddress @@ -65598,13 +69280,13 @@ struct sockaddr - the size of the native struct sockaddr that + the size of the native struct sockaddr that @address represents - a #GSocketAddress + a #GSocketAddress @@ -65614,21 +69296,21 @@ struct sockaddr - %TRUE if @dest was filled in, %FALSE on error + %TRUE if @dest was filled in, %FALSE on error - a #GSocketAddress + a #GSocketAddress - a pointer to a memory location that will contain the native + a pointer to a memory location that will contain the native struct sockaddr - the size of @dest. Must be at least as large as + the size of @dest. Must be at least as large as g_socket_address_get_native_size() @@ -65637,10 +69319,10 @@ struct sockaddr - #GSocketAddressEnumerator is an enumerator type for #GSocketAddress + #GSocketAddressEnumerator is an enumerator type for #GSocketAddress instances. It is returned by enumeration functions such as g_socket_connectable_enumerate(), which returns a #GSocketAddressEnumerator -to list all the #GSocketAddresses which could be used to connect to that +to list each #GSocketAddress which could be used to connect to that #GSocketConnectable. Enumeration is typically a blocking operation, so the asynchronous methods @@ -65653,7 +69335,7 @@ enumeration with that #GSocketAddressEnumerator is not possible, and it can be unreffed. - Retrieves the next #GSocketAddress from @enumerator. Note that this + Retrieves the next #GSocketAddress from @enumerator. Note that this may block for some amount of time. (Eg, a #GNetworkAddress may need to do a DNS lookup before it can return an address.) Use g_socket_address_enumerator_next_async() if you need to avoid @@ -65668,24 +69350,24 @@ internal errors (other than @cancellable being triggered) will be ignored. - a #GSocketAddress (owned by the caller), or %NULL on + a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Asynchronously retrieves the next #GSocketAddress from @enumerator + Asynchronously retrieves the next #GSocketAddress from @enumerator and then calls @callback, which must call g_socket_address_enumerator_next_finish() to get the result. @@ -65696,49 +69378,49 @@ It is an error to call this multiple times before the previous callback has fini - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Retrieves the result of a completed call to + Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling. - a #GSocketAddress (owned by the caller), or %NULL on + a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - a #GAsyncResult + a #GAsyncResult - Retrieves the next #GSocketAddress from @enumerator. Note that this + Retrieves the next #GSocketAddress from @enumerator. Note that this may block for some amount of time. (Eg, a #GNetworkAddress may need to do a DNS lookup before it can return an address.) Use g_socket_address_enumerator_next_async() if you need to avoid @@ -65753,24 +69435,24 @@ internal errors (other than @cancellable being triggered) will be ignored. - a #GSocketAddress (owned by the caller), or %NULL on + a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Asynchronously retrieves the next #GSocketAddress from @enumerator + Asynchronously retrieves the next #GSocketAddress from @enumerator and then calls @callback, which must call g_socket_address_enumerator_next_finish() to get the result. @@ -65781,43 +69463,43 @@ It is an error to call this multiple times before the previous callback has fini - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Retrieves the result of a completed call to + Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling. - a #GSocketAddress (owned by the caller), or %NULL on + a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - a #GAsyncResult + a #GAsyncResult @@ -65836,18 +69518,18 @@ error handling. - a #GSocketAddress (owned by the caller), or %NULL on + a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -65861,20 +69543,20 @@ error handling. - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function @@ -65884,18 +69566,18 @@ error handling. - a #GSocketAddress (owned by the caller), or %NULL on + a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. - a #GSocketAddressEnumerator + a #GSocketAddressEnumerator - a #GAsyncResult + a #GAsyncResult @@ -65989,7 +69671,7 @@ error handling. - #GSocketClient is a lightweight high-level utility class for connecting to + #GSocketClient is a lightweight high-level utility class for connecting to a network host using a connection oriented socket type. You create a #GSocketClient object, set any options you want, and then @@ -66004,10 +69686,10 @@ As #GSocketClient is a lightweight object, you don't need to cache it. You can just create a new one any time you need one. - Creates a new #GSocketClient with the default options. + Creates a new #GSocketClient with the default options. - a #GSocketClient. + a #GSocketClient. Free the returned object with g_object_unref(). @@ -66033,7 +69715,7 @@ can just create a new one any time you need one. - Enable proxy protocols to be handled by the application. When the + Enable proxy protocols to be handled by the application. When the indicated proxy protocol is returned by the #GProxyResolver, #GSocketClient will consider this protocol as supported but will not try to find a #GProxy instance to handle handshaking. The @@ -66058,17 +69740,17 @@ specific handshake. - a #GSocketClient + a #GSocketClient - The proxy protocol + The proxy protocol - Tries to resolve the @connectable and make a network connection to it. + Tries to resolve the @connectable and make a network connection to it. Upon a successful connection, a new #GSocketConnection is constructed and returned. The caller owns this new object and must drop their @@ -66088,26 +69770,26 @@ If a local address is specified with g_socket_client_set_local_address() the socket will be bound to this address before connecting. - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketClient. + a #GSocketClient. - a #GSocketConnectable specifying the remote address. + a #GSocketConnectable specifying the remote address. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - This is the asynchronous version of g_socket_client_connect(). + This is the asynchronous version of g_socket_client_connect(). When the operation is finished @callback will be called. You can then call g_socket_client_connect_finish() to get @@ -66118,47 +69800,47 @@ the result of the operation. - a #GSocketClient + a #GSocketClient - a #GSocketConnectable specifying the remote address. + a #GSocketConnectable specifying the remote address. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data for the callback + user data for the callback - Finishes an async connect operation. See g_socket_client_connect_async() + Finishes an async connect operation. See g_socket_client_connect_async() - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketClient. + a #GSocketClient. - a #GAsyncResult. + a #GAsyncResult. - This is a helper function for g_socket_client_connect(). + This is a helper function for g_socket_client_connect(). Attempts to create a TCP connection to the named host. @@ -66190,30 +69872,30 @@ connectable) %NULL is returned and @error (if non-%NULL) is set accordingly. - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketClient + a #GSocketClient - the name and optionally port of the host to connect to + the name and optionally port of the host to connect to - the default port to connect to + the default port to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - This is the asynchronous version of g_socket_client_connect_to_host(). + This is the asynchronous version of g_socket_client_connect_to_host(). When the operation is finished @callback will be called. You can then call g_socket_client_connect_to_host_finish() to get @@ -66224,51 +69906,51 @@ the result of the operation. - a #GSocketClient + a #GSocketClient - the name and optionally the port of the host to connect to + the name and optionally the port of the host to connect to - the default port to connect to + the default port to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data for the callback + user data for the callback - Finishes an async connect operation. See g_socket_client_connect_to_host_async() + Finishes an async connect operation. See g_socket_client_connect_to_host_async() - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketClient. + a #GSocketClient. - a #GAsyncResult. + a #GAsyncResult. - Attempts to create a TCP connection to a service. + Attempts to create a TCP connection to a service. This call looks up the SRV record for @service at @domain for the "tcp" protocol. It then attempts to connect, in turn, to each of @@ -66284,30 +69966,30 @@ connectable) %NULL is returned and @error (if non-%NULL) is set accordingly. - a #GSocketConnection if successful, or %NULL on error + a #GSocketConnection if successful, or %NULL on error - a #GSocketConnection + a #GSocketConnection - a domain name + a domain name - the name of the service to connect to + the name of the service to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - This is the asynchronous version of + This is the asynchronous version of g_socket_client_connect_to_service(). @@ -66315,51 +69997,51 @@ g_socket_client_connect_to_service(). - a #GSocketClient + a #GSocketClient - a domain name + a domain name - the name of the service to connect to + the name of the service to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data for the callback + user data for the callback - Finishes an async connect operation. See g_socket_client_connect_to_service_async() + Finishes an async connect operation. See g_socket_client_connect_to_service_async() - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketClient. + a #GSocketClient. - a #GAsyncResult. + a #GAsyncResult. - This is a helper function for g_socket_client_connect(). + This is a helper function for g_socket_client_connect(). Attempts to create a TCP connection with a network URI. @@ -66382,30 +70064,30 @@ connectable) %NULL is returned and @error (if non-%NULL) is set accordingly. - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketClient + a #GSocketClient - A network URI + A network URI - the default port to connect to + the default port to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - This is the asynchronous version of g_socket_client_connect_to_uri(). + This is the asynchronous version of g_socket_client_connect_to_uri(). When the operation is finished @callback will be called. You can then call g_socket_client_connect_to_uri_finish() to get @@ -66416,192 +70098,192 @@ the result of the operation. - a #GSocketClient + a #GSocketClient - a network uri + a network uri - the default port to connect to + the default port to connect to - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data for the callback + user data for the callback - Finishes an async connect operation. See g_socket_client_connect_to_uri_async() + Finishes an async connect operation. See g_socket_client_connect_to_uri_async() - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketClient. + a #GSocketClient. - a #GAsyncResult. + a #GAsyncResult. - Gets the proxy enable state; see g_socket_client_set_enable_proxy() + Gets the proxy enable state; see g_socket_client_set_enable_proxy() - whether proxying is enabled + whether proxying is enabled - a #GSocketClient. + a #GSocketClient. - Gets the socket family of the socket client. + Gets the socket family of the socket client. See g_socket_client_set_family() for details. - a #GSocketFamily + a #GSocketFamily - a #GSocketClient. + a #GSocketClient. - Gets the local address of the socket client. + Gets the local address of the socket client. See g_socket_client_set_local_address() for details. - a #GSocketAddress or %NULL. Do not free. + a #GSocketAddress or %NULL. Do not free. - a #GSocketClient. + a #GSocketClient. - Gets the protocol name type of the socket client. + Gets the protocol name type of the socket client. See g_socket_client_set_protocol() for details. - a #GSocketProtocol + a #GSocketProtocol - a #GSocketClient + a #GSocketClient - Gets the #GProxyResolver being used by @client. Normally, this will + Gets the #GProxyResolver being used by @client. Normally, this will be the resolver returned by g_proxy_resolver_get_default(), but you can override it with g_socket_client_set_proxy_resolver(). - The #GProxyResolver being used by + The #GProxyResolver being used by @client. - a #GSocketClient. + a #GSocketClient. - Gets the socket type of the socket client. + Gets the socket type of the socket client. See g_socket_client_set_socket_type() for details. - a #GSocketFamily + a #GSocketFamily - a #GSocketClient. + a #GSocketClient. - Gets the I/O timeout time for sockets created by @client. + Gets the I/O timeout time for sockets created by @client. See g_socket_client_set_timeout() for details. - the timeout in seconds + the timeout in seconds - a #GSocketClient + a #GSocketClient - Gets whether @client creates TLS connections. See + Gets whether @client creates TLS connections. See g_socket_client_set_tls() for details. - whether @client uses TLS + whether @client uses TLS - a #GSocketClient. + a #GSocketClient. - Gets the TLS validation flags used creating TLS connections via + Gets the TLS validation flags used creating TLS connections via @client. - the TLS validation flags + the TLS validation flags - a #GSocketClient. + a #GSocketClient. - Sets whether or not @client attempts to make connections via a + Sets whether or not @client attempts to make connections via a proxy server. When enabled (the default), #GSocketClient will use a #GProxyResolver to determine if a proxy protocol such as SOCKS is needed, and automatically do the necessary proxy negotiation. @@ -66613,17 +70295,17 @@ See also g_socket_client_set_proxy_resolver(). - a #GSocketClient. + a #GSocketClient. - whether to enable proxies + whether to enable proxies - Sets the socket family of the socket client. + Sets the socket family of the socket client. If this is set to something other than %G_SOCKET_FAMILY_INVALID then the sockets created by this object will be of the specified family. @@ -66637,17 +70319,17 @@ be an ipv6 mapped to ipv4 address. - a #GSocketClient. + a #GSocketClient. - a #GSocketFamily + a #GSocketFamily - Sets the local address of the socket client. + Sets the local address of the socket client. The sockets created by this object will bound to the specified address (if not %NULL) before connecting. @@ -66660,21 +70342,21 @@ a specific interface. - a #GSocketClient. + a #GSocketClient. - a #GSocketAddress, or %NULL + a #GSocketAddress, or %NULL - Sets the protocol of the socket client. + Sets the protocol of the socket client. The sockets created by this object will use of the specified protocol. -If @protocol is %0 that means to use the default +If @protocol is %G_SOCKET_PROTOCOL_DEFAULT that means to use the default protocol for the socket family and type. @@ -66682,17 +70364,17 @@ protocol for the socket family and type. - a #GSocketClient. + a #GSocketClient. - a #GSocketProtocol + a #GSocketProtocol - Overrides the #GProxyResolver used by @client. You can call this if + Overrides the #GProxyResolver used by @client. You can call this if you want to use specific proxies, rather than using the system default proxy settings. @@ -66705,18 +70387,18 @@ changed by this function (but which is %TRUE by default) - a #GSocketClient. + a #GSocketClient. - a #GProxyResolver, or %NULL for the + a #GProxyResolver, or %NULL for the default. - Sets the socket type of the socket client. + Sets the socket type of the socket client. The sockets created by this object will be of the specified type. @@ -66728,17 +70410,17 @@ as GSocketClient is used for connection oriented services. - a #GSocketClient. + a #GSocketClient. - a #GSocketType + a #GSocketType - Sets the I/O timeout for sockets created by @client. @timeout is a + Sets the I/O timeout for sockets created by @client. @timeout is a time in seconds, or 0 for no timeout (the default). The timeout value affects the initial connection attempt as well, @@ -66750,17 +70432,17 @@ to fail with %G_IO_ERROR_TIMED_OUT. - a #GSocketClient. + a #GSocketClient. - the timeout + the timeout - Sets whether @client creates TLS (aka SSL) connections. If @tls is + Sets whether @client creates TLS (aka SSL) connections. If @tls is %TRUE, @client will wrap its connections in a #GTlsClientConnection and perform a TLS handshake when connecting. @@ -66784,17 +70466,17 @@ starts. - a #GSocketClient. + a #GSocketClient. - whether to use TLS + whether to use TLS - Sets the TLS validation flags used when creating TLS connections + Sets the TLS validation flags used when creating TLS connections via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. @@ -66802,11 +70484,11 @@ via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. - a #GSocketClient. + a #GSocketClient. - the validation flags + the validation flags @@ -66824,7 +70506,7 @@ via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. - The proxy resolver to use + The proxy resolver to use @@ -66846,7 +70528,7 @@ via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. - Emitted when @client's activity on @connectable changes state. + Emitted when @client's activity on @connectable changes state. Among other things, this can be used to provide progress information about a network connection in the UI. The meanings of the different @event values are as follows: @@ -66900,15 +70582,15 @@ the future; unrecognized @event values should be ignored. - the event that is occurring + the event that is occurring - the #GSocketConnectable that @event is occurring on + the #GSocketConnectable that @event is occurring on - the current representation of the connection + the current representation of the connection @@ -66975,42 +70657,42 @@ the future; unrecognized @event values should be ignored. - Describes an event occurring on a #GSocketClient. See the + Describes an event occurring on a #GSocketClient. See the #GSocketClient::event signal for more details. Additional values may be added to this type in the future. - The client is doing a DNS lookup. + The client is doing a DNS lookup. - The client has completed a DNS lookup. + The client has completed a DNS lookup. - The client is connecting to a remote + The client is connecting to a remote host (either a proxy or the destination server). - The client has connected to a remote + The client has connected to a remote host. - The client is negotiating + The client is negotiating with a proxy to connect to the destination server. - The client has negotiated + The client has negotiated with the proxy server. - The client is performing a + The client is performing a TLS handshake. - The client has performed a + The client has performed a TLS handshake. - The client is done with a particular + The client is done with a particular #GSocketConnectable. @@ -67018,7 +70700,7 @@ Additional values may be added to this type in the future. - Objects that describe one or more potential socket endpoints + Objects that describe one or more potential socket endpoints implement #GSocketConnectable. Callers can then use g_socket_connectable_enumerate() to get a #GSocketAddressEnumerator to try out each socket address in turn until one succeeds, as shown @@ -67077,22 +70759,22 @@ connect_to_host (const char *hostname, ]| - Creates a #GSocketAddressEnumerator for @connectable. + Creates a #GSocketAddressEnumerator for @connectable. - a new #GSocketAddressEnumerator. + a new #GSocketAddressEnumerator. - a #GSocketConnectable + a #GSocketConnectable - Creates a #GSocketAddressEnumerator for @connectable that will -return #GProxyAddresses for addresses that you must connect + Creates a #GSocketAddressEnumerator for @connectable that will +return a #GProxyAddress for each of its addresses that you must connect to via a proxy. If @connectable does not implement @@ -67100,18 +70782,18 @@ g_socket_connectable_proxy_enumerate(), this will fall back to calling g_socket_connectable_enumerate(). - a new #GSocketAddressEnumerator. + a new #GSocketAddressEnumerator. - a #GSocketConnectable + a #GSocketConnectable - Format a #GSocketConnectable as a string. This is a human-readable format for + Format a #GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user. @@ -67120,33 +70802,33 @@ If the #GSocketConnectable implementation does not support string formatting, the implementation’s type name will be returned as a fallback. - the formatted string + the formatted string - a #GSocketConnectable + a #GSocketConnectable - Creates a #GSocketAddressEnumerator for @connectable. + Creates a #GSocketAddressEnumerator for @connectable. - a new #GSocketAddressEnumerator. + a new #GSocketAddressEnumerator. - a #GSocketConnectable + a #GSocketConnectable - Creates a #GSocketAddressEnumerator for @connectable that will -return #GProxyAddresses for addresses that you must connect + Creates a #GSocketAddressEnumerator for @connectable that will +return a #GProxyAddress for each of its addresses that you must connect to via a proxy. If @connectable does not implement @@ -67154,18 +70836,18 @@ g_socket_connectable_proxy_enumerate(), this will fall back to calling g_socket_connectable_enumerate(). - a new #GSocketAddressEnumerator. + a new #GSocketAddressEnumerator. - a #GSocketConnectable + a #GSocketConnectable - Format a #GSocketConnectable as a string. This is a human-readable format for + Format a #GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user. @@ -67174,12 +70856,12 @@ If the #GSocketConnectable implementation does not support string formatting, the implementation’s type name will be returned as a fallback. - the formatted string + the formatted string - a #GSocketConnectable + a #GSocketConnectable @@ -67197,12 +70879,12 @@ and #GProxyAddressEnumerator - a new #GSocketAddressEnumerator. + a new #GSocketAddressEnumerator. - a #GSocketConnectable + a #GSocketConnectable @@ -67212,12 +70894,12 @@ and #GProxyAddressEnumerator - a new #GSocketAddressEnumerator. + a new #GSocketAddressEnumerator. - a #GSocketConnectable + a #GSocketConnectable @@ -67227,12 +70909,12 @@ and #GProxyAddressEnumerator - the formatted string + the formatted string - a #GSocketConnectable + a #GSocketConnectable @@ -67240,7 +70922,7 @@ and #GProxyAddressEnumerator - #GSocketConnection is a #GIOStream for a connected socket. They + #GSocketConnection is a #GIOStream for a connected socket. They can be created either by #GSocketClient when connecting to a host, or by #GSocketListener when accepting a new client. @@ -67258,32 +70940,32 @@ substreams of the #GIOStream separately will not close the underlying #GSocket. - Looks up the #GType to be used when creating socket connections on + Looks up the #GType to be used when creating socket connections on sockets with the specified @family, @type and @protocol_id. If no type is registered, the #GSocketConnection base type is returned. - a #GType + a #GType - a #GSocketFamily + a #GSocketFamily - a #GSocketType + a #GSocketType - a protocol id + a protocol id - Looks up the #GType to be used when creating socket connections on + Looks up the #GType to be used when creating socket connections on sockets with the specified @family, @type and @protocol. If no type is registered, the #GSocketConnection base type is returned. @@ -67293,47 +70975,47 @@ If no type is registered, the #GSocketConnection base type is returned. - a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION + a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION - a #GSocketFamily + a #GSocketFamily - a #GSocketType + a #GSocketType - a protocol id + a protocol id - Connect @connection to the specified remote address. + Connect @connection to the specified remote address. - %TRUE if the connection succeeded, %FALSE on error + %TRUE if the connection succeeded, %FALSE on error - a #GSocketConnection + a #GSocketConnection - a #GSocketAddress specifying the remote address. + a #GSocketAddress specifying the remote address. - a %GCancellable or %NULL + a %GCancellable or %NULL - Asynchronously connect @connection to the specified remote address. + Asynchronously connect @connection to the specified remote address. This clears the #GSocket:blocking flag on @connection's underlying socket if it is currently set. @@ -67345,62 +71027,62 @@ Use g_socket_connection_connect_finish() to retrieve the result. - a #GSocketConnection + a #GSocketConnection - a #GSocketAddress specifying the remote address. + a #GSocketAddress specifying the remote address. - a %GCancellable or %NULL + a %GCancellable or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data for the callback + user data for the callback - Gets the result of a g_socket_connection_connect_async() call. + Gets the result of a g_socket_connection_connect_async() call. - %TRUE if the connection succeeded, %FALSE on error + %TRUE if the connection succeeded, %FALSE on error - a #GSocketConnection + a #GSocketConnection - the #GAsyncResult + the #GAsyncResult - Try to get the local address of a socket connection. + Try to get the local address of a socket connection. - a #GSocketAddress or %NULL on error. + a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). - a #GSocketConnection + a #GSocketConnection - Try to get the remote address of a socket connection. + Try to get the remote address of a socket connection. Since GLib 2.40, when used with g_socket_client_connect() or g_socket_client_connect_async(), during emission of @@ -67410,44 +71092,44 @@ applications to print e.g. "Connecting to example.com (10.42.77.3)...". - a #GSocketAddress or %NULL on error. + a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). - a #GSocketConnection + a #GSocketConnection - Gets the underlying #GSocket object of the connection. + Gets the underlying #GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the #GSocketConnection APIs. - a #GSocket or %NULL on error. + a #GSocket or %NULL on error. - a #GSocketConnection + a #GSocketConnection - Checks if @connection is connected. This is equivalent to calling + Checks if @connection is connected. This is equivalent to calling g_socket_is_connected() on @connection's underlying #GSocket. - whether @connection is connected + whether @connection is connected - a #GSocketConnection + a #GSocketConnection @@ -67520,7 +71202,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. - A #GSocketControlMessage is a special-purpose utility message that + A #GSocketControlMessage is a special-purpose utility message that can be sent to or received from a #GSocket. These types of messages are often called "ancillary data". @@ -67542,7 +71224,7 @@ class is registered with the GType typesystem before calling g_socket_receive_message() to read such a message. - Tries to deserialize a socket control message of a given + Tries to deserialize a socket control message of a given @level and @type. This will ask all known (to GType) subclasses of #GSocketControlMessage if they can understand this kind of message and if so deserialize it into a #GSocketControlMessage. @@ -67551,24 +71233,24 @@ If there is no implementation for this kind of control message, %NULL will be returned. - the deserialized message or %NULL + the deserialized message or %NULL - a socket level + a socket level - a socket control message type for the given @level + a socket control message type for the given @level - the size of the data in bytes + the size of the data in bytes - pointer to the message data + pointer to the message data @@ -67576,31 +71258,31 @@ will be returned. - Returns the "level" (i.e. the originating protocol) of the control message. + Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET. - an integer describing the level + an integer describing the level - a #GSocketControlMessage + a #GSocketControlMessage - Returns the space required for the control message, not including + Returns the space required for the control message, not including headers or alignment. - The number of bytes required. + The number of bytes required. - a #GSocketControlMessage + a #GSocketControlMessage @@ -67617,7 +71299,7 @@ headers or alignment. - Converts the data in the message to bytes placed in the + Converts the data in the message to bytes placed in the message. @data is guaranteed to have enough space to fit the size @@ -67629,62 +71311,62 @@ object. - a #GSocketControlMessage + a #GSocketControlMessage - A buffer to write data to + A buffer to write data to - Returns the "level" (i.e. the originating protocol) of the control message. + Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET. - an integer describing the level + an integer describing the level - a #GSocketControlMessage + a #GSocketControlMessage - Returns the protocol specific type of the control message. + Returns the protocol specific type of the control message. For instance, for UNIX fd passing this would be SCM_RIGHTS. - an integer describing the type of control message + an integer describing the type of control message - a #GSocketControlMessage + a #GSocketControlMessage - Returns the space required for the control message, not including + Returns the space required for the control message, not including headers or alignment. - The number of bytes required. + The number of bytes required. - a #GSocketControlMessage + a #GSocketControlMessage - Converts the data in the message to bytes placed in the + Converts the data in the message to bytes placed in the message. @data is guaranteed to have enough space to fit the size @@ -67696,11 +71378,11 @@ object. - a #GSocketControlMessage + a #GSocketControlMessage - A buffer to write data to + A buffer to write data to @@ -67722,12 +71404,12 @@ object. - The number of bytes required. + The number of bytes required. - a #GSocketControlMessage + a #GSocketControlMessage @@ -67737,12 +71419,12 @@ object. - an integer describing the level + an integer describing the level - a #GSocketControlMessage + a #GSocketControlMessage @@ -67769,11 +71451,11 @@ object. - a #GSocketControlMessage + a #GSocketControlMessage - A buffer to write data to + A buffer to write data to @@ -67846,24 +71528,24 @@ object. - The protocol family of a #GSocketAddress. (These values are + The protocol family of a #GSocketAddress. (These values are identical to the system defines %AF_INET, %AF_INET6 and %AF_UNIX, if available.) - no address family + no address family - the UNIX domain family + the UNIX domain family - the IPv4 family + the IPv4 family - the IPv6 family + the IPv6 family - A #GSocketListener is an object that keeps track of a set + A #GSocketListener is an object that keeps track of a set of server sockets and helps you accept sockets from any of the socket, either sync or async. @@ -67879,12 +71561,12 @@ and #GThreadedSocketService which are subclasses of #GSocketListener that make this even easier. - Creates a new #GSocketListener with no sockets to listen for. + Creates a new #GSocketListener 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(). - a new #GSocketListener. + a new #GSocketListener. @@ -67917,7 +71599,7 @@ or g_socket_listener_add_inet_port(). - Blocks waiting for a client to connect to any of the sockets added + Blocks waiting for a client to connect to any of the sockets added to the listener. Returns a #GSocketConnection for the socket that was accepted. @@ -67930,26 +71612,26 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketListener + a #GSocketListener - location where #GObject pointer will be stored, or %NULL + location where #GObject pointer will be stored, or %NULL - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - This is the asynchronous version of g_socket_listener_accept(). + This is the asynchronous version of g_socket_listener_accept(). When the operation is finished @callback will be called. You can then call g_socket_listener_accept_socket() @@ -67960,47 +71642,47 @@ to get the result of the operation. - a #GSocketListener + a #GSocketListener - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data for the callback + user data for the callback - Finishes an async accept operation. See g_socket_listener_accept_async() + Finishes an async accept operation. See g_socket_listener_accept_async() - a #GSocketConnection on success, %NULL on error. + a #GSocketConnection on success, %NULL on error. - a #GSocketListener + a #GSocketListener - a #GAsyncResult. + a #GAsyncResult. - Optional #GObject identifying this source + Optional #GObject identifying this source - Blocks waiting for a client to connect to any of the sockets added + Blocks waiting for a client to connect to any of the sockets added to the listener. Returns the #GSocket that was accepted. If you want to accept the high-level #GSocketConnection, not a #GSocket, @@ -68016,26 +71698,26 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - a #GSocket on success, %NULL on error. + a #GSocket on success, %NULL on error. - a #GSocketListener + a #GSocketListener - location where #GObject pointer will be stored, or %NULL. + location where #GObject pointer will be stored, or %NULL. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - This is the asynchronous version of g_socket_listener_accept_socket(). + This is the asynchronous version of g_socket_listener_accept_socket(). When the operation is finished @callback will be called. You can then call g_socket_listener_accept_socket_finish() @@ -68046,47 +71728,47 @@ to get the result of the operation. - a #GSocketListener + a #GSocketListener - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback + a #GAsyncReadyCallback - user data for the callback + user data for the callback - Finishes an async accept operation. See g_socket_listener_accept_socket_async() + Finishes an async accept operation. See g_socket_listener_accept_socket_async() - a #GSocket on success, %NULL on error. + a #GSocket on success, %NULL on error. - a #GSocketListener + a #GSocketListener - a #GAsyncResult. + a #GAsyncResult. - Optional #GObject identifying this source + Optional #GObject identifying this source - Creates a socket of type @type and protocol @protocol, binds + Creates a socket of type @type and protocol @protocol, binds it to @address and adds it to the set of sockets we're accepting sockets from. @@ -68111,38 +71793,38 @@ be done automatically when you drop your final reference to @listener, as references may be held internally. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocketListener + a #GSocketListener - a #GSocketAddress + a #GSocketAddress - a #GSocketType + a #GSocketType - a #GSocketProtocol + a #GSocketProtocol - Optional #GObject identifying this source + Optional #GObject identifying this source - location to store the address that was bound to, or %NULL. + location to store the address that was bound to, or %NULL. - Listens for TCP connections on any available port number for both + Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each is available). This is useful if you need to have a socket for incoming connections @@ -68154,22 +71836,22 @@ useful if you're listening on multiple addresses and do different things depending on what address is connected to. - the port number, or 0 in case of failure. + the port number, or 0 in case of failure. - a #GSocketListener + a #GSocketListener - Optional #GObject identifying this source + Optional #GObject identifying this source - Helper function for g_socket_listener_add_address() that + Helper function for g_socket_listener_add_address() that creates a TCP/IP socket listening on IPv4 and IPv6 (if supported) on the specified port on all interfaces. @@ -68183,26 +71865,26 @@ be done automatically when you drop your final reference to @listener, as references may be held internally. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocketListener + a #GSocketListener - an IP port number (non-zero) + an IP port number (non-zero) - Optional #GObject identifying this source + Optional #GObject identifying this source - Adds @socket to the set of sockets that we try to accept + Adds @socket to the set of sockets that we try to accept new clients from. The socket must be bound to a local address and listened to. @@ -68217,39 +71899,41 @@ the @socket was automatically closed on finalization of the @listener, even if references to it were held elsewhere. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #GSocketListener + a #GSocketListener - a listening #GSocket + a listening #GSocket - Optional #GObject identifying this source + Optional #GObject identifying this source - Closes all the sockets in the listener. + Closes all the sockets in the listener. - a #GSocketListener + a #GSocketListener - Sets the listen backlog on the sockets in the listener. + Sets the listen backlog on the sockets in the listener. This must be called +before adding any sockets, addresses or ports to the #GSocketListener (for +example, by calling g_socket_listener_add_inet_port()) to be effective. See g_socket_set_listen_backlog() for details @@ -68258,11 +71942,11 @@ See g_socket_set_listen_backlog() for details - a #GSocketListener + a #GSocketListener - an integer + an integer @@ -68277,7 +71961,7 @@ See g_socket_set_listen_backlog() for details - Emitted when @listener's activity on @socket changes state. + Emitted when @listener's activity on @socket changes state. Note that when @listener is used to listen on both IPv4 and IPv6, a separate set of signals will be emitted for each, and the order they happen in is undefined. @@ -68286,11 +71970,11 @@ the order they happen in is undefined. - the event that is occurring + the event that is occurring - the #GSocket the event is occurring on + the #GSocket the event is occurring on @@ -68376,22 +72060,22 @@ the order they happen in is undefined. - Describes an event occurring on a #GSocketListener. See the + Describes an event occurring on a #GSocketListener. See the #GSocketListener::event signal for more details. Additional values may be added to this type in the future. - The listener is about to bind a socket. + The listener is about to bind a socket. - The listener has bound a socket. + The listener has bound a socket. - The listener is about to start + The listener is about to start listening on this socket. - The listener is now listening on + The listener is now listening on this socket. @@ -68399,23 +72083,23 @@ Additional values may be added to this type in the future. - Flags used in g_socket_receive_message() and g_socket_send_message(). + Flags used in g_socket_receive_message() and g_socket_send_message(). The flags listed in the enum are some commonly available flags, but the values used for them are the same as on the platform, and any other flags are passed in/out as is. So to use a platform specific flag, just include the right system header and pass in the flag. - No flags. + No flags. - Request to send/receive out of band data. + Request to send/receive out of band data. - Read data from the socket without removing it from + Read data from the socket without removing it from the queue. - Don't use a gateway to send out the packet, + Don't use a gateway to send out the packet, only send to hosts on directly connected networks. @@ -68423,7 +72107,7 @@ the right system header and pass in the flag. - A protocol identifier is specified when creating a #GSocket, which is a + A protocol identifier is specified when creating a #GSocket, which is a family/type specific identifier, where 0 means the default protocol for the particular family/type. @@ -68431,23 +72115,23 @@ This enum contains a set of commonly available and used protocols. You can also pass any other identifiers handled by the platform in order to use protocols not listed here. - The protocol type is unknown + The protocol type is unknown - The default protocol for the family/type + The default protocol for the family/type - TCP over IP + TCP over IP - UDP over IP + UDP over IP - SCTP over IP + SCTP over IP - A #GSocketService is an object that represents a service that + A #GSocketService is an object that represents a service that is provided to the network or over local sockets. When a new connection is made to the service the #GSocketService::incoming signal is emitted. @@ -68475,7 +72159,7 @@ service are thread-safe so these can be used from threads that handle incoming clients. - Creates a new #GSocketService with no sockets to listen for. + 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(). @@ -68484,7 +72168,7 @@ g_socket_service_start(), unless g_socket_service_stop() has been called before. - a new #GSocketService. + a new #GSocketService. @@ -68506,24 +72190,24 @@ called before. - Check whether the service is active or not. An active + Check whether the service is active or not. An active service will accept new clients that connect, while a non-active service will let connecting clients queue up until the service is started. - %TRUE if the service is active, %FALSE otherwise + %TRUE if the service is active, %FALSE otherwise - a #GSocketService + a #GSocketService - Restarts the service, i.e. start accepting connections + 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(). @@ -68536,13 +72220,13 @@ handling an incoming client request. - a #GSocketService + a #GSocketService - Stops the service, i.e. stops accepting connections + Stops the service, i.e. stops accepting connections from the added sockets when the mainloop runs. This call is thread-safe, so it may be called from a thread @@ -68563,13 +72247,13 @@ when a new socket is added. - a #GSocketService + a #GSocketService - Whether the service is currently accepting connections. + Whether the service is currently accepting connections. @@ -68579,7 +72263,7 @@ when a new socket is added. - The ::incoming signal is emitted when a new incoming connection + The ::incoming signal is emitted when a new incoming connection to @service needs to be handled. The handler must initiate the handling of @connection, but may not block; in essence, asynchronous operations must be used. @@ -68587,16 +72271,16 @@ asynchronous operations must be used. @connection will be unreffed once the signal handler returns, so you need to ref it yourself if you are planning to use it. - %TRUE to stop other handlers from being called + %TRUE to stop other handlers from being called - a new #GSocketConnection object + a new #GSocketConnection object - the source_object passed to + the source_object passed to g_socket_listener_add_address() @@ -68704,25 +72388,25 @@ returned by g_socket_create_source(). - Flags used when creating a #GSocket. Some protocols may not implement + Flags used when creating a #GSocket. Some protocols may not implement all the socket types. - Type unknown or wrong + Type unknown or wrong - Reliable connection-based byte streams (e.g. TCP). + Reliable connection-based byte streams (e.g. TCP). - Connectionless, unreliable datagram passing. + Connectionless, unreliable datagram passing. (e.g. UDP) - Reliable connection-based passing of datagrams + Reliable connection-based passing of datagrams of fixed maximum length (e.g. SCTP). - SRV (service) records are used by some network protocols to provide + SRV (service) records are used by some network protocols to provide service-specific aliasing and load-balancing. For example, XMPP (Jabber) uses SRV records to locate the XMPP server for a domain; rather than connecting directly to "example.com" or assuming a @@ -68738,136 +72422,136 @@ to the remote service, you can use #GNetworkService's #GSrvTarget at all. - Creates a new #GSrvTarget with the given parameters. + Creates a new #GSrvTarget with the given parameters. You should not need to use this; normally #GSrvTargets are created by #GResolver. - a new #GSrvTarget. + a new #GSrvTarget. - the host that the service is running on + the host that the service is running on - the port that the service is running on + the port that the service is running on - the target's priority + the target's priority - the target's weight + the target's weight - Copies @target + Copies @target - a copy of @target + a copy of @target - a #GSrvTarget + a #GSrvTarget - Frees @target + Frees @target - a #GSrvTarget + a #GSrvTarget - Gets @target's hostname (in ASCII form; if you are going to present + Gets @target's hostname (in ASCII form; if you are going to present this to the user, you should use g_hostname_is_ascii_encoded() to check if it contains encoded Unicode segments, and use g_hostname_to_unicode() to convert it if it does.) - @target's hostname + @target's hostname - a #GSrvTarget + a #GSrvTarget - Gets @target's port + Gets @target's port - @target's port + @target's port - a #GSrvTarget + a #GSrvTarget - Gets @target's priority. You should not need to look at this; + Gets @target's priority. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. - @target's priority + @target's priority - a #GSrvTarget + a #GSrvTarget - Gets @target's weight. You should not need to look at this; + Gets @target's weight. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. - @target's weight + @target's weight - a #GSrvTarget + a #GSrvTarget - Sorts @targets in place according to the algorithm in RFC 2782. + Sorts @targets in place according to the algorithm in RFC 2782. - the head of the sorted list. + the head of the sorted list. - a #GList of #GSrvTarget + a #GList of #GSrvTarget @@ -68876,7 +72560,7 @@ RFC 2782. - #GStaticResource is an opaque data structure and can only be accessed + #GStaticResource is an opaque data structure and can only be accessed using the following functions. @@ -68895,7 +72579,7 @@ using the following functions. - Finalized a GResource initialized by g_static_resource_init(). + Finalized a GResource initialized by g_static_resource_init(). This is normally used by code generated by [glib-compile-resources][glib-compile-resources] @@ -68906,31 +72590,31 @@ and is not typically used by other code. - pointer to a static #GStaticResource + pointer to a static #GStaticResource - Gets the GResource that was registered by a call to g_static_resource_init(). + Gets the GResource that was registered by a call to g_static_resource_init(). This is normally used by code generated by [glib-compile-resources][glib-compile-resources] and is not typically used by other code. - a #GResource + a #GResource - pointer to a static #GStaticResource + pointer to a static #GStaticResource - Initializes a GResource from static data using a + Initializes a GResource from static data using a GStaticResource. This is normally used by code generated by @@ -68942,14 +72626,14 @@ and is not typically used by other code. - pointer to a static #GStaticResource + pointer to a static #GStaticResource - #GSubprocess allows the creation of and interaction with child + #GSubprocess allows the creation of and interaction with child processes. Processes can be communicated with using standard GIO-style APIs (ie: @@ -69005,7 +72689,7 @@ checked using functions such as g_subprocess_get_if_exited() (which are similar to the familiar WIFEXITED-style POSIX macros). - Create a new process with the given flags and varargs argument + Create a new process with the given flags and varargs argument list. By default, matching the g_spawn_async() defaults, the child's stdin will be set to the system null device, and stdout/stderr will be inherited from the parent. You can use @@ -69014,54 +72698,54 @@ stdout/stderr will be inherited from the parent. You can use The argument list must be terminated with %NULL. - A newly created #GSubprocess, or %NULL on error (and @error + A newly created #GSubprocess, or %NULL on error (and @error will be set) - flags that define the behaviour of the subprocess + flags that define the behaviour of the subprocess - return location for an error, or %NULL + return location for an error, or %NULL - first commandline argument to pass to the subprocess + first commandline argument to pass to the subprocess - more commandline arguments, followed by %NULL + more commandline arguments, followed by %NULL - Create a new process with the given flags and argument list. + Create a new process with the given flags and argument list. The argument list is expected to be %NULL-terminated. - A newly created #GSubprocess, or %NULL on error (and @error + A newly created #GSubprocess, or %NULL on error (and @error will be set) - commandline arguments for the subprocess + commandline arguments for the subprocess - flags that define the behaviour of the subprocess + flags that define the behaviour of the subprocess - Communicate with the subprocess until it terminates, and all input + Communicate with the subprocess until it terminates, and all input and output has been completed. If @stdin_buf is given, the subprocess must have been created with @@ -69104,34 +72788,34 @@ attempt to interact with the pipes while the operation is in progress (either from another thread or if using the asynchronous version). - %TRUE if successful + %TRUE if successful - a #GSubprocess + a #GSubprocess - data to send to the stdin of the subprocess, or %NULL + data to send to the stdin of the subprocess, or %NULL - a #GCancellable + a #GCancellable - data read from the subprocess stdout + data read from the subprocess stdout - data read from the subprocess stderr + data read from the subprocess stderr - Asynchronous version of g_subprocess_communicate(). Complete + Asynchronous version of g_subprocess_communicate(). Complete invocation with g_subprocess_communicate_finish(). @@ -69139,54 +72823,54 @@ invocation with g_subprocess_communicate_finish(). - Self + Self - Input data, or %NULL + Input data, or %NULL - Cancellable + Cancellable - Callback + Callback - User data + User data - Complete an invocation of g_subprocess_communicate_async(). + Complete an invocation of g_subprocess_communicate_async(). - Self + Self - Result + Result - Return location for stdout data + Return location for stdout data - Return location for stderr data + Return location for stderr data - Like g_subprocess_communicate(), but validates the output of the + Like g_subprocess_communicate(), but validates the output of the process as UTF-8, and returns it as a regular NUL terminated string. On error, @stdout_buf and @stderr_buf will be set to undefined values and @@ -69197,29 +72881,29 @@ should not be used. - a #GSubprocess + a #GSubprocess - data to send to the stdin of the subprocess, or %NULL + data to send to the stdin of the subprocess, or %NULL - a #GCancellable + a #GCancellable - data read from the subprocess stdout + data read from the subprocess stdout - data read from the subprocess stderr + data read from the subprocess stderr - Asynchronous version of g_subprocess_communicate_utf8(). Complete + Asynchronous version of g_subprocess_communicate_utf8(). Complete invocation with g_subprocess_communicate_utf8_finish(). @@ -69227,54 +72911,54 @@ invocation with g_subprocess_communicate_utf8_finish(). - Self + Self - Input data, or %NULL + Input data, or %NULL - Cancellable + Cancellable - Callback + Callback - User data + User data - Complete an invocation of g_subprocess_communicate_utf8_async(). + Complete an invocation of g_subprocess_communicate_utf8_async(). - Self + Self - Result + Result - Return location for stdout data + Return location for stdout data - Return location for stderr data + Return location for stderr data - Use an operating-system specific method to attempt an immediate, + Use an operating-system specific method to attempt an immediate, forceful termination of the process. There is no mechanism to determine whether or not the request itself was successful; however, you can use g_subprocess_wait() to monitor the status of @@ -69287,13 +72971,13 @@ On Unix, this function sends %SIGKILL. - a #GSubprocess + a #GSubprocess - Check the exit status of the subprocess, given that it exited + Check the exit status of the subprocess, given that it exited normally. This is the value passed to the exit() system call or the return value from main. @@ -69303,32 +72987,35 @@ It is an error to call this function before g_subprocess_wait() and unless g_subprocess_get_if_exited() returned %TRUE. - the exit status + the exit status - a #GSubprocess + a #GSubprocess - - On UNIX, returns the process ID as a decimal string. -On Windows, returns the result of GetProcessId() also as a string. + + On UNIX, returns the process ID as a decimal string. +On Windows, returns the result of GetProcessId() also as a string. +If the subprocess has terminated, this will return %NULL. - + + the subprocess identifier, or %NULL if the subprocess + has terminated - a #GSubprocess + a #GSubprocess - Check if the given subprocess exited normally (ie: by way of exit() + Check if the given subprocess exited normally (ie: by way of exit() or return from main()). This is equivalent to the system WIFEXITED macro. @@ -69337,18 +73024,18 @@ It is an error to call this function before g_subprocess_wait() has returned. - %TRUE if the case of a normal exit + %TRUE if the case of a normal exit - a #GSubprocess + a #GSubprocess - Check if the given subprocess terminated in response to a signal. + Check if the given subprocess terminated in response to a signal. This is equivalent to the system WIFSIGNALED macro. @@ -69356,18 +73043,18 @@ It is an error to call this function before g_subprocess_wait() has returned. - %TRUE if the case of termination due to a signal + %TRUE if the case of termination due to a signal - a #GSubprocess + a #GSubprocess - Gets the raw status code of the process, as from waitpid(). + Gets the raw status code of the process, as from waitpid(). This value has no particular meaning, but it can be used with the macros defined by the system headers such as WIFEXITED. It can also @@ -69380,72 +73067,72 @@ It is an error to call this function before g_subprocess_wait() has returned. - the (meaningless) waitpid() exit status from the kernel + the (meaningless) waitpid() exit status from the kernel - a #GSubprocess + a #GSubprocess - Gets the #GInputStream from which to read the stderr output of + Gets the #GInputStream from which to read the stderr output of @subprocess. The process must have been created with %G_SUBPROCESS_FLAGS_STDERR_PIPE. - the stderr pipe + the stderr pipe - a #GSubprocess + a #GSubprocess - Gets the #GOutputStream that you can write to in order to give data + Gets the #GOutputStream that you can write to in order to give data to the stdin of @subprocess. The process must have been created with %G_SUBPROCESS_FLAGS_STDIN_PIPE. - the stdout pipe + the stdout pipe - a #GSubprocess + a #GSubprocess - Gets the #GInputStream from which to read the stdout output of + Gets the #GInputStream from which to read the stdout output of @subprocess. The process must have been created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE. - the stdout pipe + the stdout pipe - a #GSubprocess + a #GSubprocess - Checks if the process was "successful". A process is considered + Checks if the process was "successful". A process is considered successful if it exited cleanly with an exit status of 0, either by way of the exit() system call or return from main(). @@ -69453,18 +73140,18 @@ It is an error to call this function before g_subprocess_wait() has returned. - %TRUE if the process exited cleanly with a exit status of 0 + %TRUE if the process exited cleanly with a exit status of 0 - a #GSubprocess + a #GSubprocess - Get the signal number that caused the subprocess to terminate, given + Get the signal number that caused the subprocess to terminate, given that it terminated due to a signal. This is equivalent to the system WTERMSIG macro. @@ -69473,18 +73160,18 @@ It is an error to call this function before g_subprocess_wait() and unless g_subprocess_get_if_signaled() returned %TRUE. - the signal causing termination + the signal causing termination - a #GSubprocess + a #GSubprocess - Sends the UNIX signal @signal_num to the subprocess, if it is still + Sends the UNIX signal @signal_num to the subprocess, if it is still running. This API is race-free. If the subprocess has terminated, it will not @@ -69497,17 +73184,17 @@ This API is not available on Windows. - a #GSubprocess + a #GSubprocess - the signal number to send + the signal number to send - Synchronously wait for the subprocess to terminate. + Synchronously wait for the subprocess to terminate. After the process terminates you can query its exit status with functions such as g_subprocess_get_if_exited() and @@ -69520,22 +73207,22 @@ Cancelling @cancellable doesn't kill the subprocess. Call g_subprocess_force_exit() if it is desirable. - %TRUE on success, %FALSE if @cancellable was cancelled + %TRUE on success, %FALSE if @cancellable was cancelled - a #GSubprocess + a #GSubprocess - a #GCancellable + a #GCancellable - Wait for the subprocess to terminate. + Wait for the subprocess to terminate. This is the asynchronous version of g_subprocess_wait(). @@ -69544,44 +73231,44 @@ This is the asynchronous version of g_subprocess_wait(). - a #GSubprocess + a #GSubprocess - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback to call when the operation is complete + a #GAsyncReadyCallback to call when the operation is complete - user_data for @callback + user_data for @callback - Combines g_subprocess_wait() with g_spawn_check_exit_status(). + Combines g_subprocess_wait() with g_spawn_check_exit_status(). - %TRUE on success, %FALSE if process exited abnormally, or + %TRUE on success, %FALSE if process exited abnormally, or @cancellable was cancelled - a #GSubprocess + a #GSubprocess - a #GCancellable + a #GCancellable - Combines g_subprocess_wait_async() with g_spawn_check_exit_status(). + Combines g_subprocess_wait_async() with g_spawn_check_exit_status(). This is the asynchronous version of g_subprocess_wait_check(). @@ -69590,57 +73277,57 @@ This is the asynchronous version of g_subprocess_wait_check(). - a #GSubprocess + a #GSubprocess - a #GCancellable, or %NULL + a #GCancellable, or %NULL - a #GAsyncReadyCallback to call when the operation is complete + a #GAsyncReadyCallback to call when the operation is complete - user_data for @callback + user_data for @callback - Collects the result of a previous call to + Collects the result of a previous call to g_subprocess_wait_check_async(). - %TRUE if successful, or %FALSE with @error set + %TRUE if successful, or %FALSE with @error set - a #GSubprocess + a #GSubprocess - the #GAsyncResult passed to your #GAsyncReadyCallback + the #GAsyncResult passed to your #GAsyncReadyCallback - Collects the result of a previous call to + Collects the result of a previous call to g_subprocess_wait_async(). - %TRUE if successful, or %FALSE with @error set + %TRUE if successful, or %FALSE with @error set - a #GSubprocess + a #GSubprocess - the #GAsyncResult passed to your #GAsyncReadyCallback + the #GAsyncResult passed to your #GAsyncReadyCallback @@ -69655,7 +73342,7 @@ g_subprocess_wait_async(). - Flags to define the behaviour of a #GSubprocess. + Flags to define the behaviour of a #GSubprocess. Note that the default for stdin is to redirect from `/dev/null`. For stdout and stderr the default are for them to inherit the @@ -69665,49 +73352,49 @@ Note that it is a programmer error to mix 'incompatible' flags. For example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and %G_SUBPROCESS_FLAGS_STDOUT_SILENCE. - No flags. + No flags. - create a pipe for the stdin of the + create a pipe for the stdin of the spawned process that can be accessed with g_subprocess_get_stdin_pipe(). - stdin is inherited from the + stdin is inherited from the calling process. - create a pipe for the stdout of the + create a pipe for the stdout of the spawned process that can be accessed with g_subprocess_get_stdout_pipe(). - silence the stdout of the spawned + silence the stdout of the spawned process (ie: redirect to `/dev/null`). - create a pipe for the stderr of the + create a pipe for the stderr of the spawned process that can be accessed with g_subprocess_get_stderr_pipe(). - silence the stderr of the spawned + silence the stderr of the spawned process (ie: redirect to `/dev/null`). - merge the stderr of the spawned + merge the stderr of the spawned process with whatever the stdout happens to be. This is a good way of directing both streams to a common log file, for example. - spawned processes will inherit the + spawned processes will inherit the file descriptors of their parent, unless those descriptors have been explicitly marked as close-on-exec. This flag has no effect over the "standard" file descriptors (stdin, stdout, stderr). - This class contains a set of options for launching child processes, + This class contains a set of options for launching child processes, such as where its standard input and output will be directed, the argument list, the environment, and more. @@ -69716,7 +73403,7 @@ popular cases, use of this class allows access to more advanced options. It can also be used to launch multiple subprocesses with a similar configuration. - Creates a new #GSubprocessLauncher. + Creates a new #GSubprocessLauncher. The launcher is created with the default options. A copy of the environment of the calling process is made at the time of this call @@ -69727,36 +73414,36 @@ and will be used as the environment that the process is launched in. - #GSubprocessFlags + #GSubprocessFlags - Returns the value of the environment variable @variable in the + Returns the value of the environment variable @variable in the environment of processes launched from this launcher. On UNIX, the returned string can be an arbitrary byte string. On Windows, it will be UTF-8. - the value of the environment variable, + the value of the environment variable, %NULL if unset - a #GSubprocess + a #GSubprocess - the environment variable to get + the environment variable to get - Sets up a child setup function. + Sets up a child setup function. The child setup function will be called after fork() but before exec() on the child's side. @@ -69775,25 +73462,25 @@ Child setup functions are only available on UNIX. - a #GSubprocessLauncher + a #GSubprocessLauncher - a #GSpawnChildSetupFunc to use as the child setup function + a #GSpawnChildSetupFunc to use as the child setup function - user data for @child_setup + user data for @child_setup - a #GDestroyNotify for @user_data + a #GDestroyNotify for @user_data - Sets the current working directory that processes will be launched + Sets the current working directory that processes will be launched with. By default processes are launched with the current working directory @@ -69804,17 +73491,17 @@ of the launching process at the time of launch. - a #GSubprocess + a #GSubprocess - the cwd for launched processes + the cwd for launched processes - Replace the entire environment of processes launched from this + Replace the entire environment of processes launched from this launcher with the given 'environ' variable. Typically you will build this variable by using g_listenv() to copy @@ -69839,11 +73526,11 @@ On Windows, they should be in UTF-8. - a #GSubprocess + a #GSubprocess - + the replacement environment @@ -69852,7 +73539,7 @@ On Windows, they should be in UTF-8. - Sets the flags on the launcher. + Sets the flags on the launcher. The default flags are %G_SUBPROCESS_FLAGS_NONE. @@ -69870,17 +73557,17 @@ g_subprocess_launcher_take_stdout_fd(). - a #GSubprocessLauncher + a #GSubprocessLauncher - #GSubprocessFlags + #GSubprocessFlags - Sets the file path to use as the stderr for spawned processes. + Sets the file path to use as the stderr for spawned processes. If @path is %NULL then any previously given path is unset. @@ -69900,17 +73587,17 @@ This feature is only available on UNIX. - a #GSubprocessLauncher + a #GSubprocessLauncher - a filename or %NULL + a filename or %NULL - Sets the file path to use as the stdin for spawned processes. + Sets the file path to use as the stdin for spawned processes. If @path is %NULL then any previously given path is unset. @@ -69926,7 +73613,7 @@ This feature is only available on UNIX. - a #GSubprocessLauncher + a #GSubprocessLauncher @@ -69935,7 +73622,7 @@ This feature is only available on UNIX. - Sets the file path to use as the stdout for spawned processes. + Sets the file path to use as the stdout for spawned processes. If @path is %NULL then any previously given path is unset. @@ -69952,17 +73639,17 @@ This feature is only available on UNIX. - a #GSubprocessLauncher + a #GSubprocessLauncher - a filename or %NULL + a filename or %NULL - Sets the environment variable @variable in the environment of + Sets the environment variable @variable in the environment of processes launched from this launcher. On UNIX, both the variable's name and value can be arbitrary byte @@ -69974,64 +73661,64 @@ On Windows, they should be in UTF-8. - a #GSubprocess + a #GSubprocess - the environment variable to set, + the environment variable to set, must not contain '=' - the new value for the variable + the new value for the variable - whether to change the variable if it already exists + whether to change the variable if it already exists - Creates a #GSubprocess given a provided varargs list of arguments. + Creates a #GSubprocess given a provided varargs list of arguments. - A new #GSubprocess, or %NULL on error (and @error will be set) + A new #GSubprocess, or %NULL on error (and @error will be set) - a #GSubprocessLauncher + a #GSubprocessLauncher - Error + Error - Command line arguments + Command line arguments - Continued arguments, %NULL terminated + Continued arguments, %NULL terminated - Creates a #GSubprocess given a provided array of arguments. + Creates a #GSubprocess given a provided array of arguments. - A new #GSubprocess, or %NULL on error (and @error will be set) + A new #GSubprocess, or %NULL on error (and @error will be set) - a #GSubprocessLauncher + a #GSubprocessLauncher - Command line arguments + Command line arguments @@ -70039,7 +73726,7 @@ On Windows, they should be in UTF-8. - Transfer an arbitrary file descriptor from parent process to the + Transfer an arbitrary file descriptor from parent process to the child. This function takes "ownership" of the fd; it will be closed in the parent when @self is freed. @@ -70057,21 +73744,21 @@ the passphrase to be written. - a #GSubprocessLauncher + a #GSubprocessLauncher - File descriptor in parent process + File descriptor in parent process - Target descriptor for child process + Target descriptor for child process - Sets the file descriptor to use as the stderr for spawned processes. + Sets the file descriptor to use as the stderr for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -70093,17 +73780,17 @@ This feature is only available on UNIX. - a #GSubprocessLauncher + a #GSubprocessLauncher - a file descriptor, or -1 + a file descriptor, or -1 - Sets the file descriptor to use as the stdin for spawned processes. + Sets the file descriptor to use as the stdin for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -70127,17 +73814,17 @@ This feature is only available on UNIX. - a #GSubprocessLauncher + a #GSubprocessLauncher - a file descriptor, or -1 + a file descriptor, or -1 - Sets the file descriptor to use as the stdout for spawned processes. + Sets the file descriptor to use as the stdout for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -70160,17 +73847,17 @@ This feature is only available on UNIX. - a #GSubprocessLauncher + a #GSubprocessLauncher - a file descriptor, or -1 + a file descriptor, or -1 - Removes the environment variable @variable from the environment of + Removes the environment variable @variable from the environment of processes launched from this launcher. On UNIX, the variable's name can be an arbitrary byte string not @@ -70181,11 +73868,11 @@ containing '='. On Windows, it should be in UTF-8. - a #GSubprocess + a #GSubprocess - the environment variable to unset, + the environment variable to unset, must not contain '=' @@ -70195,26 +73882,320 @@ containing '='. On Windows, it should be in UTF-8. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extension point for TLS functionality via #GTlsBackend. See [Extending GIO][extending-gio]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - The purpose used to verify the client certificate in a TLS connection. + The purpose used to verify the client certificate in a TLS connection. Used by TLS servers. - The purpose used to verify the server certificate in a TLS connection. This + The purpose used to verify the server certificate in a TLS connection. This is the most common purpose in use. Used by TLS clients. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - A #GTask represents and manages a cancellable "task". + A #GTask represents and manages a cancellable "task". ## Asynchronous operations @@ -70712,7 +74693,7 @@ in several ways: - Creates a #GTask acting on @source_object, which will eventually be + Creates a #GTask acting on @source_object, which will eventually be used to invoke @callback in the current [thread-default main context][g-main-context-push-thread-default]. @@ -70730,53 +74711,53 @@ do not want this behavior, you can use g_task_set_check_cancellable() to change it. - a #GTask. + a #GTask. - the #GObject that owns + the #GObject that owns this task, or %NULL. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - Checks that @result is a #GTask, and that @source_object is its + Checks that @result is a #GTask, and that @source_object is its source object (or that @source_object is %NULL and @result has no source object). This can be used in g_return_if_fail() checks. - %TRUE if @result and @source_object are valid, %FALSE + %TRUE if @result and @source_object are valid, %FALSE if not - A #GAsyncResult + A #GAsyncResult - the source object + the source object expected to be associated with the task - Creates a #GTask and then immediately calls g_task_return_error() + Creates a #GTask and then immediately calls g_task_return_error() on it. Use this in the wrapper function of an asynchronous method when you want to avoid even calling the virtual method. You can then use g_async_result_is_tagged() in the finish method wrapper to @@ -70790,30 +74771,30 @@ See also g_task_report_new_error(). - the #GObject that owns + the #GObject that owns this task, or %NULL. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - an opaque pointer indicating the source of this task + an opaque pointer indicating the source of this task - error to report + error to report - Creates a #GTask and then immediately calls + Creates a #GTask and then immediately calls g_task_return_new_error() on it. Use this in the wrapper function of an asynchronous method when you want to avoid even calling the virtual method. You can then use g_async_result_is_tagged() in the @@ -70828,42 +74809,42 @@ See also g_task_report_error(). - the #GObject that owns + the #GObject that owns this task, or %NULL. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - an opaque pointer indicating the source of this task + an opaque pointer indicating the source of this task - a #GQuark. + a #GQuark. - an error code. + an error code. - a string with format characters. + a string with format characters. - a list of values to insert into @format. + a list of values to insert into @format. - A utility function for dealing with async operations where you need + A utility function for dealing with async operations where you need to wait for a #GSource to trigger. Attaches @source to @task's #GMainContext with @task's [priority][io-priority], and sets @source's callback to @callback, with @task as the callback's `user_data`. @@ -70878,35 +74859,35 @@ This takes a reference on @task until @source is destroyed. - a #GTask + a #GTask - the source to attach + the source to attach - the callback to invoke when @source triggers + the callback to invoke when @source triggers - Gets @task's #GCancellable + Gets @task's #GCancellable - @task's #GCancellable + @task's #GCancellable - a #GTask + a #GTask - Gets @task's check-cancellable flag. See + Gets @task's check-cancellable flag. See g_task_set_check_cancellable() for more details. @@ -70914,29 +74895,29 @@ g_task_set_check_cancellable() for more details. - the #GTask + the #GTask - Gets the value of #GTask:completed. This changes from %FALSE to %TRUE after + Gets the value of #GTask:completed. This changes from %FALSE to %TRUE after the task’s callback is invoked, and will return %FALSE if called from inside the callback. - %TRUE if the task has completed, %FALSE otherwise. + %TRUE if the task has completed, %FALSE otherwise. - a #GTask. + a #GTask. - Gets the #GMainContext that @task will return its result in (that + Gets the #GMainContext that @task will return its result in (that is, the context that was the [thread-default main context][g-main-context-push-thread-default] at the point when @task was created). @@ -70945,46 +74926,46 @@ This will always return a non-%NULL value, even if the task's context is the default #GMainContext. - @task's #GMainContext + @task's #GMainContext - a #GTask + a #GTask - Gets @task’s name. See g_task_set_name(). + Gets @task’s name. See g_task_set_name(). - @task’s name, or %NULL + @task’s name, or %NULL - a #GTask + a #GTask - Gets @task's priority + Gets @task's priority - @task's priority + @task's priority - a #GTask + a #GTask - Gets @task's return-on-cancel flag. See + Gets @task's return-on-cancel flag. See g_task_set_return_on_cancel() for more details. @@ -70992,70 +74973,70 @@ g_task_set_return_on_cancel() for more details. - the #GTask + the #GTask - Gets the source object from @task. Like + Gets the source object from @task. Like g_async_result_get_source_object(), but does not ref the object. - @task's source object, or %NULL + @task's source object, or %NULL - a #GTask + a #GTask - Gets @task's source tag. See g_task_set_source_tag(). + Gets @task's source tag. See g_task_set_source_tag(). - @task's source tag + @task's source tag - a #GTask + a #GTask - Gets @task's `task_data`. + Gets @task's `task_data`. - @task's `task_data`. + @task's `task_data`. - a #GTask + a #GTask - Tests if @task resulted in an error. + Tests if @task resulted in an error. - %TRUE if the task resulted in an error, %FALSE otherwise. + %TRUE if the task resulted in an error, %FALSE otherwise. - a #GTask. + a #GTask. - Gets the result of @task as a #gboolean. + Gets the result of @task as a #gboolean. If the task resulted in an error, or was cancelled, then this will instead return %FALSE and set @error. @@ -71064,18 +75045,18 @@ Since this method transfers ownership of the return value (or error) to the caller, you may only call it once. - the task result, or %FALSE on error + the task result, or %FALSE on error - a #GTask. + a #GTask. - Gets the result of @task as an integer (#gssize). + Gets the result of @task as an integer (#gssize). If the task resulted in an error, or was cancelled, then this will instead return -1 and set @error. @@ -71084,18 +75065,18 @@ Since this method transfers ownership of the return value (or error) to the caller, you may only call it once. - the task result, or -1 on error + the task result, or -1 on error - a #GTask. + a #GTask. - Gets the result of @task as a pointer, and transfers ownership + Gets the result of @task as a pointer, and transfers ownership of that value to the caller. If the task resulted in an error, or was cancelled, then this will @@ -71105,18 +75086,18 @@ Since this method transfers ownership of the return value (or error) to the caller, you may only call it once. - the task result, or %NULL on error + the task result, or %NULL on error - a #GTask + a #GTask - Sets @task's result to @result and completes the task (see + Sets @task's result to @result and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -71125,17 +75106,17 @@ means). - a #GTask. + a #GTask. - the #gboolean result of a task function. + the #gboolean result of a task function. - Sets @task's result to @error (which @task assumes ownership of) + Sets @task's result to @error (which @task assumes ownership of) and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -71152,34 +75133,34 @@ See also g_task_return_new_error(). - a #GTask. + a #GTask. - the #GError result of a task function. + the #GError result of a task function. - Checks if @task's #GCancellable has been cancelled, and if so, sets + Checks if @task's #GCancellable has been cancelled, and if so, sets @task's error accordingly and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). - %TRUE if @task has been cancelled, %FALSE if not + %TRUE if @task has been cancelled, %FALSE if not - a #GTask + a #GTask - Sets @task's result to @result and completes the task (see + Sets @task's result to @result and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -71188,17 +75169,17 @@ means). - a #GTask. + a #GTask. - the integer (#gssize) result of a task function. + the integer (#gssize) result of a task function. - Sets @task's result to a new #GError created from @domain, @code, + Sets @task's result to a new #GError created from @domain, @code, @format, and the remaining arguments, and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -71210,29 +75191,29 @@ See also g_task_return_error(). - a #GTask. + a #GTask. - a #GQuark. + a #GQuark. - an error code. + an error code. - a string with format characters. + a string with format characters. - a list of values to insert into @format. + a list of values to insert into @format. - Sets @task's result to @result and completes the task. If @result + Sets @task's result to @result and completes the task. If @result is not %NULL, then @result_destroy will be used to free @result if the caller does not take ownership of it with g_task_propagate_pointer(). @@ -71256,22 +75237,22 @@ reference on it. - a #GTask + a #GTask - the pointer result of a task + the pointer result of a task function - a #GDestroyNotify function. + a #GDestroyNotify function. - Runs @task_func in another thread. When @task_func returns, @task's + Runs @task_func in another thread. When @task_func returns, @task's #GAsyncReadyCallback will be invoked in @task's #GMainContext. This takes a ref on @task until the task completes. @@ -71289,17 +75270,17 @@ number of them at a time. - a #GTask + a #GTask - a #GTaskThreadFunc + a #GTaskThreadFunc - Runs @task_func in another thread, and waits for it to return or be + Runs @task_func in another thread, and waits for it to return or be cancelled. You can use g_task_propagate_pointer(), etc, afterward to get the result of @task_func. @@ -71321,17 +75302,17 @@ limited number of them at a time. - a #GTask + a #GTask - a #GTaskThreadFunc + a #GTaskThreadFunc - Sets or clears @task's check-cancellable flag. If this is %TRUE + Sets or clears @task's check-cancellable flag. If this is %TRUE (the default), then g_task_propagate_pointer(), etc, and g_task_had_error() will check the task's #GCancellable first, and if it has been cancelled, then they will consider the task to have @@ -71351,18 +75332,18 @@ you must leave check-cancellable set %TRUE. - the #GTask + the #GTask - whether #GTask will check the state of + whether #GTask will check the state of its #GCancellable for you. - Sets @task’s name, used in debugging and profiling. The name defaults to + Sets @task’s name, used in debugging and profiling. The name defaults to %NULL. The task name should describe in a human readable way what the task does. @@ -71377,17 +75358,17 @@ other than the one it was constructed in. - a #GTask + a #GTask - a human readable name for the task, or %NULL to unset it + a human readable name for the task, or %NULL to unset it - Sets @task's priority. If you do not call this, it will default to + Sets @task's priority. If you do not call this, it will default to %G_PRIORITY_DEFAULT. This will affect the priority of #GSources created with @@ -71400,17 +75381,17 @@ g_task_get_priority(). - the #GTask + the #GTask - the [priority][io-priority] of the request + the [priority][io-priority] of the request - Sets or clears @task's return-on-cancel flag. This is only + Sets or clears @task's return-on-cancel flag. This is only meaningful for tasks run via g_task_run_in_thread() or g_task_run_in_thread_sync(). @@ -71440,25 +75421,25 @@ g_task_run_in_thread()/g_task_run_in_thread_sync(), then the will also be completed right away. - %TRUE if @task's return-on-cancel flag was changed to + %TRUE if @task's return-on-cancel flag was changed to match @return_on_cancel. %FALSE if @task has already been cancelled. - the #GTask + the #GTask - whether the task returns automatically when + whether the task returns automatically when it is cancelled. - Sets @task's source tag. You can use this to tag a task return + Sets @task's source tag. You can use this to tag a task return value with a particular pointer (usually a pointer to the function doing the tagging) and then later check it using g_task_get_source_tag() (or g_async_result_is_tagged()) in the @@ -71470,38 +75451,38 @@ particular place. - the #GTask + the #GTask - an opaque pointer indicating the source of this task + an opaque pointer indicating the source of this task - Sets @task's task data (freeing the existing task data, if any). + Sets @task's task data (freeing the existing task data, if any). - the #GTask + the #GTask - task-specific data + task-specific data - #GDestroyNotify for @task_data + #GDestroyNotify for @task_data - Whether the task has completed, meaning its callback (if set) has been + Whether the task has completed, meaning its callback (if set) has been invoked. This can only happen after g_task_return_pointer(), g_task_return_error() or one of the other return functions have been called on the task. @@ -71517,7 +75498,7 @@ context as the task’s callback, immediately after that callback is invoke - The prototype for a task function to be run in a thread via + The prototype for a task function to be run in a thread via g_task_run_in_thread() or g_task_run_in_thread_sync(). If the return-on-cancel flag is set on @task, and @cancellable gets @@ -71538,44 +75519,44 @@ Other than in that case, @task will be completed when the - the #GTask + the #GTask - @task's source object + @task's source object - @task's task data + @task's task data - @task's #GCancellable, or %NULL + @task's #GCancellable, or %NULL - This is the subclass of #GSocketConnection that is created + This is the subclass of #GSocketConnection that is created for TCP/IP sockets. - Checks if graceful disconnects are used. See + Checks if graceful disconnects are used. See g_tcp_connection_set_graceful_disconnect(). - %TRUE if graceful disconnect is used on close, %FALSE otherwise + %TRUE if graceful disconnect is used on close, %FALSE otherwise - a #GTcpConnection + a #GTcpConnection - This enables graceful disconnects on close. A graceful disconnect + This enables graceful disconnects on close. A graceful disconnect means that we signal the receiving end that the connection is terminated and wait for it to close the connection before closing the connection. @@ -71590,11 +75571,11 @@ take a while. For this reason it is disabled by default. - a #GTcpConnection + a #GTcpConnection - Whether to do graceful disconnects or not + Whether to do graceful disconnects or not @@ -71619,40 +75600,40 @@ take a while. For this reason it is disabled by default. - A #GTcpWrapperConnection can be used to wrap a #GIOStream that is + A #GTcpWrapperConnection can be used to wrap a #GIOStream that is based on a #GSocket, but which is not actually a #GSocketConnection. This is used by #GSocketClient so that it can always return a #GSocketConnection, even when the connection it has actually created is not directly a #GSocketConnection. - Wraps @base_io_stream and @socket together as a #GSocketConnection. + Wraps @base_io_stream and @socket together as a #GSocketConnection. - the new #GSocketConnection. + the new #GSocketConnection. - the #GIOStream to wrap + the #GIOStream to wrap - the #GSocket associated with @base_io_stream + the #GSocket associated with @base_io_stream - Get's @conn's base #GIOStream + Get's @conn's base #GIOStream - @conn's base #GIOStream + @conn's base #GIOStream - a #GTcpWrapperConnection + a #GTcpWrapperConnection @@ -71677,7 +75658,7 @@ actually created is not directly a #GSocketConnection. - A helper class for testing code which uses D-Bus without touching the user's + A helper class for testing code which uses D-Bus without touching the user's session bus. Note that #GTestDBus modifies the user’s environment, calling setenv(). @@ -71750,21 +75731,21 @@ do the following in the directory holding schemas: CLEANFILES += gschemas.compiled ]| - Create a new #GTestDBus object. + Create a new #GTestDBus object. - a new #GTestDBus. + a new #GTestDBus. - a #GTestDBusFlags + a #GTestDBusFlags - Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test + Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test won't use user's session bus. This is useful for unit tests that want to verify behaviour when no session @@ -71776,7 +75757,7 @@ g_test_dbus_up() before acquiring the session bus. - Add a path where dbus-daemon will look up .service files. This can't be + Add a path where dbus-daemon will look up .service files. This can't be called after g_test_dbus_up(). @@ -71784,20 +75765,20 @@ called after g_test_dbus_up(). - a #GTestDBus + a #GTestDBus - path to a directory containing .service files + path to a directory containing .service files - Stop the session bus started by g_test_dbus_up(). + Stop the session bus started by g_test_dbus_up(). This will wait for the singleton returned by g_bus_get() or g_bus_get_sync() -is destroyed. This is done to ensure that the next unit test won't get a +to be destroyed. This is done to ensure that the next unit test won't get a leaked singleton from this test. @@ -71805,43 +75786,43 @@ leaked singleton from this test. - a #GTestDBus + a #GTestDBus - Get the address on which dbus-daemon is running. If g_test_dbus_up() has not + Get the address on which dbus-daemon is running. If g_test_dbus_up() has not been called yet, %NULL is returned. This can be used with g_dbus_connection_new_for_address(). - the address of the bus, or %NULL. + the address of the bus, or %NULL. - a #GTestDBus + a #GTestDBus - Get the flags of the #GTestDBus object. + Get the flags of the #GTestDBus object. - the value of #GTestDBus:flags property + the value of #GTestDBus:flags property - a #GTestDBus + a #GTestDBus - Stop the session bus started by g_test_dbus_up(). + Stop the session bus started by g_test_dbus_up(). Unlike g_test_dbus_down(), this won't verify the #GDBusConnection singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit @@ -71853,13 +75834,13 @@ can use this function but should still call g_test_dbus_down() when done. - a #GTestDBus + a #GTestDBus - Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this + Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this call, it is safe for unit tests to start sending messages on the session bus. If this function is called from setup callback of g_test_add(), @@ -71873,24 +75854,24 @@ must be called after g_test_run(). - a #GTestDBus + a #GTestDBus - #GTestDBusFlags specifying the behaviour of the D-Bus session. + #GTestDBusFlags specifying the behaviour of the D-Bus session. - Flags to define future #GTestDBus behaviour. + Flags to define future #GTestDBus behaviour. - No flags. + No flags. - #GThemedIcon is an implementation of #GIcon that supports icon themes. + #GThemedIcon is an implementation of #GIcon that supports icon themes. #GThemedIcon contains a list of all of the icons present in an icon theme, so that icons can be looked up quickly. #GThemedIcon does not provide actual pixmaps for icons, just the icon names. @@ -71900,42 +75881,42 @@ themes that inherit other themes. - Creates a new themed icon for @iconname. + Creates a new themed icon for @iconname. - a new #GThemedIcon. + a new #GThemedIcon. - a string containing an icon name. + a string containing an icon name. - Creates a new themed icon for @iconnames. + Creates a new themed icon for @iconnames. - a new #GThemedIcon + a new #GThemedIcon - an array of strings containing icon names. + an array of strings containing icon names. - the length of the @iconnames array, or -1 if @iconnames is + the length of the @iconnames array, or -1 if @iconnames is %NULL-terminated - Creates a new themed icon for @iconname, and all the names + Creates a new themed icon for @iconname, and all the names that can be created by shortening @iconname at '-' characters. In the following example, @icon1 and @icon2 are equivalent: @@ -71952,18 +75933,18 @@ icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio"); ]| - a new #GThemedIcon. + a new #GThemedIcon. - a string containing an icon name + a string containing an icon name - Append a name to the list of icons from within @icon. + Append a name to the list of icons from within @icon. Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). @@ -71973,33 +75954,33 @@ to g_icon_hash(). - a #GThemedIcon + a #GThemedIcon - name of icon to append to list of icons from within @icon. + name of icon to append to list of icons from within @icon. - Gets the names of icons from within @icon. + Gets the names of icons from within @icon. - a list of icon names. + a list of icon names. - a #GThemedIcon. + a #GThemedIcon. - Prepend a name to the list of icons from within @icon. + Prepend a name to the list of icons from within @icon. Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). @@ -72009,27 +75990,27 @@ to g_icon_hash(). - a #GThemedIcon + a #GThemedIcon - name of icon to prepend to list of icons from within @icon. + name of icon to prepend to list of icons from within @icon. - The icon name. + The icon name. - A %NULL-terminated array of icon names. + A %NULL-terminated array of icon names. - Whether to use the default fallbacks found by shortening the icon name + Whether to use the default fallbacks found by shortening the icon name at '-' characters. If the "names" array has more than one element, ignores any past the first. @@ -72051,7 +76032,7 @@ would become - A #GThreadedSocketService is a simple subclass of #GSocketService + A #GThreadedSocketService is a simple subclass of #GSocketService that handles incoming connections by creating a worker thread and dispatching the connection to it by emitting the #GThreadedSocketService::run signal in the new thread. @@ -72068,16 +76049,16 @@ As with #GSocketService, you may connect to #GThreadedSocketService::run, or subclass and override the default handler. - Creates a new #GThreadedSocketService with no listeners. Listeners + Creates a new #GThreadedSocketService with no listeners. Listeners must be added with one of the #GSocketListener "add" methods. - a new #GSocketService. + a new #GSocketService. - the maximal number of threads to execute concurrently + the maximal number of threads to execute concurrently handling incoming clients, -1 means no limit @@ -72110,21 +76091,21 @@ must be added with one of the #GSocketListener "add" methods. - The ::run signal is emitted in a worker thread in response to an + The ::run signal is emitted in a worker thread in response to an incoming connection. This thread is dedicated to handling @connection and may perform blocking IO. The signal handler need not return until the connection is closed. - %TRUE to stop further signal handlers from being called + %TRUE to stop further signal handlers from being called - a new #GSocketConnection object. + a new #GSocketConnection object. - the source_object passed to g_socket_listener_add_address(). + the source_object passed to g_socket_listener_add_address(). @@ -72199,179 +76180,179 @@ not return until the connection is closed. - The client authentication mode for a #GTlsServerConnection. + The client authentication mode for a #GTlsServerConnection. - client authentication not required + client authentication not required - client authentication is requested + client authentication is requested - client authentication is required + client authentication is required - TLS (Transport Layer Security, aka SSL) and DTLS backend. + TLS (Transport Layer Security, aka SSL) and DTLS backend. - Gets the default #GTlsBackend for the system. + Gets the default #GTlsBackend for the system. - a #GTlsBackend + a #GTlsBackend - Gets the default #GTlsDatabase used to verify TLS connections. + Gets the default #GTlsDatabase used to verify TLS connections. - the default database, which should be + the default database, which should be unreffed when done. - the #GTlsBackend + the #GTlsBackend - Checks if DTLS is supported. DTLS support may not be available even if TLS + Checks if DTLS is supported. DTLS support may not be available even if TLS support is available, and vice-versa. - whether DTLS is supported + whether DTLS is supported - the #GTlsBackend + the #GTlsBackend - Checks if TLS is supported; if this returns %FALSE for the default + Checks if TLS is supported; if this returns %FALSE for the default #GTlsBackend, it means no "real" TLS backend is available. - whether or not TLS is supported + whether or not TLS is supported - the #GTlsBackend + the #GTlsBackend - Gets the #GType of @backend's #GTlsCertificate implementation. + Gets the #GType of @backend's #GTlsCertificate implementation. - the #GType of @backend's #GTlsCertificate + the #GType of @backend's #GTlsCertificate implementation. - the #GTlsBackend + the #GTlsBackend - Gets the #GType of @backend's #GTlsClientConnection implementation. + Gets the #GType of @backend's #GTlsClientConnection implementation. - the #GType of @backend's #GTlsClientConnection + the #GType of @backend's #GTlsClientConnection implementation. - the #GTlsBackend + the #GTlsBackend - Gets the default #GTlsDatabase used to verify TLS connections. + Gets the default #GTlsDatabase used to verify TLS connections. - the default database, which should be + the default database, which should be unreffed when done. - the #GTlsBackend + the #GTlsBackend - Gets the #GType of @backend’s #GDtlsClientConnection implementation. + Gets the #GType of @backend’s #GDtlsClientConnection implementation. - the #GType of @backend’s #GDtlsClientConnection + the #GType of @backend’s #GDtlsClientConnection implementation, or %G_TYPE_INVALID if this backend doesn’t support DTLS. - the #GTlsBackend + the #GTlsBackend - Gets the #GType of @backend’s #GDtlsServerConnection implementation. + Gets the #GType of @backend’s #GDtlsServerConnection implementation. - the #GType of @backend’s #GDtlsServerConnection + the #GType of @backend’s #GDtlsServerConnection implementation, or %G_TYPE_INVALID if this backend doesn’t support DTLS. - the #GTlsBackend + the #GTlsBackend - Gets the #GType of @backend's #GTlsFileDatabase implementation. + Gets the #GType of @backend's #GTlsFileDatabase implementation. - the #GType of backend's #GTlsFileDatabase implementation. + the #GType of backend's #GTlsFileDatabase implementation. - the #GTlsBackend + the #GTlsBackend - Gets the #GType of @backend's #GTlsServerConnection implementation. + Gets the #GType of @backend's #GTlsServerConnection implementation. - the #GType of @backend's #GTlsServerConnection + the #GType of @backend's #GTlsServerConnection implementation. - the #GTlsBackend + the #GTlsBackend - Set the default #GTlsDatabase used to verify TLS connections + Set the default #GTlsDatabase used to verify TLS connections Any subsequent call to g_tls_backend_get_default_database() will return the database set in this call. Existing databases and connections are not @@ -72385,41 +76366,41 @@ database as if g_tls_backend_set_default_database() had never been called. - the #GTlsBackend + the #GTlsBackend - the #GTlsDatabase + the #GTlsDatabase - Checks if DTLS is supported. DTLS support may not be available even if TLS + Checks if DTLS is supported. DTLS support may not be available even if TLS support is available, and vice-versa. - whether DTLS is supported + whether DTLS is supported - the #GTlsBackend + the #GTlsBackend - Checks if TLS is supported; if this returns %FALSE for the default + Checks if TLS is supported; if this returns %FALSE for the default #GTlsBackend, it means no "real" TLS backend is available. - whether or not TLS is supported + whether or not TLS is supported - the #GTlsBackend + the #GTlsBackend @@ -72436,12 +76417,12 @@ support is available, and vice-versa. - whether or not TLS is supported + whether or not TLS is supported - the #GTlsBackend + the #GTlsBackend @@ -72483,13 +76464,13 @@ support is available, and vice-versa. - the default database, which should be + the default database, which should be unreffed when done. - the #GTlsBackend + the #GTlsBackend @@ -72499,12 +76480,12 @@ support is available, and vice-versa. - whether DTLS is supported + whether DTLS is supported - the #GTlsBackend + the #GTlsBackend @@ -72528,14 +76509,14 @@ support is available, and vice-versa. - A certificate used for TLS authentication and encryption. + A certificate used for TLS authentication and encryption. This can represent either a certificate only (eg, the certificate received by a client from a server), or the combination of a certificate and a private key (which is needed when acting as a #GTlsServerConnection). - Creates a #GTlsCertificate from the PEM-encoded data in @file. The + Creates a #GTlsCertificate from the PEM-encoded data in @file. The returned certificate will be the first certificate found in @file. As of GLib 2.44, if @file contains more certificates it will try to load a certificate chain. All certificates will be verified in the order @@ -72550,18 +76531,18 @@ set @error. Otherwise, this behaves like g_tls_certificate_new_from_pem(). - the new certificate, or %NULL on error + the new certificate, or %NULL on error - file containing a PEM-encoded certificate to import + file containing a PEM-encoded certificate to import - Creates a #GTlsCertificate from the PEM-encoded data in @cert_file + Creates a #GTlsCertificate from the PEM-encoded data in @cert_file and @key_file. The returned certificate will be the first certificate found in @cert_file. As of GLib 2.44, if @cert_file contains more certificates it will try to load a certificate chain. All @@ -72577,24 +76558,24 @@ If either file cannot be read or parsed, the function will return g_tls_certificate_new_from_pem(). - the new certificate, or %NULL on error + the new certificate, or %NULL on error - file containing one or more PEM-encoded + file containing one or more PEM-encoded certificates to import - file containing a PEM-encoded private key + file containing a PEM-encoded private key to import - Creates a #GTlsCertificate from the PEM-encoded data in @data. If + Creates a #GTlsCertificate from the PEM-encoded data in @data. If @data includes both a certificate and a private key, then the returned certificate will include the private key data as well. (See the #GTlsCertificate:private-key-pem property for information about @@ -72610,29 +76591,29 @@ certificate in the chain cannot be verified, the first certificate in the file will still be returned. - the new certificate, or %NULL if @data is invalid + the new certificate, or %NULL if @data is invalid - PEM-encoded certificate data + PEM-encoded certificate data - the length of @data, or -1 if it's 0-terminated. + the length of @data, or -1 if it's 0-terminated. - Creates one or more #GTlsCertificates from the PEM-encoded + Creates one or more #GTlsCertificates from the PEM-encoded data in @file. If @file cannot be read or parsed, the function will return %NULL and set @error. If @file does not contain any PEM-encoded certificates, this will return an empty list and not set @error. - a + a #GList containing #GTlsCertificate objects. You must free the list and its contents when you are done with it. @@ -72641,13 +76622,13 @@ and its contents when you are done with it. - file containing PEM-encoded certificates to import + file containing PEM-encoded certificates to import - This verifies @cert and returns a set of #GTlsCertificateFlags + This verifies @cert and returns a set of #GTlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system @@ -72668,64 +76649,64 @@ value. as appropriate.) - the appropriate #GTlsCertificateFlags + the appropriate #GTlsCertificateFlags - a #GTlsCertificate + a #GTlsCertificate - the expected peer identity + the expected peer identity - the certificate of a trusted authority + the certificate of a trusted authority - Gets the #GTlsCertificate representing @cert's issuer, if known + Gets the #GTlsCertificate representing @cert's issuer, if known - The certificate of @cert's issuer, + The certificate of @cert's issuer, or %NULL if @cert is self-signed or signed with an unknown certificate. - a #GTlsCertificate + a #GTlsCertificate - Check if two #GTlsCertificate objects represent the same certificate. + Check if two #GTlsCertificate objects represent the same certificate. The raw DER byte data of the two certificates are checked for equality. This has the effect that two certificates may compare equal even if their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or #GTlsCertificate:private-key-pem properties differ. - whether the same or not + whether the same or not - first certificate to compare + first certificate to compare - second certificate to compare + second certificate to compare - This verifies @cert and returns a set of #GTlsCertificateFlags + This verifies @cert and returns a set of #GTlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system @@ -72746,26 +76727,26 @@ value. as appropriate.) - the appropriate #GTlsCertificateFlags + the appropriate #GTlsCertificateFlags - a #GTlsCertificate + a #GTlsCertificate - the expected peer identity + the expected peer identity - the certificate of a trusted authority + the certificate of a trusted authority - The DER (binary) encoded representation of the certificate. + The DER (binary) encoded representation of the certificate. This property and the #GTlsCertificate:certificate-pem property represent the same data, just in different forms. @@ -72773,20 +76754,20 @@ represent the same data, just in different forms. - The PEM (ASCII) encoded representation of the certificate. + The PEM (ASCII) encoded representation of the certificate. This property and the #GTlsCertificate:certificate property represent the same data, just in different forms. - A #GTlsCertificate representing the entity that issued this + A #GTlsCertificate representing the entity that issued this certificate. If %NULL, this means that the certificate is either self-signed, or else the certificate of the issuer is not available. - The DER (binary) encoded representation of the certificate's + The DER (binary) encoded representation of the certificate's private key, in either PKCS#1 format or unencrypted PKCS#8 format. This property (or the #GTlsCertificate:private-key-pem property) can be set when constructing a key (eg, from a file), @@ -72800,7 +76781,7 @@ tool to convert PKCS#8 keys to PKCS#1. - The PEM (ASCII) encoded representation of the certificate's + The PEM (ASCII) encoded representation of the certificate's private key in either PKCS#1 format ("`BEGIN RSA PRIVATE KEY`") or unencrypted PKCS#8 format ("`BEGIN PRIVATE KEY`"). This property (or the @@ -72828,20 +76809,20 @@ tool to convert PKCS#8 keys to PKCS#1. - the appropriate #GTlsCertificateFlags + the appropriate #GTlsCertificateFlags - a #GTlsCertificate + a #GTlsCertificate - the expected peer identity + the expected peer identity - the certificate of a trusted authority + the certificate of a trusted authority @@ -72854,40 +76835,40 @@ tool to convert PKCS#8 keys to PKCS#1. - A set of flags describing TLS certification validation. This can be + A set of flags describing TLS certification validation. This can be used to set which validation steps to perform (eg, with g_tls_client_connection_set_validation_flags()), or to describe why a particular certificate was rejected (eg, in #GTlsConnection::accept-certificate). - The signing certificate authority is + The signing certificate authority is not known. - The certificate does not match the + The certificate does not match the expected identity of the site that it was retrieved from. - The certificate's activation time + The certificate's activation time is still in the future - The certificate has expired + The certificate has expired - The certificate has been revoked + The certificate has been revoked according to the #GTlsConnection's certificate revocation list. - The certificate's algorithm is + The certificate's algorithm is considered insecure. - Some other error occurred validating + Some other error occurred validating the certificate - the combination of all of the above + the combination of all of the above flags @@ -72895,20 +76876,20 @@ a particular certificate was rejected (eg, in - Flags for g_tls_interaction_request_certificate(), + Flags for g_tls_interaction_request_certificate(), g_tls_interaction_request_certificate_async(), and g_tls_interaction_invoke_request_certificate(). - No flags + No flags - #GTlsClientConnection is the client-side subclass of + #GTlsClientConnection is the client-side subclass of #GTlsConnection, representing a client-side TLS connection. - Creates a new #GTlsClientConnection wrapping @base_io_stream (which + Creates a new #GTlsClientConnection wrapping @base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by @server_identity. @@ -72917,23 +76898,23 @@ on when application code can run operations on the @base_io_stream after this function has returned. - the new + the new #GTlsClientConnection, or %NULL on error - the #GIOStream to wrap + the #GIOStream to wrap - the expected identity of the server + the expected identity of the server - Copies session state from one connection to another. This is + Copies session state from one connection to another. This is not normally needed, but may be used when the same session needs to be used between different endpoints as is required by some protocols such as FTP over TLS. @source should have @@ -72945,17 +76926,17 @@ completed a handshake. - a #GTlsClientConnection + a #GTlsClientConnection - a #GTlsClientConnection + a #GTlsClientConnection - Copies session state from one connection to another. This is + Copies session state from one connection to another. This is not normally needed, but may be used when the same session needs to be used between different endpoints as is required by some protocols such as FTP over TLS. @source should have @@ -72967,17 +76948,17 @@ completed a handshake. - a #GTlsClientConnection + a #GTlsClientConnection - a #GTlsClientConnection + a #GTlsClientConnection - Gets the list of distinguished names of the Certificate Authorities + Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be %NULL. @@ -72986,7 +76967,7 @@ Each item in the list is a #GByteArray which contains the complete subject DN of the certificate authority. - the list of + the list of CA DNs. You should unref each element with g_byte_array_unref() and then the free the list with g_list_free(). @@ -72997,61 +76978,61 @@ the free the list with g_list_free(). - the #GTlsClientConnection + the #GTlsClientConnection - Gets @conn's expected server identity + Gets @conn's expected server identity - a #GSocketConnectable describing the + a #GSocketConnectable describing the expected server identity, or %NULL if the expected identity is not known. - the #GTlsClientConnection + the #GTlsClientConnection - Gets whether @conn will force the lowest-supported TLS protocol + Gets whether @conn will force the lowest-supported TLS protocol version rather than attempt to negotiate the highest mutually- supported version of TLS; see g_tls_client_connection_set_use_ssl3(). SSL 3.0 is insecure, and this function does not actually indicate whether it is enabled. - whether @conn will use the lowest-supported TLS protocol version + whether @conn will use the lowest-supported TLS protocol version - the #GTlsClientConnection + the #GTlsClientConnection - Gets @conn's validation flags + Gets @conn's validation flags - the validation flags + the validation flags - the #GTlsClientConnection + the #GTlsClientConnection - Sets @conn's expected server identity, which is used both to tell + Sets @conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let @conn know what name to look for in the certificate when performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. @@ -73061,17 +77042,17 @@ performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. - the #GTlsClientConnection + the #GTlsClientConnection - a #GSocketConnectable describing the expected server identity + a #GSocketConnectable describing the expected server identity - Since 2.42.1, if @use_ssl3 is %TRUE, this forces @conn to use the + Since 2.42.1, if @use_ssl3 is %TRUE, this forces @conn to use the lowest-supported TLS protocol version rather than trying to properly negotiate the highest mutually-supported protocol version with the peer. Be aware that SSL 3.0 is generally disabled by the @@ -73092,17 +77073,17 @@ generally enable or disable it, despite its name. - the #GTlsClientConnection + the #GTlsClientConnection - whether to use the lowest-supported protocol version + whether to use the lowest-supported protocol version - Sets @conn's validation flags, to override the default set of + Sets @conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, %G_TLS_CERTIFICATE_VALIDATE_ALL is used. @@ -73111,17 +77092,17 @@ checks performed when validating a server certificate. By default, - the #GTlsClientConnection + the #GTlsClientConnection - the #GTlsCertificateFlags to use + the #GTlsCertificateFlags to use - A list of the distinguished names of the Certificate Authorities + A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes. @@ -73133,7 +77114,7 @@ subject DN of the certificate authority. - A #GSocketConnectable describing the identity of the server that + A #GSocketConnectable describing the identity of the server that is expected on the other end of the connection. If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in @@ -73150,7 +77131,7 @@ virtual hosts. - If %TRUE, forces the connection to use a fallback version of TLS + If %TRUE, forces the connection to use a fallback version of TLS or SSL, rather than trying to negotiate the best version of TLS to use. See g_tls_client_connection_set_use_ssl3(). SSL 3.0 is insecure, and this property does not @@ -73158,7 +77139,7 @@ generally enable or disable it, despite its name. - What steps to perform when validating a certificate received from + What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in all of the ways indicated here will be rejected unless the application overrides the default via #GTlsConnection::accept-certificate. @@ -73180,11 +77161,11 @@ overrides the default via #GTlsConnection::accept-certificate. - a #GTlsClientConnection + a #GTlsClientConnection - a #GTlsClientConnection + a #GTlsClientConnection @@ -73192,7 +77173,7 @@ overrides the default via #GTlsConnection::accept-certificate. - #GTlsConnection is the base TLS connection class type, which wraps + #GTlsConnection is the base TLS connection class type, which wraps a #GIOStream and provides TLS encryption on top of it. Its subclasses, #GTlsClientConnection and #GTlsServerConnection, implement client-side and server-side TLS, respectively. @@ -73217,7 +77198,7 @@ For DTLS (Datagram TLS) support, see #GDtlsConnection. - Attempts a TLS handshake on @conn. + Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -73248,22 +77229,22 @@ older versions of GLib. handshake. - success or failure + success or failure - a #GTlsConnection + a #GTlsConnection - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously performs a TLS handshake on @conn. See + Asynchronously performs a TLS handshake on @conn. See g_tls_connection_handshake() for more information. @@ -73271,222 +77252,222 @@ g_tls_connection_handshake() for more information. - a #GTlsConnection + a #GTlsConnection - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the handshake is complete + callback to call when the handshake is complete - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous TLS handshake operation. See + Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set. - a #GTlsConnection + a #GTlsConnection - a #GAsyncResult. + a #GAsyncResult. - Used by #GTlsConnection implementations to emit the + Used by #GTlsConnection implementations to emit the #GTlsConnection::accept-certificate signal. - + - %TRUE if one of the signal handlers has returned + %TRUE if one of the signal handlers has returned %TRUE to accept @peer_cert - a #GTlsConnection + a #GTlsConnection - the peer's #GTlsCertificate + the peer's #GTlsCertificate - the problems with @peer_cert + the problems with @peer_cert - Gets @conn's certificate, as set by + Gets @conn's certificate, as set by g_tls_connection_set_certificate(). - @conn's certificate, or %NULL + @conn's certificate, or %NULL - a #GTlsConnection + a #GTlsConnection - Gets the certificate database that @conn uses to verify + Gets the certificate database that @conn uses to verify peer certificates. See g_tls_connection_set_database(). - the certificate database that @conn uses or %NULL + the certificate database that @conn uses or %NULL - a #GTlsConnection + a #GTlsConnection - Get the object that will be used to interact with the user. It will be used + Get the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. If %NULL is returned, then no user interaction will occur for this connection. - The interaction object. + The interaction object. - a connection + a connection - Gets the name of the application-layer protocol negotiated during + Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_tls_connection_set_advertised_protocols(). - + - the negotiated protocol, or %NULL + the negotiated protocol, or %NULL - a #GTlsConnection + a #GTlsConnection - Gets @conn's peer's certificate after the handshake has completed. + Gets @conn's peer's certificate after the handshake has completed. (It is not set during the emission of #GTlsConnection::accept-certificate.) - @conn's peer's certificate, or %NULL + @conn's peer's certificate, or %NULL - a #GTlsConnection + a #GTlsConnection - Gets the errors associated with validating @conn's peer's + Gets the errors associated with validating @conn's peer's certificate, after the handshake has completed. (It is not set during the emission of #GTlsConnection::accept-certificate.) - @conn's peer's certificate errors + @conn's peer's certificate errors - a #GTlsConnection + a #GTlsConnection - Gets @conn rehandshaking mode. See + Gets @conn rehandshaking mode. See g_tls_connection_set_rehandshake_mode() for details. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + - @conn's rehandshaking mode + @conn's rehandshaking mode - a #GTlsConnection + a #GTlsConnection - Tests whether or not @conn expects a proper TLS close notification + Tests whether or not @conn expects a proper TLS close notification when the connection is closed. See g_tls_connection_set_require_close_notify() for details. - %TRUE if @conn requires a proper TLS close + %TRUE if @conn requires a proper TLS close notification. - a #GTlsConnection + a #GTlsConnection - Gets whether @conn uses the system certificate database to verify + Gets whether @conn uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb(). Use g_tls_connection_get_database() instead - whether @conn uses the system certificate database + whether @conn uses the system certificate database - a #GTlsConnection + a #GTlsConnection - Attempts a TLS handshake on @conn. + Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -73515,74 +77496,74 @@ older versions of GLib. #GTlsConnection::accept_certificate may be emitted during the handshake. - + - success or failure + success or failure - a #GTlsConnection + a #GTlsConnection - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously performs a TLS handshake on @conn. See + Asynchronously performs a TLS handshake on @conn. See g_tls_connection_handshake() for more information. - + - a #GTlsConnection + a #GTlsConnection - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the handshake is complete + callback to call when the handshake is complete - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous TLS handshake operation. See + Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. - + - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set. - a #GTlsConnection + a #GTlsConnection - a #GAsyncResult. + a #GAsyncResult. - Sets the list of application-layer protocols to advertise that the + Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -73592,17 +77573,17 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + - a #GTlsConnection + a #GTlsConnection - a %NULL-terminated + a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -73611,7 +77592,7 @@ for a list of registered protocol IDs. - This sets the certificate that @conn will present to its peer + This sets the certificate that @conn will present to its peer during the TLS handshake. For a #GTlsServerConnection, it is mandatory to set this, and that will normally be done at construct time. @@ -73635,17 +77616,17 @@ non-%NULL.) - a #GTlsConnection + a #GTlsConnection - the certificate to use for @conn + the certificate to use for @conn - Sets the certificate database that is used to verify peer certificates. + Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to %NULL, then peer certificate validation will always set the @@ -73659,17 +77640,17 @@ client-side connections, unless that bit is not set in - a #GTlsConnection + a #GTlsConnection - a #GTlsDatabase + a #GTlsDatabase - Set the object that will be used to interact with the user. It will be used + Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. The @interaction argument will normally be a derived subclass of @@ -73681,17 +77662,17 @@ should occur for this connection. - a connection + a connection - an interaction object, or %NULL + an interaction object, or %NULL - Sets how @conn behaves with respect to rehandshaking requests, when + Sets how @conn behaves with respect to rehandshaking requests, when TLS 1.2 or older is in use. %G_TLS_REHANDSHAKE_NEVER means that it will never agree to @@ -73715,23 +77696,23 @@ software. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + - a #GTlsConnection + a #GTlsConnection - the rehandshaking mode + the rehandshaking mode - Sets whether or not @conn expects a proper TLS close notification + Sets whether or not @conn expects a proper TLS close notification before the connection is closed. If this is %TRUE (the default), then @conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a @@ -73764,17 +77745,17 @@ operations are pending on @conn or the base I/O stream. - a #GTlsConnection + a #GTlsConnection - whether or not to require close notification + whether or not to require close notification - Sets whether @conn uses the system certificate database to verify + Sets whether @conn uses the system certificate database to verify peer certificates. This is %TRUE by default. If set to %FALSE, then peer certificate validation will always set the %G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning @@ -73788,17 +77769,17 @@ client-side connections, unless that bit is not set in - a #GTlsConnection + a #GTlsConnection - whether to use the system certificate database + whether to use the system certificate database - The list of application-layer protocols that the connection + The list of application-layer protocols that the connection advertises that it is willing to speak. See g_tls_connection_set_advertised_protocols(). @@ -73806,7 +77787,7 @@ g_tls_connection_set_advertised_protocols(). - The #GIOStream that the connection wraps. The connection holds a reference + The #GIOStream that the connection wraps. The connection holds a reference to this stream, and may run operations on the stream from other threads throughout its lifetime. Consequently, after the #GIOStream has been constructed, application code may only run its own operations on this @@ -73814,29 +77795,29 @@ stream when no #GIOStream operations are running. - The connection's certificate; see + The connection's certificate; see g_tls_connection_set_certificate(). - The certificate database to use when verifying this TLS connection. + The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database(). - A #GTlsInteraction object to be used when the connection or certificate + A #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. - The application-layer protocol negotiated during the TLS + The application-layer protocol negotiated during the TLS handshake. See g_tls_connection_get_negotiated_protocol(). - The connection's peer's certificate, after the TLS handshake has + The connection's peer's certificate, after the TLS handshake has completed and the certificate has been accepted. Note in particular that this is not yet set during the emission of #GTlsConnection::accept-certificate. @@ -73846,7 +77827,7 @@ detect when a handshake has occurred.) - The errors noticed-and-ignored while verifying + The errors noticed-and-ignored while verifying #GTlsConnection:peer-certificate. Normally this should be 0, but it may not be if #GTlsClientConnection:validation-flags is not %G_TLS_CERTIFICATE_VALIDATE_ALL, or if @@ -73855,17 +77836,17 @@ behavior. - The rehandshaking mode. See + The rehandshaking mode. See g_tls_connection_set_rehandshake_mode(). - Whether or not proper TLS close notification is required. + Whether or not proper TLS close notification is required. See g_tls_connection_set_require_close_notify(). - Whether or not the system certificate database will be used to + Whether or not the system certificate database will be used to verify peer certificates. See g_tls_connection_set_use_system_certdb(). Use GTlsConnection:database instead @@ -73878,7 +77859,7 @@ g_tls_connection_set_use_system_certdb(). - Emitted during the TLS handshake after the peer certificate has + Emitted during the TLS handshake after the peer certificate has been received. You can examine @peer_cert's certification path by calling g_tls_certificate_get_issuer() on it. @@ -73912,7 +77893,7 @@ If you are doing I/O in another thread, you do not need to worry about this, and can simply block in the signal handler until the UI thread returns an answer. - %TRUE to accept @peer_cert (which will also + %TRUE to accept @peer_cert (which will also immediately end the signal emission). %FALSE to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it. @@ -73920,11 +77901,11 @@ no one else overrides it. - the peer's #GTlsCertificate + the peer's #GTlsCertificate - the problems with @peer_cert. + the problems with @peer_cert. @@ -73958,16 +77939,16 @@ no one else overrides it. - success or failure + success or failure - a #GTlsConnection + a #GTlsConnection - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -73981,23 +77962,23 @@ no one else overrides it. - a #GTlsConnection + a #GTlsConnection - the [I/O priority][io-priority] of the request + the [I/O priority][io-priority] of the request - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the handshake is complete + callback to call when the handshake is complete - the data to pass to the callback function + the data to pass to the callback function @@ -74007,17 +77988,17 @@ no one else overrides it. - %TRUE on success, %FALSE on failure, in which + %TRUE on success, %FALSE on failure, in which case @error will be set. - a #GTlsConnection + a #GTlsConnection - a #GAsyncResult. + a #GAsyncResult. @@ -74033,7 +78014,7 @@ case @error will be set. - #GTlsDatabase is used to lookup certificates and other information + #GTlsDatabase is used to look up certificates and other information from a certificate or key store. It is an abstract base class which TLS library specific subtypes override. @@ -74044,7 +78025,7 @@ Most common client applications will not directly interact with #GTlsDatabase. It is used internally by #GTlsConnection. - Create a handle string for the certificate. The database will only be able + Create a handle string for the certificate. The database will only be able to create a handle for certificates that originate from the database. In cases where the database cannot create a handle for a certificate, %NULL will be returned. @@ -74054,23 +78035,23 @@ and between applications. If a certificate is modified in the database, then it is not guaranteed that this handle will continue to point to it. - a newly allocated string containing the + a newly allocated string containing the handle. - a #GTlsDatabase + a #GTlsDatabase - certificate for which to create a handle. + certificate for which to create a handle. - Lookup a certificate by its handle. + Look up a certificate by its handle. The handle should have been created by calling g_tls_database_create_certificate_handle() on a #GTlsDatabase object of @@ -74084,35 +78065,35 @@ This function can block, use g_tls_database_lookup_certificate_for_handle_async( the lookup operation asynchronously. - a newly allocated + a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a certificate handle + a certificate handle - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup. + Flags which affect the lookup. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously lookup a certificate by its handle in the database. See + Asynchronously look up a certificate by its handle in the database. See g_tls_database_lookup_certificate_for_handle() for more information. @@ -74120,60 +78101,60 @@ g_tls_database_lookup_certificate_for_handle() for more information. - a #GTlsDatabase + a #GTlsDatabase - a certificate handle + a certificate handle - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup. + Flags which affect the lookup. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous lookup of a certificate by its handle. See -g_tls_database_lookup_certificate_by_handle() for more information. + Finish an asynchronous lookup of a certificate by its handle. See +g_tls_database_lookup_certificate_for_handle() for more information. If the handle is no longer valid, or does not point to a certificate in this database, then %NULL will be returned. - a newly allocated #GTlsCertificate object. + a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. - Lookup the issuer of @certificate in the database. + Look up the issuer of @certificate in the database. The #GTlsCertificate:issuer property of @certificate is not modified, and the two certificates are not hooked @@ -74183,35 +78164,35 @@ This function can block, use g_tls_database_lookup_certificate_issuer_async() to the lookup operation asynchronously. - a newly allocated issuer #GTlsCertificate, + a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate + a #GTlsCertificate - used to interact with the user if necessary + used to interact with the user if necessary - flags which affect the lookup operation + flags which affect the lookup operation - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously lookup the issuer of @certificate in the database. See + Asynchronously look up the issuer of @certificate in the database. See g_tls_database_lookup_certificate_issuer() for more information. @@ -74219,63 +78200,63 @@ g_tls_database_lookup_certificate_issuer() for more information. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate + a #GTlsCertificate - used to interact with the user if necessary + used to interact with the user if necessary - flags which affect the lookup operation + flags which affect the lookup operation - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous lookup issuer operation. See + Finish an asynchronous lookup issuer operation. See g_tls_database_lookup_certificate_issuer() for more information. - a newly allocated issuer #GTlsCertificate, + a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. - Lookup certificates issued by this issuer in the database. + Look up certificates issued by this issuer in the database. This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform the lookup operation asynchronously. - a newly allocated list of #GTlsCertificate + a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -74283,31 +78264,31 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a #GTlsDatabase + a #GTlsDatabase - a #GByteArray which holds the DER encoded issuer DN. + a #GByteArray which holds the DER encoded issuer DN. - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup operation. + Flags which affect the lookup operation. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously lookup certificates issued by this issuer in the database. See + Asynchronously look up certificates issued by this issuer in the database. See g_tls_database_lookup_certificates_issued_by() for more information. The database may choose to hold a reference to the issuer byte array for the duration @@ -74319,43 +78300,43 @@ this time. - a #GTlsDatabase + a #GTlsDatabase - a #GByteArray which holds the DER encoded issuer DN. + a #GByteArray which holds the DER encoded issuer DN. - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup operation. + Flags which affect the lookup operation. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous lookup of certificates. See + Finish an asynchronous lookup of certificates. See g_tls_database_lookup_certificates_issued_by() for more information. - a newly allocated list of #GTlsCertificate + a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -74363,17 +78344,17 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. - Determines the validity of a certificate chain after looking up and + Determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. @chain is a chain of #GTlsCertificate objects each pointing to the next @@ -74408,43 +78389,43 @@ This function can block, use g_tls_database_verify_chain_async() to perform the verification operation asynchronously. - the appropriate #GTlsCertificateFlags which represents the + the appropriate #GTlsCertificateFlags which represents the result of verification. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate chain + a #GTlsCertificate chain - the purpose that this certificate chain will be used for. + the purpose that this certificate chain will be used for. - the expected peer identity + the expected peer identity - used to interact with the user if necessary + used to interact with the user if necessary - additional verify flags + additional verify flags - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously determines the validity of a certificate chain after + Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. See g_tls_database_verify_chain() for more information. @@ -74453,45 +78434,45 @@ g_tls_database_verify_chain() for more information. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate chain + a #GTlsCertificate chain - the purpose that this certificate chain will be used for. + the purpose that this certificate chain will be used for. - the expected peer identity + the expected peer identity - used to interact with the user if necessary + used to interact with the user if necessary - additional verify flags + additional verify flags - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous verify chain operation. See + Finish an asynchronous verify chain operation. See g_tls_database_verify_chain() for more information. If @chain is found to be valid, then the return value will be 0. If @@ -74504,23 +78485,23 @@ accordingly. @error is not set when @chain is successfully analyzed but found to be invalid. - the appropriate #GTlsCertificateFlags which represents the + the appropriate #GTlsCertificateFlags which represents the result of verification. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. - Create a handle string for the certificate. The database will only be able + Create a handle string for the certificate. The database will only be able to create a handle for certificates that originate from the database. In cases where the database cannot create a handle for a certificate, %NULL will be returned. @@ -74530,23 +78511,23 @@ and between applications. If a certificate is modified in the database, then it is not guaranteed that this handle will continue to point to it. - a newly allocated string containing the + a newly allocated string containing the handle. - a #GTlsDatabase + a #GTlsDatabase - certificate for which to create a handle. + certificate for which to create a handle. - Lookup a certificate by its handle. + Look up a certificate by its handle. The handle should have been created by calling g_tls_database_create_certificate_handle() on a #GTlsDatabase object of @@ -74560,35 +78541,35 @@ This function can block, use g_tls_database_lookup_certificate_for_handle_async( the lookup operation asynchronously. - a newly allocated + a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a certificate handle + a certificate handle - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup. + Flags which affect the lookup. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously lookup a certificate by its handle in the database. See + Asynchronously look up a certificate by its handle in the database. See g_tls_database_lookup_certificate_for_handle() for more information. @@ -74596,60 +78577,60 @@ g_tls_database_lookup_certificate_for_handle() for more information. - a #GTlsDatabase + a #GTlsDatabase - a certificate handle + a certificate handle - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup. + Flags which affect the lookup. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous lookup of a certificate by its handle. See -g_tls_database_lookup_certificate_by_handle() for more information. + Finish an asynchronous lookup of a certificate by its handle. See +g_tls_database_lookup_certificate_for_handle() for more information. If the handle is no longer valid, or does not point to a certificate in this database, then %NULL will be returned. - a newly allocated #GTlsCertificate object. + a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. - Lookup the issuer of @certificate in the database. + Look up the issuer of @certificate in the database. The #GTlsCertificate:issuer property of @certificate is not modified, and the two certificates are not hooked @@ -74659,35 +78640,35 @@ This function can block, use g_tls_database_lookup_certificate_issuer_async() to the lookup operation asynchronously. - a newly allocated issuer #GTlsCertificate, + a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate + a #GTlsCertificate - used to interact with the user if necessary + used to interact with the user if necessary - flags which affect the lookup operation + flags which affect the lookup operation - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously lookup the issuer of @certificate in the database. See + Asynchronously look up the issuer of @certificate in the database. See g_tls_database_lookup_certificate_issuer() for more information. @@ -74695,63 +78676,63 @@ g_tls_database_lookup_certificate_issuer() for more information. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate + a #GTlsCertificate - used to interact with the user if necessary + used to interact with the user if necessary - flags which affect the lookup operation + flags which affect the lookup operation - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous lookup issuer operation. See + Finish an asynchronous lookup issuer operation. See g_tls_database_lookup_certificate_issuer() for more information. - a newly allocated issuer #GTlsCertificate, + a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. - Lookup certificates issued by this issuer in the database. + Look up certificates issued by this issuer in the database. This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform the lookup operation asynchronously. - a newly allocated list of #GTlsCertificate + a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -74759,31 +78740,31 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a #GTlsDatabase + a #GTlsDatabase - a #GByteArray which holds the DER encoded issuer DN. + a #GByteArray which holds the DER encoded issuer DN. - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup operation. + Flags which affect the lookup operation. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously lookup certificates issued by this issuer in the database. See + Asynchronously look up certificates issued by this issuer in the database. See g_tls_database_lookup_certificates_issued_by() for more information. The database may choose to hold a reference to the issuer byte array for the duration @@ -74795,43 +78776,43 @@ this time. - a #GTlsDatabase + a #GTlsDatabase - a #GByteArray which holds the DER encoded issuer DN. + a #GByteArray which holds the DER encoded issuer DN. - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup operation. + Flags which affect the lookup operation. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous lookup of certificates. See + Finish an asynchronous lookup of certificates. See g_tls_database_lookup_certificates_issued_by() for more information. - a newly allocated list of #GTlsCertificate + a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -74839,17 +78820,17 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. - Determines the validity of a certificate chain after looking up and + Determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. @chain is a chain of #GTlsCertificate objects each pointing to the next @@ -74884,43 +78865,43 @@ This function can block, use g_tls_database_verify_chain_async() to perform the verification operation asynchronously. - the appropriate #GTlsCertificateFlags which represents the + the appropriate #GTlsCertificateFlags which represents the result of verification. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate chain + a #GTlsCertificate chain - the purpose that this certificate chain will be used for. + the purpose that this certificate chain will be used for. - the expected peer identity + the expected peer identity - used to interact with the user if necessary + used to interact with the user if necessary - additional verify flags + additional verify flags - a #GCancellable, or %NULL + a #GCancellable, or %NULL - Asynchronously determines the validity of a certificate chain after + Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. See g_tls_database_verify_chain() for more information. @@ -74929,45 +78910,45 @@ g_tls_database_verify_chain() for more information. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate chain + a #GTlsCertificate chain - the purpose that this certificate chain will be used for. + the purpose that this certificate chain will be used for. - the expected peer identity + the expected peer identity - used to interact with the user if necessary + used to interact with the user if necessary - additional verify flags + additional verify flags - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function - Finish an asynchronous verify chain operation. See + Finish an asynchronous verify chain operation. See g_tls_database_verify_chain() for more information. If @chain is found to be valid, then the return value will be 0. If @@ -74980,17 +78961,17 @@ accordingly. @error is not set when @chain is successfully analyzed but found to be invalid. - the appropriate #GTlsCertificateFlags which represents the + the appropriate #GTlsCertificateFlags which represents the result of verification. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. @@ -75003,7 +78984,7 @@ result of verification. - The class for #GTlsDatabase. Derived classes should implement the various + The class for #GTlsDatabase. Derived classes should implement the various virtual methods. _async and _finish methods have a default implementation that runs the corresponding sync method in a thread. @@ -75014,37 +78995,37 @@ implementation that runs the corresponding sync method in a thread. - the appropriate #GTlsCertificateFlags which represents the + the appropriate #GTlsCertificateFlags which represents the result of verification. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate chain + a #GTlsCertificate chain - the purpose that this certificate chain will be used for. + the purpose that this certificate chain will be used for. - the expected peer identity + the expected peer identity - used to interact with the user if necessary + used to interact with the user if necessary - additional verify flags + additional verify flags - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -75058,39 +79039,39 @@ result of verification. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate chain + a #GTlsCertificate chain - the purpose that this certificate chain will be used for. + the purpose that this certificate chain will be used for. - the expected peer identity + the expected peer identity - used to interact with the user if necessary + used to interact with the user if necessary - additional verify flags + additional verify flags - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function @@ -75100,17 +79081,17 @@ result of verification. - the appropriate #GTlsCertificateFlags which represents the + the appropriate #GTlsCertificateFlags which represents the result of verification. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. @@ -75120,17 +79101,17 @@ result of verification. - a newly allocated string containing the + a newly allocated string containing the handle. - a #GTlsDatabase + a #GTlsDatabase - certificate for which to create a handle. + certificate for which to create a handle. @@ -75140,29 +79121,29 @@ handle. - a newly allocated + a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a certificate handle + a certificate handle - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup. + Flags which affect the lookup. - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -75176,31 +79157,31 @@ handle. - a #GTlsDatabase + a #GTlsDatabase - a certificate handle + a certificate handle - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup. + Flags which affect the lookup. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function @@ -75210,17 +79191,17 @@ handle. - a newly allocated #GTlsCertificate object. + a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. @@ -75230,29 +79211,29 @@ Use g_object_unref() to release the certificate. - a newly allocated issuer #GTlsCertificate, + a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate + a #GTlsCertificate - used to interact with the user if necessary + used to interact with the user if necessary - flags which affect the lookup operation + flags which affect the lookup operation - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -75266,31 +79247,31 @@ or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GTlsCertificate + a #GTlsCertificate - used to interact with the user if necessary + used to interact with the user if necessary - flags which affect the lookup operation + flags which affect the lookup operation - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function @@ -75300,17 +79281,17 @@ or %NULL. Use g_object_unref() to release the certificate. - a newly allocated issuer #GTlsCertificate, + a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. @@ -75320,7 +79301,7 @@ or %NULL. Use g_object_unref() to release the certificate. - a newly allocated list of #GTlsCertificate + a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -75328,25 +79309,25 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a #GTlsDatabase + a #GTlsDatabase - a #GByteArray which holds the DER encoded issuer DN. + a #GByteArray which holds the DER encoded issuer DN. - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup operation. + Flags which affect the lookup operation. - a #GCancellable, or %NULL + a #GCancellable, or %NULL @@ -75360,33 +79341,33 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a #GTlsDatabase + a #GTlsDatabase - a #GByteArray which holds the DER encoded issuer DN. + a #GByteArray which holds the DER encoded issuer DN. - used to interact with the user if necessary + used to interact with the user if necessary - Flags which affect the lookup operation. + Flags which affect the lookup operation. - a #GCancellable, or %NULL + a #GCancellable, or %NULL - callback to call when the operation completes + callback to call when the operation completes - the data to pass to the callback function + the data to pass to the callback function @@ -75396,7 +79377,7 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a newly allocated list of #GTlsCertificate + a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -75404,11 +79385,11 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - a #GTlsDatabase + a #GTlsDatabase - a #GAsyncResult. + a #GAsyncResult. @@ -75421,14 +79402,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele - Flags for g_tls_database_lookup_certificate_for_handle(), + Flags for g_tls_database_lookup_certificate_for_handle(), g_tls_database_lookup_certificate_issuer(), and g_tls_database_lookup_certificates_issued_by(). - No lookup flags + No lookup flags - Restrict lookup to certificates that have + Restrict lookup to certificates that have a private key. @@ -75436,81 +79417,81 @@ and g_tls_database_lookup_certificates_issued_by(). - Flags for g_tls_database_verify_chain(). + Flags for g_tls_database_verify_chain(). - No verification flags + No verification flags - An error code used with %G_TLS_ERROR in a #GError returned from a + An error code used with %G_TLS_ERROR in a #GError returned from a TLS-related routine. - No TLS provider is available + No TLS provider is available - Miscellaneous TLS error + Miscellaneous TLS error - The certificate presented could not + The certificate presented could not be parsed or failed validation. - The TLS handshake failed because the + The TLS handshake failed because the peer does not seem to be a TLS server. - The TLS handshake failed because the + The TLS handshake failed because the peer's certificate was not acceptable. - The TLS handshake failed because + The TLS handshake failed because the server requested a client-side certificate, but none was provided. See g_tls_connection_set_certificate(). - The TLS connection was closed without proper + The TLS connection was closed without proper notice, which may indicate an attack. See g_tls_connection_set_require_close_notify(). - The TLS handshake failed + The TLS handshake failed because the client sent the fallback SCSV, indicating a protocol downgrade attack. Since: 2.60 - Gets the TLS error quark. + Gets the TLS error quark. - a #GQuark. + a #GQuark. - #GTlsFileDatabase is implemented by #GTlsDatabase objects which load + #GTlsFileDatabase is implemented by #GTlsDatabase objects which load their certificate information from a file. It is an interface which TLS library specific subtypes implement. - Creates a new #GTlsFileDatabase which uses anchor certificate authorities + Creates a new #GTlsFileDatabase which uses anchor certificate authorities in @anchors to verify certificate chains. The certificates in @anchors must be PEM encoded. - the new + the new #GTlsFileDatabase, or %NULL on error - filename of anchor certificate authorities. + filename of anchor certificate authorities. - The path to a file containing PEM encoded certificate authority + The path to a file containing PEM encoded certificate authority root anchors. The certificates in this file will be treated as root authorities for the purpose of verifying other certificates via the g_tls_database_verify_chain() operation. @@ -75531,7 +79512,7 @@ via the g_tls_database_verify_chain() operation. - #GTlsInteraction provides a mechanism for the TLS connection and database + #GTlsInteraction provides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user for passwords. To use a #GTlsInteraction with a TLS connection use @@ -75553,7 +79534,7 @@ initialization function. Any interactions not implemented will return it must also implement the corresponding finish method. - Run synchronous interaction to ask the user for a password. In general, + Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -75568,26 +79549,26 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - The status of the ask password interaction. + The status of the ask password interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsPassword object + a #GTlsPassword object - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - Run asynchronous interaction to ask the user for a password. In general, + Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -75608,29 +79589,29 @@ Certain implementations may not support immediate cancellation. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsPassword object + a #GTlsPassword object - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - will be called when the interaction completes + will be called when the interaction completes - data to pass to the @callback + data to pass to the @callback - Complete an ask password user interaction request. This should be once + Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsPassword passed @@ -75641,22 +79622,22 @@ user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - The status of the ask password interaction. + The status of the ask password interaction. - a #GTlsInteraction object + a #GTlsInteraction object - the result passed to the callback + the result passed to the callback - Run synchronous interaction to ask the user to choose a certificate to use + Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -75674,30 +79655,30 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - The status of the request certificate interaction. + The status of the request certificate interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsConnection object + a #GTlsConnection object - flags providing more information about the request + flags providing more information about the request - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - Run asynchronous interaction to ask the user for a certificate to use with + Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -75711,33 +79692,33 @@ request, which will usually abort the TLS connection. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsConnection object + a #GTlsConnection object - flags providing more information about the request + flags providing more information about the request - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - will be called when the interaction completes + will be called when the interaction completes - data to pass to the @callback + data to pass to the @callback - Complete an request certificate user interaction request. This should be once + Complete an request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsConnection @@ -75749,22 +79730,22 @@ user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - The status of the request certificate interaction. + The status of the request certificate interaction. - a #GTlsInteraction object + a #GTlsInteraction object - the result passed to the callback + the result passed to the callback - Run synchronous interaction to ask the user for a password. In general, + Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -75779,26 +79760,26 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - The status of the ask password interaction. + The status of the ask password interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsPassword object + a #GTlsPassword object - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - Run asynchronous interaction to ask the user for a password. In general, + Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -75819,29 +79800,29 @@ Certain implementations may not support immediate cancellation. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsPassword object + a #GTlsPassword object - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - will be called when the interaction completes + will be called when the interaction completes - data to pass to the @callback + data to pass to the @callback - Complete an ask password user interaction request. This should be once + Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsPassword passed @@ -75852,22 +79833,22 @@ user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - The status of the ask password interaction. + The status of the ask password interaction. - a #GTlsInteraction object + a #GTlsInteraction object - the result passed to the callback + the result passed to the callback - Invoke the interaction to ask the user for a password. It invokes this + Invoke the interaction to ask the user for a password. It invokes this interaction in the main loop, specifically the #GMainContext returned by g_main_context_get_thread_default() when the interaction is created. This is called by called by #GTlsConnection or #GTlsDatabase to ask the user @@ -75888,26 +79869,26 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - The status of the ask password interaction. + The status of the ask password interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsPassword object + a #GTlsPassword object - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - Invoke the interaction to ask the user to choose a certificate to + Invoke the interaction to ask the user to choose a certificate to use with the connection. It invokes this interaction in the main loop, specifically the #GMainContext returned by g_main_context_get_thread_default() when the interaction is @@ -75929,30 +79910,30 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - The status of the certificate request interaction. + The status of the certificate request interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsConnection object + a #GTlsConnection object - flags providing more information about the request + flags providing more information about the request - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - Run synchronous interaction to ask the user to choose a certificate to use + Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -75970,30 +79951,30 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - The status of the request certificate interaction. + The status of the request certificate interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsConnection object + a #GTlsConnection object - flags providing more information about the request + flags providing more information about the request - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - Run asynchronous interaction to ask the user for a certificate to use with + Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -76007,33 +79988,33 @@ request, which will usually abort the TLS connection. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsConnection object + a #GTlsConnection object - flags providing more information about the request + flags providing more information about the request - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - will be called when the interaction completes + will be called when the interaction completes - data to pass to the @callback + data to pass to the @callback - Complete an request certificate user interaction request. This should be once + Complete an request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsConnection @@ -76045,16 +80026,16 @@ user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - The status of the request certificate interaction. + The status of the request certificate interaction. - a #GTlsInteraction object + a #GTlsInteraction object - the result passed to the callback + the result passed to the callback @@ -76067,7 +80048,7 @@ contains a %G_IO_ERROR_CANCELLED error code. - The class for #GTlsInteraction. Derived classes implement the various + The class for #GTlsInteraction. Derived classes implement the various virtual interaction methods to handle TLS interactions. Derived classes can choose to implement whichever interactions methods they'd @@ -76089,20 +80070,20 @@ If the user cancels an interaction, then the result should be - The status of the ask password interaction. + The status of the ask password interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsPassword object + a #GTlsPassword object - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object @@ -76116,23 +80097,23 @@ If the user cancels an interaction, then the result should be - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsPassword object + a #GTlsPassword object - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - will be called when the interaction completes + will be called when the interaction completes - data to pass to the @callback + data to pass to the @callback @@ -76142,16 +80123,16 @@ If the user cancels an interaction, then the result should be - The status of the ask password interaction. + The status of the ask password interaction. - a #GTlsInteraction object + a #GTlsInteraction object - the result passed to the callback + the result passed to the callback @@ -76161,24 +80142,24 @@ If the user cancels an interaction, then the result should be - The status of the request certificate interaction. + The status of the request certificate interaction. - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsConnection object + a #GTlsConnection object - flags providing more information about the request + flags providing more information about the request - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object @@ -76192,27 +80173,27 @@ If the user cancels an interaction, then the result should be - a #GTlsInteraction object + a #GTlsInteraction object - a #GTlsConnection object + a #GTlsConnection object - flags providing more information about the request + flags providing more information about the request - an optional #GCancellable cancellation object + an optional #GCancellable cancellation object - will be called when the interaction completes + will be called when the interaction completes - data to pass to the @callback + data to pass to the @callback @@ -76222,16 +80203,16 @@ If the user cancels an interaction, then the result should be - The status of the request certificate interaction. + The status of the request certificate interaction. - a #GTlsInteraction object + a #GTlsInteraction object - the result passed to the callback + the result passed to the callback @@ -76247,38 +80228,38 @@ If the user cancels an interaction, then the result should be - #GTlsInteractionResult is returned by various functions in #GTlsInteraction + #GTlsInteractionResult is returned by various functions in #GTlsInteraction when finishing an interaction request. - The interaction was unhandled (i.e. not + The interaction was unhandled (i.e. not implemented). - The interaction completed, and resulting data + The interaction completed, and resulting data is available. - The interaction has failed, or was cancelled. + The interaction has failed, or was cancelled. and the operation should be aborted. - Holds a password used in TLS. + Holds a password used in TLS. - Create a new #GTlsPassword object. + Create a new #GTlsPassword object. - The newly allocated password object + The newly allocated password object - the password flags + the password flags - description of what the password is for + description of what the password is for @@ -76295,29 +80276,29 @@ when finishing an interaction request. - Get the password value. If @length is not %NULL then it will be + Get the password value. If @length is not %NULL then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass %NULL for @length in contexts where you know the password will have a certain fixed length.) - The password value (owned by the password object). + The password value (owned by the password object). - a #GTlsPassword object + a #GTlsPassword object - location to place the length of the password. + location to place the length of the password. - Provide the value for this password. + Provide the value for this password. The @value will be owned by the password object, and later freed using the @destroy function callback. @@ -76332,127 +80313,127 @@ considered part of the password in this case.) - a #GTlsPassword object + a #GTlsPassword object - the value for the password + the value for the password - the length of the password, or -1 + the length of the password, or -1 - a function to use to free the password. + a function to use to free the password. - Get a description string about what the password will be used for. + Get a description string about what the password will be used for. - The description of the password. + The description of the password. - a #GTlsPassword object + a #GTlsPassword object - Get flags about the password. + Get flags about the password. - The flags about the password. + The flags about the password. - a #GTlsPassword object + a #GTlsPassword object - Get the password value. If @length is not %NULL then it will be + Get the password value. If @length is not %NULL then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass %NULL for @length in contexts where you know the password will have a certain fixed length.) - The password value (owned by the password object). + The password value (owned by the password object). - a #GTlsPassword object + a #GTlsPassword object - location to place the length of the password. + location to place the length of the password. - Get a user readable translated warning. Usually this warning is a + Get a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags(). - The warning. + The warning. - a #GTlsPassword object + a #GTlsPassword object - Set a description string about what the password will be used for. + Set a description string about what the password will be used for. - a #GTlsPassword object + a #GTlsPassword object - The description of the password + The description of the password - Set flags about the password. + Set flags about the password. - a #GTlsPassword object + a #GTlsPassword object - The flags about the password + The flags about the password - Set the value for this password. The @value will be copied by the password + Set the value for this password. The @value will be copied by the password object. Specify the @length, for a non-nul-terminated password. Pass -1 as @@ -76465,23 +80446,23 @@ considered part of the password in this case.) - a #GTlsPassword object + a #GTlsPassword object - the new password value + the new password value - the length of the password, or -1 + the length of the password, or -1 - Provide the value for this password. + Provide the value for this password. The @value will be owned by the password object, and later freed using the @destroy function callback. @@ -76496,27 +80477,27 @@ considered part of the password in this case.) - a #GTlsPassword object + a #GTlsPassword object - the value for the password + the value for the password - the length of the password, or -1 + the length of the password, or -1 - a function to use to free the password. + a function to use to free the password. - Set a user readable translated warning. Usually this warning is a + Set a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags(). @@ -76525,11 +80506,11 @@ g_tls_password_get_flags(). - a #GTlsPassword object + a #GTlsPassword object - The user readable warning + The user readable warning @@ -76560,16 +80541,16 @@ g_tls_password_get_flags(). - The password value (owned by the password object). + The password value (owned by the password object). - a #GTlsPassword object + a #GTlsPassword object - location to place the length of the password. + location to place the length of the password. @@ -76583,21 +80564,21 @@ g_tls_password_get_flags(). - a #GTlsPassword object + a #GTlsPassword object - the value for the password + the value for the password - the length of the password, or -1 + the length of the password, or -1 - a function to use to free the password. + a function to use to free the password. @@ -76623,19 +80604,19 @@ g_tls_password_get_flags(). - Various flags for the password. + Various flags for the password. - No flags + No flags - The password was wrong, and the user should retry. + The password was wrong, and the user should retry. - Hint to the user that the password has been + Hint to the user that the password has been wrong many times, and the user may not have many chances left. - Hint to the user that this is the last try to get + Hint to the user that this is the last try to get this password right. @@ -76643,28 +80624,28 @@ g_tls_password_get_flags(). - When to allow rehandshaking. See + When to allow rehandshaking. See g_tls_connection_set_rehandshake_mode(). Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - Never allow rehandshaking + Never allow rehandshaking - Allow safe rehandshaking only + Allow safe rehandshaking only - Allow unsafe rehandshaking + Allow unsafe rehandshaking - #GTlsServerConnection is the server-side subclass of #GTlsConnection, + #GTlsServerConnection is the server-side subclass of #GTlsConnection, representing a server-side TLS connection. - Creates a new #GTlsServerConnection wrapping @base_io_stream (which + Creates a new #GTlsServerConnection wrapping @base_io_stream (which must have pollable input and output streams). See the documentation for #GTlsConnection:base-io-stream for restrictions @@ -76672,23 +80653,23 @@ on when application code can run operations on the @base_io_stream after this function has returned. - the new + the new #GTlsServerConnection, or %NULL on error - the #GIOStream to wrap + the #GIOStream to wrap - the default server certificate, or %NULL + the default server certificate, or %NULL - The #GTlsAuthenticationMode for the server. This can be changed + The #GTlsAuthenticationMode for the server. This can be changed before calling g_tls_connection_handshake() if you want to rehandshake with a different mode from the initial handshake. @@ -76702,8 +80683,169 @@ rehandshake with a different mode from the initial handshake. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - This is the subclass of #GSocketConnection that is created + This is the subclass of #GSocketConnection that is created for UNIX domain sockets. It contains functions to do some of the UNIX socket specific @@ -76714,7 +80856,7 @@ GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file when using it. - Receives credentials from the sending end of the connection. The + Receives credentials from the sending end of the connection. The sending end has to call g_unix_connection_send_credentials() (or similar) for this to work. @@ -76722,27 +80864,35 @@ As well as reading the credentials this also reads (and discards) a single byte from the stream, as this is required for credentials passing to work on some implementations. +This method can be expected to be available on the following platforms: + +- Linux since GLib 2.26 +- FreeBSD since GLib 2.26 +- GNU/kFreeBSD since GLib 2.36 +- Solaris, Illumos and OpenSolaris since GLib 2.40 +- GNU/Hurd since GLib 2.40 + Other ways to exchange credentials with a foreign peer includes the #GUnixCredentialsMessage type and g_socket_get_credentials() function. - Received credentials on success (free with + Received credentials on success (free with g_object_unref()), %NULL if @error is set. - A #GUnixConnection. + A #GUnixConnection. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Asynchronously receive credentials. + Asynchronously receive credentials. For more details, see g_unix_connection_receive_credentials() which is the synchronous version of this call. @@ -76755,45 +80905,45 @@ g_unix_connection_receive_credentials_finish() to get the result of the operatio - A #GUnixConnection. + A #GUnixConnection. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous receive credentials operation started with + Finishes an asynchronous receive credentials operation started with g_unix_connection_receive_credentials_async(). - a #GCredentials, or %NULL on error. + a #GCredentials, or %NULL on error. Free the returned object with g_object_unref(). - A #GUnixConnection. + A #GUnixConnection. - a #GAsyncResult. + a #GAsyncResult. - Receives a file descriptor from the sending end of the connection. + Receives a file descriptor from the sending end of the connection. The sending end has to call g_unix_connection_send_fd() for this to work. @@ -76802,22 +80952,22 @@ stream, as this is required for fd passing to work on some implementations. - a file descriptor on success, -1 on error. + a file descriptor on success, -1 on error. - a #GUnixConnection + a #GUnixConnection - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - Passes the credentials of the current user the receiving side + Passes the credentials of the current user the receiving side of the connection. The receiving end has to call g_unix_connection_receive_credentials() (or similar) to accept the credentials. @@ -76826,26 +80976,34 @@ As well as sending the credentials this also writes a single NUL byte to the stream, as this is required for credentials passing to work on some implementations. +This method can be expected to be available on the following platforms: + +- Linux since GLib 2.26 +- FreeBSD since GLib 2.26 +- GNU/kFreeBSD since GLib 2.36 +- Solaris, Illumos and OpenSolaris since GLib 2.40 +- GNU/Hurd since GLib 2.40 + Other ways to exchange credentials with a foreign peer includes the #GUnixCredentialsMessage type and g_socket_get_credentials() function. - %TRUE on success, %FALSE if @error is set. + %TRUE on success, %FALSE if @error is set. - A #GUnixConnection. + A #GUnixConnection. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Asynchronously send credentials. + Asynchronously send credentials. For more details, see g_unix_connection_send_credentials() which is the synchronous version of this call. @@ -76858,44 +81016,44 @@ g_unix_connection_send_credentials_finish() to get the result of the operation.< - A #GUnixConnection. + A #GUnixConnection. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to callback function + the data to pass to callback function - Finishes an asynchronous send credentials operation started with + Finishes an asynchronous send credentials operation started with g_unix_connection_send_credentials_async(). - %TRUE if the operation was successful, otherwise %FALSE. + %TRUE if the operation was successful, otherwise %FALSE. - A #GUnixConnection. + A #GUnixConnection. - a #GAsyncResult. + a #GAsyncResult. - Passes a file descriptor to the receiving side of the + Passes a file descriptor to the receiving side of the connection. The receiving end has to call g_unix_connection_receive_fd() to accept the file descriptor. @@ -76904,20 +81062,20 @@ stream, as this is required for fd passing to work on some implementations. - a %TRUE on success, %NULL on error. + a %TRUE on success, %NULL on error. - a #GUnixConnection + a #GUnixConnection - a file descriptor + a file descriptor - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. @@ -76939,7 +81097,7 @@ implementations. - This #GSocketControlMessage contains a #GCredentials instance. It + This #GSocketControlMessage contains a #GCredentials instance. It may be sent using g_socket_send_message() and received using g_socket_receive_message() over UNIX sockets (ie: sockets in the %G_SOCKET_FAMILY_UNIX family). @@ -76952,51 +81110,51 @@ a foreign process connected to a socket, use g_socket_get_credentials(). - Creates a new #GUnixCredentialsMessage with credentials matching the current processes. + Creates a new #GUnixCredentialsMessage with credentials matching the current processes. - a new #GUnixCredentialsMessage + a new #GUnixCredentialsMessage - Creates a new #GUnixCredentialsMessage holding @credentials. + Creates a new #GUnixCredentialsMessage holding @credentials. - a new #GUnixCredentialsMessage + a new #GUnixCredentialsMessage - A #GCredentials object. + A #GCredentials object. - Checks if passing #GCredentials on a #GSocket is supported on this platform. + Checks if passing #GCredentials on a #GSocket is supported on this platform. - %TRUE if supported, %FALSE otherwise + %TRUE if supported, %FALSE otherwise - Gets the credentials stored in @message. + Gets the credentials stored in @message. - A #GCredentials instance. Do not free, it is owned by @message. + A #GCredentials instance. Do not free, it is owned by @message. - A #GUnixCredentialsMessage. + A #GUnixCredentialsMessage. - The credentials stored in the message. + The credentials stored in the message. @@ -77033,11 +81191,11 @@ g_socket_get_credentials(). - A #GUnixFDList contains a list of file descriptors. It owns the file + A #GUnixFDList contains a list of file descriptors. It owns the file descriptors that it contains, closing them when finalized. It may be wrapped in a #GUnixFDMessage and sent over a #GSocket in -the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_message() +the %G_SOCKET_FAMILY_UNIX family by using g_socket_send_message() and received using g_socket_receive_message(). Note that `<gio/gunixfdlist.h>` belongs to the UNIX-specific GIO @@ -77045,15 +81203,15 @@ interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file when using it. - Creates a new #GUnixFDList containing no file descriptors. + Creates a new #GUnixFDList containing no file descriptors. - a new #GUnixFDList + a new #GUnixFDList - Creates a new #GUnixFDList containing the file descriptors given in + Creates a new #GUnixFDList containing the file descriptors given in @fds. The file descriptors become the property of the new list and may no longer be used by the caller. The array itself is owned by the caller. @@ -77063,24 +81221,24 @@ Each file descriptor in the array should be set to close-on-exec. If @n_fds is -1 then @fds must be terminated with -1. - a new #GUnixFDList + a new #GUnixFDList - the initial list of file descriptors + the initial list of file descriptors - the length of #fds, or -1 + the length of #fds, or -1 - Adds a file descriptor to @list. + Adds a file descriptor to @list. The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in @list will be closed @@ -77094,23 +81252,23 @@ this index with g_unix_fd_list_get() then you will receive back a duplicated copy of the same file descriptor. - the index of the appended fd in case of success, else -1 + the index of the appended fd in case of success, else -1 (and @error is set) - a #GUnixFDList + a #GUnixFDList - a valid open file descriptor + a valid open file descriptor - Gets a file descriptor out of @list. + Gets a file descriptor out of @list. @index_ specifies the index of the file descriptor to get. It is a programmer error for @index_ to be out of range; see @@ -77124,37 +81282,37 @@ A possible cause of failure is exceeding the per-process or system-wide file descriptor limit. - the file descriptor, or -1 in case of error + the file descriptor, or -1 in case of error - a #GUnixFDList + a #GUnixFDList - the index into the list + the index into the list - Gets the length of @list (ie: the number of file descriptors + Gets the length of @list (ie: the number of file descriptors contained within). - the length of @list + the length of @list - a #GUnixFDList + a #GUnixFDList - Returns the array of file descriptors that is contained in this + Returns the array of file descriptors that is contained in this object. After this call, the descriptors remain the property of @list. The @@ -77169,7 +81327,7 @@ This function never returns %NULL. In case there are no file descriptors contained in @list, an empty array is returned. - an array of file + an array of file descriptors @@ -77177,18 +81335,18 @@ descriptors contained in @list, an empty array is returned. - a #GUnixFDList + a #GUnixFDList - pointer to the length of the returned + pointer to the length of the returned array, or %NULL - Returns the array of file descriptors that is contained in this + Returns the array of file descriptors that is contained in this object. After this call, the descriptors are no longer contained in @@ -77208,7 +81366,7 @@ This function never returns %NULL. In case there are no file descriptors contained in @list, an empty array is returned. - an array of file + an array of file descriptors @@ -77216,11 +81374,11 @@ descriptors contained in @list, an empty array is returned. - a #GUnixFDList + a #GUnixFDList - pointer to the length of the returned + pointer to the length of the returned array, or %NULL @@ -77283,10 +81441,10 @@ descriptors contained in @list, an empty array is returned. - This #GSocketControlMessage contains a #GUnixFDList. + This #GSocketControlMessage contains a #GUnixFDList. It may be sent using g_socket_send_message() and received using g_socket_receive_message() over UNIX sockets (ie: sockets in the -%G_SOCKET_ADDRESS_UNIX family). The file descriptors are copied +%G_SOCKET_FAMILY_UNIX family). The file descriptors are copied between processes by the kernel. For an easier way to send and receive file descriptors over @@ -77298,30 +81456,30 @@ interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file when using it. - Creates a new #GUnixFDMessage containing an empty file descriptor + Creates a new #GUnixFDMessage containing an empty file descriptor list. - a new #GUnixFDMessage + a new #GUnixFDMessage - Creates a new #GUnixFDMessage containing @list. + Creates a new #GUnixFDMessage containing @list. - a new #GUnixFDMessage + a new #GUnixFDMessage - a #GUnixFDList + a #GUnixFDList - Adds a file descriptor to @message. + Adds a file descriptor to @message. The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in @message will be closed @@ -77331,38 +81489,38 @@ A possible cause of failure is exceeding the per-process or system-wide file descriptor limit. - %TRUE in case of success, else %FALSE (and @error is set) + %TRUE in case of success, else %FALSE (and @error is set) - a #GUnixFDMessage + a #GUnixFDMessage - a valid open file descriptor + a valid open file descriptor - Gets the #GUnixFDList contained in @message. This function does not + Gets the #GUnixFDList contained in @message. This function does not return a reference to the caller, but the returned list is valid for the lifetime of @message. - the #GUnixFDList from @message + the #GUnixFDList from @message - a #GUnixFDMessage + a #GUnixFDMessage - Returns the array of file descriptors that is contained in this + Returns the array of file descriptors that is contained in this object. After this call, the descriptors are no longer contained in @@ -77381,7 +81539,7 @@ This function never returns %NULL. In case there are no file descriptors contained in @message, an empty array is returned. - an array of file + an array of file descriptors @@ -77389,11 +81547,11 @@ descriptors contained in @message, an empty array is returned. - a #GUnixFDMessage + a #GUnixFDMessage - pointer to the length of the returned + pointer to the length of the returned array, or %NULL @@ -77435,7 +81593,7 @@ descriptors contained in @message, an empty array is returned. - #GUnixInputStream implements #GInputStream for reading from a UNIX + #GUnixInputStream implements #GInputStream for reading from a UNIX file descriptor, including asynchronous operations. (If the file descriptor refers to a socket or pipe, this will use poll() to do asynchronous I/O. If it refers to a regular file, it will fall back @@ -77448,57 +81606,57 @@ file when using it. - Creates a new #GUnixInputStream for the given @fd. + Creates a new #GUnixInputStream for the given @fd. If @close_fd is %TRUE, the file descriptor will be closed when the stream is closed. - a new #GUnixInputStream + a new #GUnixInputStream - a UNIX file descriptor + a UNIX file descriptor - %TRUE to close the file descriptor when done + %TRUE to close the file descriptor when done - Returns whether the file descriptor of @stream will be + Returns whether the file descriptor of @stream will be closed when the stream is closed. - %TRUE if the file descriptor is closed when done + %TRUE if the file descriptor is closed when done - a #GUnixInputStream + a #GUnixInputStream - Return the UNIX file descriptor that the stream reads from. + Return the UNIX file descriptor that the stream reads from. - The file descriptor of @stream + The file descriptor of @stream - a #GUnixInputStream + a #GUnixInputStream - Sets whether the file descriptor of @stream shall be closed + Sets whether the file descriptor of @stream shall be closed when the stream is closed. @@ -77506,21 +81664,21 @@ when the stream is closed. - a #GUnixInputStream + a #GUnixInputStream - %TRUE to close the file descriptor when done + %TRUE to close the file descriptor when done - Whether to close the file descriptor when the stream is closed. + Whether to close the file descriptor when the stream is closed. - The file descriptor that the stream reads from. + The file descriptor that the stream reads from. @@ -77588,19 +81746,19 @@ This corresponds roughly to a mtab entry. Watches #GUnixMounts for changes. - Deprecated alias for g_unix_mount_monitor_get(). + Deprecated alias for g_unix_mount_monitor_get(). This function was never a true constructor, which is why it was renamed. Use g_unix_mount_monitor_get() instead. - a #GUnixMountMonitor. + a #GUnixMountMonitor. - Gets the #GUnixMountMonitor for the current thread-default main + Gets the #GUnixMountMonitor for the current thread-default main context. The mount monitor can be used to monitor for changes to the list of @@ -77611,12 +81769,12 @@ You must only call g_object_unref() on the return value from under the same main context as you called this function. - the #GUnixMountMonitor. + the #GUnixMountMonitor. - This function does nothing. + 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 @@ -77630,24 +81788,24 @@ the monitor. - a #GUnixMountMonitor + a #GUnixMountMonitor - a integer with the limit in milliseconds to + a integer with the limit in milliseconds to poll for changes. - Emitted when the unix mount points have changed. + Emitted when the unix mount points have changed. - Emitted when the unix mounts have changed. + Emitted when the unix mounts have changed. @@ -77661,186 +81819,31 @@ the monitor. This corresponds roughly to a fstab entry. - Compares two unix mount points. + Compares two unix mount points. - 1, 0 or -1 if @mount1 is greater than, equal to, + 1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. - a #GUnixMount. + a #GUnixMount. - a #GUnixMount. + a #GUnixMount. - Makes a copy of @mount_point. + Makes a copy of @mount_point. - a new #GUnixMountPoint + a new #GUnixMountPoint - - - a #GUnixMountPoint. - - - - - - Frees a unix mount point. - - - - - - - unix mount point to free. - - - - - - Gets the device path for a unix mount point. - - - a string containing the device path. - - - - - a #GUnixMountPoint. - - - - - - Gets the file system type for the mount point. - - - a string containing the file system type. - - - - - a #GUnixMountPoint. - - - - - - Gets the mount path for a unix mount point. - - - a string containing the mount path. - - - - - a #GUnixMountPoint. - - - - - - Gets the options for the mount point. - - - a string containing the options. - - - - - a #GUnixMountPoint. - - - - - - Guesses whether a Unix mount point can be ejected. - - - %TRUE if @mount_point is deemed to be ejectable. - - - - - a #GUnixMountPoint - - - - - - Guesses the icon of a Unix mount point. - - - a #GIcon - - - - - a #GUnixMountPoint - - - - - - Guesses the name of a Unix mount point. -The result is a translated string. - - - A newly allocated string that must - be freed with g_free() - - - - - a #GUnixMountPoint - - - - - - Guesses the symbolic icon of a Unix mount point. - - - a #GIcon - - - - - a #GUnixMountPoint - - - - - - Checks if a unix mount point is a loopback device. - - - %TRUE if the mount point is a loopback. %FALSE otherwise. - - - - - a #GUnixMountPoint. - - - - - - Checks if a unix mount point is read only. - - - %TRUE if a mount point is read only. - - a #GUnixMountPoint. @@ -77848,23 +81851,178 @@ The result is a translated string. - - Checks if a unix mount point is mountable by the user. - + + Frees a unix mount point. + - %TRUE if the mount point is user mountable. + + + + + unix mount point to free. + + + + + + Gets the device path for a unix mount point. + + + a string containing the device path. + + + + + a #GUnixMountPoint. + + + + + + Gets the file system type for the mount point. + + + a string containing the file system type. + + + + + a #GUnixMountPoint. + + + + + + Gets the mount path for a unix mount point. + + + a string containing the mount path. + + + + + a #GUnixMountPoint. + + + + + + Gets the options for the mount point. + + + a string containing the options. + + + + + a #GUnixMountPoint. + + + + + + Guesses whether a Unix mount point can be ejected. + + + %TRUE if @mount_point is deemed to be ejectable. - a #GUnixMountPoint. + a #GUnixMountPoint + + + + + + Guesses the icon of a Unix mount point. + + + a #GIcon + + + + + a #GUnixMountPoint + + + + + + Guesses the name of a Unix mount point. +The result is a translated string. + + + A newly allocated string that must + be freed with g_free() + + + + + a #GUnixMountPoint + + + + + + Guesses the symbolic icon of a Unix mount point. + + + a #GIcon + + + + + a #GUnixMountPoint + + + + + + Checks if a unix mount point is a loopback device. + + + %TRUE if the mount point is a loopback. %FALSE otherwise. + + + + + a #GUnixMountPoint. + + + + + + Checks if a unix mount point is read only. + + + %TRUE if a mount point is read only. + + + + + a #GUnixMountPoint. + + + + + + Checks if a unix mount point is mountable by the user. + + + %TRUE if the mount point is user mountable. + + + + + a #GUnixMountPoint. - #GUnixOutputStream implements #GOutputStream for writing to a UNIX + #GUnixOutputStream implements #GOutputStream for writing to a UNIX file descriptor, including asynchronous operations. (If the file descriptor refers to a socket or pipe, this will use poll() to do asynchronous I/O. If it refers to a regular file, it will fall back @@ -77877,57 +82035,57 @@ when using it. - Creates a new #GUnixOutputStream for the given @fd. + Creates a new #GUnixOutputStream for the given @fd. If @close_fd, is %TRUE, the file descriptor will be closed when the output stream is destroyed. - a new #GOutputStream + a new #GOutputStream - a UNIX file descriptor + a UNIX file descriptor - %TRUE to close the file descriptor when done + %TRUE to close the file descriptor when done - Returns whether the file descriptor of @stream will be + Returns whether the file descriptor of @stream will be closed when the stream is closed. - %TRUE if the file descriptor is closed when done + %TRUE if the file descriptor is closed when done - a #GUnixOutputStream + a #GUnixOutputStream - Return the UNIX file descriptor that the stream writes to. + Return the UNIX file descriptor that the stream writes to. - The file descriptor of @stream + The file descriptor of @stream - a #GUnixOutputStream + a #GUnixOutputStream - Sets whether the file descriptor of @stream shall be closed + Sets whether the file descriptor of @stream shall be closed when the stream is closed. @@ -77935,21 +82093,21 @@ when the stream is closed. - a #GUnixOutputStream + a #GUnixOutputStream - %TRUE to close the file descriptor when done + %TRUE to close the file descriptor when done - Whether to close the file descriptor when the stream is closed. + Whether to close the file descriptor when the stream is closed. - The file descriptor that the stream writes to. + The file descriptor that the stream writes to. @@ -78009,7 +82167,7 @@ when the stream is closed. - Support for UNIX-domain (also known as local) sockets. + Support for UNIX-domain (also known as local) sockets. UNIX domain sockets are generally visible in the filesystem. However, some systems support abstract socket names which are not @@ -78026,46 +82184,46 @@ when using it. - Creates a new #GUnixSocketAddress for @path. + Creates a new #GUnixSocketAddress for @path. To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract(). - a new #GUnixSocketAddress + a new #GUnixSocketAddress - the socket path + the socket path - Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED + Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED #GUnixSocketAddress for @path. Use g_unix_socket_address_new_with_type(). - a new #GUnixSocketAddress + a new #GUnixSocketAddress - the abstract name + the abstract name - the length of @path, or -1 + the length of @path, or -1 - Creates a new #GUnixSocketAddress of type @type with name @path. + Creates a new #GUnixSocketAddress of type @type with name @path. If @type is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to calling g_unix_socket_address_new(). @@ -78098,65 +82256,65 @@ use the appropriate type corresponding to how that process created its listening socket. - a new #GUnixSocketAddress + a new #GUnixSocketAddress - the name + the name - the length of @path, or -1 + the length of @path, or -1 - a #GUnixSocketAddressType + a #GUnixSocketAddressType - Checks if abstract UNIX domain socket names are supported. + Checks if abstract UNIX domain socket names are supported. - %TRUE if supported, %FALSE otherwise + %TRUE if supported, %FALSE otherwise - Gets @address's type. + Gets @address's type. - a #GUnixSocketAddressType + a #GUnixSocketAddressType - a #GInetSocketAddress + a #GInetSocketAddress - Tests if @address is abstract. + Tests if @address is abstract. Use g_unix_socket_address_get_address_type() - %TRUE if the address is abstract, %FALSE otherwise + %TRUE if the address is abstract, %FALSE otherwise - a #GInetSocketAddress + a #GInetSocketAddress - Gets @address's path, or for abstract sockets the "name". + Gets @address's path, or for abstract sockets the "name". Guaranteed to be zero-terminated, but an abstract socket may contain embedded zeros, and thus you should use @@ -78164,34 +82322,34 @@ g_unix_socket_address_get_path_len() to get the true length of this string. - the path for @address + the path for @address - a #GInetSocketAddress + a #GInetSocketAddress - Gets the length of @address's path. + Gets the length of @address's path. For details, see g_unix_socket_address_get_path(). - the length of the path + the length of the path - a #GInetSocketAddress + a #GInetSocketAddress - Whether or not this is an abstract address + Whether or not this is an abstract address Use #GUnixSocketAddress:address-type, which distinguishes between zero-padded and non-zero-padded abstract addresses. @@ -78225,7 +82383,7 @@ abstract addresses. - The type of name used by a #GUnixSocketAddress. + The type of name used by a #GUnixSocketAddress. %G_UNIX_SOCKET_ADDRESS_PATH indicates a traditional unix domain socket bound to a filesystem path. %G_UNIX_SOCKET_ADDRESS_ANONYMOUS indicates a socket not bound to any name (eg, a client-side socket, @@ -78239,30 +82397,65 @@ However, many programs instead just use a portion of %sun_path, and pass an appropriate smaller length to bind() or connect(). This is %G_UNIX_SOCKET_ADDRESS_ABSTRACT. - invalid + invalid - anonymous + anonymous - a filesystem path + a filesystem path - an abstract name + an abstract name - an abstract name, 0-padded + an abstract name, 0-padded to the full length of a unix socket name + + + + + + + + + + + + + + Extension point for #GVfs functionality. See [Extending GIO][extending-gio]. + + + + + + + + + + + + + + + + + + + + + - The string used to obtain the volume class with g_volume_get_identifier(). + The string used to obtain the volume class with g_volume_get_identifier(). Known volume classes include `device`, `network`, and `loop`. Other classes may be added in the future. @@ -78271,57 +82464,78 @@ This is intended to be used by applications to classify #GVolume instances into different sections - for example a file manager or file chooser can use this information to show `network` volumes under a "Network" heading and `device` volumes under a "Devices" heading. - + - The string used to obtain a Hal UDI with g_volume_get_identifier(). + The string used to obtain a Hal UDI with g_volume_get_identifier(). Do not use, HAL is deprecated. - + - The string used to obtain a filesystem label with g_volume_get_identifier(). - + The string used to obtain a filesystem label with g_volume_get_identifier(). + - The string used to obtain a NFS mount with g_volume_get_identifier(). - + The string used to obtain a NFS mount with g_volume_get_identifier(). + - The string used to obtain a Unix device path with g_volume_get_identifier(). - + The string used to obtain a Unix device path with g_volume_get_identifier(). + - The string used to obtain a UUID with g_volume_get_identifier(). - + The string used to obtain a UUID with g_volume_get_identifier(). + + + + + + + + + + + + + + + Extension point for volume monitor functionality. See [Extending GIO][extending-gio]. + + + + + + + - Entry point for using GIO functionality. + Entry point for using GIO functionality. - Gets the default #GVfs for the system. + Gets the default #GVfs for the system. - a #GVfs. + a #GVfs. - Gets the local #GVfs for the system. + Gets the local #GVfs for the system. - a #GVfs. + a #GVfs. @@ -78354,52 +82568,52 @@ See [Extending GIO][extending-gio]. - Gets a #GFile for @path. + Gets a #GFile for @path. - a #GFile. + a #GFile. Free the returned object with g_object_unref(). - a #GVfs. + a #GVfs. - a string containing a VFS path. + a string containing a VFS path. - Gets a #GFile for @uri. + Gets a #GFile for @uri. This operation never fails, but the returned object might not support any I/O operation if the URI is malformed or if the URI scheme is not supported. - a #GFile. + a #GFile. Free the returned object with g_object_unref(). - a#GVfs. + a#GVfs. - a string containing a URI + a string containing a URI - Gets a list of URI schemes supported by @vfs. + Gets a list of URI schemes supported by @vfs. - a %NULL-terminated array of strings. + a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -78408,22 +82622,22 @@ is malformed or if the URI scheme is not supported. - a #GVfs. + a #GVfs. - Checks if the VFS is active. + Checks if the VFS is active. - %TRUE if construction of the @vfs was successful + %TRUE if construction of the @vfs was successful and it is now active. - a #GVfs. + a #GVfs. @@ -78515,73 +82729,73 @@ is malformed or if the URI scheme is not supported. - This operation never fails, but the returned object might + This operation never fails, but the returned object might not support any I/O operations if the @parse_name cannot be parsed by the #GVfs module. - a #GFile for the given @parse_name. + a #GFile for the given @parse_name. Free the returned object with g_object_unref(). - a #GVfs. + a #GVfs. - a string to be parsed by the VFS module. + a string to be parsed by the VFS module. - Gets a #GFile for @path. + Gets a #GFile for @path. - a #GFile. + a #GFile. Free the returned object with g_object_unref(). - a #GVfs. + a #GVfs. - a string containing a VFS path. + a string containing a VFS path. - Gets a #GFile for @uri. + Gets a #GFile for @uri. This operation never fails, but the returned object might not support any I/O operation if the URI is malformed or if the URI scheme is not supported. - a #GFile. + a #GFile. Free the returned object with g_object_unref(). - a#GVfs. + a#GVfs. - a string containing a URI + a string containing a URI - Gets a list of URI schemes supported by @vfs. + Gets a list of URI schemes supported by @vfs. - a %NULL-terminated array of strings. + a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -78590,49 +82804,49 @@ is malformed or if the URI scheme is not supported. - a #GVfs. + a #GVfs. - Checks if the VFS is active. + Checks if the VFS is active. - %TRUE if construction of the @vfs was successful + %TRUE if construction of the @vfs was successful and it is now active. - a #GVfs. + a #GVfs. - This operation never fails, but the returned object might + This operation never fails, but the returned object might not support any I/O operations if the @parse_name cannot be parsed by the #GVfs module. - a #GFile for the given @parse_name. + a #GFile for the given @parse_name. Free the returned object with g_object_unref(). - a #GVfs. + a #GVfs. - a string to be parsed by the VFS module. + a string to be parsed by the VFS module. - Registers @uri_func and @parse_name_func as the #GFile URI and parse name + 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. @@ -78654,44 +82868,44 @@ 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(). - %TRUE if @scheme was successfully registered, or %FALSE if a handler + %TRUE if @scheme was successfully registered, or %FALSE if a handler for @scheme already exists. - a #GVfs + a #GVfs - an URI scheme, e.g. "http" + an URI scheme, e.g. "http" - a #GVfsFileLookupFunc + a #GVfsFileLookupFunc - custom data passed to be passed to @uri_func, or %NULL + custom data passed to be passed to @uri_func, or %NULL - function to be called when unregistering the + function to be called when unregistering the URI scheme, or when @vfs is disposed, to free the resources used by the URI lookup function - a #GVfsFileLookupFunc + a #GVfsFileLookupFunc - custom data passed to be passed to + custom data passed to be passed to @parse_name_func, or %NULL - function to be called when unregistering the + 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 @@ -78699,21 +82913,21 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). - Unregisters the URI handler for @scheme previously registered with + Unregisters the URI handler for @scheme previously registered with g_vfs_register_uri_scheme(). - %TRUE if @scheme was successfully unregistered, or %FALSE if a + %TRUE if @scheme was successfully unregistered, or %FALSE if a handler for @scheme does not exist. - a #GVfs + a #GVfs - an URI scheme, e.g. "http" + an URI scheme, e.g. "http" @@ -78731,13 +82945,13 @@ g_vfs_register_uri_scheme(). - %TRUE if construction of the @vfs was successful + %TRUE if construction of the @vfs was successful and it is now active. - a #GVfs. + a #GVfs. @@ -78747,17 +82961,17 @@ g_vfs_register_uri_scheme(). - a #GFile. + a #GFile. Free the returned object with g_object_unref(). - a #GVfs. + a #GVfs. - a string containing a VFS path. + a string containing a VFS path. @@ -78767,17 +82981,17 @@ g_vfs_register_uri_scheme(). - a #GFile. + a #GFile. Free the returned object with g_object_unref(). - a#GVfs. + a#GVfs. - a string containing a URI + a string containing a URI @@ -78787,7 +83001,7 @@ g_vfs_register_uri_scheme(). - a %NULL-terminated array of strings. + a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -78796,7 +83010,7 @@ g_vfs_register_uri_scheme(). - a #GVfs. + a #GVfs. @@ -78806,17 +83020,17 @@ g_vfs_register_uri_scheme(). - a #GFile for the given @parse_name. + a #GFile for the given @parse_name. Free the returned object with g_object_unref(). - a #GVfs. + a #GVfs. - a string to be parsed by the VFS module. + a string to be parsed by the VFS module. @@ -79015,7 +83229,7 @@ created for @uri, or %NULL to continue with the default implementation. - the identifier to lookup a #GFile for. This can either + the identifier to look up a #GFile for. This can either be an URI or a parse name as returned by g_file_get_parse_name() @@ -79026,7 +83240,7 @@ created for @uri, or %NULL to continue with the default implementation. - The #GVolume interface represents user-visible objects that can be + The #GVolume interface represents user-visible objects that can be mounted. Note, when porting from GnomeVFS, #GVolume is the moral equivalent of #GnomeVFSDrive. @@ -79067,37 +83281,37 @@ when the gvfs hal volume monitor is in use. Other volume monitors will generally be able to provide the #G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE identifier, which can be used to obtain a hal device by means of libhal_manager_find_device_string_match(). - + - Checks if a volume can be ejected. - + Checks if a volume can be ejected. + - %TRUE if the @volume can be ejected. %FALSE otherwise + %TRUE if the @volume can be ejected. %FALSE otherwise - a #GVolume + a #GVolume - Checks if a volume can be mounted. - + Checks if a volume can be mounted. + - %TRUE if the @volume can be mounted. %FALSE otherwise + %TRUE if the @volume can be mounted. %FALSE otherwise - a #GVolume + a #GVolume - + @@ -79108,118 +83322,118 @@ libhal_manager_find_device_string_match(). - Ejects a volume. This is an asynchronous operation, and is + Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback. Use g_volume_eject_with_operation() instead. - + - a #GVolume + a #GVolume - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data that gets passed to @callback + user data that gets passed to @callback - Finishes ejecting a volume. If any errors occurred during the operation, + Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_volume_eject_with_operation_finish() instead. - + - %TRUE, %FALSE if operation failed + %TRUE, %FALSE if operation failed - pointer to a #GVolume + pointer to a #GVolume - a #GAsyncResult + a #GAsyncResult - Ejects a volume. This is an asynchronous operation, and is + Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback. - + - a #GVolume + a #GVolume - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data passed to @callback + user data passed to @callback - Finishes ejecting a volume. If any errors occurred during the operation, + Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + - %TRUE if the volume was successfully ejected. %FALSE otherwise + %TRUE if the volume was successfully ejected. %FALSE otherwise - a #GVolume + a #GVolume - a #GAsyncResult + a #GAsyncResult - Gets the kinds of [identifiers][volume-identifier] that @volume has. + Gets the kinds of [identifiers][volume-identifier] that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves. - + - a %NULL-terminated array + a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -79227,13 +83441,13 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. - a #GVolume + a #GVolume - Gets the activation root for a #GVolume if it is known ahead of + Gets the activation root for a #GVolume if it is known ahead of mount time. Returns %NULL otherwise. If not %NULL and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always @@ -79259,142 +83473,142 @@ will always be %TRUE. Activation roots are typically used in #GVolumeMonitor implementations to find the underlying mount to shadow, see g_mount_is_shadowed() for more details. - + - the activation root of @volume + the activation root of @volume or %NULL. Use g_object_unref() to free. - a #GVolume + a #GVolume - Gets the drive for the @volume. - + Gets the drive for the @volume. + - a #GDrive or %NULL if @volume is not + a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the icon for @volume. - + Gets the icon for @volume. + - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the identifier of the given kind for @volume. + Gets the identifier of the given kind for @volume. See the [introduction][volume-identifier] for more information about volume identifiers. - + - a newly allocated string containing the + a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier - a #GVolume + a #GVolume - the kind of identifier to return + the kind of identifier to return - Gets the mount for the @volume. - + Gets the mount for the @volume. + - a #GMount or %NULL if @volume isn't mounted. + a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the name of @volume. - + Gets the name of @volume. + - the name for the given @volume. The returned string should + the name for the given @volume. The returned string should be freed with g_free() when no longer needed. - a #GVolume + a #GVolume - Gets the sort key for @volume, if any. - + Gets the sort key for @volume, if any. + - Sorting key for @volume or %NULL if no such key is available + Sorting key for @volume or %NULL if no such key is available - a #GVolume + a #GVolume - Gets the symbolic icon for @volume. - + Gets the symbolic icon for @volume. + - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the UUID for the @volume. The reference is typically based on + Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + - the UUID for @volume or %NULL if no UUID + the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -79402,72 +83616,72 @@ available. - a #GVolume + a #GVolume - Finishes mounting a volume. If any errors occurred during the operation, + Finishes mounting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. If the mount operation succeeded, g_volume_get_mount() on @volume is guaranteed to return the mount right after calling this function; there's no need to listen for the 'mount-added' signal on #GVolumeMonitor. - + - %TRUE, %FALSE if operation failed + %TRUE, %FALSE if operation failed - a #GVolume + a #GVolume - a #GAsyncResult + a #GAsyncResult - Mounts a volume. This is an asynchronous operation, and is + Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback. - + - a #GVolume + a #GVolume - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid user interaction + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data that gets passed to @callback + user data that gets passed to @callback - + @@ -79478,160 +83692,160 @@ and #GAsyncResult returned in the @callback. - Returns whether the volume should be automatically mounted. - + Returns whether the volume should be automatically mounted. + - %TRUE if the volume should be automatically mounted + %TRUE if the volume should be automatically mounted - a #GVolume + a #GVolume - Checks if a volume can be ejected. - + Checks if a volume can be ejected. + - %TRUE if the @volume can be ejected. %FALSE otherwise + %TRUE if the @volume can be ejected. %FALSE otherwise - a #GVolume + a #GVolume - Checks if a volume can be mounted. - + Checks if a volume can be mounted. + - %TRUE if the @volume can be mounted. %FALSE otherwise + %TRUE if the @volume can be mounted. %FALSE otherwise - a #GVolume + a #GVolume - Ejects a volume. This is an asynchronous operation, and is + Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback. Use g_volume_eject_with_operation() instead. - + - a #GVolume + a #GVolume - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data that gets passed to @callback + user data that gets passed to @callback - Finishes ejecting a volume. If any errors occurred during the operation, + Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_volume_eject_with_operation_finish() instead. - + - %TRUE, %FALSE if operation failed + %TRUE, %FALSE if operation failed - pointer to a #GVolume + pointer to a #GVolume - a #GAsyncResult + a #GAsyncResult - Ejects a volume. This is an asynchronous operation, and is + Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback. - + - a #GVolume + a #GVolume - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data passed to @callback + user data passed to @callback - Finishes ejecting a volume. If any errors occurred during the operation, + Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + - %TRUE if the volume was successfully ejected. %FALSE otherwise + %TRUE if the volume was successfully ejected. %FALSE otherwise - a #GVolume + a #GVolume - a #GAsyncResult + a #GAsyncResult - Gets the kinds of [identifiers][volume-identifier] that @volume has. + Gets the kinds of [identifiers][volume-identifier] that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves. - + - a %NULL-terminated array + a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -79639,13 +83853,13 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. - a #GVolume + a #GVolume - Gets the activation root for a #GVolume if it is known ahead of + Gets the activation root for a #GVolume if it is known ahead of mount time. Returns %NULL otherwise. If not %NULL and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always @@ -79671,142 +83885,142 @@ will always be %TRUE. Activation roots are typically used in #GVolumeMonitor implementations to find the underlying mount to shadow, see g_mount_is_shadowed() for more details. - + - the activation root of @volume + the activation root of @volume or %NULL. Use g_object_unref() to free. - a #GVolume + a #GVolume - Gets the drive for the @volume. - + Gets the drive for the @volume. + - a #GDrive or %NULL if @volume is not + a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the icon for @volume. - + Gets the icon for @volume. + - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the identifier of the given kind for @volume. + Gets the identifier of the given kind for @volume. See the [introduction][volume-identifier] for more information about volume identifiers. - + - a newly allocated string containing the + a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier - a #GVolume + a #GVolume - the kind of identifier to return + the kind of identifier to return - Gets the mount for the @volume. - + Gets the mount for the @volume. + - a #GMount or %NULL if @volume isn't mounted. + a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the name of @volume. - + Gets the name of @volume. + - the name for the given @volume. The returned string should + the name for the given @volume. The returned string should be freed with g_free() when no longer needed. - a #GVolume + a #GVolume - Gets the sort key for @volume, if any. - + Gets the sort key for @volume, if any. + - Sorting key for @volume or %NULL if no such key is available + Sorting key for @volume or %NULL if no such key is available - a #GVolume + a #GVolume - Gets the symbolic icon for @volume. - + Gets the symbolic icon for @volume. + - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume - Gets the UUID for the @volume. The reference is typically based on + Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + - the UUID for @volume or %NULL if no UUID + the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -79814,92 +84028,92 @@ available. - a #GVolume + a #GVolume - Mounts a volume. This is an asynchronous operation, and is + Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback. - + - a #GVolume + a #GVolume - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid user interaction + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data that gets passed to @callback + user data that gets passed to @callback - Finishes mounting a volume. If any errors occurred during the operation, + Finishes mounting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. If the mount operation succeeded, g_volume_get_mount() on @volume is guaranteed to return the mount right after calling this function; there's no need to listen for the 'mount-added' signal on #GVolumeMonitor. - + - %TRUE, %FALSE if operation failed + %TRUE, %FALSE if operation failed - a #GVolume + a #GVolume - a #GAsyncResult + a #GAsyncResult - Returns whether the volume should be automatically mounted. - + Returns whether the volume should be automatically mounted. + - %TRUE if the volume should be automatically mounted + %TRUE if the volume should be automatically mounted - a #GVolume + a #GVolume - Emitted when the volume has been changed. + Emitted when the volume has been changed. - This signal is emitted when the #GVolume have been removed. If + This signal is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -79908,15 +84122,15 @@ release them so the object can be finalized. - Interface for implementing operations for mountable volumes. - + Interface for implementing operations for mountable volumes. + - The parent interface. + The parent interface. - + @@ -79929,7 +84143,7 @@ release them so the object can be finalized. - + @@ -79942,15 +84156,15 @@ release them so the object can be finalized. - + - the name for the given @volume. The returned string should + the name for the given @volume. The returned string should be freed with g_free() when no longer needed. - a #GVolume + a #GVolume @@ -79958,16 +84172,16 @@ release them so the object can be finalized. - + - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume @@ -79975,9 +84189,9 @@ release them so the object can be finalized. - + - the UUID for @volume or %NULL if no UUID + the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -79985,7 +84199,7 @@ release them so the object can be finalized. - a #GVolume + a #GVolume @@ -79993,16 +84207,16 @@ release them so the object can be finalized. - + - a #GDrive or %NULL if @volume is not + a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume @@ -80010,16 +84224,16 @@ release them so the object can be finalized. - + - a #GMount or %NULL if @volume isn't mounted. + a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume @@ -80027,14 +84241,14 @@ release them so the object can be finalized. - + - %TRUE if the @volume can be mounted. %FALSE otherwise + %TRUE if the @volume can be mounted. %FALSE otherwise - a #GVolume + a #GVolume @@ -80042,14 +84256,14 @@ release them so the object can be finalized. - + - %TRUE if the @volume can be ejected. %FALSE otherwise + %TRUE if the @volume can be ejected. %FALSE otherwise - a #GVolume + a #GVolume @@ -80057,33 +84271,33 @@ release them so the object can be finalized. - + - a #GVolume + a #GVolume - flags affecting the operation + flags affecting the operation - a #GMountOperation or %NULL to avoid user interaction + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data that gets passed to @callback + user data that gets passed to @callback @@ -80091,18 +84305,18 @@ release them so the object can be finalized. - + - %TRUE, %FALSE if operation failed + %TRUE, %FALSE if operation failed - a #GVolume + a #GVolume - a #GAsyncResult + a #GAsyncResult @@ -80110,29 +84324,29 @@ release them so the object can be finalized. - + - a #GVolume + a #GVolume - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data that gets passed to @callback + user data that gets passed to @callback @@ -80140,18 +84354,18 @@ release them so the object can be finalized. - + - %TRUE, %FALSE if operation failed + %TRUE, %FALSE if operation failed - pointer to a #GVolume + pointer to a #GVolume - a #GAsyncResult + a #GAsyncResult @@ -80159,20 +84373,20 @@ release them so the object can be finalized. - + - a newly allocated string containing the + a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier - a #GVolume + a #GVolume - the kind of identifier to return + the kind of identifier to return @@ -80180,9 +84394,9 @@ release them so the object can be finalized. - + - a %NULL-terminated array + a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -80190,7 +84404,7 @@ release them so the object can be finalized. - a #GVolume + a #GVolume @@ -80198,14 +84412,14 @@ release them so the object can be finalized. - + - %TRUE if the volume should be automatically mounted + %TRUE if the volume should be automatically mounted - a #GVolume + a #GVolume @@ -80213,15 +84427,15 @@ release them so the object can be finalized. - + - the activation root of @volume + the activation root of @volume or %NULL. Use g_object_unref() to free. - a #GVolume + a #GVolume @@ -80229,34 +84443,34 @@ release them so the object can be finalized. - + - a #GVolume + a #GVolume - flags affecting the unmount if required for eject + flags affecting the unmount if required for eject - a #GMountOperation or %NULL to + a #GMountOperation or %NULL to avoid user interaction - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore - a #GAsyncReadyCallback, or %NULL + a #GAsyncReadyCallback, or %NULL - user data passed to @callback + user data passed to @callback @@ -80264,18 +84478,18 @@ release them so the object can be finalized. - + - %TRUE if the volume was successfully ejected. %FALSE otherwise + %TRUE if the volume was successfully ejected. %FALSE otherwise - a #GVolume + a #GVolume - a #GAsyncResult + a #GAsyncResult @@ -80283,14 +84497,14 @@ release them so the object can be finalized. - + - Sorting key for @volume or %NULL if no such key is available + Sorting key for @volume or %NULL if no such key is available - a #GVolume + a #GVolume @@ -80298,16 +84512,16 @@ release them so the object can be finalized. - + - a #GIcon. + a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. - a #GVolume + a #GVolume @@ -80315,7 +84529,7 @@ release them so the object can be finalized. - #GVolumeMonitor is for listing the user interesting devices and volumes + #GVolumeMonitor is for listing the user interesting devices and volumes on the computer. In other words, what a file selector or file manager would show in a sidebar. @@ -80328,7 +84542,7 @@ In order to receive updates about volumes and mounts monitored through GVFS, a main loop must be running. - This function should be called by any #GVolumeMonitor + This function should be called by any #GVolumeMonitor implementation when a new #GMount object is created that is not associated with a #GVolume object. It must be called just before emitting the @mount_added signal. @@ -80363,22 +84577,22 @@ gvfs for an example of this. Also see g_mount_is_shadowed(), g_mount_shadow() and g_mount_unshadow() functions. - the #GVolume object that is the parent for @mount or %NULL + the #GVolume object that is the parent for @mount or %NULL if no wants to adopt the #GMount. - a #GMount object to find a parent for + a #GMount object to find a parent for - Gets the volume monitor used by gio. + Gets the volume monitor used by gio. - a reference to the #GVolumeMonitor used by gio. Call + a reference to the #GVolumeMonitor used by gio. Call g_object_unref() when done with it. @@ -80454,96 +84668,96 @@ if no wants to adopt the #GMount. - Gets a list of drives connected to the system. + Gets a list of drives connected to the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - a #GList of connected #GDrive objects. + a #GList of connected #GDrive objects. - a #GVolumeMonitor. + a #GVolumeMonitor. - Finds a #GMount object by its UUID (see g_mount_get_uuid()) + Finds a #GMount object by its UUID (see g_mount_get_uuid()) - a #GMount or %NULL if no such mount is available. + a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). - a #GVolumeMonitor. + a #GVolumeMonitor. - the UUID to look for + the UUID to look for - Gets a list of the mounts on the system. + Gets a list of the mounts on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - a #GList of #GMount objects. + a #GList of #GMount objects. - a #GVolumeMonitor. + a #GVolumeMonitor. - Finds a #GVolume object by its UUID (see g_volume_get_uuid()) + Finds a #GVolume object by its UUID (see g_volume_get_uuid()) - a #GVolume or %NULL if no such volume is available. + a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). - a #GVolumeMonitor. + a #GVolumeMonitor. - the UUID to look for + the UUID to look for - Gets a list of the volumes on the system. + Gets a list of the volumes on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - a #GList of #GVolume objects. + a #GList of #GVolume objects. - a #GVolumeMonitor. + a #GVolumeMonitor. @@ -80647,96 +84861,96 @@ its elements have been unreffed with g_object_unref(). - Gets a list of drives connected to the system. + Gets a list of drives connected to the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - a #GList of connected #GDrive objects. + a #GList of connected #GDrive objects. - a #GVolumeMonitor. + a #GVolumeMonitor. - Finds a #GMount object by its UUID (see g_mount_get_uuid()) + Finds a #GMount object by its UUID (see g_mount_get_uuid()) - a #GMount or %NULL if no such mount is available. + a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). - a #GVolumeMonitor. + a #GVolumeMonitor. - the UUID to look for + the UUID to look for - Gets a list of the mounts on the system. + Gets a list of the mounts on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - a #GList of #GMount objects. + a #GList of #GMount objects. - a #GVolumeMonitor. + a #GVolumeMonitor. - Finds a #GVolume object by its UUID (see g_volume_get_uuid()) + Finds a #GVolume object by its UUID (see g_volume_get_uuid()) - a #GVolume or %NULL if no such volume is available. + a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). - a #GVolumeMonitor. + a #GVolumeMonitor. - the UUID to look for + the UUID to look for - Gets a list of the volumes on the system. + Gets a list of the volumes on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - a #GList of #GVolume objects. + a #GList of #GVolume objects. - a #GVolumeMonitor. + a #GVolumeMonitor. @@ -80748,91 +84962,91 @@ its elements have been unreffed with g_object_unref(). - Emitted when a drive changes. + Emitted when a drive changes. - the drive that changed + the drive that changed - Emitted when a drive is connected to the system. + Emitted when a drive is connected to the system. - a #GDrive that was connected. + a #GDrive that was connected. - Emitted when a drive is disconnected from the system. + Emitted when a drive is disconnected from the system. - a #GDrive that was disconnected. + a #GDrive that was disconnected. - Emitted when the eject button is pressed on @drive. + Emitted when the eject button is pressed on @drive. - the drive where the eject button was pressed + the drive where the eject button was pressed - Emitted when the stop button is pressed on @drive. + Emitted when the stop button is pressed on @drive. - the drive where the stop button was pressed + the drive where the stop button was pressed - Emitted when a mount is added. + Emitted when a mount is added. - a #GMount that was added. + a #GMount that was added. - Emitted when a mount changes. + Emitted when a mount changes. - a #GMount that changed. + a #GMount that changed. - May be emitted when a mount is about to be removed. + May be emitted when a mount is about to be removed. This signal depends on the backend and is only emitted if GIO was used to unmount. @@ -80841,55 +85055,55 @@ GIO was used to unmount. - a #GMount that is being unmounted. + a #GMount that is being unmounted. - Emitted when a mount is removed. + Emitted when a mount is removed. - a #GMount that was removed. + a #GMount that was removed. - Emitted when a mountable volume is added to the system. + Emitted when a mountable volume is added to the system. - a #GVolume that was added. + a #GVolume that was added. - Emitted when mountable volume is changed. + Emitted when mountable volume is changed. - a #GVolume that changed. + a #GVolume that changed. - Emitted when a mountable volume is removed from the system. + Emitted when a mountable volume is removed from the system. - a #GVolume that was removed. + a #GVolume that was removed. @@ -81072,14 +85286,14 @@ GIO was used to unmount. - a #GList of connected #GDrive objects. + a #GList of connected #GDrive objects. - a #GVolumeMonitor. + a #GVolumeMonitor. @@ -81089,14 +85303,14 @@ GIO was used to unmount. - a #GList of #GVolume objects. + a #GList of #GVolume objects. - a #GVolumeMonitor. + a #GVolumeMonitor. @@ -81106,14 +85320,14 @@ GIO was used to unmount. - a #GList of #GMount objects. + a #GList of #GMount objects. - a #GVolumeMonitor. + a #GVolumeMonitor. @@ -81123,17 +85337,17 @@ GIO was used to unmount. - a #GVolume or %NULL if no such volume is available. + a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). - a #GVolumeMonitor. + a #GVolumeMonitor. - the UUID to look for + the UUID to look for @@ -81143,17 +85357,17 @@ GIO was used to unmount. - a #GMount or %NULL if no such mount is available. + a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). - a #GVolumeMonitor. + a #GVolumeMonitor. - the UUID to look for + the UUID to look for @@ -81256,44 +85470,86 @@ GIO was used to unmount. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Zlib decompression + Zlib decompression - Creates a new #GZlibCompressor. + Creates a new #GZlibCompressor. - a new #GZlibCompressor + a new #GZlibCompressor - The format to use for the compressed data + The format to use for the compressed data - compression level (0-9), -1 for default + compression level (0-9), -1 for default - Returns the #GZlibCompressor:file-info property. + Returns the #GZlibCompressor:file-info property. - a #GFileInfo, or %NULL + a #GFileInfo, or %NULL - a #GZlibCompressor + a #GZlibCompressor - Sets @file_info in @compressor. If non-%NULL, and @compressor's + Sets @file_info in @compressor. If non-%NULL, and @compressor's #GZlibCompressor:format property is %G_ZLIB_COMPRESSOR_FORMAT_GZIP, it will be used to set the file name and modification time in the GZIP header of the compressed data. @@ -81307,17 +85563,17 @@ or after resetting it with g_converter_reset(). - a #GZlibCompressor + a #GZlibCompressor - a #GFileInfo + a #GFileInfo - If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is + If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is %G_ZLIB_COMPRESSOR_FORMAT_GZIP, the compressor will write the file name and modification time from the file info to the GZIP header. @@ -81336,56 +85592,56 @@ and modification time from the file info to the GZIP header. - Used to select the type of data format to use for #GZlibDecompressor + Used to select the type of data format to use for #GZlibDecompressor and #GZlibCompressor. - deflate compression with zlib header + deflate compression with zlib header - gzip file format + gzip file format - deflate compression with no header + deflate compression with no header - Zlib decompression + Zlib decompression - Creates a new #GZlibDecompressor. + Creates a new #GZlibDecompressor. - a new #GZlibDecompressor + a new #GZlibDecompressor - The format to use for the compressed data + The format to use for the compressed data - Retrieves the #GFileInfo constructed from the GZIP header data + Retrieves the #GFileInfo constructed from the GZIP header data of compressed data processed by @compressor, or %NULL if @decompressor's #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP, or the header data was not fully processed yet, or it not present in the data stream at all. - a #GFileInfo, or %NULL + a #GFileInfo, or %NULL - a #GZlibDecompressor + a #GZlibDecompressor - A #GFileInfo containing the information found in the GZIP header + A #GFileInfo containing the information found in the GZIP header of the data stream processed, or %NULL if the header was not yet fully processed, is not present at all, or the compressor's #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP. @@ -81402,7 +85658,7 @@ fully processed, is not present at all, or the compressor's - Checks if @action_name is valid. + Checks if @action_name is valid. @action_name is valid if it consists only of alphanumeric characters, plus '-' and '.'. The empty string is not a valid action name. @@ -81411,18 +85667,18 @@ It is an error to call this function with a non-utf8 @action_name. @action_name must not be %NULL. - %TRUE if @action_name is valid + %TRUE if @action_name is valid - an potential action name + an potential action name - Parses a detailed action name into its separate name and target + Parses a detailed action name into its separate name and target components. Detailed action names can have three formats. @@ -81448,26 +85704,26 @@ For strings, this third format must be used if * target value is empty or contains characters other than alphanumerics, '-' and '.'. - %TRUE if successful, else %FALSE with @error set + %TRUE if successful, else %FALSE with @error set - a detailed action name + a detailed action name - the action name + the action name - the target value, or %NULL for no target + the target value, or %NULL for no target - Formats a detailed action name from @action_name and @target_value. + Formats a detailed action name from @action_name and @target_value. It is an error to call this function with an invalid action name. @@ -81479,22 +85735,22 @@ See that function for the types of strings that will be printed by this function. - a detailed format string + a detailed format string - a valid action name + a valid action name - a #GVariant target value, or %NULL + a #GVariant target value, or %NULL - Creates a new #GAppInfo from the given information. + Creates a new #GAppInfo from the given information. Note that for @commandline, the quoting rules of the Exec key of the [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) @@ -81503,26 +85759,26 @@ percent-encoded URIs, the percent-character must be doubled in order to prevent being swallowed by Exec key unquoting. See the specification for exact quoting rules. - new #GAppInfo for given command. + new #GAppInfo for given command. - the commandline to use + the commandline to use - the application name, or %NULL to use @commandline + the application name, or %NULL to use @commandline - flags that can specify details of the created #GAppInfo + flags that can specify details of the created #GAppInfo - Gets a list of all of the applications currently registered + Gets a list of all of the applications currently registered on this system. For desktop files, this includes applications that have @@ -81532,20 +85788,20 @@ The returned list does not include applications which have the `Hidden` key set. - a newly allocated #GList of references to #GAppInfos. + a newly allocated #GList of references to #GAppInfos. - Gets a list of all #GAppInfos for a given content type, + Gets a list of all #GAppInfos for a given content type, including the recommended and fallback #GAppInfos. See g_app_info_get_recommended_for_type() and g_app_info_get_fallback_for_type(). - #GList of #GAppInfos + #GList of #GAppInfos for given @content_type or %NULL on error. @@ -81553,55 +85809,55 @@ g_app_info_get_fallback_for_type(). - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - Gets the default #GAppInfo for a given content type. + Gets the default #GAppInfo for a given content type. - #GAppInfo for given @content_type or + #GAppInfo for given @content_type or %NULL on error. - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - if %TRUE, the #GAppInfo is expected to + if %TRUE, the #GAppInfo is expected to support URIs - Gets the default application for handling URIs with + Gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". - #GAppInfo for given @uri_scheme or %NULL on error. + #GAppInfo for given @uri_scheme or %NULL on error. - a string containing a URI scheme. + a string containing a URI scheme. - Gets a list of fallback #GAppInfos for a given content type, i.e. + Gets a list of fallback #GAppInfos for a given content type, i.e. those applications which claim to support the given content type by MIME type subclassing and not directly. - #GList of #GAppInfos + #GList of #GAppInfos for given @content_type or %NULL on error. @@ -81609,13 +85865,13 @@ by MIME type subclassing and not directly. - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - Gets a list of recommended #GAppInfos for a given content type, i.e. + Gets a list of recommended #GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. @@ -81623,7 +85879,7 @@ the last one for which g_app_info_set_as_last_used_for_type() has been called. - #GList of #GAppInfos + #GList of #GAppInfos for given @content_type or %NULL on error. @@ -81631,38 +85887,38 @@ called. - the content type to find a #GAppInfo for + the content type to find a #GAppInfo for - Utility function that launches the default application + Utility function that launches the default application registered to handle the specified uri. Synchronous I/O is done on the uri to detect the type of the file if required. The D-Bus–activated applications don't have to be started if your application terminates too soon after this function. To prevent this, use -g_app_info_launch_default_for_uri() instead. +g_app_info_launch_default_for_uri_async() instead. - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - the uri to show + the uri to show - an optional #GAppLaunchContext + an optional #GAppLaunchContext - Async version of g_app_info_launch_default_for_uri(). + 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 @@ -81678,43 +85934,43 @@ in receiving error information from their activation. - the uri to show + the uri to show - an optional #GAppLaunchContext + an optional #GAppLaunchContext - a #GCancellable + a #GCancellable - a #GAsyncReadyCallback to call when the request is done + a #GAsyncReadyCallback to call when the request is done - data to pass to @callback + data to pass to @callback - Finishes an asynchronous launch-default-for-uri operation. + Finishes an asynchronous launch-default-for-uri operation. - %TRUE if the launch was successful, %FALSE if @error is set + %TRUE if the launch was successful, %FALSE if @error is set - a #GAsyncResult + a #GAsyncResult - Removes all changes to the type associations done by + Removes all changes to the type associations done by g_app_info_set_as_default_for_type(), g_app_info_set_as_default_for_extension(), g_app_info_add_supports_type() or @@ -81725,13 +85981,13 @@ g_app_info_remove_supports_type(). - a content type + a content type - Helper function for constructing #GAsyncInitable object. This is + Helper function for constructing #GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -81739,49 +85995,49 @@ then call g_async_initable_new_finish() to get the new object and check for any errors. Use g_object_new_with_properties() and g_async_initable_init_async() instead. See #GParameter for more information. - + - a #GType supporting #GAsyncInitable. + a #GType supporting #GAsyncInitable. - the number of parameters in @parameters + the number of parameters in @parameters - the parameters to use to construct the object + the parameters to use to construct the object - the [I/O priority][io-priority] of the operation + the [I/O priority][io-priority] of the operation - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - a #GAsyncReadyCallback to call when the initialization is + a #GAsyncReadyCallback to call when the initialization is finished - the data to pass to callback function + the data to pass to callback function - Asynchronously connects to the message bus specified by @bus_type. + Asynchronously connects to the message bus specified by @bus_type. When the operation is finished, @callback will be invoked. You can then call g_bus_get_finish() to get the result of the operation. -This is a asynchronous failable function. See g_bus_get_sync() for +This is an asynchronous failable function. See g_bus_get_sync() for the synchronous version. @@ -81789,25 +86045,25 @@ the synchronous version. - a #GBusType + a #GBusType - a #GCancellable or %NULL + a #GCancellable or %NULL - a #GAsyncReadyCallback to call when the request is satisfied + a #GAsyncReadyCallback to call when the request is satisfied - the data to pass to @callback + the data to pass to @callback - Finishes an operation started with g_bus_get(). + Finishes an operation started with g_bus_get(). The returned object is a singleton, that is, shared with other callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the @@ -81819,20 +86075,20 @@ Note that the returned #GDBusConnection object will (usually) have the #GDBusConnection:exit-on-close property set to %TRUE. - a #GDBusConnection or %NULL if @error is set. + a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). - a #GAsyncResult obtained from the #GAsyncReadyCallback passed + a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get() - Synchronously connects to the message bus specified by @bus_type. + Synchronously connects to the message bus specified by @bus_type. Note that the returned object may shared with other callers, e.g. if two separate parts of a process calls this function with the same @bus_type, they will share the same object. @@ -81850,23 +86106,23 @@ Note that the returned #GDBusConnection object will (usually) have the #GDBusConnection:exit-on-close property set to %TRUE. - a #GDBusConnection or %NULL if @error is set. + a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). - a #GBusType + a #GBusType - a #GCancellable or %NULL + a #GCancellable or %NULL - Starts acquiring @name on the bus specified by @bus_type and calls + Starts acquiring @name on the bus specified by @bus_type and calls @name_acquired_handler and @name_lost_handler when the name is acquired respectively lost. Callbacks will be invoked in the [thread-default main context][g-main-context-push-thread-default] @@ -81917,186 +86173,186 @@ Simply register objects to be exported in @bus_acquired_handler and unregister the objects (if any) in @name_lost_handler. - an identifier (never 0) that an be used with + an identifier (never 0) that an be used with g_bus_unown_name() to stop owning the name. - the type of bus to own a name on + the type of bus to own a name on - the well-known name to own + the well-known name to own - a set of flags from the #GBusNameOwnerFlags enumeration + a set of flags from the #GBusNameOwnerFlags enumeration - handler to invoke when connected to the bus of type @bus_type or %NULL + handler to invoke when connected to the bus of type @bus_type or %NULL - handler to invoke when @name is acquired or %NULL + handler to invoke when @name is acquired or %NULL - handler to invoke when @name is lost or %NULL + handler to invoke when @name is lost or %NULL - user data to pass to handlers + user data to pass to handlers - function for freeing @user_data or %NULL + function for freeing @user_data or %NULL - Like g_bus_own_name() but takes a #GDBusConnection instead of a + Like g_bus_own_name() but takes a #GDBusConnection instead of a #GBusType. - an identifier (never 0) that an be used with + an identifier (never 0) that an be used with g_bus_unown_name() to stop owning the name - a #GDBusConnection + a #GDBusConnection - the well-known name to own + the well-known name to own - a set of flags from the #GBusNameOwnerFlags enumeration + a set of flags from the #GBusNameOwnerFlags enumeration - handler to invoke when @name is acquired or %NULL + handler to invoke when @name is acquired or %NULL - handler to invoke when @name is lost or %NULL + handler to invoke when @name is lost or %NULL - user data to pass to handlers + user data to pass to handlers - function for freeing @user_data or %NULL + function for freeing @user_data or %NULL - Version of g_bus_own_name_on_connection() using closures instead of + Version of g_bus_own_name_on_connection() using closures instead of callbacks for easier binding in other languages. - an identifier (never 0) that an be used with + an identifier (never 0) that an be used with g_bus_unown_name() to stop owning the name. - a #GDBusConnection + a #GDBusConnection - the well-known name to own + the well-known name to own - a set of flags from the #GBusNameOwnerFlags enumeration + a set of flags from the #GBusNameOwnerFlags enumeration - #GClosure to invoke when @name is + #GClosure to invoke when @name is acquired or %NULL - #GClosure to invoke when @name is lost + #GClosure to invoke when @name is lost or %NULL - Version of g_bus_own_name() using closures instead of callbacks for + Version of g_bus_own_name() using closures instead of callbacks for easier binding in other languages. - an identifier (never 0) that an be used with + an identifier (never 0) that an be used with g_bus_unown_name() to stop owning the name. - the type of bus to own a name on + the type of bus to own a name on - the well-known name to own + the well-known name to own - a set of flags from the #GBusNameOwnerFlags enumeration + a set of flags from the #GBusNameOwnerFlags enumeration - #GClosure to invoke when connected to + #GClosure to invoke when connected to the bus of type @bus_type or %NULL - #GClosure to invoke when @name is + #GClosure to invoke when @name is acquired or %NULL - #GClosure to invoke when @name is lost or + #GClosure to invoke when @name is lost or %NULL - Stops owning a name. + Stops owning a name. - an identifier obtained from g_bus_own_name() + an identifier obtained from g_bus_own_name() - Stops watching a name. + Stops watching a name. - An identifier obtained from g_bus_watch_name() + An identifier obtained from g_bus_watch_name() - Starts watching @name on the bus specified by @bus_type and calls + Starts watching @name on the bus specified by @bus_type and calls @name_appeared_handler and @name_vanished_handler when the name is known to have a owner respectively known to lose its owner. Callbacks will be invoked in the @@ -82127,254 +86383,254 @@ Basically, the application should create object proxies in @name_vanished_handler. - An identifier (never 0) that an be used with + An identifier (never 0) that an be used with g_bus_unwatch_name() to stop watching the name. - The type of bus to watch a name on. + The type of bus to watch a name on. - The name (well-known or unique) to watch. + The name (well-known or unique) to watch. - Flags from the #GBusNameWatcherFlags enumeration. + Flags from the #GBusNameWatcherFlags enumeration. - Handler to invoke when @name is known to exist or %NULL. + Handler to invoke when @name is known to exist or %NULL. - Handler to invoke when @name is known to not exist or %NULL. + Handler to invoke when @name is known to not exist or %NULL. - User data to pass to handlers. + User data to pass to handlers. - Function for freeing @user_data or %NULL. + Function for freeing @user_data or %NULL. - Like g_bus_watch_name() but takes a #GDBusConnection instead of a + Like g_bus_watch_name() but takes a #GDBusConnection instead of a #GBusType. - An identifier (never 0) that an be used with + An identifier (never 0) that an be used with g_bus_unwatch_name() to stop watching the name. - A #GDBusConnection. + A #GDBusConnection. - The name (well-known or unique) to watch. + The name (well-known or unique) to watch. - Flags from the #GBusNameWatcherFlags enumeration. + Flags from the #GBusNameWatcherFlags enumeration. - Handler to invoke when @name is known to exist or %NULL. + Handler to invoke when @name is known to exist or %NULL. - Handler to invoke when @name is known to not exist or %NULL. + Handler to invoke when @name is known to not exist or %NULL. - User data to pass to handlers. + User data to pass to handlers. - Function for freeing @user_data or %NULL. + Function for freeing @user_data or %NULL. - Version of g_bus_watch_name_on_connection() using closures instead of callbacks for + Version of g_bus_watch_name_on_connection() using closures instead of callbacks for easier binding in other languages. - An identifier (never 0) that an be used with + An identifier (never 0) that an be used with g_bus_unwatch_name() to stop watching the name. - A #GDBusConnection. + A #GDBusConnection. - The name (well-known or unique) to watch. + The name (well-known or unique) to watch. - Flags from the #GBusNameWatcherFlags enumeration. + Flags from the #GBusNameWatcherFlags enumeration. - #GClosure to invoke when @name is known + #GClosure to invoke when @name is known to exist or %NULL. - #GClosure to invoke when @name is known + #GClosure to invoke when @name is known to not exist or %NULL. - Version of g_bus_watch_name() using closures instead of callbacks for + Version of g_bus_watch_name() using closures instead of callbacks for easier binding in other languages. - An identifier (never 0) that an be used with + An identifier (never 0) that an be used with g_bus_unwatch_name() to stop watching the name. - The type of bus to watch a name on. + The type of bus to watch a name on. - The name (well-known or unique) to watch. + The name (well-known or unique) to watch. - Flags from the #GBusNameWatcherFlags enumeration. + Flags from the #GBusNameWatcherFlags enumeration. - #GClosure to invoke when @name is known + #GClosure to invoke when @name is known to exist or %NULL. - #GClosure to invoke when @name is known + #GClosure to invoke when @name is known to not exist or %NULL. - Checks if a content type can be executable. Note that for instance + Checks if a content type can be executable. Note that for instance things like text files can be executables (i.e. scripts and batch files). - %TRUE if the file type corresponds to a type that + %TRUE if the file type corresponds to a type that can be executable, %FALSE otherwise. - a content type string + a content type string - Compares two content types for equality. + Compares two content types for equality. - %TRUE if the two strings are identical or equivalent, + %TRUE if the two strings are identical or equivalent, %FALSE otherwise. - a content type string + a content type string - a content type string + a content type string - Tries to find a content type based on the mime type name. + Tries to find a content type based on the mime type name. - Newly allocated string with content type or + Newly allocated string with content type or %NULL. Free with g_free() - a mime type string + a mime type string - Gets the human readable description of the content type. + Gets the human readable description of the content type. - a short description of the content type @type. Free the + a short description of the content type @type. Free the returned string with g_free() - a content type string + a content type string - Gets the generic icon name for a content type. + Gets the generic icon name for a content type. See the [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec) specification for more on the generic icon name. - the registered generic icon name for the given @type, + the registered generic icon name for the given @type, or %NULL if unknown. Free with g_free() - a content type string + a content type string - Gets the icon for a content type. + Gets the icon for a content type. - #GIcon corresponding to the content type. Free the returned + #GIcon corresponding to the content type. Free the returned object with g_object_unref() - a content type string + a content type string - Get the list of directories which MIME data is loaded from. See + Get the list of directories which MIME data is loaded from. See g_content_type_set_mime_dirs() for details. - + - %NULL-terminated list of + %NULL-terminated list of directories to load MIME data from, including any `mime/` subdirectory, and with the first directory to try listed first @@ -82383,70 +86639,70 @@ g_content_type_set_mime_dirs() for details. - Gets the mime type for the content type, if one is registered. + Gets the mime type for the content type, if one is registered. - the registered mime type for the + the registered mime type for the given @type, or %NULL if unknown; free with g_free(). - a content type string + a content type string - Gets the symbolic icon for a content type. + Gets the symbolic icon for a content type. - symbolic #GIcon corresponding to the content type. + symbolic #GIcon corresponding to the content type. Free the returned object with g_object_unref() - a content type string + a content type string - Guesses the content type based on example data. If the function is + Guesses the content type based on example data. If the function is uncertain, @result_uncertain will be set to %TRUE. Either @filename or @data may be %NULL, in which case the guess will be based solely on the other argument. - a string indicating a guessed content type for the + a string indicating a guessed content type for the given data. Free with g_free() - a string, or %NULL + a string, or %NULL - a stream of data, or %NULL + a stream of data, or %NULL - the size of @data + the size of @data - return location for the certainty + return location for the certainty of the result, or %NULL - Tries to guess the type of the tree with root @root, by + Tries to guess the type of the tree with root @root, by looking at the files it contains. The result is an array of content types, with the best guess coming first. @@ -82460,7 +86716,7 @@ This function is useful in the implementation of g_mount_guess_content_type(). - an %NULL-terminated + an %NULL-terminated array of zero or more content types. Free with g_strfreev() @@ -82468,69 +86724,69 @@ g_mount_guess_content_type(). - the root of the tree to guess a type for + the root of the tree to guess a type for - Determines if @type is a subset of @supertype. + Determines if @type is a subset of @supertype. - %TRUE if @type is a kind of @supertype, + %TRUE if @type is a kind of @supertype, %FALSE otherwise. - a content type string + a content type string - a content type string + a content type string - Determines if @type is a subset of @mime_type. + Determines if @type is a subset of @mime_type. Convenience wrapper around g_content_type_is_a(). - %TRUE if @type is a kind of @mime_type, + %TRUE if @type is a kind of @mime_type, %FALSE otherwise. - a content type string + a content type string - a mime type string + a mime type string - Checks if the content type is the generic "unknown" type. + Checks if the content type is the generic "unknown" type. On UNIX this is the "application/octet-stream" mimetype, while on win32 it is "*" and on OSX it is a dynamic type or octet-stream. - %TRUE if the type is the unknown type. + %TRUE if the type is the unknown type. - a content type string + a content type string - Set the list of directories used by GIO to load the MIME database. + Set the list of directories used by GIO to load the MIME database. If @dirs is %NULL, the directories used are the default: - the `mime` subdirectory of the directory in `$XDG_DATA_HOME` @@ -82553,13 +86809,13 @@ with @dirs set to %NULL before calling g_test_init(), for instance: return g_test_run (); ]| - + - %NULL-terminated list of + %NULL-terminated list of directories to load MIME data from, including any `mime/` subdirectory, and with the first directory to try listed first @@ -82569,12 +86825,12 @@ with @dirs set to %NULL before calling g_test_init(), for instance: - Gets a list of strings containing all the registered content types + Gets a list of strings containing all the registered content types known to the system. The list and its data should be freed using `g_list_free_full (list, g_free)`. - list of the registered + list of the registered content types @@ -82582,7 +86838,7 @@ known to the system. The list and its data should be freed using - Escape @string so it can appear in a D-Bus address as the value + Escape @string so it can appear in a D-Bus address as the value part of a key-value pair. For instance, if @string is `/run/bus-for-:0`, @@ -82591,20 +86847,20 @@ which could be used in a D-Bus address like `unix:nonce-tcp:host=127.0.0.1,port=42,noncefile=/run/bus-for-%3A0`. - a copy of @string with all + a copy of @string with all non-optionally-escaped bytes escaped - an unescaped string to be included in a D-Bus address + an unescaped string to be included in a D-Bus address as the value in a key-value pair - Synchronously looks up the D-Bus address for the well-known message + Synchronously looks up the D-Bus address for the well-known message bus instance specified by @bus_type. This may involve using various platform specific mechanisms. @@ -82612,23 +86868,23 @@ The returned address will be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). - a valid D-Bus address string for @bus_type or %NULL if - @error is set + a valid D-Bus address string for @bus_type or + %NULL if @error is set - a #GBusType + a #GBusType - a #GCancellable or %NULL + a #GCancellable or %NULL - Asynchronously connects to an endpoint specified by @address and + Asynchronously connects to an endpoint specified by @address and sets up the connection so it is in a state to run the client-side of the D-Bus authentication conversation. @address must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -82645,43 +86901,43 @@ g_dbus_address_get_stream_sync() for the synchronous version. - A valid D-Bus address. + A valid D-Bus address. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - A #GAsyncReadyCallback to call when the request is satisfied. + A #GAsyncReadyCallback to call when the request is satisfied. - Data to pass to @callback. + Data to pass to @callback. - Finishes an operation started with g_dbus_address_get_stream(). + Finishes an operation started with g_dbus_address_get_stream(). - A #GIOStream or %NULL if @error is set. + A #GIOStream or %NULL if @error is set. - A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream(). + A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream(). - %NULL or return location to store the GUID extracted from @address, if any. + %NULL or return location to store the GUID extracted from @address, if any. - Synchronously connects to an endpoint specified by @address and + Synchronously connects to an endpoint specified by @address and sets up the connection so it is in a state to run the client-side of the D-Bus authentication conversation. @address must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -82690,48 +86946,48 @@ This is a synchronous failable function. See g_dbus_address_get_stream() for the asynchronous version. - A #GIOStream or %NULL if @error is set. + A #GIOStream or %NULL if @error is set. - A valid D-Bus address. + A valid D-Bus address. - %NULL or return location to store the GUID extracted from @address, if any. + %NULL or return location to store the GUID extracted from @address, if any. - A #GCancellable or %NULL. + A #GCancellable or %NULL. - Looks up the value of an annotation. + Looks up the value of an annotation. The cost of this function is O(n) in number of annotations. - The value or %NULL if not found. Do not free, it is owned by @annotations. + The value or %NULL if not found. Do not free, it is owned by @annotations. - A %NULL-terminated array of annotations or %NULL. + A %NULL-terminated array of annotations or %NULL. - The name of the annotation to look up. + The name of the annotation to look up. - Creates a D-Bus error name to use for @error. If @error matches + Creates a D-Bus error name to use for @error. If @error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned. @@ -82744,18 +87000,18 @@ This function is typically only used in object mappings to put a #GError on the wire. Regular applications should not use it. - A D-Bus error name (never %NULL). Free with g_free(). + A D-Bus error name (never %NULL). Free with g_free(). - A #GError. + A #GError. - Gets the D-Bus error name used for @error, if any. + Gets the D-Bus error name used for @error, if any. This function is guaranteed to return a D-Bus error name for all #GErrors returned from functions handling remote method calls @@ -82763,35 +87019,35 @@ This function is guaranteed to return a D-Bus error name for all g_dbus_error_strip_remote_error() has been used on @error. - an allocated string or %NULL if the D-Bus error name + an allocated string or %NULL if the D-Bus error name could not be found. Free with g_free(). - a #GError + a #GError - Checks if @error represents an error received via D-Bus from a remote peer. If so, + Checks if @error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error. - %TRUE if @error represents an error from a remote peer, + %TRUE if @error represents an error from a remote peer, %FALSE otherwise. - A #GError. + A #GError. - Creates a #GError based on the contents of @dbus_error_name and + Creates a #GError based on the contents of @dbus_error_name and @dbus_error_message. Errors registered with g_dbus_error_register_error() will be looked @@ -82819,16 +87075,16 @@ This function is typically only used in object mappings to prepare it. - An allocated #GError. Free with g_error_free(). + An allocated #GError. Free with g_error_free(). - D-Bus error name. + D-Bus error name. - D-Bus error message. + D-Bus error message. @@ -82839,61 +87095,61 @@ it. - Creates an association to map between @dbus_error_name and + Creates an association to map between @dbus_error_name and #GErrors specified by @error_domain and @error_code. This is typically done in the routine that returns the #GQuark for an error domain. - %TRUE if the association was created, %FALSE if it already + %TRUE if the association was created, %FALSE if it already exists. - A #GQuark for a error domain. + A #GQuark for a error domain. - An error code. + An error code. - A D-Bus error name. + A D-Bus error name. - Helper function for associating a #GError error domain with D-Bus error names. + Helper function for associating a #GError error domain with D-Bus error names. - The error domain name. + The error domain name. - A pointer where to store the #GQuark. + A pointer where to store the #GQuark. - A pointer to @num_entries #GDBusErrorEntry struct items. + A pointer to @num_entries #GDBusErrorEntry struct items. - Number of items to register. + Number of items to register. - Looks for extra information in the error message used to recover + Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in @error will correspond exactly to what was received on the wire. @@ -82901,52 +87157,52 @@ received on the wire. This is typically used when presenting errors to the end user. - %TRUE if information was stripped, %FALSE otherwise. + %TRUE if information was stripped, %FALSE otherwise. - A #GError. + A #GError. - Destroys an association previously set up with g_dbus_error_register_error(). + Destroys an association previously set up with g_dbus_error_register_error(). - %TRUE if the association was destroyed, %FALSE if it wasn't found. + %TRUE if the association was destroyed, %FALSE if it wasn't found. - A #GQuark for a error domain. + A #GQuark for a error domain. - An error code. + An error code. - A D-Bus error name. + A D-Bus error name. - Generate a D-Bus GUID that can be used with + Generate a D-Bus GUID that can be used with e.g. g_dbus_connection_new(). See the D-Bus specification regarding what strings are valid D-Bus GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). - A valid D-Bus GUID. Free with g_free(). + A valid D-Bus GUID. Free with g_free(). - Converts a #GValue to a #GVariant of the type indicated by the @type + Converts a #GValue to a #GVariant of the type indicated by the @type parameter. The conversion is using the following rules: @@ -82976,24 +87232,24 @@ See the g_dbus_gvariant_to_gvalue() function for how to convert a #GVariant to a #GValue. - A #GVariant (never floating) of #GVariantType @type holding + A #GVariant (never floating) of #GVariantType @type holding the data from @gvalue or %NULL in case of failure. Free with g_variant_unref(). - A #GValue to convert to a #GVariant + A #GValue to convert to a #GVariant - A #GVariantType + A #GVariantType - Converts a #GVariant to a #GValue. If @value is floating, it is consumed. + Converts a #GVariant to a #GValue. If @value is floating, it is consumed. The rules specified in the g_dbus_gvalue_to_gvariant() function are used - this function is essentially its reverse form. So, a #GVariant @@ -83010,17 +87266,17 @@ The conversion never fails - a valid #GValue is always returned in - A #GVariant. + A #GVariant. - Return location pointing to a zero-filled (uninitialized) #GValue. + Return location pointing to a zero-filled (uninitialized) #GValue. - Checks if @string is a + Checks if @string is a [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). This doesn't check if @string is actually supported by #GDBusServer @@ -83028,148 +87284,148 @@ or #GDBusConnection - use g_dbus_is_supported_address() to do more checks. - %TRUE if @string is a valid D-Bus address, %FALSE otherwise. + %TRUE if @string is a valid D-Bus address, %FALSE otherwise. - A string. + A string. - Checks if @string is a D-Bus GUID. + Checks if @string is a D-Bus GUID. See the D-Bus specification regarding what strings are valid D-Bus GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). - %TRUE if @string is a guid, %FALSE otherwise. + %TRUE if @string is a guid, %FALSE otherwise. - The string to check. + The string to check. - Checks if @string is a valid D-Bus interface name. + Checks if @string is a valid D-Bus interface name. - %TRUE if valid, %FALSE otherwise. + %TRUE if valid, %FALSE otherwise. - The string to check. + The string to check. - Checks if @string is a valid D-Bus member (e.g. signal or method) name. + Checks if @string is a valid D-Bus member (e.g. signal or method) name. - %TRUE if valid, %FALSE otherwise. + %TRUE if valid, %FALSE otherwise. - The string to check. + The string to check. - Checks if @string is a valid D-Bus bus name (either unique or well-known). + Checks if @string is a valid D-Bus bus name (either unique or well-known). - %TRUE if valid, %FALSE otherwise. + %TRUE if valid, %FALSE otherwise. - The string to check. + The string to check. - Like g_dbus_is_address() but also checks if the library supports the + Like g_dbus_is_address() but also checks if the library supports the transports in @string and that key/value pairs for each transport are valid. See the specification of the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). - %TRUE if @string is a valid D-Bus address that is + %TRUE if @string is a valid D-Bus address that is supported by this library, %FALSE if @error is set. - A string. + A string. - Checks if @string is a valid D-Bus unique bus name. + Checks if @string is a valid D-Bus unique bus name. - %TRUE if valid, %FALSE otherwise. + %TRUE if valid, %FALSE otherwise. - The string to check. + The string to check. - Creates a new #GDtlsClientConnection wrapping @base_socket which is + Creates a new #GDtlsClientConnection wrapping @base_socket which is assumed to communicate with the server identified by @server_identity. - the new + the new #GDtlsClientConnection, or %NULL on error - the #GDatagramBased to wrap + the #GDatagramBased to wrap - the expected identity of the server + the expected identity of the server - Creates a new #GDtlsServerConnection wrapping @base_socket. + Creates a new #GDtlsServerConnection wrapping @base_socket. - the new + the new #GDtlsServerConnection, or %NULL on error - the #GDatagramBased to wrap + the #GDatagramBased to wrap - the default server certificate, or %NULL + the default server certificate, or %NULL - Creates a #GFile with the given argument from the command line. + Creates a #GFile with the given argument from the command line. The value of @arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. This operation never fails, but the returned object might not @@ -83185,19 +87441,19 @@ for you there. It is also always possible to use this function with #GOptionContext arguments of type %G_OPTION_ARG_FILENAME. - a new #GFile. + a new #GFile. Free the returned object with g_object_unref(). - a command line string + a command line string - Creates a #GFile with the given argument from the command line. + Creates a #GFile with the given argument from the command line. This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an @@ -83210,58 +87466,58 @@ other than the invocation of the current process. See also g_application_command_line_create_file_for_arg(). - a new #GFile + a new #GFile - a command line string + a command line string - the current working directory of the commandline + the current working directory of the commandline - Constructs a #GFile for a given path. This operation never + Constructs a #GFile for a given path. This operation never fails, but the returned object might not support any I/O operation if @path is malformed. - a new #GFile for the given @path. + a new #GFile for the given @path. Free the returned object with g_object_unref(). - a string containing a relative or absolute path. + a string containing a relative or absolute path. The string must be encoded in the glib filename encoding. - Constructs a #GFile for a given URI. This operation never + Constructs a #GFile for a given URI. This operation never fails, but the returned object might not support any I/O operation if @uri is malformed or if the uri type is not supported. - a new #GFile for the given @uri. + a new #GFile for the given @uri. Free the returned object with g_object_unref(). - a UTF-8 string containing a URI + a UTF-8 string containing a URI - Opens a file in the preferred directory for temporary files (as + Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a #GFile and #GFileIOStream pointing to it. @@ -83273,70 +87529,70 @@ Unlike the other #GFile constructors, this will return %NULL if a temporary file could not be created. - a new #GFile. + a new #GFile. Free the returned object with g_object_unref(). - Template for the file + Template for the file name, as in g_file_open_tmp(), or %NULL for a default template - on return, a #GFileIOStream for the created file + on return, a #GFileIOStream for the created file - Constructs a #GFile with the given @parse_name (i.e. something + Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the @parse_name cannot be parsed. - a new #GFile. + a new #GFile. - a file name or path to be parsed + a file name or path to be parsed - Deserializes a #GIcon previously serialized using g_icon_serialize(). + Deserializes a #GIcon previously serialized using g_icon_serialize(). - a #GIcon, or %NULL when deserialization fails. + a #GIcon, or %NULL when deserialization fails. - a #GVariant created with g_icon_serialize() + a #GVariant created with g_icon_serialize() - Gets a hash for an icon. + Gets a hash for an icon. - a #guint containing a hash for the @icon, suitable for + a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure. - #gconstpointer to an icon object. + #gconstpointer to an icon object. - Generate a #GIcon instance from @str. This function can fail if + Generate a #GIcon instance from @str. This function can fail if @str is not valid - see g_icon_to_string() for discussion. If your application or library provides one or more #GIcon @@ -83344,52 +87600,52 @@ implementations you need to ensure that each #GType is registered with the type system prior to calling g_icon_new_for_string(). - An object implementing the #GIcon + An object implementing the #GIcon interface or %NULL if @error is set. - A string obtained via g_icon_to_string(). + A string obtained via g_icon_to_string(). - Helper function for constructing #GInitable object. This is + Helper function for constructing #GInitable object. This is similar to g_object_newv() but also initializes the object and returns %NULL, setting an error on failure. Use g_object_new_with_properties() and g_initable_init() instead. See #GParameter for more information. - + - a newly allocated + a newly allocated #GObject, or %NULL on error - a #GType supporting #GInitable. + a #GType supporting #GInitable. - the number of parameters in @parameters + the number of parameters in @parameters - the parameters to use to construct the object + the parameters to use to construct the object - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Converts errno.h error codes into GIO error codes. The fallback + Converts errno.h error codes into GIO error codes. The fallback value %G_IO_ERROR_FAILED is returned for error codes not currently handled (but note that future GLib releases may return a more specific value instead). @@ -83398,92 +87654,92 @@ As %errno is global and may be modified by intermediate function calls, you should save its value as soon as the call which sets it - #GIOErrorEnum value for the given errno.h error number. + #GIOErrorEnum value for the given errno.h error number. - Error number as defined in errno.h. + Error number as defined in errno.h. - Gets the GIO Error Quark. + Gets the GIO Error Quark. - a #GQuark. + a #GQuark. - Registers @type as extension for the extension point with name + Registers @type as extension for the extension point with name @extension_point_name. If @type has already been registered as an extension for this extension point, the existing #GIOExtension object is returned. - a #GIOExtension object for #GType + a #GIOExtension object for #GType - the name of the extension point + the name of the extension point - the #GType to register as extension + the #GType to register as extension - the name for the extension + the name for the extension - the priority for the extension + the priority for the extension - Looks up an existing extension point. + Looks up an existing extension point. - the #GIOExtensionPoint, or %NULL if there + the #GIOExtensionPoint, or %NULL if there is no registered extension point with the given name. - the name of the extension point + the name of the extension point - Registers an extension point. + Registers an extension point. - the new #GIOExtensionPoint. This object is + the new #GIOExtensionPoint. This object is owned by GIO and should not be freed. - The name of the extension point + The name of the extension point - Loads all the modules in the specified directory. + Loads all the modules in the specified directory. If don't require all modules to be initialized (and thus registering all gtypes) then you can use g_io_modules_scan_all_in_directory() which allows delayed/lazy loading of modules. - a list of #GIOModules loaded + a list of #GIOModules loaded from the directory, All the modules are loaded into memory, if you want to unload them (enabling on-demand loading) you must call @@ -83495,21 +87751,21 @@ which allows delayed/lazy loading of modules. - pathname for a directory containing modules + pathname for a directory containing modules to load. - Loads all the modules in the specified directory. + Loads all the modules in the specified directory. If don't require all modules to be initialized (and thus registering all gtypes) then you can use g_io_modules_scan_all_in_directory() which allows delayed/lazy loading of modules. - a list of #GIOModules loaded + a list of #GIOModules loaded from the directory, All the modules are loaded into memory, if you want to unload them (enabling on-demand loading) you must call @@ -83521,18 +87777,18 @@ which allows delayed/lazy loading of modules. - pathname for a directory containing modules + pathname for a directory containing modules to load. - a scope to use when scanning the modules. + a scope to use when scanning the modules. - Scans all the modules in the specified directory, ensuring that + Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered. This may not actually load and initialize all the types in each @@ -83549,14 +87805,14 @@ use g_io_modules_load_all_in_directory(). - pathname for a directory containing modules + pathname for a directory containing modules to scan. - Scans all the modules in the specified directory, ensuring that + Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered. This may not actually load and initialize all the types in each @@ -83573,18 +87829,18 @@ use g_io_modules_load_all_in_directory(). - pathname for a directory containing modules + pathname for a directory containing modules to scan. - a scope to use when scanning the modules + a scope to use when scanning the modules - Cancels all cancellable I/O jobs. + Cancels all cancellable I/O jobs. A job is cancellable if a #GCancellable was passed into g_io_scheduler_push_job(). @@ -83597,7 +87853,7 @@ gioscheduler. - Schedules the I/O job to run in another thread. + Schedules the I/O job to run in another thread. @notify will be called on @user_data after @job_func has returned, regardless whether the job was cancelled or has run to completion. @@ -83612,30 +87868,30 @@ g_io_scheduler_cancel_all_jobs(). - a #GIOSchedulerJobFunc. + a #GIOSchedulerJobFunc. - data to pass to @job_func + data to pass to @job_func - a #GDestroyNotify for @user_data, or %NULL + a #GDestroyNotify for @user_data, or %NULL - the [I/O priority][io-priority] + the [I/O priority][io-priority] of the request. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Creates a keyfile-backed #GSettingsBackend. + Creates a keyfile-backed #GSettingsBackend. The filename of the keyfile to use is given by @filename. @@ -83686,47 +87942,47 @@ and a list of locked keys from a text file with the name `locks` in the same location. - a keyfile-backed #GSettingsBackend + a keyfile-backed #GSettingsBackend - the filename of the keyfile + the filename of the keyfile - the path under which all settings keys appear + the path under which all settings keys appear - the group name corresponding to + the group name corresponding to @root_path, or %NULL - Creates a memory-backed #GSettingsBackend. + Creates a memory-backed #GSettingsBackend. This backend allows changes to settings, but does not write them to any backing storage, so the next time you run your application, the memory backend will start out with the default values again. - a newly created #GSettingsBackend + a newly created #GSettingsBackend - Gets the default #GNetworkMonitor for the system. + Gets the default #GNetworkMonitor for the system. - a #GNetworkMonitor + a #GNetworkMonitor - Initializes the platform networking libraries (eg, on Windows, this + Initializes the platform networking libraries (eg, on Windows, this calls WSAStartup()). GLib will call this itself if it is needed, so you only need to call it if you directly call system networking functions (without calling any GLib networking functions first). @@ -83736,62 +87992,62 @@ functions (without calling any GLib networking functions first). - Creates a readonly #GSettingsBackend. + Creates a readonly #GSettingsBackend. This backend does not allow changes to settings, so all settings will always have their default values. - a newly created #GSettingsBackend + a newly created #GSettingsBackend - Utility method for #GPollableInputStream and #GPollableOutputStream + Utility method for #GPollableInputStream and #GPollableOutputStream implementations. Creates a new #GSource that expects a callback of type #GPollableSourceFunc. The new source does not actually do anything on its own; use g_source_add_child_source() to add other sources to it to cause it to trigger. - the new #GSource. + the new #GSource. - the stream associated with the new source + the stream associated with the new source - Utility method for #GPollableInputStream and #GPollableOutputStream + Utility method for #GPollableInputStream and #GPollableOutputStream implementations. Creates a new #GSource, as with g_pollable_source_new(), but also attaching @child_source (with a dummy callback), and @cancellable, if they are non-%NULL. - the new #GSource. + the new #GSource. - the stream associated with the + the stream associated with the new source - optional child source to attach + optional child source to attach - optional #GCancellable to attach + optional #GCancellable to attach - Tries to read from @stream, as with g_input_stream_read() (if + Tries to read from @stream, as with g_input_stream_read() (if @blocking is %TRUE) or g_pollable_input_stream_read_nonblocking() (if @blocking is %FALSE). This can be used to more easily share code between blocking and non-blocking implementations of a method. @@ -83802,37 +88058,37 @@ returns %TRUE, or else the behavior is undefined. If @blocking is %TRUE, then @stream does not need to be a #GPollableInputStream. - the number of bytes read, or -1 on error. + the number of bytes read, or -1 on error. - a #GInputStream + a #GInputStream - a buffer to + a buffer to read data into - the number of bytes to read + the number of bytes to read - whether to do blocking I/O + whether to do blocking I/O - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Tries to write to @stream, as with g_output_stream_write() (if + Tries to write to @stream, as with g_output_stream_write() (if @blocking is %TRUE) or g_pollable_output_stream_write_nonblocking() (if @blocking is %FALSE). This can be used to more easily share code between blocking and non-blocking implementations of a method. @@ -83844,37 +88100,37 @@ behavior is undefined. If @blocking is %TRUE, then @stream does not need to be a #GPollableOutputStream. - the number of bytes written, or -1 on error. + the number of bytes written, or -1 on error. - a #GOutputStream. + a #GOutputStream. - the buffer + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - whether to do blocking I/O + whether to do blocking I/O - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Tries to write @count bytes to @stream, as with + Tries to write @count bytes to @stream, as with g_output_stream_write_all(), but using g_pollable_stream_write() rather than g_output_stream_write(). @@ -83894,80 +88150,80 @@ behavior is undefined. If @blocking is %TRUE, then @stream does not need to be a #GPollableOutputStream. - %TRUE on success, %FALSE if there was an error + %TRUE on success, %FALSE if there was an error - a #GOutputStream. + a #GOutputStream. - the buffer + the buffer containing the data to write. - the number of bytes to write + the number of bytes to write - whether to do blocking I/O + whether to do blocking I/O - location to store the number of bytes that was + location to store the number of bytes that was written to the stream - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. - Lookup "gio-proxy" extension point for a proxy implementation that supports -specified protocol. + Find the `gio-proxy` extension point for a proxy implementation that supports +the specified protocol. - return a #GProxy or NULL if protocol + return a #GProxy or NULL if protocol is not supported. - the proxy protocol name (e.g. http, socks, etc) + the proxy protocol name (e.g. http, socks, etc) - Gets the default #GProxyResolver for the system. + Gets the default #GProxyResolver for the system. - the default #GProxyResolver. + the default #GProxyResolver. - Gets the #GResolver Error Quark. + Gets the #GResolver Error Quark. - a #GQuark. + a #GQuark. - Gets the #GResource Error Quark. + Gets the #GResource Error Quark. - a #GQuark + a #GQuark - Loads a binary resource bundle and creates a #GResource representation of it, allowing + Loads a binary resource bundle and creates a #GResource representation of it, allowing you to query it for data. If you want to use this resource in the global resource namespace you need @@ -83979,18 +88235,18 @@ there is an error in reading it, an error from g_mapped_file_new() will be returned. - a new #GResource, or %NULL on error + a new #GResource, or %NULL on error - the path of a filename to load, in the GLib filename encoding + the path of a filename to load, in the GLib filename encoding - Returns all the names of children at the specified @path in the set of + Returns all the names of children at the specified @path in the set of globally registered resources. The return result is a %NULL terminated list of strings which should be released with g_strfreev(). @@ -83998,55 +88254,55 @@ be released with g_strfreev(). @lookup_flags controls the behaviour of the lookup. - an array of constant strings + an array of constant strings - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - Looks for a file at the specified @path in the set of + Looks for a file at the specified @path in the set of globally registered resources and if found returns information about it. @lookup_flags controls the behaviour of the lookup. - %TRUE if the file was found. %FALSE if there were errors + %TRUE if the file was found. %FALSE if there were errors - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - a location to place the length of the contents of the file, + a location to place the length of the contents of the file, or %NULL if the length is not needed - a location to place the #GResourceFlags about the file, + a location to place the #GResourceFlags about the file, or %NULL if the flags are not needed - Looks for a file at the specified @path in the set of + Looks for a file at the specified @path in the set of globally registered resources and returns a #GBytes that lets you directly access the data in memory. @@ -84062,46 +88318,46 @@ the heap and automatically uncompress the data. @lookup_flags controls the behaviour of the lookup. - #GBytes or %NULL on error. + #GBytes or %NULL on error. Free the returned object with g_bytes_unref() - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - Looks for a file at the specified @path in the set of + Looks for a file at the specified @path in the set of globally registered resources and returns a #GInputStream that lets you read the data. @lookup_flags controls the behaviour of the lookup. - #GInputStream or %NULL on error. + #GInputStream or %NULL on error. Free the returned object with g_object_unref() - A pathname inside the resource + A pathname inside the resource - A #GResourceLookupFlags + A #GResourceLookupFlags - Registers the resource with the process-global set of resources. + Registers the resource with the process-global set of resources. Once a resource is registered the files in it can be accessed with the global resource lookup functions like g_resources_lookup_data(). @@ -84110,26 +88366,26 @@ with the global resource lookup functions like g_resources_lookup_data(). - A #GResource + A #GResource - Unregisters the resource from the process-global set of resources. + Unregisters the resource from the process-global set of resources. - A #GResource + A #GResource - Gets the default system schema source. + Gets the default system schema source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -84144,12 +88400,12 @@ lookups performed against the default source should probably be done recursively. - the default schema source + the default schema source - Reports an error in an asynchronous function in an idle function by + Reports an error in an asynchronous function in an idle function by directly setting the contents of the #GAsyncResult with the given error information. Use g_task_report_error(). @@ -84159,37 +88415,37 @@ information. - a #GObject, or %NULL. + a #GObject, or %NULL. - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - a #GQuark containing the error domain (usually #G_IO_ERROR). + a #GQuark containing the error domain (usually #G_IO_ERROR). - a specific error code. + a specific error code. - a formatted error reporting string. + a formatted error reporting string. - a list of variables to fill in @format. + a list of variables to fill in @format. - Reports an error in an idle function. Similar to + Reports an error in an idle function. Similar to g_simple_async_report_error_in_idle(), but takes a #GError rather than building a new one. Use g_task_report_error(). @@ -84199,25 +88455,25 @@ than building a new one. - a #GObject, or %NULL + a #GObject, or %NULL - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - the #GError to report + the #GError to report - Reports an error in an idle function. Similar to + Reports an error in an idle function. Similar to g_simple_async_report_gerror_in_idle(), but takes over the caller's ownership of @error, so the caller does not have to free it any more. Use g_task_report_error(). @@ -84227,35 +88483,35 @@ ownership of @error, so the caller does not have to free it any more. - a #GObject, or %NULL + a #GObject, or %NULL - a #GAsyncReadyCallback. + a #GAsyncReadyCallback. - user data passed to @callback. + user data passed to @callback. - the #GError to report + the #GError to report - Sorts @targets in place according to the algorithm in RFC 2782. + Sorts @targets in place according to the algorithm in RFC 2782. - the head of the sorted list. + the head of the sorted list. - a #GList of #GSrvTarget + a #GList of #GSrvTarget @@ -84263,15 +88519,15 @@ ownership of @error, so the caller does not have to free it any more. - Gets the default #GTlsBackend for the system. + Gets the default #GTlsBackend for the system. - a #GTlsBackend + a #GTlsBackend - Creates a new #GTlsClientConnection wrapping @base_io_stream (which + Creates a new #GTlsClientConnection wrapping @base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by @server_identity. @@ -84280,48 +88536,48 @@ on when application code can run operations on the @base_io_stream after this function has returned. - the new + the new #GTlsClientConnection, or %NULL on error - the #GIOStream to wrap + the #GIOStream to wrap - the expected identity of the server + the expected identity of the server - Gets the TLS error quark. + Gets the TLS error quark. - a #GQuark. + a #GQuark. - Creates a new #GTlsFileDatabase which uses anchor certificate authorities + Creates a new #GTlsFileDatabase which uses anchor certificate authorities in @anchors to verify certificate chains. The certificates in @anchors must be PEM encoded. - the new + the new #GTlsFileDatabase, or %NULL on error - filename of anchor certificate authorities. + filename of anchor certificate authorities. - Creates a new #GTlsServerConnection wrapping @base_io_stream (which + Creates a new #GTlsServerConnection wrapping @base_io_stream (which must have pollable input and output streams). See the documentation for #GTlsConnection:base-io-stream for restrictions @@ -84329,41 +88585,41 @@ on when application code can run operations on the @base_io_stream after this function has returned. - the new + the new #GTlsServerConnection, or %NULL on error - the #GIOStream to wrap + the #GIOStream to wrap - the default server certificate, or %NULL + the default server certificate, or %NULL - Determines if @mount_path is considered an implementation of the + Determines if @mount_path is considered an implementation of the OS. This is primarily used for hiding mountable and mounted volumes that only are used in the OS and has little to no relevance to the casual user. - %TRUE if @mount_path is considered an implementation detail + %TRUE if @mount_path is considered an implementation detail of the OS. - a mount path, e.g. `/media/disk` or `/usr` + a mount path, e.g. `/media/disk` or `/usr` - Determines if @device_path is considered a block device path which is only + Determines if @device_path is considered a block device path which is only used in implementation of the OS. This is primarily used for hiding mounted volumes that are intended as APIs for programs to read, and system administrators at a shell; rather than something that should, for example, @@ -84372,19 +88628,19 @@ appear in a GUI. For example, the Linux `/proc` filesystem. The list of device paths considered ‘system’ ones may change over time. - %TRUE if @device_path is considered an implementation detail of + %TRUE if @device_path is considered an implementation detail of the OS. - a device path, e.g. `/dev/loop0` or `nfsd` + a device path, e.g. `/dev/loop0` or `nfsd` - Determines if @fs_type is considered a type of file system which is only + Determines if @fs_type is considered a type of file system which is only used in implementation of the OS. This is primarily used for hiding mounted volumes that are intended as APIs for programs to read, and system administrators at a shell; rather than something that should, for example, @@ -84393,165 +88649,171 @@ appear in a GUI. For example, the Linux `/proc` filesystem. The list of file system types considered ‘system’ ones may change over time. - %TRUE if @fs_type is considered an implementation detail of the OS. + %TRUE if @fs_type is considered an implementation detail of the OS. - a file system type, e.g. `procfs` or `tmpfs` + a file system type, e.g. `procfs` or `tmpfs` - Gets a #GUnixMountEntry for a given mount path. If @time_read + Gets a #GUnixMountEntry for a given mount path. If @time_read is set, it will be filled with a unix timestamp for checking -if the mounts have changed since with g_unix_mounts_changed_since(). +if the mounts have changed since with g_unix_mounts_changed_since(). + +If more mounts have the same mount path, the last matching mount +is returned. - a #GUnixMountEntry. + a #GUnixMountEntry. - path for a possible unix mount. + path for a possible unix mount. - guint64 to contain a timestamp. + guint64 to contain a timestamp. - Compares two unix mounts. + Compares two unix mounts. - 1, 0 or -1 if @mount1 is greater than, equal to, + 1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. - first #GUnixMountEntry to compare. + first #GUnixMountEntry to compare. - second #GUnixMountEntry to compare. + second #GUnixMountEntry to compare. - Makes a copy of @mount_entry. + Makes a copy of @mount_entry. - a new #GUnixMountEntry + a new #GUnixMountEntry - a #GUnixMountEntry. + a #GUnixMountEntry. - Gets a #GUnixMountEntry for a given file path. If @time_read + Gets a #GUnixMountEntry for a given file path. If @time_read is set, it will be filled with a unix timestamp for checking -if the mounts have changed since with g_unix_mounts_changed_since(). +if the mounts have changed since with g_unix_mounts_changed_since(). + +If more mounts have the same mount path, the last matching mount +is returned. - a #GUnixMountEntry. + a #GUnixMountEntry. - file path on some unix mount. + file path on some unix mount. - guint64 to contain a timestamp. + guint64 to contain a timestamp. - Frees a unix mount. + Frees a unix mount. - a #GUnixMountEntry. + a #GUnixMountEntry. - Gets the device path for a unix mount. + Gets the device path for a unix mount. - a string containing the device path. + a string containing the device path. - a #GUnixMount. + a #GUnixMount. - Gets the filesystem type for the unix mount. + Gets the filesystem type for the unix mount. - a string containing the file system type. + a string containing the file system type. - a #GUnixMount. + a #GUnixMount. - Gets the mount path for a unix mount. + Gets the mount path for a unix mount. - the mount path for @mount_entry. + the mount path for @mount_entry. - input #GUnixMountEntry to get the mount path for. + input #GUnixMountEntry to get the mount path for. - Gets a comma-separated list of mount options for the unix mount. For example, + Gets a comma-separated list of mount options for the unix mount. For example, `rw,relatime,seclabel,data=ordered`. This is similar to g_unix_mount_point_get_options(), but it takes a #GUnixMountEntry as an argument. - a string containing the options, or %NULL if not + a string containing the options, or %NULL if not available. - a #GUnixMountEntry. + a #GUnixMountEntry. - Gets the root of the mount within the filesystem. This is useful e.g. for + Gets the root of the mount within the filesystem. This is useful e.g. for mounts created by bind operation, or btrfs subvolumes. For example, the root path is equal to "/" for mount created by @@ -84559,104 +88821,104 @@ For example, the root path is equal to "/" for mount created by "mount --bind /mnt/foo/bar /mnt/bar". - a string containing the root, or %NULL if not supported. + a string containing the root, or %NULL if not supported. - a #GUnixMountEntry. + a #GUnixMountEntry. - Guesses whether a Unix mount can be ejected. + Guesses whether a Unix mount can be ejected. - %TRUE if @mount_entry is deemed to be ejectable. + %TRUE if @mount_entry is deemed to be ejectable. - a #GUnixMountEntry + a #GUnixMountEntry - Guesses the icon of a Unix mount. + Guesses the icon of a Unix mount. - a #GIcon + a #GIcon - a #GUnixMountEntry + a #GUnixMountEntry - Guesses the name of a Unix mount. + Guesses the name of a Unix mount. The result is a translated string. - A newly allocated string that must + A newly allocated string that must be freed with g_free() - a #GUnixMountEntry + a #GUnixMountEntry - Guesses whether a Unix mount should be displayed in the UI. + Guesses whether a Unix mount should be displayed in the UI. - %TRUE if @mount_entry is deemed to be displayable. + %TRUE if @mount_entry is deemed to be displayable. - a #GUnixMountEntry + a #GUnixMountEntry - Guesses the symbolic icon of a Unix mount. + Guesses the symbolic icon of a Unix mount. - a #GIcon + a #GIcon - a #GUnixMountEntry + a #GUnixMountEntry - Checks if a unix mount is mounted read only. + Checks if a unix mount is mounted read only. - %TRUE if @mount_entry is read only. + %TRUE if @mount_entry is read only. - a #GUnixMount. + a #GUnixMount. - Checks if a Unix mount is a system mount. This is the Boolean OR of + Checks if a Unix mount is a system mount. This is the Boolean OR of g_unix_is_system_fs_type(), g_unix_is_system_device_path() and g_unix_is_mount_path_system_internal() on @mount_entry’s properties. @@ -84664,38 +88926,38 @@ The definition of what a ‘system’ mount entry is may change over t file system types and device paths are ignored. - %TRUE if the unix mount is for a system path. + %TRUE if the unix mount is for a system path. - a #GUnixMount. + a #GUnixMount. - Checks if the unix mount points have changed since a given unix time. + Checks if the unix mount points have changed since a given unix time. - %TRUE if the mount points have changed since @time. + %TRUE if the mount points have changed since @time. - guint64 to contain a timestamp. + guint64 to contain a timestamp. - Gets a #GList of #GUnixMountPoint containing the unix mount points. + Gets a #GList of #GUnixMountPoint containing the unix mount points. If @time_read is set, it will be filled with the mount timestamp, allowing for checking if the mounts have changed with g_unix_mount_points_changed_since(). - + a #GList of the UNIX mountpoints. @@ -84703,33 +88965,33 @@ g_unix_mount_points_changed_since(). - guint64 to contain a timestamp. + guint64 to contain a timestamp. - Checks if the unix mounts have changed since a given unix time. + Checks if the unix mounts have changed since a given unix time. - %TRUE if the mounts have changed since @time. + %TRUE if the mounts have changed since @time. - guint64 to contain a timestamp. + guint64 to contain a timestamp. - Gets a #GList of #GUnixMountEntry containing the unix mounts. + Gets a #GList of #GUnixMountEntry containing the unix mounts. If @time_read is set, it will be filled with the mount timestamp, allowing for checking if the mounts have changed with g_unix_mounts_changed_since(). - + a #GList of the UNIX mounts. @@ -84737,7 +88999,7 @@ with g_unix_mounts_changed_since(). - guint64 to contain a timestamp, or %NULL + guint64 to contain a timestamp, or %NULL diff --git a/rust-bindings/rust/src/auto/repo.rs b/rust-bindings/rust/src/auto/repo.rs index beee244e..c92f3579 100644 --- a/rust-bindings/rust/src/auto/repo.rs +++ b/rust-bindings/rust/src/auto/repo.rs @@ -344,11 +344,11 @@ impl Repo { // unsafe { TODO: call ostree_sys:ostree_repo_list_collection_refs() } //} - //pub fn list_commit_objects_starting_with>(&self, start: &str, out_commits: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 183 }/TypeId { ns_id: 2, id: 183 }, cancellable: Option<&P>) -> Result<(), Error> { + //pub fn list_commit_objects_starting_with>(&self, start: &str, out_commits: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 185 }/TypeId { ns_id: 2, id: 185 }, cancellable: Option<&P>) -> Result<(), Error> { // unsafe { TODO: call ostree_sys:ostree_repo_list_commit_objects_starting_with() } //} - //pub fn list_objects>(&self, flags: RepoListObjectsFlags, out_objects: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 183 }/TypeId { ns_id: 2, id: 183 }, cancellable: Option<&P>) -> Result<(), Error> { + //pub fn list_objects>(&self, flags: RepoListObjectsFlags, out_objects: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 185 }/TypeId { ns_id: 2, id: 185 }, cancellable: Option<&P>) -> Result<(), Error> { // unsafe { TODO: call ostree_sys:ostree_repo_list_objects() } //} @@ -789,7 +789,7 @@ impl Repo { } } - //pub fn traverse_commit>(&self, commit_checksum: &str, maxdepth: i32, out_reachable: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 183 }/TypeId { ns_id: 2, id: 183 }, cancellable: Option<&P>) -> Result<(), Error> { + //pub fn traverse_commit>(&self, commit_checksum: &str, maxdepth: i32, out_reachable: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 185 }/TypeId { ns_id: 2, id: 185 }, cancellable: Option<&P>) -> Result<(), Error> { // unsafe { TODO: call ostree_sys:ostree_repo_traverse_commit() } //} @@ -803,7 +803,7 @@ impl Repo { //} //#[cfg(any(feature = "v2018_6", feature = "dox"))] - //pub fn traverse_reachable_refs>(&self, depth: u32, reachable: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 183 }/TypeId { ns_id: 2, id: 183 }, cancellable: Option<&P>) -> Result<(), Error> { + //pub fn traverse_reachable_refs>(&self, depth: u32, reachable: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 185 }/TypeId { ns_id: 2, id: 185 }, cancellable: Option<&P>) -> Result<(), Error> { // unsafe { TODO: call ostree_sys:ostree_repo_traverse_reachable_refs() } //} @@ -1024,11 +1024,11 @@ impl Repo { //} //#[cfg(any(feature = "v2018_5", feature = "dox"))] - //pub fn traverse_new_parents() -> /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 183 }/TypeId { ns_id: 2, id: 183 } { + //pub fn traverse_new_parents() -> /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 185 }/TypeId { ns_id: 2, id: 185 } { // unsafe { TODO: call ostree_sys:ostree_repo_traverse_new_parents() } //} - //pub fn traverse_new_reachable() -> /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 183 }/TypeId { ns_id: 2, id: 183 } { + //pub fn traverse_new_reachable() -> /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 2, id: 185 }/TypeId { ns_id: 2, id: 185 } { // unsafe { TODO: call ostree_sys:ostree_repo_traverse_new_reachable() } //}